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 and contact phone number
97 push @cust_main, qsearch( {
98 'select' => 'cust_main.*',
99 'table' => 'cust_main',
100 'addl_from' => ' left join contact using (custnum) '.
101 ' left join contact_phone using (contactnum) ',
102 'hashref' => { %options },
103 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
105 join(' OR ', map "$_ = '$phonen'",
106 qw( daytime night mobile fax )
108 " OR phonenum = '$phonenum' ".
110 " AND $agentnums_sql", #agent virtualization
113 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
114 #try looking for matches with extensions unless one was specified
116 push @cust_main, qsearch( {
117 'table' => 'cust_main',
118 'hashref' => { %options },
119 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
121 join(' OR ', map "$_ LIKE '$phonen\%'",
125 " AND $agentnums_sql", #agent virtualization
133 if ( $search =~ /@/ ) { #email address from cust_main_invoice and contact_email
135 push @cust_main, qsearch( {
136 'select' => 'cust_main.*',
137 'table' => 'cust_main',
138 'addl_from' => ' left join cust_main_invoice using (custnum) '.
139 ' left join contact using (custnum) '.
140 ' left join contact_email using (contactnum) ',
141 'hashref' => { %options },
142 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
144 join(' OR ', map "$_ = '$search'",
145 qw( dest emailaddress )
148 " AND $agentnums_sql", #agent virtualization
151 # custnum search (also try agent_custid), with some tweaking options if your
152 # legacy cust "numbers" have letters
153 } elsif ( $search =~ /^\s*(\d+)\s*$/
154 or ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
155 && $search =~ /^\s*(\w\w?\d+)\s*$/
157 or ( $conf->config('cust_main-agent_custid-format') eq 'd+-w'
158 && $search =~ /^\s*(\d+-\w)\s*$/
160 or ( $conf->config('cust_main-custnum-display_special')
161 # it's not currently possible for special prefixes to contain
162 # digits, so just strip off any alphabetic prefix and match
163 # the rest to custnum
164 && $search =~ /^\s*[[:alpha:]]*(\d+)\s*$/
166 or ( $conf->exists('address1-search' )
167 && $search =~ /^\s*(\d+\-?\w*)\s*$/ #i.e. 1234A or 9432-D
174 if ( $num =~ /^(\d+)$/ && $num <= 2147483647 ) { #need a bigint custnum? wow
175 my $agent_custid_null = $conf->exists('cust_main-default_agent_custid')
176 ? ' AND agent_custid IS NULL ' : '';
177 push @cust_main, qsearch( {
178 'table' => 'cust_main',
179 'hashref' => { 'custnum' => $num, %options },
180 'extra_sql' => " AND $agentnums_sql $agent_custid_null",
184 # for all agents this user can see, if any of them have custnum prefixes
185 # that match the search string, include customers that match the rest
186 # of the custnum and belong to that agent
187 foreach my $agentnum ( keys %$agentnums_href ) {
188 my $p = $conf->config('cust_main-custnum-display_prefix', $agentnum);
190 if ( $p eq substr($num, 0, length($p)) ) {
191 push @cust_main, qsearch( {
192 'table' => 'cust_main',
193 'hashref' => { 'custnum' => 0 + substr($num, length($p)),
194 'agentnum' => $agentnum,
201 push @cust_main, qsearch( {
202 'table' => 'cust_main',
203 'hashref' => { 'agent_custid' => $num, %options },
204 'extra_sql' => " AND $agentnums_sql", #agent virtualization
207 if ( $conf->exists('address1-search') ) {
208 my $len = length($num);
210 # probably the Right Thing: return customers that have any associated
211 # locations matching the string, not just bill/ship location
212 push @cust_main, qsearch( {
213 'select' => 'cust_main.*',
214 'table' => 'cust_main',
215 'addl_from' => ' JOIN cust_location USING (custnum) ',
216 'hashref' => { %options, },
218 ( keys(%options) ? ' AND ' : ' WHERE ' ).
219 " LOWER(SUBSTRING(cust_location.address1 FROM 1 FOR $len)) = '$num' ".
220 " AND $agentnums_sql",
224 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
226 my($company, $last, $first) = ( $1, $2, $3 );
228 # "Company (Last, First)"
229 #this is probably something a browser remembered,
230 #so just do an exact search (but case-insensitive, so USPS standardization
231 #doesn't throw a wrench in the works)
233 push @cust_main, qsearch( {
234 'table' => 'cust_main',
235 'hashref' => { %options },
237 ( keys(%options) ? ' AND ' : ' WHERE ' ).
239 " LOWER(first) = ". dbh->quote(lc($first)),
240 " LOWER(last) = ". dbh->quote(lc($last)),
241 " LOWER(company) = ". dbh->quote(lc($company)),
247 # probably not necessary for the "something a browser remembered" case
249 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
250 # try {first,last,company}
254 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
255 # # full strings the browser remembers won't work
256 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
258 use Lingua::EN::NameParse;
259 my $NameParse = new Lingua::EN::NameParse(
264 my($last, $first) = ( '', '' );
265 #maybe disable this too and just rely on NameParse?
266 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
268 ($last, $first) = ( $1, $2 );
270 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
271 } elsif ( ! $NameParse->parse($value) ) {
273 my %name = $NameParse->components;
274 $first = lc($name{'given_name_1'}) || $name{'initials_1'}; #wtf NameParse, Ed?
275 $last = lc($name{'surname_1'});
279 if ( $first && $last ) {
281 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
284 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
285 $sql .= "( (LOWER(cust_main.last) = $q_last AND LOWER(cust_main.first) = $q_first)
286 OR (LOWER(contact.last) = $q_last AND LOWER(contact.first) = $q_first) )";
288 #cust_main and contacts
289 push @cust_main, qsearch( {
290 'select' => 'cust_main.*',
291 'table' => 'cust_main',
292 'addl_from' => ' left join contact using (custnum) ',
293 'hashref' => { %options },
294 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
297 # or it just be something that was typed in... (try that in a sec)
301 my $q_value = dbh->quote($value);
304 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
305 $sql .= " ( LOWER(cust_main.first) = $q_value
306 OR LOWER(cust_main.last) = $q_value
307 OR LOWER(cust_main.company) = $q_value
308 OR LOWER(cust_main.ship_company) = $q_value
309 OR LOWER(contact.first) = $q_value
310 OR LOWER(contact.last) = $q_value
313 #address1 (yes, it's a kludge)
314 $sql .= " OR EXISTS (
315 SELECT 1 FROM cust_location
316 WHERE LOWER(cust_location.address1) = $q_value
317 AND cust_location.custnum = cust_main.custnum
319 if $conf->exists('address1-search');
321 push @cust_main, qsearch( {
322 'select' => 'cust_main.*',
323 'table' => 'cust_main',
324 'addl_from' => ' left join contact using (custnum) ',
325 'hashref' => { %options },
326 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
329 #no exact match, trying substring/fuzzy
330 #always do substring & fuzzy (unless they're explicity config'ed off)
331 #getting complaints searches are not returning enough
332 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
334 #still some false laziness w/search (was search/cust_main.cgi)
337 $FS::CurrentUser::CurrentUser->access_right('List all customers')
342 my @company_hashrefs = ();
343 if ( length($value) >= $min_len ) {
344 @company_hashrefs = (
345 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
346 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
351 if ( $first && $last ) {
354 { 'first' => { op=>'ILIKE', value=>"%$first%" },
355 'last' => { op=>'ILIKE', value=>"%$last%" },
359 } elsif ( length($value) >= $min_len ) {
362 { 'first' => { op=>'ILIKE', value=>"%$value%" }, },
363 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
368 foreach my $hashref ( @company_hashrefs, @hashrefs ) {
370 push @cust_main, qsearch( {
371 'table' => 'cust_main',
372 'hashref' => { %$hashref,
375 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
380 if ( $conf->exists('address1-search') && length($value) >= $min_len ) {
382 push @cust_main, qsearch( {
383 select => 'cust_main.*',
384 table => 'cust_main',
385 addl_from => 'JOIN cust_location USING (custnum)',
386 extra_sql => 'WHERE '.
387 ' cust_location.address1 ILIKE '.dbh->quote("%$value%").
388 " AND $agentnums_sql", #agent virtualizaiton
395 foreach my $hashref ( @hashrefs ) {
398 grep $agentnums_href->{$_->agentnum}, #agent virt
399 grep $_, #skip contacts that don't have cust_main records
402 'table' => 'contact',
403 'hashref' => { %$hashref,
406 #'extra_sql' => " AND $agentnums_sql", #agent virt
413 'hashref' => \%options,
415 'extra_sql' => "WHERE $agentnums_sql", #agent virtualization
418 if ( $first && $last ) {
419 push @cust_main, FS::cust_main::Search->fuzzy_search(
420 { 'last' => $last, #fuzzy hashref
421 'first' => $first }, #
424 push @cust_main, FS::cust_main::Search->fuzzy_search(
425 { 'contact.last' => $last, #fuzzy hashref
426 'contact.first' => $first }, #
431 foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
432 push @cust_main, FS::cust_main::Search->fuzzy_search(
433 { $field => $value },
437 foreach my $field ( 'first', 'last' ) {
438 push @cust_main, FS::cust_main::Search->fuzzy_search(
439 { "contact.$field" => $value },
443 if ( $conf->exists('address1-search') ) {
445 FS::cust_main::Search->fuzzy_search(
446 { 'cust_location.address1' => $value },
455 ( my $nospace_search = $search ) =~ s/\s//g;
456 ( my $card_search = $nospace_search ) =~ s/\-//g;
457 $card_search =~ s/[x\*\.\_]/x/gi;
459 if ( $card_search =~ /^[\dx]{15,16}$/i ) { #credit card search
461 ( my $like_search = $card_search ) =~ s/x/_/g;
462 my $mask_search = FS::payinfo_Mixin->mask_payinfo('CARD', $card_search);
464 push @cust_main, qsearch({
465 'table' => 'cust_main',
467 'extra_sql' => " WHERE ( payinfo LIKE '$like_search'
468 OR paymask = '$mask_search'
470 " AND payby IN ('CARD','DCRD') ".
471 " AND $agentnums_sql", #agent virtulization
477 #eliminate duplicates
479 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
487 Accepts the following options: I<email>, the email address to search for. The
488 email address will be searched for as an email invoice destination and as an
491 #Any additional options are treated as an additional qualifier on the search
494 Returns a (possibly empty) array of FS::cust_main objects (but usually just
502 my $email = delete $options{'email'};
504 #no agent virtualization yet
505 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
509 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
511 my ( $user, $domain ) = ( $1, $2 );
513 warn "$me smart_search: searching for $user in domain $domain"
519 'table' => 'cust_main_invoice',
520 'hashref' => { 'dest' => $email },
527 map $_->cust_svc->cust_pkg,
529 'table' => 'svc_acct',
530 'hashref' => { 'username' => $user, },
532 'AND ( SELECT domain FROM svc_domain
533 WHERE svc_acct.domsvc = svc_domain.svcnum
534 ) = '. dbh->quote($domain),
540 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
542 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
559 Returns a qsearch hash expression to search for parameters specified in
560 HASHREF. Valid parameters are
580 listref of start date, end date
584 listref of start date, end date
586 =item spouse_birthdate
588 listref of start date, end date
590 =item anniversary_date
592 listref of start date, end date
602 =item current_balance
604 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
617 my ($class, $params) = @_;
624 # initialize these to prevent warnings
632 'paydate_year' => '',
633 'invoice_terms' => '',
639 # explicit custnum(s)
642 if ( $params->{'custnum'} ) {
643 my @custnums = ref($params->{'custnum'}) ?
644 @{ $params->{'custnum'} } :
645 $params->{'custnum'};
647 'cust_main.custnum IN (' .
648 join(',', map { $_ =~ /^(\d+)$/ ? $1 : () } @custnums ) .
649 ')' if scalar(@custnums) > 0;
656 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
658 "cust_main.agentnum = $1";
665 if ( $params->{'salesnum'} =~ /^(\d+)$/ ) {
666 push @where, ($1 > 0 ) ? "cust_main.salesnum = $1"
667 : 'cust_main.salesnum IS NULL';
674 if ( $params->{'usernum'} =~ /^(\d+)$/ and $1 ) {
676 "cust_main.usernum = $1";
683 #prospect ordered active inactive suspended cancelled
684 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
685 my $method = $params->{'status'}. '_sql';
686 #push @where, $class->$method();
687 push @where, FS::cust_main->$method();
691 unless ( $params->{location_history} ) {
693 AND ( cust_location.locationnum IN ( cust_main.bill_locationnum,
694 cust_main.ship_locationnum
696 OR cust_location.locationnum IN (
697 SELECT locationnum FROM cust_pkg
698 WHERE cust_pkg.custnum = cust_main.custnum
699 AND locationnum IS NOT NULL
700 AND '. FS::cust_pkg->ncancelled_recurring_sql.'
708 if ( $params->{'address'} ) {
709 # allow this to be an arrayref
710 my @values = ($params->{'address'});
711 @values = @{$values[0]} if ref($values[0]);
713 foreach (grep /\S/, @values) {
714 my $address = dbh->quote('%'. lc($_). '%');
716 "LOWER(cust_location.address1) LIKE $address",
717 "LOWER(cust_location.address2) LIKE $address";
720 push @where, "EXISTS(
721 SELECT 1 FROM cust_location
722 WHERE cust_location.custnum = cust_main.custnum
723 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
745 if ( $params->{'county'} =~ /\S/ ) {
746 my $county = dbh->quote($params->{'county'});
747 push @where, "EXISTS(
748 SELECT 1 FROM cust_location
749 WHERE cust_location.custnum = cust_main.custnum
750 AND cust_location.county = $county
758 if ( $params->{'state'} =~ /\S/ ) {
759 my $state = dbh->quote($params->{'state'});
760 push @where, "EXISTS(
761 SELECT 1 FROM cust_location
762 WHERE cust_location.custnum = cust_main.custnum
763 AND cust_location.state = $state
771 if ( $params->{'zip'} =~ /\S/ ) {
772 my $zip = dbh->quote($params->{'zip'} . '%');
773 push @where, "EXISTS(
774 SELECT 1 FROM cust_location
775 WHERE cust_location.custnum = cust_main.custnum
776 AND cust_location.zip LIKE $zip
784 if ( $params->{'country'} =~ /^(\w\w)$/ ) {
785 my $country = uc($1);
786 push @where, "EXISTS(
787 SELECT 1 FROM cust_location
788 WHERE cust_location.custnum = cust_main.custnum
789 AND cust_location.country = '$country'
797 if ( $params->{'no_censustract'} ) {
798 push @where, "EXISTS(
799 SELECT 1 FROM cust_location
800 WHERE locationnum = cust_main.ship_locationnum
801 AND cust_location.country = 'US'
802 AND ( cust_location.censusyear IS NULL
803 OR cust_location.censusyear != '2020'
812 foreach my $phonet (qw(daytime night mobile fax)) {
813 if ($params->{$phonet}) {
814 $params->{$phonet} =~ s/\D//g;
815 $params->{$phonet} =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
817 my $phonen = "$1-$2-$3";
818 if ($4) { push @where, "cust_main.".$phonet." = '".$phonen." x$4'"; }
819 else { push @where, "cust_main.".$phonet." like '".$phonen."%'"; }
826 if ( $params->{'refnum'} ) {
828 my @refnum = ref( $params->{'refnum'} )
829 ? @{ $params->{'refnum'} }
830 : ( $params->{'refnum'} );
832 @refnum = grep /^(\d*)$/, @refnum;
834 push @where, '( '. join(' OR ', map "cust_main.refnum = $_", @refnum ). ' )'
840 # parse cancelled package checkbox
845 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
846 unless $params->{'cancelled_pkgs'};
849 # "with email address(es)" checkbox
853 'EXISTS ( SELECT 1 FROM cust_main_invoice
854 WHERE cust_main_invoice.custnum = cust_main.custnum
856 )' # AND dest LIKE '%@%'
857 if $params->{'with_email'};
860 # "with postal mail invoices" checkbox
864 "EXISTS ( SELECT 1 FROM cust_main_invoice
865 WHERE cust_main_invoice.custnum = cust_main.custnum
867 if $params->{'POST'};
870 # "without postal mail invoices" checkbox
874 "NOT EXISTS ( SELECT 1 FROM cust_main_invoice
875 WHERE cust_main_invoice.custnum = cust_main.custnum
877 if $params->{'no_POST'};
880 # "tax exempt" checkbox
882 push @where, "cust_main.tax = 'Y'"
886 # "not tax exempt" checkbox
888 push @where, "(cust_main.tax = '' OR cust_main.tax IS NULL )"
889 if $params->{'no_tax'};
894 if ( $params->{with_referrals} =~ /^\s*(\d+)\s*$/ ) {
900 if ( grep { $params->{referral_status} eq $_ } FS::cust_main->statuses() ) {
901 my $method = $params->{referral_status}. '_sql';
902 $and_status = ' AND '. FS::cust_main->$method();
903 $and_status =~ s/ cust_main\./ referred_cust_main./g;
907 " $n <= ( SELECT COUNT(*) FROM cust_main AS referred_cust_main
908 WHERE cust_main.custnum = referred_cust_main.referral_custnum
918 foreach my $field (qw( signupdate birthdate spouse_birthdate anniversary_date )) {
920 next unless exists($params->{$field});
922 my($beginning, $ending, $hour) = @{$params->{$field}};
925 "cust_main.$field IS NOT NULL",
926 "cust_main.$field >= $beginning",
927 "cust_main.$field <= $ending";
929 if($field eq 'signupdate' && defined $hour) {
930 if ($dbh->{Driver}->{Name} =~ /Pg/i) {
931 push @where, "extract(hour from to_timestamp(cust_main.$field)) = $hour";
933 elsif( $dbh->{Driver}->{Name} =~ /mysql/i) {
934 push @where, "hour(from_unixtime(cust_main.$field)) = $hour"
937 warn "search by time of day not supported on ".$dbh->{Driver}->{Name}." databases";
941 $orderby ||= "ORDER BY cust_main.$field";
949 if ( $params->{'classnum'} ) {
951 my @classnum = ref( $params->{'classnum'} )
952 ? @{ $params->{'classnum'} }
953 : ( $params->{'classnum'} );
955 @classnum = grep /^(\d*)$/, @classnum;
958 push @where, '( '. join(' OR ', map {
959 $_ ? "cust_main.classnum = $_"
960 : "cust_main.classnum IS NULL"
973 if ( $params->{'payby'} ) {
975 my @payby = ref( $params->{'payby'} )
976 ? @{ $params->{'payby'} }
977 : ( $params->{'payby'} );
979 @payby = grep /^([A-Z]{4})$/, @payby;
981 push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )'
987 # paydate_year / paydate_month
990 if ( $params->{'paydate_year'} =~ /^(\d{4})$/ ) {
992 $params->{'paydate_month'} =~ /^(\d\d?)$/
993 or die "paydate_year without paydate_month?";
997 'paydate IS NOT NULL',
999 "CAST(paydate AS timestamp) < CAST('$year-$month-01' AS timestamp )"
1007 if ( $params->{'invoice_terms'} =~ /^([\w ]+)$/ ) {
1009 if ( $1 eq 'NULL' ) {
1011 "( cust_main.invoice_terms IS NULL OR cust_main.invoice_terms = '' )";
1014 "cust_main.invoice_terms IS NOT NULL",
1015 "cust_main.invoice_terms = '$1'";
1023 if ( $params->{'current_balance'} ) {
1025 #my $balance_sql = $class->balance_sql();
1026 my $balance_sql = FS::cust_main->balance_sql();
1028 my @current_balance =
1029 ref( $params->{'current_balance'} )
1030 ? @{ $params->{'current_balance'} }
1031 : ( $params->{'current_balance'} );
1033 push @where, map { s/current_balance/$balance_sql/; $_ }
1042 if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
1044 "cust_main.custbatch = '$1'";
1047 if ( $params->{'tagnum'} ) {
1048 my @tagnums = ref( $params->{'tagnum'} ) ? @{ $params->{'tagnum'} } : ( $params->{'tagnum'} );
1050 @tagnums = grep /^(\d+)$/, @tagnums;
1053 if ( $params->{'all_tags'} ) {
1054 my $exists = $params->{'all_tags'} eq 'all' ? 'exists' : 'not exists';
1055 foreach ( @tagnums ) {
1056 push @where, $exists.'(select 1 from cust_tag where '.
1057 'cust_tag.custnum = cust_main.custnum and tagnum = '.
1060 } else { # matching any tag, not all
1061 my $tags_where = "0 < (select count(1) from cust_tag where "
1062 . " cust_tag.custnum = cust_main.custnum and tagnum in ("
1063 . join(',', @tagnums) . "))";
1065 push @where, $tags_where;
1073 if ( $params->{'pkg_classnum'} ) {
1074 my @pkg_classnums = ref( $params->{'pkg_classnum'} ) ?
1075 @{ $params->{'pkg_classnum'} } :
1076 $params->{'pkg_classnum'};
1077 @pkg_classnums = grep /^(\d+)$/, @pkg_classnums;
1079 if ( @pkg_classnums ) {
1082 if ( $params->{'all_pkg_classnums'} ) {
1083 push @pkg_where, "part_pkg.classnum = $_" foreach @pkg_classnums;
1086 'part_pkg.classnum IN('. join(',', @pkg_classnums).')';
1088 foreach (@pkg_where) {
1090 "SELECT 1 FROM cust_pkg JOIN part_pkg USING (pkgpart) WHERE ".
1091 "cust_pkg.custnum = cust_main.custnum AND $_ ";
1092 if ( not $params->{'any_pkg_status'} ) {
1093 $select_pkg .= 'AND '.FS::cust_pkg->active_sql;
1095 push @where, "EXISTS($select_pkg)";
1103 if (keys %{ $params->{'contacts'} }) {
1104 my $contact_params = $params->{'contacts'};
1106 if ($contact_params->{'contacts_firstname'} || $contact_params->{'contacts_lastname'}) {
1107 my $first_query = " AND contact.first = '" . $contact_params->{'contacts_firstname'} . "'"
1108 unless !$contact_params->{'contacts_firstname'};
1109 my $last_query = " AND contact.last = '" . $contact_params->{'contacts_lastname'} . "'"
1110 unless !$contact_params->{'contacts_lastname'};
1112 "EXISTS ( SELECT 1 FROM contact
1113 WHERE contact.custnum = cust_main.custnum
1114 $first_query $last_query
1118 if ($contact_params->{'contacts_email'}) {
1120 "EXISTS ( SELECT 1 FROM contact_email
1121 JOIN contact USING (contactnum)
1122 WHERE contact.custnum = cust_main.custnum
1123 AND contact_email.emailaddress = '" . $contact_params->{'contacts_email'} . "'
1127 if ( grep { /^contacts_phonetypenum(\d+)$/ } keys %{ $contact_params } ) {
1129 foreach my $phone ( grep { /^contacts_phonetypenum(\d+)$/ } keys %{ $contact_params } ) {
1130 $phone =~ /^contacts_phonetypenum(\d+)$/ or die "No phone type num $1 from $phone";
1131 my $phonetypenum = $1;
1132 (my $num = $contact_params->{$phone}) =~ s/\W//g;
1133 if ( $num =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { $contact_params->{$phone} = "$1$2$3"; }
1134 $phone_query .= " AND ( contact_phone.phonetypenum = '".$phonetypenum."' AND contact_phone.phonenum = '" . $contact_params->{$phone} . "' )"
1135 unless !$contact_params->{$phone};
1138 "EXISTS ( SELECT 1 FROM contact_phone
1139 JOIN contact USING (contactnum)
1140 WHERE contact.custnum = cust_main.custnum
1148 # setup queries, subs, etc. for the search
1151 $orderby ||= 'ORDER BY cust_main.custnum';
1153 # here is the agent virtualization
1155 $FS::CurrentUser::CurrentUser->agentnums_sql(table => 'cust_main');
1157 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
1160 # always make address fields available in results
1161 for my $pre ('bill_', 'ship_') {
1163 'LEFT JOIN cust_location AS '.$pre.'location '.
1164 'ON (cust_main.'.$pre.'locationnum = '.$pre.'location.locationnum) ';
1167 # always make referral available in results
1168 # (maybe we should be using FS::UI::Web::join_cust_main instead?)
1169 $addl_from .= ' LEFT JOIN (select refnum, referral from part_referral) AS part_referral_x ON (cust_main.refnum = part_referral_x.refnum) ';
1172 'cust_main.custnum',
1173 'cust_main.salesnum',
1174 # there's a good chance that we'll need these
1175 'cust_main.bill_locationnum',
1176 'cust_main.ship_locationnum',
1177 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
1180 my @extra_headers = ();
1181 my @extra_fields = ();
1182 my @extra_sort_fields = ();
1184 my $count_query = "SELECT COUNT(DISTINCT cust_main.custnum) FROM cust_main $addl_from $extra_sql";
1186 if ($params->{'flattened_pkgs'}) {
1190 ' LEFT JOIN cust_pkg ON ( cust_main.custnum = cust_pkg.custnum ) ';
1192 if ($dbh->{Driver}->{Name} eq 'Pg') {
1197 SELECT pkg FROM cust_pkg LEFT JOIN part_pkg USING ( pkgpart )
1198 WHERE cust_main.custnum = cust_pkg.custnum $pkgwhere
1203 } elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
1204 push @select, "GROUP_CONCAT(part_pkg.pkg SEPARATOR '|') as magic";
1205 $addl_from .= ' LEFT JOIN part_pkg USING ( pkgpart ) ';
1206 #$pkg_join .= ' LEFT JOIN part_pkg USING ( pkgpart ) ';
1208 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
1209 "omitting package information from report.";
1212 my $header_query = "
1213 SELECT COUNT(cust_pkg.custnum = cust_main.custnum) AS count
1214 FROM cust_main $addl_from $extra_sql $pkgwhere
1215 GROUP BY cust_main.custnum ORDER BY count DESC LIMIT 1
1218 my $sth = dbh->prepare($header_query) or die dbh->errstr;
1219 $sth->execute() or die $sth->errstr;
1220 my $headerrow = $sth->fetchrow_arrayref;
1221 my $headercount = $headerrow ? $headerrow->[0] : 0;
1222 while($headercount) {
1223 unshift @extra_headers, "Package ". $headercount;
1224 unshift @extra_fields, eval q!sub {my $c = shift;
1225 my @a = split '\|', $c->magic;
1226 my $p = $a[!.--$headercount. q!];
1229 unshift @extra_sort_fields, '';
1234 if ( $params->{'with_referrals'} ) {
1236 #XXX next: num for each customer status
1239 '( SELECT COUNT(*) FROM cust_main AS referred_cust_main
1240 WHERE cust_main.custnum = referred_cust_main.referral_custnum
1241 ) AS num_referrals';
1243 unshift @extra_headers, 'Referrals';
1244 unshift @extra_fields, 'num_referrals';
1245 unshift @extra_sort_fields, 'num_referrals';
1249 my $select = join(', ', @select);
1252 'table' => 'cust_main',
1253 'select' => $select,
1254 'addl_from' => $addl_from,
1256 'extra_sql' => $extra_sql,
1257 'order_by' => $orderby,
1258 'count_query' => $count_query,
1259 'extra_headers' => \@extra_headers,
1260 'extra_fields' => \@extra_fields,
1261 'extra_sort_fields' => \@extra_sort_fields,
1263 #warn Data::Dumper::Dumper($sql_query);
1268 =item fuzzy_search FUZZY_HASHREF [ OPTS ]
1270 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
1271 records. Currently, I<first>, I<last>, I<company> and/or I<address1> may be
1274 Additional options are the same as FS::Record::qsearch
1281 # sensible defaults, then merge in any passed options
1283 'table' => 'cust_main',
1292 my @fuzzy_mod = 'i';
1293 my $conf = new FS::Conf;
1294 my $fuzziness = $conf->config('fuzzy-fuzziness');
1295 push @fuzzy_mod, $fuzziness if $fuzziness;
1297 check_and_rebuild_fuzzyfiles();
1298 foreach my $field ( keys %$fuzzy ) {
1300 my $all = $self->all_X($field);
1301 next unless scalar(@$all);
1304 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, \@fuzzy_mod, @$all ) );
1305 next if !keys(%match);
1307 my $in_matches = 'IN (' .
1308 join(',', map { dbh->quote($_) } keys %match) .
1311 my $extra_sql = $fuzopts{extra_sql};
1312 if ($extra_sql =~ /^\s*where /i or keys %{ $fuzopts{hashref} }) {
1313 $extra_sql .= ' AND ';
1315 $extra_sql .= 'WHERE ';
1317 $extra_sql .= "$field $in_matches";
1319 my $addl_from = $fuzopts{addl_from};
1320 if ( $field =~ /^cust_location\./ ) {
1321 $addl_from .= ' JOIN cust_location USING (custnum)';
1322 } elsif ( $field =~ /^contact\./ ) {
1323 $addl_from .= ' JOIN contact USING (custnum)';
1326 push @cust_main, qsearch({
1328 'addl_from' => $addl_from,
1329 'extra_sql' => $extra_sql,
1333 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
1335 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
1343 =head1 UTILITY SUBROUTINES
1347 =item check_and_rebuild_fuzzyfiles
1351 sub check_and_rebuild_fuzzyfiles {
1352 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1353 rebuild_fuzzyfiles()
1354 if grep { ! -e "$dir/$_" }
1356 my ($field, $table) = reverse split('\.', $_);
1357 $table ||= 'cust_main';
1363 =item rebuild_fuzzyfiles
1367 sub rebuild_fuzzyfiles {
1369 use Fcntl qw(:flock);
1371 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1372 mkdir $dir, 0700 unless -d $dir;
1374 foreach my $fuzzy ( @fuzzyfields ) {
1376 my ($field, $table) = reverse split('\.', $fuzzy);
1377 $table ||= 'cust_main';
1379 open(LOCK,">>$dir/$table.$field")
1380 or die "can't open $dir/$table.$field: $!";
1382 or die "can't lock $dir/$table.$field: $!";
1384 open (CACHE, '>:encoding(UTF-8)', "$dir/$table.$field.tmp")
1385 or die "can't open $dir/$table.$field.tmp: $!";
1387 my $sth = dbh->prepare(
1388 "SELECT $field FROM $table WHERE $field IS NOT NULL AND $field != ''"
1390 $sth->execute or die $sth->errstr;
1392 while ( my $row = $sth->fetchrow_arrayref ) {
1393 print CACHE $row->[0]. "\n";
1396 close CACHE or die "can't close $dir/$table.$field.tmp: $!";
1398 rename "$dir/$table.$field.tmp", "$dir/$table.$field";
1404 =item append_fuzzyfiles FIRSTNAME LASTNAME COMPANY ADDRESS1
1408 sub append_fuzzyfiles {
1409 #my( $first, $last, $company ) = @_;
1411 check_and_rebuild_fuzzyfiles();
1413 #foreach my $fuzzy (@fuzzyfields) {
1414 foreach my $fuzzy ( 'cust_main.first', 'cust_main.last', 'cust_main.company',
1415 'cust_location.address1',
1416 'cust_main.ship_company',
1419 append_fuzzyfiles_fuzzyfield($fuzzy, shift);
1426 =item append_fuzzyfiles_fuzzyfield COLUMN VALUE
1428 =item append_fuzzyfiles_fuzzyfield TABLE.COLUMN VALUE
1432 use Fcntl qw(:flock);
1433 sub append_fuzzyfiles_fuzzyfield {
1434 my( $fuzzyfield, $value ) = @_;
1436 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1439 my ($field, $table) = reverse split('\.', $fuzzyfield);
1440 $table ||= 'cust_main';
1442 return unless length($value);
1444 open(CACHE, '>>:encoding(UTF-8)', "$dir/$table.$field" )
1445 or die "can't open $dir/$table.$field: $!";
1446 flock(CACHE,LOCK_EX)
1447 or die "can't lock $dir/$table.$field: $!";
1449 print CACHE "$value\n";
1451 flock(CACHE,LOCK_UN)
1452 or die "can't unlock $dir/$table.$field: $!";
1462 my( $self, $fuzzy ) = @_;
1463 my ($field, $table) = reverse split('\.', $fuzzy);
1464 $table ||= 'cust_main';
1466 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1467 open(CACHE, '<:encoding(UTF-8)', "$dir/$table.$field")
1468 or die "can't open $dir/$table.$field: $!";
1469 my @array = map { chomp; $_; } <CACHE>;
1480 L<FS::cust_main>, L<FS::Record>