From 7fe3811c65a7c63154f03610e289a6d196f3ae2e Mon Sep 17 00:00:00 2001 From: thomascube <thomas@roundcube.net> Date: Wed, 18 Jan 2012 06:10:46 -0500 Subject: [PATCH] Changed license to GNU GPLv3+ with exceptions for skins and plugins --- program/include/rcube_template.php | 312 +++++++++++++++++++++++++++++++++++---------------- 1 files changed, 213 insertions(+), 99 deletions(-) diff --git a/program/include/rcube_template.php b/program/include/rcube_template.php old mode 100755 new mode 100644 index e9b2b21..81dbb3d --- a/program/include/rcube_template.php +++ b/program/include/rcube_template.php @@ -5,8 +5,11 @@ | program/include/rcube_template.php | | | | This file is part of the Roundcube Webmail client | - | Copyright (C) 2006-2010, Roundcube Dev. - Switzerland | - | Licensed under the GNU GPL | + | Copyright (C) 2006-2011, 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: | | Class to handle HTML page output using a skin template. | @@ -30,24 +33,35 @@ */ class rcube_template extends rcube_html_page { - var $app; - var $config; - var $framed = false; - var $pagetitle = ''; - var $message = null; - 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) @@ -60,21 +74,19 @@ //$this->framed = $framed; $this->set_env('task', $task); - $this->set_env('request_token', $this->app->get_request_token()); + $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 = '$(document).ready(function(){ '.JS_OBJECT_NAME.'.init(); });'; + $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-1.4.min.js'); + $this->include_script('jquery.min.js'); $this->include_script('common.js'); $this->include_script('app.js'); @@ -85,6 +97,7 @@ 'username' => array($this, 'current_username'), 'message' => array($this, 'message_container'), 'charsetselector' => array($this, 'charset_selector'), + 'aboutcontent' => array($this, 'about_content'), )); } @@ -103,7 +116,6 @@ } } - /** * Set page title variable */ @@ -111,7 +123,6 @@ { $this->pagetitle = $title; } - /** * Getter for the current page title @@ -132,7 +143,6 @@ return $title; } - /** * Set skin @@ -165,8 +175,7 @@ public function template_exists($name) { $filename = $this->config['skin_path'] . '/templates/' . $name . '.html'; - - return (is_file($filename) && is_readable($filename)); + return (is_file($filename) && is_readable($filename)) || ($this->deprecated_templates[$name] && $this->template_exists($this->deprecated_templates[$name])); } /** @@ -213,10 +222,11 @@ public function command() { $cmd = func_get_args(); - if (strpos($cmd[0], 'plugin.') === false) + 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 @@ -228,31 +238,35 @@ $args = $args[0]; foreach ($args as $name) { - $this->command('add_label', $name, rcube_label($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 boolean Override last set message + * @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, $override=true) + public function show_message($message, $type='notice', $vars=null, $override=true, $timeout=0) { 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', - rcube_label(array('name' => $message, 'vars' => $vars)), - $type); + $this->command('display_message', $msgtext, $type, $timeout * 1000); } } - /** * Delete all stored env variables and commands @@ -268,11 +282,11 @@ { $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 @@ -286,7 +300,6 @@ header('Location: ' . $location); exit; } - /** * Send the request output to the client. @@ -331,54 +344,74 @@ public function write($template = '') { // unlock interface after iframe load - $unlock = preg_replace('/[^a-z0-9]/i', '', $_GET['_unlock']); + $unlock = preg_replace('/[^a-z0-9]/i', '', $_REQUEST['_unlock']); if ($this->framed) { 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'); - // make sure all <form> tags have a valid request token - $template = preg_replace_callback('/<form\s+([^>]+)>/Ui', array($this, 'alter_form_tag'), $template); - $this->footer = preg_replace_callback('/<form\s+([^>]+)>/Ui', array($this, 'alter_form_tag'), $this->footer); + // 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; + $plugin = false; + $realname = $name; + $temp = explode('.', $name, 2); - $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->app->plugins->dir . $skin_dir; - if (!is_dir($skin_path)) { // fallback to default skin + $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->app->plugins->dir . $skin_dir; + $skin_path = $this->plugin_skin_path = $this->app->plugins->dir . $skin_dir; } } $path = "$skin_path/templates/$name.html"; + + 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) { @@ -387,7 +420,7 @@ 'type' => 'php', 'line' => __LINE__, 'file' => __FILE__, - 'message' => 'Error loading template for '.$name + 'message' => 'Error loading template for '.$realname ), true, true); return false; } @@ -403,23 +436,41 @@ $output = $this->parse_xml($output); // trigger generic hook where plugins can put additional content to the page - $hook = $this->app->plugins->exec_hook("render_page", array('template' => $name, 'content' => $output)); + $hook = $this->app->plugins->exec_hook("render_page", array('template' => $realname, 'content' => $output)); - // add debug console - if ($this->config['debug_level'] & 8) { - $this->add_footer('<div id="console" style="position:absolute;top:5px;left:5px;width:405px;padding:2px;background:white;z-index:9000;"> - <a href="#toggle" onclick="con=$(\'#dbgconsole\');con[con.is(\':visible\')?\'hide\':\'show\']();return false">console</a> - <textarea name="console" id="dbgconsole" rows="20" cols="40" wrap="off" style="display:none;width:400px;border:none;font-size:10px" spellcheck="false"></textarea></div>' - ); + // save some memory + $output = $hook['content']; + unset($hook['content']); + + $output = $this->parse_with_globals($output); + + // make sure all <form> tags have a valid request token + $output = preg_replace_callback('/<form\s+([^>]+)>/Ui', array($this, 'alter_form_tag'), $output); + $this->footer = preg_replace_callback('/<form\s+([^>]+)>/Ui', array($this, 'alter_form_tag'), $this->footer); + + if ($write) { + // add debug console + if ($realname != 'error' && ($this->config['debug_level'] & 8)) { + $this->add_footer('<div id="console" style="position:absolute;top:5px;left:5px;width:405px;padding:2px;background:white;z-index:9000;display:none"> + <a href="#toggle" onclick="con=$(\'#dbgconsole\');con[con.is(\':visible\')?\'hide\':\'show\']();return false">console</a> + <textarea name="console" id="dbgconsole" rows="20" cols="40" style="display:none;width:400px;border:none;font-size:10px" spellcheck="false"></textarea></div>' + ); + $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($hook['content']); - $this->write(trim($output)); if ($exit) { exit; } } - /** * Return executable javascript code for all registered commands @@ -431,6 +482,9 @@ $out = ''; 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); @@ -507,7 +561,7 @@ */ private function parse_conditions($input) { - $matches = preg_split('/<roundcube:(if|elseif|else|endif)\s+([^>]+)>/is', $input, 2, PREG_SPLIT_DELIM_CAPTURE); + $matches = preg_split('/<roundcube:(if|elseif|else|endif)\s+([^>]+)>\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]); @@ -515,10 +569,10 @@ $attrib = parse_attrib_string($matches[2]); if (isset($attrib['condition'])) { $condmet = $this->check_condition($attrib['condition']); - $submatches = preg_split('/<roundcube:(elseif|else|endif)\s+([^>]+)>/is', $matches[3], 2, PREG_SPLIT_DELIM_CAPTURE); + $submatches = preg_split('/<roundcube:(elseif|else|endif)\s+([^>]+)>\n?/is', $matches[3], 2, PREG_SPLIT_DELIM_CAPTURE); if ($condmet) { $result = $submatches[0]; - $result.= ($submatches[1] != 'endif' ? preg_replace('/.*<roundcube:endif\s+[^>]+>/Uis', '', $submatches[3], 1) : $submatches[3]); + $result.= ($submatches[1] != 'endif' ? preg_replace('/.*<roundcube:endif\s+[^>]+>\n?/Uis', '', $submatches[3], 1) : $submatches[3]); } else { $result = "<roundcube:$submatches[1] $submatches[2]>" . $submatches[3]; @@ -583,7 +637,8 @@ '/env:([a-z0-9_]+)/i', '/request:([a-z0-9_]+)/i', '/cookie:([a-z0-9_]+)/i', - '/browser:([a-z0-9_]+)/i' + '/browser:([a-z0-9_]+)/i', + '/template:name/i', ), array( "\$_SESSION['\\1']", @@ -591,7 +646,8 @@ "\$this->env['\\1']", "get_input_value('\\1', RCUBE_INPUT_GPC)", "\$_COOKIE['\\1']", - "\$this->browser->{'\\1'}" + "\$this->browser->{'\\1'}", + $this->template_name, ), $expression); } @@ -608,7 +664,7 @@ */ private function parse_xml($input) { - return preg_replace_callback('/<roundcube:([-_a-z]+)\s+([^>]+)>/Ui', array($this, 'xml_command'), $input); + return preg_replace_callback('/<roundcube:([-_a-z]+)\s+((?:[^>]|\\\\>)+)(?<!\\\\)>/Ui', array($this, 'xml_command'), $input); } @@ -641,13 +697,18 @@ // 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 (!$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); @@ -690,6 +751,15 @@ else if (function_exists($handler)) { $content = call_user_func($handler, $attrib); } + else if ($object == 'doctype') { + $content = html::doctype($attrib['value']); + } + 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); + } else if ($object == 'productname') { $name = !empty($this->config['product_name']) ? $this->config['product_name'] : 'Roundcube Webmail'; $content = Q($name); @@ -706,7 +776,12 @@ $content = Q($this->get_pagetitle()); } else if ($object == 'pagetitle') { - $title = !empty($this->config['product_name']) ? $this->config['product_name'].' :: ' : ''; + 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); } @@ -732,8 +807,8 @@ break; case 'config': $value = $this->config[$name]; - if (is_array($value) && $value[$_SESSION['imap_host']]) { - $value = $value[$_SESSION['imap_host']]; + if (is_array($value) && $value[$_SESSION['storage_host']]) { + $value = $value[$_SESSION['storage_host']]; } break; case 'request': @@ -852,6 +927,7 @@ // make valid href to specific buttons if (in_array($attrib['command'], rcmail::$main_tasks)) { $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']); @@ -901,6 +977,8 @@ else if ($attrib['type']=='link') { $btn_content = isset($attrib['content']) ? $attrib['content'] : ($attrib['label'] ? $attrib['label'] : $attrib['command']); $link_attrib = array('href', 'onclick', 'title', 'id', 'class', 'style', 'tabindex', 'target'); + if ($attrib['innerclass']) + $btn_content = html::span($attrib['innerclass'], $btn_content); } else if ($attrib['type']=='input') { $attrib['type'] = 'button'; @@ -908,14 +986,11 @@ if ($attrib['label']) { $attrib['value'] = $attrib['label']; } + if ($attrib['command']) { + $attrib['disabled'] = 'disabled'; + } - $attrib_str = html::attrib_string( - $attrib, - array( - 'type', 'value', 'onclick', 'id', 'class', 'style', 'tabindex' - ) - ); - $out = sprintf('<input%s disabled="disabled" />', $attrib_str); + $out = html::tag('input', $attrib, '', array('type', 'value', 'onclick', 'id', 'class', 'style', 'tabindex', 'disabled')); } // generate html code for button @@ -975,8 +1050,11 @@ $attrib['action'] = './'; // we already have a <form> tag - if ($attrib['form']) + 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); } @@ -1010,7 +1088,7 @@ $username = $this->app->user->get_username(); } - return idn_to_utf8($username); + return rcube_idn_to_utf8($username); } @@ -1024,6 +1102,7 @@ private function login_form($attrib) { $default_host = $this->config['default_host']; + $autocomplete = (int) $this->config['login_autocomplete']; $_SESSION['temp'] = true; @@ -1032,11 +1111,20 @@ if (empty($url) && !preg_match('/_(task|action)=logout/', $_SERVER['QUERY_STRING'])) $url = $_SERVER['QUERY_STRING']; - $input_user = new html_inputfield(array('name' => '_user', 'id' => 'rcmloginuser') + $attrib); - $input_pass = new html_passwordfield(array('name' => '_pass', 'id' => 'rcmloginpwd') + $attrib); + // 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) && count($default_host) > 1) { @@ -1058,7 +1146,8 @@ 'name' => '_host', 'id' => 'rcmloginhost', 'value' => $host) + $attrib); } else if (empty($default_host)) { - $input_host = new html_inputfield(array('name' => '_host', 'id' => 'rcmloginhost') + $attrib); + $input_host = new html_inputfield(array('name' => '_host', 'id' => 'rcmloginhost') + + $attrib + $host_attrib); } $form_name = !empty($attrib['form']) ? $attrib['form'] : 'form'; @@ -1068,19 +1157,21 @@ $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', RCUBE_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) && !$hide_host) { $table->add('title', html::label('rcmloginhost', Q(rcube_label('server')))); - $table->add(null, $input_host->show(get_input_value('_host', RCUBE_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(); @@ -1112,12 +1203,11 @@ if (empty($images) || $this->app->task == 'logout') return; - $this->add_script('$(document).ready(function(){ - var images = ' . json_serialize($images) .'; + $this->add_script('var images = ' . json_serialize($images) .'; for (var i=0; i<images.length; i++) { img = new Image(); img.src = images[i]; - }});', 'foot'); + }', 'docready'); } @@ -1197,8 +1287,8 @@ '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-8895-2 ('.rcube_label('easterneuropean').')', - 'ISO-8859-4' => 'ISO-8895-4 ('.rcube_label('baltic').')', + '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').')', @@ -1246,6 +1336,30 @@ return $select->show($set); } + /** + * Include content from config/about.<LANG>.html if available + */ + private function about_content($attrib) + { + $content = ''; + $filenames = array( + 'about.' . $_SESSION['language'] . '.html', + 'about.' . substr($_SESSION['language'], 0, 2) . '.html', + 'about.html', + ); + foreach ($filenames as $file) { + $fn = RCMAIL_CONFIG_DIR . '/' . $file; + if (is_readable($fn)) { + $content = file_get_contents($fn); + $content = $this->parse_conditions($content); + $content = $this->parse_xml($content); + break; + } + } + + return $content; + } + } // end class rcube_template -- Gitblit v1.9.1