FS/FS/contact.pm

   1 package FS::contact;
   2 use base qw( FS::Password_Mixin
   3              FS::Record );
   4
   5 use strict;
   6 use vars qw( $skip_fuzzyfiles );
   7 use Carp;
   8 use Scalar::Util qw( blessed );
   9 use FS::Record qw( qsearch qsearchs dbh );
  10 use FS::Cursor;
  11 use FS::contact_phone;
  12 use FS::contact_email;
  13 use FS::contact::Import;
  14 use FS::queue;
  15 use FS::phone_type; #for cgi_contact_fields
  16 use FS::cust_contact;
  17 use FS::prospect_contact;
  18
  19 $skip_fuzzyfiles = 0;
  20
  21 =head1 NAME
  22
  23 FS::contact - Object methods for contact records
  24
  25 =head1 SYNOPSIS
  26
  27   use FS::contact;
  28
  29   $record = new FS::contact \%hash;
  30   $record = new FS::contact { 'column' => 'value' };
  31
  32   $error = $record->insert;
  33
  34   $error = $new_record->replace($old_record);
  35
  36   $error = $record->delete;
  37
  38   $error = $record->check;
  39
  40 =head1 DESCRIPTION
  41
  42 An FS::contact object represents an specific contact person for a prospect or
  43 customer.  FS::contact inherits from FS::Record.  The following fields are
  44 currently supported:
  45
  46 =over 4
  47
  48 =item contactnum
  49
  50 primary key
  51
  52 =item prospectnum
  53
  54 prospectnum
  55
  56 =item custnum
  57
  58 custnum
  59
  60 =item locationnum
  61
  62 locationnum
  63
  64 =item last
  65
  66 last
  67
  68 =item first
  69
  70 first
  71
  72 =item title
  73
  74 title
  75
  76 =item comment
  77
  78 comment
  79
  80 =item selfservice_access
  81
  82 empty or Y
  83
  84 =item _password
  85
  86 =item _password_encoding
  87
  88 empty or bcrypt
  89
  90 =item disabled
  91
  92 disabled
  93
  94 =back
  95
  96 =head1 METHODS
  97
  98 =over 4
  99
 100 =item new HASHREF
 101
 102 Creates a new contact.  To add the contact to the database, see L<"insert">.
 103
 104 Note that this stores the hash reference, not a distinct copy of the hash it
 105 points to.  You can ask the object for a copy with the I<hash> method.
 106
 107 =cut
 108
 109 sub table { 'contact'; }
 110
 111 =item insert
 112
 113 Adds this record to the database.  If there is an error, returns the error,
 114 otherwise returns false.
 115
 116 If the object has an C<emailaddress> field, L<FS::contact_email> records
 117 will be created for each (comma-separated) email address in that field. If
 118 any of these coincide with an existing email address, this contact will be
 119 merged with the contact with that address.
 120
 121 Then, if the object has any fields named C<phonetypenumN> an
 122 L<FS::contact_phone> record will be created for each of them. Those fields
 123 should contain phone numbers of the appropriate types (where N is the key of
 124 an L<FS::phone_type> record identifying the type of number: daytime, night,
 125 etc.).
 126
 127 After inserting the record, if the object has a 'custnum' or 'prospectnum'
 128 field, an L<FS::cust_contact> or L<FS::prospect_contact> record will be
 129 created to link the contact to the customer. The following fields will also
 130 be included in that record, if they are set on the object:
 131 - classnum
 132 - comment
 133 - selfservice_access
 134 - invoice_dest
 135
 136 =cut
 137
 138 sub insert {
 139   my $self = shift;
 140
 141   local $SIG{INT} = 'IGNORE';
 142   local $SIG{QUIT} = 'IGNORE';
 143   local $SIG{TERM} = 'IGNORE';
 144   local $SIG{TSTP} = 'IGNORE';
 145   local $SIG{PIPE} = 'IGNORE';
 146
 147   my $oldAutoCommit = $FS::UID::AutoCommit;
 148   local $FS::UID::AutoCommit = 0;
 149   my $dbh = dbh;
 150
 151   #save off and blank values that move to cust_contact / prospect_contact now
 152   my $prospectnum = $self->prospectnum;
 153   $self->prospectnum('');
 154   my $custnum = $self->custnum;
 155   $self->custnum('');
 156
 157   my %link_hash = ();
 158   for (qw( classnum comment selfservice_access invoice_dest message_dest)) {
 159     $link_hash{$_} = $self->get($_);
 160     $self->$_('');
 161   }
 162
 163   #look for an existing contact with this email address
 164   my $existing_contact = '';
 165   if ( $self->get('emailaddress') =~ /\S/ ) {
 166
 167     my %existing_contact = ();
 168
 169     foreach my $email ( split(/\s*,\s*/, $self->get('emailaddress') ) ) {
 170
 171       my $contact_email = qsearchs('contact_email', { emailaddress=>$email } )
 172         or next;
 173
 174       my $contact = $contact_email->contact;
 175       $existing_contact{ $contact->contactnum } = $contact;
 176
 177     }
 178
 179     if ( scalar( keys %existing_contact ) > 1 ) {
 180       $dbh->rollback if $oldAutoCommit;
 181       return 'Multiple email addresses specified '.
 182              ' that already belong to separate contacts';
 183     } elsif ( scalar( keys %existing_contact ) ) {
 184       ($existing_contact) = values %existing_contact;
 185     }
 186
 187   }
 188
 189   my $error;
 190   if ( $existing_contact ) {
 191
 192     $self->$_($existing_contact->$_())
 193       for qw( contactnum _password _password_encoding );
 194     $error = $self->SUPER::replace($existing_contact);
 195
 196   } else {
 197
 198     $error = $self->SUPER::insert;
 199
 200   }
 201
 202   if ( $error ) {
 203     $dbh->rollback if $oldAutoCommit;
 204     return $error;
 205   }
 206
 207   my $cust_contact = '';
 208   # if $self->custnum was set, then the customer-specific properties
 209   # (custnum, classnum, invoice_dest, selfservice_access, comment) are in
 210   # pseudo-fields, and are now in %link_hash. otherwise, ignore all those
 211   # fields.
 212   if ( $custnum ) {
 213     my %hash = ( 'contactnum' => $self->contactnum,
 214                  'custnum'    => $custnum,
 215                );
 216     $cust_contact =  qsearchs('cust_contact', \%hash )
 217                   || new FS::cust_contact { %hash, %link_hash };
 218     my $error = $cust_contact->custcontactnum ? $cust_contact->replace
 219                                               : $cust_contact->insert;
 220     if ( $error ) {
 221       $dbh->rollback if $oldAutoCommit;
 222       return $error;
 223     }
 224   }
 225
 226   if ( $prospectnum ) {
 227     my %hash = ( 'contactnum'  => $self->contactnum,
 228                  'prospectnum' => $prospectnum,
 229                );
 230     my $prospect_contact =  qsearchs('prospect_contact', \%hash )
 231                          || new FS::prospect_contact { %hash, %link_hash };
 232     my $error =
 233       $prospect_contact->prospectcontactnum ? $prospect_contact->replace
 234                                             : $prospect_contact->insert;
 235     if ( $error ) {
 236       $dbh->rollback if $oldAutoCommit;
 237       return $error;
 238     }
 239   }
 240
 241   foreach my $pf ( grep { /^phonetypenum(\d+)$/ && $self->get($_) =~ /\S/ }
 242                         keys %{ $self->hashref } ) {
 243     $pf =~ /^phonetypenum(\d+)$/ or die "wtf (daily, the)";
 244     my $phonetypenum = $1;
 245
 246     my %hash = ( 'contactnum'   => $self->contactnum,
 247                  'phonetypenum' => $phonetypenum,
 248                );
 249     my $contact_phone =
 250       qsearchs('contact_phone', \%hash)
 251         || new FS::contact_phone { %hash, _parse_phonestring($self->get($pf)) };
 252     my $error = $contact_phone->contactphonenum ? $contact_phone->replace
 253                                                 : $contact_phone->insert;
 254     if ( $error ) {
 255       $dbh->rollback if $oldAutoCommit;
 256       return $error;
 257     }
 258   }
 259
 260   if ( $self->get('emailaddress') =~ /\S/ ) {
 261
 262     foreach my $email ( split(/\s*,\s*/, $self->get('emailaddress') ) ) {
 263       my %hash = (
 264         'contactnum'   => $self->contactnum,
 265         'emailaddress' => $email,
 266       );
 267       unless ( qsearchs('contact_email', \%hash) ) {
 268         my $contact_email = new FS::contact_email \%hash;
 269         my $error = $contact_email->insert;
 270         if ( $error ) {
 271           $dbh->rollback if $oldAutoCommit;
 272           return $error;
 273         }
 274       }
 275     }
 276
 277   }
 278
 279   unless ( $skip_fuzzyfiles ) { #unless ( $import || $skip_fuzzyfiles ) {
 280     #warn "  queueing fuzzyfiles update\n"
 281     #  if $DEBUG > 1;
 282     my $error = $self->queue_fuzzyfiles_update;
 283     if ( $error ) {
 284       $dbh->rollback if $oldAutoCommit;
 285       return "updating fuzzy search cache: $error";
 286     }
 287   }
 288
 289   if (      $link_hash{'selfservice_access'} eq 'R'
 290        or ( $link_hash{'selfservice_access'}
 291             && $cust_contact
 292             && ! length($self->_password)
 293           )
 294      )
 295   {
 296     my $error = $self->send_reset_email( queue=>1 );
 297     if ( $error ) {
 298       $dbh->rollback if $oldAutoCommit;
 299       return $error;
 300     }
 301   }
 302
 303   if ( $self->get('password') ) {
 304     my $error = $self->is_password_allowed($self->get('password'))
 305           ||  $self->change_password($self->get('password'));
 306     if ( $error ) {
 307       $dbh->rollback if $oldAutoCommit;
 308       return $error;
 309     }
 310   }
 311
 312   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 313
 314   '';
 315
 316 }
 317
 318 =item delete
 319
 320 Delete this record from the database.
 321
 322 =cut
 323
 324 sub delete {
 325   my $self = shift;
 326
 327   local $SIG{HUP} = 'IGNORE';
 328   local $SIG{INT} = 'IGNORE';
 329   local $SIG{QUIT} = 'IGNORE';
 330   local $SIG{TERM} = 'IGNORE';
 331   local $SIG{TSTP} = 'IGNORE';
 332   local $SIG{PIPE} = 'IGNORE';
 333
 334   my $oldAutoCommit = $FS::UID::AutoCommit;
 335   local $FS::UID::AutoCommit = 0;
 336   my $dbh = dbh;
 337
 338   #got a prospetnum or custnum? delete the prospect_contact or cust_contact link
 339
 340   if ( $self->prospectnum ) {
 341     my $prospect_contact = qsearchs('prospect_contact', {
 342                              'contactnum'  => $self->contactnum,
 343                              'prospectnum' => $self->prospectnum,
 344                            });
 345     my $error = $prospect_contact->delete;
 346     if ( $error ) {
 347       $dbh->rollback if $oldAutoCommit;
 348       return $error;
 349     }
 350   }
 351
 352   # if $self->custnum was set, then we're removing the contact from this
 353   # customer.
 354   if ( $self->custnum ) {
 355     my $cust_contact = qsearchs('cust_contact', {
 356                          'contactnum'  => $self->contactnum,
 357                          'custnum' => $self->custnum,
 358                        });
 359     my $error = $cust_contact->delete;
 360     if ( $error ) {
 361       $dbh->rollback if $oldAutoCommit;
 362       return $error;
 363     }
 364   }
 365
 366   # then, proceed with deletion only if the contact isn't attached to any other
 367   # prospects or customers
 368
 369   #inefficient, but how many prospects/customers can a single contact be
 370   # attached too?  (and is removing them from one a common operation?)
 371   if ( $self->prospect_contact || $self->cust_contact ) {
 372     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 373     return '';
 374   }
 375
 376   #proceed with deletion
 377
 378   foreach my $cust_pkg ( $self->cust_pkg ) {
 379     $cust_pkg->contactnum('');
 380     my $error = $cust_pkg->replace;
 381     if ( $error ) {
 382       $dbh->rollback if $oldAutoCommit;
 383       return $error;
 384     }
 385   }
 386
 387   foreach my $object ( $self->contact_phone, $self->contact_email ) {
 388     my $error = $object->delete;
 389     if ( $error ) {
 390       $dbh->rollback if $oldAutoCommit;
 391       return $error;
 392     }
 393   }
 394
 395   my $error = $self->delete_password_history
 396            || $self->SUPER::delete;
 397   if ( $error ) {
 398     $dbh->rollback if $oldAutoCommit;
 399     return $error;
 400   }
 401
 402   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 403   '';
 404
 405 }
 406
 407 =item replace OLD_RECORD
 408
 409 Replaces the OLD_RECORD with this one in the database.  If there is an error,
 410 returns the error, otherwise returns false.
 411
 412 =cut
 413
 414 sub replace {
 415   my $self = shift;
 416
 417   my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
 418               ? shift
 419               : $self->replace_old;
 420
 421   $self->$_( $self->$_ || $old->$_ ) for qw( _password _password_encoding );
 422
 423   local $SIG{INT} = 'IGNORE';
 424   local $SIG{QUIT} = 'IGNORE';
 425   local $SIG{TERM} = 'IGNORE';
 426   local $SIG{TSTP} = 'IGNORE';
 427   local $SIG{PIPE} = 'IGNORE';
 428
 429   my $oldAutoCommit = $FS::UID::AutoCommit;
 430   local $FS::UID::AutoCommit = 0;
 431   my $dbh = dbh;
 432
 433   #save off and blank values that move to cust_contact / prospect_contact now
 434   my $prospectnum = $self->prospectnum;
 435   $self->prospectnum('');
 436   my $custnum = $self->custnum;
 437   $self->custnum(''); $old->custnum(''); # remove because now stored cust_contact
 438
 439   my %link_hash = ();
 440   for (qw( classnum comment selfservice_access invoice_dest message_dest )) {
 441     $link_hash{$_} = $self->get($_);
 442     $old->$_('');  ##remove values from old record, causes problem with history
 443     $self->$_('');
 444   }
 445
 446   my $error = $self->SUPER::replace($old);
 447   if ( $old->_password ne $self->_password ) {
 448     $error ||= $self->insert_password_history;
 449   }
 450   if ( $error ) {
 451     $dbh->rollback if $oldAutoCommit;
 452     return $error;
 453   }
 454
 455   my $cust_contact = '';
 456   # if $self->custnum was set, then the customer-specific properties
 457   # (custnum, classnum, invoice_dest, selfservice_access, comment) are in
 458   # pseudo-fields, and are now in %link_hash. otherwise, ignore all those
 459   # fields.
 460   if ( $custnum ) {
 461     my %hash = ( 'contactnum' => $self->contactnum,
 462                  'custnum'    => $custnum,
 463                );
 464     my $error;
 465     if ( $cust_contact = qsearchs('cust_contact', \%hash ) ) {
 466       $cust_contact->$_($link_hash{$_}) for keys %link_hash;
 467       $error = $cust_contact->replace;
 468     } else {
 469       $cust_contact = new FS::cust_contact { %hash, %link_hash };
 470       $error = $cust_contact->insert;
 471     }
 472     if ( $error ) {
 473       $dbh->rollback if $oldAutoCommit;
 474       return $error;
 475     }
 476   }
 477
 478   if ( $prospectnum ) {
 479     my %hash = ( 'contactnum'  => $self->contactnum,
 480                  'prospectnum' => $prospectnum,
 481                );
 482     my $error;
 483     if ( my $prospect_contact = qsearchs('prospect_contact', \%hash ) ) {
 484       $prospect_contact->$_($link_hash{$_}) for keys %link_hash;
 485       $error = $prospect_contact->replace;
 486     } else {
 487       my $prospect_contact = new FS::prospect_contact { %hash, %link_hash };
 488       $error = $prospect_contact->insert;
 489     }
 490     if ( $error ) {
 491       $dbh->rollback if $oldAutoCommit;
 492       return $error;
 493     }
 494   }
 495
 496   foreach my $pf ( grep { /^phonetypenum(\d+)$/ }
 497                         keys %{ $self->hashref } ) {
 498     $pf =~ /^phonetypenum(\d+)$/ or die "wtf (daily, the)";
 499     my $phonetypenum = $1;
 500
 501     my %cp = ( 'contactnum'   => $self->contactnum,
 502                'phonetypenum' => $phonetypenum,
 503              );
 504     my $contact_phone = qsearchs('contact_phone', \%cp);
 505
 506     my $pv = $self->get($pf);
 507         $pv =~ s/\s//g;
 508
 509     #if new value is empty, delete old entry
 510     if (!$pv) {
 511       if ($contact_phone) {
 512         $error = $contact_phone->delete;
 513         if ( $error ) {
 514           $dbh->rollback if $oldAutoCommit;
 515           return $error;
 516         }
 517       }
 518       next;
 519     }
 520
 521     $contact_phone ||= new FS::contact_phone \%cp;
 522
 523     my %cpd = _parse_phonestring( $pv );
 524     $contact_phone->set( $_ => $cpd{$_} ) foreach keys %cpd;
 525
 526     my $method = $contact_phone->contactphonenum ? 'replace' : 'insert';
 527
 528     $error = $contact_phone->$method;
 529     if ( $error ) {
 530       $dbh->rollback if $oldAutoCommit;
 531       return $error;
 532     }
 533   }
 534
 535   if ( defined($self->hashref->{'emailaddress'}) ) {
 536
 537     #ineffecient but whatever, how many email addresses can there be?
 538
 539     foreach my $contact_email ( $self->contact_email ) {
 540       my $error = $contact_email->delete;
 541       if ( $error ) {
 542         $dbh->rollback if $oldAutoCommit;
 543         return $error;
 544       }
 545     }
 546
 547     foreach my $email ( split(/\s*,\s*/, $self->get('emailaddress') ) ) {
 548
 549       my $contact_email = new FS::contact_email {
 550         'contactnum'   => $self->contactnum,
 551         'emailaddress' => $email,
 552       };
 553       $error = $contact_email->insert;
 554       if ( $error ) {
 555         $dbh->rollback if $oldAutoCommit;
 556         return $error;
 557       }
 558
 559     }
 560
 561   }
 562
 563   unless ( $skip_fuzzyfiles ) { #unless ( $import || $skip_fuzzyfiles ) {
 564     #warn "  queueing fuzzyfiles update\n"
 565     #  if $DEBUG > 1;
 566     $error = $self->queue_fuzzyfiles_update;
 567     if ( $error ) {
 568       $dbh->rollback if $oldAutoCommit;
 569       return "updating fuzzy search cache: $error";
 570     }
 571   }
 572
 573   if ( $cust_contact and (
 574                               (      $cust_contact->selfservice_access eq ''
 575                                   && $link_hash{selfservice_access}
 576                                   && ! length($self->_password)
 577                               )
 578                            || $cust_contact->_resend()
 579                          )
 580     )
 581   {
 582     my $error = $self->send_reset_email( queue=>1 );
 583     if ( $error ) {
 584       $dbh->rollback if $oldAutoCommit;
 585       return $error;
 586     }
 587   }
 588
 589   if ( $self->get('password') ) {
 590     my $error = $self->is_password_allowed($self->get('password'))
 591           ||  $self->change_password($self->get('password'));
 592     if ( $error ) {
 593       $dbh->rollback if $oldAutoCommit;
 594       return $error;
 595     }
 596   }
 597
 598   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 599
 600   '';
 601
 602 }
 603
 604 =item _parse_phonestring PHONENUMBER_STRING
 605
 606 Subroutine, takes a string and returns a list (suitable for assigning to a hash)
 607 with keys 'countrycode', 'phonenum' and 'extension'
 608
 609 (Should probably be moved to contact_phone.pm, hence the initial underscore.)
 610
 611 =cut
 612
 613 sub _parse_phonestring {
 614   my $value = shift;
 615
 616   my($countrycode, $extension) = ('1', '');
 617
 618   #countrycode
 619   if ( $value =~ s/^\s*\+\s*(\d+)// ) {
 620     $countrycode = $1;
 621   } else {
 622     $value =~ s/^\s*1//;
 623   }
 624   #extension
 625   if ( $value =~ s/\s*(ext|x)\s*(\d+)\s*$//i ) {
 626      $extension = $2;
 627   }
 628
 629   ( 'countrycode' => $countrycode,
 630     'phonenum'    => $value,
 631     'extension'   => $extension,
 632   );
 633 }
 634
 635 =item queue_fuzzyfiles_update
 636
 637 Used by insert & replace to update the fuzzy search cache
 638
 639 =cut
 640
 641 use FS::cust_main::Search;
 642 sub queue_fuzzyfiles_update {
 643   my $self = shift;
 644
 645   local $SIG{HUP} = 'IGNORE';
 646   local $SIG{INT} = 'IGNORE';
 647   local $SIG{QUIT} = 'IGNORE';
 648   local $SIG{TERM} = 'IGNORE';
 649   local $SIG{TSTP} = 'IGNORE';
 650   local $SIG{PIPE} = 'IGNORE';
 651
 652   my $oldAutoCommit = $FS::UID::AutoCommit;
 653   local $FS::UID::AutoCommit = 0;
 654   my $dbh = dbh;
 655
 656   foreach my $field ( 'first', 'last' ) {
 657     my $queue = new FS::queue {
 658       'job' => 'FS::cust_main::Search::append_fuzzyfiles_fuzzyfield'
 659     };
 660     my @args = "contact.$field", $self->get($field);
 661     my $error = $queue->insert( @args );
 662     if ( $error ) {
 663       $dbh->rollback if $oldAutoCommit;
 664       return "queueing job (transaction rolled back): $error";
 665     }
 666   }
 667
 668   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 669   '';
 670
 671 }
 672
 673 =item check
 674
 675 Checks all fields to make sure this is a valid contact.  If there is
 676 an error, returns the error, otherwise returns false.  Called by the insert
 677 and replace methods.
 678
 679 =cut
 680
 681 sub check {
 682   my $self = shift;
 683
 684   if ( $self->selfservice_access eq 'R' || $self->selfservice_access eq 'P' ) {
 685     $self->selfservice_access('Y');
 686     $self->_resend('Y');
 687   }
 688
 689   my $error =
 690     $self->ut_numbern('contactnum')
 691     || $self->ut_foreign_keyn('prospectnum', 'prospect_main', 'prospectnum')
 692     || $self->ut_foreign_keyn('custnum',     'cust_main',     'custnum')
 693     || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
 694     || $self->ut_foreign_keyn('classnum',    'contact_class', 'classnum')
 695     || $self->ut_namen('last')
 696     || $self->ut_namen('first')
 697     || $self->ut_textn('title')
 698     || $self->ut_textn('comment')
 699     || $self->ut_enum('selfservice_access', [ '', 'Y' ])
 700     || $self->ut_textn('_password')
 701     || $self->ut_enum('_password_encoding', [ '', 'bcrypt'])
 702     || $self->ut_enum('disabled', [ '', 'Y' ])
 703   ;
 704   return $error if $error;
 705
 706   return "Prospect and customer!"       if $self->prospectnum && $self->custnum;
 707
 708   return "One of first name, last name, or title must have a value"
 709     if ! grep $self->$_(), qw( first last title);
 710
 711   $self->SUPER::check;
 712 }
 713
 714 =item line
 715
 716 Returns a formatted string representing this contact, including name, title and
 717 comment.
 718
 719 =cut
 720
 721 sub line {
 722   my $self = shift;
 723   my $data = $self->first. ' '. $self->last;
 724   $data .= ', '. $self->title
 725     if $self->title;
 726   $data .= ' ('. $self->comment. ')'
 727     if $self->comment;
 728   $data;
 729 }
 730
 731 =item firstlast
 732
 733 Returns a formatted string representing this contact, with just the name.
 734
 735 =cut
 736
 737 sub firstlast {
 738   my $self = shift;
 739   $self->first . ' ' . $self->last;
 740 }
 741
 742 #=item contact_classname PROSPECT_OBJ | CUST_MAIN_OBJ
 743 #
 744 #Returns the name of this contact's class for the specified prospect or
 745 #customer (see L<FS::prospect_contact>, L<FS::cust_contact> and
 746 #L<FS::contact_class>).
 747 #
 748 #=cut
 749 #
 750 #sub contact_classname {
 751 #  my( $self, $prospect_or_cust ) = @_;
 752 #
 753 #  my $link = '';
 754 #  if ( ref($prospect_or_cust) eq 'FS::prospect_main' ) {
 755 #    $link = qsearchs('prospect_contact', {
 756 #              'contactnum'  => $self->contactnum,
 757 #              'prospectnum' => $prospect_or_cust->prospectnum,
 758 #            });
 759 #  } elsif ( ref($prospect_or_cust) eq 'FS::cust_main' ) {
 760 #    $link = qsearchs('cust_contact', {
 761 #              'contactnum'  => $self->contactnum,
 762 #              'custnum'     => $prospect_or_cust->custnum,
 763 #            });
 764 #  } else {
 765 #    croak "$prospect_or_cust is not an FS::prospect_main or FS::cust_main object";
 766 #  }
 767 #
 768 #  my $contact_class = $link->contact_class or return '';
 769 #  $contact_class->classname;
 770 #}
 771
 772 =item by_selfservice_email EMAILADDRESS
 773
 774 Alternate search constructor (class method).  Given an email address, returns
 775 the contact for that address. If that contact doesn't have selfservice access,
 776 or there isn't one, returns the empty string.
 777
 778 =cut
 779
 780 sub by_selfservice_email {
 781   my($class, $email) = @_;
 782
 783   my $contact_email = qsearchs({
 784     'table'     => 'contact_email',
 785     'addl_from' => ' LEFT JOIN contact USING ( contactnum ) ',
 786     'hashref'   => { 'emailaddress' => $email, },
 787     'extra_sql' => "
 788       AND ( contact.disabled IS NULL )
 789       AND EXISTS ( SELECT 1 FROM cust_contact
 790                      WHERE contact.contactnum = cust_contact.contactnum
 791                        AND cust_contact.selfservice_access = 'Y'
 792                  )
 793     ",
 794   }) or return '';
 795
 796   $contact_email->contact;
 797
 798 }
 799
 800 #these three functions are very much false laziness w/FS/FS/Auth/internal.pm
 801 # and should maybe be libraried in some way for other password needs
 802
 803 use Crypt::Eksblowfish::Bcrypt qw( bcrypt_hash en_base64 de_base64);
 804
 805 sub authenticate_password {
 806   my($self, $check_password) = @_;
 807
 808   if ( $self->_password_encoding eq 'bcrypt' ) {
 809
 810     my( $cost, $salt, $hash ) = split(',', $self->_password);
 811
 812     my $check_hash = en_base64( bcrypt_hash( { key_nul => 1,
 813                                                cost    => $cost,
 814                                                salt    => de_base64($salt),
 815                                              },
 816                                              $check_password
 817                                            )
 818                               );
 819
 820     $hash eq $check_hash;
 821
 822   } else {
 823
 824     return 0 if $self->_password eq '';
 825
 826     $self->_password eq $check_password;
 827
 828   }
 829
 830 }
 831
 832 =item change_password NEW_PASSWORD
 833
 834 Changes the contact's selfservice access password to NEW_PASSWORD. This does
 835 not check password policy rules (see C<is_password_allowed>) and will return
 836 an error only if editing the record fails for some reason.
 837
 838 If NEW_PASSWORD is the same as the existing password, this does nothing.
 839
 840 =cut
 841
 842 sub change_password {
 843   my($self, $new_password) = @_;
 844
 845   # do nothing if the password is unchanged
 846   return if $self->authenticate_password($new_password);
 847
 848   $self->change_password_fields( $new_password );
 849
 850   $self->replace;
 851
 852 }
 853
 854 sub change_password_fields {
 855   my($self, $new_password) = @_;
 856
 857   $self->_password_encoding('bcrypt');
 858
 859   my $cost = 8;
 860
 861   my $salt = pack( 'C*', map int(rand(256)), 1..16 );
 862
 863   my $hash = bcrypt_hash( { key_nul => 1,
 864                             cost    => $cost,
 865                             salt    => $salt,
 866                           },
 867                           $new_password,
 868                         );
 869
 870   $self->_password(
 871     join(',', $cost, en_base64($salt), en_base64($hash) )
 872   );
 873
 874 }
 875
 876 # end of false laziness w/FS/FS/Auth/internal.pm
 877
 878
 879 #false laziness w/ClientAPI/MyAccount/reset_passwd
 880 use Digest::SHA qw(sha512_hex);
 881 use FS::Conf;
 882 use FS::ClientAPI_SessionCache;
 883 sub send_reset_email {
 884   my( $self, %opt ) = @_;
 885
 886   my @contact_email = $self->contact_email or return '';
 887
 888   my $reset_session = {
 889     'contactnum' => $self->contactnum,
 890     'svcnum'     => $opt{'svcnum'},
 891   };
 892
 893
 894   my $conf = new FS::Conf;
 895   my $timeout =
 896     ($conf->config('selfservice-password_reset_hours') || 24 ). ' hours';
 897
 898   my $reset_session_id;
 899   do {
 900     $reset_session_id = sha512_hex(time(). {}. rand(). $$)
 901   } until ( ! defined $self->myaccount_cache->get("reset_passwd_$reset_session_id") );
 902     #just in case
 903
 904   $self->myaccount_cache->set( "reset_passwd_$reset_session_id", $reset_session, $timeout );
 905
 906   #email it
 907
 908   my $cust_main = '';
 909   my @cust_contact = grep $_->selfservice_access, $self->cust_contact;
 910   $cust_main = $cust_contact[0]->cust_main if scalar(@cust_contact) == 1;
 911
 912   my $agentnum = $cust_main ? $cust_main->agentnum : '';
 913   my $msgnum = $conf->config('selfservice-password_reset_msgnum', $agentnum);
 914   #die "selfservice-password_reset_msgnum unset" unless $msgnum;
 915   return "selfservice-password_reset_msgnum unset" unless $msgnum;
 916   my $msg_template = qsearchs('msg_template', { msgnum => $msgnum } );
 917   return "selfservice-password_reset_msgnum cannot be loaded" unless $msg_template;
 918   my %msg_template = (
 919     'to'            => join(',', map $_->emailaddress, @contact_email ),
 920     'cust_main'     => $cust_main,
 921     'object'        => $self,
 922     'substitutions' => { 'session_id' => $reset_session_id }
 923   );
 924
 925   if ( $opt{'queue'} ) { #or should queueing just be the default?
 926
 927     my $cust_msg = $msg_template->prepare( %msg_template );
 928     my $error = $cust_msg->insert;
 929     return $error if $error;
 930     my $queue = new FS::queue {
 931       'job'     => 'FS::cust_msg::process_send',
 932       'custnum' => $cust_main ? $cust_main->custnum : '',
 933     };
 934     $queue->insert( $cust_msg->custmsgnum );
 935
 936   } else {
 937
 938     $msg_template->send( %msg_template );
 939
 940   }
 941
 942 }
 943
 944 use vars qw( $myaccount_cache );
 945 sub myaccount_cache {
 946   #my $class = shift;
 947   $myaccount_cache ||= new FS::ClientAPI_SessionCache( {
 948                          'namespace' => 'FS::ClientAPI::MyAccount',
 949                        } );
 950 }
 951
 952 =item cgi_contact_fields
 953
 954 Returns a list reference containing the set of contact fields used in the web
 955 interface for one-line editing (i.e. excluding contactnum, prospectnum, custnum
 956 and locationnum, as well as password fields, but including fields for
 957 contact_email and contact_phone records.)
 958
 959 =cut
 960
 961 sub cgi_contact_fields {
 962   #my $class = shift;
 963
 964   my @contact_fields = qw(
 965     classnum first last title comment emailaddress selfservice_access
 966     invoice_dest message_dest password
 967   );
 968
 969   push @contact_fields, 'phonetypenum'. $_->phonetypenum
 970     foreach qsearch({table=>'phone_type', order_by=>'weight'});
 971
 972   \@contact_fields;
 973
 974 }
 975
 976 use FS::upgrade_journal;
 977 sub _upgrade_data { #class method
 978   my ($class, %opts) = @_;
 979
 980   # before anything else, migrate contact.custnum to cust_contact records
 981   unless ( FS::upgrade_journal->is_done('contact_invoice_dest') ) {
 982
 983     local($skip_fuzzyfiles) = 1;
 984
 985     foreach my $contact (qsearch('contact', {})) {
 986       my $error = $contact->replace;
 987       die $error if $error;
 988     }
 989
 990     FS::upgrade_journal->set_done('contact_invoice_dest');
 991   }
 992
 993
 994   # always migrate cust_main_invoice records over
 995   local $FS::cust_main::import = 1; # override require_phone and such
 996   my $search = FS::Cursor->new('cust_main_invoice', {});
 997   my %custnum_dest;
 998   while (my $cust_main_invoice = $search->fetch) {
 999     my $custnum = $cust_main_invoice->custnum;
1000     my $dest = $cust_main_invoice->dest;
1001     my $cust_main = $cust_main_invoice->cust_main;
1002
1003     if ( $dest =~ /^\d+$/ ) {
1004       my $svc_acct = FS::svc_acct->by_key($dest);
1005       die "custnum $custnum, invoice destination svcnum $svc_acct does not exist\n"
1006         if !$svc_acct;
1007       $dest = $svc_acct->email;
1008     }
1009     push @{ $custnum_dest{$custnum} ||= [] }, $dest;
1010
1011     my $error = $cust_main_invoice->delete;
1012     if ( $error ) {
1013       die "custnum $custnum, cleaning up cust_main_invoice: $error\n";
1014     }
1015   }
1016
1017   foreach my $custnum (keys %custnum_dest) {
1018     my $dests = $custnum_dest{$custnum};
1019     my $cust_main = FS::cust_main->by_key($custnum);
1020     my $error = $cust_main->replace( invoicing_list => $dests );
1021     if ( $error ) {
1022       die "custnum $custnum, creating contact: $error\n";
1023     }
1024   }
1025
1026 }
1027
1028 =back
1029
1030 =head1 BUGS
1031
1032 =head1 SEE ALSO
1033
1034 L<FS::Record>, schema.html from the base documentation.
1035
1036 =cut
1037
1038 1;