| | |
| | | | program/include/rcube_template.php | |
| | | | | |
| | | | This file is part of the RoundCube Webmail client | |
| | | | Copyright (C) 2006-2008, RoundCube Dev. - Switzerland | |
| | | | Copyright (C) 2006-2009, RoundCube Dev. - Switzerland | |
| | | | Licensed under the GNU GPL | |
| | | | | |
| | | | PURPOSE: | |
| | |
| | | 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(); |
| | | |
| | | public $type = 'html'; |
| | | public $ajax_call = false; |
| | | |
| | | /** |
| | |
| | | |
| | | $this->app = rcmail::get_instance(); |
| | | $this->config = $this->app->config->all(); |
| | | $this->browser = new rcube_browser(); |
| | | |
| | | //$this->framed = $framed; |
| | | $this->set_env('task', $task); |
| | |
| | | $javascript = 'var '.JS_OBJECT_NAME.' = new rcube_webmail();'; |
| | | |
| | | // 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."');"; |
| | | $javascript_foot = '$(document).ready(function(){ '.JS_OBJECT_NAME.'.init(); });'; |
| | | |
| | | $this->add_script($javascript, 'head_top'); |
| | | $this->add_script($javascript_foot, 'foot'); |
| | | $this->scripts_path = 'program/js/'; |
| | | $this->include_script('jquery-1.3.min.js'); |
| | | $this->include_script('common.js'); |
| | | $this->include_script('app.js'); |
| | | |
| | |
| | | { |
| | | $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 command() |
| | | { |
| | | $this->js_commands[] = func_get_args(); |
| | | $cmd = func_get_args(); |
| | | if (strpos($cmd[0], 'plugin.') === false) |
| | | $this->js_commands[] = $cmd; |
| | | } |
| | | |
| | | |
| | |
| | | */ |
| | | public function add_label() |
| | | { |
| | | $arg_list = func_get_args(); |
| | | foreach ($arg_list as $i => $name) { |
| | | $args = func_get_args(); |
| | | if (count($args) == 1 && is_array($args[0])) |
| | | $args = $args[0]; |
| | | |
| | | foreach ($args as $name) { |
| | | $this->command('add_label', $name, rcube_label($name)); |
| | | } |
| | | } |
| | |
| | | * @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 |
| | | * @uses self::command() |
| | | */ |
| | | public function show_message($message, $type='notice', $vars=NULL) |
| | | public function show_message($message, $type='notice', $vars=null, $override=true) |
| | | { |
| | | $this->command( |
| | | 'display_message', |
| | | rcube_label(array('name' => $message, 'vars' => $vars)), |
| | | $type); |
| | | if ($override || !$this->message) { |
| | | $this->message = $message; |
| | | $this->command( |
| | | 'display_message', |
| | | rcube_label(array('name' => $message, 'vars' => $vars)), |
| | | $type); |
| | | } |
| | | } |
| | | |
| | | |
| | |
| | | private function parse($name = 'main', $exit = true) |
| | | { |
| | | $skin_path = $this->config['skin_path']; |
| | | $plugin = false; |
| | | |
| | | $temp = explode(".", $name, 2); |
| | | 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 |
| | | $skin_dir = $plugin . '/skins/default'; |
| | | $skin_path = $this->app->plugins->dir . $skin_dir; |
| | | } |
| | | } |
| | | |
| | | $path = "$skin_path/templates/$name.html"; |
| | | |
| | | // read template file |
| | | if (($templ = file_get_contents($path)) === false) { |
| | | ob_start(); |
| | | file_get_contents($path); |
| | | $message = ob_get_contents(); |
| | | ob_end_clean(); |
| | | 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 '.$name |
| | | ), true, true); |
| | | return false; |
| | | } |
| | | |
| | | // 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 |
| | |
| | | |
| | | // add debug console |
| | | if ($this->config['debug_level'] & 8) { |
| | | $this->add_footer('<div style="position:absolute;top:5px;left:5px;width:400px;padding:0.2em;background:white;opacity:0.8;z-index:9000"> |
| | | $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=document.getElementById(\'dbgconsole\');con.style.display=(con.style.display==\'none\'?\'block\':\'none\');return false">console</a> |
| | | <form action="/" name="debugform"><textarea name="console" id="dbgconsole" rows="20" cols="40" wrap="off" style="display:none;width:400px;border:none;font-size:x-small"></textarea></form></div>' |
| | | <form action="/" name="debugform" style="display:inline"><textarea name="console" id="dbgconsole" rows="20" cols="40" wrap="off" style="display:none;width:400px;border:none;font-size:x-small" spellcheck="false"></textarea></form></div>' |
| | | ); |
| | | } |
| | | $output = $this->parse_with_globals($output); |
| | | $this->write(trim($output), $skin_path); |
| | | $this->write(trim($output)); |
| | | if ($exit) { |
| | | exit; |
| | | } |
| | |
| | | $parent = $this->framed || preg_match('/^parent\./', $method); |
| | | $out .= sprintf( |
| | | "%s.%s(%s);\n", |
| | | ($parent ? 'parent.' : '') . JS_OBJECT_NAME, |
| | | preg_replace('/^parent\./', '', $method), |
| | | implode(',', $args) |
| | | ($parent ? 'if(window.parent && parent.'.JS_OBJECT_NAME.') 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) |
| | | ); |
| | | } |
| | | |
| | | return $out; |
| | | } |
| | | |
| | |
| | | * @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).");"); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Parses expression and replaces variables |
| | | * |
| | | * @param string Expression statement |
| | | * @return string Expression statement |
| | | */ |
| | | 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' |
| | | ), |
| | | 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'}" |
| | | ), |
| | | $condition); |
| | | |
| | | return eval("return (".$condition.");"); |
| | | $expression); |
| | | } |
| | | |
| | | |
| | |
| | | */ |
| | | private function parse_xml($input) |
| | | { |
| | | return preg_replace_callback('/<roundcube:([-_a-z]+)\s+([^>]+)>/Ui', array($this, 'xml_command_callback'), $input); |
| | | return preg_replace_callback('/<roundcube:([-_a-z]+)\s+([^>]+)>/Ui', array($this, 'xml_command'), $input); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * This is a callback function for preg_replace_callback (see #1485286) |
| | | * It's only purpose is to reconfigure parameters for xml_command, so that the signature isn't disturbed |
| | | */ |
| | | private function xml_command_callback($matches) |
| | | { |
| | | $str_attrib = isset($matches[2]) ? $matches[2] : ''; |
| | | $add_attrib = isset($matches[3]) ? $matches[3] : array(); |
| | | |
| | | $command = $matches[1]; |
| | | //matches[0] is the entire matched portion of the string |
| | | |
| | | return $this->xml_command($command, $str_attrib, $add_attrib); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * 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'])) { |
| | |
| | | $incl = $this->include_php($path); |
| | | } |
| | | else { |
| | | $incl = file_get_contents($path); |
| | | } |
| | | $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') { |
| | | else if ($object == 'productname') { |
| | | $name = !empty($this->config['product_name']) ? $this->config['product_name'] : 'RoundCube Webmail'; |
| | | return Q($name); |
| | | $content = Q($name); |
| | | } |
| | | if ($object=='version') { |
| | | 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); |
| | | } |
| | | if ($object=='pagetitle') { |
| | | $task = $this->env['task']; |
| | | else if ($object == 'steptitle') { |
| | | $content = Q($this->get_pagetitle()); |
| | | } |
| | | else if ($object == 'pagetitle') { |
| | | $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); |
| | | } |
| | | |
| | | return Q($title); |
| | | $title .= $this->get_pagetitle(); |
| | | $content = Q($title); |
| | | } |
| | | break; |
| | | |
| | | // 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 variable |
| | | case 'var': |
| | |
| | | break; |
| | | case 'session': |
| | | $value = $_SESSION[$name]; |
| | | break; |
| | | case 'cookie': |
| | | $value = htmlspecialchars($_COOKIE[$name]); |
| | | break; |
| | | case 'browser': |
| | | $value = $this->browser->{$name}; |
| | | break; |
| | | } |
| | | |
| | |
| | | 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 = $sa_buttons[$command]; |
| | | } |
| | | |
| | | // set border to 0 because of the link arround the button |
| | | if ($attrib['type']=='image' && !isset($attrib['border'])) { |
| | | $attrib['border'] = 0; |
| | | } |
| | | 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']) { |
| | | if ($this->browser->ie && $attrib['title'] && !$attrib['alt']) { |
| | | $attrib['alt'] = $attrib['title']; |
| | | unset($attrib['title']); |
| | | } |
| | | |
| | | // add empty alt attribute for XHTML compatibility |
| | |
| | | |
| | | // 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']); |
| | | } |
| | | 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']; |
| | | } |
| | | } |
| | | |
| | | // overwrite attributes |
| | |
| | | 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', 'title', 'target'); |
| | | } |
| | | else if ($attrib['type']=='link') { |
| | | $btn_content = $attrib['label'] ? $attrib['label'] : $attrib['command']; |
| | | $link_attrib = array('href', 'onclick', 'title', 'id', 'class', 'style', 'tabindex'); |
| | | $link_attrib = array('href', 'onclick', 'title', 'id', 'class', 'style', 'tabindex', 'target'); |
| | | } |
| | | else if ($attrib['type']=='input') { |
| | | $attrib['type'] = 'button'; |
| | |
| | | $default_host = $this->config['default_host']; |
| | | |
| | | $_SESSION['temp'] = true; |
| | | |
| | | // save original url |
| | | $url = get_input_value('_url', RCUBE_INPUT_POST); |
| | | if (empty($url) && !preg_match('/_action=logout/', $_SERVER['QUERY_STRING'])) |
| | | $url = $_SERVER['QUERY_STRING']; |
| | | |
| | | $input_user = new html_inputfield(array('name' => '_user', 'id' => 'rcmloginuser', 'size' => 30) + $attrib); |
| | | $input_pass = new html_passwordfield(array('name' => '_pass', 'id' => 'rcmloginpwd', 'size' => 30) + $attrib); |
| | | $input_action = new html_hiddenfield(array('name' => '_action', 'value' => 'login')); |
| | | $input_tzone = new html_hiddenfield(array('name' => '_timezone', 'id' => 'rcmlogintz', 'value' => '_default_')); |
| | | $input_url = new html_hiddenfield(array('name' => '_url', 'id' => 'rcmloginurl', 'value' => $url)); |
| | | $input_host = null; |
| | | |
| | | if (is_array($default_host)) { |
| | |
| | | } |
| | | |
| | | $out = $input_action->show(); |
| | | $out .= $input_tzone->show(); |
| | | $out .= $input_url->show(); |
| | | $out .= $table->show(); |
| | | |
| | | // surround html output with a form tag |
| | |
| | | if (empty($attrib['id'])) { |
| | | $attrib['id'] = 'rcmqsearchbox'; |
| | | } |
| | | if ($attrib['type'] == 'search' && !$this->browser->khtml) { |
| | | unset($attrib['type'], $attrib['results']); |
| | | } |
| | | |
| | | $input_q = new html_inputfield($attrib); |
| | | $out = $input_q->show(); |
| | | |