source: subversion/trunk/roundcubemail/program/include/main.inc @ 321

Last change on this file since 321 was 321, checked in by thomasb, 7 years ago

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