| | |
| | | | program/include/rcmail_output_html.php | |
| | | | | |
| | | | This file is part of the Roundcube Webmail client | |
| | | | Copyright (C) 2006-2012, The Roundcube Dev Team | |
| | | | Copyright (C) 2006-2013, The Roundcube Dev Team | |
| | | | | |
| | | | Licensed under the GNU General Public License version 3 or | |
| | | | any later version with exceptions for skins & plugins. | |
| | |
| | | /** |
| | | * Class to create HTML page output using a skin template |
| | | * |
| | | * @package Core |
| | | * @package Webmail |
| | | * @subpackage View |
| | | */ |
| | | class rcmail_output_html extends rcmail_output |
| | |
| | | protected $footer = ''; |
| | | protected $body = ''; |
| | | protected $base_path = ''; |
| | | protected $devel_mode = false; |
| | | |
| | | // deprecated names of templates used before 0.5 |
| | | protected $deprecated_templates = array( |
| | |
| | | { |
| | | parent::__construct(); |
| | | |
| | | $this->devel_mode = $this->config->get('devel_mode'); |
| | | |
| | | //$this->framed = $framed; |
| | | $this->set_env('task', $task); |
| | | $this->set_env('x_frame_options', $this->config->get('x_frame_options', 'sameorigin')); |
| | |
| | | // add cookie info |
| | | $this->set_env('cookie_domain', ini_get('session.cookie_domain')); |
| | | $this->set_env('cookie_path', ini_get('session.cookie_path')); |
| | | $this->set_env('cookie_secure', ini_get('session.cookie_secure')); |
| | | $this->set_env('cookie_secure', filter_var(ini_get('session.cookie_secure'), FILTER_VALIDATE_BOOLEAN)); |
| | | |
| | | // load the correct skin (in case user-defined) |
| | | $skin = $this->config->get('skin'); |
| | |
| | | $this->set_env('skin', $skin); |
| | | |
| | | if (!empty($_REQUEST['_extwin'])) |
| | | $this->set_env('extwin', 1); |
| | | $this->set_env('extwin', 1); |
| | | if ($this->framed || !empty($_REQUEST['_framed'])) |
| | | $this->set_env('framed', 1); |
| | | $this->set_env('framed', 1); |
| | | |
| | | // add common javascripts |
| | | $this->add_script('var '.self::JS_OBJECT_NAME.' = new rcube_webmail();', 'head_top'); |
| | |
| | | )); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Set environment variable |
| | | * |
| | |
| | | public function set_env($name, $value, $addtojs = true) |
| | | { |
| | | $this->env[$name] = $value; |
| | | |
| | | if ($addtojs || isset($this->js_env[$name])) { |
| | | $this->js_env[$name] = $value; |
| | | } |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Getter for the current page title |
| | |
| | | return $title; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Set skin |
| | | */ |
| | | public function set_skin($skin) |
| | | { |
| | | $valid = false; |
| | | $path = RCUBE_INSTALL_PATH . 'skins/'; |
| | | |
| | | if (!empty($skin) && is_dir('skins/'.$skin) && is_readable('skins/'.$skin)) { |
| | | $skin_path = 'skins/'.$skin; |
| | | $valid = true; |
| | | if (!empty($skin) && is_dir($path . $skin) && is_readable($path . $skin)) { |
| | | $skin_path = 'skins/' . $skin; |
| | | $valid = true; |
| | | } |
| | | else { |
| | | $skin_path = $this->config->get('skin_path'); |
| | |
| | | $this->skin_paths[] = $skin_path; |
| | | |
| | | // read meta file and check for dependecies |
| | | $meta = @json_decode(@file_get_contents($skin_path.'/meta.json'), true); |
| | | if ($meta['extends'] && is_dir('skins/' . $meta['extends'])) { |
| | | $this->load_skin('skins/' . $meta['extends']); |
| | | $meta = @file_get_contents(RCUBE_INSTALL_PATH . $skin_path . '/meta.json'); |
| | | $meta = @json_decode($meta, true); |
| | | if ($meta['extends']) { |
| | | $path = RCUBE_INSTALL_PATH . 'skins/'; |
| | | if (is_dir($path . $meta['extends']) && is_readable($path . $meta['extends'])) { |
| | | $this->load_skin('skins/' . $meta['extends']); |
| | | } |
| | | } |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Check if a specific template exists |
| | |
| | | */ |
| | | public function template_exists($name) |
| | | { |
| | | $found = false; |
| | | foreach ($this->skin_paths as $skin_path) { |
| | | $filename = $skin_path . '/templates/' . $name . '.html'; |
| | | $found = (is_file($filename) && is_readable($filename)) || ($this->deprecated_templates[$name] && $this->template_exists($this->deprecated_templates[$name])); |
| | | if ($found) |
| | | break; |
| | | $filename = RCUBE_INSTALL_PATH . $skin_path . '/templates/' . $name . '.html'; |
| | | if ((is_file($filename) && is_readable($filename)) |
| | | || ($this->deprecated_templates[$name] && $this->template_exists($this->deprecated_templates[$name])) |
| | | ) { |
| | | return true; |
| | | } |
| | | } |
| | | return $found; |
| | | } |
| | | |
| | | return false; |
| | | } |
| | | |
| | | /** |
| | | * Find the given file in the current skin path stack |
| | |
| | | return false; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Register a GUI object to the client script |
| | | * |
| | |
| | | { |
| | | $this->add_script(self::JS_OBJECT_NAME.".gui_object('$obj', '$id');"); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Call a client method |
| | |
| | | $this->js_commands[] = $cmd; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Add a localized label to the client environment |
| | | */ |
| | |
| | | $this->js_labels[$name] = $this->app->gettext($name); |
| | | } |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Invoke display_message command |
| | |
| | | } |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Delete all stored env variables and commands |
| | | * |
| | |
| | | */ |
| | | public function reset($all = false) |
| | | { |
| | | $framed = $this->framed; |
| | | $env = $all ? null : array_intersect_key($this->env, array('extwin'=>1, 'framed'=>1)); |
| | | |
| | | parent::reset(); |
| | | |
| | | // let some env variables survive |
| | | $this->env = $this->js_env = $env; |
| | | $this->framed = $framed || $this->env['framed']; |
| | | $this->js_labels = array(); |
| | | $this->js_commands = array(); |
| | | $this->script_files = array(); |
| | |
| | | $this->header = ''; |
| | | $this->footer = ''; |
| | | $this->body = ''; |
| | | } |
| | | |
| | | // load defaults |
| | | if (!$all) { |
| | | $this->__construct(); |
| | | } |
| | | } |
| | | |
| | | /** |
| | | * Redirect to a certain url |
| | |
| | | header('Location: ' . $location); |
| | | exit; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Send the request output to the client. |
| | |
| | | exit; |
| | | } |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Process template and write to stdOut |
| | |
| | | // call super method |
| | | $this->_write($template, $this->config->get('skin_path')); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Parse a specific skin template and deliver to stdout (or return) |
| | |
| | | } |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Return executable javascript code for all registered commands |
| | | * |
| | |
| | | return $out; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Make URLs starting with a slash point to skin directory |
| | | * |
| | |
| | | else |
| | | return $str; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Show error page and terminate script execution |
| | |
| | | array($this, 'globals_callback'), $input); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Callback funtion for preg_replace_callback() in parse_with_globals() |
| | | */ |
| | |
| | | { |
| | | return $GLOBALS[$matches[1]]; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Correct absolute paths in images and other tags |
| | |
| | | '!(src|href|background)=(["\']?)([a-z0-9/_.-]+)(["\'\s>])!i', |
| | | array($this, 'file_callback'), $output); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Callback function for preg_replace_callback in write() |
| | |
| | | } |
| | | |
| | | // add file modification timestamp |
| | | if (preg_match('/\.(js|css)$/', $file)) { |
| | | if ($fs = @filemtime($file)) { |
| | | $file .= '?s=' . $fs; |
| | | } |
| | | if (preg_match('/\.(js|css)$/', $file, $m)) { |
| | | $file = $this->file_mod($file); |
| | | } |
| | | |
| | | return $matches[1] . '=' . $matches[2] . $file . $matches[4]; |
| | | } |
| | | |
| | | /** |
| | | * Modify file by adding mtime indicator |
| | | */ |
| | | protected function file_mod($file) |
| | | { |
| | | $fs = false; |
| | | $ext = substr($file, strrpos($file, '.') + 1); |
| | | |
| | | // use minified file if exists (not in development mode) |
| | | if (!$this->devel_mode && !preg_match('/\.min\.' . $ext . '$/', $file)) { |
| | | $minified_file = substr($file, 0, strlen($ext) * -1) . 'min.' . $ext; |
| | | if ($fs = @filemtime($minified_file)) { |
| | | return $minified_file . '?s=' . $fs; |
| | | } |
| | | } |
| | | |
| | | if ($fs = @filemtime($file)) { |
| | | $file .= '?s=' . $fs; |
| | | } |
| | | |
| | | return $file; |
| | | } |
| | | |
| | | /** |
| | | * Public wrapper to dipp into template parsing. |
| | |
| | | |
| | | return $input; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Parse for conditional tags |
| | |
| | | return $input; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Determines if a given condition is met |
| | | * |
| | |
| | | { |
| | | return $this->eval_expression($condition); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Inserts hidden field with CSRF-prevention-token into POST forms |
| | |
| | | |
| | | return $out; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Parse & evaluate a given expression and return its result. |
| | |
| | | return $fn($this->app, $this->browser, $this->env); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Search for special tags in input and replace them |
| | | * with the appropriate content |
| | |
| | | { |
| | | return preg_replace_callback('/<roundcube:([-_a-z]+)\s+((?:[^>]|\\\\>)+)(?<!\\\\)>/Ui', array($this, 'xml_command'), $input); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Callback function for parsing an xml command tag |
| | |
| | | } |
| | | else if ($object == 'logo') { |
| | | $attrib += array('alt' => $this->xml_command(array('', 'object', 'name="productname"'))); |
| | | if ($logo = $this->config->get('skin_logo')) |
| | | $attrib['src'] = $logo; |
| | | |
| | | if ($logo = $this->config->get('skin_logo')) { |
| | | if (is_array($logo)) { |
| | | if ($template_logo = $logo[$this->template_name]) { |
| | | $attrib['src'] = $template_logo; |
| | | } |
| | | elseif ($template_logo = $logo['*']) { |
| | | $attrib['src'] = $template_logo; |
| | | } |
| | | } |
| | | else { |
| | | $attrib['src'] = $logo; |
| | | } |
| | | } |
| | | |
| | | $content = html::img($attrib); |
| | | } |
| | | else if ($object == 'productname') { |
| | |
| | | $content = html::quote($this->get_pagetitle()); |
| | | } |
| | | else if ($object == 'pagetitle') { |
| | | if ($this->config->get('devel_mode') && !empty($_SESSION['username'])) |
| | | if ($this->devel_mode && !empty($_SESSION['username'])) |
| | | $title = $_SESSION['username'].' :: '; |
| | | else if ($prod_name = $this->config->get('product_name')) |
| | | $title = $prod_name . ' :: '; |
| | |
| | | } |
| | | |
| | | return html::quote($value); |
| | | break; |
| | | |
| | | case 'form': |
| | | return $this->form_tag($attrib); |
| | | } |
| | | return ''; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Include a specific file and return it's contents |
| | |
| | | return $out; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Create and register a button |
| | | * |
| | |
| | | // these commands can be called directly via url |
| | | $a_static_commands = array('compose', 'list', 'preferences', 'folders', 'identities'); |
| | | |
| | | if (!($attrib['command'] || $attrib['name'])) { |
| | | if (!($attrib['command'] || $attrib['name'] || $attrib['href'])) { |
| | | return ''; |
| | | } |
| | | |
| | |
| | | } |
| | | 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'); |
| | | $link_attrib = array_merge(html::$common_attrib, array('href', 'onclick', 'tabindex', 'target')); |
| | | if ($attrib['innerclass']) |
| | | $btn_content = html::span($attrib['innerclass'], $btn_content); |
| | | } |
| | |
| | | |
| | | // generate html code for button |
| | | if ($btn_content) { |
| | | $attrib_str = html::attrib_string($attrib, $link_attrib); |
| | | $attrib_str = html::attrib_string($attrib, array_merge($link_attrib, array('data-*'))); |
| | | $out = sprintf('<a%s>%s</a>', $attrib_str, $btn_content); |
| | | } |
| | | |
| | |
| | | return $out; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Link an external script file |
| | | * |
| | |
| | | */ |
| | | public function include_script($file, $position='head') |
| | | { |
| | | static $sa_files = array(); |
| | | |
| | | if (!preg_match('|^https?://|i', $file) && $file[0] != '/') { |
| | | $file = $this->scripts_path . $file; |
| | | if ($fs = @filemtime($file)) { |
| | | $file .= '?s=' . $fs; |
| | | } |
| | | $file = $this->file_mod($this->scripts_path . $file); |
| | | } |
| | | |
| | | if (in_array($file, $sa_files)) { |
| | | return; |
| | | } |
| | | |
| | | $sa_files[] = $file; |
| | | |
| | | if (!is_array($this->script_files[$position])) { |
| | | $this->script_files[$position] = array(); |
| | | } |
| | | |
| | | $this->script_files[$position][] = $file; |
| | | if (!in_array($file, $this->script_files[$position])) { |
| | | $this->script_files[$position][] = $file; |
| | | } |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Add inline javascript code |
| | |
| | | } |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Link an external css file |
| | | * |
| | |
| | | $this->css_files[] = $file; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Add HTML code to the page header |
| | | * |
| | |
| | | { |
| | | $this->header .= "\n" . $str; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Add HTML code to the page footer |
| | |
| | | $this->footer .= "\n" . $str; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Process template and write to stdOut |
| | | * |
| | |
| | | */ |
| | | public function _write($templ = '', $base_path = '') |
| | | { |
| | | $output = empty($templ) ? $this->default_template : trim($templ); |
| | | $output = trim($templ); |
| | | |
| | | if (empty($output)) { |
| | | $output = $this->default_template; |
| | | $is_empty = true; |
| | | } |
| | | |
| | | // set default page title |
| | | if (empty($this->pagetitle)) { |
| | |
| | | } |
| | | |
| | | // add css files in head, before scripts, for speed up with parallel downloads |
| | | if (!empty($this->css_files) && |
| | | (($pos = stripos($output, '<script ')) || ($pos = stripos($output, '</head>'))) |
| | | if (!empty($this->css_files) && !$is_empty |
| | | && (($pos = stripos($output, '<script ')) || ($pos = stripos($output, '</head>'))) |
| | | ) { |
| | | $css = ''; |
| | | foreach ($this->css_files as $file) { |
| | |
| | | } |
| | | } |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Returns iframe object, registers some related env variables |
| | |
| | | |
| | | /* ************* common functions delivering gui objects ************** */ |
| | | |
| | | |
| | | /** |
| | | * Create a form tag with the necessary hidden fields |
| | | * |
| | |
| | | $attrib['noclose'] = true; |
| | | |
| | | return html::tag('form', |
| | | $attrib + array('action' => "./", 'method' => "get"), |
| | | $attrib + array('action' => $this->app->comm_path, 'method' => "get"), |
| | | $hidden . $content, |
| | | array('id','class','style','name','method','action','enctype','onsubmit')); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Build a form tag with a unique request token |
| | |
| | | else |
| | | return $this->form_tag($attrib, $hidden->show() . $content); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * GUI object 'username' |
| | |
| | | return rcube_utils::idn_to_utf8($username); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * GUI object 'loginform' |
| | | * Returns code for the webmail login form |
| | |
| | | $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_user = new html_inputfield(array('name' => '_user', 'id' => 'rcmloginuser') |
| | | $input_user = new html_inputfield(array('name' => '_user', 'id' => 'rcmloginuser', 'required' => 'required') |
| | | + $attrib + $user_attrib); |
| | | $input_pass = new html_passwordfield(array('name' => '_pass', 'id' => 'rcmloginpwd') |
| | | $input_pass = new html_passwordfield(array('name' => '_pass', 'id' => 'rcmloginpwd', 'required' => 'required') |
| | | + $attrib + $pass_attrib); |
| | | $input_host = null; |
| | | |
| | |
| | | $out .= $input_host->show(); |
| | | } |
| | | |
| | | if (rcube_utils::get_boolean($attrib['submit'])) { |
| | | $submit = new html_inputfield(array('type' => 'submit', 'id' => 'rcmloginsubmit', |
| | | 'class' => 'button mainaction', 'value' => $this->app->gettext('login'))); |
| | | $out .= html::p('formbuttons', $submit->show()); |
| | | } |
| | | |
| | | // surround html output with a form tag |
| | | if (empty($attrib['form'])) { |
| | | $out = $this->form_tag(array('name' => $form_name, 'method' => 'post'), $out); |
| | |
| | | |
| | | return $out; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * GUI object 'preloader' |
| | |
| | | img.src = images[i]; |
| | | }', 'docready'); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * GUI object 'searchform' |
| | |
| | | // add form tag around text field |
| | | if (empty($attrib['form'])) { |
| | | $out = $this->form_tag(array( |
| | | 'name' => "rcmqsearchform", |
| | | 'name' => "rcmqsearchform", |
| | | 'onsubmit' => self::JS_OBJECT_NAME . ".command('search'); return false", |
| | | 'style' => "display:inline"), |
| | | 'style' => "display:inline"), |
| | | $out); |
| | | } |
| | | |
| | | return $out; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Builder for GUI object 'message' |
| | |
| | | |
| | | return html::div($attrib, ''); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * GUI object 'charsetselector' |