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