fix(Trashbin): Improve UX

- do not wait for trashbin items to load on unrelated routes
- show proper loading modal if people are waiting for the trashbin to load
- Create a new route that empties the trashbin in one go

Signed-off-by: Marcel Klehr <mklehr@gmx.net>

Author: marcelklehr

lib/BackgroundJobs/EmptyTrashbinJob.php

@@ -13,7 +13,7 @@
 use OCP\BackgroundJob\TimedJob;
 
 class EmptyTrashbinJob extends TimedJob {
-	public const BATCH_SIZE = 1000; // 40 items
+	public const BATCH_SIZE = 1000;
 	public const INTERVAL = 5 * 60; // 5 minutes
 	public const TRASHBIN_TTL = 2 * 4 * 4 * 7 * 24 * 60 * 60; // Two months
 

lib/Controller/FoldersController.php

@@ -850,4 +850,24 @@ public function getDeletedFolders(): DataResponse {
 
 		return new Http\DataResponse(['status' => 'success', 'data' => $folderItems]);
 	}
+
+	/**
+	 * @throws UnauthenticatedError
+	 */
+	#[Http\Attribute\NoAdminRequired]
+	#[Http\Attribute\NoCSRFRequired]
+	#[Http\Attribute\PublicPage]
+	#[Http\Attribute\BruteForceProtection(action: 'removeDeletedFolders')]
+	#[Http\Attribute\FrontpageRoute(verb: 'DELETE', url: '/public/rest/v2/folder/deleted')]
+	public function removeDeletedFolders(): DataResponse {
+		$this->authorizer->setCredentials($this->request);
+		if ($this->authorizer->getUserId() === null) {
+			$res = new Http\DataResponse(['status' => 'error', 'data' => ['Unauthorized']], Http::STATUS_FORBIDDEN);
+			$res->throttle();
+			return $res;
+		}
+		$this->treeMapper->deleteTrashbinItemsForUser($this->authorizer->getUserId());
+
+		return new Http\DataResponse(['status' => 'success', 'data' => []]);
+	}
 }

lib/Controller/InternalFoldersController.php

@@ -156,4 +156,10 @@ public function deleteShare(int $shareId): DataResponse {
 	public function getDeletedFolders(): DataResponse {
 		return $this->controller->getDeletedFolders();
 	}
+
+	#[NoAdminRequired]
+	#[FrontpageRoute(verb: 'DELETE', url: '/folder/deleted')]
+	public function removeDeletedFolders(): DataResponse {
+		return $this->controller->removeDeletedFolders();
+	}
 }

lib/Db/TreeMapper.php

@@ -1288,7 +1288,7 @@ public function deleteOldTrashbinItems(int $limit, float|int $maxAge): void {
 		$qb->where($qb->expr()->neq('type', $qb->createNamedParameter(TreeMapper::TYPE_SHARE, IQueryBuilder::PARAM_STR)));
 		$cutoffDate = $this->timeFactory->getDateTime();
 		$cutoffDate->modify('- ' . ((string)$maxAge) . ' seconds');
-		$qb->andWhere($qb->expr()->lt('soft_deleted_at', $qb->createNamedParameter($cutoffDate, IQueryBuilder::PARAM_DATE)));
+		$qb->andWhere($qb->expr()->lt('soft_deleted_at', $qb->createNamedParameter($cutoffDate, IQueryBuilder::PARAM_DATETIME_MUTABLE)));
 		$qb->setMaxResults($limit);
 		try {
 			$result = $qb->executeQuery();
@@ -1301,9 +1301,47 @@ public function deleteOldTrashbinItems(int $limit, float|int $maxAge): void {
 				$this->deleteEntry($row['type'], $row['id'], $row['parent_folder']);
 			} catch (DoesNotExistException $e) {
 				// noop
-			} catch (UnsupportedOperation|MultipleObjectsReturnedException $e) {
+			} catch (UnsupportedOperation|MultipleObjectsReturnedException|Exception $e) {
 				$this->logger->error('Could not delete old trash bin item: ' . var_export($row, true), ['exception' => $e]);
 			}
 		}
 	}
+
+	/**
+	 * @param string $userId
+	 * @return void
+	 */
+	public function deleteTrashbinItemsForUser(string $userId): void {
+		$qb = $this->db->getQueryBuilder();
+		$qb->select('t.type', 't.id', 't.parent_folder')->from('bookmarks_tree', 't');
+		$qb->where($qb->expr()->neq('type', $qb->createNamedParameter(TreeMapper::TYPE_SHARE, IQueryBuilder::PARAM_STR)));
+		$qb->andWhere($qb->expr()->isNotNull('soft_deleted_at'));
+		$qb->leftJoin('t', 'bookmarks', 'b', 't.id = b.id and t.type = ' . $qb->createNamedParameter(TreeMapper::TYPE_BOOKMARK));
+		$qb->leftJoin('t', 'bookmarks_folders', 'f', 't.id = f.id and t.type = ' . $qb->createNamedParameter(TreeMapper::TYPE_FOLDER));
+		$qb->andWhere($qb->expr()->orX(
+			$qb->expr()->andX(
+				$qb->expr()->eq('t.type', $qb->createNamedParameter(TreeMapper::TYPE_BOOKMARK)),
+				$qb->expr()->eq('b.user_id', $qb->createNamedParameter($userId)),
+			),
+			$qb->expr()->andX(
+				$qb->expr()->eq('t.type', $qb->createNamedParameter(TreeMapper::TYPE_FOLDER)),
+				$qb->expr()->eq('f.user_id', $qb->createNamedParameter($userId)),
+			)
+		));
+		try {
+			$result = $qb->executeQuery();
+		} catch (Exception $e) {
+			$this->logger->error('Could not query for trash bin items of user ' . $userId, ['exception' => $e]);
+			return;
+		}
+		while ($row = $result->fetch()) {
+			try {
+				$this->deleteEntry($row['type'], $row['id'], $row['parent_folder']);
+			} catch (DoesNotExistException $e) {
+				// noop
+			} catch (UnsupportedOperation|MultipleObjectsReturnedException|Exception $e) {
+				$this->logger->error('Could not delete trash bin item: ' . var_export($row, true), ['exception' => $e]);
+			}
+		}
+	}
 }

src/components/BookmarksList.vue

@@ -209,7 +209,7 @@ export default {
 			return this.$store.state.settings.sorting
 		},
 		loading() {
-			return this.$store.state.loading.bookmarks || this.$store.state.loading.folders
+			return this.$store.state.loading.bookmarks || this.$store.state.loading.folders || (this.$route.name === privateRoutes.TRASHBIN && this.$store.state.loading.deleted_folders)
 		},
 	},
 	methods: {

src/components/LoadingModal.vue

@@ -7,6 +7,7 @@
 </template>
 <script>
 import { NcModal } from '@nextcloud/vue'
+import { privateRoutes } from '../router'
 
 export default {
 	name: 'LoadingModal',
@@ -22,6 +23,7 @@ export default {
 				moveSelection: this.t('bookmkarks', 'Moving selection'),
 				copySelection: this.t('bookmkarks', 'Adding selection to folders'),
 				emptyTrashbin: this.t('bookmkarks', 'Emptying trashbin'),
+				deleted_folders: this.t('bookmkarks', 'Loading trashbin'),
 			},
 			showNcModal: false,
 			showTimeout: null,
@@ -42,6 +44,9 @@ export default {
 	},
 	watch: {
 		state(newState, previous) {
+			if (this.state === 'deleted_folders' && this.$route.name !== privateRoutes.TRASHBIN) {
+				return
+			}
 			if (this.state && !previous) {
 				this.showTimeout = setTimeout(() => {
 					this.showNcModal = true

src/store/actions.js

@@ -799,6 +799,9 @@ export default {
 	},
 
 	async [actions.LOAD_DELETED_FOLDERS]({ commit, dispatch, state }) {
+		if (state.loading.deleted_folders) {
+			return;
+		}
 		if (state.deletedFolders === null) {
 			try {
 				const count = loadState('bookmarks', 'deletedFolders')
@@ -826,11 +829,11 @@ export default {
 			} = response
 			if (status !== 'success') throw new Error(data)
 			const folders = data
-			commit(mutations.FETCH_END, 'folders')
+			commit(mutations.FETCH_END, 'deleted_folders');
 			return commit(mutations.SET_DELETED_FOLDERS, folders)
 		} catch (err) {
 			console.error(err)
-			commit(mutations.FETCH_END, 'folders')
+			commit(mutations.FETCH_END, 'deleted_folders');
 			commit(
 				mutations.SET_ERROR,
 				AppGlobal.methods.t('bookmarks', 'Failed to load deleted folders'),
@@ -1656,35 +1659,22 @@ export default {
 	},
 	async [actions.EMPTY_TRASHBIN]({ commit, dispatch, state }) {
 		if (state.loading.emptyTrashbin) return
+		let canceled = false
 		await commit(mutations.FETCH_START, {
 			type: 'emptyTrashbin',
+			cancel() {
+				canceled = true
+			}
 		})
 		try {
-			await Parallel.each(
-				state.deletedFolders,
-				folder =>
-					dispatch(actions.DELETE_FOLDER, {
-						id: folder.id,
-						avoidReload: true,
-						hard: true,
-					}),
-				10,
-			)
-			await Parallel.each(
-				state.bookmarks,
-				(bookmark) => {
-					// soft delete all occurences instead of hard deleting the bookmark itself
-					return Promise.all(bookmark.folders.map((folder) => {
-						return dispatch(actions.DELETE_BOOKMARK, {
-							id: bookmark.id,
-							folder,
-							avoidReload: true,
-							hard: true,
-						})
-					}))
-				},
-				10,
-			)
+			const response = await axios.delete(url(state, '/folder/deleted'), {
+				params: {},
+			})
+			if (canceled) return
+			const {
+				data: { data, status },
+			} = response
+			if (status !== 'success') throw new Error(data)
 			dispatch(actions.RELOAD_VIEW)
 			dispatch(actions.LOAD_DELETED_FOLDERS)
 			commit(mutations.FETCH_END, 'emptyTrashbin')