summaryrefslogtreecommitdiff
path: root/plugins/archive/archive.php
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/archive/archive.php')
-rw-r--r--plugins/archive/archive.php140
1 files changed, 133 insertions, 7 deletions
diff --git a/plugins/archive/archive.php b/plugins/archive/archive.php
index 0a298cbe3..38b4f9fcb 100644
--- a/plugins/archive/archive.php
+++ b/plugins/archive/archive.php
@@ -6,7 +6,7 @@
* Plugin that adds a new button to the mailbox toolbar
* to move messages to a (user selectable) archive folder.
*
- * @version @package_version@
+ * @version 2.0
* @license GNU GPLv3+
* @author Andre Rodier, Thomas Bruederli
*/
@@ -45,14 +45,19 @@ class archive extends rcube_plugin
// register hook to localize the archive folder
$this->add_hook('render_mailboxlist', array($this, 'render_mailboxlist'));
- // set env variable for client
+ // set env variables for client
$rcmail->output->set_env('archive_folder', $archive_folder);
+ $rcmail->output->set_env('archive_type', $rcmail->config->get('archive_type',''));
// add archive folder to the list of default mailboxes
if (($default_folders = $rcmail->config->get('default_folders')) && !in_array($archive_folder, $default_folders)) {
$default_folders[] = $archive_folder;
$rcmail->config->set('default_folders', $default_folders);
- }
+ }
+ }
+ else if ($rcmail->task == 'mail') {
+ // handler for ajax request
+ $this->register_action('plugin.move2archive', array($this, 'move_messages'));
}
else if ($rcmail->task == 'settings') {
$dont_override = $rcmail->config->get('dont_override', array());
@@ -62,7 +67,10 @@ class archive extends rcube_plugin
}
}
}
-
+
+ /**
+ * Hook to give the archive folder a localized name in the mailbox list
+ */
function render_mailboxlist($p)
{
$rcmail = rcmail::get_instance();
@@ -80,7 +88,10 @@ class archive extends rcube_plugin
return $p;
}
- function _mod_folder_name(&$list, $folder, $new_name)
+ /**
+ * Helper method to find the archive folder in the mailbox tree
+ */
+ private function _mod_folder_name(&$list, $folder, $new_name)
{
foreach ($list as $idx => $item) {
if ($item['id'] == $folder) {
@@ -93,6 +104,100 @@ class archive extends rcube_plugin
return false;
}
+ /**
+ * Plugin action to move the submitted list of messages to the archive subfolders
+ * according to the user settings and their headers.
+ */
+ function move_messages()
+ {
+ $rcmail = rcmail::get_instance();
+ $this->add_texts('localization');
+
+ $storage = $rcmail->get_storage();
+ $storage->set_folder(($current_mbox = rcube_utils::get_input_value('_mbox', RCUBE_INPUT_POST)));
+
+ $delimiter = $storage->get_hierarchy_delimiter();
+ $archive_folder = $rcmail->config->get('archive_mbox');
+ $archive_type = $rcmail->config->get('archive_type', '');
+
+ $result = array('reload' => false, 'update' => false, 'errors' => array());
+
+ $uids = explode(',', rcube_utils::get_input_value('_uid', RCUBE_INPUT_POST));
+ foreach ($uids as $uid) {
+ if (!$archive_folder || !($message = $rcmail->storage->get_message($uid))) {
+ continue;
+ }
+
+ $subfolder = null;
+ switch ($archive_type) {
+ case 'year':
+ $subfolder = $rcmail->format_date($message->timestamp, 'Y');
+ break;
+
+ case 'month':
+ $subfolder = $rcmail->format_date($message->timestamp, 'Y') . $delimiter . $rcmail->format_date($message->timestamp, 'm');
+ break;
+
+ case 'folder':
+ $subfolder = $current_mbox;
+ break;
+
+ case 'sender':
+ $from = $message->get('from');
+ if (preg_match('/[\b<](.+@.+)[\b>]/i', $from, $m)) {
+ $subfolder = $m[1];
+ }
+ else {
+ $subfolder = $this->gettext('unkownsender');
+ }
+
+ // replace reserved characters in folder name
+ $repl = $delimiter == '-' ? '_' : '-';
+ $replacements[$delimiter] = $repl;
+ $replacements['.'] = $repl; // some IMAP server do not allow . characters
+ $subfolder = strtr($subfolder, $replacements);
+ break;
+
+ default:
+ $subfolder = '';
+ break;
+ }
+
+ // compose full folder path
+ $folder = $archive_folder . ($subfolder ? $delimiter . $subfolder : '');
+
+ // create archive subfolder if it doesn't yet exist
+ if (!$storage->folder_exists($folder, false)) {
+ if ($storage->create_folder($folder, true))
+ $result['reload'] = true;
+ }
+
+ // move message to target folder
+ if ($storage->move_message(array($uid), $folder)) {
+ $result['update'] = true;
+ }
+ else {
+ $result['errors'][] = $uid;
+ }
+ } // end for
+
+ // send response
+ if ($result['errors']) {
+ $rcmail->output->show_message($this->gettext('archiveerror'), 'warning');
+ }
+ if ($result['reload']) {
+ $rcmail->output->show_message($this->gettext('archivedreload'), 'confirmation');
+ }
+ else if ($result['update']) {
+ $rcmail->output->show_message($this->gettext('archived'), 'confirmation');
+ }
+
+ $rcmail->output->command('plugin.move2archive_response', $result);
+ }
+
+ /**
+ * Hook to inject plugin-specific user settings
+ */
function prefs_table($args)
{
global $CURR_SECTION;
@@ -104,7 +209,7 @@ class archive extends rcube_plugin
// load folders list when needed
if ($CURR_SECTION)
- $select = rcmail_mailbox_select(array('noselection' => '---', 'realnames' => true,
+ $select = $rcmail->folder_selector(array('noselection' => '---', 'realnames' => true,
'maxlength' => 30, 'exceptions' => array('INBOX'), 'folder_filter' => 'mail', 'folder_rights' => 'w'));
else
$select = new html_select();
@@ -113,15 +218,36 @@ class archive extends rcube_plugin
'title' => $this->gettext('archivefolder'),
'content' => $select->show($rcmail->config->get('archive_mbox'), array('name' => "_archive_mbox"))
);
+
+ // add option for structuring the archive folder
+ $archive_type = new html_select(array('name' => '_archive_type', 'id' => 'ff_archive_type'));
+ $archive_type->add($this->gettext('none'), '');
+ $archive_type->add($this->gettext('archivetypeyear'), 'year');
+ $archive_type->add($this->gettext('archivetypemonth'), 'month');
+ $archive_type->add($this->gettext('archivetypesender'), 'sender');
+ $archive_type->add($this->gettext('archivetypefolder'), 'folder');
+
+ $args['blocks']['archive'] = array(
+ 'name' => Q(rcube_label('settingstitle', 'archive')),
+ 'options' => array('archive_type' => array(
+ 'title' => $this->gettext('archivetype'),
+ 'content' => $archive_type->show($rcmail->config->get('archive_type'))
+ )
+ )
+ );
}
return $args;
}
+ /**
+ * Hook to save plugin-specific user settings
+ */
function save_prefs($args)
{
if ($args['section'] == 'folders') {
- $args['prefs']['archive_mbox'] = get_input_value('_archive_mbox', RCUBE_INPUT_POST);
+ $args['prefs']['archive_mbox'] = rcube_utils::get_input_value('_archive_mbox', rcube_utils::INPUT_POST);
+ $args['prefs']['archive_type'] = rcube_utils::get_input_value('_archive_type', rcube_utils::INPUT_POST);
return $args;
}
}