Add job to apply ttl

vitormattos · vitormattos · commit c87c0fe172f9 · 2022-05-13T11:42:50.000-03:00
Signed-off-by: Vitor Mattos &lt;vitor@php.rio&gt;
diff --git a/appinfo/info.xml b/appinfo/info.xml
@@ -62,6 +62,7 @@ And in the works for the [coming versions](https://github.com/nextcloud/spreed/m
 		<job>OCA\Talk\BackgroundJob\CheckReferenceIdColumn</job>
 		<job>OCA\Talk\BackgroundJob\CheckHostedSignalingServer</job>
 		<job>OCA\Talk\BackgroundJob\CheckMatterbridges</job>
+		<job>OCA\Talk\BackgroundJob\ApplyTtl</job>
 	</background-jobs>
 
 	<repair-steps>
diff --git a/lib/BackgroundJob/ApplyTtl.php b/lib/BackgroundJob/ApplyTtl.php
@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * @copyright Copyright (c) 2020 Morris Jobke <hey@morrisjobke.de>
+ *
+ * @author Morris Jobke <hey@morrisjobke.de>
+ *
+ * @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\Service\RoomService;
+use OCP\AppFramework\Utility\ITimeFactory;
+use OCP\BackgroundJob\IJob;
+use OCP\BackgroundJob\TimedJob;
+
+class ApplyTtl extends TimedJob {
+	private RoomService $roomService;
+
+	public function __construct(ITimeFactory $timeFactory,
+								RoomService $roomService) {
+		parent::__construct($timeFactory);
+		$this->roomService = $roomService;
+
+		// Every 5 minutes
+		$this->setInterval(5 * 60);
+		$this->setTimeSensitivity(IJob::TIME_SENSITIVE);
+	}
+
+	/**
+	 * @param array $argument
+	 */
+	protected function run($argument): void {
+		$this->roomService->deleteExpiredTtl($argument['room_id'], $this->getId());
+	}
+}
diff --git a/lib/Service/RoomService.php b/lib/Service/RoomService.php
@@ -23,7 +23,9 @@
 
 namespace OCA\Talk\Service;
 
+use DateInterval;
 use InvalidArgumentException;
+use OCA\Talk\BackgroundJob\ApplyTtl;
 use OCA\Talk\Events\ChangeTtlEvent;
 use OCA\Talk\Events\ModifyLobbyEvent;
 use OCA\Talk\Events\ModifyRoomEvent;
@@ -34,30 +36,36 @@
 use OCA\Talk\Participant;
 use OCA\Talk\Room;
 use OCA\Talk\Webinary;
+use OCP\AppFramework\Utility\ITimeFactory;
+use OCP\BackgroundJob\IJobList;
 use OCP\DB\QueryBuilder\IQueryBuilder;
 use OCP\EventDispatcher\IEventDispatcher;
 use OCP\IDBConnection;
 use OCP\IUser;
 use OCP\Security\IHasher;
+use OCP\Server;
 use OCP\Share\IManager as IShareManager;
 
 class RoomService {
 	protected Manager $manager;
 	protected ParticipantService $participantService;
 	protected IDBConnection $db;
+	protected ITimeFactory $timeFactory;
 	protected IShareManager $shareManager;
 	protected IHasher $hasher;
 	protected IEventDispatcher $dispatcher;
 
 	public function __construct(Manager $manager,
 								ParticipantService $participantService,
 								IDBConnection $db,
+								ITimeFactory $timeFactory,
 								IShareManager $shareManager,
 								IHasher $hasher,
 								IEventDispatcher $dispatcher) {
 		$this->manager = $manager;
 		$this->participantService = $participantService;
 		$this->db = $db;
+		$this->timeFactory = $timeFactory;
 		$this->shareManager = $shareManager;
 		$this->hasher = $hasher;
 		$this->dispatcher = $dispatcher;
@@ -396,11 +404,60 @@ public function verifyPassword(Room $room, string $password): array {
 	public function setTimeToLive(Room $room, int $ttl): void {
 		$event = new ChangeTtlEvent($room, $ttl);
 		$this->dispatcher->dispatch(Room::EVENT_BEFORE_SET_TIME_TO_LIVE, $event);
+
 		$update = $this->db->getQueryBuilder();
 		$update->update('talk_rooms')
 			->set('time_to_live', $update->createNamedParameter($ttl, IQueryBuilder::PARAM_INT))
 			->where($update->expr()->eq('id', $update->createNamedParameter($room->getId(), IQueryBuilder::PARAM_INT)));
 		$update->executeStatement();
+		$jobList = Server::get(IJobList::class);
+		if ($ttl > 0) {
+			$jobList->add(ApplyTtl::class, ['room_id' => $room->getId()]);
+		} else {
+			$jobList->remove(ApplyTtl::class, ['room_id' => $room->getId()]);
+		}
+
 		$this->dispatcher->dispatch(Room::EVENT_AFTER_SET_TIME_TO_LIVE, $event);
 	}
+
+	public function deleteExpiredTtl(int $roomId, int $jobId): void {
+		$room = $this->manager->getRoomById($roomId);
+
+		$max = $this->getMaxDateTtl($room->getTimeToLive());
+		$min = $this->getMinDateTtl($jobId);
+
+		$this->deleteMessagesByRoomIdInDateInterval($roomId, $min, $max);
+	}
+
+	private function getMaxDateTtl(int $ttl): \DateTime {
+		$max = $this->timeFactory->getDateTime();
+		return $max->sub(new DateInterval('PT' . $ttl . 'S'));
+	}
+
+	private function getMinDateTtl(int $jobId): \DateTime {
+		$query = $this->db->getQueryBuilder();
+		$query->select('last_checked')
+			->from('jobs')
+			->where(
+				$query->expr()->eq('id', $query->createNamedParameter($jobId, IQueryBuilder::PARAM_INT))
+			);
+		$result = $query->executeQuery();
+		$lastCheckedEpoch = $result->fetchOne();
+		$lastChechedDateTime = $this->timeFactory->getDateTime('@' . $lastCheckedEpoch);
+		return $lastChechedDateTime;
+	}
+
+	private function deleteMessagesByRoomIdInDateInterval(int $roomId, \DateTime $min, \DateTime $max): void {
+		$delete = $this->db->getQueryBuilder();
+		$delete->delete('comments')
+			->where(
+				$delete->expr()->andX(
+					$delete->expr()->eq('object_id', $delete->createNamedParameter($roomId, IQueryBuilder::PARAM_INT)),
+					$delete->expr()->eq('object_type', $delete->createNamedParameter('chat')),
+					$delete->expr()->gte('creation_timestamp', $delete->createNamedParameter($min, IQueryBuilder::PARAM_DATE)),
+					$delete->expr()->lte('creation_timestamp', $delete->createNamedParameter($max, IQueryBuilder::PARAM_DATE))
+				)
+			);
+		$delete->executeStatement();
+	}
 }
diff --git a/tests/integration/features/bootstrap/FeatureContext.php b/tests/integration/features/bootstrap/FeatureContext.php
@@ -2331,18 +2331,35 @@ public function userSetTheTtlToWith(string $user, int $ttl, string $identifier,
 	/**
 	 * @Given user :user check if ttl of room :identifier is :ttl (:apiVersion)
 	 */
-	public function theTtlOfRoomIsV(string $user, string $identifier, int $ttl, string $apiVersion = 'v4') {
+	public function userCheckIfTtlOfRoomIsX(string $user, string $identifier, int $ttl, string $apiVersion = 'v4') {
 		$this->setCurrentUser($user);
-		$this->sendRequest('GET', '/apps/spreed/api/' . $apiVersion . '/room');
-		$rooms = $this->getDataFromResponse($this->response);
+		$this->sendRequest('GET', '/apps/spreed/api/' . $apiVersion . '/room/' . self::$identifierToToken[$identifier]);
+		$room = $this->getDataFromResponse($this->response);
 
-		$rooms = array_filter($rooms, function ($room) {
-			return $room['type'] !== 4;
-		});
-		Assert::assertEquals($ttl, $rooms[0]['timeToLive']);
+		Assert::assertEquals($ttl, $room['timeToLive']);
 	}
 
+	/**
+	 * @When wait for :seconds seconds
+	 */
+	public function waitForXSeconds($seconds): void {
+		sleep($seconds);
+	}
 
+	/**
+	 * @When apply ttl job to room :identifier
+	 */
+	public function applyTtlJobToRoom($identifier): void {
+		$currentUser = $this->currentUser;
+		$this->setCurrentUser('admin');
+		$this->sendRequest('GET', '/apps/spreedcheats/get_ttl_job/' . self::$identifierToToken[$identifier]);
+		$response = $this->response->getBody()->getContents();
+		$response = json_decode($response, true);
+		Assert::assertIsArray($response, 'Room ' . $identifier . 'not found');
+		Assert::assertArrayHasKey('id', $response);
+		$this->runOcc(['background-job:execute', $response['id']]);
+		$this->setCurrentUser($currentUser);
+	}
 
 	/*
 	 * Requests
diff --git a/tests/integration/features/ttl/ttl.feature b/tests/integration/features/ttl/ttl.feature
@@ -3,14 +3,21 @@ Feature: room/ttp
     Given user "participant1" exists
     Given user "participant2" exists
     Given user "participant3" exists
+
   Scenario: Enable TTL and check after expire
     Given user "participant1" creates room "room" (v4)
       | roomType | 3 |
       | roomName | room |
     And user "participant1" adds user "participant2" to room "room" with 200 (v4)
+    And user "participant1" sends message "Message 1" to room "room" with 201
     And user "participant1" set the ttl to -1 of room "room" with 400 (v4)
     And user "participant2" set the ttl to 3 of room "room" with 403 (v4)
     And user "participant3" set the ttl to 3 of room "room" with 404 (v4)
     And user "participant1" set the ttl to 3 of room "room" with 200 (v4)
-    And user "participant1" sends message "Message 1" to room "room" with 201
-    And user "participant1" check if ttl of room "room" is 3 (v4)
+    And user "participant1" sends message "Message 2" to room "room" with 201
+    And user "participant1" check if ttl of room "room" is 3 (v4)
+    And wait for 3 seconds
+    And apply ttl job to room "room"
+    Then user "participant1" sees the following messages in room "room" with 200
+      | room | actorType | actorId      | actorDisplayName         | message     | messageParameters | parentMessage |
+      | room | users     | participant1 | participant1-displayname | Message 1   | []                |               |
diff --git a/tests/integration/spreedcheats/appinfo/routes.php b/tests/integration/spreedcheats/appinfo/routes.php
@@ -26,5 +26,6 @@
 return [
 	'ocs' => [
 		['name' => 'Api#resetSpreed', 'url' => '/', 'verb' => 'DELETE'],
+		['name' => 'Api#getTtlJob', 'url' => '/get_ttl_job/{token}', 'verb' => 'GET'],
 	],
 ];
diff --git a/tests/integration/spreedcheats/lib/Controller/ApiController.php b/tests/integration/spreedcheats/lib/Controller/ApiController.php
@@ -27,6 +27,7 @@
 
 use OCP\AppFramework\OCSController;
 use OCP\AppFramework\Http\DataResponse;
+use OCP\AppFramework\Http\JSONResponse;
 use OCP\IDBConnection;
 use OCP\IRequest;
 use OCP\Share\IShare;
@@ -96,4 +97,41 @@ public function resetSpreed(): DataResponse {
 
 		return new DataResponse();
 	}
+
+	/**
+	 * @NoCSRFRequired
+	 *
+	 * @return JSONResponse
+	 */
+	public function getTtlJob($token): JSONResponse {
+		$class = 'OCA\Talk\BackgroundJob\ApplyTtl';
+		$roomId = $this->getRoomIdByToken($token);
+		if (!$roomId) {
+			return new JSONResponse();
+		}
+		$query = $this->db->getQueryBuilder();
+		$query->select('id')
+			->from('jobs')
+			->where(
+				$query->expr()->andX(
+					$query->expr()->eq('class', $query->createNamedParameter($class)),
+					$query->expr()->eq('argument', $query->createNamedParameter(json_encode(['room_id' => (int) $roomId])))
+				)
+			);
+		$result = $query->executeQuery();
+		$job = $result->fetchOne();
+		if ($job) {
+			return new JSONResponse(['id' => (int) $job]);
+		}
+		return new JSONResponse();
+	}
+
+	private function getRoomIdByToken(string $token): ?string {
+		$query = $this->db->getQueryBuilder();
+		$query->select('id')
+			->from('talk_rooms')
+			->where($query->expr()->eq('token', $query->createNamedParameter($token)));
+		$result = $query->executeQuery();
+		return $result->fetchOne();
+	}
 }
diff --git a/tests/php/Service/RoomServiceTest.php b/tests/php/Service/RoomServiceTest.php
@@ -67,13 +67,15 @@ public function setUp(): void {
 
 		$this->manager = $this->createMock(Manager::class);
 		$this->participantService = $this->createMock(ParticipantService::class);
+		$this->timeFactory = $this->createMock(ITimeFactory::class);
 		$this->shareManager = $this->createMock(IShareManager::class);
 		$this->hasher = $this->createMock(IHasher::class);
 		$this->dispatcher = $this->createMock(IEventDispatcher::class);
 		$this->service = new RoomService(
 			$this->manager,
 			$this->participantService,
 			\OC::$server->get(IDBConnection::class),
+			$this->timeFactory,
 			$this->shareManager,
 			$this->hasher,
 			$this->dispatcher
@@ -334,6 +336,7 @@ public function testVerifyPassword(): void {
 			$this->manager,
 			$this->participantService,
 			\OC::$server->get(IDBConnection::class),
+			$this->timeFactory,
 			$this->shareManager,
 			$this->hasher,
 			$dispatcher
diff --git a/tests/php/Signaling/BackendNotifierTest.php b/tests/php/Signaling/BackendNotifierTest.php
@@ -155,6 +155,7 @@ public function setUp(): void {
 			$this->manager,
 			$this->participantService,
 			$dbConnection,
+			$this->timeFactory,
 			$this->createMock(IManager::class),
 			$this->createMock(IHasher::class),
 			$this->dispatcher
