LicenseManagementProcessor::pingAction() - Code Metrics - Inspection of "#539 Update modules management page, combine it wi..." - mikopbx/Core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( db553e...8a684e )

by Nikolay

created 2023-06-05 08:35 UTC

LicenseManagementProcessor::pingAction() A

↳ Parent: LicenseManagementProcessor

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	5
c	0
b	0
f	0
dl	0
loc	7
rs	10
cc	1
nc	1
nop	0

<?php
/*
 * MikoPBX - free phone system for small business
 * Copyright © 2017-2023 Alexey Portnov and Nikolay Beketov
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with this program.
 * If not, see <https://www.gnu.org/licenses/>.
 */

namespace MikoPBX\PBXCoreREST\Lib;

use MikoPBX\Common\Models\Extensions;
use MikoPBX\Common\Models\ModelsBase;
use MikoPBX\Common\Models\PbxSettings;
use MikoPBX\Core\System\MikoPBXConfig;
use Phalcon\Di\Injectable;
use Phalcon\Text;
use SimpleXMLElement;


/**
 * Class LicenseManagementProcessor
 *
 * @package MikoPBX\PBXCoreREST\Lib
 * @property \MikoPBX\Common\Providers\LicenseProvider     license
 * @property \MikoPBX\Common\Providers\TranslationProvider translation
 * @property \Phalcon\Config                               config
 */
class LicenseManagementProcessor extends Injectable
{

    /**
     * Process the license callback.
     *
     * @param array $request The request data.
     *
     * @return PBXApiResult An object containing the result of the API call.
     */
    public static function callBack(array $request): PBXApiResult
    {
        $action         = $request['action'];
        $data           = $request['data'];
        $res            = new PBXApiResult();
        $res->processor = __METHOD__;
        switch ($action) {
            case 'resetKey':
                $proc = new LicenseManagementProcessor();
                $res = $proc->resetLicenseAction();
                break;
            case 'processUserRequest':
                $proc = new LicenseManagementProcessor();
                $res = $proc->processUserRequestAction($data);
                break;
            case 'getLicenseInfo':
                $proc = new LicenseManagementProcessor();
                $res = $proc->getLicenseInfoAction();
                break;
            case 'getMikoPBXFeatureStatus':
                $proc = new LicenseManagementProcessor();
                $res = $proc->getMikoPBXFeatureStatusAction();
                break;
            case 'captureFeatureForProductId':
                $proc = new LicenseManagementProcessor();
                $res = $proc->captureFeatureForProductIdAction($data);
                break;
            case 'sendPBXMetrics':
                $proc = new LicenseManagementProcessor();
                $res = $proc->sendMetricsAction();
                break;
            case 'ping':
                $proc = new LicenseManagementProcessor();
                $res = $proc->pingAction();
                break;
            default:
                $res->messages[] = "Unknown action - {$action} in licenseCallBack";
        }

        $res->function = $action;

        return $res;
    }

    /**
     * Reset license key.
     *
     * @return PBXApiResult An object containing the result of the API call.
     */
    private function resetLicenseAction():PBXApiResult
    {
        $mikoPBXConfig = new MikoPBXConfig();
        $res           = new PBXApiResult();
        $res->processor = __METHOD__;
        $mikoPBXConfig->deleteGeneralSettings('PBXLicense');
        $res->success = true;
        $this->license->changeLicenseKey('');
        return $res;
    }

    /**
     * Check and update license key on database.
     *
     * @param array $data
     *
     * @return PBXApiResult An object containing the result of the API call.
     */
    private function processUserRequestAction(array $data): PBXApiResult
    {
        $mikoPBXConfig = new MikoPBXConfig();
        $res           = new PBXApiResult();
        $res->processor = __METHOD__;
        if (strlen($data['licKey']) === 28 && Text::startsWith($data['licKey'], 'MIKO-')) {
            ModelsBase::clearCache(PbxSettings::class);
            $oldLicKey = $mikoPBXConfig->getGeneralSettings('PBXLicense');
            if ($oldLicKey !== $data['licKey']) {
                $licenseInfo = $this->license->getLicenseInfo($data['licKey']);
                if ($licenseInfo instanceof SimpleXMLElement) {
                    $mikoPBXConfig->setGeneralSettings('PBXLicense', $data['licKey']);
                    $this->license->changeLicenseKey($data['licKey']);
                    $this->license->addTrial('11'); // MikoPBX forever license
                    $res->success = true;
                } elseif ( ! empty($licenseInfo) && strpos($licenseInfo, '2026') !== false) {
                    $res->success    = false;
                    $res->messages[] = $this->translation->_('lic_FailedCheckLicense2026');
                } elseif ( ! empty($licenseInfo)) {
                    $res->messages[] = $licenseInfo;
                    $res->success    = false;
                } else {
                    $res->messages[] = $this->translation->_('lic_FailedCheckLicense');
                    $res->success    = false;
                }
            }
            if ( ! empty($data['coupon'])) {
                $result = $this->license->activateCoupon($data['coupon']);
                if ($result === true) {
                    $res->messages[] = $this->translation->_('lic_SuccessfulСuponActivation');
                    $res->success    = true;
                } else {
                    $res->messages[] = $this->license->translateLicenseErrorMessage((string)$result);
                    $res->success    = false;
                }
            }
        } else { // Only add trial for license key
            $newLicenseKey = (string)$this->license->getTrialLicense($data);
            if (strlen($newLicenseKey) === 28
                && Text::startsWith($newLicenseKey, 'MIKO-')) {
                $mikoPBXConfig->setGeneralSettings('PBXLicense', $newLicenseKey);
                $this->license->changeLicenseKey($newLicenseKey);
                $res->success    = true;
                $res->data['PBXLicense'] = $newLicenseKey;
            } else {
                // No internet connection, or wrong data sent to license server, or something else
                $res->messages[] = $this->license->translateLicenseErrorMessage($newLicenseKey);
                $res->success    = false;
            }
        }
        return $res;
    }

    /**
     * Returns license info from license server by key.
     *
     * @return PBXApiResult An object containing the result of the API call.
     */
    private function getLicenseInfoAction(): PBXApiResult
    {
        $res = new PBXApiResult();
        $res->processor = __METHOD__;
        $licenseKey = PbxSettings::getValueByKey('PBXLicense');
        if ((strlen($licenseKey) === 28
            && Text::startsWith($licenseKey, 'MIKO-')
        )) {
            $licenseInfo              = $this->license->getLicenseInfo($licenseKey);
            $res->success             = true;
            $res->data['licenseInfo'] = json_encode($licenseInfo);
        } else {
            $res->messages[] = 'License key is wrong or empty';
        }

        return $res;
    }

    /**
     * Check for free MikoPBX base license.
     *
     * @return PBXApiResult An object containing the result of the API call.
     */
    private function getMikoPBXFeatureStatusAction(): PBXApiResult
    {
        $res = new PBXApiResult();
        $res->processor = __METHOD__;
        $checkBaseFeature = $this->license->featureAvailable(33);
        if ($checkBaseFeature['success'] === false) {
            $res->success = false;
            $textError = (string)($checkBaseFeature['error']??'');
            $res->messages[] = $this->license->translateLicenseErrorMessage($textError);
        } else {
            $res->success = true;
        }
        return $res;
    }

    /**
     * Tries to capture feature.
     *
     * If it fails we try to get trial and then try capture again.
     *
     * @param array $data
     *
     * @return PBXApiResult An object containing the result of the API call.
     */
    private function captureFeatureForProductIdAction(array $data): PBXApiResult
    {
        $res = new PBXApiResult();
        $res->processor = __METHOD__;
        $licFeatureId = $data['licFeatureId'];
        $licProductId = $data['licProductId'];

        if ( ! isset($licFeatureId, $licProductId)) {
            $res->messages[]='The feature id or product id is empty.';
            return $res;
        }
        $res->success = true;
        if ($licFeatureId > 0) {
            // 1.Try to capture feature
            $result = $this->license->captureFeature($licFeatureId);
            if ($result['success'] === false) {
                // Add trial
                $this->license->addTrial($licProductId);
                // 2.Try to capture feature
                $result = $this->license->captureFeature($licFeatureId);
                if ($result['success'] === false) {
                    $textError = (string)($result['error']??'');
                    $res->messages[] = $this->license->translateLicenseErrorMessage($textError);
                    $res->success = false;
                }
            }
        }
        return $res;
    }

    /**
     * Sends PBX metrics to the license server.
     *
     * @return PBXApiResult An object containing the result of the API call.
     */
    private function sendMetricsAction(): PBXApiResult
    {
        $res = new PBXApiResult();
        $res->processor = __METHOD__;
        $res->success= true;

        // License Key
        $licenseKey = PbxSettings::getValueByKey('PBXLicense');

        $dataMetrics = [];

        // PBXVersion
        $dataMetrics['PBXname'] = 'MikoPBX@' . PbxSettings::getValueByKey('PBXVersion');

        // SIP Extensions count
        $extensions                   = Extensions::find('type="'.Extensions::TYPE_SIP.'"');
        $dataMetrics['CountSipExtensions'] = $extensions->count();

        // Interface language
        $dataMetrics['WebAdminLanguage'] = PbxSettings::getValueByKey('WebAdminLanguage');

        // PBX language
        $dataMetrics['PBXLanguage'] = PbxSettings::getValueByKey('PBXLanguage');

        $this->license->sendLicenseMetrics($licenseKey, $dataMetrics);

        return $res;
    }

    /**
     * Sends ping request to the license server.
     *
     * @return PBXApiResult An object containing the result of the API call.
     */
    private function pingAction(): PBXApiResult
    {
        $res = new PBXApiResult();
        $res->processor = __METHOD__;
        $result = $this->license->ping();
        $res->success= $result['success'] === true;
        return $res;
    }
}

1			<?php
2			/*
3			* MikoPBX - free phone system for small business
4			* Copyright © 2017-2023 Alexey Portnov and Nikolay Beketov
5			*
6			* This program is free software: you can redistribute it and/or modify
7			* it under the terms of the GNU General Public License as published by
8			* the Free Software Foundation; either version 3 of the License, or
9			* (at your option) any later version.
10			*
11			* This program is distributed in the hope that it will be useful,
12			* but WITHOUT ANY WARRANTY; without even the implied warranty of
13			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14			* GNU General Public License for more details.
15			*
16			* You should have received a copy of the GNU General Public License along with this program.
17			* If not, see <https://www.gnu.org/licenses/>.
18			*/
19
20			namespace MikoPBX\PBXCoreREST\Lib;
21
22			use MikoPBX\Common\Models\Extensions;
23			use MikoPBX\Common\Models\ModelsBase;
24			use MikoPBX\Common\Models\PbxSettings;
25			use MikoPBX\Core\System\MikoPBXConfig;
26			use Phalcon\Di\Injectable;
27			use Phalcon\Text;
28			use SimpleXMLElement;
29
30
31			/**
32			* Class LicenseManagementProcessor
33			*
34			* @package MikoPBX\PBXCoreREST\Lib
35			* @property \MikoPBX\Common\Providers\LicenseProvider license
36			* @property \MikoPBX\Common\Providers\TranslationProvider translation
37			* @property \Phalcon\Config config
38			*/
39			class LicenseManagementProcessor extends Injectable
40			{
41
42			/**
43			* Process the license callback.
44			*
45			* @param array $request The request data.
46			*
47			* @return PBXApiResult An object containing the result of the API call.
48			*/
49			public static function callBack(array $request): PBXApiResult
50			{
51			$action = $request['action'];
52			$data = $request['data'];
53			$res = new PBXApiResult();
54			$res->processor = __METHOD__;
55			switch ($action) {
56			case 'resetKey':
57			$proc = new LicenseManagementProcessor();
58			$res = $proc->resetLicenseAction();
59			break;
60			case 'processUserRequest':
61			$proc = new LicenseManagementProcessor();
62			$res = $proc->processUserRequestAction($data);
63			break;
64			case 'getLicenseInfo':
65			$proc = new LicenseManagementProcessor();
66			$res = $proc->getLicenseInfoAction();
67			break;
68			case 'getMikoPBXFeatureStatus':
69			$proc = new LicenseManagementProcessor();
70			$res = $proc->getMikoPBXFeatureStatusAction();
71			break;
72			case 'captureFeatureForProductId':
73			$proc = new LicenseManagementProcessor();
74			$res = $proc->captureFeatureForProductIdAction($data);
75			break;
76			case 'sendPBXMetrics':
77			$proc = new LicenseManagementProcessor();
78			$res = $proc->sendMetricsAction();
79			break;
80			case 'ping':
81			$proc = new LicenseManagementProcessor();
82			$res = $proc->pingAction();
83			break;
84			default:
85			$res->messages[] = "Unknown action - {$action} in licenseCallBack";
86			}
87
88			$res->function = $action;
89
90			return $res;
91			}
92
93			/**
94			* Reset license key.
95			*
96			* @return PBXApiResult An object containing the result of the API call.
97			*/
98			private function resetLicenseAction():PBXApiResult
99			{
100			$mikoPBXConfig = new MikoPBXConfig();
101			$res = new PBXApiResult();
102			$res->processor = __METHOD__;
103			$mikoPBXConfig->deleteGeneralSettings('PBXLicense');
104			$res->success = true;
105			$this->license->changeLicenseKey('');
106			return $res;
107			}
108
109			/**
110			* Check and update license key on database.
111			*
112			* @param array $data
113			*
114			* @return PBXApiResult An object containing the result of the API call.
115			*/
116			private function processUserRequestAction(array $data): PBXApiResult
117			{
118			$mikoPBXConfig = new MikoPBXConfig();
119			$res = new PBXApiResult();
120			$res->processor = __METHOD__;
121			if (strlen($data['licKey']) === 28 && Text::startsWith($data['licKey'], 'MIKO-')) {
122			ModelsBase::clearCache(PbxSettings::class);
123			$oldLicKey = $mikoPBXConfig->getGeneralSettings('PBXLicense');
124			if ($oldLicKey !== $data['licKey']) {
125			$licenseInfo = $this->license->getLicenseInfo($data['licKey']);
126			if ($licenseInfo instanceof SimpleXMLElement) {
127			$mikoPBXConfig->setGeneralSettings('PBXLicense', $data['licKey']);
128			$this->license->changeLicenseKey($data['licKey']);
129			$this->license->addTrial('11'); // MikoPBX forever license
130			$res->success = true;
131			} elseif ( ! empty($licenseInfo) && strpos($licenseInfo, '2026') !== false) {
132			$res->success = false;
133			$res->messages[] = $this->translation->_('lic_FailedCheckLicense2026');
134			} elseif ( ! empty($licenseInfo)) {
135			$res->messages[] = $licenseInfo;
136			$res->success = false;
137			} else {
138			$res->messages[] = $this->translation->_('lic_FailedCheckLicense');
139			$res->success = false;
140			}
141			}
142			if ( ! empty($data['coupon'])) {
143			$result = $this->license->activateCoupon($data['coupon']);
144			if ($result === true) {
145			$res->messages[] = $this->translation->_('lic_SuccessfulСuponActivation');
146			$res->success = true;
147			} else {
148			$res->messages[] = $this->license->translateLicenseErrorMessage((string)$result);
149			$res->success = false;
150			}
151			}
152			} else { // Only add trial for license key
153			$newLicenseKey = (string)$this->license->getTrialLicense($data);
154			if (strlen($newLicenseKey) === 28
155			&& Text::startsWith($newLicenseKey, 'MIKO-')) {
156			$mikoPBXConfig->setGeneralSettings('PBXLicense', $newLicenseKey);
157			$this->license->changeLicenseKey($newLicenseKey);
158			$res->success = true;
159			$res->data['PBXLicense'] = $newLicenseKey;
160			} else {
161			// No internet connection, or wrong data sent to license server, or something else
162			$res->messages[] = $this->license->translateLicenseErrorMessage($newLicenseKey);
163			$res->success = false;
164			}
165			}
166			return $res;
167			}
168
169			/**
170			* Returns license info from license server by key.
171			*
172			* @return PBXApiResult An object containing the result of the API call.
173			*/
174			private function getLicenseInfoAction(): PBXApiResult
175			{
176			$res = new PBXApiResult();
177			$res->processor = __METHOD__;
178			$licenseKey = PbxSettings::getValueByKey('PBXLicense');
179			if ((strlen($licenseKey) === 28
180			&& Text::startsWith($licenseKey, 'MIKO-')
181			)) {
182			$licenseInfo = $this->license->getLicenseInfo($licenseKey);
183			$res->success = true;
184			$res->data['licenseInfo'] = json_encode($licenseInfo);
185			} else {
186			$res->messages[] = 'License key is wrong or empty';
187			}
188
189			return $res;
190			}
191
192			/**
193			* Check for free MikoPBX base license.
194			*
195			* @return PBXApiResult An object containing the result of the API call.
196			*/
197			private function getMikoPBXFeatureStatusAction(): PBXApiResult
198			{
199			$res = new PBXApiResult();
200			$res->processor = __METHOD__;
201			$checkBaseFeature = $this->license->featureAvailable(33);
202			if ($checkBaseFeature['success'] === false) {
203			$res->success = false;
204			$textError = (string)($checkBaseFeature['error']??'');
205			$res->messages[] = $this->license->translateLicenseErrorMessage($textError);
206			} else {
207			$res->success = true;
208			}
209			return $res;
210			}
211
212			/**
213			* Tries to capture feature.
214			*
215			* If it fails we try to get trial and then try capture again.
216			*
217			* @param array $data
218			*
219			* @return PBXApiResult An object containing the result of the API call.
220			*/
221			private function captureFeatureForProductIdAction(array $data): PBXApiResult
222			{
223			$res = new PBXApiResult();
224			$res->processor = __METHOD__;
225			$licFeatureId = $data['licFeatureId'];
226			$licProductId = $data['licProductId'];
227
228			if ( ! isset($licFeatureId, $licProductId)) {
229			$res->messages[]='The feature id or product id is empty.';
230			return $res;
231			}
232			$res->success = true;
233			if ($licFeatureId > 0) {
234			// 1.Try to capture feature
235			$result = $this->license->captureFeature($licFeatureId);
236			if ($result['success'] === false) {
237			// Add trial
238			$this->license->addTrial($licProductId);
239			// 2.Try to capture feature
240			$result = $this->license->captureFeature($licFeatureId);
241			if ($result['success'] === false) {
242			$textError = (string)($result['error']??'');
243			$res->messages[] = $this->license->translateLicenseErrorMessage($textError);
244			$res->success = false;
245			}
246			}
247			}
248			return $res;
249			}
250
251			/**
252			* Sends PBX metrics to the license server.
253			*
254			* @return PBXApiResult An object containing the result of the API call.
255			*/
256			private function sendMetricsAction(): PBXApiResult
257			{
258			$res = new PBXApiResult();
259			$res->processor = __METHOD__;
260			$res->success= true;
261
262			// License Key
263			$licenseKey = PbxSettings::getValueByKey('PBXLicense');
264
265			$dataMetrics = [];
266
267			// PBXVersion
268			$dataMetrics['PBXname'] = 'MikoPBX@' . PbxSettings::getValueByKey('PBXVersion');
269
270			// SIP Extensions count
271			$extensions = Extensions::find('type="'.Extensions::TYPE_SIP.'"');
272			$dataMetrics['CountSipExtensions'] = $extensions->count();
273
274			// Interface language
275			$dataMetrics['WebAdminLanguage'] = PbxSettings::getValueByKey('WebAdminLanguage');
276
277			// PBX language
278			$dataMetrics['PBXLanguage'] = PbxSettings::getValueByKey('PBXLanguage');
279
280			$this->license->sendLicenseMetrics($licenseKey, $dataMetrics);
281
282			return $res;
283			}
284
285			/**
286			* Sends ping request to the license server.
287			*
288			* @return PBXApiResult An object containing the result of the API call.
289			*/
290			private function pingAction(): PBXApiResult
291			{
292			$res = new PBXApiResult();
293			$res->processor = __METHOD__;
294			$result = $this->license->ping();
295			$res->success= $result['success'] === true;
296			return $res;
297			}
298			}

mikopbx / Core

Push — develop ( db553e...8a684e )

LicenseManagementProcessor::pingAction() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like