HttpKernel::run() - Code Metrics - Inspection of "Refactor HttpKernel and Router flow" - htmlburger/wpemerge - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — refactor/kernels (b26d95)

by Atanas

created 2019-04-11 21:08 UTC

HttpKernel::run() A

↳ Parent: HttpKernel

Complexity

Conditions	2
Paths	5

Size

Total Lines	19
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	2

Importance

Changes

Metric	Value
cc	2
eloc	13
nc	5
nop	4
dl	0
loc	19
ccs	13
cts	13
cp	1
crap	2
rs	9.8333
c	0
b	0
f	0

<?php
/**
 * @package   WPEmerge
 * @author    Atanas Angelov <[email protected]>
 * @copyright 2018 Atanas Angelov
 * @license   https://www.gnu.org/licenses/gpl-2.0.html GPL-2.0
 * @link      https://wpemerge.com/
 */

namespace WPEmerge\Kernels;

use Exception;
use Psr\Http\Message\ResponseInterface;
use WPEmerge\Application\Application;
use WPEmerge\Exceptions\ErrorHandlerInterface;
use WPEmerge\Facades\Response;
use WPEmerge\Requests\RequestInterface;
use WPEmerge\Routing\HasMiddlewareDefinitionsTrait;
use WPEmerge\Routing\HasQueryFilterInterface;
use WPEmerge\Routing\Pipeline;
use WPEmerge\Routing\Router;
use WPEmerge\Routing\SortsMiddlewareTrait;

/**
 * Describes how a request is handled.
 */
class HttpKernel implements HttpKernelInterface {
	use HasMiddlewareDefinitionsTrait;
	use SortsMiddlewareTrait;

	/**
	 * Application.
	 *
	 * @var Application
	 */
	protected $app = null;

	/**
	 * Request.
	 *
	 * @var RequestInterface
	 */
	protected $request = null;

	/**
	 * Router.
	 *
	 * @var Router
	 */
	protected $router = null;

	/**
	 * Error handler.
	 *
	 * @var ErrorHandlerInterface
	 */
	protected $error_handler = null;

	/**
	 * Constructor.
	 *
	 * @codeCoverageIgnore
	 * @param RequestInterface      $request
	 * @param Router                $router
	 * @param ErrorHandlerInterface $error_handler
	 */
	public function __construct( Application $app, RequestInterface $request, Router $router, ErrorHandlerInterface $error_handler ) {
		$this->app = $app;
		$this->request = $request;
		$this->router = $router;
		$this->error_handler = $error_handler;
	}

	/**
	 * {@inheritDoc}
	 * @codeCoverageIgnore
	 */
	public function bootstrap() {
		$this->router->setMiddleware( $this->middleware );
		$this->router->setMiddlewareGroups( $this->middleware_groups );
		$this->router->setMiddlewarePriority( $this->middleware_priority );

		// Web.
		add_action( 'request', [$this, 'filterRequest'], 1000 );
		add_action( 'template_include', [$this, 'filterTemplateInclude'], 1000 );

		// Ajax.
		add_action( 'admin_init', [$this, 'registerAjaxAction'] );

		// Admin.
		add_action( 'admin_init', [$this, 'registerAdminAction'] );
	}

	/**
	 * {@inheritDoc}
	 */
	public function handle( RequestInterface $request, $arguments = [] ) {
		$route = $this->router->execute( $request, $arguments );

		if ( $route === null ) {
			return null;
		}

		$handler = function () use ( $route ) {
			return call_user_func_array( [$route, 'handle'], func_get_args() );
		};

		$response = $this->run( $request, $route->getMiddleware(), $handler, $arguments );

		$container = $this->app->getContainer();
		$container[ WPEMERGE_RESPONSE_KEY ] = $response;

		return $response;
	}

	/**
	 * {@inheritDoc}
	 */
	public function run( RequestInterface $request, $middleware, $handler, $arguments = [] ) {
		$this->error_handler->register();

		try {
			$middleware = $this->expandMiddleware( $middleware );
			$middleware = $this->uniqueMiddleware( $middleware );
			$middleware = $this->sortMiddleware( $middleware );

			$response = ( new Pipeline() )
				->middleware( $middleware )
				->to( $handler )
				->run( $request, [$request, $arguments] );
		} catch ( Exception $exception ) {
			$response = $this->error_handler->getResponse( $request, $exception );
		}

		$this->error_handler->unregister();

		return $response;
	}

	/**
	 * Filter the main query vars.
	 *
	 * @param  array $query_vars
	 * @return array
	 */
	public function filterRequest( $query_vars ) {
		$routes = $this->router->getRoutes();

		foreach ( $routes as $route ) {
			if ( ! $route instanceof HasQueryFilterInterface ) {
				continue;
			}

			if ( ! $route->isSatisfied( $this->request ) ) {
				continue;
			}

			$query_vars = $route->applyQueryFilter( $this->request, $query_vars );
			break;
		}

		return $query_vars;
	}

	/**
	 * Filter the main template file.
	 *
	 * @param  string $view
	 * @return string
	 */
	public function filterTemplateInclude( $view ) {
		global $wp_query;

		$response = $this->handle( $this->request, [$view] );

		if ( $response instanceof ResponseInterface ) {
			if ( $response->getStatusCode() === 404 ) {
				$wp_query->set_404();
			}

			return WPEMERGE_DIR . DIRECTORY_SEPARATOR . 'src' . DIRECTORY_SEPARATOR . 'view.php';
		}

		return $view;
	}

	/**
	 * Register ajax action to hook into current one.
	 *
	 * @return void
	 */
	public function registerAjaxAction() {
		if ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX ) {
			return;
		}

		$action = $this->request->post( 'action', $this->request->get( 'action' ) );
		$action = sanitize_text_field( $action );

		add_action( "wp_ajax_{$action}", [$this, 'actionAjax'] );
		add_action( "wp_ajax_nopriv_{$action}", [$this, 'actionAjax'] );
	}

	/**
	 * Act on ajax action.
	 *
	 * @return void
	 */
	public function actionAjax() {
		$response = $this->handle( $this->request, [''] );

		if ( ! $response instanceof ResponseInterface ) {
			return;
		}

		$this->app->respond( $response );
		wp_die( '', '', ['response' => null] );
	}

	/**
	 * Get page hook.
	 * Slightly modified version of code from wp-admin/admin.php.
	 *
	 * @param  string $page_hook
	 * @return string
	 */
	protected function getAdminPageHook() {
		global $pagenow, $typenow, $plugin_page;

		$page_hook = '';
		if ( isset( $plugin_page ) ) {
			if ( ! empty( $typenow ) ) {
				$the_parent = $pagenow . '?post_type=' . $typenow;
			} else {
				$the_parent = $pagenow;
			}

			$page_hook = get_plugin_page_hook( $plugin_page, $the_parent );
		}

		return $page_hook;
	}

	/**
	 * Get admin page hook.
	 * Slightly modified version of code from wp-admin/admin.php.
	 *
	 * @param  string $page_hook
	 * @return string
	 */
	protected function getAdminHook( $page_hook ) {
		global $pagenow, $plugin_page;

		$hook_suffix = '';
		if ( ! empty( $page_hook ) ) {
			$hook_suffix = $page_hook;
		} else if ( isset( $plugin_page ) ) {
			$hook_suffix = $plugin_page;
		} else if ( isset( $pagenow ) ) {
			$hook_suffix = $pagenow;
		}

		return $hook_suffix;
	}

	/**
	 * Register admin action to hook into current one.
	 *
	 * @return void
	 */
	public function registerAdminAction() {
		global $pagenow;

		if ( $pagenow !== 'admin.php' ) {
			return;
		}

		$page_hook = $this->getAdminPageHook();
		$hook_suffix = $this->getAdminHook( $page_hook );

		add_action( "load-{$hook_suffix}", [$this, 'actionAdminLoad'] );
		add_action( $hook_suffix, [$this, 'actionAdmin'] );
	}

	/**
	 * Act on admin action load.
	 *
	 * @return void
	 */
	public function actionAdminLoad() {
		$response = $this->handle( $this->request, [''] );

		if ( ! $response instanceof ResponseInterface ) {
			return;
		}

		if ( ! headers_sent() ) {
			Response::sendHeaders( $response );
		}
	}

	/**
	 * Act on admin action.
	 *
	 * @return void
	 */
	public function actionAdmin() {
		$response = $this->app->resolve( WPEMERGE_RESPONSE_KEY );

		if ( $response === null ) {
			return;
		}

		Response::sendBody( $response );
	}
}


1		<?php
2		/**
3		* @package WPEmerge
4		* @author Atanas Angelov <[email protected]>
5		* @copyright 2018 Atanas Angelov
6		* @license https://www.gnu.org/licenses/gpl-2.0.html GPL-2.0
7		* @link https://wpemerge.com/
8		*/
9
10		namespace WPEmerge\Kernels;
11
12		use Exception;
13		use Psr\Http\Message\ResponseInterface;
14		use WPEmerge\Application\Application;
15		use WPEmerge\Exceptions\ErrorHandlerInterface;
16		use WPEmerge\Facades\Response;
17		use WPEmerge\Requests\RequestInterface;
18		use WPEmerge\Routing\HasMiddlewareDefinitionsTrait;
19		use WPEmerge\Routing\HasQueryFilterInterface;
20		use WPEmerge\Routing\Pipeline;
21		use WPEmerge\Routing\Router;
22		use WPEmerge\Routing\SortsMiddlewareTrait;
23
24		/**
25		* Describes how a request is handled.
26		*/
27		class HttpKernel implements HttpKernelInterface {
28		use HasMiddlewareDefinitionsTrait;
29		use SortsMiddlewareTrait;
30
31		/**
32		* Application.
33		*
34		* @var Application
35		*/
36		protected $app = null;
37
38		/**
39		* Request.
40		*
41		* @var RequestInterface
42		*/
43		protected $request = null;
44
45		/**
46		* Router.
47		*
48		* @var Router
49		*/
50		protected $router = null;
51
52		/**
53		* Error handler.
54		*
55		* @var ErrorHandlerInterface
56		*/
57		protected $error_handler = null;
58
59		/**
60		* Constructor.
61		*
62		* @codeCoverageIgnore
63		* @param RequestInterface $request
64		* @param Router $router
65		* @param ErrorHandlerInterface $error_handler
66		*/
67		public function __construct( Application $app, RequestInterface $request, Router $router, ErrorHandlerInterface $error_handler ) {
68		$this->app = $app;
69		$this->request = $request;
70		$this->router = $router;
71		$this->error_handler = $error_handler;
72		}
73
74		/**
75		* {@inheritDoc}
76		* @codeCoverageIgnore
77		*/
78		public function bootstrap() {
79		$this->router->setMiddleware( $this->middleware );
80		$this->router->setMiddlewareGroups( $this->middleware_groups );
81		$this->router->setMiddlewarePriority( $this->middleware_priority );
82
83		// Web.
84		add_action( 'request', [$this, 'filterRequest'], 1000 );
85		add_action( 'template_include', [$this, 'filterTemplateInclude'], 1000 );
86
87		// Ajax.
88		add_action( 'admin_init', [$this, 'registerAjaxAction'] );
89
90		// Admin.
91		add_action( 'admin_init', [$this, 'registerAdminAction'] );
92		}
93
94		/**
95		* {@inheritDoc}
96		*/
97	2	public function handle( RequestInterface $request, $arguments = [] ) {
98	2	$route = $this->router->execute( $request, $arguments );
99
100	2	if ( $route === null ) {
101	1	return null;
102		}
103
104	1	$handler = function () use ( $route ) {
105	1	return call_user_func_array( [$route, 'handle'], func_get_args() );
106	1	};
107
108	1	$response = $this->run( $request, $route->getMiddleware(), $handler, $arguments );
109
110	1	$container = $this->app->getContainer();
111	1	$container[ WPEMERGE_RESPONSE_KEY ] = $response;
112
113	1	return $response;
114		}
115
116		/**
117		* {@inheritDoc}
118		*/
119	2	public function run( RequestInterface $request, $middleware, $handler, $arguments = [] ) {
120	2	$this->error_handler->register();
121
122		try {
123	2	$middleware = $this->expandMiddleware( $middleware );
124	2	$middleware = $this->uniqueMiddleware( $middleware );
125	2	$middleware = $this->sortMiddleware( $middleware );
126
127	2	$response = ( new Pipeline() )
128	2	->middleware( $middleware )
129	2	->to( $handler )
130	2	->run( $request, [$request, $arguments] );
131	2	} catch ( Exception $exception ) {
132	1	$response = $this->error_handler->getResponse( $request, $exception );
133		}
134
135	1	$this->error_handler->unregister();
136
137	1	return $response;
138		}
139
140		/**
141		* Filter the main query vars.
142		*
143		* @param array $query_vars
144		* @return array
145		*/
146	2	public function filterRequest( $query_vars ) {
147	2	$routes = $this->router->getRoutes();
148
149	2	foreach ( $routes as $route ) {
150	2	if ( ! $route instanceof HasQueryFilterInterface ) {
151	2	continue;
152		}
153
154	2	if ( ! $route->isSatisfied( $this->request ) ) {
155	1	continue;
156		}
157
158	2	$query_vars = $route->applyQueryFilter( $this->request, $query_vars );
159	2	break;
160	2	}
161
162	2	return $query_vars;
163		}
164
165		/**
166		* Filter the main template file.
167		*
168		* @param string $view
169		* @return string
170		*/
171	3	public function filterTemplateInclude( $view ) {
172	3	global $wp_query;
173
174	3	$response = $this->handle( $this->request, [$view] );
175
176	3	if ( $response instanceof ResponseInterface ) {
177	2	if ( $response->getStatusCode() === 404 ) {
178	1	$wp_query->set_404();
179	1	}
180
181	2	return WPEMERGE_DIR . DIRECTORY_SEPARATOR . 'src' . DIRECTORY_SEPARATOR . 'view.php';
182		}
183
184	1	return $view;
185		}
186
187		/**
188		* Register ajax action to hook into current one.
189		*
190		* @return void
191		*/
192		public function registerAjaxAction() {
193		if ( ! defined( 'DOING_AJAX' ) \|\| ! DOING_AJAX ) {
194		return;
195		}
196
197		$action = $this->request->post( 'action', $this->request->get( 'action' ) );
198		$action = sanitize_text_field( $action );
199
200		add_action( "wp_ajax_{$action}", [$this, 'actionAjax'] );
201		add_action( "wp_ajax_nopriv_{$action}", [$this, 'actionAjax'] );
202		}
203
204		/**
205		* Act on ajax action.
206		*
207		* @return void
208		*/
209		public function actionAjax() {
210		$response = $this->handle( $this->request, [''] );
211
212		if ( ! $response instanceof ResponseInterface ) {
213		return;
214		}
215
216		$this->app->respond( $response );
217		wp_die( '', '', ['response' => null] );
218		}
219
220		/**
221		* Get page hook.
222		* Slightly modified version of code from wp-admin/admin.php.
223		*
224		* @param string $page_hook
225		* @return string
226		*/
227		protected function getAdminPageHook() {
228		global $pagenow, $typenow, $plugin_page;
229
230		$page_hook = '';
231		if ( isset( $plugin_page ) ) {
232		if ( ! empty( $typenow ) ) {
233		$the_parent = $pagenow . '?post_type=' . $typenow;
234		} else {
235		$the_parent = $pagenow;
236		}
237
238		$page_hook = get_plugin_page_hook( $plugin_page, $the_parent );
239		}
240
241		return $page_hook;
242		}
243
244		/**
245		* Get admin page hook.
246		* Slightly modified version of code from wp-admin/admin.php.
247		*
248		* @param string $page_hook
249		* @return string
250		*/
251		protected function getAdminHook( $page_hook ) {
252		global $pagenow, $plugin_page;
253
254		$hook_suffix = '';
255		if ( ! empty( $page_hook ) ) {
256		$hook_suffix = $page_hook;
257		} else if ( isset( $plugin_page ) ) {
258		$hook_suffix = $plugin_page;
259		} else if ( isset( $pagenow ) ) {
260		$hook_suffix = $pagenow;
261		}
262
263		return $hook_suffix;
264		}
265
266		/**
267		* Register admin action to hook into current one.
268		*
269		* @return void
270		*/
271		public function registerAdminAction() {
272		global $pagenow;
273
274		if ( $pagenow !== 'admin.php' ) {
275		return;
276		}
277
278		$page_hook = $this->getAdminPageHook();
279		$hook_suffix = $this->getAdminHook( $page_hook );
280
281		add_action( "load-{$hook_suffix}", [$this, 'actionAdminLoad'] );
282		add_action( $hook_suffix, [$this, 'actionAdmin'] );
283		}
284
285		/**
286		* Act on admin action load.
287		*
288		* @return void
289		*/
290		public function actionAdminLoad() {
291		$response = $this->handle( $this->request, [''] );
292
293		if ( ! $response instanceof ResponseInterface ) {
294		return;
295		}
296
297		if ( ! headers_sent() ) {
298		Response::sendHeaders( $response );
299		}
300		}
301
302		/**
303		* Act on admin action.
304		*
305		* @return void
306		*/
307		public function actionAdmin() {
308		$response = $this->app->resolve( WPEMERGE_RESPONSE_KEY );
309
310		if ( $response === null ) {
311		return;
312		}
313
314		Response::sendBody( $response );
315		}
316		}
317

htmlburger / wpemerge

Branch — refactor/kernels (b26d95)

HttpKernel::run() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like