adding events

Signed-off-by: Maxence Lange <maxence@artificial-owl.com>

lib/Service/BoardService.php

@@ -3,6 +3,7 @@
  * @copyright Copyright (c) 2016 Julius Härtl <jus@bitgrid.net>
  *
  * @author Julius Härtl <jus@bitgrid.net>
+ * @author Maxence Lange <maxence@artificial-owl.com>
  *
  * @license GNU AGPL version 3 or any later version
  *
@@ -43,6 +44,8 @@ use OCA\Deck\Db\BoardMapper;
 use OCA\Deck\Db\LabelMapper;
 use OCP\IUserManager;
 use OCA\Deck\BadRequestException;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+use Symfony\Component\EventDispatcher\GenericEvent;
 
 
 class BoardService {
@@ -59,6 +62,8 @@ class BoardService {
 	private $groupManager;
 	private $userId;
 	private $activityManager;
+	/** @var EventDispatcherInterface */
+	private $eventDispatcher;
 	private $changeHelper;
 
 	public function __construct(
@@ -73,6 +78,7 @@ class BoardService {
 		IUserManager $userManager,
 		IGroupManager $groupManager,
 		ActivityManager $activityManager,
+		EventDispatcherInterface $eventDispatcher,
 		ChangeHelper $changeHelper,
 		$userId
 	) {
@@ -87,6 +93,7 @@ class BoardService {
 		$this->userManager = $userManager;
 		$this->groupManager = $groupManager;
 		$this->activityManager = $activityManager;
+		$this->eventDispatcher = $eventDispatcher;
 		$this->changeHelper = $changeHelper;
 		$this->userId = $userId;
 	}
@@ -297,8 +304,15 @@ class BoardService {
 		]);
 		$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_BOARD, $new_board, ActivityManager::SUBJECT_BOARD_CREATE);
 		$this->changeHelper->boardChanged($new_board->getId());
-		return $new_board;
 
+		$this->eventDispatcher->dispatch(
+			'\OCA\Deck\Board::onCreate',
+			new GenericEvent(
+				null, ['id' => $new_board->getId(), 'userId' => $userId, 'board' => $new_board]
+			)
+		);
+
+		return $new_board;
 	}
 
 	/**
@@ -324,6 +338,11 @@ class BoardService {
 		$board = $this->boardMapper->update($board);
 		$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_BOARD, $board, ActivityManager::SUBJECT_BOARD_DELETE);
 		$this->changeHelper->boardChanged($board->getId());
+
+		$this->eventDispatcher->dispatch(
+			'\OCA\Deck\Board::onDelete', new GenericEvent(null, ['id' => $id])
+		);
+
 		return $board;
 	}
 
@@ -346,6 +365,11 @@ class BoardService {
 		$board = $this->boardMapper->update($board);
 		$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_BOARD, $board, ActivityManager::SUBJECT_BOARD_RESTORE);
 		$this->changeHelper->boardChanged($board->getId());
+
+		$this->eventDispatcher->dispatch(
+			'\OCA\Deck\Board::onUpdate', new GenericEvent(null, ['id' => $id, 'board' => $board])
+		);
+
 		return $board;
 	}
 
@@ -364,7 +388,13 @@ class BoardService {
 
 		$this->permissionService->checkPermission($this->boardMapper, $id, Acl::PERMISSION_READ);
 		$board = $this->find($id);
-		return $this->boardMapper->delete($board);
+		$delete = $this->boardMapper->delete($board);
+
+		$this->eventDispatcher->dispatch(
+			'\OCA\Deck\Board::onDelete', new GenericEvent(null, ['id' => $id])
+		);
+
+		return $delete;
 	}
 
 	/**
@@ -407,6 +437,11 @@ class BoardService {
 		$this->boardMapper->mapOwner($board);
 		$this->activityManager->triggerUpdateEvents(ActivityManager::DECK_OBJECT_BOARD, $changes, ActivityManager::SUBJECT_BOARD_UPDATE);
 		$this->changeHelper->boardChanged($board->getId());
+
+		$this->eventDispatcher->dispatch(
+			'\OCA\Deck\Board::onUpdate', new GenericEvent(null, ['id' => $id, 'board' => $board])
+		);
+
 		return $board;
 	}
 
@@ -464,6 +499,8 @@ class BoardService {
 		$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_BOARD, $newAcl, ActivityManager::SUBJECT_BOARD_SHARE);
 		$this->boardMapper->mapAcl($newAcl);
 		$this->changeHelper->boardChanged($boardId);
+
+		// TODO: use the dispatched event for this
 		$version = \OC_Util::getVersion()[0];
 		if ($version >= 16) {
 			try {
@@ -471,6 +508,11 @@ class BoardService {
 				$resourceProvider->invalidateAccessCache($boardId);
 			} catch (\Exception $e) {}
 		}
+
+		$this->eventDispatcher->dispatch(
+			'\OCA\Deck\Board::onShareNew', new GenericEvent(null, ['id' => $newAcl->getId(), 'acl' => $newAcl, 'boardId' => $boardId])
+		);
+
 		return $newAcl;
 	}
 
@@ -512,6 +554,11 @@ class BoardService {
 		$this->boardMapper->mapAcl($acl);
 		$board = $this->aclMapper->update($acl);
 		$this->changeHelper->boardChanged($acl->getBoardId());
+
+		$this->eventDispatcher->dispatch(
+			'\OCA\Deck\Board::onShareEdit', new GenericEvent(null, ['id' => $id, 'boardId' => $acl->getBoardId(), 'acl' => $acl])
+		);
+
 		return $board;
 	}
 
@@ -541,6 +588,7 @@ class BoardService {
 		}
 		$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_BOARD, $acl, ActivityManager::SUBJECT_BOARD_UNSHARE);
 		$this->changeHelper->boardChanged($acl->getBoardId());
+
 		$version = \OC_Util::getVersion()[0];
 		if ($version >= 16) {
 			try {
@@ -548,7 +596,13 @@ class BoardService {
 				$resourceProvider->invalidateAccessCache($acl->getBoardId());
 			} catch (\Exception $e) {}
 		}
-		return $this->aclMapper->delete($acl);
+		$delete = $this->aclMapper->delete($acl);
+
+		$this->eventDispatcher->dispatch(
+			'\OCA\Deck\Board::onShareDelete', new GenericEvent(null, ['id' => $id, 'boardId' => $acl->getBoardId(), 'acl' => $acl])
+		);
+
+		return $delete;
 	}
 
 	private function enrichWithStacks($board, $since = -1) {

lib/Service/CardService.php

@@ -3,6 +3,7 @@
  * @copyright Copyright (c) 2016 Julius Härtl <jus@bitgrid.net>
  *
  * @author Julius Härtl <jus@bitgrid.net>
+ * @author Maxence Lange <maxence@artificial-owl.com>
  *
  * @license GNU AGPL version 3 or any later version
  *
@@ -40,6 +41,8 @@ use OCA\Deck\StatusException;
 use OCA\Deck\BadRequestException;
 use OCP\Comments\ICommentsManager;
 use OCP\IUserManager;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+use Symfony\Component\EventDispatcher\GenericEvent;
 
 class CardService {
 
@@ -56,6 +59,8 @@ class CardService {
 	private $activityManager;
 	private $commentsManager;
 	private $changeHelper;
+	/** @var EventDispatcherInterface */
+	private $eventDispatcher;
 	private $userManager;
 
 	public function __construct(
@@ -72,6 +77,7 @@ class CardService {
 		ICommentsManager $commentsManager,
 		IUserManager $userManager,
 		ChangeHelper $changeHelper,
+		EventDispatcherInterface $eventDispatcher,
 		$userId
 	) {
 		$this->cardMapper = $cardMapper;
@@ -87,6 +93,7 @@ class CardService {
 		$this->commentsManager = $commentsManager;
 		$this->userManager = $userManager;
 		$this->changeHelper = $changeHelper;
+		$this->eventDispatcher = $eventDispatcher;
 		$this->currentUser = $userId;
 	}
 
@@ -182,6 +189,14 @@ class CardService {
 		$card = $this->cardMapper->insert($card);
 		$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_CARD, $card, ActivityManager::SUBJECT_CARD_CREATE);
 		$this->changeHelper->cardChanged($card->getId(), false);
+
+		$this->eventDispatcher->dispatch(
+			'\OCA\Deck\Card::onCreate',
+			new GenericEvent(
+				null, ['id' => $card->getId(), 'card' => $card, 'userId' => $owner, 'stackId' => $stackId]
+			)
+		);
+
 		return $card;
 	}
 
@@ -209,6 +224,11 @@ class CardService {
 		$this->cardMapper->update($card);
 		$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_CARD, $card, ActivityManager::SUBJECT_CARD_DELETE);
 		$this->changeHelper->cardChanged($card->getId(), false);
+
+		$this->eventDispatcher->dispatch(
+			'\OCA\Deck\Card::onDelete', new GenericEvent(null, ['id' => $id, 'card' => $card])
+		);
+
 		return $card;
 	}
 
@@ -294,6 +314,11 @@ class CardService {
 
 		$card = $this->cardMapper->update($card);
 		$this->changeHelper->cardChanged($card->getId(), true);
+
+		$this->eventDispatcher->dispatch(
+			'\OCA\Deck\Card::onUpdate', new GenericEvent(null, ['id' => $id, 'card' => $card])
+		);
+
 		return $card;
 	}
 
@@ -327,7 +352,13 @@ class CardService {
 		}
 		$card->setTitle($title);
 		$this->changeHelper->cardChanged($card->getId(), false);
-		return $this->cardMapper->update($card);
+		$update = $this->cardMapper->update($card);
+
+		$this->eventDispatcher->dispatch(
+			'\OCA\Deck\Card::onUpdate', new GenericEvent(null, ['id' => $id, 'card' => $card])
+		);
+
+		return $update;
 	}
 
 	/**
@@ -410,6 +441,11 @@ class CardService {
 		$this->notificationHelper->markDuedateAsRead($card);
 		$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_CARD, $newCard, ActivityManager::SUBJECT_CARD_UPDATE_ARCHIVE);
 		$this->changeHelper->cardChanged($id, false);
+
+		$this->eventDispatcher->dispatch(
+			'\OCA\Deck\Card::onUpdate', new GenericEvent(null, ['id' => $id, 'card' => $card])
+		);
+
 		return $newCard;
 	}
 
@@ -437,6 +473,11 @@ class CardService {
 		$newCard = $this->cardMapper->update($card);
 		$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_CARD, $newCard, ActivityManager::SUBJECT_CARD_UPDATE_UNARCHIVE);
 		$this->changeHelper->cardChanged($id, false);
+
+		$this->eventDispatcher->dispatch(
+			'\OCA\Deck\Card::onUpdate', new GenericEvent(null, ['id' => $id, 'card' => $card])
+		);
+
 		return $newCard;
 	}
 
@@ -471,6 +512,10 @@ class CardService {
 		$this->cardMapper->assignLabel($cardId, $labelId);
 		$this->changeHelper->cardChanged($cardId, false);
 		$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_CARD, $card, ActivityManager::SUBJECT_LABEL_ASSIGN, ['label' => $label]);
+
+		$this->eventDispatcher->dispatch(
+			'\OCA\Deck\Card::onUpdate', new GenericEvent(null, ['id' => $cardId, 'card' => $card])
+		);
 	}
 
 	/**
@@ -504,6 +549,10 @@ class CardService {
 		$this->cardMapper->removeLabel($cardId, $labelId);
 		$this->changeHelper->cardChanged($cardId, false);
 		$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_CARD, $card, ActivityManager::SUBJECT_LABEL_UNASSING, ['label' => $label]);
+
+		$this->eventDispatcher->dispatch(
+			'\OCA\Deck\Card::onUpdate', new GenericEvent(null, ['id' => $cardId, 'card' => $card])
+		);
 	}
 
 	/**
@@ -545,6 +594,11 @@ class CardService {
 		$assignment = $this->assignedUsersMapper->insert($assignment);
 		$this->changeHelper->cardChanged($cardId, false);
 		$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_CARD, $card, ActivityManager::SUBJECT_CARD_USER_ASSIGN, ['assigneduser' => $userId]);
+
+		$this->eventDispatcher->dispatch(
+			'\OCA\Deck\Card::onUpdate', new GenericEvent(null, ['id' => $cardId, 'card' => $card])
+		);
+
 		return $assignment;
 	}
 
@@ -576,6 +630,11 @@ class CardService {
 				$card = $this->cardMapper->find($cardId);
 				$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_CARD, $card, ActivityManager::SUBJECT_CARD_USER_UNASSIGN, ['assigneduser' => $userId]);
 				$this->changeHelper->cardChanged($cardId, false);
+
+				$this->eventDispatcher->dispatch(
+					'\OCA\Deck\Card::onUpdate', new GenericEvent(null, ['id' => $cardId, 'card' => $card])
+				);
+
 				return $assignment;
 			}
 		}

lib/Service/StackService.php

@@ -3,6 +3,7 @@
  * @copyright Copyright (c) 2016 Julius Härtl <jus@bitgrid.net>
  *
  * @author Julius Härtl <jus@bitgrid.net>
+ * @author Maxence Lange <maxence@artificial-owl.com>
  *
  * @license GNU AGPL version 3 or any later version
  *
@@ -25,17 +26,18 @@ namespace OCA\Deck\Service;
 
 use OCA\Deck\Activity\ActivityManager;
 use OCA\Deck\Activity\ChangeSet;
+use OCA\Deck\BadRequestException;
 use OCA\Deck\Db\Acl;
-use OCA\Deck\Db\CardMapper;
+use OCA\Deck\Db\AssignedUsersMapper;
 use OCA\Deck\Db\BoardMapper;
+use OCA\Deck\Db\CardMapper;
 use OCA\Deck\Db\ChangeHelper;
 use OCA\Deck\Db\LabelMapper;
-use OCA\Deck\Db\AssignedUsersMapper;
 use OCA\Deck\Db\Stack;
 use OCA\Deck\Db\StackMapper;
 use OCA\Deck\StatusException;
-use OCA\Deck\BadRequestException;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
-use OCP\Comments\ICommentsManager;
+use Symfony\Component\EventDispatcher\GenericEvent;
 
 
 class StackService {
@@ -50,6 +52,8 @@ class StackService {
 	private $assignedUsersMapper;
 	private $attachmentService;
 	private $activityManager;
+	/** @var EventDispatcherInterface */
+	private $eventDispatcher;
 	private $changeHelper;
 
 	public function __construct(
@@ -63,6 +67,7 @@ class StackService {
 		AssignedUsersMapper $assignedUsersMapper,
 		AttachmentService $attachmentService,
 		ActivityManager $activityManager,
+		EventDispatcherInterface $eventDispatcher,
 		ChangeHelper $changeHelper
 	) {
 		$this->stackMapper = $stackMapper;
@@ -75,13 +80,14 @@ class StackService {
 		$this->assignedUsersMapper = $assignedUsersMapper;
 		$this->attachmentService = $attachmentService;
 		$this->activityManager = $activityManager;
+		$this->eventDispatcher = $eventDispatcher;
 		$this->changeHelper = $changeHelper;
 	}
 
 	private function enrichStackWithCards($stack, $since = -1) {
 		$cards = $this->cardMapper->findAll($stack->getId(), null, null, $since);
 
-		if(\count($cards) === 0) {
+		if (\count($cards) === 0) {
 			return;
 		}
 
@@ -100,6 +106,7 @@ class StackService {
 
 	/**
 	 * @param $stackId
+	 *
 	 * @return \OCP\AppFramework\Db\Entity
 	 * @throws \OCP\AppFramework\Db\DoesNotExistException
 	 * @throws \OCP\AppFramework\Db\MultipleObjectsReturnedException
@@ -118,11 +125,13 @@ class StackService {
 			$card->setAttachmentCount($this->attachmentService->count($card->getId()));
 		}
 		$stack->setCards($cards);
+
 		return $stack;
 	}
 
 	/**
 	 * @param $boardId
+	 *
 	 * @return array
 	 * @throws \OCA\Deck\NoPermissionException
 	 * @throws BadRequestException
@@ -135,18 +144,23 @@ class StackService {
 		$this->permissionService->checkPermission(null, $boardId, Acl::PERMISSION_READ);
 		$stacks = $this->stackMapper->findAll($boardId);
 		$this->enrichStacksWithCards($stacks, $since);
+
 		return $stacks;
 	}
 
 	public function fetchDeleted($boardId) {
-		$this->permissionService->checkPermission($this->boardMapper, $boardId, Acl::PERMISSION_READ);
+		$this->permissionService->checkPermission(
+			$this->boardMapper, $boardId, Acl::PERMISSION_READ
+		);
 		$stacks = $this->stackMapper->findDeleted($boardId);
 		$this->enrichStacksWithCards($stacks);
+
 		return $stacks;
 	}
 
 	/**
 	 * @param $boardId
+	 *
 	 * @return array
 	 * @throws \OCA\Deck\NoPermissionException
 	 * @throws BadRequestException
@@ -169,6 +183,7 @@ class StackService {
 			}
 			$stacks[$stackIndex]->setCards($cards);
 		}
+
 		return $stacks;
 	}
 
@@ -176,6 +191,7 @@ class StackService {
 	 * @param $title
 	 * @param $boardId
 	 * @param integer $order
+	 *
 	 * @return \OCP\AppFramework\Db\Entity
 	 * @throws StatusException
 	 * @throws \OCA\Deck\NoPermissionException
@@ -206,13 +222,22 @@ class StackService {
 		$stack->setBoardId($boardId);
 		$stack->setOrder($order);
 		$stack = $this->stackMapper->insert($stack);
-		$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_BOARD, $stack, ActivityManager::SUBJECT_STACK_CREATE);
+		$this->activityManager->triggerEvent(
+			ActivityManager::DECK_OBJECT_BOARD, $stack, ActivityManager::SUBJECT_STACK_CREATE
+		);
 		$this->changeHelper->boardChanged($boardId);
+
+		$this->eventDispatcher->dispatch(
+			'\OCA\Deck\Stack::onCreate',
+			new GenericEvent(null, ['id' => $stack->getId(), 'stack' => $stack])
+		);
+
 		return $stack;
 	}
 
 	/**
 	 * @param $id
+	 *
 	 * @return \OCP\AppFramework\Db\Entity
 	 * @throws \OCA\Deck\NoPermissionException
 	 * @throws \OCP\AppFramework\Db\DoesNotExistException
@@ -221,7 +246,7 @@ class StackService {
 	 */
 	public function delete($id) {
 
-		if ( is_numeric($id) === false ) {
+		if (is_numeric($id) === false) {
 			throw new BadRequestException('stack id must be a number');
 		}
 
@@ -231,9 +256,16 @@ class StackService {
 		$stack->setDeletedAt(time());
 		$stack = $this->stackMapper->update($stack);
 
-		$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_BOARD, $stack, ActivityManager::SUBJECT_STACK_DELETE);
+		$this->activityManager->triggerEvent(
+			ActivityManager::DECK_OBJECT_BOARD, $stack, ActivityManager::SUBJECT_STACK_DELETE
+		);
 		$this->changeHelper->boardChanged($stack->getBoardId());
 		$this->enrichStackWithCards($stack);
+
+		$this->eventDispatcher->dispatch(
+			'\OCA\Deck\Stack::onDelete', new GenericEvent(null, ['id' => $id, 'stack' => $stack])
+		);
+
 		return $stack;
 	}
 
@@ -243,6 +275,7 @@ class StackService {
 	 * @param $boardId
 	 * @param $order
 	 * @param $deletedAt
+	 *
 	 * @return \OCP\AppFramework\Db\Entity
 	 * @throws StatusException
 	 * @throws \OCA\Deck\NoPermissionException
@@ -280,14 +313,22 @@ class StackService {
 		$stack->setDeletedAt($deletedAt);
 		$changes->setAfter($stack);
 		$stack = $this->stackMapper->update($stack);
-		$this->activityManager->triggerUpdateEvents(ActivityManager::DECK_OBJECT_BOARD, $changes, ActivityManager::SUBJECT_STACK_UPDATE);
+		$this->activityManager->triggerUpdateEvents(
+			ActivityManager::DECK_OBJECT_BOARD, $changes, ActivityManager::SUBJECT_STACK_UPDATE
+		);
 		$this->changeHelper->boardChanged($stack->getBoardId());
+
+		$this->eventDispatcher->dispatch(
+			'\OCA\Deck\Stack::onUpdate', new GenericEvent(null, ['id' => $id, 'stack' => $stack])
+		);
+
 		return $stack;
 	}
 
 	/**
 	 * @param $id
 	 * @param $order
+	 *
 	 * @return array
 	 * @throws \OCA\Deck\NoPermissionException
 	 * @throws \OCP\AppFramework\Db\DoesNotExistException
@@ -325,6 +366,7 @@ class StackService {
 			$result[$stack->getOrder()] = $stack;
 		}
 		$this->changeHelper->boardChanged($stackToSort->getBoardId());
+
 		return $result;
 	}
 }