oxfilechecker.php

Go to the documentation of this file.

<?php

class oxFileChecker {

    protected $_blError          = false;

    protected $_sErrorMessage   = null;

    public $_sWebServiceUrl = 'http://oxchkversion.oxid-esales.com/webService.php';

    protected $_oCurlHandler = null;

    protected $_sEdition = "";

    protected $_sVersion = "";

    protected $_sRevision = "";

    protected $_sBaseDirectory = '';


    protected $_blListAllFiles = false;

    public function setBaseDirectory( $sDir )
    {
        if ( !empty( $sDir ) ) {
            $this->_sBaseDirectory = $sDir;
        }
    }

    public function getBaseDirectory()
    {
        return $this->_sBaseDirectory;
    }

    public function setVersion( $sVersion )
    {
        if ( !empty( $sVersion ) ) {
            $this->_sVersion = $sVersion;
        }
    }

    public function getVersion()
    {
        return $this->_sVersion;
    }

    public function setEdition( $sEdition )
    {
        if ( !empty( $sEdition ) ) {
            $this->_sEdition = $sEdition;
        }
    }

    public function getEdition()
    {
        return $this->_sEdition;
    }

    public function setRevision( $sRevision )
    {
        if ( !empty( $sRevision ) ) {
            $this->_sRevision = $sRevision;
        }
    }

    public function getRevision()
    {
        return $this->_sRevision;
    }

    public function setWebServiceUrl( $sUrl )
    {
        if ( !empty( $sUrl ) ) {
            $this->_sWebServiceUrl = $sUrl;
        }
    }

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

    public function hasError()
    {
        return $this->_blError;
    }

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

    public function init()
    {
        $this->_oCurlHandler = oxNew( "oxCurl" );

        if ( !$this->checkSystemRequirements() ) {
            $this->_blError = true;
            $this->_sErrorMessage .= "Error: requirements are not met.";
            return false;
        }

        return true;
    }



    public function checkSystemRequirements()
    {
        return $this->_isWebServiceOnline() && $this->_isShopVersionIsKnown();
    }

    protected function _isWebServiceOnline()
    {
        $oXML = null;
        $aParams = array(
            'job' => 'ping',
        );

        $this->_oCurlHandler->setUrl( $this->_sWebServiceUrl );
        $this->_oCurlHandler->setMethod("GET");
        $this->_oCurlHandler->setOption("CURLOPT_CONNECTTIMEOUT", 30);
        $this->_oCurlHandler->setParameters(  $aParams );
        $sXML = $this->_oCurlHandler->execute();

        if (empty( $sXML ) ) {
            $this->_blError = true;
            $this->_sErrorMessage = oxRegistry::getLang()->translateString( 'OXDIAG_ERRORMESSAGEWEBSERVICEISNOTREACHABLE' );
        }

        try {
            $oXML = new SimpleXMLElement( $sXML );
        } catch (Exception $ex) {
            $this->_blError = true;
            $this->_sErrorMessage .= oxRegistry::getLang()->translateString( 'OXDIAG_ERRORMESSAGEWEBSERVICERETURNEDNOXML' );
        }

        if (!is_object( $oXML ) ) {
            $this->_blError = true;
            $this->_sErrorMessage .= oxRegistry::getLang()->translateString( 'OXDIAG_ERRORMESSAGEVERSIONDOESNOTEXIST' );
        }

        return !$this->_blError;
    }


    protected function _isShopVersionIsKnown()
    {
        $aParams = array(
            'job' => 'existsversion',
            'ver' => $this->getVersion(),
            'rev' => $this->getRevision(),
            'edi' => $this->getEdition(),
        );

        $sURL = $this->_sWebServiceUrl . "?" . http_build_query( $aParams );

        if ( $sXML = @file_get_contents( $sURL ) ) {
            $oXML = new SimpleXMLElement( $sXML );
            if ( is_object( $oXML ) ) {
                if ( $oXML->exists == 1) {
                    return true;
                }
            }
        }

        $this->_blError = true;
        $sError = sprintf( oxRegistry::getLang()->translateString( 'OXDIAG_ERRORMESSAGEVERSIONDOESNOTEXIST' ),
            $this->getEdition(), $this->getVersion(), $this->getRevision() );

        $this->_sErrorMessage .= $sError;

        return false;
    }

    public function checkFile( $sFile )
    {
        $aResult = array();

        if ($this->_oCurlHandler == null) {
            return $aResult;
        }

        if ( !file_exists( $this->_sBaseDirectory . $sFile ) ) {
            return $aResult;
        }

        $sMD5 = md5_file ( $this->_sBaseDirectory . $sFile );

        usleep( 10 );
        $oXML = $this->_getFileVersion( $sMD5, $sFile );
        $sColor = "blue";
        $blOk = true;
        $sMessage = oxRegistry::getLang()->translateString( 'OXDIAG_ERRORVERSIONCOMPARE' );

        if (is_object( $oXML ) ) {

            if ( $oXML->res == 'OK' ) {
                // If recognized, still can be source or snapshot
                $aMatch = array();

                if (preg_match ('/(SOURCE|SNAPSHOT)/', $oXML->pkg, $aMatch ) ) {
                    $blOk = false;
                    $sMessage = 'SOURCE|SNAPSHOT';
                    $sColor = 'red';
                } else {
                    $sMessage = oxRegistry::getLang()->translateString( 'OXDIAG_OK' );
                    $sColor = "green";
                }
            } elseif ( $oXML->res == 'VERSIONMISMATCH' ) {
                $sMessage = oxRegistry::getLang()->translateString( 'OXDIAG_VERSION_MISMATCH' );
                $sColor = 'red';
                $blOk = false;
            } elseif ( $oXML->res == 'MODIFIED' ) {
                $sMessage = oxRegistry::getLang()->translateString( 'OXDIAG_MODIFIED' );
                $sColor = 'red';
                $blOk = false;
            } elseif ( $oXML->res == 'OBSOLETE' ) {
                $sMessage = oxRegistry::getLang()->translateString( 'OXDIAG_OBSOLETE' );
                $sColor = 'red';
                $blOk = false;
            } elseif ( $oXML->res == 'UNKNOWN' ) {
                $sMessage = oxRegistry::getLang()->translateString( 'OXDIAG_UNKNOWN' );
                $sColor = "green";
            }
        }

        if ( $sMessage ) {
            $aResult = array(
                "result" => strval( $oXML->res),
                "ok" => $blOk,
                "file" => $sFile,
                "color" => $sColor,
                "message" => $sMessage
            );
        }

        return $aResult;
    }

    protected function _getFileVersion( $sMD5, $sFile)
    {
        $aParams = array(
            'job' => 'md5check',
            'ver' => $this->getVersion(),
            'rev' => $this->getRevision(),
            'edi' => $this->getEdition(),
            'fil' => $sFile,
            'md5' => $sMD5,
        );

        $this->_oCurlHandler->setUrl( $this->_sWebServiceUrl );
        $this->_oCurlHandler->setMethod("GET");
        $this->_oCurlHandler->setOption("CURLOPT_CONNECTTIMEOUT", 30);
        $this->_oCurlHandler->setParameters( $aParams );
        $sXML = $this->_oCurlHandler->execute();
        $oXML = null;
        try {
            $oXML = new SimpleXMLElement( $sXML );
        } catch (Exception $ex) {
            $oXML = null;
        }
        return $oXML;
    }

}