Merge pull request #5921 from nextcloud/backport/5918/stable29

[stable29] Truncate tables and rename documents folder on reset

lib/Command/ResetDocument.php

@@ -77,10 +77,17 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 			return 1;
 		}
 
+		if ($all && $fullReset) {
+			// Truncate tables and clear document directory
+			$this->documentService->clearAll();
+			return 0;
+		}
+
 		if ($all) {
-			$fileIds = array_map(static function (Document $document) {
-				return $document->getId();
-			}, $this->documentService->getAll());
+			$fileIds = [];
+			foreach ($this->documentService->getAll() as $document) {
+				$fileIds[] = $document->getId();
+			}
 		} else {
 			$fileIds = [$fileId];
 		}

lib/Cron/Cleanup.php

@@ -56,10 +56,8 @@ public function __construct(ITimeFactory $time,
 	 */
 	protected function run($argument): void {
 		$this->logger->debug('Run cleanup job for text documents');
-		$documents = $this->documentService->getAll();
-		foreach ($documents as $document) {
-			$allSessions = $this->sessionService->getAllSessions($document->getId());
-			if (count($allSessions) > 0) {
+		foreach ($this->documentService->getAll() as $document) {
+			if ($this->sessionService->countAllSessions($document->getId()) > 0) {
 				// Do not reset if there are any sessions left
 				// Inactive sessions will get removed further down and will trigger a reset next time
 				continue;
@@ -74,5 +72,8 @@ protected function run($argument): void {
 		$this->logger->debug('Run cleanup job for text sessions');
 		$removedSessions = $this->sessionService->removeInactiveSessionsWithoutSteps(null);
 		$this->logger->debug('Removed ' . $removedSessions . ' inactive sessions');
+
+		$this->logger->debug('Run cleanup job for obsolete documents folders');
+		$this->documentService->cleanupOldDocumentsFolders();
 	}
 }

lib/Db/DocumentMapper.php

@@ -23,6 +23,7 @@
 
 namespace OCA\Text\Db;
 
+use Generator;
 use OCP\AppFramework\Db\DoesNotExistException;
 use OCP\AppFramework\Db\QBMapper;
 use OCP\DB\QueryBuilder\IQueryBuilder;
@@ -55,12 +56,33 @@ public function find(int $documentId): Document {
 		return Document::fromRow($data);
 	}
 
-	public function findAll(): array {
+	public function findAll(): Generator {
 		$qb = $this->db->getQueryBuilder();
 		$result = $qb->select('*')
 			->from($this->getTableName())
 			->executeQuery();
+		try {
+			while ($row = $result->fetch()) {
+				yield $this->mapRowToEntity($row);
+			}
+		} finally {
+			$result->closeCursor();
+		}
+	}
 
-		return $this->findEntities($qb);
+	public function countAll(): int {
+		$qb = $this->db->getQueryBuilder();
+		$qb->select($qb->func()->count('id'))
+			->from($this->getTableName());
+		$result = $qb->executeQuery();
+		$count = (int)$result->fetchOne();
+		$result->closeCursor();
+		return $count;
+	}
+
+	public function clearAll(): void {
+		$qb = $this->db->getQueryBuilder();
+		$qb->delete($this->getTableName())
+			->executeStatement();
 	}
 }

lib/Db/SessionMapper.php

@@ -85,6 +85,17 @@ public function findAll(int $documentId): array {
 		return $this->findEntities($qb);
 	}
 
+	public function countAll(int $documentId): int {
+		$qb = $this->db->getQueryBuilder();
+		$qb->select('id', 'color', 'document_id', 'last_awareness_message', 'last_contact', 'user_id', 'guest_name')
+			->from($this->getTableName())
+			->where($qb->expr()->eq('document_id', $qb->createNamedParameter($documentId)));
+		$result = $qb->executeQuery();
+		$count = (int)$result->fetchOne();
+		$result->closeCursor();
+		return $count;
+	}
+
 	/**
 	 * @return Session[]
 	 *
@@ -154,6 +165,12 @@ public function deleteByDocumentId(int $documentId): int {
 		return $qb->executeStatement();
 	}
 
+	public function clearAll(): void {
+		$qb = $this->db->getQueryBuilder();
+		$qb->delete($this->getTableName())
+			->executeStatement();
+	}
+
 	public function isUserInDocument(int $documentId, string $userId): bool {
 		$qb = $this->db->getQueryBuilder();
 		$result = $qb->select('*')

lib/Db/StepMapper.php

@@ -76,6 +76,12 @@ public function deleteAll(int $documentId): void {
 			->executeStatement();
 	}
 
+	public function clearAll(): void {
+		$qb = $this->db->getQueryBuilder();
+		$qb->delete($this->getTableName())
+			->executeStatement();
+	}
+
 	// not in use right now
 	public function deleteBeforeVersion(int $documentId, int $version): int {
 		$qb = $this->db->getQueryBuilder();

lib/Migration/ResetSessionsBeforeYjs.php

@@ -2,7 +2,6 @@
 
 namespace OCA\Text\Migration;
 
-use OCA\Text\Db\Document;
 use OCA\Text\Service\DocumentService;
 use OCP\IAppConfig;
 use OCP\Migration\IOutput;
@@ -27,20 +26,6 @@ public function run(IOutput $output): void {
 			return;
 		}
 
-		$fileIds = array_map(static function (Document $document) {
-			return $document->getId();
-		}, $this->documentService->getAll());
-
-		if (!$fileIds) {
-			return;
-		}
-
-		$output->startProgress(count($fileIds));
-		foreach ($fileIds as $fileId) {
-			$this->documentService->unlock($fileId);
-			$this->documentService->resetDocument($fileId, true);
-			$output->advance();
-		}
-		$output->finishProgress();
+		$this->documentService->clearAll();
 	}
 }

lib/Service/DocumentService.php

@@ -59,6 +59,7 @@
 use OCP\Files\SimpleFS\ISimpleFile;
 use OCP\ICache;
 use OCP\ICacheFactory;
+use OCP\IConfig;
 use OCP\IRequest;
 use OCP\Lock\LockedException;
 use OCP\PreConditionNotMetException;
@@ -87,8 +88,9 @@ class DocumentService {
 	private IAppData $appData;
 	private ILockManager $lockManager;
 	private IUserMountCache $userMountCache;
+	private IConfig $config;
 
-	public function __construct(DocumentMapper $documentMapper, StepMapper $stepMapper, SessionMapper $sessionMapper, IAppData $appData, ?string $userId, IRootFolder $rootFolder, ICacheFactory $cacheFactory, LoggerInterface $logger, ShareManager $shareManager, IRequest $request, IManager $directManager, ILockManager $lockManager, IUserMountCache $userMountCache) {
+	public function __construct(DocumentMapper $documentMapper, StepMapper $stepMapper, SessionMapper $sessionMapper, IAppData $appData, ?string $userId, IRootFolder $rootFolder, ICacheFactory $cacheFactory, LoggerInterface $logger, ShareManager $shareManager, IRequest $request, IManager $directManager, ILockManager $lockManager, IUserMountCache $userMountCache, IConfig $config) {
 		$this->documentMapper = $documentMapper;
 		$this->stepMapper = $stepMapper;
 		$this->sessionMapper = $sessionMapper;
@@ -100,6 +102,7 @@ public function __construct(DocumentMapper $documentMapper, StepMapper $stepMapp
 		$this->shareManager = $shareManager;
 		$this->lockManager = $lockManager;
 		$this->userMountCache = $userMountCache;
+		$this->config = $config;
 		$token = $request->getParam('token');
 		if ($this->userId === null && $token !== null) {
 			try {
@@ -444,7 +447,7 @@ public function resetDocument(int $documentId, bool $force = false): void {
 		}
 	}
 
-	public function getAll(): array {
+	public function getAll(): \Generator {
 		return $this->documentMapper->findAll();
 	}
 
@@ -658,4 +661,40 @@ public function unlock(int $fileId): void {
 		} catch (NoLockProviderException | PreConditionNotMetException | NotFoundException $e) {
 		}
 	}
+
+	public function countAll(): int {
+		return $this->documentMapper->countAll();
+	}
+
+	private function getFullAppFolder(): Folder {
+		$appFolder = $this->rootFolder->get('appdata_' . $this->config->getSystemValueString('instanceid', '') . '/text');
+		if (!$appFolder instanceof Folder) {
+			throw new NotFoundException('Folder not found');
+		}
+		return $appFolder;
+	}
+
+	public function clearAll(): void {
+		$this->stepMapper->clearAll();
+		$this->sessionMapper->clearAll();
+		$this->documentMapper->clearAll();
+		try {
+			$appFolder = $this->getFullAppFolder();
+			$appFolder->get('documents')->move($appFolder->getPath() . '/documents_old_' . time());
+		} catch (NotFoundException) {
+		}
+		$this->ensureDocumentsFolder();
+	}
+
+	public function cleanupOldDocumentsFolders(): void {
+		try {
+			$appFolder = $this->getFullAppFolder();
+			foreach ($appFolder->getDirectoryListing() as $node) {
+				if (str_starts_with($node->getName(), 'documents_old_')) {
+					$node->delete();
+				}
+			}
+		} catch (NotFoundException) {
+		}
+	}
 }

lib/Service/SessionService.php

@@ -123,6 +123,10 @@ public function getAllSessions(int $documentId): array {
 		}, $sessions);
 	}
 
+	public function countAllSessions(int $documentId): int {
+		return $this->sessionMapper->countAll($documentId);
+	}
+
 	public function getActiveSessions(int $documentId): array {
 		$sessions = $this->sessionMapper->findAllActive($documentId);
 		return array_map(function (Session $session) {

tests/unit/Service/DocumentServiceTest.php

@@ -14,6 +14,7 @@
 use OCP\Files\Lock\ILockManager;
 use OCP\Files\NotPermittedException;
 use OCP\ICacheFactory;
+use OCP\IConfig;
 use OCP\IRequest;
 use OCP\Share\IManager;
 use Psr\Log\LoggerInterface;
@@ -49,6 +50,7 @@ public function setUp(): void {
 		$this->directManager = $this->createMock(\OCP\DirectEditing\IManager::class);
 		$this->lockManager = $this->createMock(ILockManager::class);
 		$this->userMountCache = $this->createMock(IUserMountCache::class);
+		$config = $this->createMock(IConfig::class);
 
 		$this->documentService = new DocumentService(
 			$this->documentMapper,
@@ -64,6 +66,7 @@ public function setUp(): void {
 			$this->directManager,
 			$this->lockManager,
 			$this->userMountCache,
+			$config,
 		);
 	}