X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fpayinfo_Mixin.pm;h=f4c6b4a86a507d70dd8d15446d8d83588aa2984b;hb=0cc73df2d8ca19b1f8c2fc93bd4f2468b738b969;hp=847fcc62ad9ec8660ca0b11460c1e0ea6fd2b354;hpb=0d6bdb9706b6925e4be85d7dabfb9155e1d1f2aa;p=freeside.git diff --git a/FS/FS/payinfo_Mixin.pm b/FS/FS/payinfo_Mixin.pm index 847fcc62a..f4c6b4a86 100644 --- a/FS/FS/payinfo_Mixin.pm +++ b/FS/FS/payinfo_Mixin.pm @@ -3,6 +3,12 @@ package FS::payinfo_Mixin; use strict; use Business::CreditCard; use FS::payby; +use FS::Record qw(qsearch); +use FS::UID qw(driver_name); +use FS::Cursor; +use Time::Local qw(timelocal); + +use vars qw( $ignore_masked_payinfo $allow_closed_replace ); =head1 NAME @@ -18,14 +24,6 @@ use vars qw(@ISA); This is a mixin class for records that contain payinfo. -This class handles the following functions for payinfo... - -Payment Mask (Generation and Storage) -Data Validation (parent checks need to be sure to call this) -Encryption - In the Future (Pull from Record.pm) -Bad Card Stuff - In the Future (Integrate Banned Pay) -Currency - In the Future - =head1 FIELDS =over 4 @@ -43,43 +41,36 @@ For Customers (cust_main): For Refunds (cust_refund): 'CARD' (credit cards), 'CHEK' (electronic check/ACH), 'LECB' (Phone bill billing), 'BILL' (billing), 'CASH' (cash), -'WEST' (Western Union), 'MCRD' (Manual credit card), 'CBAK' Chargeback, or 'COMP' (free) +'WEST' (Western Union), 'MCRD' (Manual credit card), 'MCHK' (Manual electronic +check), 'CBAK' Chargeback, or 'COMP' (free) For Payments (cust_pay): 'CARD' (credit cards), 'CHEK' (electronic check/ACH), 'LECB' (phone bill billing), 'BILL' (billing), 'PREP' (prepaid card), -'CASH' (cash), 'WEST' (Western Union), or 'MCRD' (Manual credit card) +'CASH' (cash), 'WEST' (Western Union), 'MCRD' (Manual credit card), 'MCHK' +(Manual electronic check), 'PPAL' (PayPal) 'COMP' (free) is depricated as a payment type in cust_pay =cut -# was this supposed to do something? - -#sub payby { -# my($self,$payby) = @_; -# if ( defined($payby) ) { -# $self->setfield('payby', $payby); -# } -# return $self->getfield('payby') -#} - =item payinfo Payment information (payinfo) can be one of the following types: -Card Number, P.O., comp issuer (4-8 lowercase alphanumerics; think username) or prepayment identifier (see L) +Card Number, P.O., comp issuer (4-8 lowercase alphanumerics; think username) +prepayment identifier (see L), PayPal transaction ID =cut sub payinfo { my($self,$payinfo) = @_; + if ( defined($payinfo) ) { - $self->setfield('payinfo', $payinfo); # This is okay since we are the 'setter' - $self->paymask($self->mask_payinfo()); + $self->setfield('payinfo', $payinfo); + $self->paymask($self->mask_payinfo) unless $payinfo =~ /^99\d{14}$/; #token } else { - $payinfo = $self->getfield('payinfo'); # This is okay since we are the 'getter' - return $payinfo; + $self->getfield('payinfo'); } } @@ -110,22 +101,13 @@ sub paycvv { =cut sub paymask { - my($self,$paymask)=@_; - + my($self, $paymask) = @_; - if ($paymask ne '') { - # I hate this little bit of magic... I don't expect it to cause a problem, but who knows... - # If the payinfo is passed in masked then ignore it and set it based on the payinfo - # The only guy that should call this in this way is... $self->payinfo - $self->setfield('paymask', $self->mask_payinfo()); + if ( defined($paymask) ) { + $self->setfield('paymask', $paymask); } else { - $paymask=$self->getfield('paymask'); - if (!defined($paymask) || $paymask eq '') { - # Generate it if it's blank - Note that we're not going to set it - just generate - $paymask = $self->mask_payinfo(); - } + $self->getfield('paymask') || $self->mask_payinfo; } - return $paymask; } =back @@ -149,84 +131,241 @@ sub mask_payinfo { my $payinfo = scalar(@_) ? shift : $self->payinfo; # Check to see if it's encrypted... - my $paymask; - if ( $self->is_encrypted($payinfo) ) { - $paymask = 'N/A'; - } else { - # if not, mask it... - if ($payby eq 'CARD' || $payby eq 'DCRD' || $payby eq 'MCRD') { - # Credit Cards (Show first and last four) - $paymask = substr($payinfo,0,6). - 'x'x(length($payinfo)-10). - substr($payinfo,(length($payinfo)-4)); + if ( ref($self) && $self->is_encrypted($payinfo) ) { + return 'N/A'; + } elsif ( $payinfo =~ /^99\d{14}$/ || $payinfo eq 'N/A' ) { #token + return 'N/A (tokenized)'; #? + } else { # if not, mask it... + + if ($payby eq 'CARD' || $payby eq 'DCRD') { + #|| $payby eq 'MCRD') { + #MCRD isn't a card in payinfo, + #its a record of an _offline_ + #card + + # Credit Cards + + # special handling for Local Isracards: always show last 4 + if ( $payinfo =~ /^(\d{8,9})$/ ) { + + return 'x'x(length($payinfo)-4). + substr($payinfo,(length($payinfo)-4)); + + } + + my $conf = new FS::Conf; + my $mask_method = $conf->config('card_masking_method') || 'first6last4'; + $mask_method =~ /^first(\d+)last(\d+)$/ + or die "can't parse card_masking_method $mask_method"; + my($first, $last) = ($1, $2); + + return substr($payinfo,0,$first). + 'x'x(length($payinfo)-$first-$last). + substr($payinfo,(length($payinfo)-$last)); + } elsif ($payby eq 'CHEK' || $payby eq 'DCHK' ) { + # Checks (Show last 2 @ bank) my( $account, $aba ) = split('@', $payinfo ); - $paymask = 'x'x(length($account)-2). - substr($account,(length($account)-2))."@".$aba; + return 'x'x(length($account)-2). + substr($account,(length($account)-2)). + ( length($aba) ? "@".$aba : ''); + + } elsif ($payby eq 'EDI') { + # EDI. + # These numbers have been seen anywhere from 8 to 30 digits, and + # possibly more. Lacking any better idea I'm going to mask all but + # the last 4 digits. + return 'x' x (length($payinfo) - 4) . substr($payinfo, -4); + } else { # Tie up loose ends - $paymask = $payinfo; + return $payinfo; } } - return $paymask; + #die "shouldn't be reached"; } +=item payinfo_check + +Checks payby and payinfo. + =cut -sub _mask_payinfo { +sub payinfo_check { my $self = shift; -=item payinfo_check + FS::payby->can_payby($self->table, $self->payby) + or return "Illegal payby: ". $self->payby; -Checks payby and payinfo. + if ( $self->payby eq 'CARD' && ! $self->is_encrypted($self->payinfo) ) { -For Customers (cust_main): -'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand), -'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand), -'LECB' (Phone bill billing), 'BILL' (billing), 'COMP' (free), or -'PREPAY' (special billing type: applies a credit - see L and sets billing type to I) + unless ( $self->paycardtype ) { -For Refunds (cust_refund): -'CARD' (credit cards), 'CHEK' (electronic check/ACH), -'LECB' (Phone bill billing), 'BILL' (billing), 'CASH' (cash), -'WEST' (Western Union), 'MCRD' (Manual credit card), 'CBAK' (Chargeback), or 'COMP' (free) + if ( $self->payinfo =~ /^99\d{14}$/ ) { + if ( $self->paymask =~ /^\d+x/ ) { + $self->set('paycardtype', cardtype($self->paymask)); + } else { + $self->set('paycardtype', ''); + # return "paycardtype required ". + # "(can't derive from a token and no paymask w/prefix provided)"; + } + } else { + $self->set('paycardtype', cardtype($self->payinfo)); + } -For Payments (cust_pay): -'CARD' (credit cards), 'CHEK' (electronic check/ACH), -'LECB' (phone bill billing), 'BILL' (billing), 'PREP' (prepaid card), -'CASH' (cash), 'WEST' (Western Union), or 'MCRD' (Manual credit card) -'COMP' (free) is depricated as a payment type in cust_pay + } + + if ( $ignore_masked_payinfo and $self->mask_payinfo eq $self->payinfo ) { + # allow it + } else { + my $payinfo = $self->payinfo; + $payinfo =~ s/\D//g; + $self->payinfo($payinfo); + if ( $self->payinfo ) { + $self->payinfo =~ /^(\d{13,19}|\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 $self->paycardtype eq "Unknown"; + } else { + $self->payinfo('N/A'); #??? + } + } + + } else { + + unless ( $self->paycardtype ) { + + if ( $self->payby eq 'CARD' && $self->paymask =~ /^\d+x/ ) { + # if we can't decrypt the card, at least detect the cardtype + $self->set('paycardtype', cardtype($self->paymask)); + } else { + $self->set('paycardtype', ''); + # return "paycardtype required ". + # "(can't derive from a token and no paymask w/prefix provided)"; + } + + } + + if ( $self->is_encrypted($self->payinfo) ) { + #something better? all it would cause is a decryption error anyway? + my $error = $self->ut_anything('payinfo'); + return $error if $error; + } else { + my $error = $self->ut_textn('payinfo'); + return $error if $error; + } + } + + return ''; +} + +=item payby_payinfo_pretty [ LOCALE ] + +Returns payment method and information (suitably masked, if applicable) as +a human-readable string, such as: + + Card #54xxxxxxxxxxxx32 + +or + + Check #119006 =cut -sub payinfo_check { +sub payby_payinfo_pretty { my $self = shift; + my $locale = shift; + my $lh = FS::L10N->get_handle($locale); + if ( $self->payby eq 'CARD' ) { + if ($self->paymask =~ /tokenized/) { + $lh->maketext('Tokenized Card'); + } else { + $lh->maketext('Card #') . $self->paymask; + } + } elsif ( $self->payby eq 'CHEK' ) { - FS::payby->can_payby($self->table, $self->payby) - or return "Illegal payby: ". $self->payby; + #false laziness w/view/cust_main/payment_history.html::translate_payinfo + my( $account, $aba ) = split('@', $self->paymask ); - 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"; + if ( $aba =~ /^(\d{5})\.(\d{3})$/ ) { #blame canada + my($branch, $routing) = ($1, $2); + $lh->maketext("Routing [_1], Branch [_2], Acct [_3]", + $routing, $branch, $account); } else { - $self->payinfo('N/A'); + $lh->maketext("Routing [_1], Acct [_2]", $aba, $account); } + + } elsif ( $self->payby eq 'BILL' ) { + $lh->maketext('Check #') . $self->payinfo; + } elsif ( $self->payby eq 'PREP' ) { + $lh->maketext('Prepaid card #') . $self->payinfo; + } elsif ( $self->payby eq 'CASH' ) { + $lh->maketext('Cash') . ' ' . $self->payinfo; + } elsif ( $self->payby eq 'WEST' ) { + # does Western Union localize their name? + $lh->maketext('Western Union'); + } elsif ( $self->payby eq 'MCRD' ) { + $lh->maketext('Manual credit card'); + } elsif ( $self->payby eq 'MCHK' ) { + $lh->maketext('Manual electronic check'); + } elsif ( $self->payby eq 'EDI' ) { + $lh->maketext('EDI') . ' ' . $self->paymask; + } elsif ( $self->payby eq 'PPAL' ) { + $lh->maketext('PayPal transaction#') . $self->order_number; } else { - my $error = $self->ut_textn('payinfo'); - return $error if $error; + $self->payby. ' '. $self->payinfo; } } -=head1 BUGS +=item payinfo_used [ PAYINFO ] + +Returns 1 if there's an existing payment using this payinfo. This can be +used to set the 'recurring payment' flag required by some processors. + +=cut + +sub payinfo_used { + my $self = shift; + my $payinfo = shift || $self->payinfo; + my %hash = ( + 'custnum' => $self->custnum, + 'payby' => $self->payby, + ); + + return 1 + if qsearch('cust_pay', { %hash, 'payinfo' => $payinfo } ) + || qsearch('cust_pay', { %hash, 'paymask' => $self->mask_payinfo } ) + ; + + return 0; +} -Have to add the future items... +=item upgrade_set_cardtype + +Find all records with a credit card payment type and no paycardtype, and +replace them in order to set their paycardtype. + +=cut + +sub upgrade_set_cardtype { + my $class = shift; + # assign cardtypes to CARD/DCRDs that need them; check_payinfo_cardtype + # will do this. ignore any problems with the cards. + local $ignore_masked_payinfo = 1; + my $search = FS::Cursor->new({ + table => $class->table, + extra_sql => q[ WHERE payby IN('CARD','DCRD') AND paycardtype IS NULL ], + }); + while (my $record = $search->fetch) { + my $error = $record->replace; + die $error if $error; + } +} + +=back + +=head1 BUGS =head1 SEE ALSO