Merged branch devel-api (from r2208 to r2387) back into trunk (omitting some sample plugins)

1 files changed, 152 insertions, 0 deletions

diff --git a/plugins/database_attachments/database_attachments.php b/plugins/database_attachments/database_attachments.php
new file mode 100644
index 000000000..28ccde4b3
--- /dev/null
+++ b/plugins/database_attachments/database_attachments.php
@@ -0,0 +1,152 @@
+<?php
+/**
+ * Filesystem 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>
+ * 
+ */
+require_once('plugins/filesystem_attachments/filesystem_attachments.php');
+class database_attachments extends filesystem_attachments
+{
+
+    // A prefix for the cache key used in the session and in the key field of the cache table
+    private $cache_prefix = "db_attach";
+
+    /**
+     * Helper method to generate a unique key for the given attachment file
+     */
+    private function _key($filepath)
+    {
+        return  $this->cache_prefix.md5(mktime().$filepath.$_SESSION['user_id']); 
+    }
+
+    /**
+     * Save a newly uploaded attachment
+     */
+    function upload($args)
+    {
+        $args['status'] = false;
+        $rcmail = rcmail::get_instance();
+        $key = $this->_key($args['path']);
+        $data = base64_encode(file_get_contents($args['path']));
+
+        $status = $rcmail->db->query(
+            "INSERT INTO ".get_table_name('cache')."
+             (created, user_id, cache_key, data)
+             VALUES (".$rcmail->db->now().", ?, ?, ?)",
+            $_SESSION['user_id'],
+            $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;
+        $rcmail = rcmail::get_instance();
+
+        $key = $this->_key($args['name']);
+        $data = base64_encode($args['data']);
+
+        $status = $rcmail->db->query(
+            "INSERT INTO ".get_table_name('cache')."
+             (created, user_id, cache_key, data)
+             VALUES (".$rcmail->db->now().", ?, ?, ?)",
+            $_SESSION['user_id'],
+            $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)
+    {
+        $args['status'] = false;
+        $rcmail = rcmail::get_instance();
+        $status = $rcmail->db->query(
+            "DELETE FROM ".get_table_name('cache')."
+             WHERE  user_id=?
+             AND    cache_key=?",
+            $_SESSION['user_id'],
+            $args['id']);
+    
+        if ($status) {
+            $args['status'] = true;
+        }
+        
+        return $args;
+    }
+
+    /**
+     * When composing an html message, image attachments may be shown
+     * For this plugin, $this->get_attachment will check the file and
+     * return it's contents
+     */
+    function display($args)
+    {
+        return $this->get_attachment($args);
+    }
+
+    /**
+     * When displaying or sending the attachment the file contents are fetched
+     * using this method. This is also called by the display_attachment hook.
+     */
+    function get_attachment($args)
+    {
+        $rcmail = rcmail::get_instance();
+        
+        $sql_result = $rcmail->db->query(
+            "SELECT cache_id, data
+             FROM ".get_table_name('cache')."
+             WHERE  user_id=?
+             AND    cache_key=?",
+            $_SESSION['user_id'],
+            $args['id']);
+
+        if ($sql_arr = $rcmail->db->fetch_assoc($sql_result)) {
+            $args['data'] = base64_decode($sql_arr['data']);
+            $args['status'] = true;
+        }
+        
+        return $args;
+    }
+    
+    /**
+     * Delete all temp files associated with this user
+     */
+    function cleanup($args)
+    {
+        $rcmail = rcmail::get_instance();
+        $rcmail->db->query(
+            "DELETE FROM ".get_table_name('cache')."
+             WHERE  user_id=?
+             AND cache_key like '{$this->cache_prefix}%'",
+            $_SESSION['user_id']);
+    }
+}