Merge pull request #2245 from nextcloud/backport/2244/stable28

[stable28] Request background job to generate metadata on non-local files
nextcloud · Jan 9, 2024 · 5d8b9d7 · 5d8b9d7
2 parents 218a0cf + 1e494c6
commit 5d8b9d7
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 3 deletions.
diff --git a/lib/AppInfo/Application.php b/lib/AppInfo/Application.php
@@ -91,8 +91,11 @@ public function register(IRegistrationContext $context): void {
 
 		// Metadata
 		$context->registerEventListener(MetadataLiveEvent::class, ExifMetadataProvider::class);
+		$context->registerEventListener(MetadataBackgroundEvent::class, ExifMetadataProvider::class);
 		$context->registerEventListener(MetadataLiveEvent::class, SizeMetadataProvider::class);
+		$context->registerEventListener(MetadataBackgroundEvent::class, SizeMetadataProvider::class);
 		$context->registerEventListener(MetadataLiveEvent::class, OriginalDateTimeMetadataProvider::class);
+		$context->registerEventListener(MetadataBackgroundEvent::class, OriginalDateTimeMetadataProvider::class);
 		$context->registerEventListener(MetadataLiveEvent::class, PlaceMetadataProvider::class);
 		$context->registerEventListener(MetadataBackgroundEvent::class, PlaceMetadataProvider::class);
 

diff --git a/lib/Listener/ExifMetadataProvider.php b/lib/Listener/ExifMetadataProvider.php
@@ -26,6 +26,7 @@
 use OCP\EventDispatcher\Event;
 use OCP\EventDispatcher\IEventListener;
 use OCP\Files\File;
+use OCP\FilesMetadata\Event\MetadataBackgroundEvent;
 use OCP\FilesMetadata\Event\MetadataLiveEvent;
 use Psr\Log\LoggerInterface;
 
@@ -42,7 +43,7 @@ public function __construct(
 	}
 
 	public function handle(Event $event): void {
-		if (!($event instanceof MetadataLiveEvent)) {
+		if (!($event instanceof MetadataLiveEvent) && !($event instanceof MetadataBackgroundEvent)) {
 			return;
 		}
 
@@ -52,6 +53,13 @@ public function handle(Event $event): void {
 			return;
 		}
 
+		// We need the file content to extract the EXIF data.
+		// This can be slow for remote storage, so we do it in a background job.
+		if (!$node->getStorage()->isLocal() && $event instanceof MetadataLiveEvent) {
+			$event->requestBackgroundJob();
+			return;
+		}
+
 		if (!in_array($node->getMimeType(), Application::IMAGE_MIMES)) {
 			return;
 		}

diff --git a/lib/Listener/OriginalDateTimeMetadataProvider.php b/lib/Listener/OriginalDateTimeMetadataProvider.php
@@ -27,6 +27,7 @@
 use OCP\EventDispatcher\Event;
 use OCP\EventDispatcher\IEventListener;
 use OCP\Files\File;
+use OCP\FilesMetadata\Event\MetadataBackgroundEvent;
 use OCP\FilesMetadata\Event\MetadataLiveEvent;
 use Psr\Log\LoggerInterface;
 
@@ -68,7 +69,7 @@ private function dateToTimestamp(string $format, string $date, File $node): int|
 	}
 
 	public function handle(Event $event): void {
-		if (!($event instanceof MetadataLiveEvent)) {
+		if (!($event instanceof MetadataLiveEvent) && !($event instanceof MetadataBackgroundEvent)) {
 			return;
 		}
 
@@ -78,6 +79,13 @@ public function handle(Event $event): void {
 			return;
 		}
 
+		// We need the file content to extract the EXIF data.
+		// This can be slow for remote storage, so we do it in a background job.
+		if (!$node->getStorage()->isLocal() && $event instanceof MetadataLiveEvent) {
+			$event->requestBackgroundJob();
+			return;
+		}
+
 		if (!in_array($node->getMimeType(), Application::IMAGE_MIMES) && !in_array($node->getMimeType(), Application::VIDEO_MIMES)) {
 			return;
 		}

diff --git a/lib/Listener/SizeMetadataProvider.php b/lib/Listener/SizeMetadataProvider.php
@@ -26,6 +26,7 @@
 use OCP\EventDispatcher\Event;
 use OCP\EventDispatcher\IEventListener;
 use OCP\Files\File;
+use OCP\FilesMetadata\Event\MetadataBackgroundEvent;
 use OCP\FilesMetadata\Event\MetadataLiveEvent;
 use Psr\Log\LoggerInterface;
 
@@ -39,7 +40,7 @@ public function __construct(
 	}
 
 	public function handle(Event $event): void {
-		if (!($event instanceof MetadataLiveEvent)) {
+		if (!($event instanceof MetadataLiveEvent) && !($event instanceof MetadataBackgroundEvent)) {
 			return;
 		}
 
@@ -49,6 +50,13 @@ public function handle(Event $event): void {
 			return;
 		}
 
+		// We need the file content to extract the size.
+		// This can be slow for remote storage, so we do it in a background job.
+		if (!$node->getStorage()->isLocal() && $event instanceof MetadataLiveEvent) {
+			$event->requestBackgroundJob();
+			return;
+		}
+
 		if (!in_array($node->getMimeType(), Application::IMAGE_MIMES)) {
 			return;
 		}