githubFork/roundcubemail.git

thomascube

2006-09-01 fda695f29732f5e5bcaa55e7e7abd090d2359927

commit \| author \| age
4e17e6	1	<?php
T	2
	3	/*
	4	+-----------------------------------------------------------------------+
	5	\| program/include/main.inc \|
	6	\| \|
	7	\| This file is part of the RoundCube Webmail client \|
	8	\| Copyright (C) 2005, RoundCube Dev, - Switzerland \|
30233b	9	\| Licensed under the GNU GPL \|
4e17e6	10	\| \|
T	11	\| PURPOSE: \|
	12	\| Provide basic functions for the webmail package \|
	13	\| \|
	14	+-----------------------------------------------------------------------+
	15	\| Author: Thomas Bruederli <roundcube@gmail.com> \|
	16	+-----------------------------------------------------------------------+
	17
	18	$Id$
	19
	20	*/
	21
	22	require_once('lib/des.inc');
0af7e8	23	require_once('lib/utf7.inc');
83dbb7	24	require_once('lib/utf8.class.php');
4e17e6	25
T	26
ea7c46	27	// define constannts for input reading
T	28	define('RCUBE_INPUT_GET', 0x0101);
	29	define('RCUBE_INPUT_POST', 0x0102);
	30	define('RCUBE_INPUT_GPC', 0x0103);
	31
	32
4e17e6	33	// register session and connect to server
T	34	function rcmail_startup($task='mail')
	35	{
	36	global $sess_id, $sess_auth, $sess_user_lang;
	37	global $CONFIG, $INSTALL_PATH, $BROWSER, $OUTPUT, $_SESSION, $IMAP, $DB, $JS_OBJECT_NAME;
	38
	39	// check client
	40	$BROWSER = rcube_browser();
de2e1e	41
4e17e6	42	// load config file
T	43	include_once('config/main.inc.php');
	44	$CONFIG = is_array($rcmail_config) ? $rcmail_config : array();
9606ff	45
T	46	// load host-specific configuration
b068a0	47	rcmail_load_host_config($CONFIG);
9606ff	48
bac7d1	49	$CONFIG['skin_path'] = $CONFIG['skin_path'] ? unslashify($CONFIG['skin_path']) : 'skins/default';
4e17e6	50
T	51	// load db conf
	52	include_once('config/db.inc.php');
	53	$CONFIG = array_merge($CONFIG, $rcmail_config);
	54
fd8c50	55	if (empty($CONFIG['log_dir']))
T	56	$CONFIG['log_dir'] = $INSTALL_PATH.'logs';
	57	else
bac7d1	58	$CONFIG['log_dir'] = unslashify($CONFIG['log_dir']);
4e17e6	59
T	60	// set PHP error logging according to config
	61	if ($CONFIG['debug_level'] & 1)
	62	{
	63	ini_set('log_errors', 1);
fd8c50	64	ini_set('error_log', $CONFIG['log_dir'].'/errors');
4e17e6	65	}
T	66	if ($CONFIG['debug_level'] & 4)
	67	ini_set('display_errors', 1);
	68	else
	69	ini_set('display_errors', 0);
bac7d1	70
T	71
7902df	72	// set session garbage collecting time according to session_lifetime
T	73	if (!empty($CONFIG['session_lifetime']))
	74	ini_set('session.gc_maxlifetime', ($CONFIG['session_lifetime']+2)*60);
4e17e6	75
T	76
	77	// prepare DB connection
f45ec7	78	require_once('include/rcube_'.(empty($CONFIG['db_backend']) ? 'db' : $CONFIG['db_backend']).'.inc');
S	79
8c2e58	80	$DB = new rcube_db($CONFIG['db_dsnw'], $CONFIG['db_dsnr'], $CONFIG['db_persistent']);
42b113	81	$DB->sqlite_initials = $INSTALL_PATH.'SQL/sqlite.initial.sql';
8affba	82	$DB->db_connect('w');
T	83
4e17e6	84	// we can use the database for storing session data
d2a9db	85	if (!$DB->is_error())
4e17e6	86	include_once('include/session.inc');
T	87
	88	// init session
	89	session_start();
	90	$sess_id = session_id();
de8c61	91
4e17e6	92	// create session and set session vars
bac7d1	93	if (!isset($_SESSION['auth_time']))
4e17e6	94	{
0af7e8	95	$_SESSION['user_lang'] = rcube_language_prop($CONFIG['locale_string']);
4e17e6	96	$_SESSION['auth_time'] = mktime();
bac7d1	97	setcookie('sessauth', rcmail_auth_hash($sess_id, $_SESSION['auth_time']));
4e17e6	98	}
T	99
	100	// set session vars global
0af7e8	101	$sess_user_lang = rcube_language_prop($_SESSION['user_lang']);
4e17e6	102
T	103
	104	// overwrite config with user preferences
	105	if (is_array($_SESSION['user_prefs']))
	106	$CONFIG = array_merge($CONFIG, $_SESSION['user_prefs']);
	107
	108
	109	// reset some session parameters when changing task
	110	if ($_SESSION['task'] != $task)
	111	unset($_SESSION['page']);
	112
	113	// set current task to session
	114	$_SESSION['task'] = $task;
	115
	116	// create IMAP object
	117	if ($task=='mail')
	118	rcmail_imap_init();
	119
	120
	121	// set localization
	122	if ($CONFIG['locale_string'])
	123	setlocale(LC_ALL, $CONFIG['locale_string']);
	124	else if ($sess_user_lang)
	125	setlocale(LC_ALL, $sess_user_lang);
	126
	127
	128	register_shutdown_function('rcmail_shutdown');
	129	}
9606ff	130
T	131
	132	// load a host-specific config file if configured
	133	function rcmail_load_host_config(&$config)
	134	{
	135	$fname = NULL;
	136
	137	if (is_array($config['include_host_config']))
	138	$fname = $config['include_host_config'][$_SERVER['HTTP_HOST']];
	139	else if (!empty($config['include_host_config']))
	140	$fname = preg_replace('/[^a-z0-9\.\-_]/i', '', $_SERVER['HTTP_HOST']) . '.inc.php';
	141
	142	if ($fname && is_file('config/'.$fname))
	143	{
	144	include('config/'.$fname);
	145	$config = array_merge($config, $rcmail_config);
	146	}
	147	}
bac7d1	148
4e17e6	149
T	150	// create authorization hash
	151	function rcmail_auth_hash($sess_id, $ts)
	152	{
	153	global $CONFIG;
	154
	155	$auth_string = sprintf('rcmailsess%sR%sChk:%s;%s',
	156	$sess_id,
	157	$ts,
	158	$CONFIG['ip_check'] ? $_SERVER['REMOTE_ADDR'] : '*...*',
	159	$_SERVER['HTTP_USER_AGENT']);
	160
	161	if (function_exists('sha1'))
	162	return sha1($auth_string);
	163	else
	164	return md5($auth_string);
	165	}
	166
bac7d1	167
T	168	// compare the auth hash sent by the client with the local session credentials
	169	function rcmail_authenticate_session()
	170	{
	171	$now = mktime();
	172	$valid = ($_COOKIE['sessauth'] == rcmail_auth_hash(session_id(), $_SESSION['auth_time']));
aade7b	173
T	174	// renew auth cookie every 5 minutes (only for GET requests)
	175	if (!$valid \|\| ($_SERVER['REQUEST_METHOD']!='POST' && $now-$_SESSION['auth_time'] > 300))
bac7d1	176	{
T	177	$_SESSION['auth_time'] = $now;
	178	setcookie('sessauth', rcmail_auth_hash(session_id(), $now));
	179	}
	180
	181	return $valid;
	182	}
4e17e6	183
T	184
	185	// create IMAP object and connect to server
	186	function rcmail_imap_init($connect=FALSE)
	187	{
1cded8	188	global $CONFIG, $DB, $IMAP;
6dc026	189
1cded8	190	$IMAP = new rcube_imap($DB);
15a9d1	191	$IMAP->debug_level = $CONFIG['debug_level'];
T	192	$IMAP->skip_deleted = $CONFIG['skip_deleted'];
	193
4e17e6	194
7902df	195	// connect with stored session data
T	196	if ($connect)
	197	{
	198	if (!($conn = $IMAP->connect($_SESSION['imap_host'], $_SESSION['username'], decrypt_passwd($_SESSION['password']), $_SESSION['imap_port'], $_SESSION['imap_ssl'])))
	199	show_message('imaperror', 'error');
	200
	201	rcmail_set_imap_prop();
	202	}
	203
6dc026	204	// enable caching of imap data
T	205	if ($CONFIG['enable_caching']===TRUE)
	206	$IMAP->set_caching(TRUE);
	207
4e17e6	208	// set pagesize from config
T	209	if (isset($CONFIG['pagesize']))
	210	$IMAP->set_pagesize($CONFIG['pagesize']);
7902df	211	}
4e17e6	212
T	213
7902df	214	// set root dir and last stored mailbox
T	215	// this must be done AFTER connecting to the server
	216	function rcmail_set_imap_prop()
	217	{
	218	global $CONFIG, $IMAP;
	219
	220	// set root dir from config
620439	221	if (!empty($CONFIG['imap_root']))
7902df	222	$IMAP->set_rootdir($CONFIG['imap_root']);
fa4cd2	223
T	224	if (is_array($CONFIG['default_imap_folders']))
	225	$IMAP->set_default_mailboxes($CONFIG['default_imap_folders']);
7902df	226
620439	227	if (!empty($_SESSION['mbox']))
7902df	228	$IMAP->set_mailbox($_SESSION['mbox']);
T	229	if (isset($_SESSION['page']))
	230	$IMAP->set_page($_SESSION['page']);
4e17e6	231	}
T	232
	233
	234	// do these things on script shutdown
	235	function rcmail_shutdown()
	236	{
	237	global $IMAP;
	238
	239	if (is_object($IMAP))
	240	{
	241	$IMAP->close();
	242	$IMAP->write_cache();
	243	}
0af7e8	244
T	245	// before closing the database connection, write session data
	246	session_write_close();
4e17e6	247	}
T	248
	249
	250	// destroy session data and remove cookie
	251	function rcmail_kill_session()
	252	{
86f172	253	// save user preferences
T	254	$a_user_prefs = $_SESSION['user_prefs'];
	255	if (!is_array($a_user_prefs))
	256	$a_user_prefs = array();
	257
	258	if ((isset($_SESSION['sort_col']) && $_SESSION['sort_col']!=$a_user_prefs['message_sort_col']) \|\|
	259	(isset($_SESSION['sort_order']) && $_SESSION['sort_order']!=$a_user_prefs['message_sort_order']))
	260	{
	261	$a_user_prefs['message_sort_col'] = $_SESSION['sort_col'];
	262	$a_user_prefs['message_sort_order'] = $_SESSION['sort_order'];
	263	rcmail_save_user_prefs($a_user_prefs);
	264	}
	265
4e17e6	266	$_SESSION = array();
T	267	session_destroy();
	268	}
	269
	270
	271	// return correct name for a specific database table
	272	function get_table_name($table)
	273	{
	274	global $CONFIG;
	275
	276	// return table name if configured
	277	$config_key = 'db_table_'.$table;
	278
	279	if (strlen($CONFIG[$config_key]))
	280	return $CONFIG[$config_key];
	281
	282	return $table;
	283	}
	284
	285
1cded8	286	// return correct name for a specific database sequence
T	287	// (used for Postres only)
	288	function get_sequence_name($sequence)
	289	{
	290	global $CONFIG;
	291
	292	// return table name if configured
	293	$config_key = 'db_sequence_'.$sequence;
	294
	295	if (strlen($CONFIG[$config_key]))
	296	return $CONFIG[$config_key];
	297
	298	return $table;
	299	}
0af7e8	300
T	301
	302	// check the given string and returns language properties
	303	function rcube_language_prop($lang, $prop='lang')
	304	{
c8c1e0	305	global $INSTALL_PATH;
0af7e8	306	static $rcube_languages, $rcube_language_aliases, $rcube_charsets;
T	307
	308	if (empty($rcube_languages))
c8c1e0	309	@include($INSTALL_PATH.'program/localization/index.inc');
0af7e8	310
T	311	// check if we have an alias for that language
	312	if (!isset($rcube_languages[$lang]) && isset($rcube_language_aliases[$lang]))
	313	$lang = $rcube_language_aliases[$lang];
	314
	315	// try the first two chars
f88d41	316	if (!isset($rcube_languages[$lang]) && strlen($lang)>2)
0af7e8	317	{
T	318	$lang = substr($lang, 0, 2);
	319	$lang = rcube_language_prop($lang);
	320	}
	321
	322	if (!isset($rcube_languages[$lang]))
	323	$lang = 'en_US';
	324
	325	// language has special charset configured
	326	if (isset($rcube_charsets[$lang]))
	327	$charset = $rcube_charsets[$lang];
	328	else
	329	$charset = 'UTF-8';
f88d41	330
0af7e8	331
T	332	if ($prop=='charset')
	333	return $charset;
	334	else
	335	return $lang;
	336	}
1cded8	337
4e17e6	338
T	339	// init output object for GUI and add common scripts
	340	function load_gui()
	341	{
3f9edb	342	global $CONFIG, $OUTPUT, $COMM_PATH, $JS_OBJECT_NAME, $sess_user_lang;
4e17e6	343
T	344	// init output page
	345	$OUTPUT = new rcube_html_page();
	346
	347	// add common javascripts
	348	$javascript = "var $JS_OBJECT_NAME = new rcube_webmail();\n";
	349	$javascript .= "$JS_OBJECT_NAME.set_env('comm_path', '$COMM_PATH');\n";
	350
97a915	351	if (isset($CONFIG['javascript_config'] )){
S	352	foreach ($CONFIG['javascript_config'] as $js_config_var){
	353	$javascript .= "$JS_OBJECT_NAME.set_env('$js_config_var', '" . $CONFIG[$js_config_var] . "');\n";
	354	}
de8c61	355	}
S	356
597170	357	if (!empty($GLOBALS['_framed']))
4e17e6	358	$javascript .= "$JS_OBJECT_NAME.set_env('framed', true);\n";
7cc38e	359
4e17e6	360	$OUTPUT->add_script($javascript);
dd53e2	361	$OUTPUT->include_script('common.js');
T	362	$OUTPUT->include_script('app.js');
	363	$OUTPUT->scripts_path = 'program/js/';
7cc38e	364
13c1af	365	// set locale setting
T	366	rcmail_set_locale($sess_user_lang);
	367
7cc38e	368	// set user-selected charset
5bc8cb	369	if (!empty($CONFIG['charset']))
7cc38e	370	$OUTPUT->set_charset($CONFIG['charset']);
0af7e8	371
10a699	372	// add some basic label to client
c8c1e0	373	rcube_add_label('loading','checkingmail');
0af7e8	374	}
7cc38e	375
T	376
	377	// set localization charset based on the given language
	378	function rcmail_set_locale($lang)
	379	{
5f56a5	380	global $OUTPUT, $MBSTRING;
f88d41	381	static $s_mbstring_loaded = NULL;
T	382
	383	// settings for mbstring module (by Tadashi Jokagi)
5f56a5	384	if (is_null($s_mbstring_loaded))
T	385	$MBSTRING = $s_mbstring_loaded = extension_loaded("mbstring");
	386	else
	387	$MBSTRING = $s_mbstring_loaded = FALSE;
f88d41	388
3f9edb	389	$OUTPUT->set_charset(rcube_language_prop($lang, 'charset'));
7cc38e	390	}
4e17e6	391
T	392
	393	// perfom login to the IMAP server and to the webmail service
	394	function rcmail_login($user, $pass, $host=NULL)
	395	{
	396	global $CONFIG, $IMAP, $DB, $sess_user_lang;
42b113	397	$user_id = NULL;
4e17e6	398
T	399	if (!$host)
	400	$host = $CONFIG['default_host'];
	401
f619de	402	// parse $host URL
T	403	$a_host = parse_url($host);
	404	if ($a_host['host'])
	405	{
	406	$host = $a_host['host'];
	407	$imap_ssl = (isset($a_host['scheme']) && in_array($a_host['scheme'], array('ssl','imaps','tls'))) ? TRUE : FALSE;
	408	$imap_port = isset($a_host['port']) ? $a_host['port'] : ($imap_ssl ? 993 : $CONFIG['default_port']);
	409	}
ea7c46	410	else
T	411	$imap_port = $CONFIG['default_port'];
f619de	412
026d68	413
T	414	/* Modify username with domain if required
	415	Inspired by Marco <P0L0_notspam_binware.org>
	416	*/
	417	// Check if we need to add domain
996066	418	if (!empty($CONFIG['username_domain']) && !strstr($user, '@'))
026d68	419	{
T	420	if (is_array($CONFIG['username_domain']) && isset($CONFIG['username_domain'][$host]))
	421	$user .= '@'.$CONFIG['username_domain'][$host];
996066	422	else if (is_string($CONFIG['username_domain']))
T	423	$user .= '@'.$CONFIG['username_domain'];
026d68	424	}
T	425
	426
4e17e6	427	// query if user already registered
d7cb77	428	$sql_result = $DB->query("SELECT user_id, username, language, preferences
S	429	FROM ".get_table_name('users')."
	430	WHERE mail_host=? AND (username=? OR alias=?)",
	431	$host,
	432	$user,
	433	$user);
4e17e6	434
42b113	435	// user already registered -> overwrite username
4e17e6	436	if ($sql_arr = $DB->fetch_assoc($sql_result))
T	437	{
	438	$user_id = $sql_arr['user_id'];
42b113	439	$user = $sql_arr['username'];
T	440	}
	441
977a29	442	// try to resolve email address from virtuser table
T	443	if (!empty($CONFIG['virtuser_file']) && strstr($user, '@'))
	444	$user = rcmail_email2user($user);
	445
	446
42b113	447	// exit if IMAP login failed
T	448	if (!($imap_login = $IMAP->connect($host, $user, $pass, $imap_port, $imap_ssl)))
	449	return FALSE;
	450
	451	// user already registered
	452	if ($user_id && !empty($sql_arr))
	453	{
4e17e6	454	// get user prefs
T	455	if (strlen($sql_arr['preferences']))
	456	{
	457	$user_prefs = unserialize($sql_arr['preferences']);
	458	$_SESSION['user_prefs'] = $user_prefs;
	459	array_merge($CONFIG, $user_prefs);
	460	}
	461
f3b659	462
4e17e6	463	// set user specific language
T	464	if (strlen($sql_arr['language']))
	465	$sess_user_lang = $_SESSION['user_lang'] = $sql_arr['language'];
f3b659	466
4e17e6	467	// update user's record
d7cb77	468	$DB->query("UPDATE ".get_table_name('users')."
107bde	469	SET last_login=".$DB->now()."
d7cb77	470	WHERE user_id=?",
S	471	$user_id);
4e17e6	472	}
T	473	// create new system user
	474	else if ($CONFIG['auto_create_user'])
	475	{
	476	$user_id = rcmail_create_user($user, $host);
	477	}
	478
	479	if ($user_id)
	480	{
	481	$_SESSION['user_id'] = $user_id;
	482	$_SESSION['imap_host'] = $host;
7902df	483	$_SESSION['imap_port'] = $imap_port;
T	484	$_SESSION['imap_ssl'] = $imap_ssl;
4e17e6	485	$_SESSION['username'] = $user;
f3b659	486	$_SESSION['user_lang'] = $sess_user_lang;
4e17e6	487	$_SESSION['password'] = encrypt_passwd($pass);
T	488
fa4cd2	489	// force reloading complete list of subscribed mailboxes
T	490	rcmail_set_imap_prop();
4e17e6	491	$IMAP->clear_cache('mailboxes');
fa4cd2	492	$IMAP->create_default_folders();
4e17e6	493
T	494	return TRUE;
	495	}
	496
	497	return FALSE;
	498	}
	499
	500
	501	// create new entry in users and identities table
	502	function rcmail_create_user($user, $host)
	503	{
	504	global $DB, $CONFIG, $IMAP;
977a29	505
T	506	$user_email = '';
	507
	508	// try to resolve user in virtusertable
	509	if (!empty($CONFIG['virtuser_file']) && strstr($user, '@')==FALSE)
	510	$user_email = rcmail_user2email($user);
	511
d7cb77	512	$DB->query("INSERT INTO ".get_table_name('users')."
977a29	513	(created, last_login, username, mail_host, alias, language)
107bde	514	VALUES (".$DB->now().", ".$DB->now().", ?, ?, ?, ?)",
d7cb77	515	$user,
S	516	$host,
977a29	517	$user_email,
d7cb77	518	$_SESSION['user_lang']);
4e17e6	519
1cded8	520	if ($user_id = $DB->insert_id(get_sequence_name('users')))
4e17e6	521	{
8cb245	522	$mail_domain = rcmail_mail_domain($host);
977a29	523
T	524	if ($user_email=='')
	525	$user_email = strstr($user, '@') ? $user : sprintf('%s@%s', $user, $mail_domain);
	526
52c1f2	527	$user_name = $user!=$user_email ? $user : '';
977a29	528
f88d41	529	// try to resolve the e-mail address from the virtuser table
T	530	if (!empty($CONFIG['virtuser_query']))
	531	{
	532	$sql_result = $DB->query(preg_replace('/%u/', $user, $CONFIG['virtuser_query']));
	533	if ($sql_arr = $DB->fetch_array($sql_result))
	534	$user_email = $sql_arr[0];
	535	}
	536
	537	// also create new identity records
d7cb77	538	$DB->query("INSERT INTO ".get_table_name('identities')."
1cded8	539	(user_id, del, standard, name, email)
T	540	VALUES (?, 0, 1, ?, ?)",
d7cb77	541	$user_id,
S	542	$user_name,
	543	$user_email);
f88d41	544
4e17e6	545
T	546	// get existing mailboxes
	547	$a_mailboxes = $IMAP->list_mailboxes();
42b113	548	}
T	549	else
	550	{
	551	raise_error(array('code' => 500,
	552	'type' => 'php',
	553	'line' => __LINE__,
	554	'file' => __FILE__,
	555	'message' => "Failed to create new user"), TRUE, FALSE);
4e17e6	556	}
T	557
	558	return $user_id;
	559	}
	560
	561
977a29	562	// load virtuser table in array
T	563	function rcmail_getvirtualfile()
	564	{
	565	global $CONFIG;
	566	if (empty($CONFIG['virtuser_file']) \|\| !is_file($CONFIG['virtuser_file']))
	567	return FALSE;
	568
	569	// read file
	570	$a_lines = file($CONFIG['virtuser_file']);
	571	return $a_lines;
	572	}
	573
	574
	575	// find matches of the given pattern in virtuser table
	576	function rcmail_findinvirtual($pattern)
	577	{
	578	$result = array();
	579	$virtual = rcmail_getvirtualfile();
	580	if ($virtual==FALSE)
	581	return $result;
	582
	583	// check each line for matches
	584	foreach ($virtual as $line)
	585	{
	586	$line = trim($line);
	587	if (empty($line) \|\| $line{0}=='#')
	588	continue;
	589
	590	if (eregi($pattern, $line))
	591	$result[] = $line;
	592	}
	593
	594	return $result;
	595	}
	596
	597
	598	// resolve username with virtuser table
	599	function rcmail_email2user($email)
	600	{
	601	$user = $email;
	602	$r = rcmail_findinvirtual("^$email");
	603
	604	for ($i=0; $i<count($r); $i++)
	605	{
	606	$data = $r[$i];
	607	$arr = preg_split('/\s+/', $data);
	608	if(count($arr)>0)
	609	{
	610	$user = trim($arr[count($arr)-1]);
	611	break;
	612	}
	613	}
	614
	615	return $user;
	616	}
	617
	618
	619	// resolve e-mail address with virtuser table
	620	function rcmail_user2email($user)
	621	{
	622	$email = "";
	623	$r = rcmail_findinvirtual("$user$");
	624
	625	for ($i=0; $i<count($r); $i++)
	626	{
	627	$data=$r[$i];
	628	$arr = preg_split('/\s+/', $data);
	629	if (count($arr)>0)
	630	{
	631	$email = trim($arr[0]);
	632	break;
	633	}
	634	}
	635
	636	return $email;
	637	}
	638
	639
86f172	640	function rcmail_save_user_prefs($a_user_prefs)
T	641	{
	642	global $DB, $CONFIG, $sess_user_lang;
	643
	644	$DB->query("UPDATE ".get_table_name('users')."
	645	SET preferences=?,
	646	language=?
	647	WHERE user_id=?",
	648	serialize($a_user_prefs),
	649	$sess_user_lang,
	650	$_SESSION['user_id']);
	651
	652	if ($DB->affected_rows())
	653	{
	654	$_SESSION['user_prefs'] = $a_user_prefs;
	655	$CONFIG = array_merge($CONFIG, $a_user_prefs);
	656	return TRUE;
	657	}
	658
	659	return FALSE;
	660	}
	661
	662
10a699	663	// overwrite action variable
T	664	function rcmail_overwrite_action($action)
	665	{
	666	global $OUTPUT, $JS_OBJECT_NAME;
	667	$GLOBALS['_action'] = $action;
	668
	669	$OUTPUT->add_script(sprintf("\n%s.set_env('action', '%s');", $JS_OBJECT_NAME, $action));
	670	}
	671
	672
4647e1	673	function show_message($message, $type='notice', $vars=NULL)
4e17e6	674	{
T	675	global $OUTPUT, $JS_OBJECT_NAME, $REMOTE_REQUEST;
4647e1	676
597170	677	$framed = $GLOBALS['_framed'];
4e17e6	678	$command = sprintf("display_message('%s', '%s');",
c39957	679	rep_specialchars_output(rcube_label(array('name' => $message, 'vars' => $vars)), 'js'),
4e17e6	680	$type);
T	681
	682	if ($REMOTE_REQUEST)
	683	return 'this.'.$command;
	684
	685	else
41fa0b	686	$OUTPUT->add_script(sprintf("%s%s.%s\n",
4e17e6	687	$framed ? sprintf('if(parent.%s)parent.', $JS_OBJECT_NAME) : '',
T	688	$JS_OBJECT_NAME,
	689	$command));
	690	}
	691
	692
bac7d1	693	// encrypt IMAP password using DES encryption
4e17e6	694	function encrypt_passwd($pass)
T	695	{
bac7d1	696	$cypher = des(get_des_key(), $pass, 1, 0, NULL);
4e17e6	697	return base64_encode($cypher);
T	698	}
	699
	700
bac7d1	701	// decrypt IMAP password using DES encryption
4e17e6	702	function decrypt_passwd($cypher)
T	703	{
bac7d1	704	$pass = des(get_des_key(), base64_decode($cypher), 0, 0, NULL);
T	705	return preg_replace('/\x00/', '', $pass);
	706	}
	707
	708
	709	// return a 24 byte key for the DES encryption
	710	function get_des_key()
	711	{
	712	$key = !empty($GLOBALS['CONFIG']['des_key']) ? $GLOBALS['CONFIG']['des_key'] : 'rcmail?24BitPwDkeyF**ECB';
	713	$len = strlen($key);
	714
	715	// make sure the key is exactly 24 chars long
	716	if ($len<24)
	717	$key .= str_repeat('_', 24-$len);
	718	else if ($len>24)
	719	substr($key, 0, 24);
	720
	721	return $key;
4e17e6	722	}
T	723
	724
	725	// send correct response on a remote request
15a9d1	726	function rcube_remote_response($js_code, $flush=FALSE)
4e17e6	727	{
13c1af	728	global $OUTPUT, $CHARSET;
15a9d1	729	static $s_header_sent = FALSE;
T	730
	731	if (!$s_header_sent)
	732	{
	733	$s_header_sent = TRUE;
	734	send_nocacheing_headers();
ded2b7	735	header('Content-Type: application/x-javascript; charset='.$CHARSET);
15a9d1	736	print '/ remote response ['.date('d/M/Y h:i:s O')."] /\n";
T	737	}
4e17e6	738
15a9d1	739	// send response code
13c1af	740	print rcube_charset_convert($js_code, $CHARSET, $OUTPUT->get_charset());
15a9d1	741
T	742	if ($flush) // flush the output buffer
	743	flush();
	744	else // terminate script
	745	exit;
4e17e6	746	}
T	747
	748
41fa0b	749	// send correctly formatted response for a request posted to an iframe
T	750	function rcube_iframe_response($js_code='')
	751	{
	752	global $OUTPUT, $JS_OBJECT_NAME;
	753
	754	if (!empty($js_code))
	755	$OUTPUT->add_script("if(parent.$JS_OBJECT_NAME){\n" . $js_code . "\n}");
	756
	757	$OUTPUT->write();
	758	exit;
	759	}
	760
	761
9fee0e	762	// read directory program/localization/ and return a list of available languages
T	763	function rcube_list_languages()
	764	{
	765	global $CONFIG, $INSTALL_PATH;
	766	static $sa_languages = array();
	767
	768	if (!sizeof($sa_languages))
	769	{
c8c1e0	770	@include($INSTALL_PATH.'program/localization/index.inc');
9fee0e	771
c8c1e0	772	if ($dh = @opendir($INSTALL_PATH.'program/localization'))
9fee0e	773	{
T	774	while (($name = readdir($dh)) !== false)
	775	{
c8c1e0	776	if ($name{0}=='.' \|\| !is_dir($INSTALL_PATH.'program/localization/'.$name))
9fee0e	777	continue;
T	778
	779	if ($label = $rcube_languages[$name])
	780	$sa_languages[$name] = $label ? $label : $name;
	781	}
	782	closedir($dh);
	783	}
	784	}
	785	return $sa_languages;
	786	}
	787
4e17e6	788
10a699	789	// add a localized label to the client environment
T	790	function rcube_add_label()
	791	{
	792	global $OUTPUT, $JS_OBJECT_NAME;
	793
	794	$arg_list = func_get_args();
	795	foreach ($arg_list as $i => $name)
	796	$OUTPUT->add_script(sprintf("%s.add_label('%s', '%s');",
	797	$JS_OBJECT_NAME,
	798	$name,
	799	rep_specialchars_output(rcube_label($name), 'js')));
1cded8	800	}
T	801
	802
	803	// remove temp files of a session
	804	function rcmail_clear_session_temp($sess_id)
	805	{
	806	global $CONFIG;
	807
bac7d1	808	$temp_dir = slashify($CONFIG['temp_dir']);
1cded8	809	$cache_dir = $temp_dir.$sess_id;
T	810
	811	if (is_dir($cache_dir))
	812	{
	813	clear_directory($cache_dir);
	814	rmdir($cache_dir);
	815	}
	816	}
	817
	818
cc9570	819	// remove all expired message cache records
T	820	function rcmail_message_cache_gc()
	821	{
	822	global $DB, $CONFIG;
	823
	824	// no cache lifetime configured
	825	if (empty($CONFIG['message_cache_lifetime']))
	826	return;
	827
	828	// get target timestamp
	829	$ts = get_offset_time($CONFIG['message_cache_lifetime'], -1);
	830
	831	$DB->query("DELETE FROM ".get_table_name('messages')."
	832	WHERE created < ".$DB->fromunixtime($ts));
	833	}
	834
1cded8	835
3f9edb	836	// convert a string from one charset to another
T	837	// this function is not complete and not tested well
	838	function rcube_charset_convert($str, $from, $to=NULL)
0af7e8	839	{
5f56a5	840	global $MBSTRING;
f88d41	841
83dbb7	842	$from = strtoupper($from);
T	843	$to = $to==NULL ? strtoupper($GLOBALS['CHARSET']) : strtoupper($to);
f88d41	844
5f56a5	845	if ($from==$to \|\| $str=='')
3f9edb	846	return $str;
5f56a5	847
f88d41	848	// convert charset using mbstring module
T	849	if ($MBSTRING)
	850	{
	851	$to = $to=="UTF-7" ? "UTF7-IMAP" : $to;
	852	$from = $from=="UTF-7" ? "UTF7-IMAP": $from;
5f56a5	853
T	854	// return if convert succeeded
	855	if (($out = mb_convert_encoding($str, $to, $from)) != '')
	856	return $out;
83dbb7	857	}
f88d41	858
T	859	// convert charset using iconv module
	860	if (function_exists('iconv') && $from!='UTF-7' && $to!='UTF-7')
	861	return iconv($from, $to, $str);
58e360	862
T	863	$conv = new utf8();
	864
83dbb7	865	// convert string to UTF-8
T	866	if ($from=='UTF-7')
	867	$str = rcube_charset_convert(UTF7DecodeString($str), 'ISO-8859-1');
4d4264	868	else if (($from=='ISO-8859-1') && function_exists('utf8_encode'))
83dbb7	869	$str = utf8_encode($str);
T	870	else if ($from!='UTF-8')
	871	{
58e360	872	$conv->loadCharset($from);
83dbb7	873	$str = $conv->strToUtf8($str);
T	874	}
0af7e8	875
3f9edb	876	// encode string for output
83dbb7	877	if ($to=='UTF-7')
4d4264	878	return UTF7EncodeString(rcube_charset_convert($str, 'UTF-8', 'ISO-8859-1'));
83dbb7	879	else if ($to=='ISO-8859-1' && function_exists('utf8_decode'))
T	880	return utf8_decode($str);
	881	else if ($to!='UTF-8')
	882	{
58e360	883	$conv->loadCharset($to);
83dbb7	884	return $conv->utf8ToStr($str);
T	885	}
3f9edb	886
83dbb7	887	// return UTF-8 string
3f9edb	888	return $str;
0af7e8	889	}
3f9edb	890
0af7e8	891
T	892
1cded8	893	// replace specials characters to a specific encoding type
T	894	function rep_specialchars_output($str, $enctype='', $mode='', $newlines=TRUE)
	895	{
3f9edb	896	global $OUTPUT_TYPE, $OUTPUT;
1cded8	897	static $html_encode_arr, $js_rep_table, $rtf_rep_table, $xml_rep_table;
T	898
	899	if (!$enctype)
	900	$enctype = $GLOBALS['OUTPUT_TYPE'];
	901
	902	// convert nbsps back to normal spaces if not html
	903	if ($enctype!='html')
	904	$str = str_replace(chr(160), ' ', $str);
	905
	906	// encode for plaintext
	907	if ($enctype=='text')
	908	return str_replace("\r\n", "\n", $mode=='remove' ? strip_tags($str) : $str);
	909
	910	// encode for HTML output
	911	if ($enctype=='html')
	912	{
	913	if (!$html_encode_arr)
	914	{
0af7e8	915	$html_encode_arr = get_html_translation_table(HTML_SPECIALCHARS);
1cded8	916	unset($html_encode_arr['?']);
T	917	}
	918
	919	$ltpos = strpos($str, '<');
	920	$encode_arr = $html_encode_arr;
	921
	922	// don't replace quotes and html tags
	923	if (($mode=='show' \|\| $mode=='') && $ltpos!==false && strpos($str, '>', $ltpos)!==false)
	924	{
	925	unset($encode_arr['"']);
	926	unset($encode_arr['<']);
	927	unset($encode_arr['>']);
10c92b	928	unset($encode_arr['&']);
1cded8	929	}
T	930	else if ($mode=='remove')
	931	$str = strip_tags($str);
	932
	933	$out = strtr($str, $encode_arr);
0af7e8	934
1cded8	935	return $newlines ? nl2br($out) : $out;
T	936	}
	937
	938
	939	if ($enctype=='url')
	940	return rawurlencode($str);
	941
	942
	943	// if the replace tables for RTF, XML and JS are not yet defined
	944	if (!$js_rep_table)
	945	{
	946	$js_rep_table = $rtf_rep_table = $xml_rep_table = array();
88375f	947	$xml_rep_table['&'] = '&';
1cded8	948
T	949	for ($c=160; $c<256; $c++) // can be increased to support more charsets
	950	{
	951	$hex = dechex($c);
	952	$rtf_rep_table[Chr($c)] = "\\'$hex";
	953	$xml_rep_table[Chr($c)] = "&#$c;";
	954
3f9edb	955	if ($OUTPUT->get_charset()=='ISO-8859-1')
1cded8	956	$js_rep_table[Chr($c)] = sprintf("\u%s%s", str_repeat('0', 4-strlen($hex)), $hex);
T	957	}
	958
	959	$js_rep_table['"'] = sprintf("\u%s%s", str_repeat('0', 4-strlen(dechex(34))), dechex(34));
	960	$xml_rep_table['"'] = '"';
	961	}
	962
	963	// encode for RTF
	964	if ($enctype=='xml')
	965	return strtr($str, $xml_rep_table);
	966
	967	// encode for javascript use
	968	if ($enctype=='js')
13c1af	969	{
T	970	if ($OUTPUT->get_charset()!='UTF-8')
	971	$str = rcube_charset_convert($str, $GLOBALS['CHARSET'], $OUTPUT->get_charset());
	972
c39957	973	return addslashes(preg_replace(array("/\r\n/", "/\r/"), array('\n', '\n'), strtr($str, $js_rep_table)));
13c1af	974	}
1cded8	975
T	976	// encode for RTF
	977	if ($enctype=='rtf')
	978	return preg_replace("/\r\n/", "\par ", strtr($str, $rtf_rep_table));
	979
	980	// no encoding given -> return original string
	981	return $str;
10a699	982	}
ea7c46	983
T	984
	985	/**
	986	* Read input value and convert it for internal use
	987	* Performs stripslashes() and charset conversion if necessary
	988	*
	989	* @param string Field name to read
	990	* @param int Source to get value from (GPC)
	991	* @param boolean Allow HTML tags in field value
	992	* @param string Charset to convert into
	993	* @return string Field value or NULL if not available
	994	*/
	995	function get_input_value($fname, $source, $allow_html=FALSE, $charset=NULL)
	996	{
	997	global $OUTPUT;
	998	$value = NULL;
	999
	1000	if ($source==RCUBE_INPUT_GET && isset($_GET[$fname]))
	1001	$value = $_GET[$fname];
	1002	else if ($source==RCUBE_INPUT_POST && isset($_POST[$fname]))
	1003	$value = $_POST[$fname];
	1004	else if ($source==RCUBE_INPUT_GPC)
	1005	{
026d68	1006	if (isset($_POST[$fname]))
ea7c46	1007	$value = $_POST[$fname];
026d68	1008	else if (isset($_GET[$fname]))
T	1009	$value = $_GET[$fname];
ea7c46	1010	else if (isset($_COOKIE[$fname]))
T	1011	$value = $_COOKIE[$fname];
	1012	}
	1013
	1014	// strip slashes if magic_quotes enabled
	1015	if ((bool)get_magic_quotes_gpc())
	1016	$value = stripslashes($value);
	1017
	1018	// remove HTML tags if not allowed
	1019	if (!$allow_html)
	1020	$value = strip_tags($value);
	1021
	1022	// convert to internal charset
026d68	1023	if (is_object($OUTPUT))
T	1024	return rcube_charset_convert($value, $OUTPUT->get_charset(), $charset);
	1025	else
	1026	return $value;
ea7c46	1027	}
T	1028
10a699	1029
T	1030
4e17e6	1031
T	1032	// ************ template parsing and gui functions ************
	1033
	1034
	1035	// return boolean if a specific template exists
	1036	function template_exists($name)
	1037	{
	1038	global $CONFIG, $OUTPUT;
	1039	$skin_path = $CONFIG['skin_path'];
	1040
	1041	// check template file
	1042	return is_file("$skin_path/templates/$name.html");
	1043	}
	1044
	1045
	1046	// get page template an replace variable
	1047	// similar function as used in nexImage
	1048	function parse_template($name='main', $exit=TRUE)
	1049	{
	1050	global $CONFIG, $OUTPUT;
	1051	$skin_path = $CONFIG['skin_path'];
	1052
	1053	// read template file
	1054	$templ = '';
	1055	$path = "$skin_path/templates/$name.html";
	1056
	1057	if($fp = @fopen($path, 'r'))
	1058	{
	1059	$templ = fread($fp, filesize($path));
	1060	fclose($fp);
	1061	}
	1062	else
	1063	{
	1064	raise_error(array('code' => 500,
	1065	'type' => 'php',
	1066	'line' => __LINE__,
	1067	'file' => __FILE__,
	1068	'message' => "Error loading template for '$name'"), TRUE, TRUE);
	1069	return FALSE;
	1070	}
	1071
	1072
	1073	// parse for specialtags
	1074	$output = parse_rcube_xml($templ);
	1075
	1076	$OUTPUT->write(trim(parse_with_globals($output)), $skin_path);
	1077
	1078	if ($exit)
	1079	exit;
	1080	}
	1081
	1082
	1083
	1084	// replace all strings ($varname) with the content of the according global variable
	1085	function parse_with_globals($input)
	1086	{
b595c9	1087	$GLOBALS['__comm_path'] = $GLOBALS['COMM_PATH'];
4e17e6	1088	$output = preg_replace('/\$(__[a-z0-9_\-]+)/e', '$GLOBALS["\\1"]', $input);
T	1089	return $output;
	1090	}
	1091
	1092
	1093
	1094	function parse_rcube_xml($input)
	1095	{
	1096	$output = preg_replace('/<roundcube:([-_a-z]+)\s+([^>]+)>/Uie', "rcube_xml_command('\\1', '\\2')", $input);
	1097	return $output;
	1098	}
	1099
	1100
fe79b1	1101	function rcube_xml_command($command, $str_attrib, $add_attrib=array())
4e17e6	1102	{
0af7e8	1103	global $IMAP, $CONFIG, $OUTPUT;
4e17e6	1104
T	1105	$command = strtolower($command);
fe79b1	1106	$attrib = parse_attrib_string($str_attrib) + $add_attrib;
4e17e6	1107
T	1108	// execute command
	1109	switch ($command)
	1110	{
	1111	// return a button
	1112	case 'button':
	1113	if ($attrib['command'])
	1114	return rcube_button($attrib);
	1115	break;
	1116
	1117	// show a label
	1118	case 'label':
	1119	if ($attrib['name'] \|\| $attrib['command'])
7dd801	1120	return rep_specialchars_output(rcube_label($attrib));
4e17e6	1121	break;
T	1122
	1123	// create a menu item
	1124	case 'menu':
	1125	if ($attrib['command'] && $attrib['group'])
	1126	rcube_menu($attrib);
	1127	break;
	1128
	1129	// include a file
	1130	case 'include':
	1131	$path = realpath($CONFIG['skin_path'].$attrib['file']);
	1132
	1133	if($fp = @fopen($path, 'r'))
	1134	{
	1135	$incl = fread($fp, filesize($path));
	1136	fclose($fp);
	1137	return parse_rcube_xml($incl);
	1138	}
	1139	break;
	1140
	1141	// return code for a specific application object
	1142	case 'object':
	1143	$object = strtolower($attrib['name']);
	1144
1cded8	1145	$object_handlers = array(
15a9d1	1146	// GENERAL
T	1147	'loginform' => 'rcmail_login_form',
	1148	'username' => 'rcmail_current_username',
	1149
1cded8	1150	// MAIL
T	1151	'mailboxlist' => 'rcmail_mailbox_list',
15a9d1	1152	'message' => 'rcmail_message_container',
1cded8	1153	'messages' => 'rcmail_message_list',
T	1154	'messagecountdisplay' => 'rcmail_messagecount_display',
58e360	1155	'quotadisplay' => 'rcmail_quota_display',
1cded8	1156	'messageheaders' => 'rcmail_message_headers',
T	1157	'messagebody' => 'rcmail_message_body',
	1158	'messageattachments' => 'rcmail_message_attachments',
	1159	'blockedobjects' => 'rcmail_remote_objects_msg',
	1160	'messagecontentframe' => 'rcmail_messagecontent_frame',
	1161	'messagepartframe' => 'rcmail_message_part_frame',
	1162	'messagepartcontrols' => 'rcmail_message_part_controls',
	1163	'composeheaders' => 'rcmail_compose_headers',
	1164	'composesubject' => 'rcmail_compose_subject',
	1165	'composebody' => 'rcmail_compose_body',
	1166	'composeattachmentlist' => 'rcmail_compose_attachment_list',
	1167	'composeattachmentform' => 'rcmail_compose_attachment_form',
	1168	'composeattachment' => 'rcmail_compose_attachment_field',
	1169	'priorityselector' => 'rcmail_priority_selector',
	1170	'charsetselector' => 'rcmail_charset_selector',
4647e1	1171	'searchform' => 'rcmail_search_form',
620439	1172	'receiptcheckbox' => 'rcmail_receipt_checkbox',
1cded8	1173
T	1174	// ADDRESS BOOK
	1175	'addresslist' => 'rcmail_contacts_list',
	1176	'addressframe' => 'rcmail_contact_frame',
	1177	'recordscountdisplay' => 'rcmail_rowcount_display',
	1178	'contactdetails' => 'rcmail_contact_details',
	1179	'contacteditform' => 'rcmail_contact_editform',
d1d2c4	1180	'ldappublicsearch' => 'rcmail_ldap_public_search_form',
S	1181	'ldappublicaddresslist' => 'rcmail_ldap_public_list',
1cded8	1182
T	1183	// USER SETTINGS
	1184	'userprefs' => 'rcmail_user_prefs_form',
	1185	'itentitieslist' => 'rcmail_identities_list',
	1186	'identityframe' => 'rcmail_identity_frame',
	1187	'identityform' => 'rcube_identity_form',
	1188	'foldersubscription' => 'rcube_subscription_form',
	1189	'createfolder' => 'rcube_create_folder_form',
fe79b1	1190	'renamefolder' => 'rcube_rename_folder_form',
1cded8	1191	'composebody' => 'rcmail_compose_body'
T	1192	);
	1193
	1194
	1195	// execute object handler function
15a9d1	1196	if ($object_handlers[$object] && function_exists($object_handlers[$object]))
1cded8	1197	return call_user_func($object_handlers[$object], $attrib);
8c2e58	1198
T	1199	else if ($object=='productname')
	1200	{
	1201	$name = !empty($CONFIG['product_name']) ? $CONFIG['product_name'] : 'RoundCube Webmail';
	1202	return rep_specialchars_output($name, 'html', 'all');
	1203	}
026d68	1204	else if ($object=='version')
T	1205	{
	1206	return (string)RCMAIL_VERSION;
	1207	}
4e17e6	1208	else if ($object=='pagetitle')
T	1209	{
	1210	$task = $GLOBALS['_task'];
15a9d1	1211	$title = !empty($CONFIG['product_name']) ? $CONFIG['product_name'].' :: ' : '';
T	1212
ded2b7	1213	if ($task=='login')
T	1214	$title = rcube_label(array('name' => 'welcome', 'vars' => array('product' => $CONFIG['product_name'])));
	1215	else if ($task=='mail' && isset($GLOBALS['MESSAGE']['subject']))
15a9d1	1216	$title .= $GLOBALS['MESSAGE']['subject'];
4e17e6	1217	else if (isset($GLOBALS['PAGE_TITLE']))
15a9d1	1218	$title .= $GLOBALS['PAGE_TITLE'];
4e17e6	1219	else if ($task=='mail' && ($mbox_name = $IMAP->get_mailbox_name()))
3f9edb	1220	$title .= rcube_charset_convert($mbox_name, 'UTF-7', 'UTF-8');
4e17e6	1221	else
ded2b7	1222	$title .= ucfirst($task);
15a9d1	1223
T	1224	return rep_specialchars_output($title, 'html', 'all');
4e17e6	1225	}
T	1226
	1227	break;
	1228	}
	1229
	1230	return '';
	1231	}
	1232
	1233
	1234	// create and register a button
	1235	function rcube_button($attrib)
	1236	{
8c2e58	1237	global $CONFIG, $OUTPUT, $JS_OBJECT_NAME, $BROWSER, $COMM_PATH, $MAIN_TASKS;
4e17e6	1238	static $sa_buttons = array();
T	1239	static $s_button_count = 100;
	1240
078adf	1241	// these commands can be called directly via url
T	1242	$a_static_commands = array('compose', 'list');
	1243
4e17e6	1244	$skin_path = $CONFIG['skin_path'];
T	1245
	1246	if (!($attrib['command'] \|\| $attrib['name']))
	1247	return '';
	1248
	1249	// try to find out the button type
	1250	if ($attrib['type'])
	1251	$attrib['type'] = strtolower($attrib['type']);
	1252	else
e21960	1253	$attrib['type'] = ($attrib['image'] \|\| $attrib['imagepas'] \|\| $arg['imageact']) ? 'image' : 'link';
4e17e6	1254
T	1255
	1256	$command = $attrib['command'];
	1257
	1258	// take the button from the stack
	1259	if($attrib['name'] && $sa_buttons[$attrib['name']])
	1260	$attrib = $sa_buttons[$attrib['name']];
	1261
	1262	// add button to button stack
e21960	1263	else if($attrib['image'] \|\| $arg['imageact'] \|\| $attrib['imagepas'] \|\| $attrib['class'])
4e17e6	1264	{
T	1265	if(!$attrib['name'])
	1266	$attrib['name'] = $command;
	1267
	1268	if (!$attrib['image'])
	1269	$attrib['image'] = $attrib['imagepas'] ? $attrib['imagepas'] : $attrib['imageact'];
	1270
	1271	$sa_buttons[$attrib['name']] = $attrib;
	1272	}
	1273
	1274	// get saved button for this command/name
	1275	else if ($command && $sa_buttons[$command])
	1276	$attrib = $sa_buttons[$command];
	1277
	1278	//else
	1279	// return '';
	1280
	1281
	1282	// set border to 0 because of the link arround the button
	1283	if ($attrib['type']=='image' && !isset($attrib['border']))
	1284	$attrib['border'] = 0;
	1285
	1286	if (!$attrib['id'])
	1287	$attrib['id'] = sprintf('rcmbtn%d', $s_button_count++);
	1288
	1289	// get localized text for labels and titles
	1290	if ($attrib['title'])
	1291	$attrib['title'] = rep_specialchars_output(rcube_label($attrib['title']));
	1292	if ($attrib['label'])
	1293	$attrib['label'] = rep_specialchars_output(rcube_label($attrib['label']));
	1294
	1295	if ($attrib['alt'])
	1296	$attrib['alt'] = rep_specialchars_output(rcube_label($attrib['alt']));
14eafe	1297
T	1298	// set title to alt attribute for IE browsers
	1299	if ($BROWSER['ie'] && $attrib['title'] && !$attrib['alt'])
	1300	{
	1301	$attrib['alt'] = $attrib['title'];
	1302	unset($attrib['title']);
	1303	}
	1304
4e17e6	1305	// add empty alt attribute for XHTML compatibility
T	1306	if (!isset($attrib['alt']))
	1307	$attrib['alt'] = '';
	1308
	1309
	1310	// register button in the system
	1311	if ($attrib['command'])
8c2e58	1312	{
4e17e6	1313	$OUTPUT->add_script(sprintf("%s.register_button('%s', '%s', '%s', '%s', '%s', '%s');",
T	1314	$JS_OBJECT_NAME,
	1315	$command,
	1316	$attrib['id'],
	1317	$attrib['type'],
	1318	$attrib['imageact'] ? $skin_path.$attrib['imageact'] : $attrib['classact'],
c8c1e0	1319	$attrib['imagesel'] ? $skin_path.$attrib['imagesel'] : $attrib['classsel'],
4e17e6	1320	$attrib['imageover'] ? $skin_path.$attrib['imageover'] : ''));
T	1321
078adf	1322	// make valid href to specific buttons
8c2e58	1323	if (in_array($attrib['command'], $MAIN_TASKS))
078adf	1324	$attrib['href'] = htmlentities(ereg_replace('_task=[a-z]+', '_task='.$attrib['command'], $COMM_PATH));
T	1325	else if (in_array($attrib['command'], $a_static_commands))
	1326	$attrib['href'] = htmlentities($COMM_PATH.'&_action='.$attrib['command']);
8c2e58	1327	}
T	1328
4e17e6	1329	// overwrite attributes
T	1330	if (!$attrib['href'])
	1331	$attrib['href'] = '#';
	1332
	1333	if ($command)
	1334	$attrib['onclick'] = sprintf("return %s.command('%s','%s',this)", $JS_OBJECT_NAME, $command, $attrib['prop']);
	1335
	1336	if ($command && $attrib['imageover'])
	1337	{
	1338	$attrib['onmouseover'] = sprintf("return %s.button_over('%s','%s')", $JS_OBJECT_NAME, $command, $attrib['id']);
	1339	$attrib['onmouseout'] = sprintf("return %s.button_out('%s','%s')", $JS_OBJECT_NAME, $command, $attrib['id']);
	1340	}
	1341
c8c1e0	1342	if ($command && $attrib['imagesel'])
S	1343	{
	1344	$attrib['onmousedown'] = sprintf("return %s.button_sel('%s','%s')", $JS_OBJECT_NAME, $command, $attrib['id']);
	1345	$attrib['onmouseup'] = sprintf("return %s.button_out('%s','%s')", $JS_OBJECT_NAME, $command, $attrib['id']);
	1346	}
4e17e6	1347
T	1348	$out = '';
	1349
	1350	// generate image tag
	1351	if ($attrib['type']=='image')
	1352	{
1cded8	1353	$attrib_str = create_attrib_string($attrib, array('style', 'class', 'id', 'width', 'height', 'border', 'hspace', 'vspace', 'align', 'alt'));
4e17e6	1354	$img_tag = sprintf('<img src="%%s"%s />', $attrib_str);
T	1355	$btn_content = sprintf($img_tag, $skin_path.$attrib['image']);
	1356	if ($attrib['label'])
	1357	$btn_content .= ' '.$attrib['label'];
	1358
c8c1e0	1359	$link_attrib = array('href', 'onclick', 'onmouseover', 'onmouseout', 'onmousedown', 'onmouseup', 'title');
4e17e6	1360	}
T	1361	else if ($attrib['type']=='link')
	1362	{
	1363	$btn_content = $attrib['label'] ? $attrib['label'] : $attrib['command'];
	1364	$link_attrib = array('href', 'onclick', 'title', 'id', 'class', 'style');
	1365	}
	1366	else if ($attrib['type']=='input')
	1367	{
	1368	$attrib['type'] = 'button';
	1369
	1370	if ($attrib['label'])
	1371	$attrib['value'] = $attrib['label'];
	1372
	1373	$attrib_str = create_attrib_string($attrib, array('type', 'value', 'onclick', 'id', 'class', 'style'));
	1374	$out = sprintf('<input%s disabled />', $attrib_str);
	1375	}
	1376
	1377	// generate html code for button
	1378	if ($btn_content)
	1379	{
	1380	$attrib_str = create_attrib_string($attrib, $link_attrib);
	1381	$out = sprintf('<a%s>%s</a>', $attrib_str, $btn_content);
	1382	}
	1383
	1384	return $out;
	1385	}
	1386
	1387
	1388	function rcube_menu($attrib)
	1389	{
	1390
	1391	return '';
	1392	}
	1393
	1394
	1395
d1d2c4	1396	function rcube_table_output($attrib, $table_data, $a_show_cols, $id_col)
4e17e6	1397	{
T	1398	global $DB;
	1399
	1400	// allow the following attributes to be added to the <table> tag
	1401	$attrib_str = create_attrib_string($attrib, array('style', 'class', 'id', 'cellpadding', 'cellspacing', 'border', 'summary'));
	1402
	1403	$table = '<table' . $attrib_str . ">\n";
	1404
	1405	// add table title
	1406	$table .= "<thead><tr>\n";
	1407
	1408	foreach ($a_show_cols as $col)
1038d5	1409	$table .= '<td class="'.$col.'">' . rep_specialchars_output(rcube_label($col)) . "</td>\n";
4e17e6	1410
T	1411	$table .= "</tr></thead>\n<tbody>\n";
	1412
	1413	$c = 0;
d1d2c4	1414
S	1415	if (!is_array($table_data))
4e17e6	1416	{
d1d2c4	1417	while ($table_data && ($sql_arr = $DB->fetch_assoc($table_data)))
4e17e6	1418	{
d1d2c4	1419	$zebra_class = $c%2 ? 'even' : 'odd';
4e17e6	1420
d1d2c4	1421	$table .= sprintf('<tr id="rcmrow%d" class="contact '.$zebra_class.'">'."\n", $sql_arr[$id_col]);
S	1422
	1423	// format each col
	1424	foreach ($a_show_cols as $col)
	1425	{
	1426	$cont = rep_specialchars_output($sql_arr[$col]);
	1427	$table .= '<td class="'.$col.'">' . $cont . "</td>\n";
	1428	}
	1429
	1430	$table .= "</tr>\n";
	1431	$c++;
	1432	}
	1433	}
	1434	else
	1435	{
	1436	foreach ($table_data as $row_data)
	1437	{
	1438	$zebra_class = $c%2 ? 'even' : 'odd';
	1439
	1440	$table .= sprintf('<tr id="rcmrow%d" class="contact '.$zebra_class.'">'."\n", $row_data[$id_col]);
	1441
	1442	// format each col
	1443	foreach ($a_show_cols as $col)
	1444	{
	1445	$cont = rep_specialchars_output($row_data[$col]);
	1446	$table .= '<td class="'.$col.'">' . $cont . "</td>\n";
	1447	}
	1448
	1449	$table .= "</tr>\n";
	1450	$c++;
	1451	}
4e17e6	1452	}
T	1453
	1454	// complete message table
	1455	$table .= "</tbody></table>\n";
	1456
	1457	return $table;
	1458	}
	1459
	1460
	1461
	1462	function rcmail_get_edit_field($col, $value, $attrib, $type='text')
	1463	{
	1464	$fname = '_'.$col;
	1465	$attrib['name'] = $fname;
	1466
	1467	if ($type=='checkbox')
	1468	{
	1469	$attrib['value'] = '1';
	1470	$input = new checkbox($attrib);
	1471	}
	1472	else if ($type=='textarea')
	1473	{
	1474	$attrib['cols'] = $attrib['size'];
	1475	$input = new textarea($attrib);
	1476	}
	1477	else
	1478	$input = new textfield($attrib);
	1479
	1480	// use value from post
597170	1481	if (!empty($_POST[$fname]))
4e17e6	1482	$value = $_POST[$fname];
T	1483
	1484	$out = $input->show($value);
	1485
	1486	return $out;
	1487	}
	1488
	1489
fe79b1	1490	// compose a valid attribute string for HTML tags
4e17e6	1491	function create_attrib_string($attrib, $allowed_attribs=array('id', 'class', 'style'))
T	1492	{
	1493	// allow the following attributes to be added to the <iframe> tag
	1494	$attrib_str = '';
	1495	foreach ($allowed_attribs as $a)
	1496	if (isset($attrib[$a]))
fe79b1	1497	$attrib_str .= sprintf(' %s="%s"', $a, str_replace('"', '"', $attrib[$a]));
4e17e6	1498
T	1499	return $attrib_str;
	1500	}
	1501
	1502
fe79b1	1503	// convert a HTML attribute string attributes to an associative array (name => value)
T	1504	function parse_attrib_string($str)
	1505	{
	1506	$attrib = array();
	1507	preg_match_all('/\s*([-_a-z]+)=["]([^"]+)["]?/i', stripslashes($str), $regs, PREG_SET_ORDER);
	1508
	1509	// convert attributes to an associative array (name => value)
	1510	if ($regs)
	1511	foreach ($regs as $attr)
	1512	$attrib[strtolower($attr[1])] = $attr[2];
	1513
	1514	return $attrib;
	1515	}
	1516
4e17e6	1517
T	1518	function format_date($date, $format=NULL)
	1519	{
	1520	global $CONFIG, $sess_user_lang;
	1521
4647e1	1522	$ts = NULL;
T	1523
4e17e6	1524	if (is_numeric($date))
T	1525	$ts = $date;
b076a4	1526	else if (!empty($date))
4647e1	1527	$ts = @strtotime($date);
T	1528
	1529	if (empty($ts))
b076a4	1530	return '';
4647e1	1531
T	1532	// get user's timezone
	1533	$tz = $CONFIG['timezone'];
	1534	if ($CONFIG['dst_active'])
	1535	$tz++;
4e17e6	1536
T	1537	// convert time to user's timezone
4647e1	1538	$timestamp = $ts - date('Z', $ts) + ($tz * 3600);
4e17e6	1539
T	1540	// get current timestamp in user's timezone
	1541	$now = time(); // local time
	1542	$now -= (int)date('Z'); // make GMT time
4647e1	1543	$now += ($tz * 3600); // user's time
749b07	1544	$now_date = getdate();
4e17e6	1545
749b07	1546	$today_limit = mktime(0, 0, 0, $now_date['mon'], $now_date['mday'], $now_date['year']);
T	1547	$week_limit = mktime(0, 0, 0, $now_date['mon'], $now_date['mday']-6, $now_date['year']);
4e17e6	1548
30233b	1549	// define date format depending on current time
749b07	1550	if ($CONFIG['prettydate'] && !$format && $timestamp > $today_limit)
4e17e6	1551	return sprintf('%s %s', rcube_label('today'), date('H:i', $timestamp));
749b07	1552	else if ($CONFIG['prettydate'] && !$format && $timestamp > $week_limit)
4e17e6	1553	$format = $CONFIG['date_short'] ? $CONFIG['date_short'] : 'D H:i';
T	1554	else if (!$format)
	1555	$format = $CONFIG['date_long'] ? $CONFIG['date_long'] : 'd.m.Y H:i';
	1556
	1557
	1558	// parse format string manually in order to provide localized weekday and month names
	1559	// an alternative would be to convert the date() format string to fit with strftime()
	1560	$out = '';
	1561	for($i=0; $i<strlen($format); $i++)
	1562	{
	1563	if ($format{$i}=='\\') // skip escape chars
	1564	continue;
	1565
	1566	// write char "as-is"
	1567	if ($format{$i}==' ' \|\| $format{$i-1}=='\\')
	1568	$out .= $format{$i};
	1569	// weekday (short)
	1570	else if ($format{$i}=='D')
	1571	$out .= rcube_label(strtolower(date('D', $timestamp)));
	1572	// weekday long
	1573	else if ($format{$i}=='l')
	1574	$out .= rcube_label(strtolower(date('l', $timestamp)));
	1575	// month name (short)
	1576	else if ($format{$i}=='M')
	1577	$out .= rcube_label(strtolower(date('M', $timestamp)));
	1578	// month name (long)
	1579	else if ($format{$i}=='F')
	1580	$out .= rcube_label(strtolower(date('F', $timestamp)));
	1581	else
	1582	$out .= date($format{$i}, $timestamp);
	1583	}
	1584
	1585	return $out;
	1586	}
	1587
	1588
	1589	// ************ functions delivering gui objects ************
	1590
	1591
	1592
	1593	function rcmail_message_container($attrib)
	1594	{
	1595	global $OUTPUT, $JS_OBJECT_NAME;
	1596
	1597	if (!$attrib['id'])
	1598	$attrib['id'] = 'rcmMessageContainer';
	1599
	1600	// allow the following attributes to be added to the <table> tag
	1601	$attrib_str = create_attrib_string($attrib, array('style', 'class', 'id'));
	1602	$out = '<div' . $attrib_str . "></div>";
	1603
	1604	$OUTPUT->add_script("$JS_OBJECT_NAME.gui_object('message', '$attrib[id]');");
	1605
	1606	return $out;
	1607	}
	1608
	1609
15a9d1	1610	// return the IMAP username of the current session
T	1611	function rcmail_current_username($attrib)
	1612	{
	1613	global $DB;
	1614	static $s_username;
	1615
	1616	// alread fetched
	1617	if (!empty($s_username))
	1618	return $s_username;
	1619
	1620	// get e-mail address form default identity
	1621	$sql_result = $DB->query("SELECT email AS mailto
	1622	FROM ".get_table_name('identities')."
	1623	WHERE user_id=?
	1624	AND standard=1
	1625	AND del<>1",
	1626	$_SESSION['user_id']);
	1627
	1628	if ($DB->num_rows($sql_result))
	1629	{
	1630	$sql_arr = $DB->fetch_assoc($sql_result);
	1631	$s_username = $sql_arr['mailto'];
	1632	}
	1633	else if (strstr($_SESSION['username'], '@'))
	1634	$s_username = $_SESSION['username'];
	1635	else
	1636	$s_username = $_SESSION['username'].'@'.$_SESSION['imap_host'];
	1637
	1638	return $s_username;
	1639	}
	1640
	1641
8cb245	1642	// return the mail domain configured for the given host
T	1643	function rcmail_mail_domain($host)
	1644	{
	1645	global $CONFIG;
	1646
	1647	$domain = $host;
	1648	if (is_array($CONFIG['mail_domain']))
	1649	{
	1650	if (isset($CONFIG['mail_domain'][$host]))
	1651	$domain = $CONFIG['mail_domain'][$host];
	1652	}
	1653	else if (!empty($CONFIG['mail_domain']))
	1654	$domain = $CONFIG['mail_domain'];
	1655
	1656	return $domain;
	1657	}
	1658
	1659
4e17e6	1660	// return code for the webmail login form
T	1661	function rcmail_login_form($attrib)
	1662	{
	1663	global $CONFIG, $OUTPUT, $JS_OBJECT_NAME, $SESS_HIDDEN_FIELD;
	1664
	1665	$labels = array();
	1666	$labels['user'] = rcube_label('username');
	1667	$labels['pass'] = rcube_label('password');
	1668	$labels['host'] = rcube_label('server');
	1669
66e2bf	1670	$input_user = new textfield(array('name' => '_user', 'id' => 'rcmloginuser', 'size' => 30));
T	1671	$input_pass = new passwordfield(array('name' => '_pass', 'id' => 'rcmloginpwd', 'size' => 30));
4e17e6	1672	$input_action = new hiddenfield(array('name' => '_action', 'value' => 'login'));
T	1673
	1674	$fields = array();
ea7c46	1675	$fields['user'] = $input_user->show(get_input_value('_user', RCUBE_INPUT_POST));
4e17e6	1676	$fields['pass'] = $input_pass->show();
T	1677	$fields['action'] = $input_action->show();
	1678
	1679	if (is_array($CONFIG['default_host']))
	1680	{
66e2bf	1681	$select_host = new select(array('name' => '_host', 'id' => 'rcmloginhost'));
42b113	1682
T	1683	foreach ($CONFIG['default_host'] as $key => $value)
	1684	$select_host->add($value, (is_numeric($key) ? $value : $key));
	1685
4e17e6	1686	$fields['host'] = $select_host->show($_POST['_host']);
T	1687	}
	1688	else if (!strlen($CONFIG['default_host']))
	1689	{
66e2bf	1690	$input_host = new textfield(array('name' => '_host', 'id' => 'rcmloginhost', 'size' => 30));
4e17e6	1691	$fields['host'] = $input_host->show($_POST['_host']);
T	1692	}
	1693
	1694	$form_name = strlen($attrib['form']) ? $attrib['form'] : 'form';
	1695	$form_start = !strlen($attrib['form']) ? '<form name="form" action="./" method="post">' : '';
	1696	$form_end = !strlen($attrib['form']) ? '</form>' : '';
	1697
	1698	if ($fields['host'])
	1699	$form_host = <<<EOF
	1700
	1701	</tr><tr>
	1702
66e2bf	1703	<td class="title"><label for="rcmloginhost">$labels[host]</label></td>
4e17e6	1704	<td>$fields[host]</td>
T	1705
	1706	EOF;
	1707
	1708	$OUTPUT->add_script("$JS_OBJECT_NAME.gui_object('loginform', '$form_name');");
	1709
	1710	$out = <<<EOF
	1711	$form_start
	1712	$SESS_HIDDEN_FIELD
	1713	$fields[action]
	1714	<table><tr>
	1715
66e2bf	1716	<td class="title"><label for="rcmloginuser">$labels[user]</label></td>
4e17e6	1717	<td>$fields[user]</td>
T	1718
	1719	</tr><tr>
	1720
66e2bf	1721	<td class="title"><label for="rcmloginpwd">$labels[pass]</label></td>
4e17e6	1722	<td>$fields[pass]</td>
T	1723	$form_host
	1724	</tr></table>
	1725	$form_end
	1726	EOF;
	1727
	1728	return $out;
	1729	}
	1730
	1731
1cded8	1732	function rcmail_charset_selector($attrib)
T	1733	{
13c1af	1734	global $OUTPUT;
T	1735
1cded8	1736	// pass the following attributes to the form class
T	1737	$field_attrib = array('name' => '_charset');
	1738	foreach ($attrib as $attr => $value)
	1739	if (in_array($attr, array('id', 'class', 'style', 'size', 'tabindex')))
	1740	$field_attrib[$attr] = $value;
	1741
	1742	$charsets = array(
	1743	'US-ASCII' => 'ASCII (English)',
f88d41	1744	'EUC-JP' => 'EUC-JP (Japanese)',
1cded8	1745	'EUC-KR' => 'EUC-KR (Korean)',
T	1746	'BIG5' => 'BIG5 (Chinese)',
	1747	'GB2312' => 'GB2312 (Chinese)',
f88d41	1748	'ISO-2022-JP' => 'ISO-2022-JP (Japanese)',
1cded8	1749	'ISO-8859-1' => 'ISO-8859-1 (Latin-1)',
T	1750	'ISO-8859-2' => 'ISO-8895-2 (Central European)',
	1751	'ISO-8859-7' => 'ISO-8859-7 (Greek)',
	1752	'ISO-8859-9' => 'ISO-8859-9 (Turkish)',
	1753	'Windows-1251' => 'Windows-1251 (Cyrillic)',
	1754	'Windows-1252' => 'Windows-1252 (Western)',
	1755	'Windows-1255' => 'Windows-1255 (Hebrew)',
	1756	'Windows-1256' => 'Windows-1256 (Arabic)',
	1757	'Windows-1257' => 'Windows-1257 (Baltic)',
	1758	'UTF-8' => 'UTF-8'
	1759	);
	1760
	1761	$select = new select($field_attrib);
	1762	$select->add(array_values($charsets), array_keys($charsets));
	1763
13c1af	1764	$set = $_POST['_charset'] ? $_POST['_charset'] : $OUTPUT->get_charset();
1cded8	1765	return $select->show($set);
T	1766	}
	1767
	1768
c39957	1769	/**** debugging functions ******/
T	1770
	1771
	1772	/**
	1773	* Print or write debug messages
	1774	*
	1775	* @param mixed Debug message or data
	1776	*/
	1777	function console($msg)
	1778	{
8d4bcd	1779	if (!is_string($msg))
c39957	1780	$msg = var_export($msg, true);
T	1781
	1782	if (!($GLOBALS['CONFIG']['debug_level'] & 4))
	1783	write_log('console', $msg);
	1784	else if ($GLOBALS['REMOTE_REQUEST'])
	1785	print "/\n $msg \n/\n";
	1786	else
	1787	{
	1788	print '<div style="background:#eee; border:1px solid #ccc; margin-bottom:3px; padding:6px"><pre>';
	1789	print $msg;
	1790	print "</pre></div>\n";
	1791	}
	1792	}
	1793
	1794
	1795	/**
	1796	* Append a line to a logfile in the logs directory.
	1797	* Date will be added automatically to the line.
	1798	*
	1799	* @param $name Name of logfile
	1800	* @param $line Line to append
	1801	*/
	1802	function write_log($name, $line)
	1803	{
	1804	global $CONFIG;
	1805
	1806	$log_entry = sprintf("[%s]: %s\n",
	1807	date("d-M-Y H:i:s O", mktime()),
	1808	$line);
	1809
	1810	if (empty($CONFIG['log_dir']))
	1811	$CONFIG['log_dir'] = $INSTALL_PATH.'logs';
	1812
	1813	// try to open specific log file for writing
	1814	if ($fp = @fopen($CONFIG['log_dir'].'/'.$name, 'a'))
	1815	{
	1816	fwrite($fp, $log_entry);
	1817	fclose($fp);
	1818	}
	1819	}
	1820
cc9570	1821
15a9d1	1822	function rcube_timer()
T	1823	{
	1824	list($usec, $sec) = explode(" ", microtime());
	1825	return ((float)$usec + (float)$sec);
	1826	}
	1827
	1828
	1829	function rcube_print_time($timer, $label='Timer')
	1830	{
	1831	static $print_count = 0;
	1832
	1833	$print_count++;
	1834	$now = rcube_timer();
	1835	$diff = $now-$timer;
	1836
	1837	if (empty($label))
	1838	$label = 'Timer '.$print_count;
	1839
	1840	console(sprintf("%s: %0.4f sec", $label, $diff));
	1841	}
	1842
d1d2c4	1843	?>