PreviewPlugin::httpGet() - Code Metrics - Inspection of "Merge pull request #31785 from owncloud/previews-r..." - owncloud/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( db7984...ab328d )

by Thomas

created 2018-06-14 18:22 UTC

PreviewPlugin::httpGet() D

↳ Parent: PreviewPlugin

Complexity

Conditions	14
Paths	225

Size

Total Lines	70
Code Lines	42

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	14
eloc	42
nc	225
nop	2
dl	0
loc	70
rs	4.6858
c	1
b	0
f	0

How to fix Long Method Complexity

<?php
/**
 * @author Thomas Müller <[email protected]>
 *
 * @copyright Copyright (c) 2017, ownCloud GmbH
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * 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, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace OCA\DAV\Files;

use OCA\DAV\Connector\Sabre\Exception\FileLocked;
use OCP\AppFramework\Utility\ITimeFactory;
use OCP\Encryption\Exceptions\GenericEncryptionException;
use OCP\Files\ForbiddenException;
use OCP\Files\IPreviewNode;
use OCP\Files\StorageNotAvailableException;
use OCP\IPreview;
use OCP\Lock\LockedException;
use Sabre\DAV\Exception\Forbidden;
use Sabre\DAV\Exception\NotFound;
use Sabre\DAV\Exception\ServiceUnavailable;
use Sabre\DAV\Server;
use Sabre\DAV\ServerPlugin;
use Sabre\HTTP\RequestInterface;
use Sabre\HTTP\ResponseInterface;

class PreviewPlugin extends ServerPlugin {

	/** @var Server */
	protected $server;
	/** @var ITimeFactory */
	private $timeFactory;
	/** @var IPreview */
	private $previewManager;

	/**
	 * PreviewPlugin constructor.
	 *
	 * @param ITimeFactory $timeFactory
	 * @param IPreview $previewManager
	 */
	public function __construct(ITimeFactory $timeFactory, IPreview $previewManager) {
		$this->timeFactory = $timeFactory;
		$this->previewManager = $previewManager;
	}

	/**
	 * Initializes the plugin and registers event handlers
	 *
	 * @param Server $server
	 * @return void
	 */
	public function initialize(Server $server) {
		$this->server = $server;
		$this->server->on('method:GET', [$this, 'httpGet'], 90);
	}

	/**
	 * Intercepts GET requests on node urls ending with ?preview.
	 * The node has to implement IPreviewNode
	 *
	 * @param RequestInterface $request
	 * @param ResponseInterface $response
	 * @return bool
	 * @throws NotFound
	 * @throws \Sabre\DAVACL\Exception\NeedPrivileges
	 * @throws \Sabre\DAV\Exception\NotAuthenticated
	 * @throws Forbidden
	 * @throws FileLocked
	 * @throws ServiceUnavailable
	 */
	public function httpGet(RequestInterface $request, ResponseInterface $response) {
		$queryParams = $request->getQueryParameters();
		if (!\array_key_exists('preview', $queryParams)) {
			return true;
		}

		$path = $request->getPath();
		$node = $this->server->tree->getNodeForPath($path);

		if (!$node instanceof IFileNode) {
			return false;
		}
		$fileNode = $node->getNode();
		if (!$fileNode instanceof IPreviewNode) {
			return false;
		}

		// Checking ACL, if available.
		if ($aclPlugin = $this->server->getPlugin('acl')) {
			/** @var \Sabre\DAVACL\Plugin $aclPlugin */
			$aclPlugin->checkPrivileges($path, '{DAV:}read');
		}

		try {
			if (!$this->previewManager->isAvailable($fileNode)) {
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
				// no preview available or preview disabled
				throw new NotFound();
			}
			if ($image = $fileNode->getThumbnail($queryParams)) {
				if ($image === null || !$image->valid()) {
					throw new NotFound();
				}
				$type = $image->mimeType();
				if (!\in_array($type, ['image/png', 'image/jpeg', 'image/gif'])) {
					$type = 'application/octet-stream';
				}

				// Enable output buffering
				\ob_start();
				// Capture the output
				$image->show();
				$imageData = \ob_get_contents();
				// Clear the output buffer
				\ob_end_clean();

				$response->setHeader('Content-Type', $type);
				$response->setHeader('Content-Disposition', 'attachment');
				// cache 24h
				$response->setHeader('Cache-Control', 'max-age=86400, must-revalidate');
				$response->setHeader('Expires', \gmdate("D, d M Y H:i:s", $this->timeFactory->getTime() + 86400) . " GMT");

				$response->setStatus(200);
				$response->setBody($imageData);

				// Returning false to break the event chain
				return false;
			}
		} catch (GenericEncryptionException $e) {
			// returning 403 because some apps stops syncing if 503 is returned.
			throw new Forbidden('Encryption not ready: ' . $e->getMessage());
		} catch (StorageNotAvailableException $e) {
			throw new ServiceUnavailable('Failed to open file: ' . $e->getMessage());
		} catch (ForbiddenException $ex) {
			throw new Forbidden($ex->getMessage(), $ex->getRetry());
		} catch (LockedException $e) {
			throw new FileLocked($e->getMessage(), $e->getCode(), $e);
		}
		// TODO: add forceIcon handling .... if still needed
		throw new NotFound();
	}
}


1			<?php
2			/**
3			* @author Thomas Müller <[email protected]>
4			*
5			* @copyright Copyright (c) 2017, ownCloud GmbH
6			* @license AGPL-3.0
7			*
8			* This code is free software: you can redistribute it and/or modify
9			* it under the terms of the GNU Affero General Public License, version 3,
10			* as published by the Free Software Foundation.
11			*
12			* This program is distributed in the hope that it will be useful,
13			* but WITHOUT ANY WARRANTY; without even the implied warranty of
14			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15			* GNU Affero General Public License for more details.
16			*
17			* You should have received a copy of the GNU Affero General Public License, version 3,
18			* along with this program. If not, see <http://www.gnu.org/licenses/>
19			*
20			*/
21
22			namespace OCA\DAV\Files;
23
24			use OCA\DAV\Connector\Sabre\Exception\FileLocked;
25			use OCP\AppFramework\Utility\ITimeFactory;
26			use OCP\Encryption\Exceptions\GenericEncryptionException;
27			use OCP\Files\ForbiddenException;
28			use OCP\Files\IPreviewNode;
29			use OCP\Files\StorageNotAvailableException;
30			use OCP\IPreview;
31			use OCP\Lock\LockedException;
32			use Sabre\DAV\Exception\Forbidden;
33			use Sabre\DAV\Exception\NotFound;
34			use Sabre\DAV\Exception\ServiceUnavailable;
35			use Sabre\DAV\Server;
36			use Sabre\DAV\ServerPlugin;
37			use Sabre\HTTP\RequestInterface;
38			use Sabre\HTTP\ResponseInterface;
39
40			class PreviewPlugin extends ServerPlugin {
41
42			/** @var Server */
43			protected $server;
44			/** @var ITimeFactory */
45			private $timeFactory;
46			/** @var IPreview */
47			private $previewManager;
48
49			/**
50			* PreviewPlugin constructor.
51			*
52			* @param ITimeFactory $timeFactory
53			* @param IPreview $previewManager
54			*/
55			public function __construct(ITimeFactory $timeFactory, IPreview $previewManager) {
56			$this->timeFactory = $timeFactory;
57			$this->previewManager = $previewManager;
58			}
59
60			/**
61			* Initializes the plugin and registers event handlers
62			*
63			* @param Server $server
64			* @return void
65			*/
66			public function initialize(Server $server) {
67			$this->server = $server;
68			$this->server->on('method:GET', [$this, 'httpGet'], 90);
69			}
70
71			/**
72			* Intercepts GET requests on node urls ending with ?preview.
73			* The node has to implement IPreviewNode
74			*
75			* @param RequestInterface $request
76			* @param ResponseInterface $response
77			* @return bool
78			* @throws NotFound
79			* @throws \Sabre\DAVACL\Exception\NeedPrivileges
80			* @throws \Sabre\DAV\Exception\NotAuthenticated
81			* @throws Forbidden
82			* @throws FileLocked
83			* @throws ServiceUnavailable
84			*/
85			public function httpGet(RequestInterface $request, ResponseInterface $response) {
86			$queryParams = $request->getQueryParameters();
87			if (!\array_key_exists('preview', $queryParams)) {
88			return true;
89			}
90
91			$path = $request->getPath();
92			$node = $this->server->tree->getNodeForPath($path);
93
94			if (!$node instanceof IFileNode) {
95			return false;
96			}
97			$fileNode = $node->getNode();
98			if (!$fileNode instanceof IPreviewNode) {
99			return false;
100			}
101
102			// Checking ACL, if available.
103			if ($aclPlugin = $this->server->getPlugin('acl')) {
104			/** @var \Sabre\DAVACL\Plugin $aclPlugin */
105			$aclPlugin->checkPrivileges($path, '{DAV:}read');
106			}
107
108			try {
109			if (!$this->previewManager->isAvailable($fileNode)) {
			0 ignored issues – show Documentation introduced 2018-06-14 15:38 UTC by Report Bug Copy Issue Report `$fileNode` is of type `object<OCP\Files\IPreviewNode>`, but the function expects a `object<OCP\Files\FileInfo>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
110			// no preview available or preview disabled
111			throw new NotFound();
112			}
113			if ($image = $fileNode->getThumbnail($queryParams)) {
114			if ($image === null \|\| !$image->valid()) {
115			throw new NotFound();
116			}
117			$type = $image->mimeType();
118			if (!\in_array($type, ['image/png', 'image/jpeg', 'image/gif'])) {
119			$type = 'application/octet-stream';
120			}
121
122			// Enable output buffering
123			\ob_start();
124			// Capture the output
125			$image->show();
126			$imageData = \ob_get_contents();
127			// Clear the output buffer
128			\ob_end_clean();
129
130			$response->setHeader('Content-Type', $type);
131			$response->setHeader('Content-Disposition', 'attachment');
132			// cache 24h
133			$response->setHeader('Cache-Control', 'max-age=86400, must-revalidate');
134			$response->setHeader('Expires', \gmdate("D, d M Y H:i:s", $this->timeFactory->getTime() + 86400) . " GMT");
135
136			$response->setStatus(200);
137			$response->setBody($imageData);
138
139			// Returning false to break the event chain
140			return false;
141			}
142			} catch (GenericEncryptionException $e) {
143			// returning 403 because some apps stops syncing if 503 is returned.
144			throw new Forbidden('Encryption not ready: ' . $e->getMessage());
145			} catch (StorageNotAvailableException $e) {
146			throw new ServiceUnavailable('Failed to open file: ' . $e->getMessage());
147			} catch (ForbiddenException $ex) {
148			throw new Forbidden($ex->getMessage(), $ex->getRetry());
149			} catch (LockedException $e) {
150			throw new FileLocked($e->getMessage(), $e->getCode(), $e);
151			}
152			// TODO: add forceIcon handling .... if still needed
153			throw new NotFound();
154			}
155			}
156

owncloud / core

Push — master ( db7984...ab328d )

PreviewPlugin::httpGet() D

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like