Legacy_Updater.class.php

<?php
 
if (!defined('XOOPS_ROOT_PATH')) {
    exit();
}
 
require_once XOOPS_LEGACY_PATH . '/admin/class/ModuleUpdater.class.php';
 
class Legacy_ModuleUpdater extends Legacy_ModulePhasedUpgrader
{
    public $_mMilestone = [
        '106' => 'update106',
        '200' => 'update200'
    ];
 
    public function _processScript()
    {
        parent::_processScript();
        $cVersion =  $this->getCurrentVersion();
        if ($cVersion < 204) {
            $this->auto_update_session_blob();
        }
    }
 
    public function auto_update_session_blob()
    {
        $root = XCube_Root::getSingleton();
        $db = $root->mController->getDB();
        $table = $db->prefix('session');
 
        $sql = 'SHOW COLUMNS FROM `'. $table .'` WHERE Field = \'sess_data\'';
        if ($res = $db->query($sql)) {
            $row = $db->fetchArray($res);
 
            if ('blob' !== strtolower($row['Type'])) {
                $sql = 'ALTER TABLE `'. $table .'` CHANGE `sess_data` `sess_data` BLOB NOT NULL';
 
                if ($db->query($sql)) {
                    $this->mLog->addReport('Table `'.$table.'` field `sess_data` changed type to BLOB.');
                } else {
                    $this->mLog->addError('Type change error of table `'.$table.'` field `sess_data` to BLOB.');
                }
            }
        }
    }
 
    public function update200()
    {
        $this->mLog->addReport(_AD_LEGACY_MESSAGE_UPDATE_STARTED);
 
        // Update database table index.
        $this->_extendConfigTitleSize();
        if (!$this->_mForceMode && $this->mLog->hasError()) {
            $this->_processReport();
            return false;
        }
 
        // Normal update process.
        $this->_updateModuleTemplates();
        if (!$this->_mForceMode && $this->mLog->hasError()) {
            $this->_processReport();
            return false;
        }
 
        $this->_updateBlocks();
        if (!$this->_mForceMode && $this->mLog->hasError()) {
            $this->_processReport();
            return false;
        }
 
        $this->_updatePreferences();
        if (!$this->_mForceMode && $this->mLog->hasError()) {
            $this->_processReport();
            return false;
        }
 
        $this->saveXoopsModule($this->_mTargetXoopsModule);
        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;
    }
 
    public function update106()
    {
        $this->mLog->addReport(_AD_LEGACY_MESSAGE_UPDATE_STARTED);
 
        // Update database table index.
        $this->_setUniqueToGroupUserLink();
        $this->_recoverXoopsGroupPermission();
        if (!$this->_mForceMode && $this->mLog->hasError()) {
            $this->_processReport();
            return false;
        }
 
        // Normal update process.
        $this->_updateModuleTemplates();
        if (!$this->_mForceMode && $this->mLog->hasError()) {
            $this->_processReport();
            return false;
        }
 
        $this->_updateBlocks();
        if (!$this->_mForceMode && $this->mLog->hasError()) {
            $this->_processReport();
            return false;
        }
 
        $this->_updatePreferences();
        if (!$this->_mForceMode && $this->mLog->hasError()) {
            $this->_processReport();
            return false;
        }
 
        $this->saveXoopsModule($this->_mTargetXoopsModule);
        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;
    }

    public function _extendConfigTitleSize()
    {
        $root =& XCube_Root::getSingleton();
        $db =& $root->mController->getDB();
        $table = $db->prefix('config');
 
        $sql = 'ALTER TABLE `'. $table .'` MODIFY `conf_title` varchar(191) NOT NULL default "", MODIFY `conf_desc` varchar(191) NOT NULL default ""';
 
        if ($db->query($sql)) {
            $this->mLog->addReport(XCube_Utils::formatString(_AD_LEGACY_MESSAGE_EXTEND_CONFIG_TITLE_SIZE_SUCCESSFUL, $table));
        } else {
            $this->mLog->addError(XCube_Utils::formatString(_AD_LEGACY_ERROR_COULD_NOT_EXTEND_CONFIG_TITLE_SIZE, $table));
        }
    }
 
    public function _setUniqueToGroupUserLink()
    {
        $root =& XCube_Root::getSingleton();
        $db =& $root->mController->getDB();
        $table = $db->prefix('groups_users_link');
 
        // Delete duplicate data.
        $sql = 'SELECT `uid`,`groupid`,COUNT(*) AS c FROM `' . $table . '` GROUP BY `uid`,`groupid` HAVING `c` > 1';
        if ($res = $db->query($sql)) {
            while ($row = $db->fetchArray($res)) {
                $sql = sprintf('DELETE FROM `%s` WHERE `uid` = %d AND `groupid` = %d ORDER BY `linkid` DESC', $table, $row['uid'], $row['groupid']);
                if (!$db->query($sql, $row['c'] - 1)) {
                    $this->mLog->addError(XCube_Utils::formatString(_AD_LEGACY_ERROR_COULD_NOT_DELETE_DUPLICATE_DATA, $table));
                    return;
                }
            }
        }
 
        // Set unique key.
        $sql = 'ALTER TABLE `' . $table . '` DROP INDEX `groupid_uid`';
        $db->query($sql); // ignore sql errors
        $sql = 'ALTER TABLE `' . $table . '` ADD UNIQUE `uid_groupid` (`uid`,`groupid`)';
        if ($db->query($sql)) {
            $this->mLog->addReport(XCube_Utils::formatString(_AD_LEGACY_MESSAGE_SET_UNIQUE_KEY_SUCCESSFUL, $table));
        } else {
            $this->mLog->addError(XCube_Utils::formatString(_AD_LEGACY_ERROR_COULD_NOT_SET_UNIQUE_KEY, $table));
        }
    }

    public function _recoverXoopsGroupPermission()
    {
        $root =& XCube_Root::getSingleton();
        $db =& $root->mController->getDB();
 
        $permTable = $db->prefix('group_permission');
        $groupTable = $db->prefix('groups');
        $sql = sprintf(
            'SELECT DISTINCT `gperm_groupid` FROM `%s` LEFT JOIN `%s` ON `%s`.`gperm_groupid`=`%s`.`groupid`' . ' WHERE `gperm_modid`=1 AND `groupid` IS NULL',
            $permTable, $groupTable, $permTable, $groupTable);
        $result = $db->query($sql);
        if (!$result) {
            return false;
        }
 
        $gids = [];
        while ($myrow = $db->fetchArray($result)) {
            $gids[] = $myrow['gperm_groupid'];
        }
 
        $db->freeRecordSet($result);
 
        // remove all invalid group id entries
        if (0 != count($gids)) {
            $sql = sprintf('DELETE FROM `%s` WHERE `gperm_groupid` IN (%s) AND `gperm_modid`=1',
                           $permTable, implode(',', $gids));
            $result = $db->query($sql);
            if (!$result) {
                return false;
            }
        }
 
        return true;
    }
}