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

Completed

Push — master ( 883df4...959368 )

by Thomas

created 2018-01-30 17:58 UTC

PreviewPlugin::httpGet() C

↳ Parent: PreviewPlugin

Complexity

Conditions	10
Paths	13

Size

Total Lines	61
Code Lines	35

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	10
eloc	35
nc	13
nop	2
dl	0
loc	61
rs	6.4757
c	0
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 OCP\Files\ForbiddenException;
use OCP\Files\IPreviewNode;
use OCP\ILogger;
use Sabre\DAV\Exception\NotFound;
use Sabre\DAV\Server;
use Sabre\DAV\ServerPlugin;
use Sabre\HTTP\RequestInterface;
use Sabre\HTTP\ResponseInterface;
use OCA\DAV\Connector\Sabre\Exception\Forbidden as DAVForbiddenException;

class PreviewPlugin extends ServerPlugin {

	/** @var Server */
	protected $server;
	/** @var ILogger */
	private $logger;

	public function __construct(ILogger $logger) {
		$this->logger = $logger;
	}

	/**
	 * Initializes the plugin and registers event handlers
	 *
	 * @param Server $server
	 * @return void
	 */
	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
	 */
	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 {
			$image = $fileNode->getThumbnail($queryParams);
		} catch (ForbiddenException $ex) {
			throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry());
		}
		if ($image) {
			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", time() + 86400) . " GMT");

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

			// Returning false to break the event chain
			return false;
		}
		// 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 OCP\Files\ForbiddenException;
25			use OCP\Files\IPreviewNode;
26			use OCP\ILogger;
27			use Sabre\DAV\Exception\NotFound;
28			use Sabre\DAV\Server;
29			use Sabre\DAV\ServerPlugin;
30			use Sabre\HTTP\RequestInterface;
31			use Sabre\HTTP\ResponseInterface;
32			use OCA\DAV\Connector\Sabre\Exception\Forbidden as DAVForbiddenException;
33
34			class PreviewPlugin extends ServerPlugin {
35
36			/** @var Server */
37			protected $server;
38			/** @var ILogger */
39			private $logger;
40
41			public function __construct(ILogger $logger) {
42			$this->logger = $logger;
43			}
44
45			/**
46			* Initializes the plugin and registers event handlers
47			*
48			* @param Server $server
49			* @return void
50			*/
51			function initialize(Server $server) {
52
53			$this->server = $server;
54			$this->server->on('method:GET', [$this, 'httpGet'], 90);
55			}
56
57			/**
58			* Intercepts GET requests on node urls ending with ?preview.
59			* The node has to implement IPreviewNode
60			*
61			* @param RequestInterface $request
62			* @param ResponseInterface $response
63			* @return bool
64			* @throws NotFound
65			* @throws \Sabre\DAVACL\Exception\NeedPrivileges
66			* @throws \Sabre\DAV\Exception\NotAuthenticated
67			*/
68			function httpGet(RequestInterface $request, ResponseInterface $response) {
69
70			$queryParams = $request->getQueryParameters();
71			if (!array_key_exists('preview', $queryParams)) {
72			return true;
73			}
74
75			$path = $request->getPath();
76			$node = $this->server->tree->getNodeForPath($path);
77
78			if (!$node instanceof IFileNode) {
79			return false;
80			}
81			$fileNode = $node->getNode();
82			if (!$fileNode instanceof IPreviewNode) {
83			return false;
84			}
85
86			// Checking ACL, if available.
87			if ($aclPlugin = $this->server->getPlugin('acl')) {
88			/** @var \Sabre\DAVACL\Plugin $aclPlugin */
89			$aclPlugin->checkPrivileges($path, '{DAV:}read');
90			}
91
92			try {
93			$image = $fileNode->getThumbnail($queryParams);
94			} catch (ForbiddenException $ex) {
95			throw new DAVForbiddenException($ex->getMessage(), $ex->getRetry());
96			}
97			if ($image) {
98			if ($image === null \|\| !$image->valid()) {
99			throw new NotFound();
100			}
101			$type = $image->mimeType();
102			if (!in_array($type, ['image/png', 'image/jpeg', 'image/gif'])) {
103			$type = 'application/octet-stream';
104			}
105
106			// Enable output buffering
107			ob_start();
108			// Capture the output
109			$image->show();
110			$imageData = ob_get_contents();
111			// Clear the output buffer
112			ob_end_clean();
113
114			$response->setHeader('Content-Type', $type);
115			$response->setHeader('Content-Disposition', 'attachment');
116			// cache 24h
117			$response->setHeader('Cache-Control', 'max-age=86400, must-revalidate');
118			$response->setHeader('Expires', gmdate ("D, d M Y H:i:s", time() + 86400) . " GMT");
119
120			$response->setStatus(200);
121			$response->setBody($imageData);
122
123			// Returning false to break the event chain
124			return false;
125			}
126			// TODO: add forceIcon handling .... if still needed
127			throw new NotFound();
128			}
129			}
130

owncloud / core

Push — master ( 883df4...959368 )

PreviewPlugin::httpGet() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like