cust_main fields only
[freeside.git] / FS / FS / cust_main / Search.pm
1 package FS::cust_main::Search;
2
3 use strict;
4 use base qw( Exporter );
5 use vars qw( @EXPORT_OK $DEBUG $me $conf @fuzzyfields );
6 use String::Approx qw(amatch);
7 use FS::UID qw( dbh );
8 use FS::Record qw( qsearch );
9 use FS::cust_main;
10 use FS::cust_main_invoice;
11 use FS::svc_acct;
12 use FS::payinfo_Mixin;
13
14 @EXPORT_OK = qw( smart_search );
15
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
19 $DEBUG = 0;
20 $me = '[FS::cust_main::Search]';
21
22 @fuzzyfields = (
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',
27 );
28
29 install_callback FS::UID sub { 
30   $conf = new FS::Conf;
31   #yes, need it for stuff below (prolly should be cached)
32 };
33
34 =head1 NAME
35
36 FS::cust_main::Search - Customer searching
37
38 =head1 SYNOPSIS
39
40   use FS::cust_main::Search;
41
42   FS::cust_main::Search::smart_search(%options);
43
44   FS::cust_main::Search::email_search(%options);
45
46   FS::cust_main::Search->search( \%options );
47   
48   FS::cust_main::Search->fuzzy_search( \%fuzzy_hashref );
49
50 =head1 SUBROUTINES
51
52 =over 4
53
54 =item smart_search OPTION => VALUE ...
55
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
59 number.
60
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
63 smart_search to
64 skip fuzzy matching when an exact match is found.
65
66 Any additional options are treated as an additional qualifier on the search
67 (i.e. I<agentnum>).
68
69 Returns a (possibly empty) array of FS::cust_main objects.
70
71 =cut
72
73 sub smart_search {
74   my %options = @_;
75
76   #here is the agent virtualization
77   my $agentnums_sql = 
78     $FS::CurrentUser::CurrentUser->agentnums_sql(table => 'cust_main');
79   my $agentnums_href = $FS::CurrentUser::CurrentUser->agentnums_href;
80
81   my @cust_main = ();
82
83   my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
84   my $search = delete $options{'search'};
85   ( my $alphanum_search = $search ) =~ s/\W//g;
86   
87   if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
88
89     #false laziness w/Record::ut_phone
90     my $phonen = "$1-$2-$3";
91     $phonen .= " x$4" if $4;
92
93     my $phonenum = "$1$2$3";
94     #my $extension = $4;
95
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 ' ).
104                      ' ( '.
105                          join(' OR ', map "$_ = '$phonen'",
106                                           qw( daytime night mobile fax )
107                              ).
108                           " OR phonenum = '$phonenum' ".
109                      ' ) '.
110                      " AND $agentnums_sql", #agent virtualization
111     } );
112
113     unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
114       #try looking for matches with extensions unless one was specified
115
116       push @cust_main, qsearch( {
117         'table'     => 'cust_main',
118         'hashref'   => { %options },
119         'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
120                        ' ( '.
121                            join(' OR ', map "$_ LIKE '$phonen\%'",
122                                             qw( daytime night )
123                                ).
124                        ' ) '.
125                        " AND $agentnums_sql", #agent virtualization
126       } );
127
128     }
129
130   } 
131   
132   
133   if ( $search =~ /@/ ) { #email address from cust_main_invoice and contact_email
134
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 ' ).
143                      ' ( '.
144                          join(' OR ', map "$_ = '$search'",
145                                           qw( dest emailaddress )
146                              ).
147                      ' ) '.
148                      " AND $agentnums_sql", #agent virtualization
149     } );
150
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*$/
156                )
157             or ( $conf->config('cust_main-agent_custid-format') eq 'd+-w'
158                  && $search =~ /^\s*(\d+-\w)\s*$/
159                )
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*$/
165                )
166             or ( $conf->exists('address1-search' )
167                  && $search =~ /^\s*(\d+\-?\w*)\s*$/ #i.e. 1234A or 9432-D
168                )
169           )
170   {
171
172     my $num = $1;
173
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",
181       } );
182     }
183
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);
189       next if !$p;
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,
195                           %options,
196                        },
197         } );
198       }
199     }
200
201     push @cust_main, qsearch( {
202         'table'     => 'cust_main',
203         'hashref'   => { 'agent_custid' => $num, %options },
204         'extra_sql' => " AND $agentnums_sql", #agent virtualization
205     } );
206
207     if ( $conf->exists('address1-search') ) {
208       my $len = length($num);
209       $num = lc($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         'select'    => 'cust_main.*',
214         'table'     => 'cust_main',
215         'addl_from' => ' JOIN cust_location USING (custnum) ',
216         'hashref'   => { %options, },
217         'extra_sql' => 
218           ( keys(%options) ? ' AND ' : ' WHERE ' ).
219           " LOWER(SUBSTRING(cust_location.address1 FROM 1 FOR $len)) = '$num' ".
220           " AND $agentnums_sql",
221       } );
222     }
223
224   } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
225
226     my($company, $last, $first) = ( $1, $2, $3 );
227
228     # "Company (Last, First)"
229     #this is probably something a browser remembered,
230     #so just do an exact search (but case-insensitive, so USPS standardization
231     #doesn't throw a wrench in the works)
232
233     push @cust_main, qsearch( {
234       'table'     => 'cust_main',
235       'hashref'   => { %options },
236       'extra_sql' => 
237         ( keys(%options) ? ' AND ' : ' WHERE ' ).
238         join(' AND ',
239           " LOWER(first)   = ". dbh->quote(lc($first)),
240           " LOWER(last)    = ". dbh->quote(lc($last)),
241           " LOWER(company) = ". dbh->quote(lc($company)),
242           $agentnums_sql,
243         ),
244     } );
245
246     #contacts?
247     # probably not necessary for the "something a browser remembered" case
248
249   } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
250                                               # try {first,last,company}
251
252     my $value = lc($1);
253
254     # # remove "(Last, First)" in "Company (Last, First)", otherwise the
255     # # full strings the browser remembers won't work
256     # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
257
258     use Lingua::EN::NameParse;
259     my $NameParse = new Lingua::EN::NameParse(
260              auto_clean     => 1,
261              allow_reversed => 1,
262     );
263
264     my($last, $first) = ( '', '' );
265     #maybe disable this too and just rely on NameParse?
266     if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
267     
268       ($last, $first) = ( $1, $2 );
269     
270     #} elsif  ( $value =~ /^(.+)\s+(.+)$/ ) {
271     } elsif ( ! $NameParse->parse($value) ) {
272
273       my %name = $NameParse->components;
274       $first = lc($name{'given_name_1'}) || $name{'initials_1'}; #wtf NameParse, Ed?
275       $last  = lc($name{'surname_1'});
276
277     }
278
279     if ( $first && $last ) {
280
281       my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
282
283       #exact
284       my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
285       $sql .= "( (LOWER(cust_main.last) = $q_last AND LOWER(cust_main.first) = $q_first)
286                  OR (LOWER(contact.last) = $q_last AND LOWER(contact.first) = $q_first) )";
287
288       #cust_main and contacts
289       push @cust_main, qsearch( {
290         'select'    => 'cust_main.*',
291         'table'     => 'cust_main',
292         'addl_from' => ' left join cust_contact using (custnum) '.
293                        ' left join contact using (contactnum) ',
294         'hashref'   => { %options },
295         'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
296       } );
297
298       # or it just be something that was typed in... (try that in a sec)
299
300     }
301
302     my $q_value = dbh->quote($value);
303
304     #exact
305     my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
306     $sql .= " (    LOWER(cust_main.first)         = $q_value
307                 OR LOWER(cust_main.last)          = $q_value
308                 OR LOWER(cust_main.company)       = $q_value
309                 OR LOWER(cust_main.ship_company)  = $q_value
310                 OR LOWER(contact.first)           = $q_value
311                 OR LOWER(contact.last)            = $q_value
312             )";
313
314     #address1 (yes, it's a kludge)
315     $sql .= "   OR EXISTS ( 
316                             SELECT 1 FROM cust_location 
317                               WHERE LOWER(cust_location.address1) = $q_value
318                                 AND cust_location.custnum = cust_main.custnum
319                           )"
320       if $conf->exists('address1-search');
321
322     push @cust_main, qsearch( {
323       'select'    => 'cust_main.*',
324       'table'     => 'cust_main',
325       'addl_from' => ' left join cust_contact using (custnum) '.
326                      ' left join contact using (contactnum) ',
327       'hashref'   => { %options },
328       'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
329     } );
330
331     #no exact match, trying substring/fuzzy
332     #always do substring & fuzzy (unless they're explicity config'ed off)
333     #getting complaints searches are not returning enough
334     unless ( @cust_main  && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
335
336       #still some false laziness w/search (was search/cust_main.cgi)
337
338       my $min_len =
339         $FS::CurrentUser::CurrentUser->access_right('List all customers')
340         ? 3 : 4;
341
342       #substring
343
344       my @company_hashrefs = ();
345       if ( length($value) >= $min_len ) {
346         @company_hashrefs = (
347           { 'company'      => { op=>'ILIKE', value=>"%$value%" }, },
348           { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
349         );
350       }
351
352       my @hashrefs = ();
353       if ( $first && $last ) {
354
355         @hashrefs = (
356           { 'first'        => { op=>'ILIKE', value=>"%$first%" },
357             'last'         => { op=>'ILIKE', value=>"%$last%" },
358           },
359         );
360
361       } elsif ( length($value) >= $min_len ) {
362
363         @hashrefs = (
364           { 'first'        => { op=>'ILIKE', value=>"%$value%" }, },
365           { 'last'         => { op=>'ILIKE', value=>"%$value%" }, },
366         );
367
368       }
369
370       foreach my $hashref ( @company_hashrefs, @hashrefs ) {
371
372         push @cust_main, qsearch( {
373           'table'     => 'cust_main',
374           'hashref'   => { %$hashref,
375                            %options,
376                          },
377           'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
378         } );
379
380       }
381
382       if ( $conf->exists('address1-search') && length($value) >= $min_len ) {
383
384         push @cust_main, qsearch( {
385           select    => 'cust_main.*',
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
391         } );
392
393       }
394
395       #contact substring
396
397       foreach my $hashref ( @hashrefs ) {
398
399         push @cust_main,
400           grep $agentnums_href->{$_->agentnum}, #agent virt
401             grep $_, #skip contacts that don't have cust_main records
402               map $_->cust_main,
403                 qsearch({
404                           'table'     => 'contact',
405                           'hashref'   => { %$hashref,
406                                            #%options,
407                                          },
408                           #'extra_sql' => " AND $agentnums_sql", #agent virt
409                        });
410
411       }
412
413       #fuzzy
414       my %fuzopts = (
415         'hashref'   => \%options,
416         'select'    => '',
417         'extra_sql' => "WHERE $agentnums_sql",    #agent virtualization
418       );
419
420       if ( $first && $last ) {
421         push @cust_main, FS::cust_main::Search->fuzzy_search(
422           { 'last'   => $last,    #fuzzy hashref
423             'first'  => $first }, #
424           %fuzopts
425         );
426         push @cust_main, FS::cust_main::Search->fuzzy_search(
427           { 'contact.last'   => $last,    #fuzzy hashref
428             'contact.first'  => $first }, #
429           %fuzopts
430         );
431       }
432
433       foreach my $field ( 'first', 'last', 'company', 'ship_company' ) {
434         push @cust_main, FS::cust_main::Search->fuzzy_search(
435           { $field => $value },
436           %fuzopts
437         );
438       }
439       foreach my $field ( 'first', 'last' ) {
440         push @cust_main, FS::cust_main::Search->fuzzy_search(
441           { "contact.$field" => $value },
442           %fuzopts
443         );
444       }
445       if ( $conf->exists('address1-search') ) {
446         push @cust_main,
447           FS::cust_main::Search->fuzzy_search(
448             { 'cust_location.address1' => $value },
449             %fuzopts
450         );
451       }
452
453     }
454
455   }
456
457   ( my $nospace_search = $search ) =~ s/\s//g;
458   ( my $card_search = $nospace_search ) =~ s/\-//g;
459   $card_search =~ s/[x\*\.\_]/x/gi;
460   
461   if ( $card_search =~ /^[\dx]{15,16}$/i ) { #credit card search
462
463     ( my $like_search = $card_search ) =~ s/x/_/g;
464     my $mask_search = FS::payinfo_Mixin->mask_payinfo('CARD', $card_search);
465
466     push @cust_main, qsearch({
467       'table'     => 'cust_main',
468       'addl_from' => ' JOIN cust_payby USING (custnum)',
469       'hashref'   => {},
470       'extra_sql' => " WHERE (    cust_payby.payinfo LIKE '$like_search'
471                                OR cust_payby.paymask =    '$mask_search'
472                              ) ".
473                      " AND cust_payby.payby IN ('CARD','DCRD') ".
474                      " AND $agentnums_sql", #agent virtulization
475     });
476
477   }
478   
479
480   #eliminate duplicates
481   my %saw = ();
482   @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
483
484   @cust_main;
485
486 }
487
488 =item email_search
489
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
492 svc_acct account.
493
494 #Any additional options are treated as an additional qualifier on the search
495 #(i.e. I<agentnum>).
496
497 Returns a (possibly empty) array of FS::cust_main objects (but usually just
498 none or one).
499
500 =cut
501
502 sub email_search {
503   my %options = @_;
504
505   my $email = delete $options{'email'};
506
507   #no agent virtualization yet
508   #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
509
510   my @cust_main = ();
511
512   if ( $email =~ /([^@]+)\@([^@]+)/ ) {
513
514     my ( $user, $domain ) = ( $1, $2 );
515
516     warn "$me smart_search: searching for $user in domain $domain"
517       if $DEBUG;
518
519     push @cust_main,
520       map { $_->cust_main }
521       map { $_->cust_contact }
522       map { $_->contact }
523           qsearch( {
524                      'table'     => 'contact_email',
525                      'hashref'   => { 'emailaddress' => $email },
526                    }
527                  );
528
529     push @cust_main,
530       map  $_->cust_main,
531       grep $_,
532       map  $_->cust_svc->cust_pkg,
533           qsearch( {
534                      'table'     => 'svc_acct',
535                      'hashref'   => { 'username' => $user, },
536                      'extra_sql' =>
537                        'AND ( SELECT domain FROM svc_domain
538                                 WHERE svc_acct.domsvc = svc_domain.svcnum
539                             ) = '. dbh->quote($domain),
540                    }
541                  );
542   }
543
544   my %saw = ();
545   @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
546
547   warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
548     if $DEBUG;
549
550   @cust_main;
551
552 }
553
554 =back
555
556 =head1 CLASS METHODS
557
558 =over 4
559
560 =item search HASHREF
561
562 (Class method)
563
564 Returns a qsearch hash expression to search for parameters specified in
565 HASHREF.  Valid parameters are
566
567 =over 4
568
569 =item agentnum
570
571 =item status
572
573 =item address
574
575 =item zip
576
577 =item refnum
578
579 =item cancelled_pkgs
580
581 bool
582
583 =item signupdate
584
585 listref of start date, end date
586
587 =item birthdate
588
589 listref of start date, end date
590
591 =item spouse_birthdate
592
593 listref of start date, end date
594
595 =item anniversary_date
596
597 listref of start date, end date
598
599 =item current_balance
600
601 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
602
603 =item cust_fields
604
605 =item flattened_pkgs
606
607 bool
608
609 =back
610
611 =cut
612
613 sub search {
614   my ($class, $params) = @_;
615
616   my $dbh = dbh;
617
618   my @where = ();
619   my $orderby;
620
621   # initialize these to prevent warnings
622   $params = {
623     'custnum'       => '',
624     'agentnum'      => '',
625     'usernum'       => '',
626     'status'        => '',
627     'address'       => '',
628     'zip'           => '',
629     'invoice_terms' => '',
630     'custbatch'     => '',
631     %$params
632   };
633
634   ##
635   # explicit custnum(s)
636   ##
637
638   if ( $params->{'custnum'} ) {
639     my @custnums = ref($params->{'custnum'}) ? 
640                       @{ $params->{'custnum'} } : 
641                       $params->{'custnum'};
642     push @where, 
643       'cust_main.custnum IN (' . 
644       join(',', map { $_ =~ /^(\d+)$/ ? $1 : () } @custnums ) .
645       ')' if scalar(@custnums) > 0;
646   }
647
648   ##
649   # parse agent
650   ##
651
652   if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
653     push @where,
654       "cust_main.agentnum = $1";
655   }
656
657   ##
658   # parse sales person
659   ##
660
661   if ( $params->{'salesnum'} =~ /^(\d+)$/ ) {
662     push @where, ($1 > 0 ) ? "cust_main.salesnum = $1"
663                            : 'cust_main.salesnum IS NULL';
664   }
665
666   ##
667   # parse usernum
668   ##
669
670   if ( $params->{'usernum'} =~ /^(\d+)$/ and $1 ) {
671     push @where,
672       "cust_main.usernum = $1";
673   }
674
675   ##
676   # parse status
677   ##
678
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();
684   }
685
686   my $current = '';
687   unless ( $params->{location_history} ) {
688     $current = '
689       AND (    cust_location.locationnum IN ( cust_main.bill_locationnum,
690                                               cust_main.ship_locationnum
691                                             )
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.'
697                )
698           )';
699   }
700
701   ##
702   # address
703   ##
704   if ( $params->{'address'} ) {
705     # allow this to be an arrayref
706     my @values = ($params->{'address'});
707     @values = @{$values[0]} if ref($values[0]);
708     my @orwhere;
709     foreach (grep /\S/, @values) {
710       my $address = dbh->quote('%'. lc($_). '%');
711       push @orwhere,
712         "LOWER(cust_location.address1) LIKE $address",
713         "LOWER(cust_location.address2) LIKE $address";
714     }
715     if (@orwhere) {
716       push @where, "EXISTS(
717         SELECT 1 FROM cust_location 
718         WHERE cust_location.custnum = cust_main.custnum
719           AND (".join(' OR ',@orwhere).")
720           $current
721         )";
722     }
723   }
724
725   ##
726   # city
727   ##
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
734         $current
735     )";
736   }
737
738   ##
739   # county
740   ##
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
747         $current
748     )";
749   }
750
751   ##
752   # state
753   ##
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
760         $current
761     )";
762   }
763
764   ##
765   # zipcode
766   ##
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
773         $current
774     )";
775   }
776
777   ##
778   # country
779   ##
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'
786         $current
787     )";
788   }
789
790   ###
791   # refnum
792   ###
793   if ( $params->{'refnum'}  ) {
794
795     my @refnum = ref( $params->{'refnum'} )
796                    ? @{ $params->{'refnum'} }
797                    :  ( $params->{'refnum'} );
798
799     @refnum = grep /^(\d*)$/, @refnum;
800
801     push @where, '( '. join(' OR ', map "cust_main.refnum = $_", @refnum ). ' )'
802       if @refnum;
803
804   }
805
806   ##
807   # parse cancelled package checkbox
808   ##
809
810   my $pkgwhere = "";
811
812   $pkgwhere .= "AND (cancel = 0 or cancel is null)"
813     unless $params->{'cancelled_pkgs'};
814
815   ##
816   # "with email address(es)" checkbox
817   ##
818
819   push @where,
820     'EXISTS ( SELECT 1 FROM contact_email
821                 JOIN cust_contact USING (contactnum)
822                 WHERE cust_contact.custnum = cust_main.custnum
823             )'
824     if $params->{'with_email'};
825
826   ##
827   # "with postal mail invoices" checkbox
828   ##
829
830   push @where, "cust_main.postal_invoice = 'Y'"
831     if $params->{'POST'};
832
833   ##
834   # "without postal mail invoices" checkbox
835   ##
836
837   push @where, "cust_main.postal_invoice IS NULL"
838     if $params->{'no_POST'};
839
840   ##
841   # "tax exempt" checkbox
842   ##
843   push @where, "cust_main.tax = 'Y'"
844     if $params->{'tax'};
845
846   ##
847   # "not tax exempt" checkbox
848   ##
849   push @where, "(cust_main.tax = '' OR cust_main.tax IS NULL )"
850     if $params->{'no_tax'};
851
852   ##
853   # with referrals
854   ##
855   if ( $params->{with_referrals} =~ /^\s*(\d+)\s*$/ ) {
856
857     my $n = $1;
858   
859     # referral status
860     my $and_status = '';
861     if ( grep { $params->{referral_status} eq $_ } FS::cust_main->statuses() ) {
862       my $method = $params->{referral_status}. '_sql';
863       $and_status = ' AND '. FS::cust_main->$method();
864       $and_status =~ s/ cust_main\./ referred_cust_main./g;
865     }
866
867     push @where,
868       " $n <= ( SELECT COUNT(*) FROM cust_main AS referred_cust_main
869                   WHERE cust_main.custnum = referred_cust_main.referral_custnum
870                     $and_status
871               )";
872
873   }
874
875   ##
876   # dates
877   ##
878
879   foreach my $field (qw( signupdate birthdate spouse_birthdate anniversary_date )) {
880
881     next unless exists($params->{$field});
882
883     my($beginning, $ending, $hour) = @{$params->{$field}};
884
885     push @where,
886       "cust_main.$field IS NOT NULL",
887       "cust_main.$field >= $beginning",
888       "cust_main.$field <= $ending";
889
890     if($field eq 'signupdate' && defined $hour) {
891       if ($dbh->{Driver}->{Name} =~ /Pg/i) {
892         push @where, "extract(hour from to_timestamp(cust_main.$field)) = $hour";
893       }
894       elsif( $dbh->{Driver}->{Name} =~ /mysql/i) {
895         push @where, "hour(from_unixtime(cust_main.$field)) = $hour"
896       }
897       else {
898         warn "search by time of day not supported on ".$dbh->{Driver}->{Name}." databases";
899       }
900     }
901
902     $orderby ||= "ORDER BY cust_main.$field";
903
904   }
905
906   ###
907   # classnum
908   ###
909
910   if ( $params->{'classnum'} ) {
911
912     my @classnum = ref( $params->{'classnum'} )
913                      ? @{ $params->{'classnum'} }
914                      :  ( $params->{'classnum'} );
915
916     @classnum = grep /^(\d*)$/, @classnum;
917
918     if ( @classnum ) {
919       push @where, '( '. join(' OR ', map {
920                                             $_ ? "cust_main.classnum = $_"
921                                                : "cust_main.classnum IS NULL"
922                                           }
923                                           @classnum
924                              ).
925                    ' )';
926     }
927
928   }
929
930   ###
931   # invoice terms
932   ###
933
934   if ( $params->{'invoice_terms'} =~ /^([\w ]+)$/ ) {
935     my $terms = $1;
936     if ( $1 eq 'NULL' ) {
937       push @where,
938         "( cust_main.invoice_terms IS NULL OR cust_main.invoice_terms = '' )";
939     } else {
940       push @where,
941         "cust_main.invoice_terms IS NOT NULL",
942         "cust_main.invoice_terms = '$1'";
943     }
944   }
945
946   ##
947   # amounts
948   ##
949
950   if ( $params->{'current_balance'} ) {
951
952     #my $balance_sql = $class->balance_sql();
953     my $balance_sql = FS::cust_main->balance_sql();
954
955     my @current_balance =
956       ref( $params->{'current_balance'} )
957       ? @{ $params->{'current_balance'} }
958       :  ( $params->{'current_balance'} );
959
960     push @where, map { s/current_balance/$balance_sql/; $_ }
961                      @current_balance;
962
963   }
964
965   ##
966   # custbatch
967   ##
968
969   if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
970     push @where,
971       "cust_main.custbatch = '$1'";
972   }
973   
974   if ( $params->{'tagnum'} ) {
975     my @tagnums = ref( $params->{'tagnum'} ) ? @{ $params->{'tagnum'} } : ( $params->{'tagnum'} );
976
977     @tagnums = grep /^(\d+)$/, @tagnums;
978
979     if ( @tagnums ) {
980       if ( $params->{'all_tags'} ) {
981         foreach ( @tagnums ) {
982           push @where, 'exists(select 1 from cust_tag where '.
983                        'cust_tag.custnum = cust_main.custnum and tagnum = '.
984                        $_ . ')';
985         }
986       } else { # matching any tag, not all
987         my $tags_where = "0 < (select count(1) from cust_tag where " 
988                 . " cust_tag.custnum = cust_main.custnum and tagnum in ("
989                 . join(',', @tagnums) . "))";
990
991         push @where, $tags_where;
992       }
993     }
994   }
995
996   # pkg_classnum
997   #   all_pkg_classnums
998   #   any_pkg_status
999   if ( $params->{'pkg_classnum'} ) {
1000     my @pkg_classnums = ref( $params->{'pkg_classnum'} ) ?
1001                           @{ $params->{'pkg_classnum'} } :
1002                              $params->{'pkg_classnum'};
1003     @pkg_classnums = grep /^(\d+)$/, @pkg_classnums;
1004
1005     if ( @pkg_classnums ) {
1006
1007       my @pkg_where;
1008       if ( $params->{'all_pkg_classnums'} ) {
1009         push @pkg_where, "part_pkg.classnum = $_" foreach @pkg_classnums;
1010       } else {
1011         push @pkg_where,
1012           'part_pkg.classnum IN('. join(',', @pkg_classnums).')';
1013       }
1014       foreach (@pkg_where) {
1015         my $select_pkg = 
1016           "SELECT 1 FROM cust_pkg JOIN part_pkg USING (pkgpart) WHERE ".
1017           "cust_pkg.custnum = cust_main.custnum AND $_ ";
1018         if ( not $params->{'any_pkg_status'} ) {
1019           $select_pkg .= 'AND '.FS::cust_pkg->active_sql;
1020         }
1021         push @where, "EXISTS($select_pkg)";
1022       }
1023     }
1024   }
1025
1026   ##
1027   # setup queries, subs, etc. for the search
1028   ##
1029
1030   $orderby ||= 'ORDER BY custnum';
1031
1032   # here is the agent virtualization
1033   push @where,
1034     $FS::CurrentUser::CurrentUser->agentnums_sql(table => 'cust_main');
1035
1036   my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
1037
1038   my $addl_from = '';
1039   # always make address fields available in results
1040   for my $pre ('bill_', 'ship_') {
1041     $addl_from .= 
1042       'LEFT JOIN cust_location AS '.$pre.'location '.
1043       'ON (cust_main.'.$pre.'locationnum = '.$pre.'location.locationnum) ';
1044   }
1045
1046   # always make referral available in results
1047   #   (maybe we should be using FS::UI::Web::join_cust_main instead?)
1048   $addl_from .= ' LEFT JOIN (select refnum, referral from part_referral) AS part_referral_x ON (cust_main.refnum = part_referral_x.refnum) ';
1049
1050   my $count_query = "SELECT COUNT(*) FROM cust_main $addl_from $extra_sql";
1051
1052   my @select = (
1053                  'cust_main.custnum',
1054                  'cust_main.salesnum',
1055                  # there's a good chance that we'll need these
1056                  'cust_main.bill_locationnum',
1057                  'cust_main.ship_locationnum',
1058                  FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
1059                );
1060
1061   my @extra_headers     = ();
1062   my @extra_fields      = ();
1063   my @extra_sort_fields = ();
1064
1065   ## search contacts
1066   if ($params->{'contacts'}) {
1067     my $contact_params = $params->{'contacts'};
1068
1069     $addl_from .=
1070       ' LEFT JOIN cust_contact ON ( cust_main.custnum = cust_contact.custnum ) ';
1071
1072     if ($contact_params->{'contacts_firstname'} || $contact_params->{'contacts_lastname'}) {
1073       $addl_from .= ' LEFT JOIN contact ON ( cust_contact.contactnum = contact.contactnum ) ';
1074       my $first_query = " AND contact.first = '" . $contact_params->{'contacts_firstname'} . "'"
1075         unless !$contact_params->{'contacts_firstname'};
1076       my $last_query = " AND contact.last = '" . $contact_params->{'contacts_lastname'} . "'"
1077         unless !$contact_params->{'contacts_lastname'};
1078       $extra_sql .= " AND ( '1' $first_query $last_query )";
1079     }
1080
1081     if ($contact_params->{'contacts_email'}) {
1082       $addl_from .= ' LEFT JOIN contact_email ON ( cust_contact.contactnum = contact_email.contactnum ) ';
1083       $extra_sql .= " AND ( contact_email.emailaddress = '" . $contact_params->{'contacts_email'} . "' )";
1084     }
1085
1086     if ($contact_params->{'contacts_homephone'} || $contact_params->{'contacts_workphone'} || $contact_params->{'contacts_mobilephone'}) {
1087       $addl_from .= ' LEFT JOIN contact_phone ON ( cust_contact.contactnum = contact_phone.contactnum ) ';
1088       my $contacts_mobilephone;
1089       foreach my $phone (qw( contacts_homephone contacts_workphone contacts_mobilephone )) {
1090         (my $num = $contact_params->{$phone}) =~ s/\W//g;
1091         if ( $num =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { $contact_params->{$phone} = "$1$2$3"; }
1092       }
1093       my $home_query = " AND ( contact_phone.phonetypenum = '2' AND contact_phone.phonenum = '" . $contact_params->{'contacts_homephone'} . "' )"
1094         unless !$contact_params->{'contacts_homephone'};
1095       my $work_query = " AND ( contact_phone.phonetypenum = '1' AND contact_phone.phonenum = '" . $contact_params->{'contacts_workphone'} . "' )"
1096         unless !$contact_params->{'contacts_workphone'};
1097       my $mobile_query = " AND ( contact_phone.phonetypenum = '3' AND contact_phone.phonenum = '" . $contact_params->{'contacts_mobilephone'} . "' )"
1098         unless !$contact_params->{'contacts_mobilephone'};
1099       $extra_sql .= " AND ( '1' $home_query $work_query $mobile_query )";
1100     }
1101
1102   }
1103
1104   if ($params->{'flattened_pkgs'}) {
1105
1106     #my $pkg_join = '';
1107     $addl_from .=
1108       ' LEFT JOIN cust_pkg ON ( cust_main.custnum = cust_pkg.custnum ) ';
1109
1110     if ($dbh->{Driver}->{Name} eq 'Pg') {
1111
1112       push @select, "
1113         ARRAY_TO_STRING(
1114           ARRAY(
1115             SELECT pkg FROM cust_pkg LEFT JOIN part_pkg USING ( pkgpart )
1116               WHERE cust_main.custnum = cust_pkg.custnum $pkgwhere
1117           ), '|'
1118         ) AS magic
1119       ";
1120
1121     } elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
1122       push @select, "GROUP_CONCAT(part_pkg.pkg SEPARATOR '|') as magic";
1123       $addl_from .= ' LEFT JOIN part_pkg USING ( pkgpart ) ';
1124       #$pkg_join  .= ' LEFT JOIN part_pkg USING ( pkgpart ) ';
1125     } else {
1126       warn "warning: unknown database type ". $dbh->{Driver}->{Name}. 
1127            "omitting package information from report.";
1128     }
1129
1130     my $header_query = "
1131       SELECT COUNT(cust_pkg.custnum = cust_main.custnum) AS count
1132         FROM cust_main $addl_from $extra_sql $pkgwhere
1133           GROUP BY cust_main.custnum ORDER BY count DESC LIMIT 1
1134     ";
1135
1136     my $sth = dbh->prepare($header_query) or die dbh->errstr;
1137     $sth->execute() or die $sth->errstr;
1138     my $headerrow = $sth->fetchrow_arrayref;
1139     my $headercount = $headerrow ? $headerrow->[0] : 0;
1140     while($headercount) {
1141       unshift @extra_headers, "Package ". $headercount;
1142       unshift @extra_fields, eval q!sub {my $c = shift;
1143                                          my @a = split '\|', $c->magic;
1144                                          my $p = $a[!.--$headercount. q!];
1145                                          $p;
1146                                         };!;
1147       unshift @extra_sort_fields, '';
1148     }
1149
1150   }
1151
1152   if ( $params->{'with_referrals'} ) {
1153
1154     #XXX next: num for each customer status
1155      
1156     push @select,
1157       '( SELECT COUNT(*) FROM cust_main AS referred_cust_main
1158            WHERE cust_main.custnum = referred_cust_main.referral_custnum
1159        ) AS num_referrals';
1160
1161     unshift @extra_headers, 'Referrals';
1162     unshift @extra_fields, 'num_referrals';
1163     unshift @extra_sort_fields, 'num_referrals';
1164
1165   }
1166
1167   my $select = join(', ', @select);
1168
1169   my $sql_query = {
1170     'table'             => 'cust_main',
1171     'select'            => $select,
1172     'addl_from'         => $addl_from,
1173     'hashref'           => {},
1174     'extra_sql'         => $extra_sql,
1175     'order_by'          => $orderby,
1176     'count_query'       => $count_query,
1177     'extra_headers'     => \@extra_headers,
1178     'extra_fields'      => \@extra_fields,
1179     'extra_sort_fields' => \@extra_sort_fields,
1180   };
1181   $sql_query;
1182
1183 }
1184
1185 =item fuzzy_search FUZZY_HASHREF [ OPTS ]
1186
1187 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
1188 records.  Currently, I<first>, I<last>, I<company> and/or I<address1> may be
1189 specified.
1190
1191 Additional options are the same as FS::Record::qsearch
1192
1193 =cut
1194
1195 sub fuzzy_search {
1196   my $self = shift;
1197   my $fuzzy = shift;
1198   # sensible defaults, then merge in any passed options
1199   my %fuzopts = (
1200     'table'     => 'cust_main',
1201     'addl_from' => '',
1202     'extra_sql' => '',
1203     'hashref'   => {},
1204     @_
1205   );
1206
1207   my @cust_main = ();
1208
1209   my @fuzzy_mod = 'i';
1210   my $conf = new FS::Conf;
1211   my $fuzziness = $conf->config('fuzzy-fuzziness');
1212   push @fuzzy_mod, $fuzziness if $fuzziness;
1213
1214   check_and_rebuild_fuzzyfiles();
1215   foreach my $field ( keys %$fuzzy ) {
1216
1217     my $all = $self->all_X($field);
1218     next unless scalar(@$all);
1219
1220     my %match = ();
1221     $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, \@fuzzy_mod, @$all ) );
1222     next if !keys(%match);
1223
1224     my $in_matches = 'IN (' .
1225                      join(',', map { dbh->quote($_) } keys %match) .
1226                      ')';
1227
1228     my $extra_sql = $fuzopts{extra_sql};
1229     if ($extra_sql =~ /^\s*where /i or keys %{ $fuzopts{hashref} }) {
1230       $extra_sql .= ' AND ';
1231     } else {
1232       $extra_sql .= 'WHERE ';
1233     }
1234     $extra_sql .= "$field $in_matches";
1235
1236     my $addl_from = $fuzopts{addl_from};
1237     if ( $field =~ /^cust_location\./ ) {
1238       $addl_from .= ' JOIN cust_location USING (custnum)';
1239     } elsif ( $field =~ /^contact\./ ) {
1240       $addl_from .= ' JOIN contact USING (custnum)';
1241     }
1242
1243     push @cust_main, qsearch({
1244       %fuzopts,
1245       'addl_from' => $addl_from,
1246       'extra_sql' => $extra_sql,
1247     });
1248   }
1249
1250   # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
1251   my %saw = ();
1252   @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
1253
1254   @cust_main;
1255
1256 }
1257
1258 =back
1259
1260 =head1 UTILITY SUBROUTINES
1261
1262 =over 4
1263
1264 =item check_and_rebuild_fuzzyfiles
1265
1266 =cut
1267
1268 sub check_and_rebuild_fuzzyfiles {
1269   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1270   rebuild_fuzzyfiles()
1271     if grep { ! -e "$dir/$_" }
1272          map {
1273                my ($field, $table) = reverse split('\.', $_);
1274                $table ||= 'cust_main';
1275                "$table.$field"
1276              }
1277            @fuzzyfields;
1278 }
1279
1280 =item rebuild_fuzzyfiles
1281
1282 =cut
1283
1284 sub rebuild_fuzzyfiles {
1285
1286   use Fcntl qw(:flock);
1287
1288   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1289   mkdir $dir, 0700 unless -d $dir;
1290
1291   foreach my $fuzzy ( @fuzzyfields ) {
1292
1293     my ($field, $table) = reverse split('\.', $fuzzy);
1294     $table ||= 'cust_main';
1295
1296     open(LOCK,">>$dir/$table.$field")
1297       or die "can't open $dir/$table.$field: $!";
1298     flock(LOCK,LOCK_EX)
1299       or die "can't lock $dir/$table.$field: $!";
1300
1301     open (CACHE, '>:encoding(UTF-8)', "$dir/$table.$field.tmp")
1302       or die "can't open $dir/$table.$field.tmp: $!";
1303
1304     my $sth = dbh->prepare(
1305       "SELECT $field FROM $table WHERE $field IS NOT NULL AND $field != ''"
1306     );
1307     $sth->execute or die $sth->errstr;
1308
1309     while ( my $row = $sth->fetchrow_arrayref ) {
1310       print CACHE $row->[0]. "\n";
1311     }
1312
1313     close CACHE or die "can't close $dir/$table.$field.tmp: $!";
1314   
1315     rename "$dir/$table.$field.tmp", "$dir/$table.$field";
1316     close LOCK;
1317   }
1318
1319 }
1320
1321 =item append_fuzzyfiles FIRSTNAME LASTNAME COMPANY ADDRESS1
1322
1323 =cut
1324
1325 sub append_fuzzyfiles {
1326   #my( $first, $last, $company ) = @_;
1327
1328   check_and_rebuild_fuzzyfiles();
1329
1330   #foreach my $fuzzy (@fuzzyfields) {
1331   foreach my $fuzzy ( 'cust_main.first', 'cust_main.last', 'cust_main.company', 
1332                       'cust_location.address1',
1333                       'cust_main.ship_company',
1334                     ) {
1335
1336     append_fuzzyfiles_fuzzyfield($fuzzy, shift);
1337
1338   }
1339
1340   1;
1341 }
1342
1343 =item append_fuzzyfiles_fuzzyfield COLUMN VALUE
1344
1345 =item append_fuzzyfiles_fuzzyfield TABLE.COLUMN VALUE
1346
1347 =cut
1348
1349 use Fcntl qw(:flock);
1350 sub append_fuzzyfiles_fuzzyfield {
1351   my( $fuzzyfield, $value ) = @_;
1352
1353   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1354
1355
1356   my ($field, $table) = reverse split('\.', $fuzzyfield);
1357   $table ||= 'cust_main';
1358
1359   return unless defined($value) && length($value);
1360
1361   open(CACHE, '>>:encoding(UTF-8)', "$dir/$table.$field" )
1362     or die "can't open $dir/$table.$field: $!";
1363   flock(CACHE,LOCK_EX)
1364     or die "can't lock $dir/$table.$field: $!";
1365
1366   print CACHE "$value\n";
1367
1368   flock(CACHE,LOCK_UN)
1369     or die "can't unlock $dir/$table.$field: $!";
1370   close CACHE;
1371
1372 }
1373
1374 =item all_X
1375
1376 =cut
1377
1378 sub all_X {
1379   my( $self, $fuzzy ) = @_;
1380   my ($field, $table) = reverse split('\.', $fuzzy);
1381   $table ||= 'cust_main';
1382
1383   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1384   open(CACHE, '<:encoding(UTF-8)', "$dir/$table.$field")
1385     or die "can't open $dir/$table.$field: $!";
1386   my @array = map { chomp; $_; } <CACHE>;
1387   close CACHE;
1388   \@array;
1389 }
1390
1391 =head1 BUGS
1392
1393 Bed bugs
1394
1395 =head1 SEE ALSO
1396
1397 L<FS::cust_main>, L<FS::Record>
1398
1399 =cut
1400
1401 1;
1402