X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fcust_pay_void.pm;h=ce4e7da78b4e8f2fbc09323db55fb2967056ebc8;hp=7267929c86127139576654acbbe6bea34d011a15;hb=772656864b377bbd2ef2febd40891ef1206b5be0;hpb=cfe85e45bcba97089988b4dc22a895aec687f2c3

diff --git a/FS/FS/cust_pay_void.pm b/FS/FS/cust_pay_void.pm
index 7267929c8..ce4e7da78 100644
--- a/FS/FS/cust_pay_void.pm
+++ b/FS/FS/cust_pay_void.pm
@@ -1,15 +1,23 @@
 package FS::cust_pay_void; 
+use base qw( FS::otaker_Mixin FS::payinfo_transaction_Mixin FS::cust_main_Mixin
+             FS::reason_Mixin FS::Record );
+
 use strict;
-use vars qw( @ISA );
+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(qsearch qsearchs dbh fields);
+use FS::CurrentUser;
+use FS::access_user;
+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;
+
+@encrypted_fields = ('payinfo');
+sub nohistory_fields { ('payinfo'); }
 
-@ISA = qw( FS::Record );
+$otaker_upgrade_kludge = 0;
 
 =head1 NAME
 
@@ -37,27 +45,56 @@ 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
 
-=item custnum - customer (see L<FS::cust_main>)
+customer (see L<FS::cust_main>)
 
-=item paid - Amount of this payment
+=item paid
 
-=item _date - specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
+Amount of this payment
+
+=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
+
+Payment Type (See L<FS::payinfo_Mixin> for valid values)
+
+=item payinfo
+
+card number, check #, or comp issuer (4-8 lowercase alphanumerics; think username), respectively
+
+=item cardtype
+
+Credit card type, if appropriate.
 
-=item payinfo - card number, check #, or comp issuer (4-8 lowercase alphanumerics; think username), respectively
+=item paybatch
 
-=item paybatch - text field for tracking card processing
+text field for tracking card processing
 
-=item closed - books closed flag, empty or `Y'
+=item closed
+
+books closed flag, empty or `Y'
+
+=item pkgnum
+
+Desired pkgnum when using experimental package balances.
 
 =item void_date
 
-=item reason
+=item reason - a freeform string (deprecated)
+
+=item reasonnum - Reason for voiding the payment (see L<FS::reason>)
 
 =back
 
@@ -77,26 +114,65 @@ 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;
+
+  my $cust_pay_pending =
+    qsearchs('cust_pay_pending', { void_paynum => $self->paynum });
+  if ( $cust_pay_pending ) {
+    $cust_pay_pending->set('paynum', $cust_pay->paynum);
+    $cust_pay_pending->set('void_paynum', '');
+    $error ||= $cust_pay_pending->replace;
+  }
 
-=item replace OLD_RECORD
+  $error ||= $self->delete;
+  if ( $error ) {
+    $dbh->rollback if $oldAutoCommit;
+    return $error;
+  }
 
-Currently unimplemented.
+  $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 
-=cut
+  '';
 
-sub replace {
-   return "Can't modify voided payments!";
 }
 
+=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 ]
+
+You can, but probably shouldn't modify voided payments...
+
+Replaces the OLD_RECORD with this one in the database, or, if OLD_RECORD is not
+supplied, replaces this record.  If there is an error, returns the error,
+otherwise returns false.
+
 =item check
 
 Checks all fields to make sure this is a valid voided payment.  If there is an
@@ -115,8 +191,11 @@ 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')
+    # || $self->payinfo_check #we'd rather void what we have than fail on this
+    || $self->ut_foreign_keyn('reasonnum', 'reason', 'reasonnum')
   ;
   return $error if $error;
 
@@ -128,30 +207,8 @@ sub check {
 
   $self->void_date(time) unless $self->void_date;
 
-  $self->payby =~ /^(CARD|CHEK|LECB|BILL|COMP)$/ or return "Illegal payby";
-  $self->payby($1);
-
-  #false laziness with cust_refund::check
-  if ( $self->payby eq 'CARD' ) {
-    my $payinfo = $self->payinfo;
-    $payinfo =~ s/\D//g;
-    $self->payinfo($payinfo);
-    if ( $self->payinfo ) {
-      $self->payinfo =~ /^(\d{13,16})$/
-        or return "Illegal (mistyped?) credit card number (payinfo)";
-      $self->payinfo($1);
-      validate($self->payinfo) or return "Illegal credit card number";
-      return "Unknown card type" if cardtype($self->payinfo) eq "Unknown";
-    } else {
-      $self->payinfo('N/A');
-    }
-
-  } else {
-    $error = $self->ut_textn('payinfo');
-    return $error if $error;
-  }
-
-  $self->otaker(getotaker);
+  $self->void_usernum($FS::CurrentUser::CurrentUser->usernum)
+    unless $self->void_usernum;
 
   $self->SUPER::check;
 }
@@ -160,24 +217,52 @@ sub check {
 
 Returns the parent customer object (see L<FS::cust_main>).
 
+=item void_access_user
+
+Returns the voiding employee object (see L<FS::access_user>).
+
 =cut
 
-sub cust_main {
+sub void_access_user {
   my $self = shift;
-  qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
+  qsearchs('access_user', { 'usernum' => $self->void_usernum } );
 }
 
-=item payinfo_masked
+=item reason
 
-Returns a "masked" payinfo field with all but the last four characters replaced
-by 'x'es.  Useful for displaying credit cards.
+Returns the text of the associated void reason (see L<FS::reason>) for this.
 
 =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 $FS::payinfo_Mixin::ignore_masked_payinfo = 1;
+
+  $class->_upgrade_reasonnum(%opts);
+
+  my $sql = "SELECT usernum FROM access_user WHERE username = ( SELECT history_user FROM h_cust_pay_void WHERE paynum = ? AND history_action = 'insert' ORDER BY history_date LIMIT 1 ) ";
+  my $sth = dbh->prepare($sql) or die dbh->errstr;
+
+  foreach my $cust_pay_void (qsearch('cust_pay_void', {'void_usernum' => ''})) {
+    $sth->execute($cust_pay_void->paynum) or die $sth->errstr;
+    my $row = $sth->fetchrow_arrayref;
+    my $usernum = $row ? $row->[0] : '';
+    if ( $usernum ) {
+      $cust_pay_void->void_usernum($usernum);
+      my $error = $cust_pay_void->replace;
+      die $error if $error;
+    } else {
+      warn "cust_pay_void upgrade: can't find access_user record for ". $cust_pay_void->paynum. "\n";
+    }
+  }
+
+  local($otaker_upgrade_kludge) = 1;
+  $class->_upgrade_otaker(%opts);
+
+  #XXX look for the h_cust_pay delete records and when that's a different
+  # usernum, set usernum
 }
 
 =back