X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fcust_pay.pm;h=799ceab510fd8fd3e5ea4232332699c68718687c;hp=42ca0b0a55ea2d59492dc83f359393e3a6dea052;hb=197e1640b4d44a4769fccc947d0f1e128fbde3a8;hpb=fbcb45dfe5a1bce7981fe4527176b9fdf2ec54b7 diff --git a/FS/FS/cust_pay.pm b/FS/FS/cust_pay.pm index 42ca0b0a5..799ceab51 100644 --- a/FS/FS/cust_pay.pm +++ b/FS/FS/cust_pay.pm @@ -1,15 +1,26 @@ package FS::cust_pay; use strict; -use vars qw( @ISA ); +use vars qw( @ISA $conf $unsuspendauto ); +use Date::Format; use Business::CreditCard; -use FS::Record qw( dbh qsearch qsearchs ); +use Text::Template; +use FS::UID qw( dbh ); +use FS::Record qw( dbh qsearch qsearchs dbh ); +use FS::Misc qw(send_email); use FS::cust_bill; use FS::cust_bill_pay; +use FS::cust_pay_refund; use FS::cust_main; @ISA = qw( FS::Record ); +#ask FS::UID to run this stuff for us later +FS::UID->install_callback( sub { + $conf = new FS::Conf; + $unsuspendauto = $conf->exists('unsuspendauto'); +} ); + =head1 NAME FS::cust_pay - Object methods for cust_pay objects @@ -46,12 +57,15 @@ currently supported: =item _date - specified as a UNIX timestamp; see L. Also see L and L for conversion functions. -=item payby - `CARD' (credit cards), `BILL' (billing), or `COMP' (free) +=item payby - `CARD' (credit cards), `CHEK' (electronic check/ACH), +`LECB' (phone bill billing), `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 +104,6 @@ sub insert { local $FS::UID::AutoCommit = 0; my $dbh = dbh; - my $error = $self->check; - return $error if $error; - if ( $self->invnum ) { my $cust_bill = qsearchs('cust_bill', { 'invnum' => $self->invnum } ) or do { @@ -102,6 +113,12 @@ sub insert { $self->custnum($cust_bill->custnum ); } + my $cust_main = $self->cust_main; + my $old_balance = $cust_main->balance; + + my $error = $self->check; + return $error if $error; + $error = $self->SUPER::insert; if ( $error ) { $dbh->rollback if $oldAutoCommit; @@ -122,14 +139,84 @@ sub insert { } } + if ( $self->paybatch =~ /^webui-/ ) { + my @cust_pay = qsearch('cust_pay', { + 'custnum' => $self->custnum, + 'paybatch' => $self->paybatch, + } ); + if ( scalar(@cust_pay) > 1 ) { + $dbh->rollback if $oldAutoCommit; + return "a payment with webui token ". $self->paybatch. " already exists"; + } + } + + #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 + $dbh->commit or die $dbh->errstr if $oldAutoCommit; + #my $cust_main = $self->cust_main; + if ( $conf->exists('payment_receipt_email') + && grep { $_ ne 'POST' } $cust_main->invoicing_list + ) { + + my $receipt_template = new Text::Template ( + TYPE => 'ARRAY', + SOURCE => [ map "$_\n", $conf->config('payment_receipt_email') ], + ) or do { + warn "can't create payment receipt template: $Text::Template::ERROR"; + return ''; + }; + + my @invoicing_list = grep { $_ ne 'POST' } $cust_main->invoicing_list; + + my $payby = $self->payby; + my $payinfo = $self->payinfo; + $payby =~ s/^BILL$/Check/ if $payinfo; + $payinfo = $self->payinfo_masked if $payby eq 'CARD'; + + my $error = send_email( + 'from' => $conf->config('invoice_from'), #??? well as good as any + 'to' => \@invoicing_list, + 'subject' => 'Payment receipt', + 'body' => [ $receipt_template->fill_in( HASH => { + 'date' => time2str("%a %B %o, %Y", $self->_date), + 'name' => $cust_main->name, + 'paynum' => $self->paynum, + 'paid' => sprintf("%.2f", $self->paid), + 'payby' => ucfirst(lc($payby)), + 'payinfo' => $payinfo, + 'balance' => $cust_main->balance, + } ) ], + ); + if ( $error ) { + warn "can't send payment receipt: $error"; + } + + } + ''; } -sub upgrade_replace { #1.3.x->1.4.x +=item delete + +Deletes this payment and all associated applications (see L), +unless the closed flag is set. + +=cut + +sub delete { my $self = shift; + return "Can't delete closed payment" if $self->closed =~ /^Y/i; local $SIG{HUP} = 'IGNORE'; local $SIG{INT} = 'IGNORE'; @@ -142,50 +229,54 @@ sub upgrade_replace { #1.3.x->1.4.x 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, - 'paynum' => $self->paynum, - 'amount' => $self->paid, - '_date' => $self->_date, - }; - $error = $cust_bill_pay->insert; + foreach my $cust_bill_pay ( $self->cust_bill_pay ) { + my $error = $cust_bill_pay->delete; if ( $error ) { $dbh->rollback if $oldAutoCommit; return $error; } - $new->custnum($cust_bill_pay->cust_bill->custnum); - } else { - die; } - $error = $new->SUPER::replace($self); + my $error = $self->SUPER::delete(@_); if ( $error ) { $dbh->rollback if $oldAutoCommit; return $error; } - $dbh->commit or die $dbh->errstr if $oldAutoCommit; - - ''; + if ( $conf->config('deletepayments') ne '' ) { + + my $cust_main = $self->cust_main; + + my $error = send_email( + 'from' => $conf->config('invoice_from'), #??? well as good as any + 'to' => $conf->config('deletepayments'), + 'subject' => 'FREESIDE NOTIFICATION: Payment deleted', + 'body' => [ + "This is an automatic message from your Freeside installation\n", + "informing you that the following payment has been deleted:\n", + "\n", + 'paynum: '. $self->paynum. "\n", + 'custnum: '. $self->custnum. + " (". $cust_main->last. ", ". $cust_main->first. ")\n", + 'paid: $'. sprintf("%.2f", $self->paid). "\n", + 'date: '. time2str("%a %b %e %T %Y", $self->_date). "\n", + 'payby: '. $self->payby. "\n", + 'payinfo: '. $self->payinfo. "\n", + 'paybatch: '. $self->paybatch. "\n", + ], + ); + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return "can't send payment deletion notification: $error"; + } -} - -=item delete + } -Currently unimplemented (accounting reasons). + $dbh->commit or die $dbh->errstr if $oldAutoCommit; -=cut + ''; -sub delete { - return "Can't (yet?) delete cust_pay records!"; } =item replace OLD_RECORD @@ -214,18 +305,22 @@ sub check { || $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 } ); $self->_date(time) unless $self->_date; - $self->payby =~ /^(CARD|BILL|COMP)$/ or return "Illegal payby"; + $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; @@ -245,8 +340,7 @@ sub check { return $error if $error; } - ''; #no error - + $self->SUPER::check; } =item cust_bill_pay @@ -263,10 +357,26 @@ sub cust_bill_pay { ; } +=item cust_pay_refund + +Returns all applications of refunds (see L) to this +payment. + +=cut + +sub cust_pay_refund { + my $self = shift; + sort { $a->_date <=> $b->_date } + qsearch( 'cust_pay_refund', { 'paynum' => $self->paynum } ) + ; +} + + =item unapplied Returns the amount of this payment that is still unapplied; which is -paid minus all payment applications (see L). +paid minus all payment applications (see L) and refund +applications (see L). =cut @@ -274,18 +384,40 @@ sub unapplied { my $self = shift; my $amount = $self->paid; $amount -= $_->amount foreach ( $self->cust_bill_pay ); + $amount -= $_->amount foreach ( $self->cust_pay_refund ); sprintf("%.2f", $amount ); } -=back +=item cust_main -=head1 VERSION +Returns the parent customer object (see L). -$Id: cust_pay.pm,v 1.7 2001-09-03 22:07:38 ivan Exp $ +=cut + +sub cust_main { + my $self = shift; + 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)); +} + +=back =head1 BUGS -Delete and replace methods. +Delete and replace methods. payinfo_masked false laziness with cust_main.pm +and cust_refund.pm =head1 SEE ALSO