Files::get() - Code Metrics - Inspection of "Merge pull request #446 from gyselroth/v2.7" - gyselroth/balloon - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( 37faaa...541bbf )

by Raffael
created 2020-02-17 10:49 UTC
Files::get() A

↳ Parent: Files
Complexity

Conditions	1
Paths	1
Size

Total Lines
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
dl	0
loc	14
rs	9.7998
c	0
b	0
f	0
cc	1
nc	1
nop	2
<?php

declare(strict_types=1);

/**
 * balloon
 *
 * @copyright   Copryright (c) 2012-2019 gyselroth GmbH (https://gyselroth.com)
 * @license     GPL-3.0 https://opensource.org/licenses/GPL-3.0
 */

namespace Balloon\App\Wopi\Wopi;

use Balloon\App\Wopi\Exception\MissingWopiOperation as MissingWopiOperationException;
use Balloon\App\Wopi\Exception\UnknownWopiOperation as UnknownWopiOperationException;
use Balloon\App\Wopi\HostManager;
use Balloon\App\Wopi\Session\SessionInterface;
use Balloon\App\Wopi\SessionManager;
use Balloon\Filesystem\Exception;
use Balloon\Filesystem\Node\AttributeDecorator;
use Balloon\Filesystem\Node\File;
use Balloon\Server;
use Micro\Http\Response;
use MongoDB\BSON\ObjectId;
use Psr\Log\LoggerInterface;

/**
 * Implements the full WOPI protocol.
 *
 * @see https://wopi.readthedocs.io/projects/wopirest/en/latest
 */
class Files
{
    /**
     * WOPI operations.
     */
    const WOPI_GET_LOCK = 'GET_LOCK';
    const WOPI_LOCK = 'LOCK';
    const WOPI_REFRESH_LOCK = 'REFRESH_LOCK';
    const WOPI_UNLOCK = 'UNLOCK';
    const WOPI_PUT = 'PUT';
    const WOPI_PUT_RELATIVE = 'PUT_RELATIVE';
    const WOPI_RENAME_FILE = 'RENAME_FILE';
    const WOPI_DELETE = 'DELETE';
    const WOPI_PUT_USERINFO = 'PUT_USERINFO';

    /**
     * Server.
     *
     * @var Server
     */
    protected $server;

    /**
     * Session manager.
     *
     * @var SessionManager
     */
    protected $session_manager;

    /**
     * Host manager.
     *
     * @var HostManager
     */
    protected $host_manager;

    /**
     * Attribute decorator.
     *
     * @var AttributeDecorator
     */
    protected $decorator;

    /**
     * Logger.
     *
     * @var LoggerInterface
     */
    protected $logger;

    /**
     * Constructor.
     */
    public function __construct(SessionManager $session_manager, HostManager $host_manager, Server $server, AttributeDecorator $decorator, LoggerInterface $logger)
    {
        $this->session_manager = $session_manager;
        $this->host_manager = $host_manager;
        $this->server = $server;
        $this->decorator = $decorator;
        $this->logger = $logger;
    }

    /**
     * Get document sesssion information.
     */
    public function get(ObjectId $id, string $access_token): Response
    {
        $file = $this->server->getFilesystem()->findNodeById($id, File::class);
        $session = $this->session_manager->getByToken($file, $access_token);


        $this->logger->info('incoming GET wopi operation', [
            'category' => get_class($this),
            'session' => $session->getAttributes(),
        ]);

        $this->validateProof($access_token);

        return (new Response())->setCode(200)->setBody($session->getAttributes(), true);

    }

    /**
     * Lock file.
     */
    public function post(ObjectId $id, string $access_token): Response
    {
        $file = $this->server->getFilesystem()->findNodeById($id, File::class);
        $session = $this->session_manager->getByToken($file, $access_token);


        $op = $_SERVER['HTTP_X_WOPI_OVERRIDE'] ?? null;
        $identifier = $_SERVER['HTTP_X_WOPI_LOCK'] ?? null;
        $previous = $_SERVER['HTTP_X_WOPI_OLDLOCK'] ?? null;
        $_SERVER['HTTP_LOCK_TOKEN'] = $identifier;

        $this->logger->info('incoming POST wopi operation [{operation}] with id [{identifier}]', [
            'category' => get_class($this),
            'operation' => $op,
            'identifier' => $identifier,
            'previous' => $previous,
        ]);

        $this->validateProof($access_token);
        $response = (new Response())
            ->setCode(200)
            ->setHeader('X-WOPI-ItemVersion', (string) $file->getVersion());

        try {
            switch ($op) {
                case self::WOPI_GET_LOCK:
                    $lock = $file->getLock();
                    $response->setHeader('X-WOPI-Lock', $lock['id']);
                    $response->setBody($this->decorator->decorate($file, ['lock'])['lock']);

                break;
                case self::WOPI_LOCK:
                    if ($previous !== null) {
                        $file->unlock($previous);
                    }

                    $file->lock($identifier);
                    $response->setBody($this->decorator->decorate($file, ['lock'])['lock']);

                break;
                case self::WOPI_REFRESH_LOCK:
                    $file->lock($identifier, 1800);

                break;
                case self::WOPI_UNLOCK:
                    if (!$file->isLocked()) {
                        $response->setCode(409)
                            ->setHeader('X-WOPI-Lock', '');

                        return $response;
                    }

                    $file->unlock($identifier);

                break;
                case self::WOPI_RENAME_FILE:
                    return $this->renameFile($file, $response);


                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
                case self::WOPI_DELETE:
                    $file->delete();

                break;
                case self::WOPI_PUT_RELATIVE:
                    return $this->putRelative($file, $response, $session);


                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
                case null:
                    throw new MissingWopiOperationException('no wopi operation provided');

                break;
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
                default:
                    throw new UnknownWopiOperationException('unknown wopi operation '.$op);
            }
        } catch (Exception\NotLocked $e) {
            return (new Response())
                ->setCode(200)
                ->setHeader('X-WOPI-Lock', '')
                ->setBody($e);
        } catch (Exception\Locked | Exception\LockIdMissmatch | Exception\Forbidden $e) {
            $lock = $file->getLock();

            return (new Response())
                ->setCode(409)
                ->setHeader('X-WOPI-ItemVersion', (string) $file->getVersion())
                ->setHeader('X-WOPI-Lock', $lock['id'])
                ->setHeader('X-WOPI-LockFailureReason', $e->getMessage())
                ->setBody($e);
        }

        return $response;
    }

    /**
     * Save document contents.
     */
    public function postContents(ObjectId $id, string $access_token): Response
    {
        $op = $_SERVER['HTTP_X_WOPI_OVERRIDE'] ?? null;
        $identifier = $_SERVER['HTTP_X_WOPI_LOCK'] ?? null;
        $previous = $_SERVER['HTTP_X_WOPI_OLDLOCK'] ?? null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $_SERVER['HTTP_LOCK_TOKEN'] = $identifier;
        $agent = $_SERVER['HTTP_USER_AGENT'] ?? '';

        $this->logger->info('incoming POST wopi operation [{operation}] with id [{identifier}]', [
            'category' => get_class($this),
            'operation' => $op,
            'identifier' => $identifier,
        ]);

        $this->validateProof($access_token);
        $file = $this->server->getFilesystem()->findNodeById($id, File::class);
        $session = $this->session_manager->getByToken($file, $access_token);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $response = new Response();

        //loolwsd does not support locking (unlike the wopi specs require) #359
        if (!$file->isLocked() && $file->getSize() > 0 && strpos($agent, 'LOOLWSD') === false) {
            return $response
                ->setCode(409)
                ->setBody(new Exception\NotLocked('file needs to be locked first'));
        }

        try {
            $content = fopen('php://input', 'rb');
            $version = $file->getVersion();
            $result = $file->put($content);

            return $response
                ->setCode(200)
                ->setHeader('X-WOPI-ItemVersion', (string) ($version == $result ? $result : $result))
                ->setBody($result);
        } catch (Exception\Locked | Exception\LockIdMissmatch $e) {
            $lock = $file->getLock();

            return $response
                ->setCode(409)
                ->setHeader('X-WOPI-Lock', $lock['id'])
                ->setHeader('X-WOPI-LockFailureReason', $e->getMessage())
                ->setHeader('X-WOPI-ItemVersion', (string) $file->getVersion())
                ->setBody($e);
        }
    }

    /**
     * Get document contents.
     */
    public function getContents(ObjectId $id, string $access_token): Response
    {
        $file = $this->server->getFilesystem()->findNodeById($id, File::class);
        $session = $this->session_manager->getByToken($file, $access_token);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $this->validateProof($access_token);
        $stream = $file->get();

        $response = (new Response())
            ->setCode(200)
            ->setHeader('X-WOPI-ItemVersion', (string) $file->getVersion())
            ->setBody(function () use ($stream) {
                if ($stream === null) {
                    echo '';

                    return;
                }

                while (!feof($stream)) {
                    echo fread($stream, 8192);
                }
            });

        return $response;
    }

    /**
     * Validate proof.
     */
    protected function validateProof(string $access_token): bool
    {
        if (isset($_SERVER['HTTP_X_WOPI_PROOF'])) {
            $data = [
                'proof' => $_SERVER['HTTP_X_WOPI_PROOF'],
                'proof-old' => $_SERVER['HTTP_X_WOPI_PROOFOLD'] ?? '',
                'access-token' => $access_token,
                'host-url' => 'http://'.$_SERVER['HTTP_HOST'].$_SERVER['REQUEST_URI'],
                'timestamp' => $_SERVER['HTTP_X_WOPI_TIMESTAMP'] ?? '',
            ];

            return $this->host_manager->verifyWopiProof($data);
        }

        return false;
    }

    /**
     * Put relative file.
     */
    protected function putRelative(File $file, Response $response, SessionInterface $session): Response
    {
        $suggested = $_SERVER['HTTP_X_WOPI_SUGGESTEDTARGET'] ?? null;
        $relative = $_SERVER['HTTP_X_WOPI_RELATIVETARGET'] ?? null;
        $conversion = $_SERVER['HTTP_X_WOPI_FILECONVERSION'] ?? null;
        $overwrite = $_SERVER['HTTP_X_WOPI_OVERWRITERELATIVETARGET'] ?? false;
        $overwrite = ($overwrite === 'False' || $overwrite === false) ? false : true;
        $size = $_SERVER['HTTP_X_WOPI_SIZE'] ?? null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $new = null;
        $name = null;
        $url = ($_SERVER['REQUEST_SCHEME'] ?? 'http').'://'.($_SERVER['HTTP_X_FORWARDED_HOST'] ?? $_SERVER['HTTP_HOST'] ?? 'localhost');

        $parent = $file->getParent();
        $content = fopen('php://input', 'rb');

        $this->logger->debug('wopi PutRelative request', [
            'category' => get_class($this),
            'X-Wopi-SuggestedTarget' => $suggested,
            'X-Wopi-RelativeTarget' => $relative,
            'X-Wopi-OverwriteRelativeTarget' => $overwrite,
            'X-Wopi-FileConversion' => $conversion,
        ]);

        if ($suggested !== null && $relative !== null) {
            return $response
                ->setCode(400)
                ->setBody([
                    'Name' => $file->getName(),
                    'Url' => $session->getWopiUrl($url),
                ]);
        }

        try {
            if ($suggested !== null) {
                if ($suggested[0] === '.') {
                    $suggested = substr($file->getName(), 0, strpos($file->getName(), '.')).$suggested;
                }

                try {
                    $name = mb_convert_encoding($suggested, 'UTF-8', 'UTF-7');
                    $new = $parent->addFile($name);
                    $new->put($content, false);

                } catch (Exception\Conflict $e) {
                    $name = $file->getDuplicateName($name);
                    $new = $parent->addFile($name);
                    $new->put($content);
                }
            } elseif ($relative !== null) {
                try {
                    $name = mb_convert_encoding($relative, 'UTF-8', 'UTF-7');
                    $new = $parent->addFile($name);
                    $new->put($content);
                } catch (Exception\Conflict $e) {
                    if ($e->getCode() === Exception\Conflict::NODE_WITH_SAME_NAME_ALREADY_EXISTS && $overwrite === true) {
                        $new = $parent->getChild($name);
                        $new->put($content);
                    } else {
                        return $response
                            ->setCode(409)
                            ->setBody([
                                'Name' => $name,
                                'Url' => $session->getWopiUrl($url),
                            ]);
                    }
                }
            } else {
                return $response
                    ->setCode(400)
                    ->setBody([
                        'Name' => $name,
                        'Url' => $session->getWopiUrl($url),
                    ]);
            }
        } catch (Exception\InvalidArgument $e) {
            return $response
                ->setCode(400)
                ->setBody([
                    'Name' => $name,
                    'Url' => $session->getWopiUrl($url),
                ]);
        } catch (Exception\Locked $e) {
            return $response
                ->setCode(409)
                ->setHeader('X-WOPI-ItemVersion', (string) $file->getVersion())
                ->setHeader('X-WOPI-LockFailureReason', $e->getMessage())
                ->setBody([
                    'Name' => $name,
                    'Url' => $session->getWopiUrl($url),
                ]);
        }

        $session = $this->session_manager->create($new, $this->server->getUserById($new->getOwner()));

        $response->setBody([
            'Name' => $new->getName(),
            'Url' => $session->getWopiUrl($url),
        ]);

        return $response;
    }

    /**
     * Rename file.
     */
    protected function renameFile(File $file, Response $response): Response
    {
        $name = $_SERVER['HTTP_X_WOPI_REQUESTEDNAME'] ?? '';
        $name = mb_convert_encoding($name, 'UTF-8', 'UTF-7');
        $full = $name;

        try {
            $ext = $file->getExtension();
            $full = $name.'.'.$ext;
        } catch (\Exception $e) {

        }

        try {
            $file->setName($full);

            if ($file->isDeleted()) {
                $response->setCode(404);
            }
        } catch (Exception\Conflict $e) {
            return (new Response())
                ->setCode(400)
                ->setHeader('X-WOPI-InvalidFileNameError', (string) $e->getMessage())
                ->setBody($e);
        }

        $response->setBody([
            'Name' => $name,
        ]);

        return $response;
    }
}

1			<?php
2
3			declare(strict_types=1);
4
5			/**
6			* balloon
7			*
8			* @copyright Copryright (c) 2012-2019 gyselroth GmbH (https://gyselroth.com)
9			* @license GPL-3.0 https://opensource.org/licenses/GPL-3.0
10			*/
11
12			namespace Balloon\App\Wopi\Wopi;
13
14			use Balloon\App\Wopi\Exception\MissingWopiOperation as MissingWopiOperationException;
15			use Balloon\App\Wopi\Exception\UnknownWopiOperation as UnknownWopiOperationException;
16			use Balloon\App\Wopi\HostManager;
17			use Balloon\App\Wopi\Session\SessionInterface;
18			use Balloon\App\Wopi\SessionManager;
19			use Balloon\Filesystem\Exception;
20			use Balloon\Filesystem\Node\AttributeDecorator;
21			use Balloon\Filesystem\Node\File;
22			use Balloon\Server;
23			use Micro\Http\Response;
24			use MongoDB\BSON\ObjectId;
25			use Psr\Log\LoggerInterface;
26
27			/**
28			* Implements the full WOPI protocol.
29			*
30			* @see https://wopi.readthedocs.io/projects/wopirest/en/latest
31			*/
32			class Files
33			{
34			/**
35			* WOPI operations.
36			*/
37			const WOPI_GET_LOCK = 'GET_LOCK';
38			const WOPI_LOCK = 'LOCK';
39			const WOPI_REFRESH_LOCK = 'REFRESH_LOCK';
40			const WOPI_UNLOCK = 'UNLOCK';
gyselroth / balloon

Push — master ( 37faaa...541bbf )

Files::get() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
