First commit

Author: fguillot

.gitignore

@@ -0,0 +1 @@
+*.zip

.travis.yml

@@ -0,0 +1,34 @@
+language: php
+sudo: false
+
+php:
+  - 7.0
+  - 5.6
+  - 5.5
+  - 5.4
+  - 5.3
+
+env:
+  global:
+    - PLUGIN=DatabaseStorage
+    - KANBOARD_REPO=https://github.com/fguillot/kanboard.git
+  matrix:
+    - DB=sqlite
+    - DB=mysql
+    - DB=postgres
+
+matrix:
+  fast_finish: true
+
+install:
+  - git clone --depth 1 $KANBOARD_REPO
+  - ln -s $TRAVIS_BUILD_DIR kanboard/plugins/$PLUGIN
+
+before_script:
+  - cd kanboard
+  - phpenv config-add tests/php.ini
+  - composer install
+  - ls -la plugins/
+
+script:
+  - phpunit -c tests/units.$DB.xml plugins/$PLUGIN/Test/

DatabaseObjectStorage.php

@@ -0,0 +1,135 @@
+<?php
+
+namespace Kanboard\Plugin\DatabaseStorage;
+
+use Kanboard\Core\ObjectStorage\ObjectStorageException;
+use Kanboard\Core\ObjectStorage\ObjectStorageInterface;
+use PicoDb\Database;
+
+/**
+ * Database Object Storage
+ *
+ * @package  DatabaseStorage
+ * @author   Frederic Guillot
+ */
+class DatabaseObjectStorage implements ObjectStorageInterface
+{
+    const TABLE = 'object_storage';
+
+    /**
+     * @var Database
+     */
+    protected $db;
+
+    /**
+     * Constructor
+     *
+     * @access public
+     */
+    public function __construct(Database $db)
+    {
+        $this->db = $db;
+    }
+
+    /**
+     * Fetch object contents
+     *
+     * @access public
+     * @throws ObjectStorageException
+     * @param  string  $key
+     * @return string
+     */
+    public function get($key)
+    {
+        $contents = $this->db
+            ->largeObject(self::TABLE)->eq('object_key', $key)
+            ->findOneColumnAsString('object_data');
+
+        if ($contents === false) {
+            throw new ObjectStorageException('Object not found: '.$key);
+        }
+
+        return $contents;
+    }
+
+    /**
+     * Save object
+     *
+     * @access public
+     * @throws ObjectStorageException
+     * @param  string  $key
+     * @param  string  $blob
+     */
+    public function put($key, &$blob)
+    {
+        $result = $this->db->largeObject(self::TABLE)
+            ->insertFromString('object_data', $blob, array('object_key' => $key));
+
+        if ($result === false) {
+            throw new ObjectStorageException('Unable to save object: '.$key);
+        }
+    }
+
+    /**
+     * Output directly object content
+     *
+     * @access public
+     * @param  string  $key
+     */
+    public function output($key)
+    {
+        $fd = $this->db->largeObject(self::TABLE)->eq('object_key', $key)->findOneColumnAsStream('object_data');
+
+        if (is_string($fd)) {
+            echo $fd;
+        } else {
+            fpassthru($fd);
+        }
+    }
+
+    /**
+     * Move local file to object storage
+     *
+     * @access public
+     * @throws ObjectStorageException
+     * @param  string  $src_filename
+     * @param  string  $key
+     * @return boolean
+     */
+    public function moveFile($src_filename, $key)
+    {
+        $result = $this->db->largeObject(self::TABLE)
+            ->insertFromFile('object_data', $src_filename, array('object_key' => $key));
+
+        if ($result === false) {
+            throw new ObjectStorageException('Unable to move this file: '.$src_filename);
+        }
+
+        return true;
+    }
+
+    /**
+     * Move uploaded file to object storage
+     *
+     * @access public
+     * @param  string  $filename
+     * @param  string  $key
+     * @return boolean
+     */
+    public function moveUploadedFile($filename, $key)
+    {
+        return $this->moveFile($filename, $key);
+    }
+
+    /**
+     * Remove object
+     *
+     * @access public
+     * @param  string  $key
+     * @return boolean
+     */
+    public function remove($key)
+    {
+        return $this->db->table(self::TABLE)->eq('object_key', $key)->remove();
+    }
+}

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Frédéric Guillot
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

Makefile

@@ -0,0 +1,3 @@
+all:
+	@ echo "Build archive for plugin ${plugin} version=${version}"
+	@ git archive HEAD --prefix=${plugin}/ --format=zip -o ${plugin}-${version}.zip

Plugin.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace Kanboard\Plugin\DatabaseStorage;
+
+use Kanboard\Core\Plugin\Base;
+
+class Plugin extends Base
+{
+    public function initialize()
+    {
+        $this->container['objectStorage'] = function() {
+            return new DatabaseObjectStorage($this->db);
+        };
+    }
+
+    public function getPluginName()
+    {
+        return 'Database Storage';
+    }
+
+    public function getPluginDescription()
+    {
+        return 'Use the database to store attachments';
+    }
+
+    public function getPluginAuthor()
+    {
+        return 'Frédéric Guillot';
+    }
+
+    public function getPluginVersion()
+    {
+        return '1.0.0';
+    }
+
+    public function getPluginHomepage()
+    {
+        return 'https://github.com/kanboard/plugin-database-storage';
+    }
+}

README.md

@@ -0,0 +1,24 @@
+Database Object Storage
+=======================
+
+[![Build Status](https://travis-ci.org/kanboard/plugin-database-storage.svg?branch=master)](https://travis-ci.org/kanboard/plugin-database-storage)
+
+This plugin stores uploaded files into the database instead of using the local filesystem.
+
+Author
+------
+
+- Frederic Guillot
+- License MIT
+
+Requirements
+------------
+
+- Postgres is recommended
+
+Notes
+-----
+
+- Obviously the database size will increase if you store large files
+- Run the command `VACUUM` to free up disk space used by removed files
+- With Mysql, you may need to change the value of `max_allowed_packet`, the default is 1MB

Schema/Mysql.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Kanboard\Plugin\DatabaseStorage\Schema;
+
+use PDO;
+
+const VERSION = 1;
+
+function version_1(PDO $pdo)
+{
+    $pdo->exec('CREATE TABLE IF NOT EXISTS `object_storage` (
+        `object_key` VARCHAR(255) NOT NULL,
+        `object_data` LONGBLOB NOT NULL,
+        PRIMARY KEY (`object_key`)
+      ) ENGINE=InnoDB
+    ');
+}

Schema/Postgres.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Kanboard\Plugin\DatabaseStorage\Schema;
+
+use PDO;
+
+const VERSION = 1;
+
+function version_1(PDO $pdo)
+{
+    $pdo->exec('CREATE TABLE IF NOT EXISTS object_storage (
+        "object_key" VARCHAR(255) PRIMARY KEY,
+        "object_data" BYTEA NOT NULL
+    )');
+}

Schema/Sqlite.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Kanboard\Plugin\DatabaseStorage\Schema;
+
+use PDO;
+
+const VERSION = 1;
+
+function version_1(PDO $pdo)
+{
+    $pdo->exec('CREATE TABLE IF NOT EXISTS object_storage (
+        "object_key" VARCHAR(255) PRIMARY KEY,
+        "object_data" BYTEA NOT NULL
+    )');
+}