Service::run() - Code Metrics - Inspection of "Merge remote-tracking branch 'origin/rewrite'" - fkooman/php-remote-storage - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 994736...366350 )

by François

created 2017-01-13 10:30 UTC

Service::run() D

↳ Parent: Service

Complexity

Conditions	11
Paths	180

Size

Total Lines	79
Code Lines	43

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	79
rs	4.9999
c	0
b	0
f	0
cc	11
eloc	43
nc	180
nop	1

How to fix Long Method Complexity

<?php
/**
 *  Copyright (C) 2016 SURFnet.
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Affero General Public License as
 *  published by the Free Software Foundation, either version 3 of the
 *  License, or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Affero General Public License for more details.
 *
 *  You should have received a copy of the GNU Affero General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

namespace fkooman\RemoteStorage\Http;

use fkooman\RemoteStorage\Http\Exception\HttpException;
use fkooman\RemoteStorage\Http\Exception\InputValidationException;
use fkooman\RemoteStorage\TplInterface;

class Service
{
    /** @var \SURFnet\VPN\Common\TplInterface|null */
    private $tpl;

    /** @var array */
    private $routes;

    /** @var array */
    private $beforeHooks;

    /** @var array */
    private $afterHooks;

    public function __construct(TplInterface $tpl = null)
    {
        $this->tpl = $tpl;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
        $this->routes = [
            'GET' => [],
            'POST' => [],
        ];
        $this->beforeHooks = [];
        $this->afterHooks = [];
    }

    public function addBeforeHook($name, BeforeHookInterface $beforeHook)
    {
        $this->beforeHooks[$name] = $beforeHook;
    }

    public function addAfterHook($name, AfterHookInterface $afterHook)
    {
        $this->afterHooks[$name] = $afterHook;
    }

    public function addRoute($requestMethod, $pathInfo, callable $callback)
    {
        $this->routes[$requestMethod][$pathInfo] = $callback;
    }

    public function get($pathInfo, callable $callback)
    {
        $this->addRoute('GET', $pathInfo, $callback);
    }

    public function post($pathInfo, callable $callback)
    {
        $this->addRoute('POST', $pathInfo, $callback);
    }

    public function put($pathInfo, callable $callback)
    {
        $this->addRoute('PUT', $pathInfo, $callback);
    }

    public function delete($pathInfo, callable $callback)
    {
        $this->addRoute('DELETE', $pathInfo, $callback);
    }

    public function options($pathInfo, callable $callback)
    {
        $this->addRoute('OPTIONS', $pathInfo, $callback);
    }

    public function head($pathInfo, callable $callback)
    {
        $this->addRoute('HEAD', $pathInfo, $callback);
    }

    public function addModule(ServiceModuleInterface $module)
    {
        $module->init($this);
    }

    public function run(Request $request)
    {
        try {
            // before hooks
            $hookData = [];
            foreach ($this->beforeHooks as $k => $v) {
                $hookResponse = $v->executeBefore($request, $hookData);
                // if we get back a Response object, return it immediately
                if ($hookResponse instanceof Response) {
                    // run afterHooks
                    return $this->runAfterHooks($request, $hookResponse);
                }

                $hookData[$k] = $hookResponse;
            }

            $requestMethod = $request->getRequestMethod();
            $pathInfo = $request->getPathInfo();

            if (!array_key_exists($requestMethod, $this->routes)) {
                throw new HttpException(
                    sprintf('method "%s" not allowed', $requestMethod),
                    405,
                    ['Allow' => implode(',', array_keys($this->routes))]
                );
            }

            if (!array_key_exists($pathInfo, $this->routes[$requestMethod])) {
                if (!array_key_exists('*', $this->routes[$requestMethod])) {
                    throw new HttpException(
                        sprintf('"%s" not found', $pathInfo),
                        404
                    );
                }

                $pathInfo = '*';
            }

            $response = $this->routes[$requestMethod][$pathInfo]($request, $hookData);

            // after hooks
            return $this->runAfterHooks($request, $response);
        } catch (InputValidationException $e) {
            // in case an InputValidationException is encountered, convert it
            // into a Bad Request HTTP response
            throw new HttpException($e->getMessage(), 400);
        } catch (HttpException $e) {
            if ($request->isBrowser()) {
                if (is_null($this->tpl)) {
                    // template not available
                    $response = new Response($e->getCode(), 'text/plain');
                    $response->setBody(sprintf('%d: %s', $e->getCode(), $e->getMessage()));
                } else {
                    // template available
                    $response = new Response($e->getCode(), 'text/html');
                    $response->setBody(
                        $this->tpl->render(
                            'errorPage',
                            [
                                'code' => $e->getCode(),
                                'message' => $e->getMessage(),
                            ]
                        )
                    );
                }
            } else {
                // not a browser
                $response = new Response($e->getCode(), 'application/json');
                $response->setBody(json_encode(['error' => $e->getMessage()]));
            }

            foreach ($e->getResponseHeaders() as $key => $value) {
                $response->addHeader($key, $value);
            }

            // after hooks
            return $this->runAfterHooks($request, $response);
        }
    }

    private function runAfterHooks(Request $request, Response $response)
    {
        foreach ($this->afterHooks as $v) {
            $response = $v->executeAfter($request, $response);
        }

        return $response;
    }
}


1			<?php
2			/**
3			* Copyright (C) 2016 SURFnet.
4			*
5			* This program is free software: you can redistribute it and/or modify
6			* it under the terms of the GNU Affero General Public License as
7			* published by the Free Software Foundation, either version 3 of the
8			* License, or (at your option) any later version.
9			*
10			* This program is distributed in the hope that it will be useful,
11			* but WITHOUT ANY WARRANTY; without even the implied warranty of
12			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13			* GNU Affero General Public License for more details.
14			*
15			* You should have received a copy of the GNU Affero General Public License
16			* along with this program. If not, see <http://www.gnu.org/licenses/>.
17			*/
18
19			namespace fkooman\RemoteStorage\Http;
20
21			use fkooman\RemoteStorage\Http\Exception\HttpException;
22			use fkooman\RemoteStorage\Http\Exception\InputValidationException;
23			use fkooman\RemoteStorage\TplInterface;
24
25			class Service
26			{
27			/** @var \SURFnet\VPN\Common\TplInterface\|null */
28			private $tpl;
29
30			/** @var array */
31			private $routes;
32
33			/** @var array */
34			private $beforeHooks;
35
36			/** @var array */
37			private $afterHooks;
38
39			public function __construct(TplInterface $tpl = null)
40			{
41			$this->tpl = $tpl;
			0 ignored issues – show Documentation Bug introduced 2017-01-13 10:38 UTC by Report Bug Copy Issue Report It seems like `$tpl` can also be of type `object<fkooman\RemoteStorage\TplInterface>`. However, the property `$tpl` is declared as type `object<SURFnet\VPN\Common\TplInterface>\|null`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
42			$this->routes = [
43			'GET' => [],
44			'POST' => [],
45			];
46			$this->beforeHooks = [];
47			$this->afterHooks = [];
48			}
49
50			public function addBeforeHook($name, BeforeHookInterface $beforeHook)
51			{
52			$this->beforeHooks[$name] = $beforeHook;
53			}
54
55			public function addAfterHook($name, AfterHookInterface $afterHook)
56			{
57			$this->afterHooks[$name] = $afterHook;
58			}
59
60			public function addRoute($requestMethod, $pathInfo, callable $callback)
61			{
62			$this->routes[$requestMethod][$pathInfo] = $callback;
63			}
64
65			public function get($pathInfo, callable $callback)
66			{
67			$this->addRoute('GET', $pathInfo, $callback);
68			}
69
70			public function post($pathInfo, callable $callback)
71			{
72			$this->addRoute('POST', $pathInfo, $callback);
73			}
74
75			public function put($pathInfo, callable $callback)
76			{
77			$this->addRoute('PUT', $pathInfo, $callback);
78			}
79
80			public function delete($pathInfo, callable $callback)
81			{
82			$this->addRoute('DELETE', $pathInfo, $callback);
83			}
84
85			public function options($pathInfo, callable $callback)
86			{
87			$this->addRoute('OPTIONS', $pathInfo, $callback);
88			}
89
90			public function head($pathInfo, callable $callback)
91			{
92			$this->addRoute('HEAD', $pathInfo, $callback);
93			}
94
95			public function addModule(ServiceModuleInterface $module)
96			{
97			$module->init($this);
98			}
99
100			public function run(Request $request)
101			{
102			try {
103			// before hooks
104			$hookData = [];
105			foreach ($this->beforeHooks as $k => $v) {
106			$hookResponse = $v->executeBefore($request, $hookData);
107			// if we get back a Response object, return it immediately
108			if ($hookResponse instanceof Response) {
109			// run afterHooks
110			return $this->runAfterHooks($request, $hookResponse);
111			}
112
113			$hookData[$k] = $hookResponse;
114			}
115
116			$requestMethod = $request->getRequestMethod();
117			$pathInfo = $request->getPathInfo();
118
119			if (!array_key_exists($requestMethod, $this->routes)) {
120			throw new HttpException(
121			sprintf('method "%s" not allowed', $requestMethod),
122			405,
123			['Allow' => implode(',', array_keys($this->routes))]
124			);
125			}
126
127			if (!array_key_exists($pathInfo, $this->routes[$requestMethod])) {
128			if (!array_key_exists('*', $this->routes[$requestMethod])) {
129			throw new HttpException(
130			sprintf('"%s" not found', $pathInfo),
131			404
132			);
133			}
134
135			$pathInfo = '*';
136			}
137
138			$response = $this->routes[$requestMethod][$pathInfo]($request, $hookData);
139
140			// after hooks
141			return $this->runAfterHooks($request, $response);
142			} catch (InputValidationException $e) {
143			// in case an InputValidationException is encountered, convert it
144			// into a Bad Request HTTP response
145			throw new HttpException($e->getMessage(), 400);
146			} catch (HttpException $e) {
147			if ($request->isBrowser()) {
148			if (is_null($this->tpl)) {
149			// template not available
150			$response = new Response($e->getCode(), 'text/plain');
151			$response->setBody(sprintf('%d: %s', $e->getCode(), $e->getMessage()));
152			} else {
153			// template available
154			$response = new Response($e->getCode(), 'text/html');
155			$response->setBody(
156			$this->tpl->render(
157			'errorPage',
158			[
159			'code' => $e->getCode(),
160			'message' => $e->getMessage(),
161			]
162			)
163			);
164			}
165			} else {
166			// not a browser
167			$response = new Response($e->getCode(), 'application/json');
168			$response->setBody(json_encode(['error' => $e->getMessage()]));
169			}
170
171			foreach ($e->getResponseHeaders() as $key => $value) {
172			$response->addHeader($key, $value);
173			}
174
175			// after hooks
176			return $this->runAfterHooks($request, $response);
177			}
178			}
179
180			private function runAfterHooks(Request $request, Response $response)
181			{
182			foreach ($this->afterHooks as $v) {
183			$response = $v->executeAfter($request, $response);
184			}
185
186			return $response;
187			}
188			}
189

fkooman / php-remote-storage

GitHub Access Token became invalid

Push — master ( 994736...366350 )

Service::run() D

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like