XoopsModules\Tdmdownloads\Common\VersionChecks

Complexity

Total Complexity

13

Size/Duplication

Total Lines	100
Duplicated Lines	0 %

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	checkVerXoops()	0	21	4
A	checkVerPhp()	0	17	4
A	checkVerModule()	0	30	5

<?php

namespace XoopsModules\Tdmdownloads\Common;

/*
 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      mamba <mambax7@gmail.com>
 */
trait VersionChecks
{
    /**
     * Verifies XOOPS version meets minimum requirements for this module
     * @static
     * @param \XoopsModule|null $module
     *
     * @param null|string       $requiredVer
     * @return bool true if meets requirements, false if not
     */
    public static function checkVerXoops(\XoopsModule $module = null, $requiredVer = null)
    {
        $moduleDirName = basename(dirname(__DIR__));
        if (null === $module) {
            $module = \XoopsModule::getByDirname($moduleDirName);
        }
        xoops_loadLanguage('admin', $moduleDirName);

        //check for minimum XOOPS version
        $currentVer = mb_substr(XOOPS_VERSION, 6); // get the numeric part of string
        if (null === $requiredVer) {
            $requiredVer = '' . $module->getInfo('min_xoops'); //making sure it's a string

Are you sure $module->getInfo('min_xoops') of type array|string can be used in concatenation?

        }
        $success = true;

        if (version_compare($currentVer, $requiredVer, '<')) {
            $success = false;
            $module->setErrors(sprintf(_AM_WFL_ERROR_BAD_XOOPS, $requiredVer, $currentVer));

The constant XoopsModules\Tdmdownloads\Common\_AM_WFL_ERROR_BAD_XOOPS was not found. Maybe you did not declare it correctly or list all dependencies?

        }

        return $success;
    }

    /**
     * Verifies PHP version meets minimum requirements for this module
     * @static
     * @param \XoopsModule $module
     *
     * @return bool true if meets requirements, false if not
     */
    public static function checkVerPhp(\XoopsModule $module)
    {
        $moduleDirName      = basename(dirname(dirname(__DIR__)));
        $moduleDirNameUpper = mb_strtoupper($moduleDirName);

The assignment to $moduleDirNameUpper is dead and can be removed.

        xoops_loadLanguage('admin', $module->dirname());

It seems like $module->dirname() can also be of type array and array; however, parameter $domain of xoops_loadLanguage() does only seem to accept string, maybe add an additional type check?

        // check for minimum PHP version
        $success = true;
        $verNum  = PHP_VERSION;
        $reqVer  = $module->getInfo('min_php');
        if (false !== $reqVer && '' !== $reqVer) {
            if (version_compare($verNum, $reqVer, '<')) {

It seems like $reqVer can also be of type array; however, parameter $version2 of version_compare() does only seem to accept string, maybe add an additional type check?

                $module->setErrors(sprintf(_AM_WFL_ERROR_BAD_PHP, $reqVer, $verNum));

The constant XoopsModules\Tdmdownloads\Common\_AM_WFL_ERROR_BAD_PHP was not found. Maybe you did not declare it correctly or list all dependencies?

It seems like $reqVer can also be of type array; however, parameter $args of sprintf() does only seem to accept string, maybe add an additional type check?

                $success = false;
            }
        }

        return $success;
    }

    /**
     *
     * compares current module version with latest GitHub release
     * @static
     * @param \Xmf\Module\Helper $helper
     * @param string             $location
     * @param string             $default
     *
     * @return string link to the latest module version, if newer
     */

    public static function checkVerModule($helper, $location = 'github', $default = 'master')
    {
        $moduleDirName = basename(dirname(dirname(__DIR__)));
        $update        = '';
        $repository    = 'XoopsModules25x/' . $moduleDirName;
        //        $repository    = 'XoopsModules25x/publisher'; //uncomment for testing
        $ret = '';

        if ('github' === $location) {
            $file              = @json_decode(@file_get_contents("https://api.github.com/repos/$repository/releases", false, stream_context_create(['http' => ['header' => "User-Agent:Publisher\r\n"]])));
            $latestReleaseLink = sprintf("https://github.com/$repository/archive/%s.zip", $file ? reset($file)->tag_name : $default);
            $latestRelease     = substr(strrchr($latestReleaseLink, "/"), 1, -4);
            if ('master' !== $latestRelease) {
                $update = '<span><strong> Latest Release: </strong>' . '   <a href="' . $latestReleaseLink . '">' . $latestRelease . '</a> </span><br><br>';
            }

            $moduleVersion = round($helper->getConfig('version') / 100, 2);
            //        $moduleVersion = '3.0'; //uncomment for testing

            $ret .= "<div align='center'>";

            //            $ret .= "<a href='https://xoops.org/'><img src='../assets/images/icons/32/xoopsmicrobutton.gif'></a><br>";
            if (version_compare($moduleVersion, $latestRelease, '<')) {
                //                $ret .= "| ";
                $ret .= " <span style='color: #FF0000; font-size:11px' " . 'Latest Release: </span>' . $update . "<a href='https://github.com/XoopsModules25x/$moduleDirName/releases/'>";
                $ret .= "<img src='https://img.shields.io/github/release/XoopsModules25x/$moduleDirName.svg?style=flat'></a>";
            }
        }
        $GLOBALS['xoopsTpl']->assign('latestModRelease', $ret);
        return $ret;
    }
}