TransferRequestManager - Code Metrics - Inspection of "[WIP] User actioned transfer of folders to other u..." - owncloud/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#32545)

by Tom

created 2018-09-02 15:12 UTC

TransferRequestManager A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	329
Duplicated Lines	6.38 %

Coupling/Cohesion

Components	1
Dependencies	21

Importance

Changes

Metric	Value
dl	21
loc	329
rs	9.52
c	0
b	0
f	0
wmc	36
lcom	1
cbo	21

13 Methods

Rating	Name	Duplication	Size	Complexity
A	prepare()	0	23	4
A	__construct()	0	18	1
B	newTransferRequest()	0	55	8
A	acceptRequest()	3	20	4
A	rejectRequest()	3	18	4
A	deleteRequest()	0	13	1
A	sendRequestNotification()	0	35	1
B	formatNotification()	15	40	6
A	actionRequest()	0	6	1
A	notifyActioned()	0	20	1
A	cleanup()	0	24	3
A	getLockTokenFromRequest()	0	3	1
A	getRequestById()	0	3	1

How to fix Duplicated Code

<?php

namespace OCA\Files\Service\TransferOwnership;

use OC\Command\CommandJob;
use OCA\Files\BackgroundJob\TransferOwnership;
use OCP\AppFramework\Db\DoesNotExistException;
use OCP\AppFramework\Utility\ITimeFactory;
use OCP\BackgroundJob\IJobList;
use OCP\Files\Folder;
use OCP\Files\IRootFolder;
use OCP\Files\NotFoundException;
use OCP\Files\NotPermittedException;
use OCP\Files\Storage\IPersistentLockingStorage;
use OCP\IL10N;
use OCP\IURLGenerator;
use OCP\IUser;
use OCP\IUserManager;
use OCP\L10N\IFactory;
use OCP\Lock\Persistent\ILock;
use OCP\Notification\IManager;
use OCP\Notification\INotification;
use OCP\Notification\INotifier;
use OCP\Util;

class TransferRequestManager implements INotifier {

	/** @var IRootFolder */
	protected $rootFolder;
	/** @var IManager */
	protected $notificationManager;
	/** @var IUserManager  */
	protected $userManager;
	/** @var ITimeFactory */
	protected $timeFactory;
	/** @var TransferRequestMapper  */
	protected $requestMapper;
	/** @var IURLGenerator  */
	protected $urlGenerator;
	/** @var IFactory */
	protected $factory;
	/** @var IJobList */
	protected $jobList;

	public function __construct(
		IRootFolder $rootFolder,
		IManager $notificationManager,
		IUserManager $userManager,
		ITimeFactory $timeFactory,
		TransferRequestMapper $requestMapper,
		IURLGenerator $urlGenerator,
		IFactory $factory,
		IJobList $jobList) {
		$this->rootFolder = $rootFolder;
		$this->notificationManager = $notificationManager;
		$this->userManager = $userManager;
		$this->timeFactory = $timeFactory;
		$this->requestMapper = $requestMapper;
		$this->urlGenerator = $urlGenerator;
		$this->factory = $factory;
		$this->jobList = $jobList;
	}

	/**
	 * @param IUser $sourceUser
	 * @param IUser $destinationUser
	 * @param $fileId
	 * @throws NotFoundException
	 * @throws \Exception
	 */
	public function newTransferRequest(IUser $sourceUser, IUser $destinationUser, $fileId) {
		// Cannot give to self
		if ($sourceUser->getUID() === $destinationUser->getUID()) {
			throw new \Exception('Cannot transfer to self');
		}
		// Check node exists
		$sourceFolder = $this->rootFolder->getById($fileId)[0];
		// Check source user owns the node
		if ($sourceFolder->getOwner()->getUID() !== $sourceUser->getUID()) {
			throw new NotPermittedException('Cannot move a file you dont own');
		}
		// Check the folder is on persistent lockable storage otherwise we can't do this in the background
		if (!$sourceFolder->getStorage() instanceof IPersistentLockingStorage) {
			throw new \Exception('Source folder storage not lockable');
		}
		// Check therer is no request with the same signature
		if (count($this->requestMapper->findRequestWithSameSignature($sourceUser->getUID(), $destinationUser->getUID(), $fileId)) > 0) {
			// There is
			throw new \Exception('There is already a request to transfer this file/folder');
		}
		// Check we are not trying to request a transfer for a folder that is inside a current request
		$folder = $sourceFolder;
		$fileids = [$folder->getId()];
		while($folder->getPath() !== '/') {
			$folder = $folder->getParent();
			$fileids[] = $folder->getId();
		}
		if (count($this->requestMapper->findOpenRequestForGivenFiles($fileids)) > 0) {
			throw new \Exception('This file/folder is already pending an existing transfer');
		}

		// Create the transfer request object
		$request = new TransferRequest();
		$request->setRequestedTime($this->timeFactory->getTime());
		$request->setSourceUserId($sourceUser->getUID());
		$request->setDestinationUserId($destinationUser->getUID());
		$request->setFileId($fileId);
		$request = $this->requestMapper->insert($request);

		/** @var IPersistentLockingStorage $storage */
		$storage = $sourceFolder->getStorage();
		try {
			$storage->lockNodePersistent($sourceFolder->getInternalPath(), [
				'depth' => ILock::LOCK_DEPTH_INFINITE,
				'token' => $this->getLockTokenFromRequest($request),

				'timeout' => 60*60*2 // 2 hours to allow a cron run
			]);
		} catch (\Exception $e) {
			// Cleanup transfer request and fail
			$this->requestMapper->delete($request);
			throw $e;
		}

		$this->sendRequestNotification($request);

	}

	public function acceptRequest(TransferRequest $request) {
		if ($request->getAcceptedTime() !== null || $request->getActionedTime() !== null || $request->getRejectedTime() !== null) {

			throw new \Exception('Already actioned, accepted or rejected');
		}
		// Create a background job, update accepted time
		$request->setAcceptedTime($this->timeFactory->getTime());
		$this->requestMapper->update($request);
		$sourcePath = $this->rootFolder->getUserFolder(
			$request->getSourceUserId())->getById($request->getFileId())[0]->getInternalPath();
		$this->jobList->add(TransferOwnership::class, json_encode([
			'sourcePath' => $sourcePath,
			'sourceUser' => $request->getSourceUserId(),
			'destinationUser' => $request->getDestinationUserId()
		]));
		$notification = $this->notificationManager->createNotification();
		$notification->setApp('files')
			->setUser($request->getDestinationUserId())
			->setObject('transfer_request', $request->getId());
		$this->notificationManager->markProcessed($notification);
	}

	public function rejectRequest(TransferRequest $request) {
		// Cleanup the lock, save reject timestamp
		if ($request->getAcceptedTime() !== null || $request->getActionedTime() !== null || $request->getRejectedTime() !== null) {

			throw new \Exception('Already actioned, accepted or rejected');
		}
		// Create a background job, update accepted time
		$request->setRejectedTime($this->timeFactory->getTime());
		$this->requestMapper->update($request);
		$notification = $this->notificationManager->createNotification();
		$notification->setApp('files')
			->setUser($request->getDestinationUserId())
			->setObject('transfer_request', $request->getId());
		$this->notificationManager->markProcessed($notification);
		$file = $this->rootFolder->getById($request->getFileId())[0];
		/** @var IPersistentLockingStorage $storage */
		$storage = $file->getStorage();
		$storage->unlockNodePersistent($file->getInternalPath(), ['token' => $this->getLockTokenFromRequest($request)]);
	}

	public function deleteRequest(TransferRequest $request) {
		// Cleanup the lock and the notification
		$this->requestMapper->delete($request);
		$notification = $this->notificationManager->createNotification();
		$notification->setApp('files')
			->setUser($request->getDestinationUserId())
			->setObject('transfer_request', $request->getId());
		$this->notificationManager->markProcessed($notification);
		$file = $this->rootFolder->getById($request->getFileId())[0];
		/** @var IPersistentLockingStorage $storage */
		$storage = $file->getStorage();
		$storage->unlockNodePersistent($file->getInternalPath(), ['token' => $this->getLockTokenFromRequest($request)]);
	}


	/**
	 * @param TransferRequest $request the request object
	 */
	protected function sendRequestNotification(TransferRequest $request) {
		$time = new \DateTime();
		$time->setTimestamp($this->timeFactory->getTime());
		$notification = $this->notificationManager->createNotification();
		$notification->setApp('files')
			->setUser($request->getDestinationUserId())
			->setDateTime($time)
			->setObject('transfer_request', $request->getId());

		$notification->setIcon(
			$this->urlGenerator->imagePath('core', 'actions/give.svg')
		);

		$sourceUser = $this->userManager->get($request->getSourceUserId());
		$folder = $this->rootFolder->getById($request->getFileId())[0];
		$notification->setSubject("new_transfer_request");
		$notification->setMessage("new_transfer_request", [$sourceUser->getDisplayName(), $folder->getName(), Util::humanFileSize($folder->getSize())]);

		$endpoint = $this->urlGenerator->linkToRouteAbsolute(
			'files.Transfer.accept',
			['requestId' => $request->getId()]
		);
		$declineAction = $notification->createAction();
		$declineAction->setLabel('reject');
		$declineAction->setLink($endpoint, 'DELETE');
		$notification->addAction($declineAction);

		$acceptAction = $notification->createAction();
		$acceptAction->setLabel('accept');
		$acceptAction->setLink($endpoint, 'POST');
		$acceptAction->setPrimary(true);
		$notification->addAction($acceptAction);

		$this->notificationManager->notify($notification);
	}

	public function prepare(INotification $notification, $languageCode) {
		if ($notification->getApp() !== 'files') {
			throw new \InvalidArgumentException();
		}

		// Read the language from the notification
		$l = $this->factory->get('files', $languageCode);

		switch ($notification->getObjectType()) {
			case 'transfer_request':
				$requestId = $notification->getObjectId();
				try {
					$this->requestMapper->findById($requestId);
				} catch (DoesNotExistException $ex) {
					$this->notificationManager->markProcessed($notification);
					throw new \InvalidArgumentException();
				}
				return $this->formatNotification($notification, $l);

			default:
				throw new \InvalidArgumentException();
		}
	}

	protected function formatNotification(INotification $notification, IL10N $l) {
		switch($notification->getObjectType()) {
			case 'transfer_request':
				$notification->setParsedSubject((string) $l->t('A user would like to transfer a folder to you'));
				$notification->setParsedMessage(
					(string) $l->t(
						'"%1$s" requested to transfer "%2$s" to you (%3$s)"',
						$notification->getMessageParameters())
				);
				foreach ($notification->getActions() as $action) {

					switch ($action->getLabel()) {
						case 'accept':
							$action->setParsedLabel(
								(string) $l->t('Accept')
							);
							break;
						case 'reject':
							$action->setParsedLabel(
								(string) $l->t('Decline')
							);
							break;
					}
					$notification->addParsedAction($action);
				}
				return $notification;
				break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
			case 'transfer_request_actioned':
				$notification->setParsedSubject((string) $l->t('Transfer completed'));
				$notification->setParsedMessage(
					(string) $l->t(
						'"%1$s" accepted your transfer of "%2$s" and it was completed',
						$notification->getMessageParameters())
				);
				return $notification;
				break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
			default:
				throw new \InvalidArgumentException('Not a notifcation that can be formatted by this class');
		}

	}

	public function actionRequest(TransferRequest $request) {
		$request->setActionedTime($this->timeFactory->getTime());
		$this->requestMapper->update($request);
		// Notify the source user it was accepted
		$this->notifyActioned($request);
	}

	/**
	 * Tell the source user that the trasnfer has happened
	 * @param TransferRequest $request
	 * @throws NotFoundException
	 * @throws \OCP\Files\InvalidPathException
	 */
	public function notifyActioned(TransferRequest $request) {
		// Set to now
		$time = new \DateTime();
		$time->setTimestamp($request->getActionedTime());
		$notification = $this->notificationManager->createNotification();
		$notification->setApp('files')
			->setUser($request->getSourceUserId())
			->setDateTime($time)
			->setObject('transfer_request_actioned', $request->getId());

		$notification->setIcon(
			$this->urlGenerator->imagePath('core', 'actions/give.svg')
		);

		$sourceUser = $this->userManager->get($request->getSourceUserId());
		$folder = $this->rootFolder->getById($request->getFileId())[0];
		$notification->setSubject("transfer_request_actioned");
		$notification->setMessage("transfer_request_actioned", [$sourceUser->getDisplayName(), $folder->getName()]);
		$this->notificationManager->notify($notification);
	}

	public function cleanup() {
		// Delete request that are older than 24 hours
		$oldRequests = $this->requestMapper->findOpenRequestsOlderThan(1);
		/** @var TransferRequest $request */
		foreach ($oldRequests as $request) {
			// Remove the lock
			try {
				$file = $this->rootFolder->getById($request->getFileId())[0];
				/** @var IPersistentLockingStorage $storage */
				$storage = $file->getStorage();
				$storage->unlockNodePersistent($file->getInternalPath(), $this->getLockTokenFromRequest($request));
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
			} catch (\Exception $e) {
				\OC::$server->getLogger()->logException($e, ['app' => 'files']);
			}
			// Now remove the request
			$this->requestMapper->delete($request);
			// And lets remove the notification to save confusion
			$notification = $this->notificationManager->createNotification();
			$notification->setApp('files')
				->setUser($request->getDestinationUserId())
				->setObject('transfer_request', $request->getId());
			$this->notificationManager->markProcessed($notification);
		}
	}

	protected function getLockTokenFromRequest(TransferRequest $request) {
		return 'transfer-request-'.$request->getId();
	}

	public function getRequestById($requestId) {
		return $this->requestMapper->findById($requestId);
	}


}

1		<?php
2
3		namespace OCA\Files\Service\TransferOwnership;
4
5		use OC\Command\CommandJob;
6		use OCA\Files\BackgroundJob\TransferOwnership;
7		use OCP\AppFramework\Db\DoesNotExistException;
8		use OCP\AppFramework\Utility\ITimeFactory;
9		use OCP\BackgroundJob\IJobList;
10		use OCP\Files\Folder;
11		use OCP\Files\IRootFolder;
12		use OCP\Files\NotFoundException;
13		use OCP\Files\NotPermittedException;
14		use OCP\Files\Storage\IPersistentLockingStorage;
15		use OCP\IL10N;
16		use OCP\IURLGenerator;
17		use OCP\IUser;
18		use OCP\IUserManager;
19		use OCP\L10N\IFactory;
20		use OCP\Lock\Persistent\ILock;
21		use OCP\Notification\IManager;
22		use OCP\Notification\INotification;
23		use OCP\Notification\INotifier;
24		use OCP\Util;
25
26		class TransferRequestManager implements INotifier {
27
28		/** @var IRootFolder */
29		protected $rootFolder;
30		/** @var IManager */
31		protected $notificationManager;
32		/** @var IUserManager */
33		protected $userManager;
34		/** @var ITimeFactory */
35		protected $timeFactory;
36		/** @var TransferRequestMapper */
37		protected $requestMapper;
38		/** @var IURLGenerator */
39		protected $urlGenerator;
40		/** @var IFactory */
41		protected $factory;
42		/** @var IJobList */
43		protected $jobList;
44
45		public function __construct(
46		IRootFolder $rootFolder,
47		IManager $notificationManager,
48		IUserManager $userManager,
49		ITimeFactory $timeFactory,
50		TransferRequestMapper $requestMapper,
51		IURLGenerator $urlGenerator,
52		IFactory $factory,
53		IJobList $jobList) {
54		$this->rootFolder = $rootFolder;
55		$this->notificationManager = $notificationManager;
56		$this->userManager = $userManager;
57		$this->timeFactory = $timeFactory;
58		$this->requestMapper = $requestMapper;
59		$this->urlGenerator = $urlGenerator;
60		$this->factory = $factory;
61		$this->jobList = $jobList;
62		}
63
64		/**
65		* @param IUser $sourceUser
66		* @param IUser $destinationUser
67		* @param $fileId
68		* @throws NotFoundException
69		* @throws \Exception
70		*/
71		public function newTransferRequest(IUser $sourceUser, IUser $destinationUser, $fileId) {
72		// Cannot give to self
73		if ($sourceUser->getUID() === $destinationUser->getUID()) {
74		throw new \Exception('Cannot transfer to self');
75		}
76		// Check node exists
77		$sourceFolder = $this->rootFolder->getById($fileId)[0];
78		// Check source user owns the node
79		if ($sourceFolder->getOwner()->getUID() !== $sourceUser->getUID()) {
80		throw new NotPermittedException('Cannot move a file you dont own');
81		}
82		// Check the folder is on persistent lockable storage otherwise we can't do this in the background
83		if (!$sourceFolder->getStorage() instanceof IPersistentLockingStorage) {
84		throw new \Exception('Source folder storage not lockable');
85		}
86		// Check therer is no request with the same signature
87		if (count($this->requestMapper->findRequestWithSameSignature($sourceUser->getUID(), $destinationUser->getUID(), $fileId)) > 0) {
88		// There is
89		throw new \Exception('There is already a request to transfer this file/folder');
90		}
91		// Check we are not trying to request a transfer for a folder that is inside a current request
92		$folder = $sourceFolder;
93		$fileids = [$folder->getId()];
94		while($folder->getPath() !== '/') {
95		$folder = $folder->getParent();
96		$fileids[] = $folder->getId();
97		}
98		if (count($this->requestMapper->findOpenRequestForGivenFiles($fileids)) > 0) {
99		throw new \Exception('This file/folder is already pending an existing transfer');
100		}
101
102		// Create the transfer request object
103		$request = new TransferRequest();
104		$request->setRequestedTime($this->timeFactory->getTime());
105		$request->setSourceUserId($sourceUser->getUID());
106		$request->setDestinationUserId($destinationUser->getUID());
107		$request->setFileId($fileId);
108		$request = $this->requestMapper->insert($request);
109
110		/** @var IPersistentLockingStorage $storage */
111		$storage = $sourceFolder->getStorage();
112		try {
113		$storage->lockNodePersistent($sourceFolder->getInternalPath(), [
114		'depth' => ILock::LOCK_DEPTH_INFINITE,
115		'token' => $this->getLockTokenFromRequest($request),
		0 ignored issues – show Compatibility introduced 2018-09-01 23:43 UTC by Report Bug Copy Issue Report `$request` of type `object<OCP\AppFramework\Db\Entity>` is not a sub-type of `object<OCA\Files\Service...ership\TransferRequest>`. It seems like you assume a child class of the class `OCP\AppFramework\Db\Entity` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
116		'timeout' => 60602 // 2 hours to allow a cron run
117		]);
118		} catch (\Exception $e) {
119		// Cleanup transfer request and fail
120		$this->requestMapper->delete($request);
121		throw $e;
122		}
123
124		$this->sendRequestNotification($request);
		0 ignored issues – show Compatibility introduced 2018-09-01 23:43 UTC by Report Bug Copy Issue Report `$request` of type `object<OCP\AppFramework\Db\Entity>` is not a sub-type of `object<OCA\Files\Service...ership\TransferRequest>`. It seems like you assume a child class of the class `OCP\AppFramework\Db\Entity` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
125		}
126
127		public function acceptRequest(TransferRequest $request) {
128	View Code Duplication	if ($request->getAcceptedTime() !== null \|\| $request->getActionedTime() !== null \|\| $request->getRejectedTime() !== null) {
		0 ignored issues – show Duplication introduced 2018-09-01 23:43 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...
129		throw new \Exception('Already actioned, accepted or rejected');
130		}
131		// Create a background job, update accepted time
132		$request->setAcceptedTime($this->timeFactory->getTime());
133		$this->requestMapper->update($request);
134		$sourcePath = $this->rootFolder->getUserFolder(
135		$request->getSourceUserId())->getById($request->getFileId())[0]->getInternalPath();
136		$this->jobList->add(TransferOwnership::class, json_encode([
137		'sourcePath' => $sourcePath,
138		'sourceUser' => $request->getSourceUserId(),
139		'destinationUser' => $request->getDestinationUserId()
140		]));
141		$notification = $this->notificationManager->createNotification();
142		$notification->setApp('files')
143		->setUser($request->getDestinationUserId())
144		->setObject('transfer_request', $request->getId());
145		$this->notificationManager->markProcessed($notification);
146		}
147
148		public function rejectRequest(TransferRequest $request) {
149		// Cleanup the lock, save reject timestamp
150	View Code Duplication	if ($request->getAcceptedTime() !== null \|\| $request->getActionedTime() !== null \|\| $request->getRejectedTime() !== null) {
		0 ignored issues – show Duplication introduced 2018-09-01 23:43 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...
151		throw new \Exception('Already actioned, accepted or rejected');
152		}
153		// Create a background job, update accepted time
154		$request->setRejectedTime($this->timeFactory->getTime());
155		$this->requestMapper->update($request);
156		$notification = $this->notificationManager->createNotification();
157		$notification->setApp('files')
158		->setUser($request->getDestinationUserId())
159		->setObject('transfer_request', $request->getId());
160		$this->notificationManager->markProcessed($notification);
161		$file = $this->rootFolder->getById($request->getFileId())[0];
162		/** @var IPersistentLockingStorage $storage */
163		$storage = $file->getStorage();
164		$storage->unlockNodePersistent($file->getInternalPath(), ['token' => $this->getLockTokenFromRequest($request)]);
165		}
166
167		public function deleteRequest(TransferRequest $request) {
168		// Cleanup the lock and the notification
169		$this->requestMapper->delete($request);
170		$notification = $this->notificationManager->createNotification();
171		$notification->setApp('files')
172		->setUser($request->getDestinationUserId())
173		->setObject('transfer_request', $request->getId());
174		$this->notificationManager->markProcessed($notification);
175		$file = $this->rootFolder->getById($request->getFileId())[0];
176		/** @var IPersistentLockingStorage $storage */
177		$storage = $file->getStorage();
178		$storage->unlockNodePersistent($file->getInternalPath(), ['token' => $this->getLockTokenFromRequest($request)]);
179		}
180
181
182		/**
183		* @param TransferRequest $request the request object
184		*/
185		protected function sendRequestNotification(TransferRequest $request) {
186		$time = new \DateTime();
187		$time->setTimestamp($this->timeFactory->getTime());
188		$notification = $this->notificationManager->createNotification();
189		$notification->setApp('files')
190		->setUser($request->getDestinationUserId())
191		->setDateTime($time)
192		->setObject('transfer_request', $request->getId());
193
194		$notification->setIcon(
195		$this->urlGenerator->imagePath('core', 'actions/give.svg')
196		);
197
198		$sourceUser = $this->userManager->get($request->getSourceUserId());
199		$folder = $this->rootFolder->getById($request->getFileId())[0];
200		$notification->setSubject("new_transfer_request");
201		$notification->setMessage("new_transfer_request", [$sourceUser->getDisplayName(), $folder->getName(), Util::humanFileSize($folder->getSize())]);
202
203		$endpoint = $this->urlGenerator->linkToRouteAbsolute(
204		'files.Transfer.accept',
205		['requestId' => $request->getId()]
206		);
207		$declineAction = $notification->createAction();
208		$declineAction->setLabel('reject');
209		$declineAction->setLink($endpoint, 'DELETE');
210		$notification->addAction($declineAction);
211
212		$acceptAction = $notification->createAction();
213		$acceptAction->setLabel('accept');
214		$acceptAction->setLink($endpoint, 'POST');
215		$acceptAction->setPrimary(true);
216		$notification->addAction($acceptAction);
217
218		$this->notificationManager->notify($notification);
219		}
220
221		public function prepare(INotification $notification, $languageCode) {
222		if ($notification->getApp() !== 'files') {
223		throw new \InvalidArgumentException();
224		}
225
226		// Read the language from the notification
227		$l = $this->factory->get('files', $languageCode);
228
229		switch ($notification->getObjectType()) {
230		case 'transfer_request':
231		$requestId = $notification->getObjectId();
232		try {
233		$this->requestMapper->findById($requestId);
234		} catch (DoesNotExistException $ex) {
235		$this->notificationManager->markProcessed($notification);
236		throw new \InvalidArgumentException();
237		}
238		return $this->formatNotification($notification, $l);
239
240		default:
241		throw new \InvalidArgumentException();
242		}
243		}
244
245		protected function formatNotification(INotification $notification, IL10N $l) {
246		switch($notification->getObjectType()) {
247		case 'transfer_request':
248		$notification->setParsedSubject((string) $l->t('A user would like to transfer a folder to you'));
249		$notification->setParsedMessage(
250		(string) $l->t(
251		'"%1$s" requested to transfer "%2$s" to you (%3$s)"',
252		$notification->getMessageParameters())
253		);
254	View Code Duplication	foreach ($notification->getActions() as $action) {
		0 ignored issues – show Duplication introduced 2018-08-16 10:28 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...
255		switch ($action->getLabel()) {
256		case 'accept':
257		$action->setParsedLabel(
258		(string) $l->t('Accept')
259		);
260		break;
261		case 'reject':
262		$action->setParsedLabel(
263		(string) $l->t('Decline')
264		);
265		break;
266		}
267		$notification->addParsedAction($action);
268		}
269		return $notification;
270		break;
		0 ignored issues – show Unused Code introduced 2018-09-02 15:22 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...
271		case 'transfer_request_actioned':
272		$notification->setParsedSubject((string) $l->t('Transfer completed'));
273		$notification->setParsedMessage(
274		(string) $l->t(
275		'"%1$s" accepted your transfer of "%2$s" and it was completed',
276		$notification->getMessageParameters())
277		);
278		return $notification;
279		break;
		0 ignored issues – show Unused Code introduced 2018-09-02 15:22 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...
280		default:
281		throw new \InvalidArgumentException('Not a notifcation that can be formatted by this class');
282		}
283
284		}
285
286		public function actionRequest(TransferRequest $request) {
287		$request->setActionedTime($this->timeFactory->getTime());
288		$this->requestMapper->update($request);
289		// Notify the source user it was accepted
290		$this->notifyActioned($request);
291		}
292
293		/**
294		* Tell the source user that the trasnfer has happened
295		* @param TransferRequest $request
296		* @throws NotFoundException
297		* @throws \OCP\Files\InvalidPathException
298		*/
299		public function notifyActioned(TransferRequest $request) {
300		// Set to now
301		$time = new \DateTime();
302		$time->setTimestamp($request->getActionedTime());
303		$notification = $this->notificationManager->createNotification();
304		$notification->setApp('files')
305		->setUser($request->getSourceUserId())
306		->setDateTime($time)
307		->setObject('transfer_request_actioned', $request->getId());
308
309		$notification->setIcon(
310		$this->urlGenerator->imagePath('core', 'actions/give.svg')
311		);
312
313		$sourceUser = $this->userManager->get($request->getSourceUserId());
314		$folder = $this->rootFolder->getById($request->getFileId())[0];
315		$notification->setSubject("transfer_request_actioned");
316		$notification->setMessage("transfer_request_actioned", [$sourceUser->getDisplayName(), $folder->getName()]);
317		$this->notificationManager->notify($notification);
318		}
319
320		public function cleanup() {
321		// Delete request that are older than 24 hours
322		$oldRequests = $this->requestMapper->findOpenRequestsOlderThan(1);
323		/** @var TransferRequest $request */
324		foreach ($oldRequests as $request) {
325		// Remove the lock
326		try {
327		$file = $this->rootFolder->getById($request->getFileId())[0];
328		/** @var IPersistentLockingStorage $storage */
329		$storage = $file->getStorage();
330		$storage->unlockNodePersistent($file->getInternalPath(), $this->getLockTokenFromRequest($request));
		0 ignored issues – show Documentation introduced 2018-09-01 23:43 UTC by Report Bug Copy Issue Report `$this->getLockTokenFromRequest($request)` is of type `string`, but the function expects a `array`. 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...
331		} catch (\Exception $e) {
332		\OC::$server->getLogger()->logException($e, ['app' => 'files']);
333		}
334		// Now remove the request
335		$this->requestMapper->delete($request);
336		// And lets remove the notification to save confusion
337		$notification = $this->notificationManager->createNotification();
338		$notification->setApp('files')
339		->setUser($request->getDestinationUserId())
340		->setObject('transfer_request', $request->getId());
341		$this->notificationManager->markProcessed($notification);
342		}
343		}
344
345		protected function getLockTokenFromRequest(TransferRequest $request) {
346		return 'transfer-request-'.$request->getId();
347		}
348
349		public function getRequestById($requestId) {
350		return $this->requestMapper->findById($requestId);
351		}
352
353
354		}

owncloud / core

Pull Request — master (#32545)

TransferRequestManager A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

13 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like