ModuleUninstaller.class.php

<?php
 
if (!defined('XOOPS_ROOT_PATH')) {
    exit();
}
 
require_once XOOPS_LEGACY_PATH . '/admin/class/ModuleInstallUtils.class.php';
 
class Legacy_ModuleUninstaller
{
    public $mLog = null;
 
    public $_mForceMode = false;

    public $_mXoopsModule = null;

    public $m_fireNotifyUninstallTemplateBegun;
 
    public function Legacy_ModuleUninstaller()
    {
        self::__construct();
    }
 
    public function __construct()
    {
        $this->mLog =new Legacy_ModuleInstallLog();
        $this->m_fireNotifyUninstallTemplateBegun =new XCube_Delegate();
        $this->m_fireNotifyUninstallTemplateBegun->register('Legacy_ModuleUninstaller._fireNotifyUninstallTemplateBegun');
    }

    public function setCurrentXoopsModule(&$xoopsModule)
    {
        $this->_mXoopsModule =& $xoopsModule;
    }

    public function setForceMode($isForceMode)
    {
        $this->_mForceMode = $isForceMode;
    }

    public function _uninstallModule()
    {
        $moduleHandler =& xoops_gethandler('module');
        if (!$moduleHandler->delete($this->_mXoopsModule)) {
            $this->mLog->addError(_AD_LEGACY_ERROR_DELETE_MODULEINFO_FROM_DB);
        } else {
            $this->mLog->addReport(_AD_LEGACY_MESSAGE_DELETE_MODULEINFO_FROM_DB);
        }
    }

    public function _uninstallTables()
    {
        $root =& XCube_Root::getSingleton();
        $db =& $root->mController->getDB();
 
        $dirname = $this->_mXoopsModule->get('dirname');
        $t_search = ['{prefix}', '{dirname}', '{Dirname}', '{_dirname_}'];
        $t_replace = [XOOPS_DB_PREFIX, strtolower($dirname), ucfirst(strtolower($dirname)), $dirname];
 
        $tables = $this->_mXoopsModule->getInfo('tables');
        if (false != $tables && is_array($tables)) {
            foreach ($tables as $table) {
                //
                // TODO Do we need to check reserved core tables?
                //
                $t_tableName = $table;
                if (isset($this->_mXoopsModule->modinfo['cube_style']) && true == $this->_mXoopsModule->modinfo['cube_style']) {
                    $t_tableName = str_replace($t_search, $t_replace, $table);
                } else {
                    $t_tableName = $db->prefix($table);
                }
 
                $sql = 'DROP TABLE ' . $t_tableName;
 
                if ($db->query($sql)) {
                    $this->mLog->addReport(XCube_Utils::formatString(_AD_LEGACY_MESSAGE_DROP_TABLE, $t_tableName));
                } else {
                    $this->mLog->addError(XCube_Utils::formatString(_AD_LEGACY_ERROR_DROP_TABLE, $t_tableName));
                }
            }
        }
    }

    public function _uninstallTemplates()
    {
        $this->m_fireNotifyUninstallTemplateBegun->call(new XCube_Ref($this->_mXoopsModule));
        Legacy_ModuleInstallUtils::uninstallAllOfModuleTemplates($this->_mXoopsModule, $this->mLog);
    }

    public function _uninstallBlocks()
    {
        Legacy_ModuleInstallUtils::uninstallAllOfBlocks($this->_mXoopsModule, $this->mLog);
 
        //
        // Additional
        //
        $tplHandler =& xoops_gethandler('tplfile');
        $criteria =new Criteria('tpl_module', $this->_mXoopsModule->get('dirname'));
        if (!$tplHandler->deleteAll($criteria)) {
            $this->mLog->addError(XCube_Utils::formatString(_AD_LEGACY_ERROR_COULD_NOT_DELETE_BLOCK_TEMPLATES, $tplHandler->db->error()));
        }
    }
 
    public function _uninstallPreferences()
    {
        Legacy_ModuleInstallUtils::uninstallAllOfConfigs($this->_mXoopsModule, $this->mLog);
        Legacy_ModuleInstallUtils::deleteAllOfNotifications($this->_mXoopsModule, $this->mLog);
        Legacy_ModuleInstallUtils::deleteAllOfComments($this->_mXoopsModule, $this->mLog);
    }
 
    public function _processScript()
    {
        $installScript = trim($this->_mXoopsModule->getInfo('onUninstall'));
        if (false != $installScript) {
            require_once XOOPS_MODULE_PATH . '/' . $this->_mXoopsModule->get('dirname') . '/' . $installScript;
            $funcName = 'xoops_module_uninstall_' . $this->_mXoopsModule->get('dirname');
 
            if (!preg_match('/^[a-zA-Z_][a-zA-Z0-9_]*$/', $funcName)) {
                $this->mLog->addError(XCube_Utils::formatString(_AD_LEGACY_ERROR_FAILED_TO_EXECUTE_CALLBACK, $funcName));
                return;
            }
 
            if (function_exists($funcName)) {
                // Because X2 can use reference parameter, Legacy doesn't use the following code;'
                // if (!call_user_func($funcName, $this->_mXoopsModule, new XCube_Ref($this->mLog))) {
 
                $result = $funcName($this->_mXoopsModule, new XCube_Ref($this->mLog));
                if (!$result) {
                    $this->mLog->addError(XCube_Utils::formatString(_AD_LEGACY_ERROR_FAILED_TO_EXECUTE_CALLBACK, $funcName));
                }
            }
        }
    }
 
    public function _processReport()
    {
        if (!$this->mLog->hasError()) {
            $this->mLog->add(XCube_Utils::formatString(_AD_LEGACY_MESSAGE_UNINSTALLATION_MODULE_SUCCESSFUL, $this->_mXoopsModule->get('name')));
        } else {
            $this->mLog->addError(XCube_Utils::formatString(_AD_LEGACY_ERROR_UNINSTALLATION_MODULE_FAILURE, $this->_mXoopsModule->get('name')));
        }
    }

    public function executeUninstall()
    {
        $this->_uninstallTables();
        if (!$this->_mForceMode && $this->mLog->hasError()) {
            $this->_processReport();
            return false;
        }
        if (null != $this->_mXoopsModule->get('mid')) {
            $this->_uninstallModule();
            if (!$this->_mForceMode && $this->mLog->hasError()) {
                $this->_processReport();
                return false;
            }
 
            $this->_uninstallTemplates();
            if (!$this->_mForceMode && $this->mLog->hasError()) {
                $this->_processReport();
                return false;
            }
 
            $this->_uninstallBlocks();
            if (!$this->_mForceMode && $this->mLog->hasError()) {
                $this->_processReport();
                return false;
            }
 
            $this->_uninstallPreferences();
            if (!$this->_mForceMode && $this->mLog->hasError()) {
                $this->_processReport();
                return false;
            }
 
            $this->_processScript();
            if (!$this->_mForceMode && $this->mLog->hasError()) {
                $this->_processReport();
                return false;
            }
        }
        $this->_processReport();
 
        return true;
    }
}