TransferRequestManager::formatNotification() - 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 21:43 UTC
TransferRequestManager::formatNotification() B

↳ Parent: TransferRequestManager
Complexity

Conditions	9
Paths	9
Size

Total Lines
Duplication

Lines	51
Ratio	76.12 %
Importance

Changes
Metric	Value
cc	9
nc	9
nop	2
dl	51
loc	67
rs	7.1644
c	0
b	0
f	0
How to fix Long Method

<?php
/**
 * @author Tom Needham <[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\Files\Service\TransferOwnership;

use OCA\Files\BackgroundJob\TransferOwnership;
use OCP\AppFramework\Db\DoesNotExistException;
use OCP\AppFramework\Utility\ITimeFactory;
use OCP\BackgroundJob\IJobList;
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;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\EventDispatcher\GenericEvent;

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;
	/** @var EventDispatcherInterface  */
	protected $eventDispatcher;

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

	/**
	 * @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*24 // 24 hours to allow a cron run and acceptance
			]);
		} 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([
			'requestId' => $request->getId(),
		]));
		$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');
		}
		$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->getUserFolder($request->getSourceUserId())->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());
		$sourceUserFolder = $this->rootFolder->getUserFolder($sourceUser->getUID());
		$folder = $sourceUserFolder->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->getSubject()) {
			case 'new_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_source':

				$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.
}
			case 'transfer_request_actioned_destination':

				$notification->setParsedSubject((string) $l->t('Transfer completed'));
				$notification->setParsedMessage(
					(string) $l->t(
						'"%1$s" was transferred to you from "%2$s"',
						$notification->getMessageParameters())
				);
				return $notification;
				break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
			case 'transfer_request_failed_destination':

				$notification->setParsedSubject((string) $l->t('Transfer failed'));
				$notification->setParsedMessage(
					(string) $l->t(
						'The transfer of "%1$s" from "%2$s failed. Ask the sender to try again."',
						$notification->getMessageParameters())
				);
				return $notification;
			break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
			case 'transfer_request_failed_source':

				$notification->setParsedSubject((string) $l->t('Transfer failed'));
				$notification->setParsedMessage(
					(string) $l->t(
						'The transfer of "%1$s" to "%2$s" failed with message: "%3$s"',
						$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);
		$this->eventDispatcher->dispatch('files:user-transfer-complete', new GenericEvent([
			'requestId' => $request,
			'sourceUser' => $request->getSourceUserId(),
			'destinationUser' => $request->getDestinationUserId(),
			'sourceNode' => $request->getFileId()
		]));
	}

	/**
	 * Cleanup and notify
	 * @param TransferRequest $request
	 * @throws NotFoundException
	 * @throws \OCP\Files\InvalidPathException
	 */
	public function actionRequestFailure(TransferRequest $request, $message = null) {
		// Notify the users that it failed
		$this->notifyActionedFailure($request, $message);
		$this->cleanupRequest($request);

	}

	/**
	 * Tell the source user and destination user that the transfer 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', $request->getId());

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

		$destinationUser = $this->userManager->get($request->getDestinationUserId());
		$folder = $this->rootFolder->getById($request->getFileId())[0];
		$notification->setSubject("transfer_request_actioned_source");
		$notification->setMessage("transfer_request_actioned_source", [$destinationUser->getDisplayName(), $folder->getName()]);
		$this->notificationManager->notify($notification);

		// Set to now
		$time = new \DateTime();
		$time->setTimestamp($request->getActionedTime());
		$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("transfer_request_actioned_destination");
		$notification->setMessage("transfer_request_actioned_destination", [$folder->getName(), $sourceUser->getDisplayName()]);
		$notification->setLink($this->urlGenerator->getAbsoluteURL('/f/'.$folder->getId()));
		$this->notificationManager->notify($notification);
	}

	/**
	 * Tell the source user and destination user that the transfer failed
	 * @param TransferRequest $request
	 * @throws NotFoundException
	 * @throws \OCP\Files\InvalidPathException
	 */
	public function notifyActionedFailure(TransferRequest $request, $message = null) {
		// Set to now
		$time = new \DateTime();
		$time->setTimestamp($this->timeFactory->getTime());
		$notification = $this->notificationManager->createNotification();
		$notification->setApp('files')
			->setUser($request->getSourceUserId())
			->setDateTime($time)
			->setObject('transfer_request', $request->getId());

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

		$destinationUser = $this->userManager->get($request->getDestinationUserId());
		$folder = $this->rootFolder->getById($request->getFileId())[0];
		$notification->setSubject("transfer_request_failed_source");
		$notification->setMessage("transfer_request_failed_source", [$folder->getName(), $destinationUser->getDisplayName(), $message]);
		$this->notificationManager->notify($notification);

		// Set to now
		$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("transfer_request_failed_destination");
		$notification->setMessage("transfer_request_failed_destination", [$folder->getName(), $sourceUser->getDisplayName()]);
		$this->notificationManager->notify($notification);
	}

	/**
	 * Background job for cleaning up old requests, removes notifications, request and locks
	 */
	public function cleanup() {
		// Delete request that are older than 24 hours
		$oldRequests = $this->requestMapper->findOpenRequestsOlderThan(1);
		/** @var TransferRequest $request */
		foreach ($oldRequests as $request) {
			$this->cleanupRequest($request);
		}
	}

	/**
	 * Delete request, delete lock, and delete requested notification
	 * @param TransferRequest $request
	 */
	protected function cleanupRequest(TransferRequest $request) {
		// Remove the lock
		try {
			$file = $this->rootFolder->getById($request->getFileId())[0];
			/** @var IPersistentLockingStorage $storage */
			$storage = $file->getStorage();
			$storage->unlockNodePersistent($file->getInternalPath(), ['token' => $this->getLockTokenFromRequest($request)]);
		} 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);
	}

	/**
	 * Helper to get the lock token id associated with a request
	 * @param TransferRequest $request
	 * @return string
	 */
	protected function getLockTokenFromRequest(TransferRequest $request) {
		return 'transfer-request-'.$request->getId();
	}

	/**
	 * Helper to get a request object from the mapper without another dep injection
	 * @param $requestId
	 * @return TransferRequest|\OCP\AppFramework\Db\Entity
	 * @throws DoesNotExistException
	 * @throws \OCP\AppFramework\Db\MultipleObjectsReturnedException
	 */
	public function getRequestById($requestId) {
		return $this->requestMapper->findById($requestId);
	}


}
owncloud / core

Pull Request — master (#32545)

TransferRequestManager::formatNotification() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like
