agent-virtualize credit card surcharge percentage, RT#72961

[freeside.git] / FS / FS / contact.pm

diff --git a/FS/FS/contact.pm b/FS/FS/contact.pm
index 07458c7..fd3e9d7 100644 (file)
--- a/FS/FS/contact.pm
+++ b/FS/FS/contact.pm
@@ -1,11 +1,13 @@
 package FS::contact;
 package FS::contact;

-use base qw( FS::Record );
+use base qw( FS::Password_Mixin
+             FS::Record );

 
 use strict;
 use vars qw( $skip_fuzzyfiles );
 use Carp;
 use Scalar::Util qw( blessed );
 use FS::Record qw( qsearch qsearchs dbh );
 
 use strict;
 use vars qw( $skip_fuzzyfiles );
 use Carp;
 use Scalar::Util qw( blessed );
 use FS::Record qw( qsearch qsearchs dbh );

+use FS::Cursor;

 use FS::contact_phone;
 use FS::contact_email;
 use FS::queue;
 use FS::contact_phone;
 use FS::contact_email;
 use FS::queue;


@@ -88,7 +90,6 @@ empty or bcrypt
 
 disabled
 
 
 disabled
 

-

 =back
 
 =head1 METHODS
 =back
 
 =head1 METHODS


@@ -111,6 +112,26 @@ sub table { 'contact'; }
 Adds this record to the database.  If there is an error, returns the error,
 otherwise returns false.
 
 Adds this record to the database.  If there is an error, returns the error,
 otherwise returns false.
 

+If the object has an C<emailaddress> field, L<FS::contact_email> records
+will be created for each (comma-separated) email address in that field. If
+any of these coincide with an existing email address, this contact will be
+merged with the contact with that address.
+
+Then, if the object has any fields named C<phonetypenumN> an
+L<FS::contact_phone> record will be created for each of them. Those fields
+should contain phone numbers of the appropriate types (where N is the key of
+an L<FS::phone_type> record identifying the type of number: daytime, night,
+etc.).
+
+After inserting the record, if the object has a 'custnum' or 'prospectnum'
+field, an L<FS::cust_contact> or L<FS::prospect_contact> record will be
+created to link the contact to the customer. The following fields will also
+be included in that record, if they are set on the object:
+- classnum
+- comment
+- selfservice_access
+- invoice_dest
+

 =cut
 
 sub insert {
 =cut
 
 sub insert {


@@ -133,7 +154,7 @@ sub insert {
   $self->custnum('');
 
   my %link_hash = ();
   $self->custnum('');
 
   my %link_hash = ();

-  for (qw( classnum comment selfservice_access )) {
+  for (qw( classnum comment selfservice_access invoice_dest )) {

     $link_hash{$_} = $self->get($_);
     $self->$_('');
   }
     $link_hash{$_} = $self->get($_);
     $self->$_('');
   }


@@ -164,23 +185,31 @@ sub insert {
 
   }
 
 
   }
 

+  my $error;

   if ( $existing_contact ) {
 
     $self->$_($existing_contact->$_())
       for qw( contactnum _password _password_encoding );
   if ( $existing_contact ) {
 
     $self->$_($existing_contact->$_())
       for qw( contactnum _password _password_encoding );

-    $self->SUPER::replace($existing_contact);
+    $error = $self->SUPER::replace($existing_contact);

 
   } else {
 
 
   } else {
 

-    my $error = $self->SUPER::insert;
-    if ( $error ) {
-      $dbh->rollback if $oldAutoCommit;
-      return $error;
-    }
+    $error = $self->SUPER::insert;

 
   }
 
 
   }
 

+  $error ||= $self->insert_password_history;
+
+  if ( $error ) {
+    $dbh->rollback if $oldAutoCommit;
+    return $error;
+  }
+

   my $cust_contact = '';
   my $cust_contact = '';

+  # if $self->custnum was set, then the customer-specific properties
+  # (custnum, classnum, invoice_dest, selfservice_access, comment) are in
+  # pseudo-fields, and are now in %link_hash. otherwise, ignore all those
+  # fields.

   if ( $custnum ) {
     my %hash = ( 'contactnum' => $self->contactnum,
                  'custnum'    => $custnum,
   if ( $custnum ) {
     my %hash = ( 'contactnum' => $self->contactnum,
                  'custnum'    => $custnum,


@@ -259,7 +288,10 @@ sub insert {
   }
 
   if (      $link_hash{'selfservice_access'} eq 'R'
   }
 
   if (      $link_hash{'selfservice_access'} eq 'R'

-       or ( $link_hash{'selfservice_access'} && $cust_contact )
+       or ( $link_hash{'selfservice_access'}
+            && $cust_contact
+            && ! length($self->_password)
+          )

      )
   {
     my $error = $self->send_reset_email( queue=>1 );
      )
   {
     my $error = $self->send_reset_email( queue=>1 );


@@ -309,6 +341,8 @@ sub delete {
     }
   }
 
     }
   }
 

+  # if $self->custnum was set, then we're removing the contact from this
+  # customer.

   if ( $self->custnum ) {
     my $cust_contact = qsearchs('cust_contact', {
                          'contactnum'  => $self->contactnum,
   if ( $self->custnum ) {
     my $cust_contact = qsearchs('cust_contact', {
                          'contactnum'  => $self->contactnum,


@@ -350,7 +384,8 @@ sub delete {
     }
   }
 
     }
   }
 

-  my $error = $self->SUPER::delete;
+  my $error = $self->delete_password_history
+           || $self->SUPER::delete;

   if ( $error ) {
     $dbh->rollback if $oldAutoCommit;
     return $error;
   if ( $error ) {
     $dbh->rollback if $oldAutoCommit;
     return $error;


@@ -394,18 +429,25 @@ sub replace {
   $self->custnum('');
 
   my %link_hash = ();
   $self->custnum('');
 
   my %link_hash = ();

-  for (qw( classnum comment selfservice_access )) {
+  for (qw( classnum comment selfservice_access invoice_dest )) {

     $link_hash{$_} = $self->get($_);
     $self->$_('');
   }
 
   my $error = $self->SUPER::replace($old);
     $link_hash{$_} = $self->get($_);
     $self->$_('');
   }
 
   my $error = $self->SUPER::replace($old);

+  if ( $old->_password ne $self->_password ) {
+    $error ||= $self->insert_password_history;
+  }

   if ( $error ) {
     $dbh->rollback if $oldAutoCommit;
     return $error;
   }
 
   my $cust_contact = '';
   if ( $error ) {
     $dbh->rollback if $oldAutoCommit;
     return $error;
   }
 
   my $cust_contact = '';

+  # if $self->custnum was set, then the customer-specific properties
+  # (custnum, classnum, invoice_dest, selfservice_access, comment) are in
+  # pseudo-fields, and are now in %link_hash. otherwise, ignore all those
+  # fields.

   if ( $custnum ) {
     my %hash = ( 'contactnum' => $self->contactnum,
                  'custnum'    => $custnum,
   if ( $custnum ) {
     my %hash = ( 'contactnum' => $self->contactnum,
                  'custnum'    => $custnum,


@@ -452,8 +494,11 @@ sub replace {
              );
     my $contact_phone = qsearchs('contact_phone', \%cp);
 
              );
     my $contact_phone = qsearchs('contact_phone', \%cp);
 

+    my $pv = $self->get($pf);
+       $pv =~ s/\s//g;
+

     #if new value is empty, delete old entry
     #if new value is empty, delete old entry

-    if (!$self->get($pf)) {
+    if (!$pv) {

       if ($contact_phone) {
         $error = $contact_phone->delete;
         if ( $error ) {
       if ($contact_phone) {
         $error = $contact_phone->delete;
         if ( $error ) {


@@ -464,7 +509,9 @@ sub replace {
       next;
     }
 
       next;
     }
 

-    my %cpd = _parse_phonestring( $self->get($pf) );
+    $contact_phone ||= new FS::contact_phone \%cp;
+
+    my %cpd = _parse_phonestring( $pv );

     $contact_phone->set( $_ => $cpd{$_} ) foreach keys %cpd;
 
     my $method = $contact_phone->contactphonenum ? 'replace' : 'insert';
     $contact_phone->set( $_ => $cpd{$_} ) foreach keys %cpd;
 
     my $method = $contact_phone->contactphonenum ? 'replace' : 'insert';


@@ -706,9 +753,9 @@ sub firstlast {
 
 =item by_selfservice_email EMAILADDRESS
 
 
 =item by_selfservice_email EMAILADDRESS
 

-Alternate search constructor (class method).  Given an email address,
-returns the contact for that address, or the empty string if no contact
-has that email address.
+Alternate search constructor (class method).  Given an email address, returns
+the contact for that address. If that contact doesn't have selfservice access,
+or there isn't one, returns the empty string.

 
 =cut
 
 
 =cut
 


@@ -719,7 +766,8 @@ sub by_selfservice_email {
     'table'     => 'contact_email',
     'addl_from' => ' LEFT JOIN contact USING ( contactnum ) ',
     'hashref'   => { 'emailaddress' => $email, },
     'table'     => 'contact_email',
     'addl_from' => ' LEFT JOIN contact USING ( contactnum ) ',
     'hashref'   => { 'emailaddress' => $email, },

-    'extra_sql' => " AND ( disabled IS NULL OR disabled = '' )",
+    'extra_sql' => " AND ( contact.disabled IS NULL ) ".
+                   " AND ( contact.selfservice_access = 'Y' )",

   }) or return '';
 
   $contact_email->contact;
   }) or return '';
 
   $contact_email->contact;


@@ -758,9 +806,22 @@ sub authenticate_password {
 
 }
 
 
 }
 

+=item change_password NEW_PASSWORD
+
+Changes the contact's selfservice access password to NEW_PASSWORD. This does
+not check password policy rules (see C<is_password_allowed>) and will return
+an error only if editing the record fails for some reason.
+
+If NEW_PASSWORD is the same as the existing password, this does nothing.
+
+=cut
+

 sub change_password {
   my($self, $new_password) = @_;
 
 sub change_password {
   my($self, $new_password) = @_;
 

+  # do nothing if the password is unchanged
+  return if $self->authenticate_password($new_password);
+

   $self->change_password_fields( $new_password );
 
   $self->replace;
   $self->change_password_fields( $new_password );
 
   $self->replace;


@@ -827,8 +888,9 @@ sub send_reset_email {
   my $agentnum = $cust_main ? $cust_main->agentnum : '';
   my $msgnum = $conf->config('selfservice-password_reset_msgnum', $agentnum);
   #die "selfservice-password_reset_msgnum unset" unless $msgnum;
   my $agentnum = $cust_main ? $cust_main->agentnum : '';
   my $msgnum = $conf->config('selfservice-password_reset_msgnum', $agentnum);
   #die "selfservice-password_reset_msgnum unset" unless $msgnum;

-  return { 'error' => "selfservice-password_reset_msgnum unset" } unless $msgnum;
+  return "selfservice-password_reset_msgnum unset" unless $msgnum;

   my $msg_template = qsearchs('msg_template', { msgnum => $msgnum } );
   my $msg_template = qsearchs('msg_template', { msgnum => $msgnum } );

+  return "selfservice-password_reset_msgnum cannot be loaded" unless $msg_template;

   my %msg_template = (
     'to'            => join(',', map $_->emailaddress, @contact_email ),
     'cust_main'     => $cust_main,
   my %msg_template = (
     'to'            => join(',', map $_->emailaddress, @contact_email ),
     'cust_main'     => $cust_main,


@@ -838,11 +900,14 @@ sub send_reset_email {
 
   if ( $opt{'queue'} ) { #or should queueing just be the default?
 
 
   if ( $opt{'queue'} ) { #or should queueing just be the default?
 

+    my $cust_msg = $msg_template->prepare( %msg_template );
+    my $error = $cust_msg->insert;
+    return $error if $error;

     my $queue = new FS::queue {
     my $queue = new FS::queue {

-      'job'     => 'FS::Misc::process_send_email',
+      'job'     => 'FS::cust_msg::process_send',

       'custnum' => $cust_main ? $cust_main->custnum : '',
     };
       'custnum' => $cust_main ? $cust_main->custnum : '',
     };

-    $queue->insert( $msg_template->prepare( %msg_template ) );
+    $queue->insert( $cust_msg->custmsgnum );

 
   } else {
 
 
   } else {
 


@@ -874,6 +939,7 @@ sub cgi_contact_fields {
 
   my @contact_fields = qw(
     classnum first last title comment emailaddress selfservice_access
 
   my @contact_fields = qw(
     classnum first last title comment emailaddress selfservice_access

+    invoice_dest

   );
 
   push @contact_fields, 'phonetypenum'. $_->phonetypenum
   );
 
   push @contact_fields, 'phonetypenum'. $_->phonetypenum


@@ -887,14 +953,50 @@ use FS::upgrade_journal;
 sub _upgrade_data { #class method
   my ($class, %opts) = @_;
 
 sub _upgrade_data { #class method
   my ($class, %opts) = @_;
 

-  unless ( FS::upgrade_journal->is_done('contact__DUPEMAIL') ) {
+  # before anything else, migrate contact.custnum to cust_contact records
+  unless ( FS::upgrade_journal->is_done('contact_invoice_dest') ) {
+
+    local($skip_fuzzyfiles) = 1;

 
     foreach my $contact (qsearch('contact', {})) {
       my $error = $contact->replace;
       die $error if $error;
     }
 
 
     foreach my $contact (qsearch('contact', {})) {
       my $error = $contact->replace;
       die $error if $error;
     }
 

-    FS::upgrade_journal->set_done('contact__DUPEMAIL');
+    FS::upgrade_journal->set_done('contact_invoice_dest');
+  }
+
+
+  # always migrate cust_main_invoice records over
+  local $FS::cust_main::import = 1; # override require_phone and such
+  my $search = FS::Cursor->new('cust_main_invoice', {});
+  my %custnum_dest;
+  while (my $cust_main_invoice = $search->fetch) {
+    my $custnum = $cust_main_invoice->custnum;
+    my $dest = $cust_main_invoice->dest;
+    my $cust_main = $cust_main_invoice->cust_main;
+
+    if ( $dest =~ /^\d+$/ ) {
+      my $svc_acct = FS::svc_acct->by_key($dest);
+      die "custnum $custnum, invoice destination svcnum $svc_acct does not exist\n"
+        if !$svc_acct;
+      $dest = $svc_acct->email;
+    }
+    push @{ $custnum_dest{$custnum} ||= [] }, $dest;
+
+    my $error = $cust_main_invoice->delete;
+    if ( $error ) {
+      die "custnum $custnum, cleaning up cust_main_invoice: $error\n";
+    }
+  }
+
+  foreach my $custnum (keys %custnum_dest) {
+    my $dests = $custnum_dest{$custnum};
+    my $cust_main = FS::cust_main->by_key($custnum);
+    my $error = $cust_main->replace( invoicing_list => $dests );
+    if ( $error ) {
+      die "custnum $custnum, creating contact: $error\n";
+    }

   }
 
 }
   }
 
 }