communigate provisioning phase 2: add svc_domain.trailer -> communigate TrailerText...

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

diff --git a/FS/FS/cust_pay_void.pm b/FS/FS/cust_pay_void.pm
index 7267929..e18a4f6 100644 (file)
--- a/FS/FS/cust_pay_void.pm
+++ b/FS/FS/cust_pay_void.pm
@@ -1,15 +1,20 @@
 package FS::cust_pay_void; 
+
 use strict;
-use vars qw( @ISA );
+use base qw( FS::otaker_Mixin FS::payinfo_Mixin FS::Record );
+use vars qw( @encrypted_fields $otaker_upgrade_kludge );
 use Business::CreditCard;
 use FS::UID qw(getotaker);
-use FS::Record qw(qsearchs); # dbh qsearch );
+use FS::Record qw(qsearchs dbh fields); # qsearch );
+use FS::cust_pay;
 #use FS::cust_bill;
 #use FS::cust_bill_pay;
 #use FS::cust_pay_refund;
 #use FS::cust_main;
+use FS::cust_pkg;
 
-@ISA = qw( FS::Record );
+@encrypted_fields = ('payinfo');
+$otaker_upgrade_kludge = 0;
 
 =head1 NAME
 
@@ -37,23 +42,48 @@ are currently supported:
 
 =over 4
 
-=item paynum - primary key (assigned automatically for new payments)
+=item paynum
+
+primary key (assigned automatically for new payments)
+
+=item custnum
+
+customer (see L<FS::cust_main>)
 
-=item custnum - customer (see L<FS::cust_main>)
+=item paid
 
-=item paid - Amount of this payment
+Amount of this payment
 
-=item _date - specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
+=item _date
+
+specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
 L<Time::Local> and L<Date::Parse> for conversion functions.
 
-=item payby - `CARD' (credit cards), `CHEK' (electronic check/ACH),
-`LECB' (phone bill billing), `BILL' (billing), or `COMP' (free)
+=item otaker
+
+order taker (see L<FS::access_user>)
+
+=item payby
+
+`CARD' (credit cards), `CHEK' (electronic check/ACH),
+`LECB' (phone bill billing), `BILL' (billing), `CASH' (cash),
+`WEST' (Western Union), `MCRD' (Manual credit card), or `COMP' (free)
 
-=item payinfo - card number, check #, or comp issuer (4-8 lowercase alphanumerics; think username), respectively
+=item payinfo
 
-=item paybatch - text field for tracking card processing
+card number, check #, or comp issuer (4-8 lowercase alphanumerics; think username), respectively
 
-=item closed - books closed flag, empty or `Y'
+=item paybatch
+
+text field for tracking card processing
+
+=item closed
+
+books closed flag, empty or `Y'
+
+=item pkgnum
+
+Desired pkgnum when using experimental package balances.
 
 =item void_date
 
@@ -77,16 +107,53 @@ sub table { 'cust_pay_void'; }
 
 Adds this voided payment to the database.
 
-=item delete
+=item unvoid 
 
-Currently unimplemented.
+"Un-void"s this payment: Deletes the voided payment from the database and adds
+back a normal payment.
 
 =cut
 
-sub delete {
-  return "Can't delete voided payments!";
+sub unvoid {
+  my $self = shift;
+
+  local $SIG{HUP} = 'IGNORE';
+  local $SIG{INT} = 'IGNORE';
+  local $SIG{QUIT} = 'IGNORE';
+  local $SIG{TERM} = 'IGNORE';
+  local $SIG{TSTP} = 'IGNORE';
+  local $SIG{PIPE} = 'IGNORE';
+
+  my $oldAutoCommit = $FS::UID::AutoCommit;
+  local $FS::UID::AutoCommit = 0;
+  my $dbh = dbh;
+
+  my $cust_pay = new FS::cust_pay ( {
+    map { $_ => $self->get($_) } fields('cust_pay')
+  } );
+  my $error = $cust_pay->insert;
+  if ( $error ) {
+    $dbh->rollback if $oldAutoCommit;
+    return $error;
+  }
+
+  $error = $self->delete;
+  if ( $error ) {
+    $dbh->rollback if $oldAutoCommit;
+    return $error;
+  }
+
+  $dbh->commit or die $dbh->errstr if $oldAutoCommit;
+
+  '';
+
 }
 
+=item delete
+
+Deletes this voided payment.  You probably don't want to use this directly; see
+the B<unvoid> method to add the original payment back.
+
 =item replace OLD_RECORD
 
 Currently unimplemented.
@@ -94,7 +161,8 @@ Currently unimplemented.
 =cut
 
 sub replace {
-   return "Can't modify voided payments!";
+   return "Can't modify voided payments!" unless $otaker_upgrade_kludge;
+   shift->SUPER::replace(@_);
 }
 
 =item check
@@ -115,6 +183,7 @@ sub check {
     || $self->ut_number('_date')
     || $self->ut_textn('paybatch')
     || $self->ut_enum('closed', [ '', 'Y' ])
+    || $self->ut_foreign_keyn('pkgnum', 'cust_pkg', 'pkgnum')
     || $self->ut_numbern('void_date')
     || $self->ut_textn('reason')
   ;
@@ -128,7 +197,8 @@ sub check {
 
   $self->void_date(time) unless $self->void_date;
 
-  $self->payby =~ /^(CARD|CHEK|LECB|BILL|COMP)$/ or return "Illegal payby";
+  $self->payby =~ /^(CARD|CHEK|LECB|BILL|COMP|PREP|CASH|WEST|MCRD)$/
+    or return "Illegal payby";
   $self->payby($1);
 
   #false laziness with cust_refund::check
@@ -151,7 +221,7 @@ sub check {
     return $error if $error;
   }
 
-  $self->otaker(getotaker);
+  $self->otaker(getotaker) unless $self->otaker;
 
   $self->SUPER::check;
 }
@@ -167,17 +237,11 @@ sub cust_main {
   qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
 }
 
-=item payinfo_masked
-
-Returns a "masked" payinfo field with all but the last four characters replaced
-by 'x'es.  Useful for displaying credit cards.
-
-=cut
-
-sub payinfo_masked {
-  my $self = shift;
-  my $payinfo = $self->payinfo;
-  'x'x(length($payinfo)-4). substr($payinfo,(length($payinfo)-4));
+# Used by FS::Upgrade to migrate to a new database.
+sub _upgrade_data {  # class method
+  my ($class, %opts) = @_;
+  local($otaker_upgrade_kludge) = 1;
+  $class->_upgrade_otaker(%opts);
 }
 
 =back