oxmoduleinstaller.php

Go to the documentation of this file.

<?php

class oxModuleInstaller extends oxSuperCfg
{

    protected $_oModuleCache;

    public function __construct(oxModuleCache $oxModuleCache = null)
    {
        $this->setModuleCache($oxModuleCache);
    }

    public function setModuleCache($oModuleCache)
    {
        $this->_oModuleCache = $oModuleCache;
    }

    public function getModuleCache()
    {
        return $this->_oModuleCache;
    }

    public function activate(oxModule $oModule)
    {
        $blResult = false;

        $sModuleId = $oModule->getId();

        if ($sModuleId) {
            $this->_addExtensions($oModule);
            $this->_removeFromDisabledList($sModuleId);

            $this->_addTemplateBlocks($oModule->getInfo("blocks"), $sModuleId);
            $this->_addModuleFiles($oModule->getInfo("files"), $sModuleId);
            $this->_addTemplateFiles($oModule->getInfo("templates"), $sModuleId);
            $this->_addModuleSettings($oModule->getInfo("settings"), $sModuleId);
            $this->_addModuleVersion($oModule->getInfo("version"), $sModuleId);
            $this->_addModuleEvents($oModule->getInfo("events"), $sModuleId);

            //resets cache
            if ($this->getModuleCache()) {
                $this->getModuleCache()->resetCache();

            }

            $this->_callEvent('onActivate', $oModule->getId());

            $blResult = true;
        }

        return $blResult;
    }

    public function deactivate(oxModule $oModule)
    {
        $blResult = false;

        $sModuleId = $oModule->getId();

        if ($sModuleId) {
            $sModuleId = $oModule->getId();
            $this->_callEvent('onDeactivate', $sModuleId);

            $this->_addToDisabledList($sModuleId);

            //removing recoverable options
            $this->_deleteBlock($sModuleId);
            $this->_deleteTemplateFiles($sModuleId);
            $this->_deleteModuleFiles($sModuleId);
            $this->_deleteModuleEvents($sModuleId);
            $this->_deleteModuleVersions($sModuleId);

            //resets cache
            if ($this->getModuleCache()) {
                $this->getModuleCache()->resetCache();
            }

            $blResult = true;
        }

        return $blResult;
    }

    public function getModulesWithExtendedClass()
    {
        return $this->getConfig()->getModulesWithExtendedClass();
    }

    public function buildModuleChains($aModuleArray)
    {
        $aModules = array();
        if (is_array($aModuleArray)) {
            foreach ($aModuleArray as $sClass => $aModuleChain) {
                $aModules[$sClass] = implode('&', $aModuleChain);
            }
        }

        return $aModules;
    }

    public function diffModuleArrays($aAllModuleArray, $aRemModuleArray)
    {
        if (is_array($aAllModuleArray) && is_array($aRemModuleArray)) {
            foreach ($aAllModuleArray as $sClass => $aModuleChain) {
                if (!is_array($aModuleChain)) {
                    $aModuleChain = array($aModuleChain);
                }
                if (isset($aRemModuleArray[$sClass])) {
                    if (!is_array($aRemModuleArray[$sClass])) {
                        $aRemModuleArray[$sClass] = array($aRemModuleArray[$sClass]);
                    }
                    $aAllModuleArray[$sClass] = array();
                    foreach ($aModuleChain as $sModule) {
                        if (!in_array($sModule, $aRemModuleArray[$sClass])) {
                            $aAllModuleArray[$sClass][] = $sModule;
                        }
                    }
                    if (!count($aAllModuleArray[$sClass])) {
                        unset ($aAllModuleArray[$sClass]);
                    }
                } else {
                    $aAllModuleArray[$sClass] = $aModuleChain;
                }
            }

        }

        return $aAllModuleArray;
    }

    protected function _addToDisabledList($sModuleId)
    {
        $aDisabledModules = (array) $this->getConfig()->getConfigParam('aDisabledModules');

        $aModules = array_merge($aDisabledModules, array($sModuleId));
        $aModules = array_unique($aModules);

        $this->_saveToConfig('aDisabledModules', $aModules, 'arr');
    }

    protected function _deleteModule($sModuleId)
    {
        $aExt = $this->getConfig()->getModulesWithExtendedClass();

        $aUpdatedExt = $this->diffModuleArrays($aExt, $sModuleId);
        $aUpdatedExt = $this->buildModuleChains($aUpdatedExt);

        $this->getConfig()->saveShopConfVar('aarr', 'aModules', $aUpdatedExt);
    }

    protected function _deleteBlock($sModuleId)
    {
        $oDb = oxDb::getDb();
        $sShopId = $this->getConfig()->getShopId();
        $oDb->execute("DELETE FROM `oxtplblocks` WHERE `oxmodule` =" . $oDb->quote($sModuleId) . " AND `oxshopid` = " . $oDb->quote($sShopId));
    }

    protected function _deleteTemplateFiles($sModuleId)
    {
        $aTemplates = (array) $this->getConfig()->getConfigParam('aModuleTemplates');
        unset($aTemplates[$sModuleId]);

        $this->_saveToConfig('aModuleTemplates', $aTemplates);
    }

    protected function _deleteModuleFiles($sModuleId)
    {
        $aFiles = (array) $this->getConfig()->getConfigParam('aModuleFiles');
        unset($aFiles[$sModuleId]);

        $this->_saveToConfig('aModuleFiles', $aFiles);
    }

    protected function _deleteModuleEvents($sModuleId)
    {
        $aEvents = (array) $this->getConfig()->getConfigParam('aModuleEvents');
        unset($aEvents[$sModuleId]);

        $this->_saveToConfig('aModuleEvents', $aEvents);
    }

    protected function _deleteModuleVersions($sModuleId)
    {
        $aVersions = (array) $this->getConfig()->getConfigParam('aModuleVersions');
        unset($aVersions[$sModuleId]);

        $this->_saveToConfig('aModuleVersions', $aVersions);
    }

    protected function _addExtensions(oxModule $oModule)
    {
        $aModules = $this->_removeNotUsedExtensions($this->getModulesWithExtendedClass(), $oModule);

        if ($oModule->hasExtendClass()) {
            $aAddModules = $oModule->getExtensions();
            $aModules = $this->_mergeModuleArrays($aModules, $aAddModules);
        }

        $aModules = $this->buildModuleChains($aModules);

        $this->_saveToConfig('aModules', $aModules);
    }

    protected function _mergeModuleArrays($aAllModuleArray, $aAddModuleArray)
    {
        if (is_array($aAllModuleArray) && is_array($aAddModuleArray)) {
            foreach ($aAddModuleArray as $sClass => $aModuleChain) {
                if (!is_array($aModuleChain)) {
                    $aModuleChain = array($aModuleChain);
                }
                if (isset($aAllModuleArray[$sClass])) {
                    foreach ($aModuleChain as $sModule) {
                        if (!in_array($sModule, $aAllModuleArray[$sClass])) {
                            $aAllModuleArray[$sClass][] = $sModule;
                        }
                    }
                } else {
                    $aAllModuleArray[$sClass] = $aModuleChain;
                }
            }
        }

        return $aAllModuleArray;
    }

    protected function _removeFromDisabledList($sModuleId)
    {
        $aDisabledModules = (array) $this->getConfig()->getConfigParam('aDisabledModules');

        if (isset($aDisabledModules) && is_array($aDisabledModules)) {
            $aDisabledModules = array_diff($aDisabledModules, array($sModuleId));
            $this->_saveToConfig('aDisabledModules', $aDisabledModules, 'arr');
        }
    }

    protected function _addTemplateBlocks($aModuleBlocks, $sModuleId)
    {
        $sShopId = $this->getConfig()->getShopId();
        $oDb = oxDb::getDb();

        if (is_array($aModuleBlocks)) {

            foreach ($aModuleBlocks as $aValue) {
                $sOxId = oxUtilsObject::getInstance()->generateUId();

                $sTemplate = $aValue["template"];
                $iPosition = $aValue["position"] ? $aValue["position"] : 1;
                $sBlock = $aValue["block"];
                $sFile = $aValue["file"];

                $sSql = "INSERT INTO `oxtplblocks` (`OXID`, `OXACTIVE`, `OXSHOPID`, `OXTEMPLATE`, `OXBLOCKNAME`, `OXPOS`, `OXFILE`, `OXMODULE`)
                         VALUES ('{$sOxId}', 1, '{$sShopId}', " . $oDb->quote($sTemplate) . ", " . $oDb->quote($sBlock) . ", " . $oDb->quote($iPosition) . ", " . $oDb->quote($sFile) . ", '{$sModuleId}')";

                $oDb->execute($sSql);
            }
        }
    }

    protected function _addModuleFiles($aModuleFiles, $sModuleId)
    {
        $aFiles = (array) $this->getConfig()->getConfigParam('aModuleFiles');

        if (is_array($aModuleFiles)) {
            $aFiles[$sModuleId] = array_change_key_case($aModuleFiles, CASE_LOWER);
        }

        $this->_saveToConfig('aModuleFiles', $aFiles);
    }

    protected function _addTemplateFiles($aModuleTemplates, $sModuleId)
    {
        $aTemplates = (array) $this->getConfig()->getConfigParam('aModuleTemplates');
        if (is_array($aModuleTemplates)) {
            $aTemplates[$sModuleId] = $aModuleTemplates;
        }

        $this->_saveToConfig('aModuleTemplates', $aTemplates);
    }

    protected function _addModuleSettings($aModuleSettings, $sModuleId)
    {
        $this->_removeNotUsedSettings($aModuleSettings, $sModuleId);
        $oConfig = $this->getConfig();
        $sShopId = $oConfig->getShopId();
        $oDb = oxDb::getDb();

        if (is_array($aModuleSettings)) {

            foreach ($aModuleSettings as $aValue) {
                $sOxId = oxUtilsObject::getInstance()->generateUId();

                $sModule = 'module:' . $sModuleId;
                $sName = $aValue["name"];
                $sType = $aValue["type"];
                $sValue = is_null($oConfig->getConfigParam($sName)) ? $aValue["value"] : $oConfig->getConfigParam($sName);
                $sGroup = $aValue["group"];

                $sConstraints = "";
                if ($aValue["constraints"]) {
                    $sConstraints = $aValue["constraints"];
                } elseif ($aValue["constrains"]) {
                    $sConstraints = $aValue["constrains"];
                }

                $iPosition = $aValue["position"] ? $aValue["position"] : 1;

                $oConfig->setConfigParam($sName, $sValue);
                $oConfig->saveShopConfVar($sType, $sName, $sValue, $sShopId, $sModule);

                $sDeleteSql = "DELETE FROM `oxconfigdisplay` WHERE OXCFGMODULE=" . $oDb->quote($sModule) . " AND OXCFGVARNAME=" . $oDb->quote($sName);
                $sInsertSql = "INSERT INTO `oxconfigdisplay` (`OXID`, `OXCFGMODULE`, `OXCFGVARNAME`, `OXGROUPING`, `OXVARCONSTRAINT`, `OXPOS`) " .
                              "VALUES ('{$sOxId}', " . $oDb->quote($sModule) . ", " . $oDb->quote($sName) . ", " . $oDb->quote($sGroup) . ", " . $oDb->quote($sConstraints) . ", " . $oDb->quote($iPosition) . ")";

                $oDb->execute($sDeleteSql);
                $oDb->execute($sInsertSql);
            }
        }
    }

    protected function _addModuleEvents($aModuleEvents, $sModuleId)
    {
        $aEvents = (array) $this->getConfig()->getConfigParam('aModuleEvents');
        if (is_array($aEvents)) {
            $aEvents[$sModuleId] = $aModuleEvents;
        }

        $this->_saveToConfig('aModuleEvents', $aEvents);
    }

    protected function _addModuleVersion($sModuleVersion, $sModuleId)
    {
        $aVersions = (array) $this->getConfig()->getConfigParam('aModuleVersions');
        if (is_array($aVersions)) {
            $aVersions[$sModuleId] = $sModuleVersion;
        }

        $this->_saveToConfig('aModuleVersions', $aVersions);
    }

    protected function _callEvent($sEvent, $sModuleId)
    {
        $aModuleEvents = (array) $this->getConfig()->getConfigParam('aModuleEvents');

        if (isset($aModuleEvents[$sModuleId], $aModuleEvents[$sModuleId][$sEvent])) {
            $mEvent = $aModuleEvents[$sModuleId][$sEvent];

            if (is_callable($mEvent)) {
                call_user_func($mEvent);
            }
        }
    }


    protected function _removeNotUsedExtensions($aInstalledExtensions, oxModule $oModule)
    {
        $aModuleExtensions = $oModule->getExtensions();

        $aInstalledModuleExtensions = $this->_filterModuleArray($aInstalledExtensions, $oModule->getId());

        if (count($aInstalledModuleExtensions)) {
            $aGarbage = $this->_getModuleExtensionsGarbage($aModuleExtensions, $aInstalledModuleExtensions);

            if (count($aGarbage)) {
                $aInstalledExtensions = $this->_removeGarbage($aInstalledExtensions, $aGarbage);
            }
        }

        return $aInstalledExtensions;
    }

    protected function _getModuleExtensionsGarbage($aModuleMetaDataExtensions, $aModuleInstalledExtensions)
    {
        $aGarbage = $aModuleInstalledExtensions;

        foreach ($aModuleMetaDataExtensions as $sClassName => $sClassPath) {
            if (isset($aGarbage[$sClassName])) {
                unset($aGarbage[$sClassName][array_search($sClassPath, $aGarbage[$sClassName])]);
                if (count($aGarbage[$sClassName]) == 0) {
                    unset($aGarbage[$sClassName]);
                }
            }
        }

        return $aGarbage;
    }

    protected function _removeGarbage($aInstalledExtensions, $aGarbage)
    {
        foreach ($aGarbage as $sClassName => $aClassPaths) {
            foreach ($aClassPaths as $sClassPath) {
                if (isset($aInstalledExtensions[$sClassName])) {
                    unset($aInstalledExtensions[$sClassName][array_search($sClassPath, $aInstalledExtensions[$sClassName])]);
                    if (count($aInstalledExtensions[$sClassName]) == 0) {
                        unset($aInstalledExtensions[$sClassName]);
                    }
                }
            }
        }

        return $aInstalledExtensions;
    }

    protected function _removeNotUsedSettings($aModuleSettings, $sModuleId)
    {
        $aModuleConfigs = $this->_getModuleConfigs($sModuleId);
        $aModuleSettings = $this->_parseModuleSettings($aModuleSettings);

        $aConfigsToRemove = array_diff($aModuleConfigs, $aModuleSettings);
        if (!empty($aConfigsToRemove)) {
            $this->_removeModuleConfigs($sModuleId, $aConfigsToRemove);
        }
    }

    protected function _getModuleConfigs($sModuleId)
    {
        $oDb = oxDb::getDb();
        $sQuotedShopId = $oDb->quote($this->getConfig()->getShopId());
        $sQuotedModuleId = $oDb->quote('module:' . $sModuleId);

        $sModuleConfigsQuery = "SELECT oxvarname FROM oxconfig WHERE oxmodule = $sQuotedModuleId AND oxshopid = $sQuotedShopId";

        return $oDb->getCol($sModuleConfigsQuery);
    }

    protected function _parseModuleSettings($aModuleSettings)
    {
        $aSettings = array();

        if (is_array($aModuleSettings)) {
            foreach ($aModuleSettings as $aSetting) {
                $aSettings[] = $aSetting['name'];
            }
        }

        return $aSettings;
    }

    protected function _removeModuleConfigs($sModuleId, $aConfigsToRemove)
    {
        $oDb = oxDb::getDb();
        $sQuotedShopId = $oDb->quote($this->getConfig()->getShopId());
        $sQuotedModuleId = $oDb->quote('module:' . $sModuleId);

        $aQuotedConfigsToRemove = array_map(array($oDb, 'quote'), $aConfigsToRemove);
        $sDeleteSql = "DELETE
                       FROM `oxconfig`
                       WHERE oxmodule = $sQuotedModuleId AND
                             oxshopid = $sQuotedShopId AND
                             oxvarname IN (" . implode(", ", $aQuotedConfigsToRemove) . ")";

        $oDb->execute($sDeleteSql);
    }

    protected function _filterModuleArray($aModules, $sModuleId)
    {
        $aFilteredModules = array();
        foreach ($aModules as $sClass => $aExtend) {
            foreach ($aExtend as $sExtendPath) {
                if (strpos($sExtendPath, $sModuleId . "/") === 0) {
                    $aFilteredModules[$sClass][] = $sExtendPath;
                }
            }
        }

        return $aFilteredModules;
    }

    protected function _saveToConfig($sVariableName, $sVariableValue, $sVariableType = 'aarr')
    {
        $oConfig = $this->getConfig();
        $oConfig->setConfigParam($sVariableName, $sVariableValue);
        $oConfig->saveShopConfVar($sVariableType, $sVariableName, $sVariableValue);
    }
}