Completed
Push — master ( d1a68a...39bb73 )
by Michael
01:32
created

VersionChecks::checkVerModule()   B

Complexity

Conditions 11
Paths 12

Size

Total Lines 50

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 11
nc 12
nop 3
dl 0
loc 50
rs 7.3166
c 0
b 0
f 0

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\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     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
     * @param \XoopsModule|null $module
26
     *
27
     * @param null|string       $requiredVer
28
     * @return bool true if meets requirements, false if not
29
     */
30
    public static function checkVerXoops(\XoopsModule $module = null, $requiredVer = null)
31
    {
32
        $moduleDirName      = basename(dirname(dirname(__DIR__)));
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
44
        }
45
        $success = true;
46
47 View Code Duplication
        if (version_compare($currentVer, $requiredVer, '<')) {
0 ignored issues
show
Duplication introduced by
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...
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
     * @param \XoopsModule|null $module
59
     *
60
     * @return bool true if meets requirements, false if not
61
     */
62
    public static function checkVerPhp(\XoopsModule $module = null)
63
    {
64
        $moduleDirName      = basename(dirname(dirname(__DIR__)));
65
        $moduleDirNameUpper = mb_strtoupper($moduleDirName);
66
        if (null === $module) {
67
            $module = \XoopsModule::getByDirname($moduleDirName);
68
        }
69
        xoops_loadLanguage('admin', $moduleDirName);
70
        xoops_loadLanguage('common', $moduleDirName);
71
72
        // check for minimum PHP version
73
        $success = true;
74
75
        $verNum = PHP_VERSION;
76
        $reqVer = &$module->getInfo('min_php');
77
78
        if (false !== $reqVer && '' !== $reqVer && !is_array($reqVer)) {
79 View Code Duplication
            if (version_compare($verNum, $reqVer, '<')) {
0 ignored issues
show
Duplication introduced by
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...
80
                $module->setErrors(sprintf(constant('CO_' . $moduleDirNameUpper . '_ERROR_BAD_PHP'), $reqVer, $verNum));
81
                $success = false;
82
            }
83
        }
84
85
        return $success;
86
    }
87
88
    /**
89
     *
90
     * compares current module version with latest GitHub release
91
     * @static
92
     * @param \Xmf\Module\Helper $helper
93
     * @param string|null        $source
94
     * @param string|null        $default
95
     *
96
     * @return string|array info about the latest module version, if newer
97
     */
98
99
    public static function checkVerModule($helper, $source = 'github', $default = 'master')
100
    {
101
        $moduleDirName      = basename(dirname(dirname(__DIR__)));
102
        $moduleDirNameUpper = mb_strtoupper($moduleDirName);
103
        $update             = '';
104
        $repository         = 'XoopsModules25x/' . $moduleDirName;
105
        //        $repository         = 'XoopsModules25x/publisher'; //for testing only
106
        $ret             = '';
107
        $infoReleasesUrl = "https://api.github.com/repos/$repository/releases";
108
        if ('github' === $source) {
109
            if (function_exists('curl_init') && false !== ($curlHandle = curl_init())) {
110
                curl_setopt($curlHandle, CURLOPT_URL, $infoReleasesUrl);
111
                curl_setopt($curlHandle, CURLOPT_RETURNTRANSFER, true);
112
                curl_setopt($curlHandle, CURLOPT_SSL_VERIFYPEER, false);
113
                curl_setopt($curlHandle, CURLOPT_HTTPHEADER, ["User-Agent:Publisher\r\n"]);
114
                $curlReturn = curl_exec($curlHandle);
115
                if (false === $curlReturn) {
116
                    trigger_error(curl_error($curlHandle));
117
                } elseif (false !== strpos($curlReturn, 'Not Found')) {
118
                    trigger_error('Repository Not Found: ' . $infoReleasesUrl);
119
                } else {
120
                    $file              = json_decode($curlReturn, false);
121
                    $latestVersionLink = sprintf("https://github.com/$repository/archive/%s.zip", $file ? reset($file)->tag_name : $default);
122
                    $latestVersion     = $file[0]->tag_name;
123
                    $prerelease        = $file[0]->prerelease;
124
                    if ('master' !== $latestVersionLink) {
125
                        $update = constant('CO_' . $moduleDirNameUpper . '_' . 'NEW_VERSION') . $latestVersion;
126
                    }
127
                    //"PHP-standardized" version
128
                    $latestVersion = mb_strtolower($latestVersion);
129
                    if (false !== mb_strpos($latestVersion, 'final')) {
130
                        $latestVersion = str_replace('_', '', mb_strtolower($latestVersion));
131
                        $latestVersion = str_replace('final', '', mb_strtolower($latestVersion));
132
                    }
133
                    $moduleVersion = ($helper->getModule()->getInfo('version') . '_' . $helper->getModule()->getInfo('module_status'));
134
                    //"PHP-standardized" version
135
                    $moduleVersion = str_replace(' ', '', mb_strtolower($moduleVersion));
136
                    //                    $moduleVersion = '1.0'; //for testing only
137
                    //                    $moduleDirName = 'publisher'; //for testing only
138
                    if (!$prerelease && version_compare($moduleVersion, $latestVersion, '<')) {
139
                        $ret   = [];
140
                        $ret[] = $update;
141
                        $ret[] = $latestVersionLink;
142
                    }
143
                }
144
                curl_close($curlHandle);
145
            }
146
        }
147
        return $ret;
148
    }
149
}
150