Merge pull request #4137 from TehThanos/master

lib/Activity/ActivityManager.php

@@ -91,6 +91,8 @@ class ActivityManager {
 	public const SUBJECT_CARD_UPDATE_DUEDATE = 'card_update_duedate';
 	public const SUBJECT_CARD_UPDATE_ARCHIVE = 'card_update_archive';
 	public const SUBJECT_CARD_UPDATE_UNARCHIVE = 'card_update_unarchive';
+	public const SUBJECT_CARD_UPDATE_DONE = 'card_update_done';
+	public const SUBJECT_CARD_UPDATE_UNDONE = 'card_update_undone';
 	public const SUBJECT_CARD_UPDATE_STACKID = 'card_update_stackId';
 	public const SUBJECT_CARD_USER_ASSIGN = 'card_user_assign';
 	public const SUBJECT_CARD_USER_UNASSIGN = 'card_user_unassign';
@@ -198,6 +200,12 @@ class ActivityManager {
 			case self::SUBJECT_CARD_UPDATE_UNARCHIVE:
 				$subject = $ownActivity ? $l->t('You have unarchived card {card} in list {stack} on board {board}') : $l->t('{user} has unarchived card {card} in list {stack} on board {board}');
 				break;
+			case self::SUBJECT_CARD_UPDATE_DONE:
+				$subject = $ownActivity ? $l->t('You have marked the card {card} as done in list {stack} on board {board}') : $l->t('{user} has marked card {card} as done in list {stack} on board {board}');
+				break;
+			case self::SUBJECT_CARD_UPDATE_UNDONE:
+				$subject = $ownActivity ? $l->t('You have marked the card {card} as undone in list {stack} on board {board}') : $l->t('{user} has marked the card {card} as undone in list {stack} on board {board}');
+				break;
 			case self::SUBJECT_CARD_UPDATE_DUEDATE:
 				if (!isset($subjectParams['after'])) {
 					$subject = $ownActivity ? $l->t('You have removed the due date of card {card}') : $l->t('{user} has removed the due date of card {card}');
@@ -357,6 +365,8 @@ class ActivityManager {
 			case self::SUBJECT_CARD_DELETE:
 			case self::SUBJECT_CARD_UPDATE_ARCHIVE:
 			case self::SUBJECT_CARD_UPDATE_UNARCHIVE:
+			case self::SUBJECT_CARD_UPDATE_DONE:
+			case self::SUBJECT_CARD_UPDATE_UNDONE:
 			case self::SUBJECT_CARD_UPDATE_TITLE:
 			case self::SUBJECT_CARD_UPDATE_DESCRIPTION:
 			case self::SUBJECT_CARD_UPDATE_DUEDATE:

lib/Controller/CardApiController.php

@@ -25,6 +25,7 @@
 
 namespace OCA\Deck\Controller;
 
+use OCA\Deck\Model\OptionalNullableValue;
 use OCA\Deck\Service\AssignmentService;
 use OCA\Deck\Service\CardService;
 use OCP\AppFramework\ApiController;
@@ -105,7 +106,8 @@ class CardApiController extends ApiController {
 	 * Update a card
 	 */
 	public function update($title, $type, $owner, $description = '', $order = 0, $duedate = null, $archived = null) {
-		$card = $this->cardService->update($this->request->getParam('cardId'), $title, $this->request->getParam('stackId'), $type, $owner, $description, $order, $duedate, 0, $archived);
+		$done = array_key_exists('done', $this->request->getParams()) ? new OptionalNullableValue($this->request->getParam('done', null)) : null;
+		$card = $this->cardService->update($this->request->getParam('cardId'), $title, $this->request->getParam('stackId'), $type, $owner, $description, $order, $duedate, 0, $archived, $done);
 		return new DataResponse($card, HTTP::STATUS_OK);
 	}
 

lib/Controller/CardController.php

@@ -143,6 +143,24 @@ class CardController extends Controller {
 		return $this->cardService->unarchive($cardId);
 	}
 
+	/**
+	 * @NoAdminRequired
+	 * @param $cardId
+	 * @return \OCP\AppFramework\Db\Entity
+	 */
+	public function done(int $cardId) {
+		return $this->cardService->done($cardId);
+	}
+
+	/**
+	 * @NoAdminRequired
+	 * @param $cardId
+	 * @return \OCP\AppFramework\Db\Entity
+	 */
+	public function undone(int $cardId) {
+		return $this->cardService->undone($cardId);
+	}
+
 	/**
 	 * @NoAdminRequired
 	 * @param $cardId

lib/Db/Card.php

@@ -1,4 +1,7 @@
 <?php
+
+declare(strict_types=1);
+
 /**
  * @copyright Copyright (c) 2016 Julius Härtl <jus@bitgrid.net>
  *
@@ -37,6 +40,8 @@ use Sabre\VObject\Component\VCalendar;
  * @method int getCreatedAt()
  * @method bool getArchived()
  * @method bool getNotified()
+ * @method ?DateTime getDone()
+ * @method void setDone(?DateTime $done)
  *
  * @method void setLabels(Label[] $labels)
  * @method null|Label[] getLabels()
@@ -83,6 +88,7 @@ class Card extends RelationalEntity {
 	protected $owner;
 	protected $order;
 	protected $archived = false;
+	protected $done = null;
 	protected $duedate;
 	protected $notified = false;
 	protected $deletedAt = 0;
@@ -106,6 +112,7 @@ class Card extends RelationalEntity {
 		$this->addType('lastModified', 'integer');
 		$this->addType('createdAt', 'integer');
 		$this->addType('archived', 'boolean');
+		$this->addType('done', 'datetime');
 		$this->addType('notified', 'boolean');
 		$this->addType('deletedAt', 'integer');
 		$this->addType('duedate', 'datetime');
@@ -139,19 +146,22 @@ class Card extends RelationalEntity {
 		$event->add('RELATED-TO', 'deck-stack-' . $this->getStackId());
 
 		// FIXME: For write support: CANCELLED / IN-PROCESS handling
-		$event->STATUS = $this->getArchived() ? "COMPLETED" : "NEEDS-ACTION";
-		if ($this->getArchived()) {
+		if ($this->getDone() || $this->getArchived()) {
 			$date = new DateTime();
 			$date->setTimestamp($this->getLastModified());
-			$event->COMPLETED = $date;
-			//$event->add('PERCENT-COMPLETE', 100);
-		}
-		if (count($this->getLabels()) > 0) {
-			$event->CATEGORIES = array_map(function ($label) {
-				return $label->getTitle();
-			}, $this->getLabels());
+			$event->STATUS = 'COMPLETED';
+			$event->COMPLETED = $this->getDone() ? $this->$this->getDone() : $this->getArchived();
+		} else {
+			$event->STATUS = 'NEEDS-ACTION';
 		}
 
+		// $event->add('PERCENT-COMPLETE', 100);
+
+		$labels = $this->getLabels() ?? [];
+		$event->CATEGORIES = array_map(function ($label): string {
+			return $label->getTitle();
+		}, $labels);
+
 		$event->SUMMARY = $this->getTitle();
 		$event->DESCRIPTION = $this->getDescription();
 		$calendar->add($event);
@@ -177,7 +187,7 @@ class Card extends RelationalEntity {
 		return 'card';
 	}
 
-	public function getETag() {
+	public function getETag(): string {
 		return md5((string)$this->getLastModified());
 	}
 }

lib/Db/CardMapper.php

@@ -263,6 +263,7 @@ class CardMapper extends QBMapper implements IPermissionMapper {
 			->where($qb->expr()->in('s.board_id', $qb->createNamedParameter($boardIds, IQueryBuilder::PARAM_INT_ARRAY)))
 			->andWhere($qb->expr()->isNotNull('c.duedate'))
 			->andWhere($qb->expr()->eq('c.archived', $qb->createNamedParameter(false, IQueryBuilder::PARAM_BOOL)))
+			->andWhere($qb->expr()->isNull('done'))
 			->andWhere($qb->expr()->eq('c.deleted_at', $qb->createNamedParameter(0, IQueryBuilder::PARAM_INT)))
 			->andWhere($qb->expr()->eq('s.deleted_at', $qb->createNamedParameter(0, IQueryBuilder::PARAM_INT)))
 			->andWhere($qb->expr()->eq('b.archived', $qb->createNamedParameter(false, IQueryBuilder::PARAM_BOOL)))
@@ -284,6 +285,7 @@ class CardMapper extends QBMapper implements IPermissionMapper {
 			)
 			// Filter out archived/deleted cards and board
 			->andWhere($qb->expr()->eq('c.archived', $qb->createNamedParameter(false, IQueryBuilder::PARAM_BOOL)))
+			->andWhere($qb->expr()->isNull('done'))
 			->andWhere($qb->expr()->eq('c.deleted_at', $qb->createNamedParameter(0, IQueryBuilder::PARAM_INT)))
 			->andWhere($qb->expr()->eq('s.deleted_at', $qb->createNamedParameter(0, IQueryBuilder::PARAM_INT)))
 			->andWhere($qb->expr()->eq('b.archived', $qb->createNamedParameter(false, IQueryBuilder::PARAM_BOOL)))
@@ -298,6 +300,7 @@ class CardMapper extends QBMapper implements IPermissionMapper {
 			->where($qb->expr()->lt('duedate', $qb->createFunction('NOW()')))
 			->andWhere($qb->expr()->eq('notified', $qb->createNamedParameter(false, IQueryBuilder::PARAM_BOOL)))
 			->andWhere($qb->expr()->eq('archived', $qb->createNamedParameter(false, IQueryBuilder::PARAM_BOOL)))
+			->andWhere($qb->expr()->isNull('done'))
 			->andWhere($qb->expr()->eq('deleted_at', $qb->createNamedParameter(0, IQueryBuilder::PARAM_INT)));
 		return $this->findEntities($qb);
 	}

lib/Migration/Version1011Date20230901010840.php

@@ -0,0 +1,61 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2023 Thanos kamber <thanos.kamber@gmail.com>
+ *
+ * @author Thanos kamber <thanos.kamber@gmail.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * 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
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCA\Deck\Migration;
+
+use Closure;
+use OCP\DB\ISchemaWrapper;
+use OCP\DB\Types;
+use OCP\Migration\IOutput;
+use OCP\Migration\SimpleMigrationStep;
+
+/**
+ * Auto-generated migration step: Please modify to your needs!
+ */
+class Version1011Date20230901010840 extends SimpleMigrationStep {
+	/**
+	 * @param IOutput $output
+	 * @param Closure $schemaClosure
+	 * @param array $options
+	 * @return null|ISchemaWrapper
+	 */
+	public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
+		/** @var ISchemaWrapper $schema */
+		$schema = $schemaClosure();
+
+		$table = $schema->getTable('deck_cards');
+		if (!$table->hasColumn('done')) {
+			$table->addColumn('done', Types::DATETIME, [
+				'default' => null,
+				'notnull' => false,
+			]);
+
+			return $schema;
+		}
+
+		return null;
+	}
+}

lib/Model/OptionalNullableValue.php

@@ -0,0 +1,51 @@
+<?php
+/**
+ * @copyright Copyright (c) 2023 Julius Härtl <jus@bitgrid.net>
+ *
+ * @author Julius Härtl <jus@bitgrid.net>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * 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
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+namespace OCA\Deck\Model;
+
+/**
+ * This is a helper abstraction to allow usage of optional parameters
+ * which hold a nullable value. The actual null value of the parameter
+ * is used to indicate if it has been set or not. The containing value
+ * will then still allow having null as a value
+ *
+ * Example use case: Have a nullable database column,
+ * but only update it if it is passed
+ *
+ * @template T
+ */
+class OptionalNullableValue {
+
+	/** @var ?T */
+	private mixed $value;
+
+	/** @param ?T $value */
+	public function __construct(mixed $value) {
+		$this->value = $value;
+	}
+
+	/** @return ?T */
+	public function getValue(): mixed {
+		return $this->value;
+	}
+
+}

lib/Service/CardService.php

@@ -43,6 +43,7 @@ use OCA\Deck\Event\CardCreatedEvent;
 use OCA\Deck\Event\CardDeletedEvent;
 use OCA\Deck\Event\CardUpdatedEvent;
 use OCA\Deck\Model\CardDetails;
+use OCA\Deck\Model\OptionalNullableValue;
 use OCA\Deck\NoPermissionException;
 use OCA\Deck\Notification\NotificationHelper;
 use OCA\Deck\StatusException;
@@ -284,6 +285,9 @@ class CardService {
 	 * @param $description
 	 * @param $order
 	 * @param $duedate
+	 * @param $deletedAt
+	 * @param $archived
+	 * @param $done
 	 * @return \OCP\AppFramework\Db\Entity
 	 * @throws StatusException
 	 * @throws \OCA\Deck\NoPermissionException
@@ -291,7 +295,7 @@ class CardService {
 	 * @throws \OCP\AppFramework\Db\MultipleObjectsReturnedException
 	 * @throws BadRequestException
 	 */
-	public function update($id, $title, $stackId, $type, $owner, $description = '', $order = 0, $duedate = null, $deletedAt = null, $archived = null) {
+	public function update($id, $title, $stackId, $type, $owner, $description = '', $order = 0, $duedate = null, $deletedAt = null, $archived = null, ?OptionalNullableValue $done = null) {
 		$this->cardServiceValidator->check(compact('id', 'title', 'stackId', 'type', 'owner', 'order'));
 
 		$this->permissionService->checkPermission($this->cardMapper, $id, Acl::PERMISSION_EDIT);
@@ -341,6 +345,9 @@ class CardService {
 		if ($archived !== null) {
 			$card->setArchived($archived);
 		}
+		if ($done !== null) {
+			$card->setDone($done->getValue());
+		}
 
 
 		// Trigger update events before setting description as it is handled separately
@@ -511,6 +518,57 @@ class CardService {
 		return $newCard;
 	}
 
+	/**
+	 * @param $id
+	 * @return \OCA\Deck\Db\Card
+	 * @throws StatusException
+	 * @throws \OCA\Deck\NoPermissionException
+	 * @throws \OCP\AppFramework\Db\DoesNotExistException
+	 * @throws \OCP\AppFramework\Db\MultipleObjectsReturnedException
+	 * @throws BadRequestException
+	 */
+	public function done(int $id): Card {
+		$this->permissionService->checkPermission($this->cardMapper, $id, Acl::PERMISSION_EDIT);
+		if ($this->boardService->isArchived($this->cardMapper, $id)) {
+			throw new StatusException('Operation not allowed. This board is archived.');
+		}
+		$card = $this->cardMapper->find($id);
+		$card->setDone(new \DateTime());
+		$newCard = $this->cardMapper->update($card);
+		$this->notificationHelper->markDuedateAsRead($card);
+		$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_CARD, $newCard, ActivityManager::SUBJECT_CARD_UPDATE_DONE);
+		$this->changeHelper->cardChanged($id, false);
+
+		$this->eventDispatcher->dispatchTyped(new CardUpdatedEvent($card));
+
+		return $newCard;
+	}
+
+	/**
+	 * @param $id
+	 * @return \OCA\Deck\Db\Card
+	 * @throws StatusException
+	 * @throws \OCA\Deck\NoPermissionException
+	 * @throws \OCP\AppFramework\Db\DoesNotExistException
+	 * @throws \OCP\AppFramework\Db\MultipleObjectsReturnedException
+	 * @throws BadRequestException
+	 */
+	public function undone(int $id): Card {
+		$this->permissionService->checkPermission($this->cardMapper, $id, Acl::PERMISSION_EDIT);
+		if ($this->boardService->isArchived($this->cardMapper, $id)) {
+			throw new StatusException('Operation not allowed. This board is archived.');
+		}
+		$card = $this->cardMapper->find($id);
+		$card->setDone(null);
+		$newCard = $this->cardMapper->update($card);
+		$this->activityManager->triggerEvent(ActivityManager::DECK_OBJECT_CARD, $newCard, ActivityManager::SUBJECT_CARD_UPDATE_UNDONE);
+		$this->changeHelper->cardChanged($id, false);
+
+		$this->eventDispatcher->dispatchTyped(new CardUpdatedEvent($card));
+
+		return $newCard;
+	}
+
 	/**
 	 * @param $cardId
 	 * @param $labelId