action.module.php ➔ xoops_module_pre_install_xsitemap() - Code Metrics - Inspection of "Updates for XOOPS 2.5.8, added new plugins, change..." - XoopsModules25x/xsitemap - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#3)

unknown

created 2017-05-03 02:48 UTC

action.module.php ➔ xoops_module_pre_install_xsitemap() A

↳ Parent: Project

Complexity

Conditions	3
Paths	4

Size

Total Lines	11
Code Lines	7

Duplication

Lines	11
Ratio	100 %

Importance

Changes

Metric	Value
cc	3
eloc	7
nc	4
nop	1
dl	11
loc	11
rs	9.4285
c	0
b	0
f	0

<?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.
*/
/**
 * Module: xsitemap
 *
 * @package    module\xsitemap\includes
 * @author     Taiwen Jiang <[email protected]>
 * @author     ZySpec <[email protected]>
 * @copyright  http://xoops.org 2001-2017 XOOPS Project
 * @license    http://www.fsf.org/copyleft/gpl.html GNU public license
 * @link       http://xoops.org XOOPS
 * @since      1.00
 */

/**
 * @internal {Make sure you PROTECT THIS FILE}
 */

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

/**
 *
 * Prepares system prior to attempting to install module
 *
 * @param XoopsModule $module
 *
 * @return bool true if ready to install, false if not
 */
function xoops_module_pre_install_xsitemap(XoopsModule $module)

{
    $utilsClass = ucfirst($moduleDirName) . 'Utilities';

    if (!class_exists($utilsClass)) {
        xoops_load('utilities', $moduleDirName);

    }

    $xoopsSuccess = $utilsClass::checkXoopsVer($module);
    $phpSuccess   = $utilsClass::checkPHPVer($module);
    return $xoopsSuccess && $phpSuccess;
}

/**
 *
 * Performs tasks required during installation of the module
 *
 * @param XoopsModule $module
 *
 * @return bool true if installation successful, false if not
 */
function xoops_module_install_xsitemap(&$module) {

    return true; //
    /** @internal following code removed, it will fail because module not fully loaded/available until
     * after install, module now uses XOOPS preload instead */
    /*

    //28/08/2009 by urbanspaceman
    include_once $GLOBALS['xoops']->path("class/tree.php");
    include_once $GLOBALS['xoops']->path("modules/" . $module->dirname() . "/class/plugin.php");
    include_once $GLOBALS['xoops']->path("modules/" . $module->dirname() . "/include/functions.php");
    include_once $GLOBALS['xoops']->path("modules/" . $module->dirname(). "/class/dummy.php");

    //Create the xsitemap.xml file in the site root
    $xsitemap_show = xsitemap_generate_sitemap();
    return xsitemap_save($xsitemap_show) ? true : false;
    */
}

/**
 *
 * Prepares system prior to attempting to update module
 *
 * @param XoopsModule $module
 *
 * @return bool true if successfully ready to update module, false if not
 */
function xoops_module_pre_update_xsitemap($module)

{
    $utilsClass = ucfirst($moduleDirName) . 'Utilities';

    if (!class_exists($utilsClass)) {
        xoops_load('utilities', $moduleDirName);

    }

    $xoopsSuccess = $utilsClass::checkXoopsVer($module);
    $phpSuccess   = $utilsClass::checkPHPVer($module);
    return $xoopsSuccess && $phpSuccess;
}

/**
 *
 * Functions to upgrade from previous version of the module
 *
 * @param XoopsModule $module
 * @param int $curr_version version number of module currently installed

 *
 * @return bool true if successfully updated module, false if not
 */
function xoops_module_update_xsitemap($module, $curr_version = null)

{
/*======================================================================

    //----------------------------------------------------------------
    // Remove xSitemap uploads folder (and all subfolders) if they exist
    //----------------------------------------------------------------*
    $utilsClass = ucfirst($moduleDirName) . 'Utilities';
    if (!class_exists($utilsClass)) {
        xoops_load('utilities', $moduleDirName);
    }

    // Recursively delete directories
    $xsUploadDir = realpath(XOOPS_UPLOAD_PATH . "/" . $module->dirname());
    $success = $utilsClass::rrmdir($xsUploadDir);
    if (true !== $success) {
        \Xmf\Language::load('admin', $module->dirname());
        $module->setErrors(sprintf(_AM_XSITEMAP_ERROR_BAD_DEL_PATH, $xsUploadDir));
    }
    return $success;
======================================================================*/

    $moduleDirName = $module->getVar('dirname');
    $xsHelper = \Xmf\Module\Helper::getHelper($moduleDirName);

    $utilsClass = ucfirst($moduleDirName) . 'Utilities';
    if (!class_exists($utilsClass)) {
        xoops_load('utilities', $moduleDirName);
    }
    //-----------------------------------------------------------------------
    // Upgrade for Xsitemap < 1.54
    //-----------------------------------------------------------------------

    $success = true;

    $xsHelper->loadLanguage('modinfo');
    $xsHelper->loadLanguage('admin');

    if ($prev_version < 154) {

        //----------------------------------------------------------------
        // Remove previous css & images directories since they've been relocated to ./assets
        // Also remove uploads directories since they're no longer used
        //----------------------------------------------------------------
        $old_directories = array($xsHelper->path('css/'),
            $xsHelper->path('js/'),
            $xsHelper->path('images/'),
            XOOPS_UPLOAD_PATH . "/" . $module->dirname()
        );
        foreach ($old_directories as $old_dir) {

            $dirInfo = new SplFileInfo($old_dir);
            if ($dirInfo->isDir()) {
                // The directory exists so delete it
                if (false === $utilsClass::rrmdir($old_dir)) {
                    $xoopsModule->setErrors(sprintf(_AM_XSITEMAP_ERROR_BAD_DEL_PATH, $old_dir));

                    return false;
                }
            }
            unset($dirInfo);
        }

        //-----------------------------------------------------------------------
        // Remove ./template/*.html (except index.html) files since they've
        // been replaced by *.tpl files
        // Note: this will also remove /template/xsitemap_style.html since it's no longer used
        //-----------------------------------------------------------------------
        $path       = $xsHelper->path('templates/');
        $unfiltered = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($path));
        $iterator   = new RegexIterator($unfiltered, "/.*\.html/");
        foreach ($iterator as $name => $fObj) {
            if (($fObj->isFile()) && ('index.html' !== $fObj->getFilename())) {
                if (false === ($success = unlink($fObj->getPathname()))) {
                    $xoopsModule->setErrors(sprintf(_AM_XSITEMAP_ERROR_BAD_REMOVE, $fObj->getPathname()));

                    return false;
                }
            }
        }

        //-----------------------------------------------------------------------
        // Now remove a some misc files that were renamed or deprecated
        //-----------------------------------------------------------------------
        $oldFiles = array($xsHelper->path('include/install.php'),
                          $xsHelper->path('class/module.php'),
                          $xsHelper->path('class/menu.php')
        );
        foreach($oldFiles as $file) {
            if (is_file($file)) {
                if (false === ($delOk = unlink($file))) {

                    $module->setErrors(sprintf(_AM_XSITEMAP_ERROR_BAD_REMOVE, $file));
                }
                $success = $success && $delOk;
            }
        }
    }
    return $success;
}

/**
 *
 * Function to perform before module uninstall
 *
 * @param XoopsModule $module
 *
 * @return bool true if successfully executed, false if not
 */
function xoops_module_pre_uninstall_xsitemap($module)

{
    return true;
}

/**
 *
 * Function to complete upon module uninstall
 *
 * @param XoopsModule $module
 *
 * @return bool true if successfully executed uninstall of module, false if not
 */
function xoops_module_uninstall_xsitemap($module)
// 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);
    }
}
{
//    return true;
    $moduleDirName = $module->getVar('dirname');
    $xsHelper = \Xmf\Module\Helper::getHelper($moduleDirName);
    $utilsClass = ucfirst($moduleDirName) . 'Utilities';
    if (!class_exists($utilsClass)) {
        xoops_load('utilities', $moduleDirName);
    }

    $success = true;
    $xsHelper->loadLanguage('admin');

    //------------------------------------------------------------------
    // Remove xSitemap uploads folder (and all subfolders) if they exist
    //------------------------------------------------------------------

    $old_directories = array($GLOBALS['xoops']->path("uploads/{$moduleDirName}"));
    foreach ($old_directories as $old_dir) {

        $dirInfo = new SplFileInfo($old_dir);
        if ($dirInfo->isDir()) {
            // The directory exists so delete it
            if (false === $utilsClass::rrmdir($old_dir)) {
                $module->setErrors(sprintf(_AM_XSITEMAP_ERROR_BAD_DEL_PATH, $old_dir));
                $success = false;
            }
        }
        unset($dirInfo);
    }
    //------------------------------------------------------------------
    // Remove xsitemap.xml from XOOPS root folder if it exists
    //------------------------------------------------------------------
    $xmlfile = $GLOBALS['xoops']->path('xsitemap.xml');
    if (is_file($xmlfile)) {

        if (false === ($delOk = unlink($xmlfile))) {
            $module->setErrors(sprintf(_AM_XSITEMAP_ERROR_BAD_REMOVE, $xmlfile));
        }
    }
    return $success && $delOk;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
}


Pull Request — master (#3)

action.module.php ➔ xoops_module_pre_install_xsitemap() A

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

Available Fixes

1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2017-05-03 02:50 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 42 and the first side effect is on line 31. 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			* Module: xsitemap
13			*
14			* @package module\xsitemap\includes
15			* @author Taiwen Jiang <[email protected]>
16			* @author ZySpec <[email protected]>
17			* @copyright http://xoops.org 2001-2017 XOOPS Project
18			* @license http://www.fsf.org/copyleft/gpl.html GNU public license
19			* @link http://xoops.org XOOPS
20			* @since 1.00
21			*/
22
23			/**
24			* @internal {Make sure you PROTECT THIS FILE}
25			*/
26
27			if ((!defined('XOOPS_ROOT_PATH'))
28			\|\| !($GLOBALS['xoopsUser'] instanceof XoopsUser)
			0 ignored issues – show Bug introduced 2017-05-03 02:50 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...
29			\|\| !($GLOBALS['xoopsUser']->isAdmin()))
30			{
31			exit("Restricted access" . PHP_EOL);
32			}
33
34			/**
35			*
36			* Prepares system prior to attempting to install module
37			*
38			* @param XoopsModule $module

XoopsModules25x / xsitemap

Pull Request — master (#3)

action.module.php ➔ xoops_module_pre_install_xsitemap() A

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

Available Fixes

Duplication Side-by-Side

Filter issues like