PbxExtensionState::makeBeforeEnableTest() - Code Metrics - Inspection of "Merge branch 'develop' of https://github.com/mikop..." - mikopbx/Core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( b7c00c...da1f69 )

by Nikolay

created 2020-11-17 14:13 UTC

PbxExtensionState::makeBeforeEnableTest() C

↳ Parent: PbxExtensionState

Complexity

Conditions	17
Paths	84

Size

Total Lines	90
Code Lines	50

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
eloc	50
c	2
b	0
f	0
dl	0
loc	90
rs	5.2166
cc	17
nc	84
nop	0

How to fix Long Method Complexity

<?php
/**
 * Copyright (C) MIKO LLC - All Rights Reserved
 * Unauthorized copying of this file, via any medium is strictly prohibited
 * Proprietary and confidential
 * Written by Nikolay Beketov, 5 2020
 *
 */

namespace MikoPBX\Modules;


use MikoPBX\Common\Models\FirewallRules;
use MikoPBX\Common\Models\NetworkFilters;
use MikoPBX\Common\Models\PbxExtensionModules;
use MikoPBX\Common\Models\PbxSettings;
use MikoPBX\Core\System\Configs\NginxConf;
use MikoPBX\Core\System\Configs\IptablesConf;
use MikoPBX\Core\System\Processes;
use MikoPBX\Core\System\Util;
use PDOException;
use Phalcon\Di\Injectable;
use ReflectionClass;
use ReflectionException;
use Throwable;

/**
 * @property \MikoPBX\Service\License license
 *
 */
class PbxExtensionState extends Injectable
{
    private array $messages;
    private $lic_feature_id;
    private string $moduleUniqueID;
    private $configClass;
    private $modulesRoot;


    public function __construct(string $moduleUniqueID)
    {
        $this->messages       = [];
        $this->moduleUniqueID = $moduleUniqueID;
        $this->modulesRoot    = $this->getDI()->getShared('config')->path('core.modulesDir');
        $moduleJson           = "{$this->modulesRoot}/{$this->moduleUniqueID}/module.json";
        if ( ! file_exists($moduleJson)) {
            $this->messages[] = 'module.json not found for module ' . $this->moduleUniqueID;

            return;
        }

        $jsonString            = file_get_contents($moduleJson);
        $jsonModuleDescription = json_decode($jsonString, true);
        if ( ! is_array($jsonModuleDescription)) {
            $this->messages[] = 'module.json parsing error ' . $this->moduleUniqueID;

            return;
        }

        if (array_key_exists('lic_feature_id', $jsonModuleDescription)) {
            $this->lic_feature_id = $jsonModuleDescription['lic_feature_id'];
        } else {
            $this->lic_feature_id = 0;
        }
        $this->reloadConfigClass();
    }

    /**
     * Recreates module's ClassNameConf class
     */
    private function reloadConfigClass(): void
    {
        $class_name      = str_replace('Module', '', $this->moduleUniqueID);
        $configClassName = "\\Modules\\{$this->moduleUniqueID}\\Lib\\{$class_name}Conf";
        if (class_exists($configClassName)) {
            $this->configClass = new $configClassName();
        } else {
            $this->configClass = null;
        }
    }

    /**
     * Enable extension module with checking relations
     *
     */
    public function enableModule(): bool
    {
        if ($this->lic_feature_id > 0) {
            // Try to capture feature if it set
            $result = $this->license->featureAvailable($this->lic_feature_id);
            if ($result['success'] === false) {
                $this->messages[] = $this->license->translateLicenseErrorMessage($result['error']);

                return false;
            }
        }
        $success = $this->makeBeforeEnableTest();
        if ( ! $success) {
            return false;
        }

        $this->reloadConfigClass();
        // Если ошибок нет, включаем Firewall и модуль
        if ( ! $this->enableFirewallSettings()) {
            $this->messages[] = 'Error on enable firewall settings';

            return false;
        }
        if ($this->configClass !== null
            && method_exists($this->configClass, 'onBeforeModuleEnable')) {
            $this->configClass->onBeforeModuleEnable();
        }
        $module = PbxExtensionModules::findFirstByUniqid($this->moduleUniqueID);
        if ($module !== null) {
            $module->disabled = '0';
            $module->save();
        }

        if ($this->configClass !== null
            && method_exists($this->configClass, 'onAfterModuleEnable')) {
            $this->configClass->onAfterModuleEnable();
        }

        if ($this->configClass !== null
            && method_exists($this->configClass, 'getMessages')) {
            $this->messages = array_merge($this->messages, $this->configClass->getMessages());
        }

        // Restart Nginx if module has locations
        $this->refreshNginxLocations();

        // Reconfigure fail2ban and restart iptables
        $this->refreshFail2BanRules();


        return true;
    }

    /**
     * При включении модуля устанавливает настройки Firewall по-умолчаниию
     * или по состоянию на момент выключения
     *
     * @return bool
     */
    protected function enableFirewallSettings(): bool
    {
        if ($this->configClass === null
            || method_exists($this->configClass, 'getDefaultFirewallRules') === false
            || $this->configClass->getDefaultFirewallRules() === []
        ) {
            return true;
        }

        $this->db->begin(true);
        $defaultRules         = $this->configClass->getDefaultFirewallRules();
        $previousRuleSettings = PbxSettings::findFirstByKey("{$this->moduleUniqueID}FirewallSettings");
        $previousRules        = [];
        if ($previousRuleSettings !== null) {
            $previousRules = json_decode($previousRuleSettings->value, true);
            $previousRuleSettings->delete();
        }
        $errors   = [];
        $networks = NetworkFilters::find();
        $key      = strtoupper(key($defaultRules));
        $record   = $defaultRules[key($defaultRules)];

        $oldRules = FirewallRules::findByCategory($key);
        if ($oldRules->count() > 0) {
            $oldRules->delete();
        }

        foreach ($networks as $network) {
            foreach ($record['rules'] as $detailRule) {
                $newRule                  = new FirewallRules();
                $newRule->networkfilterid = $network->id;
                $newRule->protocol        = $detailRule['protocol'];
                $newRule->portfrom        = $detailRule['portfrom'];
                $newRule->portto          = $detailRule['portto'];
                $newRule->category        = $key;
                $newRule->action          = $record['action'];
                $newRule->description     = $detailRule['name'];
                if (array_key_exists($network->id, $previousRules)) {
                    $newRule->action = $previousRules[$network->id];
                }
                if ( ! $newRule->save()) {
                    $this->messages[] = $newRule->getMessages();
                }
            }
        }
        if (count($errors) > 0) {
            $this->messages[] = array_merge($this->messages, $errors);
            $this->db->rollback(true);

            return false;
        }

        $this->db->commit(true);

        return true;
    }

    /**
     * If module has additional locations we will generate it until next reboot
     *
     *
     * @return void
     */
    private function refreshNginxLocations(): void
    {
        if ($this->configClass !== null
            && method_exists($this->configClass, 'createNginxLocations')
            && ! empty($this->configClass->createNginxLocations())) {
            $nginxConf = new NginxConf();
            $nginxConf->generateModulesConf();
            $nginxConf->reStart();
        }
    }

    /**
     * If module has additional fail2ban rules we will generate it until next reboot
     *
     *
     * @return void
     */
    private function refreshFail2BanRules(): void
    {
        if ($this->configClass !== null
            && method_exists($this->configClass, 'generateFail2BanJails')
            && ! empty($this->configClass->generateFail2BanJails())) {
            IptablesConf::reloadFirewall();
        }
    }

    /**
     * Disable extension module with checking relations
     *
     */
    public function disableModule(): bool
    {
        $success = $this->makeBeforeDisableTest();
        if ( ! $success) {
            return false;
        }
        $this->reloadConfigClass();
        // Если ошибок нет, выключаем Firewall и модуль
        if ( ! $this->disableFirewallSettings()) {
            $this->messages[] = 'Error on disable firewall settings';

            return false;
        }
        if ($this->configClass !== null
            && method_exists($this->configClass, 'onBeforeModuleDisable')) {
            $this->configClass->onBeforeModuleDisable();
        }
        $module = PbxExtensionModules::findFirstByUniqid($this->moduleUniqueID);
        if ($module !== null) {
            $module->disabled = '1';
            $module->save();
        }

        if ($this->configClass !== null
            && method_exists($this->configClass, 'onAfterModuleDisable')) {
            $this->configClass->onAfterModuleDisable();
        }

        if ($this->configClass !== null
            && method_exists($this->configClass, 'getMessages')) {
            $this->messages = array_merge($this->messages, $this->configClass->getMessages());
        }

        // Reconfigure fail2ban and restart iptables
        $this->refreshFail2BanRules();

        // Refresh Nginx conf if module has any locations
        $this->refreshNginxLocations();

        // Kill module workers
        if ($this->configClass !== null
            && method_exists($this->configClass, 'getModuleWorkers')) {
            $workersToKill = $this->configClass->getModuleWorkers();
            foreach ($workersToKill as $moduleWorker) {
                Processes::killByName($moduleWorker['worker']);
            }
        }

        return true;
    }

    /**
     * Makes before disable test to check dependency
     *
     * @return bool
     */
    private function makeBeforeDisableTest(): bool
    {
        // Проверим, нет ли настроенных зависимостей у других модулей
        // Попробуем удалить все настройки модуля
        $this->db->begin(true);
        $success = true;

        if ($this->configClass !== null
            && method_exists($this->configClass, 'onBeforeModuleDisable')
            && $this->configClass->onBeforeModuleDisable() === false) {
            $messages = $this->configClass->getMessages();
            if ( ! empty($messages)) {
                $this->messages = $messages;
            } else {
                $this->messages[] = 'Error on the Module enable function at onBeforeModuleDisable';
            }
            $this->db->rollback(true); // Откатываем временную транзакцию

            return false;
        }

        // Попытаемся удалить текущий модуль, если ошибок не будет, значит можно выклчать
        // Например на модуль может ссылаться запись в таблице Extensions, которую надо удалить при отключении
        // модуля
        $modelsFiles = glob("{$this->modulesRoot}/{$this->moduleUniqueID}/Models/*.php", GLOB_NOSORT);
        foreach ($modelsFiles as $file) {
            $className        = pathinfo($file)['filename'];
            $moduleModelClass = "\\Modules\\{$this->moduleUniqueID}\\Models\\{$className}";
            try {
                if ( ! class_exists($moduleModelClass)) {
                    continue;
                }
                $reflection = new ReflectionClass($moduleModelClass);
                if ($reflection->isAbstract()) {
                    continue;
                }
                if (count($reflection->getProperties()) === 0) {
                    continue;
                }
                $records = $moduleModelClass::find();
                foreach ($records as $record) {
                    if ( ! $record->beforeDelete()) {
                        foreach ($record->getMessages() as $message) {
                            $this->messages[] = $message->getMessage();
                        }
                        $success = false;
                    }
                }
            } catch (Throwable $exception) {
                $this->messages[] = $exception->getMessage();
                $success          = false;
            }
        }
        if ($success) {
            $this->messages = [];
        }

        // Откатываем временную транзакцию
        $this->db->rollback(true);

        return $success;
    }

    /**
     * При выключении модуля сбрасывает настройки Firewall
     * и сохраняет параметры для будущего включения
     *
     *
     * @return bool
     */
    protected function disableFirewallSettings(): bool
    {
        if ($this->configClass === null
            || method_exists($this->configClass, 'getDefaultFirewallRules') === false
            || $this->configClass->getDefaultFirewallRules() === []
        ) {
            return true;
        }
        $errors       = [];
        $savedState   = [];
        $defaultRules = $this->configClass->getDefaultFirewallRules();
        $key          = strtoupper(key($defaultRules));
        $currentRules = FirewallRules::findByCategory($key);
        foreach ($currentRules as $detailRule) {
            $savedState[$detailRule->networkfilterid] = $detailRule->action;
        }
        $this->db->begin(true);
        if ( ! $currentRules->delete()) {
            $this->messages[] = $currentRules->getMessages();

            return false;
        }

        $previousRuleSettings = PbxSettings::findFirstByKey("{$this->moduleUniqueID}FirewallSettings");
        if ($previousRuleSettings === null) {
            $previousRuleSettings      = new PbxSettings();
            $previousRuleSettings->key = "{$this->moduleUniqueID}FirewallSettings";
        }
        $previousRuleSettings->value = json_encode($savedState);
        if ( ! $previousRuleSettings->save()) {
            $this->messages[] = $previousRuleSettings->getMessages();
        }
        if (count($errors) > 0) {
            $this->messages[] = array_merge($this->messages, $errors);
            $this->db->rollback(true);

            return false;
        }

        $this->db->commit(true);

        return true;
    }

    /**
     * Return messages after function or methods execution
     *
     * @return array
     */
    public function getMessages(): array
    {
        return $this->messages;
    }

    /**
     * Makes before enable test to check dependency
     *
     * @return bool
     */
    private function makeBeforeEnableTest(): bool
    {
        $success = true;
        // Temporary transaction, we will rollback it after checks
        $this->db->begin(true);

        // Временно включим модуль, чтобы включить все связи и зависимости
        // Temporary disable module and disable all links
        $module = PbxExtensionModules::findFirstByUniqid($this->moduleUniqueID);
        if ($module !== null) {
            $module->disabled = '0';
            $module->save();
        }

        // Если в конфигурационном классе модуля есть функция корректного включения, вызовем ее,
        // например модуль умной маршртутизации прописывает себя в маршруты
        //
        // If module config has special function before enable, we will execute it

        if ($this->configClass !== null
            && method_exists($this->configClass, 'onBeforeModuleEnable')
            && $this->configClass->onBeforeModuleEnable() === false) {
            $messages = $this->configClass->getMessages();
            if ( ! empty($messages)) {
                $this->messages = $messages;
            } else {
                $this->messages[] = 'Error on the enableModule function at onBeforeModuleEnable';
            }
            $this->db->rollback(true); // Откатываем временную транзакцию

            return false;
        }

        // Проверим нет ли битых ссылок, которые мешают включить модуль
        // например удалили сотрудника, а модуль указывает на его extension
        //
        $modelsFiles = glob("{$this->modulesRoot}/{$this->moduleUniqueID}/Models/*.php", GLOB_NOSORT);
        $translator  = $this->di->getShared('translation');
        foreach ($modelsFiles as $file) {
            $className        = pathinfo($file)['filename'];
            $moduleModelClass = "\\Modules\\{$this->moduleUniqueID}\\Models\\{$className}";

            try {
                if ( ! class_exists($moduleModelClass)) {
                    continue;
                }
                $reflection = new ReflectionClass($moduleModelClass);
                if ($reflection->isAbstract()) {
                    continue;
                }
                if (count($reflection->getProperties()) === 0) {
                    continue;
                }
                $records = $moduleModelClass::find();
                foreach ($records as $record) {
                    $relations = $record->_modelsManager->getRelations(get_class($record));
                    foreach ($relations as $relation) {
                        $alias        = $relation->getOption('alias');
                        $checkedValue = $record->$alias;
                        $foreignKey   = $relation->getOption('foreignKey');
                        // В модуле указан заперт на NULL в описании модели,
                        // а параметр этот не заполнен в настройках модуля
                        // например в модуле маршрутизации, резервный номер
                        if ($checkedValue === false
                            && array_key_exists('allowNulls', $foreignKey)
                            && $foreignKey['allowNulls'] === false
                        ) {
                            $this->messages[] = $translator->_(
                                'mo_ModuleSettingsError',
                                [
                                    'modulename' => $record->getRepresent(true),
                                ]
                            );
                            $success          = false;
                        }
                    }
                }
            } catch (Throwable $exception) {
                $this->messages[] = $exception->getMessage();
                $success          = false;
            }
        }
        if ($success) {
            $this->messages = [];
        }

        // Откатываем временную транзакцию
        $this->db->rollback(true);

        return $success;
    }

}

1			<?php
2			/**
3			* Copyright (C) MIKO LLC - All Rights Reserved
4			* Unauthorized copying of this file, via any medium is strictly prohibited
5			* Proprietary and confidential
6			* Written by Nikolay Beketov, 5 2020
7			*
8			*/
9
10			namespace MikoPBX\Modules;
11
12
13			use MikoPBX\Common\Models\FirewallRules;
14			use MikoPBX\Common\Models\NetworkFilters;
15			use MikoPBX\Common\Models\PbxExtensionModules;
16			use MikoPBX\Common\Models\PbxSettings;
17			use MikoPBX\Core\System\Configs\NginxConf;
18			use MikoPBX\Core\System\Configs\IptablesConf;
19			use MikoPBX\Core\System\Processes;
20			use MikoPBX\Core\System\Util;
21			use PDOException;
22			use Phalcon\Di\Injectable;
23			use ReflectionClass;
24			use ReflectionException;
25			use Throwable;
26
27			/**
28			* @property \MikoPBX\Service\License license
29			*
30			*/
31			class PbxExtensionState extends Injectable
32			{
33			private array $messages;
34			private $lic_feature_id;
35			private string $moduleUniqueID;
36			private $configClass;
37			private $modulesRoot;
38
39
40			public function __construct(string $moduleUniqueID)
41			{
42			$this->messages = [];
43			$this->moduleUniqueID = $moduleUniqueID;
44			$this->modulesRoot = $this->getDI()->getShared('config')->path('core.modulesDir');
45			$moduleJson = "{$this->modulesRoot}/{$this->moduleUniqueID}/module.json";
46			if ( ! file_exists($moduleJson)) {
47			$this->messages[] = 'module.json not found for module ' . $this->moduleUniqueID;
48
49			return;
50			}
51
52			$jsonString = file_get_contents($moduleJson);
53			$jsonModuleDescription = json_decode($jsonString, true);
54			if ( ! is_array($jsonModuleDescription)) {
55			$this->messages[] = 'module.json parsing error ' . $this->moduleUniqueID;
56
57			return;
58			}
59
60			if (array_key_exists('lic_feature_id', $jsonModuleDescription)) {
61			$this->lic_feature_id = $jsonModuleDescription['lic_feature_id'];
62			} else {
63			$this->lic_feature_id = 0;
64			}
65			$this->reloadConfigClass();
66			}
67
68			/**
69			* Recreates module's ClassNameConf class
70			*/
71			private function reloadConfigClass(): void
72			{
73			$class_name = str_replace('Module', '', $this->moduleUniqueID);
74			$configClassName = "\\Modules\\{$this->moduleUniqueID}\\Lib\\{$class_name}Conf";
75			if (class_exists($configClassName)) {
76			$this->configClass = new $configClassName();
77			} else {
78			$this->configClass = null;
79			}
80			}
81
82			/**
83			* Enable extension module with checking relations
84			*
85			*/
86			public function enableModule(): bool
87			{
88			if ($this->lic_feature_id > 0) {
89			// Try to capture feature if it set
90			$result = $this->license->featureAvailable($this->lic_feature_id);
91			if ($result['success'] === false) {
92			$this->messages[] = $this->license->translateLicenseErrorMessage($result['error']);
93
94			return false;
95			}
96			}
97			$success = $this->makeBeforeEnableTest();
98			if ( ! $success) {
99			return false;
100			}
101
102			$this->reloadConfigClass();
103			// Если ошибок нет, включаем Firewall и модуль
104			if ( ! $this->enableFirewallSettings()) {
105			$this->messages[] = 'Error on enable firewall settings';
106
107			return false;
108			}
109			if ($this->configClass !== null
110			&& method_exists($this->configClass, 'onBeforeModuleEnable')) {
111			$this->configClass->onBeforeModuleEnable();
112			}
113			$module = PbxExtensionModules::findFirstByUniqid($this->moduleUniqueID);
114			if ($module !== null) {
115			$module->disabled = '0';
116			$module->save();
117			}
118
119			if ($this->configClass !== null
120			&& method_exists($this->configClass, 'onAfterModuleEnable')) {
121			$this->configClass->onAfterModuleEnable();
122			}
123
124			if ($this->configClass !== null
125			&& method_exists($this->configClass, 'getMessages')) {
126			$this->messages = array_merge($this->messages, $this->configClass->getMessages());
127			}
128
129			// Restart Nginx if module has locations
130			$this->refreshNginxLocations();
131
132			// Reconfigure fail2ban and restart iptables
133			$this->refreshFail2BanRules();
134
135
136			return true;
137			}
138
139			/**
140			* При включении модуля устанавливает настройки Firewall по-умолчаниию
141			* или по состоянию на момент выключения
142			*
143			* @return bool
144			*/
145			protected function enableFirewallSettings(): bool
146			{
147			if ($this->configClass === null
148			\|\| method_exists($this->configClass, 'getDefaultFirewallRules') === false
149			\|\| $this->configClass->getDefaultFirewallRules() === []
150			) {
151			return true;
152			}
153
154			$this->db->begin(true);
155			$defaultRules = $this->configClass->getDefaultFirewallRules();
156			$previousRuleSettings = PbxSettings::findFirstByKey("{$this->moduleUniqueID}FirewallSettings");
157			$previousRules = [];
158			if ($previousRuleSettings !== null) {
159			$previousRules = json_decode($previousRuleSettings->value, true);
160			$previousRuleSettings->delete();
161			}
162			$errors = [];
163			$networks = NetworkFilters::find();
164			$key = strtoupper(key($defaultRules));
165			$record = $defaultRules[key($defaultRules)];
166
167			$oldRules = FirewallRules::findByCategory($key);
168			if ($oldRules->count() > 0) {
169			$oldRules->delete();
170			}
171
172			foreach ($networks as $network) {
173			foreach ($record['rules'] as $detailRule) {
174			$newRule = new FirewallRules();
175			$newRule->networkfilterid = $network->id;
176			$newRule->protocol = $detailRule['protocol'];
177			$newRule->portfrom = $detailRule['portfrom'];
178			$newRule->portto = $detailRule['portto'];
179			$newRule->category = $key;
180			$newRule->action = $record['action'];
181			$newRule->description = $detailRule['name'];
182			if (array_key_exists($network->id, $previousRules)) {
183			$newRule->action = $previousRules[$network->id];
184			}
185			if ( ! $newRule->save()) {
186			$this->messages[] = $newRule->getMessages();
187			}
188			}
189			}
190			if (count($errors) > 0) {
191			$this->messages[] = array_merge($this->messages, $errors);
192			$this->db->rollback(true);
193
194			return false;
195			}
196
197			$this->db->commit(true);
198
199			return true;
200			}
201
202			/**
203			* If module has additional locations we will generate it until next reboot
204			*
205			*
206			* @return void
207			*/
208			private function refreshNginxLocations(): void
209			{
210			if ($this->configClass !== null
211			&& method_exists($this->configClass, 'createNginxLocations')
212			&& ! empty($this->configClass->createNginxLocations())) {
213			$nginxConf = new NginxConf();
214			$nginxConf->generateModulesConf();
215			$nginxConf->reStart();
216			}
217			}
218
219			/**
220			* If module has additional fail2ban rules we will generate it until next reboot
221			*
222			*
223			* @return void
224			*/
225			private function refreshFail2BanRules(): void
226			{
227			if ($this->configClass !== null
228			&& method_exists($this->configClass, 'generateFail2BanJails')
229			&& ! empty($this->configClass->generateFail2BanJails())) {
230			IptablesConf::reloadFirewall();
231			}
232			}
233
234			/**
235			* Disable extension module with checking relations
236			*
237			*/
238			public function disableModule(): bool
239			{
240			$success = $this->makeBeforeDisableTest();
241			if ( ! $success) {
242			return false;
243			}
244			$this->reloadConfigClass();
245			// Если ошибок нет, выключаем Firewall и модуль
246			if ( ! $this->disableFirewallSettings()) {
247			$this->messages[] = 'Error on disable firewall settings';
248
249			return false;
250			}
251			if ($this->configClass !== null
252			&& method_exists($this->configClass, 'onBeforeModuleDisable')) {
253			$this->configClass->onBeforeModuleDisable();
254			}
255			$module = PbxExtensionModules::findFirstByUniqid($this->moduleUniqueID);
256			if ($module !== null) {
257			$module->disabled = '1';
258			$module->save();
259			}
260
261			if ($this->configClass !== null
262			&& method_exists($this->configClass, 'onAfterModuleDisable')) {
263			$this->configClass->onAfterModuleDisable();
264			}
265
266			if ($this->configClass !== null
267			&& method_exists($this->configClass, 'getMessages')) {
268			$this->messages = array_merge($this->messages, $this->configClass->getMessages());
269			}
270
271			// Reconfigure fail2ban and restart iptables
272			$this->refreshFail2BanRules();
273
274			// Refresh Nginx conf if module has any locations
275			$this->refreshNginxLocations();
276
277			// Kill module workers
278			if ($this->configClass !== null
279			&& method_exists($this->configClass, 'getModuleWorkers')) {
280			$workersToKill = $this->configClass->getModuleWorkers();
281			foreach ($workersToKill as $moduleWorker) {
282			Processes::killByName($moduleWorker['worker']);
283			}
284			}
285
286			return true;
287			}
288
289			/**
290			* Makes before disable test to check dependency
291			*
292			* @return bool
293			*/
294			private function makeBeforeDisableTest(): bool
295			{
296			// Проверим, нет ли настроенных зависимостей у других модулей
297			// Попробуем удалить все настройки модуля
298			$this->db->begin(true);
299			$success = true;
300
301			if ($this->configClass !== null
302			&& method_exists($this->configClass, 'onBeforeModuleDisable')
303			&& $this->configClass->onBeforeModuleDisable() === false) {
304			$messages = $this->configClass->getMessages();
305			if ( ! empty($messages)) {
306			$this->messages = $messages;
307			} else {
308			$this->messages[] = 'Error on the Module enable function at onBeforeModuleDisable';
309			}
310			$this->db->rollback(true); // Откатываем временную транзакцию
311
312			return false;
313			}
314
315			// Попытаемся удалить текущий модуль, если ошибок не будет, значит можно выклчать
316			// Например на модуль может ссылаться запись в таблице Extensions, которую надо удалить при отключении
317			// модуля
318			$modelsFiles = glob("{$this->modulesRoot}/{$this->moduleUniqueID}/Models/*.php", GLOB_NOSORT);
319			foreach ($modelsFiles as $file) {
320			$className = pathinfo($file)['filename'];
321			$moduleModelClass = "\\Modules\\{$this->moduleUniqueID}\\Models\\{$className}";
322			try {
323			if ( ! class_exists($moduleModelClass)) {
324			continue;
325			}
326			$reflection = new ReflectionClass($moduleModelClass);
327			if ($reflection->isAbstract()) {
328			continue;
329			}
330			if (count($reflection->getProperties()) === 0) {
331			continue;
332			}
333			$records = $moduleModelClass::find();
334			foreach ($records as $record) {
335			if ( ! $record->beforeDelete()) {
336			foreach ($record->getMessages() as $message) {
337			$this->messages[] = $message->getMessage();
338			}
339			$success = false;
340			}
341			}
342			} catch (Throwable $exception) {
343			$this->messages[] = $exception->getMessage();
344			$success = false;
345			}
346			}
347			if ($success) {
348			$this->messages = [];
349			}
350
351			// Откатываем временную транзакцию
352			$this->db->rollback(true);
353
354			return $success;
355			}
356
357			/**
358			* При выключении модуля сбрасывает настройки Firewall
359			* и сохраняет параметры для будущего включения
360			*
361			*
362			* @return bool
363			*/
364			protected function disableFirewallSettings(): bool
365			{
366			if ($this->configClass === null
367			\|\| method_exists($this->configClass, 'getDefaultFirewallRules') === false
368			\|\| $this->configClass->getDefaultFirewallRules() === []
369			) {
370			return true;
371			}
372			$errors = [];
373			$savedState = [];
374			$defaultRules = $this->configClass->getDefaultFirewallRules();
375			$key = strtoupper(key($defaultRules));
376			$currentRules = FirewallRules::findByCategory($key);
377			foreach ($currentRules as $detailRule) {
378			$savedState[$detailRule->networkfilterid] = $detailRule->action;
379			}
380			$this->db->begin(true);
381			if ( ! $currentRules->delete()) {
382			$this->messages[] = $currentRules->getMessages();
383
384			return false;
385			}
386
387			$previousRuleSettings = PbxSettings::findFirstByKey("{$this->moduleUniqueID}FirewallSettings");
388			if ($previousRuleSettings === null) {
389			$previousRuleSettings = new PbxSettings();
390			$previousRuleSettings->key = "{$this->moduleUniqueID}FirewallSettings";
391			}
392			$previousRuleSettings->value = json_encode($savedState);
393			if ( ! $previousRuleSettings->save()) {
394			$this->messages[] = $previousRuleSettings->getMessages();
395			}
396			if (count($errors) > 0) {
397			$this->messages[] = array_merge($this->messages, $errors);
398			$this->db->rollback(true);
399
400			return false;
401			}
402
403			$this->db->commit(true);
404
405			return true;
406			}
407
408			/**
409			* Return messages after function or methods execution
410			*
411			* @return array
412			*/
413			public function getMessages(): array
414			{
415			return $this->messages;
416			}
417
418			/**
419			* Makes before enable test to check dependency
420			*
421			* @return bool
422			*/
423			private function makeBeforeEnableTest(): bool
424			{
425			$success = true;
426			// Temporary transaction, we will rollback it after checks
427			$this->db->begin(true);
428
429			// Временно включим модуль, чтобы включить все связи и зависимости
430			// Temporary disable module and disable all links
431			$module = PbxExtensionModules::findFirstByUniqid($this->moduleUniqueID);
432			if ($module !== null) {
433			$module->disabled = '0';
434			$module->save();
435			}
436
437			// Если в конфигурационном классе модуля есть функция корректного включения, вызовем ее,
438			// например модуль умной маршртутизации прописывает себя в маршруты
439			//
440			// If module config has special function before enable, we will execute it
441
442			if ($this->configClass !== null
443			&& method_exists($this->configClass, 'onBeforeModuleEnable')
444			&& $this->configClass->onBeforeModuleEnable() === false) {
445			$messages = $this->configClass->getMessages();
446			if ( ! empty($messages)) {
447			$this->messages = $messages;
448			} else {
449			$this->messages[] = 'Error on the enableModule function at onBeforeModuleEnable';
450			}
451			$this->db->rollback(true); // Откатываем временную транзакцию
452
453			return false;
454			}
455
456			// Проверим нет ли битых ссылок, которые мешают включить модуль
457			// например удалили сотрудника, а модуль указывает на его extension
458			//
459			$modelsFiles = glob("{$this->modulesRoot}/{$this->moduleUniqueID}/Models/*.php", GLOB_NOSORT);
460			$translator = $this->di->getShared('translation');
461			foreach ($modelsFiles as $file) {
462			$className = pathinfo($file)['filename'];
463			$moduleModelClass = "\\Modules\\{$this->moduleUniqueID}\\Models\\{$className}";
464
465			try {
466			if ( ! class_exists($moduleModelClass)) {
467			continue;
468			}
469			$reflection = new ReflectionClass($moduleModelClass);
470			if ($reflection->isAbstract()) {
471			continue;
472			}
473			if (count($reflection->getProperties()) === 0) {
474			continue;
475			}
476			$records = $moduleModelClass::find();
477			foreach ($records as $record) {
478			$relations = $record->_modelsManager->getRelations(get_class($record));
479			foreach ($relations as $relation) {
480			$alias = $relation->getOption('alias');
481			$checkedValue = $record->$alias;
482			$foreignKey = $relation->getOption('foreignKey');
483			// В модуле указан заперт на NULL в описании модели,
484			// а параметр этот не заполнен в настройках модуля
485			// например в модуле маршрутизации, резервный номер
486			if ($checkedValue === false
487			&& array_key_exists('allowNulls', $foreignKey)
488			&& $foreignKey['allowNulls'] === false
489			) {
490			$this->messages[] = $translator->_(
491			'mo_ModuleSettingsError',
492			[
493			'modulename' => $record->getRepresent(true),
494			]
495			);
496			$success = false;
497			}
498			}
499			}
500			} catch (Throwable $exception) {
501			$this->messages[] = $exception->getMessage();
502			$success = false;
503			}
504			}
505			if ($success) {
506			$this->messages = [];
507			}
508
509			// Откатываем временную транзакцию
510			$this->db->rollback(true);
511
512			return $success;
513			}
514
515			}

mikopbx / Core

Push — develop ( b7c00c...da1f69 )

PbxExtensionState::makeBeforeEnableTest() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like