1 package FS::cust_main::Search;
5 use base qw( Exporter );
6 use vars qw( @EXPORT_OK $DEBUG $me $conf @fuzzyfields );
7 use String::Approx qw(amatch);
9 use FS::Record qw( qsearch );
11 use FS::cust_main_invoice;
13 use FS::payinfo_Mixin;
15 @EXPORT_OK = qw( smart_search );
17 # 1 is mostly method/subroutine entry and options
18 # 2 traces progress of some operations
19 # 3 is even more information including possibly sensitive data
21 $me = '[FS::cust_main::Search]';
24 'cust_main.first', 'cust_main.last', 'cust_main.company',
25 'cust_main.ship_company', # if you're using it
26 'cust_location.address1',
27 'contact.first', 'contact.last',
30 install_callback FS::UID sub {
32 #yes, need it for stuff below (prolly should be cached)
37 FS::cust_main::Search - Customer searching
41 use FS::cust_main::Search;
43 FS::cust_main::Search::smart_search(%options);
45 FS::cust_main::Search::email_search(%options);
47 FS::cust_main::Search->search( \%options );
49 FS::cust_main::Search->fuzzy_search( \%fuzzy_hashref );
55 =item smart_search OPTION => VALUE ...
57 Accepts the following options: I<search>, the string to search for. The string
58 will be searched for as a customer number, phone number, name or company name,
59 address (if address1-search is on), invoicing email address, or credit card
62 Searches match as an exact, or, in some cases, a substring or fuzzy match (see
63 the source code for the exact heuristics used); I<no_fuzzy_on_exact>, causes
65 skip fuzzy matching when an exact match is found.
67 Any additional options are treated as an additional qualifier on the search
70 Returns a (possibly empty) array of FS::cust_main objects.
77 #here is the agent virtualization
79 $FS::CurrentUser::CurrentUser->agentnums_sql(table => 'cust_main');
80 my $agentnums_href = $FS::CurrentUser::CurrentUser->agentnums_href;
84 my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
85 my $search = delete $options{'search'};
86 ( my $alphanum_search = $search ) =~ s/\W//g;
88 if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
90 #false laziness w/Record::ut_phone
91 my $phonen = "$1-$2-$3";
92 $phonen .= " x$4" if $4;
94 my $phonenum = "$1$2$3";
97 #cust_main phone numbers and contact phone number
98 push @cust_main, qsearch( {
99 'select' => 'cust_main.*',
100 'table' => 'cust_main',
101 'addl_from' => ' left join cust_contact using (custnum) '.
102 ' left join contact_phone using (contactnum) ',
103 'hashref' => { %options },
104 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
106 join(' OR ', map "$_ = '$phonen'",
107 qw( daytime night mobile fax )
109 " OR phonenum = '$phonenum' ".
111 " AND $agentnums_sql", #agent virtualization
114 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
115 #try looking for matches with extensions unless one was specified
117 push @cust_main, qsearch( {
118 'table' => 'cust_main',
119 'hashref' => { %options },
120 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
122 join(' OR ', map "$_ LIKE '$phonen\%'",
126 " AND $agentnums_sql", #agent virtualization
134 if ( $search =~ /@/ ) { #email address from cust_main_invoice and contact_email
136 push @cust_main, qsearch( {
137 'select' => 'cust_main.*',
138 'table' => 'cust_main',
139 'addl_from' => ' left join cust_main_invoice using (custnum) '.
140 ' left join cust_contact using (custnum) '.
141 ' left join contact_email using (contactnum) ',
142 'hashref' => { %options },
143 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
145 join(' OR ', map "$_ = '$search'",
146 qw( dest emailaddress )
149 " AND $agentnums_sql", #agent virtualization
152 # custnum search (also try agent_custid), with some tweaking options if your
153 # legacy cust "numbers" have letters
154 } elsif ( $search =~ /^\s*(\d+)\s*$/
155 or ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
156 && $search =~ /^\s*(\w\w?\d+)\s*$/
158 or ( $conf->config('cust_main-agent_custid-format') eq 'd+-w'
159 && $search =~ /^\s*(\d+-\w)\s*$/
161 or ( $conf->config('cust_main-custnum-display_special')
162 # it's not currently possible for special prefixes to contain
163 # digits, so just strip off any alphabetic prefix and match
164 # the rest to custnum
165 && $search =~ /^\s*[[:alpha:]]*(\d+)\s*$/
167 or ( $conf->exists('address1-search' )
168 && $search =~ /^\s*(\d+\-?\w*)\s*$/ #i.e. 1234A or 9432-D
175 if ( $num =~ /^(\d+)$/ && $num <= 2147483647 ) { #need a bigint custnum? wow
176 my $agent_custid_null = $conf->exists('cust_main-default_agent_custid')
177 ? ' AND agent_custid IS NULL ' : '';
178 push @cust_main, qsearch( {
179 'table' => 'cust_main',
180 'hashref' => { 'custnum' => $num, %options },
181 'extra_sql' => " AND $agentnums_sql $agent_custid_null",
185 # for all agents this user can see, if any of them have custnum prefixes
186 # that match the search string, include customers that match the rest
187 # of the custnum and belong to that agent
188 foreach my $agentnum ( keys %$agentnums_href ) {
189 my $p = $conf->config('cust_main-custnum-display_prefix', $agentnum);
191 if ( $p eq substr($num, 0, length($p)) ) {
192 push @cust_main, qsearch( {
193 'table' => 'cust_main',
194 'hashref' => { 'custnum' => 0 + substr($num, length($p)),
195 'agentnum' => $agentnum,
202 push @cust_main, qsearch( {
203 'table' => 'cust_main',
204 'hashref' => { 'agent_custid' => $num, %options },
205 'extra_sql' => " AND $agentnums_sql", #agent virtualization
208 if ( $conf->exists('address1-search') ) {
209 my $len = length($num);
211 # probably the Right Thing: return customers that have any associated
212 # locations matching the string, not just bill/ship location
213 push @cust_main, qsearch( {
214 'select' => 'cust_main.*',
215 'table' => 'cust_main',
216 'addl_from' => ' JOIN cust_location USING (custnum) ',
217 'hashref' => { %options, },
219 ( keys(%options) ? ' AND ' : ' WHERE ' ).
220 " LOWER(SUBSTRING(cust_location.address1 FROM 1 FOR $len)) = '$num' ".
221 " AND $agentnums_sql",
225 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
227 my($company, $last, $first) = ( $1, $2, $3 );
229 # "Company (Last, First)"
230 #this is probably something a browser remembered,
231 #so just do an exact search (but case-insensitive, so USPS standardization
232 #doesn't throw a wrench in the works)
234 push @cust_main, qsearch( {
235 'table' => 'cust_main',
236 'hashref' => { %options },
238 ( keys(%options) ? ' AND ' : ' WHERE ' ).
240 " LOWER(first) = ". dbh->quote(lc($first)),
241 " LOWER(last) = ". dbh->quote(lc($last)),
242 " LOWER(company) = ". dbh->quote(lc($company)),
248 # probably not necessary for the "something a browser remembered" case
250 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
251 # try {first,last,company}
255 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
256 # # full strings the browser remembers won't work
257 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
259 use Lingua::EN::NameParse;
260 my $NameParse = new Lingua::EN::NameParse(
265 my($last, $first) = ( '', '' );
266 #maybe disable this too and just rely on NameParse?
267 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
269 ($last, $first) = ( $1, $2 );
271 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
272 } elsif ( ! $NameParse->parse($value) ) {
274 my %name = $NameParse->components;
275 $first = lc($name{'given_name_1'}) || $name{'initials_1'}; #wtf NameParse, Ed?
276 $last = lc($name{'surname_1'});
280 if ( $first && $last ) {
282 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
285 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
286 $sql .= "( (LOWER(cust_main.last) = $q_last AND LOWER(cust_main.first) = $q_first)
287 OR (LOWER(contact.last) = $q_last AND LOWER(contact.first) = $q_first) )";
289 #cust_main and contacts
290 push @cust_main, qsearch( {
291 'select' => 'cust_main.*',
292 'table' => 'cust_main',
293 'addl_from' => ' left join cust_contact using (custnum) '.
294 ' left join contact using (contactnum) ',
295 'hashref' => { %options },
296 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
299 # or it just be something that was typed in... (try that in a sec)
303 my $q_value = dbh->quote($value);
306 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
307 $sql .= " ( LOWER(cust_main.first) = $q_value
308 OR LOWER(cust_main.last) = $q_value
309 OR LOWER(cust_main.company) = $q_value
310 OR LOWER(cust_main.ship_company) = $q_value
311 OR LOWER(contact.first) = $q_value
312 OR LOWER(contact.last) = $q_value
315 #address1 (yes, it's a kludge)
316 $sql .= " OR EXISTS (
317 SELECT 1 FROM cust_location
318 WHERE LOWER(cust_location.address1) = $q_value
319 AND cust_location.custnum = cust_main.custnum
321 if $conf->exists('address1-search');
323 push @cust_main, qsearch( {
324 'select' => 'cust_main.*',
325 'table' => 'cust_main',
326 'addl_from' => ' left join cust_contact using (custnum) '.
327 ' left join contact using (contactnum) ',
328 'hashref' => { %options },
329 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
332 #no exact match, trying substring/fuzzy
333 #always do substring & fuzzy (unless they're explicity config'ed off)
334 #getting complaints searches are not returning enough
335 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
337 #still some false laziness w/search (was search/cust_main.cgi)
340 $FS::CurrentUser::CurrentUser->access_right('List all customers')
345 my @company_hashrefs = ();
346 if ( length($value) >= $min_len ) {
347 @company_hashrefs = (
348 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
349 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
354 if ( $first && $last ) {
357 { 'first' => { op=>'ILIKE', value=>"%$first%" },
358 'last' => { op=>'ILIKE', value=>"%$last%" },
362 } elsif ( length($value) >= $min_len ) {
365 { 'first' => { op=>'ILIKE', value=>"%$value%" }, },
366 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
371 foreach my $hashref ( @company_hashrefs, @hashrefs ) {
373 push @cust_main, qsearch( {
374 'table' => 'cust_main',
375 'hashref' => { %$hashref,
378 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
383 if ( $conf->exists('address1-search') && length($value) >= $min_len ) {
385 push @cust_main, qsearch( {
386 table => 'cust_main',
387 addl_from => 'JOIN cust_location USING (custnum)',
388 extra_sql => 'WHERE '.
389 ' cust_location.address1 ILIKE '.dbh->quote("%$value%").
390 " AND $agentnums_sql", #agent virtualizaiton
397 foreach my $hashref ( @hashrefs ) {
400 grep $agentnums_href->{$_->agentnum}, #agent virt
401 grep $_, #skip contacts that don't have cust_main records
404 'table' => 'contact',
405 'hashref' => { %$hashref,
408 #'extra_sql' => " AND $agentnums_sql", #agent virt
415 'hashref' => \%options,
417 'extra_sql' => "WHERE $agentnums_sql", #agent virtualization
420 if ( $first && $last ) {
421 push @cust_main, FS::cust_main::Search->fuzzy_search(
422 { 'last' => $last, #fuzzy hashref
423 'first' => $first }, #
426 push @cust_main, FS::cust_main::Search->fuzzy_search(
427 { 'contact.last' => $last, #fuzzy hashref
428 'contact.first' => $first }, #
433 foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
434 push @cust_main, FS::cust_main::Search->fuzzy_search(
435 { $field => $value },
439 foreach my $field ( 'first', 'last' ) {
440 push @cust_main, FS::cust_main::Search->fuzzy_search(
441 { "contact.$field" => $value },
445 if ( $conf->exists('address1-search') ) {
447 FS::cust_main::Search->fuzzy_search(
448 { 'cust_location.address1' => $value },
457 ( my $nospace_search = $search ) =~ s/\s//g;
458 ( my $card_search = $nospace_search ) =~ s/\-//g;
459 $card_search =~ s/[x\*\.\_]/x/gi;
461 if ( $card_search =~ /^[\dx]{15,16}$/i ) { #credit card search
463 ( my $like_search = $card_search ) =~ s/x/_/g;
464 my $mask_search = FS::payinfo_Mixin->mask_payinfo('CARD', $card_search);
466 push @cust_main, qsearch({
467 'table' => 'cust_main',
468 'addl_from' => ' JOIN cust_payby USING (custnum)',
470 'extra_sql' => " WHERE ( cust_payby.payinfo LIKE '$like_search'
471 OR cust_payby.paymask = '$mask_search'
473 " AND cust_payby.payby IN ('CARD','DCRD') ".
474 " AND $agentnums_sql", #agent virtulization
480 #eliminate duplicates
482 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
490 Accepts the following options: I<email>, the email address to search for. The
491 email address will be searched for as an email invoice destination and as an
494 #Any additional options are treated as an additional qualifier on the search
497 Returns a (possibly empty) array of FS::cust_main objects (but usually just
505 my $email = delete $options{'email'};
507 #no agent virtualization yet
508 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
512 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
514 my ( $user, $domain ) = ( $1, $2 );
516 warn "$me smart_search: searching for $user in domain $domain"
520 map { $_->cust_main }
521 map { $_->cust_contact }
524 'table' => 'contact_email',
525 'hashref' => { 'emailaddress' => $email },
532 map $_->cust_svc->cust_pkg,
534 'table' => 'svc_acct',
535 'hashref' => { 'username' => $user, },
537 'AND ( SELECT domain FROM svc_domain
538 WHERE svc_acct.domsvc = svc_domain.svcnum
539 ) = '. dbh->quote($domain),
545 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
547 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
564 Returns a qsearch hash expression to search for parameters specified in
565 HASHREF. Valid parameters are
585 listref of start date, end date
589 listref of start date, end date
591 =item spouse_birthdate
593 listref of start date, end date
595 =item anniversary_date
597 listref of start date, end date
599 =item current_balance
601 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
614 my ($class, $params) = @_;
621 # initialize these to prevent warnings
629 'invoice_terms' => '',
635 # explicit custnum(s)
638 if ( $params->{'custnum'} ) {
639 my @custnums = ref($params->{'custnum'}) ?
640 @{ $params->{'custnum'} } :
641 $params->{'custnum'};
643 'cust_main.custnum IN (' .
644 join(',', map { $_ =~ /^(\d+)$/ ? $1 : () } @custnums ) .
645 ')' if scalar(@custnums) > 0;
652 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
654 "cust_main.agentnum = $1";
661 if ( $params->{'salesnum'} =~ /^(\d+)$/ ) {
662 push @where, ($1 > 0 ) ? "cust_main.salesnum = $1"
663 : 'cust_main.salesnum IS NULL';
670 if ( $params->{'usernum'} =~ /^(\d+)$/ and $1 ) {
672 "cust_main.usernum = $1";
679 #prospect ordered active inactive suspended cancelled
680 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
681 my $method = $params->{'status'}. '_sql';
682 #push @where, $class->$method();
683 push @where, FS::cust_main->$method();
687 unless ( $params->{location_history} ) {
689 AND ( cust_location.locationnum IN ( cust_main.bill_locationnum,
690 cust_main.ship_locationnum
692 OR cust_location.locationnum IN (
693 SELECT locationnum FROM cust_pkg
694 WHERE cust_pkg.custnum = cust_main.custnum
695 AND locationnum IS NOT NULL
696 AND '. FS::cust_pkg->ncancelled_recurring_sql.'
704 if ( $params->{'address'} ) {
705 # allow this to be an arrayref
706 my @values = ($params->{'address'});
707 @values = @{$values[0]} if ref($values[0]);
709 foreach (grep /\S/, @values) {
710 my $address = dbh->quote('%'. lc($_). '%');
712 "LOWER(cust_location.address1) LIKE $address",
713 "LOWER(cust_location.address2) LIKE $address";
716 push @where, "EXISTS(
717 SELECT 1 FROM cust_location
718 WHERE cust_location.custnum = cust_main.custnum
719 AND (".join(' OR ',@orwhere).")
728 if ( $params->{'city'} =~ /\S/ ) {
729 my $city = dbh->quote($params->{'city'});
730 push @where, "EXISTS(
731 SELECT 1 FROM cust_location
732 WHERE cust_location.custnum = cust_main.custnum
733 AND cust_location.city = $city
741 if ( $params->{'county'} =~ /\S/ ) {
742 my $county = dbh->quote($params->{'county'});
743 push @where, "EXISTS(
744 SELECT 1 FROM cust_location
745 WHERE cust_location.custnum = cust_main.custnum
746 AND cust_location.county = $county
754 if ( $params->{'state'} =~ /\S/ ) {
755 my $state = dbh->quote($params->{'state'});
756 push @where, "EXISTS(
757 SELECT 1 FROM cust_location
758 WHERE cust_location.custnum = cust_main.custnum
759 AND cust_location.state = $state
767 if ( $params->{'zip'} =~ /\S/ ) {
768 my $zip = dbh->quote($params->{'zip'} . '%');
769 push @where, "EXISTS(
770 SELECT 1 FROM cust_location
771 WHERE cust_location.custnum = cust_main.custnum
772 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'
793 if ( $params->{'refnum'} ) {
795 my @refnum = ref( $params->{'refnum'} )
796 ? @{ $params->{'refnum'} }
797 : ( $params->{'refnum'} );
799 @refnum = grep /^(\d*)$/, @refnum;
801 push @where, '( '. join(' OR ', map "cust_main.refnum = $_", @refnum ). ' )'
807 # parse cancelled package checkbox
812 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
813 unless $params->{'cancelled_pkgs'};
816 # "with email address(es)" checkbox,
817 # also optionally: with_email_dest and with_contact_type
820 if ($params->{with_email}) {
823 my $contact_type_sql;
825 if ($params->{with_email_dest}) {
826 croak unless ref $params->{with_email_dest} eq 'ARRAY';
828 @email_dest = @{$params->{with_email_dest}};
831 join(' OR ',map(" cust_contact.${_}_dest IS NOT NULL ", @email_dest)).
833 # Can't use message_dist = 'Y' because single quotes are escaped later
835 if ($params->{with_contact_type}) {
836 croak unless ref $params->{with_contact_type} eq 'ARRAY';
838 my @contact_type = grep {/^\d+$/ && $_ > 0} @{$params->{with_contact_type}};
839 my $has_null_type = 0;
840 $has_null_type = 1 if grep { $_ eq 0 } @{$params->{with_contact_type}};
842 if ($has_null_type) {
843 $hnt_sql = ' OR ' if @contact_type;
844 $hnt_sql .= ' cust_contact.classnum IS NULL ';
849 join(' OR ', map(" cust_contact.classnum = $_ ", @contact_type)).
854 "EXISTS ( SELECT 1 FROM contact_email
855 JOIN cust_contact USING (contactnum)
856 WHERE cust_contact.custnum = cust_main.custnum
863 # "with postal mail invoices" checkbox
866 push @where, "cust_main.postal_invoice = 'Y'"
867 if $params->{'POST'};
870 # "without postal mail invoices" checkbox
873 push @where, "cust_main.postal_invoice IS NULL"
874 if $params->{'no_POST'};
877 # "tax exempt" checkbox
879 push @where, "cust_main.tax = 'Y'"
883 # "not tax exempt" checkbox
885 push @where, "(cust_main.tax = '' OR cust_main.tax IS NULL )"
886 if $params->{'no_tax'};
891 if ( $params->{with_referrals} =~ /^\s*(\d+)\s*$/ ) {
897 if ( grep { $params->{referral_status} eq $_ } FS::cust_main->statuses() ) {
898 my $method = $params->{referral_status}. '_sql';
899 $and_status = ' AND '. FS::cust_main->$method();
900 $and_status =~ s/ cust_main\./ referred_cust_main./g;
904 " $n <= ( SELECT COUNT(*) FROM cust_main AS referred_cust_main
905 WHERE cust_main.custnum = referred_cust_main.referral_custnum
915 foreach my $field (qw( signupdate birthdate spouse_birthdate anniversary_date )) {
917 next unless exists($params->{$field});
919 my($beginning, $ending, $hour) = @{$params->{$field}};
922 "cust_main.$field IS NOT NULL",
923 "cust_main.$field >= $beginning",
924 "cust_main.$field <= $ending";
926 if($field eq 'signupdate' && defined $hour) {
927 if ($dbh->{Driver}->{Name} =~ /Pg/i) {
928 push @where, "extract(hour from to_timestamp(cust_main.$field)) = $hour";
930 elsif( $dbh->{Driver}->{Name} =~ /mysql/i) {
931 push @where, "hour(from_unixtime(cust_main.$field)) = $hour"
934 warn "search by time of day not supported on ".$dbh->{Driver}->{Name}." databases";
938 $orderby ||= "ORDER BY cust_main.$field";
946 if ( $params->{'classnum'} ) {
948 my @classnum = ref( $params->{'classnum'} )
949 ? @{ $params->{'classnum'} }
950 : ( $params->{'classnum'} );
952 @classnum = grep /^(\d*)$/, @classnum;
955 push @where, '( '. join(' OR ', map {
956 $_ ? "cust_main.classnum = $_"
957 : "cust_main.classnum IS NULL"
970 if ( $params->{'invoice_terms'} =~ /^([\w ]+)$/ ) {
972 if ( $1 eq 'NULL' ) {
974 "( cust_main.invoice_terms IS NULL OR cust_main.invoice_terms = '' )";
977 "cust_main.invoice_terms IS NOT NULL",
978 "cust_main.invoice_terms = '$1'";
986 if ( $params->{'current_balance'} ) {
988 #my $balance_sql = $class->balance_sql();
989 my $balance_sql = FS::cust_main->balance_sql();
991 my @current_balance =
992 ref( $params->{'current_balance'} )
993 ? @{ $params->{'current_balance'} }
994 : ( $params->{'current_balance'} );
996 push @where, map { s/current_balance/$balance_sql/; $_ }
1005 if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
1007 "cust_main.custbatch = '$1'";
1010 if ( $params->{'tagnum'} ) {
1011 my @tagnums = ref( $params->{'tagnum'} ) ? @{ $params->{'tagnum'} } : ( $params->{'tagnum'} );
1013 @tagnums = grep /^(\d+)$/, @tagnums;
1016 if ( $params->{'all_tags'} ) {
1017 foreach ( @tagnums ) {
1018 push @where, 'exists(select 1 from cust_tag where '.
1019 'cust_tag.custnum = cust_main.custnum and tagnum = '.
1022 } else { # matching any tag, not all
1023 my $tags_where = "0 < (select count(1) from cust_tag where "
1024 . " cust_tag.custnum = cust_main.custnum and tagnum in ("
1025 . join(',', @tagnums) . "))";
1027 push @where, $tags_where;
1035 if ( $params->{'pkg_classnum'} ) {
1036 my @pkg_classnums = ref( $params->{'pkg_classnum'} ) ?
1037 @{ $params->{'pkg_classnum'} } :
1038 $params->{'pkg_classnum'};
1039 @pkg_classnums = grep /^(\d+)$/, @pkg_classnums;
1041 if ( @pkg_classnums ) {
1044 if ( $params->{'all_pkg_classnums'} ) {
1045 push @pkg_where, "part_pkg.classnum = $_" foreach @pkg_classnums;
1048 'part_pkg.classnum IN('. join(',', @pkg_classnums).')';
1050 foreach (@pkg_where) {
1052 "SELECT 1 FROM cust_pkg JOIN part_pkg USING (pkgpart) WHERE ".
1053 "cust_pkg.custnum = cust_main.custnum AND $_ ";
1054 if ( not $params->{'any_pkg_status'} ) {
1055 $select_pkg .= 'AND '.FS::cust_pkg->active_sql;
1057 push @where, "EXISTS($select_pkg)";
1063 # setup queries, subs, etc. for the search
1066 $orderby ||= 'ORDER BY custnum';
1068 # here is the agent virtualization
1070 $FS::CurrentUser::CurrentUser->agentnums_sql(table => 'cust_main');
1072 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
1075 # always make address fields available in results
1076 for my $pre ('bill_', 'ship_') {
1078 'LEFT JOIN cust_location AS '.$pre.'location '.
1079 'ON (cust_main.'.$pre.'locationnum = '.$pre.'location.locationnum) ';
1082 # always make referral available in results
1083 # (maybe we should be using FS::UI::Web::join_cust_main instead?)
1084 $addl_from .= ' LEFT JOIN (select refnum, referral from part_referral) AS part_referral_x ON (cust_main.refnum = part_referral_x.refnum) ';
1086 my $count_query = "SELECT COUNT(*) FROM cust_main $addl_from $extra_sql";
1089 'cust_main.custnum',
1090 'cust_main.salesnum',
1091 # there's a good chance that we'll need these
1092 'cust_main.bill_locationnum',
1093 'cust_main.ship_locationnum',
1094 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
1097 my @extra_headers = ();
1098 my @extra_fields = ();
1099 my @extra_sort_fields = ();
1102 if ($params->{'contacts'}) {
1103 my $contact_params = $params->{'contacts'};
1106 ' LEFT JOIN cust_contact ON ( cust_main.custnum = cust_contact.custnum ) ';
1108 if ($contact_params->{'contacts_firstname'} || $contact_params->{'contacts_lastname'}) {
1109 $addl_from .= ' LEFT JOIN contact ON ( cust_contact.contactnum = contact.contactnum ) ';
1110 my $first_query = " AND contact.first = '" . $contact_params->{'contacts_firstname'} . "'"
1111 unless !$contact_params->{'contacts_firstname'};
1112 my $last_query = " AND contact.last = '" . $contact_params->{'contacts_lastname'} . "'"
1113 unless !$contact_params->{'contacts_lastname'};
1114 $extra_sql .= " AND ( '1' $first_query $last_query )";
1117 if ($contact_params->{'contacts_email'}) {
1118 $addl_from .= ' LEFT JOIN contact_email ON ( cust_contact.contactnum = contact_email.contactnum ) ';
1119 $extra_sql .= " AND ( contact_email.emailaddress = '" . $contact_params->{'contacts_email'} . "' )";
1122 if ($contact_params->{'contacts_homephone'} || $contact_params->{'contacts_workphone'} || $contact_params->{'contacts_mobilephone'}) {
1123 $addl_from .= ' LEFT JOIN contact_phone ON ( cust_contact.contactnum = contact_phone.contactnum ) ';
1124 my $contacts_mobilephone;
1125 foreach my $phone (qw( contacts_homephone contacts_workphone contacts_mobilephone )) {
1126 (my $num = $contact_params->{$phone}) =~ s/\W//g;
1127 if ( $num =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { $contact_params->{$phone} = "$1$2$3"; }
1129 my $home_query = " AND ( contact_phone.phonetypenum = '2' AND contact_phone.phonenum = '" . $contact_params->{'contacts_homephone'} . "' )"
1130 unless !$contact_params->{'contacts_homephone'};
1131 my $work_query = " AND ( contact_phone.phonetypenum = '1' AND contact_phone.phonenum = '" . $contact_params->{'contacts_workphone'} . "' )"
1132 unless !$contact_params->{'contacts_workphone'};
1133 my $mobile_query = " AND ( contact_phone.phonetypenum = '3' AND contact_phone.phonenum = '" . $contact_params->{'contacts_mobilephone'} . "' )"
1134 unless !$contact_params->{'contacts_mobilephone'};
1135 $extra_sql .= " AND ( '1' $home_query $work_query $mobile_query )";
1140 if ($params->{'flattened_pkgs'}) {
1144 ' LEFT JOIN cust_pkg ON ( cust_main.custnum = cust_pkg.custnum ) ';
1146 if ($dbh->{Driver}->{Name} eq 'Pg') {
1151 SELECT pkg FROM cust_pkg LEFT JOIN part_pkg USING ( pkgpart )
1152 WHERE cust_main.custnum = cust_pkg.custnum $pkgwhere
1157 } elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
1158 push @select, "GROUP_CONCAT(part_pkg.pkg SEPARATOR '|') as magic";
1159 $addl_from .= ' LEFT JOIN part_pkg USING ( pkgpart ) ';
1160 #$pkg_join .= ' LEFT JOIN part_pkg USING ( pkgpart ) ';
1162 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
1163 "omitting package information from report.";
1166 my $header_query = "
1167 SELECT COUNT(cust_pkg.custnum = cust_main.custnum) AS count
1168 FROM cust_main $addl_from $extra_sql $pkgwhere
1169 GROUP BY cust_main.custnum ORDER BY count DESC LIMIT 1
1172 my $sth = dbh->prepare($header_query) or die dbh->errstr;
1173 $sth->execute() or die $sth->errstr;
1174 my $headerrow = $sth->fetchrow_arrayref;
1175 my $headercount = $headerrow ? $headerrow->[0] : 0;
1176 while($headercount) {
1177 unshift @extra_headers, "Package ". $headercount;
1178 unshift @extra_fields, eval q!sub {my $c = shift;
1179 my @a = split '\|', $c->magic;
1180 my $p = $a[!.--$headercount. q!];
1183 unshift @extra_sort_fields, '';
1188 if ( $params->{'with_referrals'} ) {
1190 #XXX next: num for each customer status
1193 '( SELECT COUNT(*) FROM cust_main AS referred_cust_main
1194 WHERE cust_main.custnum = referred_cust_main.referral_custnum
1195 ) AS num_referrals';
1197 unshift @extra_headers, 'Referrals';
1198 unshift @extra_fields, 'num_referrals';
1199 unshift @extra_sort_fields, 'num_referrals';
1203 my $select = join(', ', @select);
1206 'table' => 'cust_main',
1207 'select' => $select,
1208 'addl_from' => $addl_from,
1210 'extra_sql' => $extra_sql,
1211 'order_by' => $orderby,
1212 'count_query' => $count_query,
1213 'extra_headers' => \@extra_headers,
1214 'extra_fields' => \@extra_fields,
1215 'extra_sort_fields' => \@extra_sort_fields,
1221 =item fuzzy_search FUZZY_HASHREF [ OPTS ]
1223 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
1224 records. Currently, I<first>, I<last>, I<company> and/or I<address1> may be
1227 Additional options are the same as FS::Record::qsearch
1234 # sensible defaults, then merge in any passed options
1236 'table' => 'cust_main',
1245 my @fuzzy_mod = 'i';
1246 my $conf = new FS::Conf;
1247 my $fuzziness = $conf->config('fuzzy-fuzziness');
1248 push @fuzzy_mod, $fuzziness if $fuzziness;
1250 check_and_rebuild_fuzzyfiles();
1251 foreach my $field ( keys %$fuzzy ) {
1253 my $all = $self->all_X($field);
1254 next unless scalar(@$all);
1257 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, \@fuzzy_mod, @$all ) );
1258 next if !keys(%match);
1260 my $in_matches = 'IN (' .
1261 join(',', map { dbh->quote($_) } keys %match) .
1264 my $extra_sql = $fuzopts{extra_sql};
1265 if ($extra_sql =~ /^\s*where /i or keys %{ $fuzopts{hashref} }) {
1266 $extra_sql .= ' AND ';
1268 $extra_sql .= 'WHERE ';
1270 $extra_sql .= "$field $in_matches";
1272 my $addl_from = $fuzopts{addl_from};
1273 if ( $field =~ /^cust_location\./ ) {
1274 $addl_from .= ' JOIN cust_location USING (custnum)';
1275 } elsif ( $field =~ /^contact\./ ) {
1276 $addl_from .= ' JOIN contact USING (custnum)';
1279 push @cust_main, qsearch({
1281 'addl_from' => $addl_from,
1282 'extra_sql' => $extra_sql,
1286 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
1288 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
1296 =head1 UTILITY SUBROUTINES
1300 =item check_and_rebuild_fuzzyfiles
1304 sub check_and_rebuild_fuzzyfiles {
1305 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1306 rebuild_fuzzyfiles()
1307 if grep { ! -e "$dir/$_" }
1309 my ($field, $table) = reverse split('\.', $_);
1310 $table ||= 'cust_main';
1316 =item rebuild_fuzzyfiles
1320 sub rebuild_fuzzyfiles {
1322 use Fcntl qw(:flock);
1324 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1325 mkdir $dir, 0700 unless -d $dir;
1327 foreach my $fuzzy ( @fuzzyfields ) {
1329 my ($field, $table) = reverse split('\.', $fuzzy);
1330 $table ||= 'cust_main';
1332 open(LOCK,">>$dir/$table.$field")
1333 or die "can't open $dir/$table.$field: $!";
1335 or die "can't lock $dir/$table.$field: $!";
1337 open (CACHE, '>:encoding(UTF-8)', "$dir/$table.$field.tmp")
1338 or die "can't open $dir/$table.$field.tmp: $!";
1340 my $sth = dbh->prepare(
1341 "SELECT $field FROM $table WHERE $field IS NOT NULL AND $field != ''"
1343 $sth->execute or die $sth->errstr;
1345 while ( my $row = $sth->fetchrow_arrayref ) {
1346 print CACHE $row->[0]. "\n";
1349 close CACHE or die "can't close $dir/$table.$field.tmp: $!";
1351 rename "$dir/$table.$field.tmp", "$dir/$table.$field";
1357 =item append_fuzzyfiles FIRSTNAME LASTNAME COMPANY ADDRESS1
1361 sub append_fuzzyfiles {
1362 #my( $first, $last, $company ) = @_;
1364 check_and_rebuild_fuzzyfiles();
1366 #foreach my $fuzzy (@fuzzyfields) {
1367 foreach my $fuzzy ( 'cust_main.first', 'cust_main.last', 'cust_main.company',
1368 'cust_location.address1',
1369 'cust_main.ship_company',
1372 append_fuzzyfiles_fuzzyfield($fuzzy, shift);
1379 =item append_fuzzyfiles_fuzzyfield COLUMN VALUE
1381 =item append_fuzzyfiles_fuzzyfield TABLE.COLUMN VALUE
1385 use Fcntl qw(:flock);
1386 sub append_fuzzyfiles_fuzzyfield {
1387 my( $fuzzyfield, $value ) = @_;
1389 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1392 my ($field, $table) = reverse split('\.', $fuzzyfield);
1393 $table ||= 'cust_main';
1395 return unless defined($value) && length($value);
1397 open(CACHE, '>>:encoding(UTF-8)', "$dir/$table.$field" )
1398 or die "can't open $dir/$table.$field: $!";
1399 flock(CACHE,LOCK_EX)
1400 or die "can't lock $dir/$table.$field: $!";
1402 print CACHE "$value\n";
1404 flock(CACHE,LOCK_UN)
1405 or die "can't unlock $dir/$table.$field: $!";
1415 my( $self, $fuzzy ) = @_;
1416 my ($field, $table) = reverse split('\.', $fuzzy);
1417 $table ||= 'cust_main';
1419 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1420 open(CACHE, '<:encoding(UTF-8)', "$dir/$table.$field")
1421 or die "can't open $dir/$table.$field: $!";
1422 my @array = map { chomp; $_; } <CACHE>;
1433 L<FS::cust_main>, L<FS::Record>