diff options
author | Hugues Hiegel <root@paranoid> | 2015-04-21 12:49:44 +0200 |
---|---|---|
committer | Hugues Hiegel <root@paranoid> | 2015-04-21 12:49:44 +0200 |
commit | 733f8e8d0ce6217d906d06dc4fb08e36d48ed794 (patch) | |
tree | cff28366ff63ea6596f8026e1698090bd0b9405c /plugins/database_attachments | |
parent | ef2e7b3f9d264ec146d4dae257b1e295ab3b462a (diff) | |
parent | a4ba3df54834ee90fb2c9930669f1229dc80261a (diff) |
Conflicts:
composer.json-dist
config/defaults.inc.php
plugins
plugins/acl/acl.js
plugins/acl/acl.php
plugins/acl/skins/classic/templates/table.html
plugins/acl/skins/larry/templates/table.html
plugins/enigma/README
plugins/enigma/config.inc.php.dist
plugins/enigma/enigma.js
plugins/enigma/enigma.php
plugins/enigma/lib/enigma_driver.php
plugins/enigma/lib/enigma_driver_gnupg.php
plugins/enigma/lib/enigma_driver_phpssl.php
plugins/enigma/lib/enigma_engine.php
plugins/enigma/lib/enigma_error.php
plugins/enigma/lib/enigma_key.php
plugins/enigma/lib/enigma_signature.php
plugins/enigma/lib/enigma_subkey.php
plugins/enigma/lib/enigma_ui.php
plugins/enigma/lib/enigma_userid.php
plugins/enigma/localization/en_US.inc
plugins/enigma/localization/ja_JP.inc
plugins/enigma/localization/ru_RU.inc
plugins/enigma/skins/classic/enigma.css
plugins/enigma/skins/classic/templates/keys.html
plugins/help/config.inc.php.dist
plugins/help/help.php
plugins/help/localization/en_US.inc
plugins/jqueryui/jqueryui.php
plugins/managesieve/Changelog
plugins/managesieve/composer.json
plugins/managesieve/config.inc.php.dist
plugins/managesieve/lib/Roundcube/rcube_sieve.php
plugins/managesieve/lib/Roundcube/rcube_sieve_engine.php
plugins/managesieve/lib/Roundcube/rcube_sieve_vacation.php
plugins/managesieve/localization/en_US.inc
plugins/managesieve/managesieve.js
plugins/managesieve/skins/classic/managesieve.css
plugins/managesieve/skins/larry/managesieve.css
plugins/password/README
plugins/password/config.inc.php.dist
plugins/password/drivers/ldap.php
plugins/password/drivers/poppassd.php
plugins/password/drivers/vpopmaild.php
plugins/vcard_attachments/vcardattach.js
plugins/zipdownload/zipdownload.php
Diffstat (limited to 'plugins/database_attachments')
-rw-r--r-- | plugins/database_attachments/composer.json | 30 | ||||
-rw-r--r-- | plugins/database_attachments/config.inc.php.dist | 12 | ||||
-rw-r--r-- | plugins/database_attachments/database_attachments.php | 163 | ||||
-rw-r--r-- | plugins/database_attachments/tests/DatabaseAttachments.php | 23 |
4 files changed, 228 insertions, 0 deletions
diff --git a/plugins/database_attachments/composer.json b/plugins/database_attachments/composer.json new file mode 100644 index 000000000..d0df987eb --- /dev/null +++ b/plugins/database_attachments/composer.json @@ -0,0 +1,30 @@ +{ + "name": "roundcube/database_attachments", + "type": "roundcube-plugin", + "description": "This plugin which provides database backed storage for temporary attachment file handling. The primary advantage of this plugin is its compatibility with round-robin dns multi-server Roundcube installations.", + "license": "GPLv2", + "version": "1.1", + "authors": [ + { + "name": "Aleksander Machniak", + "email": "alec@alec.pl", + "role": "Lead" + }, + { + "name": "Ziba Scott", + "email": "ziba@umich.edu", + "role": "Developer" + } + ], + "repositories": [ + { + "type": "composer", + "url": "http://plugins.roundcube.net" + } + ], + "require": { + "php": ">=5.3.0", + "roundcube/plugin-installer": ">=0.1.3", + "roundcube/filesystem_attachments": ">=1.0.0" + } +} diff --git a/plugins/database_attachments/config.inc.php.dist b/plugins/database_attachments/config.inc.php.dist new file mode 100644 index 000000000..c371cbbb7 --- /dev/null +++ b/plugins/database_attachments/config.inc.php.dist @@ -0,0 +1,12 @@ +<?php + +// By default this plugin stores attachments in filesystem +// and copies them into sql database. +// You can change it to use 'memcache' or 'apc'. +$config['database_attachments_cache'] = 'db'; + +// Attachment data expires after specied TTL time in seconds (max.2592000). +// Default is 12 hours. +$config['database_attachments_cache_ttl'] = 12 * 60 * 60; + +?> diff --git a/plugins/database_attachments/database_attachments.php b/plugins/database_attachments/database_attachments.php new file mode 100644 index 000000000..e4abf937e --- /dev/null +++ b/plugins/database_attachments/database_attachments.php @@ -0,0 +1,163 @@ +<?php +/** + * Database Attachments + * + * This plugin which provides database backed storage for temporary + * attachment file handling. The primary advantage of this plugin + * is its compatibility with round-robin dns multi-server roundcube + * installations. + * + * This plugin relies on the core filesystem_attachments plugin + * + * @author Ziba Scott <ziba@umich.edu> + * @author Aleksander Machniak <alec@alec.pl> + * @version @package_version@ + */ + +require_once INSTALL_PATH . 'plugins/filesystem_attachments/filesystem_attachments.php'; + +class database_attachments extends filesystem_attachments +{ + // Cache object + protected $cache; + + // A prefix for the cache key used in the session and in the key field of the cache table + protected $prefix = "db_attach"; + + /** + * Save a newly uploaded attachment + */ + function upload($args) + { + $args['status'] = false; + + $cache = $this->get_cache(); + $key = $this->_key($args); + $data = file_get_contents($args['path']); + + if ($data === false) { + return $args; + } + + $data = base64_encode($data); + $status = $cache->write($key, $data); + + if ($status) { + $args['id'] = $key; + $args['status'] = true; + unset($args['path']); + } + + return $args; + } + + /** + * Save an attachment from a non-upload source (draft or forward) + */ + function save($args) + { + $args['status'] = false; + + $cache = $this->get_cache(); + $key = $this->_key($args); + + if ($args['path']) { + $args['data'] = file_get_contents($args['path']); + + if ($args['data'] === false) { + return $args; + } + } + + $data = base64_encode($args['data']); + $status = $cache->write($key, $data); + + if ($status) { + $args['id'] = $key; + $args['status'] = true; + } + + return $args; + } + + /** + * Remove an attachment from storage + * This is triggered by the remove attachment button on the compose screen + */ + function remove($args) + { + $cache = $this->get_cache(); + $status = $cache->remove($args['id']); + + $args['status'] = true; + + return $args; + } + + /** + * When composing an html message, image attachments may be shown + * For this plugin, $this->get() will check the file and + * return it's contents + */ + function display($args) + { + return $this->get($args); + } + + /** + * When displaying or sending the attachment the file contents are fetched + * using this method. This is also called by the attachment_display hook. + */ + function get($args) + { + $cache = $this->get_cache(); + $data = $cache->read($args['id']); + + if ($data) { + $args['data'] = base64_decode($data); + $args['status'] = true; + } + + return $args; + } + + /** + * Delete all temp files associated with this user + */ + function cleanup($args) + { + // check if cache object exist, it may be empty on session_destroy (#1489726) + if ($cache = $this->get_cache()) { + $cache->remove($args['group'], true); + } + } + + /** + * Helper method to generate a unique key for the given attachment file + */ + protected function _key($args) + { + $uname = $args['path'] ? $args['path'] : $args['name']; + return $args['group'] . md5(mktime() . $uname . $_SESSION['user_id']); + } + + /** + * Initialize and return cache object + */ + protected function get_cache() + { + if (!$this->cache) { + $this->load_config(); + + $rcmail = rcube::get_instance(); + $ttl = 12 * 60 * 60; // default: 12 hours + $ttl = $rcmail->config->get('database_attachments_cache_ttl', $ttl); + $type = $rcmail->config->get('database_attachments_cache', 'db'); + + // Init SQL cache (disable cache data serialization) + $this->cache = $rcmail->get_cache($this->prefix, 'db', $ttl, false); + } + + return $this->cache; + } +} diff --git a/plugins/database_attachments/tests/DatabaseAttachments.php b/plugins/database_attachments/tests/DatabaseAttachments.php new file mode 100644 index 000000000..15ea5f44e --- /dev/null +++ b/plugins/database_attachments/tests/DatabaseAttachments.php @@ -0,0 +1,23 @@ +<?php + +class DatabaseAttachments_Plugin extends PHPUnit_Framework_TestCase +{ + + function setUp() + { + include_once __DIR__ . '/../database_attachments.php'; + } + + /** + * Plugin object construction test + */ + function test_constructor() + { + $rcube = rcube::get_instance(); + $plugin = new database_attachments($rcube->api); + + $this->assertInstanceOf('database_attachments', $plugin); + $this->assertInstanceOf('rcube_plugin', $plugin); + } +} + |