SubmitDataController::checkPHPVersion() - Code Metrics - Inspection of "Start MySQL service on Travis" - joomla/statistics-server - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2df1ff...31a2b9 )

by Michael

created 2019-08-13 16:10 UTC

SubmitDataController::checkPHPVersion() A

↳ Parent: SubmitDataController

Complexity

Conditions	5
Paths	5

Size

Total Lines

Duplication

Lines	35
Ratio	100 %

Code Coverage

Tests	8
CRAP Score	6.4222

Importance

Changes

Metric	Value
dl	35
loc	35
ccs	8
cts	13
cp	0.6153
rs	9.0488
c	0
b	0
f	0
cc	5
nc	5
nop	1
crap	6.4222

<?php
/**
 * Joomla! Statistics Server
 *
 * @copyright  Copyright (C) 2013 - 2017 Open Source Matters, Inc. All rights reserved.
 * @license    http://www.gnu.org/licenses/gpl-2.0.txt GNU General Public License Version 2 or Later
 */

namespace Joomla\StatsServer\Controllers;

use Joomla\Controller\AbstractController;
use Joomla\StatsServer\Decorators\ValidateVersion;
use Joomla\StatsServer\Repositories\StatisticsRepository;
use League\Flysystem\FileNotFoundException;
use League\Flysystem\Filesystem;
use Zend\Diactoros\Response\JsonResponse;

/**
 * Controller for processing submitted statistics data.
 *
 * @method         \Joomla\Application\WebApplication  getApplication()  Get the application object.
 * @property-read  \Joomla\Application\WebApplication  $app              Application object
 */
class SubmitDataController extends AbstractController
{
	use ValidateVersion;

	/**
	 * Statistics repository.
	 *
	 * @var  StatisticsRepository
	 */
	private $repository;

	/**
	 * Filesystem adapter for the snapshots space.
	 *
	 * @var  Filesystem
	 */
	private $filesystem;

	/**
	 * Allowed Database Types.
	 *
	 * @var  array
	 */
	private $databaseTypes = [
		'mysql',
		'mysqli',
		'pgsql',
		'pdomysql',
		'postgresql',
		'sqlazure',
		'sqlsrv',
	];

	/**
	 * Constructor.
	 *
	 * @param   StatisticsRepository  $repository  Statistics repository.
	 * @param   Filesystem            $filesystem  Filesystem adapter for the versions space.
	 */
	public function __construct(StatisticsRepository $repository, Filesystem $filesystem)
	{
		$this->repository = $repository;
		$this->filesystem = $filesystem;
	}

	/**
	 * Execute the controller.
	 *
	 * @return  boolean
	 */
	public function execute()
	{
		$input = $this->getInput();

		$data = [
			'php_version' => $input->getRaw('php_version', ''),
			'db_version'  => $input->getRaw('db_version', ''),
			'cms_version' => $input->getRaw('cms_version', ''),
			'unique_id'   => $input->getString('unique_id'),
			'db_type'     => $input->getString('db_type', ''),
			'server_os'   => $input->getString('server_os'),
		];

		// Backup the original POST before manipulating/validating data
		$originalData = $data;

		// Validate the submitted data
		$data['php_version'] = $this->checkPHPVersion($data['php_version']);
		$data['cms_version'] = $this->checkCMSVersion($data['cms_version']);
		$data['db_type']     = $this->checkDatabaseType($data['db_type']);
		$data['db_version']  = $this->validateVersionNumber($data['db_version']);

		// We require at a minimum a unique ID and the CMS version
		if (empty($data['unique_id']) || (empty($data['cms_version']) && $data['cms_version'] !== false))
		{
			$this->getApplication()->getLogger()->info(
				'Missing required data from request.',
				['postData' => $originalData]
			);

			/** @var JsonResponse $response */
			$response = $this->getApplication()->getResponse();
			$response = $response->withPayload(
				[
					'error'   => true,
					'message' => 'There was an error storing the data.',
				]
			);
			$response = $response->withStatus(500);

			$this->getApplication()->setResponse($response);

			return true;
		}

		// If the below data does not pass tests, we do not accept the POST
		if ($data['php_version'] === false || $data['cms_version'] === false || $data['db_type'] === false || $data['db_version'] === false)
		{
			/** @var JsonResponse $response */
			$response = $this->getApplication()->getResponse();
			$response = $response->withPayload(
				[
					'error'   => true,
					'message' => 'Invalid data submission.',
				]
			);
			$response = $response->withStatus(500);

			$this->getApplication()->setResponse($response);

			return true;
		}

		// Account for configuration differences with 4.0
		if (version_compare($data['cms_version'], '4.0', 'ge'))
		{
			// For 4.0 and later, we map `mysql` to the `pdomysql` option to correctly track the database type
			if ($data['db_type'] === 'mysql')
			{
				$data['db_type'] = 'pdomysql';
			}
		}

		$this->repository->save((object) $data);

		/** @var JsonResponse $response */
		$response = $this->getApplication()->getResponse();
		$response = $response->withPayload(
			[
				'error'   => false,
				'message' => 'Data saved successfully',
			]
		);

		$this->getApplication()->setResponse($response);

		return true;
	}

	/**
	 * Check the CMS version.
	 *
	 * @param   string  $version  The version number to check.
	 *
	 * @return  string|boolean  The version number on success or boolean false on failure.
	 */
	private function checkCMSVersion(string $version)

	{
		$version = $this->validateVersionNumber($version);

		// If the version number is invalid, don't go any further
		if ($version === false)
		{
			return false;
		}

		// Joomla only uses major.minor.patch so everything else is invalid
		$explodedVersion = explode('.', $version);

		if (\count($explodedVersion) > 3)
		{
			return false;
		}

		try
		{
			$validVersions = json_decode($this->filesystem->read('joomla.json'), true);
		}
		catch (FileNotFoundException $exception)
		{
			throw new \RuntimeException('Missing Joomla! release listing', 500, $exception);
		}

		// Check that the version is in our valid release list
		if (!\in_array($version, $validVersions))
		{
			return false;
		}

		return $version;
	}

	/**
	 * Check the database type
	 *
	 * @param   string  $database  The database type to check.
	 *
	 * @return  string|boolean  The database type on success or boolean false on failure.
	 */
	private function checkDatabaseType(string $database)
	{
		if (!\in_array($database, $this->databaseTypes))
		{
			return false;
		}

		return $database;
	}

	/**
	 * Check the PHP version
	 *
	 * @param   string  $version  The version number to check.
	 *
	 * @return  string|boolean  The version number on success or boolean false on failure.
	 */
	private function checkPHPVersion(string $version)

	{
		$version = $this->validateVersionNumber($version);

		// If the version number is invalid, don't go any further
		if ($version === false)
		{
			return false;
		}

		// We only track versions based on major.minor.patch so everything else is invalid
		$explodedVersion = explode('.', $version);

		if (\count($explodedVersion) > 3)
		{
			return false;
		}

		try
		{
			$validVersions = json_decode($this->filesystem->read('php.json'), true);
		}
		catch (FileNotFoundException $exception)
		{
			throw new \RuntimeException('Missing PHP release listing', 500, $exception);
		}

		// Check that the version is in our valid release list
		if (!\in_array($version, $validVersions))
		{
			return false;
		}

		return $version;
	}
}


1			<?php
2			/**
3			* Joomla! Statistics Server
4			*
5			* @copyright Copyright (C) 2013 - 2017 Open Source Matters, Inc. All rights reserved.
6			* @license http://www.gnu.org/licenses/gpl-2.0.txt GNU General Public License Version 2 or Later
7			*/
8
9			namespace Joomla\StatsServer\Controllers;
10
11			use Joomla\Controller\AbstractController;
12			use Joomla\StatsServer\Decorators\ValidateVersion;
13			use Joomla\StatsServer\Repositories\StatisticsRepository;
14			use League\Flysystem\FileNotFoundException;
15			use League\Flysystem\Filesystem;
16			use Zend\Diactoros\Response\JsonResponse;
17
18			/**
19			* Controller for processing submitted statistics data.
20			*
21			* @method \Joomla\Application\WebApplication getApplication() Get the application object.
22			* @property-read \Joomla\Application\WebApplication $app Application object
23			*/
24			class SubmitDataController extends AbstractController
25			{
26			use ValidateVersion;
27
28			/**
29			* Statistics repository.
30			*
31			* @var StatisticsRepository
32			*/
33			private $repository;
34
35			/**
36			* Filesystem adapter for the snapshots space.
37			*
38			* @var Filesystem
39			*/
40			private $filesystem;
41
42			/**
43			* Allowed Database Types.
44			*
45			* @var array
46			*/
47			private $databaseTypes = [
48			'mysql',
49			'mysqli',
50			'pgsql',
51			'pdomysql',
52			'postgresql',
53			'sqlazure',
54			'sqlsrv',
55			];
56
57			/**
58			* Constructor.
59			*
60			* @param StatisticsRepository $repository Statistics repository.
61			* @param Filesystem $filesystem Filesystem adapter for the versions space.
62			*/
63	5		public function __construct(StatisticsRepository $repository, Filesystem $filesystem)
64			{
65	5		$this->repository = $repository;
66	5		$this->filesystem = $filesystem;
67	5		}
68
69			/**
70			* Execute the controller.
71			*
72			* @return boolean
73			*/
74	5		public function execute()
75			{
76	5		$input = $this->getInput();
77
78			$data = [
79	5		'php_version' => $input->getRaw('php_version', ''),
80	5		'db_version' => $input->getRaw('db_version', ''),
81	5		'cms_version' => $input->getRaw('cms_version', ''),
82	5		'unique_id' => $input->getString('unique_id'),
83	5		'db_type' => $input->getString('db_type', ''),
84	5		'server_os' => $input->getString('server_os'),
85			];
86
87			// Backup the original POST before manipulating/validating data
88	5		$originalData = $data;
89
90			// Validate the submitted data
91	5		$data['php_version'] = $this->checkPHPVersion($data['php_version']);
92	5		$data['cms_version'] = $this->checkCMSVersion($data['cms_version']);
93	5		$data['db_type'] = $this->checkDatabaseType($data['db_type']);
94	5		$data['db_version'] = $this->validateVersionNumber($data['db_version']);
95
96			// We require at a minimum a unique ID and the CMS version
97	5		if (empty($data['unique_id']) \|\| (empty($data['cms_version']) && $data['cms_version'] !== false))
98			{
99	1		$this->getApplication()->getLogger()->info(
100	1		'Missing required data from request.',
101	1		['postData' => $originalData]
102			);
103
104			/** @var JsonResponse $response */
105	1		$response = $this->getApplication()->getResponse();
106	1		$response = $response->withPayload(
107			[
108	1		'error' => true,
109			'message' => 'There was an error storing the data.',
110			]
111			);
112	1		$response = $response->withStatus(500);
113
114	1		$this->getApplication()->setResponse($response);
115
116	1		return true;
117			}
118
119			// If the below data does not pass tests, we do not accept the POST
120	4		if ($data['php_version'] === false \|\| $data['cms_version'] === false \|\| $data['db_type'] === false \|\| $data['db_version'] === false)
121			{
122			/** @var JsonResponse $response */
123	1		$response = $this->getApplication()->getResponse();
124	1		$response = $response->withPayload(
125			[
126	1		'error' => true,
127			'message' => 'Invalid data submission.',
128			]
129			);
130	1		$response = $response->withStatus(500);
131
132	1		$this->getApplication()->setResponse($response);
133
134	1		return true;
135			}
136
137			// Account for configuration differences with 4.0
138	3		if (version_compare($data['cms_version'], '4.0', 'ge'))
139			{
140			// For 4.0 and later, we map `mysql` to the `pdomysql` option to correctly track the database type
141	1		if ($data['db_type'] === 'mysql')
142			{
143	1		$data['db_type'] = 'pdomysql';
144			}
145			}
146
147	3		$this->repository->save((object) $data);
148
149			/** @var JsonResponse $response */
150	3		$response = $this->getApplication()->getResponse();
151	3		$response = $response->withPayload(
152			[
153	3		'error' => false,
154			'message' => 'Data saved successfully',
155			]
156			);
157
158	3		$this->getApplication()->setResponse($response);
159
160	3		return true;
161			}
162
163			/**
164			* Check the CMS version.
165			*
166			* @param string $version The version number to check.
167			*
168			* @return string\|boolean The version number on success or boolean false on failure.
169			*/
170	5	View Code Duplication	private function checkCMSVersion(string $version)
			0 ignored issues – show Duplication introduced 2017-08-10 23:44 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
171			{
172	5		$version = $this->validateVersionNumber($version);
173
174			// If the version number is invalid, don't go any further
175	5		if ($version === false)
176			{
177	1		return false;
178			}
179
180			// Joomla only uses major.minor.patch so everything else is invalid
181	4		$explodedVersion = explode('.', $version);
182
183	4		if (\count($explodedVersion) > 3)
184			{
185			return false;
186			}
187
188			try
189			{
190	4		$validVersions = json_decode($this->filesystem->read('joomla.json'), true);
191			}
192			catch (FileNotFoundException $exception)
193			{
194			throw new \RuntimeException('Missing Joomla! release listing', 500, $exception);
195			}
196
197			// Check that the version is in our valid release list
198	4		if (!\in_array($version, $validVersions))
199			{
200	1		return false;
201			}
202
203	3		return $version;
204			}
205
206			/**
207			* Check the database type
208			*
209			* @param string $database The database type to check.
210			*
211			* @return string\|boolean The database type on success or boolean false on failure.
212			*/
213	5		private function checkDatabaseType(string $database)
214			{
215	5		if (!\in_array($database, $this->databaseTypes))
216			{
217			return false;
218			}
219
220	5		return $database;
221			}
222
223			/**
224			* Check the PHP version
225			*
226			* @param string $version The version number to check.
227			*
228			* @return string\|boolean The version number on success or boolean false on failure.
229			*/
230	5	View Code Duplication	private function checkPHPVersion(string $version)
			0 ignored issues – show Duplication introduced 2017-08-10 23:44 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
231			{
232	5		$version = $this->validateVersionNumber($version);
233
234			// If the version number is invalid, don't go any further
235	5		if ($version === false)
236			{
237			return false;
238			}
239
240			// We only track versions based on major.minor.patch so everything else is invalid
241	5		$explodedVersion = explode('.', $version);
242
243	5		if (\count($explodedVersion) > 3)
244			{
245			return false;
246			}
247
248			try
249			{
250	5		$validVersions = json_decode($this->filesystem->read('php.json'), true);
251			}
252			catch (FileNotFoundException $exception)
253			{
254			throw new \RuntimeException('Missing PHP release listing', 500, $exception);
255			}
256
257			// Check that the version is in our valid release list
258	5		if (!\in_array($version, $validVersions))
259			{
260			return false;
261			}
262
263	5		return $version;
264			}
265			}
266

joomla / statistics-server

Push — master ( 2df1ff...31a2b9 )

SubmitDataController::checkPHPVersion() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like