show credit balance on invoices, #11564

[freeside.git] / FS / FS / payinfo_Mixin.pm

diff --git a/FS/FS/payinfo_Mixin.pm b/FS/FS/payinfo_Mixin.pm
index f2edbd2..9995183 100644 (file)
--- a/FS/FS/payinfo_Mixin.pm
+++ b/FS/FS/payinfo_Mixin.pm
@@ -18,14 +18,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
@@ -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');
   }
 }
 
@@ -112,25 +104,11 @@ sub paycvv {
 sub paymask {
   my($self, $paymask) = @_;
 
-  if ( defined($paymask) && $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
@@ -157,6 +135,8 @@ sub mask_payinfo {
   my $paymask;
   if ( $self->is_encrypted($payinfo) ) {
     $paymask = 'N/A';
+  } elsif ( $payinfo =~ /^99\d{14}$/ || $payinfo eq 'N/A' ) { #token
+    $paymask = 'N/A (tokenized)'; #?
   } else {
     # if not, mask it...
     if ($payby eq 'CARD' || $payby eq 'DCRD' || $payby eq 'MCRD') {
@@ -179,14 +159,9 @@ sub mask_payinfo {
       $paymask = $payinfo;
     }
   }
-  return $paymask;
+  $paymask;
 }
 
-=cut
-
-sub _mask_payinfo {
-  my $self = shift;
-
 =item payinfo_check
 
 Checks payby and payinfo.
@@ -225,25 +200,63 @@ sub payinfo_check {
         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'); #???
     }
   } else {
     if ( $self->is_encrypted($self->payinfo) ) {
       #something better?  all it would cause is a decryption error anyway?
-      my $error = $self->ut_anythingn('payinfo');
+      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
 
-Have to add the future items...
+Returns payment method and information (suitably masked, if applicable) as
+a human-readable string, such as:
+
+  Card #54xxxxxxxxxxxx32
+
+or
+
+  Check #119006
+
+=cut
+
+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