oxonlinelicensecheck.php

Go to the documentation of this file.

<?php

class oxOnlineLicenseCheck
{

    const CONFIG_VAR_NAME = 'iOlcSuccess';

    protected $_iValidResponseCode = 0;

    protected $_sValidResponseMessage = 'ACK';

    protected $_aSerialKeys = array();

    protected $_sErrorMessage = '';

    protected $_blIsException = false;

    protected $_oCaller = null;

    protected $_oUserCounter = null;

    protected $_oServersManager = null;

    public function setServersManager($oServersManager)
    {
        $this->_oServersManager = $oServersManager;
    }

    public function getServersManager()
    {
        return $this->_oServersManager;
    }

    public function setUserCounter($oUserCounter)
    {
        $this->_oUserCounter = $oUserCounter;
    }

    public function getUserCounter()
    {
        return $this->_oUserCounter;
    }


    public function __construct($oCaller)
    {
        $this->_oCaller = $oCaller;
    }

    public function getErrorMessage()
    {
        return $this->_sErrorMessage;
    }

    public function isException()
    {
        return $this->_blIsException;
    }

    public function validateShopSerials()
    {
        $aSerials = oxRegistry::getConfig()->getConfigParam("aSerials");
        if (!$this->validate($aSerials) && !$this->isException()) {
            $this->_startGracePeriod();
        }
    }

    public function validateNewSerial($sSerial)
    {
        $aSerials = oxRegistry::getConfig()->getConfigParam("aSerials");
        $aSerials[] = array('attributes' => array('state' => 'new'), 'value' => $sSerial);

        return $this->validate($aSerials);
    }

    public function validate($aSerials)
    {
        $aSerials = (array)$aSerials;
        $this->_setIsException(false);

        $blResult = false;
        try {
            $oRequest = $this->_formRequest($aSerials);

            $oCaller = $this->_getCaller();
            $oResponse = $oCaller->doRequest($oRequest);

            $blResult = $this->_validateResponse($oResponse);

            if ($blResult) {
                $this->_logSuccess();
            }
        } catch (oxException $oEx) {
            $this->_setErrorMessage($oEx->getMessage());
            $this->_setIsException(true);
        }

        return $blResult;
    }

    protected function _setErrorMessage($sErrorMessage)
    {
        $this->_sErrorMessage = $sErrorMessage;
    }

    protected function _getCaller()
    {
        return $this->_oCaller;
    }

    protected function _validateResponse($oResponse)
    {
        if (isset($oResponse->code) && isset($oResponse->message)) {
            if ($oResponse->code == $this->_iValidResponseCode &&
                $oResponse->message == $this->_sValidResponseMessage
            ) {
                // serial keys are valid
                $blValid = true;
            } else {
                // serial keys are not valid
                $this->_setErrorMessage(oxRegistry::getLang()->translateString('OLC_ERROR_SERIAL_NOT_VALID'));
                $blValid = false;
            }
        } else {
            // validation result is unknown
            throw new oxException('OLC_ERROR_RESPONSE_NOT_VALID');
        }

        return $blValid;
    }

    protected function _formRequest($aSerials)
    {
        $oConfig = oxRegistry::getConfig();

        $oRequest = oxNew('oxOnlineLicenseCheckRequest');

        $oRequest->revision = $oConfig->getRevision();

        $oRequest->keys = array('key' => $aSerials);

        $oRequest->productSpecificInformation = new stdClass();

        if (!is_null($this->getServersManager())) {
            $aServers = $this->getServersManager()->getServers();
            $oRequest->productSpecificInformation->servers = array('server' => $aServers);
        }

        $aCounters = $this->_formCounters();
        if (!empty($aCounters)) {
            $oRequest->productSpecificInformation->counters = array('counter' => $aCounters);
        }

        return $oRequest;
    }

    protected function _formCounters()
    {
        $oUserCounter = $this->_getUserCounter();

        $aCounters = array();

        if (!is_null($this->getUserCounter())) {
            $aCounters[] = array(
                'name' => 'admin users',
                'value' => $oUserCounter->getAdminCount(),
            );
            $aCounters[] = array(
                'name' => 'active admin users',
                'value' => $oUserCounter->getActiveAdminCount(),
            );
        }

        $aCounters[] = array(
            'name' => 'subShops',
            'value' => oxRegistry::getConfig()->getMandateCount(),
        );

        return $aCounters;
    }

    protected function _logSuccess()
    {
        $iTime = oxRegistry::get("oxUtilsDate")->getTime();
        $sBaseShop = oxRegistry::getConfig()->getBaseShopId();
        oxRegistry::getConfig()->saveShopConfVar("str", oxOnlineLicenseCheck::CONFIG_VAR_NAME, $iTime, $sBaseShop);
    }

    protected function _setIsException($blIsException)
    {
        $this->_blIsException = $blIsException;
    }

    protected function _startGracePeriod()
    {
    }

    protected function _getUserCounter()
    {
        return $this->_oUserCounter;
    }
}