Api::setResponseApi() - Code Metrics - Inspection of "Update controller" - gplcart/api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a1153a...d5a137 )

by Iurii

created 2018-02-15 03:02 UTC

Api::setResponseApi() B

↳ Parent: Api

Complexity

Conditions	4
Paths	5

Size

Total Lines	24
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	4
eloc	13
c	2
b	0
f	0
nc	5
nop	0
dl	0
loc	24
rs	8.6845

<?php

/**
 * @package API
 * @author Iurii Makukh <[email protected]>
 * @copyright Copyright (c) 2018, Iurii Makukh
 * @license https://www.gnu.org/licenses/gpl.html GNU/GPLv3
 */

namespace gplcart\modules\api\controllers;

use Exception;
use gplcart\core\controllers\frontend\Controller;
use gplcart\modules\api\models\Api as ApiModel;
use gplcart\modules\api\models\User;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use RuntimeException;
use UnexpectedValueException;

/**
 * Handles incoming requests and outputs data related to API requests
 */
class Api extends Controller
{

    /**
     * Api model class instance
     * @var \gplcart\modules\api\models\Api $api
     */
    protected $api;

    /**
     * User model class instance
     * @var \gplcart\modules\api\models\User $apiuser
     */
    protected $apiuser;

    /**
     * The current API user
     * @var array
     */
    protected $data_user = array();

    /**
     * An array of arguments from URL
     * @var array
     */
    protected $data_arguments = array();

    /**
     * An array of API data to output
     * @var array
     */
    protected $data_response;

    /**
     * @param User $user
     * @param ApiModel $api
     */
    public function __construct(User $user, ApiModel $api)
    {
        parent::__construct();

        $this->api = $api;
        $this->apiuser = $user;
    }

    /**
     * Page callback
     * @param string $arguments
     */
    public function callbackApi($arguments = null)
    {
        try {
            $this->controlAccessApi();
            $this->setUserApi();
            $this->outputTokenApi();
            $this->setArgumentsApi($arguments);
            $this->setResponseApi();
        } catch (Exception $ex) {
            $code = $ex->getCode() ?: 403;
            $this->response->outputStatus($code);
        }

        $this->response->outputStatus(501);
    }

    /**
     * Controls access to API
     * @throws RuntimeException
     */
    protected function controlAccessApi()
    {
        if (!$this->api->getStatus()) {
            throw new RuntimeException('API is disabled', 403);
        }
    }

    /**
     * Sets the user data
     */
    protected function setUserApi()
    {
        $this->data_user = array();

        $client_id = $this->getPosted('client_id');
        $client_secret = $this->getPosted('client_secret');

        if (isset($client_id) && isset($client_secret)) {

            $condition = array(
                'secret' => $client_secret,
                'api_user_id' => $client_id
            );

            $this->data_user = $this->apiuser->get($condition);

            if (empty($this->data_user['status'])) {
                throw new RuntimeException('API user is disabled or not found', 403);
            }

            if (empty($this->data_user['user_status'])) {
                throw new RuntimeException('System user is disabled or not found', 403);
            }

            if (!empty($this->data_user['data']['ip']) && !in_array($this->getIp(), $this->data_user['data']['ip'])) {
                throw new RuntimeException('IP is not allowed for this API user', 403);
            }
        }
    }

    /**
     * Output JWT token
     */
    protected function outputTokenApi()
    {
        if (isset($this->data_user['api_user_id'])) {
            $token = $this->api->getToken($this->data_user['api_user_id']);
            $this->outputJson($token);
        }
    }

    /**
     * Output API response
     */
    protected function setResponseApi()
    {
        $this->data_response = null;


        $token = $this->getTokenFromHeaderApi();

        if (isset($token)) {

            try {
                $this->data_user = $this->api->getUserFromToken($token);
            } catch (Exception $ex) {
                throw new RuntimeException($ex->getMessage(), 401);
            }

            try {

                $this->hook->attach('module.api.process', $this->data_arguments, $this->data_user, $this->data_response, $this);
                $this->outputApi();

            } catch (Exception $ex) {
                throw new RuntimeException($ex->getMessage(), 500);
            }
        }
    }

    /**
     * Output API data
     * @throws RuntimeException
     */
    protected function outputApi()
    {
        if (!isset($this->data_response)) {
            throw new RuntimeException('Not content to output', 204);
        }

        $this->hook->attach('module.api.output', $this->data_arguments, $this->data_user, $this->data_response, $this);
        $this->outputJson($this->data_response);
    }

    /**
     * Returns a JWT token from the request header
     * @return null|string
     * @throws UnexpectedValueException
     */
    protected function getTokenFromHeaderApi()
    {
        $header = $this->server->header('Authorization');

        if (!isset($header)) {
            return null;
        }

        $parts = explode(' ', $header);

        if (count($parts) != 2) {
            throw new UnexpectedValueException('Invalid authorization header value', 400);
        }

        if (empty($parts[1])) {
            throw new UnexpectedValueException('Empty authorization token', 400);
        }

        return $parts[1];
    }

    /**
     * Sets an array of arguments from a string
     * @param string $path
     * @throws UnexpectedValueException
     */
    protected function setArgumentsApi($path)
    {
        $this->data_arguments = array(
            'arguments' => array_filter(explode('/', trim($path, '/'))));

        if (empty($this->data_arguments['arguments'])) {
            throw new UnexpectedValueException('Invalid number of arguments passed', 400);
        }

        $this->data_arguments['query'] = $this->getQuery(null, array(), 'array');

        if (isset($this->data_arguments['query']['version'])
            && version_compare($this->data_arguments['query']['version'], '0.0.1', '>=') < 0) {
            throw new UnexpectedValueException('Version has invalid value', 400);
        }
    }

}


1			<?php
2
3			/**
4			* @package API
5			* @author Iurii Makukh <[email protected]>
6			* @copyright Copyright (c) 2018, Iurii Makukh
7			* @license https://www.gnu.org/licenses/gpl.html GNU/GPLv3
8			*/
9
10			namespace gplcart\modules\api\controllers;
11
12			use Exception;
13			use gplcart\core\controllers\frontend\Controller;
14			use gplcart\modules\api\models\Api as ApiModel;
15			use gplcart\modules\api\models\User;
			0 ignored issues – show Bug introduced 2018-02-14 03:56 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `gplcart\modules\api\controllers\User`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
16			use RuntimeException;
17			use UnexpectedValueException;
18
19			/**
20			* Handles incoming requests and outputs data related to API requests
21			*/
22			class Api extends Controller
23			{
24
25			/**
26			* Api model class instance
27			* @var \gplcart\modules\api\models\Api $api
28			*/
29			protected $api;
30
31			/**
32			* User model class instance
33			* @var \gplcart\modules\api\models\User $apiuser
34			*/
35			protected $apiuser;
36
37			/**
38			* The current API user
39			* @var array
40			*/
41			protected $data_user = array();
42
43			/**
44			* An array of arguments from URL
45			* @var array
46			*/
47			protected $data_arguments = array();
48
49			/**
50			* An array of API data to output
51			* @var array
52			*/
53			protected $data_response;
54
55			/**
56			* @param User $user
57			* @param ApiModel $api
58			*/
59			public function __construct(User $user, ApiModel $api)
60			{
61			parent::__construct();
62
63			$this->api = $api;
64			$this->apiuser = $user;
65			}
66
67			/**
68			* Page callback
69			* @param string $arguments
70			*/
71			public function callbackApi($arguments = null)
72			{
73			try {
74			$this->controlAccessApi();
75			$this->setUserApi();
76			$this->outputTokenApi();
77			$this->setArgumentsApi($arguments);
78			$this->setResponseApi();
79			} catch (Exception $ex) {
80			$code = $ex->getCode() ?: 403;
81			$this->response->outputStatus($code);
82			}
83
84			$this->response->outputStatus(501);
85			}
86
87			/**
88			* Controls access to API
89			* @throws RuntimeException
90			*/
91			protected function controlAccessApi()
92			{
93			if (!$this->api->getStatus()) {
94			throw new RuntimeException('API is disabled', 403);
95			}
96			}
97
98			/**
99			* Sets the user data
100			*/
101			protected function setUserApi()
102			{
103			$this->data_user = array();
104
105			$client_id = $this->getPosted('client_id');
106			$client_secret = $this->getPosted('client_secret');
107
108			if (isset($client_id) && isset($client_secret)) {
109
110			$condition = array(
111			'secret' => $client_secret,
112			'api_user_id' => $client_id
113			);
114
115			$this->data_user = $this->apiuser->get($condition);
116
117			if (empty($this->data_user['status'])) {
118			throw new RuntimeException('API user is disabled or not found', 403);
119			}
120
121			if (empty($this->data_user['user_status'])) {
122			throw new RuntimeException('System user is disabled or not found', 403);
123			}
124
125			if (!empty($this->data_user['data']['ip']) && !in_array($this->getIp(), $this->data_user['data']['ip'])) {
126			throw new RuntimeException('IP is not allowed for this API user', 403);
127			}
128			}
129			}
130
131			/**
132			* Output JWT token
133			*/
134			protected function outputTokenApi()
135			{
136			if (isset($this->data_user['api_user_id'])) {
137			$token = $this->api->getToken($this->data_user['api_user_id']);
138			$this->outputJson($token);
139			}
140			}
141
142			/**
143			* Output API response
144			*/
145			protected function setResponseApi()
146			{
147			$this->data_response = null;
			0 ignored issues – show Documentation Bug introduced 2018-02-14 03:56 UTC by Report Bug Copy Issue Report It seems like `null` of type `null` is incompatible with the declared type `array` of property `$data_response`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
148
149			$token = $this->getTokenFromHeaderApi();
150
151			if (isset($token)) {
152
153			try {
154			$this->data_user = $this->api->getUserFromToken($token);
155			} catch (Exception $ex) {
156			throw new RuntimeException($ex->getMessage(), 401);
157			}
158
159			try {
160
161			$this->hook->attach('module.api.process', $this->data_arguments, $this->data_user, $this->data_response, $this);
162			$this->outputApi();
163
164			} catch (Exception $ex) {
165			throw new RuntimeException($ex->getMessage(), 500);
166			}
167			}
168			}
169
170			/**
171			* Output API data
172			* @throws RuntimeException
173			*/
174			protected function outputApi()
175			{
176			if (!isset($this->data_response)) {
177			throw new RuntimeException('Not content to output', 204);
178			}
179
180			$this->hook->attach('module.api.output', $this->data_arguments, $this->data_user, $this->data_response, $this);
181			$this->outputJson($this->data_response);
182			}
183
184			/**
185			* Returns a JWT token from the request header
186			* @return null\|string
187			* @throws UnexpectedValueException
188			*/
189			protected function getTokenFromHeaderApi()
190			{
191			$header = $this->server->header('Authorization');
192
193			if (!isset($header)) {
194			return null;
195			}
196
197			$parts = explode(' ', $header);
198
199			if (count($parts) != 2) {
200			throw new UnexpectedValueException('Invalid authorization header value', 400);
201			}
202
203			if (empty($parts[1])) {
204			throw new UnexpectedValueException('Empty authorization token', 400);
205			}
206
207			return $parts[1];
208			}
209
210			/**
211			* Sets an array of arguments from a string
212			* @param string $path
213			* @throws UnexpectedValueException
214			*/
215			protected function setArgumentsApi($path)
216			{
217			$this->data_arguments = array(
218			'arguments' => array_filter(explode('/', trim($path, '/'))));
219
220			if (empty($this->data_arguments['arguments'])) {
221			throw new UnexpectedValueException('Invalid number of arguments passed', 400);
222			}
223
224			$this->data_arguments['query'] = $this->getQuery(null, array(), 'array');
225
226			if (isset($this->data_arguments['query']['version'])
227			&& version_compare($this->data_arguments['query']['version'], '0.0.1', '>=') < 0) {
228			throw new UnexpectedValueException('Version has invalid value', 400);
229			}
230			}
231
232			}
233

gplcart / api

Push — master ( a1153a...d5a137 )

Api::setResponseApi() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like