feat: add command to get object metadata

Signed-off-by: Robin Appelman <robin@icewind.nl>

apps/files/appinfo/info.xml

@@ -49,6 +49,7 @@
 		<command>OCA\Files\Command\Object\Delete</command>
 		<command>OCA\Files\Command\Object\Get</command>
 		<command>OCA\Files\Command\Object\Put</command>
+		<command>OCA\Files\Command\Object\Info</command>
 	</commands>
 
 	<settings>

apps/files/composer/composer/autoload_classmap.php

@@ -35,6 +35,7 @@ return array(
     'OCA\\Files\\Command\\Move' => $baseDir . '/../lib/Command/Move.php',
     'OCA\\Files\\Command\\Object\\Delete' => $baseDir . '/../lib/Command/Object/Delete.php',
     'OCA\\Files\\Command\\Object\\Get' => $baseDir . '/../lib/Command/Object/Get.php',
+    'OCA\\Files\\Command\\Object\\Info' => $baseDir . '/../lib/Command/Object/Info.php',
     'OCA\\Files\\Command\\Object\\ObjectUtil' => $baseDir . '/../lib/Command/Object/ObjectUtil.php',
     'OCA\\Files\\Command\\Object\\Put' => $baseDir . '/../lib/Command/Object/Put.php',
     'OCA\\Files\\Command\\Put' => $baseDir . '/../lib/Command/Put.php',

apps/files/composer/composer/autoload_static.php

@@ -50,6 +50,7 @@ class ComposerStaticInitFiles
         'OCA\\Files\\Command\\Move' => __DIR__ . '/..' . '/../lib/Command/Move.php',
         'OCA\\Files\\Command\\Object\\Delete' => __DIR__ . '/..' . '/../lib/Command/Object/Delete.php',
         'OCA\\Files\\Command\\Object\\Get' => __DIR__ . '/..' . '/../lib/Command/Object/Get.php',
+        'OCA\\Files\\Command\\Object\\Info' => __DIR__ . '/..' . '/../lib/Command/Object/Info.php',
         'OCA\\Files\\Command\\Object\\ObjectUtil' => __DIR__ . '/..' . '/../lib/Command/Object/ObjectUtil.php',
         'OCA\\Files\\Command\\Object\\Put' => __DIR__ . '/..' . '/../lib/Command/Object/Put.php',
         'OCA\\Files\\Command\\Put' => __DIR__ . '/..' . '/../lib/Command/Put.php',

apps/files/lib/Command/Object/Info.php

@@ -0,0 +1,79 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Files\Command\Object;
+
+use OC\Core\Command\Base;
+use OCP\Files\IMimeTypeDetector;
+use OCP\Files\ObjectStore\IObjectStoreMetaData;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class Info extends Base {
+	public function __construct(
+		private ObjectUtil $objectUtils,
+		private IMimeTypeDetector $mimeTypeDetector,
+	) {
+		parent::__construct();
+	}
+
+	protected function configure(): void {
+		parent::configure();
+		$this
+			->setName('files:object:info')
+			->setDescription('Get the metadata of an object')
+			->addArgument('object', InputArgument::REQUIRED, 'Object to get')
+			->addOption('bucket', 'b', InputOption::VALUE_REQUIRED, "Bucket to get the object from, only required in cases where it can't be determined from the config");
+	}
+
+	public function execute(InputInterface $input, OutputInterface $output): int {
+		$object = $input->getArgument('object');
+		$objectStore = $this->objectUtils->getObjectStore($input->getOption('bucket'), $output);
+		if (!$objectStore) {
+			return self::FAILURE;
+		}
+
+		if (!$objectStore instanceof IObjectStoreMetaData) {
+			$output->writeln('<error>Configured object store does currently not support retrieve metadata</error>');
+			return self::FAILURE;
+		}
+
+		if (!$objectStore->objectExists($object)) {
+			$output->writeln("<error>Object $object does not exist</error>");
+			return self::FAILURE;
+		}
+
+		try {
+			$meta = $objectStore->getObjectMetaData($object);
+		} catch (\Exception $e) {
+			$msg = $e->getMessage();
+			$output->writeln("<error>Failed to read $object from object store: $msg</error>");
+			return self::FAILURE;
+		}
+
+		if ($input->getOption('output') === 'plain' && isset($meta['size'])) {
+			$meta['size'] = \OC_Helper::humanFileSize($meta['size']);
+		}
+		if (isset($meta['mtime'])) {
+			$meta['mtime'] = $meta['mtime']->format(\DateTimeImmutable::ATOM);
+		}
+		if (!isset($meta['mimetype'])) {
+			$handle = $objectStore->readObject($object);
+			$head = fread($handle, 8192);
+			fclose($handle);
+			$meta['mimetype'] = $this->mimeTypeDetector->detectString($head);
+		}
+
+		$this->writeArrayInOutputFormat($input, $output, $meta);
+
+		return self::SUCCESS;
+	}
+
+}

lib/composer/composer/autoload_classmap.php

@@ -456,6 +456,7 @@ return array(
     'OCP\\Files\\Notify\\INotifyHandler' => $baseDir . '/lib/public/Files/Notify/INotifyHandler.php',
     'OCP\\Files\\Notify\\IRenameChange' => $baseDir . '/lib/public/Files/Notify/IRenameChange.php',
     'OCP\\Files\\ObjectStore\\IObjectStore' => $baseDir . '/lib/public/Files/ObjectStore/IObjectStore.php',
+    'OCP\\Files\\ObjectStore\\IObjectStoreMetaData' => $baseDir . '/lib/public/Files/ObjectStore/IObjectStoreMetaData.php',
     'OCP\\Files\\ObjectStore\\IObjectStoreMultiPartUpload' => $baseDir . '/lib/public/Files/ObjectStore/IObjectStoreMultiPartUpload.php',
     'OCP\\Files\\ReservedWordException' => $baseDir . '/lib/public/Files/ReservedWordException.php',
     'OCP\\Files\\Search\\ISearchBinaryOperator' => $baseDir . '/lib/public/Files/Search/ISearchBinaryOperator.php',

lib/composer/composer/autoload_static.php

@@ -505,6 +505,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
         'OCP\\Files\\Notify\\INotifyHandler' => __DIR__ . '/../../..' . '/lib/public/Files/Notify/INotifyHandler.php',
         'OCP\\Files\\Notify\\IRenameChange' => __DIR__ . '/../../..' . '/lib/public/Files/Notify/IRenameChange.php',
         'OCP\\Files\\ObjectStore\\IObjectStore' => __DIR__ . '/../../..' . '/lib/public/Files/ObjectStore/IObjectStore.php',
+        'OCP\\Files\\ObjectStore\\IObjectStoreMetaData' => __DIR__ . '/../../..' . '/lib/public/Files/ObjectStore/IObjectStoreMetaData.php',
         'OCP\\Files\\ObjectStore\\IObjectStoreMultiPartUpload' => __DIR__ . '/../../..' . '/lib/public/Files/ObjectStore/IObjectStoreMultiPartUpload.php',
         'OCP\\Files\\ReservedWordException' => __DIR__ . '/../../..' . '/lib/public/Files/ReservedWordException.php',
         'OCP\\Files\\Search\\ISearchBinaryOperator' => __DIR__ . '/../../..' . '/lib/public/Files/Search/ISearchBinaryOperator.php',

lib/private/Files/ObjectStore/S3.php

@@ -3,14 +3,16 @@
  * SPDX-FileCopyrightText: 2016 Nextcloud GmbH and Nextcloud contributors
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
+
 namespace OC\Files\ObjectStore;
 
 use Aws\Result;
 use Exception;
 use OCP\Files\ObjectStore\IObjectStore;
+use OCP\Files\ObjectStore\IObjectStoreMetaData;
 use OCP\Files\ObjectStore\IObjectStoreMultiPartUpload;
 
-class S3 implements IObjectStore, IObjectStoreMultiPartUpload {
+class S3 implements IObjectStore, IObjectStoreMultiPartUpload, IObjectStoreMetaData {
 	use S3ConnectionTrait;
 	use S3ObjectTrait;
 
@@ -61,7 +63,7 @@ class S3 implements IObjectStore, IObjectStoreMultiPartUpload {
 				'Key' => $urn,
 				'UploadId' => $uploadId,
 				'MaxParts' => 1000,
-				'PartNumberMarker' => $partNumberMarker
+				'PartNumberMarker' => $partNumberMarker,
 			] + $this->getSSECParameters());
 			$parts = array_merge($parts, $result->get('Parts') ?? []);
 			$isTruncated = $result->get('IsTruncated');
@@ -89,7 +91,41 @@ class S3 implements IObjectStore, IObjectStoreMultiPartUpload {
 		$this->getConnection()->abortMultipartUpload([
 			'Bucket' => $this->bucket,
 			'Key' => $urn,
-			'UploadId' => $uploadId
+			'UploadId' => $uploadId,
 		]);
 	}
+
+	public function getObjectMetaData(string $urn): array {
+		$object = $this->getConnection()->headObject([
+			'Bucket' => $this->bucket,
+			'Key' => $urn
+		] + $this->getSSECParameters())->toArray();
+		return [
+			'mtime' => $object['LastModified'],
+			'etag' => trim($object['ETag'], '"'),
+			'size' => (int)($object['Size'] ?? $object['ContentLength']),
+		];
+	}
+
+	public function listObjects(string $prefix = ''): \Iterator {
+		$results = $this->getConnection()->getPaginator('ListObjectsV2', [
+			'Bucket' => $this->bucket,
+			'Prefix' => $prefix,
+		] + $this->getSSECParameters());
+
+		foreach ($results as $result) {
+			if (is_array($result['Contents'])) {
+				foreach ($result['Contents'] as $object) {
+					yield [
+						'urn' => basename($object['Key']),
+						'meta' => [
+							'mtime' => strtotime($object['LastModified']),
+							'etag' => trim($object['ETag'], '"'),
+							'size' => (int)($object['Size'] ?? $object['ContentLength']),
+						],
+					];
+				}
+			}
+		}
+	}
 }

lib/public/Files/ObjectStore/IObjectStoreMetaData.php

@@ -0,0 +1,36 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+namespace OCP\Files\ObjectStore;
+
+/**
+ * Interface IObjectStoreMetaData
+ *
+ * @psalm-type ObjectMetaData = array{mtime?: \DateTime, etag?: string, size?: int, mimetype?: string, filename?: string}
+ *
+ * @since 32.0.0
+ */
+interface IObjectStoreMetaData {
+	/**
+	 * Get metadata for an object.
+	 *
+	 * @param string $urn
+	 * @return ObjectMetaData
+	 *
+	 * @since 32.0.0
+	 */
+	public function getObjectMetaData(string $urn): array;
+
+	/**
+	 * List all objects in the object store.
+	 *
+	 * If the object store implementation can do it efficiently, the metadata for each object is also included.
+	 *
+	 * @param string $prefix
+	 * @return \Iterator<array{urn: string, meta: ?ObjectMetaData}>
+	 */
+	public function listObjects(string $prefix = ''): \Iterator;
+}