1
|
|
|
<?php declare(strict_types=1); |
2
|
|
|
|
3
|
|
|
namespace XoopsModules\Xoopsheadline\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 https://www.fsf.org/copyleft/gpl.html GNU public license |
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, '<')) { |
|
|
|
|
78
|
|
|
$module->setErrors(\sprintf(\constant('CO_' . $moduleDirNameUpper . '_ERROR_BAD_PHP'), $reqVer, $verNum)); |
|
|
|
|
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 = 'github', ?string $default = 'master'): ?array |
91
|
|
|
{ |
92
|
|
|
$moduleDirName = \basename(\dirname(__DIR__, 2)); |
93
|
|
|
$moduleDirNameUpper = \mb_strtoupper($moduleDirName); |
94
|
|
|
$update = ''; |
95
|
|
|
$repository = 'XoopsModules25x/' . $moduleDirName; |
96
|
|
|
/** @internal Developer Note: set repository to development github site for testing |
97
|
|
|
* uncomment out following line to test development repository |
98
|
|
|
* $repository = 'XoopsModules25x/publisher'; //for testing only |
99
|
|
|
*/ |
100
|
|
|
$ret = null; |
101
|
|
|
$infoReleasesUrl = "https://api.github.com/repos/$repository/releases"; |
102
|
|
|
if ('github' === $source) { |
103
|
|
|
if (\function_exists('curl_init') && false !== ($curlHandle = \curl_init())) { |
104
|
|
|
\curl_setopt($curlHandle, \CURLOPT_URL, $infoReleasesUrl); |
105
|
|
|
\curl_setopt($curlHandle, \CURLOPT_RETURNTRANSFER, true); |
106
|
|
|
\curl_setopt($curlHandle, \CURLOPT_SSL_VERIFYPEER, true); //TODO: how to avoid an error when 'Peer's Certificate issuer is not recognized' |
107
|
|
|
\curl_setopt($curlHandle, \CURLOPT_HTTPHEADER, ["User-Agent:Publisher\r\n"]); |
108
|
|
|
$curlReturn = \curl_exec($curlHandle); |
109
|
|
|
if (false === $curlReturn) { |
110
|
|
|
\trigger_error(\curl_error($curlHandle)); |
111
|
|
|
} elseif (\is_string($curlReturn) && false !== \mb_strpos($curlReturn, 'Not Found')) { |
112
|
|
|
\trigger_error(\constant('CO_' . $moduleDirNameUpper . '_' . 'REPO_NOT_FOUND') . $infoReleasesUrl); |
113
|
|
|
} elseif (\is_string($curlReturn)) { |
114
|
|
|
$file = json_decode($curlReturn, false); |
115
|
|
|
if (empty($file)) { |
116
|
|
|
\trigger_error(\constant('CO_' . $moduleDirNameUpper . '_' . 'NO_REL_FOUND') . $infoReleasesUrl); |
117
|
|
|
} else { |
118
|
|
|
$latestVersionLink = \sprintf("https://github.com/$repository/archive/%s.zip", $file ? \reset($file)->tag_name : $default); |
119
|
|
|
$latestVersion = $file[0]->tag_name; |
120
|
|
|
$prerelease = $file[0]->prerelease; |
121
|
|
|
if ('master' !== $latestVersionLink) { |
122
|
|
|
$update = \constant('CO_' . $moduleDirNameUpper . '_' . 'NEW_VERSION') . $latestVersion; |
123
|
|
|
} |
124
|
|
|
//"PHP-standardized" version |
125
|
|
|
$latestVersion = \mb_strtolower($latestVersion); |
126
|
|
|
if (false !== mb_strpos($latestVersion, 'final')) { |
127
|
|
|
$latestVersion = \str_replace('_', '', \mb_strtolower($latestVersion)); |
128
|
|
|
$latestVersion = \str_replace('final', '', \mb_strtolower($latestVersion)); |
129
|
|
|
} |
130
|
|
|
$moduleVersion = ($helper->getModule()->getInfo('version') . '_' . $helper->getModule()->getInfo('module_status')); |
|
|
|
|
131
|
|
|
//"PHP-standardized" version |
132
|
|
|
$moduleVersion = \str_replace(' ', '', \mb_strtolower($moduleVersion)); |
133
|
|
|
// $moduleVersion = '1.0'; //for testing only |
134
|
|
|
// $moduleDirName = 'publisher'; //for testing only |
135
|
|
|
if (!$prerelease && \version_compare($moduleVersion, $latestVersion, '<')) { |
136
|
|
|
$ret = []; |
137
|
|
|
$ret[] = $update; |
138
|
|
|
$ret[] = $latestVersionLink; |
139
|
|
|
} |
140
|
|
|
} |
141
|
|
|
} |
142
|
|
|
\curl_close($curlHandle); |
143
|
|
|
} |
144
|
|
|
} |
145
|
|
|
|
146
|
|
|
return $ret; |
147
|
|
|
} |
148
|
|
|
} |
149
|
|
|
|