OcmController - Code Metrics - Inspection of "[WIP] Federated sharing new spec" - owncloud/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#32303)

by Victor

created 2018-10-01 22:07 UTC

OcmController A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	411
Duplicated Lines	7.79 %

Coupling/Cohesion

Components	1
Dependencies	14

Importance

Changes

Metric	Value
dl	32
loc	411
rs	10
c	0
b	0
f	0
wmc	30
lcom	1
cbo	14

8 Methods

Rating	Name	Duplication	Size	Complexity
A	isSupportedResourceType()	0	3	1
A	isSupportedShareType()	0	4	1
A	isSupportedProtocol()	0	5	1
C	createShare()	0	114	13
A	__construct()	18	18	1
A	discovery()	0	16	1
C	processNotification()	14	120	11
A	getProtocols()	0	5	1

How to fix Duplicated Code

<?php
/**
 * @author Viktar Dubiniuk <[email protected]>
 *
 * @copyright Copyright (c) 2018, 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\FederatedFileSharing\Controller;

use OCA\FederatedFileSharing\Address;
use OCA\FederatedFileSharing\AddressHandler;
use OCA\FederatedFileSharing\Middleware\OcmMiddleware;
use OCA\FederatedFileSharing\Ocm\Exception\BadRequestException;
use OCA\FederatedFileSharing\Ocm\Exception\NotImplementedException;
use OCA\FederatedFileSharing\Ocm\Notification\FileNotification;
use OCP\AppFramework\Http\JSONResponse;
use OCA\FederatedFileSharing\FedShareManager;
use OCA\FederatedFileSharing\Ocm\Exception\OcmException;
use OCP\AppFramework\Controller;
use OCP\AppFramework\Http;
use OCP\ILogger;
use OCP\IRequest;
use OCP\IURLGenerator;
use OCP\IUserManager;

/**
 * Class OcmController
 *
 * @package OCA\FederatedFileSharing\Controller
 */
class OcmController extends Controller {
	const API_VERSION = '1.0-proposal1';

	/**
	 * @var OcmMiddleware
	 */
	private $ocmMiddleware;

	/**
	 * @var IURLGenerator
	 */
	protected $urlGenerator;

	/**
	 * @var IUserManager
	 */
	protected $userManager;

	/**
	 * @var AddressHandler
	 */
	protected $addressHandler;

	/**
	 * @var FedShareManager
	 */
	protected $fedShareManager;

	/**
	 * @var ILogger
	 */
	protected $logger;

	/**
	 * OcmController constructor.
	 *
	 * @param string $appName
	 * @param IRequest $request
	 * @param OcmMiddleware $ocmMiddleware
	 * @param IURLGenerator $urlGenerator
	 * @param IUserManager $userManager
	 * @param AddressHandler $addressHandler
	 * @param FedShareManager $fedShareManager
	 * @param ILogger $logger
	 */
	public function __construct($appName,
									IRequest $request,
									OcmMiddleware $ocmMiddleware,
									IURLGenerator $urlGenerator,
									IUserManager $userManager,
									AddressHandler $addressHandler,
									FedShareManager $fedShareManager,
									ILogger $logger
	) {
		parent::__construct($appName, $request);

		$this->ocmMiddleware = $ocmMiddleware;
		$this->urlGenerator = $urlGenerator;
		$this->userManager = $userManager;
		$this->addressHandler = $addressHandler;
		$this->fedShareManager = $fedShareManager;
		$this->logger = $logger;
	}

	/**
	 * @NoCSRFRequired
	 * @PublicPage
	 *
	 * EndPoint discovery
	 * Responds to /ocm-provider/ requests
	 *
	 * @return array
	 */
	public function discovery() {
		$endPoint = $this->urlGenerator->linkToRouteAbsolute(
			"{$this->appName}.ocm.index"
		);
		return [
			'enabled' => true,
			'apiVersion' => self::API_VERSION,
			'endPoint' => \rtrim($endPoint, '/'),
			'shareTypes' => [
				[
					'name' => FileNotification::RESOURCE_TYPE_FILE,
					'protocols' => $this->getProtocols()
				]
			]
		];
	}

	/**
	 * @NoCSRFRequired
	 * @PublicPage
	 *
	 * @param string $shareWith identifier of the user or group
	 * 							to share the resource with
	 * @param string $name name of the shared resource
	 * @param string $description share description (optional)
	 * @param string $providerId Identifier of the resource at the provider side
	 * @param string $owner identifier of the user that owns the resource
	 * @param string $ownerDisplayName display name of the owner
	 * @param string $sender Provider specific identifier of the user that wants
	 *							to share the resource
	 * @param string $senderDisplayName Display name of the user that wants
	 * 									to share the resource
	 * @param string $shareType Share type ('user' is supported atm)
	 * @param string $resourceType only 'file' is supported atm
	 * @param array $protocol
	 * 		[
	 * 			'name' => (string) protocol name. Only 'webdav' is supported atm,
	 * 			'options' => [
	 * 				protocol specific options
	 * 				only `webdav` options are supported atm
	 * 				e.g. `uri`,	`access_token`, `password`, `permissions` etc.
	 *
	 * 				For backward compatibility the webdav protocol will use
	 * 				the 'sharedSecret" as username and password
	 * 			]
	 *
	 * @return JSONResponse
	 */
	public function createShare($shareWith,
								$name,
								$description,

								$providerId,
								$owner,
								$ownerDisplayName,
								$sender,
								$senderDisplayName,
								$shareType,
								$resourceType,
								$protocol

	) {
		try {
			$this->ocmMiddleware->assertIncomingSharingEnabled();
			$this->ocmMiddleware->assertNotNull(
				[
					'shareWith' => $shareWith,
					'name' => $name,
					'providerId' => $providerId,
					'owner' => $owner,
					'shareType' => $shareType,
					'resourceType' => $resourceType
				]
			);
			if (!\is_array($protocol)
				|| !isset($protocol['name'])
				|| !isset($protocol['options'])
				|| !\is_array($protocol['options'])
				|| !isset($protocol['options']['sharedSecret'])
			) {
				throw new BadRequestException(
					'server can not add remote share, missing parameter'
				);
			}
			if (!\OCP\Util::isValidFileName($name)) {
				throw new BadRequestException(
					'The mountpoint name contains invalid characters.'
				);
			}

			$shareWithAddress = new Address($shareWith);
			$localShareWith = $shareWithAddress->getUserId();

			// FIXME this should be a method in the user management instead
			$this->logger->debug(
				"shareWith before, $localShareWith",
				['app' => $this->appName]
			);
			\OCP\Util::emitHook(
				'\OCA\Files_Sharing\API\Server2Server',
				'preLoginNameUsedAsUserName',
				['uid' => &$localShareWith]
			);
			$this->logger->debug(
				"shareWith after, $localShareWith",
				['app' => $this->appName]
			);

			if ($this->isSupportedProtocol($protocol['name']) === false) {
				throw new NotImplementedException(
					"Protocol {$protocol['name']} is not supported"
				);
			}

			if ($this->isSupportedShareType($shareType) === false) {
				throw new NotImplementedException(
					"ShareType {$shareType} is not supported"
				);
			}

			if ($this->isSupportedResourceType($resourceType) === false) {
				throw new NotImplementedException(
					"ResourceType {$resourceType} is not supported"
				);
			}

			if (!$this->userManager->userExists($localShareWith)) {
				throw new BadRequestException("User $localShareWith does not exist");
			}

			$ownerAddress = new Address($owner, $ownerDisplayName);
			$sharedByAddress = new Address($sender, $senderDisplayName);

			$this->fedShareManager->createShare(
				$ownerAddress,
				$sharedByAddress,
				$localShareWith,
				$providerId,
				$name,
				$protocol['options']['sharedSecret']
			);
		} catch (OcmException $e) {
			return new JSONResponse(
				['message' => $e->getMessage()],
				$e->getHttpStatusCode()
			);
		} catch (\Exception $e) {
			$this->logger->error(
				"server can not add remote share, {$e->getMessage()}",
				['app' => 'federatefilesharing']
			);
			return new JSONResponse(
				[
					'message' => "internal server error, was not able to add share from {$ownerAddress->getHostName()}"
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
				],
				Http::STATUS_INTERNAL_SERVER_ERROR
			);
		}
		return new JSONResponse(
			[],
			Http::STATUS_CREATED
		);
	}

	/**
	 * @NoCSRFRequired
	 * @PublicPage
	 *
	 * @param string $notificationType notification type (SHARE_REMOVED, etc)
	 * @param string $resourceType only 'file' is supported atm
	 * @param string $providerId Identifier of the resource at the provider side
	 * @param array $notification
	 * 		[
	 * 			optional additional parameters, depending on the notification
	 * 				and the resource type
	 * 		]
	 *
	 * @return JSONResponse
	 */
	public function processNotification($notificationType,
										$resourceType,
										$providerId,
										$notification
	) {
		try {
			$this->ocmMiddleware->assertNotNull(
				[
					'notificationType' => $notificationType,
					'resourceType' => $resourceType,
					'providerId' => $providerId
				]
			);
			if (!\is_array($notification)) {
				throw new BadRequestException(
					'server can not add remote share, missing parameter'
				);
			}

			if ($this->isSupportedResourceType($resourceType) === false) {
				throw new NotImplementedException(
					"ResourceType {$resourceType} is not supported"
				);
			}
			// TODO: check permissions/preconditions in all cases
			switch ($notificationType) {
				case FileNotification::NOTIFICATION_TYPE_SHARE_ACCEPTED:

					$this->ocmMiddleware->assertOutgoingSharingEnabled();
					$share = $this->ocmMiddleware->getValidShare(
						$providerId, $notification['sharedSecret']
					);
					$this->fedShareManager->acceptShare($share);
					break;
				case FileNotification::NOTIFICATION_TYPE_SHARE_DECLINED:

					$this->ocmMiddleware->assertOutgoingSharingEnabled();
					$share = $this->ocmMiddleware->getValidShare(
						$providerId, $notification['sharedSecret']
					);
					$this->fedShareManager->declineShare($share);
					break;
				case FileNotification::NOTIFICATION_TYPE_REQUEST_RESHARE:
					$this->ocmMiddleware->assertOutgoingSharingEnabled();
					$this->ocmMiddleware->assertNotNull(
						[
							'shareWith' => $notification['shareWith'],
							'senderId' => $notification['senderId'],
						]
					);
					$share = $this->ocmMiddleware->getValidShare(
						$providerId, $notification['sharedSecret']
					);

					// don't allow to share a file back to the owner
					$owner = $share->getShareOwner();
					$ownerAddress = $this->addressHandler->getLocalUserFederatedAddress($owner);
					$shareWithAddress = new Address($notification['shareWith']);
					$this->ocmMiddleware->assertNotSameUser($ownerAddress, $shareWithAddress);
					$this->ocmMiddleware->assertSharingPermissionSet($share);

					// TODO: permissions not needed ???
					$reShare = $this->fedShareManager->reShare(
						$share, $notification['senderId'],
						$notification['shareWith'],
						0
					);
					return new JSONResponse(
						[
							'sharedSecret' => $reShare->getToken(),
							'providerId' => $reShare->getId()
						],
						Http::STATUS_CREATED
					);
					break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
				case FileNotification::NOTIFICATION_TYPE_RESHARE_CHANGE_PERMISSION:
					$permissions = $notification['permission'];
					// TODO: Map OCM permissions to numeric
					$share = $this->ocmMiddleware->getValidShare(
						$providerId, $notification['sharedSecret']
					);
					$this->fedShareManager->updatePermissions($share, $permissions);
					break;
				case FileNotification::NOTIFICATION_TYPE_SHARE_UNSHARED:
					$this->fedShareManager->unshare(
						$providerId, $notification['sharedSecret']
					);
					break;
				case FileNotification::NOTIFICATION_TYPE_RESHARE_UNDO:
					$share = $this->ocmMiddleware->getValidShare(
						$providerId, $notification['sharedSecret']
					);
					$this->fedShareManager->revoke($share);
					break;
				default:
					return new JSONResponse(
						['message' => "Notification of type {$notificationType} is not supported"],
						Http::STATUS_NOT_IMPLEMENTED
					);
			}
		} catch (OcmException $e) {
			return new JSONResponse(
				['message' => $e->getMessage()],
				$e->getHttpStatusCode()
			);
		} catch (\Exception $e) {
			$this->logger->error(
				"server can not process notification, {$e->getMessage()}",
				['app' => 'federatefilesharing']
			);
			return new JSONResponse(
				[
					'message' => "internal server error, was not able to process notification"
				],
				Http::STATUS_INTERNAL_SERVER_ERROR
			);
		}
		return new JSONResponse(
			[],
			Http::STATUS_CREATED
		);
	}

	/**
	 * Get list of supported protocols
	 *
	 * @return array
	 */
	protected function getProtocols() {
		return [
			'webdav' => '/public.php/webdav/'
		];
	}

	/**
	 * @param string $resourceType
	 *
	 * @return bool
	 */
	protected function isSupportedResourceType($resourceType) {
		return $resourceType === FileNotification::RESOURCE_TYPE_FILE;
	}

	/**
	 * @param string $shareType
	 * @return bool
	 */
	protected function isSupportedShareType($shareType) {
		// TODO: make it a constant
		return $shareType === 'user';
	}

	/**
	 * @param string $protocolName
	 * @return bool
	 */
	protected function isSupportedProtocol($protocolName) {
		$supportedProtocols = $this->getProtocols();
		$supportedProtocolNames = \array_keys($supportedProtocols);
		return \in_array($protocolName, $supportedProtocolNames);
	}
}


1		<?php
2		/**
3		* @author Viktar Dubiniuk <[email protected]>
4		*
5		* @copyright Copyright (c) 2018, 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\FederatedFileSharing\Controller;
23
24		use OCA\FederatedFileSharing\Address;
25		use OCA\FederatedFileSharing\AddressHandler;
26		use OCA\FederatedFileSharing\Middleware\OcmMiddleware;
27		use OCA\FederatedFileSharing\Ocm\Exception\BadRequestException;
28		use OCA\FederatedFileSharing\Ocm\Exception\NotImplementedException;
29		use OCA\FederatedFileSharing\Ocm\Notification\FileNotification;
30		use OCP\AppFramework\Http\JSONResponse;
31		use OCA\FederatedFileSharing\FedShareManager;
32		use OCA\FederatedFileSharing\Ocm\Exception\OcmException;
33		use OCP\AppFramework\Controller;
34		use OCP\AppFramework\Http;
35		use OCP\ILogger;
36		use OCP\IRequest;
37		use OCP\IURLGenerator;
38		use OCP\IUserManager;
39
40		/**
41		* Class OcmController
42		*
43		* @package OCA\FederatedFileSharing\Controller
44		*/
45		class OcmController extends Controller {
46		const API_VERSION = '1.0-proposal1';
47
48		/**
49		* @var OcmMiddleware
50		*/
51		private $ocmMiddleware;
52
53		/**
54		* @var IURLGenerator
55		*/
56		protected $urlGenerator;
57
58		/**
59		* @var IUserManager
60		*/
61		protected $userManager;
62
63		/**
64		* @var AddressHandler
65		*/
66		protected $addressHandler;
67
68		/**
69		* @var FedShareManager
70		*/
71		protected $fedShareManager;
72
73		/**
74		* @var ILogger
75		*/
76		protected $logger;
77
78		/**
79		* OcmController constructor.
80		*
81		* @param string $appName
82		* @param IRequest $request
83		* @param OcmMiddleware $ocmMiddleware
84		* @param IURLGenerator $urlGenerator
85		* @param IUserManager $userManager
86		* @param AddressHandler $addressHandler
87		* @param FedShareManager $fedShareManager
88		* @param ILogger $logger
89		*/
90	View Code Duplication	public function __construct($appName,
91		IRequest $request,
92		OcmMiddleware $ocmMiddleware,
93		IURLGenerator $urlGenerator,
94		IUserManager $userManager,
95		AddressHandler $addressHandler,
96		FedShareManager $fedShareManager,
97		ILogger $logger
98		) {
99		parent::__construct($appName, $request);
100
101		$this->ocmMiddleware = $ocmMiddleware;
102		$this->urlGenerator = $urlGenerator;
103		$this->userManager = $userManager;
104		$this->addressHandler = $addressHandler;
105		$this->fedShareManager = $fedShareManager;
106		$this->logger = $logger;
107		}
108
109		/**
110		* @NoCSRFRequired
111		* @PublicPage
112		*
113		* EndPoint discovery
114		* Responds to /ocm-provider/ requests
115		*
116		* @return array
117		*/
118		public function discovery() {
119		$endPoint = $this->urlGenerator->linkToRouteAbsolute(
120		"{$this->appName}.ocm.index"
121		);
122		return [
123		'enabled' => true,
124		'apiVersion' => self::API_VERSION,
125		'endPoint' => \rtrim($endPoint, '/'),
126		'shareTypes' => [
127		[
128		'name' => FileNotification::RESOURCE_TYPE_FILE,
129		'protocols' => $this->getProtocols()
130		]
131		]
132		];
133		}
134
135		/**
136		* @NoCSRFRequired
137		* @PublicPage
138		*
139		* @param string $shareWith identifier of the user or group
140		* to share the resource with
141		* @param string $name name of the shared resource
142		* @param string $description share description (optional)
143		* @param string $providerId Identifier of the resource at the provider side
144		* @param string $owner identifier of the user that owns the resource
145		* @param string $ownerDisplayName display name of the owner
146		* @param string $sender Provider specific identifier of the user that wants
147		* to share the resource
148		* @param string $senderDisplayName Display name of the user that wants
149		* to share the resource
150		* @param string $shareType Share type ('user' is supported atm)
151		* @param string $resourceType only 'file' is supported atm
152		* @param array $protocol
153		* [
154		* 'name' => (string) protocol name. Only 'webdav' is supported atm,
155		* 'options' => [
156		* protocol specific options
157		* only `webdav` options are supported atm
158		* e.g. `uri`, `access_token`, `password`, `permissions` etc.
159		*
160		* For backward compatibility the webdav protocol will use
161		* the 'sharedSecret" as username and password
162		* ]
163		*
164		* @return JSONResponse
165		*/
166		public function createShare($shareWith,
167		$name,
168		$description,
		0 ignored issues – show Unused Code introduced 2018-08-10 16:39 UTC by Report Bug Copy Issue Report The parameter `$description` 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...
169		$providerId,
170		$owner,
171		$ownerDisplayName,
172		$sender,
173		$senderDisplayName,
174		$shareType,
175		$resourceType,
176		$protocol
177
178		) {
179		try {
180		$this->ocmMiddleware->assertIncomingSharingEnabled();
181		$this->ocmMiddleware->assertNotNull(
182		[
183		'shareWith' => $shareWith,
184		'name' => $name,
185		'providerId' => $providerId,
186		'owner' => $owner,
187		'shareType' => $shareType,
188		'resourceType' => $resourceType
189		]
190		);
191		if (!\is_array($protocol)
192		\|\| !isset($protocol['name'])
193		\|\| !isset($protocol['options'])
194		\|\| !\is_array($protocol['options'])
195		\|\| !isset($protocol['options']['sharedSecret'])
196		) {
197		throw new BadRequestException(
198		'server can not add remote share, missing parameter'
199		);
200		}
201		if (!\OCP\Util::isValidFileName($name)) {
202		throw new BadRequestException(
203		'The mountpoint name contains invalid characters.'
204		);
205		}
206
207		$shareWithAddress = new Address($shareWith);
208		$localShareWith = $shareWithAddress->getUserId();
209
210		// FIXME this should be a method in the user management instead
211		$this->logger->debug(
212		"shareWith before, $localShareWith",
213		['app' => $this->appName]
214		);
215		\OCP\Util::emitHook(
216		'\OCA\Files_Sharing\API\Server2Server',
217		'preLoginNameUsedAsUserName',
218		['uid' => &$localShareWith]
219		);
220		$this->logger->debug(
221		"shareWith after, $localShareWith",
222		['app' => $this->appName]
223		);
224
225		if ($this->isSupportedProtocol($protocol['name']) === false) {
226		throw new NotImplementedException(
227		"Protocol {$protocol['name']} is not supported"
228		);
229		}
230
231		if ($this->isSupportedShareType($shareType) === false) {
232		throw new NotImplementedException(
233		"ShareType {$shareType} is not supported"
234		);
235		}
236
237		if ($this->isSupportedResourceType($resourceType) === false) {
238		throw new NotImplementedException(
239		"ResourceType {$resourceType} is not supported"
240		);
241		}
242
243		if (!$this->userManager->userExists($localShareWith)) {
244		throw new BadRequestException("User $localShareWith does not exist");
245		}
246
247		$ownerAddress = new Address($owner, $ownerDisplayName);
248		$sharedByAddress = new Address($sender, $senderDisplayName);
249
250		$this->fedShareManager->createShare(
251		$ownerAddress,
252		$sharedByAddress,
253		$localShareWith,
254		$providerId,
255		$name,
256		$protocol['options']['sharedSecret']
257		);
258		} catch (OcmException $e) {
259		return new JSONResponse(
260		['message' => $e->getMessage()],
261		$e->getHttpStatusCode()
262		);
263		} catch (\Exception $e) {
264		$this->logger->error(
265		"server can not add remote share, {$e->getMessage()}",
266		['app' => 'federatefilesharing']
267		);
268		return new JSONResponse(
269		[
270		'message' => "internal server error, was not able to add share from {$ownerAddress->getHostName()}"
		0 ignored issues – show Bug introduced 2018-08-30 15:06 UTC by Report Bug Copy Issue Report The variable `$ownerAddress` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
271		],
272		Http::STATUS_INTERNAL_SERVER_ERROR
273		);
274		}
275		return new JSONResponse(
276		[],
277		Http::STATUS_CREATED
278		);
279		}
280
281		/**
282		* @NoCSRFRequired
283		* @PublicPage
284		*
285		* @param string $notificationType notification type (SHARE_REMOVED, etc)
286		* @param string $resourceType only 'file' is supported atm
287		* @param string $providerId Identifier of the resource at the provider side
288		* @param array $notification
289		* [
290		* optional additional parameters, depending on the notification
291		* and the resource type
292		* ]
293		*
294		* @return JSONResponse
295		*/
296		public function processNotification($notificationType,
297		$resourceType,
298		$providerId,
299		$notification
300		) {
301		try {
302		$this->ocmMiddleware->assertNotNull(
303		[
304		'notificationType' => $notificationType,
305		'resourceType' => $resourceType,
306		'providerId' => $providerId
307		]
308		);
309		if (!\is_array($notification)) {
310		throw new BadRequestException(
311		'server can not add remote share, missing parameter'
312		);
313		}
314
315		if ($this->isSupportedResourceType($resourceType) === false) {
316		throw new NotImplementedException(
317		"ResourceType {$resourceType} is not supported"
318		);
319		}
320		// TODO: check permissions/preconditions in all cases
321		switch ($notificationType) {
322	View Code Duplication	case FileNotification::NOTIFICATION_TYPE_SHARE_ACCEPTED:
		0 ignored issues – show Duplication introduced 2018-09-03 17:53 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...
323		$this->ocmMiddleware->assertOutgoingSharingEnabled();
324		$share = $this->ocmMiddleware->getValidShare(
325		$providerId, $notification['sharedSecret']
326		);
327		$this->fedShareManager->acceptShare($share);
328		break;
329	View Code Duplication	case FileNotification::NOTIFICATION_TYPE_SHARE_DECLINED:
		0 ignored issues – show Duplication introduced 2018-09-03 17:53 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...
330		$this->ocmMiddleware->assertOutgoingSharingEnabled();
331		$share = $this->ocmMiddleware->getValidShare(
332		$providerId, $notification['sharedSecret']
333		);
334		$this->fedShareManager->declineShare($share);
335		break;
336		case FileNotification::NOTIFICATION_TYPE_REQUEST_RESHARE:
337		$this->ocmMiddleware->assertOutgoingSharingEnabled();
338		$this->ocmMiddleware->assertNotNull(
339		[
340		'shareWith' => $notification['shareWith'],
341		'senderId' => $notification['senderId'],
342		]
343		);
344		$share = $this->ocmMiddleware->getValidShare(
345		$providerId, $notification['sharedSecret']
346		);
347
348		// don't allow to share a file back to the owner
349		$owner = $share->getShareOwner();
350		$ownerAddress = $this->addressHandler->getLocalUserFederatedAddress($owner);
351		$shareWithAddress = new Address($notification['shareWith']);
352		$this->ocmMiddleware->assertNotSameUser($ownerAddress, $shareWithAddress);
353		$this->ocmMiddleware->assertSharingPermissionSet($share);
354
355		// TODO: permissions not needed ???
356		$reShare = $this->fedShareManager->reShare(
357		$share, $notification['senderId'],
358		$notification['shareWith'],
359		0
360		);
361		return new JSONResponse(
362		[
363		'sharedSecret' => $reShare->getToken(),
364		'providerId' => $reShare->getId()
365		],
366		Http::STATUS_CREATED
367		);
368		break;
		0 ignored issues – show Unused Code introduced 2018-09-13 23:26 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
369		case FileNotification::NOTIFICATION_TYPE_RESHARE_CHANGE_PERMISSION:
370		$permissions = $notification['permission'];
371		// TODO: Map OCM permissions to numeric
372		$share = $this->ocmMiddleware->getValidShare(
373		$providerId, $notification['sharedSecret']
374		);
375		$this->fedShareManager->updatePermissions($share, $permissions);
376		break;
377		case FileNotification::NOTIFICATION_TYPE_SHARE_UNSHARED:
378		$this->fedShareManager->unshare(
379		$providerId, $notification['sharedSecret']
380		);
381		break;
382		case FileNotification::NOTIFICATION_TYPE_RESHARE_UNDO:
383		$share = $this->ocmMiddleware->getValidShare(
384		$providerId, $notification['sharedSecret']
385		);
386		$this->fedShareManager->revoke($share);
387		break;
388		default:
389		return new JSONResponse(
390		['message' => "Notification of type {$notificationType} is not supported"],
391		Http::STATUS_NOT_IMPLEMENTED
392		);
393		}
394		} catch (OcmException $e) {
395		return new JSONResponse(
396		['message' => $e->getMessage()],
397		$e->getHttpStatusCode()
398		);
399		} catch (\Exception $e) {
400		$this->logger->error(
401		"server can not process notification, {$e->getMessage()}",
402		['app' => 'federatefilesharing']
403		);
404		return new JSONResponse(
405		[
406		'message' => "internal server error, was not able to process notification"
407		],
408		Http::STATUS_INTERNAL_SERVER_ERROR
409		);
410		}
411		return new JSONResponse(
412		[],
413		Http::STATUS_CREATED
414		);
415		}
416
417		/**
418		* Get list of supported protocols
419		*
420		* @return array
421		*/
422		protected function getProtocols() {
423		return [
424		'webdav' => '/public.php/webdav/'
425		];
426		}
427
428		/**
429		* @param string $resourceType
430		*
431		* @return bool
432		*/
433		protected function isSupportedResourceType($resourceType) {
434		return $resourceType === FileNotification::RESOURCE_TYPE_FILE;
435		}
436
437		/**
438		* @param string $shareType
439		* @return bool
440		*/
441		protected function isSupportedShareType($shareType) {
442		// TODO: make it a constant
443		return $shareType === 'user';
444		}
445
446		/**
447		* @param string $protocolName
448		* @return bool
449		*/
450		protected function isSupportedProtocol($protocolName) {
451		$supportedProtocols = $this->getProtocols();
452		$supportedProtocolNames = \array_keys($supportedProtocols);
453		return \in_array($protocolName, $supportedProtocolNames);
454		}
455		}
456

owncloud / core

Pull Request — master (#32303)

OcmController A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

8 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Duplication Side-by-Side

Filter issues like