oxmodulelist.php

Go to the documentation of this file.

<?php

class oxModuleList extends oxSuperCfg
{
    protected $_aModules = array();

    protected $_aSkipFiles = array( 'functions.php', 'vendormetadata.php' );


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

    public function getActiveModuleInfo()
    {
        $aModulePaths   = $this->getModulePaths();

        // Extract module paths from extended classes
        if ( !is_array($aModulePaths) || count($aModulePaths) < 1 ) {
            $aModulePaths = $this->extractModulePaths();
        }

        $aDisabledModules = $this->getDisabledModules();
        if ( is_array($aDisabledModules) && count($aDisabledModules) > 0  && count($aModulePaths) > 0 ) {
            $aModulePaths = array_diff_key($aModulePaths, array_flip($aDisabledModules));
        }
        return $aModulePaths;
    }

    public function getDisabledModuleInfo()
    {
        $aDisabledModules = $this->getDisabledModules();
        $aModulePaths     = array();

        if ( is_array($aDisabledModules) && count($aDisabledModules) > 0 ) {
            $aModulePaths   = $this->getModulePaths();

            // Extract module paths from extended classes
            if ( !is_array($aModulePaths) || count($aModulePaths) < 1 ) {
                $aModulePaths = $this->extractModulePaths();
            }

            if ( is_array($aModulePaths) || count($aModulePaths) > 0 ) {
                $aModulePaths = array_intersect_key($aModulePaths, array_flip($aDisabledModules));
            }
        }

        return $aModulePaths;
    }

    public function getModuleVersions()
    {
        return $this->getConfig()->getConfigParam('aModuleVersions');
    }

    public function getLegacyModules()
    {
        return $this->getConfig()->getConfigParam('aLegacyModules');
    }

    public function getDisabledModules()
    {
        return $this->getConfig()->getConfigParam('aDisabledModules');
    }

    public function getModulePaths()
    {
        return $this->getConfig()->getConfigParam('aModulePaths');
    }

    public function getModuleEvents()
    {
        return (array) $this->getConfig()->getConfigParam('aModuleEvents');
    }

    public function extractModulePaths()
    {
        $aModules     = $this->getAllModules();
        $aModulePaths = array();

        if (is_array($aModules) && count($aModules) > 0) {
            foreach ($aModules as $aModuleClasses) {
                foreach ($aModuleClasses as $sModule) {
                    $sModuleId = substr($sModule, 0, strpos($sModule, "/"));
                    $aModulePaths[$sModuleId] = $sModuleId;
                }
            }
        }
        return $aModulePaths;
    }

    public function getModuleFiles()
    {
        return $this->getConfig()->getConfigParam('aModuleFiles');
    }

    public function getModuleTemplates()
    {
        return $this->getConfig()->getConfigParam('aModuleTemplates');
    }

    public function getDisabledModuleClasses()
    {
        $aDisabledModules = $this->getDisabledModules();
        $aModules         = $this->getAllModules();
        $aModulePaths     = $this->getModulePaths();

        $aDisabledModuleClasses = array();
        if (isset($aDisabledModules) && is_array($aDisabledModules)) {
            //get all disabled module paths
            foreach ($aDisabledModules as $sId) {
                $sPath = $aModulePaths[$sId];
                if (!isset($sPath)) {
                    $sPath = $sId;
                }
                foreach ( $aModules as $sClass => $aModuleClasses ) {
                    foreach ( $aModuleClasses as $sModuleClass ) {
                        if (strpos($sModuleClass, $sPath."/") === 0 ) {
                            $aDisabledModuleClasses[] = $sModuleClass;
                        }
                    }
                }
            }
        }

        return $aDisabledModuleClasses;
    }

    public function cleanup()
    {
        $aDeletedExt = $this->getDeletedExtensions();

        //collecting deleted extension IDs
        $aDeletedExtIds = $this->getDeletedExtensionIds($aDeletedExt);

        // removing from aModules config array
        $this->_removeFromModulesArray( $aDeletedExt );

        // removing from aDisabledModules array
        $this->_removeFromDisabledModulesArray( $aDeletedExtIds );

        // removing from aLegacyModules array
        $this->_removeFromLegacyModulesArray( $aDeletedExtIds );

        // removing from aModulePaths array
        $this->_removeFromModulesPathsArray( $aDeletedExtIds );

        // removing from aModuleEvents array
        $this->_removeFromModulesEventsArray( $aDeletedExtIds );

        // removing from aModuleVersions array
        $this->_removeFromModulesVersionsArray( $aDeletedExtIds );

        // removing from aModuleFiles array
        $this->_removeFromModulesFilesArray( $aDeletedExtIds );

        // removing from aModuleTemplates array
        $this->_removeFromModulesTemplatesArray( $aDeletedExtIds );

        //removing from config tables and templates blocks table
        $this->_removeFromDatabase( $aDeletedExtIds );
    }

    public function getDeletedExtensionIds($aDeletedExt)
    {
        $aDeletedExtIds = array();
        if ( !empty($aDeletedExt) ) {
            $oModule = oxNew('oxModule');
            foreach ( $aDeletedExt as $sOxClass => $aDeletedModules ) {
                foreach ( $aDeletedModules as $sModulePath ) {
                    $aDeletedExtIds[] = $oModule->getIdByPath($sModulePath);
                }
            }
        }

        if ( !empty( $aDeletedExtIds ) ) {
            $aDeletedExtIds = array_unique( $aDeletedExtIds );
        }

        return $aDeletedExtIds;
    }

    public function getDeletedExtensions()
    {
        $aModules = $this->getAllModules();
        $aDeletedExt = array();

        foreach ( $aModules as $sOxClass => $aModulesList ) {
            foreach ( $aModulesList as $sModulePath ) {
                $sExtPath = $this->getConfig()->getModulesDir() . $sModulePath.'.php';
                if ( !file_exists( $sExtPath ) ) {
                    $aDeletedExt[$sOxClass][] = $sModulePath;
                }
            }
        }

        return $aDeletedExt;
    }

    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;
    }

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

    protected function _removeFromModulesArray( $aDeletedExt )
    {
        $aExt = $this->getAllModules();
        $aUpdatedExt = $this->diffModuleArrays( $aExt, $aDeletedExt );
        $aUpdatedExt = $this->buildModuleChains( $aUpdatedExt );

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

    protected function _removeFromDisabledModulesArray( $aDeletedExtIds )
    {
        $oConfig = $this->getConfig();
        $aDisabledExtensionIds = $this->getDisabledModules();
        $aDisabledExtensionIds = array_diff($aDisabledExtensionIds, $aDeletedExtIds);
        $oConfig->saveShopConfVar( 'arr', 'aDisabledModules', $aDisabledExtensionIds );
    }

    protected function _removeFromLegacyModulesArray( $aDeletedExtIds )
    {
        $aLegacyExt = $this->getLegacyModules();

        foreach ( $aDeletedExtIds as $sDeletedExtId ) {
            if ( isset($aLegacyExt[$sDeletedExtId]) ) {
                unset( $aLegacyExt[$sDeletedExtId] );
            }
        }

        $this->getConfig()->saveShopConfVar( 'aarr', 'aLegacyModules', $aLegacyExt );
    }

    protected function _removeFromModulesPathsArray( $aDeletedModule )
    {
        $aModulePaths = $this->getModulePaths();

        foreach ( $aDeletedModule as $sDeletedModuleId ) {
            if ( isset($aModulePaths[$sDeletedModuleId]) ) {
                unset( $aModulePaths[$sDeletedModuleId] );
            }
        }

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

    protected function _removeFromModulesVersionsArray( $aDeletedModule )
    {
        $aModuleVersions = $this->getModuleVersions();

        foreach ( $aDeletedModule as $sDeletedModuleId ) {
            if ( isset($aModuleVersions[$sDeletedModuleId]) ) {
                unset( $aModuleVersions[$sDeletedModuleId] );
            }
        }

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

    protected function _removeFromModulesEventsArray( $aDeletedModule )
    {
        $aModuleEvents = $this->getModuleEvents();

        foreach ( $aDeletedModule as $sDeletedModuleId ) {
            if ( isset($aModuleEvents[$sDeletedModuleId]) ) {
                unset( $aModuleEvents[$sDeletedModuleId] );
            }
        }

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

    protected function _removeFromModulesFilesArray( $aDeletedModule )
    {
        $aModuleFiles = $this->getModuleFiles();

        foreach ( $aDeletedModule as $sDeletedModuleId ) {
            if ( isset($aModuleFiles[$sDeletedModuleId]) ) {
                unset( $aModuleFiles[$sDeletedModuleId] );
            }
        }

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

    protected function _removeFromModulesTemplatesArray( $aDeletedModule )
    {
        $aModuleTemplates = $this->getModuleTemplates();

        foreach ( $aDeletedModule as $sDeletedModuleId ) {
            if ( isset($aModuleTemplates[$sDeletedModuleId]) ) {
                unset( $aModuleTemplates[$sDeletedModuleId] );
            }
        }

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

    protected function _removeFromDatabase( $aDeletedExtIds )
    {
        if ( !is_array($aDeletedExtIds) || !count($aDeletedExtIds) ) {
            return;
        }

        $oDb = oxDb::getDb();

        $aConfigIds = $sDelExtIds = array();
        foreach ( $aDeletedExtIds as $sDeletedExtId ) {
            $aConfigIds[] = $oDb->quote('module:'.$sDeletedExtId);
            $sDelExtIds[] = $oDb->quote($sDeletedExtId);
        }

        $sConfigIds = implode( ', ', $aConfigIds );
        $sDelExtIds = implode( ', ', $sDelExtIds );

        $aSql[] = "DELETE FROM oxconfig where oxmodule IN ($sConfigIds)";
        $aSql[] = "DELETE FROM oxconfigdisplay where oxcfgmodule IN ($sConfigIds)";
        $aSql[] = "DELETE FROM oxtplblocks where oxmodule IN ($sDelExtIds)";

        foreach ( $aSql as $sQuery ) {
            $oDb->execute( $sQuery );
        }
    }

    public function getModulesFromDir( $sModulesDir, $sVendorDir = null )
    {
        $sModulesDir  = oxRegistry::get('oxUtilsFile')->normalizeDir( $sModulesDir );

        foreach ( glob( $sModulesDir.'*' ) as $sModuleDirPath ) {

            $sModuleDirPath .= ( is_dir( $sModuleDirPath ) ) ?'/':'';
            $sModuleDirName  = basename( $sModuleDirPath );

            // skipping some file
            if ( in_array( $sModuleDirName, $this->_aSkipFiles ) || (!is_dir( $sModuleDirPath ) && substr($sModuleDirName, -4) != ".php")) {
                continue;
            }

            if ( $this->_isVendorDir( $sModuleDirPath ) ) {
                // scanning modules vendor directory
                $this->getModulesFromDir( $sModuleDirPath, basename( $sModuleDirPath ) );
            } else {
                // loading module info
                $oModule = oxNew( 'oxModule' );
                $sModuleDirName = ( !empty($sVendorDir) ) ? $sVendorDir.'/'.$sModuleDirName : $sModuleDirName;
                $oModule->loadByDir( $sModuleDirName );
                $sModuleId = $oModule->getId();
                $this->_aModules[$sModuleId] = $oModule;

                $aModulePaths = $this->getModulePaths();

                if ( !is_array($aModulePaths) || !array_key_exists( $sModuleId, $aModulePaths ) ) {
                    // saving module path info
                    $this->_saveModulePath( $sModuleId, $sModuleDirName );

                    //checking if this is new module and if it extends any eshop class
                    if ( !$this->_extendsClasses( $sModuleDirName ) ) {
                        // if not - marking it as disabled by default
                        $oModule->deactivate();
                    }
                }
            }
        }
        // sorting by name
        if ( $this->_aModules !== null ) {
            uasort($this->_aModules, array($this, '_sortModules'));
        }

        return $this->_aModules;
    }

    protected function _sortModules( $oModule1, $oModule2 )
    {
        return strcasecmp($oModule1->getTitle(), $oModule2->getTitle());
    }

    protected function _isVendorDir( $sModuleDir )
    {
        if ( is_dir( $sModuleDir ) && file_exists( $sModuleDir . 'vendormetadata.php' ) ) {
            return true;
        }

        return false;
    }

    protected function _extendsClasses ( $sModuleDir )
    {
        $aModules = $this->getConfig()->getConfigParam( 'aModules' );
        if (is_array($aModules)) {
            $sModules = implode( '&', $aModules );

            if ( preg_match("@(^|&+)".$sModuleDir."\b@", $sModules ) ) {
                return true;
            }
        }

        return false;
    }

    protected function _saveModulePath( $sModuleId, $sModulePath )
    {
        $aModulePaths = $this->getModulePaths();

        $aModulePaths[$sModuleId] = $sModulePath;
        $this->getConfig()->saveShopConfVar( 'aarr', 'aModulePaths', $aModulePaths );
    }

}