From 0c259682f65eaaf23ea4ccb56a706d6baf3007e4 Mon Sep 17 00:00:00 2001 From: alecpl Date: Fri, 13 Apr 2012 08:52:02 +0000 Subject: - Merge devel-framework branch, resolved conflicts --- program/include/rcube_output_html.php | 1604 +++++++++++++++++++++++++++++++++ 1 file changed, 1604 insertions(+) create mode 100644 program/include/rcube_output_html.php (limited to 'program/include/rcube_output_html.php') diff --git a/program/include/rcube_output_html.php b/program/include/rcube_output_html.php new file mode 100644 index 000000000..a047aba45 --- /dev/null +++ b/program/include/rcube_output_html.php @@ -0,0 +1,1604 @@ + | + +-----------------------------------------------------------------------+ + + $Id$ + + */ + + +/** + * Class to create HTML page output using a skin template + * + * @package View + */ +class rcube_output_html extends rcube_output +{ + public $type = 'html'; + + protected $message = null; + protected $js_env = array(); + protected $js_labels = array(); + protected $js_commands = array(); + protected $plugin_skin_path; + protected $template_name; + protected $scripts_path = ''; + protected $script_files = array(); + protected $css_files = array(); + protected $scripts = array(); + protected $default_template = "\n\n\n"; + protected $header = ''; + protected $footer = ''; + protected $body = ''; + protected $base_path = ''; + + // deprecated names of templates used before 0.5 + protected $deprecated_templates = array( + 'contact' => 'showcontact', + 'contactadd' => 'addcontact', + 'contactedit' => 'editcontact', + 'identityedit' => 'editidentity', + 'messageprint' => 'printmessage', + ); + + /** + * Constructor + * + * @todo Replace $this->config with the real rcube_config object + */ + public function __construct($task = null, $framed = false) + { + parent::__construct(); + + //$this->framed = $framed; + $this->set_env('task', $task); + $this->set_env('x_frame_options', $this->config->get('x_frame_options', 'sameorigin')); + + // load the correct skin (in case user-defined) + $this->set_skin($this->config->get('skin')); + + // add common javascripts + $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) + $this->add_script(JS_OBJECT_NAME.'.init();', 'docready'); + + $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'), + 'aboutcontent' => array($this, 'about_content'), + )); + } + + + /** + * Set environment variable + * + * @param string Property name + * @param mixed Property value + * @param boolean True if this property should be added to client environment + */ + 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 string The page title + */ + protected function get_pagetitle() + { + if (!empty($this->pagetitle)) { + $title = $this->pagetitle; + } + else if ($this->env['task'] == 'login') { + $title = $this->app->gettext(array( + 'name' => 'welcome', + 'vars' => array('product' => $this->config->get('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->get('skin_path'); + if (!$skin_path) { + $skin_path = 'skins/default'; + } + $valid = !$skin; + } + + $this->config->set('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->get('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 GUI object to the client script + * + * @param string Object name + * @param string Object ID + * @return void + */ + public function add_gui_object($obj, $id) + { + $this->add_script(JS_OBJECT_NAME.".gui_object('$obj', '$id');"); + } + + + /** + * Call a client method + * + * @param string Method to call + * @param ... Additional arguments + */ + public function command() + { + $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() + { + $args = func_get_args(); + if (count($args) == 1 && is_array($args[0])) + $args = $args[0]; + + foreach ($args as $name) { + $this->js_labels[$name] = $this->app->gettext($name); + } + } + + + /** + * Invoke display_message command + * + * @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, $timeout=0) + { + if ($override || !$this->message) { + if ($this->app->text_exists($message)) { + if (!empty($vars)) + $vars = array_map('Q', $vars); + $msgtext = $this->app->gettext(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 + */ + public function reset() + { + parent::reset(); + $this->js_env = array(); + $this->js_labels = array(); + $this->js_commands = array(); + $this->script_files = array(); + $this->scripts = array(); + $this->header = ''; + $this->footer = ''; + $this->body = ''; + } + + + /** + * Redirect to a certain url + * + * @param mixed $p Either a string with the action or url parameters as key-value pairs + * @param int $delay Delay in seconds + */ + public function redirect($p = array(), $delay = 1) + { + $location = $this->app->url($p); + header('Location: ' . $location); + exit; + } + + + /** + * Send the request output to the client. + * This will either parse a skin tempalte or send an AJAX response + * + * @param string Template name + * @param boolean True if script should terminate (default) + */ + public function send($templ = null, $exit = true) + { + if ($templ != 'iframe') { + // prevent from endless loops + if ($exit != 'recur' && $this->app->plugins->is_processing('render_page')) { + rcube::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 { + $this->framed = $templ == 'iframe' ? true : $this->framed; + $this->write(); + } + + // set output asap + ob_flush(); + flush(); + + if ($exit) { + exit; + } + } + + + /** + * Process template and write to stdOut + * + * @param string $template HTML template content + */ + 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, 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 + $this->_write($template, $this->config->get('skin_path')); + } + + + /** + * Parse a specific skin template and deliver to stdout (or return) + * + * @param string Template name + * @param boolean Exit script + * @param boolean Don't write to stdout, return parsed content instead + * + * @link http://php.net/manual/en/function.exit.php + */ + function parse($name = 'main', $exit = true, $write = true) + { + $skin_path = $this->config->get('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->get('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; + } + } + + $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)) + rcube::raise_error(array('code' => 502, 'type' => 'php', + 'file' => __FILE__, 'line' => __LINE__, + 'message' => "Using deprecated template '".$this->deprecated_templates[$realname] + ."' in $skin_path/templates. Please rename to '".$realname."'"), + true, false); + } + + // read template file + if (($templ = @file_get_contents($path)) === false) { + rcube::raise_error(array( + 'code' => 501, + 'type' => 'php', + 'line' => __LINE__, + 'file' => __FILE__, + 'message' => 'Error loading template for '.$realname + ), 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 + $output = $this->parse_conditions($templ); + $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' => $realname, 'content' => $output)); + + // save some memory + $output = $hook['content']; + unset($hook['content']); + + $output = $this->parse_with_globals($output); + + // 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->get('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; + } + + if ($exit) { + exit; + } + } + + + /** + * Return executable javascript code for all registered commands + * + * @return string $out + */ + protected function get_js_commands() + { + $out = ''; + if (!$this->framed && !empty($this->js_env)) { + $out .= JS_OBJECT_NAME . '.set_env('.self::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) { + $args[$i] = self::json_serialize($arg); + } + $parent = $this->framed || preg_match('/^parent\./', $method); + $out .= sprintf( + "%s.%s(%s);\n", + ($parent ? 'if(window.parent && parent.'.JS_OBJECT_NAME.') parent.' : '') . JS_OBJECT_NAME, + preg_replace('/^parent\./', '', $method), + implode(',', $args) + ); + } + + return $out; + } + + + /** + * Make URLs starting with a slash point to skin directory + * + * @param string Input string + * @return string + */ + public function abs_url($str) + { + if ($str[0] == '/') + return $this->config->get('skin_path') . $str; + else + return $str; + } + + + /** + * Show error page and terminate script execution + * + * @param int $code Error code + * @param string $message Error message + */ + public function raise_error($code, $message) + { + global $__page_content, $ERROR_CODE, $ERROR_MESSAGE; + + $ERROR_CODE = $code; + $ERROR_MESSAGE = $message; + + include INSTALL_PATH . 'program/steps/utils/error.inc'; + exit; + } + + + /***** Template parsing methods *****/ + + /** + * Replace all strings ($varname) + * with the content of the according global variable. + */ + protected function parse_with_globals($input) + { + $GLOBALS['__version'] = html::quote(RCMAIL_VERSION); + $GLOBALS['__comm_path'] = html::quote($this->app->comm_path); + $GLOBALS['__skin_path'] = Q($this->config->get('skin_path')); + + return preg_replace_callback('/\$(__[a-z0-9_\-]+)/', + array($this, 'globals_callback'), $input); + } + + + /** + * Callback funtion for preg_replace_callback() in parse_with_globals() + */ + protected function globals_callback($matches) + { + return $GLOBALS[$matches[1]]; + } + + + /** + * Public wrapper to dipp into template parsing. + * + * @param string $input + * @return string + * @uses rcube_output_html::parse_xml() + * @since 0.1-rc1 + */ + public function just_parse($input) + { + return $this->parse_xml($input); + } + + + /** + * Parse for conditional tags + * + * @param string $input + * @return string + */ + protected function parse_conditions($input) + { + $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]); + } + $attrib = html::parse_attrib_string($matches[2]); + if (isset($attrib['condition'])) { + $condmet = $this->check_condition($attrib['condition']); + $submatches = preg_split('/]+)>\n?/is', $matches[3], 2, PREG_SPLIT_DELIM_CAPTURE); + if ($condmet) { + $result = $submatches[0]; + $result.= ($submatches[1] != 'endif' ? preg_replace('/.*]+>\n?/Uis', '', $submatches[3], 1) : $submatches[3]); + } + else { + $result = "" . $submatches[3]; + } + return $matches[0] . $this->parse_conditions($result); + } + rcube::raise_error(array( + 'code' => 500, + 'type' => 'php', + 'line' => __LINE__, + 'file' => __FILE__, + 'message' => "Unable to parse conditional tag " . $matches[2] + ), true, false); + } + return $input; + } + + + /** + * Determines if a given condition is met + * + * @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 if not + */ + protected function check_condition($condition) + { + return eval("return (".$this->parse_expression($condition).");"); + } + + + /** + * Inserts hidden field with CSRF-prevention-token into POST forms + */ + protected function alter_form_tag($matches) + { + $out = $matches[0]; + $attrib = html::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 + */ + protected function parse_expression($expression) + { + return preg_replace( + array( + '/session:([a-z0-9_]+)/i', + '/config:([a-z0-9_]+)(:([a-z0-9_]+))?/i', + '/env:([a-z0-9_]+)/i', + '/request:([a-z0-9_]+)/i', + '/cookie:([a-z0-9_]+)/i', + '/browser:([a-z0-9_]+)/i', + '/template:name/i', + ), + array( + "\$_SESSION['\\1']", + "\$this->app->config->get('\\1',get_boolean('\\3'))", + "\$this->env['\\1']", + "rcube_ui::get_input_value('\\1', rcube_ui::INPUT_GPC)", + "\$_COOKIE['\\1']", + "\$this->browser->{'\\1'}", + $this->template_name, + ), + $expression); + } + + + /** + * Search for special tags in input and replace them + * with the appropriate content + * + * @param string Input string to parse + * @return string Altered input string + * @todo Use DOM-parser to traverse template HTML + * @todo Maybe a cache. + */ + protected function parse_xml($input) + { + return preg_replace_callback('/]|\\\\>)+)(?/Ui', array($this, 'xml_command'), $input); + } + + + /** + * Callback function for parsing an xml command tag + * and turn it into real html content + * + * @param array Matches array of preg_replace_callback + * @return string Tag/Object content + */ + protected function xml_command($matches) + { + $command = strtolower($matches[1]); + $attrib = html::parse_attrib_string($matches[2]); + + // empty output if required condition is not met + if (!empty($attrib['condition']) && !$this->check_condition($attrib['condition'])) { + return ''; + } + + // execute command + switch ($command) { + // return a button + case 'button': + if ($attrib['name'] || $attrib['command']) { + return $this->button($attrib); + } + break; + + // show a label + case 'label': + if ($attrib['name'] || $attrib['command']) { + $vars = $attrib + array('product' => $this->config->get('product_name')); + unset($vars['name'], $vars['command']); + $label = $this->app->gettext($attrib + array('vars' => $vars)); + return !$attrib['noshow'] ? (get_boolean((string)$attrib['html']) ? $label : html::quote($label)) : ''; + } + break; + + // include a file + case 'include': + 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->get('skin_path')).$attrib['file']); + + if (is_readable($path)) { + if ($this->config->get('skin_include_php')) { + $incl = $this->include_php($path); + } + else { + $incl = file_get_contents($path); + } + $incl = $this->parse_conditions($incl); + return $this->parse_xml($incl); + } + break; + + case 'plugin.include': + $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]))) + $content = call_user_func($handler, $attrib); + } + // execute object handler function + 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 ($logo = $this->config->get('skin_logo')) + $attrib['src'] = $logo; + $content = html::img($attrib); + } + else if ($object == 'productname') { + $name = $this->config->get('product_name', 'Roundcube Webmail'); + $content = html::quote($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].']'; + } + $content = html::quote($ver); + } + else if ($object == 'steptitle') { + $content = html::quote($this->get_pagetitle()); + } + else if ($object == 'pagetitle') { + if ($this->config->get('devel_mode') && !empty($_SESSION['username'])) + $title = $_SESSION['username'].' :: '; + else if ($prod_name = $this->config->get('product_name')) + $title = $prod_name . ' :: '; + else + $title = ''; + $title .= $this->get_pagetitle(); + $content = html::quote($title); + } + + // 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 html::quote($value);"); + + // return variable + case 'var': + $var = explode(':', $attrib['name']); + $name = $var[1]; + $value = ''; + + switch ($var[0]) { + case 'env': + $value = $this->env[$name]; + break; + case 'config': + $value = $this->config->get($name); + if (is_array($value) && $value[$_SESSION['storage_host']]) { + $value = $value[$_SESSION['storage_host']]; + } + break; + case 'request': + $value = rcube_ui::get_input_value($name, rcube_ui::INPUT_GPC); + break; + case 'session': + $value = $_SESSION[$name]; + break; + case 'cookie': + $value = htmlspecialchars($_COOKIE[$name]); + break; + case 'browser': + $value = $this->browser->{$name}; + break; + } + + if (is_array($value)) { + $value = implode(', ', $value); + } + + return html::quote($value); + break; + } + return ''; + } + + + /** + * Include a specific file and return it's contents + * + * @param string File path + * @return string Contents of the processed file + */ + protected function include_php($file) + { + ob_start(); + include $file; + $out = ob_get_contents(); + ob_end_clean(); + + return $out; + } + + + /** + * Create and register a button + * + * @param array Named button attributes + * @return string HTML button + * @todo Remove all inline JS calls and use jQuery instead. + * @todo Remove all sprintf()'s - they are pretty, but also slow. + */ + public function button($attrib) + { + static $s_button_count = 100; + + // these commands can be called directly via url + $a_static_commands = array('compose', 'list', 'preferences', 'folders', 'identities'); + + if (!($attrib['command'] || $attrib['name'])) { + return ''; + } + + // try to find out the button type + if ($attrib['type']) { + $attrib['type'] = strtolower($attrib['type']); + } + else { + $attrib['type'] = ($attrib['image'] || $attrib['imagepas'] || $attrib['imageact']) ? 'image' : 'link'; + } + + $command = $attrib['command']; + + if ($attrib['task']) + $command = $attrib['task'] . '.' . $command; + + 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'] = html::quote($this->app->gettext($attrib['title'], $attrib['domain'])); + } + if ($attrib['label']) { + $attrib['label'] = html::quote($this->app->gettext($attrib['label'], $attrib['domain'])); + } + if ($attrib['alt']) { + $attrib['alt'] = html::quote($this->app->gettext($attrib['alt'], $attrib['domain'])); + } + + // set title to alt attribute for IE browsers + if ($this->browser->ie && !$attrib['title'] && $attrib['alt']) { + $attrib['title'] = $attrib['alt']; + } + + // add empty alt attribute for XHTML compatibility + if (!isset($attrib['alt'])) { + $attrib['alt'] = ''; + } + + // register button in the system + if ($attrib['command']) { + $this->add_script(sprintf( + "%s.register_button('%s', '%s', '%s', '%s', '%s', '%s');", + JS_OBJECT_NAME, + $command, + $attrib['id'], + $attrib['type'], + $attrib['imageact'] ? $this->abs_url($attrib['imageact']) : $attrib['classact'], + $attrib['imagesel'] ? $this->abs_url($attrib['imagesel']) : $attrib['classsel'], + $attrib['imageover'] ? $this->abs_url($attrib['imageover']) : '' + )); + + // make valid href to specific buttons + if (in_array($attrib['command'], rcmail::$main_tasks)) { + $attrib['href'] = $this->app->url(array('task' => $attrib['command'])); + $attrib['onclick'] = sprintf("%s.command('switch-task','%s');return false", JS_OBJECT_NAME, $attrib['command']); + } + else if ($attrib['task'] && in_array($attrib['task'], rcmail::$main_tasks)) { + $attrib['href'] = $this->app->url(array('action' => $attrib['command'], 'task' => $attrib['task'])); + } + else if (in_array($attrib['command'], $a_static_commands)) { + $attrib['href'] = $this->app->url(array('action' => $attrib['command'])); + } + else if ($attrib['command'] == 'permaurl' && !empty($this->env['permaurl'])) { + $attrib['href'] = $this->env['permaurl']; + } + } + + // overwrite attributes + if (!$attrib['href']) { + $attrib['href'] = '#'; + } + 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, + $command, + $attrib['prop'] + ); + } + + $out = ''; + + // generate image tag + if ($attrib['type'] == 'image') { + $attrib_str = html::attrib_string( + $attrib, + array( + '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', 'target'); + } + 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'; + + if ($attrib['label']) { + $attrib['value'] = $attrib['label']; + } + if ($attrib['command']) { + $attrib['disabled'] = 'disabled'; + } + + $out = html::tag('input', $attrib, null, array('type', 'value', 'onclick', 'id', 'class', 'style', 'tabindex', 'disabled')); + } + + // generate html code for button + if ($btn_content) { + $attrib_str = html::attrib_string($attrib, $link_attrib); + $out = sprintf('%s', $attrib_str, $btn_content); + } + + return $out; + } + + + /** + * Link an external script file + * + * @param string File URL + * @param string Target position [head|foot] + */ + 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; + } + } + + 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; + } + + + /** + * Add inline javascript code + * + * @param string JS code snippet + * @param string Target position [head|head_top|foot] + */ + public function add_script($script, $position='head') + { + if (!isset($this->scripts[$position])) { + $this->scripts[$position] = "\n" . rtrim($script); + } + else { + $this->scripts[$position] .= "\n" . rtrim($script); + } + } + + + /** + * Link an external css file + * + * @param string File URL + */ + public function include_css($file) + { + $this->css_files[] = $file; + } + + + /** + * Add HTML code to the page header + * + * @param string $str HTML code + */ + public function add_header($str) + { + $this->header .= "\n" . $str; + } + + + /** + * Add HTML code to the page footer + * To be added right befor + * + * @param string $str HTML code + */ + public function add_footer($str) + { + $this->footer .= "\n" . $str; + } + + + /** + * Process template and write to stdOut + * + * @param string HTML template + * @param string Base for absolute paths + */ + public function _write($templ = '', $base_path = '') + { + $output = empty($templ) ? $this->default_template : trim($templ); + + // set default page title + if (empty($this->pagetitle)) { + $this->pagetitle = 'Roundcube Mail'; + } + + // replace specialchars in content + $page_title = html::quote($this->pagetitle); + $page_header = ''; + $page_footer = ''; + + // include meta tag with charset + if (!empty($this->charset)) { + if (!headers_sent()) { + header('Content-Type: text/html; charset=' . $this->charset); + } + $page_header = 'charset . '" />'."\n"; + } + + // definition of the code to be placed in the document header and footer + if (is_array($this->script_files['head'])) { + foreach ($this->script_files['head'] as $file) { + $page_header .= html::script($file); + } + } + + $head_script = $this->scripts['head_top'] . $this->scripts['head']; + if (!empty($head_script)) { + $page_header .= html::script(array(), $head_script); + } + + if (!empty($this->header)) { + $page_header .= $this->header; + } + + // put docready commands into page footer + if (!empty($this->scripts['docready'])) { + $this->add_script('$(document).ready(function(){ ' . $this->scripts['docready'] . "\n});", 'foot'); + } + + if (is_array($this->script_files['foot'])) { + foreach ($this->script_files['foot'] as $file) { + $page_footer .= html::script($file); + } + } + + if (!empty($this->footer)) { + $page_footer .= $this->footer . "\n"; + } + + if (!empty($this->scripts['foot'])) { + $page_footer .= html::script(array(), $this->scripts['foot']); + } + + // find page header + if ($hpos = stripos($output, '')) { + $page_header .= "\n"; + } + else { + if (!is_numeric($hpos)) { + $hpos = stripos($output, '')) || ($fpos = strripos($output, ''))) { + $output = substr_replace($output, $page_footer."\n", $fpos, 0); + } + else { + $output .= "\n".$page_footer; + } + + // add css files in head, before scripts, for speed up with parallel downloads + if (!empty($this->css_files) && + (($pos = stripos($output, '