—
—
—
—
—
—
—

              
 package Business::Tax::VAT::Validation;
 ############################################################################
# IT Development software                                                    #
# European VAT number validator Version 0.13                                 #
# Copyright 2003 Nauwelaerts B  bpn#it-development%be                        #
# Created 06/08/2003            Last Modified 05/07/2007                     #
 ############################################################################
# COPYRIGHT NOTICE                                                           #
# Copyright 2003 Bernard Nauwelaerts  All Rights Reserved.                   #
#                                                                            #
# THIS SOFTWARE IS RELEASED UNDER THE GNU Public Licence                     #
# Please see COPYING for details                                             #
#                                                                            #
# DISCLAIMER                                                                 #
#  As usually with GNU software, this one is provided as is,                 # 
#  WITHOUT ANY WARRANTY, without even the implied warranty of                #
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                      #
#                                                                            #
 ############################################################################
# Revision history (dd/mm/yyyy) :                                            #
#                                                                            #
# 0.15   06/07/2007; Added missing "keys" during $self->{members}            #
#                    constuction                                             #
#                    (Thanks to Dave O.)                                     #
#                    Corrected returned 0-1 error codes inversion            #
#                    Some POD improvements                                   #
# 0.14   05/07/2007; VIES interface changed $baseurl, and POST params were   #
#                    changed to lowercase. Added support for Bulgaria and    #
#                    Romania (thanks to Kaloyan Iliev)                       #
#                    New get_last_error_code method                          #
#                    Updated regexps according to the actual VIES FAQ        #
#                    Some slight documentation improvements                  #
#                    Improved tests: each regexp is tested accordind to FAQ  #
# 0.13   16/01/2007; VIES interface changed "not found" layout               # 
#                    (Thanks to Tom Kirkpatrick for this update)                 #
# 0.12   10/11/2006; YAML Compliance                                             # 
# 0.11   10/11/2006; Minor bug allowing one forbidden character              # 
#                    corrected in Belgian regexp                             # 
#                            (Thanks to Andy Wardley for this report)                #
#                    + added regular_expressions property                    # 
#                      for external testing purposes                         #  
# 0.10   20/07/2006; Adding Test::Pod to test suite                          #
# 0.09   20/06/2006; local_check method allows you to test VAT numbers       #
#                    without asking the EU database. Based on regexps.       #
# 0.08   20/06/2006; 9 and 10 digits transitional regexp for Belgium         #
#                    From 31/12/2007, only 10 digits will be valid           #
# 0.07   25/05/2006; Now we use "request" method not "simple request"        #
#                    in order to follow potential redirects                  #
# 0.06   25/05/2006; Changed $baseurl                                                        #
#                    (Thanks to Torsten Mueller for this update)                 #
# 0.05   19/01/2006; Adding support for proxy settings                               #
#                    (Thanks to Tom Kirkpatrick for this update)                 #
# 0.04   01/11/2004; Adding support for error "Member Service Unavailable"   #
# 0.03   01/11/2004; Adding 10 new members.                                  #
#                    (Thanks to Robert Alloway for this update)              #
# 0.02   29/09/2003; Fix alphanumeric VAT numbers rejection                  #
#                    (Thanks to Robert Alloway for the regexps)              #
# 0.01   06/08/2003; Initial release                                         #
#                                                                            #
 ############################################################################
use strict;
BEGIN {
    $Business::Tax::VAT::Validation::VERSION = "0.15";
    use HTTP::Request::Common qw(POST);
    use LWP::UserAgent;
}
HideShow 40 lines of Pod
=head1 NAME
Business::Tax::VAT::Validation - A class for european VAT numbers validation.
=head1 SYNOPSIS
  use Business::Tax::VAT::Validation;
   
  my $hvatn=Business::Tax::VAT::Validation->new();
   
  # Check number
  if ($hvatn->check($VAT, [$member_state])){
        print "OK\n";
  } else {
        print $hvatn->get_last_error;
  }
   
=head1 DESCRIPTION
This class provides you a easy api to check validity of european VAT numbers (if the provided number exists).
It asks the EU database for this. 
=head1 CONSTRUCTOR
=over 4
=item B<new> Class constructor.
    $hvatn=Business::Tax::VAT::Validation->new();
     
    If your system is located behind a proxy :
     
    $hvatn=Business::Tax::VAT::Validation->new(-proxy => ['http', 'http://example.com:8001/']);
     
    Note : 
=cut
sub new {
    my $class   = shift;
    my %arg     = @_;
    my $self = {
        #baseurl  => 'http://europa.eu.int/comm/taxation_customs/vies/cgi-bin/viesquer', # Obsolete since v0.06
        #baseurl  => 'http://ec.europa.eu/taxation_customs/vies/cgi-bin/viesquer',       # Obsolete since v0.14
        baseurl    => 'http://ec.europa.eu/taxation_customs/vies/viesquer.do',
        error      =>    '',
        error_code => 0,
        re         => {
        ### t/01_localcheck.t tests if these regexps accepts all regular VAT numbers, according to VIES FAQ
            AT      =>  'U[0-9]{8}',
            BE      =>  '0?[0-9]{9}',
            BG      =>  '[0-9]{9,10}',
            CY      =>  '[0-9]{8}[A-Za-z]',
            CZ      =>  '[0-9]{8,10}',
            DE      =>  '[0-9]{9}',
            DK      =>  '[0-9]{2} [0-9]{2} [0-9]{2} [0-9]{2}',
            EE      =>  '[0-9]{9}',
            EL      =>  '[0-9]{9}',
            ES      =>  '([A-Za-z0-9][0-9]{7}[A-Za-z0-9])',
            FI      =>  '[0-9]{8}',
            FR      =>  '[A-Za-z10-9]{2} [0-9]{9}',
            GB      =>  '([0-9]{3} [0-9]{4} [0-9]{2}( [0-9]{3})?|GD[0-9]{3}|HA[0-9]{3})',
            HU      =>  '[0-8]{8}',
            IE      =>  '[0-9][A-Za-z0-9\+\*][0-9]{5}[A-Za-z]',
            IT      =>  '[0-9]{11}',
            LT      =>  '([0-9]{9}|[0-9]{12})',
            LU      =>  '[0-9]{8}',
            LV      =>  '[0-9]{11}',
            MT      =>  '[0-9]{8}',
            NL      =>  '[0-9]{9}B[0-9]{2}',
            PL      =>  '[0-9]{10}',
            PT      =>  '[0-9]{9}',
            RO      =>  '[0-9]{2,10}',
            SE      =>  '[0-9]{12}',
            SI      =>  '[0-9]{8}',
            SK      =>  '[0-9]{10}',
        },
        proxy => $arg{-proxy}
    };
    $self = bless $self, $class;
    $self->{members}=join('|', keys %{$self->{re}});
    $self;
}
HideShow 12 lines of Pod
=back
=head1 PROPERTIES
=over 4
=item B<member_states> Returns all member states 2-digit codes as array
    @ms=$hvatn->member_states;
     
=cut
sub member_states {
    my $self=shift;
    (keys %{$self->{re}})
}
HideShow 16 lines of Pod
=item B<regular_expressions> - Returns a hash list containing one regular expression for each country
If you want to test a VAT number format ouside this module, eg. embedded as javascript in web form.
    %re=$hvatn->regular_expressions;
returns
    (
        AT      =>  'U[0-9]{8}',
        ...
        SK          =>  '[0-9]{10}',
    );
=cut
sub regular_expressions {
    (%{shift->{re}})
}
HideShow 23 lines of Pod
=back
=head1 METHODS
=cut
=over 4
=item B<check> - Checks if a VAT number exists into the VIES database
     
    $ok=$hvatn->check($VAT, [$member_state]);
You may either provide the VAT number under its complete form (e.g. BE-123456789, BE123456789)
or either specify VAT and MS (member state) individually.
Valid MS values are :
 AT, BE, BG, CY, CZ, DE, DK, EE, EL, ES,
 FI, FR, GB, HU, IE, IT, LU, LV, MT, NL,
 PL, PT, RO, SE, SI, SK
=cut
sub check {
    my $self=shift;
    my $vatn=shift || return $self->_set_error('You must provide a VAT number');
    my $mscc=shift || '';
    ($vatn, $mscc)=$self->_format_vatn($vatn, $mscc);
    if ($vatn) {
        my $ua = LWP::UserAgent->new;
        if (ref $self->{proxy} eq 'ARRAY') {
            $ua->proxy(@{$self->{proxy}});
        } else {
            $ua->env_proxy;
        }
        $ua->agent('Business::Tax::VAT::Validation/'.$Business::Tax::VAT::Validation::VERSION);
        my $req = POST $self->{baseurl},
        [
            'selectedLanguage'        => 'EN',
            'ms'                      => $mscc ,
            'vat'                     => $vatn ,
            'iso'                     => $mscc ,
        ];
        return $mscc.'-'.$vatn if $self->_is_res_ok($ua->request($req)->as_string);
    }
    0;
}
HideShow 8 lines of Pod
=item B<local_check> - Checks if a VAT number format is valid
     
    $ok=$hvatn->local_check($VAT, [$member_state]);
     
    This method is based on regexps only and DOES NOT asks the VIES database
=cut
sub local_check {
    my $self=shift;
    my $vatn=shift || return $self->_set_error('You must provide a VAT number');
    my $mscc=shift || '';
    ($vatn, $mscc)=$self->_format_vatn($vatn, $mscc);
    if ($vatn) {
        return 1
    } else {
        return 0
    }
}
HideShow 39 lines of Pod
=item B<get_last_error_code> - Returns the last recorded error code
=item B<get_last_error> - Returns the last recorded error
    my $err = $hvatn->get_last_error_code();
    my $txt = $hvatn->get_last_error();
Possible errors are :
=over 4
=item *
  0  Unknown MS code : Internal checkup failed (Specified Member State does not exists)
=item *
  1  Invalid VAT number format : Internal checkup failed (bad syntax)
=item *
  2  This VAT number doesn't exists in EU database : distant checkup
=item *
  3  This VAT number contains errors : distant checkup
=item *
 17  Time out connecting to the database : Temporary error when the connection to the database times out
=item *
 18  Member Sevice Unavailable: The EU database is unable to reach the requested member's database.
=item *
257  Invalid response, please contact the author of this module. : This normally only happens if this software doesn't recognize any valid pattern into the response document: this generally means that the database interface has been modified, and you'll make the author happy by submitting the returned response !!!
=back
If error_code > 16,  you should temporarily accept the provided number, and periodically perform new checks until response is OK or error < 17
If error_code > 256, you should temporarily accept the provided number, contact the author, and perform a new check when the software is updated.
=cut
sub get_last_error {
    shift->{error};
}
sub get_last_error_code {
    shift->{error_code};
}
### PRIVATE FUNCTIONS ==========================================================
sub _format_vatn {
    my $self=shift;
    my $vatn=shift;
    my $mscc=shift;
    my $null='';
    $vatn=~s/\-/ /g; $vatn=~s/\./ /g; $vatn=~s/\s+/ /g;
    if (!$mscc && $vatn=~s/^($self->{members}) ?/$null/e) {
        $mscc=$1;
    }
    return $self->_set_error(0, "Unknown MS code") if $mscc!~m/^($self->{members})$/;
    my $re=$self->{re}{$mscc};
    return $self->_set_error(1, "Invalid VAT number format") if $vatn!~m/^$re$/;
    ($vatn, $mscc);
}
sub _is_res_ok {
    my $self=shift;
    my $res=shift;
    if ($res=~/^(\d{3}) (.*)/) {
        return $self->_set_error($1, $2)
    }
    $res=~s/[\r\n]//; $res=~s/>/>\n/;
    foreach (split(/\n/, $res)) {
        next unless $_;
        if (/^\s*No\, invalid VAT number/) {
            return $self->_set_error(2, "This VAT number doesn't exists in EU database.")
        } elsif (/^\s*Error\: (.*)$/) {
            return $self->_set_error(3, "This VAT number contains errors: ".$1)
        } elsif (/Request time-out\. Please re-submit your request later/){
                        return $self->_set_error(17, "Time out connecting to the database")
        } elsif (/^\s*Member State service unavailable/) {
            return $self->_set_error(18, "Member State service unavailable: Please re-submit your request later.")
        }
        return 1 if /^\s*Yes\, valid VAT number$/;
    }
    $self->_set_error(257, "Invalid response, please contact the author of this module. ".$res)
}
sub _set_error {
    my ($self, $code, $txt)=@_;
    $self->{error_code}=$code;
    $self->{error}=$txt;
    undef
HideShow 64 lines of Pod
}
=back
=head1 Why not SOAP ?
Just because this module's author wasn't given such time to do so. The SOAP module available at CPAN at time of writing is farly too complex to be used here, simple tasks having to be simply performed.
=head1 Other documentation
Jetez un oeil sur I<http://www.it-development.be/software/PERL/Business-Tax-VAT-Validation/> pour la documentation en français.
=head1 Feedback
If you find this module useful, or have any comments, suggestions or improvements, please let me know.
=head1 AUTHOR
Bernard Nauwelaerts <bpn#it-development%be>
=head1 Credits
Many thanks to the following people, actively implied in this software development by submitting patches, bug reports, new members regexps, VIES interface changes,... :
Sorted by last intervention :
=over 4
=item *
Dave O., POBox, U.S.A.
=item *
Kaloyan Iliev, Digital Systems, Bulgaria.
=item *
Tom Kirkpatrick, Virus Bulletin, United Kingdom.
=item *
Andy Wardley, individual, United Kingdom.
=item *
Robert Alloway, Service Centre, United Kingdom.
=item *
Torsten Mueller, Archesoft, Germany
=back
=head1 LICENSE
GPL. Enjoy! See COPYING for further informations on the GPL.
=head1 Disclaimer
See I<http://ec.europa.eu/taxation_customs/vies/viesdisc.do> to known the limitations of the EU validation service.
  This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
  without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
=cut
1;