| Author: Thomas Bruederli <roundcube@gmail.com> |
+-----------------------------------------------------------------------+
- $Id: main.inc 617 2007-06-13 06:57:22Z thomasb $
+ $Id: main.inc 903 2007-10-22 06:52:13Z thomasb $
*/
+/**
+ * RoundCube Webmail common functions
+ *
+ * @package Core
+ * @author Thomas Bruederli <roundcube@gmail.com>
+ */
+
require_once('lib/utf7.inc');
+require_once('include/rcube_shared.inc');
require_once('include/rcmail_template.inc');
define('RCUBE_INPUT_GPC', 0x0103);
-// register session and connect to server
+/**
+ * Initial startup function
+ * to register session, create database and imap connections
+ *
+ * @param string Current task
+ */
function rcmail_startup($task='mail')
{
global $sess_id, $sess_user_lang;
ini_set('session.gc_maxlifetime', ($CONFIG['session_lifetime']) * 120);
// prepare DB connection
- require_once('include/rcube_'.(empty($CONFIG['db_backend']) ? 'db' : $CONFIG['db_backend']).'.inc');
+ $dbwrapper = empty($CONFIG['db_backend']) ? 'db' : $CONFIG['db_backend'];
+ $dbclass = "rcube_" . $dbwrapper;
+ require_once("include/$dbclass.inc");
- $DB = new rcube_db($CONFIG['db_dsnw'], $CONFIG['db_dsnr'], $CONFIG['db_persistent']);
+ $DB = new $dbclass($CONFIG['db_dsnw'], $CONFIG['db_dsnr'], $CONFIG['db_persistent']);
$DB->sqlite_initials = $INSTALL_PATH.'SQL/sqlite.initial.sql';
$DB->db_connect('w');
}
-// load roundcube configuration into global var
+/**
+ * Load roundcube configuration array
+ *
+ * @return array Named configuration parameters
+ */
function rcmail_load_config()
{
global $INSTALL_PATH;
}
-// load a host-specific config file if configured
+/**
+ * Load a host-specific config file if configured
+ * This will merge the host specific configuration with the given one
+ *
+ * @param array Global configuration parameters
+ */
function rcmail_load_host_config(&$config)
{
$fname = NULL;
}
-// create authorization hash
+/**
+ * Create unique authorization hash
+ *
+ * @param string Session ID
+ * @param int Timestamp
+ * @return string The generated auth hash
+ */
function rcmail_auth_hash($sess_id, $ts)
{
global $CONFIG;
}
-// compare the auth hash sent by the client with the local session credentials
+/**
+ * Check the auth hash sent by the client against the local session credentials
+ *
+ * @return boolean True if valid, False if not
+ */
function rcmail_authenticate_session()
{
global $CONFIG, $SESS_CLIENT_IP, $SESS_CHANGED;
// check session filetime
if (!empty($CONFIG['session_lifetime']) && isset($SESS_CHANGED) && $SESS_CHANGED + $CONFIG['session_lifetime']*60 < time())
$valid = false;
-
+
return $valid;
}
-// create IMAP object and connect to server
+/**
+ * Create global IMAP object and connect to server
+ *
+ * @param boolean True if connection should be established
+ */
function rcmail_imap_init($connect=FALSE)
{
global $CONFIG, $DB, $IMAP, $OUTPUT;
}
-// set root dir and last stored mailbox
-// this must be done AFTER connecting to the server
+/**
+ * Set root dir and last stored mailbox
+ * This must be done AFTER connecting to the server!
+ */
function rcmail_set_imap_prop()
{
global $CONFIG, $IMAP;
}
-// do these things on script shutdown
+/**
+ * Do these things on script shutdown
+ */
function rcmail_shutdown()
{
- global $IMAP;
+ global $IMAP, $CONTACTS;
if (is_object($IMAP))
{
$IMAP->write_cache();
}
+ if (is_object($CONTACTS))
+ $CONTACTS->close();
+
// before closing the database connection, write session data
session_write_close();
}
-// destroy session data and remove cookie
+/**
+ * Destroy session data and remove cookie
+ */
function rcmail_kill_session()
{
// save user preferences
}
-// return correct name for a specific database table
+/**
+ * Return correct name for a specific database table
+ *
+ * @param string Table name
+ * @return string Translated table name
+ */
function get_table_name($table)
{
global $CONFIG;
}
-// return correct name for a specific database sequence
-// (used for Postres only)
+/**
+ * Return correct name for a specific database sequence
+ * (used for Postres only)
+ *
+ * @param string Secuence name
+ * @return string Translated sequence name
+ */
function get_sequence_name($sequence)
{
global $CONFIG;
}
-// check the given string and returns language properties
+/**
+ * Check the given string and returns language properties
+ *
+ * @param string Language code
+ * @param string Peropert name
+ * @return string Property value
+ */
function rcube_language_prop($lang, $prop='lang')
{
global $INSTALL_PATH;
}
-// init output object for GUI and add common scripts
+/**
+ * Init output object for GUI and add common scripts.
+ * This will instantiate a rcmail_template object and set
+ * environment vars according to the current session and configuration
+ */
function rcmail_load_gui()
{
global $CONFIG, $OUTPUT, $sess_user_lang;
// add some basic label to client
if (!$OUTPUT->ajax_call)
- rcube_add_label('loading');
+ rcube_add_label('loading', 'movingmessage');
}
-// set localization charset based on the given language
+/**
+ * Set localization charset based on the given language.
+ * This also creates a global property for mbstring usage.
+ */
function rcmail_set_locale($lang)
{
global $OUTPUT, $MBSTRING;
static $s_mbstring_loaded = NULL;
// settings for mbstring module (by Tadashi Jokagi)
- if (is_null($s_mbstring_loaded))
- $MBSTRING = $s_mbstring_loaded = extension_loaded("mbstring");
+ if (is_null($s_mbstring_loaded))
+ $MBSTRING = $s_mbstring_loaded = extension_loaded("mbstring");
else
$MBSTRING = $s_mbstring_loaded = FALSE;
-
+
if ($MBSTRING)
mb_internal_encoding(RCMAIL_CHARSET);
}
-// auto-select IMAP host based on the posted login information
+/**
+ * Auto-select IMAP host based on the posted login information
+ *
+ * @return string Selected IMAP host
+ */
function rcmail_autoselect_host()
{
global $CONFIG;
}
-// perfom login to the IMAP server and to the webmail service
+/**
+ * Perfom login to the IMAP 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
+ * @return boolean True on success, False on failure
+ */
function rcmail_login($user, $pass, $host=NULL)
{
global $CONFIG, $IMAP, $DB, $sess_user_lang;
Inspired by Marco <P0L0_notspam_binware.org>
*/
// Check if we need to add domain
- if (!empty($CONFIG['username_domain']) && !strstr($user, '@'))
+ if (!empty($CONFIG['username_domain']) && !strpos($user, '@'))
{
if (is_array($CONFIG['username_domain']) && isset($CONFIG['username_domain'][$host]))
$user .= '@'.$CONFIG['username_domain'][$host];
$user .= '@'.$CONFIG['username_domain'];
}
+ // try to resolve email address from virtuser table
+ if (!empty($CONFIG['virtuser_file']) && strpos($user, '@'))
+ $user = rcmail_email2user($user);
+
+ // lowercase username if it's an e-mail address (#1484473)
+ if (strpos($user, '@'))
+ $user = strtolower($user);
// query if user already registered
- $sql_result = $DB->query("SELECT user_id, username, language, preferences
- FROM ".get_table_name('users')."
- WHERE mail_host=? AND (username=? OR alias=?)",
- $host,
- $user,
- $user);
+ $sql_result = $DB->query(
+ "SELECT user_id, username, language, preferences
+ FROM ".get_table_name('users')."
+ WHERE mail_host=? AND (username=? OR alias=?)",
+ $host,
+ $user,
+ $user);
// user already registered -> overwrite username
if ($sql_arr = $DB->fetch_assoc($sql_result))
$user = $sql_arr['username'];
}
- // try to resolve email address from virtuser table
- if (!empty($CONFIG['virtuser_file']) && strstr($user, '@'))
- $user = rcmail_email2user($user);
-
-
// exit if IMAP login failed
if (!($imap_login = $IMAP->connect($host, $user, $pass, $imap_port, $imap_ssl)))
return FALSE;
{
$user_id = rcmail_create_user($user, $host);
}
+ else
+ {
+ raise_error(array(
+ 'code' => 600,
+ 'type' => 'php',
+ 'file' => "config/main.inc.php",
+ 'message' => "Acces denied for new user $user. 'auto_create_user' is disabled"
+ ), true, false);
+ }
if ($user_id)
{
}
-// create new entry in users and identities table
+/**
+ * Create new entry in users and identities table
+ *
+ * @param string User name
+ * @param string IMAP host
+ * @return mixed New user ID or False on failure
+ */
function rcmail_create_user($user, $host)
- {
+{
global $DB, $CONFIG, $IMAP;
$user_email = '';
// try to resolve user in virtusertable
- if (!empty($CONFIG['virtuser_file']) && strstr($user, '@')==FALSE)
+ if (!empty($CONFIG['virtuser_file']) && !strpos($user, '@'))
$user_email = rcmail_user2email($user);
$DB->query("INSERT INTO ".get_table_name('users')."
$_SESSION['user_lang']);
if ($user_id = $DB->insert_id(get_sequence_name('users')))
- {
+ {
$mail_domain = rcmail_mail_domain($host);
if ($user_email=='')
- $user_email = strstr($user, '@') ? $user : sprintf('%s@%s', $user, $mail_domain);
+ $user_email = strpos($user, '@') ? $user : sprintf('%s@%s', $user, $mail_domain);
$user_name = $user!=$user_email ? $user : '';
// try to resolve the e-mail address from the virtuser table
if (!empty($CONFIG['virtuser_query']) &&
- ($sql_result = $DB->query(preg_replace('/%u/', $user, $CONFIG['virtuser_query']))) &&
+ ($sql_result = $DB->query(preg_replace('/%u/', $DB->quote($user), $CONFIG['virtuser_query']))) &&
($DB->num_rows()>0))
+ {
while ($sql_arr = $DB->fetch_array($sql_result))
- {
+ {
$DB->query("INSERT INTO ".get_table_name('identities')."
(user_id, del, standard, name, email)
VALUES (?, 0, 1, ?, ?)",
$user_id,
strip_newlines($user_name),
preg_replace('/^@/', $user . '@', $sql_arr[0]));
- }
+ }
+ }
else
- {
+ {
// also create new identity records
$DB->query("INSERT INTO ".get_table_name('identities')."
(user_id, del, standard, name, email)
$user_id,
strip_newlines($user_name),
strip_newlines($user_email));
- }
+ }
// get existing mailboxes
$a_mailboxes = $IMAP->list_mailboxes();
- }
+ }
else
- {
- raise_error(array('code' => 500,
- 'type' => 'php',
- 'line' => __LINE__,
- 'file' => __FILE__,
- 'message' => "Failed to create new user"), TRUE, FALSE);
- }
+ {
+ raise_error(array(
+ 'code' => 500,
+ 'type' => 'php',
+ 'line' => __LINE__,
+ 'file' => __FILE__,
+ 'message' => "Failed to create new user"), TRUE, FALSE);
+ }
return $user_id;
- }
+}
-// load virtuser table in array
+/**
+ * Load virtuser table in array
+ *
+ * @return array Virtuser table entries
+ */
function rcmail_getvirtualfile()
{
global $CONFIG;
}
-// find matches of the given pattern in virtuser table
+/**
+ * Find matches of the given pattern in virtuser table
+ *
+ * @param string Regular expression to search for
+ * @return array Matching entries
+ */
function rcmail_findinvirtual($pattern)
{
$result = array();
}
-// resolve username with virtuser table
+/**
+ * Resolve username using a virtuser table
+ *
+ * @param string E-mail address to resolve
+ * @return string Resolved IMAP username
+ */
function rcmail_email2user($email)
{
$user = $email;
}
-// resolve e-mail address with virtuser table
+/**
+ * Resolve e-mail address from virtuser table
+ *
+ * @param string User name
+ * @return string Resolved e-mail address
+ */
function rcmail_user2email($user)
{
$email = "";
}
+/**
+ * Write the given user prefs to the user's record
+ *
+ * @param mixed User prefs to save
+ * @return boolean True on success, False on failure
+ */
function rcmail_save_user_prefs($a_user_prefs)
{
global $DB, $CONFIG, $sess_user_lang;
+ // merge (partial) prefs array with existing settings
+ $a_user_prefs += (array)$_SESSION['user_prefs'];
+
$DB->query("UPDATE ".get_table_name('users')."
SET preferences=?,
language=?
}
-// overwrite action variable
+/**
+ * Overwrite action variable
+ *
+ * @param string New action value
+ */
function rcmail_overwrite_action($action)
{
global $OUTPUT;
}
-// encrypt IMAP password using DES encryption
+/**
+ * Encrypt IMAP password using DES encryption
+ *
+ * @param string Password to encrypt
+ * @return string Encryprted string
+ */
function encrypt_passwd($pass)
{
$td = mcrypt_module_open(MCRYPT_TripleDES, "", MCRYPT_MODE_ECB, "");
}
-// decrypt IMAP password using DES encryption
+/**
+ * Decrypt IMAP password using DES encryption
+ *
+ * @param string Encrypted password
+ * @return string Plain password
+ */
function decrypt_passwd($cypher)
{
$td = mcrypt_module_open(MCRYPT_TripleDES, "", MCRYPT_MODE_ECB, "");
}
-// return a 24 byte key for the DES encryption
+/**
+ * Return a 24 byte key for the DES encryption
+ *
+ * @return string DES encryption key
+ */
function get_des_key()
{
$key = !empty($GLOBALS['CONFIG']['des_key']) ? $GLOBALS['CONFIG']['des_key'] : 'rcmail?24BitPwDkeyF**ECB';
}
-// read directory program/localization/ and return a list of available languages
+/**
+ * Read directory program/localization and return a list of available languages
+ *
+ * @return array List of available localizations
+ */
function rcube_list_languages()
{
global $CONFIG, $INSTALL_PATH;
}
-// add a localized label to the client environment
+/**
+ * Add a localized label to the client environment
+ */
function rcube_add_label()
{
global $OUTPUT;
}
-// remove temp files older than two day
+/**
+ * Garbage collector function for temp files.
+ * Remove temp files older than two days
+ */
function rcmail_temp_gc()
{
$tmp = unslashify($CONFIG['temp_dir']);
}
-// remove all expired message cache records
+/**
+ * Garbage collector for cache entries.
+ * Remove all expired message cache records
+ */
function rcmail_message_cache_gc()
{
global $DB, $CONFIG;
if ($from==$to || $str=='' || empty($from))
return $str;
+ // convert charset using iconv module
+ if (function_exists('iconv') && $from != 'UTF-7' && $to != 'UTF-7')
+ {
+ $iconv_map = array('KS_C_5601-1987' => 'EUC-KR');
+ return iconv(($iconv_map[$from] ? $iconv_map[$from] : $from), ($iconv_map[$to] ? $iconv_map[$to] : $to) . "//IGNORE", $str);
+ }
+
// convert charset using mbstring module
if ($MBSTRING)
{
- $to = $to=="UTF-7" ? "UTF7-IMAP" : $to;
- $from = $from=="UTF-7" ? "UTF7-IMAP": $from;
-
+ $mb_map = array('UTF-7' => 'UTF7-IMAP', 'KS_C_5601-1987' => 'EUC-KR');
+
// return if convert succeeded
- if (($out = mb_convert_encoding($str, $to, $from)) != '')
+ if (($out = mb_convert_encoding($str, ($mb_map[$to] ? $mb_map[$to] : $to), ($mb_map[$from] ? $mb_map[$from] : $from))) != '')
return $out;
}
- // convert charset using iconv module
- if (function_exists('iconv') && $from!='UTF-7' && $to!='UTF-7')
- return iconv($from, $to, $str);
-
// convert string to UTF-8
if ($from=='UTF-7')
$str = utf7_to_utf8($str);
if (!$enctype)
$enctype = $GLOBALS['OUTPUT_TYPE'];
- // convert nbsps back to normal spaces if not html
- if ($enctype!='html')
- $str = str_replace(chr(160), ' ', $str);
-
// encode for plaintext
if ($enctype=='text')
return str_replace("\r\n", "\n", $mode=='remove' ? strip_tags($str) : $str);
for ($c=160; $c<256; $c++) // can be increased to support more charsets
{
- $hex = dechex($c);
$xml_rep_table[Chr($c)] = "&#$c;";
if ($OUTPUT->get_charset()=='ISO-8859-1')
- $js_rep_table[Chr($c)] = sprintf("\u%s%s", str_repeat('0', 4-strlen($hex)), $hex);
+ $js_rep_table[Chr($c)] = sprintf("\\u%04x", $c);
}
$xml_rep_table['"'] = '"';
}
/**
- * Quote a given string. Alias function for rep_specialchars_output
- * @see rep_specialchars_output
+ * Quote a given string.
+ * Shortcut function for rep_specialchars_output
+ *
+ * @return string HTML-quoted string
+ * @see rep_specialchars_output()
*/
function Q($str, $mode='strict', $newlines=TRUE)
{
}
/**
- * Quote a given string. Alias function for rep_specialchars_output
- * @see rep_specialchars_output
+ * Quote a given string for javascript output.
+ * Shortcut function for rep_specialchars_output
+ *
+ * @return string JS-quoted string
+ * @see rep_specialchars_output()
*/
function JQ($str)
{
return $value;
}
+
/**
* Remove single and double quotes from given string
+ *
+ * @param string Input value
+ * @return string Dequoted string
*/
function strip_quotes($str)
{
return preg_replace('/[\'"]/', '', $str);
}
+
/**
* Remove new lines characters from given string
+ *
+ * @param string Input value
+ * @return string Stripped string
*/
function strip_newlines($str)
{
}
-// return boolean if a specific template exists
+/**
+ * Check if a specific template exists
+ *
+ * @param string Template name
+ * @return boolean True if template exists
+ */
function template_exists($name)
{
global $CONFIG;
}
-// Wrapper for rcmail_template::parse()
-// @deprecated
+/**
+ * Wrapper for rcmail_template::parse()
+ * @deprecated
+ */
function parse_template($name='main', $exit=true)
{
$GLOBALS['OUTPUT']->parse($name, $exit);
}
-
+/**
+ * Create a HTML table based on the given data
+ *
+ * @param array Named table attributes
+ * @param mixed Table row data. Either a two-dimensional array or a valid SQL result set
+ * @param array List of cols to show
+ * @param string Name of the identifier col
+ * @return string HTML table code
+ */
function rcube_table_output($attrib, $table_data, $a_show_cols, $id_col)
{
global $DB;
}
-// return the mail domain configured for the given host
+/**
+ * Return the mail domain configured for the given host
+ *
+ * @param string IMAP host
+ * @return string Resolved SMTP host
+ */
function rcmail_mail_domain($host)
{
global $CONFIG;
}
-// compose a valid attribute string for HTML tags
+/**
+ * Replace all css definitions with #container [def]
+ *
+ * @param string CSS source code
+ * @param string Container ID to use as prefix
+ * @return string Modified CSS source
+ */
+function rcmail_mod_css_styles($source, $container_id, $base_url = '')
+ {
+ $a_css_values = array();
+ $last_pos = 0;
+
+ // cut out all contents between { and }
+ while (($pos = strpos($source, '{', $last_pos)) && ($pos2 = strpos($source, '}', $pos)))
+ {
+ $key = sizeof($a_css_values);
+ $a_css_values[$key] = substr($source, $pos+1, $pos2-($pos+1));
+ $source = substr($source, 0, $pos+1) . "<<str_replacement[$key]>>" . substr($source, $pos2, strlen($source)-$pos2);
+ $last_pos = $pos+2;
+ }
+
+ // remove html commends and add #container to each tag selector.
+ // also replace body definition because we also stripped off the <body> tag
+ $styles = preg_replace(
+ array(
+ '/(^\s*<!--)|(-->\s*$)/',
+ '/(^\s*|,\s*|\}\s*)([a-z0-9\._#][a-z0-9\.\-_]*)/im',
+ '/@import\s+(url\()?[\'"]?([^\)\'"]+)[\'"]?(\))?/ime',
+ '/<<str_replacement\[([0-9]+)\]>>/e',
+ "/$container_id\s+body/i"
+ ),
+ array(
+ '',
+ "\\1#$container_id \\2",
+ "sprintf(\"@import url('./bin/modcss.php?u=%s&c=%s')\", urlencode(make_absolute_url('\\2','$base_url')), urlencode($container_id))",
+ "\$a_css_values[\\1]",
+ "$container_id div.rcmBody"
+ ),
+ $source);
+
+ return $styles;
+ }
+
+
+/**
+ * Compose a valid attribute string for HTML tags
+ *
+ * @param array Named tag attributes
+ * @param array List of allowed attributes
+ * @return string HTML formatted attribute string
+ */
function create_attrib_string($attrib, $allowed_attribs=array('id', 'class', 'style'))
{
// allow the following attributes to be added to the <iframe> tag
}
-// convert a HTML attribute string attributes to an associative array (name => value)
+/**
+ * Convert a HTML attribute string attributes to an associative array (name => value)
+ *
+ * @param string Input string
+ * @return array Key-value pairs of parsed attributes
+ */
function parse_attrib_string($str)
{
$attrib = array();
}
+/**
+ * Convert the given date to a human readable form
+ * This uses the date formatting properties from config
+ *
+ * @param mixed Date representation (string or timestamp)
+ * @param string Date format to use
+ * @return string Formatted date string
+ */
function format_date($date, $format=NULL)
{
global $CONFIG, $sess_user_lang;
}
+/**
+ * Compose a valid representaion of name and e-mail address
+ *
+ * @param string E-mail address
+ * @param string Person name
+ * @return string Formatted string
+ */
function format_email_recipient($email, $name='')
{
if ($name && $name != $email)
-// ************** functions delivering gui objects **************
-
-
-
-function rcmail_message_container($attrib)
- {
- global $OUTPUT;
-
- if (!$attrib['id'])
- $attrib['id'] = 'rcmMessageContainer';
-
- // allow the following attributes to be added to the <table> tag
- $attrib_str = create_attrib_string($attrib, array('style', 'class', 'id'));
- $out = '<div' . $attrib_str . "></div>";
-
- $OUTPUT->add_gui_object('message', $attrib['id']);
-
- return $out;
- }
-
-
-// return the IMAP username of the current session
-function rcmail_current_username($attrib)
- {
- global $DB;
- static $s_username;
-
- // alread fetched
- if (!empty($s_username))
- return $s_username;
-
- // get e-mail address form default identity
- $sql_result = $DB->query("SELECT email AS mailto
- FROM ".get_table_name('identities')."
- WHERE user_id=?
- AND standard=1
- AND del<>1",
- $_SESSION['user_id']);
-
- if ($DB->num_rows($sql_result))
- {
- $sql_arr = $DB->fetch_assoc($sql_result);
- $s_username = $sql_arr['mailto'];
- }
- else if (strstr($_SESSION['username'], '@'))
- $s_username = $_SESSION['username'];
- else
- $s_username = $_SESSION['username'].'@'.$_SESSION['imap_host'];
-
- return $s_username;
- }
-
-
-// return code for the webmail login form
-function rcmail_login_form($attrib)
- {
- global $CONFIG, $OUTPUT, $SESS_HIDDEN_FIELD;
-
- $labels = array();
- $labels['user'] = rcube_label('username');
- $labels['pass'] = rcube_label('password');
- $labels['host'] = rcube_label('server');
-
- $input_user = new textfield(array('name' => '_user', 'id' => 'rcmloginuser', 'size' => 30, 'autocomplete' => 'off'));
- $input_pass = new passwordfield(array('name' => '_pass', 'id' => 'rcmloginpwd', 'size' => 30));
- $input_action = new hiddenfield(array('name' => '_action', 'value' => 'login'));
-
- $fields = array();
- $fields['user'] = $input_user->show(get_input_value('_user', RCUBE_INPUT_POST));
- $fields['pass'] = $input_pass->show();
- $fields['action'] = $input_action->show();
-
- if (is_array($CONFIG['default_host']))
- {
- $select_host = new select(array('name' => '_host', 'id' => 'rcmloginhost'));
-
- foreach ($CONFIG['default_host'] as $key => $value)
- {
- if (!is_array($value))
- $select_host->add($value, (is_numeric($key) ? $value : $key));
- else
- {
- unset($select_host);
- break;
- }
- }
-
- $fields['host'] = isset($select_host) ? $select_host->show($_POST['_host']) : null;
- }
- else if (!strlen($CONFIG['default_host']))
- {
- $input_host = new textfield(array('name' => '_host', 'id' => 'rcmloginhost', 'size' => 30));
- $fields['host'] = $input_host->show($_POST['_host']);
- }
-
- $form_name = strlen($attrib['form']) ? $attrib['form'] : 'form';
- $form_start = !strlen($attrib['form']) ? '<form name="form" action="./" method="post">' : '';
- $form_end = !strlen($attrib['form']) ? '</form>' : '';
-
- if ($fields['host'])
- $form_host = <<<EOF
-
-</tr><tr>
-
-<td class="title"><label for="rcmloginhost">$labels[host]</label></td>
-<td>$fields[host]</td>
-
-EOF;
-
- $OUTPUT->add_gui_object('loginform', $form_name);
-
- $out = <<<EOF
-$form_start
-$SESS_HIDDEN_FIELD
-$fields[action]
-<table><tr>
-
-<td class="title"><label for="rcmloginuser">$labels[user]</label></td>
-<td>$fields[user]</td>
-
-</tr><tr>
-
-<td class="title"><label for="rcmloginpwd">$labels[pass]</label></td>
-<td>$fields[pass]</td>
-$form_host
-</tr></table>
-$form_end
-EOF;
-
- return $out;
- }
-
-
-function rcmail_charset_selector($attrib)
- {
- global $OUTPUT;
-
- // pass the following attributes to the form class
- $field_attrib = array('name' => '_charset');
- foreach ($attrib as $attr => $value)
- if (in_array($attr, array('id', 'class', 'style', 'size', 'tabindex')))
- $field_attrib[$attr] = $value;
-
- $charsets = array(
- 'US-ASCII' => 'ASCII (English)',
- 'EUC-JP' => 'EUC-JP (Japanese)',
- 'EUC-KR' => 'EUC-KR (Korean)',
- 'BIG5' => 'BIG5 (Chinese)',
- 'GB2312' => 'GB2312 (Chinese)',
- 'ISO-2022-JP' => 'ISO-2022-JP (Japanese)',
- 'ISO-8859-1' => 'ISO-8859-1 (Latin-1)',
- 'ISO-8859-2' => 'ISO-8895-2 (Central European)',
- 'ISO-8859-7' => 'ISO-8859-7 (Greek)',
- 'ISO-8859-9' => 'ISO-8859-9 (Turkish)',
- 'Windows-1251' => 'Windows-1251 (Cyrillic)',
- 'Windows-1252' => 'Windows-1252 (Western)',
- 'Windows-1255' => 'Windows-1255 (Hebrew)',
- 'Windows-1256' => 'Windows-1256 (Arabic)',
- 'Windows-1257' => 'Windows-1257 (Baltic)',
- 'UTF-8' => 'UTF-8'
- );
-
- $select = new select($field_attrib);
- $select->add(array_values($charsets), array_keys($charsets));
-
- $set = $_POST['_charset'] ? $_POST['_charset'] : $OUTPUT->get_charset();
- return $select->show($set);
- }
-
-
-// return code for search function
-function rcmail_search_form($attrib)
- {
- global $OUTPUT;
-
- // add some labels to client
- rcube_add_label('searching');
-
- $attrib['name'] = '_q';
-
- if (empty($attrib['id']))
- $attrib['id'] = 'rcmqsearchbox';
-
- $input_q = new textfield($attrib);
- $out = $input_q->show();
-
- $OUTPUT->add_gui_object('qsearchbox', $attrib['id']);
-
- // add form tag around text field
- if (empty($attrib['form']))
- $out = sprintf(
- '<form name="rcmqsearchform" action="./" '.
- 'onsubmit="%s.command(\'search\');return false" style="display:inline;">%s</form>',
- JS_OBJECT_NAME,
- $out);
-
- return $out;
- }
-
-
/****** debugging functions ********/
*/
function write_log($name, $line)
{
- global $CONFIG;
+ global $CONFIG, $INSTALL_PATH;
if (!is_string($line))
$line = var_export($line, true);
}
+/**
+ * @access private
+ */
function rcube_timer()
{
list($usec, $sec) = explode(" ", microtime());
}
+/**
+ * @access private
+ */
function rcube_print_time($timer, $label='Timer')
{
static $print_count = 0;
console(sprintf("%s: %0.4f sec", $label, $diff));
}
+
+/**
+ * Return the mailboxlist in HTML
+ *
+ * @param array Named parameters
+ * @return string HTML code for the gui object
+ */
+function rcmail_mailbox_list($attrib)
+ {
+ global $IMAP, $CONFIG, $OUTPUT, $COMM_PATH;
+ static $s_added_script = FALSE;
+ static $a_mailboxes;
+
+ // add some labels to client
+ rcube_add_label('purgefolderconfirm');
+ rcube_add_label('deletemessagesconfirm');
+
+// $mboxlist_start = rcube_timer();
+
+ $type = $attrib['type'] ? $attrib['type'] : 'ul';
+ $add_attrib = $type=='select' ? array('style', 'class', 'id', 'name', 'onchange') :
+ array('style', 'class', 'id');
+
+ if ($type=='ul' && !$attrib['id'])
+ $attrib['id'] = 'rcmboxlist';
+
+ // allow the following attributes to be added to the <ul> tag
+ $attrib_str = create_attrib_string($attrib, $add_attrib);
+
+ $out = '<' . $type . $attrib_str . ">\n";
+
+ // add no-selection option
+ if ($type=='select' && $attrib['noselection'])
+ $out .= sprintf('<option value="0">%s</option>'."\n",
+ rcube_label($attrib['noselection']));
+
+ // get mailbox list
+ $mbox_name = $IMAP->get_mailbox_name();
+
+ // for these mailboxes we have localized labels
+ $special_mailboxes = array('inbox', 'sent', 'drafts', 'trash', 'junk');
+
+
+ // build the folders tree
+ if (empty($a_mailboxes))
+ {
+ // get mailbox list
+ $a_folders = $IMAP->list_mailboxes();
+ $delimiter = $IMAP->get_hierarchy_delimiter();
+ $a_mailboxes = array();
+
+// rcube_print_time($mboxlist_start, 'list_mailboxes()');
+
+ foreach ($a_folders as $folder)
+ rcmail_build_folder_tree($a_mailboxes, $folder, $delimiter);
+ }
+
+// var_dump($a_mailboxes);
+
+ if ($type=='select')
+ $out .= rcmail_render_folder_tree_select($a_mailboxes, $special_mailboxes, $mbox_name, $attrib['maxlength']);
+ else
+ $out .= rcmail_render_folder_tree_html($a_mailboxes, $special_mailboxes, $mbox_name, $attrib['maxlength']);
+
+// rcube_print_time($mboxlist_start, 'render_folder_tree()');
+
+
+ if ($type=='ul')
+ $OUTPUT->add_gui_object('mailboxlist', $attrib['id']);
+
+ return $out . "</$type>";
+ }
+
+
+
+
+/**
+ * Create a hierarchical array of the mailbox list
+ * @access private
+ */
+function rcmail_build_folder_tree(&$arrFolders, $folder, $delm='/', $path='')
+ {
+ $pos = strpos($folder, $delm);
+ if ($pos !== false)
+ {
+ $subFolders = substr($folder, $pos+1);
+ $currentFolder = substr($folder, 0, $pos);
+ }
+ else
+ {
+ $subFolders = false;
+ $currentFolder = $folder;
+ }
+
+ $path .= $currentFolder;
+
+ if (!isset($arrFolders[$currentFolder]))
+ {
+ $arrFolders[$currentFolder] = array('id' => $path,
+ 'name' => rcube_charset_convert($currentFolder, 'UTF-7'),
+ 'folders' => array());
+ }
+
+ if (!empty($subFolders))
+ rcmail_build_folder_tree($arrFolders[$currentFolder]['folders'], $subFolders, $delm, $path.$delm);
+ }
+
+
+/**
+ * Return html for a structured list <ul> for the mailbox tree
+ * @access private
+ */
+function rcmail_render_folder_tree_html(&$arrFolders, &$special, &$mbox_name, $maxlength, $nestLevel=0)
+ {
+ global $COMM_PATH, $IMAP, $CONFIG, $OUTPUT;
+
+ $idx = 0;
+ $out = '';
+ foreach ($arrFolders as $key => $folder)
+ {
+ $zebra_class = ($nestLevel*$idx)%2 ? 'even' : 'odd';
+ $title = '';
+
+ $folder_lc = strtolower($folder['id']);
+ if (in_array($folder_lc, $special))
+ $foldername = rcube_label($folder_lc);
+ else
+ {
+ $foldername = $folder['name'];
+
+ // shorten the folder name to a given length
+ if ($maxlength && $maxlength>1)
+ {
+ $fname = abbrevate_string($foldername, $maxlength);
+ if ($fname != $foldername)
+ $title = ' title="'.Q($foldername).'"';
+ $foldername = $fname;
+ }
+ }
+
+ // add unread message count display
+ if ($unread_count = $IMAP->messagecount($folder['id'], 'RECENT', ($folder['id']==$mbox_name)))
+ $foldername .= sprintf(' (%d)', $unread_count);
+
+ // make folder name safe for ids and class names
+ $folder_id = preg_replace('/[^A-Za-z0-9\-_]/', '', $folder['id']);
+ $class_name = preg_replace('/[^a-z0-9\-_]/', '', $folder_lc);
+
+ // set special class for Sent, Drafts, Trash and Junk
+ if ($folder['id']==$CONFIG['sent_mbox'])
+ $class_name = 'sent';
+ else if ($folder['id']==$CONFIG['drafts_mbox'])
+ $class_name = 'drafts';
+ else if ($folder['id']==$CONFIG['trash_mbox'])
+ $class_name = 'trash';
+ else if ($folder['id']==$CONFIG['junk_mbox'])
+ $class_name = 'junk';
+
+ $js_name = htmlspecialchars(JQ($folder['id']));
+ $out .= sprintf('<li id="rcmli%s" class="mailbox %s %s%s%s"><a href="%s"'.
+ ' onclick="return %s.command(\'list\',\'%s\',this)"'.
+ ' onmouseover="return %s.focus_folder(\'%s\')"' .
+ ' onmouseout="return %s.unfocus_folder(\'%s\')"' .
+ ' onmouseup="return %s.folder_mouse_up(\'%s\')"%s>%s</a>',
+ $folder_id,
+ $class_name,
+ $zebra_class,
+ $unread_count ? ' unread' : '',
+ $folder['id']==$mbox_name ? ' selected' : '',
+ Q(rcmail_url('', array('_mbox' => $folder['id']))),
+ JS_OBJECT_NAME,
+ $js_name,
+ JS_OBJECT_NAME,
+ $js_name,
+ JS_OBJECT_NAME,
+ $js_name,
+ JS_OBJECT_NAME,
+ $js_name,
+ $title,
+ Q($foldername));
+
+ if (!empty($folder['folders']))
+ $out .= "\n<ul>\n" . rcmail_render_folder_tree_html($folder['folders'], $special, $mbox_name, $maxlength, $nestLevel+1) . "</ul>\n";
+
+ $out .= "</li>\n";
+ $idx++;
+ }
+
+ return $out;
+ }
+
+
+/**
+ * Return html for a flat list <select> for the mailbox tree
+ * @access private
+ */
+function rcmail_render_folder_tree_select(&$arrFolders, &$special, &$mbox_name, $maxlength, $nestLevel=0)
+ {
+ global $IMAP, $OUTPUT;
+
+ $idx = 0;
+ $out = '';
+ foreach ($arrFolders as $key=>$folder)
+ {
+ $folder_lc = strtolower($folder['id']);
+ if (in_array($folder_lc, $special))
+ $foldername = rcube_label($folder_lc);
+ else
+ {
+ $foldername = $folder['name'];
+
+ // shorten the folder name to a given length
+ if ($maxlength && $maxlength>1)
+ $foldername = abbrevate_string($foldername, $maxlength);
+ }
+
+ $out .= sprintf('<option value="%s">%s%s</option>'."\n",
+ htmlspecialchars($folder['id']),
+ str_repeat(' ', $nestLevel*4),
+ Q($foldername));
+
+ if (!empty($folder['folders']))
+ $out .= rcmail_render_folder_tree_select($folder['folders'], $special, $mbox_name, $maxlength, $nestLevel+1);
+
+ $idx++;
+ }
+
+ return $out;
+ }
+
?>