X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fpayinfo_Mixin.pm;h=d03391f6806cfe66ee9219be382a54d787a8d3f0;hp=652dc4149b5775b836ab2c528aac87d9f187ae7d;hb=72deba42ac5847c2a6bdeea20157035b8f9df7ae;hpb=a0ddcb6b2ac38076c48e8f0b69e0758d5283303a

diff --git a/FS/FS/payinfo_Mixin.pm b/FS/FS/payinfo_Mixin.pm
index 652dc4149..d03391f68 100644
--- a/FS/FS/payinfo_Mixin.pm
+++ b/FS/FS/payinfo_Mixin.pm
@@ -14,18 +14,10 @@ package FS::some_table;
 use vars qw(@ISA);
 @ISA = qw( FS::payinfo_Mixin FS::Record );
 
-=had1 DESCRIPTION
+=head1 DESCRIPTION
 
 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
@@ -74,12 +66,12 @@ Card Number, P.O., comp issuer (4-8 lowercase alphanumerics; think username) or
 
 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 +102,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
@@ -134,33 +117,62 @@ sub paymask {
 
 =over 4
 
-=item mask_payinfo
+=item mask_payinfo [ PAYBY, PAYINFO ]
 
-This method converts the payment info (credit card, bank account, etc.) into a masked string.
+This method converts the payment info (credit card, bank account, etc.) into a
+masked string.
+
+Optionally, an arbitrary payby and payinfo can be passed.
 
 =cut
 
 sub mask_payinfo {
   my $self = shift;
-  my $paymask;
-  my $payinfo = $self->payinfo;
-  my $payby = $self->payby;
+  my $payby   = scalar(@_) ? shift : $self->payby;
+  my $payinfo = scalar(@_) ? shift : $self->payinfo;
+
   # Check to see if it's encrypted...
-  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));
-    } elsif ($payby eq 'CHEK' ||
-             $payby eq 'DCHK' ) { # Checks (Show last 2 @ bank)
+  if ( $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') {
+
+      # 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 : '');
+
     } else { # Tie up loose ends
-      $paymask = $payinfo;
+      return $payinfo;
     }
   }
-  return $paymask;
+  #die "shouldn't be reached";
 }
 
 =item payinfo_check
@@ -190,30 +202,74 @@ sub payinfo_check {
   my $self = shift;
 
   FS::payby->can_payby($self->table, $self->payby)
-    or return "Illegal payby";
+    or return "Illegal payby: ". $self->payby;
 
-  if ( $self->payby eq 'CARD' ) {
+  if ( $self->payby eq 'CARD' && ! $self->is_encrypted($self->payinfo) ) {
     my $payinfo = $self->payinfo;
     $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');
+      $self->payinfo('N/A'); #???
     }
   } else {
-    my $error = $self->ut_textn('payinfo');
-    return $error if $error;
+    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;
+    }
   }
+
+  '';
+
 }
 
-=head1 BUGS
+=item payby_payinfo_pretty
+
+Returns payment method and information (suitably masked, if applicable) as
+a human-readable string, such as:
+
+  Card #54xxxxxxxxxxxx32
+
+or
+
+  Check #119006
+
+=cut
 
-Have to add the future items...
+sub payby_payinfo_pretty {
+  my $self = shift;
+  if ( $self->payby eq 'CARD' ) {
+    'Card #'. $self->paymask;
+  } elsif ( $self->payby eq 'CHEK' ) {
+    'E-check acct#'. $self->payinfo;
+  } elsif ( $self->payby eq 'BILL' ) {
+    'Check #'. $self->payinfo;
+  } elsif ( $self->payby eq 'PREP' ) {
+    'Prepaid card #'. $self->payinfo;
+  } elsif ( $self->payby eq 'CASH' ) {
+    'Cash '. $self->payinfo;
+  } elsif ( $self->payby eq 'WEST' ) {
+    'Western Union'; #. $self->payinfo;
+  } elsif ( $self->payby eq 'MCRD' ) {
+    'Manual credit card'; #. $self->payinfo;
+  } else {
+    $self->payby. ' '. $self->payinfo;
+  }
+}
+
+=back
+
+=head1 BUGS
 
 =head1 SEE ALSO