| | |
| | | | program/include/rcmail_output_html.php | |
| | | | | |
| | | | This file is part of the Roundcube Webmail client | |
| | | | Copyright (C) 2006-2013, The Roundcube Dev Team | |
| | | | Copyright (C) 2006-2014, The Roundcube Dev Team | |
| | | | | |
| | | | Licensed under the GNU General Public License version 3 or | |
| | | | any later version with exceptions for skins & plugins. | |
| | |
| | | { |
| | | public $type = 'html'; |
| | | |
| | | protected $message = null; |
| | | protected $js_env = array(); |
| | | protected $js_labels = array(); |
| | | protected $js_commands = array(); |
| | | protected $skin_paths = array(); |
| | | protected $message; |
| | | protected $template_name; |
| | | protected $js_env = array(); |
| | | protected $js_labels = array(); |
| | | protected $js_commands = array(); |
| | | protected $skin_paths = array(); |
| | | protected $scripts_path = ''; |
| | | protected $script_files = array(); |
| | | protected $css_files = array(); |
| | | protected $scripts = array(); |
| | | protected $css_files = array(); |
| | | protected $scripts = array(); |
| | | protected $default_template = "<html>\n<head><title></title></head>\n<body></body>\n</html>"; |
| | | protected $header = ''; |
| | | protected $footer = ''; |
| | |
| | | |
| | | /** |
| | | * Constructor |
| | | * |
| | | * @todo Replace $this->config with the real rcube_config object |
| | | */ |
| | | public function __construct($task = null, $framed = false) |
| | | { |
| | |
| | | |
| | | $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')); |
| | | $this->set_env('standard_windows', (bool) $this->config->get('standard_windows')); |
| | | $this->set_env('locale', $_SESSION['language']); |
| | | |
| | | // add cookie info |
| | | $this->set_env('cookie_domain', ini_get('session.cookie_domain')); |
| | |
| | | |
| | | if (!empty($_REQUEST['_extwin'])) |
| | | $this->set_env('extwin', 1); |
| | | if ($this->framed || !empty($_REQUEST['_framed'])) |
| | | if ($this->framed || $framed) |
| | | $this->set_env('framed', 1); |
| | | |
| | | $lic = <<<EOF |
| | |
| | | $valid = !$skin; |
| | | } |
| | | |
| | | $skin_path = rtrim($skin_path, '/'); |
| | | |
| | | $this->config->set('skin_path', $skin_path); |
| | | $this->base_path = $skin_path; |
| | | |
| | |
| | | // read meta file and check for dependecies |
| | | $meta = @file_get_contents(RCUBE_INSTALL_PATH . $skin_path . '/meta.json'); |
| | | $meta = @json_decode($meta, true); |
| | | |
| | | $meta['path'] = $skin_path; |
| | | $skin_id = end(explode('/', $skin_path)); |
| | | if (!$meta['name']) { |
| | | $meta['name'] = $skin_id; |
| | | } |
| | | $this->skins[$skin_id] = $meta; |
| | | |
| | | if ($meta['extends']) { |
| | | $path = RCUBE_INSTALL_PATH . 'skins/'; |
| | | if (is_dir($path . $meta['extends']) && is_readable($path . $meta['extends'])) { |
| | |
| | | public function get_skin_file($file, &$skin_path = null, $add_path = null) |
| | | { |
| | | $skin_paths = $this->skin_paths; |
| | | if ($add_path) |
| | | if ($add_path) { |
| | | array_unshift($skin_paths, $add_path); |
| | | } |
| | | |
| | | foreach ($skin_paths as $skin_path) { |
| | | $path = realpath($skin_path . $file); |
| | |
| | | { |
| | | $cmd = func_get_args(); |
| | | if (strpos($cmd[0], 'plugin.') !== false) |
| | | $this->js_commands[] = array('triggerEvent', $cmd[0], $cmd[1]); |
| | | $this->js_commands[] = array('triggerEvent', $cmd[0], $cmd[1]); |
| | | else |
| | | $this->js_commands[] = $cmd; |
| | | $this->js_commands[] = $cmd; |
| | | } |
| | | |
| | | /** |
| | |
| | | { |
| | | $args = func_get_args(); |
| | | if (count($args) == 1 && is_array($args[0])) |
| | | $args = $args[0]; |
| | | $args = $args[0]; |
| | | |
| | | foreach ($args as $name) { |
| | | $this->js_labels[$name] = $this->app->gettext($name); |
| | |
| | | public function reset($all = false) |
| | | { |
| | | $framed = $this->framed; |
| | | $env = $all ? null : array_intersect_key($this->env, array('extwin'=>1, 'framed'=>1)); |
| | | $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->env = $this->js_env = $env; |
| | | $this->framed = $framed || $this->env['framed']; |
| | | $this->js_labels = array(); |
| | | $this->js_commands = array(); |
| | | $this->script_files = array(); |
| | |
| | | */ |
| | | 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('iframe_loaded', $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()); |
| | | } |
| | | |
| | | if (!empty($this->script_files)) |
| | | $this->set_env('request_token', $this->app->get_request_token()); |
| | | $commands = $this->get_js_commands($framed); |
| | | |
| | | // write all env variables to client |
| | | if ($commands = $this->get_js_commands()) { |
| | | $js = $this->framed ? "if (window.parent) {\n" : ''; |
| | | $js .= $commands . ($this->framed ? ' }' : ''); |
| | | $this->add_script($js, 'head_top'); |
| | | // if all js commands go to parent window we can ignore all |
| | | // script files and skip rcube_webmail initialization (#1489792) |
| | | if ($framed) { |
| | | $this->scripts = array(); |
| | | $this->script_files = array(); |
| | | $this->header = ''; |
| | | $this->footer = ''; |
| | | } |
| | | |
| | | // write all javascript commands |
| | | $this->add_script($commands, 'head_top'); |
| | | |
| | | // send clickjacking protection headers |
| | | $iframe = $this->framed || !empty($_REQUEST['_framed']); |
| | | if (!headers_sent() && ($xframe = $this->app->config->get('x_frame_options', 'sameorigin'))) |
| | | $iframe = $this->framed || $this->env['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 |
| | | $this->_write($template, $this->config->get('skin_path')); |
| | |
| | | */ |
| | | function parse($name = 'main', $exit = true, $write = true) |
| | | { |
| | | $plugin = false; |
| | | $realname = $name; |
| | | $plugin = false; |
| | | $realname = $name; |
| | | $plugin_skin_paths = array(); |
| | | |
| | | $this->template_name = $realname; |
| | | |
| | | $temp = explode('.', $name, 2); |
| | | if (count($temp) > 1) { |
| | | $plugin = $temp[0]; |
| | | $name = $temp[1]; |
| | | $skin_dir = $plugin . '/skins/' . $this->config->get('skin'); |
| | | $plugin = $temp[0]; |
| | | $name = $temp[1]; |
| | | $skin_dir = $plugin . '/skins/' . $this->config->get('skin'); |
| | | |
| | | // apply skin search escalation list to plugin directory |
| | | $plugin_skin_paths = array(); |
| | | foreach ($this->skin_paths as $skin_path) { |
| | | $plugin_skin_paths[] = $this->app->plugins->url . $plugin . '/' . $skin_path; |
| | | } |
| | |
| | | $plugin_skin_paths[] = $this->app->plugins->url . $skin_dir; |
| | | } |
| | | |
| | | // add plugin skin paths to search list |
| | | // prepend plugin skin paths to search list |
| | | $this->skin_paths = array_merge($plugin_skin_paths, $this->skin_paths); |
| | | } |
| | | |
| | |
| | | 'file' => __FILE__, |
| | | 'message' => 'Error loading template for '.$realname |
| | | ), true, $write); |
| | | |
| | | $this->skin_paths = array_slice($this->skin_paths, count($plugin_skin_paths)); |
| | | return false; |
| | | } |
| | | |
| | |
| | | $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); |
| | | |
| | | // remove plugin skin paths from current context |
| | | $this->skin_paths = array_slice($this->skin_paths, count($plugin_skin_paths)); |
| | | |
| | | if (!$write) { |
| | | return $output; |
| | | } |
| | |
| | | * |
| | | * @return string $out |
| | | */ |
| | | protected function get_js_commands() |
| | | protected function get_js_commands(&$framed = null) |
| | | { |
| | | $out = ''; |
| | | $out = ''; |
| | | $parent_commands = 0; |
| | | $top_commands = array(); |
| | | |
| | | // these should be always on top, |
| | | // e.g. hide_message() below depends on env.framed |
| | | if (!$this->framed && !empty($this->js_env)) { |
| | | $out .= self::JS_OBJECT_NAME . '.set_env('.self::json_serialize($this->js_env).");\n"; |
| | | $top_commands[] = array('set_env', $this->js_env); |
| | | } |
| | | if (!empty($this->js_labels)) { |
| | | $this->command('add_label', $this->js_labels); |
| | | $top_commands[] = array('add_label', $this->js_labels); |
| | | } |
| | | foreach ($this->js_commands as $i => $args) { |
| | | |
| | | // unlock interface after iframe load |
| | | $unlock = preg_replace('/[^a-z0-9]/i', '', $_REQUEST['_unlock']); |
| | | if ($this->framed) { |
| | | $top_commands[] = array('iframe_loaded', $unlock); |
| | | } |
| | | else if ($unlock) { |
| | | $top_commands[] = array('hide_message', $unlock); |
| | | } |
| | | |
| | | $commands = array_merge($top_commands, $this->js_commands); |
| | | |
| | | foreach ($commands as $i => $args) { |
| | | $method = array_shift($args); |
| | | $parent = $this->framed || preg_match('/^parent\./', $method); |
| | | |
| | | foreach ($args as $i => $arg) { |
| | | $args[$i] = self::json_serialize($arg); |
| | | } |
| | | $parent = $this->framed || preg_match('/^parent\./', $method); |
| | | $out .= sprintf( |
| | | "%s.%s(%s);\n", |
| | | ($parent ? 'if(window.parent && parent.'.self::JS_OBJECT_NAME.') parent.' : '') . self::JS_OBJECT_NAME, |
| | | preg_replace('/^parent\./', '', $method), |
| | | implode(',', $args) |
| | | ); |
| | | |
| | | if ($parent) { |
| | | $parent_commands++; |
| | | $method = preg_replace('/^parent\./', '', $method); |
| | | $parent_prefix = 'if (window.parent && parent.' . self::JS_OBJECT_NAME . ') parent.'; |
| | | $method = $parent_prefix . self::JS_OBJECT_NAME . '.' . $method; |
| | | } |
| | | else { |
| | | $method = self::JS_OBJECT_NAME . '.' . $method; |
| | | } |
| | | |
| | | $out .= sprintf("%s(%s);\n", $method, implode(',', $args)); |
| | | } |
| | | |
| | | $framed = $parent_prefix && $parent_commands == count($commands); |
| | | |
| | | // make the output more compact if all commands go to parent window |
| | | if ($framed) { |
| | | $out = "if (window.parent && parent." . self::JS_OBJECT_NAME . ") {\n" |
| | | . str_replace($parent_prefix, "\tparent.", $out) |
| | | . "}\n"; |
| | | } |
| | | |
| | | return $out; |
| | |
| | | public function abs_url($str, $search_path = false) |
| | | { |
| | | if ($str[0] == '/') { |
| | | if ($search_path && ($file_url = $this->get_skin_file($str, $skin_path))) |
| | | if ($search_path && ($file_url = $this->get_skin_file($str, $skin_path))) { |
| | | return $file_url; |
| | | } |
| | | |
| | | return $this->base_path . $str; |
| | | } |
| | | else |
| | | return $str; |
| | | |
| | | return $str; |
| | | } |
| | | |
| | | /** |
| | |
| | | return ''; |
| | | } |
| | | |
| | | // localize title and summary attributes |
| | | if ($command != 'button' && !empty($attrib['title']) && $this->app->text_exists($attrib['title'])) { |
| | | $attrib['title'] = $this->app->gettext($attrib['title']); |
| | | } |
| | | if ($command != 'button' && !empty($attrib['summary']) && $this->app->text_exists($attrib['summary'])) { |
| | | $attrib['summary'] = $this->app->gettext($attrib['summary']); |
| | | } |
| | | |
| | | // execute command |
| | | switch ($command) { |
| | | // return a button |
| | |
| | | $attrib['name'] = $this->eval_expression($attrib['expression']); |
| | | |
| | | if ($attrib['name'] || $attrib['command']) { |
| | | // @FIXME: 'noshow' is useless, remove? |
| | | if ($attrib['noshow']) { |
| | | return ''; |
| | | } |
| | | |
| | | $vars = $attrib + array('product' => $this->config->get('product_name')); |
| | | unset($vars['name'], $vars['command']); |
| | | |
| | | $label = $this->app->gettext($attrib + array('vars' => $vars)); |
| | | $quoting = !empty($attrib['quoting']) ? strtolower($attrib['quoting']) : (rcube_utils::get_boolean((string)$attrib['html']) ? 'no' : ''); |
| | | |
| | | // 'noshow' can be used in skins to define new labels |
| | | if ($attrib['noshow']) { |
| | | return ''; |
| | | } |
| | | |
| | | switch ($quoting) { |
| | | case 'no': |
| | |
| | | */ |
| | | public function button($attrib) |
| | | { |
| | | static $s_button_count = 100; |
| | | static $s_button_count = 100; |
| | | static $disabled_actions = null; |
| | | |
| | | // these commands can be called directly via url |
| | | $a_static_commands = array('compose', 'list', 'preferences', 'folders', 'identities'); |
| | |
| | | return ''; |
| | | } |
| | | |
| | | |
| | | // try to find out the button type |
| | | if ($attrib['type']) { |
| | | $attrib['type'] = strtolower($attrib['type']); |
| | | if ($pos = strpos($attrib['type'], '-menuitem')) { |
| | | $attrib['type'] = substr($attrib['type'], 0, -9); |
| | | $menuitem = true; |
| | | } |
| | | } |
| | | else { |
| | | $attrib['type'] = ($attrib['image'] || $attrib['imagepas'] || $attrib['imageact']) ? 'image' : 'link'; |
| | |
| | | |
| | | $command = $attrib['command']; |
| | | |
| | | if ($attrib['task']) |
| | | $command = $attrib['task'] . '.' . $command; |
| | | if ($attrib['task']) { |
| | | $element = $command = $attrib['task'] . '.' . $command; |
| | | } |
| | | else { |
| | | $element = ($this->env['task'] ? $this->env['task'] . '.' : '') . $command; |
| | | } |
| | | |
| | | if ($disabled_actions === null) { |
| | | $disabled_actions = (array) $this->config->get('disabled_actions'); |
| | | } |
| | | |
| | | // remove buttons for disabled actions |
| | | if (in_array($element, $disabled_actions)) { |
| | | return ''; |
| | | } |
| | | |
| | | if (!$attrib['image']) { |
| | | $attrib['image'] = $attrib['imagepas'] ? $attrib['imagepas'] : $attrib['imageact']; |
| | |
| | | $attrib['role'] = 'button'; |
| | | } |
| | | if (!empty($attrib['class']) && !empty($attrib['classact']) || !empty($attrib['imagepas']) && !empty($attrib['imageact'])) { |
| | | if (array_key_exists('tabindex', $attrib)) |
| | | $attrib['data-tabindex'] = $attrib['tabindex']; |
| | | $attrib['tabindex'] = '-1'; // disable button by default |
| | | $attrib['aria-disabled'] = 'true'; |
| | | } |
| | |
| | | |
| | | // generate html code for button |
| | | if ($btn_content) { |
| | | $attrib_str = html::attrib_string($attrib, array_merge($link_attrib, array('data-*'))); |
| | | $attrib_str = html::attrib_string($attrib, $link_attrib); |
| | | $out = sprintf('<a%s>%s</a>', $attrib_str, $btn_content); |
| | | } |
| | | |
| | | if ($attrib['wrapper']) { |
| | | $out = html::tag($attrib['wrapper'], null, $out); |
| | | } |
| | | |
| | | if ($menuitem) { |
| | | $class = $attrib['menuitem-class'] ? ' class="' . $attrib['menuitem-class'] . '"' : ''; |
| | | $out = '<li role="menuitem"' . $class . '>' . $out . '</li>'; |
| | | } |
| | | |
| | | return $out; |
| | |
| | | $output = trim($templ); |
| | | |
| | | if (empty($output)) { |
| | | $output = $this->default_template; |
| | | $output = html::doctype('html5') . "\n" . $this->default_template; |
| | | $is_empty = true; |
| | | } |
| | | |
| | | // set default page title |
| | | if (empty($this->pagetitle)) { |
| | | $this->pagetitle = 'Roundcube Mail'; |
| | | } |
| | | |
| | | // declare page language |
| | | if (!empty($_SESSION['language'])) { |
| | | $lang = substr($_SESSION['language'], 0, 2); |
| | | $output = preg_replace('/<html/', '<html lang="' . html::quote($lang) . '"', $output, 1); |
| | | if (!headers_sent()) { |
| | | header('Content-Language: ' . $lang); |
| | | } |
| | | } |
| | | |
| | | // replace specialchars in content |
| | |
| | | */ |
| | | public function form_tag($attrib, $content = null) |
| | | { |
| | | if ($this->framed || !empty($_REQUEST['_framed'])) { |
| | | if ($this->framed || $this->env['framed']) { |
| | | $hiddenfield = new html_hiddenfield(array('name' => '_framed', 'value' => '1')); |
| | | $hidden = $hiddenfield->show(); |
| | | } |
| | |
| | | |
| | | // we already have a <form> tag |
| | | if ($attrib['form']) { |
| | | if ($this->framed || !empty($_REQUEST['_framed'])) |
| | | if ($this->framed || $this->env['framed']) |
| | | $hidden->add(array('name' => '_framed', 'value' => '1')); |
| | | return $hidden->show() . $content; |
| | | } |