Add migration from the old to new metadata tables

Signed-off-by: Louis Chemineau <louis@chmn.me>

diff --git a/core/BackgroundJobs/MigrateMetadataJob.php b/core/BackgroundJobs/MigrateMetadataJob.php
new file mode 100644 (file)
index 0000000..4f1856c
--- /dev/null
+++ b/core/BackgroundJobs/MigrateMetadataJob.php
@@ -0,0 +1,107 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * @copyright Copyright (c) 2023 Louis Chemineau <louis@chmn.me>
+ *
+ * @author Louis Chemineau <louis@chmn.me>
+ *
+ * @license AGPL-3.0-or-later
+ *
+ * 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\BackgroundJobs;
+
+use OCP\AppFramework\Utility\ITimeFactory;
+use OCP\BackgroundJob\IJobList;
+use OCP\BackgroundJob\TimedJob;
+use OCP\FilesMetadata\IFilesMetadataManager;
+use OCP\IConfig;
+use OCP\IDBConnection;
+
+class MigrateMetadataJob extends TimedJob {
+       public function __construct(
+               ITimeFactory $time,
+               private IConfig $config,
+               private IFilesMetadataManager $filesMetadataManager,
+               private IDBConnection $connection,
+               private IJobList $jobList,
+       ) {
+               parent::__construct($time);
+
+               $this->setTimeSensitivity(\OCP\BackgroundJob\IJob::TIME_INSENSITIVE);
+               $this->setInterval(24 * 3600);
+       }
+
+       protected function run(mixed $argument): void {
+               if (!$this->connection->tableExists('file_metadata')) {
+                       return;
+               }
+
+               $startTime = time();
+
+               $selectQuery = $this->connection->getQueryBuilder()
+                       ->select('*')
+                       ->from('file_metadata')
+                       ->setMaxResults(200);
+
+               $deleteQuery = $this->connection->getQueryBuilder();
+               $deleteQuery->delete('file_metadata')
+                       ->where($deleteQuery->expr()->eq('id', $deleteQuery->createParameter('id')))
+                       ->where($deleteQuery->expr()->eq('group_name', $deleteQuery->createParameter('group_name')))
+                       ->where($deleteQuery->expr()->eq('value', $deleteQuery->createParameter('value')));
+
+               do {
+                       $this->connection->beginTransaction();
+
+                       $results = $selectQuery->executeQuery();
+
+                       while ($row = $results->fetch()) {
+                               $metadata = $this->filesMetadataManager->getMetadata($row['id'], true);
+
+                               switch ($row['group_name']) {
+                                       case 'size':
+                                               $metadata->setArray('photos-size', json_decode($row['value'], true));
+                                               break;
+                                       case 'gps':
+                                               $metadata->setArray('photos-gps', json_decode($row['value'], true));
+                                               break;
+                                       case 'photos_place':
+                                               $metadata->setString('photos-place', $row['value'], true);
+                                               break;
+                               }
+
+                               $this->filesMetadataManager->saveMetadata($metadata);
+                               $deleteQuery->setParameter('id', $row['id']);
+                               $deleteQuery->setParameter('group_name', $row['group_name']);
+                               $deleteQuery->setParameter('value', $row['value']);
+                               $deleteQuery->executeStatement();
+                       }
+
+                       $results->closeCursor();
+
+                       $this->connection->commit();
+
+                       // Stop if execution time is more than one hour.
+                       if (time() - $startTime > 60 * 60) {
+                               return;
+                       }
+               } while ($results->rowCount() !== 0);
+
+               $this->connection->dropTable('file_metadata');
+               $this->jobList->remove(MigrateMetadataJob::class);
+       }
+}

diff --git a/core/Migrations/Version28000Date20231004103301.php b/core/Migrations/Version28000Date20231004103301.php
index 8888bf51910422123efe0d5ce189d028ea393232..f1ce479d0faa5ae11a3a68b86d534473de437465 100644 (file)
--- a/core/Migrations/Version28000Date20231004103301.php
+++ b/core/Migrations/Version28000Date20231004103301.php
@@ -31,6 +31,7 @@ use OCP\DB\Types;
 use OCP\Migration\IOutput;
 use OCP\Migration\SimpleMigrationStep;
 
+// Create new tables for the Metadata API (files_metadata and files_metadata_index).
 class Version28000Date20231004103301 extends SimpleMigrationStep {
        public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
                /** @var ISchemaWrapper $schema */

diff --git a/lib/composer/composer/autoload_classmap.php b/lib/composer/composer/autoload_classmap.php
index 85fbe3d9151df7fe8881f03e9caf38a56945910a..390853250677bd219a8353839ec6b11a652d601e 100644 (file)
--- a/lib/composer/composer/autoload_classmap.php
+++ b/lib/composer/composer/autoload_classmap.php
@@ -1003,6 +1003,7 @@ return array(
     'OC\\Core\\BackgroundJobs\\CheckForUserCertificates' => $baseDir . '/core/BackgroundJobs/CheckForUserCertificates.php',
     'OC\\Core\\BackgroundJobs\\CleanupLoginFlowV2' => $baseDir . '/core/BackgroundJobs/CleanupLoginFlowV2.php',
     'OC\\Core\\BackgroundJobs\\LookupServerSendCheckBackgroundJob' => $baseDir . '/core/BackgroundJobs/LookupServerSendCheckBackgroundJob.php',
+    'OC\\Core\\BackgroundJobs\\MigrateMetadataJob' => $baseDir . '/core/BackgroundJobs/MigrateMetadataJob.php',
     'OC\\Core\\Command\\App\\Disable' => $baseDir . '/core/Command/App/Disable.php',
     'OC\\Core\\Command\\App\\Enable' => $baseDir . '/core/Command/App/Enable.php',
     'OC\\Core\\Command\\App\\GetPath' => $baseDir . '/core/Command/App/GetPath.php',
@@ -1602,6 +1603,7 @@ return array(
     'OC\\RepairException' => $baseDir . '/lib/private/RepairException.php',
     'OC\\Repair\\AddBruteForceCleanupJob' => $baseDir . '/lib/private/Repair/AddBruteForceCleanupJob.php',
     'OC\\Repair\\AddCleanupUpdaterBackupsJob' => $baseDir . '/lib/private/Repair/AddCleanupUpdaterBackupsJob.php',
+    'OC\\Repair\\AddMetadataMigrationJob' => $baseDir . '/lib/private/Repair/AddMetadataMigrationJob.php',
     'OC\\Repair\\AddRemoveOldTasksBackgroundJob' => $baseDir . '/lib/private/Repair/AddRemoveOldTasksBackgroundJob.php',
     'OC\\Repair\\CleanTags' => $baseDir . '/lib/private/Repair/CleanTags.php',
     'OC\\Repair\\CleanUpAbandonedApps' => $baseDir . '/lib/private/Repair/CleanUpAbandonedApps.php',

diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php
index 1881fd88eb3e9c208d7f66910fe7fac942f12192..498f4d8c0b13b2f29b17fd08887cab014d9e8b16 100644 (file)
--- a/lib/composer/composer/autoload_static.php
+++ b/lib/composer/composer/autoload_static.php
@@ -1036,6 +1036,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
         'OC\\Core\\BackgroundJobs\\CheckForUserCertificates' => __DIR__ . '/../../..' . '/core/BackgroundJobs/CheckForUserCertificates.php',
         'OC\\Core\\BackgroundJobs\\CleanupLoginFlowV2' => __DIR__ . '/../../..' . '/core/BackgroundJobs/CleanupLoginFlowV2.php',
         'OC\\Core\\BackgroundJobs\\LookupServerSendCheckBackgroundJob' => __DIR__ . '/../../..' . '/core/BackgroundJobs/LookupServerSendCheckBackgroundJob.php',
+        'OC\\Core\\BackgroundJobs\\MigrateMetadataJob' => __DIR__ . '/../../..' . '/core/BackgroundJobs/MigrateMetadataJob.php',
         'OC\\Core\\Command\\App\\Disable' => __DIR__ . '/../../..' . '/core/Command/App/Disable.php',
         'OC\\Core\\Command\\App\\Enable' => __DIR__ . '/../../..' . '/core/Command/App/Enable.php',
         'OC\\Core\\Command\\App\\GetPath' => __DIR__ . '/../../..' . '/core/Command/App/GetPath.php',
@@ -1635,6 +1636,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
         'OC\\RepairException' => __DIR__ . '/../../..' . '/lib/private/RepairException.php',
         'OC\\Repair\\AddBruteForceCleanupJob' => __DIR__ . '/../../..' . '/lib/private/Repair/AddBruteForceCleanupJob.php',
         'OC\\Repair\\AddCleanupUpdaterBackupsJob' => __DIR__ . '/../../..' . '/lib/private/Repair/AddCleanupUpdaterBackupsJob.php',
+        'OC\\Repair\\AddMetadataMigrationJob' => __DIR__ . '/../../..' . '/lib/private/Repair/AddMetadataMigrationJob.php',
         'OC\\Repair\\AddRemoveOldTasksBackgroundJob' => __DIR__ . '/../../..' . '/lib/private/Repair/AddRemoveOldTasksBackgroundJob.php',
         'OC\\Repair\\CleanTags' => __DIR__ . '/../../..' . '/lib/private/Repair/CleanTags.php',
         'OC\\Repair\\CleanUpAbandonedApps' => __DIR__ . '/../../..' . '/lib/private/Repair/CleanUpAbandonedApps.php',

diff --git a/lib/private/Repair.php b/lib/private/Repair.php
index 967d079d6db9300d06b69e653048c04ea8b96db7..e70c3f7e39d468e16214017284d43bf4047049c1 100644 (file)
--- a/lib/private/Repair.php
+++ b/lib/private/Repair.php
@@ -46,6 +46,7 @@ use OC\DB\Connection;
 use OC\DB\ConnectionAdapter;
 use OC\Repair\AddBruteForceCleanupJob;
 use OC\Repair\AddCleanupUpdaterBackupsJob;
+use OC\Repair\AddMetadataMigrationJob;
 use OC\Repair\CleanTags;
 use OC\Repair\ClearFrontendCaches;
 use OC\Repair\ClearGeneratedAvatarCache;
@@ -211,6 +212,7 @@ class Repair implements IOutput {
                        \OCP\Server::get(CleanUpAbandonedApps::class),
                        \OCP\Server::get(AddMissingSecretJob::class),
                        \OCP\Server::get(AddRemoveOldTasksBackgroundJob::class),
+                       \OCP\Server::get(AddMetadataMigrationJob::class),
                ];
        }
 

diff --git a/lib/private/Repair/AddMetadataMigrationJob.php b/lib/private/Repair/AddMetadataMigrationJob.php
new file mode 100644 (file)
index 0000000..f737687
--- /dev/null
+++ b/lib/private/Repair/AddMetadataMigrationJob.php
@@ -0,0 +1,43 @@
+<?php
+/**
+ * @copyright Copyright (c) 2018 Morris Jobke <hey@morrisjobke.de>
+ *
+ * @author Morris Jobke <hey@morrisjobke.de>
+ *
+ * @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\Repair;
+
+use OC\Core\BackgroundJobs\MigrateMetadataJob;
+use OCP\BackgroundJob\IJobList;
+use OCP\Migration\IOutput;
+use OCP\Migration\IRepairStep;
+
+class AddMetadataMigrationJob implements IRepairStep {
+       public function __construct(
+               private IJobList $jobList,
+       ) {
+       }
+
+       public function getName() {
+               return 'Queue a job to migrate legacy metadata tables';
+       }
+
+       public function run(IOutput $output) {
+               $this->jobList->add(MigrateMetadataJob::class);
+       }
+}