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 'table' => 'cust_main',
99 'hashref' => { %options },
100 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
102 join(' OR ', map "$_ = '$phonen'",
103 qw( daytime night mobile fax )
105 " OR phonenum = '$phonenum' ".
107 " AND $agentnums_sql", #agent virtualization
108 'addl_from' => ' left join cust_contact using (custnum) left join contact_phone using (contactnum) ',
111 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
112 #try looking for matches with extensions unless one was specified
114 push @cust_main, qsearch( {
115 'table' => 'cust_main',
116 'hashref' => { %options },
117 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
119 join(' OR ', map "$_ LIKE '$phonen\%'",
123 " AND $agentnums_sql", #agent virtualization
131 if ( $search =~ /@/ ) { #email address from cust_main_invoice and contact_email
133 push @cust_main, qsearch( {
134 'table' => 'cust_main',
135 'hashref' => { %options },
136 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
138 join(' OR ', map "$_ = '$search'",
139 qw( dest emailaddress )
142 " AND $agentnums_sql", #agent virtualization
143 'addl_from' => ' left join cust_main_invoice using (custnum) left join cust_contact using (custnum) left join contact_email using (contactnum) ',
146 # custnum search (also try agent_custid), with some tweaking options if your
147 # legacy cust "numbers" have letters
148 } elsif ( $search =~ /^\s*(\d+)\s*$/
149 or ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
150 && $search =~ /^\s*(\w\w?\d+)\s*$/
152 or ( $conf->config('cust_main-agent_custid-format') eq 'd+-w'
153 && $search =~ /^\s*(\d+-\w)\s*$/
155 or ( $conf->config('cust_main-custnum-display_special')
156 # it's not currently possible for special prefixes to contain
157 # digits, so just strip off any alphabetic prefix and match
158 # the rest to custnum
159 && $search =~ /^\s*[[:alpha:]]*(\d+)\s*$/
161 or ( $conf->exists('address1-search' )
162 && $search =~ /^\s*(\d+\-?\w*)\s*$/ #i.e. 1234A or 9432-D
169 if ( $num =~ /^(\d+)$/ && $num <= 2147483647 ) { #need a bigint custnum? wow
170 my $agent_custid_null = $conf->exists('cust_main-default_agent_custid')
171 ? ' AND agent_custid IS NULL ' : '';
172 push @cust_main, qsearch( {
173 'table' => 'cust_main',
174 'hashref' => { 'custnum' => $num, %options },
175 'extra_sql' => " AND $agentnums_sql $agent_custid_null",
179 # for all agents this user can see, if any of them have custnum prefixes
180 # that match the search string, include customers that match the rest
181 # of the custnum and belong to that agent
182 foreach my $agentnum ( keys %$agentnums_href ) {
183 my $p = $conf->config('cust_main-custnum-display_prefix', $agentnum);
185 if ( $p eq substr($num, 0, length($p)) ) {
186 push @cust_main, qsearch( {
187 'table' => 'cust_main',
188 'hashref' => { 'custnum' => 0 + substr($num, length($p)),
189 'agentnum' => $agentnum,
196 push @cust_main, qsearch( {
197 'table' => 'cust_main',
198 'hashref' => { 'agent_custid' => $num, %options },
199 'extra_sql' => " AND $agentnums_sql", #agent virtualization
202 if ( $conf->exists('address1-search') ) {
203 my $len = length($num);
205 # probably the Right Thing: return customers that have any associated
206 # locations matching the string, not just bill/ship location
207 push @cust_main, qsearch( {
208 'table' => 'cust_main',
209 'addl_from' => ' JOIN cust_location USING (custnum) ',
210 'hashref' => { %options, },
212 ( keys(%options) ? ' AND ' : ' WHERE ' ).
213 " LOWER(SUBSTRING(cust_location.address1 FROM 1 FOR $len)) = '$num' ".
214 " AND $agentnums_sql",
218 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
220 my($company, $last, $first) = ( $1, $2, $3 );
222 # "Company (Last, First)"
223 #this is probably something a browser remembered,
224 #so just do an exact search (but case-insensitive, so USPS standardization
225 #doesn't throw a wrench in the works)
227 push @cust_main, qsearch( {
228 'table' => 'cust_main',
229 'hashref' => { %options },
231 ( keys(%options) ? ' AND ' : ' WHERE ' ).
233 " LOWER(first) = ". dbh->quote(lc($first)),
234 " LOWER(last) = ". dbh->quote(lc($last)),
235 " LOWER(company) = ". dbh->quote(lc($company)),
241 # probably not necessary for the "something a browser remembered" case
243 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
244 # try {first,last,company}
248 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
249 # # full strings the browser remembers won't work
250 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
252 use Lingua::EN::NameParse;
253 my $NameParse = new Lingua::EN::NameParse(
258 my($last, $first) = ( '', '' );
259 #maybe disable this too and just rely on NameParse?
260 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
262 ($last, $first) = ( $1, $2 );
264 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
265 } elsif ( ! $NameParse->parse($value) ) {
267 my %name = $NameParse->components;
268 $first = lc($name{'given_name_1'}) || $name{'initials_1'}; #wtf NameParse, Ed?
269 $last = lc($name{'surname_1'});
273 if ( $first && $last ) {
275 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
278 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
279 $sql .= "( (LOWER(cust_main.last) = $q_last AND LOWER(cust_main.first) = $q_first)
280 OR (LOWER(contact.last) = $q_last AND LOWER(contact.first) = $q_first) )";
282 #cust_main and contacts
283 push @cust_main, qsearch( {
284 'table' => 'cust_main',
285 'select' => 'cust_main.*, cust_contact.*, contact.contactnum, contact.last as contact_last, contact.first as contact_first, contact.title',
286 'hashref' => { %options },
287 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
288 'addl_from' => ' left join cust_contact on cust_main.custnum = cust_contact.custnum left join contact using (contactnum) ',
291 # or it just be something that was typed in... (try that in a sec)
295 my $q_value = dbh->quote($value);
298 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
299 $sql .= " ( LOWER(cust_main.first) = $q_value
300 OR LOWER(cust_main.last) = $q_value
301 OR LOWER(cust_main.company) = $q_value
302 OR LOWER(cust_main.ship_company) = $q_value
303 OR LOWER(contact.first) = $q_value
304 OR LOWER(contact.last) = $q_value
307 #address1 (yes, it's a kludge)
308 $sql .= " OR EXISTS (
309 SELECT 1 FROM cust_location
310 WHERE LOWER(cust_location.address1) = $q_value
311 AND cust_location.custnum = cust_main.custnum
313 if $conf->exists('address1-search');
315 push @cust_main, qsearch( {
316 'table' => 'cust_main',
317 'select' => 'cust_main.*, cust_contact.*, contact.contactnum, contact.last as contact_last, contact.first as contact_first, contact.title',
318 'hashref' => { %options },
319 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
320 'addl_from' => 'left join cust_contact on cust_main.custnum = cust_contact.custnum left join contact using (contactnum) ',
323 #no exact match, trying substring/fuzzy
324 #always do substring & fuzzy (unless they're explicity config'ed off)
325 #getting complaints searches are not returning enough
326 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
328 #still some false laziness w/search (was search/cust_main.cgi)
331 $FS::CurrentUser::CurrentUser->access_right('List all customers')
336 my @company_hashrefs = ();
337 if ( length($value) >= $min_len ) {
338 @company_hashrefs = (
339 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
340 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
345 if ( $first && $last ) {
348 { 'first' => { op=>'ILIKE', value=>"%$first%" },
349 'last' => { op=>'ILIKE', value=>"%$last%" },
353 } elsif ( length($value) >= $min_len ) {
356 { 'first' => { op=>'ILIKE', value=>"%$value%" }, },
357 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
362 foreach my $hashref ( @company_hashrefs, @hashrefs ) {
364 push @cust_main, qsearch( {
365 'table' => 'cust_main',
366 'hashref' => { %$hashref,
369 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
374 if ( $conf->exists('address1-search') && length($value) >= $min_len ) {
376 push @cust_main, qsearch( {
377 table => 'cust_main',
378 addl_from => 'JOIN cust_location USING (custnum)',
379 extra_sql => 'WHERE '.
380 ' cust_location.address1 ILIKE '.dbh->quote("%$value%").
381 " AND $agentnums_sql", #agent virtualizaiton
388 foreach my $hashref ( @hashrefs ) {
391 grep $agentnums_href->{$_->agentnum}, #agent virt
392 grep $_, #skip contacts that don't have cust_main records
395 'table' => 'contact',
396 'hashref' => { %$hashref,
399 #'extra_sql' => " AND $agentnums_sql", #agent virt
406 'hashref' => \%options,
408 'extra_sql' => "WHERE $agentnums_sql", #agent virtualization
411 if ( $first && $last ) {
412 push @cust_main, FS::cust_main::Search->fuzzy_search(
413 { 'last' => $last, #fuzzy hashref
414 'first' => $first }, #
417 push @cust_main, FS::cust_main::Search->fuzzy_search(
418 { 'contact.last' => $last, #fuzzy hashref
419 'contact.first' => $first }, #
424 foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
425 push @cust_main, FS::cust_main::Search->fuzzy_search(
426 { $field => $value },
430 foreach my $field ( 'first', 'last' ) {
431 push @cust_main, FS::cust_main::Search->fuzzy_search(
432 { "contact.$field" => $value },
436 if ( $conf->exists('address1-search') ) {
438 FS::cust_main::Search->fuzzy_search(
439 { 'cust_location.address1' => $value },
448 ( my $nospace_search = $search ) =~ s/\s//g;
449 ( my $card_search = $nospace_search ) =~ s/\-//g;
450 $card_search =~ s/[x\*\.\_]/x/gi;
452 if ( $card_search =~ /^[\dx]{15,16}$/i ) { #credit card search
454 ( my $like_search = $card_search ) =~ s/x/_/g;
455 my $mask_search = FS::payinfo_Mixin->mask_payinfo('CARD', $card_search);
457 push @cust_main, qsearch({
458 'table' => 'cust_main',
459 'addl_from' => ' JOIN cust_payby USING (custnum)',
461 'extra_sql' => " WHERE ( cust_payby.payinfo LIKE '$like_search'
462 OR cust_payby.paymask = '$mask_search'
464 " AND cust_payby.payby IN ('CARD','DCRD') ".
465 " AND $agentnums_sql", #agent virtulization
471 #eliminate duplicates
473 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
481 Accepts the following options: I<email>, the email address to search for. The
482 email address will be searched for as an email invoice destination and as an
485 #Any additional options are treated as an additional qualifier on the search
488 Returns a (possibly empty) array of FS::cust_main objects (but usually just
496 my $email = delete $options{'email'};
498 #no agent virtualization yet
499 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
503 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
505 my ( $user, $domain ) = ( $1, $2 );
507 warn "$me smart_search: searching for $user in domain $domain"
511 map { $_->cust_main }
512 map { $_->cust_contact }
515 'table' => 'contact_email',
516 'hashref' => { 'emailaddress' => $email },
523 map $_->cust_svc->cust_pkg,
525 'table' => 'svc_acct',
526 'hashref' => { 'username' => $user, },
528 'AND ( SELECT domain FROM svc_domain
529 WHERE svc_acct.domsvc = svc_domain.svcnum
530 ) = '. dbh->quote($domain),
536 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
538 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
555 Returns a qsearch hash expression to search for parameters specified in
556 HASHREF. Valid parameters are
576 listref of start date, end date
580 listref of start date, end date
582 =item spouse_birthdate
584 listref of start date, end date
586 =item anniversary_date
588 listref of start date, end date
590 =item current_balance
592 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
605 my ($class, $params) = @_;
612 # initialize these to prevent warnings
620 'invoice_terms' => '',
626 # explicit custnum(s)
629 if ( $params->{'custnum'} ) {
630 my @custnums = ref($params->{'custnum'}) ?
631 @{ $params->{'custnum'} } :
632 $params->{'custnum'};
634 'cust_main.custnum IN (' .
635 join(',', map { $_ =~ /^(\d+)$/ ? $1 : () } @custnums ) .
636 ')' if scalar(@custnums) > 0;
643 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
645 "cust_main.agentnum = $1";
652 if ( $params->{'salesnum'} =~ /^(\d+)$/ ) {
653 push @where, ($1 > 0 ) ? "cust_main.salesnum = $1"
654 : 'cust_main.salesnum IS NULL';
661 if ( $params->{'usernum'} =~ /^(\d+)$/ and $1 ) {
663 "cust_main.usernum = $1";
670 #prospect ordered active inactive suspended cancelled
671 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
672 my $method = $params->{'status'}. '_sql';
673 #push @where, $class->$method();
674 push @where, FS::cust_main->$method();
678 unless ( $params->{location_history} ) {
680 AND ( cust_location.locationnum IN ( cust_main.bill_locationnum,
681 cust_main.ship_locationnum
683 OR cust_location.locationnum IN (
684 SELECT locationnum FROM cust_pkg
685 WHERE cust_pkg.custnum = cust_main.custnum
686 AND locationnum IS NOT NULL
687 AND '. FS::cust_pkg->ncancelled_recurring_sql.'
695 if ( $params->{'address'} ) {
696 # allow this to be an arrayref
697 my @values = ($params->{'address'});
698 @values = @{$values[0]} if ref($values[0]);
700 foreach (grep /\S/, @values) {
701 my $address = dbh->quote('%'. lc($_). '%');
703 "LOWER(cust_location.address1) LIKE $address",
704 "LOWER(cust_location.address2) LIKE $address";
707 push @where, "EXISTS(
708 SELECT 1 FROM cust_location
709 WHERE cust_location.custnum = cust_main.custnum
710 AND (".join(' OR ',@orwhere).")
719 if ( $params->{'city'} =~ /\S/ ) {
720 my $city = dbh->quote($params->{'city'});
721 push @where, "EXISTS(
722 SELECT 1 FROM cust_location
723 WHERE cust_location.custnum = cust_main.custnum
724 AND cust_location.city = $city
732 if ( $params->{'county'} =~ /\S/ ) {
733 my $county = dbh->quote($params->{'county'});
734 push @where, "EXISTS(
735 SELECT 1 FROM cust_location
736 WHERE cust_location.custnum = cust_main.custnum
737 AND cust_location.county = $county
745 if ( $params->{'state'} =~ /\S/ ) {
746 my $state = dbh->quote($params->{'state'});
747 push @where, "EXISTS(
748 SELECT 1 FROM cust_location
749 WHERE cust_location.custnum = cust_main.custnum
750 AND cust_location.state = $state
758 if ( $params->{'zip'} =~ /\S/ ) {
759 my $zip = dbh->quote($params->{'zip'} . '%');
760 push @where, "EXISTS(
761 SELECT 1 FROM cust_location
762 WHERE cust_location.custnum = cust_main.custnum
763 AND cust_location.zip LIKE $zip
771 if ( $params->{'country'} =~ /^(\w\w)$/ ) {
772 my $country = uc($1);
773 push @where, "EXISTS(
774 SELECT 1 FROM cust_location
775 WHERE cust_location.custnum = cust_main.custnum
776 AND cust_location.country = '$country'
784 if ( $params->{'refnum'} ) {
786 my @refnum = ref( $params->{'refnum'} )
787 ? @{ $params->{'refnum'} }
788 : ( $params->{'refnum'} );
790 @refnum = grep /^(\d*)$/, @refnum;
792 push @where, '( '. join(' OR ', map "cust_main.refnum = $_", @refnum ). ' )'
798 # parse cancelled package checkbox
803 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
804 unless $params->{'cancelled_pkgs'};
807 # "with email address(es)" checkbox
811 'EXISTS ( SELECT 1 FROM contact_email
812 JOIN cust_contact USING (contactnum)
813 WHERE cust_contact.custnum = cust_main.custnum
815 if $params->{'with_email'};
818 # "with postal mail invoices" checkbox
821 push @where, "cust_main.postal_invoice = 'Y'"
822 if $params->{'POST'};
825 # "without postal mail invoices" checkbox
828 push @where, "cust_main.postal_invoice IS NULL"
829 if $params->{'no_POST'};
832 # "tax exempt" checkbox
834 push @where, "cust_main.tax = 'Y'"
838 # "not tax exempt" checkbox
840 push @where, "(cust_main.tax = '' OR cust_main.tax IS NULL )"
841 if $params->{'no_tax'};
846 if ( $params->{with_referrals} =~ /^\s*(\d+)\s*$/ ) {
852 if ( grep { $params->{referral_status} eq $_ } FS::cust_main->statuses() ) {
853 my $method = $params->{referral_status}. '_sql';
854 $and_status = ' AND '. FS::cust_main->$method();
855 $and_status =~ s/ cust_main\./ referred_cust_main./g;
859 " $n <= ( SELECT COUNT(*) FROM cust_main AS referred_cust_main
860 WHERE cust_main.custnum = referred_cust_main.referral_custnum
870 foreach my $field (qw( signupdate birthdate spouse_birthdate anniversary_date )) {
872 next unless exists($params->{$field});
874 my($beginning, $ending, $hour) = @{$params->{$field}};
877 "cust_main.$field IS NOT NULL",
878 "cust_main.$field >= $beginning",
879 "cust_main.$field <= $ending";
881 if($field eq 'signupdate' && defined $hour) {
882 if ($dbh->{Driver}->{Name} =~ /Pg/i) {
883 push @where, "extract(hour from to_timestamp(cust_main.$field)) = $hour";
885 elsif( $dbh->{Driver}->{Name} =~ /mysql/i) {
886 push @where, "hour(from_unixtime(cust_main.$field)) = $hour"
889 warn "search by time of day not supported on ".$dbh->{Driver}->{Name}." databases";
893 $orderby ||= "ORDER BY cust_main.$field";
901 if ( $params->{'classnum'} ) {
903 my @classnum = ref( $params->{'classnum'} )
904 ? @{ $params->{'classnum'} }
905 : ( $params->{'classnum'} );
907 @classnum = grep /^(\d*)$/, @classnum;
910 push @where, '( '. join(' OR ', map {
911 $_ ? "cust_main.classnum = $_"
912 : "cust_main.classnum IS NULL"
925 if ( $params->{'invoice_terms'} =~ /^([\w ]+)$/ ) {
927 if ( $1 eq 'NULL' ) {
929 "( cust_main.invoice_terms IS NULL OR cust_main.invoice_terms = '' )";
932 "cust_main.invoice_terms IS NOT NULL",
933 "cust_main.invoice_terms = '$1'";
941 if ( $params->{'current_balance'} ) {
943 #my $balance_sql = $class->balance_sql();
944 my $balance_sql = FS::cust_main->balance_sql();
946 my @current_balance =
947 ref( $params->{'current_balance'} )
948 ? @{ $params->{'current_balance'} }
949 : ( $params->{'current_balance'} );
951 push @where, map { s/current_balance/$balance_sql/; $_ }
960 if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
962 "cust_main.custbatch = '$1'";
965 if ( $params->{'tagnum'} ) {
966 my @tagnums = ref( $params->{'tagnum'} ) ? @{ $params->{'tagnum'} } : ( $params->{'tagnum'} );
968 @tagnums = grep /^(\d+)$/, @tagnums;
971 if ( $params->{'all_tags'} ) {
972 foreach ( @tagnums ) {
973 push @where, 'exists(select 1 from cust_tag where '.
974 'cust_tag.custnum = cust_main.custnum and tagnum = '.
977 } else { # matching any tag, not all
978 my $tags_where = "0 < (select count(1) from cust_tag where "
979 . " cust_tag.custnum = cust_main.custnum and tagnum in ("
980 . join(',', @tagnums) . "))";
982 push @where, $tags_where;
990 if ( $params->{'pkg_classnum'} ) {
991 my @pkg_classnums = ref( $params->{'pkg_classnum'} ) ?
992 @{ $params->{'pkg_classnum'} } :
993 $params->{'pkg_classnum'};
994 @pkg_classnums = grep /^(\d+)$/, @pkg_classnums;
996 if ( @pkg_classnums ) {
999 if ( $params->{'all_pkg_classnums'} ) {
1000 push @pkg_where, "part_pkg.classnum = $_" foreach @pkg_classnums;
1003 'part_pkg.classnum IN('. join(',', @pkg_classnums).')';
1005 foreach (@pkg_where) {
1007 "SELECT 1 FROM cust_pkg JOIN part_pkg USING (pkgpart) WHERE ".
1008 "cust_pkg.custnum = cust_main.custnum AND $_ ";
1009 if ( not $params->{'any_pkg_status'} ) {
1010 $select_pkg .= 'AND '.FS::cust_pkg->active_sql;
1012 push @where, "EXISTS($select_pkg)";
1018 # setup queries, subs, etc. for the search
1021 $orderby ||= 'ORDER BY custnum';
1023 # here is the agent virtualization
1025 $FS::CurrentUser::CurrentUser->agentnums_sql(table => 'cust_main');
1027 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
1030 # always make address fields available in results
1031 for my $pre ('bill_', 'ship_') {
1033 'LEFT JOIN cust_location AS '.$pre.'location '.
1034 'ON (cust_main.'.$pre.'locationnum = '.$pre.'location.locationnum) ';
1037 # always make referral available in results
1038 # (maybe we should be using FS::UI::Web::join_cust_main instead?)
1039 $addl_from .= ' LEFT JOIN (select refnum, referral from part_referral) AS part_referral_x ON (cust_main.refnum = part_referral_x.refnum) ';
1041 my $count_query = "SELECT COUNT(*) FROM cust_main $addl_from $extra_sql";
1044 'cust_main.custnum',
1045 'cust_main.salesnum',
1046 # there's a good chance that we'll need these
1047 'cust_main.bill_locationnum',
1048 'cust_main.ship_locationnum',
1049 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
1052 my @extra_headers = ();
1053 my @extra_fields = ();
1054 my @extra_sort_fields = ();
1057 if ($params->{'contacts'}) {
1058 my $contact_params = $params->{'contacts'};
1061 ' LEFT JOIN cust_contact ON ( cust_main.custnum = cust_contact.custnum ) ';
1063 if ($contact_params->{'contacts_firstname'} || $contact_params->{'contacts_lastname'}) {
1064 $addl_from .= ' LEFT JOIN contact ON ( cust_contact.contactnum = contact.contactnum ) ';
1065 my $first_query = " AND contact.first = '" . $contact_params->{'contacts_firstname'} . "'"
1066 unless !$contact_params->{'contacts_firstname'};
1067 my $last_query = " AND contact.last = '" . $contact_params->{'contacts_lastname'} . "'"
1068 unless !$contact_params->{'contacts_lastname'};
1069 $extra_sql .= " AND ( '1' $first_query $last_query )";
1072 if ($contact_params->{'contacts_email'}) {
1073 $addl_from .= ' LEFT JOIN contact_email ON ( cust_contact.contactnum = contact_email.contactnum ) ';
1074 $extra_sql .= " AND ( contact_email.emailaddress = '" . $contact_params->{'contacts_email'} . "' )";
1077 if ($contact_params->{'contacts_homephone'} || $contact_params->{'contacts_workphone'} || $contact_params->{'contacts_mobilephone'}) {
1078 $addl_from .= ' LEFT JOIN contact_phone ON ( cust_contact.contactnum = contact_phone.contactnum ) ';
1079 my $contacts_mobilephone;
1080 foreach my $phone (qw( contacts_homephone contacts_workphone contacts_mobilephone )) {
1081 (my $num = $contact_params->{$phone}) =~ s/\W//g;
1082 if ( $num =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { $contact_params->{$phone} = "$1$2$3"; }
1084 my $home_query = " AND ( contact_phone.phonetypenum = '2' AND contact_phone.phonenum = '" . $contact_params->{'contacts_homephone'} . "' )"
1085 unless !$contact_params->{'contacts_homephone'};
1086 my $work_query = " AND ( contact_phone.phonetypenum = '1' AND contact_phone.phonenum = '" . $contact_params->{'contacts_workphone'} . "' )"
1087 unless !$contact_params->{'contacts_workphone'};
1088 my $mobile_query = " AND ( contact_phone.phonetypenum = '3' AND contact_phone.phonenum = '" . $contact_params->{'contacts_mobilephone'} . "' )"
1089 unless !$contact_params->{'contacts_mobilephone'};
1090 $extra_sql .= " AND ( '1' $home_query $work_query $mobile_query )";
1095 if ($params->{'flattened_pkgs'}) {
1099 ' LEFT JOIN cust_pkg ON ( cust_main.custnum = cust_pkg.custnum ) ';
1101 if ($dbh->{Driver}->{Name} eq 'Pg') {
1106 SELECT pkg FROM cust_pkg LEFT JOIN part_pkg USING ( pkgpart )
1107 WHERE cust_main.custnum = cust_pkg.custnum $pkgwhere
1112 } elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
1113 push @select, "GROUP_CONCAT(part_pkg.pkg SEPARATOR '|') as magic";
1114 $addl_from .= ' LEFT JOIN part_pkg USING ( pkgpart ) ';
1115 #$pkg_join .= ' LEFT JOIN part_pkg USING ( pkgpart ) ';
1117 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
1118 "omitting package information from report.";
1121 my $header_query = "
1122 SELECT COUNT(cust_pkg.custnum = cust_main.custnum) AS count
1123 FROM cust_main $addl_from $extra_sql $pkgwhere
1124 GROUP BY cust_main.custnum ORDER BY count DESC LIMIT 1
1127 my $sth = dbh->prepare($header_query) or die dbh->errstr;
1128 $sth->execute() or die $sth->errstr;
1129 my $headerrow = $sth->fetchrow_arrayref;
1130 my $headercount = $headerrow ? $headerrow->[0] : 0;
1131 while($headercount) {
1132 unshift @extra_headers, "Package ". $headercount;
1133 unshift @extra_fields, eval q!sub {my $c = shift;
1134 my @a = split '\|', $c->magic;
1135 my $p = $a[!.--$headercount. q!];
1138 unshift @extra_sort_fields, '';
1143 if ( $params->{'with_referrals'} ) {
1145 #XXX next: num for each customer status
1148 '( SELECT COUNT(*) FROM cust_main AS referred_cust_main
1149 WHERE cust_main.custnum = referred_cust_main.referral_custnum
1150 ) AS num_referrals';
1152 unshift @extra_headers, 'Referrals';
1153 unshift @extra_fields, 'num_referrals';
1154 unshift @extra_sort_fields, 'num_referrals';
1158 my $select = join(', ', @select);
1161 'table' => 'cust_main',
1162 'select' => $select,
1163 'addl_from' => $addl_from,
1165 'extra_sql' => $extra_sql,
1166 'order_by' => $orderby,
1167 'count_query' => $count_query,
1168 'extra_headers' => \@extra_headers,
1169 'extra_fields' => \@extra_fields,
1170 'extra_sort_fields' => \@extra_sort_fields,
1176 =item fuzzy_search FUZZY_HASHREF [ OPTS ]
1178 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
1179 records. Currently, I<first>, I<last>, I<company> and/or I<address1> may be
1182 Additional options are the same as FS::Record::qsearch
1189 # sensible defaults, then merge in any passed options
1191 'table' => 'cust_main',
1200 my @fuzzy_mod = 'i';
1201 my $conf = new FS::Conf;
1202 my $fuzziness = $conf->config('fuzzy-fuzziness');
1203 push @fuzzy_mod, $fuzziness if $fuzziness;
1205 check_and_rebuild_fuzzyfiles();
1206 foreach my $field ( keys %$fuzzy ) {
1208 my $all = $self->all_X($field);
1209 next unless scalar(@$all);
1212 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, \@fuzzy_mod, @$all ) );
1213 next if !keys(%match);
1215 my $in_matches = 'IN (' .
1216 join(',', map { dbh->quote($_) } keys %match) .
1219 my $extra_sql = $fuzopts{extra_sql};
1220 if ($extra_sql =~ /^\s*where /i or keys %{ $fuzopts{hashref} }) {
1221 $extra_sql .= ' AND ';
1223 $extra_sql .= 'WHERE ';
1225 $extra_sql .= "$field $in_matches";
1227 my $addl_from = $fuzopts{addl_from};
1228 if ( $field =~ /^cust_location\./ ) {
1229 $addl_from .= ' JOIN cust_location USING (custnum)';
1230 } elsif ( $field =~ /^contact\./ ) {
1231 $addl_from .= ' JOIN contact USING (custnum)';
1234 push @cust_main, qsearch({
1236 'addl_from' => $addl_from,
1237 'extra_sql' => $extra_sql,
1241 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
1243 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
1251 =head1 UTILITY SUBROUTINES
1255 =item check_and_rebuild_fuzzyfiles
1259 sub check_and_rebuild_fuzzyfiles {
1260 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1261 rebuild_fuzzyfiles()
1262 if grep { ! -e "$dir/$_" }
1264 my ($field, $table) = reverse split('\.', $_);
1265 $table ||= 'cust_main';
1271 =item rebuild_fuzzyfiles
1275 sub rebuild_fuzzyfiles {
1277 use Fcntl qw(:flock);
1279 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1280 mkdir $dir, 0700 unless -d $dir;
1282 foreach my $fuzzy ( @fuzzyfields ) {
1284 my ($field, $table) = reverse split('\.', $fuzzy);
1285 $table ||= 'cust_main';
1287 open(LOCK,">>$dir/$table.$field")
1288 or die "can't open $dir/$table.$field: $!";
1290 or die "can't lock $dir/$table.$field: $!";
1292 open (CACHE, '>:encoding(UTF-8)', "$dir/$table.$field.tmp")
1293 or die "can't open $dir/$table.$field.tmp: $!";
1295 my $sth = dbh->prepare(
1296 "SELECT $field FROM $table WHERE $field IS NOT NULL AND $field != ''"
1298 $sth->execute or die $sth->errstr;
1300 while ( my $row = $sth->fetchrow_arrayref ) {
1301 print CACHE $row->[0]. "\n";
1304 close CACHE or die "can't close $dir/$table.$field.tmp: $!";
1306 rename "$dir/$table.$field.tmp", "$dir/$table.$field";
1312 =item append_fuzzyfiles FIRSTNAME LASTNAME COMPANY ADDRESS1
1316 sub append_fuzzyfiles {
1317 #my( $first, $last, $company ) = @_;
1319 check_and_rebuild_fuzzyfiles();
1321 #foreach my $fuzzy (@fuzzyfields) {
1322 foreach my $fuzzy ( 'cust_main.first', 'cust_main.last', 'cust_main.company',
1323 'cust_location.address1',
1324 'cust_main.ship_company',
1327 append_fuzzyfiles_fuzzyfield($fuzzy, shift);
1334 =item append_fuzzyfiles_fuzzyfield COLUMN VALUE
1336 =item append_fuzzyfiles_fuzzyfield TABLE.COLUMN VALUE
1340 use Fcntl qw(:flock);
1341 sub append_fuzzyfiles_fuzzyfield {
1342 my( $fuzzyfield, $value ) = @_;
1344 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1347 my ($field, $table) = reverse split('\.', $fuzzyfield);
1348 $table ||= 'cust_main';
1350 return unless defined($value) && length($value);
1352 open(CACHE, '>>:encoding(UTF-8)', "$dir/$table.$field" )
1353 or die "can't open $dir/$table.$field: $!";
1354 flock(CACHE,LOCK_EX)
1355 or die "can't lock $dir/$table.$field: $!";
1357 print CACHE "$value\n";
1359 flock(CACHE,LOCK_UN)
1360 or die "can't unlock $dir/$table.$field: $!";
1370 my( $self, $fuzzy ) = @_;
1371 my ($field, $table) = reverse split('\.', $fuzzy);
1372 $table ||= 'cust_main';
1374 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1375 open(CACHE, '<:encoding(UTF-8)', "$dir/$table.$field")
1376 or die "can't open $dir/$table.$field: $!";
1377 my @array = map { chomp; $_; } <CACHE>;
1388 L<FS::cust_main>, L<FS::Record>