Update DeckMapper to extend QBMapper instead of deprecated Mapper

Signed-off-by: Raul Ferreira Fuentes <raul@nextcloud.com>
2022-04-11 18:24:41 +02:00
parent dbc4d10ddf
commit ec602f3e15
4 changed files with 255 additions and 71 deletions
--- a/lib/Db/AclMapper.php
+++ b/lib/Db/AclMapper.php
@@ -29,22 +29,54 @@ use OCP\DB\QueryBuilder\IQueryBuilder;
 use OCP\IDBConnection;

 class AclMapper extends DeckMapper implements IPermissionMapper {
+
+	/**
+	 * @param IDBConnection $db
+	 */
 	public function __construct(IDBConnection $db) {
-		parent::__construct($db, 'deck_board_acl', Acl::class);
+		parent::__construct($db, 'deck_boards', Board::class);
 	}

+	/**
+	 * @param int $boardId
+	 * @param int|null $limit
+	 * @param int|null $offset
+	 * @return Acl[]
+	 * @throws \OCP\DB\Exception
+	 */
 	public function findAll($boardId, $limit = null, $offset = null) {
-		$sql = 'SELECT id, board_id, type, participant, permission_edit, permission_share, permission_manage FROM `*PREFIX*deck_board_acl` WHERE `board_id` = ? ';
-		return $this->findEntities($sql, [$boardId], $limit, $offset);
+		$qb = $this->db->getQueryBuilder();
+		$qb->select('*')
+			->from($this->getTableName())
+			->where($qb->expr()->eq('board_id', $qb->createNamedParameter($boardId, IQueryBuilder::PARAM_INT)))
+			->setMaxResults($limit)
+			->setFirstResult($offset);
+
+		return $this->findEntities($qb);
 	}

+	/**
+	 * @param int $userId
+	 * @param int $aclId
+	 * @return bool
+	 * @throws \OCP\DB\Exception
+	 */
 	public function isOwner($userId, $aclId): bool {
-		$sql = 'SELECT owner FROM `*PREFIX*deck_boards` WHERE `id` IN (SELECT board_id FROM `*PREFIX*deck_board_acl` WHERE id = ?)';
-		$stmt = $this->execute($sql, [$aclId]);
-		$row = $stmt->fetch();
-		return ($row['owner'] === $userId);
+		$qb = $this->db->getQueryBuilder();
+
+		$qb->select('owner')
+			->from($this->getTableName())
+			->innerJoin('acl', 'deck_boards','b', 'acl.board_id = b.id')
+			->where($qb->expr()->eq('owner.id', $qb->createNamedParameter($userId, IQueryBuilder::PARAM_INT)))
+			->andWhere($qb->expr()->eq('acl.id', $qb->createNamedParameter($aclId, IQueryBuilder::PARAM_INT)));
+
+		return $qb->executeQuery()->rowCount() > 0;
 	}

+	/**
+	 * @param int $id
+	 * @return int|null
+	 */
 	public function findBoardId($id): ?int {
 		try {
 			$entity = $this->find($id);
@@ -54,9 +86,21 @@ class AclMapper extends DeckMapper implements IPermissionMapper {
 		return null;
 	}

+	/**
+	 * @param int $type
+	 * @param string $participant
+	 * @return Acl[]
+	 * @throws \OCP\DB\Exception
+	 */
 	public function findByParticipant($type, $participant): array {
-		$sql = 'SELECT * from *PREFIX*deck_board_acl WHERE type = ? AND participant = ?';
-		return $this->findEntities($sql, [$type, $participant]);
+		$qb = $this->db->getQueryBuilder();
+
+		$qb->select('*')
+			->from($this->getTableName())
+			->where($qb->expr()->eq('type', $qb->createNamedParameter($type, IQueryBuilder::PARAM_INT)))
+			->andWhere($qb->expr()->eq('participant', $qb->createNamedParameter($participant, IQueryBuilder::PARAM_STR)));
+
+		return $this->findEntities($qb);
 	}

 	/**
--- a/lib/Db/DeckMapper.php
+++ b/lib/Db/DeckMapper.php
@@ -23,17 +23,15 @@

 namespace OCA\Deck\Db;

-use OCP\AppFramework\Db\Mapper;
+use OCP\AppFramework\Db\QBMapper;
+use OCP\DB\QueryBuilder\IQueryBuilder;

 /**
 * Class DeckMapper
 *
 * @package OCA\Deck\Db
- * @deprecated use QBMapper
- *
- * TODO: Move to QBMapper once Nextcloud 14 is a minimum requirement
 */
-class DeckMapper extends Mapper {
+class DeckMapper extends QBMapper {

 	/**
 	 * @param $id
@@ -42,11 +40,11 @@ class DeckMapper extends Mapper {
 	 * @throws \OCP\AppFramework\Db\DoesNotExistException
 	 */
 	public function find($id) {
-		$sql = 'SELECT * FROM `' . $this->tableName . '` ' . 'WHERE `id` = ?';
-		return $this->findEntity($sql, [$id]);
-	}
+		$qb = $this->db->getQueryBuilder();
+		$qb->select('*')
+			->from($this->getTableName())
+			->where($qb->expr()->eq('id', $qb->createNamedParameter($id, IQueryBuilder::PARAM_INT)));

-	protected function execute($sql, array $params = [], $limit = null, $offset = null) {
-		return parent::execute($sql, $params, $limit, $offset);
+		return $this->findEntity($qb);
 	}
 }
--- a/lib/Db/LabelMapper.php
+++ b/lib/Db/LabelMapper.php
@@ -26,48 +26,115 @@ namespace OCA\Deck\Db;
 use OCP\AppFramework\Db\DoesNotExistException;
 use OCP\AppFramework\Db\Entity;
 use OCP\AppFramework\Db\MultipleObjectsReturnedException;
+use OCP\DB\QueryBuilder\IQueryBuilder;
 use OCP\IDBConnection;

 class LabelMapper extends DeckMapper implements IPermissionMapper {
+	/**
+	 * @param IDBConnection $db
+	 */
 	public function __construct(IDBConnection $db) {
 		parent::__construct($db, 'deck_labels', Label::class);
 	}

-	public function findAll($boardId, $limit = null, $offset = null) {
-		$sql = 'SELECT * FROM `*PREFIX*deck_labels` WHERE `board_id` = ? ORDER BY `id`';
-		return $this->findEntities($sql, [$boardId], $limit, $offset);
+	/**
+	 * @param int $boardId
+	 * @param int|null $limit
+	 * @param int|null $offset
+	 * @return Label[]
+	 * @throws \OCP\DB\Exception
+	 */
+	public function findAll($boardId, $limit = null, $offset = null): array {
+		$qb = $this->db->getQueryBuilder();
+		$qb->select('*')
+			->from($this->getTableName())
+			->where($qb->expr()->eq('board_id', $qb->createNamedParameter($boardId, IQueryBuilder::PARAM_INT)))
+			->setMaxResults($limit)
+			->setFirstResult($offset);
+		return $this->findEntities($qb);
 	}

-	public function delete(\OCP\AppFramework\Db\Entity $entity) {
+	/**
+	 * @param Entity $entity
+	 * @return Entity
+	 * @throws \OCP\DB\Exception
+	 */
+	public function delete(Entity $entity): Entity {
 		// delete assigned labels
 		$this->deleteLabelAssignments($entity->getId());
 		// delete label
 		return parent::delete($entity);
 	}

-	public function findAssignedLabelsForCard($cardId, $limit = null, $offset = null) {
-		$sql = 'SELECT l.*,card_id FROM `*PREFIX*deck_assigned_labels` as al INNER JOIN *PREFIX*deck_labels as l ON l.id = al.label_id WHERE `card_id` = ? ORDER BY l.id';
-		return $this->findEntities($sql, [$cardId], $limit, $offset);
-	}
-	public function findAssignedLabelsForBoard($boardId, $limit = null, $offset = null) {
-		$sql = 'SELECT c.id as card_id, l.id as id, l.title as title, l.color as color FROM `*PREFIX*deck_cards` as c ' .
-			' INNER JOIN `*PREFIX*deck_assigned_labels` as al ON al.card_id = c.id INNER JOIN `*PREFIX*deck_labels` as l ON  al.label_id = l.id WHERE board_id=? ORDER BY l.id';
-		return $this->findEntities($sql, [$boardId], $limit, $offset);
+	/**
+	 * @param int $cardId
+	 * @param int|null $limit
+	 * @param int|null $offset
+	 * @return Label[]
+	 * @throws \OCP\DB\Exception
+	 */
+	public function findAssignedLabelsForCard($cardId, $limit = null, $offset = null): array {
+		$qb = $this->db->getQueryBuilder();
+		$qb->select('l.*,card_id')
+			->from($this->getTableName(), 'l')
+			->innerJoin('l', 'deck_assigned_labels', 'al', 'l.id = al.label_id')
+			->where($qb->expr()->eq('card_id', $qb->createNamedParameter($cardId, IQueryBuilder::PARAM_INT)))
+			->orderBy('l.id')
+			->setMaxResults($limit)
+			->setFirstResult($offset);
+
+		return $this->findEntities($qb);
 	}

-	public function insert(Entity $entity) {
+	/**
+	 * @param int $boardId
+	 * @param int|null $limit
+	 * @param int|null $offset
+	 * @return Label[]
+	 * @throws \OCP\DB\Exception
+	 */
+	public function findAssignedLabelsForBoard($boardId, $limit = null, $offset = null): array {
+		$qb = $this->db->getQueryBuilder();
+		$qb->select('c.id as card_id', 'l.id as id', 'l.title as title', 'l.color as color')
+			->from($this->getTableName(), 'l')
+			->innerJoin('l', 'deck_assigned_labels', 'al', 'al.label_id = l.id')
+			->innerJoin('l', 'deck_cards', 'c', 'al.card_id = c.id')
+			->where($qb->expr()->eq('board_id', $qb->createNamedParameter($boardId, IQueryBuilder::PARAM_INT)))
+			->orderBy('l.id')
+			->setMaxResults($limit)
+			->setFirstResult($offset);
+
+		return $this->findEntities($qb);
+	}
+
+	/**
+	 * @param Entity $entity
+	 * @return Entity
+	 * @throws \OCP\DB\Exception
+	 */
+	public function insert(Entity $entity): Entity {
 		$entity->setLastModified(time());
 		return parent::insert($entity);
 	}

-	public function update(Entity $entity, $updateModified = true) {
+	/**
+	 * @param Entity $entity
+	 * @param bool $updateModified
+	 * @return Entity
+	 * @throws \OCP\DB\Exception
+	 */
+	public function update(Entity $entity, $updateModified = true): Entity {
 		if ($updateModified) {
 			$entity->setLastModified(time());
 		}
 		return parent::update($entity);
 	}

-
+	/**
+	 * @param int $boardId
+	 * @return array
+	 * @throws \OCP\DB\Exception
+	 */
 	public function getAssignedLabelsForBoard($boardId) {
 		$labels = $this->findAssignedLabelsForBoard($boardId);
 		$result = [];
@@ -80,27 +147,51 @@ class LabelMapper extends DeckMapper implements IPermissionMapper {
 		return $result;
 	}

+	/**
+	 * @param int $labelId
+	 * @return void
+	 * @throws \OCP\DB\Exception
+	 */
 	public function deleteLabelAssignments($labelId) {
-		$sql = 'DELETE FROM `*PREFIX*deck_assigned_labels` WHERE label_id = ?';
-		$stmt = $this->db->prepare($sql);
-		$stmt->bindParam(1, $labelId, \PDO::PARAM_INT);
-		$stmt->execute();
+		$qb = $this->db->getQueryBuilder();
+		$qb->delete('deck_assigned_labels')
+			->where($qb->expr()->eq('label_id', $qb->createNamedParameter($labelId, IQueryBuilder::PARAM_INT)));
+		$qb->executeStatement();
 	}

+	/**
+	 * @param int $cardId
+	 * @return void
+	 * @throws \OCP\DB\Exception
+	 */
 	public function deleteLabelAssignmentsForCard($cardId) {
-		$sql = 'DELETE FROM `*PREFIX*deck_assigned_labels` WHERE card_id = ?';
-		$stmt = $this->db->prepare($sql);
-		$stmt->bindParam(1, $cardId, \PDO::PARAM_INT);
-		$stmt->execute();
+		$qb = $this->db->getQueryBuilder();
+		$qb->delete('deck_assigned_labels')
+			->where($qb->expr()->eq('card_id', $qb->createNamedParameter($cardId, IQueryBuilder::PARAM_INT)));
+		$qb->executeStatement();
 	}

+	/**
+	 * @param string $userId
+	 * @param int $labelId
+	 * @return bool
+	 * @throws \OCP\DB\Exception
+	 */
 	public function isOwner($userId, $labelId): bool {
-		$sql = 'SELECT owner FROM `*PREFIX*deck_boards` WHERE `id` IN (SELECT board_id FROM `*PREFIX*deck_labels` WHERE id = ?)';
-		$stmt = $this->execute($sql, [$labelId]);
-		$row = $stmt->fetch();
-		return ($row['owner'] === $userId);
+		$qb = $this->db->getQueryBuilder();
+		$qb->select('*')
+			->from($this->getTableName(), 'l')
+			->innerJoin('l', 'deck_boards' , 'b', 'l.board_id = b.id')
+			->where($qb->expr()->eq('l.id', $qb->createNamedParameter($labelId, IQueryBuilder::PARAM_INT)))
+			->andWhere($qb->expr()->eq('b.owner', $qb->createNamedParameter($userId, IQueryBuilder::PARAM_STR)));
+
+		return $qb->executeQuery()->rowCount() > 0;
 	}

+	/**
+	 * @param int $id
+	 * @return int|null
+	 */
 	public function findBoardId($id): ?int {
 		try {
 			$entity = $this->find($id);
--- a/lib/Db/StackMapper.php
+++ b/lib/Db/StackMapper.php
@@ -26,6 +26,7 @@ namespace OCA\Deck\Db;
 use OCP\AppFramework\Db\DoesNotExistException;
 use OCP\AppFramework\Db\Entity;
 use OCP\AppFramework\Db\MultipleObjectsReturnedException;
+use OCP\DB\QueryBuilder\IQueryBuilder;
 use OCP\IDBConnection;

 class StackMapper extends DeckMapper implements IPermissionMapper {
@@ -38,62 +39,112 @@ class StackMapper extends DeckMapper implements IPermissionMapper {


 	/**
-	 * @param $id
-	 * @throws MultipleObjectsReturnedException
+	 * @param int $id
+	 * @return Stack
 	 * @throws DoesNotExistException
+	 * @throws MultipleObjectsReturnedException
+	 * @throws \OCP\DB\Exception
 	 */
 	public function find($id): Stack {
-		$sql = 'SELECT * FROM `*PREFIX*deck_stacks` ' .
-			'WHERE `id` = ?';
-		return $this->findEntity($sql, [$id]);
+		$qb = $this->db->getQueryBuilder();
+		$qb->select('*')
+			->from($this->getTableName())
+			->where($qb->expr()->eq('id', $qb->createNamedParameter($id, IQueryBuilder::PARAM_INT)));
+
+		return $this->findEntity($qb);
 	}

 	/**
 	 * @param $cardId
 	 * @return Stack|null
+	 * @throws \OCP\DB\Exception
 	 */
 	public function findStackFromCardId($cardId): ?Stack {
-		$sql = <<<SQL
-SELECT s.* 
-FROM `*PREFIX*deck_stacks` as `s`
-INNER JOIN `*PREFIX*deck_cards` as `c` ON s.id = c.stack_id
-WHERE c.id = ?
-SQL;
+		$qb = $this->db->getQueryBuilder();
+		$qb->select('*')
+			->from($this->getTableName(), 's')
+			->innerJoin('s', 'deck_cards', 'c', 's.id = c.stack_id')
+			->where($qb->expr()->eq('c.id', $qb->createNamedParameter($cardId, IQueryBuilder::PARAM_INT)));
+
 		try {
-			return $this->findEntity($sql, [$cardId]);
+			return $this->findEntity($qb);
 		} catch (MultipleObjectsReturnedException|DoesNotExistException $e) {
 		}

 		return null;
 	}

+	/**
+	 * @param int $boardId
+	 * @param int|null $limit
+	 * @param int|null $offset
+	 * @return Stack[]
+	 * @throws \OCP\DB\Exception
+	 */
+	public function findAll($boardId, $limit = null, $offset = null): array {
+		$qb = $this->db->getQueryBuilder();
+		$qb->select('*')
+			->from($this->getTableName())
+			->where($qb->expr()->eq('board_id', $qb->createNamedParameter($boardId, IQueryBuilder::PARAM_INT)))
+			->andWhere($qb->expr()->eq('deleted_at', $qb->createNamedParameter(0, IQueryBuilder::PARAM_INT)))
+			->setFirstResult($offset)
+			->setMaxResults($limit);

-	public function findAll($boardId, $limit = null, $offset = null) {
-		$sql = 'SELECT * FROM `*PREFIX*deck_stacks` WHERE `board_id` = ? AND deleted_at = 0 ORDER BY `order`, `id`';
-		return $this->findEntities($sql, [$boardId], $limit, $offset);
+		return $this->findEntities($qb);
 	}

-
+	/**
+	 * @param int $boardId
+	 * @param int|null $limit
+	 * @param int|null $offset
+	 * @return Stack[]
+	 * @throws \OCP\DB\Exception
+	 */
 	public function findDeleted($boardId, $limit = null, $offset = null) {
-		$sql = 'SELECT * FROM `*PREFIX*deck_stacks` s
-	  WHERE `s`.`board_id` = ? AND NOT s.deleted_at = 0';
-		return $this->findEntities($sql, [$boardId], $limit, $offset);
+		$qb = $this->db->getQueryBuilder();
+		$qb->select('*')
+			->from($this->getTableName())
+			->where($qb->expr()->eq('board_id', $qb->createNamedParameter($boardId, IQueryBuilder::PARAM_INT)))
+			->andWhere($qb->expr()->neq('deleted_at', $qb->createNamedParameter(0, IQueryBuilder::PARAM_INT)))
+			->setFirstResult($offset)
+			->setMaxResults($limit);
+
+		return $this->findEntities($qb);
 	}

-
-	public function delete(Entity $entity) {
+	/**
+	 * @param Entity $entity
+	 * @return Entity
+	 * @throws \OCP\DB\Exception
+	 */
+	public function delete(Entity $entity): Entity {
 		// delete cards on stack
 		$this->cardMapper->deleteByStack($entity->getId());
 		return parent::delete($entity);
 	}

+	/**
+	 * @param int $userId
+	 * @param int $stackId
+	 * @return bool
+	 * @throws \OCP\DB\Exception
+	 */
 	public function isOwner($userId, $stackId): bool {
-		$sql = 'SELECT owner FROM `*PREFIX*deck_boards` WHERE `id` IN (SELECT board_id FROM `*PREFIX*deck_stacks` WHERE id = ?)';
-		$stmt = $this->execute($sql, [$stackId]);
-		$row = $stmt->fetch();
-		return ($row['owner'] === $userId);
+		$qb = $this->db->getQueryBuilder();
+		$qb->select('*')
+			->from($this->getTableName(), 's')
+			->innerJoin('s', 'deck_boards', 'b', 'b.id = s.board_id')
+			->where($qb->expr()->eq('s.id', $qb->createNamedParameter($stackId, IQueryBuilder::PARAM_INT)))
+			->andWhere($qb->expr()->eq('owner', $qb->createNamedParameter($userId, IQueryBuilder::PARAM_STR)));
+
+		return $qb->executeQuery()->rowCount() > 0;
 	}

+	/**
+	 * @param $id
+	 * @return int|null
+	 * @throws \OCP\DB\Exception
+	 */
 	public function findBoardId($id): ?int {
 		try {
 			$entity = $this->find($id);