Userlog_Module_Plugin

Complexity

Total Complexity

19

Size/Duplication

Total Lines	113
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	loadFile()	0	15	3
A	fileExists()	0	9	2
A	_securityCheck()	0	9	2
A	getPlugin()	0	13	3
D	getPlugins()	0	31	9

<?php
/*
 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.
 */

/**
 * @copyright       XOOPS Project (https://xoops.org)
 * @license         http://www.fsf.org/copyleft/gpl.html GNU public license
 * @author          trabis <lusopoemas@gmail.com>
 */
// irmtfan copy from xoops26 xoops_lib/Xoops/Module/plugin.php class
// change XoopsLoad -> self
// change $xoops -> $GLOBALS['xoops']
// change  Userlog_Module_Plugin_Abstract , Userlog_Module_Plugin
// change  $xoops->getActiveModules() -> xoops_getActiveModules()

class Userlog_Module_Plugin

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    /**
     * @param string $dirname
     * @param string $pluginName
     * @param bool   $force
     *
     * @return bool|Xoops_Module_Plugin_Abstract false if plugin does not exist
     */
    public static function getPlugin($dirname, $pluginName = 'system', $force = false)
    {
        $inactiveModules = false;
        if ($force) {
            $inactiveModules = [$dirname];
        }
        $available = self::getPlugins($pluginName, $inactiveModules);
        if (!in_array($dirname, array_keys($available))) {
            return false;
        }

        return $available[$dirname];
    }

    /**
     * @param string     $pluginName
     * @param array|bool $inactiveModules
     *
     * @return mixed
     */
    public static function getPlugins($pluginName = 'system', $inactiveModules = false)

getPlugins uses the super-global variable $GLOBALS which is generally not recommended.

    {
        static $plugins = [];
        if (!isset($plugins[$pluginName])) {
            $plugins[$pluginName] = [];
            //$xoops = Xoops::getInstance();

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

            //Load interface for this plugin
            if (!self::loadFile($GLOBALS['xoops']->path("modules/{$pluginName}/class/plugin/interface.php"))) {
                return $plugins[$pluginName];
            }

            $dirnames = xoops_getActiveModules();
            if (is_array($inactiveModules)) {
                $dirnames = array_merge($dirnames, $inactiveModules);
            }
            foreach ($dirnames as $dirname) {
                if (self::loadFile($GLOBALS['xoops']->path("modules/{$dirname}/class/plugin/{$pluginName}.php"))
                    || self::loadFile($GLOBALS['xoops']->path("modules/{$pluginName}/class/plugin/{$dirname}.php"))) {
                    $className = ucfirst($dirname) . ucfirst($pluginName) . 'Plugin';
                    $interface = ucfirst($pluginName) . 'PluginInterface';
                    $class     = new $className($dirname);
                    if ($class instanceof Userlog_Module_Plugin_Abstract && $class instanceof $interface) {
                        $plugins[$pluginName][$dirname] = $class;
                    }
                }
            }
        }

        return $plugins[$pluginName];
    }

    /**
     * @param      $file
     * @param bool $once
     *
     * @return bool
     */

    public static function loadFile($file, $once = true)
    {
        self::_securityCheck($file);
        if (self::fileExists($file)) {
            if ($once) {
                require_once $file;
            } else {
                include $file;
            }

            return true;
        }

        return false;
    }

    /**
     * @param $file
     *
     * @return mixed
     */

    public static function fileExists($file)
    {
        static $included = [];
        if (!isset($included[$file])) {
            $included[$file] = file_exists($file);
        }

        return $included[$file];
    }

    /**
     * @param $filename
     */
    protected static function _securityCheck($filename)
    {
        /**
         * Security check
         */
        if (preg_match('/[^a-z0-9\\/\\\\_.:-]/i', $filename)) {
            exit('Security check: Illegal character in filename');

The method _securityCheck() contains an exit expression.

        }
    }
}