XoopsModules25x / suico

include/onupdate.php

<?php declare(strict_types=1);
/*
 You may not change or alter any portion of this comment or credits
 of supporting developers from this source code or any supporting source code
 which is considered copyrighted (c) material of the original comment or credit authors.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*/

/**
 * @category        Module
 * @copyright       {@link https://xoops.org/ XOOPS Project}
 * @license         GNU GPL 2.0 or later (https://www.gnu.org/licenses/gpl-2.0.html)
 * @author          Marcello Brandão aka  Suico, Mamba, LioMJ  <https://xoops.org>
 */

use XoopsModules\Suico\{
    Common\Configurator,
    Common\Migrate,
    Helper,
    Utility
};
/** @var Helper $helper */
/** @var Utility $utility */
/** @var Configurator $configurator */
/** @var Migrate $migrator */
if ((!defined('XOOPS_ROOT_PATH')) || !($GLOBALS['xoopsUser'] instanceof \XoopsUser)
    || !$GLOBALS['xoopsUser']->isAdmin()) {
    exit('Restricted access' . PHP_EOL);
}
include \dirname(__DIR__) . '/preloads/autoloader.php';

/**
 * Prepares system prior to attempting to install module
 * @param \XoopsModule $module {@link \XoopsModule}
 * @return bool true if ready to install, false if not
 */
function xoops_module_pre_update_suico(
    \XoopsModule $module
) {
    $moduleDirName = \basename(\dirname(__DIR__));
    $helper        = Helper::getInstance();
    $utility       = new Utility();
    $xoopsSuccess  = $utility::checkVerXoops($module);
    $phpSuccess    = $utility::checkVerPhp($module);
    $configurator  = new Configurator();
    $migrator      = new Migrate($configurator);
    $migrator->synchronizeSchema();

    return $xoopsSuccess && $phpSuccess;
}

/**
 * Performs tasks required during update of the module
 * @param \XoopsModule $module {@link XoopsModule}
 * @param null         $previousVersion

Are you sure the doc-type for parameter $previousVersion is correct as it would always require null to be passed?

 *
 * @return bool true if update successful, false if not
 */
function xoops_module_update_suico(
    XoopsModule $module,
    $previousVersion = null
) {
    $moduleDirName      = \basename(\dirname(__DIR__));
    $moduleDirNameUpper = \mb_strtoupper($moduleDirName);

    $helper       = Helper::getInstance();
    $utility      = new Utility();
    $configurator = new Configurator();
    $helper->loadLanguage('common');
    $migrator = new Migrate($configurator);
    $migrator->synchronizeSchema();
    if ($previousVersion < 360) {
        //rename column EXAMPLE
        //        $tables = new Tables();
        //        $table = 'xxxx_categories';
        //        $column = 'order';
        //        $newName = 'order';
        //        $attributes = "INT(5) NOT NULL DEFAULT '0'";
        //        if ($tables->useTable($table)) {
        //            $tables->alterColumn($table, $column, $attributes, $newName);
        //            if (!$tables->executeQueue()) {
        //                echo '<br>' . constant('CO_' . $moduleDirNameUpper . '_UPGRADEFAILED0') . ' ' . $migrate->getLastError();
        //            }
        //        }
        //delete old HTML templates
        if (count($configurator->templateFolders) > 0) {
            foreach ($configurator->templateFolders as $folder) {
                $templateFolder = $GLOBALS['xoops']->path('modules/' . $moduleDirName . $folder);
                if (is_dir($templateFolder)) {
                    $templateList = array_diff(scandir($templateFolder, SCANDIR_SORT_NONE), ['..', '.']);
                    foreach ($templateList as $k => $v) {
                        $fileInfo = new SplFileInfo($templateFolder . $v);
                        if ('html' === $fileInfo->getExtension() && 'index.html' !== $fileInfo->getFilename()) {
                            if (is_file($templateFolder . $v)) {
                                if (false === @\unlink($templateFolder . $v)) {
                                    throw new \RuntimeException('The file ' . $templateFolder . $v . ' could not be deleted.');
                                }
                            }
                        }
                    }
                }
            }
        }
        //  ---  DELETE OLD FILES ---------------
        if (count($configurator->oldFiles) > 0) {
            //    foreach (array_keys($GLOBALS['uploadFolders']) as $i) {
            foreach (
                array_keys(
                    $configurator->oldFiles
                ) as $i
            ) {
                $tempFile = $GLOBALS['xoops']->path('modules/' . $moduleDirName . $configurator->oldFiles[$i]);
                if (is_file($tempFile)) {
                    if (false === @\unlink($tempFile)) {
                        throw new \RuntimeException('The file ' . $tempFile . ' could not be deleted.');
                    }
                }
            }
        }
        //  ---  DELETE OLD FOLDERS ---------------
        xoops_load('XoopsFile');
        if (count($configurator->oldFolders) > 0) {
            //    foreach (array_keys($GLOBALS['uploadFolders']) as $i) {
            foreach (
                array_keys(
                    $configurator->oldFolders
                ) as $i
            ) {
                $tempFolder = $GLOBALS['xoops']->path('modules/' . $moduleDirName . $configurator->oldFolders[$i]);
                /** @var XoopsObjectHandler $folderHandler */
                $folderHandler = XoopsFile::getHandler(
                    'folder',
                    $tempFolder
                );
                $folderHandler->delete($tempFolder);
            }
        }
        //  ---  CREATE UPLOAD FOLDERS ---------------
        if (count($configurator->uploadFolders) > 0) {
            //    foreach (array_keys($GLOBALS['uploadFolders']) as $i) {
            foreach (
                array_keys(
                    $configurator->uploadFolders
                ) as $i
            ) {
                $utility::createFolder($configurator->uploadFolders[$i]);
            }
        }
        //  ---  COPY blank.png FILES ---------------
        if (count($configurator->copyBlankFiles) > 0) {
            $file = \dirname(__DIR__) . '/assets/images/blank.png';
            foreach (array_keys($configurator->copyBlankFiles) as $i) {
                $dest = $configurator->copyBlankFiles[$i] . '/blank.png';
                $utility::copyFile($file, $dest);
            }
        }
        //delete .html entries from the tpl table
        $sql = 'DELETE FROM ' . $GLOBALS['xoopsDB']->prefix(
                'tplfile'
            ) . " WHERE `tpl_module` = '" . $module->getVar(
                'dirname',
                'n'
            ) . "' AND `tpl_file` LIKE '%.html%'";
        $GLOBALS['xoopsDB']->queryF($sql);
        /** @var XoopsGroupPermHandler $grouppermHandler */
        $grouppermHandler = xoops_getHandler('groupperm');

        return $grouppermHandler->deleteByModule($module->getVar('mid'), 'item_read');
    }
    $profileHandler = $helper->getHandler('Profile');
    $profileHandler->cleanOrphan($GLOBALS['xoopsDB']->prefix('users'), 'uid', 'profile_id');
    $fieldHandler = $helper->getHandler('Field');
    $user_fields  = $fieldHandler->getUserVars();
    $criteria     = new Criteria('field_name', "('" . implode("', '", $user_fields) . "')", 'IN');
    $fieldHandler->updateAll('field_config', 0, $criteria);

    return true;
}