VersionChecks   A
last analyzed

Complexity

Total Complexity 22

Size/Duplication

Total Lines 119
Duplicated Lines 0 %

Importance

Changes 2
Bugs 0 Features 0
Metric Value
eloc 67
c 2
b 0
f 0
dl 0
loc 119
rs 10
wmc 22

3 Methods

Rating   Name   Duplication   Size   Complexity  
A checkVerXoops() 0 23 4
A checkVerPhp() 0 24 5
C checkVerModule() 0 52 13
1
<?php declare(strict_types=1);
2
3
namespace XoopsModules\Xoopsfaq\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     GNU GPL 2.0 or later (https://www.gnu.org/licenses/gpl-2.0.html)
18
 * @author      mamba <[email protected]>
19
 */
20
21
use Xmf\Module\Helper;
22
23
trait VersionChecks
24
{
25
    /**
26
     * Verifies XOOPS version meets minimum requirements for this module
27
     * @static
28
     */
29
    public static function checkVerXoops(?\XoopsModule $module = null, ?string $requiredVer = null): bool
30
    {
31
        $moduleDirName      = \basename(\dirname(__DIR__, 2));
32
        $moduleDirNameUpper = \mb_strtoupper($moduleDirName);
33
        if (null === $module) {
34
            $module = \XoopsModule::getByDirname($moduleDirName);
35
        }
36
        \xoops_loadLanguage('admin', $moduleDirName);
37
        \xoops_loadLanguage('common', $moduleDirName);
38
39
        //check for minimum XOOPS version
40
        $currentVer = \mb_substr(\XOOPS_VERSION, 6); // get the numeric part of string
41
        if (null === $requiredVer) {
42
            $requiredVer = (string)$module->getInfo('min_xoops'); //making sure it's a string
43
        }
44
        $success = true;
45
46
        if (\version_compare($currentVer, $requiredVer, '<')) {
47
            $success = false;
48
            $module->setErrors(\sprintf(\constant('CO_' . $moduleDirNameUpper . '_' . 'ERROR_BAD_XOOPS'), $requiredVer, $currentVer));
49
        }
50
51
        return $success;
52
    }
53
54
    /**
55
     * Verifies PHP version meets minimum requirements for this module
56
     * @static
57
     *
58
     * @return bool true if meets requirements, false if not
59
     */
60
    public static function checkVerPhp(?\XoopsModule $module = null): bool
61
    {
62
        $moduleDirName      = \basename(\dirname(__DIR__, 2));
63
        $moduleDirNameUpper = \mb_strtoupper($moduleDirName);
64
        if (null === $module) {
65
            $module = \XoopsModule::getByDirname($moduleDirName);
66
        }
67
        \xoops_loadLanguage('admin', $moduleDirName);
68
        \xoops_loadLanguage('common', $moduleDirName);
69
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
     */
90
    public static function checkVerModule(Helper $helper, ?string $source = null, ?string $default = null): ?array
91
    {
92
        $source             ??= 'github';
93
        $default            ??= 'master';
94
        $moduleDirName      = \basename(\dirname(__DIR__, 2));
95
        $moduleDirNameUpper = \mb_strtoupper($moduleDirName);
96
        $update             = '';
97
        $repository         = 'XoopsModules25x/' . $moduleDirName;
98
        //        $repository         = 'XoopsModules25x/publisher'; //for testing only
99
        $ret             = null;
100
        $infoReleasesUrl = "https://api.github.com/repos/$repository/releases";
101
        if ('github' === $source) {
102
            if (\function_exists('curl_init') && false !== ($curlHandle = \curl_init())) {
103
                \curl_setopt($curlHandle, \CURLOPT_URL, $infoReleasesUrl);
104
                \curl_setopt($curlHandle, \CURLOPT_RETURNTRANSFER, true);
105
                \curl_setopt($curlHandle, \CURLOPT_SSL_VERIFYPEER, true); //TODO: how to avoid an error when 'Peer's Certificate issuer is not recognized'
106
                \curl_setopt($curlHandle, \CURLOPT_HTTPHEADER, ["User-Agent:Publisher\r\n"]);
107
                $curlReturn = \curl_exec($curlHandle);
108
                if (false === $curlReturn) {
109
                    \trigger_error(\curl_error($curlHandle));
110
                } elseif (\is_string($curlReturn) && false !== \mb_strpos($curlReturn, 'Not Found')) {
111
                    \trigger_error('Repository Not Found: ' . $infoReleasesUrl);
112
                } elseif (\is_string($curlReturn)) {
113
                    $file              = \json_decode($curlReturn, false);
114
                    $latestVersionLink = \sprintf("https://github.com/$repository/archive/%s.zip", $file ? \reset($file)->tag_name : $default);
115
                    $latestVersion     = $file[0]->tag_name;
116
                    $prerelease        = $file[0]->prerelease;
117
                    if ('master' !== $latestVersionLink) {
118
                        $update = \constant('CO_' . $moduleDirNameUpper . '_' . 'NEW_VERSION') . $latestVersion;
119
                    }
120
                    //"PHP-standardized" version
121
                    $latestVersion = \mb_strtolower($latestVersion);
122
                    if (false !== mb_strpos($latestVersion, 'final')) {
123
                        $latestVersion = \str_replace('_', '', \mb_strtolower($latestVersion));
124
                        $latestVersion = \str_replace('final', '', \mb_strtolower($latestVersion));
125
                    }
126
                    $moduleVersion = ($helper->getModule()->getInfo('version') . '_' . $helper->getModule()->getInfo('module_status'));
0 ignored issues
show
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

126
                    $moduleVersion = (/** @scrutinizer ignore-type */ $helper->getModule()->getInfo('version') . '_' . $helper->getModule()->getInfo('module_status'));
Loading history...
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

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