Add command to migrate local files to the database

Author: fguillot

Command/MigrateCommand.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace Kanboard\Plugin\DatabaseStorage\Command;
+
+use Kanboard\Console\BaseCommand;
+use Kanboard\Core\ObjectStorage\ObjectStorageException;
+use Kanboard\Plugin\DatabaseStorage\DatabaseObjectStorage;
+use RecursiveDirectoryIterator;
+use RecursiveIteratorIterator;
+use Symfony\Component\Console\Helper\Table;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class MigrateCommand extends BaseCommand
+{
+    protected function configure()
+    {
+        $this
+            ->setName('db-storage:migrate')
+            ->setDescription('Migrate local files to the database');
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        if (! file_exists(FILES_DIR)) {
+            $output->writeln('<error>Directory not found: '.FILES_DIR.'</error>');
+        } else {
+            $files = new RecursiveIteratorIterator(new RecursiveDirectoryIterator(FILES_DIR), RecursiveIteratorIterator::SELF_FIRST);
+            $storage = new DatabaseObjectStorage($this->container['db']);;
+
+            foreach($files as $file) {
+                if ($file->getFilename(){0} !== '.' && ! $file->isDir()) {
+                    $key = substr($file->getRealPath(), strlen(FILES_DIR) + 1);
+
+                    if (! $this->fileExists($storage, $key)) {
+                        $output->writeln('<info>Migrating '.$file->getFilename().'</info>');
+                        $blob = $this->readFile($file->getRealPath());
+                        $storage->put($key, $blob);
+                    }
+                }
+            }
+        }
+    }
+
+    protected function fileExists(DatabaseObjectStorage $storage, $key)
+    {
+        try {
+            $storage->get($key);
+            return true;
+        } catch (ObjectStorageException $e) {}
+
+        return false;
+    }
+
+    protected function readFile($filename)
+    {
+        $handle = fopen($filename, 'rb');
+        $contents = fread($handle, filesize($filename));
+        fclose($handle);
+        return $contents;
+    }
+}

Plugin.php

@@ -3,6 +3,7 @@
 namespace Kanboard\Plugin\DatabaseStorage;
 
 use Kanboard\Core\Plugin\Base;
+use Kanboard\Plugin\DatabaseStorage\Command\MigrateCommand;
 
 class Plugin extends Base
 {
@@ -11,6 +12,8 @@ public function initialize()
         $this->container['objectStorage'] = function() {
             return new DatabaseObjectStorage($this->db);
         };
+
+        $this->cli->add(new MigrateCommand($this->container));
     }
 
     public function getPluginName()
@@ -30,7 +33,7 @@ public function getPluginAuthor()
 
     public function getPluginVersion()
     {
-        return '1.0.0';
+        return '1.0.1';
     }
 
     public function getPluginHomepage()

README.md

@@ -28,6 +28,13 @@ The main benefit of doing this is to simplify backups.
 Everything is in a central location and nothing is stored on the frontend servers.
 PostgreSQL is preferred because streaming files is supported.
 
+Migrating old files to the database
+-----------------------------------
+
+```bash
+./cli db-storage:migrate
+```
+
 Notes
 -----