oxonlinevatidcheck.php

Go to the documentation of this file.

<?php

class oxOnlineVatIdCheck extends oxCompanyVatInChecker
{

    protected $_blServiceIsOn = null;

    protected static $_aVatCheckCache = array();

    const BUSY_RETRY_CNT = 1;

    const BUSY_RETRY_WAITUSEC = 500000;

    protected $_sWsdl = 'http://ec.europa.eu/taxation_customs/vies/checkVatService.wsdl';

    public function __construct()
    {
    }

    public function validate(oxCompanyVatIn $oVatIn)
    {
        $oCheckVat = new stdClass();
        $oCheckVat->countryCode = $oVatIn->getCountryCode();
        $oCheckVat->vatNumber = $oVatIn->getNumbers();

        $blResult = $this->_checkOnline($oCheckVat);
        if (!$blResult) {
            $this->setError('ID_NOT_VALID');
        }

        return $blResult;
    }

    protected function _parseError($sErrorMsg)
    {
        if (!$sErrorMsg || $sErrorMsg == 'INVALID_INPUT') {
            $oEx = oxNew('oxInputException');
            $oEx->setMessage('VAT_MESSAGE_' . ($sErrorMsg ? $sErrorMsg : 'ID_NOT_VALID'));
            throw $oEx;
        }

        $oEx = oxNew('oxConnectionException');
        $oEx->setAdress($this->getWsdlUrl());
        $oEx->setMessage('VAT_MESSAGE_' . $sErrorMsg);
        $oEx->debugOut();
        throw $oEx;
    }

    public function checkUid($sCompVatId)
    {
        if (isset(self::$_aVatCheckCache[$sCompVatId])) {
            if (true === self::$_aVatCheckCache[$sCompVatId]) {
                return true;
            }
            if (is_string(self::$_aVatCheckCache[$sCompVatId])) {
                $this->_parseError(self::$_aVatCheckCache[$sCompVatId]);
            }

            return false;
        }

        $oCheckVat = new stdClass();
        $oCheckVat->countryCode = substr($sCompVatId, 0, 2);
        $oCheckVat->vatNumber = substr($sCompVatId, 2);

        if (!$this->_checkOnline($oCheckVat)) {
            $sErrorMsg = $this->_getError();
            self::$_aVatCheckCache[$sCompVatId] = $sErrorMsg;
            $this->_parseError($sErrorMsg);
        }

        return self::$_aVatCheckCache[$sCompVatId] = true;
    }

    public function catchWarning($iErrNo, $sErrStr, $sErrFile, $iErrLine)
    {
        // message to write to exception log
        $sLogMessage = "Warning: $sErrStr in $sErrFile on line $iErrLine";

        // fetching exception log file name
        $oEx = oxNew("oxException");
        $sLogFileName = $oEx->getLogFileName();

        // logs error message
        return oxRegistry::getUtils()->writeToLog($sLogMessage, $sLogFileName);
    }

    protected function _isServiceAvailable()
    {
        if ($this->_blServiceIsOn === null) {
            $this->_blServiceIsOn = class_exists('SoapClient') ? true : false;
            if ($this->_blServiceIsOn) {
                $rFp = @fopen($this->getWsdlUrl(), 'r');
                $this->_blServiceIsOn = $rFp !== false;
                if ($this->_blServiceIsOn) {
                    $sWsdl = '';
                    while (!feof($rFp)) {
                        $sWsdl .= fread($rFp, 8192);
                    }
                    fclose($rFp);

                    // validating wsdl file
                    try {
                        $oDomDocument = new DOMDocument();
                        $oDomDocument->loadXML($sWsdl);
                    } catch (Exception $oExcp) {
                        // invalid xml
                        $this->_blServiceIsOn = false;
                    }
                }
            }
        }

        return $this->_blServiceIsOn;
    }

    protected function _checkOnline($oCheckVat)
    {
        if ($this->_isServiceAvailable()) {
            $iTryMoreCnt = self::BUSY_RETRY_CNT;

            //T2009-07-02
            //how long socket should wait for server RESPONSE
            ini_set('default_socket_timeout', 5);

            // setting local error handler to catch possible soap errors
            set_error_handler(array($this, 'catchWarning'), E_WARNING);

            do {
                try {
                    //connection_timeout = how long we should wait to CONNECT to wsdl server
                    $oSoapClient = new SoapClient($this->getWsdlUrl(), array("connection_timeout" => 5));
                    $this->setError('');
                    $oRes = $oSoapClient->checkVat($oCheckVat);
                    $iTryMoreCnt = 0;
                } catch (SoapFault $e) {
                    $this->setError($e->faultstring);
                    if ($this->getError() == "SERVER_BUSY") {
                        usleep(self::BUSY_RETRY_WAITUSEC);
                    } else {
                        $iTryMoreCnt = 0;
                    }
                }
            } while (0 < $iTryMoreCnt--);

            // restoring previous error handler
            restore_error_handler();

            return (bool) $oRes->valid;
        } else {
            $this->setError("SERVICE_UNREACHABLE");

            return false;
        }
    }

    protected function _getError()
    {
        $sError = '';
        if ($this->_sError) {
            $sRegex = '/\{ \'([A-Z_]*)\' \}/';
            $n = preg_match($sRegex, $this->_sError, $aMatches);
            $sError = ($aMatches[1]) ? $aMatches[1] : 'SERVICE_UNAVAILABLE';
        }

        return $sError;
    }

    public function getWsdlUrl()
    {
        // overriding wsdl url
        if (($sWsdl = oxRegistry::getConfig()->getConfigParam("sVatIdCheckInterfaceWsdl"))) {
            $this->_sWsdl = $sWsdl;
        }

        return $this->_sWsdl;
    }

    public function isDisabled()
    {
        return (bool) oxRegistry::getConfig()->getConfigParam("blVatIdCheckDisabled");
    }
}