package FS::cust_pay_void;
+
use strict;
-use vars qw( @ISA );
+use base qw( FS::otaker_Mixin FS::payinfo_Mixin FS::cust_main_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 fields); # 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;
-@ISA = qw( FS::Record );
+@encrypted_fields = ('payinfo');
+$otaker_upgrade_kludge = 0;
=head1 NAME
=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),
+=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
+
+card number, check #, or comp issuer (4-8 lowercase alphanumerics; think username), respectively
+
+=item paybatch
+
+text field for tracking card processing
+
+=item closed
-=item paybatch - text field for tracking card processing
+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
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.
+=item replace [ OLD_RECORD ]
-=cut
+You can, but probably shouldn't modify voided payments...
-sub replace {
- return "Can'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
|| $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')
;
$payinfo =~ s/\D//g;
$self->payinfo($payinfo);
if ( $self->payinfo ) {
- $self->payinfo =~ /^(\d{13,16})$/
+ $self->payinfo =~ /^(\d{13,16}|\d{8,9})$/
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";
+ return "Unknown card type" if $self->payinfo !~ /^99\d{14}$/ #token
+ && cardtype($self->payinfo) eq "Unknown";
} else {
$self->payinfo('N/A');
}
return $error if $error;
}
- $self->otaker(getotaker);
+ $self->void_usernum($FS::CurrentUser::CurrentUser->usernum)
+ unless $self->void_usernum;
$self->SUPER::check;
}
qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
}
-=item payinfo_masked
+=item void_access_user
-Returns a "masked" payinfo field with all but the last four characters replaced
-by 'x'es. Useful for displaying credit cards.
+Returns the voiding employee object (see L<FS::access_user>).
=cut
-sub payinfo_masked {
+sub void_access_user {
my $self = shift;
- my $payinfo = $self->payinfo;
- 'x'x(length($payinfo)-4). substr($payinfo,(length($payinfo)-4));
+ qsearchs('access_user', { 'usernum' => $self->void_usernum } );
+}
+
+# Used by FS::Upgrade to migrate to a new database.
+sub _upgrade_data { # class method
+ my ($class, %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