System::reloadMenus() - Code Metrics - Inspection of "Improved YetiForce CLI" - YetiForceCompany/YetiForceCRM - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — developer ( 495154...c1b806 )

by Mariusz

created 2023-06-30 11:07 UTC

System::reloadMenus() A

↳ Parent: System

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	4
c	1
b	0
f	0
dl	0
loc	6
rs	10
cc	2
nc	2
nop	0

<?php
/**
 * System cli file.
 *
 * @package Cli
 *
 * @copyright YetiForce S.A.
 * @license   YetiForce Public License 5.0 (licenses/LicenseEN.txt or yetiforce.com)
 * @author    Mariusz Krzaczkowski <[email protected]>
 */

namespace App\Cli;

/**
 * System cli class.
 */
class System extends Base
{
	/** {@inheritdoc} */
	public $moduleName = 'System';

	/** @var string[] Methods list */
	public $methods = [
		'history' => 'History of uploaded updates',
		'update' => 'Update',
		'checkRegStatus' => 'Check registration status',
		'deleteRegistration' => 'Delete registration data',
		'showProducts' => 'Show active products',
		'reloadModule' => 'Reload modules',
		'reloadUserPrivileges' => 'Reload users privileges',
		'reloadMenus' => 'Reload menus',
	];

	/**
	 * History of uploaded updates.
	 *
	 * @return void
	 */
	public function history(): void
	{
		$table = array_map(function ($item) {
			$item['result'] = $item['result'] ? 'OK' : 'Error';
			unset($item['id']);
			return $item;
		}, \Settings_Updates_Module_Model::getUpdates());
		if ($table) {

			$this->climate->table($table);
		} else {
			$this->climate->lightGreen('No updates');
		}
		if (!$this->climate->arguments->defined('action')) {
			$this->cli->actionsList('System');
		}
	}

	/**
	 * Update CRM.
	 *
	 * @return void
	 */
	public function update(): void
	{
		$maxExecutionTime = ini_get('max_execution_time');
		if ($maxExecutionTime < 1 || $maxExecutionTime > 600) {
			$this->climate->lightGreen('Max execution time = ' . $maxExecutionTime);
		} else {
			$this->climate->lightRed('Max execution time = ' . $maxExecutionTime);
		}
		$this->climate->arguments->add([
			'type' => [
				'prefix' => 't',
				'description' => 'Update type. Values: patches, version',
			],
		]);
		if ($this->helpMode) {
			return;
		}
		$this->climate->arguments->parse();
		if ($this->climate->arguments->defined('type')) {
			$this->updateByType($this->climate->arguments->get('type'));
		} else {
			$this->updateBySelect();
		}
	}

	/**
	 * Update by package type.
	 *
	 * @param string $type Package type. Values: patches, version
	 *
	 * @return void
	 */
	private function updateByType(string $type): void
	{
		$types = ['patches', 'version'];
		if (!\in_array($this->climate->arguments->get('type'), $types)) {
			$this->climate->white('Type not found. Allowed types:')->columns($types);
			return;
		}
		$versionUpdate = 'version' === $type;
		foreach (\App\YetiForce\Updater::getToInstall() as $package) {
			$versionCompare = $package['fromVersion'] !== $package['toVersion'];
			if (($versionCompare && !$versionUpdate) || (!$versionCompare && $versionUpdate)) {
				continue;
			}
			if (!\App\YetiForce\Updater::isDownloaded($package)) {
				$this->climate->inline($package['label'] . ' - Downloading a package ...');
				\App\YetiForce\Updater::download($package);
				$this->climate->out('- downloaded');
			}
			$this->updateByPackage($package);
		}
	}

	/**
	 * Update by selecting a package.
	 *
	 * @return void
	 */
	private function updateBySelect(): void
	{
		$options = [];
		$toInstall = \App\YetiForce\Updater::getToInstall();
		foreach ($toInstall as $package) {
			$option = "{$package['label']}";
			if ($package['fromVersion'] !== $package['toVersion']) {
				$option .= " ({$package['fromVersion']} >> {$package['toVersion']})";
			}
			if (\App\YetiForce\Updater::isDownloaded($package)) {
				$option .= ' - Downloaded, ready to install';
			} else {
				$option .= ' - To download';
			}
			$options[$package['hash']] = $option;
		}
		if (!$options) {
			$this->climate->lightBlue('No updates available');
			return;
		}
		$input = $this->climate->radio('Updates available:', $options);
		$hash = $input->prompt();
		foreach ($toInstall as $package) {
			if ($package['hash'] === $hash) {
				if (\App\YetiForce\Updater::isDownloaded($package)) {
					$this->updateByPackage($package);
				} else {
					\App\YetiForce\Updater::download($package);
					$this->update();
				}
				return;
			}
		}
	}

	/**
	 * Update package.
	 *
	 * @param array $package
	 *
	 * @return void
	 */
	private function updateByPackage(array $package): void
	{
		$startTime = microtime(true);
		try {
			$packageInstance = new \vtlib\Package();
			$this->climate->white($package['label'] . ' - Installing the package');
			$path = ROOT_DIRECTORY . \DIRECTORY_SEPARATOR . \Settings_ModuleManager_Module_Model::getUploadDirectory() . \DIRECTORY_SEPARATOR . $package['hash'] . '.zip';
			$response = $packageInstance->import($path, true);
			if ($packageInstance->_errorText) {
				$this->climate->lightRed($packageInstance->_errorText);
			} else {
				echo $response . PHP_EOL;
				unlink($path);
			}
		} catch (\Throwable $th) {
			$this->climate->lightRed($th->__toString());
		}
		$this->climate->lightBlue('Total time: ' . round(microtime(true) - $startTime, 2));
	}

	/**
	 * Check registration status.
	 *
	 * @return void
	 */
	public function checkRegStatus(): void
	{
		\App\YetiForce\Register::check(true);
		$this->climate->bold('Status: ' . \App\Language::translate(\App\YetiForce\Register::STATUS_MESSAGES[\App\YetiForce\Register::getStatus()], 'Settings::Companies'));
		$this->climate->border('─', 200);
		$this->climate->bold('APP ID: ' . \App\YetiForce\Register::getInstanceKey());
		$this->climate->border('─', 200);
		$this->climate->bold('CRM ID: ' . \App\YetiForce\Register::getCrmKey());
		$this->climate->border('─', 200);
		$this->climate->bold('Provider: ' . \App\YetiForce\Register::getProvider());
		$this->climate->border('─', 200);
		$table = [];
		foreach (\App\Company::getAll() as $row) {
			$table[] = [
				'name' => $row['name'],
				'status' => $row['status'],
				'type' => $row['type'],
				'companysize' => $row['companysize'],
				'vat_id' => $row['vat_id'],
			];
		}
		$this->climate->table($table);
		$this->climate->border('─', 200);
		if (!$this->climate->arguments->defined('action')) {
			$this->cli->actionsList('System');
		}
	}

	/**
	 * Show active products.
	 *
	 * @return void
	 */
	public function showProducts(): void
	{
		$table = [];
		foreach (\App\YetiForce\Register::getProducts() as $row) {
			$row['params'] = \App\Utils::varExport($row['params']);
			$table[] = $row;
		}
		$table ? $this->climate->table($table) : $this->climate->bold('None');
		$this->climate->border('─', 200);
		if (!$this->climate->arguments->defined('action')) {
			$this->cli->actionsList('System');
		}
	}

	/**
	 * Reload modules.
	 *
	 * @return void
	 */
	public function reloadModule(): void
	{
		$this->climate->bold('Tools: ' . \App\Db\Fixer::baseModuleTools());
		$this->climate->bold('Actions: ' . \App\Db\Fixer::baseModuleActions());
		$this->climate->bold('Profile field: ' . \App\Db\Fixer::profileField());
		$this->climate->bold('Share: ' . \App\Db\Fixer::share());
		\App\Module::createModuleMetaFile();
		$this->climate->bold('Create module meta file');
		\App\Colors::generate();
		$this->climate->bold('Colors');
		$this->climate->lightYellow()->border('─', 200);
		if (!$this->climate->arguments->defined('action')) {
			$this->cli->actionsList('System');
		}
	}

	/**
	 * Reload users privileges.
	 *
	 * @return void
	 */
	public function reloadUserPrivileges(): void
	{
		$this->climate->bold('Users: ' . \App\UserPrivilegesFile::recalculateAll());
		$this->climate->lightYellow()->border('─', 200);
		if (!$this->climate->arguments->defined('action')) {
			$this->cli->actionsList('System');
		}
	}

	/**
	 * Delete registration data.
	 *
	 * @return void
	 */
	public function deleteRegistration(): void
	{
		\App\Db::getInstance('admin')->createCommand()->update('s_#__companies', [
			'status' => 0,
			'name' => '', 'industry' => '', 'vat_id' => '', 'city' => '', 'address' => '',
			'post_code' => '', 'country' => '', 'companysize' => '', 'website' => '', 'logo' => '',
			'firstname' => '', 'lastname' => '', 'email' => '', 'facebook' => '', 'twitter' => '', 'linkedin' => '',
		])->execute();
	}

	/**
	 * Reload menus.
	 *
	 * @return void
	 */
	public function reloadMenus(): void
	{
		$menuRecordModel = new \Settings_Menu_Record_Model();
		$menuRecordModel->refreshMenuFiles();
		if (!$this->climate->arguments->defined('action')) {
			$this->cli->actionsList('System');
		}
	}
}


1			<?php
2			/**
3			* System cli file.
4			*
5			* @package Cli
6			*
7			* @copyright YetiForce S.A.
8			* @license YetiForce Public License 5.0 (licenses/LicenseEN.txt or yetiforce.com)
9			* @author Mariusz Krzaczkowski <[email protected]>
10			*/
11
12			namespace App\Cli;
13
14			/**
15			* System cli class.
16			*/
17			class System extends Base
18			{
19			/** {@inheritdoc} */
20			public $moduleName = 'System';
21
22			/** @var string[] Methods list */
23			public $methods = [
24			'history' => 'History of uploaded updates',
25			'update' => 'Update',
26			'checkRegStatus' => 'Check registration status',
27			'deleteRegistration' => 'Delete registration data',
28			'showProducts' => 'Show active products',
29			'reloadModule' => 'Reload modules',
30			'reloadUserPrivileges' => 'Reload users privileges',
31			'reloadMenus' => 'Reload menus',
32			];
33
34			/**
35			* History of uploaded updates.
36			*
37			* @return void
38			*/
39			public function history(): void
40			{
41			$table = array_map(function ($item) {
42			$item['result'] = $item['result'] ? 'OK' : 'Error';
43			unset($item['id']);
44			return $item;
45			}, \Settings_Updates_Module_Model::getUpdates());
46			if ($table) {
			0 ignored issues – show Bug Best Practice introduced 2021-04-24 21:59 UTC by Report Bug Copy Issue Report The expression `$table` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
47			$this->climate->table($table);
48			} else {
49			$this->climate->lightGreen('No updates');
50			}
51			if (!$this->climate->arguments->defined('action')) {
52			$this->cli->actionsList('System');
53			}
54			}
55
56			/**
57			* Update CRM.
58			*
59			* @return void
60			*/
61			public function update(): void
62			{
63			$maxExecutionTime = ini_get('max_execution_time');
64			if ($maxExecutionTime < 1 \|\| $maxExecutionTime > 600) {
65			$this->climate->lightGreen('Max execution time = ' . $maxExecutionTime);
66			} else {
67			$this->climate->lightRed('Max execution time = ' . $maxExecutionTime);
68			}
69			$this->climate->arguments->add([
70			'type' => [
71			'prefix' => 't',
72			'description' => 'Update type. Values: patches, version',
73			],
74			]);
75			if ($this->helpMode) {
76			return;
77			}
78			$this->climate->arguments->parse();
79			if ($this->climate->arguments->defined('type')) {
80			$this->updateByType($this->climate->arguments->get('type'));
81			} else {
82			$this->updateBySelect();
83			}
84			}
85
86			/**
87			* Update by package type.
88			*
89			* @param string $type Package type. Values: patches, version
90			*
91			* @return void
92			*/
93			private function updateByType(string $type): void
94			{
95			$types = ['patches', 'version'];
96			if (!\in_array($this->climate->arguments->get('type'), $types)) {
97			$this->climate->white('Type not found. Allowed types:')->columns($types);
98			return;
99			}
100			$versionUpdate = 'version' === $type;
101			foreach (\App\YetiForce\Updater::getToInstall() as $package) {
102			$versionCompare = $package['fromVersion'] !== $package['toVersion'];
103			if (($versionCompare && !$versionUpdate) \|\| (!$versionCompare && $versionUpdate)) {
104			continue;
105			}
106			if (!\App\YetiForce\Updater::isDownloaded($package)) {
107			$this->climate->inline($package['label'] . ' - Downloading a package ...');
108			\App\YetiForce\Updater::download($package);
109			$this->climate->out('- downloaded');
110			}
111			$this->updateByPackage($package);
112			}
113			}
114
115			/**
116			* Update by selecting a package.
117			*
118			* @return void
119			*/
120			private function updateBySelect(): void
121			{
122			$options = [];
123			$toInstall = \App\YetiForce\Updater::getToInstall();
124			foreach ($toInstall as $package) {
125			$option = "{$package['label']}";
126			if ($package['fromVersion'] !== $package['toVersion']) {
127			$option .= " ({$package['fromVersion']} >> {$package['toVersion']})";
128			}
129			if (\App\YetiForce\Updater::isDownloaded($package)) {
130			$option .= ' - Downloaded, ready to install';
131			} else {
132			$option .= ' - To download';
133			}
134			$options[$package['hash']] = $option;
135			}
136			if (!$options) {
137			$this->climate->lightBlue('No updates available');
138			return;
139			}
140			$input = $this->climate->radio('Updates available:', $options);
141			$hash = $input->prompt();
142			foreach ($toInstall as $package) {
143			if ($package['hash'] === $hash) {
144			if (\App\YetiForce\Updater::isDownloaded($package)) {
145			$this->updateByPackage($package);
146			} else {
147			\App\YetiForce\Updater::download($package);
148			$this->update();
149			}
150			return;
151			}
152			}
153			}
154
155			/**
156			* Update package.
157			*
158			* @param array $package
159			*
160			* @return void
161			*/
162			private function updateByPackage(array $package): void
163			{
164			$startTime = microtime(true);
165			try {
166			$packageInstance = new \vtlib\Package();
167			$this->climate->white($package['label'] . ' - Installing the package');
168			$path = ROOT_DIRECTORY . \DIRECTORY_SEPARATOR . \Settings_ModuleManager_Module_Model::getUploadDirectory() . \DIRECTORY_SEPARATOR . $package['hash'] . '.zip';
169			$response = $packageInstance->import($path, true);
170			if ($packageInstance->_errorText) {
171			$this->climate->lightRed($packageInstance->_errorText);
172			} else {
173			echo $response . PHP_EOL;
174			unlink($path);
175			}
176			} catch (\Throwable $th) {
177			$this->climate->lightRed($th->__toString());
178			}
179			$this->climate->lightBlue('Total time: ' . round(microtime(true) - $startTime, 2));
180			}
181
182			/**
183			* Check registration status.
184			*
185			* @return void
186			*/
187			public function checkRegStatus(): void
188			{
189			\App\YetiForce\Register::check(true);
190			$this->climate->bold('Status: ' . \App\Language::translate(\App\YetiForce\Register::STATUS_MESSAGES[\App\YetiForce\Register::getStatus()], 'Settings::Companies'));
191			$this->climate->border('─', 200);
192			$this->climate->bold('APP ID: ' . \App\YetiForce\Register::getInstanceKey());
193			$this->climate->border('─', 200);
194			$this->climate->bold('CRM ID: ' . \App\YetiForce\Register::getCrmKey());
195			$this->climate->border('─', 200);
196			$this->climate->bold('Provider: ' . \App\YetiForce\Register::getProvider());
197			$this->climate->border('─', 200);
198			$table = [];
199			foreach (\App\Company::getAll() as $row) {
200			$table[] = [
201			'name' => $row['name'],
202			'status' => $row['status'],
203			'type' => $row['type'],
204			'companysize' => $row['companysize'],
205			'vat_id' => $row['vat_id'],
206			];
207			}
208			$this->climate->table($table);
209			$this->climate->border('─', 200);
210			if (!$this->climate->arguments->defined('action')) {
211			$this->cli->actionsList('System');
212			}
213			}
214
215			/**
216			* Show active products.
217			*
218			* @return void
219			*/
220			public function showProducts(): void
221			{
222			$table = [];
223			foreach (\App\YetiForce\Register::getProducts() as $row) {
224			$row['params'] = \App\Utils::varExport($row['params']);
225			$table[] = $row;
226			}
227			$table ? $this->climate->table($table) : $this->climate->bold('None');
228			$this->climate->border('─', 200);
229			if (!$this->climate->arguments->defined('action')) {
230			$this->cli->actionsList('System');
231			}
232			}
233
234			/**
235			* Reload modules.
236			*
237			* @return void
238			*/
239			public function reloadModule(): void
240			{
241			$this->climate->bold('Tools: ' . \App\Db\Fixer::baseModuleTools());
242			$this->climate->bold('Actions: ' . \App\Db\Fixer::baseModuleActions());
243			$this->climate->bold('Profile field: ' . \App\Db\Fixer::profileField());
244			$this->climate->bold('Share: ' . \App\Db\Fixer::share());
245			\App\Module::createModuleMetaFile();
246			$this->climate->bold('Create module meta file');
247			\App\Colors::generate();
248			$this->climate->bold('Colors');
249			$this->climate->lightYellow()->border('─', 200);
250			if (!$this->climate->arguments->defined('action')) {
251			$this->cli->actionsList('System');
252			}
253			}
254
255			/**
256			* Reload users privileges.
257			*
258			* @return void
259			*/
260			public function reloadUserPrivileges(): void
261			{
262			$this->climate->bold('Users: ' . \App\UserPrivilegesFile::recalculateAll());
263			$this->climate->lightYellow()->border('─', 200);
264			if (!$this->climate->arguments->defined('action')) {
265			$this->cli->actionsList('System');
266			}
267			}
268
269			/**
270			* Delete registration data.
271			*
272			* @return void
273			*/
274			public function deleteRegistration(): void
275			{
276			\App\Db::getInstance('admin')->createCommand()->update('s_#__companies', [
277			'status' => 0,
278			'name' => '', 'industry' => '', 'vat_id' => '', 'city' => '', 'address' => '',
279			'post_code' => '', 'country' => '', 'companysize' => '', 'website' => '', 'logo' => '',
280			'firstname' => '', 'lastname' => '', 'email' => '', 'facebook' => '', 'twitter' => '', 'linkedin' => '',
281			])->execute();
282			}
283
284			/**
285			* Reload menus.
286			*
287			* @return void
288			*/
289			public function reloadMenus(): void
290			{
291			$menuRecordModel = new \Settings_Menu_Record_Model();
292			$menuRecordModel->refreshMenuFiles();
293			if (!$this->climate->arguments->defined('action')) {
294			$this->cli->actionsList('System');
295			}
296			}
297			}
298

YetiForceCompany / YetiForceCRM

Push — developer ( 495154...c1b806 )

System::reloadMenus() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like