Aleksander Machniak
2016-05-22 77b5d7ee304a688a2eb115ce04b460b43c0dd700
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                       |
@@ -47,6 +47,7 @@
    protected $search_set;
    protected $options = array('auth_type' => 'check');
    protected $page_size = 10;
    protected $list_page = 1;
    protected $threading = false;
    /**
@@ -93,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.
@@ -107,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
@@ -123,7 +120,6 @@
     */
    abstract function get_error_code();
    /**
     * Returns message of last error
     *
@@ -131,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
@@ -150,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.
@@ -157,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.
@@ -170,7 +174,6 @@
    {
        $this->default_charset = $cs;
    }
    /**
     * Set internal folder reference.
@@ -187,7 +190,6 @@
        $this->folder = $folder;
    }
    /**
     * Returns the currently used folder name
     *
@@ -198,7 +200,6 @@
        return $this->folder;
    }
    /**
     * Set internal list page number.
     *
@@ -206,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.
@@ -220,7 +222,6 @@
        return $this->list_page;
    }
    /**
     * Set internal page size
     *
@@ -230,7 +231,6 @@
    {
        $this->page_size = (int) $size;
    }
    /**
     * Get internal page size
@@ -242,7 +242,6 @@
        return $this->page_size;
    }
    /**
     * Save a search result for future message listing methods.
     *
@@ -250,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
@@ -267,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.
@@ -291,7 +287,6 @@
        return $this->threading;
    }
    /**
     * Get current threading flag.
     *
@@ -301,7 +296,6 @@
    {
        return $this->threading;
    }
    /**
     * Checks the PERMANENTFLAGS capability of the current folder
@@ -313,7 +307,6 @@
     */
    abstract function check_permflag($flag);
    /**
     * Returns the delimiter that is used by the server
     * for folder hierarchy separation.
@@ -321,7 +314,6 @@
     * @return  string  Delimiter string
     */
    abstract function get_hierarchy_delimiter();
    /**
     * Get namespace
@@ -331,7 +323,6 @@
     * @return  array  Namespace data
     */
    abstract function get_namespace($name = null);
    /**
     * Get messages count for a specific folder.
@@ -346,7 +337,6 @@
     */
    abstract function count($folder = null, $mode = 'ALL', $force = false, $status = true);
    /**
     * Public method for listing message flags
     *
@@ -357,7 +347,6 @@
     * @return array Indexed array with message flags
     */
    abstract function list_flags($folder, $uids, $mod_seq = null);
    /**
     * Public method for listing headers.
@@ -372,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
     *
@@ -383,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.
@@ -397,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).
     *
@@ -407,7 +393,6 @@
     * @return rcube_result_index  Search result (UIDs)
     */
    abstract function search_once($folder = null, $str = 'ALL');
    /**
     * Refresh saved search set
@@ -423,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
@@ -431,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
@@ -443,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
@@ -459,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
     *
@@ -472,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
@@ -504,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
@@ -517,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
@@ -534,7 +513,6 @@
        return $this->set_flag($uids, 'UN'.$flag, $folder);
    }
    /**
     * Append a mail message (source) to a specific folder.
     *
@@ -550,7 +528,6 @@
     */
    abstract function save_message($folder, &$message, $headers = '', $is_file = false, $flags = array(), $date = null);
    /**
     * Move message(s) from one folder to another.
     *
@@ -561,7 +538,6 @@
     * @return boolean True on success, False on error
     */
    abstract function move_message($uids, $to, $from = null);
    /**
     * Copy message(s) from one mailbox to another.
@@ -574,7 +550,6 @@
     */
    abstract function copy_message($uids, $to, $from = null);
    /**
     * Mark message(s) as deleted and expunge.
     *
@@ -584,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.
@@ -596,7 +570,6 @@
     * @return boolean True on success, False on error
     */
    abstract function expunge_message($uids, $folder = null, $clear_cache = true);
    /**
     * Parse message UIDs input
@@ -651,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.
     *
@@ -665,7 +637,6 @@
     */
    abstract function list_folders($root = '', $name = '*', $filter = null, $rights = null, $skip_sort = false);
    /**
     * Subscribe to a specific folder(s)
     *
@@ -675,7 +646,6 @@
     */
    abstract function subscribe($folders);
    /**
     * Unsubscribe folder(s)
     *
@@ -684,7 +654,6 @@
     * @return boolean True on success
     */
    abstract function unsubscribe($folders);
    /**
     * Create a new folder on the server.
@@ -696,7 +665,6 @@
     */
    abstract function create_folder($folder, $subscribe = false);
    /**
     * Set a new name to an existing folder
     *
@@ -707,7 +675,6 @@
     */
    abstract function rename_folder($folder, $new_name);
    /**
     * Remove a folder from the server.
     *
@@ -716,7 +683,6 @@
     * @return boolean True on success, False on error
     */
    abstract function delete_folder($folder);
    /**
     * Send expunge command and clear the cache.
@@ -731,7 +697,6 @@
        return $this->expunge_message('*', $folder, $clear_cache);
    }
    /**
     * Remove all messages in a folder..
     *
@@ -744,7 +709,6 @@
        return $this->delete_message('*', $folder);
    }
    /**
     * Checks if folder exists and is subscribed
     *
@@ -755,7 +719,6 @@
     */
    abstract function folder_exists($folder, $subscription = false);
    /**
     * Get folder size (size of all messages in a folder)
     *
@@ -765,7 +728,6 @@
     */
    abstract function folder_size($folder);
    /**
     * Returns the namespace where the folder is in
     *
@@ -774,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).
@@ -786,7 +747,6 @@
     */
    abstract function folder_attributes($folder, $force = false);
    /**
     * Gets connection (and current folder) data: UIDVALIDITY, EXISTS, RECENT,
     * PERMANENTFLAGS, UIDNEXT, UNSEEN
@@ -797,7 +757,6 @@
     */
    abstract function folder_data($folder);
    /**
     * Returns extended information about the folder.
     *
@@ -806,7 +765,6 @@
     * @return array Data
     */
    abstract function folder_info($folder);
    /**
     * Returns current status of a folder (compared to the last time use)
@@ -818,14 +776,12 @@
     */
    abstract function folder_status($folder = null, &$diff = array());
    /**
     * Synchronizes messages cache.
     *
     * @param string $folder Folder name
     */
    abstract function folder_sync($folder);
    /**
     * Modify folder name according to namespace.
@@ -839,7 +795,6 @@
     * @return string Folder name
     */
    abstract function mod_folder($folder, $mode = 'out');
    /**
     * Create all folders specified as default
@@ -861,7 +816,6 @@
        }
    }
    /**
     * Check if specified folder is a special folder
     */
@@ -869,7 +823,6 @@
    {
        return $name == 'INBOX' || in_array($name, $this->get_special_folders());
    }
    /**
     * Return configured special folders
@@ -891,7 +844,6 @@
        return $this->icache['special-folders'];
    }
    /**
     * Set special folder associations stored in backend
     */
@@ -901,13 +853,14 @@
        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);
    /* -----------------------------------------
@@ -925,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
@@ -938,7 +890,6 @@
     */
    abstract function delete_acl($folder, $user);
    /**
     * Returns the access control list for a folder (GETACL).
     *
@@ -947,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
@@ -960,7 +910,6 @@
     */
    abstract function list_rights($folder, $user);
    /**
     * Returns the set of rights that the current user has to a folder (MYRIGHTS).
     *
@@ -969,7 +918,6 @@
     * @return array MYRIGHTS response on success, NULL on error
     */
    abstract function my_rights($folder);
    /**
     * Sets metadata/annotations (SETMETADATA/SETANNOTATION)
@@ -981,7 +929,6 @@
     */
    abstract function set_metadata($folder, $entries);
    /**
     * Unsets metadata/annotations (SETMETADATA/SETANNOTATION)
     *
@@ -992,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
@@ -1018,7 +964,6 @@
     */
    abstract function clear_cache($key = null, $prefix_mode = false);
    /**
     * Returns cached value
     *
@@ -1028,10 +973,8 @@
     */
    abstract function get_cache($key);
    /**
     * Delete outdated cache entries
     */
    abstract function cache_gc();
}  // end class rcube_storage
}