multiple payment options (new complimentary flag), RT#23741

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

diff --git a/FS/FS/cust_pay.pm b/FS/FS/cust_pay.pm
index a65520f..e8f9aee 100644 (file)
--- a/FS/FS/cust_pay.pm
+++ b/FS/FS/cust_pay.pm
@@ -11,6 +11,7 @@ use Business::CreditCard;
 use Text::Template;
 use FS::Misc::DateTime qw( parse_datetime ); #for batch_import
 use FS::Record qw( dbh qsearch qsearchs );
 use Text::Template;
 use FS::Misc::DateTime qw( parse_datetime ); #for batch_import
 use FS::Record qw( dbh qsearch qsearchs );

+use FS::UID qw( driver_name );

 use FS::CurrentUser;
 use FS::payby;
 use FS::cust_main_Mixin;
 use FS::CurrentUser;
 use FS::payby;
 use FS::cust_main_Mixin;


@@ -189,7 +190,13 @@ If the additional field discount_term is defined then a prepayment discount
 is taken for that length of time.  It is an error for the customer to owe
 after this payment is made.
 
 is taken for that length of time.  It is an error for the customer to owe
 after this payment is made.
 

-A hash of optional arguments may be passed.  Currently "manual" is supported.
+A hash of optional arguments may be passed.  The following arguments are
+supported:
+
+=over 4
+
+=item manual
+

 If true, a payment receipt is sent instead of a statement when
 'payment_receipt_email' configuration option is set.
 
 If true, a payment receipt is sent instead of a statement when
 'payment_receipt_email' configuration option is set.
 


@@ -202,6 +209,13 @@ payment is created directly from the web interface, from a user-initiated
 realtime payment, or from a third-party payment via self-service.  It should
 be I<false> when creating a payment from a billing event or from a batch.
 
 realtime payment, or from a third-party payment via self-service.  It should
 be I<false> when creating a payment from a billing event or from a batch.
 

+=item noemail
+
+Don't send an email receipt.  (Note: does not currently work when
+payment_receipt-trigger is set to something other than default / cust_bill)
+
+=back
+

 =cut
 
 sub insert {
 =cut
 
 sub insert {


@@ -378,6 +392,7 @@ sub insert {
   if ( $trigger eq 'cust_pay' ) {
     my $error = $self->send_receipt(
       'manual'    => $options{'manual'},
   if ( $trigger eq 'cust_pay' ) {
     my $error = $self->send_receipt(
       'manual'    => $options{'manual'},

+      'noemail'   => $options{'noemail'},

       'cust_bill' => $cust_bill,
       'cust_main' => $cust_main,
     );
       'cust_bill' => $cust_bill,
       'cust_main' => $cust_main,
     );


@@ -580,6 +595,12 @@ will be assumed.
 
 Customer (FS::cust_main) object (for efficiency).
 
 
 Customer (FS::cust_main) object (for efficiency).
 

+=item noemail
+
+Don't send an email receipt.
+
+=cut
+

 =back
 
 =cut
 =back
 
 =cut


@@ -610,6 +631,9 @@ sub send_receipt {
     my $msgnum = $conf->config('payment_receipt_msgnum', $cust_main->agentnum);
     if ( $msgnum ) {
 
     my $msgnum = $conf->config('payment_receipt_msgnum', $cust_main->agentnum);
     if ( $msgnum ) {
 

+      my %substitutions = ();
+      $substitutions{invnum} = $opt->{cust_bill}->invnum if $opt->{cust_bill};
+

       my $queue = new FS::queue {
         'job'     => 'FS::Misc::process_send_email',
         'paynum'  => $self->paynum,
       my $queue = new FS::queue {
         'job'     => 'FS::Misc::process_send_email',
         'paynum'  => $self->paynum,


@@ -617,9 +641,10 @@ sub send_receipt {
       };
       $error = $queue->insert(
         FS::msg_template->by_key($msgnum)->prepare(
       };
       $error = $queue->insert(
         FS::msg_template->by_key($msgnum)->prepare(

-          'cust_main'   => $cust_main,
-          'object'      => $self,
-          'from_config' => 'payment_receipt_from',
+          'cust_main'     => $cust_main,
+          'object'        => $self,
+          'from_config'   => 'payment_receipt_from',
+          'substitutions' => \%substitutions,

         ),
         'msgtype' => 'receipt', # override msg_template's default
       );
         ),
         'msgtype' => 'receipt', # override msg_template's default
       );


@@ -669,7 +694,7 @@ sub send_receipt {
         'msgtype' => 'receipt',
       };
       $error = $queue->insert(
         'msgtype' => 'receipt',
       };
       $error = $queue->insert(

-        'from'    => $conf->config('invoice_from', $cust_main->agentnum),
+        'from'    => $conf->invoice_from_full( $cust_main->agentnum ),

                                    #invoice_from??? well as good as any
         'to'      => \@invoicing_list,
         'subject' => 'Payment receipt',
                                    #invoice_from??? well as good as any
         'to'      => \@invoicing_list,
         'subject' => 'Payment receipt',


@@ -682,7 +707,8 @@ sub send_receipt {
 
     }
 
 
     }
 

-  } elsif ( ! $cust_main->invoice_noemail ) { #not manual
+  #not manual and no noemail flag (here or on the customer)
+  } elsif ( ! $opt->{'noemail'} && ! $cust_main->invoice_noemail ) {

 
     my $queue = new FS::queue {
        'job'     => 'FS::cust_bill::queueable_email',
 
     my $queue = new FS::queue {
        'job'     => 'FS::cust_bill::queueable_email',


@@ -888,6 +914,13 @@ sub unapplied_sql {
 
 }
 
 
 }
 

+sub API_getinfo {
+ my $self = shift;
+ my @fields = grep { $_ ne 'payinfo' } $self->fields;
+ +{ ( map { $_=>$self->$_ } @fields ),
+  };
+}
+

 # _upgrade_data
 #
 # Used by FS::Upgrade to migrate to a new database.
 # _upgrade_data
 #
 # Used by FS::Upgrade to migrate to a new database.


@@ -895,7 +928,7 @@ sub unapplied_sql {
 use FS::h_cust_pay;
 
 sub _upgrade_data {  #class method
 use FS::h_cust_pay;
 
 sub _upgrade_data {  #class method

-  my ($class, %opts) = @_;
+  my ($class, %opt) = @_;

 
   warn "$me upgrading $class\n" if $DEBUG;
 
 
   warn "$me upgrading $class\n" if $DEBUG;
 


@@ -909,10 +942,11 @@ sub _upgrade_data {  #class method
 
     #not the most efficient, but hey, it only has to run once
 
 
     #not the most efficient, but hey, it only has to run once
 

-    my $where = "WHERE ( otaker IS NULL OR otaker = '' OR otaker = 'ivan' ) ".
-                "  AND usernum IS NULL ".
-                "  AND 0 < ( SELECT COUNT(*) FROM cust_main                 ".
-                "              WHERE cust_main.custnum = cust_pay.custnum ) ";
+    my $where = " WHERE ( otaker IS NULL OR otaker = '' OR otaker = 'ivan' )
+                    AND usernum IS NULL
+                    AND EXISTS ( SELECT 1 FROM cust_main                    
+                                   WHERE cust_main.custnum = cust_pay.custnum )
+                ";

 
     my $count_sql = "SELECT COUNT(*) FROM cust_pay $where";
 
 
     my $count_sql = "SELECT COUNT(*) FROM cust_pay $where";
 


@@ -944,7 +978,6 @@ sub _upgrade_data {  #class method
         $cust_pay->set('otaker', 'legacy');
       }
 
         $cust_pay->set('otaker', 'legacy');
       }
 

-      delete $FS::payby::hash{'COMP'}->{cust_pay}; #quelle kludge

       my $error = $cust_pay->replace;
 
       if ( $error ) {
       my $error = $cust_pay->replace;
 
       if ( $error ) {


@@ -953,8 +986,6 @@ sub _upgrade_data {  #class method
         next;
       }
 
         next;
       }
 

-      $FS::payby::hash{'COMP'}->{cust_pay} = ''; #restore it
-

       $count++;
       if ( $DEBUG > 1 && $lastprog + 30 < time ) {
         warn "$me $count/$total (".sprintf('%.2f',100*$count/$total). '%)'."\n";
       $count++;
       if ( $DEBUG > 1 && $lastprog + 30 < time ) {
         warn "$me $count/$total (".sprintf('%.2f',100*$count/$total). '%)'."\n";


@@ -1008,16 +1039,39 @@ sub _upgrade_data {  #class method
   # otaker->usernum upgrade
   ###
 
   # otaker->usernum upgrade
   ###
 

-  delete $FS::payby::hash{'COMP'}->{cust_pay}; #quelle kludge
-  $class->_upgrade_otaker(%opts);
-  $FS::payby::hash{'COMP'}->{cust_pay} = ''; #restore it
+  $class->_upgrade_otaker(%opt);
+
+  # if we do this anywhere else, it should become an FS::Upgrade method
+  my $num_to_upgrade = $class->count('paybatch is not null');
+  my $num_jobs = FS::queue->count('job = \'FS::cust_pay::process_upgrade_paybatch\' and status != \'failed\'');
+  if ( $num_to_upgrade > 0 ) {
+    warn "Need to migrate paybatch field in $num_to_upgrade payments.\n";
+    if ( $opt{queue} ) {
+      if ( $num_jobs > 0 ) {
+        warn "Upgrade already queued.\n";
+      } else {
+        warn "Scheduling upgrade.\n";
+        my $job = FS::queue->new({ job => 'FS::cust_pay::process_upgrade_paybatch' });
+        $job->insert;
+      }
+    } else {
+      process_upgrade_paybatch();
+    }
+  }
+}
+
+sub process_upgrade_paybatch {
+  my $dbh = dbh;
+  local $FS::payinfo_Mixin::ignore_masked_payinfo = 1;
+  local $FS::UID::AutoCommit = 1;

 
   ###
   # migrate batchnums from the misused 'paybatch' field to 'batchnum'
   ###
 
   ###
   # migrate batchnums from the misused 'paybatch' field to 'batchnum'
   ###

+  my $text = (driver_name =~ /^mysql/i) ? 'char' : 'text';

   my $search = FS::Cursor->new( {
     'table'     => 'cust_pay',
   my $search = FS::Cursor->new( {
     'table'     => 'cust_pay',

-    'addl_from' => ' JOIN pay_batch ON cust_pay.paybatch = CAST(pay_batch.batchnum AS text) ',
+    'addl_from' => " JOIN pay_batch ON cust_pay.paybatch = CAST(pay_batch.batchnum AS $text) ",

   } );
   while (my $cust_pay = $search->fetch) {
     $cust_pay->set('batchnum' => $cust_pay->paybatch);
   } );
   while (my $cust_pay = $search->fetch) {
     $cust_pay->set('batchnum' => $cust_pay->paybatch);


@@ -1038,12 +1092,14 @@ sub _upgrade_data {  #class method
     foreach my $table (qw(cust_pay cust_pay_void cust_refund)) {
       my $and_batchnum_is_null =
         ( $table =~ /^cust_pay/ ? ' AND batchnum IS NULL' : '' );
     foreach my $table (qw(cust_pay cust_pay_void cust_refund)) {
       my $and_batchnum_is_null =
         ( $table =~ /^cust_pay/ ? ' AND batchnum IS NULL' : '' );

+      my $pkey = ($table =~ /^cust_pay/ ? 'paynum' : 'refundnum');

       my $search = FS::Cursor->new({
         table     => $table,
         extra_sql => "WHERE payby IN('CARD','CHEK') ".
                      "AND (paybatch IS NOT NULL ".
                      "OR (paybatch IS NULL AND auth IS NULL
       my $search = FS::Cursor->new({
         table     => $table,
         extra_sql => "WHERE payby IN('CARD','CHEK') ".
                      "AND (paybatch IS NOT NULL ".
                      "OR (paybatch IS NULL AND auth IS NULL

-                     $and_batchnum_is_null ) )",
+                     $and_batchnum_is_null ) )
+                     ORDER BY $pkey DESC"

       });
       while ( my $object = $search->fetch ) {
         if ( $object->paybatch eq '' ) {
       });
       while ( my $object = $search->fetch ) {
         if ( $object->paybatch eq '' ) {


@@ -1118,7 +1174,7 @@ sub batch_import {
   my @fields;
   my $payby;
   if ( $format eq 'simple' ) {
   my @fields;
   my $payby;
   if ( $format eq 'simple' ) {

-    @fields = qw( custnum agent_custid paid payinfo );
+    @fields = qw( custnum agent_custid paid payinfo invnum );

     $payby = 'BILL';
   } elsif ( $format eq 'extended' ) {
     die "unimplemented\n";
     $payby = 'BILL';
   } elsif ( $format eq 'extended' ) {
     die "unimplemented\n";


@@ -1203,9 +1259,20 @@ sub batch_import {
       $cust_pay{custnum} = $2;
     }
 
       $cust_pay{custnum} = $2;
     }
 

+    my $custnum = $cust_pay{custnum};
+

     my $cust_pay = new FS::cust_pay( \%cust_pay );
     my $error = $cust_pay->insert;
 
     my $cust_pay = new FS::cust_pay( \%cust_pay );
     my $error = $cust_pay->insert;
 

+    if ( ! $error && $cust_pay->custnum != $custnum ) {
+      #invnum was defined, and ->insert set custnum to the customer for that
+      #invoice, but it wasn't the one the import specified.
+      $dbh->rollback if $oldAutoCommit;
+      $error = "specified invoice #". $cust_pay{invnum}.
+               " is for custnum ". $cust_pay->custnum.
+               ", not specified custnum $custnum";
+    }
+

     if ( $error ) {
       $dbh->rollback if $oldAutoCommit;
       return "can't insert payment for $line: $error";
     if ( $error ) {
       $dbh->rollback if $oldAutoCommit;
       return "can't insert payment for $line: $error";