Implement time to live

appinfo/info.xml

@@ -16,7 +16,7 @@ And in the works for the [coming versions](https://github.com/nextcloud/spreed/m
 
 	]]></description>
 
-	<version>15.0.0-dev.4</version>
+	<version>15.0.0-dev.5</version>
 	<licence>agpl</licence>
 
 	<author>Aleksandra Lazarević</author>

appinfo/routes/routesRoomController.php

@@ -102,5 +102,7 @@
 		['name' => 'Room#setLobby', 'url' => '/api/{apiVersion}/room/{token}/webinar/lobby', 'verb' => 'PUT', 'requirements' => $requirementsWithToken],
 		/** @see \OCA\Talk\Controller\RoomController::setSIPEnabled() */
 		['name' => 'Room#setSIPEnabled', 'url' => '/api/{apiVersion}/room/{token}/webinar/sip', 'verb' => 'PUT', 'requirements' => $requirementsWithToken],
+		/** @see \OCA\Talk\Controller\RoomController::setMessageExpiration() */
+		['name' => 'Room#setMessageExpiration', 'url' => '/api/{apiVersion}/room/{token}/message-expiration', 'verb' => 'POST', 'requirements' => $requirements],
 	],
 ];

docs/capabilities.md

@@ -97,6 +97,7 @@ title: Capabilities
 * `unified-search` - When the extended attributes of unified search results are there
 * `chat-permission` - When permission 128 is required to post chat messages, reaction or share items to the conversation
 * `silent-send` - Whether the chat API allows to send chat messages without triggering notifications
+* `message-expiration` - Message expiration time for a conversation
 * `sip-support-nopin` - Whether SIP can be configured to not require a custom attendee PIN
 * `send-call-notification` - When the API allows to resend call notifications for individual users that did not join yet
 * `silent-call` - Allow to start calls without sending notification

docs/chat.md

@@ -384,4 +384,5 @@ See [OCP\RichObjectStrings\Definitions](https://github.com/nextcloud/server/blob
 * Creating a poll is an `object_shared` with a poll object
 * `poll_voted` - {actor} voted on the poll {poll}
 * `poll_closed` - {actor} closed the poll {poll}
-
+* `message_expiration_enabled` - {actor} set the message expiration to 3 hours
+* `message_expiration_disabled` - {actor} disabled message expiration

docs/conversation.md

@@ -51,6 +51,7 @@
         `participantFlags` | int | v1 | | "In call" flags of the user's session making the request (only available with `in-call-flags` capability)
         `readOnly` | int | v1 | | Read-only state for the current user (only available with `read-only-rooms` capability)
         `listable` | int | v3 | | Listable scope for the room (only available with `listable-rooms` capability)
+        `messageExpiration` | int | v4 | | The message expiration time in seconds in this chat. Zero if disabled. (only available with `message-expiration` capability)
         `count` | int | v1 | v2 | **Removed:** Count the users on the [Get list of participants in a conversation](participant.md#get-list-of-participants-in-a-conversation) endpoint
         `numGuests` | int | v1 | v2 | **Removed:** Count the guests on the [Get list of participants in a conversation](participant.md#get-list-of-participants-in-a-conversation) endpoin
         `lastPing` | int | v1 | | Timestamp of the user's session making the request
@@ -336,6 +337,24 @@
         + `401 Unauthorized` When the participant is a guest
         + `404 Not Found` When the conversation could not be found for the participant
 
+## Set message expiration
+
+* Required capability: `message-expiration`
+* Method: `POST`
+* Endpoint: `/room/{token}/message-expiration`
+* Data:
+
+    field | type | Description
+    ---|---|---
+    `seconds` | int | The messages expiration in seconds. If is zero, messages will not be deleted automatically.
+
+* Response:
+    - Status code:
+        + `200 OK`
+        + `400 Bad Request` Invalid value
+        + `403 Forbidden` When the current user is not a moderator, owner or guest moderator
+        + `404 Not Found` When the conversation could not be found for the participant
+
 ## Open a conversation
 
 * Required capability: `listable-rooms`

lib/BackgroundJob/ExpireChatMessages.php

@@ -0,0 +1,71 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * @copyright Copyright (c) 2022 Vitor Mattos <[email protected]>
+ *
+ * @author Vitor Mattos <[email protected]>
+ *
+ * @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\Talk\BackgroundJob;
+
+use OCA\Talk\Chat\ChatManager;
+use OCA\Talk\Exceptions\RoomNotFoundException;
+use OCA\Talk\Manager;
+use OCP\AppFramework\Utility\ITimeFactory;
+use OCP\BackgroundJob\IJob;
+use OCP\BackgroundJob\IJobList;
+use OCP\BackgroundJob\TimedJob;
+
+class ExpireChatMessages extends TimedJob {
+	private IJobList $jobList;
+	private Manager $roomManager;
+	private ChatManager $chatManager;
+
+	public function __construct(ITimeFactory $timeFactory,
+								IJobList $jobList,
+								Manager $roomManager,
+								ChatManager $chatManager) {
+		parent::__construct($timeFactory);
+		$this->jobList = $jobList;
+		$this->roomManager = $roomManager;
+		$this->chatManager = $chatManager;
+
+		// Every 5 minutes
+		$this->setInterval(5 * 60);
+		$this->setTimeSensitivity(IJob::TIME_SENSITIVE);
+	}
+
+	/**
+	 * @param array $argument
+	 */
+	protected function run($argument): void {
+		$this->chatManager->deleteExpiredMessages($argument['room_id']);
+
+		try {
+			$room = $this->roomManager->getRoomById($argument['room_id']);
+			if ($room->getMessageExpiration() === 0) {
+				// FIXME check if there are still messages to expire in the database
+				$this->jobList->remove(ExpireChatMessages::class, $argument);
+			}
+		} catch (RoomNotFoundException $e) {
+			$this->jobList->remove(ExpireChatMessages::class, $argument);
+		}
+	}
+}

lib/Capabilities.php

@@ -134,6 +134,10 @@ public function getCapabilities(): array {
 			'version' => $this->appManager->getAppVersion('spreed'),
 		];
 
+		if ($this->serverConfig->getAppValue('core', 'backgroundjobs_mode', 'ajax') === 'cron') {
+			$capabilities['features'][] = 'message-expiration';
+		}
+
 		if ($this->commentsManager->supportReactions()) {
 			$capabilities['features'][] = 'reactions';
 		}

lib/Chat/ChatManager.php

@@ -24,10 +24,12 @@
 
 namespace OCA\Talk\Chat;
 
+use DateInterval;
 use OC\Memcache\ArrayCache;
 use OC\Memcache\NullCache;
 use OCA\Talk\Events\ChatEvent;
 use OCA\Talk\Events\ChatParticipantEvent;
+use OCA\Talk\Manager;
 use OCA\Talk\Model\Attendee;
 use OCA\Talk\Participant;
 use OCA\Talk\Room;
@@ -84,6 +86,7 @@ class ChatManager {
 	private IDBConnection $connection;
 	private INotificationManager $notificationManager;
 	private IManager $shareManager;
+	private Manager $manager;
 	private RoomShareProvider $shareProvider;
 	private ParticipantService $participantService;
 	private PollService $pollService;
@@ -98,6 +101,7 @@ public function __construct(CommentsManager $commentsManager,
 								IDBConnection $connection,
 								INotificationManager $notificationManager,
 								IManager $shareManager,
+								Manager $manager,
 								RoomShareProvider $shareProvider,
 								ParticipantService $participantService,
 								PollService $pollService,
@@ -110,6 +114,7 @@ public function __construct(CommentsManager $commentsManager,
 		$this->connection = $connection;
 		$this->notificationManager = $notificationManager;
 		$this->shareManager = $shareManager;
+		$this->manager = $manager;
 		$this->shareProvider = $shareProvider;
 		$this->participantService = $participantService;
 		$this->pollService = $pollService;
@@ -258,6 +263,7 @@ public function sendMessage(Room $chat, Participant $participant, string $actorT
 		if ($referenceId !== '') {
 			$comment->setReferenceId($referenceId);
 		}
+		$this->setMessageExpiration($chat, $comment);
 
 		$event = new ChatParticipantEvent($chat, $comment, $participant, $silent);
 		$this->dispatcher->dispatch(self::EVENT_BEFORE_MESSAGE_SEND, $event);
@@ -303,6 +309,17 @@ public function sendMessage(Room $chat, Participant $participant, string $actorT
 		return $comment;
 	}
 
+	private function setMessageExpiration(Room $room, IComment $comment): void {
+		$messageExpiration = $room->getMessageExpiration();
+		if (!$messageExpiration) {
+			return;
+		}
+
+		$dateTime = $this->timeFactory->getDateTime();
+		$dateTime->add(DateInterval::createFromDateString($messageExpiration . ' seconds'));
+		$comment->setExpireDate($dateTime);
+	}
+
 	/**
 	 * @param Room $room
 	 * @param Participant $participant
@@ -693,4 +710,8 @@ private function searchIsPartOfConversationNameOrAtAll(string $search, string $r
 		}
 		return false;
 	}
+
+	public function deleteExpiredMessages(int $roomId): void {
+		$this->commentsManager->deleteMessageExpiredAtObject('chat', (string) $roomId);
+	}
 }

lib/Chat/Parser/SystemMessage.php

@@ -456,6 +456,34 @@ public function parseMessage(Message $chatMessage): void {
 			if ($currentUserIsActor) {
 				$parsedMessage = $this->l->t('You deleted a reaction');
 			}
+		} elseif ($message === 'message_expiration_enabled') {
+			$weeks = $parameters['seconds'] > (86400 * 7) ? (int) round($parameters['seconds'] / (86400 * 7)) : 0;
+			$days = $parameters['seconds'] > 86400 ? (int) round($parameters['seconds'] / 86400) : 0;
+			$hours = $parameters['seconds']  ? (int) round($parameters['seconds'] / 3600) : 0;
+
+			$parsedParameters['seconds'] = $parameters['seconds'];
+			if ($currentUserIsActor) {
+				if ($weeks > 0) {
+					$parsedMessage = $this->l->n('You set the message expiration to %n week', 'You set the message expiration to %n weeks', $weeks);
+				} elseif ($days > 0) {
+					$parsedMessage = $this->l->n('You set the message expiration to %n day', 'You set the message expiration to %n days', $days);
+				} else {
+					$parsedMessage = $this->l->n('You set the message expiration to %n hour', 'You set the message expiration to %n hours', $hours);
+				}
+			} else {
+				if ($weeks > 0) {
+					$parsedMessage = $this->l->n('{actor} set the message expiration to %n week', '{actor} set the message expiration to %n weeks', $weeks);
+				} elseif ($days > 0) {
+					$parsedMessage = $this->l->n('{actor} set the message expiration to %n day', '{actor} set the message expiration to %n days', $days);
+				} else {
+					$parsedMessage = $this->l->n('{actor} set the message expiration to %n hour', '{actor} set the message expiration to %n hours', $hours);
+				}
+			}
+		} elseif ($message === 'message_expiration_disabled') {
+			$parsedMessage = $this->l->t('{actor} disabled message expiration');
+			if ($currentUserIsActor) {
+				$parsedMessage = $this->l->t('You disabled message expiration');
+			}
 		} elseif ($message === 'history_cleared') {
 			$parsedMessage = $this->l->t('{actor} cleared the history of the conversation');
 			if ($currentUserIsActor) {

lib/Controller/RoomController.php

@@ -400,6 +400,7 @@ protected function formatRoomV4(Room $room, ?Participant $currentParticipant, ?a
 			'lastCommonReadMessage' => 0,
 			'listable' => Room::LISTABLE_NONE,
 			'callFlag' => Participant::FLAG_DISCONNECTED,
+			'messageExpiration' => 0,
 		];
 
 		$lastActivity = $room->getLastActivity();
@@ -466,6 +467,7 @@ protected function formatRoomV4(Room $room, ?Participant $currentParticipant, ?a
 			'defaultPermissions' => $room->getDefaultPermissions(),
 			'description' => $room->getDescription(),
 			'listable' => $room->getListable(),
+			'messageExpiration' => $this->roomService->getMessageExpiration($room),
 		]);
 
 		if ($currentParticipant->getAttendee()->getReadPrivacy() === Participant::PRIVACY_PUBLIC) {
@@ -1706,4 +1708,16 @@ public function resendInvitations(?int $attendeeId): DataResponse {
 		}
 		return new DataResponse();
 	}
+
+	/**
+	 * @PublicPage
+	 * @RequireModeratorParticipant
+	 */
+	public function setMessageExpiration(int $seconds): DataResponse {
+		if ($seconds < 0) {
+			return new DataResponse([], Http::STATUS_BAD_REQUEST);
+		}
+		$this->roomService->setMessageExpiration($this->room, $this->getParticipant(), $seconds);
+		return new DataResponse();
+	}
 }

lib/Manager.php

@@ -165,6 +165,7 @@ public function createRoomObject(array $row): Room {
 			(int) $row['type'],
 			(int) $row['read_only'],
 			(int) $row['listable'],
+			(int) $row['message_expiration'],
 			(int) $row['lobby_state'],
 			(int) $row['sip_enabled'],
 			$assignedSignalingServer,

lib/Migration/Version15000Date20220506005058.php

@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2022 Vitor Mattos <[email protected]>
+ *
+ * @author Vitor Mattos <[email protected]>
+ *
+ * @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\Talk\Migration;
+
+use Closure;
+use OCP\DB\ISchemaWrapper;
+use OCP\DB\Types;
+use OCP\Migration\IOutput;
+use OCP\Migration\SimpleMigrationStep;
+
+class Version15000Date20220506005058 extends SimpleMigrationStep {
+
+	/**
+	 * @param IOutput $output
+	 * @param Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper`
+	 * @param array $options
+	 * @return null|ISchemaWrapper
+	 */
+	public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
+		/** @var ISchemaWrapper $schema */
+		$schema = $schemaClosure();
+
+		$table = $schema->getTable('talk_rooms');
+		if (!$table->hasColumn('message_expiration')) {
+			$table->addColumn('message_expiration', Types::INTEGER, [
+				'default' => 0,
+			]);
+			return $schema;
+		}
+		return null;
+	}
+}

lib/Model/SelectHelper.php

@@ -51,6 +51,7 @@ public function selectRoomsTable(IQueryBuilder $query, string $alias = 'r'): voi
 			->addSelect($alias . 'object_type')
 			->addSelect($alias . 'object_id')
 			->addSelect($alias . 'listable')
+			->addSelect($alias . 'message_expiration')
 			->addSelect($alias . 'remote_server')
 			->addSelect($alias . 'remote_token')
 			->selectAlias($alias . 'id', 'r_id');