Issues in Router.php - New 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 break */

		if ($this->_registry->get('routerBreak'))
		{
			return '<!-- routerBreak -->';
		}

		/* 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();
		}
		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');

	}

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

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