1 package FS::cust_main::Search;
4 use base qw( Exporter );
5 use vars qw( @EXPORT_OK $DEBUG $me $conf @fuzzyfields );
6 use String::Approx qw(amatch);
8 use FS::Record qw( qsearch );
10 use FS::cust_main_invoice;
12 use FS::payinfo_Mixin;
14 @EXPORT_OK = qw( smart_search );
16 # 1 is mostly method/subroutine entry and options
17 # 2 traces progress of some operations
18 # 3 is even more information including possibly sensitive data
20 $me = '[FS::cust_main::Search]';
23 'cust_main.first', 'cust_main.last', 'cust_main.company',
24 'cust_main.ship_company', # if you're using it
25 'cust_location.address1',
26 'contact.first', 'contact.last',
29 install_callback FS::UID sub {
31 #yes, need it for stuff below (prolly should be cached)
36 FS::cust_main::Search - Customer searching
40 use FS::cust_main::Search;
42 FS::cust_main::Search::smart_search(%options);
44 FS::cust_main::Search::email_search(%options);
46 FS::cust_main::Search->search( \%options );
48 FS::cust_main::Search->fuzzy_search( \%fuzzy_hashref );
54 =item smart_search OPTION => VALUE ...
56 Accepts the following options: I<search>, the string to search for. The string
57 will be searched for as a customer number, phone number, name or company name,
58 address (if address1-search is on), invoicing email address, or credit card
61 Searches match as an exact, or, in some cases, a substring or fuzzy match (see
62 the source code for the exact heuristics used); I<no_fuzzy_on_exact>, causes
64 skip fuzzy matching when an exact match is found.
66 Any additional options are treated as an additional qualifier on the search
69 Returns a (possibly empty) array of FS::cust_main objects.
76 #here is the agent virtualization
78 $FS::CurrentUser::CurrentUser->agentnums_sql(table => 'cust_main');
79 my $agentnums_href = $FS::CurrentUser::CurrentUser->agentnums_href;
83 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
84 my $search = delete $options{'search'};
85 ( my $alphanum_search = $search ) =~ s/\W//g;
87 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
89 #false laziness w/Record::ut_phone
90 my $phonen = "$1-$2-$3";
91 $phonen .= " x$4" if $4;
93 my $phonenum = "$1$2$3";
96 #cust_main phone numbers
97 push @cust_main, qsearch( {
98 'table' => 'cust_main',
99 'hashref' => { %options },
100 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
102 join(' OR ', map "$_ = '$phonen'",
103 qw( daytime night mobile fax )
106 " AND $agentnums_sql", #agent virtualization
109 #contact phone numbers
111 grep $agentnums_href->{$_->agentnum}, #agent virt
112 grep $_, #skip contacts that don't have cust_main records
113 map $_->contact->cust_main,
115 'table' => 'contact_phone',
116 'hashref' => { 'phonenum' => $phonenum },
119 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
120 #try looking for matches with extensions unless one was specified
122 push @cust_main, qsearch( {
123 'table' => 'cust_main',
124 'hashref' => { %options },
125 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
127 join(' OR ', map "$_ LIKE '$phonen\%'",
131 " AND $agentnums_sql", #agent virtualization
139 if ( $search =~ /@/ ) { #email address
141 # invoicing email address
143 grep $agentnums_href->{$_->agentnum}, #agent virt
146 'table' => 'cust_main_invoice',
147 'hashref' => { 'dest' => $search },
151 # contact email address
153 grep $agentnums_href->{$_->agentnum}, #agent virt
154 grep $_, #skip contacts that don't have cust_main records
155 map $_->contact->cust_main,
157 'table' => 'contact_email',
158 'hashref' => { 'emailaddress' => $search },
162 # custnum search (also try agent_custid), with some tweaking options if your
163 # legacy cust "numbers" have letters
164 } elsif ( $search =~ /^\s*(\d+)\s*$/
165 || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
166 && $search =~ /^\s*(\w\w?\d+)\s*$/
168 || ( $conf->config('cust_main-custnum-display_special')
169 # it's not currently possible for special prefixes to contain
170 # digits, so just strip off any alphabetic prefix and match
171 # the rest to custnum
172 && $search =~ /^\s*[[:alpha:]]*(\d+)\s*$/
174 || ( $conf->exists('address1-search' )
175 && $search =~ /^\s*(\d+\-?\w*)\s*$/ #i.e. 1234A or 9432-D
182 if ( $num =~ /^(\d+)$/ && $num <= 2147483647 ) { #need a bigint custnum? wow
183 my $agent_custid_null = $conf->exists('cust_main-default_agent_custid')
184 ? ' AND agent_custid IS NULL ' : '';
185 push @cust_main, qsearch( {
186 'table' => 'cust_main',
187 'hashref' => { 'custnum' => $num, %options },
188 'extra_sql' => " AND $agentnums_sql $agent_custid_null",
192 # for all agents this user can see, if any of them have custnum prefixes
193 # that match the search string, include customers that match the rest
194 # of the custnum and belong to that agent
195 foreach my $agentnum ( keys %$agentnums_href ) {
196 my $p = $conf->config('cust_main-custnum-display_prefix', $agentnum);
198 if ( $p eq substr($num, 0, length($p)) ) {
199 push @cust_main, qsearch( {
200 'table' => 'cust_main',
201 'hashref' => { 'custnum' => 0 + substr($num, length($p)),
202 'agentnum' => $agentnum,
209 push @cust_main, qsearch( {
210 'table' => 'cust_main',
211 'hashref' => { 'agent_custid' => $num, %options },
212 'extra_sql' => " AND $agentnums_sql", #agent virtualization
215 if ( $conf->exists('address1-search') ) {
216 my $len = length($num);
218 # probably the Right Thing: return customers that have any associated
219 # locations matching the string, not just bill/ship location
220 push @cust_main, qsearch( {
221 'table' => 'cust_main',
222 'addl_from' => ' JOIN cust_location USING (custnum) ',
223 'hashref' => { %options, },
225 ( keys(%options) ? ' AND ' : ' WHERE ' ).
226 " LOWER(SUBSTRING(cust_location.address1 FROM 1 FOR $len)) = '$num' ".
227 " AND $agentnums_sql",
231 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
233 my($company, $last, $first) = ( $1, $2, $3 );
235 # "Company (Last, First)"
236 #this is probably something a browser remembered,
237 #so just do an exact search (but case-insensitive, so USPS standardization
238 #doesn't throw a wrench in the works)
240 push @cust_main, qsearch( {
241 'table' => 'cust_main',
242 'hashref' => { %options },
244 ( keys(%options) ? ' AND ' : ' WHERE ' ).
246 " LOWER(first) = ". dbh->quote(lc($first)),
247 " LOWER(last) = ". dbh->quote(lc($last)),
248 " LOWER(company) = ". dbh->quote(lc($company)),
254 # probably not necessary for the "something a browser remembered" case
256 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
257 # try {first,last,company}
261 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
262 # # full strings the browser remembers won't work
263 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
265 use Lingua::EN::NameParse;
266 my $NameParse = new Lingua::EN::NameParse(
271 my($last, $first) = ( '', '' );
272 #maybe disable this too and just rely on NameParse?
273 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
275 ($last, $first) = ( $1, $2 );
277 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
278 } elsif ( ! $NameParse->parse($value) ) {
280 my %name = $NameParse->components;
281 $first = $name{'given_name_1'} || $name{'initials_1'}; #wtf NameParse, Ed?
282 $last = $name{'surname_1'};
286 if ( $first && $last ) {
288 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
291 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
292 $sql .= "( LOWER(cust_main.last) = $q_last AND LOWER(cust_main.first) = $q_first )";
295 push @cust_main, qsearch( {
296 'table' => 'cust_main',
297 'hashref' => \%options,
298 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
303 grep $agentnums_href->{$_->agentnum}, #agent virt
304 grep $_, #skip contacts that don't have cust_main records
307 'table' => 'contact',
308 'hashref' => { 'first' => $first,
314 # or it just be something that was typed in... (try that in a sec)
318 my $q_value = dbh->quote($value);
321 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
322 $sql .= " ( LOWER(cust_main.first) = $q_value
323 OR LOWER(cust_main.last) = $q_value
324 OR LOWER(cust_main.company) = $q_value
325 OR LOWER(cust_main.ship_company) = $q_value
328 #address1 (yes, it's a kludge)
329 $sql .= " OR EXISTS (
330 SELECT 1 FROM cust_location
331 WHERE LOWER(cust_location.address1) = $q_value
332 AND cust_location.custnum = cust_main.custnum
334 if $conf->exists('address1-search');
336 #contacts (look, another kludge)
337 $sql .= " OR EXISTS ( SELECT 1 FROM contact
338 WHERE ( LOWER(contact.first) = $q_value
339 OR LOWER(contact.last) = $q_value
341 AND contact.custnum IS NOT NULL
342 AND contact.custnum = cust_main.custnum
346 push @cust_main, qsearch( {
347 'table' => 'cust_main',
348 'hashref' => \%options,
349 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
352 #no exact match, trying substring/fuzzy
353 #always do substring & fuzzy (unless they're explicity config'ed off)
354 #getting complaints searches are not returning enough
355 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
357 #still some false laziness w/search (was search/cust_main.cgi)
361 my @company_hashrefs = (
362 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
363 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
368 if ( $first && $last ) {
371 { 'first' => { op=>'ILIKE', value=>"%$first%" },
372 'last' => { op=>'ILIKE', value=>"%$last%" },
379 { 'first' => { op=>'ILIKE', value=>"%$value%" }, },
380 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
384 foreach my $hashref ( @company_hashrefs, @hashrefs ) {
386 push @cust_main, qsearch( {
387 'table' => 'cust_main',
388 'hashref' => { %$hashref,
391 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
396 if ( $conf->exists('address1-search') ) {
398 push @cust_main, qsearch( {
399 table => 'cust_main',
400 addl_from => 'JOIN cust_location USING (custnum)',
401 extra_sql => 'WHERE '.
402 ' cust_location.address1 ILIKE '.dbh->quote("%$value%").
403 " AND $agentnums_sql", #agent virtualizaiton
410 foreach my $hashref ( @hashrefs ) {
413 grep $agentnums_href->{$_->agentnum}, #agent virt
414 grep $_, #skip contacts that don't have cust_main records
417 'table' => 'contact',
418 'hashref' => { %$hashref,
421 #'extra_sql' => " AND $agentnums_sql", #agent virt
428 'hashref' => \%options,
430 'extra_sql' => "WHERE $agentnums_sql", #agent virtualization
433 if ( $first && $last ) {
434 push @cust_main, FS::cust_main::Search->fuzzy_search(
435 { 'last' => $last, #fuzzy hashref
436 'first' => $first }, #
439 push @cust_main, FS::cust_main::Search->fuzzy_search(
440 { 'contact.last' => $last, #fuzzy hashref
441 'contact.first' => $first }, #
445 foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
446 push @cust_main, FS::cust_main::Search->fuzzy_search(
447 { $field => $value },
451 foreach my $field ( 'first', 'last' ) {
452 push @cust_main, FS::cust_main::Search->fuzzy_search(
453 { "contact.$field" => $value },
457 if ( $conf->exists('address1-search') ) {
459 FS::cust_main::Search->fuzzy_search(
460 { 'cust_location.address1' => $value },
469 ( my $nospace_search = $search ) =~ s/\s//g;
470 ( my $card_search = $nospace_search ) =~ s/\-//g;
471 $card_search =~ s/[x\*\.\_]/x/gi;
473 if ( $card_search =~ /^[\dx]{15,16}$/i ) { #credit card search
475 ( my $like_search = $card_search ) =~ s/x/_/g;
476 my $mask_search = FS::payinfo_Mixin->mask_payinfo('CARD', $card_search);
478 push @cust_main, qsearch({
479 'table' => 'cust_main',
481 'extra_sql' => " WHERE ( payinfo LIKE '$like_search'
482 OR paymask = '$mask_search'
484 " AND payby IN ('CARD','DCRD') ".
485 " AND $agentnums_sql", #agent virtulization
491 #eliminate duplicates
493 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
501 Accepts the following options: I<email>, the email address to search for. The
502 email address will be searched for as an email invoice destination and as an
505 #Any additional options are treated as an additional qualifier on the search
508 Returns a (possibly empty) array of FS::cust_main objects (but usually just
518 my $email = delete $options{'email'};
520 #we're only being used by RT at the moment... no agent virtualization yet
521 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
525 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
527 my ( $user, $domain ) = ( $1, $2 );
529 warn "$me smart_search: searching for $user in domain $domain"
535 'table' => 'cust_main_invoice',
536 'hashref' => { 'dest' => $email },
543 map $_->cust_svc->cust_pkg,
545 'table' => 'svc_acct',
546 'hashref' => { 'username' => $user, },
548 'AND ( SELECT domain FROM svc_domain
549 WHERE svc_acct.domsvc = svc_domain.svcnum
550 ) = '. dbh->quote($domain),
556 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
558 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
575 Returns a qsearch hash expression to search for parameters specified in
576 HASHREF. Valid parameters are
596 listref of start date, end date
600 listref of start date, end date
602 =item spouse_birthdate
604 listref of start date, end date
606 =item anniversary_date
608 listref of start date, end date
618 =item current_balance
620 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
633 my ($class, $params) = @_;
640 # initialize these to prevent warnings
648 'paydate_year' => '',
649 'invoice_terms' => '',
655 # explicit custnum(s)
658 if ( $params->{'custnum'} ) {
659 my @custnums = ref($params->{'custnum'}) ?
660 @{ $params->{'custnum'} } :
661 $params->{'custnum'};
663 'cust_main.custnum IN (' .
664 join(',', map { $_ =~ /^(\d+)$/ ? $1 : () } @custnums ) .
665 ')' if scalar(@custnums) > 0;
672 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
674 "cust_main.agentnum = $1";
681 if ( $params->{'salesnum'} =~ /^(\d+)$/ ) {
682 push @where, ($1 > 0 ) ? "cust_main.salesnum = $1"
683 : 'cust_main.salesnum IS NULL';
690 if ( $params->{'usernum'} =~ /^(\d+)$/ and $1 ) {
692 "cust_main.usernum = $1";
699 #prospect ordered active inactive suspended cancelled
700 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
701 my $method = $params->{'status'}. '_sql';
702 #push @where, $class->$method();
703 push @where, FS::cust_main->$method();
709 if ( $params->{'address'} ) {
710 # allow this to be an arrayref
711 my @values = ($params->{'address'});
712 @values = @{$values[0]} if ref($values[0]);
714 foreach (grep /\S/, @values) {
715 my $address = dbh->quote('%'. lc($_). '%');
717 "LOWER(cust_location.address1) LIKE $address",
718 "LOWER(cust_location.address2) LIKE $address";
721 push @where, "EXISTS(
722 SELECT 1 FROM cust_location
723 WHERE cust_location.custnum = cust_main.custnum
724 AND (".join(' OR ',@orwhere).")
732 if ( $params->{'city'} =~ /\S/ ) {
733 my $city = dbh->quote($params->{'city'});
734 push @where, "EXISTS(
735 SELECT 1 FROM cust_location
736 WHERE cust_location.custnum = cust_main.custnum
737 AND cust_location.city = $city
744 if ( $params->{'county'} =~ /\S/ ) {
745 my $county = dbh->quote($params->{'county'});
746 push @where, "EXISTS(
747 SELECT 1 FROM cust_location
748 WHERE cust_location.custnum = cust_main.custnum
749 AND cust_location.county = $county
756 if ( $params->{'state'} =~ /\S/ ) {
757 my $state = dbh->quote($params->{'state'});
758 push @where, "EXISTS(
759 SELECT 1 FROM cust_location
760 WHERE cust_location.custnum = cust_main.custnum
761 AND cust_location.state = $state
768 if ( $params->{'zip'} =~ /\S/ ) {
769 my $zip = dbh->quote($params->{'zip'} . '%');
770 push @where, "EXISTS(
771 SELECT 1 FROM cust_location
772 WHERE cust_location.custnum = cust_main.custnum
773 AND cust_location.zip LIKE $zip
780 if ( $params->{'country'} =~ /^(\w\w)$/ ) {
781 my $country = uc($1);
782 push @where, "EXISTS(
783 SELECT 1 FROM cust_location
784 WHERE cust_location.custnum = cust_main.custnum
785 AND cust_location.country = '$country'
792 if ( $params->{'refnum'} ) {
794 my @refnum = ref( $params->{'refnum'} )
795 ? @{ $params->{'refnum'} }
796 : ( $params->{'refnum'} );
798 @refnum = grep /^(\d*)$/, @refnum;
800 push @where, '( '. join(' OR ', map "cust_main.refnum = $_", @refnum ). ' )'
806 # parse cancelled package checkbox
811 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
812 unless $params->{'cancelled_pkgs'};
815 # "with email address(es)" checkbox
819 'EXISTS ( SELECT 1 FROM cust_main_invoice
820 WHERE cust_main_invoice.custnum = cust_main.custnum
822 )' # AND dest LIKE '%@%'
823 if $params->{'with_email'};
826 # "with postal mail invoices" checkbox
830 "EXISTS ( SELECT 1 FROM cust_main_invoice
831 WHERE cust_main_invoice.custnum = cust_main.custnum
833 if $params->{'POST'};
836 # "without postal mail invoices" checkbox
840 "NOT EXISTS ( SELECT 1 FROM cust_main_invoice
841 WHERE cust_main_invoice.custnum = cust_main.custnum
843 if $params->{'no_POST'};
846 # "tax exempt" checkbox
848 push @where, "cust_main.tax = 'Y'"
852 # "not tax exempt" checkbox
854 push @where, "(cust_main.tax = '' OR cust_main.tax IS NULL )"
855 if $params->{'no_tax'};
861 foreach my $field (qw( signupdate birthdate spouse_birthdate anniversary_date )) {
863 next unless exists($params->{$field});
865 my($beginning, $ending, $hour) = @{$params->{$field}};
868 "cust_main.$field IS NOT NULL",
869 "cust_main.$field >= $beginning",
870 "cust_main.$field <= $ending";
872 if($field eq 'signupdate' && defined $hour) {
873 if ($dbh->{Driver}->{Name} =~ /Pg/i) {
874 push @where, "extract(hour from to_timestamp(cust_main.$field)) = $hour";
876 elsif( $dbh->{Driver}->{Name} =~ /mysql/i) {
877 push @where, "hour(from_unixtime(cust_main.$field)) = $hour"
880 warn "search by time of day not supported on ".$dbh->{Driver}->{Name}." databases";
884 $orderby ||= "ORDER BY cust_main.$field";
892 if ( $params->{'classnum'} ) {
894 my @classnum = ref( $params->{'classnum'} )
895 ? @{ $params->{'classnum'} }
896 : ( $params->{'classnum'} );
898 @classnum = grep /^(\d*)$/, @classnum;
901 push @where, '( '. join(' OR ', map {
902 $_ ? "cust_main.classnum = $_"
903 : "cust_main.classnum IS NULL"
916 if ( $params->{'payby'} ) {
918 my @payby = ref( $params->{'payby'} )
919 ? @{ $params->{'payby'} }
920 : ( $params->{'payby'} );
922 @payby = grep /^([A-Z]{4})$/, @payby;
924 push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )'
930 # paydate_year / paydate_month
933 if ( $params->{'paydate_year'} =~ /^(\d{4})$/ ) {
935 $params->{'paydate_month'} =~ /^(\d\d?)$/
936 or die "paydate_year without paydate_month?";
940 'paydate IS NOT NULL',
942 "CAST(paydate AS timestamp) < CAST('$year-$month-01' AS timestamp )"
950 if ( $params->{'invoice_terms'} =~ /^([\w ]+)$/ ) {
952 if ( $1 eq 'NULL' ) {
954 "( cust_main.invoice_terms IS NULL OR cust_main.invoice_terms = '' )";
957 "cust_main.invoice_terms IS NOT NULL",
958 "cust_main.invoice_terms = '$1'";
966 if ( $params->{'current_balance'} ) {
968 #my $balance_sql = $class->balance_sql();
969 my $balance_sql = FS::cust_main->balance_sql();
971 my @current_balance =
972 ref( $params->{'current_balance'} )
973 ? @{ $params->{'current_balance'} }
974 : ( $params->{'current_balance'} );
976 push @where, map { s/current_balance/$balance_sql/; $_ }
985 if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
987 "cust_main.custbatch = '$1'";
990 if ( $params->{'tagnum'} ) {
991 my @tagnums = ref( $params->{'tagnum'} ) ? @{ $params->{'tagnum'} } : ( $params->{'tagnum'} );
993 @tagnums = grep /^(\d+)$/, @tagnums;
996 if ( $params->{'all_tags'} ) {
997 foreach ( @tagnums ) {
998 push @where, 'exists(select 1 from cust_tag where '.
999 'cust_tag.custnum = cust_main.custnum and tagnum = '.
1002 } else { # matching any tag, not all
1003 my $tags_where = "0 < (select count(1) from cust_tag where "
1004 . " cust_tag.custnum = cust_main.custnum and tagnum in ("
1005 . join(',', @tagnums) . "))";
1007 push @where, $tags_where;
1015 if ( $params->{'pkg_classnum'} ) {
1016 my @pkg_classnums = ref( $params->{'pkg_classnum'} ) ?
1017 @{ $params->{'pkg_classnum'} } :
1018 $params->{'pkg_classnum'};
1019 @pkg_classnums = grep /^(\d+)$/, @pkg_classnums;
1021 if ( @pkg_classnums ) {
1024 if ( $params->{'all_pkg_classnums'} ) {
1025 push @pkg_where, "part_pkg.classnum = $_" foreach @pkg_classnums;
1028 'part_pkg.classnum IN('. join(',', @pkg_classnums).')';
1030 foreach (@pkg_where) {
1032 "SELECT 1 FROM cust_pkg JOIN part_pkg USING (pkgpart) WHERE ".
1033 "cust_pkg.custnum = cust_main.custnum AND $_ ";
1034 if ( not $params->{'any_pkg_status'} ) {
1035 $select_pkg .= 'AND '.FS::cust_pkg->active_sql;
1037 push @where, "EXISTS($select_pkg)";
1043 # setup queries, subs, etc. for the search
1046 $orderby ||= 'ORDER BY custnum';
1048 # here is the agent virtualization
1050 $FS::CurrentUser::CurrentUser->agentnums_sql(table => 'cust_main');
1052 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
1055 # always make address fields available in results
1056 for my $pre ('bill_', 'ship_') {
1058 'LEFT JOIN cust_location AS '.$pre.'location '.
1059 'ON (cust_main.'.$pre.'locationnum = '.$pre.'location.locationnum) ';
1062 # always make referral available in results
1063 # (maybe we should be using FS::UI::Web::join_cust_main instead?)
1064 $addl_from .= ' LEFT JOIN (select refnum, referral from part_referral) AS part_referral_x ON (cust_main.refnum = part_referral_x.refnum) ';
1066 my $count_query = "SELECT COUNT(*) FROM cust_main $addl_from $extra_sql";
1069 'cust_main.custnum',
1070 'cust_main.salesnum',
1071 # there's a good chance that we'll need these
1072 'cust_main.bill_locationnum',
1073 'cust_main.ship_locationnum',
1074 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
1077 my(@extra_headers) = ();
1078 my(@extra_fields) = ();
1080 if ($params->{'flattened_pkgs'}) {
1084 ' LEFT JOIN cust_pkg ON ( cust_main.custnum = cust_pkg.custnum ) ';
1086 if ($dbh->{Driver}->{Name} eq 'Pg') {
1091 SELECT pkg FROM cust_pkg LEFT JOIN part_pkg USING ( pkgpart )
1092 WHERE cust_main.custnum = cust_pkg.custnum $pkgwhere
1097 } elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
1098 push @select, "GROUP_CONCAT(part_pkg.pkg SEPARATOR '|') as magic";
1099 $addl_from .= ' LEFT JOIN part_pkg USING ( pkgpart ) ';
1100 #$pkg_join .= ' LEFT JOIN part_pkg USING ( pkgpart ) ';
1102 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
1103 "omitting package information from report.";
1106 my $header_query = "
1107 SELECT COUNT(cust_pkg.custnum = cust_main.custnum) AS count
1108 FROM cust_main $addl_from $extra_sql $pkgwhere
1109 GROUP BY cust_main.custnum ORDER BY count DESC LIMIT 1
1112 my $sth = dbh->prepare($header_query) or die dbh->errstr;
1113 $sth->execute() or die $sth->errstr;
1114 my $headerrow = $sth->fetchrow_arrayref;
1115 my $headercount = $headerrow ? $headerrow->[0] : 0;
1116 while($headercount) {
1117 unshift @extra_headers, "Package ". $headercount;
1118 unshift @extra_fields, eval q!sub {my $c = shift;
1119 my @a = split '\|', $c->magic;
1120 my $p = $a[!.--$headercount. q!];
1127 my $select = join(', ', @select);
1130 'table' => 'cust_main',
1131 'select' => $select,
1132 'addl_from' => $addl_from,
1134 'extra_sql' => $extra_sql,
1135 'order_by' => $orderby,
1136 'count_query' => $count_query,
1137 'extra_headers' => \@extra_headers,
1138 'extra_fields' => \@extra_fields,
1140 #warn Data::Dumper::Dumper($sql_query);
1145 =item fuzzy_search FUZZY_HASHREF [ OPTS ]
1147 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
1148 records. Currently, I<first>, I<last>, I<company> and/or I<address1> may be
1151 Additional options are the same as FS::Record::qsearch
1158 # sensible defaults, then merge in any passed options
1160 'table' => 'cust_main',
1169 my @fuzzy_mod = 'i';
1170 my $conf = new FS::Conf;
1171 my $fuzziness = $conf->config('fuzzy-fuzziness');
1172 push @fuzzy_mod, $fuzziness if $fuzziness;
1174 check_and_rebuild_fuzzyfiles();
1175 foreach my $field ( keys %$fuzzy ) {
1177 my $all = $self->all_X($field);
1178 next unless scalar(@$all);
1181 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, \@fuzzy_mod, @$all ) );
1182 next if !keys(%match);
1184 my $in_matches = 'IN (' .
1185 join(',', map { dbh->quote($_) } keys %match) .
1188 my $extra_sql = $fuzopts{extra_sql};
1189 if ($extra_sql =~ /^\s*where /i or keys %{ $fuzopts{hashref} }) {
1190 $extra_sql .= ' AND ';
1192 $extra_sql .= 'WHERE ';
1194 $extra_sql .= "$field $in_matches";
1196 my $addl_from = $fuzopts{addl_from};
1197 if ( $field =~ /^cust_location\./ ) {
1198 $addl_from .= ' JOIN cust_location USING (custnum)';
1199 } elsif ( $field =~ /^contact\./ ) {
1200 $addl_from .= ' JOIN contact USING (custnum)';
1203 push @cust_main, qsearch({
1205 'addl_from' => $addl_from,
1206 'extra_sql' => $extra_sql,
1210 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
1212 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
1220 =head1 UTILITY SUBROUTINES
1224 =item check_and_rebuild_fuzzyfiles
1228 sub check_and_rebuild_fuzzyfiles {
1229 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1230 rebuild_fuzzyfiles()
1231 if grep { ! -e "$dir/$_" }
1233 my ($field, $table) = reverse split('\.', $_);
1234 $table ||= 'cust_main';
1240 =item rebuild_fuzzyfiles
1244 sub rebuild_fuzzyfiles {
1246 use Fcntl qw(:flock);
1248 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1249 mkdir $dir, 0700 unless -d $dir;
1251 foreach my $fuzzy ( @fuzzyfields ) {
1253 my ($field, $table) = reverse split('\.', $fuzzy);
1254 $table ||= 'cust_main';
1256 open(LOCK,">>$dir/$table.$field")
1257 or die "can't open $dir/$table.$field: $!";
1259 or die "can't lock $dir/$table.$field: $!";
1261 open (CACHE, '>:encoding(UTF-8)', "$dir/$table.$field.tmp")
1262 or die "can't open $dir/$table.$field.tmp: $!";
1264 my $sth = dbh->prepare(
1265 "SELECT $field FROM $table WHERE $field IS NOT NULL AND $field != ''"
1267 $sth->execute or die $sth->errstr;
1269 while ( my $row = $sth->fetchrow_arrayref ) {
1270 print CACHE $row->[0]. "\n";
1273 close CACHE or die "can't close $dir/$table.$field.tmp: $!";
1275 rename "$dir/$table.$field.tmp", "$dir/$table.$field";
1281 =item append_fuzzyfiles FIRSTNAME LASTNAME COMPANY ADDRESS1
1285 sub append_fuzzyfiles {
1286 #my( $first, $last, $company ) = @_;
1288 check_and_rebuild_fuzzyfiles();
1290 #foreach my $fuzzy (@fuzzyfields) {
1291 foreach my $fuzzy ( 'cust_main.first', 'cust_main.last', 'cust_main.company',
1292 'cust_location.address1',
1293 'cust_main.ship_company',
1296 append_fuzzyfiles_fuzzyfield($fuzzy, shift);
1303 =item append_fuzzyfiles_fuzzyfield COLUMN VALUE
1305 =item append_fuzzyfiles_fuzzyfield TABLE.COLUMN VALUE
1309 use Fcntl qw(:flock);
1310 sub append_fuzzyfiles_fuzzyfield {
1311 my( $fuzzyfield, $value ) = @_;
1313 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1316 my ($field, $table) = reverse split('\.', $fuzzyfield);
1317 $table ||= 'cust_main';
1319 return unless length($value);
1321 open(CACHE, '>>:encoding(UTF-8)', "$dir/$table.$field" )
1322 or die "can't open $dir/$table.$field: $!";
1323 flock(CACHE,LOCK_EX)
1324 or die "can't lock $dir/$table.$field: $!";
1326 print CACHE "$value\n";
1328 flock(CACHE,LOCK_UN)
1329 or die "can't unlock $dir/$table.$field: $!";
1339 my( $self, $fuzzy ) = @_;
1340 my ($field, $table) = reverse split('\.', $fuzzy);
1341 $table ||= 'cust_main';
1343 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1344 open(CACHE, '<:encoding(UTF-8)', "$dir/$table.$field")
1345 or die "can't open $dir/$table.$field: $!";
1346 my @array = map { chomp; $_; } <CACHE>;
1357 L<FS::cust_main>, L<FS::Record>