ApiModule - Code Metrics - fkooman/php-remote-storage - Measure and Improve Code Quality continuously with Scrutinizer

ApiModule C
last analyzed 2017-04-15 07:37 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	391
Duplicated Lines	6.65 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes	4
Bugs	1	Features	0

Metric	Value
wmc	59
c	4
b	1
f	0
lcom	1
cbo	6
dl	26
loc	391
rs	6.1904

16 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	get()	0	8	1
A	head()	0	9	1
A	put()	0	7	1
A	delete()	0	7	1
A	options()	0	15	1
B	getObject()	0	25	5
C	getFolder()	9	46	7
C	getDocument()	8	64	10
C	putDocument()	3	48	9
C	deleteDocument()	6	48	8
B	stripQuotes()	0	26	6
A	hasReadScope()	0	18	3
A	hasWriteScope()	0	16	3
A	addCors()	0	8	1
A	addNoCache()	0	5	1

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like ApiModule often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use ApiModule, and based on these observations, apply Extract Interface, too.

<?php

/**
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser 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 Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

namespace fkooman\RemoteStorage;

use fkooman\RemoteStorage\Http\Exception\HttpException;
use fkooman\RemoteStorage\Http\Request;
use fkooman\RemoteStorage\Http\Response;
use fkooman\RemoteStorage\OAuth\TokenInfo;

class ApiModule
{
    /** @var RemoteStorage */
    private $remoteStorage;

    /** @var string */
    private $serverMode;

    public function __construct(RemoteStorage $remoteStorage, $serverMode)
    {
        $this->remoteStorage = $remoteStorage;
        $this->serverMode = $serverMode;
    }

    /**
     * @param Request                                      $request
     * @param \fkooman\RemoteStorage\OAuth\TokenInfo|false $tokenInfo
     */
    public function get(Request $request, $tokenInfo)
    {
        $response = $this->getObject($request, $tokenInfo);
        $this->addNoCache($response);
        $this->addCors($response);

        return $response;
    }

    public function head(Request $request, $tokenInfo)
    {
        // XXX return headers only?
        $response = $this->getObject($request, $tokenInfo);
        $this->addNoCache($response);
        $this->addCors($response);

        return $response;
    }

    public function put(Request $request, TokenInfo $tokenInfo)
    {
        $response = $this->putDocument($request, $tokenInfo);
        $this->addCors($response);

        return $response;
    }

    public function delete(Request $request, TokenInfo $tokenInfo)
    {
        $response = $this->deleteDocument($request, $tokenInfo);
        $this->addCors($response);

        return $response;
    }

    public function options(Request $request)

    {
        $response = new Response();
        $response->addHeader(
            'Access-Control-Allow-Methods',
            'GET, PUT, DELETE, HEAD, OPTIONS'
        );
        $response->addHeader(
            'Access-Control-Allow-Headers',
            'Authorization, Content-Length, Content-Type, Origin, X-Requested-With, If-Match, If-None-Match'
        );
        $this->addCors($response);

        return $response;
    }

    /**
     * @param Request         $request
     * @param TokenInfo|false $tokenInfo
     */
    public function getObject(Request $request, $tokenInfo)
    {
        $path = new Path($request->getPathInfo());

        // allow requests to public files (GET|HEAD) without authentication
        if ($path->getIsPublic() && $path->getIsDocument()) {
            // XXX create a getPublicDocument call instead to make sure?
            return $this->getDocument($path, $request, $tokenInfo);
        }

        // past this point we MUST be authenticated
        if (false === $tokenInfo) {
            throw new HttpException(
                'no_token',
                401,
                ['WWW-Authenticate' => 'Bearer realm="remoteStorage API"']
            );
        }

        if ($path->getIsFolder()) {
            return $this->getFolder($path, $request, $tokenInfo);
        }

        return $this->getDocument($path, $request, $tokenInfo);
    }

    public function getFolder(Path $path, Request $request, TokenInfo $tokenInfo)
    {
        if ($path->getUserId() !== $tokenInfo->getUserId()) {
            throw new HttpException('path does not match authorized subject', 403);
        }
        if (!$this->hasReadScope($tokenInfo->getScope(), $path->getModuleName())) {
            throw new HttpException('path does not match authorized scope', 403);
        }

        $folderVersion = $this->remoteStorage->getVersion($path);
        if (null === $folderVersion) {
            // folder does not exist, so we just invent this
            // ETag that will be the same for all empty folders
            $folderVersion = 'e:404';
        }

        $requestedVersion = $this->stripQuotes(
            $request->getHeader('HTTP_IF_NONE_MATCH', false, null)
        );

        if (null !== $requestedVersion) {

            if (in_array($folderVersion, $requestedVersion)) {
                //return new RemoteStorageResponse($request, 304, $folderVersion);

                $response = new Response(304, 'application/ld+json');
                $response->addHeader('ETag', '"'.$folderVersion.'"');

                return $response;
            }
        }

        $rsr = new Response(200, 'application/ld+json');
        $rsr->addHeader('ETag', '"'.$folderVersion.'"');

        if ('GET' === $request->getRequestMethod()) {
            $rsr->setBody(
                $this->remoteStorage->getFolder(
                    $path,
                    $this->stripQuotes(
                        $request->getHeader('HTTP_IF_NONE_MATCH', false, null)
                    )
                )
            );
        }

        return $rsr;
    }

    public function getDocument(Path $path, Request $request, $tokenInfo)
    {
        if (false !== $tokenInfo) {
            if ($path->getUserId() !== $tokenInfo->getUserId()) {
                throw new HttpException('path does not match authorized subject', 403);
            }
            if (!$this->hasReadScope($tokenInfo->getScope(), $path->getModuleName())) {
                throw new HttpException('path does not match authorized scope', 403);
            }
        }
        $documentVersion = $this->remoteStorage->getVersion($path);
        if (is_null($documentVersion)) {
            throw new HttpException(
                sprintf('document "%s" not found', $path->getPath()),
                404
            );
        }

        $requestedVersion = $this->stripQuotes(
            $request->getHeader('HTTP_IF_NONE_MATCH', false, null)
        );
        $documentContentType = $this->remoteStorage->getContentType($path);

        if (!is_null($requestedVersion)) {

            if (in_array($documentVersion, $requestedVersion)) {
                $response = new Response(304, $documentContentType);
                $response->addHeader('ETag', '"'.$documentVersion.'"');

                return $response;
            }
        }

        $rsr = new Response(200, $documentContentType);
        $rsr->addHeader('ETag', '"'.$documentVersion.'"');

        if ('development' !== $this->serverMode) {
            $rsr->addHeader('Accept-Ranges', 'bytes');
        }

        if ('GET' === $request->getRequestMethod()) {
            if ('development' === $this->serverMode) {
                // use body
                $rsr->setBody(
                    file_get_contents(
                        $this->remoteStorage->getDocument(
                            $path,
                            $requestedVersion
                        )
                    )
                );
                $rsr->addHeader('Content-Length', (string) strlen($rsr->getBody()));
            } else {
                // use X-SendFile
                $rsr->setFile(
                    $this->remoteStorage->getDocument(
                        $path,
                        $requestedVersion
                    )
                );
            }
        }

        return $rsr;
    }

    public function putDocument(Request $request, TokenInfo $tokenInfo)
    {
        $path = new Path($request->getPathInfo());

        if ($path->getUserId() !== $tokenInfo->getUserId()) {
            throw new HttpException('path does not match authorized subject', 403);
        }
        if (!$this->hasWriteScope($tokenInfo->getScope(), $path->getModuleName())) {
            throw new HttpException('path does not match authorized scope', 403);
        }

        // https://tools.ietf.org/html/rfc7231#section-4.3.4
        if (!is_null($request->getHeader('HTTP_CONTENT_RANGE', false, null))) {
            throw new HttpException('PUT MUST NOT have Content-Range', 400);
        }

        $ifMatch = $this->stripQuotes(
            $request->getHeader('HTTP_IF_MATCH', false, null)
        );
        $ifNoneMatch = $this->stripQuotes(
            $request->getHeader('HTTP_IF_NONE_MATCH', false, null)
        );

        $documentVersion = $this->remoteStorage->getVersion($path);
        if (null !== $ifMatch && !in_array($documentVersion, $ifMatch)) {

            throw new HttpException('version mismatch', 412);
        }

        if (null !== $ifNoneMatch && in_array('*', $ifNoneMatch) && null !== $documentVersion) {
            throw new HttpException('document already exists', 412);
        }

        $x = $this->remoteStorage->putDocument(
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
            $path,
            $request->getHeader('CONTENT_TYPE'),
            $request->getBody(),
            $ifMatch,
            $ifNoneMatch
        );
        // we have to get the version again after the PUT
        $documentVersion = $this->remoteStorage->getVersion($path);

        $rsr = new Response();
        $rsr->addHeader('ETag', '"'.$documentVersion.'"');
        $rsr->setBody($x);

        return $rsr;
    }

    public function deleteDocument(Request $request, TokenInfo $tokenInfo)
    {
        $path = new Path($request->getPathInfo());

        if ($path->getUserId() !== $tokenInfo->getUserId()) {
            throw new HttpException('path does not match authorized subject', 403);
        }
        if (!$this->hasWriteScope($tokenInfo->getScope(), $path->getModuleName())) {
            throw new HttpException('path does not match authorized scope', 403);
        }

        // need to get the version before the delete
        $documentVersion = $this->remoteStorage->getVersion($path);

        $ifMatch = $this->stripQuotes(
            $request->getHeader('HTTP_IF_MATCH', false, null)
        );

        // if document does not exist, and we have If-Match header set we should
        // return a 412 instead of a 404
        if (null !== $ifMatch && !in_array($documentVersion, $ifMatch)) {

            throw new HttpException('version mismatch', 412);
        }

        if (null === $documentVersion) {
            throw new HttpException(
                sprintf('document "%s" not found', $path->getPath()),
                404
            );
        }

        $ifMatch = $this->stripQuotes(
            $request->getHeader('HTTP_IF_MATCH', false, null)
        );
        if (null !== $ifMatch && !in_array($documentVersion, $ifMatch)) {

            throw new HttpException('version mismatch', 412);
        }

        $x = $this->remoteStorage->deleteDocument(
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
            $path,
            $ifMatch
        );
        $rsr = new Response();
        $rsr->addHeader('ETag', '"'.$documentVersion.'"');
        $rsr->setBody($x);

        return $rsr;
    }

    /**
     * ETag/If-Match/If-None-Match are always quoted, this method removes
     * the quotes.
     */
    public function stripQuotes($versionHeader)
    {
        if (null === $versionHeader) {
            return;
        }

        $versions = [];

        if ('*' === $versionHeader) {
            return ['*'];
        }

        foreach (explode(',', $versionHeader) as $v) {
            $v = trim($v);
            $startQuote = strpos($v, '"');
            $endQuote = strrpos($v, '"');
            $length = strlen($v);

            if (0 !== $startQuote || $length - 1 !== $endQuote) {
                throw new HttpException('version header must start and end with a double quote', 400);
            }
            $versions[] = substr($v, 1, $length - 2);
        }

        return $versions;
    }

    private function hasReadScope($scope, $moduleName)
    {
        $obtainedScopes = explode(' ', $scope);
        $requiredScopes = [
            '*:r',
            '*:rw',
            sprintf('%s:%s', $moduleName, 'r'),
            sprintf('%s:%s', $moduleName, 'rw'),
        ];

        foreach ($requiredScopes as $requiredScope) {
            if (in_array($requiredScope, $obtainedScopes)) {
                return true;
            }
        }

        return false;
    }

    private function hasWriteScope($scope, $moduleName)
    {
        $obtainedScopes = explode(' ', $scope);
        $requiredScopes = [
            '*:rw',
            sprintf('%s:%s', $moduleName, 'rw'),
        ];

        foreach ($requiredScopes as $requiredScope) {
            if (in_array($requiredScope, $obtainedScopes)) {
                return true;
            }
        }

        return false;
    }

    private function addCors(Response &$response)
    {
        $response->addHeader('Access-Control-Allow-Origin', '*');
        $response->addHeader(
            'Access-Control-Expose-Headers',
            'ETag, Content-Length'
        );
    }

    private function addNoCache(Response &$response)
    {
        $response->addHeader('Expires', '0');
        $response->addHeader('Cache-Control', 'no-cache');
    }
}


1		<?php
2
3		/**
4		* This program is free software: you can redistribute it and/or modify
5		* it under the terms of the GNU Lesser General Public License as published by
6		* the Free Software Foundation, either version 3 of the License, or
7		* (at your option) any later version.
8		*
9		* This program is distributed in the hope that it will be useful,
10		* but WITHOUT ANY WARRANTY; without even the implied warranty of
11		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12		* GNU Lesser General Public License for more details.
13		*
14		* You should have received a copy of the GNU Lesser General Public License
15		* along with this program. If not, see <http://www.gnu.org/licenses/>.
16		*/
17
18		namespace fkooman\RemoteStorage;
19
20		use fkooman\RemoteStorage\Http\Exception\HttpException;
21		use fkooman\RemoteStorage\Http\Request;
22		use fkooman\RemoteStorage\Http\Response;
23		use fkooman\RemoteStorage\OAuth\TokenInfo;
24
25		class ApiModule
26		{
27		/** @var RemoteStorage */
28		private $remoteStorage;
29
30		/** @var string */
31		private $serverMode;
32
33		public function __construct(RemoteStorage $remoteStorage, $serverMode)
34		{
35		$this->remoteStorage = $remoteStorage;
36		$this->serverMode = $serverMode;
37		}
38
39		/**
40		* @param Request $request
41		* @param \fkooman\RemoteStorage\OAuth\TokenInfo\|false $tokenInfo
42		*/
43		public function get(Request $request, $tokenInfo)
44		{
45		$response = $this->getObject($request, $tokenInfo);
46		$this->addNoCache($response);
47		$this->addCors($response);
48
49		return $response;
50		}
51
52		public function head(Request $request, $tokenInfo)
53		{
54		// XXX return headers only?
55		$response = $this->getObject($request, $tokenInfo);
56		$this->addNoCache($response);
57		$this->addCors($response);
58
59		return $response;
60		}
61
62		public function put(Request $request, TokenInfo $tokenInfo)
63		{
64		$response = $this->putDocument($request, $tokenInfo);
65		$this->addCors($response);
66
67		return $response;
68		}
69
70		public function delete(Request $request, TokenInfo $tokenInfo)
71		{
72		$response = $this->deleteDocument($request, $tokenInfo);
73		$this->addCors($response);
74
75		return $response;
76		}
77
78		public function options(Request $request)
		0 ignored issues – show Unused Code introduced 2017-01-16 12:34 UTC by Report Bug Copy Issue Report The parameter `$request` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
79		{
80		$response = new Response();
81		$response->addHeader(
82		'Access-Control-Allow-Methods',
83		'GET, PUT, DELETE, HEAD, OPTIONS'
84		);
85		$response->addHeader(
86		'Access-Control-Allow-Headers',
87		'Authorization, Content-Length, Content-Type, Origin, X-Requested-With, If-Match, If-None-Match'
88		);
89		$this->addCors($response);
90
91		return $response;
92		}
93
94		/**
95		* @param Request $request
96		* @param TokenInfo\|false $tokenInfo
97		*/
98		public function getObject(Request $request, $tokenInfo)
99		{
100		$path = new Path($request->getPathInfo());
101
102		// allow requests to public files (GET\|HEAD) without authentication
103		if ($path->getIsPublic() && $path->getIsDocument()) {
104		// XXX create a getPublicDocument call instead to make sure?
105		return $this->getDocument($path, $request, $tokenInfo);
106		}
107
108		// past this point we MUST be authenticated
109		if (false === $tokenInfo) {
110		throw new HttpException(
111		'no_token',
112		401,
113		['WWW-Authenticate' => 'Bearer realm="remoteStorage API"']
114		);
115		}
116
117		if ($path->getIsFolder()) {
118		return $this->getFolder($path, $request, $tokenInfo);
119		}
120
121		return $this->getDocument($path, $request, $tokenInfo);
122		}
123
124		public function getFolder(Path $path, Request $request, TokenInfo $tokenInfo)
125		{
126		if ($path->getUserId() !== $tokenInfo->getUserId()) {
127		throw new HttpException('path does not match authorized subject', 403);
128		}
129		if (!$this->hasReadScope($tokenInfo->getScope(), $path->getModuleName())) {
130		throw new HttpException('path does not match authorized scope', 403);
131		}
132
133		$folderVersion = $this->remoteStorage->getVersion($path);
134		if (null === $folderVersion) {
135		// folder does not exist, so we just invent this
136		// ETag that will be the same for all empty folders
137		$folderVersion = 'e:404';
138		}
139
140		$requestedVersion = $this->stripQuotes(
141		$request->getHeader('HTTP_IF_NONE_MATCH', false, null)
142		);
143
144	View Code Duplication	if (null !== $requestedVersion) {
		0 ignored issues – show Duplication introduced 2017-02-07 22:09 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
145		if (in_array($folderVersion, $requestedVersion)) {
146		//return new RemoteStorageResponse($request, 304, $folderVersion);
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-01-13 10:38 UTC by Report Bug Copy Issue Report `67%` 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...
147		$response = new Response(304, 'application/ld+json');
148		$response->addHeader('ETag', '"'.$folderVersion.'"');
149
150		return $response;
151		}
152		}
153
154		$rsr = new Response(200, 'application/ld+json');
155		$rsr->addHeader('ETag', '"'.$folderVersion.'"');
156
157		if ('GET' === $request->getRequestMethod()) {
158		$rsr->setBody(
159		$this->remoteStorage->getFolder(
160		$path,
161		$this->stripQuotes(
162		$request->getHeader('HTTP_IF_NONE_MATCH', false, null)
163		)
164		)
165		);
166		}
167
168		return $rsr;
169		}
170
171		public function getDocument(Path $path, Request $request, $tokenInfo)
172		{
173		if (false !== $tokenInfo) {
174		if ($path->getUserId() !== $tokenInfo->getUserId()) {
175		throw new HttpException('path does not match authorized subject', 403);
176		}
177		if (!$this->hasReadScope($tokenInfo->getScope(), $path->getModuleName())) {
178		throw new HttpException('path does not match authorized scope', 403);
179		}
180		}
181		$documentVersion = $this->remoteStorage->getVersion($path);
182		if (is_null($documentVersion)) {
183		throw new HttpException(
184		sprintf('document "%s" not found', $path->getPath()),
185		404
186		);
187		}
188
189		$requestedVersion = $this->stripQuotes(
190		$request->getHeader('HTTP_IF_NONE_MATCH', false, null)
191		);
192		$documentContentType = $this->remoteStorage->getContentType($path);
193
194	View Code Duplication	if (!is_null($requestedVersion)) {
		0 ignored issues – show Duplication introduced 2017-01-16 12:34 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
195		if (in_array($documentVersion, $requestedVersion)) {
196		$response = new Response(304, $documentContentType);
197		$response->addHeader('ETag', '"'.$documentVersion.'"');
198
199		return $response;
200		}
201		}
202
203		$rsr = new Response(200, $documentContentType);
204		$rsr->addHeader('ETag', '"'.$documentVersion.'"');
205
206		if ('development' !== $this->serverMode) {
207		$rsr->addHeader('Accept-Ranges', 'bytes');
208		}
209
210		if ('GET' === $request->getRequestMethod()) {
211		if ('development' === $this->serverMode) {
212		// use body
213		$rsr->setBody(
214		file_get_contents(
215		$this->remoteStorage->getDocument(
216		$path,
217		$requestedVersion
218		)
219		)
220		);
221		$rsr->addHeader('Content-Length', (string) strlen($rsr->getBody()));
222		} else {
223		// use X-SendFile
224		$rsr->setFile(
225		$this->remoteStorage->getDocument(
226		$path,
227		$requestedVersion
228		)
229		);
230		}
231		}
232
233		return $rsr;
234		}
235
236		public function putDocument(Request $request, TokenInfo $tokenInfo)
237		{
238		$path = new Path($request->getPathInfo());
239
240		if ($path->getUserId() !== $tokenInfo->getUserId()) {
241		throw new HttpException('path does not match authorized subject', 403);
242		}
243		if (!$this->hasWriteScope($tokenInfo->getScope(), $path->getModuleName())) {
244		throw new HttpException('path does not match authorized scope', 403);
245		}
246
247		// https://tools.ietf.org/html/rfc7231#section-4.3.4
248		if (!is_null($request->getHeader('HTTP_CONTENT_RANGE', false, null))) {
249		throw new HttpException('PUT MUST NOT have Content-Range', 400);
250		}
251
252		$ifMatch = $this->stripQuotes(
253		$request->getHeader('HTTP_IF_MATCH', false, null)
254		);
255		$ifNoneMatch = $this->stripQuotes(
256		$request->getHeader('HTTP_IF_NONE_MATCH', false, null)
257		);
258
259		$documentVersion = $this->remoteStorage->getVersion($path);
260	View Code Duplication	if (null !== $ifMatch && !in_array($documentVersion, $ifMatch)) {
		0 ignored issues – show Duplication introduced 2017-01-13 10:38 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
261		throw new HttpException('version mismatch', 412);
262		}
263
264		if (null !== $ifNoneMatch && in_array('*', $ifNoneMatch) && null !== $documentVersion) {
265		throw new HttpException('document already exists', 412);
266		}
267
268		$x = $this->remoteStorage->putDocument(
		0 ignored issues – show Bug introduced 2017-02-08 13:10 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$x` is correct as `$this->remoteStorage->pu...$ifMatch, $ifNoneMatch)` (which targets `fkooman\RemoteStorage\RemoteStorage::putDocument()`) 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...
269		$path,
270		$request->getHeader('CONTENT_TYPE'),
271		$request->getBody(),
272		$ifMatch,
273		$ifNoneMatch
274		);
275		// we have to get the version again after the PUT
276		$documentVersion = $this->remoteStorage->getVersion($path);
277
278		$rsr = new Response();
279		$rsr->addHeader('ETag', '"'.$documentVersion.'"');
280		$rsr->setBody($x);
281
282		return $rsr;
283		}
284
285		public function deleteDocument(Request $request, TokenInfo $tokenInfo)
286		{
287		$path = new Path($request->getPathInfo());
288
289		if ($path->getUserId() !== $tokenInfo->getUserId()) {
290		throw new HttpException('path does not match authorized subject', 403);
291		}
292		if (!$this->hasWriteScope($tokenInfo->getScope(), $path->getModuleName())) {
293		throw new HttpException('path does not match authorized scope', 403);
294		}
295
296		// need to get the version before the delete
297		$documentVersion = $this->remoteStorage->getVersion($path);
298
299		$ifMatch = $this->stripQuotes(
300		$request->getHeader('HTTP_IF_MATCH', false, null)
301		);
302
303		// if document does not exist, and we have If-Match header set we should
304		// return a 412 instead of a 404
305	View Code Duplication	if (null !== $ifMatch && !in_array($documentVersion, $ifMatch)) {
		0 ignored issues – show Duplication introduced 2017-01-13 10:38 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
306		throw new HttpException('version mismatch', 412);
307		}
308
309		if (null === $documentVersion) {
310		throw new HttpException(
311		sprintf('document "%s" not found', $path->getPath()),
312		404
313		);
314		}
315
316		$ifMatch = $this->stripQuotes(
317		$request->getHeader('HTTP_IF_MATCH', false, null)
318		);
319	View Code Duplication	if (null !== $ifMatch && !in_array($documentVersion, $ifMatch)) {
		0 ignored issues – show Duplication introduced 2017-01-13 10:38 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
320		throw new HttpException('version mismatch', 412);
321		}
322
323		$x = $this->remoteStorage->deleteDocument(
		0 ignored issues – show Bug introduced 2017-01-13 10:38 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$x` is correct as `$this->remoteStorage->de...cument($path, $ifMatch)` (which targets `fkooman\RemoteStorage\Re...orage::deleteDocument()`) 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...
324		$path,
325		$ifMatch
326		);
327		$rsr = new Response();
328		$rsr->addHeader('ETag', '"'.$documentVersion.'"');
329		$rsr->setBody($x);
330
331		return $rsr;
332		}
333
334		/**
335		* ETag/If-Match/If-None-Match are always quoted, this method removes
336		* the quotes.
337		*/
338		public function stripQuotes($versionHeader)
339		{
340		if (null === $versionHeader) {
341		return;
342		}
343
344		$versions = [];
345
346		if ('*' === $versionHeader) {
347		return ['*'];
348		}
349
350		foreach (explode(',', $versionHeader) as $v) {
351		$v = trim($v);
352		$startQuote = strpos($v, '"');
353		$endQuote = strrpos($v, '"');
354		$length = strlen($v);
355
356		if (0 !== $startQuote \|\| $length - 1 !== $endQuote) {
357		throw new HttpException('version header must start and end with a double quote', 400);
358		}
359		$versions[] = substr($v, 1, $length - 2);
360		}
361
362		return $versions;
363		}
364
365		private function hasReadScope($scope, $moduleName)
366		{
367		$obtainedScopes = explode(' ', $scope);
368		$requiredScopes = [
369		'*:r',
370		'*:rw',
371		sprintf('%s:%s', $moduleName, 'r'),
372		sprintf('%s:%s', $moduleName, 'rw'),
373		];
374
375		foreach ($requiredScopes as $requiredScope) {
376		if (in_array($requiredScope, $obtainedScopes)) {
377		return true;
378		}
379		}
380
381		return false;
382		}
383
384		private function hasWriteScope($scope, $moduleName)
385		{
386		$obtainedScopes = explode(' ', $scope);
387		$requiredScopes = [
388		'*:rw',
389		sprintf('%s:%s', $moduleName, 'rw'),
390		];
391
392		foreach ($requiredScopes as $requiredScope) {
393		if (in_array($requiredScope, $obtainedScopes)) {
394		return true;
395		}
396		}
397
398		return false;
399		}
400
401		private function addCors(Response &$response)
402		{
403		$response->addHeader('Access-Control-Allow-Origin', '*');
404		$response->addHeader(
405		'Access-Control-Expose-Headers',
406		'ETag, Content-Length'
407		);
408		}
409
410		private function addNoCache(Response &$response)
411		{
412		$response->addHeader('Expires', '0');
413		$response->addHeader('Cache-Control', 'no-cache');
414		}
415		}
416

fkooman / php-remote-storage

GitHub Access Token became invalid

ApiModule C last analyzed 2017-04-15 07:37 UTC