XoopsModules25x / userlog

include/module.php

<?php

For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 28 and the first side effect is on line 21.

/*
 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.
*/
/**
 *  userlog module
 *
 * @copyright       XOOPS Project (https://xoops.org)
 * @license         GNU GPL 2 (http://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
 * @package         userlog include
 * @since           1
 * @author          irmtfan (irmtfan@yahoo.com)
 * @author          XOOPS Project <www.xoops.org> <www.xoops.ir>
 */
defined('XOOPS_ROOT_PATH') || exit('Restricted access.');
require_once __DIR__ . '/common.php';
/**
 * @param XoopsModule $module
 *
 * @return int
 */
function xoops_module_uninstall_userlog(XoopsModule $module)

The parameter $module is not used and could be removed.

{
    $logsetObj = UserlogSetting::getInstance();

    return $logsetObj->cleanCache(); // delete all settings caches
}

/**
 * @param XoopsModule $module
 * @param null        $prev_version
 *
 * @return bool|mixed
 */

function xoops_module_update_userlog(XoopsModule $module, $prev_version = null)
{
    if ($prev_version == round($module->getInfo('version') * 100, 2)) {
        $module->setErrors('You have the latest ' . $module->getInfo('name') . ' module (' . $module->getInfo('dirname') . ' version ' . $module->getInfo('version') . ') and update is not necessary');
//        print_r($module->getErrors());

70% of this comment could be valid code. Did you maybe forget this after debugging?

        return true;
    }
    $ret = true;
    // first db update
    if (100 == $prev_version) {
        $ret = update_userlog_v100($module);
    }
    if ($prev_version < 114) {
        $ret = update_userlog_v114($module);
    }
    if ($prev_version < 115) {
        $ret = update_userlog_v115($module);
    }
    if ($prev_version < 116) {
        $ret = update_userlog_v116($module);
    }
    $errors = $module->getErrors();
    if (!empty($errors)) {

This if statement is empty and can be removed.

//        print_r($errors);

67% of this comment could be valid code. Did you maybe forget this after debugging?

    }

    return $ret;
}

// update database from v1 to 1.01 (Beta1 to RC1)
// module_name VARCHAR(25) change to VARCHAR(50)
/**
 * @param XoopsModule $module
 *
 * @return bool
 */
function update_userlog_v100(XoopsModule $module)

This function seems to be duplicated in your project.

{
    $field   = 'module_name';
    $userlog  = Userlog::getInstance();
    $ret     = $userlog->getHandler('log')->showFields($field);
    preg_match_all('!\d+!', $ret[$field]['Type'], $nums);
    // only change if module_name Type was VARCHAR(25)
    if (25 == $nums[0][0]) {
        $ret2 = $userlog->getHandler('log')->changeField($field, "VARCHAR(50) NOT NULL default ''");
    } else {
        $ret2 = true;
        $module->setErrors("Your table field ({$field}) with size {$ret[$field]['Type']} don't need change.");
    }

    return $ret2;
}

// add ",active,inside,outside,unset_pass" to all settings
/**
 * @param XoopsModule $module
 *
 * @return bool
 */
function update_userlog_v114(XoopsModule $module)

This function seems to be duplicated in your project.

{
    $userlog    = Userlog::getInstance();
    $logsetsObj = $userlog->getHandler('setting')->getAll();
    $ret        = true;
    foreach ($logsetsObj as $setObj) {
        if (strpos($setObj->getVar('options'), 'active')) {
            continue;
        }
        $setObj->setVar('options', $setObj->getVar('options') . ',active,inside,outside,unset_pass');
        if (!$setObj->storeSet(true)) {
            $ret = false;
            $module->setErrors(_AM_USERLOG_SET_ERROR . ' id=' . $setObj->set_id() . ' options=' . $setObj->options());
        }
    }

    return $ret;
}

/**
 * @param XoopsModule $module
 *
 * @return mixed
 */
function update_userlog_v115(XoopsModule $module)

This function seems to be duplicated in your project.

{
    $userlog  = Userlog::getInstance();
    // Only change the field from INDEX to UNIQUE if it is not unique
    // if (isset($indexArr[0]["Non_unique"]) || $indexArr[0]["Non_unique"] == 1) { }

73% of this comment could be valid code. Did you maybe forget this after debugging?

    // change the index in _stats table
    if (!$ret = $userlog->getHandler('stats')->changeIndex('stats_type_link_period', ['stats_type', 'stats_link', 'stats_period'], 'UNIQUE')) {
        $module->setErrors("'stats_type_link_period' index is not changed to unique. Warning: do not use module until you change this index to unique.");
    }
    // drop the index in _log table
    if (!$ret = $userlog->getHandler('log')->dropIndex('log_id_uid')) {
        $module->setErrors("'log_id_uid' index is not dropped.");
    }
    // add the index in _log table
    if (!$ret = $userlog->getHandler('log')->addIndex('log_time', ['log_time'])) {
        $module->setErrors("'log_time' index is not added.");
    }

    return $ret;
}

/**
 * @param XoopsModule $module
 *
 * @return bool
 */
function update_userlog_v116(XoopsModule $module)

This function seems to be duplicated in your project.

{
    // remove old html template files
    $template_directory = XOOPS_ROOT_PATH . '/modules/' . $module->getVar('dirname', 'n') . '/templates/';
    $template_list      = array_diff(scandir($template_directory, SCANDIR_SORT_NONE), ['..', '.']);
    foreach ($template_list as $k => $v) {
        $fileinfo = new SplFileInfo($template_directory . $v);
        if ('html' === $fileinfo->getExtension() && 'index.html' !== $fileinfo->getFilename()) {
            @unlink($template_directory . $v);

It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

        }
    }

    return true;
}