X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=plugins%2Fsent_subfolders%2Fsetup.php;h=201d34b0f96b0a403564f974a463419d90cb6094;hp=dafc1035dc9dd93e6e87eb2d2c3e7191bfa191f0;hb=fb0bcfdbbcbd1bfb5e8183c4b48b0ef184d21dbb;hpb=b587ac51cdb214754146d61829ba87bf4341f949 diff --git a/plugins/sent_subfolders/setup.php b/plugins/sent_subfolders/setup.php index dafc1035..201d34b0 100644 --- a/plugins/sent_subfolders/setup.php +++ b/plugins/sent_subfolders/setup.php @@ -3,20 +3,26 @@ /** * setup.php -- Sent Subfolders Setup File * - * Copyright (c) 1999-2003 The SquirrelMail Project Team - * Licensed under the GNU GPL. For full terms see the file COPYING. + * This is a standard SquirrelMail 1.2 API for plugins. * - * This is a standard Squirrelmail-1.2 API for plugins. - * - * $Id$ + * @copyright © 1999-2007 The SquirrelMail Project Team + * @license http://opensource.org/licenses/gpl-license.php GNU Public License + * @version $Id$ + * @package plugins + * @subpackage sent_subfolders */ +/** + */ define('SMPREF_SENT_SUBFOLDERS_DISABLED', 0); define('SMPREF_SENT_SUBFOLDERS_YEARLY', 1); define('SMPREF_SENT_SUBFOLDERS_QUARTERLY', 2); define('SMPREF_SENT_SUBFOLDERS_MONTHLY', 3); define('SMOPT_GRP_SENT_SUBFOLDERS','SENT_SUBFOLDERS'); +/** + * Adds plugin to SquirrelMail's hooks + */ function squirrelmail_plugin_init_sent_subfolders() { /* Standard initialization API. */ global $squirrelmail_plugin_hooks; @@ -44,12 +50,18 @@ function squirrelmail_plugin_init_sent_subfolders() { $squirrelmail_plugin_hooks ['optpage_loadhook_folder']['sent_subfolders'] = 'sent_subfolders_optpage_loadhook_folders'; + + /* mark base sent folder as special mailbox */ + $squirrelmail_plugin_hooks + ['special_mailbox']['sent_subfolders'] = + 'sent_subfolders_special_mailbox'; } function sent_subfolders_check_handleAsSent() { global $handleAsSent_result, $sent_subfolders_base, $use_sent_subfolders; + // FIXME: hardcoded folder $sent_subfolders_base = 'INBOX.Sent'; $args = func_get_arg(0); sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION); @@ -69,6 +81,9 @@ function sent_subfolders_check_handleAsSent() { } } +/** + * Loads sent_subfolders settings + */ function sent_subfolders_load_prefs() { global $use_sent_subfolders, $data_dir, $username, $sent_subfolders_setting, $sent_subfolders_base; @@ -83,15 +98,14 @@ function sent_subfolders_load_prefs() { ($data_dir, $username, 'sent_subfolders_base', SMPREF_NONE); } +/** + * Adds sent_subfolders options in folder preferences + */ function sent_subfolders_optpage_loadhook_folders() { - global $optpage_data, $imapServerAddress, $imapPort; - - sqgetGlobalVar('username', $username, SQ_SESSION); - sqgetGlobalVar('key', $key, SQ_COOKIE); + global $username, $optpage_data, $imapServerAddress, $imapPort, $show_contain_subfolders_option; /* Get some imap data we need later. */ - $imapConnection = - sqimap_login($username, $key, $imapServerAddress, $imapPort, 0); + $imapConnection = sqimap_login($username, false, $imapServerAddress, $imapPort, 0); $boxes = sqimap_mailbox_list($imapConnection); sqimap_logout($imapConnection); @@ -111,28 +125,47 @@ function sent_subfolders_optpage_loadhook_folders() { 'save' => 'save_option_sent_subfolders_setting' ); - $sent_subfolders_base_values = array(); - foreach ($boxes as $folder) { - if (strtolower($folder['unformatted']) != 'inbox') { - $real_value = $folder['unformatted-dm']; - $disp_value = str_replace(' ', ' ', $folder['formatted']); - $sent_subfolders_base_values[$real_value] = $disp_value; - } - } + $filtered_folders=array_filter($boxes, "filter_folders"); + $sent_subfolders_base_values = array('whatever'=>$filtered_folders); $optvals[] = array( 'name' => 'sent_subfolders_base', 'caption' => _("Base Sent Folder"), - 'type' => SMOPT_TYPE_STRLIST, + 'type' => SMOPT_TYPE_FLDRLIST, 'refresh' => SMOPT_REFRESH_FOLDERLIST, - 'posvals' => $sent_subfolders_base_values + 'posvals' => $sent_subfolders_base_values, + 'folder_filter' => 'noinferiors' ); + if ($show_contain_subfolders_option) { + $optvals[] = array( + 'name' => 'sent_subfolders_warning', + 'caption' => _("Warning"), + 'type' => SMOPT_TYPE_COMMENT, + 'comment' => _("There are some restrictions in Sent Subfolder options.") + ); + } + /* Add our option data to the global array. */ $optpage_data['grps'][SMOPT_GRP_SENT_SUBFOLDERS] = $optgrp; $optpage_data['vals'][SMOPT_GRP_SENT_SUBFOLDERS] = $optvals; } +/** + * Defines folder filtering rules + * + * Callback function that should exclude some folders from folder listing. + * @param array $fldr list of folders. See sqimap_mailbox_list + * @return boolean returns true, if folder has to included in folder listing + * @access private + */ +function filter_folders($fldr) { + return strtolower($fldr['unformatted'])!='inbox'; +} + +/** + * Saves sent_subfolder_options + */ function save_option_sent_subfolders_setting($option) { global $data_dir, $username, $use_sent_subfolders; @@ -148,36 +181,33 @@ function save_option_sent_subfolders_setting($option) { save_option($option); } +/** + * Update sent_subfolders settings + * + * function updates default sent folder value and + * creates required imap folders + */ function sent_subfolders_update_sentfolder() { - global $sent_folder, $auto_create_special, $auto_create_done; + global $sent_folder, $username; global $sent_subfolders_base, $sent_subfolders_setting; global $data_dir, $imapServerAddress, $imapPort; - global $use_sent_subfolders, $move_to_sent, $imap_server_type; + global $use_sent_subfolders, $move_to_sent; - sqgetGlobalVar('username', $username, SQ_SESSION); - sqgetGlobalVar('key', $key, SQ_COOKIE); sqgetGlobalVar('delimiter', $delimiter, SQ_SESSION); - + if ($use_sent_subfolders || $move_to_sent) { $year = date('Y'); $month = date('m'); $quarter = sent_subfolder_getQuarter($month); - /* - Regarding the structure we've got three main possibilities. - One sent holder. level 0. - Multiple year holders with messages in it. level 1. - Multiple year folders with holders in it. level 2. - */ -/* - if( $imap_server_type == 'uw' ) { - $cnd_delimiter = ''; - } else { - $cnd_delimiter = $delimiter; - } -*/ + /** + * Regarding the structure we've got three main possibilities. + * One sent holder. level 0. + * Multiple year holders with messages in it. level 1. + * Multiple year folders with holders in it. level 2. + */ $cnd_delimiter = $delimiter; - + switch ($sent_subfolders_setting) { case SMPREF_SENT_SUBFOLDERS_YEARLY: $level = 1; @@ -186,10 +216,10 @@ function sent_subfolders_update_sentfolder() { break; case SMPREF_SENT_SUBFOLDERS_QUARTERLY: $level = 2; - $sent_subfolder = $sent_subfolders_base . $cnd_delimiter + $sent_subfolder = $sent_subfolders_base . $cnd_delimiter . $year . $delimiter . $quarter; - $year_folder = $sent_subfolders_base + $year_folder = $sent_subfolders_base . $cnd_delimiter . $year; break; case SMPREF_SENT_SUBFOLDERS_MONTHLY: @@ -197,7 +227,7 @@ function sent_subfolders_update_sentfolder() { $sent_subfolder = $sent_subfolders_base . $cnd_delimiter . $year . $delimiter . $month; - $year_folder = $sent_subfolders_base . $year; + $year_folder = $sent_subfolders_base. $cnd_delimiter . $year; break; case SMPREF_SENT_SUBFOLDERS_DISABLED: default: @@ -208,40 +238,59 @@ function sent_subfolders_update_sentfolder() { /* If this folder is NOT the current sent folder, update stuff. */ if ($sent_subfolder != $sent_folder) { - /* First, update the sent folder. */ - - setPref($data_dir, $username, 'sent_folder', $sent_subfolder); - setPref($data_dir, $username, 'move_to_sent', SMPREF_ON); - $sent_folder = $sent_subfolder; - $move_to_sent = SMPREF_ON; - /* Auto-create folders, if they do not yet exist. */ - if ($sent_folder != 'none') { + if ($sent_subfolder != 'none') { /* Create the imap connection. */ - $ic = sqimap_login - ($username, $key, $imapServerAddress, $imapPort, 10); - - /* Auto-create the year folder, if it does not yet exist. */ - if (!sqimap_mailbox_exists($ic, $year_folder)) { - sqimap_mailbox_create($ic, $year_folder, ($level==1)?'':'noselect'); - } else if (!sqimap_mailbox_is_subscribed($ic, $year_folder)) { - sqimap_subscribe($ic, $year_folder); - } - - /* Auto-create the subfolder, if it does not yet exist. */ - if (!sqimap_mailbox_exists($ic, $sent_folder)) { - sqimap_mailbox_create($ic, $sent_folder, ''); - } else if (!sqimap_mailbox_is_subscribed($ic, $sent_subfolder)) { - sqimap_subscribe($ic, $sent_subfolder); + $ic = sqimap_login($username, false, $imapServerAddress, $imapPort, 10); + + $boxes = false; + /** + * If sent_subfolder can't store messages (noselect) || + * year_folder can't store subfolders (noinferiors) in level=2 setup || + * subfolder_base can't store subfolders (noinferiors), setup is broken + */ + if (sqimap_mailbox_is_noselect($ic,$sent_subfolder,$boxes) || + ($level==2 && sqimap_mailbox_is_noinferiors($ic,$year_folder,$boxes)) || + sqimap_mailbox_is_noinferiors($ic,$sent_subfolders_base,$boxes)) { + error_box(_("Sent Subfolders plugin is misconfigured.")); + } else { + if ($level==2) { + /* Auto-create the year folder, if it does not yet exist. */ + if (!sqimap_mailbox_exists($ic, $year_folder)) { + sqimap_mailbox_create($ic, $year_folder, 'noselect'); + // TODO: safety check for imap servers that can't create subfolders + + } else if (!sqimap_mailbox_is_subscribed($ic, $year_folder)) { + sqimap_subscribe($ic, $year_folder); + } + } + + /* Auto-create the subfolder, if it does not yet exist. */ + if (!sqimap_mailbox_exists($ic, $sent_subfolder)) { + sqimap_mailbox_create($ic, $sent_subfolder, ''); + } else if (!sqimap_mailbox_is_subscribed($ic, $sent_subfolder)) { + sqimap_subscribe($ic, $sent_subfolder); + } + /* Update sent_folder setting. */ + //setPref($data_dir, $username, 'sent_folder', $sent_subfolder); + //setPref($data_dir, $username, 'move_to_sent', SMPREF_ON); + $sent_folder = $sent_subfolder; + $move_to_sent = SMPREF_ON; } - /* Close the imap connection. */ sqimap_logout($ic); } + } } } +/** + * Sets quarter subfolder names + * + * @param string $month numeric month + * @return string quarter name (Q + number) + */ function sent_subfolder_getQuarter($month) { switch ($month) { case '01': @@ -272,4 +321,26 @@ function sent_subfolder_getQuarter($month) { return ('Q' . $result); } -?> +/** + * detects if mailbox is part of sent_subfolders + * + * @param string $mb imap folder name + * @return boolean 1 - is part of sent_subfolders, 0 - is not part of sent_subfolders + */ +function sent_subfolders_special_mailbox($mb) { + global $data_dir, $username, $delimiter; + + $use_sent_subfolders = getPref + ($data_dir, $username, 'use_sent_subfolders', SMPREF_OFF); + $sent_subfolders_base = getPref($data_dir, $username, 'sent_subfolders_base', 'na'); + + /** + * If sent_subfolders are used and mailbox is equal to subfolder base + * or mailbox matches subfolder base + delimiter. + */ + if ($use_sent_subfolders == SMPREF_ON && + ($mb == $sent_subfolders_base || stristr($mb,$sent_subfolders_base . $delimiter) ) ) { + return 1; + } + return 0; +}