X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=CreditCard.pm;h=12dbf0d956add9e57bdd15a440eca16701248509;hb=27fc63b10116887d2db9a59de39930a03cf4156d;hp=1fe11089b1664a5e0fb8ec9b2d35270414ef2173;hpb=dea489dc1b1facbb1d1ad256d3ec2b284fb87e7e;p=Business-CreditCard.git diff --git a/CreditCard.pm b/CreditCard.pm index 1fe1108..12dbf0d 100644 --- a/CreditCard.pm +++ b/CreditCard.pm @@ -1,30 +1,17 @@ package Business::CreditCard; -# Business::CreditCard.pm -# -# Jon Orwant, -# -# 12 Jul 96 - created -# 17 Jan 97 - 0.21 released. -# short numbers and numbers with letters are no longer kosher. -# 1 Feb 2001 - 0.22 released, new maintainer, MakeMaker installation -# 3 May 2001 - 0.23 released, silly bug in test.pl -# 11 Jun 2001 - 0.24. added enRoute, JCB, BankCard, rewrote with regexes -# -# Copyright 1995,1996,1997 Jon Orwant. All rights reserved. -# This program is free software; you can redistribute it and/or -# modify it under the same terms as Perl itself. -# -# Version 0.24. Module list status is "Rdpf." - -require 5; - require Exporter; -use vars qw( @ISA $VERSION ); +use vars qw( @ISA $VERSION @EXPORT @EXPORT_OK %EXPORT_TAGS $Country ); @ISA = qw( Exporter ); -$VERSION = "0.23"; +$VERSION = "0.36"; + +@EXPORT = qw( cardtype validate generate_last_digit ); +@EXPORT_OK = qw( receipt_cardtype validate_card ); +$EXPORT_TAGS{NEW} = [ qw( validate_card cardtype receipt_cardtype ) ]; + +$Country = 'US'; =head1 NAME @@ -50,8 +37,37 @@ The validate() subroutine returns 1 if the card number provided passes the checksum test, and 0 otherwise. The cardtype() subroutine returns a string containing the type of -card: "MasterCard", "VISA", and so on. My list is not complete; -I welcome additions. +card. The list of possible return values is more comprehensive than it used +to be, but additions are still most welcome. + +Possible return values are: + + VISA card + MasterCard + Discover card + American Express card + enRoute + JCB + BankCard + Switch + Solo + China Union Pay + Laser + Isracard + Unknown + +"Not a credit card" is returned on obviously invalid data values. + +Versions before 0.31 may also have returned "Diner's Club/Carte Blanche" (these +cards are now recognized as "Discover card"). + +As of 0.30, cardtype() will accept a partial card masked with "x", "X', ".", +"*" or "_". Only the first 2-6 digits and the length are significant; +whitespace and dashes are removed. With two digits, Visa, MasterCard, Discover +and Amex are recognized (versions before 0.36 needed four digits to recognize +all Discover cards). With four digits, almost all cards except some +Switch cards are recognized. With six digits (the full "BIN" or "IIN"), all +cards are recognized. Six digits are also required for receipt_cardtype(). The generate_last_digit() subroutine computes and returns the last digit of the card given the preceding digits. With a 16-digit card, @@ -59,75 +75,247 @@ you provide the first 15 digits; the subroutine returns the sixteenth. This module does I tell you whether the number is on an actual card, only whether it might conceivably be on a real card. To verify -whether a card is real, or whether it's been stolen, or what its -balance is, you need a Merchant ID, which gives you access to credit -card databases. The Perl Journal (http://tpj.com/tpj) has -a Merchant ID so that I can accept MasterCard and VISA payments; it -comes with the little pushbutton/slide-your-card-through device you've -seen in restaurants and stores. That device calculates the checksum -for you, so I don't actually use this module. +whether a card is real, or whether it's been stolen, or to actually process +charges, you need a Merchant account. See L. These subroutines will also work if you provide the arguments as numbers instead of strings, e.g. C. -=head1 AUTHOR +=head1 PROCESSING AGREEMENTS + +Credit card issuers have recently been forming agreements to process cards on +other networks, in which one type of card is processed as another card type. + +By default, Business::CreditCard returns the type the card should be treated as +in the US. You can change this to return the type the card should +be treated as in a different country by setting +C<$Business::CreditCard::Country> to your two-letter country code. This +is probably what you want to determine if you accept the card, or which +merchant agreement it is processed through. + +You can also set C<$Business::CreditCard::Country> to a false value such +as the empty string to return the "base" card type. This is probably only +useful for informational purposes when used along with the default type. + +Here are the currently known agreements: + +=over 4 + +=item Most Diner's club is now identified as Discover. (This supercedes the earlier identification of some Diner's club cards as MasterCard inside the US and Canada.) + +=item JCB cards in the 3528-3589 range are identified as Discover inside the US and territories. + +=item China Union Pay cards are identified as Discover cards in the US, Mexico and most Caribbean countries. + +=back + +=head1 RECEIPT REQUIREMENTS + +Discover requires some cards processed on its network to display "PayPal" +on receipts instead of "Discover". The receipt_cardtype() subroutine will +return "PayPal card" for these cards only, and otherwise the same output as +cardtype(). + +Use this for receipt display/printing only. + +Note: this subroutine is not exported by default like the others. +Before 0.36, you needed to call this subroutine fully-qualified, as +Business::CreditCard::receipt_cardtype() + +In 0.36 and later, you can import it into your namespace: + + use Business::CreditCard qw( :DEFAULT receipt_cardtype ); + + +=head1 ORIGINAL AUTHOR Jon Orwant The Perl Journal and MIT Media Lab -orwant@tpj.com +=head1 MAINTAINER Current maintainer is Ivan Kohler . -Please don't bother Jon with emails about this module. -Lee Lawrence and Neale Banks -contributed support for additional card types. Lee also contributed a working -test.pl. +Lee Lawrence , Neale Banks and +Max Becker contributed support for additional card +types. Lee also contributed a working test.pl. Alexandr Ciornii + contributed code cleanups. Jason Terry + contributed updates for Discover BIN ranges. + +=head1 COPYRIGHT AND LICENSE + +Copyright (C) 1995,1996,1997 Jon Orwant +Copyright (C) 2001-2006 Ivan Kohler +Copyright (C) 2007-2016 Freeside Internet Services, Inc. + +This library is free software; you can redistribute it and/or modify +it under the same terms as Perl itself, either Perl version 5.8.8 or, +at your option, any later version of Perl 5 you may have available. + +=head1 BUGS + +(paraphrasing Neil Bowers) We export all functions by default. It would be +better to let the user decide which functions to import. And validate() is +a bit of a generic name. + +The question is, after almost 2 decades with this interface (inherited from +the original author, who probably never expected it to live half this long), +how to change things to behave in a more modern fashion without breaking +existing code? "use Business::CreditCard " turns it off? +Explicitly ask to turn it off and list that in the SYNOPSIS? + +=head2 validate() and @EXPORT transition plan + +First (done in 0.36): + +validate_card() is the new name for validate(). Both work for now. + +New-style usage (not recommended for code that needs to support B:CC before 0.36): + + use Business::CreditCard qw( :NEW ); + +You get validate_card(), cardtype() and receipt_cardtype(). You can also ask +for them explicitly / individually: + + use Business::CreditCard qw( validate_card cardtype receipt_cardtype ); + + +Second (we're at now now): + +Waiting for 0.36+ to become more prevalent. + + +Third: + +Recommend new-style usage. Maybe asking for a specific minimum version turns +it on too? + + +Fourth: + (this is the incompatible part): + +Don't export validate() (or anything else [separately?]) by default. + +This is the part that will break things and we probably won't do for a long +time, until new-style usage is the norm and the tradeoff of breaking old code +is worth it to stop or namespace pollution. Maybe do a 1.00 releaes with the +current API and 2.00 is when this happens (with a 1.99_01 pre-release)? + +=head1 SEE ALSO + +L is a wrapper around Business::CreditCard +providing an OO interface. Assistance integrating this into the base +Business::CreditCard distribution is welcome. + +L is a framework for processing online payments +including modules for various payment gateways. + +http://neilb.org/reviews/luhn.html is an excellent overview of similar modules +providing credit card number verification (LUHN checking). =cut -@EXPORT = qw(cardtype validate generate_last_digit); +## ref http://neilb.org/reviews/luhn.html#Comparison it looks like +## Business::CCCheck is 2x faster than we are. looking at their implementation +## not entirely a fair comparison, we also do the equivalent of their CC_clean, +## they don't recognize certain cards at all (i.e. Switch) which require +## an expensive check before VISA, Diners doesn't exist anymore, Discover is +## a lot more than just 6011*, they don't handle processing agreements, etc. sub cardtype { + # Allow use as a class method + shift if UNIVERSAL::isa( $_[0], 'Business::CreditCard' ); + my ($number) = @_; - return "Not a credit card" if $number =~ /[^\d\s]/; + $number =~ s/[\s\-]//go; + $number =~ s/[x\*\.\_]/x/gio; - $number =~ s/\D//g; + return "Not a credit card" if $number =~ /[^\dx]/io; + + #$number =~ s/\D//g; + { + local $^W=0; #no warning at next line + return "Not a credit card" + unless ( length($number) >= 13 + || length($number) == 8 || length($number) == 9 #Isracard + ) + && 0+$number; + } + + return "VISA card" if $number =~ /^4[0-8][\dx]{11,17}$/o; + + return "MasterCard" + if $number =~ /^5[1-5][\dx]{14}$/o + || $number =~ /^2 ( 22[1-9] | 2[3-9][\dx] | [3-6][\dx]{2} | 7[0-1][\dx] | 720 ) [\dx]{12}$/xo + || $number =~ /^2[2-7]xx[\dx]{12}$/o; + + return "American Express card" if $number =~ /^3[47][\dx]{13}$/o; + + return "Discover card" + if $number =~ /^30[0-5x][\dx]{13,16}$/o #diner's: 300-305, 30x + || $number =~ /^309[5x][\dx]{12}$/o # 3095, 309x + || $number =~ /^36[\dx]{12,17}$/o # 36 + || $number =~ /^3[89][\dx]{14,17}$/o # 38 and 39 + || $number =~ /^60[1x]{2}[\dx]{12,15}$/o #discover: 6011 601x 60xx + || $number =~ /^64[4-9x][\dx]{13,16}$/o # 644-649, 64x + || $number =~ /^65[\dx]{14,17}$/o # 65 + || ( $number =~ /^62[24-68x][\dx]{13,16}$/o && $Country =~ /^(US|MX|AI|AG|AW|BS|BB|BM|BQ|VG|KY|CW|DM|DO|GD|GP|JM|MQ|MS|BL|KN|LC|VC|MF|SX|TT|TC)$/oi ) #China Union Pay identified as Discover in US, Mexico and Caribbean + || ( $number =~ /^35(2[89x]|[3-8][\dx]|xx)[\dx]{12,15}$/o && $Country =~ /^(US|PR|VI|MP|PW|GU)$/oi ); #JCB cards in the 3528-3589 range are identified as Discover in US, Puerto Rico, US Virgin Islands, Northern Mariana Islands, Palau and Guam + + return "Switch" + if $number =~ /^49(03(0[2-9]|3[5-9])|11(0[1-2]|7[4-9]|8[1-2])|36[0-9]{2})[\dx]{10}([\dx]{2,3})?$/o + || $number =~ /^564182[\dx]{10}([\dx]{2,3})?$/o + || $number =~ /^6(3(33[0-4][0-9])|759[0-9]{2})[\dx]{10}([\dx]{2,3})?$/o; + #redunant with above, catch 49* that's not Switch + return "VISA card" if $number =~ /^4[\dx]{12,18}$/o; + + #"Diners Club enRoute" + return "enRoute" if $number =~ /^2(014|149)[\dx]{11}$/o; + + return "JCB" if $number =~ /^(3[\dx]{4}|2131|1800)[\dx]{11}$/o; + + return "BankCard" if $number =~ /^56(10[\dx][\dx]|022[1-5])[\dx]{10}$/o; + + return "Solo" + if $number =~ /^6(3(34[5-9][0-9])|767[0-9]{2})[\dx]{10}([\dx]{2,3})?$/o; + + return "China Union Pay" + if $number =~ /^62[24-68][\dx]{13}$/o; + + return "Laser" + if $number =~ /^6(304|7(06|09|71))[\dx]{12,15}$/o; + + return "Isracard" + if $number =~ /^[\dx]{8,9}$/; - return "Not a credit card" unless length($number) >= 13 && 0+$number; - - return "VISA card" if $number =~ /^4\d{12}(\d{3})?$/o; - return "MasterCard" if $number =~ /^5[1-5]\d{14}$/o; - return "Discover card" if $number =~ /^6011\d{12}$/o; - return "American Express card" if $number =~ /^3[47]\d{13}/o; - return "Diner's Club/Carte Blanche" - if $number =~ /^3(0[0-5]|[68]\d)\d{11}$/o; - return "enRoute" if $number =~ /^2(014|149)\d{11}$/o; - return "JCB" if $number =~ /^(3\d{4}|2131|1800)\d{11}$/o; - return "BankCard" if $number =~ /^56(10\d\d|022[1-5])\d{10}$/o; return "Unknown"; } -# from http://perl.about.com/compute/perl/library/nosearch/P073000.htm -# Card Type Prefix Length -# MasterCard 51-55 16 -# VISA 4 13, 16 -# American Express (AMEX) 34, 37 15 -# Diners Club/Carte Blanche 300-305, 36, 38 14 -# enRoute 2014, 2149 15 -# Discover 6011 16 -# JCB 3 16 -# JCB 2131, 1800 15 -# -# from Neale Banks -# According to a booklet I have from Westpac (an Aussie bank), a card number -# starting with 5610 or 56022[1-5] is a BankCard -# BankCards have exactly 16 digits. +sub receipt_cardtype { + # Allow use as a class method + shift if UNIVERSAL::isa( $_[0], 'Business::CreditCard' ); + + my ($number) = @_; + + $number =~ s/[\s\-]//go; + $number =~ s/[x\*\.\_]/x/gio; + + #ref Discover IIN Bulletin Feb 2015_021715 + return "PayPal card" if $number =~ /^6(01104|506[01]0)[\dx]{10,13}$/o; + + cardtype($number); +} sub generate_last_digit { + # Allow use as a class method + shift if UNIVERSAL::isa( $_[0], 'Business::CreditCard' ); + my ($number) = @_; + + die "invalid operation" if length($number) == 8 || length($number) == 9; + my ($i, $sum, $weight); $number =~ s/\D//g; @@ -140,14 +328,45 @@ sub generate_last_digit { return (10 - $sum % 10) % 10; } -sub validate { + +## this (GPLed) code from Business::CCCheck is apparantly 4x faster than ours +## ref http://neilb.org/reviews/luhn.html#Comparison +## maybe see if we can speed ours up a bit +# my @ccn = split('',$ccn); +# my $even = 0; +# $ccn = 0; +# for($i=$#ccn;$i >=0;--$i) { +# $ccn[$i] *= 2 if $even; +# $ccn -= 9 if $ccn[$i] > 9; +# $ccn += $ccn[$i]; +# $even = ! $even; +# } +# $type = '' if $ccn % 10; +# return $type; + +sub validate { validate_card(@_); } + +sub validate_card { + # Allow use as a class method + shift if UNIVERSAL::isa( $_[0], 'Business::CreditCard' ); + my ($number) = @_; + my ($i, $sum, $weight); return 0 if $number =~ /[^\d\s]/; $number =~ s/\D//g; + if ( $number =~ /^[\dx]{8,9}$/ ) { # Isracard + $number = "0$number" if length($number) == 8; + for($i=1;$i= 13 && 0+$number; for ($i = 0; $i < length($number) - 1; $i++) {