oxsysrequirements.php

Go to the documentation of this file.

<?php

class oxSysRequirements
{
    protected $_aRequiredModules = null;

    protected $_blSysReqStatus = null;

    protected $_aException = array( 'OXDELIVERY'   => 'OXDELTYPE',
                                    'OXSELECTLIST' => 'OXIDENT');

    protected $_aColumns = array( 'OXID',
                                  'OXOBJECTID',
                                  'OXARTICLENID',
                                  'OXACTIONID',
                                  'OXARTID',
                                  'OXUSERID',
                                  'OXADDRESSUSERID',
                                  'OXCOUNTRYID',
                                  'OXSESSID',
                                  'OXITMID',
                                  'OXPARENTID',
                                  'OXAMITEMID',
                                  'OXAMTASKID',
                                  'OXVENDORID',
                                  'OXMANUFACTURERID',
                                  'OXROOTID',
                                  'OXATTRID',
                                  'OXCATID',
                                  'OXDELID',
                                  'OXDELSETID',
                                  'OXITMARTID',
                                  'OXFIELDID',
                                  'OXROLEID',
                                  'OXCNID',
                                  'OXANID',
                                  'OXARTICLENID',
                                  'OXCATNID',
                                  'OXDELIVERYID',
                                  'OXDISCOUNTID',
                                  'OXGROUPSID',
                                  'OXLISTID',
                                  'OXPAYMENTID',
                                  'OXDELTYPE',
                                  'OXROLEID',
                                  'OXSELNID',
                                  'OXBILLCOUNTRYID',
                                  'OXDELCOUNTRYID',
                                  'OXPAYMENTID',
                                  'OXCARDID',
                                  'OXPAYID',
                                  'OXIDENT',
                                  'OXDEFCAT',
                                  'OXBASKETID',
                                  'OXPAYMENTSID',
                                  'OXORDERID',
                                  'OXVOUCHERSERIEID');

    protected $_sReqInfoUrl = "http://www.oxidforge.org/wiki/Installation";

    protected $_aInfoMap    = array( "php_version"        => "PHP_version_at_least_5.2.0",
                                     "lib_xml2"           => "LIB_XML2",
                                     "php_xml"            => "DOM",
                                     "open_ssl"           => "OpenSSL",
                                     "soap"               => "SOAP",
                                     "j_son"              => "JSON",
                                     "i_conv"             => "ICONV",
                                     "tokenizer"          => "Tokenizer",
                                     "mysql_connect"      => "MySQL_client_connector_for_MySQL_5",
                                     "gd_info"            => "GDlib_v2_.5Bv1.5D_incl._JPEG_support",
                                     "mb_string"          => "mbstring",
                                     "bc_math"            => "BCMath",
                                     "allow_url_fopen"    => "allow_url_fopen_or_fsockopen_to_port_80",
                                     "php4_compat"        => "Zend_compatibility_mode_must_be_off",
                                     "request_uri"        => "REQUEST_URI_set",
                                     "ini_set"            => "ini_set_allowed",
                                     "register_globals"   => "register_globals_must_be_off",
                                     "memory_limit"       => "PHP_Memory_limit_.28min._14MB.2C_30MB_recommended.29",
                                     "unicode_support"    => "UTF-8_support",
                                     "mod_rewrite"        => "apache_mod_rewrite_module",
                                     "server_permissions" => "Files_.26_Folder_Permission_Setup",
                                     "zend_optimizer"     => "Zend_Optimizer",
                                     "bug53632"           => "Not_recommended_PHP_versions",
                                     // "zend_platform_or_server"
                                      );

    public function __construct()
    {
    }

    public function __call( $sMethod, $aArgs )
    {
        if ( defined( 'OXID_PHP_UNIT' ) ) {
            if ( substr( $sMethod, 0, 4) == "UNIT" ) {
                $sMethod = str_replace( "UNIT", "_", $sMethod );
            }
            if ( method_exists( $this, $sMethod)) {
                return call_user_func_array( array( & $this, $sMethod ), $aArgs );
            }
        }

        throw new oxSystemComponentException( "Function '$sMethod' does not exist or is not accessible! (" . get_class($this) . ")".PHP_EOL);
    }

    public function getConfig()
    {
        return oxConfig::getInstance();
    }

    public function getRequiredModules()
    {
        if ( $this->_aRequiredModules == null ) {
            $aRequiredPHPExtensions = array(
                                          'php_version',
                                          'lib_xml2',
                                          'php_xml',
                                          'j_son',
                                          'i_conv',
                                          'tokenizer',
                                          'mysql_connect',
                                          'gd_info',
                                          'mb_string',
                                          'curl',
                                          'bc_math',
                                          'open_ssl',
                                          'soap',
                                      );

            $aRequiredPHPConfigs = array(
                                       'allow_url_fopen',
                                       'php4_compat',
                                       'request_uri',
                                       'ini_set',
                                       'register_globals',
                                       'memory_limit',
                                       'unicode_support'
                                   );

            $aRequiredServerConfigs = array(
                                          'mod_rewrite',
                                          'server_permissions',
                                          'bug53632'
                                      );


            if ( isAdmin() ) {
                $aRequiredServerConfigs[] = 'mysql_version';
            }
            $this->_aRequiredModules = array_fill_keys( $aRequiredPHPExtensions, 'php_extennsions' ) +
                                       array_fill_keys( $aRequiredPHPConfigs, 'php_config' ) +
                                       array_fill_keys( $aRequiredServerConfigs, 'server_config' );
        }
        return $this->_aRequiredModules;
    }

    public function checkBug53632()
    {
        $iState = 1;
        if ( version_compare( PHP_VERSION, "5.3", ">=" ) ) {
            if ( version_compare( PHP_VERSION, "5.3.5", ">=" ) && version_compare( PHP_VERSION, "5.3.7", "!=" ) ) {
                $iState = 2;
            }
        } elseif ( version_compare( PHP_VERSION, '5.2', ">=" ) ) {
            $iState = version_compare( PHP_VERSION, "5.2.17", ">=" ) ? 2 : $iState;
        }
        return $iState;
    }

    public function checkCurl()
    {
        return extension_loaded( 'curl' ) ? 2 : 1;
    }

    public function checkMbString()
    {
        return extension_loaded( 'mbstring' ) ? 2 : 1;
    }

    public function checkServerPermissions( $sPath = null, $iMinPerm = 777 )
    {
        $sVerPrefix = '';

        clearstatcache();
        $sPath = $sPath ? $sPath : getShopBasePath();

        // special config file check
        $sFullPath = $sPath . "config.inc.php";
        if ( !is_readable( $sFullPath ) ||
             ( isAdmin() && is_writable( $sFullPath ) ) ||
             ( !isAdmin() && !is_writable( $sFullPath ) )
           ) {
            return 0;
        }

        $sTmp = "$sPath/tmp$sVerPrefix/";
        if (class_exists('oxConfig')) {
            $sCfgTmp = $this->getConfig()->getConfigParam('sCompileDir');
            if (strpos($sCfgTmp, '<sCompileDir_') === false) {
                $sTmp = $sCfgTmp;
            }
        }

        $aPathsToCheck = array(
                            $sPath."out/pictures{$sVerPrefix}/promo/",
                            $sPath."out/pictures{$sVerPrefix}/media/",
                            $sPath."out/pictures{$sVerPrefix}/master/",
                            $sPath."out/pictures{$sVerPrefix}/generated/",
                            $sPath."log/",
                            $sTmp
                            );
        $iModStat = 2;
        $sPathToCheck = reset( $aPathsToCheck );
        while ( $sPathToCheck ) {
            // missing file/folder?
            if ( !file_exists( $sPathToCheck ) ) {
                $iModStat = 0;
                break;
            }

            if ( is_dir( $sPathToCheck ) ) {
                // adding subfolders
                $aSubF = glob( $sPathToCheck."*", GLOB_ONLYDIR );
                if (is_array($aSubF)) {
                    foreach ( $aSubF as $sNewFolder ) {
                        $aPathsToCheck[] = $sNewFolder . "/";
                    }
                }
            }

            // testing if file permissions >= $iMinPerm
            //if ( ( (int) substr( decoct( fileperms( $sFullPath ) ), 2 ) ) < $iMinPerm ) {
            if ( !is_readable( $sPathToCheck ) || !is_writable( $sPathToCheck ) ) {
                $iModStat = 0;
                break;
            }

            $sPathToCheck = next( $aPathsToCheck );
        }

        return $iModStat;
    }

    protected function _getShopHostInfoFromConfig()
    {
        $sShopURL = $this->getConfig()->getConfigParam( 'sShopURL' );
        if (preg_match('#^(https?://)?([^/:]+)(:([0-9]+))?(/.*)?$#i', $sShopURL, $m)) {
            $sHost = $m[2];
            $iPort = (int)$m[4];
            $blSsl = (strtolower($m[1])=='https://');
            if (!$iPort) {
                $iPort = $blSsl?443:80;
            }
            $sScript = rtrim($m[5], '/').'/';
            return array(
                    'host'=>$sHost,
                    'port'=>$iPort,
                    'dir'=>$sScript,
                    'ssl'=>$blSsl,
            );
        } else {
            return false;
        }
    }

    protected function _getShopSSLHostInfoFromConfig()
    {       
        $sSSLShopURL = $this->getConfig()->getConfigParam( 'sSSLShopURL' );
        if (preg_match('#^(https?://)?([^/:]+)(:([0-9]+))?(/.*)?$#i', $sSSLShopURL, $m)) {
            $sHost = $m[2];
            $iPort = (int)$m[4];
            $blSsl = (strtolower($m[1])=='https://');
            if (!$iPort) {
                $iPort = $blSsl?443:80;
            }
            $sScript = rtrim($m[5], '/').'/';
            return array(
                    'host'=>$sHost,
                    'port'=>$iPort,
                    'dir'=>$sScript,
                    'ssl'=>$blSsl,
            );
        }
        return false;
    }

    protected function _getShopHostInfoFromServerVars()
    {
        // got here from setup dir
        $sScript = $_SERVER['SCRIPT_NAME'];
        $iPort = (int) $_SERVER['SERVER_PORT'];
        $blSsl = (isset($_SERVER['HTTPS']) && ($_SERVER['HTTPS'] == 'on'));
        if (!$iPort) {
            $iPort = $blSsl?443:80;
        }
        $sScript = rtrim(dirname(dirname( $sScript )), '/').'/';
        return array(
                    'host'=>$_SERVER['HTTP_HOST'],
                    'port'=>$iPort,
                    'dir'=>$sScript,
                    'ssl'=>$blSsl,
        );
    }

    protected function _getShopHostInfo()
    {
        if ( isAdmin() ) {
            return $this->_getShopHostInfoFromConfig();
        } else {
            return $this->_getShopHostInfoFromServerVars();
        }
    }

    protected function _getShopSSLHostInfo()
    {
        if ( isAdmin() ) {
            return $this->_getShopSSLHostInfoFromConfig();
        }
        return false;
    }

    public function checkModRewrite()
    {
        $iModStat = null;
        $aHostInfo = $this->_getShopHostInfo();        
        $iModStat = $this->_checkModRewrite( $aHostInfo );        
        
        $aSSLHostInfo = $this->_getShopSSLHostInfo();       
        // Don't need to check if mod status is already failed.
        if ( 0 != $iModStat && $aSSLHostInfo ) {
            $iSSLModStat = $this->_checkModRewrite( $aSSLHostInfo );

            // Send if failed, even if couldn't check another
            if ( 0 == $iSSLModStat ) {
                return 0;
            } elseif ( 1 == $iSSLModStat || 1 == $iModStat ) {
                return 1;
            }
            
            return min( $iModStat, $iSSLModStat );
        }
        
        return $iModStat;
    }

    protected function _checkModRewrite($aHostInfo)
    {
        if ( $rFp = @fsockopen( ($aHostInfo['ssl']?'ssl://':'').$aHostInfo['host'], $aHostInfo['port'], $iErrNo, $sErrStr, 10 ) ) {
            $sReq  = "POST {$aHostInfo['dir']}oxseo.php?mod_rewrite_module_is=off HTTP/1.1\r\n";
            $sReq .= "Host: {$aHostInfo['host']}\r\n";
            $sReq .= "User-Agent: OXID eShop setup\r\n";
            $sReq .= "Content-Type: application/x-www-form-urlencoded\r\n";
            $sReq .= "Content-Length: 0\r\n"; // empty post
            $sReq .= "Connection: close\r\n\r\n";

            $sOut = '';
            fwrite( $rFp, $sReq );
            while ( !feof( $rFp ) ) {
                $sOut .= fgets( $rFp, 100 );
            }
            fclose( $rFp );

            $iModStat = ( strpos( $sOut, 'mod_rewrite_on' ) !== false ) ? 2 : 0;
        } else {
            if ( function_exists( 'apache_get_modules' ) ) {
                // it does not assure that mod_rewrite is enabled on current host, so setting 1
                $iModStat = in_array( 'mod_rewrite', apache_get_modules() ) ? 1 : 0;
            } else {
                $iModStat = -1;
            }
        }
        return $iModStat;       
    }

    public function checkAllowUrlFopen()
    {
        $iModStat = @ini_get('allow_url_fopen');
        $iModStat = ( $iModStat && strcasecmp( '1', $iModStat ) ) ? 2 : 1;
        if ( $iModStat == 1 ) {
            $iErrNo  = 0;
            $sErrStr = '';
            if ( $oRes = @fsockopen( 'www.example.com', 80, $iErrNo, $sErrStr, 10 ) ) {
                $iModStat = 2;
                fclose( $oRes );
            }
        }
        $iModStat = ( !$iModStat ) ? 1 : $iModStat;
        return $iModStat;
    }

    public function checkPhp4Compat()
    {
        $sZendStatus = ( strtolower( (string) @ini_get( 'zend.ze1_compatibility_mode' ) ) );
        return in_array( $sZendStatus, array( 'on', '1' ) ) ? 0 : 2;
    }

    public function checkPhpVersion()
    {
        $iModStat = ( version_compare( PHP_VERSION, '5.1', '>' ) ) ? 1 : 0;
        $iModStat = ( $iModStat == 0 ) ? $iModStat : ( version_compare( PHP_VERSION, '5.2', '>=' ) ? 2 : 1 );
        return $iModStat;
    }

    public function checkRequestUri()
    {
        return ( isset( $_SERVER['REQUEST_URI'] ) || isset( $_SERVER['SCRIPT_URI'] ) ) ? 2 : 0;
    }

    public function checkLibXml2()
    {
        return class_exists( 'DOMDocument' ) ? 2 : 0;
    }

    public function checkPhpXml()
    {
        return class_exists( 'DOMDocument' ) ? 2 : 0;
    }

    public function checkJSon()
    {
        return extension_loaded( 'json' ) ? 2 : 0;
    }

    public function checkIConv()
    {
        return extension_loaded( 'iconv' ) ? 2 : 0;
    }

    public function checkTokenizer()
    {
        return extension_loaded( 'tokenizer' ) ? 2 : 0;
    }

    public function checkBcMath()
    {
        return extension_loaded( 'bcmath' ) ? 2 : 1;
    }

    public function checkOpenSsl()
    {
        return extension_loaded( 'openssl' ) ? 2 : 1;
    }

    public function checkSoap()
    {
        return extension_loaded( 'soap' ) ? 2 : 1;
    }

    public function checkMysqlConnect()
    {
        // MySQL module for MySQL5
        $iModStat = ( extension_loaded( 'mysql' ) || extension_loaded( 'mysqli' ) || extension_loaded( 'pdo_mysql' ) ) ? 2 : 0;

        // client version must be >=5
        if ( $iModStat ) {
            $sClientVersion = mysql_get_client_info();
            if (version_compare( $sClientVersion, '5', '<' )) {
                $iModStat = 1;
                if (version_compare( $sClientVersion, '4', '<' )) {
                    $iModStat = 0;
                }
            } elseif (version_compare($sClientVersion, '5.0.36', '>=') && version_compare($sClientVersion, '5.0.38', '<')) {
                // mantis#0001003: Problems with MySQL version 5.0.37
                $iModStat = 0;
            } elseif (version_compare($sClientVersion, '5.0.40', '>') && version_compare($sClientVersion, '5.0.42', '<')) {
                // mantis#0001877: Exclude MySQL 5.0.41 from system requirements as not fitting
                $iModStat = 0;
            }
            if ( strpos($sClientVersion, 'mysqlnd') !== false ) {
                // PHP 5.3 includes new mysqlnd extension
                $iModStat = 2;
            }
        }
        return $iModStat;
    }

    public function checkMysqlVersion( $sVersion = null )
    {
        if ( $sVersion === null ) {
            $aRez = oxDb::getDb()->getAll( "SHOW VARIABLES LIKE 'version'" );
            foreach ( $aRez as $aRecord ) {
                $sVersion = $aRecord[1];
                break;
            }
        }

        $iModStat = 0;
        if ( version_compare( $sVersion, '5.0.3', '>=' ) && version_compare( $sVersion, '5.0.37', '<>' ) ) {
            $iModStat = 2;
        }

        return $iModStat;
    }

    public function checkGdInfo()
    {
        $iModStat = extension_loaded( 'gd' ) ? 1 : 0;
        $iModStat = function_exists( 'imagecreatetruecolor' ) ? 2 : $iModStat;
        $iModStat = function_exists( 'imagecreatefromjpeg' ) ? $iModStat : 0;
        return $iModStat;
    }

    public function checkIniSet()
    {
        return ( @ini_set('session.name', 'sid' ) !== false ) ? 2 : 0;
    }

    public function checkRegisterGlobals()
    {
        $sGlobStatus = ( strtolower( (string) @ini_get( 'register_globals' ) ) );
        return in_array( $sGlobStatus, array( 'on', '1' ) ) ? 0 : 2;
    }

    public function checkMemoryLimit()
    {
        if ( $sMemLimit = @ini_get('memory_limit') ) {
                // CE - PE at least to 14 MB. We recomend a memory_limit of 30MB.
                $sDefLimit = '14M';
                $sRecLimit = '30M';


            $iMemLimit = $this->_getBytes( $sMemLimit );
            $iModStat = ( $iMemLimit >= $this->_getBytes( $sDefLimit ) ) ? 1 : 0;
            $iModStat = $iModStat ? ( ( $iMemLimit >= $this->_getBytes( $sRecLimit ) ) ? 2 : $iModStat ) : $iModStat;

        } else {
            $iModStat = -1;
        }
        return $iModStat;
    }

    public function checkZendOptimizer()
    {
        return 2;
    }

    public function checkZendPlatformOrServer()
    {
        if (function_exists( 'output_cache_get' )) {
            return 2;
        }
        if (function_exists( 'zend_disk_cache_fetch' )) {
            return 2;
        }
        if (function_exists( 'zend_shm_cache_fetch' )) {
            return 2;
        }
        return 1;
    }

    protected function _getAdditionalCheck()
    {
        $sSelect = '';
        foreach ( $this->_aException as $sTable => $sColumn ) {
            $sSelect .= 'and ( t.TABLE_NAME != "'.$sTable.'" and c.COLUMN_NAME != "'.$sColumn.'" ) ';
        }
        return $sSelect;
    }

    public function checkCollation()
    {
        $myConfig = $this->getConfig();

        $aCollations = array();
        $sCollation = '';

        $sSelect = 'select t.TABLE_NAME, c.COLUMN_NAME, c.COLLATION_NAME from INFORMATION_SCHEMA.tables t ' .
                   'LEFT JOIN INFORMATION_SCHEMA.columns c ON t.TABLE_NAME = c.TABLE_NAME  ' .
                   'where t.TABLE_SCHEMA = "'.$myConfig->getConfigParam( 'dbName' ).'" ' .
                   'and c.TABLE_SCHEMA = "'.$myConfig->getConfigParam( 'dbName' ).'" ' .
                   'and c.COLUMN_NAME in ("'.implode('", "', $this->_aColumns).'") ' . $this->_getAdditionalCheck() .
                   ' ORDER BY (t.TABLE_NAME = "oxarticles") DESC';
        $aRez = oxDb::getDb()->getAll($sSelect);
        foreach ( $aRez as $aRetTable ) {
            if ( !$sCollation ) {
                $sCollation = $aRetTable[2];
            } else {
                if ( $aRetTable[2] && $sCollation != $aRetTable[2]) {
                    $aCollations[$aRetTable[0]][$aRetTable[1]] = $aRetTable[2];
                }
            }
        }

        if ( $this->_blSysReqStatus === null ) {
            $this->_blSysReqStatus = true;
        }
        if ( count($aCollations) > 0 ) {
            $this->_blSysReqStatus = false;
        }
        return $aCollations;
    }

    public function checkDatabaseCluster()
    {
        return 2;
    }

    public function checkUnicodeSupport()
    {
        return (@preg_match('/\pL/u', 'a') == 1) ? 2 : 1;
    }

    public function getSysReqStatus()
    {
        if ( $this->_blSysReqStatus == null ) {
            $this->_blSysReqStatus = true;
            $this->getSystemInfo();
            $this->checkCollation();
        }
        return $this->_blSysReqStatus;
    }

    public function getSystemInfo()
    {
        $aSysInfo = array();
        $aRequiredModules = $this->getRequiredModules();
        $this->_blSysReqStatus = true;
        foreach ( $aRequiredModules as $sModule => $sGroup ) {
            if ( isset($aSysInfo[$sGroup]) && !$aSysInfo[$sGroup] ) {
                $aSysInfo[$sGroup] = array();
            }
            $iModuleState = $this->getModuleInfo( $sModule );
            $aSysInfo[$sGroup][$sModule] = $iModuleState;
            $this->_blSysReqStatus = $this->_blSysReqStatus && ( bool ) abs( $iModuleState );
        }
        return $aSysInfo;
    }

    public function getModuleInfo( $sModule = null )
    {
        if ( $sModule ) {
            $iModStat = null;
            $sCheckFunction = "check".str_replace(" ", "", ucwords(str_replace("_", " ", $sModule)));
            $iModStat = $this->$sCheckFunction();

            return $iModStat;
        }
    }

    public function getReqInfoUrl( $sIdent)
    {
        $sUrl = $this->_sReqInfoUrl;
        $aInfoMap = $this->_aInfoMap;

        // only known will be anchored
        if ( isset( $aInfoMap[$sIdent] ) ) {
            $sUrl .= "#".$aInfoMap[$sIdent];
        }

        return $sUrl;
    }

    protected function _getBytes( $sBytes )
    {
        $sBytes = trim( $sBytes );
        $sLast = strtolower($sBytes[strlen($sBytes)-1]);
        switch( $sLast ) {
            // The 'G' modifier is available since PHP 5.1.0
            case 'g':
                $sBytes *= 1024;
            case 'm':
                $sBytes *= 1024;
            case 'k':
                $sBytes *= 1024;
                break;
        }

        return $sBytes;
    }

    protected function _checkTemplateBlock($sTemplate, $sBlockName)
    {
        $sTplFile = $this->getConfig()->getTemplatePath($sTemplate, false);
        if (!$sTplFile || !file_exists($sTplFile)) {
            return false;
        }

        $sFile = file_get_contents($sTplFile);
        $sBlockNameQuoted = preg_quote($sBlockName, '/');
        return (bool)preg_match('/\[\{\s*block\s+name\s*=\s*([\'"])'.$sBlockNameQuoted.'\1\s*\}\]/is', $sFile);
    }

    public function getMissingTemplateBlocks()
    {
        $oDb = oxDb::getDb( true );
        $aCache = array();
        $oConfig = $this->getConfig();

        $sShpIdParam = $oDb->quote($oConfig->getShopId());
        $sSql = "select * from oxtplblocks where oxactive=1 and oxshopid=$sShpIdParam";
        $rs = $oDb->execute($sSql);
        $aRet = array();
        if ($rs != false && $rs->recordCount() > 0) {
            while (!$rs->EOF) {
                $blStatus = false;
                if (isset($aCache[$rs->fields['OXTEMPLATE']]) && isset($aCache[$rs->fields['OXTEMPLATE']][$rs->fields['OXBLOCKNAME']])) {
                    $blStatus = $aCache[$rs->fields['OXTEMPLATE']][$rs->fields['OXBLOCKNAME']];
                } else {
                    $blStatus = $this->_checkTemplateBlock($rs->fields['OXTEMPLATE'], $rs->fields['OXBLOCKNAME']);
                    $aCache[$rs->fields['OXTEMPLATE']][$rs->fields['OXBLOCKNAME']] = $blStatus;
                }

                if (!$blStatus) {
                    $aRet[] = array(
                                'module'   => $rs->fields['OXMODULE'],
                                'block'    => $rs->fields['OXBLOCKNAME'],
                                'template' => $rs->fields['OXTEMPLATE'],
                            );
                }
                $rs->moveNext();
            }
        }

        return $aRet;
    }
}