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 cust_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 cust_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 'table' => 'cust_main',
214 'addl_from' => ' JOIN cust_location USING (custnum) ',
215 'hashref' => { %options, },
217 ( keys(%options) ? ' AND ' : ' WHERE ' ).
218 " LOWER(SUBSTRING(cust_location.address1 FROM 1 FOR $len)) = '$num' ".
219 " AND $agentnums_sql",
223 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
225 my($company, $last, $first) = ( $1, $2, $3 );
227 # "Company (Last, First)"
228 #this is probably something a browser remembered,
229 #so just do an exact search (but case-insensitive, so USPS standardization
230 #doesn't throw a wrench in the works)
232 push @cust_main, qsearch( {
233 'table' => 'cust_main',
234 'hashref' => { %options },
236 ( keys(%options) ? ' AND ' : ' WHERE ' ).
238 " LOWER(first) = ". dbh->quote(lc($first)),
239 " LOWER(last) = ". dbh->quote(lc($last)),
240 " LOWER(company) = ". dbh->quote(lc($company)),
246 # probably not necessary for the "something a browser remembered" case
248 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
249 # try {first,last,company}
253 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
254 # # full strings the browser remembers won't work
255 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
257 use Lingua::EN::NameParse;
258 my $NameParse = new Lingua::EN::NameParse(
263 my($last, $first) = ( '', '' );
264 #maybe disable this too and just rely on NameParse?
265 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
267 ($last, $first) = ( $1, $2 );
269 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
270 } elsif ( ! $NameParse->parse($value) ) {
272 my %name = $NameParse->components;
273 $first = lc($name{'given_name_1'}) || $name{'initials_1'}; #wtf NameParse, Ed?
274 $last = lc($name{'surname_1'});
278 if ( $first && $last ) {
280 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
283 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
284 $sql .= "( (LOWER(cust_main.last) = $q_last AND LOWER(cust_main.first) = $q_first)
285 OR (LOWER(contact.last) = $q_last AND LOWER(contact.first) = $q_first) )";
287 #cust_main and contacts
288 push @cust_main, qsearch( {
289 'select' => 'cust_main.*',
290 'table' => 'cust_main',
291 'addl_from' => ' left join cust_contact using (custnum) '.
292 ' left join contact using (contactnum) ',
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 cust_contact using (custnum) '.
325 ' left join contact using (contactnum) ',
326 'hashref' => { %options },
327 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
330 #no exact match, trying substring/fuzzy
331 #always do substring & fuzzy (unless they're explicity config'ed off)
332 #getting complaints searches are not returning enough
333 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
335 #still some false laziness w/search (was search/cust_main.cgi)
338 $FS::CurrentUser::CurrentUser->access_right('List all customers')
343 my @company_hashrefs = ();
344 if ( length($value) >= $min_len ) {
345 @company_hashrefs = (
346 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
347 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
352 if ( $first && $last ) {
355 { 'first' => { op=>'ILIKE', value=>"%$first%" },
356 'last' => { op=>'ILIKE', value=>"%$last%" },
360 } elsif ( length($value) >= $min_len ) {
363 { 'first' => { op=>'ILIKE', value=>"%$value%" }, },
364 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
369 foreach my $hashref ( @company_hashrefs, @hashrefs ) {
371 push @cust_main, qsearch( {
372 'table' => 'cust_main',
373 'hashref' => { %$hashref,
376 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
381 if ( $conf->exists('address1-search') && length($value) >= $min_len ) {
383 push @cust_main, qsearch( {
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',
466 'addl_from' => ' JOIN cust_payby USING (custnum)',
468 'extra_sql' => " WHERE ( cust_payby.payinfo LIKE '$like_search'
469 OR cust_payby.paymask = '$mask_search'
471 " AND cust_payby.payby IN ('CARD','DCRD') ".
472 " AND $agentnums_sql", #agent virtulization
478 #eliminate duplicates
480 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
488 Accepts the following options: I<email>, the email address to search for. The
489 email address will be searched for as an email invoice destination and as an
492 #Any additional options are treated as an additional qualifier on the search
495 Returns a (possibly empty) array of FS::cust_main objects (but usually just
503 my $email = delete $options{'email'};
505 #no agent virtualization yet
506 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
510 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
512 my ( $user, $domain ) = ( $1, $2 );
514 warn "$me smart_search: searching for $user in domain $domain"
518 map { $_->cust_main }
519 map { $_->cust_contact }
522 'table' => 'contact_email',
523 'hashref' => { 'emailaddress' => $email },
530 map $_->cust_svc->cust_pkg,
532 'table' => 'svc_acct',
533 'hashref' => { 'username' => $user, },
535 'AND ( SELECT domain FROM svc_domain
536 WHERE svc_acct.domsvc = svc_domain.svcnum
537 ) = '. dbh->quote($domain),
543 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
545 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
562 Returns a qsearch hash expression to search for parameters specified in
563 HASHREF. Valid parameters are
583 listref of start date, end date
587 listref of start date, end date
589 =item spouse_birthdate
591 listref of start date, end date
593 =item anniversary_date
595 listref of start date, end date
597 =item current_balance
599 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
612 my ($class, $params) = @_;
619 # initialize these to prevent warnings
627 'invoice_terms' => '',
633 # explicit custnum(s)
636 if ( $params->{'custnum'} ) {
637 my @custnums = ref($params->{'custnum'}) ?
638 @{ $params->{'custnum'} } :
639 $params->{'custnum'};
641 'cust_main.custnum IN (' .
642 join(',', map { $_ =~ /^(\d+)$/ ? $1 : () } @custnums ) .
643 ')' if scalar(@custnums) > 0;
650 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
652 "cust_main.agentnum = $1";
659 if ( $params->{'salesnum'} =~ /^(\d+)$/ ) {
660 push @where, ($1 > 0 ) ? "cust_main.salesnum = $1"
661 : 'cust_main.salesnum IS NULL';
668 if ( $params->{'usernum'} =~ /^(\d+)$/ and $1 ) {
670 "cust_main.usernum = $1";
677 #prospect ordered active inactive suspended cancelled
678 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
679 my $method = $params->{'status'}. '_sql';
680 #push @where, $class->$method();
681 push @where, FS::cust_main->$method();
685 unless ( $params->{location_history} ) {
687 AND ( cust_location.locationnum IN ( cust_main.bill_locationnum,
688 cust_main.ship_locationnum
690 OR cust_location.locationnum IN (
691 SELECT locationnum FROM cust_pkg
692 WHERE cust_pkg.custnum = cust_main.custnum
693 AND locationnum IS NOT NULL
694 AND '. FS::cust_pkg->ncancelled_recurring_sql.'
702 if ( $params->{'address'} ) {
703 # allow this to be an arrayref
704 my @values = ($params->{'address'});
705 @values = @{$values[0]} if ref($values[0]);
707 foreach (grep /\S/, @values) {
708 my $address = dbh->quote('%'. lc($_). '%');
710 "LOWER(cust_location.address1) LIKE $address",
711 "LOWER(cust_location.address2) LIKE $address";
714 push @where, "EXISTS(
715 SELECT 1 FROM cust_location
716 WHERE cust_location.custnum = cust_main.custnum
717 AND (".join(' OR ',@orwhere).")
726 if ( $params->{'city'} =~ /\S/ ) {
727 my $city = dbh->quote($params->{'city'});
728 push @where, "EXISTS(
729 SELECT 1 FROM cust_location
730 WHERE cust_location.custnum = cust_main.custnum
731 AND cust_location.city = $city
739 if ( $params->{'county'} =~ /\S/ ) {
740 my $county = dbh->quote($params->{'county'});
741 push @where, "EXISTS(
742 SELECT 1 FROM cust_location
743 WHERE cust_location.custnum = cust_main.custnum
744 AND cust_location.county = $county
752 if ( $params->{'state'} =~ /\S/ ) {
753 my $state = dbh->quote($params->{'state'});
754 push @where, "EXISTS(
755 SELECT 1 FROM cust_location
756 WHERE cust_location.custnum = cust_main.custnum
757 AND cust_location.state = $state
765 if ( $params->{'zip'} =~ /\S/ ) {
766 my $zip = dbh->quote($params->{'zip'} . '%');
767 push @where, "EXISTS(
768 SELECT 1 FROM cust_location
769 WHERE cust_location.custnum = cust_main.custnum
770 AND cust_location.zip LIKE $zip
778 if ( $params->{'country'} =~ /^(\w\w)$/ ) {
779 my $country = uc($1);
780 push @where, "EXISTS(
781 SELECT 1 FROM cust_location
782 WHERE cust_location.custnum = cust_main.custnum
783 AND cust_location.country = '$country'
791 if ( $params->{'refnum'} ) {
793 my @refnum = ref( $params->{'refnum'} )
794 ? @{ $params->{'refnum'} }
795 : ( $params->{'refnum'} );
797 @refnum = grep /^(\d*)$/, @refnum;
799 push @where, '( '. join(' OR ', map "cust_main.refnum = $_", @refnum ). ' )'
805 # parse cancelled package checkbox
810 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
811 unless $params->{'cancelled_pkgs'};
814 # "with email address(es)" checkbox
818 'EXISTS ( SELECT 1 FROM contact_email
819 JOIN cust_contact USING (contactnum)
820 WHERE cust_contact.custnum = cust_main.custnum
822 if $params->{'with_email'};
825 # "with postal mail invoices" checkbox
828 push @where, "cust_main.postal_invoice = 'Y'"
829 if $params->{'POST'};
832 # "without postal mail invoices" checkbox
835 push @where, "cust_main.postal_invoice IS NULL"
836 if $params->{'no_POST'};
839 # "tax exempt" checkbox
841 push @where, "cust_main.tax = 'Y'"
845 # "not tax exempt" checkbox
847 push @where, "(cust_main.tax = '' OR cust_main.tax IS NULL )"
848 if $params->{'no_tax'};
853 if ( $params->{with_referrals} =~ /^\s*(\d+)\s*$/ ) {
859 if ( grep { $params->{referral_status} eq $_ } FS::cust_main->statuses() ) {
860 my $method = $params->{referral_status}. '_sql';
861 $and_status = ' AND '. FS::cust_main->$method();
862 $and_status =~ s/ cust_main\./ referred_cust_main./g;
866 " $n <= ( SELECT COUNT(*) FROM cust_main AS referred_cust_main
867 WHERE cust_main.custnum = referred_cust_main.referral_custnum
877 foreach my $field (qw( signupdate birthdate spouse_birthdate anniversary_date )) {
879 next unless exists($params->{$field});
881 my($beginning, $ending, $hour) = @{$params->{$field}};
884 "cust_main.$field IS NOT NULL",
885 "cust_main.$field >= $beginning",
886 "cust_main.$field <= $ending";
888 if($field eq 'signupdate' && defined $hour) {
889 if ($dbh->{Driver}->{Name} =~ /Pg/i) {
890 push @where, "extract(hour from to_timestamp(cust_main.$field)) = $hour";
892 elsif( $dbh->{Driver}->{Name} =~ /mysql/i) {
893 push @where, "hour(from_unixtime(cust_main.$field)) = $hour"
896 warn "search by time of day not supported on ".$dbh->{Driver}->{Name}." databases";
900 $orderby ||= "ORDER BY cust_main.$field";
908 if ( $params->{'classnum'} ) {
910 my @classnum = ref( $params->{'classnum'} )
911 ? @{ $params->{'classnum'} }
912 : ( $params->{'classnum'} );
914 @classnum = grep /^(\d*)$/, @classnum;
917 push @where, '( '. join(' OR ', map {
918 $_ ? "cust_main.classnum = $_"
919 : "cust_main.classnum IS NULL"
932 if ( $params->{'invoice_terms'} =~ /^([\w ]+)$/ ) {
934 if ( $1 eq 'NULL' ) {
936 "( cust_main.invoice_terms IS NULL OR cust_main.invoice_terms = '' )";
939 "cust_main.invoice_terms IS NOT NULL",
940 "cust_main.invoice_terms = '$1'";
948 if ( $params->{'current_balance'} ) {
950 #my $balance_sql = $class->balance_sql();
951 my $balance_sql = FS::cust_main->balance_sql();
953 my @current_balance =
954 ref( $params->{'current_balance'} )
955 ? @{ $params->{'current_balance'} }
956 : ( $params->{'current_balance'} );
958 push @where, map { s/current_balance/$balance_sql/; $_ }
967 if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
969 "cust_main.custbatch = '$1'";
972 if ( $params->{'tagnum'} ) {
973 my @tagnums = ref( $params->{'tagnum'} ) ? @{ $params->{'tagnum'} } : ( $params->{'tagnum'} );
975 @tagnums = grep /^(\d+)$/, @tagnums;
978 if ( $params->{'all_tags'} ) {
979 foreach ( @tagnums ) {
980 push @where, 'exists(select 1 from cust_tag where '.
981 'cust_tag.custnum = cust_main.custnum and tagnum = '.
984 } else { # matching any tag, not all
985 my $tags_where = "0 < (select count(1) from cust_tag where "
986 . " cust_tag.custnum = cust_main.custnum and tagnum in ("
987 . join(',', @tagnums) . "))";
989 push @where, $tags_where;
997 if ( $params->{'pkg_classnum'} ) {
998 my @pkg_classnums = ref( $params->{'pkg_classnum'} ) ?
999 @{ $params->{'pkg_classnum'} } :
1000 $params->{'pkg_classnum'};
1001 @pkg_classnums = grep /^(\d+)$/, @pkg_classnums;
1003 if ( @pkg_classnums ) {
1006 if ( $params->{'all_pkg_classnums'} ) {
1007 push @pkg_where, "part_pkg.classnum = $_" foreach @pkg_classnums;
1010 'part_pkg.classnum IN('. join(',', @pkg_classnums).')';
1012 foreach (@pkg_where) {
1014 "SELECT 1 FROM cust_pkg JOIN part_pkg USING (pkgpart) WHERE ".
1015 "cust_pkg.custnum = cust_main.custnum AND $_ ";
1016 if ( not $params->{'any_pkg_status'} ) {
1017 $select_pkg .= 'AND '.FS::cust_pkg->active_sql;
1019 push @where, "EXISTS($select_pkg)";
1025 # setup queries, subs, etc. for the search
1028 $orderby ||= 'ORDER BY custnum';
1030 # here is the agent virtualization
1032 $FS::CurrentUser::CurrentUser->agentnums_sql(table => 'cust_main');
1034 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
1037 # always make address fields available in results
1038 for my $pre ('bill_', 'ship_') {
1040 'LEFT JOIN cust_location AS '.$pre.'location '.
1041 'ON (cust_main.'.$pre.'locationnum = '.$pre.'location.locationnum) ';
1044 # always make referral available in results
1045 # (maybe we should be using FS::UI::Web::join_cust_main instead?)
1046 $addl_from .= ' LEFT JOIN (select refnum, referral from part_referral) AS part_referral_x ON (cust_main.refnum = part_referral_x.refnum) ';
1048 my $count_query = "SELECT COUNT(*) FROM cust_main $addl_from $extra_sql";
1051 'cust_main.custnum',
1052 'cust_main.salesnum',
1053 # there's a good chance that we'll need these
1054 'cust_main.bill_locationnum',
1055 'cust_main.ship_locationnum',
1056 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
1059 my @extra_headers = ();
1060 my @extra_fields = ();
1061 my @extra_sort_fields = ();
1064 if ($params->{'contacts'}) {
1065 my $contact_params = $params->{'contacts'};
1068 ' LEFT JOIN cust_contact ON ( cust_main.custnum = cust_contact.custnum ) ';
1070 if ($contact_params->{'contacts_firstname'} || $contact_params->{'contacts_lastname'}) {
1071 $addl_from .= ' LEFT JOIN contact ON ( cust_contact.contactnum = contact.contactnum ) ';
1072 my $first_query = " AND contact.first = '" . $contact_params->{'contacts_firstname'} . "'"
1073 unless !$contact_params->{'contacts_firstname'};
1074 my $last_query = " AND contact.last = '" . $contact_params->{'contacts_lastname'} . "'"
1075 unless !$contact_params->{'contacts_lastname'};
1076 $extra_sql .= " AND ( '1' $first_query $last_query )";
1079 if ($contact_params->{'contacts_email'}) {
1080 $addl_from .= ' LEFT JOIN contact_email ON ( cust_contact.contactnum = contact_email.contactnum ) ';
1081 $extra_sql .= " AND ( contact_email.emailaddress = '" . $contact_params->{'contacts_email'} . "' )";
1084 if ($contact_params->{'contacts_homephone'} || $contact_params->{'contacts_workphone'} || $contact_params->{'contacts_mobilephone'}) {
1085 $addl_from .= ' LEFT JOIN contact_phone ON ( cust_contact.contactnum = contact_phone.contactnum ) ';
1086 my $contacts_mobilephone;
1087 foreach my $phone (qw( contacts_homephone contacts_workphone contacts_mobilephone )) {
1088 (my $num = $contact_params->{$phone}) =~ s/\W//g;
1089 if ( $num =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { $contact_params->{$phone} = "$1$2$3"; }
1091 my $home_query = " AND ( contact_phone.phonetypenum = '2' AND contact_phone.phonenum = '" . $contact_params->{'contacts_homephone'} . "' )"
1092 unless !$contact_params->{'contacts_homephone'};
1093 my $work_query = " AND ( contact_phone.phonetypenum = '1' AND contact_phone.phonenum = '" . $contact_params->{'contacts_workphone'} . "' )"
1094 unless !$contact_params->{'contacts_workphone'};
1095 my $mobile_query = " AND ( contact_phone.phonetypenum = '3' AND contact_phone.phonenum = '" . $contact_params->{'contacts_mobilephone'} . "' )"
1096 unless !$contact_params->{'contacts_mobilephone'};
1097 $extra_sql .= " AND ( '1' $home_query $work_query $mobile_query )";
1102 if ($params->{'flattened_pkgs'}) {
1106 ' LEFT JOIN cust_pkg ON ( cust_main.custnum = cust_pkg.custnum ) ';
1108 if ($dbh->{Driver}->{Name} eq 'Pg') {
1113 SELECT pkg FROM cust_pkg LEFT JOIN part_pkg USING ( pkgpart )
1114 WHERE cust_main.custnum = cust_pkg.custnum $pkgwhere
1119 } elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
1120 push @select, "GROUP_CONCAT(part_pkg.pkg SEPARATOR '|') as magic";
1121 $addl_from .= ' LEFT JOIN part_pkg USING ( pkgpart ) ';
1122 #$pkg_join .= ' LEFT JOIN part_pkg USING ( pkgpart ) ';
1124 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
1125 "omitting package information from report.";
1128 my $header_query = "
1129 SELECT COUNT(cust_pkg.custnum = cust_main.custnum) AS count
1130 FROM cust_main $addl_from $extra_sql $pkgwhere
1131 GROUP BY cust_main.custnum ORDER BY count DESC LIMIT 1
1134 my $sth = dbh->prepare($header_query) or die dbh->errstr;
1135 $sth->execute() or die $sth->errstr;
1136 my $headerrow = $sth->fetchrow_arrayref;
1137 my $headercount = $headerrow ? $headerrow->[0] : 0;
1138 while($headercount) {
1139 unshift @extra_headers, "Package ". $headercount;
1140 unshift @extra_fields, eval q!sub {my $c = shift;
1141 my @a = split '\|', $c->magic;
1142 my $p = $a[!.--$headercount. q!];
1145 unshift @extra_sort_fields, '';
1150 if ( $params->{'with_referrals'} ) {
1152 #XXX next: num for each customer status
1155 '( SELECT COUNT(*) FROM cust_main AS referred_cust_main
1156 WHERE cust_main.custnum = referred_cust_main.referral_custnum
1157 ) AS num_referrals';
1159 unshift @extra_headers, 'Referrals';
1160 unshift @extra_fields, 'num_referrals';
1161 unshift @extra_sort_fields, 'num_referrals';
1165 my $select = join(', ', @select);
1168 'table' => 'cust_main',
1169 'select' => $select,
1170 'addl_from' => $addl_from,
1172 'extra_sql' => $extra_sql,
1173 'order_by' => $orderby,
1174 'count_query' => $count_query,
1175 'extra_headers' => \@extra_headers,
1176 'extra_fields' => \@extra_fields,
1177 'extra_sort_fields' => \@extra_sort_fields,
1183 =item fuzzy_search FUZZY_HASHREF [ OPTS ]
1185 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
1186 records. Currently, I<first>, I<last>, I<company> and/or I<address1> may be
1189 Additional options are the same as FS::Record::qsearch
1196 # sensible defaults, then merge in any passed options
1198 'table' => 'cust_main',
1207 my @fuzzy_mod = 'i';
1208 my $conf = new FS::Conf;
1209 my $fuzziness = $conf->config('fuzzy-fuzziness');
1210 push @fuzzy_mod, $fuzziness if $fuzziness;
1212 check_and_rebuild_fuzzyfiles();
1213 foreach my $field ( keys %$fuzzy ) {
1215 my $all = $self->all_X($field);
1216 next unless scalar(@$all);
1219 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, \@fuzzy_mod, @$all ) );
1220 next if !keys(%match);
1222 my $in_matches = 'IN (' .
1223 join(',', map { dbh->quote($_) } keys %match) .
1226 my $extra_sql = $fuzopts{extra_sql};
1227 if ($extra_sql =~ /^\s*where /i or keys %{ $fuzopts{hashref} }) {
1228 $extra_sql .= ' AND ';
1230 $extra_sql .= 'WHERE ';
1232 $extra_sql .= "$field $in_matches";
1234 my $addl_from = $fuzopts{addl_from};
1235 if ( $field =~ /^cust_location\./ ) {
1236 $addl_from .= ' JOIN cust_location USING (custnum)';
1237 } elsif ( $field =~ /^contact\./ ) {
1238 $addl_from .= ' JOIN contact USING (custnum)';
1241 push @cust_main, qsearch({
1243 'addl_from' => $addl_from,
1244 'extra_sql' => $extra_sql,
1248 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
1250 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
1258 =head1 UTILITY SUBROUTINES
1262 =item check_and_rebuild_fuzzyfiles
1266 sub check_and_rebuild_fuzzyfiles {
1267 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1268 rebuild_fuzzyfiles()
1269 if grep { ! -e "$dir/$_" }
1271 my ($field, $table) = reverse split('\.', $_);
1272 $table ||= 'cust_main';
1278 =item rebuild_fuzzyfiles
1282 sub rebuild_fuzzyfiles {
1284 use Fcntl qw(:flock);
1286 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1287 mkdir $dir, 0700 unless -d $dir;
1289 foreach my $fuzzy ( @fuzzyfields ) {
1291 my ($field, $table) = reverse split('\.', $fuzzy);
1292 $table ||= 'cust_main';
1294 open(LOCK,">>$dir/$table.$field")
1295 or die "can't open $dir/$table.$field: $!";
1297 or die "can't lock $dir/$table.$field: $!";
1299 open (CACHE, '>:encoding(UTF-8)', "$dir/$table.$field.tmp")
1300 or die "can't open $dir/$table.$field.tmp: $!";
1302 my $sth = dbh->prepare(
1303 "SELECT $field FROM $table WHERE $field IS NOT NULL AND $field != ''"
1305 $sth->execute or die $sth->errstr;
1307 while ( my $row = $sth->fetchrow_arrayref ) {
1308 print CACHE $row->[0]. "\n";
1311 close CACHE or die "can't close $dir/$table.$field.tmp: $!";
1313 rename "$dir/$table.$field.tmp", "$dir/$table.$field";
1319 =item append_fuzzyfiles FIRSTNAME LASTNAME COMPANY ADDRESS1
1323 sub append_fuzzyfiles {
1324 #my( $first, $last, $company ) = @_;
1326 check_and_rebuild_fuzzyfiles();
1328 #foreach my $fuzzy (@fuzzyfields) {
1329 foreach my $fuzzy ( 'cust_main.first', 'cust_main.last', 'cust_main.company',
1330 'cust_location.address1',
1331 'cust_main.ship_company',
1334 append_fuzzyfiles_fuzzyfield($fuzzy, shift);
1341 =item append_fuzzyfiles_fuzzyfield COLUMN VALUE
1343 =item append_fuzzyfiles_fuzzyfield TABLE.COLUMN VALUE
1347 use Fcntl qw(:flock);
1348 sub append_fuzzyfiles_fuzzyfield {
1349 my( $fuzzyfield, $value ) = @_;
1351 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1354 my ($field, $table) = reverse split('\.', $fuzzyfield);
1355 $table ||= 'cust_main';
1357 return unless defined($value) && length($value);
1359 open(CACHE, '>>:encoding(UTF-8)', "$dir/$table.$field" )
1360 or die "can't open $dir/$table.$field: $!";
1361 flock(CACHE,LOCK_EX)
1362 or die "can't lock $dir/$table.$field: $!";
1364 print CACHE "$value\n";
1366 flock(CACHE,LOCK_UN)
1367 or die "can't unlock $dir/$table.$field: $!";
1377 my( $self, $fuzzy ) = @_;
1378 my ($field, $table) = reverse split('\.', $fuzzy);
1379 $table ||= 'cust_main';
1381 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1382 open(CACHE, '<:encoding(UTF-8)', "$dir/$table.$field")
1383 or die "can't open $dir/$table.$field: $!";
1384 my @array = map { chomp; $_; } <CACHE>;
1395 L<FS::cust_main>, L<FS::Record>