ApiModule::init() - 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

ApiModule::init() B

↳ Parent: ApiModule

Complexity

Conditions	1
Paths	1

Size

Total Lines	80
Code Lines	45

Duplication

Lines	34
Ratio	42.5 %

Importance

Changes

Metric	Value
dl	34
loc	80
rs	8.8387
c	0
b	0
f	0
cc	1
eloc	45
nc	1
nop	1

How to fix Long Method

<?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\Exception\PathException;
use fkooman\RemoteStorage\Http\Exception\HttpException;
use fkooman\RemoteStorage\Http\Request;
use fkooman\RemoteStorage\Http\Response;
use fkooman\RemoteStorage\Http\Service;
use fkooman\RemoteStorage\Http\ServiceModuleInterface;
use fkooman\RemoteStorage\OAuth\TokenInfo;
use fkooman\RemoteStorage\OAuth\TokenStorage;
use InvalidArgumentException;

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

    /** @var \fkooman\RemoteStorage\OAuth\TokenStorage */
    private $tokenStorage;

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

    public function __construct(RemoteStorage $remoteStorage, TokenStorage $tokenStorage, $serverMode)

    {
        $this->remoteStorage = $remoteStorage;
        $this->tokenStorage = $tokenStorage;
    }

    public function init(Service $service)
    {
        // ApiAuth OPTIONAL??
        // maybe for "public" files it is optional?
        $service->addRoute(
            'GET',
            '*',
            function (Request $request, array $hookData) {

                $tokenInfo = $hookData['bearer'];

                $response = $this->getObject($request, $tokenInfo);
                $this->addNoCache($response);
                $this->addCors($response);

                return $response;
            }
        );

        $service->addRoute(
            'HEAD',
            '*',
            function (Request $request, array $hookData) {

                $tokenInfo = $hookData['bearer'];

                $response = $this->getObject($request, $tokenInfo);
                $this->addNoCache($response);
                $this->addCors($response);

                return $response;
            }
        );

        // put a document
        // ApiAuth
        $service->put(
            '*',
            function (Request $request, array $hookData) {

                $tokenInfo = $hookData['bearer'];

                $response = $this->putDocument($request, $tokenInfo);
                $this->addCors($response);

                return $response;
            }
        );

        // delete a document
        // ApiAuth
        $service->delete(
            '*',
            function (Request $request, array $hookData) {

                $tokenInfo = $hookData['bearer'];

                $response = $this->deleteDocument($request, $tokenInfo);
                $this->addCors($response);

                return $response;
            }
        );

        // options request
        // NoAuth
        $service->options(
            '*',
            function (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;
            }
        );
    }

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

        // allow requests to public files (GET|HEAD) without authentication
        if ($path->getIsPublic() && $path->getIsDocument()) {
            return $this->getDocument($path, $request, $tokenInfo);
        }

        // past this point we MUST be authenticated
        if (null === $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('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('If-None-Match', false, null)
                    )
                )
            );
        }

        return $rsr;
    }

    public function getDocument(Path $path, Request $request, TokenInfo $tokenInfo = null)
    {
        if (null !== $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 (null === $documentVersion) {
            throw new HttpException(
                sprintf('document "%s" not found', $path->getPath()),
                404
            );
        }

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

        if (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
                        )
                    )
                );
            } 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);
        }

        $ifMatch = $this->stripQuotes(
            $request->getHeader('If-Match', false, null)
        );
        $ifNoneMatch = $this->stripQuotes(
            $request->getHeader('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('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('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;
    }

//    public function run(Request $request = null)

//    {
//        if (null === $request) {
//            throw new InvalidArgumentException('must provide Request object');
//        }

//        $response = null;

//        try {
//            $response = parent::run($request);
//        } catch (PathException $e) {
//            $e = new BadRequestException($e->getMessage());
//            $response = $e->getJsonResponse();
//        }

//        // if error, add CORS

//        $statusCode = $response->getStatusCode();
//        if (400 <= $statusCode && 500 > $statusCode) {
//            $this->addCors($response);
//            $this->addNoCache($response);
//        }

//        return $response;

//    }

    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\Exception\PathException;
21			use fkooman\RemoteStorage\Http\Exception\HttpException;
22			use fkooman\RemoteStorage\Http\Request;
23			use fkooman\RemoteStorage\Http\Response;
24			use fkooman\RemoteStorage\Http\Service;
25			use fkooman\RemoteStorage\Http\ServiceModuleInterface;
26			use fkooman\RemoteStorage\OAuth\TokenInfo;
27			use fkooman\RemoteStorage\OAuth\TokenStorage;
28			use InvalidArgumentException;
29
30			class ApiModule implements ServiceModuleInterface
31			{
32			/** @var RemoteStorage */
33			private $remoteStorage;
34
35			/** @var \fkooman\RemoteStorage\OAuth\TokenStorage */
36			private $tokenStorage;
37
38			/** @var string */
39			private $serverMode;
40

fkooman / php-remote-storage

GitHub Access Token became invalid

Push — master ( 994736...366350 )

ApiModule::init() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like