onupdate.php ➔ xoops_module_update_wflinks() - Code Metrics - Inspection of "Updates" - mambax7/wflinks - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d1322e...dc7924 )

by Michael

created 2017-09-04 11:50 UTC

onupdate.php ➔ xoops_module_update_wflinks() D

↳ Parent: Project

Complexity

Conditions	19
Paths	65

Size

Total Lines	90
Code Lines	45

Duplication

Lines	13
Ratio	14.44 %

Importance

Changes

Metric	Value
cc	19
eloc	45
nc	65
nop	2
dl	13
loc	90
rs	4.764
c	0
b	0
f	0

How to fix Long Method Complexity

<?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      GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
 * @package
 * @since
 * @author       XOOPS Development Team
 */

if ((!defined('XOOPS_ROOT_PATH')) || !($GLOBALS['xoopsUser'] instanceof XoopsUser)
if ($x instanceof DoesNotExist) {
    // Do something.
}
    || !$GLOBALS['xoopsUser']->IsAdmin()
) {
    exit('Restricted access' . PHP_EOL);
}

/**
 * @param string $tablename
 *
 * @return bool
 */
function tableExists($tablename)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
{
    $result = $GLOBALS['xoopsDB']->queryF("SHOW TABLES LIKE '$tablename'");

    return ($GLOBALS['xoopsDB']->getRowsNum($result) > 0) ? true : false;
}

/**
 *
 * 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_wflinks(XoopsModule $module)
{
    $moduleDirName = basename(dirname(__DIR__));
    /** @var WflinksUtility $utilityClass */
    $utilityClass     = ucfirst($moduleDirName) . 'Utility';
    if (!class_exists($utilityClass)) {
        xoops_load('utility', $moduleDirName);
    }
    $xoopsSuccess = $utilityClass::checkVerXoops($module);
    $phpSuccess   = $utilityClass::checkVerPhp($module);
    return $xoopsSuccess && $phpSuccess;
}

/**
 *
 * Performs tasks required during update of the module
 * @param XoopsModule $module {@link XoopsModule}
 * @param null        $previousVersion
 *
 * @return bool true if update successful, false if not
 */

function xoops_module_update_wflinks(XoopsModule $module, $previousVersion = null)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
{
    $moduleDirName = basename(dirname(__DIR__));
    $capsDirName   = strtoupper($moduleDirName);

    if ($previousVersion < 112) {

        $configurator = include __DIR__ . '/config.php';


        /** @var WflinksUtility $utilityClass */
        $utilityClass    = ucfirst($moduleDirName) . 'Utility';
        if (!class_exists($utilityClass)) {
            xoops_load('utility', $moduleDirName);
        }

        //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 ($fileInfo->getExtension() === 'html' && $fileInfo->getFilename() !== 'index.html') {
                            if (file_exists($templateFolder . $v)) {
                                unlink($templateFolder . $v);
                            }
                        }
                    }
                }
            }
        }

        //  ---  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)) {
                    unlink($tempFile);
                }
            }
        }

        //  ---  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 $folderHandler XoopsObjectHandler */
                $folderHandler = XoopsFile::getHandler('folder', $tempFolder);
                $folderHandler->delete($tempFolder);
            }
        }

        //  ---  CREATE FOLDERS ---------------
        if (count($configurator->uploadFolders) > 0) {

            //    foreach (array_keys($GLOBALS['uploadFolders']) as $i) {

            foreach (array_keys($configurator->uploadFolders) as $i) {
                $utilityClass::createFolder($configurator->uploadFolders[$i]);
            }
        }

        //  ---  COPY blank.png FILES ---------------
        if (count($configurator->blankFiles) > 0) {

            $file = __DIR__ . '/../assets/images/blank.png';
            foreach (array_keys($configurator->blankFiles) as $i) {
                $dest = $configurator->blankFiles[$i] . '/blank.png';
                $utilityClass::copyFile($file, $dest);
            }
        }

        //  ---  COPY FLAGS FILES ---------------
        $source = XOOPS_ROOT_PATH . '/modules/' . $moduleDirName .'/EXTRA/htdocs/uploads/flags';
        $dest   = XOOPS_UPLOAD_PATH .'/flags';
        $utilityClass::rcopy($source, $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 $gpermHandler */
        $gpermHandler = xoops_getHandler('groupperm');
        return $gpermHandler->deleteByModule($module->getVar('mid'), 'item_read');

    }
    return true;
}



1		<?php
		0 ignored issues – show Coding Style Compatibility introduced 2017-09-04 11:52 UTC by Report Bug Copy Issue Report 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 31 and the first side effect is on line 23. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2		/*
3		* You may not change or alter any portion of this comment or credits
4		* of supporting developers from this source code or any supporting source code
5		* which is considered copyrighted (c) material of the original comment or credit authors.
6		*
7		* This program is distributed in the hope that it will be useful,
8		* but WITHOUT ANY WARRANTY; without even the implied warranty of
9		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
10		*/
11
12		/**
13		* @copyright XOOPS Project https://xoops.org/
14		* @license GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
15		* @package
16		* @since
17		* @author XOOPS Development Team
18		*/
19
20		if ((!defined('XOOPS_ROOT_PATH')) \|\| !($GLOBALS['xoopsUser'] instanceof XoopsUser)
		0 ignored issues – show Bug introduced 2017-09-04 11:52 UTC by Report Bug Copy Issue Report The class `XoopsUser` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
21		\|\| !$GLOBALS['xoopsUser']->IsAdmin()
22		) {
23		exit('Restricted access' . PHP_EOL);
24		}
25
26		/**
27		* @param string $tablename
28		*
29		* @return bool
30		*/
31		function tableExists($tablename)
		0 ignored issues – show Coding Style introduced 2017-09-04 11:52 UTC by Report Bug Copy Issue Report `tableExists` uses the super-global variable `$GLOBALS` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
32		{
33		$result = $GLOBALS['xoopsDB']->queryF("SHOW TABLES LIKE '$tablename'");
34
35		return ($GLOBALS['xoopsDB']->getRowsNum($result) > 0) ? true : false;
36		}
37
38		/**
39		*
40		* Prepares system prior to attempting to install module
41		* @param XoopsModule $module {@link XoopsModule}
42		*
43		* @return bool true if ready to install, false if not
44		*/
45		function xoops_module_pre_update_wflinks(XoopsModule $module)
46		{
47		$moduleDirName = basename(dirname(__DIR__));
48		/** @var WflinksUtility $utilityClass */
49		$utilityClass = ucfirst($moduleDirName) . 'Utility';
50		if (!class_exists($utilityClass)) {
51		xoops_load('utility', $moduleDirName);
52		}
53		$xoopsSuccess = $utilityClass::checkVerXoops($module);
54		$phpSuccess = $utilityClass::checkVerPhp($module);
55		return $xoopsSuccess && $phpSuccess;
56		}
57
58		/**
59		*
60		* Performs tasks required during update of the module
61		* @param XoopsModule $module {@link XoopsModule}
62		* @param null $previousVersion
63		*
64		* @return bool true if update successful, false if not
65		*/
66
67		function xoops_module_update_wflinks(XoopsModule $module, $previousVersion = null)
		0 ignored issues – show Coding Style introduced 2017-09-04 11:52 UTC by Report Bug Copy Issue Report `xoops_module_update_wflinks` uses the super-global variable `$GLOBALS` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
68		{
69		$moduleDirName = basename(dirname(__DIR__));
70		$capsDirName = strtoupper($moduleDirName);
71
72		if ($previousVersion < 112) {
73
74		$configurator = include __DIR__ . '/config.php';
75
76
77		/** @var WflinksUtility $utilityClass */
78		$utilityClass = ucfirst($moduleDirName) . 'Utility';
79		if (!class_exists($utilityClass)) {
80		xoops_load('utility', $moduleDirName);
81		}
82
83		//delete old HTML templates
84		if (count($configurator->templateFolders) > 0) {
85		foreach ($configurator->templateFolders as $folder) {
86		$templateFolder = $GLOBALS['xoops']->path('modules/' . $moduleDirName . $folder);
87		if (is_dir($templateFolder)) {
88		$templateList = array_diff(scandir($templateFolder, SCANDIR_SORT_NONE), ['..', '.']);
89		foreach ($templateList as $k => $v) {
90		$fileInfo = new SplFileInfo($templateFolder . $v);
91		if ($fileInfo->getExtension() === 'html' && $fileInfo->getFilename() !== 'index.html') {
92		if (file_exists($templateFolder . $v)) {
93		unlink($templateFolder . $v);
94		}
95		}
96		}
97		}
98		}
99		}
100
101		// --- DELETE OLD FILES ---------------
102		if (count($configurator->oldFiles) > 0) {
103		// foreach (array_keys($GLOBALS['uploadFolders']) as $i) {
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-09-04 11:52 UTC by Report Bug Copy Issue Report `67%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
104		foreach (array_keys($configurator->oldFiles) as $i) {
105		$tempFile = $GLOBALS['xoops']->path('modules/' . $moduleDirName . $configurator->oldFiles[$i]);
106		if (is_file($tempFile)) {
107		unlink($tempFile);
108		}
109		}
110		}
111
112		// --- DELETE OLD FOLDERS ---------------
113		xoops_load('XoopsFile');
114		if (count($configurator->oldFolders) > 0) {
115		// foreach (array_keys($GLOBALS['uploadFolders']) as $i) {
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-09-04 11:52 UTC by Report Bug Copy Issue Report `67%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
116		foreach (array_keys($configurator->oldFolders) as $i) {
117		$tempFolder = $GLOBALS['xoops']->path('modules/' . $moduleDirName . $configurator->oldFolders[$i]);
118		/* @var $folderHandler XoopsObjectHandler */
119		$folderHandler = XoopsFile::getHandler('folder', $tempFolder);
120		$folderHandler->delete($tempFolder);
121		}
122		}
123
124		// --- CREATE FOLDERS ---------------
125	View Code Duplication	if (count($configurator->uploadFolders) > 0) {
		0 ignored issues – show Duplication introduced 2017-09-04 11:52 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
126		// foreach (array_keys($GLOBALS['uploadFolders']) as $i) {
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-09-04 11:52 UTC by Report Bug Copy Issue Report `67%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
127		foreach (array_keys($configurator->uploadFolders) as $i) {
128		$utilityClass::createFolder($configurator->uploadFolders[$i]);
129		}
130		}
131
132		// --- COPY blank.png FILES ---------------
133	View Code Duplication	if (count($configurator->blankFiles) > 0) {
		0 ignored issues – show Duplication introduced 2017-09-04 11:52 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
134		$file = __DIR__ . '/../assets/images/blank.png';
135		foreach (array_keys($configurator->blankFiles) as $i) {
136		$dest = $configurator->blankFiles[$i] . '/blank.png';
137		$utilityClass::copyFile($file, $dest);
138		}
139		}
140
141		// --- COPY FLAGS FILES ---------------
142		$source = XOOPS_ROOT_PATH . '/modules/' . $moduleDirName .'/EXTRA/htdocs/uploads/flags';
143		$dest = XOOPS_UPLOAD_PATH .'/flags';
144		$utilityClass::rcopy($source, $dest);
145
146		//delete .html entries from the tpl table
147		$sql = 'DELETE FROM ' . $GLOBALS['xoopsDB']->prefix('tplfile') . " WHERE `tpl_module` = '" . $module->getVar('dirname', 'n') . '\' AND `tpl_file` LIKE \'%.html%\'';
148		$GLOBALS['xoopsDB']->queryF($sql);
149
150		/** @var XoopsGroupPermHandler $gpermHandler */
151		$gpermHandler = xoops_getHandler('groupperm');
152		return $gpermHandler->deleteByModule($module->getVar('mid'), 'item_read');
153
154		}
155		return true;
156		}
157
158

mambax7 / wflinks

Push — master ( d1322e...dc7924 )

onupdate.php ➔ xoops_module_update_wflinks() D

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like