Issues in Router.php - Fixed Issues - Inspection of "Develop (#608)" - redaxscript/redaxscript - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 4d87e8...6f96cd )

by Henry

created 2019-09-17 21:06 UTC

includes/Router/Router.php (1 issue)

Labels

Bug 1

Severity

Minor 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php
namespace Redaxscript\Router;

use Redaxscript\Controller;
use Redaxscript\Filter;
use Redaxscript\Header;
use Redaxscript\Model;
use Redaxscript\Module;
use Redaxscript\Validator;
use Redaxscript\View;

/**
 * parent class to provide the router
 *
 * @since 3.3.0
 *
 * @package Redaxscript
 * @category Router
 * @author Henry Ruhs
 */

class Router extends RouterAbstract
{
	/**
	 * route the header
	 *
	 * @since 3.3.0
	 *
	 * @return bool
	 */

	public function routeHeader() : bool
	{
		Module\Hook::trigger('routeHeader');

		/* handle break */

		if ($this->_registry->get('routerBreak'))
		{
			Header::responseCode(202);
		}

		/* handle guard */

		if ($this->_tokenGuard())
		{
			Header::responseCode(403);
		}
		if ($this->_authGuard())
		{
			Header::responseCode(403);
		}

		/* handle validator */

		if ($this->_aliasValidator())
		{
			Header::responseCode(202);
		}
		else if (!$this->_contentValidator())
		{
			Header::responseCode(404);
		}

		/* handle post */

		if ($this->_request->getPost('Redaxscript\View\SearchForm'))
		{
			return $this->_redirectSearch();
		}

		return (bool)$this->_registry->get('routerBreak');
	}

	/**
	 * route the content
	 *
	 * @since 3.3.0
	 *
	 * @return string|null
	 */

	public function routeContent() : ?string
	{
		Module\Hook::trigger('routeContent');
		$firstParameter = $this->getFirst();
		$fileInstall = $this->_registry->get('file') === 'install.php' && $this->_config->get('env') !== 'production';

		/* handle guard */

		if ($this->_tokenGuard())
		{
			return $this->_errorToken();
		}
		if ($this->_authGuard())
		{
			return $this->_errorAccess();
		}

		/* handle post */

		if ($this->_request->getPost('Redaxscript\View\CommentForm'))
		{
			return $this->_processComment();
		}
		if ($this->_request->getPost('Redaxscript\View\LoginForm'))
		{
			return $this->_processLogin();
		}
		if ($this->_request->getPost('Redaxscript\View\ResetForm'))
		{
			return $this->_processReset();
		}
		if ($this->_request->getPost('Redaxscript\View\RecoverForm'))
		{
			return $this->_processRecover();
		}
		if ($this->_request->getPost('Redaxscript\View\RegisterForm'))
		{
			return $this->_processRegister();
		}
		if ($fileInstall && $this->_request->getPost('Redaxscript\View\InstallForm'))
		{
			return $this->_processInstall();
		}

		/* handle route */

		if ($firstParameter === 'search')
		{
			return $this->_processSearch();
		}
		if ($firstParameter === 'login')
		{
			return $this->_renderLogin();
		}
		if ($firstParameter === 'logout')
		{
			return $this->_processLogout();
		}
		if ($firstParameter === 'register')
		{
			return $this->_renderRegister();
		}
		if ($fileInstall)
		{
			return $this->_renderInstall();
		}
		if ($this->_registry->get('routerBreak'))
		{
			return '<!-- routerBreak -->';
		}
		return null;
	}

	/**
	 * token guard
	 *
	 * @since 3.3.0
	 *
	 * @return bool
	 */

	protected function _tokenGuard() : bool
	{
		return $this->_request->get('post') && $this->_request->getPost('token') !== $this->_registry->get('token');
	}

	/**
	 * auth guard
	 *
	 * @since 3.3.0
	 *
	 * @return bool
	 */

	protected function _authGuard() : bool
	{
		return $this->_registry->get('token') !== $this->_registry->get('loggedIn') && $this->_registry->get('firstParameter') === 'admin';
	}

	/**
	 * alias validator
	 *
	 * @since 4.0.0
	 *
	 * @return bool
	 */

	protected function _aliasValidator() : bool
	{
		$aliasValidator = new Validator\Alias();
		return $aliasValidator->validate($this->_registry->get('firstParameter'), 'system') && $this->_registry->get('fullRoute') !== 'admin';

	}

	/**
	 * content validator
	 *
	 * @since 4.0.0
	 *
	 * @return bool
	 */

	protected function _contentValidator() : bool
	{
		return $this->_registry->get('lastId') > 0;
	}

	/**
	 * redirect the search
	 *
	 * @since 3.3.0
	 *
	 * @return bool
	 */

	protected function _redirectSearch() : bool
	{
		$aliasFilter = new Filter\Alias();
		$root = $this->_registry->get('root');
		$parameterRoute = $this->_registry->get('parameterRoute');

		/* handle post */

		$table = $aliasFilter->sanitize($this->_request->getPost('table'));
		$search = $aliasFilter->sanitize($this->_request->getPost('search'));
		$tableString = $table ? '/' . $table : null;

		/* redirect */

		return Header::doRedirect($root . '/' . $parameterRoute . 'search' . $tableString . '/' . $search);
	}

	/**
	 * process the search
	 *
	 * @since 3.3.0
	 *
	 * @return string
	 */

	protected function _processSearch() : string
	{
		$searchController = new Controller\Search($this->_registry, $this->_request, $this->_language, $this->_config);
		return $searchController->process();
	}

	/**
	 * process the comment
	 *
	 * @since 3.3.0
	 *
	 * @return string
	 */

	protected function _processComment() : string
	{
		$commentController = new Controller\Comment($this->_registry, $this->_request, $this->_language, $this->_config);
		return $commentController->process();
	}

	/**
	 * process the login
	 *
	 * @since 3.3.0
	 *
	 * @return string
	 */

	protected function _processLogin() : string
	{
		$loginController = new Controller\Login($this->_registry, $this->_request, $this->_language, $this->_config);
		return $loginController->process();
	}

	/**
	 * process the reset
	 *
	 * @since 3.3.0
	 *
	 * @return string
	 */

	protected function _processReset() : string
	{
		$resetController = new Controller\Reset($this->_registry, $this->_request, $this->_language, $this->_config);
		return $resetController->process();
	}

	/**
	 * process the recover
	 *
	 * @since 3.3.0
	 *
	 * @return string
	 */

	protected function _processRecover() : string
	{
		$recoverController = new Controller\Recover($this->_registry, $this->_request, $this->_language, $this->_config);
		return $recoverController->process();
	}

	/**
	 * process the register
	 *
	 * @since 3.3.0
	 *
	 * @return string
	 */

	protected function _processRegister() : string
	{
		$registerController = new Controller\Register($this->_registry, $this->_request, $this->_language, $this->_config);
		return $registerController->process();
	}

	/**
	 * process the logout
	 *
	 * @since 3.3.0
	 *
	 * @return string
	 */

	protected function _processLogout() : string
	{
		$logoutController = new Controller\Logout($this->_registry, $this->_request, $this->_language, $this->_config);
		return $logoutController->process();
	}

	/**
	 * process the install
	 *
	 * @since 3.3.0
	 *
	 * @return string
	 */

	protected function _processInstall() : string
	{
		$this->_request->setSession('installArray',
		[
			'dbType' => $this->_request->getPost('db-type'),
			'dbHost' => $this->_request->getPost('db-host'),
			'dbName' => $this->_request->getPost('db-name'),
			'dbUser' => $this->_request->getPost('db-user'),
			'dbPassword' => $this->_request->getPost('db-password'),
			'dbPrefix' => $this->_request->getPost('db-prefix'),
			'adminName' => $this->_request->getPost('admin-name'),
			'adminUser' => $this->_request->getPost('admin-user'),
			'adminPassword' => $this->_request->getPost('admin-password'),
			'adminEmail' => $this->_request->getPost('admin-email')
		]);
		$installController = new Controller\Install($this->_registry, $this->_request, $this->_language, $this->_config);
		return $installController->process();
	}

	/**
	 * render the login
	 *
	 * @since 3.3.0
	 *
	 * @return string
	 */

	protected function _renderLogin() : string
	{
		$secondParameter = $this->getSecond();
		$thirdParameter = $this->getThird();
		$thirdSubParameter = $this->getThirdSub();
		$settingModel = new Model\Setting();

		/* handle login */

		if ($settingModel->get('recovery'))
		{
			if ($secondParameter === 'recover')
			{
				$recoverForm = new View\RecoverForm($this->_registry, $this->_language);
				return $recoverForm->render();
			}
			if ($secondParameter === 'reset' && $thirdParameter && $thirdSubParameter)
			{
				$resetForm = new View\ResetForm($this->_registry, $this->_language);
				return $resetForm->render();
			}
		}
		if (!$secondParameter)
		{
			$loginForm = new View\LoginForm($this->_registry, $this->_language);
			return $loginForm->render();
		}
		return $this->_errorAccess();
	}

	/**
	 * render the register
	 *
	 * @since 3.3.0
	 *
	 * @return string
	 */

	protected function _renderRegister() : string
	{
		$settingModel = new Model\Setting();
		if ($settingModel->get('registration'))
		{
			$registerForm = new View\RegisterForm($this->_registry, $this->_language);
			return $registerForm->render();
		}
		return $this->_errorAccess();
	}

	/**
	 * render the install
	 *
	 * @since 3.3.0
	 *
	 * @return string
	 */

	protected function _renderInstall() : string
	{
		$installArray = $this->_request->getSession('installArray');
		$systemStatus = new View\SystemStatus($this->_registry, $this->_language);
		$installForm = new View\InstallForm($this->_registry, $this->_language);
		return $systemStatus->render() . $installForm->render($installArray ? : []);
	}

	/**
	 * messenger factory
	 *
	 * @since 4.0.0
	 *
	 * @return View\Helper\Messenger
	 */

	protected function _messengerFactory() : View\Helper\Messenger
	{
		return new View\Helper\Messenger($this->_registry);
	}

	/**
	 * show the token error
	 *
	 * @since 3.3.0
	 *
	 * @return string
	 */

	protected function _errorToken() : string
	{
		$messenger = $this->_messengerFactory();
		return $messenger
			->setUrl($this->_language->get('home'), $this->_registry->get('root'))
			->error($this->_language->get('token_incorrect'), $this->_language->get('error_occurred'));
	}

	/**
	 * show the access error
	 *
	 * @since 3.3.0
	 *
	 * @return string
	 */

	protected function _errorAccess() : string
	{
		$messenger = $this->_messengerFactory();
		return $messenger
			->setUrl($this->_language->get('home'), $this->_registry->get('root'))
			->error($this->_language->get('access_no'), $this->_language->get('error_occurred'));
	}
}


1		<?php
2		namespace Redaxscript\Router;
3
4		use Redaxscript\Controller;
5		use Redaxscript\Filter;
6		use Redaxscript\Header;
7		use Redaxscript\Model;
8		use Redaxscript\Module;
9		use Redaxscript\Validator;
10		use Redaxscript\View;
11
12		/**
13		* parent class to provide the router
14		*
15		* @since 3.3.0
16		*
17		* @package Redaxscript
18		* @category Router
19		* @author Henry Ruhs
20		*/
21
22		class Router extends RouterAbstract
23		{
24		/**
25		* route the header
26		*
27		* @since 3.3.0
28		*
29		* @return bool
30		*/
31
32	3	public function routeHeader() : bool
33		{
34	3	Module\Hook::trigger('routeHeader');
35
36		/* handle break */
37
38	3	if ($this->_registry->get('routerBreak'))
39		{
40	1	Header::responseCode(202);
41		}
42
43		/* handle guard */
44
45	3	if ($this->_tokenGuard())
46		{
47	1	Header::responseCode(403);
48		}
49	3	if ($this->_authGuard())
50		{
51		Header::responseCode(403);
52		}
53
54		/* handle validator */
55
56	3	if ($this->_aliasValidator())
57		{
58		Header::responseCode(202);
59		}
60	3	else if (!$this->_contentValidator())
61		{
62		Header::responseCode(404);
63		}
64
65		/* handle post */
66
67	3	if ($this->_request->getPost('Redaxscript\View\SearchForm'))
68		{
69	1	return $this->_redirectSearch();
70		}
71
72	2	return (bool)$this->_registry->get('routerBreak');
73		}
74
75		/**
76		* route the content
77		*
78		* @since 3.3.0
79		*
80		* @return string\|null
81		*/
82
83	17	public function routeContent() : ?string
84		{
85	17	Module\Hook::trigger('routeContent');
86	17	$firstParameter = $this->getFirst();
87	17	$fileInstall = $this->_registry->get('file') === 'install.php' && $this->_config->get('env') !== 'production';
88
89		/* handle guard */
90
91	17	if ($this->_tokenGuard())
92		{
93	1	return $this->_errorToken();
94		}
95	16	if ($this->_authGuard())
96		{
97		return $this->_errorAccess();
98		}
99
100		/* handle post */
101
102	16	if ($this->_request->getPost('Redaxscript\View\CommentForm'))
103		{
104	1	return $this->_processComment();
105		}
106	15	if ($this->_request->getPost('Redaxscript\View\LoginForm'))
107		{
108	1	return $this->_processLogin();
109		}
110	14	if ($this->_request->getPost('Redaxscript\View\ResetForm'))
111		{
112	1	return $this->_processReset();
113		}
114	13	if ($this->_request->getPost('Redaxscript\View\RecoverForm'))
115		{
116	1	return $this->_processRecover();
117		}
118	12	if ($this->_request->getPost('Redaxscript\View\RegisterForm'))
119		{
120	1	return $this->_processRegister();
121		}
122	11	if ($fileInstall && $this->_request->getPost('Redaxscript\View\InstallForm'))
123		{
124	1	return $this->_processInstall();
125		}
126
127		/* handle route */
128
129	10	if ($firstParameter === 'search')
130		{
131	1	return $this->_processSearch();
132		}
133	9	if ($firstParameter === 'login')
134		{
135	4	return $this->_renderLogin();
136		}
137	5	if ($firstParameter === 'logout')
138		{
139	1	return $this->_processLogout();
140		}
141	4	if ($firstParameter === 'register')
142		{
143	2	return $this->_renderRegister();
144		}
145	2	if ($fileInstall)
146		{
147	1	return $this->_renderInstall();
148		}
149	1	if ($this->_registry->get('routerBreak'))
150		{
151		return '<!-- routerBreak -->';
152		}
153	1	return null;
154		}
155
156		/**
157		* token guard
158		*
159		* @since 3.3.0
160		*
161		* @return bool
162		*/
163
164	20	protected function _tokenGuard() : bool
165		{
166	20	return $this->_request->get('post') && $this->_request->getPost('token') !== $this->_registry->get('token');
167		}
168
169		/**
170		* auth guard
171		*
172		* @since 3.3.0
173		*
174		* @return bool
175		*/
176
177	19	protected function _authGuard() : bool
178		{
179	19	return $this->_registry->get('token') !== $this->_registry->get('loggedIn') && $this->_registry->get('firstParameter') === 'admin';
180		}
181
182		/**
183		* alias validator
184		*
185		* @since 4.0.0
186		*
187		* @return bool
188		*/
189
190	3	protected function _aliasValidator() : bool
191		{
192	3	$aliasValidator = new Validator\Alias();
193	3	return $aliasValidator->validate($this->_registry->get('firstParameter'), 'system') && $this->_registry->get('fullRoute') !== 'admin';
		0 ignored issues – show Bug introduced 2019-04-22 21:27 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like `$this->_registry->get('firstParameter')` targeting `Redaxscript\Registry::get()` can also be of type `array`; however, `Redaxscript\Validator\Alias::validate()` does only seem to accept `null\|string`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
194		}
195
196		/**
197		* content validator
198		*
199		* @since 4.0.0
200		*
201		* @return bool
202		*/
203
204	3	protected function _contentValidator() : bool
205		{
206	3	return $this->_registry->get('lastId') > 0;
207		}
208
209		/**
210		* redirect the search
211		*
212		* @since 3.3.0
213		*
214		* @return bool
215		*/
216
217	1	protected function _redirectSearch() : bool
218		{
219	1	$aliasFilter = new Filter\Alias();
220	1	$root = $this->_registry->get('root');
221	1	$parameterRoute = $this->_registry->get('parameterRoute');
222
223		/* handle post */
224
225	1	$table = $aliasFilter->sanitize($this->_request->getPost('table'));
226	1	$search = $aliasFilter->sanitize($this->_request->getPost('search'));
227	1	$tableString = $table ? '/' . $table : null;
228
229		/* redirect */
230
231	1	return Header::doRedirect($root . '/' . $parameterRoute . 'search' . $tableString . '/' . $search);
232		}
233
234		/**
235		* process the search
236		*
237		* @since 3.3.0
238		*
239		* @return string
240		*/
241
242	1	protected function _processSearch() : string
243		{
244	1	$searchController = new Controller\Search($this->_registry, $this->_request, $this->_language, $this->_config);
245	1	return $searchController->process();
246		}
247
248		/**
249		* process the comment
250		*
251		* @since 3.3.0
252		*
253		* @return string
254		*/
255
256	1	protected function _processComment() : string
257		{
258	1	$commentController = new Controller\Comment($this->_registry, $this->_request, $this->_language, $this->_config);
259	1	return $commentController->process();
260		}
261
262		/**
263		* process the login
264		*
265		* @since 3.3.0
266		*
267		* @return string
268		*/
269
270	1	protected function _processLogin() : string
271		{
272	1	$loginController = new Controller\Login($this->_registry, $this->_request, $this->_language, $this->_config);
273	1	return $loginController->process();
274		}
275
276		/**
277		* process the reset
278		*
279		* @since 3.3.0
280		*
281		* @return string
282		*/
283
284	1	protected function _processReset() : string
285		{
286	1	$resetController = new Controller\Reset($this->_registry, $this->_request, $this->_language, $this->_config);
287	1	return $resetController->process();
288		}
289
290		/**
291		* process the recover
292		*
293		* @since 3.3.0
294		*
295		* @return string
296		*/
297
298	1	protected function _processRecover() : string
299		{
300	1	$recoverController = new Controller\Recover($this->_registry, $this->_request, $this->_language, $this->_config);
301	1	return $recoverController->process();
302		}
303
304		/**
305		* process the register
306		*
307		* @since 3.3.0
308		*
309		* @return string
310		*/
311
312	1	protected function _processRegister() : string
313		{
314	1	$registerController = new Controller\Register($this->_registry, $this->_request, $this->_language, $this->_config);
315	1	return $registerController->process();
316		}
317
318		/**
319		* process the logout
320		*
321		* @since 3.3.0
322		*
323		* @return string
324		*/
325
326	1	protected function _processLogout() : string
327		{
328	1	$logoutController = new Controller\Logout($this->_registry, $this->_request, $this->_language, $this->_config);
329	1	return $logoutController->process();
330		}
331
332		/**
333		* process the install
334		*
335		* @since 3.3.0
336		*
337		* @return string
338		*/
339
340	1	protected function _processInstall() : string
341		{
342	1	$this->_request->setSession('installArray',
343		[
344	1	'dbType' => $this->_request->getPost('db-type'),
345	1	'dbHost' => $this->_request->getPost('db-host'),
346	1	'dbName' => $this->_request->getPost('db-name'),
347	1	'dbUser' => $this->_request->getPost('db-user'),
348	1	'dbPassword' => $this->_request->getPost('db-password'),
349	1	'dbPrefix' => $this->_request->getPost('db-prefix'),
350	1	'adminName' => $this->_request->getPost('admin-name'),
351	1	'adminUser' => $this->_request->getPost('admin-user'),
352	1	'adminPassword' => $this->_request->getPost('admin-password'),
353	1	'adminEmail' => $this->_request->getPost('admin-email')
354		]);
355	1	$installController = new Controller\Install($this->_registry, $this->_request, $this->_language, $this->_config);
356	1	return $installController->process();
357		}
358
359		/**
360		* render the login
361		*
362		* @since 3.3.0
363		*
364		* @return string
365		*/
366
367	4	protected function _renderLogin() : string
368		{
369	4	$secondParameter = $this->getSecond();
370	4	$thirdParameter = $this->getThird();
371	4	$thirdSubParameter = $this->getThirdSub();
372	4	$settingModel = new Model\Setting();
373
374		/* handle login */
375
376	4	if ($settingModel->get('recovery'))
377		{
378	2	if ($secondParameter === 'recover')
379		{
380	1	$recoverForm = new View\RecoverForm($this->_registry, $this->_language);
381	1	return $recoverForm->render();
382		}
383	1	if ($secondParameter === 'reset' && $thirdParameter && $thirdSubParameter)
384		{
385	1	$resetForm = new View\ResetForm($this->_registry, $this->_language);
386	1	return $resetForm->render();
387		}
388		}
389	2	if (!$secondParameter)
390		{
391	1	$loginForm = new View\LoginForm($this->_registry, $this->_language);
392	1	return $loginForm->render();
393		}
394	1	return $this->_errorAccess();
395		}
396
397		/**
398		* render the register
399		*
400		* @since 3.3.0
401		*
402		* @return string
403		*/
404
405	2	protected function _renderRegister() : string
406		{
407	2	$settingModel = new Model\Setting();
408	2	if ($settingModel->get('registration'))
409		{
410	1	$registerForm = new View\RegisterForm($this->_registry, $this->_language);
411	1	return $registerForm->render();
412		}
413	1	return $this->_errorAccess();
414		}
415
416		/**
417		* render the install
418		*
419		* @since 3.3.0
420		*
421		* @return string
422		*/
423
424	1	protected function _renderInstall() : string
425		{
426	1	$installArray = $this->_request->getSession('installArray');
427	1	$systemStatus = new View\SystemStatus($this->_registry, $this->_language);
428	1	$installForm = new View\InstallForm($this->_registry, $this->_language);
429	1	return $systemStatus->render() . $installForm->render($installArray ? : []);
430		}
431
432		/**
433		* messenger factory
434		*
435		* @since 4.0.0
436		*
437		* @return View\Helper\Messenger
438		*/
439
440	3	protected function _messengerFactory() : View\Helper\Messenger
441		{
442	3	return new View\Helper\Messenger($this->_registry);
443		}
444
445		/**
446		* show the token error
447		*
448		* @since 3.3.0
449		*
450		* @return string
451		*/
452
453	1	protected function _errorToken() : string
454		{
455	1	$messenger = $this->_messengerFactory();
456		return $messenger
457	1	->setUrl($this->_language->get('home'), $this->_registry->get('root'))
458	1	->error($this->_language->get('token_incorrect'), $this->_language->get('error_occurred'));
459		}
460
461		/**
462		* show the access error
463		*
464		* @since 3.3.0
465		*
466		* @return string
467		*/
468
469	2	protected function _errorAccess() : string
470		{
471	2	$messenger = $this->_messengerFactory();
472		return $messenger
473	2	->setUrl($this->_language->get('home'), $this->_registry->get('root'))
474	2	->error($this->_language->get('access_no'), $this->_language->get('error_occurred'));
475		}
476		}
477

redaxscript / redaxscript

Push — master ( 4d87e8...6f96cd )

includes/Router/Router.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like