From 831c830124c5cafeb36e952acacc01e36de50d78 Mon Sep 17 00:00:00 2001
From: alecpl <alec@alec.pl>
Date: Sun, 15 Apr 2012 04:10:34 -0400
Subject: [PATCH] - More aliases of deprecated functions
---
program/include/main.inc | 1937 ++++++----------------------------------------------------
1 files changed, 210 insertions(+), 1,727 deletions(-)
diff --git a/program/include/main.inc b/program/include/main.inc
index 6d4e19c..bbb232b 100644
--- a/program/include/main.inc
+++ b/program/include/main.inc
@@ -5,11 +5,14 @@
| program/include/main.inc |
| |
| This file is part of the Roundcube Webmail client |
- | Copyright (C) 2005-2009, Roundcube Dev, - Switzerland |
- | Licensed under the GNU GPL |
+ | Copyright (C) 2005-2012, The Roundcube Dev Team |
+ | |
+ | 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: |
- | Provide basic functions for the webmail package |
+ | Provide deprecated functions aliases for backward compatibility |
| |
+-----------------------------------------------------------------------+
| Author: Thomas Bruederli <roundcube@gmail.com> |
@@ -20,1864 +23,344 @@
*/
/**
- * Roundcube Webmail common functions
+ * Roundcube Webmail deprecated functions
*
* @package Core
* @author Thomas Bruederli <roundcube@gmail.com>
*/
-require_once('lib/utf7.inc');
-require_once('include/rcube_shared.inc');
-
-// fallback if not PHP modules are available
-@include_once('lib/utf8.class.php');
-
-// define constannts for input reading
-define('RCUBE_INPUT_GET', 0x0101);
-define('RCUBE_INPUT_POST', 0x0102);
-define('RCUBE_INPUT_GPC', 0x0103);
+// constants for input reading
+define('RCUBE_INPUT_GET', rcube_ui::INPUT_GET);
+define('RCUBE_INPUT_POST', rcube_ui::INPUT_POST);
+define('RCUBE_INPUT_GPC', rcube_ui::INPUT_GPC);
-
-/**
- * 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 rcmail::get_instance()->db->table_name($table);
+}
- // return table name if configured
- $config_key = 'db_table_'.$table;
-
- if (strlen($CONFIG[$config_key]))
- return $CONFIG[$config_key];
-
- return $table;
- }
-
-
-/**
- * Return correct name for a specific database sequence
- * (used for Postgres only)
- *
- * @param string Secuence name
- * @return string Translated sequence name
- */
function get_sequence_name($sequence)
- {
- // return sequence name if configured
- $config_key = 'db_sequence_'.$sequence;
- $opt = rcmail::get_instance()->config->get($config_key);
+{
+ return rcmail::get_instance()->db->sequence_name($sequence);
+}
- if (!empty($opt))
- return $opt;
-
- return $sequence;
- }
-
-
-/**
- * Get localized text in the desired language
- * It's a global wrapper for rcmail::gettext()
- *
- * @param mixed Named parameters array or label name
- * @return string Localized text
- * @see rcmail::gettext()
- */
function rcube_label($p, $domain=null)
{
- return rcmail::get_instance()->gettext($p, $domain);
+ return rcmail::get_instance()->gettext($p, $domain);
}
+function rcube_label_exists($name, $domain=null, &$ref_domain = null)
+{
+ return rcmail::get_instance()->text_exists($name, $domain, $ref_domain);
+}
-/**
- * Overwrite action variable
- *
- * @param string New action value
- */
function rcmail_overwrite_action($action)
- {
- $app = rcmail::get_instance();
- $app->action = $action;
- $app->output->set_env('action', $action);
- }
+{
+ rcmail::get_instance()->overwrite_action($action);
+}
-
-/**
- * Compose an URL for a specific action
- *
- * @param string Request action
- * @param array More URL parameters
- * @param string Request task (omit if the same)
- * @return The application URL
- */
function rcmail_url($action, $p=array(), $task=null)
{
- $app = rcmail::get_instance();
- return $app->url((array)$p + array('_action' => $action, 'task' => $task));
+ return rcube_ui::url($action, $p, $task);
}
-
-/**
- * Garbage collector function for temp files.
- * Remove temp files older than two days
- */
function rcmail_temp_gc()
- {
- $rcmail = rcmail::get_instance();
+{
+ $rcmail = rcmail::get_instance()->temp_gc();
+}
- $tmp = unslashify($rcmail->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);
- }
- }
-
-
-/**
- * Garbage collector for cache entries.
- * Remove all expired message cache records
- * @return void
- */
-function rcmail_cache_gc()
- {
- $rcmail = rcmail::get_instance();
- $db = $rcmail->get_dbh();
-
- // get target timestamp
- $ts = get_offset_time($rcmail->config->get('message_cache_lifetime', '30d'), -1);
-
- $db->query("DELETE FROM ".get_table_name('messages')."
- WHERE created < " . $db->fromunixtime($ts));
-
- $db->query("DELETE FROM ".get_table_name('cache')."
- WHERE created < " . $db->fromunixtime($ts));
- }
-
-
-/**
- * Catch an error and throw an exception.
- *
- * @param int Level of the error
- * @param string Error message
- */
-function rcube_error_handler($errno, $errstr)
- {
- throw new ErrorException($errstr, 0, $errno);
- }
-
-
-/**
- * Convert a string from one charset to another.
- * Uses mbstring and iconv functions if possible
- *
- * @param string Input string
- * @param string Suspected charset of the input string
- * @param string Target charset to convert to; defaults to RCMAIL_CHARSET
- * @return string Converted string
- */
function rcube_charset_convert($str, $from, $to=NULL)
- {
- static $iconv_options = null;
- static $mbstring_loaded = null;
- static $mbstring_list = null;
- static $convert_warning = false;
- static $conv = null;
-
- $error = false;
-
- $to = empty($to) ? strtoupper(RCMAIL_CHARSET) : rcube_parse_charset($to);
- $from = rcube_parse_charset($from);
-
- if ($from == $to || empty($str) || empty($from))
- return $str;
-
- // convert charset using iconv module
- if (function_exists('iconv') && $from != 'UTF7-IMAP' && $to != 'UTF7-IMAP') {
- if ($iconv_options === null) {
- // ignore characters not available in output charset
- $iconv_options = '//IGNORE';
- if (iconv('', $iconv_options, '') === false) {
- // iconv implementation does not support options
- $iconv_options = '';
- }
- }
-
- // throw an exception if iconv reports an illegal character in input
- // it means that input string has been truncated
- set_error_handler('rcube_error_handler', E_NOTICE);
- try {
- $_iconv = iconv($from, $to . $iconv_options, $str);
- } catch (ErrorException $e) {
- $_iconv = false;
- }
- restore_error_handler();
- if ($_iconv !== false) {
- return $_iconv;
- }
- }
-
- if ($mbstring_loaded === null)
- $mbstring_loaded = extension_loaded('mbstring');
-
- // convert charset using mbstring module
- if ($mbstring_loaded) {
- $aliases['WINDOWS-1257'] = 'ISO-8859-13';
-
- if ($mbstring_list === null) {
- $mbstring_list = mb_list_encodings();
- $mbstring_list = array_map('strtoupper', $mbstring_list);
- }
-
- $mb_from = $aliases[$from] ? $aliases[$from] : $from;
- $mb_to = $aliases[$to] ? $aliases[$to] : $to;
-
- // return if encoding found, string matches encoding and convert succeeded
- if (in_array($mb_from, $mbstring_list) && in_array($mb_to, $mbstring_list)) {
- if (mb_check_encoding($str, $mb_from) && ($out = mb_convert_encoding($str, $mb_to, $mb_from)))
- return $out;
- }
- }
-
- // convert charset using bundled classes/functions
- if ($to == 'UTF-8') {
- if ($from == 'UTF7-IMAP') {
- if ($_str = utf7_to_utf8($str))
- return $_str;
- }
- else if ($from == 'UTF-7') {
- if ($_str = rcube_utf7_to_utf8($str))
- return $_str;
- }
- else if (($from == 'ISO-8859-1') && function_exists('utf8_encode')) {
- return utf8_encode($str);
- }
- else if (class_exists('utf8')) {
- if (!$conv)
- $conv = new utf8($from);
- else
- $conv->loadCharset($from);
-
- if($_str = $conv->strToUtf8($str))
- return $_str;
- }
- $error = true;
- }
-
- // encode string for output
- if ($from == 'UTF-8') {
- // @TODO: we need a function for UTF-7 (RFC2152) conversion
- if ($to == 'UTF7-IMAP' || $to == 'UTF-7') {
- if ($_str = utf8_to_utf7($str))
- return $_str;
- }
- else if ($to == 'ISO-8859-1' && function_exists('utf8_decode')) {
- return utf8_decode($str);
- }
- else if (class_exists('utf8')) {
- if (!$conv)
- $conv = new utf8($to);
- else
- $conv->loadCharset($from);
-
- if ($_str = $conv->strToUtf8($str))
- return $_str;
- }
- $error = true;
- }
-
- // report error
- if ($error && !$convert_warning) {
- raise_error(array(
- 'code' => 500,
- 'type' => 'php',
- 'file' => __FILE__,
- 'line' => __LINE__,
- 'message' => "Could not convert string from $from to $to. Make sure iconv/mbstring is installed or lib/utf8.class is available."
- ), true, false);
-
- $convert_warning = true;
- }
-
- // return UTF-8 or original string
- return $str;
- }
-
-
-/**
- * Parse and validate charset name string (see #1485758).
- * Sometimes charset string is malformed, there are also charset aliases
- * but we need strict names for charset conversion (specially utf8 class)
- *
- * @param string Input charset name
- * @return string The validated charset name
- */
-function rcube_parse_charset($input)
- {
- static $charsets = array();
- $charset = strtoupper($input);
-
- if (isset($charsets[$input]))
- return $charsets[$input];
-
- $charset = preg_replace(array(
- '/^[^0-9A-Z]+/', // e.g. _ISO-8859-JP$SIO
- '/\$.*$/', // e.g. _ISO-8859-JP$SIO
- '/UNICODE-1-1-*/', // RFC1641/1642
- '/^X-/', // X- prefix (e.g. X-ROMAN8 => ROMAN8)
- ), '', $charset);
-
- if ($charset == 'BINARY')
- return $charsets[$input] = null;
-
- # Aliases: some of them from HTML5 spec.
- $aliases = array(
- 'USASCII' => 'WINDOWS-1252',
- 'ANSIX31101983' => 'WINDOWS-1252',
- 'ANSIX341968' => 'WINDOWS-1252',
- 'UNKNOWN8BIT' => 'ISO-8859-15',
- 'UNKNOWN' => 'ISO-8859-15',
- 'USERDEFINED' => 'ISO-8859-15',
- 'KSC56011987' => 'EUC-KR',
- 'GB2312' => 'GBK',
- 'GB231280' => 'GBK',
- 'UNICODE' => 'UTF-8',
- 'UTF7IMAP' => 'UTF7-IMAP',
- 'TIS620' => 'WINDOWS-874',
- 'ISO88599' => 'WINDOWS-1254',
- 'ISO885911' => 'WINDOWS-874',
- 'MACROMAN' => 'MACINTOSH',
- '77' => 'MAC',
- '128' => 'SHIFT-JIS',
- '129' => 'CP949',
- '130' => 'CP1361',
- '134' => 'GBK',
- '136' => 'BIG5',
- '161' => 'WINDOWS-1253',
- '162' => 'WINDOWS-1254',
- '163' => 'WINDOWS-1258',
- '177' => 'WINDOWS-1255',
- '178' => 'WINDOWS-1256',
- '186' => 'WINDOWS-1257',
- '204' => 'WINDOWS-1251',
- '222' => 'WINDOWS-874',
- '238' => 'WINDOWS-1250',
- 'MS950' => 'CP950',
- 'WINDOWS949' => 'UHC',
- );
-
- // allow A-Z and 0-9 only
- $str = preg_replace('/[^A-Z0-9]/', '', $charset);
-
- if (isset($aliases[$str]))
- $result = $aliases[$str];
- // UTF
- else if (preg_match('/U[A-Z][A-Z](7|8|16|32)(BE|LE)*/', $str, $m))
- $result = 'UTF-' . $m[1] . $m[2];
- // ISO-8859
- else if (preg_match('/ISO8859([0-9]{0,2})/', $str, $m)) {
- $iso = 'ISO-8859-' . ($m[1] ? $m[1] : 1);
- // some clients sends windows-1252 text as latin1,
- // it is safe to use windows-1252 for all latin1
- $result = $iso == 'ISO-8859-1' ? 'WINDOWS-1252' : $iso;
- }
- // handle broken charset names e.g. WINDOWS-1250HTTP-EQUIVCONTENT-TYPE
- else if (preg_match('/(WIN|WINDOWS)([0-9]+)/', $str, $m)) {
- $result = 'WINDOWS-' . $m[2];
- }
- // LATIN
- else if (preg_match('/LATIN(.*)/', $str, $m)) {
- $aliases = array('2' => 2, '3' => 3, '4' => 4, '5' => 9, '6' => 10,
- '7' => 13, '8' => 14, '9' => 15, '10' => 16,
- 'ARABIC' => 6, 'CYRILLIC' => 5, 'GREEK' => 7, 'GREEK1' => 7, 'HEBREW' => 8);
-
- // some clients sends windows-1252 text as latin1,
- // it is safe to use windows-1252 for all latin1
- if ($m[1] == 1) {
- $result = 'WINDOWS-1252';
- }
- // if iconv is not supported we need ISO labels, it's also safe for iconv
- else if (!empty($aliases[$m[1]])) {
- $result = 'ISO-8859-'.$aliases[$m[1]];
- }
- // iconv requires convertion of e.g. LATIN-1 to LATIN1
- else {
- $result = $str;
- }
- }
- else {
- $result = $charset;
- }
-
- $charsets[$input] = $result;
-
- return $result;
- }
-
-
-/**
- * Converts string from standard UTF-7 (RFC 2152) to UTF-8.
- *
- * @param string Input string
- * @return string The converted string
- */
-function rcube_utf7_to_utf8($str)
{
- $Index_64 = array(
- 0,0,0,0, 0,0,0,0, 0,0,0,0, 0,0,0,0,
- 0,0,0,0, 0,0,0,0, 0,0,0,0, 0,0,0,0,
- 0,0,0,0, 0,0,0,0, 0,0,0,1, 0,0,0,0,
- 1,1,1,1, 1,1,1,1, 1,1,0,0, 0,0,0,0,
- 0,1,1,1, 1,1,1,1, 1,1,1,1, 1,1,1,1,
- 1,1,1,1, 1,1,1,1, 1,1,1,0, 0,0,0,0,
- 0,1,1,1, 1,1,1,1, 1,1,1,1, 1,1,1,1,
- 1,1,1,1, 1,1,1,1, 1,1,1,0, 0,0,0,0,
- );
-
- $u7len = strlen($str);
- $str = strval($str);
- $res = '';
-
- for ($i=0; $u7len > 0; $i++, $u7len--)
- {
- $u7 = $str[$i];
- if ($u7 == '+')
- {
- $i++;
- $u7len--;
- $ch = '';
-
- for (; $u7len > 0; $i++, $u7len--)
- {
- $u7 = $str[$i];
-
- if (!$Index_64[ord($u7)])
- break;
-
- $ch .= $u7;
- }
-
- if ($ch == '') {
- if ($u7 == '-')
- $res .= '+';
- continue;
- }
-
- $res .= rcube_utf16_to_utf8(base64_decode($ch));
- }
- else
- {
- $res .= $u7;
- }
- }
-
- return $res;
+ return rcube_charset::convert($str, $from, $to);
}
-/**
- * Converts string from UTF-16 to UTF-8 (helper for utf-7 to utf-8 conversion)
- *
- * @param string Input string
- * @return string The converted string
- */
-function rcube_utf16_to_utf8($str)
+function rc_detect_encoding($string, $failover='')
{
- $len = strlen($str);
- $dec = '';
-
- for ($i = 0; $i < $len; $i += 2) {
- $c = ord($str[$i]) << 8 | ord($str[$i + 1]);
- if ($c >= 0x0001 && $c <= 0x007F) {
- $dec .= chr($c);
- } else if ($c > 0x07FF) {
- $dec .= chr(0xE0 | (($c >> 12) & 0x0F));
- $dec .= chr(0x80 | (($c >> 6) & 0x3F));
- $dec .= chr(0x80 | (($c >> 0) & 0x3F));
- } else {
- $dec .= chr(0xC0 | (($c >> 6) & 0x1F));
- $dec .= chr(0x80 | (($c >> 0) & 0x3F));
- }
- }
- return $dec;
+ return rcube_charset::detect($string, $failover);
}
+function rc_utf8_clean($input)
+{
+ return rcube_charset::clean($input);
+}
-/**
- * Replacing specials characters to a specific encoding type
- *
- * @param string Input string
- * @param string Encoding type: text|html|xml|js|url
- * @param string Replace mode for tags: show|replace|remove
- * @param boolean Convert newlines
- * @return string The quoted string
- */
+function json_serialize($input)
+{
+ return rcube_output::json_serialize($input);
+}
+
function rep_specialchars_output($str, $enctype='', $mode='', $newlines=TRUE)
- {
- static $html_encode_arr = false;
- static $js_rep_table = false;
- static $xml_rep_table = false;
+{
+ return rcube_ui::rep_specialchars_output($str, $enctype, $mode, $newlines);
+}
- if (!$enctype)
- $enctype = $OUTPUT->type;
-
- // encode for HTML output
- if ($enctype=='html')
- {
- if (!$html_encode_arr)
- {
- $html_encode_arr = get_html_translation_table(HTML_SPECIALCHARS);
- unset($html_encode_arr['?']);
- }
-
- $ltpos = strpos($str, '<');
- $encode_arr = $html_encode_arr;
-
- // don't replace quotes and html tags
- if (($mode=='show' || $mode=='') && $ltpos!==false && strpos($str, '>', $ltpos)!==false)
- {
- unset($encode_arr['"']);
- unset($encode_arr['<']);
- unset($encode_arr['>']);
- unset($encode_arr['&']);
- }
- else if ($mode=='remove')
- $str = strip_tags($str);
-
- $out = strtr($str, $encode_arr);
-
- // avoid douple quotation of &
- $out = preg_replace('/&([A-Za-z]{2,6}|#[0-9]{2,4});/', '&\\1;', $out);
-
- return $newlines ? nl2br($out) : $out;
- }
-
- // if the replace tables for XML and JS are not yet defined
- if ($js_rep_table===false)
- {
- $js_rep_table = $xml_rep_table = array();
- $xml_rep_table['&'] = '&';
-
- for ($c=160; $c<256; $c++) // can be increased to support more charsets
- $xml_rep_table[chr($c)] = "&#$c;";
-
- $xml_rep_table['"'] = '"';
- $js_rep_table['"'] = '\\"';
- $js_rep_table["'"] = "\\'";
- $js_rep_table["\\"] = "\\\\";
- // Unicode line and paragraph separators (#1486310)
- $js_rep_table[chr(hexdec(E2)).chr(hexdec(80)).chr(hexdec(A8))] = '
';
- $js_rep_table[chr(hexdec(E2)).chr(hexdec(80)).chr(hexdec(A9))] = '
';
- }
-
- // encode for javascript use
- if ($enctype=='js')
- return preg_replace(array("/\r?\n/", "/\r/", '/<\\//'), array('\n', '\n', '<\\/'), strtr($str, $js_rep_table));
-
- // encode for plaintext
- if ($enctype=='text')
- return str_replace("\r\n", "\n", $mode=='remove' ? strip_tags($str) : $str);
-
- if ($enctype=='url')
- return rawurlencode($str);
-
- // encode for XML
- if ($enctype=='xml')
- return strtr($str, $xml_rep_table);
-
- // no encoding given -> return original string
- return $str;
- }
-
-/**
- * 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)
- {
- return rep_specialchars_output($str, 'html', $mode, $newlines);
- }
+{
+ return rcube_ui::Q($str, $mode, $newlines);
+}
-/**
- * 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 rep_specialchars_output($str, 'js');
- }
+{
+ return rcube_ui::JQ($str);
+}
-
-/**
- * Read input value and convert it for internal use
- * Performs stripslashes() and charset conversion if necessary
- *
- * @param string Field name to read
- * @param int Source to get value from (GPC)
- * @param boolean Allow HTML tags in field value
- * @param string Charset to convert into
- * @return string Field value or NULL if not available
- */
function get_input_value($fname, $source, $allow_html=FALSE, $charset=NULL)
{
- $value = NULL;
-
- if ($source==RCUBE_INPUT_GET && isset($_GET[$fname]))
- $value = $_GET[$fname];
- else if ($source==RCUBE_INPUT_POST && isset($_POST[$fname]))
- $value = $_POST[$fname];
- else if ($source==RCUBE_INPUT_GPC)
- {
- if (isset($_POST[$fname]))
- $value = $_POST[$fname];
- else if (isset($_GET[$fname]))
- $value = $_GET[$fname];
- else if (isset($_COOKIE[$fname]))
- $value = $_COOKIE[$fname];
- }
-
- return parse_input_value($value, $allow_html, $charset);
+ return rcube_ui::get_input_value($fname, $source, $allow_html, $charset);
}
-/**
- * Parse/validate input value. See get_input_value()
- * Performs stripslashes() and charset conversion if necessary
- *
- * @param string Input value
- * @param boolean Allow HTML tags in field value
- * @param string Charset to convert into
- * @return string Parsed value
- */
function parse_input_value($value, $allow_html=FALSE, $charset=NULL)
{
- global $OUTPUT;
-
- if (empty($value))
- return $value;
-
- if (is_array($value)) {
- foreach ($value as $idx => $val)
- $value[$idx] = parse_input_value($val, $allow_html, $charset);
- return $value;
- }
-
- // strip single quotes if magic_quotes_sybase is enabled
- if (ini_get('magic_quotes_sybase'))
- $value = str_replace("''", "'", $value);
- // strip slashes if magic_quotes enabled
- else if (get_magic_quotes_gpc() || get_magic_quotes_runtime())
- $value = stripslashes($value);
-
- // remove HTML tags if not allowed
- if (!$allow_html)
- $value = strip_tags($value);
-
- // convert to internal charset
- if (is_object($OUTPUT) && $charset)
- return rcube_charset_convert($value, $OUTPUT->get_charset(), $charset);
- else
- return $value;
+ return rcube_ui::parse_input_value($value, $allow_html, $charset);
}
-/**
- * Convert array of request parameters (prefixed with _)
- * to a regular array with non-prefixed keys.
- *
- * @param int Source to get value from (GPC)
- * @return array Hash array with all request parameters
- */
-function request2param($mode = RCUBE_INPUT_GPC)
+function request2param($mode = RCUBE_INPUT_GPC, $ignore = 'task|action')
{
- $out = array();
- $src = $mode == RCUBE_INPUT_GET ? $_GET : ($mode == RCUBE_INPUT_POST ? $_POST : $_REQUEST);
- foreach ($src as $key => $value) {
- $fname = $key[0] == '_' ? substr($key, 1) : $key;
- $out[$fname] = get_input_value($key, $mode);
- }
-
- return $out;
+ return rcube_ui::request2param($mode, $ignore);
}
-/**
- * Remove all non-ascii and non-word chars
- * except ., -, _
- */
-function asciiwords($str, $css_id = false, $replace_with = '')
+function html_identifier($str, $encode=false)
{
- $allowed = 'a-z0-9\_\-' . (!$css_id ? '\.' : '');
- return preg_replace("/[^$allowed]/i", $replace_with, $str);
+ return rcube_ui::html_identifier($str, $encode);
}
-/**
- * Remove single and double quotes from given string
- *
- * @param string Input value
- * @return string Dequoted string
- */
-function strip_quotes($str)
-{
- return str_replace(array("'", '"'), '', $str);
-}
-
-
-/**
- * Remove new lines characters from given string
- *
- * @param string Input value
- * @return string Stripped string
- */
-function strip_newlines($str)
-{
- return preg_replace('/[\r\n]/', '', $str);
-}
-
-
-/**
- * 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 $RCMAIL;
-
- $table = new html_table(/*array('cols' => count($a_show_cols))*/);
-
- // add table header
- if (!$attrib['noheader'])
- foreach ($a_show_cols as $col)
- $table->add_header($col, Q(rcube_label($col)));
-
- $c = 0;
- if (!is_array($table_data))
- {
- $db = $RCMAIL->get_dbh();
- while ($table_data && ($sql_arr = $db->fetch_assoc($table_data)))
- {
- $zebra_class = $c % 2 ? 'even' : 'odd';
- $table->add_row(array('id' => 'rcmrow' . $sql_arr[$id_col], 'class' => $zebra_class));
+{
+ return rcube_ui::table_output($attrib, $table_data, $a_show_cols, $id_col);
+}
- // format each col
- foreach ($a_show_cols as $col)
- $table->add($col, Q($sql_arr[$col]));
-
- $c++;
- }
- }
- else
- {
- foreach ($table_data as $row_data)
- {
- $zebra_class = $c % 2 ? 'even' : 'odd';
- if (!empty($row_data['class']))
- $zebra_class .= ' '.$row_data['class'];
-
- $table->add_row(array('id' => 'rcmrow' . $row_data[$id_col], 'class' => $zebra_class));
-
- // format each col
- foreach ($a_show_cols as $col)
- $table->add($col, Q($row_data[$col]));
-
- $c++;
- }
- }
-
- return $table->show($attrib);
- }
-
-
-/**
- * Create an edit field for inclusion on a form
- *
- * @param string col field name
- * @param string value field value
- * @param array attrib HTML element attributes for field
- * @param string type HTML element type (default 'text')
- * @return string HTML field definition
- */
function rcmail_get_edit_field($col, $value, $attrib, $type='text')
- {
- $fname = '_'.$col;
- $attrib['name'] = $fname;
-
- if ($type=='checkbox')
- {
- $attrib['value'] = '1';
- $input = new html_checkbox($attrib);
- }
- else if ($type=='textarea')
- {
- $attrib['cols'] = $attrib['size'];
- $input = new html_textarea($attrib);
- }
- else
- $input = new html_inputfield($attrib);
+{
+ return rcube_ui::get_edit_field($col, $value, $attrib, $type);
+}
- // use value from post
- if (!empty($_POST[$fname]))
- $value = get_input_value($fname, RCUBE_INPUT_POST,
- $type == 'textarea' && strpos($attrib['class'], 'mce_editor')!==false ? true : false);
+function rcmail_mod_css_styles($source, $container_id, $allow_remote=false)
+{
+ return rcube_ui::mod_css_styles($source, $container_id, $allow_remote);
+}
- $out = $input->show($value);
-
- return $out;
- }
-
-
-/**
- * Replace all css definitions with #container [def]
- * and remove css-inlined scripting
- *
- * @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)
- {
- $last_pos = 0;
- $replacements = new rcube_string_replacer;
-
- // ignore the whole block if evil styles are detected
- $stripped = preg_replace('/[^a-z\(:]/', '', rcmail_xss_entity_decode($source));
- if (preg_match('/expression|behavior|url\(|import/', $stripped))
- return '/* evil! */';
-
- // remove css comments (sometimes used for some ugly hacks)
- $source = preg_replace('!/\*(.+)\*/!Ums', '', $source);
-
- // cut out all contents between { and }
- while (($pos = strpos($source, '{', $last_pos)) && ($pos2 = strpos($source, '}', $pos)))
- {
- $key = $replacements->add(substr($source, $pos+1, $pos2-($pos+1)));
- $source = substr($source, 0, $pos+1) . $replacements->get_replacement($key) . substr($source, $pos2, strlen($source)-$pos2);
- $last_pos = $pos+2;
- }
-
- // remove html comments 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',
- '/'.preg_quote($container_id, '/').'\s+body/i',
- ),
- array(
- '',
- "\\1#$container_id \\2",
- $container_id,
- ),
- $source);
-
- // put block contents back in
- $styles = $replacements->resolve($styles);
-
- return $styles;
- }
-
-
-/**
- * Decode escaped entities used by known XSS exploits.
- * See http://downloads.securityfocus.com/vulnerabilities/exploits/26800.eml for examples
- *
- * @param string CSS content to decode
- * @return string Decoded string
- */
function rcmail_xss_entity_decode($content)
{
- $out = html_entity_decode(html_entity_decode($content));
- $out = preg_replace_callback('/\\\([0-9a-f]{4})/i', 'rcmail_xss_entity_decode_callback', $out);
- $out = preg_replace('#/\*.*\*/#Um', '', $out);
- return $out;
+ return rcube_ui::xss_entity_decode($content);
}
-
-/**
- * preg_replace_callback callback for rcmail_xss_entity_decode_callback
- *
- * @param array matches result from preg_replace_callback
- * @return string decoded entity
- */
-function rcmail_xss_entity_decode_callback($matches)
-{
- return chr(hexdec($matches[1]));
-}
-
-/**
- * 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
- $attrib_str = '';
- foreach ($allowed_attribs as $a)
- if (isset($attrib[$a]))
- $attrib_str .= sprintf(' %s="%s"', $a, str_replace('"', '"', $attrib[$a]));
+{
+ return html::attrib_string($attrib, $allowed_attribs);
+}
- return $attrib_str;
- }
-
-
-/**
- * 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();
- preg_match_all('/\s*([-_a-z]+)=(["\'])??(?(2)([^\2]*)\2|(\S+?))/Ui', stripslashes($str), $regs, PREG_SET_ORDER);
-
- // convert attributes to an associative array (name => value)
- if ($regs) {
- foreach ($regs as $attr) {
- $attrib[strtolower($attr[1])] = html_entity_decode($attr[3] . $attr[4]);
- }
- }
-
- return $attrib;
- }
-
-
-/**
- * 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;
-
- $ts = NULL;
-
- if (is_numeric($date))
- $ts = $date;
- else if (!empty($date))
- {
- // support non-standard "GMTXXXX" literal
- $date = preg_replace('/GMT\s*([+-][0-9]+)/', '\\1', $date);
- // if date parsing fails, we have a date in non-rfc format.
- // remove token from the end and try again
- while ((($ts = @strtotime($date))===false) || ($ts < 0))
- {
- $d = explode(' ', $date);
- array_pop($d);
- if (!$d) break;
- $date = implode(' ', $d);
- }
- }
-
- if (empty($ts))
- return '';
-
- // get user's timezone
- if ($CONFIG['timezone'] === 'auto')
- $tz = isset($_SESSION['timezone']) ? $_SESSION['timezone'] : date('Z')/3600;
- else {
- $tz = $CONFIG['timezone'];
- if ($CONFIG['dst_active'])
- $tz++;
- }
-
- // convert time to user's timezone
- $timestamp = $ts - date('Z', $ts) + ($tz * 3600);
-
- // get current timestamp in user's timezone
- $now = time(); // local time
- $now -= (int)date('Z'); // make GMT time
- $now += ($tz * 3600); // user's time
- $now_date = getdate($now);
-
- $today_limit = mktime(0, 0, 0, $now_date['mon'], $now_date['mday'], $now_date['year']);
- $week_limit = mktime(0, 0, 0, $now_date['mon'], $now_date['mday']-6, $now_date['year']);
-
- // define date format depending on current time
- if (!$format) {
- if ($CONFIG['prettydate'] && $timestamp > $today_limit && $timestamp < $now)
- return sprintf('%s %s', rcube_label('today'), date($CONFIG['date_today'] ? $CONFIG['date_today'] : 'H:i', $timestamp));
- else if ($CONFIG['prettydate'] && $timestamp > $week_limit && $timestamp < $now)
- $format = $CONFIG['date_short'] ? $CONFIG['date_short'] : 'D H:i';
- else
- $format = $CONFIG['date_long'] ? $CONFIG['date_long'] : 'd.m.Y H:i';
- }
-
- // strftime() format
- if (preg_match('/%[a-z]+/i', $format))
- return strftime($format, $timestamp);
-
- // parse format string manually in order to provide localized weekday and month names
- // an alternative would be to convert the date() format string to fit with strftime()
- $out = '';
- for($i=0; $i<strlen($format); $i++)
- {
- if ($format{$i}=='\\') // skip escape chars
- continue;
-
- // write char "as-is"
- if ($format{$i}==' ' || $format{$i-1}=='\\')
- $out .= $format{$i};
- // weekday (short)
- else if ($format{$i}=='D')
- $out .= rcube_label(strtolower(date('D', $timestamp)));
- // weekday long
- else if ($format{$i}=='l')
- $out .= rcube_label(strtolower(date('l', $timestamp)));
- // month name (short)
- else if ($format{$i}=='M')
- $out .= rcube_label(strtolower(date('M', $timestamp)));
- // month name (long)
- else if ($format{$i}=='F')
- $out .= rcube_label('long'.strtolower(date('M', $timestamp)));
- else if ($format{$i}=='x')
- $out .= strftime('%x %X', $timestamp);
- else
- $out .= date($format{$i}, $timestamp);
- }
-
- return $out;
- }
-
-
-/**
- * Compose a valid representation 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)
- {
- // Special chars as defined by RFC 822 need to in quoted string (or escaped).
- return sprintf('%s <%s>', preg_match('/[\(\)\<\>\\\.\[\]@,;:"]/', $name) ? '"'.addcslashes($name, '"').'"' : $name, trim($email));
- }
- else
- return trim($email);
- }
-
-
-
-/****** debugging functions ********/
-
-
-/**
- * Print or write debug messages
- *
- * @param mixed Debug message or data
- * @return void
- */
-function console()
- {
- $args = func_get_args();
-
- if (class_exists('rcmail', false)) {
- $rcmail = rcmail::get_instance();
- if (is_object($rcmail->plugins))
- $rcmail->plugins->exec_hook('console', $args);
- }
-
- $msg = array();
- foreach ($args as $arg)
- $msg[] = !is_string($arg) ? var_export($arg, true) : $arg;
-
- if (!($GLOBALS['CONFIG']['debug_level'] & 4))
- write_log('console', join(";\n", $msg));
- else if ($GLOBALS['OUTPUT']->ajax_call)
- print "/*\n " . join(";\n", $msg) . " \n*/\n";
- else
- {
- print '<div style="background:#eee; border:1px solid #ccc; margin-bottom:3px; padding:6px"><pre>';
- print join(";<br/>\n", $msg);
- print "</pre></div>\n";
- }
- }
-
-
-/**
- * Append a line to a logfile in the logs directory.
- * Date will be added automatically to the line.
- *
- * @param $name name of log file
- * @param line Line to append
- * @return void
- */
-function write_log($name, $line)
- {
- global $CONFIG, $RCMAIL;
-
- if (!is_string($line))
- $line = var_export($line, true);
-
- if (empty($CONFIG['log_date_format']))
- $CONFIG['log_date_format'] = 'd-M-Y H:i:s O';
-
- $date = date($CONFIG['log_date_format']);
-
- // trigger logging hook
- if (is_object($RCMAIL) && is_object($RCMAIL->plugins)) {
- $log = $RCMAIL->plugins->exec_hook('write_log', array('name' => $name, 'date' => $date, 'line' => $line));
- $name = $log['name'];
- $line = $log['line'];
- $date = $log['date'];
- if ($log['abort'])
- return true;
- }
-
- if ($CONFIG['log_driver'] == 'syslog') {
- $prio = $name == 'errors' ? LOG_ERR : LOG_INFO;
- syslog($prio, $line);
- return true;
- }
- else {
- $line = sprintf("[%s]: %s\n", $date, $line);
-
- // log_driver == 'file' is assumed here
- if (empty($CONFIG['log_dir']))
- $CONFIG['log_dir'] = INSTALL_PATH.'logs';
-
- // try to open specific log file for writing
- $logfile = $CONFIG['log_dir'].'/'.$name;
- if ($fp = @fopen($logfile, 'a')) {
- fwrite($fp, $line);
- fflush($fp);
- fclose($fp);
- return true;
- }
- else
- trigger_error("Error writing to log file $logfile; Please check permissions", E_USER_WARNING);
- }
- return false;
-}
-
-
-/**
- * Write login data (name, ID, IP address) to the 'userlogins' log file.
- *
- * @return void
- */
-function rcmail_log_login()
{
- global $RCMAIL;
-
- if (!$RCMAIL->config->get('log_logins') || !$RCMAIL->user)
- return;
-
- $address = $_SERVER['REMOTE_ADDR'];
- // append the NGINX X-Real-IP header, if set
- if (!empty($_SERVER['HTTP_X_REAL_IP'])) {
- $remote_ip[] = 'X-Real-IP: ' . $_SERVER['HTTP_X_REAL_IP'];
- }
- // append the X-Forwarded-For header, if set
- if (!empty($_SERVER['HTTP_X_FORWARDED_FOR'])) {
- $remote_ip[] = 'X-Forwarded-For: ' . $_SERVER['HTTP_X_FORWARDED_FOR'];
- }
-
- if (!empty($remote_ip))
- $address .= '(' . implode(',', $remote_ip) . ')';
-
- write_log('userlogins', sprintf('Successful login for %s (ID: %d) from %s',
- $RCMAIL->user->get_username(), $RCMAIL->user->ID, $address));
+ return html::parse_attrib_string($str);
}
-
-/**
- * @access private
- * @return mixed
- */
-function rcube_timer()
+function format_date($date, $format=NULL, $convert=true)
{
- return microtime(true);
-}
-
-
-/**
- * @access private
- * @return void
- */
-function rcube_print_time($timer, $label='Timer', $dest='console')
-{
- static $print_count = 0;
-
- $print_count++;
- $now = rcube_timer();
- $diff = $now-$timer;
-
- if (empty($label))
- $label = 'Timer '.$print_count;
-
- write_log($dest, sprintf("%s: %0.4f sec", $label, $diff));
+ return rcube_ui::format_date($date, $format, $convert);
}
-
-/**
- * Return the mailboxlist in HTML
- *
- * @param array Named parameters
- * @return string HTML code for the gui object
- */
function rcmail_mailbox_list($attrib)
{
- global $RCMAIL;
- static $a_mailboxes;
-
- $attrib += array('maxlength' => 100, 'realnames' => false);
-
- // add some labels to client
- $RCMAIL->output->add_label('purgefolderconfirm', 'deletemessagesconfirm');
-
- $type = $attrib['type'] ? $attrib['type'] : 'ul';
- unset($attrib['type']);
-
- if ($type=='ul' && !$attrib['id'])
- $attrib['id'] = 'rcmboxlist';
-
- // get mailbox list
- $mbox_name = $RCMAIL->imap->get_mailbox_name();
-
- // build the folders tree
- if (empty($a_mailboxes)) {
- // get mailbox list
- $a_folders = $RCMAIL->imap->list_mailboxes();
- $delimiter = $RCMAIL->imap->get_hierarchy_delimiter();
- $a_mailboxes = array();
-
- foreach ($a_folders as $folder)
- rcmail_build_folder_tree($a_mailboxes, $folder, $delimiter);
- }
-
- // allow plugins to alter the folder tree or to localize folder names
- $hook = $RCMAIL->plugins->exec_hook('render_mailboxlist', array('list' => $a_mailboxes, 'delimiter' => $delimiter));
-
- if ($type=='select') {
- $select = new html_select($attrib);
-
- // add no-selection option
- if ($attrib['noselection'])
- $select->add(rcube_label($attrib['noselection']), '0');
-
- rcmail_render_folder_tree_select($hook['list'], $mbox_name, $attrib['maxlength'], $select, $attrib['realnames']);
- $out = $select->show();
- }
- else {
- $js_mailboxlist = array();
- $out = html::tag('ul', $attrib, rcmail_render_folder_tree_html($hook['list'], $mbox_name, $js_mailboxlist, $attrib), html::$common_attrib);
-
- $RCMAIL->output->add_gui_object('mailboxlist', $attrib['id']);
- $RCMAIL->output->set_env('mailboxes', $js_mailboxlist);
- $RCMAIL->output->set_env('collapsed_folders', $RCMAIL->config->get('collapsed_folders'));
- }
-
- return $out;
+ return rcube_ui::folder_list($attrib);
}
-
-/**
- * Return the mailboxlist as html_select object
- *
- * @param array Named parameters
- * @return html_select HTML drop-down object
- */
-function rcmail_mailbox_select($p = array())
+function rcmail_mailbox_select($attrib = array())
{
- global $RCMAIL;
-
- $p += array('maxlength' => 100, 'realnames' => false);
- $a_mailboxes = array();
-
- if ($p['unsubscribed'])
- $list = $RCMAIL->imap->list_unsubscribed();
- else
- $list = $RCMAIL->imap->list_mailboxes();
-
- foreach ($list as $folder)
- if (empty($p['exceptions']) || !in_array($folder, $p['exceptions']))
- rcmail_build_folder_tree($a_mailboxes, $folder, $RCMAIL->imap->get_hierarchy_delimiter());
-
- $select = new html_select($p);
-
- if ($p['noselection'])
- $select->add($p['noselection'], '');
-
- rcmail_render_folder_tree_select($a_mailboxes, $mbox, $p['maxlength'], $select, $p['realnames']);
-
- return $select;
+ return rcube_ui::folder_selector($attrib);
}
-
-/**
- * Create a hierarchical array of the mailbox list
- * @access private
- * @return void
- */
-function rcmail_build_folder_tree(&$arrFolders, $folder, $delm='/', $path='')
+function rcmail_render_folder_tree_html(&$arrFolders, &$mbox_name, &$jslist, $attrib, $nestLevel = 0)
{
- global $RCMAIL;
-
- $pos = strpos($folder, $delm);
-
- if ($pos !== false) {
- $subFolders = substr($folder, $pos+1);
- $currentFolder = substr($folder, 0, $pos);
-
- // sometimes folder has a delimiter as the last character
- if (!strlen($subFolders))
- $virtual = false;
- else if (!isset($arrFolders[$currentFolder]))
- $virtual = true;
- else
- $virtual = $arrFolders[$currentFolder]['virtual'];
- }
- else {
- $subFolders = false;
- $currentFolder = $folder;
- $virtual = false;
- }
-
- $path .= $currentFolder;
-
- // Check \Noselect option (if options are in cache)
- if (!$virtual && ($opts = $RCMAIL->imap->mailbox_options($path))) {
- $virtual = in_array('\\Noselect', $opts);
- }
-
- if (!isset($arrFolders[$currentFolder])) {
- $arrFolders[$currentFolder] = array(
- 'id' => $path,
- 'name' => rcube_charset_convert($currentFolder, 'UTF7-IMAP'),
- 'virtual' => $virtual,
- 'folders' => array());
- }
- else
- $arrFolders[$currentFolder]['virtual'] = $virtual;
-
- if (strlen($subFolders))
- rcmail_build_folder_tree($arrFolders[$currentFolder]['folders'], $subFolders, $delm, $path.$delm);
+ return rcube_ui::render_folder_tree_html($arrFolders, $mbox_name, $jslist, $attrib, $nestLevel);
}
-
-/**
- * Return html for a structured list <ul> for the mailbox tree
- * @access private
- * @return string
- */
-function rcmail_render_folder_tree_html(&$arrFolders, &$mbox_name, &$jslist, $attrib, $nestLevel=0)
+function rcmail_render_folder_tree_select(&$arrFolders, &$mbox_name, $maxlength, &$select, $realnames = false, $nestLevel = 0, $opts = array())
{
- global $RCMAIL, $CONFIG;
-
- $maxlength = intval($attrib['maxlength']);
- $realnames = (bool)$attrib['realnames'];
- $msgcounts = $RCMAIL->imap->get_cache('messagecount');
-
- $idx = 0;
- $out = '';
- foreach ($arrFolders as $key => $folder) {
- $zebra_class = (($nestLevel+1)*$idx) % 2 == 0 ? 'even' : 'odd';
- $title = null;
-
- if (($folder_class = rcmail_folder_classname($folder['id'])) && !$realnames) {
- $foldername = rcube_label($folder_class);
- }
- else {
- $foldername = $folder['name'];
-
- // shorten the folder name to a given length
- if ($maxlength && $maxlength > 1) {
- $fname = abbreviate_string($foldername, $maxlength);
- if ($fname != $foldername)
- $title = $foldername;
- $foldername = $fname;
- }
- }
-
- // make folder name safe for ids and class names
- $folder_id = asciiwords($folder['id'], true, '_');
- $classes = array('mailbox');
-
- // set special class for Sent, Drafts, Trash and Junk
- if ($folder['id']==$CONFIG['sent_mbox'])
- $classes[] = 'sent';
- else if ($folder['id']==$CONFIG['drafts_mbox'])
- $classes[] = 'drafts';
- else if ($folder['id']==$CONFIG['trash_mbox'])
- $classes[] = 'trash';
- else if ($folder['id']==$CONFIG['junk_mbox'])
- $classes[] = 'junk';
- else if ($folder['id']=='INBOX')
- $classes[] = 'inbox';
- else
- $classes[] = '_'.asciiwords($folder_class ? $folder_class : strtolower($folder['id']), true);
-
- $classes[] = $zebra_class;
-
- if ($folder['id'] == $mbox_name)
- $classes[] = 'selected';
-
- $collapsed = preg_match('/&'.rawurlencode($folder['id']).'&/', $RCMAIL->config->get('collapsed_folders'));
- $unread = $msgcounts ? intval($msgcounts[$folder['id']]['UNSEEN']) : 0;
-
- if ($folder['virtual'])
- $classes[] = 'virtual';
- else if ($unread)
- $classes[] = 'unread';
-
- $js_name = JQ($folder['id']);
- $html_name = Q($foldername . ($unread ? " ($unread)" : ''));
- $link_attrib = $folder['virtual'] ? array() : array(
- 'href' => rcmail_url('', array('_mbox' => $folder['id'])),
- 'onclick' => sprintf("return %s.command('list','%s',this)", JS_OBJECT_NAME, $js_name),
- 'title' => $title,
- );
-
- $out .= html::tag('li', array(
- 'id' => "rcmli".$folder_id,
- 'class' => join(' ', $classes),
- 'noclose' => true),
- html::a($link_attrib, $html_name) .
- (!empty($folder['folders']) ? html::div(array(
- 'class' => ($collapsed ? 'collapsed' : 'expanded'),
- 'style' => "position:absolute",
- 'onclick' => sprintf("%s.command('collapse-folder', '%s')", JS_OBJECT_NAME, $js_name)
- ), ' ') : ''));
-
- $jslist[$folder_id] = array('id' => $folder['id'], 'name' => $foldername, 'virtual' => $folder['virtual']);
-
- if (!empty($folder['folders'])) {
- $out .= html::tag('ul', array('style' => ($collapsed ? "display:none;" : null)),
- rcmail_render_folder_tree_html($folder['folders'], $mbox_name, $jslist, $attrib, $nestLevel+1));
- }
-
- $out .= "</li>\n";
- $idx++;
- }
-
- return $out;
+ return rcube_ui::render_folder_tree_select($arrFolders, $mbox_name, $maxlength, $select, $realnames, $nestLevel, $opts);
}
+function rcmail_build_folder_tree(&$arrFolders, $folder, $delm = '/', $path = '')
+{
+ return rcmail_ui::build_folder_tree($arrFolders, $folder, $delm, $path);
+}
-/**
- * Return html for a flat list <select> for the mailbox tree
- * @access private
- * @return string
- */
-function rcmail_render_folder_tree_select(&$arrFolders, &$mbox_name, $maxlength, &$select, $realnames=false, $nestLevel=0)
- {
- $idx = 0;
- $out = '';
- foreach ($arrFolders as $key=>$folder)
- {
- if (!$realnames && ($folder_class = rcmail_folder_classname($folder['id'])))
- $foldername = rcube_label($folder_class);
- else
- {
- $foldername = $folder['name'];
-
- // shorten the folder name to a given length
- if ($maxlength && $maxlength>1)
- $foldername = abbreviate_string($foldername, $maxlength);
- }
-
- $select->add(str_repeat(' ', $nestLevel*4) . $foldername, $folder['id']);
-
- if (!empty($folder['folders']))
- $out .= rcmail_render_folder_tree_select($folder['folders'], $mbox_name, $maxlength, $select, $realnames, $nestLevel+1);
-
- $idx++;
- }
-
- return $out;
- }
-
-
-/**
- * Return internal name for the given folder if it matches the configured special folders
- * @access private
- * @return string
- */
function rcmail_folder_classname($folder_id)
{
- global $CONFIG;
-
- if ($folder_id == 'INBOX')
- return 'inbox';
-
- // for these mailboxes we have localized labels and css classes
- foreach (array('sent', 'drafts', 'trash', 'junk') as $smbx)
- {
- if ($folder_id == $CONFIG[$smbx.'_mbox'])
- return $smbx;
- }
+ return rcube_ui::folder_classname($folder_id);
}
-
-/**
- * Try to localize the given IMAP folder name.
- * UTF-7 decode it in case no localized text was found
- *
- * @param string Folder name
- * @return string Localized folder name in UTF-8 encoding
- */
function rcmail_localize_foldername($name)
{
- if ($folder_class = rcmail_folder_classname($name))
- return rcube_label($folder_class);
- else
- return rcube_charset_convert($name, 'UTF7-IMAP');
+ return rcube_ui::localize_foldername($name);
}
+function rcmail_localize_folderpath($path)
+{
+ return rcube_ui::localize_folderpath($path);
+}
function rcmail_quota_display($attrib)
{
- global $OUTPUT;
-
- if (!$attrib['id'])
- $attrib['id'] = 'rcmquotadisplay';
-
- if(isset($attrib['display']))
- $_SESSION['quota_display'] = $attrib['display'];
-
- $OUTPUT->add_gui_object('quotadisplay', $attrib['id']);
-
- $quota = rcmail_quota_content($attrib);
-
- $OUTPUT->add_script('$(document).ready(function(){
- rcmail.set_quota('.json_serialize($quota).')});', 'foot');
-
- return html::span($attrib, '');
+ return rcube_ui::quota_display($attrib);
}
-
-function rcmail_quota_content($attrib=NULL)
+function rcmail_quota_content($attrib = null)
{
- global $RCMAIL;
-
- $quota = $RCMAIL->imap->get_quota();
- $quota = $RCMAIL->plugins->exec_hook('quota', $quota);
-
- $quota_result = (array) $quota;
- $quota_result['type'] = isset($_SESSION['quota_display']) ? $_SESSION['quota_display'] : '';
-
- if (!$quota['total'] && $RCMAIL->config->get('quota_zero_as_unlimited')) {
- $quota_result['title'] = rcube_label('unlimited');
- $quota_result['percent'] = 0;
- }
- else if ($quota['total']) {
- if (!isset($quota['percent']))
- $quota_result['percent'] = min(100, round(($quota['used']/max(1,$quota['total']))*100));
-
- $title = sprintf('%s / %s (%.0f%%)',
- show_bytes($quota['used'] * 1024), show_bytes($quota['total'] * 1024),
- $quota_result['percent']);
-
- $quota_result['title'] = $title;
-
- if ($attrib['width'])
- $quota_result['width'] = $attrib['width'];
- if ($attrib['height'])
- $quota_result['height'] = $attrib['height'];
- }
- else {
- $quota_result['title'] = rcube_label('unknown');
- $quota_result['percent'] = 0;
- }
-
- return $quota_result;
+ return rcube_ui::quota_content($attrib);
}
+function rcmail_display_server_error($fallback=null, $fallback_args=null)
+{
+ rcube_ui::display_server_error($fallback, $fallback_args);
+}
-/**
- * Output HTML editor scripts
- *
- * @param string Editor mode
- * @return void
- */
+function rcmail_filetype2classname($mimetype, $filename)
+{
+ return rcube_ui::file2class($mimetype, $filename);
+}
+
function rcube_html_editor($mode='')
{
- global $RCMAIL, $CONFIG;
-
- $hook = $RCMAIL->plugins->exec_hook('hmtl_editor', array('mode' => $mode));
-
- if ($hook['abort'])
- return;
-
- $lang = strtolower($_SESSION['language']);
-
- // TinyMCE uses 'tw' for zh_TW (which is wrong, because tw is a code of Twi language)
- $lang = ($lang == 'zh_tw') ? 'tw' : substr($lang, 0, 2);
-
- if (!file_exists(INSTALL_PATH . 'program/js/tiny_mce/langs/'.$lang.'.js'))
- $lang = 'en';
-
- $RCMAIL->output->include_script('tiny_mce/tiny_mce.js');
- $RCMAIL->output->include_script('editor.js');
- $RCMAIL->output->add_script(sprintf("rcmail_editor_init('\$__skin_path', '%s', %d, '%s');",
- JQ($lang), intval($CONFIG['enable_spellcheck']), $mode),
- 'foot');
+ rcube_ui::html_editor($mode);
}
+function rcmail_replace_emoticons($html)
+{
+ return rcube_ui::replace_emoticons($html);
+}
-/**
- * Check if working in SSL mode
- *
- * @param integer HTTPS port number
- * @param boolean Enables 'use_https' option checking
- * @return boolean
- */
+function rcmail_deliver_message(&$message, $from, $mailto, &$smtp_error, &$body_file=null, $smtp_opts=null)
+{
+ return rcmail::get_instance()->deliver_message($message, $from, $mailto, $smtp_error, $body_file, $smtp_opts);
+}
+
+function rcmail_gen_message_id()
+{
+ return rcmail::get_instance()->gen_message_id();
+}
+
+function rcmail_user_date()
+{
+ return rcmail::get_instance()->user_date();
+}
+
+function rcmail_mem_check($need)
+{
+ return rcube_ui::mem_check($need);
+}
+
function rcube_https_check($port=null, $use_https=true)
{
- global $RCMAIL;
-
- if (!empty($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) != 'off')
- return true;
- if (!empty($_SERVER['HTTP_X_FORWARDED_PROTO']) && strtolower($_SERVER['HTTP_X_FORWARDED_PROTO']) == 'https')
- return true;
- if ($port && $_SERVER['SERVER_PORT'] == $port)
- return true;
- if ($use_https && isset($RCMAIL) && $RCMAIL->config->get('use_https'))
- return true;
-
- return false;
+ return rcube_ui::https_check($port, $use_https);
}
-
-/**
- * For backward compatibility.
- *
- * @global rcmail $RCMAIL
- * @param string $var_name Variable name.
- * @return void
- */
function rcube_sess_unset($var_name=null)
{
- global $RCMAIL;
-
- $RCMAIL->session->remove($var_name);
+ rcmail::get_instance()->session->remove($var_name);
}
-
-
-/**
- * Replaces hostname variables
- *
- * @param string $name Hostname
- * @return string
- */
-function rcube_parse_host($name)
+function rcube_parse_host($name, $host='')
{
- // %n - host
- $n = preg_replace('/:\d+$/', '', $_SERVER['SERVER_NAME']);
- // %d - domain name without first part, e.g. %d=mail.domain.tld, %m=domain.tld
- $d = preg_replace('/^[^\.]+\./', '', $n);
- // %h - IMAP host
- $h = $_SESSION['imap_host'];
- // %z - IMAP domain without first part, e.g. %h=imap.domain.tld, %z=domain.tld
- $z = preg_replace('/^[^\.]+\./', '', $h);
-
- $name = str_replace(array('%n', '%d', '%h', '%z'), array($n, $d, $h, $z), $name);
- return $name;
+ return rcmail::parse_host($name, $host);
}
-
-/**
- * E-mail address validation
- *
- * @param string $email Email address
- * @param boolean $dns_check True to check dns
- * @return boolean
- */
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);
- if (sizeof($domain_array) < 2)
- return false; // Not enough parts to be a valid domain
-
- 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 || !rcmail::get_instance()->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;
+ return rcmail::get_instance()->check_email($email, $dns_check);
}
-
-/**
- * Helper class to turn relative urls into absolute ones
- * using a predefined base
- */
-class rcube_base_replacer
+function console()
{
- private $base_url;
-
- public function __construct($base)
- {
- $this->base_url = $base;
- }
-
- public function callback($matches)
- {
- return $matches[1] . '="' . make_absolute_url($matches[3], $this->base_url) . '"';
- }
+ call_user_func_array(array('rcmail', 'console'), func_get_args());
}
+function write_log($name, $line)
+{
+ return rcmail::write_log($name, $line);
+}
-/**
- * Throw system error and show error page
- *
- * @param array Named parameters
- * - code: Error code (required)
- * - type: Error type [php|db|imap|javascript] (required)
- * - message: Error message
- * - file: File where error occured
- * - line: Line where error occured
- * @param boolean True to log the error
- * @param boolean Terminate script execution
- */
-// may be defined in Installer
-if (!function_exists('raise_error')) {
+function rcmail_log_login()
+{
+ return rcmail::get_instance()->log_login();
+}
+
+function rcmail_remote_ip()
+{
+ return rcmail::remote_ip();
+}
+
+function rcube_check_referer()
+{
+ return rcmail::check_referer();
+}
+
+function rcube_timer()
+{
+ return rcmail::timer();
+}
+
+function rcube_print_time($timer, $label='Timer', $dest='console')
+{
+ rcmail::print_timer($timer, $label, $dest);
+}
+
function raise_error($arg=array(), $log=false, $terminate=false)
{
- global $__page_content, $CONFIG, $OUTPUT, $ERROR_CODE, $ERROR_MESSAGE;
-
- // report bug (if not incompatible browser)
- if ($log && $arg['type'] && $arg['message'])
- log_bug($arg);
-
- // display error page and terminate script
- if ($terminate) {
- $ERROR_CODE = $arg['code'];
- $ERROR_MESSAGE = $arg['message'];
- include('program/steps/utils/error.inc');
- exit;
- }
-}
+ rcmail::raise_error($arg, $log, $terminate);
}
-
-/**
- * Report error according to configured debug_level
- *
- * @param array Named parameters
- * @return void
- * @see raise_error()
- */
-function log_bug($arg_arr)
+function rcube_log_bug($arg_arr)
{
- global $CONFIG;
- $program = strtoupper($arg_arr['type']);
+ rcmail::log_bug($arg_arr);
+}
- // write error to local log file
- if ($CONFIG['debug_level'] & 1) {
- $post_query = ($_SERVER['REQUEST_METHOD'] == 'POST' ? '?_task='.urlencode($_POST['_task']).'&_action='.urlencode($_POST['_action']) : '');
- $log_entry = sprintf("%s Error: %s%s (%s %s)",
- $program,
- $arg_arr['message'],
- $arg_arr['file'] ? sprintf(' in %s on line %d', $arg_arr['file'], $arg_arr['line']) : '',
- $_SERVER['REQUEST_METHOD'],
- $_SERVER['REQUEST_URI'] . $post_query);
+function rcube_upload_progress()
+{
+ rcube_ui::upload_progress();
+}
- if (!write_log('errors', $log_entry)) {
- // send error to PHPs error handler if write_log didn't succeed
- trigger_error($arg_arr['message']);
- }
- }
+function rcube_upload_init()
+{
+ return rcube_ui::upload_init();
+}
- // resport the bug to the global bug reporting system
- if ($CONFIG['debug_level'] & 2) {
- // TODO: Send error via HTTP
- }
+function rcube_autocomplete_init()
+{
+ rcube_ui::autocomplete_init();
+}
- // show error if debug_mode is on
- if ($CONFIG['debug_level'] & 4) {
- print "<b>$program Error";
+function rcube_fontdefs($font = null)
+{
+ return rcube_ui::font_defs($font);
+}
- if (!empty($arg_arr['file']) && !empty($arg_arr['line']))
- print " in $arg_arr[file] ($arg_arr[line])";
+function send_nocacheing_headers()
+{
+ return rcmail::get_instance()->output->nocacheing_headers();
+}
- print ':</b> ';
- print nl2br($arg_arr['message']);
- print '<br />';
- flush();
- }
+function show_bytes($bytes)
+{
+ return rcube_ui::show_bytes($bytes);
+}
+
+function rc_wordwrap($string, $width=75, $break="\n", $cut=false)
+{
+ return rcube_mime::wordwrap($string, $width, $break, $cut);
+}
+
+function rc_request_header($name)
+{
+ return rcube_request_header($name);
+}
+
+function rc_mime_content_type($path, $name, $failover = 'application/octet-stream', $is_stream=false)
+{
+ return rcube_mime::file_content_type($path, $name, $failover, $is_stream);
+}
+
+function rc_image_content_type($data)
+{
+ return rcube_mime::image_content_type($data);
}
--
Gitblit v1.9.1