From 1495ac7913095ae8284c3501b7d4e6dd31a484ec Mon Sep 17 00:00:00 2001
From: alecpl <alec@alec.pl>
Date: Sat, 14 Apr 2012 07:15:28 -0400
Subject: [PATCH] - More public methods, code cleanup
---
program/include/rcmail.php | 1369 +++++++++++++++++++++--------------------------------------
1 files changed, 492 insertions(+), 877 deletions(-)
diff --git a/program/include/rcmail.php b/program/include/rcmail.php
index 9f26450..bca91e1 100644
--- a/program/include/rcmail.php
+++ b/program/include/rcmail.php
@@ -5,9 +5,12 @@
| program/include/rcmail.php |
| |
| This file is part of the Roundcube Webmail client |
- | Copyright (C) 2008-2011, The Roundcube Dev Team |
- | Copyright (C) 2011, Kolab Systems AG |
- | Licensed under the GNU GPL |
+ | Copyright (C) 2008-2012, The Roundcube Dev Team |
+ | Copyright (C) 2011-2012, Kolab Systems AG |
+ | |
+ | Licensed under the GNU General Public License version 3 or |
+ | any later version with exceptions for skins & plugins. |
+ | See the README file for a full license statement. |
| |
| PURPOSE: |
| Application class providing core functions and holding |
@@ -27,7 +30,7 @@
*
* @package Core
*/
-class rcmail
+class rcmail extends rcube
{
/**
* Main tasks.
@@ -35,76 +38,6 @@
* @var array
*/
static public $main_tasks = array('mail','settings','addressbook','login','logout','utils','dummy');
-
- /**
- * Singleton instace of rcmail
- *
- * @var rcmail
- */
- static private $instance;
-
- /**
- * Stores instance of rcube_config.
- *
- * @var rcube_config
- */
- public $config;
-
- /**
- * Stores rcube_user instance.
- *
- * @var rcube_user
- */
- public $user;
-
- /**
- * Instace of database class.
- *
- * @var rcube_mdb2
- */
- public $db;
-
- /**
- * Instace of Memcache class.
- *
- * @var rcube_mdb2
- */
- public $memcache;
-
- /**
- * Instace of rcube_session class.
- *
- * @var rcube_session
- */
- public $session;
-
- /**
- * Instance of rcube_smtp class.
- *
- * @var rcube_smtp
- */
- public $smtp;
-
- /**
- * Instance of rcube_imap class.
- *
- * @var rcube_imap
- */
- public $imap;
-
- /**
- * Instance of rcube_template class.
- *
- * @var rcube_template
- */
- public $output;
-
- /**
- * Instance of rcube_plugin_api.
- *
- * @var rcube_plugin_api
- */
- public $plugins;
/**
* Current task.
@@ -121,11 +54,8 @@
public $action = '';
public $comm_path = './';
- private $texts;
private $address_books = array();
- private $caches = array();
private $action_map = array();
- private $shutdown_functions = array();
/**
@@ -135,7 +65,7 @@
*/
static function get_instance()
{
- if (!self::$instance) {
+ if (!self::$instance || !is_a(self::$instance, 'rcmail')) {
self::$instance = new rcmail();
self::$instance->startup(); // init AFTER object was linked with self::$instance
}
@@ -145,34 +75,12 @@
/**
- * Private constructor
- */
- private function __construct()
- {
- // load configuration
- $this->config = new rcube_config();
-
- register_shutdown_function(array($this, 'shutdown'));
- }
-
-
- /**
* Initial startup function
* to register session, create database and imap connections
- *
- * @todo Remove global vars $DB, $USER
*/
- private function startup()
+ protected function startup()
{
- // initialize syslog
- if ($this->config->get('log_driver') == 'syslog') {
- $syslog_id = $this->config->get('syslog_id', 'roundcube');
- $syslog_facility = $this->config->get('syslog_facility', LOG_USER);
- openlog($syslog_id, LOG_ODELAY, $syslog_facility);
- }
-
- // connect to database
- $GLOBALS['DB'] = $this->get_dbh();
+ $this->init(self::INIT_WITH_DB | self::INIT_WITH_PLUGINS);
// start session
$this->session_init();
@@ -184,8 +92,8 @@
$this->session_configure();
// set task and action properties
- $this->set_task(get_input_value('_task', RCUBE_INPUT_GPC));
- $this->action = asciiwords(get_input_value('_action', RCUBE_INPUT_GPC));
+ $this->set_task(rcube_ui::get_input_value('_task', rcube_ui::INPUT_GPC));
+ $this->action = asciiwords(rcube_ui::get_input_value('_action', rcube_ui::INPUT_GPC));
// reset some session parameters when changing task
if ($this->task != 'utils') {
@@ -201,11 +109,9 @@
else
$GLOBALS['OUTPUT'] = $this->load_gui(!empty($_REQUEST['_framed']));
- // create plugin API and load plugins
- $this->plugins = rcube_plugin_api::get_instance();
-
- // init plugins
- $this->plugins->init();
+ // load plugins
+ $this->plugins->init($this, $this->task);
+ $this->plugins->load_plugins((array)$this->config->get('plugins', array()), array('filesystem_attachments', 'jqueryui'));
}
@@ -240,7 +146,6 @@
{
if (is_object($user)) {
$this->user = $user;
- $GLOBALS['USER'] = $this->user;
// overwrite config with user preferences
$this->config->set_user_prefs((array)$this->user->get_prefs());
@@ -254,144 +159,6 @@
// workaround for http://bugs.php.net/bug.php?id=18556
if (in_array($_SESSION['language'], array('tr_TR', 'ku', 'az_AZ')))
setlocale(LC_CTYPE, 'en_US' . '.utf8');
- }
-
-
- /**
- * Check the given string and return a valid language code
- *
- * @param string Language code
- * @return string Valid language code
- */
- private function language_prop($lang)
- {
- static $rcube_languages, $rcube_language_aliases;
-
- // user HTTP_ACCEPT_LANGUAGE if no language is specified
- if (empty($lang) || $lang == 'auto') {
- $accept_langs = explode(',', $_SERVER['HTTP_ACCEPT_LANGUAGE']);
- $lang = str_replace('-', '_', $accept_langs[0]);
- }
-
- if (empty($rcube_languages)) {
- @include(INSTALL_PATH . 'program/localization/index.inc');
- }
-
- // check if we have an alias for that language
- if (!isset($rcube_languages[$lang]) && isset($rcube_language_aliases[$lang])) {
- $lang = $rcube_language_aliases[$lang];
- }
- // try the first two chars
- else if (!isset($rcube_languages[$lang])) {
- $short = substr($lang, 0, 2);
-
- // check if we have an alias for the short language code
- if (!isset($rcube_languages[$short]) && isset($rcube_language_aliases[$short])) {
- $lang = $rcube_language_aliases[$short];
- }
- // expand 'nn' to 'nn_NN'
- else if (!isset($rcube_languages[$short])) {
- $lang = $short.'_'.strtoupper($short);
- }
- }
-
- if (!isset($rcube_languages[$lang]) || !is_dir(INSTALL_PATH . 'program/localization/' . $lang)) {
- $lang = 'en_US';
- }
-
- return $lang;
- }
-
-
- /**
- * Get the current database connection
- *
- * @return rcube_mdb2 Database connection object
- */
- public function get_dbh()
- {
- if (!$this->db) {
- $config_all = $this->config->all();
-
- $this->db = new rcube_mdb2($config_all['db_dsnw'], $config_all['db_dsnr'], $config_all['db_persistent']);
- $this->db->sqlite_initials = INSTALL_PATH . 'SQL/sqlite.initial.sql';
- $this->db->set_debug((bool)$config_all['sql_debug']);
- }
-
- return $this->db;
- }
-
-
- /**
- * Get global handle for memcache access
- *
- * @return object Memcache
- */
- public function get_memcache()
- {
- if (!isset($this->memcache)) {
- // no memcache support in PHP
- if (!class_exists('Memcache')) {
- $this->memcache = false;
- return false;
- }
-
- $this->memcache = new Memcache;
- $this->mc_available = 0;
-
- // add alll configured hosts to pool
- $pconnect = $this->config->get('memcache_pconnect', true);
- foreach ($this->config->get('memcache_hosts', array()) as $host) {
- list($host, $port) = explode(':', $host);
- if (!$port) $port = 11211;
- $this->mc_available += intval($this->memcache->addServer($host, $port, $pconnect, 1, 1, 15, false, array($this, 'memcache_failure')));
- }
-
- // test connection and failover (will result in $this->mc_available == 0 on complete failure)
- $this->memcache->increment('__CONNECTIONTEST__', 1); // NOP if key doesn't exist
-
- if (!$this->mc_available)
- $this->memcache = false;
- }
-
- return $this->memcache;
- }
-
- /**
- * Callback for memcache failure
- */
- public function memcache_failure($host, $port)
- {
- static $seen = array();
-
- // only report once
- if (!$seen["$host:$port"]++) {
- $this->mc_available--;
- raise_error(array('code' => 604, 'type' => 'db',
- 'line' => __LINE__, 'file' => __FILE__,
- 'message' => "Memcache failure on host $host:$port"),
- true, false);
- }
- }
-
-
- /**
- * Initialize and get cache object
- *
- * @param string $name Cache identifier
- * @param string $type Cache type ('db', 'apc' or 'memcache')
- * @param int $ttl Expiration time for cache items in seconds
- * @param bool $packed Enables/disables data serialization
- *
- * @return rcube_cache Cache object
- */
- public function get_cache($name, $type='db', $ttl=0, $packed=true)
- {
- if (!isset($this->caches[$name])) {
- $this->caches[$name] = new rcube_cache($type, $_SESSION['user_id'], $name, $ttl, $packed);
- }
-
- return $this->caches[$name];
}
@@ -421,10 +188,10 @@
$contacts = $this->address_books[$id];
}
else if ($id && $ldap_config[$id]) {
- $contacts = new rcube_ldap($ldap_config[$id], $this->config->get('ldap_debug'), $this->config->mail_domain($_SESSION['imap_host']));
+ $contacts = new rcube_ldap($ldap_config[$id], $this->config->get('ldap_debug'), $this->config->mail_domain($_SESSION['storage_host']));
}
else if ($id === '0') {
- $contacts = new rcube_contacts($this->db, $this->user->ID);
+ $contacts = new rcube_contacts($this->db, $this->get_user_id());
}
else {
$plugin = $this->plugins->exec_hook('addressbook_get', array('id' => $id, 'writeable' => $writeable));
@@ -445,12 +212,16 @@
}
if (!$contacts) {
- raise_error(array(
+ self::raise_error(array(
'code' => 700, 'type' => 'php',
'file' => __FILE__, 'line' => __LINE__,
'message' => "Addressbook source ($id) not found!"),
true, true);
}
+
+ // set configured sort order
+ if ($sort_col = $this->config->get('addressbook_sort_col'))
+ $contacts->set_sort_order($sort_col);
// add to the 'books' array for shutdown function
$this->address_books[$id] = $contacts;
@@ -476,10 +247,10 @@
// We are using the DB address book
if ($abook_type != 'ldap') {
if (!isset($this->address_books['0']))
- $this->address_books['0'] = new rcube_contacts($this->db, $this->user->ID);
+ $this->address_books['0'] = new rcube_contacts($this->db, $this->get_user_id());
$list['0'] = array(
'id' => '0',
- 'name' => rcube_label('personaladrbook'),
+ 'name' => $this->gettext('personaladrbook'),
'groups' => $this->address_books['0']->groups,
'readonly' => $this->address_books['0']->readonly,
'autocomplete' => in_array('sql', $autocomplete),
@@ -489,7 +260,11 @@
if ($ldap_config) {
$ldap_config = (array) $ldap_config;
- foreach ($ldap_config as $id => $prop)
+ foreach ($ldap_config as $id => $prop) {
+ // handle misconfiguration
+ if (empty($prop) || !is_array($prop)) {
+ continue;
+ }
$list[$id] = array(
'id' => $id,
'name' => $prop['name'],
@@ -498,6 +273,7 @@
'hidden' => $prop['hidden'],
'autocomplete' => in_array($id, $autocomplete)
);
+ }
}
$plugin = $this->plugins->exec_hook('addressbooks_list', array('sources' => $list));
@@ -522,13 +298,13 @@
* environment vars according to the current session and configuration
*
* @param boolean True if this request is loaded in a (i)frame
- * @return rcube_template Reference to HTML output object
+ * @return rcube_output_html Reference to HTML output object
*/
public function load_gui($framed = false)
{
// init output page
- if (!($this->output instanceof rcube_template))
- $this->output = new rcube_template($this->task, $framed);
+ if (!($this->output instanceof rcube_output_html))
+ $this->output = new rcube_output_html($this->task, $framed);
// set keep-alive/check-recent interval
if ($this->session && ($keep_alive = $this->session->get_keep_alive())) {
@@ -555,115 +331,14 @@
/**
* Create an output object for JSON responses
*
- * @return rcube_json_output Reference to JSON output object
+ * @return rcube_output_json Reference to JSON output object
*/
public function json_init()
{
- if (!($this->output instanceof rcube_json_output))
- $this->output = new rcube_json_output($this->task);
+ if (!($this->output instanceof rcube_output_json))
+ $this->output = new rcube_output_json($this->task);
return $this->output;
- }
-
-
- /**
- * Create SMTP object and connect to server
- *
- * @param boolean True if connection should be established
- */
- public function smtp_init($connect = false)
- {
- $this->smtp = new rcube_smtp();
-
- if ($connect)
- $this->smtp->connect();
- }
-
-
- /**
- * Create global IMAP object and connect to server
- *
- * @param boolean True if connection should be established
- */
- public function imap_init($connect = false)
- {
- // already initialized
- if (is_object($this->imap))
- return;
-
- $this->imap = new rcube_imap();
- $this->imap->skip_deleted = $this->config->get('skip_deleted');
-
- // enable caching of imap data
- $imap_cache = $this->config->get('imap_cache');
- $messages_cache = $this->config->get('messages_cache');
- // for backward compatybility
- if ($imap_cache === null && $messages_cache === null && $this->config->get('enable_caching')) {
- $imap_cache = 'db';
- $messages_cache = true;
- }
- if ($imap_cache)
- $this->imap->set_caching($imap_cache);
- if ($messages_cache)
- $this->imap->set_messages_caching(true);
-
- // set pagesize from config
- $this->imap->set_pagesize($this->config->get('pagesize', 50));
-
- // Setting root and delimiter before establishing the connection
- // can save time detecting them using NAMESPACE and LIST
- $options = array(
- 'auth_type' => $this->config->get('imap_auth_type', 'check'),
- 'auth_cid' => $this->config->get('imap_auth_cid'),
- 'auth_pw' => $this->config->get('imap_auth_pw'),
- 'debug' => (bool) $this->config->get('imap_debug', 0),
- 'force_caps' => (bool) $this->config->get('imap_force_caps'),
- 'timeout' => (int) $this->config->get('imap_timeout', 0),
- );
-
- $this->imap->set_options($options);
-
- // set global object for backward compatibility
- $GLOBALS['IMAP'] = $this->imap;
-
- $hook = $this->plugins->exec_hook('imap_init', array('fetch_headers' => $this->imap->fetch_add_headers));
- if ($hook['fetch_headers'])
- $this->imap->fetch_add_headers = $hook['fetch_headers'];
-
- // support this parameter for backward compatibility but log warning
- if ($connect) {
- $this->imap_connect();
- raise_error(array(
- 'code' => 800, 'type' => 'imap',
- 'file' => __FILE__, 'line' => __LINE__,
- 'message' => "rcube::imap_init(true) is deprecated, use rcube::imap_connect() instead"),
- true, false);
- }
- }
-
-
- /**
- * Connect to IMAP server with stored session data
- *
- * @return bool True on success, false on error
- */
- public function imap_connect()
- {
- if (!$this->imap)
- $this->imap_init();
-
- if ($_SESSION['imap_host'] && !$this->imap->conn->connected()) {
- if (!$this->imap->connect($_SESSION['imap_host'], $_SESSION['username'], $this->decrypt($_SESSION['password']), $_SESSION['imap_port'], $_SESSION['imap_ssl'])) {
- if ($this->output)
- $this->output->show_message($this->imap->get_error_code() == -1 ? 'imaperror' : 'sessionerror', 'error');
- }
- else {
- $this->set_imap_prop();
- return $this->imap->conn;
- }
- }
-
- return false;
}
@@ -689,7 +364,7 @@
ini_set('session.gc_maxlifetime', $lifetime * 2);
}
- ini_set('session.cookie_secure', rcube_https_check());
+ ini_set('session.cookie_secure', rcube_ui::https_check());
ini_set('session.name', $sess_name ? $sess_name : 'roundcube_sessid');
ini_set('session.use_cookies', 1);
ini_set('session.use_only_cookies', 1);
@@ -698,9 +373,8 @@
// use database for storing session data
$this->session = new rcube_session($this->get_dbh(), $this->config);
- $this->session->register_gc_handler('rcmail_temp_gc');
- if ($this->config->get('enable_caching'))
- $this->session->register_gc_handler('rcmail_cache_gc');
+ $this->session->register_gc_handler(array($this, 'temp_gc'));
+ $this->session->register_gc_handler(array($this, 'cache_gc'));
// start PHP session (if not in CLI mode)
if ($_SERVER['REMOTE_ADDR'])
@@ -709,6 +383,10 @@
// set initial session vars
if (!$_SESSION['user_id'])
$_SESSION['temp'] = true;
+
+ // restore skin selection after logout
+ if ($_SESSION['temp'] && !empty($_SESSION['skin']))
+ $this->config->set('skin', $_SESSION['skin']);
}
@@ -737,17 +415,21 @@
/**
- * Perfom login to the IMAP server and to the webmail service.
+ * Perfom login to the mail server and to the webmail service.
* This will also create a new user entry if auto_create_user is configured.
*
- * @param string IMAP user name
- * @param string IMAP password
- * @param string IMAP host
+ * @param string Mail storage (IMAP) user name
+ * @param string Mail storage (IMAP) password
+ * @param string Mail storage (IMAP) host
+ *
* @return boolean True on success, False on failure
*/
function login($username, $pass, $host=NULL)
{
- $user = NULL;
+ if (empty($username)) {
+ return false;
+ }
+
$config = $this->config->all();
if (!$host)
@@ -767,21 +449,23 @@
if (!$allowed)
return false;
}
- else if (!empty($config['default_host']) && $host != rcube_parse_host($config['default_host']))
+ else if (!empty($config['default_host']) && $host != self::parse_host($config['default_host']))
return false;
// parse $host URL
$a_host = parse_url($host);
if ($a_host['host']) {
$host = $a_host['host'];
- $imap_ssl = (isset($a_host['scheme']) && in_array($a_host['scheme'], array('ssl','imaps','tls'))) ? $a_host['scheme'] : null;
+ $ssl = (isset($a_host['scheme']) && in_array($a_host['scheme'], array('ssl','imaps','tls'))) ? $a_host['scheme'] : null;
if (!empty($a_host['port']))
- $imap_port = $a_host['port'];
- else if ($imap_ssl && $imap_ssl != 'tls' && (!$config['default_port'] || $config['default_port'] == 143))
- $imap_port = 993;
+ $port = $a_host['port'];
+ else if ($ssl && $ssl != 'tls' && (!$config['default_port'] || $config['default_port'] == 143))
+ $port = 993;
}
- $imap_port = $imap_port ? $imap_port : $config['default_port'];
+ if (!$port) {
+ $port = $config['default_port'];
+ }
/* Modify username with domain if required
Inspired by Marco <P0L0_notspam_binware.org>
@@ -789,12 +473,12 @@
// Check if we need to add domain
if (!empty($config['username_domain']) && strpos($username, '@') === false) {
if (is_array($config['username_domain']) && isset($config['username_domain'][$host]))
- $username .= '@'.rcube_parse_host($config['username_domain'][$host], $host);
+ $username .= '@'.self::parse_host($config['username_domain'][$host], $host);
else if (is_string($config['username_domain']))
- $username .= '@'.rcube_parse_host($config['username_domain'], $host);
+ $username .= '@'.self::parse_host($config['username_domain'], $host);
}
- // Convert username to lowercase. If IMAP backend
+ // Convert username to lowercase. If storage backend
// is case-insensitive we need to store always the same username (#1487113)
if ($config['login_lc']) {
$username = mb_strtolower($username);
@@ -819,11 +503,11 @@
if ($user = rcube_user::query($username, $host))
$username = $user->data['username'];
- if (!$this->imap)
- $this->imap_init();
+ if (!$this->storage)
+ $this->storage_init();
- // try IMAP login
- if (!($imap_login = $this->imap->connect($host, $username, $pass, $imap_port, $imap_ssl))) {
+ // try to log in
+ if (!($login = $this->storage->connect($host, $username, $pass, $port, $ssl))) {
// try with lowercase
$username_lc = mb_strtolower($username);
if ($username_lc != $username) {
@@ -831,14 +515,15 @@
if (!$user && ($user = rcube_user::query($username_lc, $host)))
$username_lc = $user->data['username'];
- if ($imap_login = $this->imap->connect($host, $username_lc, $pass, $imap_port, $imap_ssl))
+ if ($login = $this->storage->connect($host, $username_lc, $pass, $port, $ssl))
$username = $username_lc;
}
}
- // exit if IMAP login failed
- if (!$imap_login)
+ // exit if login failed
+ if (!$login) {
return false;
+ }
// user already registered -> update user's record
if (is_object($user)) {
@@ -851,7 +536,7 @@
$user = $created;
}
else {
- raise_error(array(
+ self::raise_error(array(
'code' => 620, 'type' => 'php',
'file' => __FILE__, 'line' => __LINE__,
'message' => "Failed to create a user record. Maybe aborted by a plugin?"
@@ -859,7 +544,7 @@
}
}
else {
- raise_error(array(
+ self::raise_error(array(
'code' => 621, 'type' => 'php',
'file' => __FILE__, 'line' => __LINE__,
'message' => "Access denied for new user $username. 'auto_create_user' is disabled"
@@ -870,7 +555,7 @@
if (is_object($user) && $user->ID) {
// Configure environment
$this->set_user($user);
- $this->set_imap_prop();
+ $this->set_storage_prop();
$this->session_configure();
// fix some old settings according to namespace prefix
@@ -878,17 +563,17 @@
// create default folders on first login
if ($config['create_default_folders'] && (!empty($created) || empty($user->data['last_login']))) {
- $this->imap->create_default_folders();
+ $this->storage->create_default_folders();
}
// set session vars
- $_SESSION['user_id'] = $user->ID;
- $_SESSION['username'] = $user->data['username'];
- $_SESSION['imap_host'] = $host;
- $_SESSION['imap_port'] = $imap_port;
- $_SESSION['imap_ssl'] = $imap_ssl;
- $_SESSION['password'] = $this->encrypt($pass);
- $_SESSION['login_time'] = mktime();
+ $_SESSION['user_id'] = $user->ID;
+ $_SESSION['username'] = $user->data['username'];
+ $_SESSION['storage_host'] = $host;
+ $_SESSION['storage_port'] = $port;
+ $_SESSION['storage_ssl'] = $ssl;
+ $_SESSION['password'] = $this->encrypt($pass);
+ $_SESSION['login_time'] = mktime();
if (isset($_REQUEST['_timezone']) && $_REQUEST['_timezone'] != '_default_')
$_SESSION['timezone'] = floatval($_REQUEST['_timezone']);
@@ -896,32 +581,12 @@
$_SESSION['dst_active'] = intval($_REQUEST['_dstactive']);
// force reloading complete list of subscribed mailboxes
- $this->imap->clear_cache('mailboxes', true);
+ $this->storage->clear_cache('mailboxes', true);
return true;
}
return false;
- }
-
-
- /**
- * Set root dir and last stored mailbox
- * This must be done AFTER connecting to the server!
- */
- public function set_imap_prop()
- {
- $this->imap->set_charset($this->config->get('default_charset', RCMAIL_CHARSET));
-
- if ($default_folders = $this->config->get('default_imap_folders')) {
- $this->imap->set_default_mailboxes($default_folders);
- }
- if (isset($_SESSION['mbox'])) {
- $this->imap->set_mailbox($_SESSION['mbox']);
- }
- if (isset($_SESSION['page'])) {
- $this->imap->set_page($_SESSION['page']);
- }
}
@@ -936,7 +601,7 @@
$host = null;
if (is_array($default_host)) {
- $post_host = get_input_value('_host', RCUBE_INPUT_POST);
+ $post_host = rcube_ui::get_input_value('_host', rcube_ui::INPUT_POST);
// direct match in default_host array
if ($default_host[$post_host] || in_array($post_host, array_values($default_host))) {
@@ -944,190 +609,33 @@
}
// try to select host by mail domain
- list($user, $domain) = explode('@', get_input_value('_user', RCUBE_INPUT_POST));
+ list($user, $domain) = explode('@', rcube_ui::get_input_value('_user', rcube_ui::INPUT_POST));
if (!empty($domain)) {
- foreach ($default_host as $imap_host => $mail_domains) {
- if (is_array($mail_domains) && in_array($domain, $mail_domains)) {
- $host = $imap_host;
+ foreach ($default_host as $storage_host => $mail_domains) {
+ if (is_array($mail_domains) && in_array_nocase($domain, $mail_domains)) {
+ $host = $storage_host;
+ break;
+ }
+ else if (stripos($storage_host, $domain) !== false || stripos(strval($mail_domains), $domain) !== false) {
+ $host = is_numeric($storage_host) ? $mail_domains : $storage_host;
break;
}
}
}
- // take the first entry if $host is still an array
+ // take the first entry if $host is still not set
if (empty($host)) {
- $host = array_shift($default_host);
+ list($key, $val) = each($default_host);
+ $host = is_numeric($key) ? $val : $key;
}
}
else if (empty($default_host)) {
- $host = get_input_value('_host', RCUBE_INPUT_POST);
+ $host = rcube_ui::get_input_value('_host', rcube_ui::INPUT_POST);
}
else
- $host = rcube_parse_host($default_host);
+ $host = self::parse_host($default_host);
return $host;
- }
-
-
- /**
- * Get localized text in the desired language
- *
- * @param mixed $attrib Named parameters array or label name
- * @param string $domain Label domain (plugin) name
- *
- * @return string Localized text
- */
- public function gettext($attrib, $domain=null)
- {
- // load localization files if not done yet
- if (empty($this->texts))
- $this->load_language();
-
- // extract attributes
- if (is_string($attrib))
- $attrib = array('name' => $attrib);
-
- $name = $attrib['name'] ? $attrib['name'] : '';
-
- // attrib contain text values: use them from now
- if (($setval = $attrib[strtolower($_SESSION['language'])]) || ($setval = $attrib['en_us']))
- $this->texts[$name] = $setval;
-
- // check for text with domain
- if ($domain && ($text = $this->texts[$domain.'.'.$name]))
- ;
- // text does not exist
- else if (!($text = $this->texts[$name])) {
- return "[$name]";
- }
-
- // replace vars in text
- if (is_array($attrib['vars'])) {
- foreach ($attrib['vars'] as $var_key => $var_value)
- $text = str_replace($var_key[0]!='$' ? '$'.$var_key : $var_key, $var_value, $text);
- }
-
- // format output
- if (($attrib['uppercase'] && strtolower($attrib['uppercase']=='first')) || $attrib['ucfirst'])
- return ucfirst($text);
- else if ($attrib['uppercase'])
- return mb_strtoupper($text);
- else if ($attrib['lowercase'])
- return mb_strtolower($text);
-
- return strtr($text, array('\n' => "\n"));
- }
-
-
- /**
- * Check if the given text label exists
- *
- * @param string $name Label name
- * @param string $domain Label domain (plugin) name or '*' for all domains
- * @param string $ref_domain Sets domain name if label is found
- *
- * @return boolean True if text exists (either in the current language or in en_US)
- */
- public function text_exists($name, $domain = null, &$ref_domain = null)
- {
- // load localization files if not done yet
- if (empty($this->texts))
- $this->load_language();
-
- if (isset($this->texts[$name])) {
- $ref_domain = '';
- return true;
- }
-
- // any of loaded domains (plugins)
- if ($domain == '*') {
- foreach ($this->plugins->loaded_plugins() as $domain)
- if (isset($this->texts[$domain.'.'.$name])) {
- $ref_domain = $domain;
- return true;
- }
- }
- // specified domain
- else if ($domain) {
- $ref_domain = $domain;
- return isset($this->texts[$domain.'.'.$name]);
- }
-
- return false;
- }
-
- /**
- * Load a localization package
- *
- * @param string Language ID
- */
- public function load_language($lang = null, $add = array())
- {
- $lang = $this->language_prop(($lang ? $lang : $_SESSION['language']));
-
- // load localized texts
- if (empty($this->texts) || $lang != $_SESSION['language']) {
- $this->texts = array();
-
- // handle empty lines after closing PHP tag in localization files
- ob_start();
-
- // get english labels (these should be complete)
- @include(INSTALL_PATH . 'program/localization/en_US/labels.inc');
- @include(INSTALL_PATH . 'program/localization/en_US/messages.inc');
-
- if (is_array($labels))
- $this->texts = $labels;
- if (is_array($messages))
- $this->texts = array_merge($this->texts, $messages);
-
- // include user language files
- if ($lang != 'en' && is_dir(INSTALL_PATH . 'program/localization/' . $lang)) {
- include_once(INSTALL_PATH . 'program/localization/' . $lang . '/labels.inc');
- include_once(INSTALL_PATH . 'program/localization/' . $lang . '/messages.inc');
-
- if (is_array($labels))
- $this->texts = array_merge($this->texts, $labels);
- if (is_array($messages))
- $this->texts = array_merge($this->texts, $messages);
- }
-
- ob_end_clean();
-
- $_SESSION['language'] = $lang;
- }
-
- // append additional texts (from plugin)
- if (is_array($add) && !empty($add))
- $this->texts += $add;
- }
-
-
- /**
- * Read directory program/localization and return a list of available languages
- *
- * @return array List of available localizations
- */
- public function list_languages()
- {
- static $sa_languages = array();
-
- if (!sizeof($sa_languages)) {
- @include(INSTALL_PATH . 'program/localization/index.inc');
-
- if ($dh = @opendir(INSTALL_PATH . 'program/localization')) {
- while (($name = readdir($dh)) !== false) {
- if ($name[0] == '.' || !is_dir(INSTALL_PATH . 'program/localization/' . $name))
- continue;
-
- if ($label = $rcube_languages[$name])
- $sa_languages[$name] = $label;
- }
- closedir($dh);
- }
- }
-
- return $sa_languages;
}
@@ -1139,7 +647,7 @@
$this->plugins->exec_hook('session_destroy');
$this->session->kill();
- $_SESSION = array('language' => $this->user->language, 'temp' => true);
+ $_SESSION = array('language' => $this->user->language, 'temp' => true, 'skin' => $this->config->get('skin'));
$this->user->reset();
}
@@ -1156,15 +664,15 @@
if (!$this->session->check_auth())
return;
- $this->imap_connect();
+ $this->storage_connect();
}
if ($config['logout_purge'] && !empty($config['trash_mbox'])) {
- $this->imap->clear_mailbox($config['trash_mbox']);
+ $this->storage->clear_folder($config['trash_mbox']);
}
if ($config['logout_expunge']) {
- $this->imap->expunge('INBOX');
+ $this->storage->expunge_folder('INBOX');
}
// Try to save unsaved user preferences
@@ -1175,61 +683,14 @@
/**
- * Function to be executed in script shutdown
- * Registered with register_shutdown_function()
+ * Garbage collector for cache entries.
+ * Set flag to expunge caches on shutdown
*/
- public function shutdown()
+ function cache_gc()
{
- foreach ($this->shutdown_functions as $function)
- call_user_func($function);
-
- if (is_object($this->smtp))
- $this->smtp->disconnect();
-
- foreach ($this->address_books as $book) {
- if (is_object($book) && is_a($book, 'rcube_addressbook'))
- $book->close();
- }
-
- foreach ($this->caches as $cache) {
- if (is_object($cache))
- $cache->close();
- }
-
- if (is_object($this->imap))
- $this->imap->close();
-
- // before closing the database connection, write session data
- if ($_SERVER['REMOTE_ADDR'] && is_object($this->session)) {
- session_write_close();
- }
-
- // write performance stats to logs/console
- if ($this->config->get('devel_mode')) {
- if (function_exists('memory_get_usage'))
- $mem = show_bytes(memory_get_usage());
- if (function_exists('memory_get_peak_usage'))
- $mem .= '/'.show_bytes(memory_get_peak_usage());
-
- $log = $this->task . ($this->action ? '/'.$this->action : '') . ($mem ? " [$mem]" : '');
- if (defined('RCMAIL_START'))
- rcube_print_time(RCMAIL_START, $log);
- else
- console($log);
- }
- }
-
-
- /**
- * Registers shutdown function to be executed on shutdown.
- * The functions will be executed before destroying any
- * objects like smtp, imap, session, etc.
- *
- * @param callback Function callback
- */
- public function add_shutdown_function($function)
- {
- $this->shutdown_functions[] = $function;
+ // because this gc function is called before storage is initialized,
+ // we just set a flag to expunge storage cache on shutdown.
+ $this->expunge_cache = true;
}
@@ -1242,7 +703,7 @@
{
$sess_id = $_COOKIE[ini_get('session.name')];
if (!$sess_id) $sess_id = session_id();
- $plugin = $this->plugins->exec_hook('request_token', array('value' => md5('RT' . $this->user->ID . $this->config->get('des_key') . $sess_id)));
+ $plugin = $this->plugins->exec_hook('request_token', array('value' => md5('RT' . $this->get_user_id() . $this->config->get('des_key') . $sess_id)));
return $plugin['value'];
}
@@ -1253,9 +714,9 @@
* @param int Request method
* @return boolean True if request token is valid false if not
*/
- public function check_request($mode = RCUBE_INPUT_POST)
+ public function check_request($mode = rcube_ui::INPUT_POST)
{
- $token = get_input_value('_token', $mode);
+ $token = rcube_ui::get_input_value('_token', $mode);
$sess_id = $_COOKIE[ini_get('session.name')];
return !empty($sess_id) && $token == $this->get_request_token();
}
@@ -1284,130 +745,6 @@
/**
- * Encrypt using 3DES
- *
- * @param string $clear clear text input
- * @param string $key encryption key to retrieve from the configuration, defaults to 'des_key'
- * @param boolean $base64 whether or not to base64_encode() the result before returning
- *
- * @return string encrypted text
- */
- public function encrypt($clear, $key = 'des_key', $base64 = true)
- {
- if (!$clear)
- return '';
- /*-
- * Add a single canary byte to the end of the clear text, which
- * will help find out how much of padding will need to be removed
- * upon decryption; see http://php.net/mcrypt_generic#68082
- */
- $clear = pack("a*H2", $clear, "80");
-
- if (function_exists('mcrypt_module_open') &&
- ($td = mcrypt_module_open(MCRYPT_TripleDES, "", MCRYPT_MODE_CBC, "")))
- {
- $iv = $this->create_iv(mcrypt_enc_get_iv_size($td));
- mcrypt_generic_init($td, $this->config->get_crypto_key($key), $iv);
- $cipher = $iv . mcrypt_generic($td, $clear);
- mcrypt_generic_deinit($td);
- mcrypt_module_close($td);
- }
- else {
- @include_once 'des.inc';
-
- if (function_exists('des')) {
- $des_iv_size = 8;
- $iv = $this->create_iv($des_iv_size);
- $cipher = $iv . des($this->config->get_crypto_key($key), $clear, 1, 1, $iv);
- }
- else {
- raise_error(array(
- 'code' => 500, 'type' => 'php',
- 'file' => __FILE__, 'line' => __LINE__,
- 'message' => "Could not perform encryption; make sure Mcrypt is installed or lib/des.inc is available"
- ), true, true);
- }
- }
-
- return $base64 ? base64_encode($cipher) : $cipher;
- }
-
- /**
- * Decrypt 3DES-encrypted string
- *
- * @param string $cipher encrypted text
- * @param string $key encryption key to retrieve from the configuration, defaults to 'des_key'
- * @param boolean $base64 whether or not input is base64-encoded
- *
- * @return string decrypted text
- */
- public function decrypt($cipher, $key = 'des_key', $base64 = true)
- {
- if (!$cipher)
- return '';
-
- $cipher = $base64 ? base64_decode($cipher) : $cipher;
-
- if (function_exists('mcrypt_module_open') &&
- ($td = mcrypt_module_open(MCRYPT_TripleDES, "", MCRYPT_MODE_CBC, "")))
- {
- $iv_size = mcrypt_enc_get_iv_size($td);
- $iv = substr($cipher, 0, $iv_size);
-
- // session corruption? (#1485970)
- if (strlen($iv) < $iv_size)
- return '';
-
- $cipher = substr($cipher, $iv_size);
- mcrypt_generic_init($td, $this->config->get_crypto_key($key), $iv);
- $clear = mdecrypt_generic($td, $cipher);
- mcrypt_generic_deinit($td);
- mcrypt_module_close($td);
- }
- else {
- @include_once 'des.inc';
-
- if (function_exists('des')) {
- $des_iv_size = 8;
- $iv = substr($cipher, 0, $des_iv_size);
- $cipher = substr($cipher, $des_iv_size);
- $clear = des($this->config->get_crypto_key($key), $cipher, 0, 1, $iv);
- }
- else {
- raise_error(array(
- 'code' => 500, 'type' => 'php',
- 'file' => __FILE__, 'line' => __LINE__,
- 'message' => "Could not perform decryption; make sure Mcrypt is installed or lib/des.inc is available"
- ), true, true);
- }
- }
-
- /*-
- * Trim PHP's padding and the canary byte; see note in
- * rcmail::encrypt() and http://php.net/mcrypt_generic#68082
- */
- $clear = substr(rtrim($clear, "\0"), 0, -1);
-
- return $clear;
- }
-
- /**
- * Generates encryption initialization vector (IV)
- *
- * @param int Vector size
- * @return string Vector string
- */
- private function create_iv($size)
- {
- // mcrypt_create_iv() can be slow when system lacks entrophy
- // we'll generate IV vector manually
- $iv = '';
- for ($i = 0; $i < $size; $i++)
- $iv .= chr(mt_rand(0, 255));
- return $iv;
- }
-
- /**
* Build a valid URL to this instance of Roundcube
*
* @param mixed Either a string with the action or url parameters as key-value pairs
@@ -1425,7 +762,7 @@
$url = './';
$delm = '?';
foreach (array_reverse($p) as $key => $val) {
- if ($val !== '') {
+ if ($val !== '' && $val !== null) {
$par = $key[0] == '_' ? $key : '_'.$key;
$url .= $delm.urlencode($par).'='.urlencode($val);
$delm = '&';
@@ -1436,110 +773,36 @@
/**
- * Use imagemagick or GD lib to read image properties
- *
- * @param string Absolute file path
- * @return mixed Hash array with image props like type, width, height or False on error
+ * Function to be executed in script shutdown
*/
- public static function imageprops($filepath)
+ public function shutdown()
{
- $rcmail = rcmail::get_instance();
- if ($cmd = $rcmail->config->get('im_identify_path', false)) {
- list(, $type, $size) = explode(' ', strtolower(rcmail::exec($cmd. ' 2>/dev/null {in}', array('in' => $filepath))));
- if ($size)
- list($width, $height) = explode('x', $size);
- }
- else if (function_exists('getimagesize')) {
- $imsize = @getimagesize($filepath);
- $width = $imsize[0];
- $height = $imsize[1];
- $type = preg_replace('!image/!', '', $imsize['mime']);
+ parent::shutdown();
+
+ foreach ($this->address_books as $book) {
+ if (is_object($book) && is_a($book, 'rcube_addressbook'))
+ $book->close();
}
- return $type ? array('type' => $type, 'width' => $width, 'height' => $height) : false;
- }
-
-
- /**
- * Convert an image to a given size and type using imagemagick (ensures input is an image)
- *
- * @param $p['in'] Input filename (mandatory)
- * @param $p['out'] Output filename (mandatory)
- * @param $p['size'] Width x height of resulting image, e.g. "160x60"
- * @param $p['type'] Output file type, e.g. "jpg"
- * @param $p['-opts'] Custom command line options to ImageMagick convert
- * @return Success of convert as true/false
- */
- public static function imageconvert($p)
- {
- $result = false;
- $rcmail = rcmail::get_instance();
- $convert = $rcmail->config->get('im_convert_path', false);
- $identify = $rcmail->config->get('im_identify_path', false);
-
- // imagemagick is required for this
- if (!$convert)
- return false;
-
- if (!(($imagetype = @exif_imagetype($p['in'])) && ($type = image_type_to_extension($imagetype, false))))
- list(, $type) = explode(' ', strtolower(rcmail::exec($identify . ' 2>/dev/null {in}', $p))); # for things like eps
-
- $type = strtr($type, array("jpeg" => "jpg", "tiff" => "tif", "ps" => "eps", "ept" => "eps"));
- $p += array('type' => $type, 'types' => "bmp,eps,gif,jp2,jpg,png,svg,tif", 'quality' => 75);
- $p['-opts'] = array('-resize' => $p['size'].'>') + (array)$p['-opts'];
-
- if (in_array($type, explode(',', $p['types']))) # Valid type?
- $result = rcmail::exec($convert . ' 2>&1 -flatten -auto-orient -colorspace RGB -quality {quality} {-opts} {in} {type}:{out}', $p) === "";
-
- return $result;
- }
-
-
- /**
- * Construct shell command, execute it and return output as string.
- * Keywords {keyword} are replaced with arguments
- *
- * @param $cmd Format string with {keywords} to be replaced
- * @param $values (zero, one or more arrays can be passed)
- * @return output of command. shell errors not detectable
- */
- public static function exec(/* $cmd, $values1 = array(), ... */)
- {
- $args = func_get_args();
- $cmd = array_shift($args);
- $values = $replacements = array();
-
- // merge values into one array
- foreach ($args as $arg)
- $values += (array)$arg;
-
- preg_match_all('/({(-?)([a-z]\w*)})/', $cmd, $matches, PREG_SET_ORDER);
- foreach ($matches as $tags) {
- list(, $tag, $option, $key) = $tags;
- $parts = array();
-
- if ($option) {
- foreach ((array)$values["-$key"] as $key => $value) {
- if ($value === true || $value === false || $value === null)
- $parts[] = $value ? $key : "";
- else foreach ((array)$value as $val)
- $parts[] = "$key " . escapeshellarg($val);
- }
- }
- else {
- foreach ((array)$values[$key] as $value)
- $parts[] = escapeshellarg($value);
- }
-
- $replacements[$tag] = join(" ", $parts);
+ // before closing the database connection, write session data
+ if ($_SERVER['REMOTE_ADDR'] && is_object($this->session)) {
+ session_write_close();
}
- // use strtr behaviour of going through source string once
- $cmd = strtr($cmd, $replacements);
+ // write performance stats to logs/console
+ if ($this->config->get('devel_mode')) {
+ if (function_exists('memory_get_usage'))
+ $mem = rcube_ui::show_bytes(memory_get_usage());
+ if (function_exists('memory_get_peak_usage'))
+ $mem .= '/'.rcube_ui::show_bytes(memory_get_peak_usage());
- return (string)shell_exec($cmd);
+ $log = $this->task . ($this->action ? '/'.$this->action : '') . ($mem ? " [$mem]" : '');
+ if (defined('RCMAIL_START'))
+ self::print_timer(RCMAIL_START, $log);
+ else
+ self::console($log);
+ }
}
-
/**
* Helper method to set a cookie with the current path and host settings
@@ -1556,7 +819,7 @@
$cookie = session_get_cookie_params();
setcookie($name, $value, $exp, $cookie['path'], $cookie['domain'],
- rcube_https_check(), true);
+ rcube_ui::https_check(), true);
}
/**
@@ -1596,7 +859,7 @@
*/
private function fix_namespace_settings($user)
{
- $prefix = $this->imap->get_namespace('prefix');
+ $prefix = $this->storage->get_namespace('prefix');
$prefix_len = strlen($prefix);
if (!$prefix_len)
@@ -1607,7 +870,7 @@
return;
// Build namespace prefix regexp
- $ns = $this->imap->get_namespace();
+ $ns = $this->storage->get_namespace();
$regexp = array();
foreach ($ns as $entry) {
@@ -1631,10 +894,10 @@
}
}
- if (!empty($prefs['default_imap_folders'])) {
- foreach ($prefs['default_imap_folders'] as $idx => $name) {
+ if (!empty($prefs['default_folders'])) {
+ foreach ($prefs['default_folders'] as $idx => $name) {
if ($name != 'INBOX' && !preg_match($regexp, $name)) {
- $prefs['default_imap_folders'][$idx] = $prefix.$name;
+ $prefs['default_folders'][$idx] = $prefix.$name;
}
}
}
@@ -1684,7 +947,359 @@
// save updated preferences and reset imap settings (default folders)
$user->save_prefs($prefs);
- $this->set_imap_prop();
+ $this->set_storage_prop();
}
+
+ /**
+ * Overwrite action variable
+ *
+ * @param string New action value
+ */
+ public function overwrite_action($action)
+ {
+ $this->action = $action;
+ $this->output->set_env('action', $action);
+ }
+
+
+ /**
+ * Send the given message using the configured method.
+ *
+ * @param object $message Reference to Mail_MIME object
+ * @param string $from Sender address string
+ * @param array $mailto Array of recipient address strings
+ * @param array $smtp_error SMTP error array (reference)
+ * @param string $body_file Location of file with saved message body (reference),
+ * used when delay_file_io is enabled
+ * @param array $smtp_opts SMTP options (e.g. DSN request)
+ *
+ * @return boolean Send status.
+ */
+ public function deliver_message(&$message, $from, $mailto, &$smtp_error, &$body_file = null, $smtp_opts = null)
+ {
+ $headers = $message->headers();
+
+ // send thru SMTP server using custom SMTP library
+ if ($this->config->get('smtp_server')) {
+ // generate list of recipients
+ $a_recipients = array($mailto);
+
+ if (strlen($headers['Cc']))
+ $a_recipients[] = $headers['Cc'];
+ if (strlen($headers['Bcc']))
+ $a_recipients[] = $headers['Bcc'];
+
+ // clean Bcc from header for recipients
+ $send_headers = $headers;
+ unset($send_headers['Bcc']);
+ // here too, it because txtHeaders() below use $message->_headers not only $send_headers
+ unset($message->_headers['Bcc']);
+
+ $smtp_headers = $message->txtHeaders($send_headers, true);
+
+ if ($message->getParam('delay_file_io')) {
+ // use common temp dir
+ $temp_dir = $this->config->get('temp_dir');
+ $body_file = tempnam($temp_dir, 'rcmMsg');
+ if (PEAR::isError($mime_result = $message->saveMessageBody($body_file))) {
+ self::raise_error(array('code' => 650, 'type' => 'php',
+ 'file' => __FILE__, 'line' => __LINE__,
+ 'message' => "Could not create message: ".$mime_result->getMessage()),
+ TRUE, FALSE);
+ return false;
+ }
+ $msg_body = fopen($body_file, 'r');
+ }
+ else {
+ $msg_body = $message->get();
+ }
+
+ // send message
+ if (!is_object($this->smtp)) {
+ $this->smtp_init(true);
+ }
+
+ $sent = $this->smtp->send_mail($from, $a_recipients, $smtp_headers, $msg_body, $smtp_opts);
+ $smtp_response = $this->smtp->get_response();
+ $smtp_error = $this->smtp->get_error();
+
+ // log error
+ if (!$sent) {
+ self::raise_error(array('code' => 800, 'type' => 'smtp',
+ 'line' => __LINE__, 'file' => __FILE__,
+ 'message' => "SMTP error: ".join("\n", $smtp_response)), TRUE, FALSE);
+ }
+ }
+ // send mail using PHP's mail() function
+ else {
+ // unset some headers because they will be added by the mail() function
+ $headers_enc = $message->headers($headers);
+ $headers_php = $message->_headers;
+ unset($headers_php['To'], $headers_php['Subject']);
+
+ // reset stored headers and overwrite
+ $message->_headers = array();
+ $header_str = $message->txtHeaders($headers_php);
+
+ // #1485779
+ if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
+ if (preg_match_all('/<([^@]+@[^>]+)>/', $headers_enc['To'], $m)) {
+ $headers_enc['To'] = implode(', ', $m[1]);
+ }
+ }
+
+ $msg_body = $message->get();
+
+ if (PEAR::isError($msg_body)) {
+ self::raise_error(array('code' => 650, 'type' => 'php',
+ 'file' => __FILE__, 'line' => __LINE__,
+ 'message' => "Could not create message: ".$msg_body->getMessage()),
+ TRUE, FALSE);
+ }
+ else {
+ $delim = $this->config->header_delimiter();
+ $to = $headers_enc['To'];
+ $subject = $headers_enc['Subject'];
+ $header_str = rtrim($header_str);
+
+ if ($delim != "\r\n") {
+ $header_str = str_replace("\r\n", $delim, $header_str);
+ $msg_body = str_replace("\r\n", $delim, $msg_body);
+ $to = str_replace("\r\n", $delim, $to);
+ $subject = str_replace("\r\n", $delim, $subject);
+ }
+
+ if (ini_get('safe_mode'))
+ $sent = mail($to, $subject, $msg_body, $header_str);
+ else
+ $sent = mail($to, $subject, $msg_body, $header_str, "-f$from");
+ }
+ }
+
+ if ($sent) {
+ $this->plugins->exec_hook('message_sent', array('headers' => $headers, 'body' => $msg_body));
+
+ // remove MDN headers after sending
+ unset($headers['Return-Receipt-To'], $headers['Disposition-Notification-To']);
+
+ // get all recipients
+ if ($headers['Cc'])
+ $mailto .= $headers['Cc'];
+ if ($headers['Bcc'])
+ $mailto .= $headers['Bcc'];
+ if (preg_match_all('/<([^@]+@[^>]+)>/', $mailto, $m))
+ $mailto = implode(', ', array_unique($m[1]));
+
+ if ($this->config->get('smtp_log')) {
+ self::write_log('sendmail', sprintf("User %s [%s]; Message for %s; %s",
+ $this->user->get_username(),
+ $_SERVER['REMOTE_ADDR'],
+ $mailto,
+ !empty($smtp_response) ? join('; ', $smtp_response) : ''));
+ }
+ }
+
+ if (is_resource($msg_body)) {
+ fclose($msg_body);
+ }
+
+ $message->_headers = array();
+ $message->headers($headers);
+
+ return $sent;
+ }
+
+
+ /**
+ * Unique Message-ID generator.
+ *
+ * @return string Message-ID
+ */
+ public function gen_message_id()
+ {
+ $local_part = md5(uniqid('rcmail'.mt_rand(),true));
+ $domain_part = $this->user->get_username('domain');
+
+ // Try to find FQDN, some spamfilters doesn't like 'localhost' (#1486924)
+ if (!preg_match('/\.[a-z]+$/i', $domain_part)) {
+ foreach (array($_SERVER['HTTP_HOST'], $_SERVER['SERVER_NAME']) as $host) {
+ $host = preg_replace('/:[0-9]+$/', '', $host);
+ if ($host && preg_match('/\.[a-z]+$/i', $host)) {
+ $domain_part = $host;
+ }
+ }
+ }
+
+ return sprintf('<%s@%s>', $local_part, $domain_part);
+ }
+
+
+ /**
+ * Returns RFC2822 formatted current date in user's timezone
+ *
+ * @return string Date
+ */
+ public function user_date()
+ {
+ // get user's timezone
+ try {
+ $tz = new DateTimeZone($this->config->get('timezone'));
+ $date = new DateTime('now', $tz);
+ }
+ catch (Exception $e) {
+ $date = new DateTime();
+ }
+
+ return $date->format('r');
+ }
+
+
+ /**
+ * E-mail address validation.
+ *
+ * @param string $email Email address
+ * @param boolean $dns_check True to check dns
+ *
+ * @return boolean True on success, False if address is invalid
+ */
+ public function check_email($email, $dns_check=true)
+ {
+ // Check for invalid characters
+ if (preg_match('/[\x00-\x1F\x7F-\xFF]/', $email)) {
+ return false;
+ }
+
+ // Check for length limit specified by RFC 5321 (#1486453)
+ if (strlen($email) > 254) {
+ return false;
+ }
+
+ $email_array = explode('@', $email);
+
+ // Check that there's one @ symbol
+ if (count($email_array) < 2) {
+ return false;
+ }
+
+ $domain_part = array_pop($email_array);
+ $local_part = implode('@', $email_array);
+
+ // from PEAR::Validate
+ $regexp = '&^(?:
+ ("\s*(?:[^"\f\n\r\t\v\b\s]+\s*)+")| #1 quoted name
+ ([-\w!\#\$%\&\'*+~/^`|{}=]+(?:\.[-\w!\#\$%\&\'*+~/^`|{}=]+)*)) #2 OR dot-atom (RFC5322)
+ $&xi';
+
+ if (!preg_match($regexp, $local_part)) {
+ return false;
+ }
+
+ // Check domain part
+ if (preg_match('/^\[*(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])(\.(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}\]*$/', $domain_part)) {
+ return true; // IP address
+ }
+ else {
+ // If not an IP address
+ $domain_array = explode('.', $domain_part);
+ // Not enough parts to be a valid domain
+ if (sizeof($domain_array) < 2) {
+ return false;
+ }
+
+ foreach ($domain_array as $part) {
+ if (!preg_match('/^(([A-Za-z0-9][A-Za-z0-9-]{0,61}[A-Za-z0-9])|([A-Za-z0-9]))$/', $part)) {
+ return false;
+ }
+ }
+
+ if (!$dns_check || !$this->config->get('email_dns_check')) {
+ return true;
+ }
+
+ if (strtoupper(substr(PHP_OS, 0, 3)) == 'WIN' && version_compare(PHP_VERSION, '5.3.0', '<')) {
+ $lookup = array();
+ @exec("nslookup -type=MX " . escapeshellarg($domain_part) . " 2>&1", $lookup);
+ foreach ($lookup as $line) {
+ if (strpos($line, 'MX preference')) {
+ return true;
+ }
+ }
+ return false;
+ }
+
+ // find MX record(s)
+ if (getmxrr($domain_part, $mx_records)) {
+ return true;
+ }
+
+ // find any DNS record
+ if (checkdnsrr($domain_part, 'ANY')) {
+ return true;
+ }
+ }
+
+ return false;
+ }
+
+
+ /**
+ * Write login data (name, ID, IP address) to the 'userlogins' log file.
+ */
+ public function log_login()
+ {
+ if (!$this->config->get('log_logins')) {
+ return;
+ }
+
+ $user_name = $this->get_user_name();
+ $user_id = $this->get_user_id();
+
+ if (!$user_id) {
+ return;
+ }
+
+ self::write_log('userlogins',
+ sprintf('Successful login for %s (ID: %d) from %s in session %s',
+ $user_name, $user_id, self::remote_ip(), session_id()));
+ }
+
+
+ /**
+ * Check whether the HTTP referer matches the current request
+ *
+ * @return boolean True if referer is the same host+path, false if not
+ */
+ public static function check_referer()
+ {
+ $uri = parse_url($_SERVER['REQUEST_URI']);
+ $referer = parse_url(rcube_request_header('Referer'));
+ return $referer['host'] == rcube_request_header('Host') && $referer['path'] == $uri['path'];
+ }
+
+
+ /**
+ * Garbage collector function for temp files.
+ * Remove temp files older than two days
+ */
+ public function temp_gc()
+ {
+ $tmp = unslashify($this->config->get('temp_dir'));
+ $expire = mktime() - 172800; // expire in 48 hours
+
+ if ($dir = opendir($tmp)) {
+ while (($fname = readdir($dir)) !== false) {
+ if ($fname{0} == '.') {
+ continue;
+ }
+
+ if (filemtime($tmp.'/'.$fname) < $expire) {
+ @unlink($tmp.'/'.$fname);
+ }
+ }
+
+ closedir($dir);
+ }
+ }
+
}
--
Gitblit v1.9.1