From 7e3298753a9f93405ef44b46ba4db4ca98553b51 Mon Sep 17 00:00:00 2001
From: Aleksander Machniak <alec@alec.pl>
Date: Sat, 14 Nov 2015 04:08:07 -0500
Subject: [PATCH] Use ternary operator where aplicable
---
program/lib/Roundcube/rcube_storage.php | 230 +++++++++++++++++++++++++++------------------------------
1 files changed, 110 insertions(+), 120 deletions(-)
diff --git a/program/lib/Roundcube/rcube_storage.php b/program/lib/Roundcube/rcube_storage.php
index 8a36f1f..387b3d0 100644
--- a/program/lib/Roundcube/rcube_storage.php
+++ b/program/lib/Roundcube/rcube_storage.php
@@ -1,6 +1,6 @@
<?php
-/*
+/**
+-----------------------------------------------------------------------+
| This file is part of the Roundcube Webmail client |
| Copyright (C) 2005-2012, The Roundcube Dev Team |
@@ -35,12 +35,19 @@
*/
public $conn;
+ /**
+ * List of supported special folder types
+ *
+ * @var array
+ */
+ public static $folder_types = array('drafts', 'sent', 'junk', 'trash');
+
protected $folder = 'INBOX';
protected $default_charset = 'ISO-8859-1';
- protected $default_folders = array('INBOX');
protected $search_set;
- protected $options = array('auth_method' => 'check');
+ protected $options = array('auth_type' => 'check');
protected $page_size = 10;
+ protected $list_page = 1;
protected $threading = false;
/**
@@ -61,8 +68,6 @@
'MAIL-FOLLOWUP-TO',
'MAIL-REPLY-TO',
'RETURN-PATH',
- 'DELIVERED-TO',
- 'ENVELOPE-TO',
);
const UNKNOWN = 0;
@@ -89,12 +94,10 @@
*/
abstract function connect($host, $user, $pass, $port = 143, $use_ssl = null);
-
/**
* Close connection. Usually done on script shutdown
*/
abstract function close();
-
/**
* Checks connection state.
@@ -103,14 +106,12 @@
*/
abstract function is_connected();
-
/**
* Check connection state, connect if not connected.
*
* @return bool Connection state.
*/
abstract function check_connection();
-
/**
* Returns code of last error
@@ -119,7 +120,6 @@
*/
abstract function get_error_code();
-
/**
* Returns message of last error
*
@@ -127,14 +127,12 @@
*/
abstract function get_error_str();
-
/**
* Returns code of last command response
*
* @return int Response code (class constant)
*/
abstract function get_response_code();
-
/**
* Set connection and class options
@@ -146,6 +144,17 @@
$this->options = array_merge($this->options, (array)$opt);
}
+ /**
+ * Get connection/class option
+ *
+ * @param string $name Option name
+ *
+ * @param mixed Option value
+ */
+ public function get_option($name)
+ {
+ return $this->options[$name];
+ }
/**
* Activate/deactivate debug mode.
@@ -153,7 +162,6 @@
* @param boolean $dbg True if conversation with the server should be logged
*/
abstract function set_debug($dbg = true);
-
/**
* Set default message charset.
@@ -166,25 +174,6 @@
{
$this->default_charset = $cs;
}
-
-
- /**
- * This list of folders will be listed above all other folders
- *
- * @param array $arr Indexed list of folder names
- */
- public function set_default_folders($arr)
- {
- if (is_array($arr)) {
- $this->default_folders = $arr;
-
- // add inbox if not included
- if (!in_array('INBOX', $this->default_folders)) {
- array_unshift($this->default_folders, 'INBOX');
- }
- }
- }
-
/**
* Set internal folder reference.
@@ -201,7 +190,6 @@
$this->folder = $folder;
}
-
/**
* Returns the currently used folder name
*
@@ -212,7 +200,6 @@
return $this->folder;
}
-
/**
* Set internal list page number.
*
@@ -220,9 +207,10 @@
*/
public function set_page($page)
{
- $this->list_page = (int) $page;
+ if ($page = intval($page)) {
+ $this->list_page = $page;
+ }
}
-
/**
* Gets internal list page number.
@@ -234,7 +222,6 @@
return $this->list_page;
}
-
/**
* Set internal page size
*
@@ -244,7 +231,6 @@
{
$this->page_size = (int) $size;
}
-
/**
* Get internal page size
@@ -256,7 +242,6 @@
return $this->page_size;
}
-
/**
* Save a search result for future message listing methods.
*
@@ -264,14 +249,12 @@
*/
abstract function set_search_set($set);
-
/**
* Return the saved search set.
*
* @return array Search set in driver specific format, NULL if search wasn't initialized
*/
abstract function get_search_set();
-
/**
* Returns the storage server's (IMAP) capability
@@ -281,7 +264,6 @@
* @return mixed Capability value or TRUE if supported, FALSE if not
*/
abstract function get_capability($cap);
-
/**
* Sets threading flag to the best supported THREAD algorithm.
@@ -305,7 +287,6 @@
return $this->threading;
}
-
/**
* Get current threading flag.
*
@@ -315,7 +296,6 @@
{
return $this->threading;
}
-
/**
* Checks the PERMANENTFLAGS capability of the current folder
@@ -327,7 +307,6 @@
*/
abstract function check_permflag($flag);
-
/**
* Returns the delimiter that is used by the server
* for folder hierarchy separation.
@@ -335,7 +314,6 @@
* @return string Delimiter string
*/
abstract function get_hierarchy_delimiter();
-
/**
* Get namespace
@@ -345,7 +323,6 @@
* @return array Namespace data
*/
abstract function get_namespace($name = null);
-
/**
* Get messages count for a specific folder.
@@ -360,6 +337,16 @@
*/
abstract function count($folder = null, $mode = 'ALL', $force = false, $status = true);
+ /**
+ * Public method for listing message flags
+ *
+ * @param string $folder Folder name
+ * @param array $uids Message UIDs
+ * @param int $mod_seq Optional MODSEQ value
+ *
+ * @return array Indexed array with message flags
+ */
+ abstract function list_flags($folder, $uids, $mod_seq = null);
/**
* Public method for listing headers.
@@ -374,7 +361,6 @@
*/
abstract function list_messages($folder = null, $page = null, $sort_field = null, $sort_order = null, $slice = 0);
-
/**
* Return sorted list of message UIDs
*
@@ -385,7 +371,6 @@
* @return rcube_result_index|rcube_result_thread List of messages (UIDs)
*/
abstract function index($folder = null, $sort_field = null, $sort_order = null);
-
/**
* Invoke search request to the server.
@@ -399,7 +384,6 @@
*/
abstract function search($folder = null, $str = 'ALL', $charset = null, $sort_field = null);
-
/**
* Direct (real and simple) search request (without result sorting and caching).
*
@@ -409,7 +393,6 @@
* @return rcube_result_index Search result (UIDs)
*/
abstract function search_once($folder = null, $str = 'ALL');
-
/**
* Refresh saved search set
@@ -425,7 +408,7 @@
/**
* Fetch message headers and body structure from the server and build
- * an object structure similar to the one generated by PEAR::Mail_mimeDecode
+ * an object structure.
*
* @param int $uid Message UID to fetch
* @param string $folder Folder to read from
@@ -433,7 +416,6 @@
* @return object rcube_message_header Message data
*/
abstract function get_message($uid, $folder = null);
-
/**
* Return message headers object of a specific message
@@ -445,7 +427,6 @@
* @return rcube_message_header Message headers
*/
abstract function get_message_headers($uid, $folder = null, $force = false);
-
/**
* Fetch message body of a specific message from the server
@@ -461,7 +442,6 @@
*/
abstract function get_message_part($uid, $part = 1, $o_part = null, $print = null, $fp = null, $skip_charset_conv = false);
-
/**
* Fetch message body of a specific message from the server
*
@@ -474,30 +454,29 @@
{
$headers = $this->get_message_headers($uid);
return rcube_charset::convert($this->get_message_part($uid, $part, null),
- $headers->charset ? $headers->charset : $this->default_charset);
+ $headers->charset ?: $this->default_charset);
}
-
/**
* Returns the whole message source as string (or saves to a file)
*
- * @param int $uid Message UID
- * @param resource $fp File pointer to save the message
+ * @param int $uid Message UID
+ * @param resource $fp File pointer to save the message
+ * @param string $part Optional message part ID
*
* @return string Message source string
*/
- abstract function get_raw_body($uid, $fp = null);
-
+ abstract function get_raw_body($uid, $fp = null, $part = null);
/**
* Returns the message headers as string
*
- * @param int $uid Message UID
+ * @param int $uid Message UID
+ * @param string $part Optional message part ID
*
* @return string Message headers string
*/
- abstract function get_raw_headers($uid);
-
+ abstract function get_raw_headers($uid, $part = null);
/**
* Sends the whole message source to stdout
@@ -506,7 +485,6 @@
* @param bool $formatted Enables line-ending formatting
*/
abstract function print_raw_body($uid, $formatted = true);
-
/**
* Set message flag to one or several messages
@@ -519,7 +497,6 @@
* @return bool Operation status
*/
abstract function set_flag($uids, $flag, $folder = null, $skip_cache = false);
-
/**
* Remove message flag for one or several messages
@@ -536,21 +513,20 @@
return $this->set_flag($uids, 'UN'.$flag, $folder);
}
-
/**
* Append a mail message (source) to a specific folder.
*
- * @param string $folder Target folder
- * @param string $message The message source string or filename
- * @param string $headers Headers string if $message contains only the body
- * @param boolean $is_file True if $message is a filename
- * @param array $flags Message flags
- * @param mixed $date Message internal date
+ * @param string $folder Target folder
+ * @param string|array $message The message source string or filename
+ * or array (of strings and file pointers)
+ * @param string $headers Headers string if $message contains only the body
+ * @param boolean $is_file True if $message is a filename
+ * @param array $flags Message flags
+ * @param mixed $date Message internal date
*
* @return int|bool Appended message UID or True on success, False on error
*/
abstract function save_message($folder, &$message, $headers = '', $is_file = false, $flags = array(), $date = null);
-
/**
* Move message(s) from one folder to another.
@@ -563,7 +539,6 @@
*/
abstract function move_message($uids, $to, $from = null);
-
/**
* Copy message(s) from one mailbox to another.
*
@@ -575,7 +550,6 @@
*/
abstract function copy_message($uids, $to, $from = null);
-
/**
* Mark message(s) as deleted and expunge.
*
@@ -585,7 +559,6 @@
* @return boolean True on success, False on error
*/
abstract function delete_message($uids, $folder = null);
-
/**
* Expunge message(s) and clear the cache.
@@ -598,11 +571,10 @@
*/
abstract function expunge_message($uids, $folder = null, $clear_cache = true);
-
/**
* Parse message UIDs input
*
- * @param mixed $uids UIDs array or comma-separated list or '*' or '1:*'
+ * @param mixed $uids UIDs array or comma-separated list or '*' or '1:*'
*
* @return array Two elements array with UIDs converted to list and ALL flag
*/
@@ -621,6 +593,9 @@
else {
if (is_array($uids)) {
$uids = join(',', $uids);
+ }
+ else if (strpos($uids, ':')) {
+ $uids = join(',', rcube_imap_generic::uncompressMessageSet($uids));
}
if (preg_match('/[^0-9,]/', $uids)) {
@@ -649,7 +624,6 @@
*/
abstract function list_folders_subscribed($root = '', $name = '*', $filter = null, $rights = null, $skip_sort = false);
-
/**
* Get a list of all folders available on the server.
*
@@ -663,7 +637,6 @@
*/
abstract function list_folders($root = '', $name = '*', $filter = null, $rights = null, $skip_sort = false);
-
/**
* Subscribe to a specific folder(s)
*
@@ -673,7 +646,6 @@
*/
abstract function subscribe($folders);
-
/**
* Unsubscribe folder(s)
*
@@ -682,7 +654,6 @@
* @return boolean True on success
*/
abstract function unsubscribe($folders);
-
/**
* Create a new folder on the server.
@@ -694,7 +665,6 @@
*/
abstract function create_folder($folder, $subscribe = false);
-
/**
* Set a new name to an existing folder
*
@@ -705,7 +675,6 @@
*/
abstract function rename_folder($folder, $new_name);
-
/**
* Remove a folder from the server.
*
@@ -714,7 +683,6 @@
* @return boolean True on success, False on error
*/
abstract function delete_folder($folder);
-
/**
* Send expunge command and clear the cache.
@@ -729,7 +697,6 @@
return $this->expunge_message('*', $folder, $clear_cache);
}
-
/**
* Remove all messages in a folder..
*
@@ -742,7 +709,6 @@
return $this->delete_message('*', $folder);
}
-
/**
* Checks if folder exists and is subscribed
*
@@ -753,7 +719,6 @@
*/
abstract function folder_exists($folder, $subscription = false);
-
/**
* Get folder size (size of all messages in a folder)
*
@@ -763,7 +728,6 @@
*/
abstract function folder_size($folder);
-
/**
* Returns the namespace where the folder is in
*
@@ -772,7 +736,6 @@
* @return string One of 'personal', 'other' or 'shared'
*/
abstract function folder_namespace($folder);
-
/**
* Gets folder attributes (from LIST response, e.g. \Noselect, \Noinferiors).
@@ -784,7 +747,6 @@
*/
abstract function folder_attributes($folder, $force = false);
-
/**
* Gets connection (and current folder) data: UIDVALIDITY, EXISTS, RECENT,
* PERMANENTFLAGS, UIDNEXT, UNSEEN
@@ -795,7 +757,6 @@
*/
abstract function folder_data($folder);
-
/**
* Returns extended information about the folder.
*
@@ -805,16 +766,15 @@
*/
abstract function folder_info($folder);
-
/**
- * Returns current status of a folder
+ * Returns current status of a folder (compared to the last time use)
*
* @param string $folder Folder name
+ * @param array $diff Difference data
*
* @return int Folder status
*/
- abstract function folder_status($folder = null);
-
+ abstract function folder_status($folder = null, &$diff = array());
/**
* Synchronizes messages cache.
@@ -822,7 +782,6 @@
* @param string $folder Folder name
*/
abstract function folder_sync($folder);
-
/**
* Modify folder name according to namespace.
@@ -837,30 +796,71 @@
*/
abstract function mod_folder($folder, $mode = 'out');
-
/**
* Create all folders specified as default
*/
public function create_default_folders()
{
+ $rcube = rcube::get_instance();
+
// create default folders if they do not exist
- foreach ($this->default_folders as $folder) {
- if (!$this->folder_exists($folder)) {
- $this->create_folder($folder, true);
- }
- else if (!$this->folder_exists($folder, true)) {
- $this->subscribe($folder);
+ foreach (self::$folder_types as $type) {
+ if ($folder = $rcube->config->get($type . '_mbox')) {
+ if (!$this->folder_exists($folder)) {
+ $this->create_folder($folder, true, $type);
+ }
+ else if (!$this->folder_exists($folder, true)) {
+ $this->subscribe($folder);
+ }
}
}
}
+ /**
+ * Check if specified folder is a special folder
+ */
+ public function is_special_folder($name)
+ {
+ return $name == 'INBOX' || in_array($name, $this->get_special_folders());
+ }
+
+ /**
+ * Return configured special folders
+ */
+ public function get_special_folders($forced = false)
+ {
+ // getting config might be expensive, store special folders in memory
+ if (!isset($this->icache['special-folders'])) {
+ $rcube = rcube::get_instance();
+ $this->icache['special-folders'] = array();
+
+ foreach (self::$folder_types as $type) {
+ if ($folder = $rcube->config->get($type . '_mbox')) {
+ $this->icache['special-folders'][$type] = $folder;
+ }
+ }
+ }
+
+ return $this->icache['special-folders'];
+ }
+
+ /**
+ * Set special folder associations stored in backend
+ */
+ public function set_special_folders($specials)
+ {
+ // should be overriden by storage class if backend supports special folders (SPECIAL-USE)
+ unset($this->icache['special-folders']);
+ }
/**
* Get mailbox quota information.
*
+ * @param string $folder Folder name
+ *
* @return mixed Quota info or False if not supported
*/
- abstract function get_quota();
+ abstract function get_quota($folder = null);
/* -----------------------------------------
@@ -878,7 +878,6 @@
*/
abstract function set_acl($folder, $user, $acl);
-
/**
* Removes any <identifier,rights> pair for the
* specified user from the ACL for the specified
@@ -891,7 +890,6 @@
*/
abstract function delete_acl($folder, $user);
-
/**
* Returns the access control list for a folder (GETACL).
*
@@ -900,7 +898,6 @@
* @return array User-rights array on success, NULL on error
*/
abstract function get_acl($folder);
-
/**
* Returns information about what rights can be granted to the
@@ -913,7 +910,6 @@
*/
abstract function list_rights($folder, $user);
-
/**
* Returns the set of rights that the current user has to a folder (MYRIGHTS).
*
@@ -922,7 +918,6 @@
* @return array MYRIGHTS response on success, NULL on error
*/
abstract function my_rights($folder);
-
/**
* Sets metadata/annotations (SETMETADATA/SETANNOTATION)
@@ -934,7 +929,6 @@
*/
abstract function set_metadata($folder, $entries);
-
/**
* Unsets metadata/annotations (SETMETADATA/SETANNOTATION)
*
@@ -945,18 +939,17 @@
*/
abstract function delete_metadata($folder, $entries);
-
/**
* Returns folder metadata/annotations (GETMETADATA/GETANNOTATION).
*
* @param string $folder Folder name (empty for server metadata)
* @param array $entries Entries
* @param array $options Command options (with MAXSIZE and DEPTH keys)
+ * @param bool $force Disables cache use
*
* @return array Metadata entry-value hash array on success, NULL on error
*/
- abstract function get_metadata($folder, $entries, $options = array());
-
+ abstract function get_metadata($folder, $entries, $options = array(), $force = false);
/* -----------------------------------------
* Cache related functions
@@ -971,7 +964,6 @@
*/
abstract function clear_cache($key = null, $prefix_mode = false);
-
/**
* Returns cached value
*
@@ -981,10 +973,8 @@
*/
abstract function get_cache($key);
-
/**
* Delete outdated cache entries
*/
- abstract function expunge_cache();
-
-} // end class rcube_storage
+ abstract function cache_gc();
+}
--
Gitblit v1.9.1