Merge pull request #3664 from nextcloud/backport/stable23/2496

[stable23] Transfer ownership

lib/Command/TransferOwnership.php

@@ -0,0 +1,105 @@
+<?php
+
+namespace OCA\Deck\Command;
+
+use OCA\Deck\Db\BoardMapper;
+use OCA\Deck\Service\BoardService;
+use OCA\Deck\Service\PermissionService;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Helper\QuestionHelper;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Question\ConfirmationQuestion;
+
+final class TransferOwnership extends Command {
+	protected $boardService;
+	protected $boardMapper;
+	protected $permissionService;
+	protected $questionHelper;
+
+	public function __construct(BoardService $boardService, BoardMapper $boardMapper, PermissionService $permissionService, QuestionHelper $questionHelper) {
+		parent::__construct();
+
+		$this->boardService = $boardService;
+		$this->boardMapper = $boardMapper;
+		$this->permissionService = $permissionService;
+		$this->questionHelper = $questionHelper;
+	}
+
+	protected function configure() {
+		$this
+			->setName('deck:transfer-ownership')
+			->setDescription('Change owner of deck boards')
+			->addArgument(
+				'owner',
+				InputArgument::REQUIRED,
+				'Owner uid'
+			)
+			->addArgument(
+				'newOwner',
+				InputArgument::REQUIRED,
+				'New owner uid'
+			)
+			->addArgument(
+				'boardId',
+				InputArgument::OPTIONAL,
+				'Single board ID'
+			)
+			->addOption(
+				'remap',
+				'r',
+				InputOption::VALUE_NONE,
+				'Reassign card details of the old owner to the new one'
+			)
+		;
+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output): int {
+		$owner = $input->getArgument('owner');
+		$newOwner = $input->getArgument('newOwner');
+		$boardId = $input->getArgument('boardId');
+
+		$remapAssignment = $input->getOption('remap');
+
+		$this->boardService->setUserId($owner);
+		$this->permissionService->setUserId($owner);
+
+		try {
+			$board = $boardId ? $this->boardMapper->find($boardId) : null;
+		} catch (\Exception $e) {
+			$output->writeln("Could not find a board for the provided id.");
+			return 1;
+		}
+
+		if ($boardId !== null && $board->getOwner() !== $owner) {
+			$output->writeln("$owner is not the owner of the board $boardId (" . $board->getTitle() . ")");
+			return 1;
+		}
+
+		if ($boardId) {
+			$output->writeln("Transfer board " . $board->getTitle() . " from ". $board->getOwner() ." to $newOwner");
+		} else {
+			$output->writeln("Transfer all boards from $owner to $newOwner");
+		}
+
+		$question = new ConfirmationQuestion('Do you really want to continue? (y/n) ', false);
+		if (!$this->questionHelper->ask($input, $output, $question)) {
+			return 1;
+		}
+
+		if ($boardId) {
+			$this->boardService->transferBoardOwnership($boardId, $newOwner, $remapAssignment);
+			$output->writeln("<info>Board " . $board->getTitle() . " from ". $board->getOwner() ." transferred to $newOwner completed</info>");
+			return 0;
+		}
+
+		foreach ($this->boardService->transferOwnership($owner, $newOwner, $remapAssignment) as $board) {
+			$output->writeln(" - " . $board->getTitle() . " transferred");
+		}
+		$output->writeln("<info>All boards from $owner to $newOwner transferred</info>");
+
+		return 0;
+	}
+}

lib/Controller/BoardController.php

@@ -24,9 +24,12 @@
 namespace OCA\Deck\Controller;
 
 use OCA\Deck\Db\Acl;
+use OCA\Deck\Db\Board;
 use OCA\Deck\Service\BoardService;
 use OCA\Deck\Service\PermissionService;
 use OCP\AppFramework\ApiController;
+use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\DataResponse;
 use OCP\IRequest;
 
 class BoardController extends ApiController {
@@ -150,9 +153,20 @@ class BoardController extends ApiController {
 	/**
 	 * @NoAdminRequired
 	 * @param $boardId
-	 * @return \OCP\Deck\DB\Board
+	 * @return Board
 	 */
 	public function clone($boardId) {
 		return $this->boardService->clone($boardId, $this->userId);
 	}
+
+	/**
+	 * @NoAdminRequired
+	 */
+	public function transferOwner(int $boardId, string $newOwner): DataResponse {
+		if ($this->permissionService->userIsBoardOwner($boardId, $this->userId)) {
+			return new DataResponse($this->boardService->transferBoardOwnership($boardId, $newOwner), HTTP::STATUS_OK);
+		}
+
+		return new DataResponse([], HTTP::STATUS_UNAUTHORIZED);
+	}
 }

lib/Db/AclMapper.php

@@ -25,6 +25,7 @@ namespace OCA\Deck\Db;
 
 use OCP\AppFramework\Db\DoesNotExistException;
 use OCP\AppFramework\Db\MultipleObjectsReturnedException;
+use OCP\DB\QueryBuilder\IQueryBuilder;
 use OCP\IDBConnection;
 
 class AclMapper extends DeckMapper implements IPermissionMapper {
@@ -57,4 +58,16 @@ class AclMapper extends DeckMapper implements IPermissionMapper {
 		$sql = 'SELECT * from *PREFIX*deck_board_acl WHERE type = ? AND participant = ?';
 		return $this->findEntities($sql, [$type, $participant]);
 	}
+
+	/**
+	 * @throws \OCP\DB\Exception
+	 */
+	public function deleteParticipantFromBoard(int $boardId, int $type, string $participant): void {
+		$qb = $this->db->getQueryBuilder();
+		$qb->delete('deck_board_acl')
+			->where($qb->expr()->eq('type', $qb->createNamedParameter($type, IQueryBuilder::PARAM_INT)))
+			->andWhere($qb->expr()->eq('participant', $qb->createNamedParameter($participant, IQueryBuilder::PARAM_STR)))
+			->andWhere($qb->expr()->eq('board_id', $qb->createNamedParameter($boardId, IQueryBuilder::PARAM_INT)));
+		$qb->executeStatement();
+	}
 }

lib/Db/AssignmentMapper.php

@@ -29,6 +29,7 @@ use OCA\Deck\NotFoundException;
 use OCA\Deck\Service\CirclesService;
 use OCP\AppFramework\Db\Entity;
 use OCP\AppFramework\Db\QBMapper;
+use OCP\DB\QueryBuilder\IQueryBuilder;
 use OCP\IDBConnection;
 use OCP\IGroupManager;
 use OCP\IUserManager;
@@ -146,4 +147,39 @@ class AssignmentMapper extends QBMapper implements IPermissionMapper {
 		}
 		return null;
 	}
+
+	public function remapAssignedUser(int $boardId, string $userId, string $newUserId): void {
+		$subQuery = $this->db->getQueryBuilder();
+		$subQuery->selectAlias('a.id', 'id')
+			->from('deck_assigned_users', 'a')
+			->innerJoin('a', 'deck_cards', 'c', 'c.id = a.card_id')
+			->innerJoin('c', 'deck_stacks', 's', 's.id = c.stack_id')
+			->where($subQuery->expr()->eq('a.type', $subQuery->createNamedParameter(Assignment::TYPE_USER, IQueryBuilder::PARAM_INT)))
+			->andWhere($subQuery->expr()->eq('a.participant', $subQuery->createNamedParameter($userId, IQueryBuilder::PARAM_STR)))
+			->andWhere($subQuery->expr()->eq('s.board_id', $subQuery->createNamedParameter($boardId, IQueryBuilder::PARAM_INT)))
+			->setMaxResults(1000);
+
+		$qb = $this->db->getQueryBuilder();
+		$qb->update('deck_assigned_users')
+			->set('participant', $qb->createParameter('participant'))
+			->where($qb->expr()->in('id', $qb->createParameter('ids')));
+
+		$moreResults = true;
+		do {
+			$result = $subQuery->executeQuery();
+			$ids = array_map(function ($item) {
+				return $item['id'];
+			}, $result->fetchAll());
+
+			if (count($ids) === 0 || $result->rowCount() === 0) {
+				$moreResults = false;
+			}
+
+			$qb->setParameter('participant', $newUserId, IQueryBuilder::PARAM_STR);
+			$qb->setParameter('ids', $ids, IQueryBuilder::PARAM_INT_ARRAY);
+			$qb->executeStatement();
+		} while ($moreResults === true);
+
+		$result->closeCursor();
+	}
 }

lib/Db/BoardMapper.php

@@ -475,4 +475,34 @@ class BoardMapper extends QBMapper implements IPermissionMapper {
 			return null;
 		});
 	}
+
+	/**
+	 * @throws \OCP\DB\Exception
+	 */
+	public function transferOwnership(string $ownerId, string $newOwnerId, $boardId = null): void {
+		$qb = $this->db->getQueryBuilder();
+		$qb->update('deck_boards')
+			->set('owner', $qb->createNamedParameter($newOwnerId, IQueryBuilder::PARAM_STR))
+			->where($qb->expr()->eq('owner', $qb->createNamedParameter($ownerId, IQueryBuilder::PARAM_STR)));
+		if ($boardId !== null) {
+			$qb->andWhere($qb->expr()->eq('id', $qb->createNamedParameter($boardId, IQueryBuilder::PARAM_INT)));
+		}
+		$qb->executeStatement();
+	}
+
+	/**
+	 * Reset cache for a given board or a given user
+	 */
+	public function flushCache(?int $boardId = null, ?string $userId = null) {
+		if ($boardId) {
+			unset($this->boardCache[$boardId]);
+		} else {
+			$this->boardCache = null;
+		}
+		if ($userId) {
+			unset($this->userBoardCache[$userId]);
+		} else {
+			$this->userBoardCache = null;
+		}
+	}
 }

lib/Db/CardMapper.php

@@ -586,4 +586,47 @@ class CardMapper extends QBMapper implements IPermissionMapper {
 			return null;
 		});
 	}
+
+	public function transferOwnership(string $ownerId, string $newOwnerId, int $boardId = null): void {
+		$params = [
+			'owner' => $ownerId,
+			'newOwner' => $newOwnerId
+		];
+		$sql = "UPDATE `*PREFIX*{$this->tableName}`  SET `owner` = :newOwner WHERE `owner` = :owner";
+		$stmt = $this->db->executeQuery($sql, $params);
+		$stmt->closeCursor();
+	}
+
+	public function remapCardOwner(int $boardId, string $userId, string $newUserId): void {
+		$subQuery = $this->db->getQueryBuilder();
+		$subQuery->selectAlias('c.id', 'id')
+			->from('deck_cards', 'c')
+			->innerJoin('c', 'deck_stacks', 's', 's.id = c.stack_id')
+			->where($subQuery->expr()->eq('c.owner', $subQuery->createNamedParameter($userId, IQueryBuilder::PARAM_STR)))
+			->andWhere($subQuery->expr()->eq('s.board_id', $subQuery->createNamedParameter($boardId, IQueryBuilder::PARAM_INT)))
+			->setMaxResults(1000);
+
+		$qb = $this->db->getQueryBuilder();
+		$qb->update('deck_cards')
+			->set('owner', $qb->createParameter('owner'))
+			->where($qb->expr()->in('id', $qb->createParameter('ids')));
+
+		$moreResults = true;
+		do {
+			$result = $subQuery->executeQuery();
+			$ids = array_map(function ($item) {
+				return $item['id'];
+			}, $result->fetchAll());
+
+			if (count($ids) === 0 || $result->rowCount() === 0) {
+				$moreResults = false;
+			}
+
+			$qb->setParameter('owner', $newUserId, IQueryBuilder::PARAM_STR);
+			$qb->setParameter('ids', $ids, IQueryBuilder::PARAM_INT_ARRAY);
+			$qb->executeStatement();
+		} while ($moreResults === true);
+
+		$result->closeCursor();
+	}
 }

lib/Service/BoardService.php

@@ -24,12 +24,14 @@
 
 namespace OCA\Deck\Service;
 
+use Doctrine\DBAL\Exception\UniqueConstraintViolationException;
 use OCA\Deck\Activity\ActivityManager;
 use OCA\Deck\Activity\ChangeSet;
 use OCA\Deck\AppInfo\Application;
 use OCA\Deck\Db\Acl;
 use OCA\Deck\Db\AclMapper;
 use OCA\Deck\Db\AssignmentMapper;
+use OCA\Deck\Db\CardMapper;
 use OCA\Deck\Db\ChangeHelper;
 use OCA\Deck\Db\IPermissionMapper;
 use OCA\Deck\Db\Label;
@@ -69,6 +71,8 @@ class BoardService {
 	private $activityManager;
 	private $eventDispatcher;
 	private $changeHelper;
+	private $cardMapper;
+
 	private $boardsCache = null;
 	private $urlGenerator;
 
@@ -83,6 +87,7 @@ class BoardService {
 		PermissionService $permissionService,
 		NotificationHelper $notificationHelper,
 		AssignmentMapper $assignedUsersMapper,
+		CardMapper $cardMapper,
 		IUserManager $userManager,
 		IGroupManager $groupManager,
 		ActivityManager $activityManager,
@@ -107,6 +112,7 @@ class BoardService {
 		$this->changeHelper = $changeHelper;
 		$this->userId = $userId;
 		$this->urlGenerator = $urlGenerator;
+		$this->cardMapper = $cardMapper;
 	}
 
 	/**
@@ -518,11 +524,14 @@ class BoardService {
 		$acl->setPermissionManage($manage);
 		$newAcl = $this->aclMapper->insert($acl);
 
-		$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_BOARD, $newAcl, ActivityManager::SUBJECT_BOARD_SHARE);
+		$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_BOARD, $newAcl, ActivityManager::SUBJECT_BOARD_SHARE, [], $this->userId);
 		$this->notificationHelper->sendBoardShared((int)$boardId, $acl);
 		$this->boardMapper->mapAcl($newAcl);
 		$this->changeHelper->boardChanged($boardId);
 
+		$board = $this->boardMapper->find($boardId);
+		$this->clearBoardFromCache($board);
+
 		// TODO: use the dispatched event for this
 		try {
 			$resourceProvider = \OC::$server->query(\OCA\Deck\Collaboration\Resources\ResourceProvider::class);
@@ -673,6 +682,43 @@ class BoardService {
 		return $newBoard;
 	}
 
+	public function transferBoardOwnership(int $boardId, string $newOwner, bool $changeContent = false): Board {
+		\OC::$server->getDatabaseConnection()->beginTransaction();
+		try {
+			$board = $this->boardMapper->find($boardId);
+			$previousOwner = $board->getOwner();
+			$this->clearBoardFromCache($board);
+			$this->aclMapper->deleteParticipantFromBoard($boardId, Acl::PERMISSION_TYPE_USER, $newOwner);
+			if (!$changeContent) {
+				try {
+					$this->addAcl($boardId, Acl::PERMISSION_TYPE_USER, $previousOwner, true, true, true);
+				} catch (UniqueConstraintViolationException $e) {
+				}
+			}
+			$this->boardMapper->transferOwnership($previousOwner, $newOwner, $boardId);
+
+			// Optionally also change user assignments and card owner information
+			if ($changeContent) {
+				$this->assignedUsersMapper->remapAssignedUser($boardId, $previousOwner, $newOwner);
+				$this->cardMapper->remapCardOwner($boardId, $previousOwner, $newOwner);
+			}
+			\OC::$server->getDatabaseConnection()->commit();
+			return $this->boardMapper->find($boardId);
+		} catch (\Throwable $e) {
+			\OC::$server->getDatabaseConnection()->rollBack();
+			throw $e;
+		}
+	}
+
+	public function transferOwnership(string $owner, string $newOwner, bool $changeContent = false): \Generator {
+		$boards = $this->boardMapper->findAllByUser($owner);
+		foreach ($boards as $board) {
+			if ($board->getOwner() === $owner) {
+				yield $this->transferBoardOwnership($board->getId(), $newOwner, $changeContent);
+			}
+		}
+	}
+
 	private function enrichWithStacks($board, $since = -1) {
 		$stacks = $this->stackMapper->findAll($board->getId(), null, null, $since);
 
@@ -704,4 +750,19 @@ class BoardService {
 	public function getBoardUrl($endpoint) {
 		return $this->urlGenerator->linkToRouteAbsolute('deck.page.index') . '#' . $endpoint;
 	}
+
+	private function clearBoardsCache() {
+		$this->boardsCache = null;
+	}
+
+	/**
+	 * Clean a given board data from the Cache
+	 */
+	private function clearBoardFromCache(Board $board) {
+		$boardId = $board->getId();
+		$boardOwnerId = $board->getOwner();
+
+		$this->boardMapper->flushCache($boardId, $boardOwnerId);
+		unset($this->boardsCache[$boardId]);
+	}
 }

lib/Service/PermissionService.php

@@ -243,6 +243,7 @@ class PermissionService {
 		if (array_key_exists((string) $boardId, $this->users) && !$refresh) {
 			return $this->users[(string) $boardId];
 		}
+
 		try {
 			$board = $this->boardMapper->find($boardId);
 		} catch (DoesNotExistException $e) {
@@ -334,4 +335,13 @@ class PermissionService {
 		}
 		return $groups;
 	}
+
+	/**
+	 * Set a different user than the current one, e.g. when no user is available in occ
+	 *
+	 * @param string $userId
+	 */
+	public function setUserId(string $userId): void {
+		$this->userId = $userId;
+	}
 }