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
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 )
106 " AND $agentnums_sql", #agent virtualization
109 #contact phone numbers
111 grep $agentnums_href->{$_->agentnum}, #agent virt
112 grep $_, #skip contacts that don't have cust_main records
113 map $_->contact->cust_main,
115 'table' => 'contact_phone',
116 'hashref' => { 'phonenum' => $phonenum },
119 unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
120 #try looking for matches with extensions unless one was specified
122 push @cust_main, qsearch( {
123 'table' => 'cust_main',
124 'hashref' => { %options },
125 'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
127 join(' OR ', map "$_ LIKE '$phonen\%'",
131 " AND $agentnums_sql", #agent virtualization
139 if ( $search =~ /@/ ) { #email address
141 # invoicing email address
143 grep $agentnums_href->{$_->agentnum}, #agent virt
146 'table' => 'cust_main_invoice',
147 'hashref' => { 'dest' => $search },
151 # contact email address
153 grep $agentnums_href->{$_->agentnum}, #agent virt
154 grep $_, #skip contacts that don't have cust_main records
155 map $_->contact->cust_main,
157 'table' => 'contact_email',
158 'hashref' => { 'emailaddress' => $search },
162 # custnum search (also try agent_custid), with some tweaking options if your
163 # legacy cust "numbers" have letters
164 } elsif ( $search =~ /^\s*(\d+)\s*$/
165 || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
166 && $search =~ /^\s*(\w\w?\d+)\s*$/
168 || ( $conf->config('cust_main-custnum-display_special')
169 # it's not currently possible for special prefixes to contain
170 # digits, so just strip off any alphabetic prefix and match
171 # the rest to custnum
172 && $search =~ /^\s*[[:alpha:]]*(\d+)\s*$/
174 || ( $conf->exists('address1-search' )
175 && $search =~ /^\s*(\d+\-?\w*)\s*$/ #i.e. 1234A or 9432-D
182 if ( $num =~ /^(\d+)$/ && $num <= 2147483647 ) { #need a bigint custnum? wow
183 my $agent_custid_null = $conf->exists('cust_main-default_agent_custid')
184 ? ' AND agent_custid IS NULL ' : '';
185 push @cust_main, qsearch( {
186 'table' => 'cust_main',
187 'hashref' => { 'custnum' => $num, %options },
188 'extra_sql' => " AND $agentnums_sql $agent_custid_null",
192 # for all agents this user can see, if any of them have custnum prefixes
193 # that match the search string, include customers that match the rest
194 # of the custnum and belong to that agent
195 foreach my $agentnum ( keys %$agentnums_href ) {
196 my $p = $conf->config('cust_main-custnum-display_prefix', $agentnum);
198 if ( $p eq substr($num, 0, length($p)) ) {
199 push @cust_main, qsearch( {
200 'table' => 'cust_main',
201 'hashref' => { 'custnum' => 0 + substr($num, length($p)),
202 'agentnum' => $agentnum,
209 push @cust_main, qsearch( {
210 'table' => 'cust_main',
211 'hashref' => { 'agent_custid' => $num, %options },
212 'extra_sql' => " AND $agentnums_sql", #agent virtualization
215 if ( $conf->exists('address1-search') ) {
216 my $len = length($num);
218 # probably the Right Thing: return customers that have any associated
219 # locations matching the string, not just bill/ship location
220 push @cust_main, qsearch( {
221 'table' => 'cust_main',
222 'addl_from' => ' JOIN cust_location USING (custnum) ',
223 'hashref' => { %options, },
225 ( keys(%options) ? ' AND ' : ' WHERE ' ).
226 " LOWER(SUBSTRING(cust_location.address1 FROM 1 FOR $len)) = '$num' ".
227 " AND $agentnums_sql",
231 } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
233 my($company, $last, $first) = ( $1, $2, $3 );
235 # "Company (Last, First)"
236 #this is probably something a browser remembered,
237 #so just do an exact search (but case-insensitive, so USPS standardization
238 #doesn't throw a wrench in the works)
240 push @cust_main, qsearch( {
241 'table' => 'cust_main',
242 'hashref' => { %options },
244 ( keys(%options) ? ' AND ' : ' WHERE ' ).
246 " LOWER(first) = ". dbh->quote(lc($first)),
247 " LOWER(last) = ". dbh->quote(lc($last)),
248 " LOWER(company) = ". dbh->quote(lc($company)),
254 # probably not necessary for the "something a browser remembered" case
256 } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
257 # try {first,last,company}
261 # # remove "(Last, First)" in "Company (Last, First)", otherwise the
262 # # full strings the browser remembers won't work
263 # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
265 use Lingua::EN::NameParse;
266 my $NameParse = new Lingua::EN::NameParse(
271 my($last, $first) = ( '', '' );
272 #maybe disable this too and just rely on NameParse?
273 if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
275 ($last, $first) = ( $1, $2 );
277 #} elsif ( $value =~ /^(.+)\s+(.+)$/ ) {
278 } elsif ( ! $NameParse->parse($value) ) {
280 my %name = $NameParse->components;
281 $first = $name{'given_name_1'} || $name{'initials_1'}; #wtf NameParse, Ed?
282 $last = $name{'surname_1'};
286 if ( $first && $last ) {
288 my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
291 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
292 $sql .= "( LOWER(cust_main.last) = $q_last AND LOWER(cust_main.first) = $q_first )";
295 push @cust_main, qsearch( {
296 'table' => 'cust_main',
297 'hashref' => \%options,
298 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
303 grep $agentnums_href->{$_->agentnum}, #agent virt
304 grep $_, #skip contacts that don't have cust_main records
307 'table' => 'contact',
308 'hashref' => { 'first' => $first,
314 # or it just be something that was typed in... (try that in a sec)
318 my $q_value = dbh->quote($value);
321 my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
322 $sql .= " ( LOWER(cust_main.first) = $q_value
323 OR LOWER(cust_main.last) = $q_value
324 OR LOWER(cust_main.company) = $q_value
325 OR LOWER(cust_main.ship_company) = $q_value
328 #address1 (yes, it's a kludge)
329 $sql .= " OR EXISTS (
330 SELECT 1 FROM cust_location
331 WHERE LOWER(cust_location.address1) = $q_value
332 AND cust_location.custnum = cust_main.custnum
334 if $conf->exists('address1-search');
336 #contacts (look, another kludge)
337 $sql .= " OR EXISTS ( SELECT 1 FROM contact
338 WHERE ( LOWER(contact.first) = $q_value
339 OR LOWER(contact.last) = $q_value
341 AND contact.custnum IS NOT NULL
342 AND contact.custnum = cust_main.custnum
346 push @cust_main, qsearch( {
347 'table' => 'cust_main',
348 'hashref' => \%options,
349 'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
352 #no exact match, trying substring/fuzzy
353 #always do substring & fuzzy (unless they're explicity config'ed off)
354 #getting complaints searches are not returning enough
355 unless ( @cust_main && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
357 #still some false laziness w/search (was search/cust_main.cgi)
361 my @company_hashrefs = ();
362 if ( length($value) >= 4 ) {
363 @company_hashrefs = (
364 { 'company' => { op=>'ILIKE', value=>"%$value%" }, },
365 { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
370 if ( $first && $last ) {
373 { 'first' => { op=>'ILIKE', value=>"%$first%" },
374 'last' => { op=>'ILIKE', value=>"%$last%" },
378 } elsif ( length($value) >= 4 ) {
381 { 'first' => { op=>'ILIKE', value=>"%$value%" }, },
382 { 'last' => { op=>'ILIKE', value=>"%$value%" }, },
387 foreach my $hashref ( @company_hashrefs, @hashrefs ) {
389 push @cust_main, qsearch( {
390 'table' => 'cust_main',
391 'hashref' => { %$hashref,
394 'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
399 if ( $conf->exists('address1-search') && length($value) >= 4 ) {
401 push @cust_main, qsearch( {
402 table => 'cust_main',
403 addl_from => 'JOIN cust_location USING (custnum)',
404 extra_sql => 'WHERE '.
405 ' cust_location.address1 ILIKE '.dbh->quote("%$value%").
406 " AND $agentnums_sql", #agent virtualizaiton
413 foreach my $hashref ( @hashrefs ) {
416 grep $agentnums_href->{$_->agentnum}, #agent virt
417 grep $_, #skip contacts that don't have cust_main records
420 'table' => 'contact',
421 'hashref' => { %$hashref,
424 #'extra_sql' => " AND $agentnums_sql", #agent virt
431 'hashref' => \%options,
433 'extra_sql' => "WHERE $agentnums_sql", #agent virtualization
436 if ( $first && $last ) {
437 push @cust_main, FS::cust_main::Search->fuzzy_search(
438 { 'last' => $last, #fuzzy hashref
439 'first' => $first }, #
442 push @cust_main, FS::cust_main::Search->fuzzy_search(
443 { 'contact.last' => $last, #fuzzy hashref
444 'contact.first' => $first }, #
449 foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
450 push @cust_main, FS::cust_main::Search->fuzzy_search(
451 { $field => $value },
455 foreach my $field ( 'first', 'last' ) {
456 push @cust_main, FS::cust_main::Search->fuzzy_search(
457 { "contact.$field" => $value },
461 if ( $conf->exists('address1-search') ) {
463 FS::cust_main::Search->fuzzy_search(
464 { 'cust_location.address1' => $value },
473 ( my $nospace_search = $search ) =~ s/\s//g;
474 ( my $card_search = $nospace_search ) =~ s/\-//g;
475 $card_search =~ s/[x\*\.\_]/x/gi;
477 if ( $card_search =~ /^[\dx]{15,16}$/i ) { #credit card search
479 ( my $like_search = $card_search ) =~ s/x/_/g;
480 my $mask_search = FS::payinfo_Mixin->mask_payinfo('CARD', $card_search);
482 push @cust_main, qsearch({
483 'table' => 'cust_main',
484 'addl_from' => ' JOIN cust_payby USING (custnum)',
486 'extra_sql' => " WHERE ( cust_payby.payinfo LIKE '$like_search'
487 OR cust_payby.paymask = '$mask_search'
489 " AND cust_payby.payby IN ('CARD','DCRD') ".
490 " AND $agentnums_sql", #agent virtulization
496 #eliminate duplicates
498 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
506 Accepts the following options: I<email>, the email address to search for. The
507 email address will be searched for as an email invoice destination and as an
510 #Any additional options are treated as an additional qualifier on the search
513 Returns a (possibly empty) array of FS::cust_main objects (but usually just
521 my $email = delete $options{'email'};
523 #no agent virtualization yet
524 #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
528 if ( $email =~ /([^@]+)\@([^@]+)/ ) {
530 my ( $user, $domain ) = ( $1, $2 );
532 warn "$me smart_search: searching for $user in domain $domain"
536 map { $_->cust_main }
537 map { $_->cust_contact }
540 'table' => 'contact_email',
541 'hashref' => { 'emailaddress' => $email },
548 map $_->cust_svc->cust_pkg,
550 'table' => 'svc_acct',
551 'hashref' => { 'username' => $user, },
553 'AND ( SELECT domain FROM svc_domain
554 WHERE svc_acct.domsvc = svc_domain.svcnum
555 ) = '. dbh->quote($domain),
561 @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
563 warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
580 Returns a qsearch hash expression to search for parameters specified in
581 HASHREF. Valid parameters are
601 listref of start date, end date
605 listref of start date, end date
607 =item spouse_birthdate
609 listref of start date, end date
611 =item anniversary_date
613 listref of start date, end date
615 =item current_balance
617 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
630 my ($class, $params) = @_;
637 # initialize these to prevent warnings
645 'invoice_terms' => '',
651 # explicit custnum(s)
654 if ( $params->{'custnum'} ) {
655 my @custnums = ref($params->{'custnum'}) ?
656 @{ $params->{'custnum'} } :
657 $params->{'custnum'};
659 'cust_main.custnum IN (' .
660 join(',', map { $_ =~ /^(\d+)$/ ? $1 : () } @custnums ) .
661 ')' if scalar(@custnums) > 0;
668 if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
670 "cust_main.agentnum = $1";
677 if ( $params->{'salesnum'} =~ /^(\d+)$/ ) {
678 push @where, ($1 > 0 ) ? "cust_main.salesnum = $1"
679 : 'cust_main.salesnum IS NULL';
686 if ( $params->{'usernum'} =~ /^(\d+)$/ and $1 ) {
688 "cust_main.usernum = $1";
695 #prospect ordered active inactive suspended cancelled
696 if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
697 my $method = $params->{'status'}. '_sql';
698 #push @where, $class->$method();
699 push @where, FS::cust_main->$method();
703 unless ( $params->{location_history} ) {
705 AND ( cust_location.locationnum IN ( cust_main.bill_locationnum,
706 cust_main.ship_locationnum
708 OR cust_location.locationnum IN (
709 SELECT locationnum FROM cust_pkg
710 WHERE cust_pkg.custnum = cust_main.custnum
711 AND locationnum IS NOT NULL
712 AND '. FS::cust_pkg->ncancelled_recurring_sql.'
720 if ( $params->{'address'} ) {
721 # allow this to be an arrayref
722 my @values = ($params->{'address'});
723 @values = @{$values[0]} if ref($values[0]);
725 foreach (grep /\S/, @values) {
726 my $address = dbh->quote('%'. lc($_). '%');
728 "LOWER(cust_location.address1) LIKE $address",
729 "LOWER(cust_location.address2) LIKE $address";
732 push @where, "EXISTS(
733 SELECT 1 FROM cust_location
734 WHERE cust_location.custnum = cust_main.custnum
735 AND (".join(' OR ',@orwhere).")
744 if ( $params->{'city'} =~ /\S/ ) {
745 my $city = dbh->quote($params->{'city'});
746 push @where, "EXISTS(
747 SELECT 1 FROM cust_location
748 WHERE cust_location.custnum = cust_main.custnum
749 AND cust_location.city = $city
757 if ( $params->{'county'} =~ /\S/ ) {
758 my $county = dbh->quote($params->{'county'});
759 push @where, "EXISTS(
760 SELECT 1 FROM cust_location
761 WHERE cust_location.custnum = cust_main.custnum
762 AND cust_location.county = $county
770 if ( $params->{'state'} =~ /\S/ ) {
771 my $state = dbh->quote($params->{'state'});
772 push @where, "EXISTS(
773 SELECT 1 FROM cust_location
774 WHERE cust_location.custnum = cust_main.custnum
775 AND cust_location.state = $state
783 if ( $params->{'zip'} =~ /\S/ ) {
784 my $zip = dbh->quote($params->{'zip'} . '%');
785 push @where, "EXISTS(
786 SELECT 1 FROM cust_location
787 WHERE cust_location.custnum = cust_main.custnum
788 AND cust_location.zip LIKE $zip
796 if ( $params->{'country'} =~ /^(\w\w)$/ ) {
797 my $country = uc($1);
798 push @where, "EXISTS(
799 SELECT 1 FROM cust_location
800 WHERE cust_location.custnum = cust_main.custnum
801 AND cust_location.country = '$country'
809 if ( $params->{'refnum'} ) {
811 my @refnum = ref( $params->{'refnum'} )
812 ? @{ $params->{'refnum'} }
813 : ( $params->{'refnum'} );
815 @refnum = grep /^(\d*)$/, @refnum;
817 push @where, '( '. join(' OR ', map "cust_main.refnum = $_", @refnum ). ' )'
823 # parse cancelled package checkbox
828 $pkgwhere .= "AND (cancel = 0 or cancel is null)"
829 unless $params->{'cancelled_pkgs'};
832 # "with email address(es)" checkbox
836 'EXISTS ( SELECT 1 FROM contact_email
837 JOIN cust_contact USING (contactnum)
838 WHERE cust_contact.custnum = cust_main.custnum
840 if $params->{'with_email'};
843 # "with postal mail invoices" checkbox
846 push @where, "cust_main.postal_invoice = 'Y'"
847 if $params->{'POST'};
850 # "without postal mail invoices" checkbox
853 push @where, "cust_main.postal_invoice IS NULL"
854 if $params->{'no_POST'};
857 # "tax exempt" checkbox
859 push @where, "cust_main.tax = 'Y'"
863 # "not tax exempt" checkbox
865 push @where, "(cust_main.tax = '' OR cust_main.tax IS NULL )"
866 if $params->{'no_tax'};
871 if ( $params->{'with_referrals'} ) {
873 ' EXISTS ( SELECT 1 FROM cust_main AS referred_cust_main
874 WHERE cust_main.custnum = referred_cust_main.referral_custnum )';
881 foreach my $field (qw( signupdate birthdate spouse_birthdate anniversary_date )) {
883 next unless exists($params->{$field});
885 my($beginning, $ending, $hour) = @{$params->{$field}};
888 "cust_main.$field IS NOT NULL",
889 "cust_main.$field >= $beginning",
890 "cust_main.$field <= $ending";
892 if($field eq 'signupdate' && defined $hour) {
893 if ($dbh->{Driver}->{Name} =~ /Pg/i) {
894 push @where, "extract(hour from to_timestamp(cust_main.$field)) = $hour";
896 elsif( $dbh->{Driver}->{Name} =~ /mysql/i) {
897 push @where, "hour(from_unixtime(cust_main.$field)) = $hour"
900 warn "search by time of day not supported on ".$dbh->{Driver}->{Name}." databases";
904 $orderby ||= "ORDER BY cust_main.$field";
912 if ( $params->{'classnum'} ) {
914 my @classnum = ref( $params->{'classnum'} )
915 ? @{ $params->{'classnum'} }
916 : ( $params->{'classnum'} );
918 @classnum = grep /^(\d*)$/, @classnum;
921 push @where, '( '. join(' OR ', map {
922 $_ ? "cust_main.classnum = $_"
923 : "cust_main.classnum IS NULL"
936 if ( $params->{'invoice_terms'} =~ /^([\w ]+)$/ ) {
938 if ( $1 eq 'NULL' ) {
940 "( cust_main.invoice_terms IS NULL OR cust_main.invoice_terms = '' )";
943 "cust_main.invoice_terms IS NOT NULL",
944 "cust_main.invoice_terms = '$1'";
952 if ( $params->{'current_balance'} ) {
954 #my $balance_sql = $class->balance_sql();
955 my $balance_sql = FS::cust_main->balance_sql();
957 my @current_balance =
958 ref( $params->{'current_balance'} )
959 ? @{ $params->{'current_balance'} }
960 : ( $params->{'current_balance'} );
962 push @where, map { s/current_balance/$balance_sql/; $_ }
971 if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
973 "cust_main.custbatch = '$1'";
976 if ( $params->{'tagnum'} ) {
977 my @tagnums = ref( $params->{'tagnum'} ) ? @{ $params->{'tagnum'} } : ( $params->{'tagnum'} );
979 @tagnums = grep /^(\d+)$/, @tagnums;
982 if ( $params->{'all_tags'} ) {
983 foreach ( @tagnums ) {
984 push @where, 'exists(select 1 from cust_tag where '.
985 'cust_tag.custnum = cust_main.custnum and tagnum = '.
988 } else { # matching any tag, not all
989 my $tags_where = "0 < (select count(1) from cust_tag where "
990 . " cust_tag.custnum = cust_main.custnum and tagnum in ("
991 . join(',', @tagnums) . "))";
993 push @where, $tags_where;
1001 if ( $params->{'pkg_classnum'} ) {
1002 my @pkg_classnums = ref( $params->{'pkg_classnum'} ) ?
1003 @{ $params->{'pkg_classnum'} } :
1004 $params->{'pkg_classnum'};
1005 @pkg_classnums = grep /^(\d+)$/, @pkg_classnums;
1007 if ( @pkg_classnums ) {
1010 if ( $params->{'all_pkg_classnums'} ) {
1011 push @pkg_where, "part_pkg.classnum = $_" foreach @pkg_classnums;
1014 'part_pkg.classnum IN('. join(',', @pkg_classnums).')';
1016 foreach (@pkg_where) {
1018 "SELECT 1 FROM cust_pkg JOIN part_pkg USING (pkgpart) WHERE ".
1019 "cust_pkg.custnum = cust_main.custnum AND $_ ";
1020 if ( not $params->{'any_pkg_status'} ) {
1021 $select_pkg .= 'AND '.FS::cust_pkg->active_sql;
1023 push @where, "EXISTS($select_pkg)";
1029 # setup queries, subs, etc. for the search
1032 $orderby ||= 'ORDER BY custnum';
1034 # here is the agent virtualization
1036 $FS::CurrentUser::CurrentUser->agentnums_sql(table => 'cust_main');
1038 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
1041 # always make address fields available in results
1042 for my $pre ('bill_', 'ship_') {
1044 'LEFT JOIN cust_location AS '.$pre.'location '.
1045 'ON (cust_main.'.$pre.'locationnum = '.$pre.'location.locationnum) ';
1048 # always make referral available in results
1049 # (maybe we should be using FS::UI::Web::join_cust_main instead?)
1050 $addl_from .= ' LEFT JOIN (select refnum, referral from part_referral) AS part_referral_x ON (cust_main.refnum = part_referral_x.refnum) ';
1052 my $count_query = "SELECT COUNT(*) FROM cust_main $addl_from $extra_sql";
1055 'cust_main.custnum',
1056 'cust_main.salesnum',
1057 # there's a good chance that we'll need these
1058 'cust_main.bill_locationnum',
1059 'cust_main.ship_locationnum',
1060 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
1063 my(@extra_headers) = ();
1064 my(@extra_fields) = ();
1066 if ($params->{'flattened_pkgs'}) {
1070 ' LEFT JOIN cust_pkg ON ( cust_main.custnum = cust_pkg.custnum ) ';
1072 if ($dbh->{Driver}->{Name} eq 'Pg') {
1077 SELECT pkg FROM cust_pkg LEFT JOIN part_pkg USING ( pkgpart )
1078 WHERE cust_main.custnum = cust_pkg.custnum $pkgwhere
1083 } elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
1084 push @select, "GROUP_CONCAT(part_pkg.pkg SEPARATOR '|') as magic";
1085 $addl_from .= ' LEFT JOIN part_pkg USING ( pkgpart ) ';
1086 #$pkg_join .= ' LEFT JOIN part_pkg USING ( pkgpart ) ';
1088 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
1089 "omitting package information from report.";
1092 my $header_query = "
1093 SELECT COUNT(cust_pkg.custnum = cust_main.custnum) AS count
1094 FROM cust_main $addl_from $extra_sql $pkgwhere
1095 GROUP BY cust_main.custnum ORDER BY count DESC LIMIT 1
1098 my $sth = dbh->prepare($header_query) or die dbh->errstr;
1099 $sth->execute() or die $sth->errstr;
1100 my $headerrow = $sth->fetchrow_arrayref;
1101 my $headercount = $headerrow ? $headerrow->[0] : 0;
1102 while($headercount) {
1103 unshift @extra_headers, "Package ". $headercount;
1104 unshift @extra_fields, eval q!sub {my $c = shift;
1105 my @a = split '\|', $c->magic;
1106 my $p = $a[!.--$headercount. q!];
1113 if ( $params->{'with_referrals'} ) {
1115 #XXX next: num for each customer status
1118 '( SELECT COUNT(*) FROM cust_main AS referred_cust_main
1119 WHERE cust_main.custnum = referred_cust_main.referral_custnum
1120 ) AS num_referrals';
1122 unshift @extra_headers, 'Referrals';
1123 unshift @extra_fields, 'num_referrals';
1127 my $select = join(', ', @select);
1130 'table' => 'cust_main',
1131 'select' => $select,
1132 'addl_from' => $addl_from,
1134 'extra_sql' => $extra_sql,
1135 'order_by' => $orderby,
1136 'count_query' => $count_query,
1137 'extra_headers' => \@extra_headers,
1138 'extra_fields' => \@extra_fields,
1144 =item fuzzy_search FUZZY_HASHREF [ OPTS ]
1146 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
1147 records. Currently, I<first>, I<last>, I<company> and/or I<address1> may be
1150 Additional options are the same as FS::Record::qsearch
1157 # sensible defaults, then merge in any passed options
1159 'table' => 'cust_main',
1168 my @fuzzy_mod = 'i';
1169 my $conf = new FS::Conf;
1170 my $fuzziness = $conf->config('fuzzy-fuzziness');
1171 push @fuzzy_mod, $fuzziness if $fuzziness;
1173 check_and_rebuild_fuzzyfiles();
1174 foreach my $field ( keys %$fuzzy ) {
1176 my $all = $self->all_X($field);
1177 next unless scalar(@$all);
1180 $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, \@fuzzy_mod, @$all ) );
1181 next if !keys(%match);
1183 my $in_matches = 'IN (' .
1184 join(',', map { dbh->quote($_) } keys %match) .
1187 my $extra_sql = $fuzopts{extra_sql};
1188 if ($extra_sql =~ /^\s*where /i or keys %{ $fuzopts{hashref} }) {
1189 $extra_sql .= ' AND ';
1191 $extra_sql .= 'WHERE ';
1193 $extra_sql .= "$field $in_matches";
1195 my $addl_from = $fuzopts{addl_from};
1196 if ( $field =~ /^cust_location\./ ) {
1197 $addl_from .= ' JOIN cust_location USING (custnum)';
1198 } elsif ( $field =~ /^contact\./ ) {
1199 $addl_from .= ' JOIN contact USING (custnum)';
1202 push @cust_main, qsearch({
1204 'addl_from' => $addl_from,
1205 'extra_sql' => $extra_sql,
1209 # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
1211 @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
1219 =head1 UTILITY SUBROUTINES
1223 =item check_and_rebuild_fuzzyfiles
1227 sub check_and_rebuild_fuzzyfiles {
1228 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1229 rebuild_fuzzyfiles()
1230 if grep { ! -e "$dir/$_" }
1232 my ($field, $table) = reverse split('\.', $_);
1233 $table ||= 'cust_main';
1239 =item rebuild_fuzzyfiles
1243 sub rebuild_fuzzyfiles {
1245 use Fcntl qw(:flock);
1247 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1248 mkdir $dir, 0700 unless -d $dir;
1250 foreach my $fuzzy ( @fuzzyfields ) {
1252 my ($field, $table) = reverse split('\.', $fuzzy);
1253 $table ||= 'cust_main';
1255 open(LOCK,">>$dir/$table.$field")
1256 or die "can't open $dir/$table.$field: $!";
1258 or die "can't lock $dir/$table.$field: $!";
1260 open (CACHE, '>:encoding(UTF-8)', "$dir/$table.$field.tmp")
1261 or die "can't open $dir/$table.$field.tmp: $!";
1263 my $sth = dbh->prepare(
1264 "SELECT $field FROM $table WHERE $field IS NOT NULL AND $field != ''"
1266 $sth->execute or die $sth->errstr;
1268 while ( my $row = $sth->fetchrow_arrayref ) {
1269 print CACHE $row->[0]. "\n";
1272 close CACHE or die "can't close $dir/$table.$field.tmp: $!";
1274 rename "$dir/$table.$field.tmp", "$dir/$table.$field";
1280 =item append_fuzzyfiles FIRSTNAME LASTNAME COMPANY ADDRESS1
1284 sub append_fuzzyfiles {
1285 #my( $first, $last, $company ) = @_;
1287 check_and_rebuild_fuzzyfiles();
1289 #foreach my $fuzzy (@fuzzyfields) {
1290 foreach my $fuzzy ( 'cust_main.first', 'cust_main.last', 'cust_main.company',
1291 'cust_location.address1',
1292 'cust_main.ship_company',
1295 append_fuzzyfiles_fuzzyfield($fuzzy, shift);
1302 =item append_fuzzyfiles_fuzzyfield COLUMN VALUE
1304 =item append_fuzzyfiles_fuzzyfield TABLE.COLUMN VALUE
1308 use Fcntl qw(:flock);
1309 sub append_fuzzyfiles_fuzzyfield {
1310 my( $fuzzyfield, $value ) = @_;
1312 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1315 my ($field, $table) = reverse split('\.', $fuzzyfield);
1316 $table ||= 'cust_main';
1318 return unless defined($value) && length($value);
1320 open(CACHE, '>>:encoding(UTF-8)', "$dir/$table.$field" )
1321 or die "can't open $dir/$table.$field: $!";
1322 flock(CACHE,LOCK_EX)
1323 or die "can't lock $dir/$table.$field: $!";
1325 print CACHE "$value\n";
1327 flock(CACHE,LOCK_UN)
1328 or die "can't unlock $dir/$table.$field: $!";
1338 my( $self, $fuzzy ) = @_;
1339 my ($field, $table) = reverse split('\.', $fuzzy);
1340 $table ||= 'cust_main';
1342 my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1343 open(CACHE, '<:encoding(UTF-8)', "$dir/$table.$field")
1344 or die "can't open $dir/$table.$field: $!";
1345 my @array = map { chomp; $_; } <CACHE>;
1356 L<FS::cust_main>, L<FS::Record>