4 +-----------------------------------------------------------------------+
5 | program/include/rcube_template.php |
7 | This file is part of the Roundcube Webmail client |
8 | Copyright (C) 2006-2010, Roundcube Dev. - Switzerland |
9 | Licensed under the GNU GPL |
12 | Class to handle HTML page output using a skin template. |
13 | Extends rcube_html_page class from rcube_shared.inc |
15 +-----------------------------------------------------------------------+
16 | Author: Thomas Bruederli <roundcube@gmail.com> |
17 +-----------------------------------------------------------------------+
19 $Id: rcube_template.php 4509 2011-02-09 10:51:50Z thomasb $
25 * Class to create HTML page output using a skin template
29 * @uses rcube_html_page
31 class rcube_template extends rcube_html_page
35 private $pagetitle = '';
36 private $message = null;
37 private $js_env = array();
38 private $js_commands = array();
39 private $object_handlers = array();
40 private $plugin_skin_path;
43 public $framed = false;
44 public $env = array();
45 public $type = 'html';
46 public $ajax_call = false;
48 // deprecated names of templates used before 0.5
49 private $deprecated_templates = array(
50 'contact' => 'showcontact',
51 'contactadd' => 'addcontact',
52 'contactedit' => 'editcontact',
53 'identityedit' => 'editidentity',
54 'messageprint' => 'printmessage',
60 * @todo Use jQuery's $(document).ready() here.
61 * @todo Replace $this->config with the real rcube_config object
63 public function __construct($task, $framed = false)
65 parent::__construct();
67 $this->app = rcmail::get_instance();
68 $this->config = $this->app->config->all();
69 $this->browser = new rcube_browser();
71 //$this->framed = $framed;
72 $this->set_env('task', $task);
73 $this->set_env('request_token', $this->app->get_request_token());
75 // load the correct skin (in case user-defined)
76 $this->set_skin($this->config['skin']);
78 // add common javascripts
79 $javascript = 'var '.JS_OBJECT_NAME.' = new rcube_webmail();';
81 // don't wait for page onload. Call init at the bottom of the page (delayed)
82 $javascript_foot = '$(document).ready(function(){ '.JS_OBJECT_NAME.'.init(); });';
84 $this->add_script($javascript, 'head_top');
85 $this->add_script($javascript_foot, 'foot');
86 $this->scripts_path = 'program/js/';
87 $this->include_script('jquery-1.4.min.js');
88 $this->include_script('common.js');
89 $this->include_script('app.js');
91 // register common UI objects
92 $this->add_handlers(array(
93 'loginform' => array($this, 'login_form'),
94 'preloader' => array($this, 'preloader'),
95 'username' => array($this, 'current_username'),
96 'message' => array($this, 'message_container'),
97 'charsetselector' => array($this, 'charset_selector'),
102 * Set environment variable
104 * @param string Property name
105 * @param mixed Property value
106 * @param boolean True if this property should be added to client environment
108 public function set_env($name, $value, $addtojs = true)
110 $this->env[$name] = $value;
111 if ($addtojs || isset($this->js_env[$name])) {
112 $this->js_env[$name] = $value;
118 * Set page title variable
120 public function set_pagetitle($title)
122 $this->pagetitle = $title;
127 * Getter for the current page title
129 * @return string The page title
131 public function get_pagetitle()
133 if (!empty($this->pagetitle)) {
134 $title = $this->pagetitle;
136 else if ($this->env['task'] == 'login') {
137 $title = rcube_label(array('name' => 'welcome', 'vars' => array('product' => $this->config['product_name'])));
140 $title = ucfirst($this->env['task']);
150 public function set_skin($skin)
154 if (!empty($skin) && is_dir('skins/'.$skin) && is_readable('skins/'.$skin)) {
155 $skin_path = 'skins/'.$skin;
159 $skin_path = $this->config['skin_path'] ? $this->config['skin_path'] : 'skins/default';
163 $this->app->config->set('skin_path', $skin_path);
164 $this->config['skin_path'] = $skin_path;
170 * Check if a specific template exists
172 * @param string Template name
173 * @return boolean True if template exists
175 public function template_exists($name)
177 $filename = $this->config['skin_path'] . '/templates/' . $name . '.html';
178 return (is_file($filename) && is_readable($filename)) || ($this->deprecated_templates[$name] && $this->template_exists($this->deprecated_templates[$name]));
182 * Register a template object handler
184 * @param string Object name
185 * @param string Function name to call
188 public function add_handler($obj, $func)
190 $this->object_handlers[$obj] = $func;
194 * Register a list of template object handlers
196 * @param array Hash array with object=>handler pairs
199 public function add_handlers($arr)
201 $this->object_handlers = array_merge($this->object_handlers, $arr);
205 * Register a GUI object to the client script
207 * @param string Object name
208 * @param string Object ID
211 public function add_gui_object($obj, $id)
213 $this->add_script(JS_OBJECT_NAME.".gui_object('$obj', '$id');");
217 * Call a client method
219 * @param string Method to call
220 * @param ... Additional arguments
222 public function command()
224 $cmd = func_get_args();
225 if (strpos($cmd[0], 'plugin.') === false)
226 $this->js_commands[] = $cmd;
231 * Add a localized label to the client environment
233 public function add_label()
235 $args = func_get_args();
236 if (count($args) == 1 && is_array($args[0]))
239 foreach ($args as $name) {
240 $this->command('add_label', $name, rcube_label($name));
246 * Invoke display_message command
248 * @param string Message to display
249 * @param string Message type [notice|confirm|error]
250 * @param array Key-value pairs to be replaced in localized text
251 * @param boolean Override last set message
252 * @uses self::command()
254 public function show_message($message, $type='notice', $vars=null, $override=true)
256 if ($override || !$this->message) {
257 $this->message = $message;
260 rcube_label(array('name' => $message, 'vars' => $vars)),
267 * Delete all stored env variables and commands
270 * @uses rcube_html::reset()
272 * @uses self::$js_env
273 * @uses self::$js_commands
274 * @uses self::$object_handlers
276 public function reset()
278 $this->env = array();
279 $this->js_env = array();
280 $this->js_commands = array();
281 $this->object_handlers = array();
287 * Redirect to a certain url
289 * @param mixed Either a string with the action or url parameters as key-value pairs
292 public function redirect($p = array())
294 $location = $this->app->url($p);
295 header('Location: ' . $location);
301 * Send the request output to the client.
302 * This will either parse a skin tempalte or send an AJAX response
304 * @param string Template name
305 * @param boolean True if script should terminate (default)
307 public function send($templ = null, $exit = true)
309 if ($templ != 'iframe') {
310 // prevent from endless loops
311 if ($exit != 'recur' && $this->app->plugins->is_processing('render_page')) {
312 raise_error(array('code' => 505, 'type' => 'php',
313 'file' => __FILE__, 'line' => __LINE__,
314 'message' => 'Recursion alert: ignoring output->send()'), true, false);
317 $this->parse($templ, false);
320 $this->framed = $templ == 'iframe' ? true : $this->framed;
334 * Process template and write to stdOut
336 * @param string HTML template
337 * @see rcube_html_page::write()
340 public function write($template = '')
342 // unlock interface after iframe load
343 $unlock = preg_replace('/[^a-z0-9]/i', '', $_GET['_unlock']);
345 array_unshift($this->js_commands, array('set_busy', false, null, $unlock));
348 array_unshift($this->js_commands, array('hide_message', $unlock));
350 // write all env variables to client
351 $js = $this->framed ? "if(window.parent) {\n" : '';
352 $js .= $this->get_js_commands() . ($this->framed ? ' }' : '');
353 $this->add_script($js, 'head_top');
355 // make sure all <form> tags have a valid request token
356 $template = preg_replace_callback('/<form\s+([^>]+)>/Ui', array($this, 'alter_form_tag'), $template);
357 $this->footer = preg_replace_callback('/<form\s+([^>]+)>/Ui', array($this, 'alter_form_tag'), $this->footer);
360 parent::write($template, $this->config['skin_path']);
364 * Parse a specific skin template and deliver to stdout
366 * Either returns nothing, or exists hard (exit();)
368 * @param string Template name
369 * @param boolean Exit script
371 * @link http://php.net/manual/en/function.exit.php
373 private function parse($name = 'main', $exit = true)
375 $skin_path = $this->config['skin_path'];
377 $this->plugin_skin_path = null;
379 $temp = explode(".", $name, 2);
380 if (count($temp) > 1) {
383 $skin_dir = $plugin . '/skins/' . $this->config['skin'];
384 $skin_path = $this->plugin_skin_path = $this->app->plugins->dir . $skin_dir;
385 if (!is_dir($skin_path)) { // fallback to default skin
386 $skin_dir = $plugin . '/skins/default';
387 $skin_path = $this->plugin_skin_path = $this->app->plugins->dir . $skin_dir;
391 $path = "$skin_path/templates/$name.html";
393 if (!is_readable($path) && $this->deprecated_templates[$name]) {
394 $path = "$skin_path/templates/".$this->deprecated_templates[$name].".html";
395 if (is_readable($path))
396 raise_error(array('code' => 502, 'type' => 'php',
397 'file' => __FILE__, 'line' => __LINE__,
398 'message' => "Using deprecated template '".$this->deprecated_templates[$name]."' in ".$this->config['skin_path']."/templates. Please rename to '".$name."'"),
402 // read template file
403 if (($templ = @file_get_contents($path)) === false) {
409 'message' => 'Error loading template for '.$name
414 // replace all path references to plugins/... with the configured plugins dir
415 // and /this/ to the current plugin skin directory
417 $templ = preg_replace(array('/\bplugins\//', '/(["\']?)\/this\//'), array($this->app->plugins->url, '\\1'.$this->app->plugins->url.$skin_dir.'/'), $templ);
420 // parse for specialtags
421 $output = $this->parse_conditions($templ);
422 $output = $this->parse_xml($output);
424 // trigger generic hook where plugins can put additional content to the page
425 $hook = $this->app->plugins->exec_hook("render_page", array('template' => $name, 'content' => $output));
428 if ($this->config['debug_level'] & 8) {
429 $this->add_footer('<div id="console" style="position:absolute;top:5px;left:5px;width:405px;padding:2px;background:white;z-index:9000;">
430 <a href="#toggle" onclick="con=$(\'#dbgconsole\');con[con.is(\':visible\')?\'hide\':\'show\']();return false">console</a>
431 <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>'
435 $output = $this->parse_with_globals($hook['content']);
436 $this->write(trim($output));
444 * Return executable javascript code for all registered commands
446 * @return string $out
448 private function get_js_commands()
451 if (!$this->framed && !empty($this->js_env)) {
452 $out .= JS_OBJECT_NAME . '.set_env('.json_serialize($this->js_env).");\n";
454 foreach ($this->js_commands as $i => $args) {
455 $method = array_shift($args);
456 foreach ($args as $i => $arg) {
457 $args[$i] = json_serialize($arg);
459 $parent = $this->framed || preg_match('/^parent\./', $method);
462 ($parent ? 'if(window.parent && parent.'.JS_OBJECT_NAME.') parent.' : '') . JS_OBJECT_NAME,
463 preg_replace('/^parent\./', '', $method),
472 * Make URLs starting with a slash point to skin directory
474 * @param string Input string
477 public function abs_url($str)
480 return $this->config['skin_path'] . $str;
486 /***** Template parsing methods *****/
489 * Replace all strings ($varname)
490 * with the content of the according global variable.
492 private function parse_with_globals($input)
494 $GLOBALS['__version'] = Q(RCMAIL_VERSION);
495 $GLOBALS['__comm_path'] = Q($this->app->comm_path);
496 return preg_replace_callback('/\$(__[a-z0-9_\-]+)/',
497 array($this, 'globals_callback'), $input);
501 * Callback funtion for preg_replace_callback() in parse_with_globals()
503 private function globals_callback($matches)
505 return $GLOBALS[$matches[1]];
509 * Public wrapper to dipp into template parsing.
511 * @param string $input
513 * @uses rcube_template::parse_xml()
516 public function just_parse($input)
518 return $this->parse_xml($input);
522 * Parse for conditional tags
524 * @param string $input
527 private function parse_conditions($input)
529 $matches = preg_split('/<roundcube:(if|elseif|else|endif)\s+([^>]+)>\n?/is', $input, 2, PREG_SPLIT_DELIM_CAPTURE);
530 if ($matches && count($matches) == 4) {
531 if (preg_match('/^(else|endif)$/i', $matches[1])) {
532 return $matches[0] . $this->parse_conditions($matches[3]);
534 $attrib = parse_attrib_string($matches[2]);
535 if (isset($attrib['condition'])) {
536 $condmet = $this->check_condition($attrib['condition']);
537 $submatches = preg_split('/<roundcube:(elseif|else|endif)\s+([^>]+)>\n?/is', $matches[3], 2, PREG_SPLIT_DELIM_CAPTURE);
539 $result = $submatches[0];
540 $result.= ($submatches[1] != 'endif' ? preg_replace('/.*<roundcube:endif\s+[^>]+>\n?/Uis', '', $submatches[3], 1) : $submatches[3]);
543 $result = "<roundcube:$submatches[1] $submatches[2]>" . $submatches[3];
545 return $matches[0] . $this->parse_conditions($result);
552 'message' => "Unable to parse conditional tag " . $matches[2]
560 * Determines if a given condition is met
562 * @todo Get rid off eval() once I understand what this does.
563 * @todo Extend this to allow real conditions, not just "set"
564 * @param string Condition statement
565 * @return boolean True if condition is met, False if not
567 private function check_condition($condition)
569 return eval("return (".$this->parse_expression($condition).");");
574 * Inserts hidden field with CSRF-prevention-token into POST forms
576 private function alter_form_tag($matches)
579 $attrib = parse_attrib_string($matches[1]);
581 if (strtolower($attrib['method']) == 'post') {
582 $hidden = new html_hiddenfield(array('name' => '_token', 'value' => $this->app->get_request_token()));
583 $out .= "\n" . $hidden->show();
591 * Parses expression and replaces variables
593 * @param string Expression statement
594 * @return string Expression value
596 private function parse_expression($expression)
600 '/session:([a-z0-9_]+)/i',
601 '/config:([a-z0-9_]+)(:([a-z0-9_]+))?/i',
602 '/env:([a-z0-9_]+)/i',
603 '/request:([a-z0-9_]+)/i',
604 '/cookie:([a-z0-9_]+)/i',
605 '/browser:([a-z0-9_]+)/i'
609 "\$this->app->config->get('\\1',get_boolean('\\3'))",
610 "\$this->env['\\1']",
611 "get_input_value('\\1', RCUBE_INPUT_GPC)",
613 "\$this->browser->{'\\1'}"
620 * Search for special tags in input and replace them
621 * with the appropriate content
623 * @param string Input string to parse
624 * @return string Altered input string
625 * @todo Use DOM-parser to traverse template HTML
626 * @todo Maybe a cache.
628 private function parse_xml($input)
630 return preg_replace_callback('/<roundcube:([-_a-z]+)\s+([^>]+)>/Ui', array($this, 'xml_command'), $input);
635 * Callback function for parsing an xml command tag
636 * and turn it into real html content
638 * @param array Matches array of preg_replace_callback
639 * @return string Tag/Object content
641 private function xml_command($matches)
643 $command = strtolower($matches[1]);
644 $attrib = parse_attrib_string($matches[2]);
646 // empty output if required condition is not met
647 if (!empty($attrib['condition']) && !$this->check_condition($attrib['condition'])) {
655 if ($attrib['name'] || $attrib['command']) {
656 return $this->button($attrib);
662 if ($attrib['name'] || $attrib['command']) {
663 return Q(rcube_label($attrib + array('vars' => array('product' => $this->config['product_name']))));
669 if (!$this->plugin_skin_path || !is_file($path = realpath($this->plugin_skin_path . $attrib['file'])))
670 $path = realpath(($attrib['skin_path'] ? $attrib['skin_path'] : $this->config['skin_path']).$attrib['file']);
672 if (is_readable($path)) {
673 if ($this->config['skin_include_php']) {
674 $incl = $this->include_php($path);
677 $incl = file_get_contents($path);
679 $incl = $this->parse_conditions($incl);
680 return $this->parse_xml($incl);
684 case 'plugin.include':
685 $hook = $this->app->plugins->exec_hook("template_plugin_include", $attrib);
686 return $hook['content'];
689 // define a container block
691 if ($attrib['name'] && $attrib['id']) {
692 $this->command('gui_container', $attrib['name'], $attrib['id']);
693 // let plugins insert some content here
694 $hook = $this->app->plugins->exec_hook("template_container", $attrib);
695 return $hook['content'];
699 // return code for a specific application object
701 $object = strtolower($attrib['name']);
704 // we are calling a class/method
705 if (($handler = $this->object_handlers[$object]) && is_array($handler)) {
706 if ((is_object($handler[0]) && method_exists($handler[0], $handler[1])) ||
707 (is_string($handler[0]) && class_exists($handler[0])))
708 $content = call_user_func($handler, $attrib);
710 // execute object handler function
711 else if (function_exists($handler)) {
712 $content = call_user_func($handler, $attrib);
714 else if ($object == 'productname') {
715 $name = !empty($this->config['product_name']) ? $this->config['product_name'] : 'Roundcube Webmail';
718 else if ($object == 'version') {
719 $ver = (string)RCMAIL_VERSION;
720 if (is_file(INSTALL_PATH . '.svn/entries')) {
721 if (preg_match('/Revision:\s(\d+)/', @shell_exec('svn info'), $regs))
722 $ver .= ' [SVN r'.$regs[1].']';
726 else if ($object == 'steptitle') {
727 $content = Q($this->get_pagetitle());
729 else if ($object == 'pagetitle') {
730 $title = !empty($this->config['product_name']) ? $this->config['product_name'].' :: ' : '';
731 $title .= $this->get_pagetitle();
732 $content = Q($title);
735 // exec plugin hooks for this template object
736 $hook = $this->app->plugins->exec_hook("template_object_$object", $attrib + array('content' => $content));
737 return $hook['content'];
739 // return code for a specified eval expression
741 $value = $this->parse_expression($attrib['expression']);
742 return eval("return Q($value);");
746 $var = explode(':', $attrib['name']);
752 $value = $this->env[$name];
755 $value = $this->config[$name];
756 if (is_array($value) && $value[$_SESSION['imap_host']]) {
757 $value = $value[$_SESSION['imap_host']];
761 $value = get_input_value($name, RCUBE_INPUT_GPC);
764 $value = $_SESSION[$name];
767 $value = htmlspecialchars($_COOKIE[$name]);
770 $value = $this->browser->{$name};
774 if (is_array($value)) {
775 $value = implode(', ', $value);
785 * Include a specific file and return it's contents
787 * @param string File path
788 * @return string Contents of the processed file
790 private function include_php($file)
794 $out = ob_get_contents();
801 * Create and register a button
803 * @param array Named button attributes
804 * @return string HTML button
805 * @todo Remove all inline JS calls and use jQuery instead.
806 * @todo Remove all sprintf()'s - they are pretty, but also slow.
808 public function button($attrib)
810 static $s_button_count = 100;
812 // these commands can be called directly via url
813 $a_static_commands = array('compose', 'list', 'preferences', 'folders', 'identities');
815 if (!($attrib['command'] || $attrib['name'])) {
819 // try to find out the button type
820 if ($attrib['type']) {
821 $attrib['type'] = strtolower($attrib['type']);
824 $attrib['type'] = ($attrib['image'] || $attrib['imagepas'] || $attrib['imageact']) ? 'image' : 'link';
827 $command = $attrib['command'];
830 $command = $attrib['task'] . '.' . $command;
832 if (!$attrib['image']) {
833 $attrib['image'] = $attrib['imagepas'] ? $attrib['imagepas'] : $attrib['imageact'];
836 if (!$attrib['id']) {
837 $attrib['id'] = sprintf('rcmbtn%d', $s_button_count++);
839 // get localized text for labels and titles
840 if ($attrib['title']) {
841 $attrib['title'] = Q(rcube_label($attrib['title'], $attrib['domain']));
843 if ($attrib['label']) {
844 $attrib['label'] = Q(rcube_label($attrib['label'], $attrib['domain']));
846 if ($attrib['alt']) {
847 $attrib['alt'] = Q(rcube_label($attrib['alt'], $attrib['domain']));
850 // set title to alt attribute for IE browsers
851 if ($this->browser->ie && !$attrib['title'] && $attrib['alt']) {
852 $attrib['title'] = $attrib['alt'];
855 // add empty alt attribute for XHTML compatibility
856 if (!isset($attrib['alt'])) {
860 // register button in the system
861 if ($attrib['command']) {
862 $this->add_script(sprintf(
863 "%s.register_button('%s', '%s', '%s', '%s', '%s', '%s');",
868 $attrib['imageact'] ? $this->abs_url($attrib['imageact']) : $attrib['classact'],
869 $attrib['imagesel'] ? $this->abs_url($attrib['imagesel']) : $attrib['classsel'],
870 $attrib['imageover'] ? $this->abs_url($attrib['imageover']) : ''
873 // make valid href to specific buttons
874 if (in_array($attrib['command'], rcmail::$main_tasks)) {
875 $attrib['href'] = rcmail_url(null, null, $attrib['command']);
877 else if ($attrib['task'] && in_array($attrib['task'], rcmail::$main_tasks)) {
878 $attrib['href'] = rcmail_url($attrib['command'], null, $attrib['task']);
880 else if (in_array($attrib['command'], $a_static_commands)) {
881 $attrib['href'] = rcmail_url($attrib['command']);
883 else if ($attrib['command'] == 'permaurl' && !empty($this->env['permaurl'])) {
884 $attrib['href'] = $this->env['permaurl'];
888 // overwrite attributes
889 if (!$attrib['href']) {
890 $attrib['href'] = '#';
892 if ($attrib['task']) {
893 if ($attrib['classact'])
894 $attrib['class'] = $attrib['classact'];
896 else if ($command && !$attrib['onclick']) {
897 $attrib['onclick'] = sprintf(
898 "return %s.command('%s','%s',this)",
907 // generate image tag
908 if ($attrib['type']=='image') {
909 $attrib_str = html::attrib_string(
912 'style', 'class', 'id', 'width', 'height', 'border', 'hspace',
913 'vspace', 'align', 'alt', 'tabindex', 'title'
916 $btn_content = sprintf('<img src="%s"%s />', $this->abs_url($attrib['image']), $attrib_str);
917 if ($attrib['label']) {
918 $btn_content .= ' '.$attrib['label'];
920 $link_attrib = array('href', 'onclick', 'onmouseover', 'onmouseout', 'onmousedown', 'onmouseup', 'target');
922 else if ($attrib['type']=='link') {
923 $btn_content = isset($attrib['content']) ? $attrib['content'] : ($attrib['label'] ? $attrib['label'] : $attrib['command']);
924 $link_attrib = array('href', 'onclick', 'title', 'id', 'class', 'style', 'tabindex', 'target');
926 else if ($attrib['type']=='input') {
927 $attrib['type'] = 'button';
929 if ($attrib['label']) {
930 $attrib['value'] = $attrib['label'];
933 $attrib_str = html::attrib_string(
936 'type', 'value', 'onclick', 'id', 'class', 'style', 'tabindex'
939 $out = sprintf('<input%s disabled="disabled" />', $attrib_str);
942 // generate html code for button
944 $attrib_str = html::attrib_string($attrib, $link_attrib);
945 $out = sprintf('<a%s>%s</a>', $attrib_str, $btn_content);
952 /* ************* common functions delivering gui objects ************** */
956 * Create a form tag with the necessary hidden fields
958 * @param array Named tag parameters
959 * @return string HTML code for the form
961 public function form_tag($attrib, $content = null)
963 if ($this->framed || !empty($_REQUEST['_framed'])) {
964 $hiddenfield = new html_hiddenfield(array('name' => '_framed', 'value' => '1'));
965 $hidden = $hiddenfield->show();
969 $attrib['noclose'] = true;
971 return html::tag('form',
972 $attrib + array('action' => "./", 'method' => "get"),
974 array('id','class','style','name','method','action','enctype','onsubmit'));
979 * Build a form tag with a unique request token
981 * @param array Named tag parameters including 'action' and 'task' values which will be put into hidden fields
982 * @param string Form content
983 * @return string HTML code for the form
985 public function request_form($attrib, $content = '')
987 $hidden = new html_hiddenfield();
988 if ($attrib['task']) {
989 $hidden->add(array('name' => '_task', 'value' => $attrib['task']));
991 if ($attrib['action']) {
992 $hidden->add(array('name' => '_action', 'value' => $attrib['action']));
995 unset($attrib['task'], $attrib['request']);
996 $attrib['action'] = './';
998 // we already have a <form> tag
1000 return $hidden->show() . $content;
1002 return $this->form_tag($attrib, $hidden->show() . $content);
1007 * GUI object 'username'
1008 * Showing IMAP username of the current session
1010 * @param array Named tag parameters (currently not used)
1011 * @return string HTML code for the gui object
1013 public function current_username($attrib)
1018 if (!empty($username)) {
1022 // Current username is an e-mail address
1023 if (strpos($_SESSION['username'], '@')) {
1024 $username = $_SESSION['username'];
1026 // get e-mail address from default identity
1027 else if ($sql_arr = $this->app->user->get_identity()) {
1028 $username = $sql_arr['email'];
1031 $username = $this->app->user->get_username();
1034 return rcube_idn_to_utf8($username);
1039 * GUI object 'loginform'
1040 * Returns code for the webmail login form
1042 * @param array Named parameters
1043 * @return string HTML code for the gui object
1045 private function login_form($attrib)
1047 $default_host = $this->config['default_host'];
1048 $autocomplete = (int) $this->config['login_autocomplete'];
1050 $_SESSION['temp'] = true;
1052 // save original url
1053 $url = get_input_value('_url', RCUBE_INPUT_POST);
1054 if (empty($url) && !preg_match('/_(task|action)=logout/', $_SERVER['QUERY_STRING']))
1055 $url = $_SERVER['QUERY_STRING'];
1057 // set atocomplete attribute
1058 $user_attrib = $autocomplete > 0 ? array() : array('autocomplete' => 'off');
1059 $host_attrib = $autocomplete > 0 ? array() : array('autocomplete' => 'off');
1060 $pass_attrib = $autocomplete > 1 ? array() : array('autocomplete' => 'off');
1062 $input_task = new html_hiddenfield(array('name' => '_task', 'value' => 'login'));
1063 $input_action = new html_hiddenfield(array('name' => '_action', 'value' => 'login'));
1064 $input_tzone = new html_hiddenfield(array('name' => '_timezone', 'id' => 'rcmlogintz', 'value' => '_default_'));
1065 $input_url = new html_hiddenfield(array('name' => '_url', 'id' => 'rcmloginurl', 'value' => $url));
1066 $input_user = new html_inputfield(array('name' => '_user', 'id' => 'rcmloginuser')
1067 + $attrib + $user_attrib);
1068 $input_pass = new html_passwordfield(array('name' => '_pass', 'id' => 'rcmloginpwd')
1069 + $attrib + $pass_attrib);
1072 if (is_array($default_host) && count($default_host) > 1) {
1073 $input_host = new html_select(array('name' => '_host', 'id' => 'rcmloginhost'));
1075 foreach ($default_host as $key => $value) {
1076 if (!is_array($value)) {
1077 $input_host->add($value, (is_numeric($key) ? $value : $key));
1085 else if (is_array($default_host) && ($host = array_pop($default_host))) {
1087 $input_host = new html_hiddenfield(array(
1088 'name' => '_host', 'id' => 'rcmloginhost', 'value' => $host) + $attrib);
1090 else if (empty($default_host)) {
1091 $input_host = new html_inputfield(array('name' => '_host', 'id' => 'rcmloginhost')
1092 + $attrib + $host_attrib);
1095 $form_name = !empty($attrib['form']) ? $attrib['form'] : 'form';
1096 $this->add_gui_object('loginform', $form_name);
1098 // create HTML table with two cols
1099 $table = new html_table(array('cols' => 2));
1101 $table->add('title', html::label('rcmloginuser', Q(rcube_label('username'))));
1102 $table->add(null, $input_user->show(get_input_value('_user', RCUBE_INPUT_GPC)));
1104 $table->add('title', html::label('rcmloginpwd', Q(rcube_label('password'))));
1105 $table->add(null, $input_pass->show());
1107 // add host selection row
1108 if (is_object($input_host) && !$hide_host) {
1109 $table->add('title', html::label('rcmloginhost', Q(rcube_label('server'))));
1110 $table->add(null, $input_host->show(get_input_value('_host', RCUBE_INPUT_GPC)));
1113 $out = $input_task->show();
1114 $out .= $input_action->show();
1115 $out .= $input_tzone->show();
1116 $out .= $input_url->show();
1117 $out .= $table->show();
1120 $out .= $input_host->show();
1123 // surround html output with a form tag
1124 if (empty($attrib['form'])) {
1125 $out = $this->form_tag(array('name' => $form_name, 'method' => 'post'), $out);
1133 * GUI object 'preloader'
1134 * Loads javascript code for images preloading
1136 * @param array Named parameters
1139 private function preloader($attrib)
1141 $images = preg_split('/[\s\t\n,]+/', $attrib['images'], -1, PREG_SPLIT_NO_EMPTY);
1142 $images = array_map(array($this, 'abs_url'), $images);
1144 if (empty($images) || $this->app->task == 'logout')
1147 $this->add_script('$(document).ready(function(){
1148 var images = ' . json_serialize($images) .';
1149 for (var i=0; i<images.length; i++) {
1151 img.src = images[i];
1157 * GUI object 'searchform'
1158 * Returns code for search function
1160 * @param array Named parameters
1161 * @return string HTML code for the gui object
1163 private function search_form($attrib)
1165 // add some labels to client
1166 $this->add_label('searching');
1168 $attrib['name'] = '_q';
1170 if (empty($attrib['id'])) {
1171 $attrib['id'] = 'rcmqsearchbox';
1173 if ($attrib['type'] == 'search' && !$this->browser->khtml) {
1174 unset($attrib['type'], $attrib['results']);
1177 $input_q = new html_inputfield($attrib);
1178 $out = $input_q->show();
1180 $this->add_gui_object('qsearchbox', $attrib['id']);
1182 // add form tag around text field
1183 if (empty($attrib['form'])) {
1184 $out = $this->form_tag(array(
1185 'name' => "rcmqsearchform",
1186 'onsubmit' => JS_OBJECT_NAME . ".command('search');return false;",
1187 'style' => "display:inline"),
1196 * Builder for GUI object 'message'
1198 * @param array Named tag parameters
1199 * @return string HTML code for the gui object
1201 private function message_container($attrib)
1203 if (isset($attrib['id']) === false) {
1204 $attrib['id'] = 'rcmMessageContainer';
1207 $this->add_gui_object('message', $attrib['id']);
1208 return html::div($attrib, "");
1213 * GUI object 'charsetselector'
1215 * @param array Named parameters for the select tag
1216 * @return string HTML code for the gui object
1218 function charset_selector($attrib)
1220 // pass the following attributes to the form class
1221 $field_attrib = array('name' => '_charset');
1222 foreach ($attrib as $attr => $value) {
1223 if (in_array($attr, array('id', 'name', 'class', 'style', 'size', 'tabindex'))) {
1224 $field_attrib[$attr] = $value;
1229 'UTF-8' => 'UTF-8 ('.rcube_label('unicode').')',
1230 'US-ASCII' => 'ASCII ('.rcube_label('english').')',
1231 'ISO-8859-1' => 'ISO-8859-1 ('.rcube_label('westerneuropean').')',
1232 'ISO-8859-2' => 'ISO-8859-2 ('.rcube_label('easterneuropean').')',
1233 'ISO-8859-4' => 'ISO-8859-4 ('.rcube_label('baltic').')',
1234 'ISO-8859-5' => 'ISO-8859-5 ('.rcube_label('cyrillic').')',
1235 'ISO-8859-6' => 'ISO-8859-6 ('.rcube_label('arabic').')',
1236 'ISO-8859-7' => 'ISO-8859-7 ('.rcube_label('greek').')',
1237 'ISO-8859-8' => 'ISO-8859-8 ('.rcube_label('hebrew').')',
1238 'ISO-8859-9' => 'ISO-8859-9 ('.rcube_label('turkish').')',
1239 'ISO-8859-10' => 'ISO-8859-10 ('.rcube_label('nordic').')',
1240 'ISO-8859-11' => 'ISO-8859-11 ('.rcube_label('thai').')',
1241 'ISO-8859-13' => 'ISO-8859-13 ('.rcube_label('baltic').')',
1242 'ISO-8859-14' => 'ISO-8859-14 ('.rcube_label('celtic').')',
1243 'ISO-8859-15' => 'ISO-8859-15 ('.rcube_label('westerneuropean').')',
1244 'ISO-8859-16' => 'ISO-8859-16 ('.rcube_label('southeasterneuropean').')',
1245 'WINDOWS-1250' => 'Windows-1250 ('.rcube_label('easterneuropean').')',
1246 'WINDOWS-1251' => 'Windows-1251 ('.rcube_label('cyrillic').')',
1247 'WINDOWS-1252' => 'Windows-1252 ('.rcube_label('westerneuropean').')',
1248 'WINDOWS-1253' => 'Windows-1253 ('.rcube_label('greek').')',
1249 'WINDOWS-1254' => 'Windows-1254 ('.rcube_label('turkish').')',
1250 'WINDOWS-1255' => 'Windows-1255 ('.rcube_label('hebrew').')',
1251 'WINDOWS-1256' => 'Windows-1256 ('.rcube_label('arabic').')',
1252 'WINDOWS-1257' => 'Windows-1257 ('.rcube_label('baltic').')',
1253 'WINDOWS-1258' => 'Windows-1258 ('.rcube_label('vietnamese').')',
1254 'ISO-2022-JP' => 'ISO-2022-JP ('.rcube_label('japanese').')',
1255 'ISO-2022-KR' => 'ISO-2022-KR ('.rcube_label('korean').')',
1256 'ISO-2022-CN' => 'ISO-2022-CN ('.rcube_label('chinese').')',
1257 'EUC-JP' => 'EUC-JP ('.rcube_label('japanese').')',
1258 'EUC-KR' => 'EUC-KR ('.rcube_label('korean').')',
1259 'EUC-CN' => 'EUC-CN ('.rcube_label('chinese').')',
1260 'BIG5' => 'BIG5 ('.rcube_label('chinese').')',
1261 'GB2312' => 'GB2312 ('.rcube_label('chinese').')',
1264 if (!empty($_POST['_charset']))
1265 $set = $_POST['_charset'];
1266 else if (!empty($attrib['selected']))
1267 $set = $attrib['selected'];
1269 $set = $this->get_charset();
1271 $set = strtoupper($set);
1272 if (!isset($charsets[$set]))
1273 $charsets[$set] = $set;
1275 $select = new html_select($field_attrib);
1276 $select->add(array_values($charsets), array_keys($charsets));
1278 return $select->show($set);
1281 } // end class rcube_template