IFilesMetadata

Signed-off-by: Maxence Lange <maxence@artificial-owl.com>

3 files changed, 204 insertions, 0 deletions

diff --git a/core/Command/FilesMetadata/Get.php b/core/Command/FilesMetadata/Get.php
new file mode 100644
index 00000000000..aebabe63e35
--- /dev/null
+++ b/core/Command/FilesMetadata/Get.php
@@ -0,0 +1,119 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2023 Maxence Lange <maxence@artificial-owl.com>
+ *
+ * @author Maxence Lange <maxence@artificial-owl.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OC\Core\Command\FilesMetadata;
+
+use OC\User\NoUserException;
+use OCP\Files\IRootFolder;
+use OCP\Files\NotFoundException;
+use OCP\Files\NotPermittedException;
+use OCP\FilesMetadata\Exceptions\FilesMetadataNotFoundException;
+use OCP\FilesMetadata\IFilesMetadataManager;
+use Symfony\Component\Console\Command\Command;
+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 Get extends Command {
+	public function __construct(
+		private IRootFolder $rootFolder,
+		private IFilesMetadataManager $filesMetadataManager,
+	) {
+		parent::__construct();
+	}
+
+	protected function configure(): void {
+		$this->setName('metadata:get')
+			 ->setDescription('get stored metadata about a file, by its id')
+			 ->addArgument(
+			 	'fileId',
+			 	InputArgument::REQUIRED,
+			 	'id of the file document'
+			 )
+			 ->addArgument(
+			 	'userId',
+			 	InputArgument::OPTIONAL,
+			 	'file owner'
+			 )
+			 ->addOption(
+			 	'as-array',
+			 	'',
+			 	InputOption::VALUE_NONE,
+			 	'display metadata as a simple key=>value array'
+			 )
+			 ->addOption(
+			 	'refresh',
+			 	'',
+			 	InputOption::VALUE_NONE,
+			 	'refresh metadata'
+			 )
+			 ->addOption(
+			 	'reset',
+			 	'',
+			 	InputOption::VALUE_NONE,
+			 	'refresh metadata from scratch'
+			 );
+	}
+
+	/**
+	 * @throws NotPermittedException
+	 * @throws FilesMetadataNotFoundException
+	 * @throws NoUserException
+	 * @throws NotFoundException
+	 */
+	protected function execute(InputInterface $input, OutputInterface $output): int {
+		$fileId = (int)$input->getArgument('fileId');
+
+		if ($input->getOption('reset')) {
+			$this->filesMetadataManager->deleteMetadata($fileId);
+			if (!$input->getOption('refresh')) {
+				return 0;
+			}
+		}
+
+		if ($input->getOption('refresh')) {
+			$node = $this->rootFolder->getUserFolder($input->getArgument('userId'))->getById($fileId);
+			if (count($node) === 0) {
+				throw new NotFoundException();
+			}
+			$metadata = $this->filesMetadataManager->refreshMetadata(
+				$node[0],
+				IFilesMetadataManager::PROCESS_LIVE | IFilesMetadataManager::PROCESS_BACKGROUND
+			);
+		} else {
+			$metadata = $this->filesMetadataManager->getMetadata($fileId);
+		}
+
+		if ($input->getOption('as-array')) {
+			$output->writeln(json_encode($metadata->asArray(), JSON_PRETTY_PRINT));
+		} else {
+			$output->writeln(json_encode($metadata, JSON_PRETTY_PRINT));
+		}
+
+		return 0;
+	}
+}
diff --git a/core/Migrations/Version28000Date20231004103301.php b/core/Migrations/Version28000Date20231004103301.php
new file mode 100644
index 00000000000..3266bf3a440
--- /dev/null
+++ b/core/Migrations/Version28000Date20231004103301.php
@@ -0,0 +1,83 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * @copyright 2023 Maxence Lange <maxence@artificial-owl.com>
+ *
+ * @author Maxence Lange <maxence@artificial-owl.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OC\Core\Migrations;
+
+use Closure;
+use OCP\DB\ISchemaWrapper;
+use OCP\DB\Types;
+use OCP\Migration\IOutput;
+use OCP\Migration\SimpleMigrationStep;
+
+class Version28000Date20231004103301 extends SimpleMigrationStep {
+	public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
+		/** @var ISchemaWrapper $schema */
+		$schema = $schemaClosure();
+		$updated = false;
+
+		if (!$schema->hasTable('files_metadata')) {
+			$table = $schema->createTable('files_metadata');
+			$table->addColumn('id', Types::BIGINT, [
+				'autoincrement' => true,
+				'notnull' => true,
+				'length' => 15,
+				'unsigned' => true,
+			]);
+			$table->addColumn('file_id', Types::BIGINT, ['notnull' => false, 'length' => 15,]);
+			$table->addColumn('json', Types::TEXT);
+			$table->addColumn('sync_token', Types::STRING, ['length' => 15]);
+			$table->addColumn('last_update', Types::DATETIME);
+
+			$table->setPrimaryKey(['id']);
+			$table->addUniqueIndex(['file_id'], 'files_meta_fileid');
+			$updated = true;
+		}
+
+		if (!$schema->hasTable('files_metadata_index')) {
+			$table = $schema->createTable('files_metadata_index');
+			$table->addColumn('id', Types::BIGINT, [
+				'autoincrement' => true,
+				'notnull' => true,
+				'length' => 15,
+				'unsigned' => true,
+			]);
+			$table->addColumn('file_id', Types::BIGINT, ['notnull' => false, 'length' => 15]);
+			$table->addColumn('meta_key', Types::STRING, ['notnull' => false, 'length' => 31]);
+			$table->addColumn('meta_value_string', Types::STRING, ['notnull' => false, 'length' => 63]);
+			$table->addColumn('meta_value_int', Types::BIGINT, ['notnull' => false, 'length' => 11]);
+
+			$table->setPrimaryKey(['id']);
+			$table->addIndex(['file_id', 'meta_key', 'meta_value_string'], 'f_meta_index');
+			$table->addIndex(['file_id', 'meta_key', 'meta_value_int'], 'f_meta_index_i');
+			$updated = true;
+		}
+
+		if (!$updated) {
+			return null;
+		}
+
+		return $schema;
+	}
+}
diff --git a/core/register_command.php b/core/register_command.php
index 975dcf6c05f..27863cfdc8d 100644
--- a/core/register_command.php
+++ b/core/register_command.php
@@ -19,6 +19,7 @@ declare(strict_types=1);
  * @author Jörn Friedrich Dreyer <jfd@butonic.de>
  * @author Julius Härtl <jus@bitgrid.net>
  * @author Lukas Reschke <lukas@statuscode.ch>
+ * @author Maxence Lange <maxence@artificial-owl.com>
  * @author michag86 <micha_g@arcor.de>
  * @author Morris Jobke <hey@morrisjobke.de>
  * @author Patrik Kernstock <info@pkern.at>
@@ -215,6 +216,7 @@ if (\OC::$server->getConfig()->getSystemValue('installed', false)) {
 	$application->add(\OC::$server->get(\OC\Core\Command\Security\BruteforceAttempts::class));
 	$application->add(\OC::$server->get(\OC\Core\Command\Security\BruteforceResetAttempts::class));
 	$application->add(\OC::$server->get(\OC\Core\Command\SetupChecks::class));
+	$application->add(\OCP\Server::get(\OC\Core\Command\FilesMetadata\Get::class));
 } else {
 	$application->add(\OC::$server->get(\OC\Core\Command\Maintenance\Install::class));
 }