X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=program%2Finclude%2Frcube_template.php;h=5a09fca9200c882ab486ced150e55d87043dfc4f;hb=76507f7c63a660742e76889ad6e3919f3dde3bb0;hp=2173784b67f5f11e5962a2ee41c747202d4ffb3f;hpb=48e8459231a1efa3e97284d07a328776a5b7485b;p=roundcube.git diff --git a/program/include/rcube_template.php b/program/include/rcube_template.php index 2173784..5a09fca 100755 --- a/program/include/rcube_template.php +++ b/program/include/rcube_template.php @@ -4,8 +4,8 @@ +-----------------------------------------------------------------------+ | program/include/rcube_template.php | | | - | This file is part of the RoundCube Webmail client | - | Copyright (C) 2006-2008, RoundCube Dev. - Switzerland | + | This file is part of the Roundcube Webmail client | + | Copyright (C) 2006-2011, The Roundcube Dev Team | | Licensed under the GNU GPL | | | | PURPOSE: | @@ -16,7 +16,7 @@ | Author: Thomas Bruederli | +-----------------------------------------------------------------------+ - $Id$ + $Id: rcube_template.php 5481 2011-11-24 07:53:00Z alec $ */ @@ -30,22 +30,35 @@ */ class rcube_template extends rcube_html_page { - var $app; - var $config; - var $task = ''; - var $framed = false; - var $pagetitle = ''; - var $env = array(); - var $js_env = array(); - var $js_commands = array(); - var $object_handlers = array(); - + private $app; + private $config; + private $pagetitle = ''; + private $message = null; + private $js_env = array(); + private $js_labels = array(); + private $js_commands = array(); + private $object_handlers = array(); + private $plugin_skin_path; + private $template_name; + + public $browser; + public $framed = false; + public $env = array(); + public $type = 'html'; public $ajax_call = false; + // deprecated names of templates used before 0.5 + private $deprecated_templates = array( + 'contact' => 'showcontact', + 'contactadd' => 'addcontact', + 'contactedit' => 'editcontact', + 'identityedit' => 'editidentity', + 'messageprint' => 'printmessage', + ); + /** * Constructor * - * @todo Use jQuery's $(document).ready() here. * @todo Replace $this->config with the real rcube_config object */ public function __construct($task, $framed = false) @@ -54,25 +67,30 @@ class rcube_template extends rcube_html_page $this->app = rcmail::get_instance(); $this->config = $this->app->config->all(); - + $this->browser = new rcube_browser(); + //$this->framed = $framed; - $this->task = $task; + $this->set_env('task', $task); + $this->set_env('x_frame_options', $this->app->config->get('x_frame_options', 'sameorigin')); + + // load the correct skin (in case user-defined) + $this->set_skin($this->config['skin']); // add common javascripts - $javascript = 'var '.JS_OBJECT_NAME.' = new rcube_webmail();'; + $this->add_script('var '.JS_OBJECT_NAME.' = new rcube_webmail();', 'head_top'); // don't wait for page onload. Call init at the bottom of the page (delayed) - $javascript_foot = "if (window.call_init)\n call_init('".JS_OBJECT_NAME."');"; + $this->add_script(JS_OBJECT_NAME.'.init();', 'docready'); - $this->add_script($javascript, 'head_top'); - $this->add_script($javascript_foot, 'foot'); $this->scripts_path = 'program/js/'; + $this->include_script('jquery.min.js'); $this->include_script('common.js'); $this->include_script('app.js'); // register common UI objects $this->add_handlers(array( 'loginform' => array($this, 'login_form'), + 'preloader' => array($this, 'preloader'), 'username' => array($this, 'current_username'), 'message' => array($this, 'message_container'), 'charsetselector' => array($this, 'charset_selector'), @@ -94,7 +112,6 @@ class rcube_template extends rcube_html_page } } - /** * Set page title variable */ @@ -103,6 +120,59 @@ class rcube_template extends rcube_html_page $this->pagetitle = $title; } + /** + * Getter for the current page title + * + * @return string The page title + */ + public function get_pagetitle() + { + if (!empty($this->pagetitle)) { + $title = $this->pagetitle; + } + else if ($this->env['task'] == 'login') { + $title = rcube_label(array('name' => 'welcome', 'vars' => array('product' => $this->config['product_name']))); + } + else { + $title = ucfirst($this->env['task']); + } + + return $title; + } + + /** + * Set skin + */ + public function set_skin($skin) + { + $valid = false; + + if (!empty($skin) && is_dir('skins/'.$skin) && is_readable('skins/'.$skin)) { + $skin_path = 'skins/'.$skin; + $valid = true; + } + else { + $skin_path = $this->config['skin_path'] ? $this->config['skin_path'] : 'skins/default'; + $valid = !$skin; + } + + $this->app->config->set('skin_path', $skin_path); + $this->config['skin_path'] = $skin_path; + + return $valid; + } + + /** + * Check if a specific template exists + * + * @param string Template name + * @return boolean True if template exists + */ + public function template_exists($name) + { + $filename = $this->config['skin_path'] . '/templates/' . $name . '.html'; + return (is_file($filename) && is_readable($filename)) || ($this->deprecated_templates[$name] && $this->template_exists($this->deprecated_templates[$name])); + } /** * Register a template object handler @@ -147,38 +217,52 @@ class rcube_template extends rcube_html_page */ public function command() { - $this->js_commands[] = func_get_args(); + $cmd = func_get_args(); + if (strpos($cmd[0], 'plugin.') !== false) + $this->js_commands[] = array('triggerEvent', $cmd[0], $cmd[1]); + else + $this->js_commands[] = $cmd; } - /** * Add a localized label to the client environment */ public function add_label() { - $arg_list = func_get_args(); - foreach ($arg_list as $i => $name) { - $this->command('add_label', $name, rcube_label($name)); + $args = func_get_args(); + if (count($args) == 1 && is_array($args[0])) + $args = $args[0]; + + foreach ($args as $name) { + $this->js_labels[$name] = rcube_label($name); } } - /** * Invoke display_message command * - * @param string Message to display - * @param string Message type [notice|confirm|error] - * @param array Key-value pairs to be replaced in localized text + * @param string $message Message to display + * @param string $type Message type [notice|confirm|error] + * @param array $vars Key-value pairs to be replaced in localized text + * @param boolean $override Override last set message + * @param int $timeout Message display time in seconds * @uses self::command() */ - public function show_message($message, $type='notice', $vars=NULL) + public function show_message($message, $type='notice', $vars=null, $override=true, $timeout=0) { - $this->command( - 'display_message', - rcube_label(array('name' => $message, 'vars' => $vars)), - $type); - } + if ($override || !$this->message) { + if (rcube_label_exists($message)) { + if (!empty($vars)) + $vars = array_map('Q', $vars); + $msgtext = rcube_label(array('name' => $message, 'vars' => $vars)); + } + else + $msgtext = $message; + $this->message = $message; + $this->command('display_message', $msgtext, $type, $timeout * 1000); + } + } /** * Delete all stored env variables and commands @@ -190,15 +274,28 @@ class rcube_template extends rcube_html_page * @uses self::$js_commands * @uses self::$object_handlers */ - public public function reset() + public function reset() { $this->env = array(); $this->js_env = array(); + $this->js_labels = array(); $this->js_commands = array(); $this->object_handlers = array(); parent::reset(); } + /** + * Redirect to a certain url + * + * @param mixed Either a string with the action or url parameters as key-value pairs + * @see rcmail::url() + */ + public function redirect($p = array()) + { + $location = $this->app->url($p); + header('Location: ' . $location); + exit; + } /** * Send the request output to the client. @@ -210,6 +307,13 @@ class rcube_template extends rcube_html_page public function send($templ = null, $exit = true) { if ($templ != 'iframe') { + // prevent from endless loops + if ($exit != 'recur' && $this->app->plugins->is_processing('render_page')) { + raise_error(array('code' => 505, 'type' => 'php', + 'file' => __FILE__, 'line' => __LINE__, + 'message' => 'Recursion alert: ignoring output->send()'), true, false); + return; + } $this->parse($templ, false); } else { @@ -217,6 +321,10 @@ class rcube_template extends rcube_html_page $this->write(); } + // set output asap + ob_flush(); + flush(); + if ($exit) { exit; } @@ -232,73 +340,130 @@ class rcube_template extends rcube_html_page public function write($template = '') { // unlock interface after iframe load + $unlock = preg_replace('/[^a-z0-9]/i', '', $_REQUEST['_unlock']); if ($this->framed) { - array_unshift($this->js_commands, array('set_busy', false)); + array_unshift($this->js_commands, array('set_busy', false, null, $unlock)); + } + else if ($unlock) { + array_unshift($this->js_commands, array('hide_message', $unlock)); } + + if (!empty($this->script_files)) + $this->set_env('request_token', $this->app->get_request_token()); + // write all env variables to client $js = $this->framed ? "if(window.parent) {\n" : ''; $js .= $this->get_js_commands() . ($this->framed ? ' }' : ''); $this->add_script($js, 'head_top'); + // send clickjacking protection headers + $iframe = $this->framed || !empty($_REQUEST['_framed']); + if (!headers_sent() && ($xframe = $this->app->config->get('x_frame_options', 'sameorigin'))) + header('X-Frame-Options: ' . ($iframe && $xframe == 'deny' ? 'sameorigin' : $xframe)); + // call super method parent::write($template, $this->config['skin_path']); } /** - * Parse a specific skin template and deliver to stdout - * - * Either returns nothing, or exists hard (exit();) + * Parse a specific skin template and deliver to stdout (or return) * * @param string Template name * @param boolean Exit script - * @return void + * @param boolean Don't write to stdout, return parsed content instead + * * @link http://php.net/manual/en/function.exit.php */ - private function parse($name = 'main', $exit = true) + function parse($name = 'main', $exit = true, $write = true) { $skin_path = $this->config['skin_path']; + $plugin = false; + $realname = $name; + $temp = explode('.', $name, 2); + + $this->plugin_skin_path = null; + $this->template_name = $realname; + + if (count($temp) > 1) { + $plugin = $temp[0]; + $name = $temp[1]; + $skin_dir = $plugin . '/skins/' . $this->config['skin']; + $skin_path = $this->plugin_skin_path = $this->app->plugins->dir . $skin_dir; + + // fallback to default skin + if (!is_dir($skin_path)) { + $skin_dir = $plugin . '/skins/default'; + $skin_path = $this->plugin_skin_path = $this->app->plugins->dir . $skin_dir; + } + } - // read template file - $templ = ''; $path = "$skin_path/templates/$name.html"; - if (($fp = fopen($path, 'r')) === false) { - $message = ''; - ob_start(); - fopen($path, 'r'); - $message.= ob_get_contents(); - ob_end_clean(); + if (!is_readable($path) && $this->deprecated_templates[$realname]) { + $path = "$skin_path/templates/".$this->deprecated_templates[$realname].".html"; + if (is_readable($path)) + raise_error(array('code' => 502, 'type' => 'php', + 'file' => __FILE__, 'line' => __LINE__, + 'message' => "Using deprecated template '".$this->deprecated_templates[$realname] + ."' in ".$this->config['skin_path']."/templates. Please rename to '".$realname."'"), + true, false); + } + + // read template file + if (($templ = @file_get_contents($path)) === false) { raise_error(array( 'code' => 501, 'type' => 'php', 'line' => __LINE__, 'file' => __FILE__, - 'message' => 'Error loading template for '.$name.': '.$message + 'message' => 'Error loading template for '.$realname ), true, true); return false; } - $templ = fread($fp, filesize($path)); - fclose($fp); + + // replace all path references to plugins/... with the configured plugins dir + // and /this/ to the current plugin skin directory + if ($plugin) { + $templ = preg_replace(array('/\bplugins\//', '/(["\']?)\/this\//'), array($this->app->plugins->url, '\\1'.$this->app->plugins->url.$skin_dir.'/'), $templ); + } // parse for specialtags $output = $this->parse_conditions($templ); $output = $this->parse_xml($output); - // add debug console - if ($this->config['debug_level'] & 8) { - $this->add_footer('
- console -
' - ); + // trigger generic hook where plugins can put additional content to the page + $hook = $this->app->plugins->exec_hook("render_page", array('template' => $realname, 'content' => $output)); + + $output = $this->parse_with_globals($hook['content']); + + // make sure all
tags have a valid request token + $output = preg_replace_callback('/]+)>/Ui', array($this, 'alter_form_tag'), $output); + $this->footer = preg_replace_callback('/]+)>/Ui', array($this, 'alter_form_tag'), $this->footer); + + if ($write) { + // add debug console + if ($realname != 'error' && ($this->config['debug_level'] & 8)) { + $this->add_footer('' + ); + $this->add_script( + "if (!window.console || !window.console.log) {\n". + " window.console = new rcube_console();\n". + " $('#console').show();\n". + "}", 'foot'); + } + $this->write(trim($output)); + } + else { + return $output; } - $output = $this->parse_with_globals($output); - $this->write(trim($output), $skin_path); + if ($exit) { exit; } } - /** * Return executable javascript code for all registered commands * @@ -310,6 +475,9 @@ class rcube_template extends rcube_html_page if (!$this->framed && !empty($this->js_env)) { $out .= JS_OBJECT_NAME . '.set_env('.json_serialize($this->js_env).");\n"; } + if (!empty($this->js_labels)) { + $this->command('add_label', $this->js_labels); + } foreach ($this->js_commands as $i => $args) { $method = array_shift($args); foreach ($args as $i => $arg) { @@ -318,18 +486,12 @@ class rcube_template extends rcube_html_page $parent = $this->framed || preg_match('/^parent\./', $method); $out .= sprintf( "%s.%s(%s);\n", - ($parent ? 'parent.' : '') . JS_OBJECT_NAME, - preg_replace('/^parent\./', '', $method), - implode(',', $args) - ); - } - // add command to set page title - if ($this->ajax_call && !empty($this->pagetitle)) { - $out .= sprintf( - "this.set_pagetitle('%s');\n", - JQ((!empty($this->config['product_name']) ? $this->config['product_name'].' :: ' : '') . $this->pagetitle) + ($parent ? 'if(window.parent && parent.'.JS_OBJECT_NAME.') parent.' : '') . JS_OBJECT_NAME, + preg_replace('/^parent\./', '', $method), + implode(',', $args) ); } + return $out; } @@ -341,7 +503,10 @@ class rcube_template extends rcube_html_page */ public function abs_url($str) { - return preg_replace('/^\//', $this->config['skin_path'].'/', $str); + if ($str[0] == '/') + return $this->config['skin_path'] . $str; + else + return $str; } @@ -353,8 +518,18 @@ class rcube_template extends rcube_html_page */ private function parse_with_globals($input) { + $GLOBALS['__version'] = Q(RCMAIL_VERSION); $GLOBALS['__comm_path'] = Q($this->app->comm_path); - return preg_replace('/\$(__[a-z0-9_\-]+)/e', '$GLOBALS["\\1"]', $input); + return preg_replace_callback('/\$(__[a-z0-9_\-]+)/', + array($this, 'globals_callback'), $input); + } + + /** + * Callback funtion for preg_replace_callback() in parse_with_globals() + */ + private function globals_callback($matches) + { + return $GLOBALS[$matches[1]]; } /** @@ -378,7 +553,7 @@ class rcube_template extends rcube_html_page */ private function parse_conditions($input) { - $matches = preg_split('/]+)>/is', $input, 2, PREG_SPLIT_DELIM_CAPTURE); + $matches = preg_split('/]+)>\n?/is', $input, 2, PREG_SPLIT_DELIM_CAPTURE); if ($matches && count($matches) == 4) { if (preg_match('/^(else|endif)$/i', $matches[1])) { return $matches[0] . $this->parse_conditions($matches[3]); @@ -386,10 +561,10 @@ class rcube_template extends rcube_html_page $attrib = parse_attrib_string($matches[2]); if (isset($attrib['condition'])) { $condmet = $this->check_condition($attrib['condition']); - $submatches = preg_split('/]+)>/is', $matches[3], 2, PREG_SPLIT_DELIM_CAPTURE); + $submatches = preg_split('/]+)>\n?/is', $matches[3], 2, PREG_SPLIT_DELIM_CAPTURE); if ($condmet) { $result = $submatches[0]; - $result.= ($submatches[1] != 'endif' ? preg_replace('/.*]+>/Uis', '', $submatches[3], 1) : $submatches[3]); + $result.= ($submatches[1] != 'endif' ? preg_replace('/.*]+>\n?/Uis', '', $submatches[3], 1) : $submatches[3]); } else { $result = "" . $submatches[3]; @@ -414,26 +589,59 @@ class rcube_template extends rcube_html_page * @todo Get rid off eval() once I understand what this does. * @todo Extend this to allow real conditions, not just "set" * @param string Condition statement - * @return boolean True if condition is met, False is not + * @return boolean True if condition is met, False if not */ private function check_condition($condition) { - $condition = preg_replace( + return eval("return (".$this->parse_expression($condition).");"); + } + + + /** + * Inserts hidden field with CSRF-prevention-token into POST forms + */ + private function alter_form_tag($matches) + { + $out = $matches[0]; + $attrib = parse_attrib_string($matches[1]); + + if (strtolower($attrib['method']) == 'post') { + $hidden = new html_hiddenfield(array('name' => '_token', 'value' => $this->app->get_request_token())); + $out .= "\n" . $hidden->show(); + } + + return $out; + } + + + /** + * Parses expression and replaces variables + * + * @param string Expression statement + * @return string Expression value + */ + private function parse_expression($expression) + { + return preg_replace( array( '/session:([a-z0-9_]+)/i', - '/config:([a-z0-9_]+)/i', + '/config:([a-z0-9_]+)(:([a-z0-9_]+))?/i', '/env:([a-z0-9_]+)/i', - '/request:([a-z0-9_]+)/ie' + '/request:([a-z0-9_]+)/i', + '/cookie:([a-z0-9_]+)/i', + '/browser:([a-z0-9_]+)/i', + '/template:name/i', ), array( "\$_SESSION['\\1']", - "\$this->config['\\1']", + "\$this->app->config->get('\\1',get_boolean('\\3'))", "\$this->env['\\1']", - "get_input_value('\\1', RCUVE_INPUT_GPC)" + "get_input_value('\\1', RCUBE_INPUT_GPC)", + "\$_COOKIE['\\1']", + "\$this->browser->{'\\1'}", + $this->template_name, ), - $condition); - - return eval("return (".$condition.");"); + $expression); } @@ -443,25 +651,26 @@ class rcube_template extends rcube_html_page * * @param string Input string to parse * @return string Altered input string + * @todo Use DOM-parser to traverse template HTML * @todo Maybe a cache. */ private function parse_xml($input) { - return preg_replace('/]+)>/Uie', "\$this->xml_command('\\1', '\\2')", $input); + return preg_replace_callback('/]+)>/Ui', array($this, 'xml_command'), $input); } /** - * Convert a xml command tag into real content + * Callback function for parsing an xml command tag + * and turn it into real html content * - * @param string Tag command: object,button,label, etc. - * @param string Attribute string + * @param array Matches array of preg_replace_callback * @return string Tag/Object content */ - private function xml_command($command, $str_attrib, $add_attrib = array()) + private function xml_command($matches) { - $command = strtolower($command); - $attrib = parse_attrib_string($str_attrib) + $add_attrib; + $command = strtolower($matches[1]); + $attrib = parse_attrib_string($matches[2]); // empty output if required condition is not met if (!empty($attrib['condition']) && !$this->check_condition($attrib['condition'])) { @@ -480,85 +689,101 @@ class rcube_template extends rcube_html_page // show a label case 'label': if ($attrib['name'] || $attrib['command']) { - return Q(rcube_label($attrib + array('vars' => array('product' => $this->config['product_name'])))); + $vars = $attrib + array('product' => $this->config['product_name']); + unset($vars['name'], $vars['command']); + $label = rcube_label($attrib + array('vars' => $vars)); + return !$attrib['noshow'] ? (get_boolean((string)$attrib['html']) ? $label : Q($label)) : ''; } break; // include a file case 'include': - $path = realpath($this->config['skin_path'].$attrib['file']); - if ($fsize = filesize($path)) { + if (!$this->plugin_skin_path || !is_file($path = realpath($this->plugin_skin_path . $attrib['file']))) + $path = realpath(($attrib['skin_path'] ? $attrib['skin_path'] : $this->config['skin_path']).$attrib['file']); + + if (is_readable($path)) { if ($this->config['skin_include_php']) { $incl = $this->include_php($path); } - else if ($fp = fopen($path, 'r')) { - $incl = fread($fp, $fsize); - fclose($fp); + else { + $incl = file_get_contents($path); } + $incl = $this->parse_conditions($incl); return $this->parse_xml($incl); } break; case 'plugin.include': - //rcube::tfk_debug(var_export($this->config['skin_path'], true)); - $path = realpath($this->config['skin_path'].$attrib['file']); - if (!$path) { - //rcube::tfk_debug("Does not exist:"); - //rcube::tfk_debug($this->config['skin_path']); - //rcube::tfk_debug($attrib['file']); - //rcube::tfk_debug($path); - } - $incl = file_get_contents($path); - if ($incl) { - return $this->parse_xml($incl); + $hook = $this->app->plugins->exec_hook("template_plugin_include", $attrib); + return $hook['content']; + break; + + // define a container block + case 'container': + if ($attrib['name'] && $attrib['id']) { + $this->command('gui_container', $attrib['name'], $attrib['id']); + // let plugins insert some content here + $hook = $this->app->plugins->exec_hook("template_container", $attrib); + return $hook['content']; } break; // return code for a specific application object case 'object': $object = strtolower($attrib['name']); + $content = ''; // we are calling a class/method if (($handler = $this->object_handlers[$object]) && is_array($handler)) { if ((is_object($handler[0]) && method_exists($handler[0], $handler[1])) || (is_string($handler[0]) && class_exists($handler[0]))) - return call_user_func($handler, $attrib); + $content = call_user_func($handler, $attrib); } + // execute object handler function else if (function_exists($handler)) { - // execute object handler function - return call_user_func($handler, $attrib); + $content = call_user_func($handler, $attrib); } - - if ($object=='productname') { - $name = !empty($this->config['product_name']) ? $this->config['product_name'] : 'RoundCube Webmail'; - return Q($name); + else if ($object == 'logo') { + $attrib += array('alt' => $this->xml_command(array('', 'object', 'name="productname"'))); + if ($this->config['skin_logo']) + $attrib['src'] = $this->config['skin_logo']; + $content = html::img($attrib); } - if ($object=='version') { + else if ($object == 'productname') { + $name = !empty($this->config['product_name']) ? $this->config['product_name'] : 'Roundcube Webmail'; + $content = Q($name); + } + else if ($object == 'version') { $ver = (string)RCMAIL_VERSION; if (is_file(INSTALL_PATH . '.svn/entries')) { if (preg_match('/Revision:\s(\d+)/', @shell_exec('svn info'), $regs)) $ver .= ' [SVN r'.$regs[1].']'; } - return $ver; + $content = Q($ver); + } + else if ($object == 'steptitle') { + $content = Q($this->get_pagetitle()); + } + else if ($object == 'pagetitle') { + if (!empty($this->config['devel_mode']) && !empty($_SESSION['username'])) + $title = $_SESSION['username'].' :: '; + else if (!empty($this->config['product_name'])) + $title = $this->config['product_name'].' :: '; + else + $title = ''; + $title .= $this->get_pagetitle(); + $content = Q($title); } - if ($object=='pagetitle') { - $task = $this->task; - $title = !empty($this->config['product_name']) ? $this->config['product_name'].' :: ' : ''; - if (!empty($this->pagetitle)) { - $title .= $this->pagetitle; - } - else if ($task == 'login') { - $title = rcube_label(array('name' => 'welcome', 'vars' => array('product' => $this->config['product_name']))); - } - else { - $title .= ucfirst($task); - } + // exec plugin hooks for this template object + $hook = $this->app->plugins->exec_hook("template_object_$object", $attrib + array('content' => $content)); + return $hook['content']; + + // return code for a specified eval expression + case 'exp': + $value = $this->parse_expression($attrib['expression']); + return eval("return Q($value);"); - return Q($title); - } - break; - // return variable case 'var': $var = explode(':', $attrib['name']); @@ -581,6 +806,12 @@ class rcube_template extends rcube_html_page case 'session': $value = $_SESSION[$name]; break; + case 'cookie': + $value = htmlspecialchars($_COOKIE[$name]); + break; + case 'browser': + $value = $this->browser->{$name}; + break; } if (is_array($value)) { @@ -617,20 +848,17 @@ class rcube_template extends rcube_html_page * @todo Remove all inline JS calls and use jQuery instead. * @todo Remove all sprintf()'s - they are pretty, but also slow. */ - private function button($attrib) + public function button($attrib) { - static $sa_buttons = array(); static $s_button_count = 100; // these commands can be called directly via url - $a_static_commands = array('compose', 'list'); + $a_static_commands = array('compose', 'list', 'preferences', 'folders', 'identities'); if (!($attrib['command'] || $attrib['name'])) { return ''; } - $browser = new rcube_browser(); - // try to find out the button type if ($attrib['type']) { $attrib['type'] = strtolower($attrib['type']); @@ -638,48 +866,33 @@ class rcube_template extends rcube_html_page else { $attrib['type'] = ($attrib['image'] || $attrib['imagepas'] || $attrib['imageact']) ? 'image' : 'link'; } + $command = $attrib['command']; - // take the button from the stack - if ($attrib['name'] && $sa_buttons[$attrib['name']]) { - $attrib = $sa_buttons[$attrib['name']]; - } - else if($attrib['image'] || $attrib['imageact'] || $attrib['imagepas'] || $attrib['class']) { - // add button to button stack - if (!$attrib['name']) { - $attrib['name'] = $command; - } - if (!$attrib['image']) { - $attrib['image'] = $attrib['imagepas'] ? $attrib['imagepas'] : $attrib['imageact']; - } - $sa_buttons[$attrib['name']] = $attrib; - } - else if ($command && $sa_buttons[$command]) { - // get saved button for this command/name - $attrib = $sa_buttons[$command]; - } + if ($attrib['task']) + $command = $attrib['task'] . '.' . $command; - // set border to 0 because of the link arround the button - if ($attrib['type']=='image' && !isset($attrib['border'])) { - $attrib['border'] = 0; + if (!$attrib['image']) { + $attrib['image'] = $attrib['imagepas'] ? $attrib['imagepas'] : $attrib['imageact']; } + if (!$attrib['id']) { $attrib['id'] = sprintf('rcmbtn%d', $s_button_count++); } // get localized text for labels and titles if ($attrib['title']) { - $attrib['title'] = Q(rcube_label($attrib['title'])); + $attrib['title'] = Q(rcube_label($attrib['title'], $attrib['domain'])); } if ($attrib['label']) { - $attrib['label'] = Q(rcube_label($attrib['label'])); + $attrib['label'] = Q(rcube_label($attrib['label'], $attrib['domain'])); } if ($attrib['alt']) { - $attrib['alt'] = Q(rcube_label($attrib['alt'])); + $attrib['alt'] = Q(rcube_label($attrib['alt'], $attrib['domain'])); } + // set title to alt attribute for IE browsers - if ($browser->ie && $attrib['title'] && !$attrib['alt']) { - $attrib['alt'] = $attrib['title']; - unset($attrib['title']); + if ($this->browser->ie && !$attrib['title'] && $attrib['alt']) { + $attrib['title'] = $attrib['alt']; } // add empty alt attribute for XHTML compatibility @@ -702,10 +915,17 @@ class rcube_template extends rcube_html_page // make valid href to specific buttons if (in_array($attrib['command'], rcmail::$main_tasks)) { - $attrib['href'] = Q(rcmail_url(null, null, $attrib['command'])); + $attrib['href'] = rcmail_url(null, null, $attrib['command']); + $attrib['onclick'] = sprintf("%s.switch_task('%s');return false", JS_OBJECT_NAME, $attrib['command']); + } + else if ($attrib['task'] && in_array($attrib['task'], rcmail::$main_tasks)) { + $attrib['href'] = rcmail_url($attrib['command'], null, $attrib['task']); } else if (in_array($attrib['command'], $a_static_commands)) { - $attrib['href'] = Q(rcmail_url($attrib['command'])); + $attrib['href'] = rcmail_url($attrib['command']); + } + else if ($attrib['command'] == 'permaurl' && !empty($this->env['permaurl'])) { + $attrib['href'] = $this->env['permaurl']; } } @@ -713,7 +933,11 @@ class rcube_template extends rcube_html_page if (!$attrib['href']) { $attrib['href'] = '#'; } - if ($command) { + if ($attrib['task']) { + if ($attrib['classact']) + $attrib['class'] = $attrib['classact']; + } + else if ($command && !$attrib['onclick']) { $attrib['onclick'] = sprintf( "return %s.command('%s','%s',this)", JS_OBJECT_NAME, @@ -721,35 +945,6 @@ class rcube_template extends rcube_html_page $attrib['prop'] ); } - if ($command && $attrib['imageover']) { - $attrib['onmouseover'] = sprintf( - "return %s.button_over('%s','%s')", - JS_OBJECT_NAME, - $command, - $attrib['id'] - ); - $attrib['onmouseout'] = sprintf( - "return %s.button_out('%s','%s')", - JS_OBJECT_NAME, - $command, - $attrib['id'] - ); - } - - if ($command && $attrib['imagesel']) { - $attrib['onmousedown'] = sprintf( - "return %s.button_sel('%s','%s')", - JS_OBJECT_NAME, - $command, - $attrib['id'] - ); - $attrib['onmouseup'] = sprintf( - "return %s.button_out('%s','%s')", - JS_OBJECT_NAME, - $command, - $attrib['id'] - ); - } $out = ''; @@ -758,20 +953,19 @@ class rcube_template extends rcube_html_page $attrib_str = html::attrib_string( $attrib, array( - 'style', 'class', 'id', 'width', - 'height', 'border', 'hspace', - 'vspace', 'align', 'alt', + 'style', 'class', 'id', 'width', 'height', 'border', 'hspace', + 'vspace', 'align', 'alt', 'tabindex', 'title' ) ); $btn_content = sprintf('', $this->abs_url($attrib['image']), $attrib_str); if ($attrib['label']) { $btn_content .= ' '.$attrib['label']; } - $link_attrib = array('href', 'onclick', 'onmouseover', 'onmouseout', 'onmousedown', 'onmouseup', 'title'); + $link_attrib = array('href', 'onclick', 'onmouseover', 'onmouseout', 'onmousedown', 'onmouseup', 'target'); } else if ($attrib['type']=='link') { - $btn_content = $attrib['label'] ? $attrib['label'] : $attrib['command']; - $link_attrib = array('href', 'onclick', 'title', 'id', 'class', 'style'); + $btn_content = isset($attrib['content']) ? $attrib['content'] : ($attrib['label'] ? $attrib['label'] : $attrib['command']); + $link_attrib = array('href', 'onclick', 'title', 'id', 'class', 'style', 'tabindex', 'target'); } else if ($attrib['type']=='input') { $attrib['type'] = 'button'; @@ -783,8 +977,7 @@ class rcube_template extends rcube_html_page $attrib_str = html::attrib_string( $attrib, array( - 'type', 'value', 'onclick', - 'id', 'class', 'style' + 'type', 'value', 'onclick', 'id', 'class', 'style', 'tabindex' ) ); $out = sprintf('', $attrib_str); @@ -811,17 +1004,49 @@ class rcube_template extends rcube_html_page */ public function form_tag($attrib, $content = null) { - if ($this->framed) { + if ($this->framed || !empty($_REQUEST['_framed'])) { $hiddenfield = new html_hiddenfield(array('name' => '_framed', 'value' => '1')); $hidden = $hiddenfield->show(); } - + if (!$content) $attrib['noclose'] = true; - + return html::tag('form', $attrib + array('action' => "./", 'method' => "get"), - $hidden . $content); + $hidden . $content, + array('id','class','style','name','method','action','enctype','onsubmit')); + } + + + /** + * Build a form tag with a unique request token + * + * @param array Named tag parameters including 'action' and 'task' values which will be put into hidden fields + * @param string Form content + * @return string HTML code for the form + */ + public function request_form($attrib, $content = '') + { + $hidden = new html_hiddenfield(); + if ($attrib['task']) { + $hidden->add(array('name' => '_task', 'value' => $attrib['task'])); + } + if ($attrib['action']) { + $hidden->add(array('name' => '_action', 'value' => $attrib['action'])); + } + + unset($attrib['task'], $attrib['request']); + $attrib['action'] = './'; + + // we already have a tag + if ($attrib['form']) { + if ($this->framed || !empty($_REQUEST['_framed'])) + $hidden->add(array('name' => '_framed', 'value' => '1')); + return $hidden->show() . $content; + } + else + return $this->form_tag($attrib, $hidden->show() . $content); } @@ -841,15 +1066,19 @@ class rcube_template extends rcube_html_page return $username; } - // get e-mail address form default identity - if ($sql_arr = $this->app->user->get_identity()) { + // Current username is an e-mail address + if (strpos($_SESSION['username'], '@')) { + $username = $_SESSION['username']; + } + // get e-mail address from default identity + else if ($sql_arr = $this->app->user->get_identity()) { $username = $sql_arr['email']; } else { $username = $this->app->user->get_username(); } - return $username; + return rcube_idn_to_utf8($username); } @@ -863,15 +1092,32 @@ class rcube_template extends rcube_html_page private function login_form($attrib) { $default_host = $this->config['default_host']; + $autocomplete = (int) $this->config['login_autocomplete']; $_SESSION['temp'] = true; - $input_user = new html_inputfield(array('name' => '_user', 'id' => 'rcmloginuser', 'size' => 30, 'autocomplete' => 'off')); - $input_pass = new html_passwordfield(array('name' => '_pass', 'id' => 'rcmloginpwd', 'size' => 30)); + // save original url + $url = get_input_value('_url', RCUBE_INPUT_POST); + if (empty($url) && !preg_match('/_(task|action)=logout/', $_SERVER['QUERY_STRING'])) + $url = $_SERVER['QUERY_STRING']; + + // set atocomplete attribute + $user_attrib = $autocomplete > 0 ? array() : array('autocomplete' => 'off'); + $host_attrib = $autocomplete > 0 ? array() : array('autocomplete' => 'off'); + $pass_attrib = $autocomplete > 1 ? array() : array('autocomplete' => 'off'); + + $input_task = new html_hiddenfield(array('name' => '_task', 'value' => 'login')); $input_action = new html_hiddenfield(array('name' => '_action', 'value' => 'login')); + $input_tzone = new html_hiddenfield(array('name' => '_timezone', 'id' => 'rcmlogintz', 'value' => '_default_')); + $input_dst = new html_hiddenfield(array('name' => '_dstactive', 'id' => 'rcmlogindst', 'value' => '_default_')); + $input_url = new html_hiddenfield(array('name' => '_url', 'id' => 'rcmloginurl', 'value' => $url)); + $input_user = new html_inputfield(array('name' => '_user', 'id' => 'rcmloginuser') + + $attrib + $user_attrib); + $input_pass = new html_passwordfield(array('name' => '_pass', 'id' => 'rcmloginpwd') + + $attrib + $pass_attrib); $input_host = null; - if (is_array($default_host)) { + if (is_array($default_host) && count($default_host) > 1) { $input_host = new html_select(array('name' => '_host', 'id' => 'rcmloginhost')); foreach ($default_host as $key => $value) { @@ -884,8 +1130,14 @@ class rcube_template extends rcube_html_page } } } - else if (!strlen($default_host)) { - $input_host = new html_inputfield(array('name' => '_host', 'id' => 'rcmloginhost', 'size' => 30)); + else if (is_array($default_host) && ($host = array_pop($default_host))) { + $hide_host = true; + $input_host = new html_hiddenfield(array( + 'name' => '_host', 'id' => 'rcmloginhost', 'value' => $host) + $attrib); + } + else if (empty($default_host)) { + $input_host = new html_inputfield(array('name' => '_host', 'id' => 'rcmloginhost') + + $attrib + $host_attrib); } $form_name = !empty($attrib['form']) ? $attrib['form'] : 'form'; @@ -895,29 +1147,60 @@ class rcube_template extends rcube_html_page $table = new html_table(array('cols' => 2)); $table->add('title', html::label('rcmloginuser', Q(rcube_label('username')))); - $table->add(null, $input_user->show(get_input_value('_user', RCUVE_INPUT_POST))); + $table->add('input', $input_user->show(get_input_value('_user', RCUBE_INPUT_GPC))); $table->add('title', html::label('rcmloginpwd', Q(rcube_label('password')))); - $table->add(null, $input_pass->show()); + $table->add('input', $input_pass->show()); // add host selection row - if (is_object($input_host)) { + if (is_object($input_host) && !$hide_host) { $table->add('title', html::label('rcmloginhost', Q(rcube_label('server')))); - $table->add(null, $input_host->show(get_input_value('_host', RCUVE_INPUT_POST))); + $table->add('input', $input_host->show(get_input_value('_host', RCUBE_INPUT_GPC))); } - $out = $input_action->show(); + $out = $input_task->show(); + $out .= $input_action->show(); + $out .= $input_tzone->show(); + $out .= $input_dst->show(); + $out .= $input_url->show(); $out .= $table->show(); + if ($hide_host) { + $out .= $input_host->show(); + } + // surround html output with a form tag if (empty($attrib['form'])) { - $out = $this->form_tag(array('name' => $form_name, 'method' => "post"), $out); + $out = $this->form_tag(array('name' => $form_name, 'method' => 'post'), $out); } return $out; } + /** + * GUI object 'preloader' + * Loads javascript code for images preloading + * + * @param array Named parameters + * @return void + */ + private function preloader($attrib) + { + $images = preg_split('/[\s\t\n,]+/', $attrib['images'], -1, PREG_SPLIT_NO_EMPTY); + $images = array_map(array($this, 'abs_url'), $images); + + if (empty($images) || $this->app->task == 'logout') + return; + + $this->add_script('var images = ' . json_serialize($images) .'; + for (var i=0; ibrowser->khtml) { + unset($attrib['type'], $attrib['results']); + } + $input_q = new html_inputfield($attrib); $out = $input_q->show(); @@ -946,7 +1233,7 @@ class rcube_template extends rcube_html_page 'name' => "rcmqsearchform", 'onsubmit' => JS_OBJECT_NAME . ".command('search');return false;", 'style' => "display:inline"), - $out); + $out); } return $out; @@ -976,39 +1263,67 @@ class rcube_template extends rcube_html_page * @param array Named parameters for the select tag * @return string HTML code for the gui object */ - static function charset_selector($attrib) + function charset_selector($attrib) { // 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'))) { + if (in_array($attr, array('id', 'name', '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 html_select($field_attrib); - $select->add(array_values($charsets), array_keys($charsets)); - - $set = $_POST['_charset'] ? $_POST['_charset'] : $this->get_charset(); - return $select->show($set); + $charsets = array( + 'UTF-8' => 'UTF-8 ('.rcube_label('unicode').')', + 'US-ASCII' => 'ASCII ('.rcube_label('english').')', + 'ISO-8859-1' => 'ISO-8859-1 ('.rcube_label('westerneuropean').')', + 'ISO-8859-2' => 'ISO-8859-2 ('.rcube_label('easterneuropean').')', + 'ISO-8859-4' => 'ISO-8859-4 ('.rcube_label('baltic').')', + 'ISO-8859-5' => 'ISO-8859-5 ('.rcube_label('cyrillic').')', + 'ISO-8859-6' => 'ISO-8859-6 ('.rcube_label('arabic').')', + 'ISO-8859-7' => 'ISO-8859-7 ('.rcube_label('greek').')', + 'ISO-8859-8' => 'ISO-8859-8 ('.rcube_label('hebrew').')', + 'ISO-8859-9' => 'ISO-8859-9 ('.rcube_label('turkish').')', + 'ISO-8859-10' => 'ISO-8859-10 ('.rcube_label('nordic').')', + 'ISO-8859-11' => 'ISO-8859-11 ('.rcube_label('thai').')', + 'ISO-8859-13' => 'ISO-8859-13 ('.rcube_label('baltic').')', + 'ISO-8859-14' => 'ISO-8859-14 ('.rcube_label('celtic').')', + 'ISO-8859-15' => 'ISO-8859-15 ('.rcube_label('westerneuropean').')', + 'ISO-8859-16' => 'ISO-8859-16 ('.rcube_label('southeasterneuropean').')', + 'WINDOWS-1250' => 'Windows-1250 ('.rcube_label('easterneuropean').')', + 'WINDOWS-1251' => 'Windows-1251 ('.rcube_label('cyrillic').')', + 'WINDOWS-1252' => 'Windows-1252 ('.rcube_label('westerneuropean').')', + 'WINDOWS-1253' => 'Windows-1253 ('.rcube_label('greek').')', + 'WINDOWS-1254' => 'Windows-1254 ('.rcube_label('turkish').')', + 'WINDOWS-1255' => 'Windows-1255 ('.rcube_label('hebrew').')', + 'WINDOWS-1256' => 'Windows-1256 ('.rcube_label('arabic').')', + 'WINDOWS-1257' => 'Windows-1257 ('.rcube_label('baltic').')', + 'WINDOWS-1258' => 'Windows-1258 ('.rcube_label('vietnamese').')', + 'ISO-2022-JP' => 'ISO-2022-JP ('.rcube_label('japanese').')', + 'ISO-2022-KR' => 'ISO-2022-KR ('.rcube_label('korean').')', + 'ISO-2022-CN' => 'ISO-2022-CN ('.rcube_label('chinese').')', + 'EUC-JP' => 'EUC-JP ('.rcube_label('japanese').')', + 'EUC-KR' => 'EUC-KR ('.rcube_label('korean').')', + 'EUC-CN' => 'EUC-CN ('.rcube_label('chinese').')', + 'BIG5' => 'BIG5 ('.rcube_label('chinese').')', + 'GB2312' => 'GB2312 ('.rcube_label('chinese').')', + ); + + if (!empty($_POST['_charset'])) + $set = $_POST['_charset']; + else if (!empty($attrib['selected'])) + $set = $attrib['selected']; + else + $set = $this->get_charset(); + + $set = strtoupper($set); + if (!isset($charsets[$set])) + $charsets[$set] = $set; + + $select = new html_select($field_attrib); + $select->add(array_values($charsets), array_keys($charsets)); + + return $select->show($set); } } // end class rcube_template