Enhancement: Make tables import asynchronous

appinfo/info.xml

@@ -50,6 +50,17 @@ Have a good time and manage whatever you want.
 		<database>sqlite</database>
 		<nextcloud min-version="29" max-version="32"/>
 	</dependencies>
+	<activity>
+		<settings>
+			<setting>OCA\Tables\Activity\Setting</setting>
+		</settings>
+		<filters>
+			<filter>OCA\Tables\Activity\Filter</filter>
+		</filters>
+		<providers>
+			<provider>OCA\Tables\Activity\Provider</provider>
+		</providers>
+	</activity>
 	<repair-steps>
 		<pre-migration>
 			<step>OCA\Tables\Migration\FixContextsDefaults</step>

lib/Activity/ActivityConstants.php

@@ -0,0 +1,32 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2021 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Tables\Activity;
+
+class ActivityConstants {
+	public const APP_ID = 'tables';
+
+	/*****
+	 * Types can have different Settings for Mail/Notifications.
+	 */
+	public const TYPE_IMPORT_FINISHED = 'tables_import_finished';
+
+	/*****
+	 * Subjects are internal 'types', that get interpreted by our own Provider.
+	 */
+
+	/**
+	 * Somebody shared a form to a selected user
+	 * Needs Params:
+	 * "user": The userId of the user who shared.
+	 * "formTitle": The hash of the shared form.
+	 * "formHash": The hash of the shared form
+	 */
+	public const SUBJECT_IMPORT_FINISHED = 'import_finished_subject';
+
+	public const MESSAGE_IMPORT_FINISHED = 'import_finished_message';
+}

lib/Activity/ActivityManager.php

@@ -0,0 +1,38 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Tables\Activity;
+
+use OCA\Tables\Model\ImportStats;
+use OCP\Activity\IManager;
+
+class ActivityManager {
+	public function __construct(
+		protected IManager $activityManager,
+	) {
+	}
+
+	public function notifyImportFinished(string $userId, int $tableId, ImportStats $importStats): void {
+
+		$activity = $this->activityManager->generateEvent();
+		$activity->setApp(ActivityConstants::APP_ID)
+			->setType(ActivityConstants::TYPE_IMPORT_FINISHED)
+			->setAuthor($userId)
+			->setObject('table', $tableId)
+			->setAffectedUser($userId)
+			->setSubject(ActivityConstants::SUBJECT_IMPORT_FINISHED, [
+				'actor' => $userId,
+				'tableId' => $tableId,
+			])
+			->setMessage(ActivityConstants::MESSAGE_IMPORT_FINISHED, [
+				'actor' => $userId,
+				'tableId' => $tableId,
+			] + (array)$importStats);
+
+		$this->activityManager->publish($activity);
+	}
+}

lib/Activity/Filter.php

@@ -0,0 +1,44 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Tables\Activity;
+
+use OCP\Activity\IFilter;
+use OCP\IL10N;
+use OCP\IURLGenerator;
+
+class Filter implements IFilter {
+	public function __construct(
+		protected IL10N $l,
+		protected IURLGenerator $url,
+	) {
+	}
+
+	public function getIdentifier(): string {
+		return ActivityConstants::APP_ID;
+	}
+
+	public function getName(): string {
+		return $this->l->t('Tables');
+	}
+
+	public function getPriority(): int {
+		return 40;
+	}
+
+	public function getIcon(): string {
+		return $this->url->getAbsoluteURL($this->url->imagePath(ActivityConstants::APP_ID, 'app-dark.svg'));
+	}
+
+	public function filterTypes(array $types): array {
+		return $types;
+	}
+
+	public function allowedApps(): array {
+		return [ActivityConstants::APP_ID];
+	}
+}

lib/Activity/Provider.php

@@ -0,0 +1,125 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCA\Tables\Activity;
+
+use OCP\Activity\Exceptions\UnknownActivityException;
+use OCP\Activity\IEvent;
+use OCP\Activity\IManager;
+use OCP\Activity\IProvider;
+use OCP\Comments\ICommentsManager;
+use OCP\IL10N;
+use OCP\IURLGenerator;
+use OCP\IUserManager;
+use OCP\L10N\IFactory;
+
+class Provider implements IProvider {
+	protected ?IL10N $l = null;
+
+	public function __construct(
+		protected IFactory $languageFactory,
+		protected IURLGenerator $url,
+		protected ICommentsManager $commentsManager,
+		protected IUserManager $userManager,
+		protected IManager $activityManager,
+	) {
+	}
+
+	/**
+	 * @param string $language
+	 * @param IEvent $event
+	 * @param IEvent|null $previousEvent
+	 * @return IEvent
+	 * @throws UnknownActivityException
+	 */
+	public function parse($language, IEvent $event, ?IEvent $previousEvent = null): IEvent {
+		if ($event->getApp() !== ActivityConstants::APP_ID) {
+			throw new UnknownActivityException();
+		}
+
+		$this->l = $this->languageFactory->get(ActivityConstants::APP_ID, $language);
+
+		if ($event->getSubject() === ActivityConstants::SUBJECT_IMPORT_FINISHED) {
+			//			$event->setParsedMessage($comment->getMessage())
+			//				->setRichMessage($message, $mentions);
+
+			$event->setIcon($this->url->getAbsoluteURL($this->url->imagePath(ActivityConstants::APP_ID, 'app-dark.svg')));
+
+			if ($this->activityManager->isFormattingFilteredObject()) {
+				try {
+					return $this->parseShortVersion($event);
+				} catch (UnknownActivityException) {
+					// Ignore and simply use the long version...
+				}
+			}
+
+			return $this->parseLongVersion($event);
+		}
+
+		throw new UnknownActivityException();
+	}
+
+	/**
+	 * @throws UnknownActivityException
+	 */
+	protected function parseShortVersion(IEvent $event): IEvent {
+		$subjectParameters = $this->getSubjectParameters($event);
+
+		if ($event->getSubject() === ActivityConstants::SUBJECT_IMPORT_FINISHED) {
+			$event->setRichSubject($this->l->t('You commented'), []);
+		} else {
+			throw new UnknownActivityException();
+		}
+
+		return $event;
+	}
+
+	/**
+	 * @throws UnknownActivityException
+	 */
+	protected function parseLongVersion(IEvent $event): IEvent {
+		$subjectParameters = $this->getSubjectParameters($event);
+
+		if ($event->getSubject() === ActivityConstants::SUBJECT_IMPORT_FINISHED) {
+			$event->setParsedSubject($this->l->t('You commented on %1$s', [
+				$subjectParameters['filePath'],
+			]))
+				->setRichSubject($this->l->t('You commented on {file}'), [
+					'file' => $this->generateFileParameter($subjectParameters['fileId'], $subjectParameters['filePath']),
+				]);
+		} else {
+			throw new UnknownActivityException();
+		}
+
+		return $event;
+	}
+
+	protected function getSubjectParameters(IEvent $event): array {
+		$subjectParameters = $event->getSubjectParameters();
+		if (isset($subjectParameters['fileId'])) {
+			return $subjectParameters;
+		}
+
+		return [
+			'actor' => $subjectParameters[0],
+			'fileId' => $event->getObjectId(),
+			'filePath' => trim($subjectParameters[1], '/'),
+		];
+	}
+
+	/**
+	 * @return array<string, string>
+	 */
+	protected function generateFileParameter(int $id, string $path): array {
+		return [
+			'type' => 'file',
+			'id' => (string)$id,
+			'name' => basename($path),
+			'path' => $path,
+			'link' => $this->url->linkToRouteAbsolute('files.viewcontroller.showFile', ['fileid' => $id]),
+		];
+	}
+}

lib/Activity/Setting.php

@@ -0,0 +1,53 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCA\Tables\Activity;
+
+use OCP\Activity\ActivitySettings;
+use OCP\IL10N;
+
+class Setting extends ActivitySettings {
+	public function __construct(
+		protected IL10N $l,
+	) {
+	}
+
+	public function getIdentifier(): string {
+		return ActivityConstants::TYPE_IMPORT_FINISHED;
+	}
+
+	public function getName(): string {
+		return $this->l->t('<strong>Import</strong> of a file has finished');
+	}
+
+	public function getGroupIdentifier() {
+		return ActivityConstants::APP_ID;
+	}
+
+	public function getGroupName() {
+		return $this->l->t('Tables');
+	}
+
+	public function getPriority(): int {
+		return 50;
+	}
+
+	public function canChangeStream(): bool {
+		return true;
+	}
+
+	public function isDefaultEnabledStream(): bool {
+		return true;
+	}
+
+	public function canChangeMail(): bool {
+		return true;
+	}
+
+	public function isDefaultEnabledMail(): bool {
+		return false;
+	}
+}

lib/BackgroundJob/ImportTableJob.php

@@ -0,0 +1,55 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Tables\BackgroundJob;
+
+use OCA\Tables\Activity\ActivityManager;
+use OCA\Tables\Service\ImportService;
+use OCP\AppFramework\Utility\ITimeFactory;
+use OCP\BackgroundJob\QueuedJob;
+use OCP\IUserManager;
+use OCP\IUserSession;
+
+class ImportTableJob extends QueuedJob {
+	public function __construct(
+		ITimeFactory $time,
+		private IUserManager $userManager,
+		private IUserSession $userSession,
+		private ImportService $importService,
+		private ActivityManager $activityManager,
+	) {
+		parent::__construct($time);
+	}
+
+	/**
+	 * @param array $argument
+	 */
+	public function run($argument): void {
+		$userId = $argument['user_id'];
+		$tableId = $argument['table_id'];
+		$viewId = $argument['view_id'];
+		$path = $argument['path'];
+		$createMissingColumns = $argument['create_missing_columns'] ?? false;
+		$columnsConfig = $argument['columns_config'] ?? null;
+
+		$oldUser = $this->userSession->getUser();
+		try {
+			$user = $this->userManager->get($userId);
+			$this->userSession->setUser($user);
+
+			//fixme: handle errors
+			$importStats = $this->importService
+				->import($userId, $tableId, $viewId, $path, $createMissingColumns, $columnsConfig);
+		} catch (\Throwable $e) {
+			throw $e;
+		} finally {
+			$this->userSession->setUser($oldUser);
+		}
+
+		$this->activityManager->notifyImportFinished($userId, $tableId, $importStats);
+	}
+}

lib/Controller/Api1Controller.php

@@ -1373,7 +1373,7 @@
 	public function importInTable(int $tableId, string $path, bool $createMissingColumns = true): DataResponse {
 		try {
 			// minimal permission is checked, creating columns requires MANAGE permissions - currently tested on service layer
-			return new DataResponse($this->importService->import($tableId, null, $path, $createMissingColumns));
+			return new DataResponse($this->importService->scheduleImport($tableId, null, $path, $createMissingColumns));
 		} catch (PermissionError $e) {
 			$this->logger->warning('A permission error occurred: ' . $e->getMessage(), ['exception' => $e]);
 			$message = ['message' => $e->getMessage()];
@@ -1408,7 +1408,7 @@
 	public function importInView(int $viewId, string $path, bool $createMissingColumns = true): DataResponse {
 		try {
 			// minimal permission is checked, creating columns requires MANAGE permissions - currently tested on service layer
-			return new DataResponse($this->importService->import(null, $viewId, $path, $createMissingColumns));
+			return new DataResponse($this->importService->scheduleImport(null, $viewId, $path, $createMissingColumns));
 		} catch (PermissionError $e) {
 			$this->logger->warning('A permission error occurred: ' . $e->getMessage(), ['exception' => $e]);
 			$message = ['message' => $e->getMessage()];