book closing schema changes
[freeside.git] / FS / FS / cust_pay.pm
index a70b7cb..3f81135 100644 (file)
@@ -1,15 +1,24 @@
 package FS::cust_pay;
 
 use strict;
-use vars qw( @ISA );
+use vars qw( @ISA $conf $unsuspendauto );
 use Business::CreditCard;
-use FS::Record qw( dbh );
+use FS::UID qw( dbh );
+use FS::Record qw( dbh qsearch qsearchs dbh );
 use FS::cust_bill;
 use FS::cust_bill_pay;
 use FS::cust_main;
 
 @ISA = qw( FS::Record );
 
+#ask FS::UID to run this stuff for us later
+$FS::UID::callback{'FS::cust_pay'} = sub { 
+
+  $conf = new FS::Conf;
+  $unsuspendauto = $conf->exists('unsuspendauto');
+
+};
+
 =head1 NAME
 
 FS::cust_pay - Object methods for cust_pay objects
@@ -48,10 +57,12 @@ L<Time::Local> and L<Date::Parse> for conversion functions.
 
 =item payby - `CARD' (credit cards), `BILL' (billing), or `COMP' (free)
 
-=item payinfo - card number, P.O.#, or comp issuer (4-8 lowercase alphanumerics; think username)
+=item payinfo - card number, check #, or comp issuer (4-8 lowercase alphanumerics; think username), respectively
 
 =item paybatch - text field for tracking card processing
 
+=item closed - books closed flag, empty or `Y'
+
 =back
 
 =head1 METHODS
@@ -90,9 +101,78 @@ sub insert {
   local $FS::UID::AutoCommit = 0;
   my $dbh = dbh;
 
+  if ( $self->invnum ) {
+    my $cust_bill = qsearchs('cust_bill', { 'invnum' => $self->invnum } )
+      or do {
+        $dbh->rollback if $oldAutoCommit;
+        return "Unknown cust_bill.invnum: ". $self->invnum;
+      };
+    $self->custnum($cust_bill->custnum );
+  }
+
+  my $cust_main = qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
+  my $old_balance = $cust_main->balance;
+
+  my $error = $self->check;
+  return $error if $error;
+
+  $error = $self->SUPER::insert;
+  if ( $error ) {
+    $dbh->rollback if $oldAutoCommit;
+    return "error inserting $self: $error";
+  }
+
+  if ( $self->invnum ) {
+    my $cust_bill_pay = new FS::cust_bill_pay {
+      'invnum' => $self->invnum,
+      'paynum' => $self->paynum,
+      'amount' => $self->paid,
+      '_date'  => $self->_date,
+    };
+    $error = $cust_bill_pay->insert;
+    if ( $error ) {
+      $dbh->rollback if $oldAutoCommit;
+      return "error inserting $cust_bill_pay: $error";
+    }
+  }
+
+  $dbh->commit or die $dbh->errstr if $oldAutoCommit;
+
+  #false laziness w/ cust_credit::insert
+  if ( $unsuspendauto && $old_balance && $cust_main->balance <= 0 ) {
+    my @errors = $cust_main->unsuspend;
+    #return 
+    # side-fx with nested transactions?  upstack rolls back?
+    warn "WARNING:Errors unsuspending customer ". $cust_main->custnum. ": ".
+         join(' / ', @errors)
+      if @errors;
+  }
+  #eslaf
+
+  '';
+
+}
+
+sub upgrade_replace { #1.3.x->1.4.x
+  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 $error = $self->check;
   return $error if $error;
 
+  my %new = $self->hash;
+  my $new = FS::cust_pay->new(\%new);
+
   if ( $self->invnum ) {
     my $cust_bill_pay = new FS::cust_bill_pay {
       'invnum' => $self->invnum,
@@ -105,10 +185,12 @@ sub insert {
       $dbh->rollback if $oldAutoCommit;
       return $error;
     }
-    $self->custnum($cust_bill_pay->cust_bill->custnum);
+    $new->custnum($cust_bill_pay->cust_bill->custnum);
+  } else {
+    die;
   }
 
-  $error = $self->SUPER::insert;
+  $error = $new->SUPER::replace($self);
   if ( $error ) {
     $dbh->rollback if $oldAutoCommit;
     return $error;
@@ -118,6 +200,7 @@ sub insert {
 
   '';
 
+
 }
 
 =item delete
@@ -127,7 +210,9 @@ Currently unimplemented (accounting reasons).
 =cut
 
 sub delete {
-  return "Can't (yet?) delete cust_pay records!";
+  my $self = shift;
+  return "Can't delete closed payment" if $self->closed =~ /^Y/i;
+  $self->SUPER::delete(@_);
 }
 
 =item replace OLD_RECORD
@@ -152,13 +237,16 @@ sub check {
 
   my $error =
     $self->ut_numbern('paynum')
-    || $self->ut_number('custnum')
+    || $self->ut_numbern('custnum')
     || $self->ut_money('paid')
     || $self->ut_numbern('_date')
     || $self->ut_textn('paybatch')
+    || $self->ut_enum('closed', [ '', 'Y' ])
   ;
   return $error if $error;
 
+  return "paid must be > 0 " if $self->paid <= 0;
+
   return "unknown cust_main.custnum: ". $self->custnum
     unless $self->invnum
            || qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
@@ -168,6 +256,7 @@ sub check {
   $self->payby =~ /^(CARD|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;
@@ -223,7 +312,7 @@ sub unapplied {
 
 =head1 VERSION
 
-$Id: cust_pay.pm,v 1.5 2001-09-02 02:46:55 ivan Exp $
+$Id: cust_pay.pm,v 1.14 2002-01-28 06:57:23 ivan Exp $
 
 =head1 BUGS