Context Navigation

source: github/program/include/rcube_template.php @ fbe24e9

Visit:

HEADcourier-fixdev-browser-capabilitiespdorelease-0.6release-0.7release-0.8

Last change on this file since fbe24e9 was fbe24e9, checked in by thomascube <thomas@…>, 2 years ago
Allow plugin templates to include local files (#1487133); make autocomplete on login screen configurable
Property mode set to `100755`
File size: 42.8 KB

Line
1	<?php
2
3	/*
4	+-----------------------------------------------------------------------+
5	\| program/include/rcube_template.php \|
6	\| \|
7	\| This file is part of the Roundcube Webmail client \|
8	\| Copyright (C) 2006-2010, Roundcube Dev. - Switzerland \|
9	\| Licensed under the GNU GPL \|
10	\| \|
11	\| PURPOSE: \|
12	\| Class to handle HTML page output using a skin template. \|
13	\| Extends rcube_html_page class from rcube_shared.inc \|
14	\| \|
15	+-----------------------------------------------------------------------+
16	\| Author: Thomas Bruederli <roundcube@gmail.com> \|
17	+-----------------------------------------------------------------------+
18
19	$Id$
20
21	*/
22
23
24	/**
25	* Class to create HTML page output using a skin template
26	*
27	* @package View
28	* @todo Documentation
29	* @uses rcube_html_page
30	*/
31	class rcube_template extends rcube_html_page
32	{
33	private $app;
34	private $config;
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;
41
42	public $browser;
43	public $framed = false;
44	public $env = array();
45	public $type = 'html';
46	public $ajax_call = false;
47
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',
55	);
56
57	/**
58	* Constructor
59	*
60	* @todo Use jQuery's $(document).ready() here.
61	* @todo Replace $this->config with the real rcube_config object
62	*/
63	public function __construct($task, $framed = false)
64	{
65	parent::__construct();
66
67	$this->app = rcmail::get_instance();
68	$this->config = $this->app->config->all();
69	$this->browser = new rcube_browser();
70
71	//$this->framed = $framed;
72	$this->set_env('task', $task);
73	$this->set_env('request_token', $this->app->get_request_token());
74
75	// load the correct skin (in case user-defined)
76	$this->set_skin($this->config['skin']);
77
78	// add common javascripts
79	$javascript = 'var '.JS_OBJECT_NAME.' = new rcube_webmail();';
80
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(); });';
83
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');
90
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'),
98	));
99	}
100
101	/**
102	* Set environment variable
103	*
104	* @param string Property name
105	* @param mixed Property value
106	* @param boolean True if this property should be added to client environment
107	*/
108	public function set_env($name, $value, $addtojs = true)
109	{
110	$this->env[$name] = $value;
111	if ($addtojs \|\| isset($this->js_env[$name])) {
112	$this->js_env[$name] = $value;
113	}
114	}
115
116
117	/**
118	* Set page title variable
119	*/
120	public function set_pagetitle($title)
121	{
122	$this->pagetitle = $title;
123	}
124
125
126	/**
127	* Getter for the current page title
128	*
129	* @return string The page title
130	*/
131	public function get_pagetitle()
132	{
133	if (!empty($this->pagetitle)) {
134	$title = $this->pagetitle;
135	}
136	else if ($this->env['task'] == 'login') {
137	$title = rcube_label(array('name' => 'welcome', 'vars' => array('product' => $this->config['product_name'])));
138	}
139	else {
140	$title = ucfirst($this->env['task']);
141	}
142
143	return $title;
144	}
145
146
147	/**
148	* Set skin
149	*/
150	public function set_skin($skin)
151	{
152	$valid = false;
153
154	if (!empty($skin) && is_dir('skins/'.$skin) && is_readable('skins/'.$skin)) {
155	$skin_path = 'skins/'.$skin;
156	$valid = true;
157	}
158	else {
159	$skin_path = $this->config['skin_path'] ? $this->config['skin_path'] : 'skins/default';
160	$valid = !$skin;
161	}
162
163	$this->app->config->set('skin_path', $skin_path);
164	$this->config['skin_path'] = $skin_path;
165
166	return $valid;
167	}
168
169	/**
170	* Check if a specific template exists
171	*
172	* @param string Template name
173	* @return boolean True if template exists
174	*/
175	public function template_exists($name)
176	{
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]));
179	}
180
181	/**
182	* Register a template object handler
183	*
184	* @param string Object name
185	* @param string Function name to call
186	* @return void
187	*/
188	public function add_handler($obj, $func)
189	{
190	$this->object_handlers[$obj] = $func;
191	}
192
193	/**
194	* Register a list of template object handlers
195	*
196	* @param array Hash array with object=>handler pairs
197	* @return void
198	*/
199	public function add_handlers($arr)
200	{
201	$this->object_handlers = array_merge($this->object_handlers, $arr);
202	}
203
204	/**
205	* Register a GUI object to the client script
206	*
207	* @param string Object name
208	* @param string Object ID
209	* @return void
210	*/
211	public function add_gui_object($obj, $id)
212	{
213	$this->add_script(JS_OBJECT_NAME.".gui_object('$obj', '$id');");
214	}
215
216	/**
217	* Call a client method
218	*
219	* @param string Method to call
220	* @param ... Additional arguments
221	*/
222	public function command()
223	{
224	$cmd = func_get_args();
225	if (strpos($cmd[0], 'plugin.') === false)
226	$this->js_commands[] = $cmd;
227	}
228
229
230	/**
231	* Add a localized label to the client environment
232	*/
233	public function add_label()
234	{
235	$args = func_get_args();
236	if (count($args) == 1 && is_array($args[0]))
237	$args = $args[0];
238
239	foreach ($args as $name) {
240	$this->command('add_label', $name, rcube_label($name));
241	}
242	}
243
244
245	/**
246	* Invoke display_message command
247	*
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()
253	*/
254	public function show_message($message, $type='notice', $vars=null, $override=true)
255	{
256	if ($override \|\| !$this->message) {
257	$this->message = $message;
258	$this->command(
259	'display_message',
260	rcube_label(array('name' => $message, 'vars' => $vars)),
261	$type);
262	}
263	}
264
265
266	/**
267	* Delete all stored env variables and commands
268	*
269	* @return void
270	* @uses rcube_html::reset()
271	* @uses self::$env
272	* @uses self::$js_env
273	* @uses self::$js_commands
274	* @uses self::$object_handlers
275	*/
276	public function reset()
277	{
278	$this->env = array();
279	$this->js_env = array();
280	$this->js_commands = array();
281	$this->object_handlers = array();
282	parent::reset();
283	}
284
285
286	/**
287	* Redirect to a certain url
288	*
289	* @param mixed Either a string with the action or url parameters as key-value pairs
290	* @see rcmail::url()
291	*/
292	public function redirect($p = array())
293	{
294	$location = $this->app->url($p);
295	header('Location: ' . $location);
296	exit;
297	}
298
299
300	/**
301	* Send the request output to the client.
302	* This will either parse a skin tempalte or send an AJAX response
303	*
304	* @param string Template name
305	* @param boolean True if script should terminate (default)
306	*/
307	public function send($templ = null, $exit = true)
308	{
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);
315	return;
316	}
317	$this->parse($templ, false);
318	}
319	else {
320	$this->framed = $templ == 'iframe' ? true : $this->framed;
321	$this->write();
322	}
323
324	// set output asap
325	ob_flush();
326	flush();
327
328	if ($exit) {
329	exit;
330	}
331	}
332
333	/**
334	* Process template and write to stdOut
335	*
336	* @param string HTML template
337	* @see rcube_html_page::write()
338	* @override
339	*/
340	public function write($template = '')
341	{
342	// unlock interface after iframe load
343	$unlock = preg_replace('/[^a-z0-9]/i', '', $_GET['_unlock']);
344	if ($this->framed) {
345	array_unshift($this->js_commands, array('set_busy', false, null, $unlock));
346	}
347	else if ($unlock) {
348	array_unshift($this->js_commands, array('hide_message', $unlock));
349	}
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');
354
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);
358
359	// call super method
360	parent::write($template, $this->config['skin_path']);
361	}
362
363	/**
364	* Parse a specific skin template and deliver to stdout
365	*
366	* Either returns nothing, or exists hard (exit();)
367	*
368	* @param string Template name
369	* @param boolean Exit script
370	* @return void
371	* @link http://php.net/manual/en/function.exit.php
372	*/
373	private function parse($name = 'main', $exit = true)
374	{
375	$skin_path = $this->config['skin_path'];
376	$plugin = false;
377	$this->plugin_skin_path = null;
378
379	$temp = explode(".", $name, 2);
380	if (count($temp) > 1) {
381	$plugin = $temp[0];
382	$name = $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;
388	}
389	}
390
391	$path = "$skin_path/templates/$name.html";
392
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."'"),
399	true, false);
400	}
401
402	// read template file
403	if (($templ = @file_get_contents($path)) === false) {
404	raise_error(array(
405	'code' => 501,
406	'type' => 'php',
407	'line' => __LINE__,
408	'file' => __FILE__,
409	'message' => 'Error loading template for '.$name
410	), true, true);
411	return false;
412	}
413
414	// replace all path references to plugins/... with the configured plugins dir
415	// and /this/ to the current plugin skin directory
416	if ($plugin) {
417	$templ = preg_replace(array('/\bplugins\//', '/(["\']?)\/this\//'), array($this->app->plugins->url, '\\1'.$this->app->plugins->url.$skin_dir.'/'), $templ);
418	}
419
420	// parse for specialtags
421	$output = $this->parse_conditions($templ);
422	$output = $this->parse_xml($output);
423
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));
426
427	// add debug console
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>'
432	);
433	}
434
435	$output = $this->parse_with_globals($hook['content']);
436	$this->write(trim($output));
437	if ($exit) {
438	exit;
439	}
440	}
441
442
443	/**
444	* Return executable javascript code for all registered commands
445	*
446	* @return string $out
447	*/
448	private function get_js_commands()
449	{
450	$out = '';
451	if (!$this->framed && !empty($this->js_env)) {
452	$out .= JS_OBJECT_NAME . '.set_env('.json_serialize($this->js_env).");\n";
453	}
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);
458	}
459	$parent = $this->framed \|\| preg_match('/^parent\./', $method);
460	$out .= sprintf(
461	"%s.%s(%s);\n",
462	($parent ? 'if(window.parent && parent.'.JS_OBJECT_NAME.') parent.' : '') . JS_OBJECT_NAME,
463	preg_replace('/^parent\./', '', $method),
464	implode(',', $args)
465	);
466	}
467
468	return $out;
469	}
470
471	/**
472	* Make URLs starting with a slash point to skin directory
473	*
474	* @param string Input string
475	* @return string
476	*/
477	public function abs_url($str)
478	{
479	if ($str[0] == '/')
480	return $this->config['skin_path'] . $str;
481	else
482	return $str;
483	}
484
485
486	/*** Template parsing methods ***/
487
488	/**
489	* Replace all strings ($varname)
490	* with the content of the according global variable.
491	*/
492	private function parse_with_globals($input)
493	{
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);
498	}
499
500	/**
501	* Callback funtion for preg_replace_callback() in parse_with_globals()
502	*/
503	private function globals_callback($matches)
504	{
505	return $GLOBALS[$matches[1]];
506	}
507
508	/**
509	* Public wrapper to dipp into template parsing.
510	*
511	* @param string $input
512	* @return string
513	* @uses rcube_template::parse_xml()
514	* @since 0.1-rc1
515	*/
516	public function just_parse($input)
517	{
518	return $this->parse_xml($input);
519	}
520
521	/**
522	* Parse for conditional tags
523	*
524	* @param string $input
525	* @return string
526	*/
527	private function parse_conditions($input)
528	{
529	$matches = preg_split('/<roundcube:(if\|elseif\|else\|endif)\s+([^>]+)>/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]);
533	}
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+([^>]+)>/is', $matches[3], 2, PREG_SPLIT_DELIM_CAPTURE);
538	if ($condmet) {
539	$result = $submatches[0];
540	$result.= ($submatches[1] != 'endif' ? preg_replace('/.*<roundcube:endif\s+[^>]+>/Uis', '', $submatches[3], 1) : $submatches[3]);
541	}
542	else {
543	$result = "<roundcube:$submatches[1] $submatches[2]>" . $submatches[3];
544	}
545	return $matches[0] . $this->parse_conditions($result);
546	}
547	raise_error(array(
548	'code' => 500,
549	'type' => 'php',
550	'line' => __LINE__,
551	'file' => __FILE__,
552	'message' => "Unable to parse conditional tag " . $matches[2]
553	), true, false);
554	}
555	return $input;
556	}
557
558
559	/**
560	* Determines if a given condition is met
561	*
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
566	*/
567	private function check_condition($condition)
568	{
569	return eval("return (".$this->parse_expression($condition).");");
570	}
571
572
573	/**
574	* Inserts hidden field with CSRF-prevention-token into POST forms
575	*/
576	private function alter_form_tag($matches)
577	{
578	$out = $matches[0];
579	$attrib = parse_attrib_string($matches[1]);
580
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();
584	}
585
586	return $out;
587	}
588
589
590	/**
591	* Parses expression and replaces variables
592	*
593	* @param string Expression statement
594	* @return string Expression value
595	*/
596	private function parse_expression($expression)
597	{
598	return preg_replace(
599	array(
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'
606	),
607	array(
608	"\$_SESSION['\\1']",
609	"\$this->app->config->get('\\1',get_boolean('\\3'))",
610	"\$this->env['\\1']",
611	"get_input_value('\\1', RCUBE_INPUT_GPC)",
612	"\$_COOKIE['\\1']",
613	"\$this->browser->{'\\1'}"
614	),
615	$expression);
616	}
617
618
619	/**
620	* Search for special tags in input and replace them
621	* with the appropriate content
622	*
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.
627	*/
628	private function parse_xml($input)
629	{
630	return preg_replace_callback('/<roundcube:([-_a-z]+)\s+([^>]+)>/Ui', array($this, 'xml_command'), $input);
631	}
632
633
634	/**
635	* Callback function for parsing an xml command tag
636	* and turn it into real html content
637	*
638	* @param array Matches array of preg_replace_callback
639	* @return string Tag/Object content
640	*/
641	private function xml_command($matches)
642	{
643	$command = strtolower($matches[1]);
644	$attrib = parse_attrib_string($matches[2]);
645
646	// empty output if required condition is not met
647	if (!empty($attrib['condition']) && !$this->check_condition($attrib['condition'])) {
648	return '';
649	}
650
651	// execute command
652	switch ($command) {
653	// return a button
654	case 'button':
655	if ($attrib['name'] \|\| $attrib['command']) {
656	return $this->button($attrib);
657	}
658	break;
659
660	// show a label
661	case 'label':
662	if ($attrib['name'] \|\| $attrib['command']) {
663	return Q(rcube_label($attrib + array('vars' => array('product' => $this->config['product_name']))));
664	}
665	break;
666
667	// include a file
668	case 'include':
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']);
671
672	if (is_readable($path)) {
673	if ($this->config['skin_include_php']) {
674	$incl = $this->include_php($path);
675	}
676	else {
677	$incl = file_get_contents($path);
678	}
679	$incl = $this->parse_conditions($incl);
680	return $this->parse_xml($incl);
681	}
682	break;
683
684	case 'plugin.include':
685	$hook = $this->app->plugins->exec_hook("template_plugin_include", $attrib);
686	return $hook['content'];
687	break;
688
689	// define a container block
690	case 'container':
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'];
696	}
697	break;
698
699	// return code for a specific application object
700	case 'object':
701	$object = strtolower($attrib['name']);
702	$content = '';
703
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);
709	}
710	// execute object handler function
711	else if (function_exists($handler)) {
712	$content = call_user_func($handler, $attrib);
713	}
714	else if ($object == 'productname') {
715	$name = !empty($this->config['product_name']) ? $this->config['product_name'] : 'Roundcube Webmail';
716	$content = Q($name);
717	}
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].']';
723	}
724	$content = Q($ver);
725	}
726	else if ($object == 'steptitle') {
727	$content = Q($this->get_pagetitle());
728	}
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);
733	}
734
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'];
738
739	// return code for a specified eval expression
740	case 'exp':
741	$value = $this->parse_expression($attrib['expression']);
742	return eval("return Q($value);");
743
744	// return variable
745	case 'var':
746	$var = explode(':', $attrib['name']);
747	$name = $var[1];
748	$value = '';
749
750	switch ($var[0]) {
751	case 'env':
752	$value = $this->env[$name];
753	break;
754	case 'config':
755	$value = $this->config[$name];
756	if (is_array($value) && $value[$_SESSION['imap_host']]) {
757	$value = $value[$_SESSION['imap_host']];
758	}
759	break;
760	case 'request':
761	$value = get_input_value($name, RCUBE_INPUT_GPC);
762	break;
763	case 'session':
764	$value = $_SESSION[$name];
765	break;
766	case 'cookie':
767	$value = htmlspecialchars($_COOKIE[$name]);
768	break;
769	case 'browser':
770	$value = $this->browser->{$name};
771	break;
772	}
773
774	if (is_array($value)) {
775	$value = implode(', ', $value);
776	}
777
778	return Q($value);
779	break;
780	}
781	return '';
782	}
783
784	/**
785	* Include a specific file and return it's contents
786	*
787	* @param string File path
788	* @return string Contents of the processed file
789	*/
790	private function include_php($file)
791	{
792	ob_start();
793	include $file;
794	$out = ob_get_contents();
795	ob_end_clean();
796
797	return $out;
798	}
799
800	/**
801	* Create and register a button
802	*
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.
807	*/
808	public function button($attrib)
809	{
810	static $s_button_count = 100;
811
812	// these commands can be called directly via url
813	$a_static_commands = array('compose', 'list', 'preferences', 'folders', 'identities');
814
815	if (!($attrib['command'] \|\| $attrib['name'])) {
816	return '';
817	}
818
819	// try to find out the button type
820	if ($attrib['type']) {
821	$attrib['type'] = strtolower($attrib['type']);
822	}
823	else {
824	$attrib['type'] = ($attrib['image'] \|\| $attrib['imagepas'] \|\| $attrib['imageact']) ? 'image' : 'link';
825	}
826
827	$command = $attrib['command'];
828
829	if ($attrib['task'])
830	$command = $attrib['task'] . '.' . $command;
831
832	if (!$attrib['image']) {
833	$attrib['image'] = $attrib['imagepas'] ? $attrib['imagepas'] : $attrib['imageact'];
834	}
835
836	if (!$attrib['id']) {
837	$attrib['id'] = sprintf('rcmbtn%d', $s_button_count++);
838	}
839	// get localized text for labels and titles
840	if ($attrib['title']) {
841	$attrib['title'] = Q(rcube_label($attrib['title'], $attrib['domain']));
842	}
843	if ($attrib['label']) {
844	$attrib['label'] = Q(rcube_label($attrib['label'], $attrib['domain']));
845	}
846	if ($attrib['alt']) {
847	$attrib['alt'] = Q(rcube_label($attrib['alt'], $attrib['domain']));
848	}
849
850	// set title to alt attribute for IE browsers
851	if ($this->browser->ie && !$attrib['title'] && $attrib['alt']) {
852	$attrib['title'] = $attrib['alt'];
853	}
854
855	// add empty alt attribute for XHTML compatibility
856	if (!isset($attrib['alt'])) {
857	$attrib['alt'] = '';
858	}
859
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');",
864	JS_OBJECT_NAME,
865	$command,
866	$attrib['id'],
867	$attrib['type'],
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']) : ''
871	));
872
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']);
876	}
877	else if ($attrib['task'] && in_array($attrib['task'], rcmail::$main_tasks)) {
878	$attrib['href'] = rcmail_url($attrib['command'], null, $attrib['task']);
879	}
880	else if (in_array($attrib['command'], $a_static_commands)) {
881	$attrib['href'] = rcmail_url($attrib['command']);
882	}
883	else if ($attrib['command'] == 'permaurl' && !empty($this->env['permaurl'])) {
884	$attrib['href'] = $this->env['permaurl'];
885	}
886	}
887
888	// overwrite attributes
889	if (!$attrib['href']) {
890	$attrib['href'] = '#';
891	}
892	if ($attrib['task']) {
893	if ($attrib['classact'])
894	$attrib['class'] = $attrib['classact'];
895	}
896	else if ($command && !$attrib['onclick']) {
897	$attrib['onclick'] = sprintf(
898	"return %s.command('%s','%s',this)",
899	JS_OBJECT_NAME,
900	$command,
901	$attrib['prop']
902	);
903	}
904
905	$out = '';
906
907	// generate image tag
908	if ($attrib['type']=='image') {
909	$attrib_str = html::attrib_string(
910	$attrib,
911	array(
912	'style', 'class', 'id', 'width', 'height', 'border', 'hspace',
913	'vspace', 'align', 'alt', 'tabindex', 'title'
914	)
915	);
916	$btn_content = sprintf('<img src="%s"%s />', $this->abs_url($attrib['image']), $attrib_str);
917	if ($attrib['label']) {
918	$btn_content .= ' '.$attrib['label'];
919	}
920	$link_attrib = array('href', 'onclick', 'onmouseover', 'onmouseout', 'onmousedown', 'onmouseup', 'target');
921	}
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');
925	}
926	else if ($attrib['type']=='input') {
927	$attrib['type'] = 'button';
928
929	if ($attrib['label']) {
930	$attrib['value'] = $attrib['label'];
931	}
932
933	$attrib_str = html::attrib_string(
934	$attrib,
935	array(
936	'type', 'value', 'onclick', 'id', 'class', 'style', 'tabindex'
937	)
938	);
939	$out = sprintf('<input%s disabled="disabled" />', $attrib_str);
940	}
941
942	// generate html code for button
943	if ($btn_content) {
944	$attrib_str = html::attrib_string($attrib, $link_attrib);
945	$out = sprintf('<a%s>%s</a>', $attrib_str, $btn_content);
946	}
947
948	return $out;
949	}
950
951
952	/* *********** common functions delivering gui objects ************ */
953
954
955	/**
956	* Create a form tag with the necessary hidden fields
957	*
958	* @param array Named tag parameters
959	* @return string HTML code for the form
960	*/
961	public function form_tag($attrib, $content = null)
962	{
963	if ($this->framed \|\| !empty($_REQUEST['_framed'])) {
964	$hiddenfield = new html_hiddenfield(array('name' => '_framed', 'value' => '1'));
965	$hidden = $hiddenfield->show();
966	}
967
968	if (!$content)
969	$attrib['noclose'] = true;
970
971	return html::tag('form',
972	$attrib + array('action' => "./", 'method' => "get"),
973	$hidden . $content,
974	array('id','class','style','name','method','action','enctype','onsubmit'));
975	}
976
977
978	/**
979	* Build a form tag with a unique request token
980	*
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
984	*/
985	public function request_form($attrib, $content = '')
986	{
987	$hidden = new html_hiddenfield();
988	if ($attrib['task']) {
989	$hidden->add(array('name' => '_task', 'value' => $attrib['task']));
990	}
991	if ($attrib['action']) {
992	$hidden->add(array('name' => '_action', 'value' => $attrib['action']));
993	}
994
995	unset($attrib['task'], $attrib['request']);
996	$attrib['action'] = './';
997
998	// we already have a <form> tag
999	if ($attrib['form'])
1000	return $hidden->show() . $content;
1001	else
1002	return $this->form_tag($attrib, $hidden->show() . $content);
1003	}
1004
1005
1006	/**
1007	* GUI object 'username'
1008	* Showing IMAP username of the current session
1009	*
1010	* @param array Named tag parameters (currently not used)
1011	* @return string HTML code for the gui object
1012	*/
1013	public function current_username($attrib)
1014	{
1015	static $username;
1016
1017	// alread fetched
1018	if (!empty($username)) {
1019	return $username;
1020	}
1021
1022	// Current username is an e-mail address
1023	if (strpos($_SESSION['username'], '@')) {
1024	$username = $_SESSION['username'];
1025	}
1026	// get e-mail address from default identity
1027	else if ($sql_arr = $this->app->user->get_identity()) {
1028	$username = $sql_arr['email'];
1029	}
1030	else {
1031	$username = $this->app->user->get_username();
1032	}
1033
1034	return idn_to_utf8($username);
1035	}
1036
1037
1038	/**
1039	* GUI object 'loginform'
1040	* Returns code for the webmail login form
1041	*
1042	* @param array Named parameters
1043	* @return string HTML code for the gui object
1044	*/
1045	private function login_form($attrib)
1046	{
1047	$default_host = $this->config['default_host'];
1048	$attrib['autocomplete'] = $this->config['login_autocomplete'] ? null : 'off';
1049
1050	$_SESSION['temp'] = true;
1051
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'];
1056
1057	$input_user = new html_inputfield(array('name' => '_user', 'id' => 'rcmloginuser') + $attrib);
1058	$input_pass = new html_passwordfield(array('name' => '_pass', 'id' => 'rcmloginpwd') + $attrib);
1059	$input_action = new html_hiddenfield(array('name' => '_action', 'value' => 'login'));
1060	$input_tzone = new html_hiddenfield(array('name' => '_timezone', 'id' => 'rcmlogintz', 'value' => '_default_'));
1061	$input_url = new html_hiddenfield(array('name' => '_url', 'id' => 'rcmloginurl', 'value' => $url));
1062	$input_host = null;
1063
1064	if (is_array($default_host) && count($default_host) > 1) {
1065	$input_host = new html_select(array('name' => '_host', 'id' => 'rcmloginhost'));
1066
1067	foreach ($default_host as $key => $value) {
1068	if (!is_array($value)) {
1069	$input_host->add($value, (is_numeric($key) ? $value : $key));
1070	}
1071	else {
1072	$input_host = null;
1073	break;
1074	}
1075	}
1076	}
1077	else if (is_array($default_host) && ($host = array_pop($default_host))) {
1078	$hide_host = true;
1079	$input_host = new html_hiddenfield(array(
1080	'name' => '_host', 'id' => 'rcmloginhost', 'value' => $host) + $attrib);
1081	}
1082	else if (empty($default_host)) {
1083	$input_host = new html_inputfield(array('name' => '_host', 'id' => 'rcmloginhost') + $attrib);
1084	}
1085
1086	$form_name = !empty($attrib['form']) ? $attrib['form'] : 'form';
1087	$this->add_gui_object('loginform', $form_name);
1088
1089	// create HTML table with two cols
1090	$table = new html_table(array('cols' => 2));
1091
1092	$table->add('title', html::label('rcmloginuser', Q(rcube_label('username'))));
1093	$table->add(null, $input_user->show(get_input_value('_user', RCUBE_INPUT_POST)));
1094
1095	$table->add('title', html::label('rcmloginpwd', Q(rcube_label('password'))));
1096	$table->add(null, $input_pass->show());
1097
1098	// add host selection row
1099	if (is_object($input_host) && !$hide_host) {
1100	$table->add('title', html::label('rcmloginhost', Q(rcube_label('server'))));
1101	$table->add(null, $input_host->show(get_input_value('_host', RCUBE_INPUT_POST)));
1102	}
1103
1104	$out = $input_action->show();
1105	$out .= $input_tzone->show();
1106	$out .= $input_url->show();
1107	$out .= $table->show();
1108
1109	if ($hide_host) {
1110	$out .= $input_host->show();
1111	}
1112
1113	// surround html output with a form tag
1114	if (empty($attrib['form'])) {
1115	$out = $this->form_tag(array('name' => $form_name, 'method' => 'post'), $out);
1116	}
1117
1118	return $out;
1119	}
1120
1121
1122	/**
1123	* GUI object 'preloader'
1124	* Loads javascript code for images preloading
1125	*
1126	* @param array Named parameters
1127	* @return void
1128	*/
1129	private function preloader($attrib)
1130	{
1131	$images = preg_split('/[\s\t\n,]+/', $attrib['images'], -1, PREG_SPLIT_NO_EMPTY);
1132	$images = array_map(array($this, 'abs_url'), $images);
1133
1134	if (empty($images) \|\| $this->app->task == 'logout')
1135	return;
1136
1137	$this->add_script('$(document).ready(function(){
1138	var images = ' . json_serialize($images) .';
1139	for (var i=0; i<images.length; i++) {
1140	img = new Image();
1141	img.src = images[i];
1142	}});', 'foot');
1143	}
1144
1145
1146	/**
1147	* GUI object 'searchform'
1148	* Returns code for search function
1149	*
1150	* @param array Named parameters
1151	* @return string HTML code for the gui object
1152	*/
1153	private function search_form($attrib)
1154	{
1155	// add some labels to client
1156	$this->add_label('searching');
1157
1158	$attrib['name'] = '_q';
1159
1160	if (empty($attrib['id'])) {
1161	$attrib['id'] = 'rcmqsearchbox';
1162	}
1163	if ($attrib['type'] == 'search' && !$this->browser->khtml) {
1164	unset($attrib['type'], $attrib['results']);
1165	}
1166
1167	$input_q = new html_inputfield($attrib);
1168	$out = $input_q->show();
1169
1170	$this->add_gui_object('qsearchbox', $attrib['id']);
1171
1172	// add form tag around text field
1173	if (empty($attrib['form'])) {
1174	$out = $this->form_tag(array(
1175	'name' => "rcmqsearchform",
1176	'onsubmit' => JS_OBJECT_NAME . ".command('search');return false;",
1177	'style' => "display:inline"),
1178	$out);
1179	}
1180
1181	return $out;
1182	}
1183
1184
1185	/**
1186	* Builder for GUI object 'message'
1187	*
1188	* @param array Named tag parameters
1189	* @return string HTML code for the gui object
1190	*/
1191	private function message_container($attrib)
1192	{
1193	if (isset($attrib['id']) === false) {
1194	$attrib['id'] = 'rcmMessageContainer';
1195	}
1196
1197	$this->add_gui_object('message', $attrib['id']);
1198	return html::div($attrib, "");
1199	}
1200
1201
1202	/**
1203	* GUI object 'charsetselector'
1204	*
1205	* @param array Named parameters for the select tag
1206	* @return string HTML code for the gui object
1207	*/
1208	function charset_selector($attrib)
1209	{
1210	// pass the following attributes to the form class
1211	$field_attrib = array('name' => '_charset');
1212	foreach ($attrib as $attr => $value) {
1213	if (in_array($attr, array('id', 'name', 'class', 'style', 'size', 'tabindex'))) {
1214	$field_attrib[$attr] = $value;
1215	}
1216	}
1217
1218	$charsets = array(
1219	'UTF-8' => 'UTF-8 ('.rcube_label('unicode').')',
1220	'US-ASCII' => 'ASCII ('.rcube_label('english').')',
1221	'ISO-8859-1' => 'ISO-8859-1 ('.rcube_label('westerneuropean').')',
1222	'ISO-8859-2' => 'ISO-8895-2 ('.rcube_label('easterneuropean').')',
1223	'ISO-8859-4' => 'ISO-8895-4 ('.rcube_label('baltic').')',
1224	'ISO-8859-5' => 'ISO-8859-5 ('.rcube_label('cyrillic').')',
1225	'ISO-8859-6' => 'ISO-8859-6 ('.rcube_label('arabic').')',
1226	'ISO-8859-7' => 'ISO-8859-7 ('.rcube_label('greek').')',
1227	'ISO-8859-8' => 'ISO-8859-8 ('.rcube_label('hebrew').')',
1228	'ISO-8859-9' => 'ISO-8859-9 ('.rcube_label('turkish').')',
1229	'ISO-8859-10' => 'ISO-8859-10 ('.rcube_label('nordic').')',
1230	'ISO-8859-11' => 'ISO-8859-11 ('.rcube_label('thai').')',
1231	'ISO-8859-13' => 'ISO-8859-13 ('.rcube_label('baltic').')',
1232	'ISO-8859-14' => 'ISO-8859-14 ('.rcube_label('celtic').')',
1233	'ISO-8859-15' => 'ISO-8859-15 ('.rcube_label('westerneuropean').')',
1234	'ISO-8859-16' => 'ISO-8859-16 ('.rcube_label('southeasterneuropean').')',
1235	'WINDOWS-1250' => 'Windows-1250 ('.rcube_label('easterneuropean').')',
1236	'WINDOWS-1251' => 'Windows-1251 ('.rcube_label('cyrillic').')',
1237	'WINDOWS-1252' => 'Windows-1252 ('.rcube_label('westerneuropean').')',
1238	'WINDOWS-1253' => 'Windows-1253 ('.rcube_label('greek').')',
1239	'WINDOWS-1254' => 'Windows-1254 ('.rcube_label('turkish').')',
1240	'WINDOWS-1255' => 'Windows-1255 ('.rcube_label('hebrew').')',
1241	'WINDOWS-1256' => 'Windows-1256 ('.rcube_label('arabic').')',
1242	'WINDOWS-1257' => 'Windows-1257 ('.rcube_label('baltic').')',
1243	'WINDOWS-1258' => 'Windows-1258 ('.rcube_label('vietnamese').')',
1244	'ISO-2022-JP' => 'ISO-2022-JP ('.rcube_label('japanese').')',
1245	'ISO-2022-KR' => 'ISO-2022-KR ('.rcube_label('korean').')',
1246	'ISO-2022-CN' => 'ISO-2022-CN ('.rcube_label('chinese').')',
1247	'EUC-JP' => 'EUC-JP ('.rcube_label('japanese').')',
1248	'EUC-KR' => 'EUC-KR ('.rcube_label('korean').')',
1249	'EUC-CN' => 'EUC-CN ('.rcube_label('chinese').')',
1250	'BIG5' => 'BIG5 ('.rcube_label('chinese').')',
1251	'GB2312' => 'GB2312 ('.rcube_label('chinese').')',
1252	);
1253
1254	if (!empty($_POST['_charset']))
1255	$set = $_POST['_charset'];
1256	else if (!empty($attrib['selected']))
1257	$set = $attrib['selected'];
1258	else
1259	$set = $this->get_charset();
1260
1261	$set = strtoupper($set);
1262	if (!isset($charsets[$set]))
1263	$charsets[$set] = $set;
1264
1265	$select = new html_select($field_attrib);
1266	$select->add(array_values($charsets), array_keys($charsets));
1267
1268	return $select->show($set);
1269	}
1270
1271	} // end class rcube_template
1272
1273

Note: See TracBrowser for help on using the repository browser.

Download in other formats: