Router::routeRequest() - Code Metrics - Inspection of "add import/export tools" - pryley/site-reviews - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 796b78...de3336 )

by Paul

created 2018-06-01 13:22 UTC

Router::routeRequest() A

↳ Parent: Project

Complexity

Conditions	3
Paths	3

Size

Total Lines	11
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

Metric	Value
cc	3
eloc	8
nc	3
nop	3
dl	0
loc	11
ccs	0
cts	9
cp	0
crap	12
rs	9.4285
c	0
b	0
f	0

<?php

namespace GeminiLabs\SiteReviews;

use GeminiLabs\SiteReviews\Application;
use GeminiLabs\SiteReviews\Controllers\AdminController;
use GeminiLabs\SiteReviews\Controllers\AjaxController;
use GeminiLabs\SiteReviews\Controllers\PublicController;
use GeminiLabs\SiteReviews\Helper;

class Router
{
	/**
	 * @return void
	 */
	public function routeAdminPostRequest()
	{
		$request = filter_input( INPUT_POST, Application::ID, FILTER_DEFAULT, FILTER_REQUIRE_ARRAY );
		if( !isset( $request['action'] ))return;
		$this->checkNonce( $request['action'] );
		$this->routeRequest( 'admin', $request['action'], $request );
	}

	/**
	 * @return void
	 */
	public function routeAjaxRequest()
	{
		$request = $this->normalizeAjaxRequest();
		if( !wp_verify_nonce( $request['nonce'], $request['action'] )) {
			glsr_log()->error( 'Nonce check failed for ajax request' )->info( $request );
			wp_die( -1, 403 );
		}
		$this->routeRequest( 'ajax', $request['action'], $request );
		wp_die();
	}

	/**
	 * @return void
	 */
	public function routePublicPostRequest()
	{
		$action = filter_input( INPUT_POST, 'action' );

		$request = $this->normalize( $_POST );

		// glsr_log( $this->normalize( $_POST ) );

		// $this->routeRequest( 'public', $action, $request );

	}

	/**
	 * @param string $type
	 * @param string $action
	 * @return void
	 */
	public function routeRequest( $type, $action, array $request = [] )
	{
		$controller = glsr( glsr( Helper::class )->buildClassName( $type.'-controller', 'Controllers' ));
		$method = glsr( Helper::class )->buildMethodName( $action, 'router' );
		if( is_callable( [$controller, $method] )) {
			call_user_func( [$controller, $method], $request );
			return;
		}
		$response = do_action( 'site-reviews/route/'.$type.'/request', $action, $request );
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
		if( empty( $response )) {
			glsr_log( 'Unknown '.$type.' router request: '.$action );
		}
	}

	/**
	 * @return void
	 */
	public function routeWebhookRequest()
	{
		$request = filter_input( INPUT_GET, sprintf( '%s-hook', Application::ID ));
		if( !$request )return;
		// @todo manage webhook here
	}

	/**
	 * @param string $action
	 * @return void
	 * @todo verify the $action-options
	 */
	protected function checkNonce( $action )
	{
		$nonce = filter_input( INPUT_POST, 'option_page' ) == $action
			&& filter_input( INPUT_POST, 'action' ) == 'update'
			? $action.'-options'
			: $action;
		check_admin_referer( $nonce );
	}

	/**
	 * Undo damage done by javascript: encodeURIComponent() and sanitize values
	 * @return array
	 */
	protected function normalize( array $request )
	{
		array_walk_recursive( $request, function( &$value ) {
			$value = stripslashes( $value );
		});
		return $request;
	}

	/**
	 * All ajax requests in the plugin are triggered by a single action hook
	 * Each route is determined by the request["action"]
	 * @return array|void
	 */
	protected function normalizeAjaxRequest()
	{
		$request = filter_input( INPUT_POST, 'request', FILTER_DEFAULT, FILTER_REQUIRE_ARRAY );
		if( isset( $request[Application::ID]['action'] )) {
			$request = $request[Application::ID];
		}
		if( !isset( $request['action'] )) {
			glsr_log()->error( 'The AJAX request must include an action' )->info( $request );
			wp_die();
		}
		if( !isset( $request['nonce'] )) {
			glsr_log()->error( 'The AJAX request must include a nonce' )->info( $request );
			wp_die();
		}
		$request['ajax_request'] = true;
		return $this->normalize( $request );
	}
}


1			<?php
2
3			namespace GeminiLabs\SiteReviews;
4
5			use GeminiLabs\SiteReviews\Application;
6			use GeminiLabs\SiteReviews\Controllers\AdminController;
7			use GeminiLabs\SiteReviews\Controllers\AjaxController;
8			use GeminiLabs\SiteReviews\Controllers\PublicController;
9			use GeminiLabs\SiteReviews\Helper;
10
11			class Router
12			{
13			/**
14			* @return void
15			*/
16			public function routeAdminPostRequest()
17			{
18			$request = filter_input( INPUT_POST, Application::ID, FILTER_DEFAULT, FILTER_REQUIRE_ARRAY );
19			if( !isset( $request['action'] ))return;
20			$this->checkNonce( $request['action'] );
21			$this->routeRequest( 'admin', $request['action'], $request );
22			}
23
24			/**
25			* @return void
26			*/
27			public function routeAjaxRequest()
28			{
29			$request = $this->normalizeAjaxRequest();
30			if( !wp_verify_nonce( $request['nonce'], $request['action'] )) {
31			glsr_log()->error( 'Nonce check failed for ajax request' )->info( $request );
32			wp_die( -1, 403 );
33			}
34			$this->routeRequest( 'ajax', $request['action'], $request );
35			wp_die();
36			}
37
38			/**
39			* @return void
40			*/
41			public function routePublicPostRequest()
42			{
43			$action = filter_input( INPUT_POST, 'action' );
			0 ignored issues – show Unused Code introduced 2018-06-01 13:28 UTC by Report Bug Copy Issue Report The assignment to `$action` is dead and can be removed. Loading history...
44			$request = $this->normalize( $_POST );
			0 ignored issues – show Unused Code introduced 2018-06-01 13:28 UTC by Report Bug Copy Issue Report The assignment to `$request` is dead and can be removed. Loading history...
45			// glsr_log( $this->normalize( $_POST ) );
			0 ignored issues – show Unused Code Comprehensibility introduced 2018-06-01 13:28 UTC by Report Bug Copy Issue Report `54%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
46			// $this->routeRequest( 'public', $action, $request );
			1 ignored issue – show Unused Code Comprehensibility introduced 2018-06-01 13:28 UTC by Report Bug Copy Issue Report `63%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
47			}
48
49			/**
50			* @param string $type
51			* @param string $action
52			* @return void
53			*/
54			public function routeRequest( $type, $action, array $request = [] )
55			{
56			$controller = glsr( glsr( Helper::class )->buildClassName( $type.'-controller', 'Controllers' ));
57			$method = glsr( Helper::class )->buildMethodName( $action, 'router' );
58			if( is_callable( [$controller, $method] )) {
59			call_user_func( [$controller, $method], $request );
60			return;
61			}
62			$response = do_action( 'site-reviews/route/'.$type.'/request', $action, $request );
			0 ignored issues – show Bug introduced 2018-06-01 13:28 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$response` is correct as `do_action('site-reviews/...st', $action, $request)` seems to always return `null`. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
63			if( empty( $response )) {
64			glsr_log( 'Unknown '.$type.' router request: '.$action );
65			}
66			}
67
68			/**
69			* @return void
70			*/
71			public function routeWebhookRequest()
72			{
73			$request = filter_input( INPUT_GET, sprintf( '%s-hook', Application::ID ));
74			if( !$request )return;
75			// @todo manage webhook here
76			}
77
78			/**
79			* @param string $action
80			* @return void
81			* @todo verify the $action-options
82			*/
83			protected function checkNonce( $action )
84			{
85			$nonce = filter_input( INPUT_POST, 'option_page' ) == $action
86			&& filter_input( INPUT_POST, 'action' ) == 'update'
87			? $action.'-options'
88			: $action;
89			check_admin_referer( $nonce );
90			}
91
92			/**
93			* Undo damage done by javascript: encodeURIComponent() and sanitize values
94			* @return array
95			*/
96			protected function normalize( array $request )
97			{
98			array_walk_recursive( $request, function( &$value ) {
99			$value = stripslashes( $value );
100			});
101			return $request;
102			}
103
104			/**
105			* All ajax requests in the plugin are triggered by a single action hook
106			* Each route is determined by the request["action"]
107			* @return array\|void
108			*/
109			protected function normalizeAjaxRequest()
110			{
111			$request = filter_input( INPUT_POST, 'request', FILTER_DEFAULT, FILTER_REQUIRE_ARRAY );
112			if( isset( $request[Application::ID]['action'] )) {
113			$request = $request[Application::ID];
114			}
115			if( !isset( $request['action'] )) {
116			glsr_log()->error( 'The AJAX request must include an action' )->info( $request );
117			wp_die();
118			}
119			if( !isset( $request['nonce'] )) {
120			glsr_log()->error( 'The AJAX request must include a nonce' )->info( $request );
121			wp_die();
122			}
123			$request['ajax_request'] = true;
124			return $this->normalize( $request );
125			}
126			}
127

pryley / site-reviews

Push — master ( 796b78...de3336 )

Router::routeRequest() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like