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 'hashref' => { %options },
101 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
103 join(' OR ', map "$_ = '$phonen'",
104 qw( daytime night mobile fax )
106 " OR phonenum = '$phonenum' ".
108 " AND $agentnums_sql", #agent virtualization
109 'addl_from' => ' left join cust_contact using (custnum) left join contact_phone using (contactnum) ',
112 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
113 #try looking for matches with extensions unless one was specified
115 push @cust_main, qsearch( {
116 'table' => 'cust_main',
117 'hashref' => { %options },
118 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
120 join(' OR ', map "$_ LIKE '$phonen\%'",
124 " AND $agentnums_sql", #agent virtualization
132 if ( $search =~ /@/ ) { #email address from cust_main_invoice and contact_email
134 push @cust_main, qsearch( {
135 'select' => 'cust_main.*',
136 'table' => 'cust_main',
137 'hashref' => { %options },
138 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
140 join(' OR ', map "$_ = '$search'",
141 qw( dest emailaddress )
144 " AND $agentnums_sql", #agent virtualization
145 'addl_from' => ' left join cust_main_invoice using (custnum) left join cust_contact using (custnum) left join contact_email using (contactnum) ',
148 # custnum search (also try agent_custid), with some tweaking options if your
149 # legacy cust "numbers" have letters
150 } elsif ( $search =~ /^\s*(\d+)\s*$/
151 or ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
152 && $search =~ /^\s*(\w\w?\d+)\s*$/
154 or ( $conf->config('cust_main-agent_custid-format') eq 'd+-w'
155 && $search =~ /^\s*(\d+-\w)\s*$/
157 or ( $conf->config('cust_main-custnum-display_special')
158 # it's not currently possible for special prefixes to contain
159 # digits, so just strip off any alphabetic prefix and match
160 # the rest to custnum
161 && $search =~ /^\s*[[:alpha:]]*(\d+)\s*$/
163 or ( $conf->exists('address1-search' )
164 && $search =~ /^\s*(\d+\-?\w*)\s*$/ #i.e. 1234A or 9432-D
171 if ( $num =~ /^(\d+)$/ && $num <= 2147483647 ) { #need a bigint custnum? wow
172 my $agent_custid_null = $conf->exists('cust_main-default_agent_custid')
173 ? ' AND agent_custid IS NULL ' : '';
174 push @cust_main, qsearch( {
175 'table' => 'cust_main',
176 'hashref' => { 'custnum' => $num, %options },
177 'extra_sql' => " AND $agentnums_sql $agent_custid_null",
181 # for all agents this user can see, if any of them have custnum prefixes
182 # that match the search string, include customers that match the rest
183 # of the custnum and belong to that agent
184 foreach my $agentnum ( keys %$agentnums_href ) {
185 my $p = $conf->config('cust_main-custnum-display_prefix', $agentnum);
187 if ( $p eq substr($num, 0, length($p)) ) {
188 push @cust_main, qsearch( {
189 'table' => 'cust_main',
190 'hashref' => { 'custnum' => 0 + substr($num, length($p)),
191 'agentnum' => $agentnum,
198 push @cust_main, qsearch( {
199 'table' => 'cust_main',
200 'hashref' => { 'agent_custid' => $num, %options },
201 'extra_sql' => " AND $agentnums_sql", #agent virtualization
204 if ( $conf->exists('address1-search') ) {
205 my $len = length($num);
207 # probably the Right Thing: return customers that have any associated
208 # locations matching the string, not just bill/ship location
209 push @cust_main, qsearch( {
210 'table' => 'cust_main',
211 'addl_from' => ' JOIN cust_location USING (custnum) ',
212 'hashref' => { %options, },
214 ( keys(%options) ? ' AND ' : ' WHERE ' ).
215 " LOWER(SUBSTRING(cust_location.address1 FROM 1 FOR $len)) = '$num' ".
216 " AND $agentnums_sql",
220 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
222 my($company, $last, $first) = ( $1, $2, $3 );
224 # "Company (Last, First)"
225 #this is probably something a browser remembered,
226 #so just do an exact search (but case-insensitive, so USPS standardization
227 #doesn't throw a wrench in the works)
229 push @cust_main, qsearch( {
230 'table' => 'cust_main',
231 'hashref' => { %options },
233 ( keys(%options) ? ' AND ' : ' WHERE ' ).
235 " LOWER(first) = ". dbh->quote(lc($first)),
236 " LOWER(last) = ". dbh->quote(lc($last)),
237 " LOWER(company) = ". dbh->quote(lc($company)),
243 # probably not necessary for the "something a browser remembered" case
245 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
246 # try {first,last,company}
250 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
251 # # full strings the browser remembers won't work
252 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
254 use Lingua::EN::NameParse;
255 my $NameParse = new Lingua::EN::NameParse(
260 my($last, $first) = ( '', '' );
261 #maybe disable this too and just rely on NameParse?
262 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
264 ($last, $first) = ( $1, $2 );
266 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
267 } elsif ( ! $NameParse->parse($value) ) {
269 my %name = $NameParse->components;
270 $first = lc($name{'given_name_1'}) || $name{'initials_1'}; #wtf NameParse, Ed?
271 $last = lc($name{'surname_1'});
275 if ( $first && $last ) {
277 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
280 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
281 $sql .= "( (LOWER(cust_main.last) = $q_last AND LOWER(cust_main.first) = $q_first)
282 OR (LOWER(contact.last) = $q_last AND LOWER(contact.first) = $q_first) )";
284 #cust_main and contacts
285 push @cust_main, qsearch( {
286 'table' => 'cust_main',
287 'select' => 'cust_main.*',
288 'hashref' => { %options },
289 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
290 'addl_from' => ' left join cust_contact on cust_main.custnum = cust_contact.custnum left join contact using (contactnum) ',
293 # or it just be something that was typed in... (try that in a sec)
297 my $q_value = dbh->quote($value);
300 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
301 $sql .= " ( LOWER(cust_main.first) = $q_value
302 OR LOWER(cust_main.last) = $q_value
303 OR LOWER(cust_main.company) = $q_value
304 OR LOWER(cust_main.ship_company) = $q_value
305 OR LOWER(contact.first) = $q_value
306 OR LOWER(contact.last) = $q_value
309 #address1 (yes, it's a kludge)
310 $sql .= " OR EXISTS (
311 SELECT 1 FROM cust_location
312 WHERE LOWER(cust_location.address1) = $q_value
313 AND cust_location.custnum = cust_main.custnum
315 if $conf->exists('address1-search');
317 push @cust_main, qsearch( {
318 'table' => 'cust_main',
319 'select' => 'cust_main.*',
320 'hashref' => { %options },
321 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
322 'addl_from' => 'left join cust_contact on cust_main.custnum = cust_contact.custnum left join contact using (contactnum) ',
325 #no exact match, trying substring/fuzzy
326 #always do substring & fuzzy (unless they're explicity config'ed off)
327 #getting complaints searches are not returning enough
328 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
330 #still some false laziness w/search (was search/cust_main.cgi)
333 $FS::CurrentUser::CurrentUser->access_right('List all customers')
338 my @company_hashrefs = ();
339 if ( length($value) >= $min_len ) {
340 @company_hashrefs = (
341 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
342 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
347 if ( $first && $last ) {
350 { 'first' => { op=>'ILIKE', value=>"%$first%" },
351 'last' => { op=>'ILIKE', value=>"%$last%" },
355 } elsif ( length($value) >= $min_len ) {
358 { 'first' => { op=>'ILIKE', value=>"%$value%" }, },
359 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
364 foreach my $hashref ( @company_hashrefs, @hashrefs ) {
366 push @cust_main, qsearch( {
367 'table' => 'cust_main',
368 'hashref' => { %$hashref,
371 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
376 if ( $conf->exists('address1-search') && length($value) >= $min_len ) {
378 push @cust_main, qsearch( {
379 table => 'cust_main',
380 addl_from => 'JOIN cust_location USING (custnum)',
381 extra_sql => 'WHERE '.
382 ' cust_location.address1 ILIKE '.dbh->quote("%$value%").
383 " AND $agentnums_sql", #agent virtualizaiton
390 foreach my $hashref ( @hashrefs ) {
393 grep $agentnums_href->{$_->agentnum}, #agent virt
394 grep $_, #skip contacts that don't have cust_main records
397 'table' => 'contact',
398 'hashref' => { %$hashref,
401 #'extra_sql' => " AND $agentnums_sql", #agent virt
408 'hashref' => \%options,
410 'extra_sql' => "WHERE $agentnums_sql", #agent virtualization
413 if ( $first && $last ) {
414 push @cust_main, FS::cust_main::Search->fuzzy_search(
415 { 'last' => $last, #fuzzy hashref
416 'first' => $first }, #
419 push @cust_main, FS::cust_main::Search->fuzzy_search(
420 { 'contact.last' => $last, #fuzzy hashref
421 'contact.first' => $first }, #
426 foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
427 push @cust_main, FS::cust_main::Search->fuzzy_search(
428 { $field => $value },
432 foreach my $field ( 'first', 'last' ) {
433 push @cust_main, FS::cust_main::Search->fuzzy_search(
434 { "contact.$field" => $value },
438 if ( $conf->exists('address1-search') ) {
440 FS::cust_main::Search->fuzzy_search(
441 { 'cust_location.address1' => $value },
450 ( my $nospace_search = $search ) =~ s/\s//g;
451 ( my $card_search = $nospace_search ) =~ s/\-//g;
452 $card_search =~ s/[x\*\.\_]/x/gi;
454 if ( $card_search =~ /^[\dx]{15,16}$/i ) { #credit card search
456 ( my $like_search = $card_search ) =~ s/x/_/g;
457 my $mask_search = FS::payinfo_Mixin->mask_payinfo('CARD', $card_search);
459 push @cust_main, qsearch({
460 'table' => 'cust_main',
461 'addl_from' => ' JOIN cust_payby USING (custnum)',
463 'extra_sql' => " WHERE ( cust_payby.payinfo LIKE '$like_search'
464 OR cust_payby.paymask = '$mask_search'
466 " AND cust_payby.payby IN ('CARD','DCRD') ".
467 " AND $agentnums_sql", #agent virtulization
473 #eliminate duplicates
475 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
483 Accepts the following options: I<email>, the email address to search for. The
484 email address will be searched for as an email invoice destination and as an
487 #Any additional options are treated as an additional qualifier on the search
490 Returns a (possibly empty) array of FS::cust_main objects (but usually just
498 my $email = delete $options{'email'};
500 #no agent virtualization yet
501 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
505 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
507 my ( $user, $domain ) = ( $1, $2 );
509 warn "$me smart_search: searching for $user in domain $domain"
513 map { $_->cust_main }
514 map { $_->cust_contact }
517 'table' => 'contact_email',
518 'hashref' => { 'emailaddress' => $email },
525 map $_->cust_svc->cust_pkg,
527 'table' => 'svc_acct',
528 'hashref' => { 'username' => $user, },
530 'AND ( SELECT domain FROM svc_domain
531 WHERE svc_acct.domsvc = svc_domain.svcnum
532 ) = '. dbh->quote($domain),
538 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
540 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
557 Returns a qsearch hash expression to search for parameters specified in
558 HASHREF. Valid parameters are
578 listref of start date, end date
582 listref of start date, end date
584 =item spouse_birthdate
586 listref of start date, end date
588 =item anniversary_date
590 listref of start date, end date
592 =item current_balance
594 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
607 my ($class, $params) = @_;
614 # initialize these to prevent warnings
622 'invoice_terms' => '',
628 # explicit custnum(s)
631 if ( $params->{'custnum'} ) {
632 my @custnums = ref($params->{'custnum'}) ?
633 @{ $params->{'custnum'} } :
634 $params->{'custnum'};
636 'cust_main.custnum IN (' .
637 join(',', map { $_ =~ /^(\d+)$/ ? $1 : () } @custnums ) .
638 ')' if scalar(@custnums) > 0;
645 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
647 "cust_main.agentnum = $1";
654 if ( $params->{'salesnum'} =~ /^(\d+)$/ ) {
655 push @where, ($1 > 0 ) ? "cust_main.salesnum = $1"
656 : 'cust_main.salesnum IS NULL';
663 if ( $params->{'usernum'} =~ /^(\d+)$/ and $1 ) {
665 "cust_main.usernum = $1";
672 #prospect ordered active inactive suspended cancelled
673 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
674 my $method = $params->{'status'}. '_sql';
675 #push @where, $class->$method();
676 push @where, FS::cust_main->$method();
680 unless ( $params->{location_history} ) {
682 AND ( cust_location.locationnum IN ( cust_main.bill_locationnum,
683 cust_main.ship_locationnum
685 OR cust_location.locationnum IN (
686 SELECT locationnum FROM cust_pkg
687 WHERE cust_pkg.custnum = cust_main.custnum
688 AND locationnum IS NOT NULL
689 AND '. FS::cust_pkg->ncancelled_recurring_sql.'
697 if ( $params->{'address'} ) {
698 # allow this to be an arrayref
699 my @values = ($params->{'address'});
700 @values = @{$values[0]} if ref($values[0]);
702 foreach (grep /\S/, @values) {
703 my $address = dbh->quote('%'. lc($_). '%');
705 "LOWER(cust_location.address1) LIKE $address",
706 "LOWER(cust_location.address2) LIKE $address";
709 push @where, "EXISTS(
710 SELECT 1 FROM cust_location
711 WHERE cust_location.custnum = cust_main.custnum
712 AND (".join(' OR ',@orwhere).")
721 if ( $params->{'city'} =~ /\S/ ) {
722 my $city = dbh->quote($params->{'city'});
723 push @where, "EXISTS(
724 SELECT 1 FROM cust_location
725 WHERE cust_location.custnum = cust_main.custnum
726 AND cust_location.city = $city
734 if ( $params->{'county'} =~ /\S/ ) {
735 my $county = dbh->quote($params->{'county'});
736 push @where, "EXISTS(
737 SELECT 1 FROM cust_location
738 WHERE cust_location.custnum = cust_main.custnum
739 AND cust_location.county = $county
747 if ( $params->{'state'} =~ /\S/ ) {
748 my $state = dbh->quote($params->{'state'});
749 push @where, "EXISTS(
750 SELECT 1 FROM cust_location
751 WHERE cust_location.custnum = cust_main.custnum
752 AND cust_location.state = $state
760 if ( $params->{'zip'} =~ /\S/ ) {
761 my $zip = dbh->quote($params->{'zip'} . '%');
762 push @where, "EXISTS(
763 SELECT 1 FROM cust_location
764 WHERE cust_location.custnum = cust_main.custnum
765 AND cust_location.zip LIKE $zip
773 if ( $params->{'country'} =~ /^(\w\w)$/ ) {
774 my $country = uc($1);
775 push @where, "EXISTS(
776 SELECT 1 FROM cust_location
777 WHERE cust_location.custnum = cust_main.custnum
778 AND cust_location.country = '$country'
786 if ( $params->{'refnum'} ) {
788 my @refnum = ref( $params->{'refnum'} )
789 ? @{ $params->{'refnum'} }
790 : ( $params->{'refnum'} );
792 @refnum = grep /^(\d*)$/, @refnum;
794 push @where, '( '. join(' OR ', map "cust_main.refnum = $_", @refnum ). ' )'
800 # parse cancelled package checkbox
805 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
806 unless $params->{'cancelled_pkgs'};
809 # "with email address(es)" checkbox
813 'EXISTS ( SELECT 1 FROM contact_email
814 JOIN cust_contact USING (contactnum)
815 WHERE cust_contact.custnum = cust_main.custnum
817 if $params->{'with_email'};
820 # "with postal mail invoices" checkbox
823 push @where, "cust_main.postal_invoice = 'Y'"
824 if $params->{'POST'};
827 # "without postal mail invoices" checkbox
830 push @where, "cust_main.postal_invoice IS NULL"
831 if $params->{'no_POST'};
834 # "tax exempt" checkbox
836 push @where, "cust_main.tax = 'Y'"
840 # "not tax exempt" checkbox
842 push @where, "(cust_main.tax = '' OR cust_main.tax IS NULL )"
843 if $params->{'no_tax'};
848 if ( $params->{with_referrals} =~ /^\s*(\d+)\s*$/ ) {
854 if ( grep { $params->{referral_status} eq $_ } FS::cust_main->statuses() ) {
855 my $method = $params->{referral_status}. '_sql';
856 $and_status = ' AND '. FS::cust_main->$method();
857 $and_status =~ s/ cust_main\./ referred_cust_main./g;
861 " $n <= ( SELECT COUNT(*) FROM cust_main AS referred_cust_main
862 WHERE cust_main.custnum = referred_cust_main.referral_custnum
872 foreach my $field (qw( signupdate birthdate spouse_birthdate anniversary_date )) {
874 next unless exists($params->{$field});
876 my($beginning, $ending, $hour) = @{$params->{$field}};
879 "cust_main.$field IS NOT NULL",
880 "cust_main.$field >= $beginning",
881 "cust_main.$field <= $ending";
883 if($field eq 'signupdate' && defined $hour) {
884 if ($dbh->{Driver}->{Name} =~ /Pg/i) {
885 push @where, "extract(hour from to_timestamp(cust_main.$field)) = $hour";
887 elsif( $dbh->{Driver}->{Name} =~ /mysql/i) {
888 push @where, "hour(from_unixtime(cust_main.$field)) = $hour"
891 warn "search by time of day not supported on ".$dbh->{Driver}->{Name}." databases";
895 $orderby ||= "ORDER BY cust_main.$field";
903 if ( $params->{'classnum'} ) {
905 my @classnum = ref( $params->{'classnum'} )
906 ? @{ $params->{'classnum'} }
907 : ( $params->{'classnum'} );
909 @classnum = grep /^(\d*)$/, @classnum;
912 push @where, '( '. join(' OR ', map {
913 $_ ? "cust_main.classnum = $_"
914 : "cust_main.classnum IS NULL"
927 if ( $params->{'invoice_terms'} =~ /^([\w ]+)$/ ) {
929 if ( $1 eq 'NULL' ) {
931 "( cust_main.invoice_terms IS NULL OR cust_main.invoice_terms = '' )";
934 "cust_main.invoice_terms IS NOT NULL",
935 "cust_main.invoice_terms = '$1'";
943 if ( $params->{'current_balance'} ) {
945 #my $balance_sql = $class->balance_sql();
946 my $balance_sql = FS::cust_main->balance_sql();
948 my @current_balance =
949 ref( $params->{'current_balance'} )
950 ? @{ $params->{'current_balance'} }
951 : ( $params->{'current_balance'} );
953 push @where, map { s/current_balance/$balance_sql/; $_ }
962 if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
964 "cust_main.custbatch = '$1'";
967 if ( $params->{'tagnum'} ) {
968 my @tagnums = ref( $params->{'tagnum'} ) ? @{ $params->{'tagnum'} } : ( $params->{'tagnum'} );
970 @tagnums = grep /^(\d+)$/, @tagnums;
973 if ( $params->{'all_tags'} ) {
974 foreach ( @tagnums ) {
975 push @where, 'exists(select 1 from cust_tag where '.
976 'cust_tag.custnum = cust_main.custnum and tagnum = '.
979 } else { # matching any tag, not all
980 my $tags_where = "0 < (select count(1) from cust_tag where "
981 . " cust_tag.custnum = cust_main.custnum and tagnum in ("
982 . join(',', @tagnums) . "))";
984 push @where, $tags_where;
992 if ( $params->{'pkg_classnum'} ) {
993 my @pkg_classnums = ref( $params->{'pkg_classnum'} ) ?
994 @{ $params->{'pkg_classnum'} } :
995 $params->{'pkg_classnum'};
996 @pkg_classnums = grep /^(\d+)$/, @pkg_classnums;
998 if ( @pkg_classnums ) {
1001 if ( $params->{'all_pkg_classnums'} ) {
1002 push @pkg_where, "part_pkg.classnum = $_" foreach @pkg_classnums;
1005 'part_pkg.classnum IN('. join(',', @pkg_classnums).')';
1007 foreach (@pkg_where) {
1009 "SELECT 1 FROM cust_pkg JOIN part_pkg USING (pkgpart) WHERE ".
1010 "cust_pkg.custnum = cust_main.custnum AND $_ ";
1011 if ( not $params->{'any_pkg_status'} ) {
1012 $select_pkg .= 'AND '.FS::cust_pkg->active_sql;
1014 push @where, "EXISTS($select_pkg)";
1020 # setup queries, subs, etc. for the search
1023 $orderby ||= 'ORDER BY custnum';
1025 # here is the agent virtualization
1027 $FS::CurrentUser::CurrentUser->agentnums_sql(table => 'cust_main');
1029 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
1032 # always make address fields available in results
1033 for my $pre ('bill_', 'ship_') {
1035 'LEFT JOIN cust_location AS '.$pre.'location '.
1036 'ON (cust_main.'.$pre.'locationnum = '.$pre.'location.locationnum) ';
1039 # always make referral available in results
1040 # (maybe we should be using FS::UI::Web::join_cust_main instead?)
1041 $addl_from .= ' LEFT JOIN (select refnum, referral from part_referral) AS part_referral_x ON (cust_main.refnum = part_referral_x.refnum) ';
1043 my $count_query = "SELECT COUNT(*) FROM cust_main $addl_from $extra_sql";
1046 'cust_main.custnum',
1047 'cust_main.salesnum',
1048 # there's a good chance that we'll need these
1049 'cust_main.bill_locationnum',
1050 'cust_main.ship_locationnum',
1051 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
1054 my @extra_headers = ();
1055 my @extra_fields = ();
1056 my @extra_sort_fields = ();
1059 if ($params->{'contacts'}) {
1060 my $contact_params = $params->{'contacts'};
1063 ' LEFT JOIN cust_contact ON ( cust_main.custnum = cust_contact.custnum ) ';
1065 if ($contact_params->{'contacts_firstname'} || $contact_params->{'contacts_lastname'}) {
1066 $addl_from .= ' LEFT JOIN contact ON ( cust_contact.contactnum = contact.contactnum ) ';
1067 my $first_query = " AND contact.first = '" . $contact_params->{'contacts_firstname'} . "'"
1068 unless !$contact_params->{'contacts_firstname'};
1069 my $last_query = " AND contact.last = '" . $contact_params->{'contacts_lastname'} . "'"
1070 unless !$contact_params->{'contacts_lastname'};
1071 $extra_sql .= " AND ( '1' $first_query $last_query )";
1074 if ($contact_params->{'contacts_email'}) {
1075 $addl_from .= ' LEFT JOIN contact_email ON ( cust_contact.contactnum = contact_email.contactnum ) ';
1076 $extra_sql .= " AND ( contact_email.emailaddress = '" . $contact_params->{'contacts_email'} . "' )";
1079 if ($contact_params->{'contacts_homephone'} || $contact_params->{'contacts_workphone'} || $contact_params->{'contacts_mobilephone'}) {
1080 $addl_from .= ' LEFT JOIN contact_phone ON ( cust_contact.contactnum = contact_phone.contactnum ) ';
1081 my $contacts_mobilephone;
1082 foreach my $phone (qw( contacts_homephone contacts_workphone contacts_mobilephone )) {
1083 (my $num = $contact_params->{$phone}) =~ s/\W//g;
1084 if ( $num =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { $contact_params->{$phone} = "$1$2$3"; }
1086 my $home_query = " AND ( contact_phone.phonetypenum = '2' AND contact_phone.phonenum = '" . $contact_params->{'contacts_homephone'} . "' )"
1087 unless !$contact_params->{'contacts_homephone'};
1088 my $work_query = " AND ( contact_phone.phonetypenum = '1' AND contact_phone.phonenum = '" . $contact_params->{'contacts_workphone'} . "' )"
1089 unless !$contact_params->{'contacts_workphone'};
1090 my $mobile_query = " AND ( contact_phone.phonetypenum = '3' AND contact_phone.phonenum = '" . $contact_params->{'contacts_mobilephone'} . "' )"
1091 unless !$contact_params->{'contacts_mobilephone'};
1092 $extra_sql .= " AND ( '1' $home_query $work_query $mobile_query )";
1097 if ($params->{'flattened_pkgs'}) {
1101 ' LEFT JOIN cust_pkg ON ( cust_main.custnum = cust_pkg.custnum ) ';
1103 if ($dbh->{Driver}->{Name} eq 'Pg') {
1108 SELECT pkg FROM cust_pkg LEFT JOIN part_pkg USING ( pkgpart )
1109 WHERE cust_main.custnum = cust_pkg.custnum $pkgwhere
1114 } elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
1115 push @select, "GROUP_CONCAT(part_pkg.pkg SEPARATOR '|') as magic";
1116 $addl_from .= ' LEFT JOIN part_pkg USING ( pkgpart ) ';
1117 #$pkg_join .= ' LEFT JOIN part_pkg USING ( pkgpart ) ';
1119 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
1120 "omitting package information from report.";
1123 my $header_query = "
1124 SELECT COUNT(cust_pkg.custnum = cust_main.custnum) AS count
1125 FROM cust_main $addl_from $extra_sql $pkgwhere
1126 GROUP BY cust_main.custnum ORDER BY count DESC LIMIT 1
1129 my $sth = dbh->prepare($header_query) or die dbh->errstr;
1130 $sth->execute() or die $sth->errstr;
1131 my $headerrow = $sth->fetchrow_arrayref;
1132 my $headercount = $headerrow ? $headerrow->[0] : 0;
1133 while($headercount) {
1134 unshift @extra_headers, "Package ". $headercount;
1135 unshift @extra_fields, eval q!sub {my $c = shift;
1136 my @a = split '\|', $c->magic;
1137 my $p = $a[!.--$headercount. q!];
1140 unshift @extra_sort_fields, '';
1145 if ( $params->{'with_referrals'} ) {
1147 #XXX next: num for each customer status
1150 '( SELECT COUNT(*) FROM cust_main AS referred_cust_main
1151 WHERE cust_main.custnum = referred_cust_main.referral_custnum
1152 ) AS num_referrals';
1154 unshift @extra_headers, 'Referrals';
1155 unshift @extra_fields, 'num_referrals';
1156 unshift @extra_sort_fields, 'num_referrals';
1160 my $select = join(', ', @select);
1163 'table' => 'cust_main',
1164 'select' => $select,
1165 'addl_from' => $addl_from,
1167 'extra_sql' => $extra_sql,
1168 'order_by' => $orderby,
1169 'count_query' => $count_query,
1170 'extra_headers' => \@extra_headers,
1171 'extra_fields' => \@extra_fields,
1172 'extra_sort_fields' => \@extra_sort_fields,
1178 =item fuzzy_search FUZZY_HASHREF [ OPTS ]
1180 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
1181 records. Currently, I<first>, I<last>, I<company> and/or I<address1> may be
1184 Additional options are the same as FS::Record::qsearch
1191 # sensible defaults, then merge in any passed options
1193 'table' => 'cust_main',
1202 my @fuzzy_mod = 'i';
1203 my $conf = new FS::Conf;
1204 my $fuzziness = $conf->config('fuzzy-fuzziness');
1205 push @fuzzy_mod, $fuzziness if $fuzziness;
1207 check_and_rebuild_fuzzyfiles();
1208 foreach my $field ( keys %$fuzzy ) {
1210 my $all = $self->all_X($field);
1211 next unless scalar(@$all);
1214 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, \@fuzzy_mod, @$all ) );
1215 next if !keys(%match);
1217 my $in_matches = 'IN (' .
1218 join(',', map { dbh->quote($_) } keys %match) .
1221 my $extra_sql = $fuzopts{extra_sql};
1222 if ($extra_sql =~ /^\s*where /i or keys %{ $fuzopts{hashref} }) {
1223 $extra_sql .= ' AND ';
1225 $extra_sql .= 'WHERE ';
1227 $extra_sql .= "$field $in_matches";
1229 my $addl_from = $fuzopts{addl_from};
1230 if ( $field =~ /^cust_location\./ ) {
1231 $addl_from .= ' JOIN cust_location USING (custnum)';
1232 } elsif ( $field =~ /^contact\./ ) {
1233 $addl_from .= ' JOIN contact USING (custnum)';
1236 push @cust_main, qsearch({
1238 'addl_from' => $addl_from,
1239 'extra_sql' => $extra_sql,
1243 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
1245 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
1253 =head1 UTILITY SUBROUTINES
1257 =item check_and_rebuild_fuzzyfiles
1261 sub check_and_rebuild_fuzzyfiles {
1262 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1263 rebuild_fuzzyfiles()
1264 if grep { ! -e "$dir/$_" }
1266 my ($field, $table) = reverse split('\.', $_);
1267 $table ||= 'cust_main';
1273 =item rebuild_fuzzyfiles
1277 sub rebuild_fuzzyfiles {
1279 use Fcntl qw(:flock);
1281 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1282 mkdir $dir, 0700 unless -d $dir;
1284 foreach my $fuzzy ( @fuzzyfields ) {
1286 my ($field, $table) = reverse split('\.', $fuzzy);
1287 $table ||= 'cust_main';
1289 open(LOCK,">>$dir/$table.$field")
1290 or die "can't open $dir/$table.$field: $!";
1292 or die "can't lock $dir/$table.$field: $!";
1294 open (CACHE, '>:encoding(UTF-8)', "$dir/$table.$field.tmp")
1295 or die "can't open $dir/$table.$field.tmp: $!";
1297 my $sth = dbh->prepare(
1298 "SELECT $field FROM $table WHERE $field IS NOT NULL AND $field != ''"
1300 $sth->execute or die $sth->errstr;
1302 while ( my $row = $sth->fetchrow_arrayref ) {
1303 print CACHE $row->[0]. "\n";
1306 close CACHE or die "can't close $dir/$table.$field.tmp: $!";
1308 rename "$dir/$table.$field.tmp", "$dir/$table.$field";
1314 =item append_fuzzyfiles FIRSTNAME LASTNAME COMPANY ADDRESS1
1318 sub append_fuzzyfiles {
1319 #my( $first, $last, $company ) = @_;
1321 check_and_rebuild_fuzzyfiles();
1323 #foreach my $fuzzy (@fuzzyfields) {
1324 foreach my $fuzzy ( 'cust_main.first', 'cust_main.last', 'cust_main.company',
1325 'cust_location.address1',
1326 'cust_main.ship_company',
1329 append_fuzzyfiles_fuzzyfield($fuzzy, shift);
1336 =item append_fuzzyfiles_fuzzyfield COLUMN VALUE
1338 =item append_fuzzyfiles_fuzzyfield TABLE.COLUMN VALUE
1342 use Fcntl qw(:flock);
1343 sub append_fuzzyfiles_fuzzyfield {
1344 my( $fuzzyfield, $value ) = @_;
1346 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1349 my ($field, $table) = reverse split('\.', $fuzzyfield);
1350 $table ||= 'cust_main';
1352 return unless defined($value) && length($value);
1354 open(CACHE, '>>:encoding(UTF-8)', "$dir/$table.$field" )
1355 or die "can't open $dir/$table.$field: $!";
1356 flock(CACHE,LOCK_EX)
1357 or die "can't lock $dir/$table.$field: $!";
1359 print CACHE "$value\n";
1361 flock(CACHE,LOCK_UN)
1362 or die "can't unlock $dir/$table.$field: $!";
1372 my( $self, $fuzzy ) = @_;
1373 my ($field, $table) = reverse split('\.', $fuzzy);
1374 $table ||= 'cust_main';
1376 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1377 open(CACHE, '<:encoding(UTF-8)', "$dir/$table.$field")
1378 or die "can't open $dir/$table.$field: $!";
1379 my @array = map { chomp; $_; } <CACHE>;
1390 L<FS::cust_main>, L<FS::Record>