VersionChecks::checkVerModule()   B
last analyzed

Complexity

Conditions 11
Paths 12

Size

Total Lines 50
Code Lines 36

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 11
eloc 36
c 1
b 0
f 0
nc 12
nop 3
dl 0
loc 50
rs 7.3166

How to fix   Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
3
namespace XoopsModules\Wgfilemanager\Common;
4
5
/*
6
 You may not change or alter any portion of this comment or credits
7
 of supporting developers from this source code or any supporting source code
8
 which is considered copyrighted (c) material of the original comment or credit authors.
9
10
 This program is distributed in the hope that it will be useful,
11
 but WITHOUT ANY WARRANTY; without even the implied warranty of
12
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13
 */
14
15
/**
16
 * @copyright   XOOPS Project (https://xoops.org)
17
 * @license     http://www.fsf.org/copyleft/gpl.html GNU public license
18
 * @author      mamba <[email protected]>
19
 */
20
trait VersionChecks
21
{
22
    /**
23
     * Verifies XOOPS version meets minimum requirements for this module
24
     * @static
25
     *
26
     * @param \XoopsModule|null $module
27
     * @param null|string $requiredVer
28
     * @return bool true if meets requirements, false if not
29
     */
30
     public static function checkVerXoops(?\XoopsModule $module = null, ?string $requiredVer = null): bool
31
    {
32
        $moduleDirName      = \basename(\dirname(__DIR__, 2));
33
        $moduleDirNameUpper = \mb_strtoupper($moduleDirName);
34
        if (null === $module) {
35
            $module = \XoopsModule::getByDirname($moduleDirName);
36
        }
37
        \xoops_loadLanguage('admin', $moduleDirName);
38
        \xoops_loadLanguage('common', $moduleDirName);
39
40
        //check for minimum XOOPS version
41
        $currentVer = mb_substr(\XOOPS_VERSION, 6); // get the numeric part of string
42
        if (null === $requiredVer) {
43
            $requiredVer = '' . $module->getInfo('min_xoops'); //making sure it's a string
0 ignored issues
show
Bug introduced by
Are you sure $module->getInfo('min_xoops') of type array|string can be used in concatenation? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

43
            $requiredVer = '' . /** @scrutinizer ignore-type */ $module->getInfo('min_xoops'); //making sure it's a string
Loading history...
44
        }
45
        $success = true;
46
47
        if ($module->versionCompare($currentVer, $requiredVer, '<')) {
48
            $success = false;
49
            $module->setErrors(\sprintf(\constant('CO_' . $moduleDirNameUpper . '_ERROR_BAD_XOOPS'), $requiredVer, $currentVer));
50
        }
51
52
        return $success;
53
    }
54
55
    /**
56
     * Verifies PHP version meets minimum requirements for this module
57
     * @static
58
     *
59
     * @param \XoopsModule|null $module
60
     * @return bool true if meets requirements, false if not
61
     */
62
    public static function checkVerPhp(?\XoopsModule $module = null): bool
63
    {
64
        $moduleDirName      = \basename(\dirname(__DIR__, 2));
65
        $moduleDirNameUpper = \mb_strtoupper($moduleDirName);
66
        if (null === $module) {
67
            $module = \XoopsModule::getByDirname($moduleDirName);
68
        }
69
        \xoops_loadLanguage('admin', $moduleDirName);
70
        // check for minimum PHP version
71
        $success = true;
72
73
        $verNum = \PHP_VERSION;
74
        $reqVer = &$module->getInfo('min_php');
75
76
        if (false !== $reqVer && '' !== $reqVer) {
77
            if (\version_compare($verNum, $reqVer, '<')) {
0 ignored issues
show
Bug introduced by
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? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

77
            if (\version_compare($verNum, /** @scrutinizer ignore-type */ $reqVer, '<')) {
Loading history...
78
                $module->setErrors(\sprintf(\constant('CO_' . $moduleDirNameUpper . '_ERROR_BAD_PHP'), $reqVer, $verNum));
0 ignored issues
show
Bug introduced by
It seems like $reqVer can also be of type array; however, parameter $values of sprintf() does only seem to accept double|integer|string, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

78
                $module->setErrors(\sprintf(\constant('CO_' . $moduleDirNameUpper . '_ERROR_BAD_PHP'), /** @scrutinizer ignore-type */ $reqVer, $verNum));
Loading history...
79
                $success = false;
80
            }
81
        }
82
83
        return $success;
84
    }
85
86
    /**
87
     * compares current module version with the latest GitHub release
88
     * @static
89
     * @param \Xmf\Module\Helper $helper
90
     * @param string|null        $source
91
     * @param string|null        $default
92
     *
93
     * @return string|array info about the latest module version, if newer
94
     */
95
    public static function checkVerModule(\Xmf\Module\Helper $helper, ?string $source = 'github', ?string $default = 'master'): ?array
96
    {
97
        $moduleDirName      = \basename(\dirname(__DIR__, 2));
98
        $moduleDirNameUpper = \mb_strtoupper($moduleDirName);
99
        $update             = '';
100
        $repository         = 'XoopsModules25x/' . $moduleDirName;
101
        //        $repository         = 'XoopsModules25x/publisher'; //for testing only
102
        $ret             = null;
103
        $infoReleasesUrl = "https://api.github.com/repos/$repository/releases";
104
        if ('github' === $source) {
105
            if (\function_exists('curl_init') && false !== ($curlHandle = \curl_init())) {
106
                \curl_setopt($curlHandle, \CURLOPT_URL, $infoReleasesUrl);
107
                \curl_setopt($curlHandle, \CURLOPT_RETURNTRANSFER, true);
108
                \curl_setopt($curlHandle, \CURLOPT_SSL_VERIFYPEER, false);
109
                \curl_setopt($curlHandle, \CURLOPT_HTTPHEADER, ["User-Agent:Publisher\r\n"]);
110
                $curlReturn = \curl_exec($curlHandle);
111
                if (false === $curlReturn) {
112
                    \trigger_error(\curl_error($curlHandle));
113
                } elseif (\mb_strpos($curlReturn, 'Not Found')) {
0 ignored issues
show
Bug introduced by
It seems like $curlReturn can also be of type true; however, parameter $haystack of mb_strpos() does only seem to accept string, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

113
                } elseif (\mb_strpos(/** @scrutinizer ignore-type */ $curlReturn, 'Not Found')) {
Loading history...
114
                    \trigger_error('Repository Not Found: ' . $infoReleasesUrl);
115
                } else {
116
                    $file              = \json_decode($curlReturn, false);
0 ignored issues
show
Bug introduced by
It seems like $curlReturn can also be of type true; however, parameter $json of json_decode() does only seem to accept string, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

116
                    $file              = \json_decode(/** @scrutinizer ignore-type */ $curlReturn, false);
Loading history...
117
                    $latestVersionLink = \sprintf("https://github.com/$repository/archive/%s.zip", $file ? \reset($file)->tag_name : $default);
118
                    $latestVersion     = $file[0]->tag_name;
119
                    $prerelease        = $file[0]->prerelease;
120
                    if ('master' !== $latestVersionLink) {
121
                        $update = \constant('CO_' . $moduleDirNameUpper . '_' . 'NEW_VERSION') . $latestVersion;
122
                    }
123
                    //"PHP-standardized" version
124
                    $latestVersion = \mb_strtolower($latestVersion);
125
                    if (false !== \mb_strpos($latestVersion, 'final')) {
126
                        $latestVersion = \str_replace('_', '', \mb_strtolower($latestVersion));
127
                        $latestVersion = \str_replace('final', '', \mb_strtolower($latestVersion));
128
                    }
129
                    $moduleVersion = ($helper->getModule()->getInfo('version') . '_' . $helper->getModule()->getInfo('module_status'));
0 ignored issues
show
Bug introduced by
Are you sure $helper->getModule()->getInfo('module_status') of type array|string can be used in concatenation? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

129
                    $moduleVersion = ($helper->getModule()->getInfo('version') . '_' . /** @scrutinizer ignore-type */ $helper->getModule()->getInfo('module_status'));
Loading history...
Bug introduced by
Are you sure $helper->getModule()->getInfo('version') of type array|string can be used in concatenation? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

129
                    $moduleVersion = (/** @scrutinizer ignore-type */ $helper->getModule()->getInfo('version') . '_' . $helper->getModule()->getInfo('module_status'));
Loading history...
130
                    //"PHP-standardized" version
131
                    $moduleVersion = \str_replace(' ', '', \mb_strtolower($moduleVersion));
132
                    //                    $moduleVersion = '1.0'; //for testing only
133
                    //                    $moduleDirName = 'publisher'; //for testing only
134
                    if (!$prerelease && \version_compare($moduleVersion, $latestVersion, '<')) {
135
                        $ret   = [];
136
                        $ret[] = $update;
137
                        $ret[] = $latestVersionLink;
138
                    }
139
                }
140
                \curl_close($curlHandle);
141
            }
142
        }
143
144
        return $ret;
145
    }
146
}
147