oxonlinemoduleversionnotifier.php

Go to the documentation of this file.

<?php

class oxOnlineModuleVersionNotifier
{

    protected $_sProtocolversion = '1.0';


    protected $_sWebServiceUrl = 'https://omvn.oxid-esales.com/check.php';

    protected $_sRawResponseMessage = '';

    protected $_aModules = array();

    protected $_blIsException = false;

    public function setModules($aModules)
    {
        $this->_aModules = $aModules;
    }

    public function getModules()
    {
        return $this->_aModules;
    }

    public function setRawResponseMessage($sRawResponseMessage)
    {
        $this->_sRawResponseMessage = $sRawResponseMessage;
    }

    public function getRawResponseMessage()
    {
        return $this->_sRawResponseMessage;
    }

    public function setWebServiceUrl($sWebServiceUrl)
    {
        $this->_sWebServiceUrl = $sWebServiceUrl;
    }

    public function getWebServiceUrl()
    {
        return $this->_sWebServiceUrl;
    }

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

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

    protected function _prepareModulesInformation()
    {
        $aPreparedModules = array();

        $aModules = oxRegistry::getConfig()->getConfigParam('aModulePaths');
        if( !is_array($aModules) ) {
            return;
        }

        foreach( $aModules as $sModule ) {
            $oModule = oxNew('oxModule');
            if (!$oModule->load($sModule)) {
                continue;
            }

            $oPreparedModule = new stdClass();
            $oPreparedModule->id = $oModule->getId();
            $oPreparedModule->version = $oModule->getInfo('version');

            $oPreparedModule->activeInShops = new stdClass();
            $oPreparedModule->activeInShops->activeInShop = array( ($oModule->isActive() ? oxRegistry::getConfig()->getShopUrl() : null) );

            $aPreparedModules[] = $oPreparedModule;
        }

        $this->setModules($aPreparedModules);
    }

    protected function _doRequest($oRequestParams)
    {
        $sOutput = "";

        $oXml = oxNew('oxSimpleXml');
        $sXml = $oXml->objectToXml($oRequestParams, 'omvnRequest');

        // send request to web service
        try {
            $oCurl = oxNew( 'oxCurl' );
            $oCurl->setMethod( 'POST' );
            $oCurl->setUrl( $this->getWebServiceUrl() );
            $oCurl->setParameters( array("xmlRequest" => $sXml) );
            $sOutput = $oCurl->execute();
        } catch (Exception $oEx) {
            throw new oxException('OMVN_ERROR_REQUEST_FAILED');
        }
        return $sOutput;
    }

    protected function _sendRequestMessage()
    {
        $this->_prepareModulesInformation();

        // build request parameters
        $oRequestParams = new stdClass();

        $oRequestParams->modules = new stdClass();
        $oRequestParams->modules->module = $this->getModules();

        $oRequestParams->edition = oxRegistry::getConfig()->getEdition();
        $oRequestParams->version = oxRegistry::getConfig()->getVersion();
        $oRequestParams->shopurl = oxRegistry::getConfig()->getShopUrl();
        $oRequestParams->pversion = $this->_sProtocolversion;


        if ( !$sOutput = $this->_doRequest($oRequestParams) ){
            throw new oxException('OMVN_ERROR_REQUEST_FAILED');
        }
        $this->setRawResponseMessage($sOutput);
    }

    public function versionNotify()
    {
        $this->_setIsException(false);

        try {
            $this->_sendRequestMessage();
            return true;

        } catch ( oxException $oEx ) {
            $this->_setIsException(true);
            return false;
        }
    }
}