Completed
Push — master ( c5b9c9...4f0041 )
by Goffy
14s queued 12s
created

VersionChecks::checkVerPhp()   B

Complexity

Conditions 6
Paths 6

Size

Total Lines 25

Duplication

Lines 4
Ratio 16 %

Importance

Changes 0
Metric Value
cc 6
nc 6
nop 1
dl 4
loc 25
rs 8.8977
c 0
b 0
f 0
1
<?php
2
3
namespace XoopsModules\Tools\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
use XoopsModule;
16
17
/**
18
 * @copyright   XOOPS Project (https://xoops.org)
19
 * @license     http://www.fsf.org/copyleft/gpl.html GNU public license
20
 * @author      mamba <[email protected]>
21
 */
22
trait VersionChecks
23
{
24
    /**
25
     * Verifies XOOPS version meets minimum requirements for this module
26
     * @static
27
     * @param \XoopsModule|null $module
28
     *
29
     * @param null|string       $requiredVer
30
     * @return bool true if meets requirements, false if not
31
     */
32
    public static function checkVerXoops(XoopsModule $module = null, $requiredVer = null)
33
    {
34
        $moduleDirName      = \basename(\dirname(__DIR__, 2));
35
        $moduleDirNameUpper = \mb_strtoupper($moduleDirName);
36
        if (null === $module) {
37
            $module = XoopsModule::getByDirname($moduleDirName);
38
        }
39
        xoops_loadLanguage('admin', $moduleDirName);
40
        xoops_loadLanguage('common', $moduleDirName);
41
42
        //check for minimum XOOPS version
43
        $currentVer = mb_substr(XOOPS_VERSION, 6); // get the numeric part of string
44
        if (null === $requiredVer) {
45
            $requiredVer = '' . $module->getInfo('min_xoops'); //making sure it's a string
46
        }
47
        $success = true;
48
49 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...
50
            $success = false;
51
            $module->setErrors(sprintf(constant('CO_' . $moduleDirNameUpper . '_ERROR_BAD_XOOPS'), $requiredVer, $currentVer));
52
        }
53
54
        return $success;
55
    }
56
57
    /**
58
     * Verifies PHP version meets minimum requirements for this module
59
     * @static
60
     * @param \XoopsModule|null $module
61
     *
62
     * @return bool true if meets requirements, false if not
63
     */
64
    public static function checkVerPhp(XoopsModule $module = null)
65
    {
66
        $moduleDirName      = \basename(\dirname(__DIR__, 2));
67
        $moduleDirNameUpper = \mb_strtoupper($moduleDirName);
68
        if (null === $module) {
69
            $module = XoopsModule::getByDirname($moduleDirName);
70
        }
71
        xoops_loadLanguage('admin', $moduleDirName);
72
        xoops_loadLanguage('common', $moduleDirName);
73
74
        // check for minimum PHP version
75
        $success = true;
76
77
        $verNum = PHP_VERSION;
78
        $reqVer = &$module->getInfo('min_php');
79
80
        if (false !== $reqVer && '' !== $reqVer && !is_array($reqVer)) {
81 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...
82
                $module->setErrors(sprintf(constant('CO_' . $moduleDirNameUpper . '_ERROR_BAD_PHP'), $reqVer, $verNum));
83
                $success = false;
84
            }
85
        }
86
87
        return $success;
88
    }
89
90
    /**
91
     *
92
     * compares current module version with latest GitHub release
93
     * @static
94
     * @param \Xmf\Module\Helper $helper
95
     * @param string|null        $source
96
     * @param string|null        $default
97
     *
98
     * @return string|array info about the latest module version, if newer
99
     */
100
101
    public static function checkVerModule($helper, $source = 'github', $default = 'master')
102
    {
103
        $moduleDirName      = \basename(\dirname(__DIR__, 2));
104
        $moduleDirNameUpper = \mb_strtoupper($moduleDirName);
105
        $update             = '';
106
        $repository         = 'XoopsModules25x/' . $moduleDirName;
107
        //        $repository         = 'XoopsModules25x/publisher'; //for testing only
108
        $ret             = '';
109
        $infoReleasesUrl = "https://api.github.com/repos/$repository/releases";
110
        if ('github' === $source) {
111
            if (function_exists('curl_init') && false !== ($curlHandle = curl_init())) {
112
                curl_setopt($curlHandle, CURLOPT_URL, $infoReleasesUrl);
113
                curl_setopt($curlHandle, CURLOPT_RETURNTRANSFER, true);
114
                curl_setopt($curlHandle, CURLOPT_SSL_VERIFYPEER, true); //TODO: how to avoid an error when 'Peer's Certificate issuer is not recognized'
115
                curl_setopt($curlHandle, CURLOPT_HTTPHEADER, ["User-Agent:Publisher\r\n"]);
116
                $curlReturn = curl_exec($curlHandle);
117
                if (false === $curlReturn) {
118
                    trigger_error(curl_error($curlHandle));
119
                } elseif (false !== strpos($curlReturn, 'Not Found')) {
120
                    trigger_error('Repository Not Found: ' . $infoReleasesUrl);
121
                } else {
122
                    $file              = json_decode($curlReturn, false);
123
                    $latestVersionLink = sprintf("https://github.com/$repository/archive/%s.zip", $file ? reset($file)->tag_name : $default);
124
                    $latestVersion     = $file[0]->tag_name;
125
                    $prerelease        = $file[0]->prerelease;
126
                    if ('master' !== $latestVersionLink) {
127
                        $update = constant('CO_' . $moduleDirNameUpper . '_' . 'NEW_VERSION') . $latestVersion;
128
                    }
129
                    //"PHP-standardized" version
130
                    $latestVersion = mb_strtolower($latestVersion);
131
                    if (false !== mb_strpos($latestVersion, 'final')) {
132
                        $latestVersion = str_replace('_', '', mb_strtolower($latestVersion));
133
                        $latestVersion = str_replace('final', '', mb_strtolower($latestVersion));
134
                    }
135
                    $moduleVersion = ($helper->getModule()->getInfo('version') . '_' . $helper->getModule()->getInfo('module_status'));
136
                    //"PHP-standardized" version
137
                    $moduleVersion = str_replace(' ', '', mb_strtolower($moduleVersion));
138
                    //                    $moduleVersion = '1.0'; //for testing only
139
                    //                    $moduleDirName = 'publisher'; //for testing only
140
                    if (!$prerelease && version_compare($moduleVersion, $latestVersion, '<')) {
141
                        $ret   = [];
142
                        $ret[] = $update;
143
                        $ret[] = $latestVersionLink;
144
                    }
145
                }
146
                curl_close($curlHandle);
147
            }
148
        }
149
        return $ret;
150
    }
151
}
152