thomascube
2011-08-13 1c72e9983dfc9bbfb0fe4c0f02215855b0cb3e5f
commit | author | age
197601 1 <?php
T 2
3 /*
4  +-----------------------------------------------------------------------+
5  | program/include/rcmail.php                                            |
6  |                                                                       |
e019f2 7  | This file is part of the Roundcube Webmail client                     |
A 8  | Copyright (C) 2008-2010, Roundcube Dev. - Switzerland                 |
197601 9  | Licensed under the GNU GPL                                            |
T 10  |                                                                       |
11  | PURPOSE:                                                              |
12  |   Application class providing core functions and holding              |
13  |   instances of all 'global' objects like db- and imap-connections     |
14  +-----------------------------------------------------------------------+
15  | Author: Thomas Bruederli <roundcube@gmail.com>                        |
16  +-----------------------------------------------------------------------+
17
638fb8 18  $Id$
197601 19
T 20 */
21
22
23 /**
e019f2 24  * Application class of Roundcube Webmail
197601 25  * implemented as singleton
T 26  *
27  * @package Core
28  */
29 class rcmail
30 {
5c461b 31   /**
A 32    * Main tasks.
33    *
34    * @var array
35    */
677e1f 36   static public $main_tasks = array('mail','settings','addressbook','login','logout','utils','dummy');
A 37
5c461b 38   /**
A 39    * Singleton instace of rcmail
40    *
41    * @var rcmail
42    */
197601 43   static private $instance;
677e1f 44
5c461b 45   /**
A 46    * Stores instance of rcube_config.
47    *
48    * @var rcube_config
49    */
197601 50   public $config;
5c461b 51
A 52   /**
53    * Stores rcube_user instance.
54    *
55    * @var rcube_user
56    */
197601 57   public $user;
5c461b 58
A 59   /**
60    * Instace of database class.
61    *
62    * @var rcube_mdb2
63    */
197601 64   public $db;
5c461b 65
A 66   /**
67    * Instace of rcube_session class.
68    *
69    * @var rcube_session
70    */
929a50 71   public $session;
5c461b 72
A 73   /**
74    * Instance of rcube_smtp class.
75    *
76    * @var rcube_smtp
77    */
2c3d81 78   public $smtp;
5c461b 79
A 80   /**
81    * Instance of rcube_imap class.
82    *
83    * @var rcube_imap
84    */
197601 85   public $imap;
5c461b 86
A 87   /**
88    * Instance of rcube_template class.
89    *
90    * @var rcube_template
91    */
197601 92   public $output;
5c461b 93
A 94   /**
95    * Instance of rcube_plugin_api.
96    *
97    * @var rcube_plugin_api
98    */
cc97ea 99   public $plugins;
5c461b 100
A 101   /**
102    * Current task.
103    *
104    * @var string
105    */
9b94eb 106   public $task;
5c461b 107
A 108   /**
109    * Current action.
110    *
111    * @var string
112    */
197601 113   public $action = '';
T 114   public $comm_path = './';
677e1f 115
197601 116   private $texts;
457373 117   private $books = array();
677e1f 118
A 119
197601 120   /**
T 121    * This implements the 'singleton' design pattern
122    *
5c461b 123    * @return rcmail The one and only instance
197601 124    */
T 125   static function get_instance()
126   {
127     if (!self::$instance) {
128       self::$instance = new rcmail();
129       self::$instance->startup();  // init AFTER object was linked with self::$instance
130     }
131
132     return self::$instance;
133   }
b62a0d 134
A 135
197601 136   /**
T 137    * Private constructor
138    */
139   private function __construct()
140   {
141     // load configuration
142     $this->config = new rcube_config();
b62a0d 143
197601 144     register_shutdown_function(array($this, 'shutdown'));
T 145   }
b62a0d 146
A 147
197601 148   /**
T 149    * Initial startup function
150    * to register session, create database and imap connections
151    *
152    * @todo Remove global vars $DB, $USER
153    */
154   private function startup()
155   {
b77d0d 156     // initialize syslog
A 157     if ($this->config->get('log_driver') == 'syslog') {
158       $syslog_id = $this->config->get('syslog_id', 'roundcube');
159       $syslog_facility = $this->config->get('syslog_facility', LOG_USER);
160       openlog($syslog_id, LOG_ODELAY, $syslog_facility);
161     }
cc97ea 162
197601 163     // connect to database
T 164     $GLOBALS['DB'] = $this->get_dbh();
165
929a50 166     // start session
A 167     $this->session_init();
197601 168
T 169     // create user object
170     $this->set_user(new rcube_user($_SESSION['user_id']));
929a50 171
A 172     // configure session (after user config merge!)
173     $this->session_configure();
197601 174
9b94eb 175     // set task and action properties
A 176     $this->set_task(get_input_value('_task', RCUBE_INPUT_GPC));
177     $this->action = asciiwords(get_input_value('_action', RCUBE_INPUT_GPC));
178
197601 179     // reset some session parameters when changing task
677e1f 180     if ($this->task != 'utils') {
A 181       if ($this->session && $_SESSION['task'] != $this->task)
182         $this->session->remove('page');
183       // set current task to session
184       $_SESSION['task'] = $this->task;
185     }
197601 186
48bc52 187     // init output class
A 188     if (!empty($_REQUEST['_remote']))
929a50 189       $GLOBALS['OUTPUT'] = $this->json_init();
48bc52 190     else
A 191       $GLOBALS['OUTPUT'] = $this->load_gui(!empty($_REQUEST['_framed']));
192
cc97ea 193     // create plugin API and load plugins
T 194     $this->plugins = rcube_plugin_api::get_instance();
48bc52 195
A 196     // init plugins
197     $this->plugins->init();
197601 198   }
b62a0d 199
A 200
197601 201   /**
T 202    * Setter for application task
203    *
204    * @param string Task to set
205    */
206   public function set_task($task)
207   {
1c932d 208     $task = asciiwords($task);
9b94eb 209
A 210     if ($this->user && $this->user->ID)
c3be8e 211       $task = !$task ? 'mail' : $task;
9b94eb 212     else
A 213       $task = 'login';
214
215     $this->task = $task;
1c932d 216     $this->comm_path = $this->url(array('task' => $this->task));
b62a0d 217
197601 218     if ($this->output)
1c932d 219       $this->output->set_env('task', $this->task);
197601 220   }
b62a0d 221
A 222
197601 223   /**
T 224    * Setter for system user object
225    *
5c461b 226    * @param rcube_user Current user instance
197601 227    */
T 228   public function set_user($user)
229   {
230     if (is_object($user)) {
231       $this->user = $user;
232       $GLOBALS['USER'] = $this->user;
b62a0d 233
197601 234       // overwrite config with user preferences
b545d3 235       $this->config->set_user_prefs((array)$this->user->get_prefs());
197601 236     }
b62a0d 237
c8ae24 238     $_SESSION['language'] = $this->user->language = $this->language_prop($this->config->get('language', $_SESSION['language']));
531abb 239
197601 240     // set localization
e80f50 241     setlocale(LC_ALL, $_SESSION['language'] . '.utf8', 'en_US.utf8');
14de18 242
b62a0d 243     // workaround for http://bugs.php.net/bug.php?id=18556
A 244     if (in_array($_SESSION['language'], array('tr_TR', 'ku', 'az_AZ')))
245       setlocale(LC_CTYPE, 'en_US' . '.utf8');
197601 246   }
b62a0d 247
A 248
197601 249   /**
T 250    * Check the given string and return a valid language code
251    *
252    * @param string Language code
253    * @return string Valid language code
254    */
255   private function language_prop($lang)
256   {
257     static $rcube_languages, $rcube_language_aliases;
b62a0d 258
c8ae24 259     // user HTTP_ACCEPT_LANGUAGE if no language is specified
T 260     if (empty($lang) || $lang == 'auto') {
261        $accept_langs = explode(',', $_SERVER['HTTP_ACCEPT_LANGUAGE']);
262        $lang = str_replace('-', '_', $accept_langs[0]);
263      }
b62a0d 264
197601 265     if (empty($rcube_languages)) {
T 266       @include(INSTALL_PATH . 'program/localization/index.inc');
267     }
b62a0d 268
197601 269     // check if we have an alias for that language
T 270     if (!isset($rcube_languages[$lang]) && isset($rcube_language_aliases[$lang])) {
271       $lang = $rcube_language_aliases[$lang];
272     }
273     // try the first two chars
c3ab75 274     else if (!isset($rcube_languages[$lang])) {
7e78b2 275       $short = substr($lang, 0, 2);
b62a0d 276
235086 277       // check if we have an alias for the short language code
T 278       if (!isset($rcube_languages[$short]) && isset($rcube_language_aliases[$short])) {
279         $lang = $rcube_language_aliases[$short];
280       }
c3ab75 281       // expand 'nn' to 'nn_NN'
T 282       else if (!isset($rcube_languages[$short])) {
235086 283         $lang = $short.'_'.strtoupper($short);
T 284       }
197601 285     }
T 286
1854c4 287     if (!isset($rcube_languages[$lang]) || !is_dir(INSTALL_PATH . 'program/localization/' . $lang)) {
197601 288       $lang = 'en_US';
T 289     }
290
291     return $lang;
292   }
b62a0d 293
A 294
197601 295   /**
T 296    * Get the current database connection
297    *
5c461b 298    * @return rcube_mdb2  Database connection object
197601 299    */
T 300   public function get_dbh()
301   {
302     if (!$this->db) {
303       $config_all = $this->config->all();
304
9e8e5f 305       $this->db = new rcube_mdb2($config_all['db_dsnw'], $config_all['db_dsnr'], $config_all['db_persistent']);
197601 306       $this->db->sqlite_initials = INSTALL_PATH . 'SQL/sqlite.initial.sql';
T 307       $this->db->set_debug((bool)$config_all['sql_debug']);
308     }
309
310     return $this->db;
311   }
b62a0d 312
A 313
197601 314   /**
ade8e1 315    * Return instance of the internal address book class
T 316    *
3704b7 317    * @param string  Address book identifier
ade8e1 318    * @param boolean True if the address book needs to be writeable
5c461b 319    * @return rcube_contacts Address book object
ade8e1 320    */
T 321   public function get_address_book($id, $writeable = false)
322   {
323     $contacts = null;
324     $ldap_config = (array)$this->config->get('ldap_public');
325     $abook_type = strtolower($this->config->get('address_book_type'));
cc97ea 326
e6ce00 327     $plugin = $this->plugins->exec_hook('addressbook_get', array('id' => $id, 'writeable' => $writeable));
b62a0d 328
cc97ea 329     // plugin returned instance of a rcube_addressbook
T 330     if ($plugin['instance'] instanceof rcube_addressbook) {
331       $contacts = $plugin['instance'];
332     }
333     else if ($id && $ldap_config[$id]) {
010274 334       $contacts = new rcube_ldap($ldap_config[$id], $this->config->get('ldap_debug'), $this->config->mail_domain($_SESSION['imap_host']));
cc97ea 335     }
T 336     else if ($id === '0') {
337       $contacts = new rcube_contacts($this->db, $this->user->ID);
ade8e1 338     }
T 339     else if ($abook_type == 'ldap') {
340       // Use the first writable LDAP address book.
341       foreach ($ldap_config as $id => $prop) {
342         if (!$writeable || $prop['writable']) {
010274 343           $contacts = new rcube_ldap($prop, $this->config->get('ldap_debug'), $this->config->mail_domain($_SESSION['imap_host']));
ade8e1 344           break;
T 345         }
346       }
347     }
3704b7 348     else { // $id == 'sql'
ade8e1 349       $contacts = new rcube_contacts($this->db, $this->user->ID);
T 350     }
457373 351
A 352     // add to the 'books' array for shutdown function
353     if (!in_array($contacts, $this->books))
354       $this->books[] = $contacts;
b62a0d 355
ade8e1 356     return $contacts;
T 357   }
3704b7 358
A 359
360   /**
361    * Return address books list
362    *
363    * @param boolean True if the address book needs to be writeable
364    * @return array  Address books array
365    */
366   public function get_address_sources($writeable = false)
367   {
368     $abook_type = strtolower($this->config->get('address_book_type'));
7fdb9d 369     $ldap_config = $this->config->get('ldap_public');
A 370     $autocomplete = (array) $this->config->get('autocomplete_addressbooks');
3704b7 371     $list = array();
A 372
373     // We are using the DB address book
374     if ($abook_type != 'ldap') {
c0297f 375       $contacts = new rcube_contacts($this->db, null);
3704b7 376       $list['0'] = array(
A 377         'id' => 0,
a61bbb 378         'name' => rcube_label('personaladrbook'),
c0297f 379         'groups' => $contacts->groups,
3704b7 380         'readonly' => false,
a61bbb 381         'autocomplete' => in_array('sql', $autocomplete)
3704b7 382       );
A 383     }
384
7fdb9d 385     if ($ldap_config) {
A 386       $ldap_config = (array) $ldap_config;
3704b7 387       foreach ($ldap_config as $id => $prop)
A 388         $list[$id] = array(
a61bbb 389           'id' => $id,
T 390           'name' => $prop['name'],
391           'groups' => false,
392           'readonly' => !$prop['writable'],
393           'autocomplete' => in_array('sql', $autocomplete)
3704b7 394         );
A 395     }
396
e6ce00 397     $plugin = $this->plugins->exec_hook('addressbooks_list', array('sources' => $list));
3704b7 398     $list = $plugin['sources'];
A 399
400     if ($writeable && !empty($list)) {
401       foreach ($list as $idx => $item) {
402         if ($item['readonly']) {
c0297f 403           unset($list[$idx]);
3704b7 404         }
A 405       }
406     }
7fdb9d 407
3704b7 408     return $list;
A 409   }
b62a0d 410
A 411
ade8e1 412   /**
197601 413    * Init output object for GUI and add common scripts.
T 414    * This will instantiate a rcmail_template object and set
415    * environment vars according to the current session and configuration
0ece58 416    *
T 417    * @param boolean True if this request is loaded in a (i)frame
5c461b 418    * @return rcube_template Reference to HTML output object
197601 419    */
T 420   public function load_gui($framed = false)
421   {
422     // init output page
0ece58 423     if (!($this->output instanceof rcube_template))
T 424       $this->output = new rcube_template($this->task, $framed);
197601 425
95d90f 426     // set keep-alive/check-recent interval
bf67d6 427     if ($this->session && ($keep_alive = $this->session->get_keep_alive())) {
929a50 428       $this->output->set_env('keep_alive', $keep_alive);
95d90f 429     }
197601 430
T 431     if ($framed) {
432       $this->comm_path .= '&_framed=1';
433       $this->output->set_env('framed', true);
434     }
435
436     $this->output->set_env('task', $this->task);
437     $this->output->set_env('action', $this->action);
438     $this->output->set_env('comm_path', $this->comm_path);
79c45f 439     $this->output->set_charset(RCMAIL_CHARSET);
197601 440
T 441     // add some basic label to client
74d421 442     $this->output->add_label('loading', 'servererror');
b62a0d 443
197601 444     return $this->output;
T 445   }
b62a0d 446
A 447
197601 448   /**
T 449    * Create an output object for JSON responses
0ece58 450    *
5c461b 451    * @return rcube_json_output Reference to JSON output object
197601 452    */
929a50 453   public function json_init()
197601 454   {
0ece58 455     if (!($this->output instanceof rcube_json_output))
T 456       $this->output = new rcube_json_output($this->task);
b62a0d 457
197601 458     return $this->output;
2c3d81 459   }
A 460
461
462   /**
463    * Create SMTP object and connect to server
464    *
465    * @param boolean True if connection should be established
466    */
467   public function smtp_init($connect = false)
468   {
469     $this->smtp = new rcube_smtp();
b62a0d 470
2c3d81 471     if ($connect)
A 472       $this->smtp->connect();
197601 473   }
b62a0d 474
A 475
197601 476   /**
T 477    * Create global IMAP object and connect to server
478    *
479    * @param boolean True if connection should be established
480    * @todo Remove global $IMAP
481    */
1854c4 482   public function imap_init($connect = false)
197601 483   {
47d8d3 484     // already initialized
T 485     if (is_object($this->imap))
486       return;
b62a0d 487
197601 488     $this->imap = new rcube_imap($this->db);
T 489     $this->imap->debug_level = $this->config->get('debug_level');
490     $this->imap->skip_deleted = $this->config->get('skip_deleted');
491
492     // enable caching of imap data
493     if ($this->config->get('enable_caching')) {
494       $this->imap->set_caching(true);
495     }
496
497     // set pagesize from config
498     $this->imap->set_pagesize($this->config->get('pagesize', 50));
b62a0d 499
600981 500     // Setting root and delimiter before establishing the connection
b62a0d 501     // can save time detecting them using NAMESPACE and LIST
230f94 502     $options = array(
bdab2c 503       'auth_method' => $this->config->get('imap_auth_type', 'check'),
a1fe6b 504       'auth_cid'    => $this->config->get('imap_auth_cid'),
A 505       'auth_pw'     => $this->config->get('imap_auth_pw'),
7f1da4 506       'debug'       => (bool) $this->config->get('imap_debug', 0),
f07d23 507       'force_caps'  => (bool) $this->config->get('imap_force_caps'),
A 508       'timeout'     => (int) $this->config->get('imap_timeout', 0),
230f94 509     );
76db10 510
230f94 511     $this->imap->set_options($options);
b62a0d 512
197601 513     // set global object for backward compatibility
T 514     $GLOBALS['IMAP'] = $this->imap;
48bc52 515
A 516     $hook = $this->plugins->exec_hook('imap_init', array('fetch_headers' => $this->imap->fetch_add_headers));
517     if ($hook['fetch_headers'])
518       $this->imap->fetch_add_headers = $hook['fetch_headers'];
b62a0d 519
47d8d3 520     // support this parameter for backward compatibility but log warning
T 521     if ($connect) {
1854c4 522       $this->imap_connect();
13ffa2 523       raise_error(array(
A 524         'code' => 800, 'type' => 'imap',
525         'file' => __FILE__, 'line' => __LINE__,
526         'message' => "rcube::imap_init(true) is deprecated, use rcube::imap_connect() instead"),
527         true, false);
47d8d3 528     }
1854c4 529   }
T 530
531
532   /**
533    * Connect to IMAP server with stored session data
534    *
535    * @return bool True on success, false on error
536    */
537   public function imap_connect()
538   {
48bc52 539     if (!$this->imap)
A 540       $this->imap_init();
b62a0d 541
59c216 542     if ($_SESSION['imap_host'] && !$this->imap->conn->connected()) {
A 543       if (!$this->imap->connect($_SESSION['imap_host'], $_SESSION['username'], $this->decrypt($_SESSION['password']), $_SESSION['imap_port'], $_SESSION['imap_ssl'])) {
1854c4 544         if ($this->output)
0f0c17 545           $this->output->show_message($this->imap->get_error_code() == -1 ? 'imaperror' : 'sessionerror', 'error');
1854c4 546       }
59c216 547       else {
A 548         $this->set_imap_prop();
549         return $this->imap->conn;
550       }
1854c4 551     }
T 552
59c216 553     return false;
929a50 554   }
A 555
556
557   /**
558    * Create session object and start the session.
559    */
560   public function session_init()
561   {
bf67d6 562     // session started (Installer?)
A 563     if (session_id())
564       return;
565
929a50 566     $lifetime = $this->config->get('session_lifetime', 0) * 60;
A 567
568     // set session domain
569     if ($domain = $this->config->get('session_domain')) {
570       ini_set('session.cookie_domain', $domain);
571     }
572     // set session garbage collecting time according to session_lifetime
573     if ($lifetime) {
574       ini_set('session.gc_maxlifetime', $lifetime * 2);
575     }
576
577     ini_set('session.cookie_secure', rcube_https_check());
578     ini_set('session.name', 'roundcube_sessid');
579     ini_set('session.use_cookies', 1);
b62a0d 580     ini_set('session.use_only_cookies', 1);
929a50 581     ini_set('session.serialize_handler', 'php');
A 582
583     // use database for storing session data
584     $this->session = new rcube_session($this->get_dbh(), $lifetime);
585
586     $this->session->register_gc_handler('rcmail_temp_gc');
587     if ($this->config->get('enable_caching'))
588       $this->session->register_gc_handler('rcmail_cache_gc');
589
590     // start PHP session (if not in CLI mode)
591     if ($_SERVER['REMOTE_ADDR'])
592       session_start();
593
594     // set initial session vars
595     if (!isset($_SESSION['auth_time'])) {
596       $_SESSION['auth_time'] = time();
597       $_SESSION['temp'] = true;
598     }
599   }
600
601
602   /**
603    * Configure session object internals
604    */
605   public function session_configure()
606   {
bf67d6 607     if (!$this->session)
A 608       return;
609
929a50 610     $lifetime = $this->config->get('session_lifetime', 0) * 60;
A 611
612     // set keep-alive/check-recent interval
613     if ($keep_alive = $this->config->get('keep_alive')) {
614       // be sure that it's less than session lifetime
615       if ($lifetime)
616         $keep_alive = min($keep_alive, $lifetime - 30);
617       $keep_alive = max(60, $keep_alive);
618       $this->session->set_keep_alive($keep_alive);
619     }
197601 620   }
T 621
622
623   /**
624    * Perfom login to the IMAP server and to the webmail service.
625    * This will also create a new user entry if auto_create_user is configured.
626    *
627    * @param string IMAP user name
628    * @param string IMAP password
629    * @param string IMAP host
630    * @return boolean True on success, False on failure
631    */
632   function login($username, $pass, $host=NULL)
633   {
634     $user = NULL;
635     $config = $this->config->all();
636
637     if (!$host)
638       $host = $config['default_host'];
639
640     // Validate that selected host is in the list of configured hosts
641     if (is_array($config['default_host'])) {
642       $allowed = false;
643       foreach ($config['default_host'] as $key => $host_allowed) {
644         if (!is_numeric($key))
645           $host_allowed = $key;
646         if ($host == $host_allowed) {
647           $allowed = true;
648           break;
649         }
650       }
651       if (!$allowed)
652         return false;
653       }
bb8721 654     else if (!empty($config['default_host']) && $host != rcube_parse_host($config['default_host']))
197601 655       return false;
T 656
657     // parse $host URL
658     $a_host = parse_url($host);
659     if ($a_host['host']) {
660       $host = $a_host['host'];
661       $imap_ssl = (isset($a_host['scheme']) && in_array($a_host['scheme'], array('ssl','imaps','tls'))) ? $a_host['scheme'] : null;
e99991 662       if (!empty($a_host['port']))
f86e8f 663         $imap_port = $a_host['port'];
904809 664       else if ($imap_ssl && $imap_ssl != 'tls' && (!$config['default_port'] || $config['default_port'] == 143))
f86e8f 665         $imap_port = 993;
197601 666     }
b62a0d 667
f86e8f 668     $imap_port = $imap_port ? $imap_port : $config['default_port'];
197601 669
b62a0d 670     /* Modify username with domain if required
197601 671        Inspired by Marco <P0L0_notspam_binware.org>
T 672     */
673     // Check if we need to add domain
c16fab 674     if (!empty($config['username_domain']) && strpos($username, '@') === false) {
197601 675       if (is_array($config['username_domain']) && isset($config['username_domain'][$host]))
98cb0f 676         $username .= '@'.rcube_parse_host($config['username_domain'][$host], $host);
197601 677       else if (is_string($config['username_domain']))
98cb0f 678         $username .= '@'.rcube_parse_host($config['username_domain'], $host);
197601 679     }
T 680
e17553 681     // Convert username to lowercase. If IMAP backend
A 682     // is case-insensitive we need to store always the same username (#1487113)
683     if ($config['login_lc']) {
684       $username = mb_strtolower($username);
685     }
686
942069 687     // try to resolve email address from virtuser table
e17553 688     if (strpos($username, '@') && ($virtuser = rcube_user::email2user($username))) {
A 689       $username = $virtuser;
690     }
197601 691
f1adbf 692     // Here we need IDNA ASCII
A 693     // Only rcube_contacts class is using domain names in Unicode
b46e5b 694     $host = rcube_idn_to_ascii($host);
f1adbf 695     if (strpos($username, '@')) {
8f94b1 696       // lowercase domain name
A 697       list($local, $domain) = explode('@', $username);
698       $username = $local . '@' . mb_strtolower($domain);
b46e5b 699       $username = rcube_idn_to_ascii($username);
f1adbf 700     }
A 701
197601 702     // user already registered -> overwrite username
T 703     if ($user = rcube_user::query($username, $host))
704       $username = $user->data['username'];
705
48bc52 706     if (!$this->imap)
A 707       $this->imap_init();
708
6d94ab 709     // try IMAP login
T 710     if (!($imap_login = $this->imap->connect($host, $username, $pass, $imap_port, $imap_ssl))) {
f1adbf 711       // try with lowercase
6d94ab 712       $username_lc = mb_strtolower($username);
e17553 713       if ($username_lc != $username) {
A 714         // try to find user record again -> overwrite username
715         if (!$user && ($user = rcube_user::query($username_lc, $host)))
716           $username_lc = $user->data['username'];
717
718         if ($imap_login = $this->imap->connect($host, $username_lc, $pass, $imap_port, $imap_ssl))
719           $username = $username_lc;
720       }
6d94ab 721     }
T 722
197601 723     // exit if IMAP login failed
6d94ab 724     if (!$imap_login)
197601 725       return false;
T 726
b5846e 727     $this->set_imap_prop();
A 728
197601 729     // user already registered -> update user's record
T 730     if (is_object($user)) {
b5846e 731       // create default folders on first login
A 732       if (!$user->data['last_login'] && $config['create_default_folders'])
733         $this->imap->create_default_folders();
197601 734       $user->touch();
T 735     }
736     // create new system user
737     else if ($config['auto_create_user']) {
738       if ($created = rcube_user::create($username, $host)) {
739         $user = $created;
b5846e 740         // create default folders on first login
A 741         if ($config['create_default_folders'])
742           $this->imap->create_default_folders();
197601 743       }
f879f4 744       else {
T 745         raise_error(array(
10eedb 746           'code' => 600, 'type' => 'php',
6d94ab 747           'file' => __FILE__, 'line' => __LINE__,
f879f4 748           'message' => "Failed to create a user record. Maybe aborted by a plugin?"
10eedb 749           ), true, false);
f879f4 750       }
197601 751     }
T 752     else {
753       raise_error(array(
10eedb 754         'code' => 600, 'type' => 'php',
A 755         'file' => __FILE__, 'line' => __LINE__,
197601 756         'message' => "Acces denied for new user $username. 'auto_create_user' is disabled"
T 757         ), true, false);
758     }
759
760     // login succeeded
761     if (is_object($user) && $user->ID) {
762       $this->set_user($user);
763
764       // set session vars
765       $_SESSION['user_id']   = $user->ID;
766       $_SESSION['username']  = $user->data['username'];
767       $_SESSION['imap_host'] = $host;
768       $_SESSION['imap_port'] = $imap_port;
769       $_SESSION['imap_ssl']  = $imap_ssl;
2471d3 770       $_SESSION['password']  = $this->encrypt($pass);
197601 771       $_SESSION['login_time'] = mktime();
b62a0d 772
A 773       if (isset($_REQUEST['_timezone']) && $_REQUEST['_timezone'] != '_default_')
c8ae24 774         $_SESSION['timezone'] = floatval($_REQUEST['_timezone']);
197601 775
T 776       // force reloading complete list of subscribed mailboxes
777       $this->imap->clear_cache('mailboxes');
778
779       return true;
780     }
781
782     return false;
783   }
784
785
786   /**
787    * Set root dir and last stored mailbox
788    * This must be done AFTER connecting to the server!
789    */
790   public function set_imap_prop()
791   {
792     $this->imap->set_charset($this->config->get('default_charset', RCMAIL_CHARSET));
793
794     if ($default_folders = $this->config->get('default_imap_folders')) {
795       $this->imap->set_default_mailboxes($default_folders);
796     }
448409 797     if (isset($_SESSION['mbox'])) {
197601 798       $this->imap->set_mailbox($_SESSION['mbox']);
T 799     }
800     if (isset($_SESSION['page'])) {
801       $this->imap->set_page($_SESSION['page']);
802     }
803   }
804
1854c4 805
T 806   /**
807    * Auto-select IMAP host based on the posted login information
808    *
809    * @return string Selected IMAP host
810    */
811   public function autoselect_host()
812   {
813     $default_host = $this->config->get('default_host');
257f88 814     $host = null;
b62a0d 815
257f88 816     if (is_array($default_host)) {
T 817       $post_host = get_input_value('_host', RCUBE_INPUT_POST);
b62a0d 818
257f88 819       // direct match in default_host array
T 820       if ($default_host[$post_host] || in_array($post_host, array_values($default_host))) {
821         $host = $post_host;
822       }
b62a0d 823
257f88 824       // try to select host by mail domain
1854c4 825       list($user, $domain) = explode('@', get_input_value('_user', RCUBE_INPUT_POST));
T 826       if (!empty($domain)) {
257f88 827         foreach ($default_host as $imap_host => $mail_domains) {
1854c4 828           if (is_array($mail_domains) && in_array($domain, $mail_domains)) {
T 829             $host = $imap_host;
830             break;
831           }
832         }
833       }
834
835       // take the first entry if $host is still an array
257f88 836       if (empty($host)) {
T 837         $host = array_shift($default_host);
838       }
839     }
840     else if (empty($default_host)) {
841       $host = get_input_value('_host', RCUBE_INPUT_POST);
1854c4 842     }
eec34e 843     else
bb8721 844       $host = rcube_parse_host($default_host);
1854c4 845
T 846     return $host;
847   }
848
849
850   /**
851    * Get localized text in the desired language
852    *
853    * @param mixed Named parameters array or label name
854    * @return string Localized text
855    */
cc97ea 856   public function gettext($attrib, $domain=null)
1854c4 857   {
T 858     // load localization files if not done yet
859     if (empty($this->texts))
860       $this->load_language();
b62a0d 861
1854c4 862     // extract attributes
T 863     if (is_string($attrib))
864       $attrib = array('name' => $attrib);
865
866     $nr = is_numeric($attrib['nr']) ? $attrib['nr'] : 1;
9898fe 867     $name = $attrib['name'] ? $attrib['name'] : '';
1854c4 868
cc97ea 869     // check for text with domain
9898fe 870     if ($domain && ($text_item = $this->texts[$domain.'.'.$name]))
cc97ea 871       ;
1854c4 872     // text does not exist
9898fe 873     else if (!($text_item = $this->texts[$name])) {
A 874       return "[$name]";
1854c4 875     }
T 876
b62a0d 877     // make text item array
1854c4 878     $a_text_item = is_array($text_item) ? $text_item : array('single' => $text_item);
T 879
880     // decide which text to use
881     if ($nr == 1) {
882       $text = $a_text_item['single'];
883     }
884     else if ($nr > 0) {
885       $text = $a_text_item['multiple'];
886     }
887     else if ($nr == 0) {
888       if ($a_text_item['none'])
889         $text = $a_text_item['none'];
890       else if ($a_text_item['single'])
891         $text = $a_text_item['single'];
892       else if ($a_text_item['multiple'])
893         $text = $a_text_item['multiple'];
894     }
895
896     // default text is single
897     if ($text == '') {
898       $text = $a_text_item['single'];
899     }
900
901     // replace vars in text
902     if (is_array($attrib['vars'])) {
903       foreach ($attrib['vars'] as $var_key => $var_value)
9898fe 904         $text = str_replace($var_key[0]!='$' ? '$'.$var_key : $var_key, $var_value, $text);
1854c4 905     }
T 906
907     // format output
908     if (($attrib['uppercase'] && strtolower($attrib['uppercase']=='first')) || $attrib['ucfirst'])
909       return ucfirst($text);
910     else if ($attrib['uppercase'])
2aa2b3 911       return mb_strtoupper($text);
1854c4 912     else if ($attrib['lowercase'])
2aa2b3 913       return mb_strtolower($text);
1854c4 914
T 915     return $text;
916   }
917
a02cfa 918   /**
T 919    * Check if the given text lable exists
920    *
921    * @param string Label name
922    * @return boolean True if text exists (either in the current language or in en_US)
923    */
924   public function text_exists($name, $domain=null)
925   {
926     // load localization files if not done yet
927     if (empty($this->texts))
928       $this->load_language();
929
930     // check for text with domain first
931     return ($domain && isset($this->texts[$domain.'.'.$name])) || isset($this->texts[$name]);
932   }
1854c4 933
T 934   /**
935    * Load a localization package
936    *
937    * @param string Language ID
938    */
cc97ea 939   public function load_language($lang = null, $add = array())
1854c4 940   {
c8ae24 941     $lang = $this->language_prop(($lang ? $lang : $_SESSION['language']));
b62a0d 942
1854c4 943     // load localized texts
T 944     if (empty($this->texts) || $lang != $_SESSION['language']) {
945       $this->texts = array();
946
7c9850 947       // handle empty lines after closing PHP tag in localization files
A 948       ob_start();
949
1854c4 950       // get english labels (these should be complete)
T 951       @include(INSTALL_PATH . 'program/localization/en_US/labels.inc');
952       @include(INSTALL_PATH . 'program/localization/en_US/messages.inc');
953
954       if (is_array($labels))
9d9f8d 955         $this->texts = $labels;
1854c4 956       if (is_array($messages))
9d9f8d 957         $this->texts = array_merge($this->texts, $messages);
1854c4 958
T 959       // include user language files
960       if ($lang != 'en' && is_dir(INSTALL_PATH . 'program/localization/' . $lang)) {
961         include_once(INSTALL_PATH . 'program/localization/' . $lang . '/labels.inc');
962         include_once(INSTALL_PATH . 'program/localization/' . $lang . '/messages.inc');
963
964         if (is_array($labels))
965           $this->texts = array_merge($this->texts, $labels);
966         if (is_array($messages))
967           $this->texts = array_merge($this->texts, $messages);
968       }
b62a0d 969
7c9850 970       ob_end_clean();
A 971
1854c4 972       $_SESSION['language'] = $lang;
T 973     }
cc97ea 974
T 975     // append additional texts (from plugin)
976     if (is_array($add) && !empty($add))
977       $this->texts += $add;
1854c4 978   }
T 979
980
981   /**
982    * Read directory program/localization and return a list of available languages
983    *
984    * @return array List of available localizations
985    */
986   public function list_languages()
987   {
988     static $sa_languages = array();
989
990     if (!sizeof($sa_languages)) {
991       @include(INSTALL_PATH . 'program/localization/index.inc');
992
993       if ($dh = @opendir(INSTALL_PATH . 'program/localization')) {
994         while (($name = readdir($dh)) !== false) {
2aa2b3 995           if ($name[0] == '.' || !is_dir(INSTALL_PATH . 'program/localization/' . $name))
1854c4 996             continue;
T 997
998           if ($label = $rcube_languages[$name])
7d5178 999             $sa_languages[$name] = $label;
1854c4 1000         }
T 1001         closedir($dh);
1002       }
1003     }
1004
1005     return $sa_languages;
1006   }
1007
1008
1009   /**
1010    * Check the auth hash sent by the client against the local session credentials
1011    *
1012    * @return boolean True if valid, False if not
1013    */
1014   function authenticate_session()
1015   {
1016     // advanced session authentication
1017     if ($this->config->get('double_auth')) {
1018       $now = time();
1019       $valid = ($_COOKIE['sessauth'] == $this->get_auth_hash(session_id(), $_SESSION['auth_time']) ||
1020                 $_COOKIE['sessauth'] == $this->get_auth_hash(session_id(), $_SESSION['last_auth']));
1021
1022       // renew auth cookie every 5 minutes (only for GET requests)
1023       if (!$valid || ($_SERVER['REQUEST_METHOD']!='POST' && $now - $_SESSION['auth_time'] > 300)) {
1024         $_SESSION['last_auth'] = $_SESSION['auth_time'];
1025         $_SESSION['auth_time'] = $now;
cefd1d 1026         rcmail::setcookie('sessauth', $this->get_auth_hash(session_id(), $now), 0);
1854c4 1027       }
T 1028     }
1029     else {
929a50 1030       $valid = $this->config->get('ip_check') ? $_SERVER['REMOTE_ADDR'] == $this->session->get_ip() : true;
1854c4 1031     }
T 1032
1033     // check session filetime
1034     $lifetime = $this->config->get('session_lifetime');
929a50 1035     $sess_ts = $this->session->get_ts();
A 1036     if (!empty($lifetime) && !empty($sess_ts) && $sess_ts + $lifetime*60 < time()) {
1854c4 1037       $valid = false;
T 1038     }
1039
1040     return $valid;
1041   }
1042
1043
1044   /**
1045    * Destroy session data and remove cookie
1046    */
1047   public function kill_session()
1048   {
e6ce00 1049     $this->plugins->exec_hook('session_destroy');
b62a0d 1050
929a50 1051     $this->session->remove();
c8ae24 1052     $_SESSION = array('language' => $this->user->language, 'auth_time' => time(), 'temp' => true);
cefd1d 1053     rcmail::setcookie('sessauth', '-del-', time() - 60);
1854c4 1054     $this->user->reset();
T 1055   }
1056
1057
1058   /**
1059    * Do server side actions on logout
1060    */
1061   public function logout_actions()
1062   {
1063     $config = $this->config->all();
b62a0d 1064
A 1065     // on logout action we're not connected to imap server
1854c4 1066     if (($config['logout_purge'] && !empty($config['trash_mbox'])) || $config['logout_expunge']) {
T 1067       if (!$this->authenticate_session())
1068         return;
1069
47d8d3 1070       $this->imap_connect();
1854c4 1071     }
T 1072
1073     if ($config['logout_purge'] && !empty($config['trash_mbox'])) {
1074       $this->imap->clear_mailbox($config['trash_mbox']);
1075     }
1076
1077     if ($config['logout_expunge']) {
1078       $this->imap->expunge('INBOX');
1079     }
1080   }
1081
1082
1083   /**
1084    * Function to be executed in script shutdown
1085    * Registered with register_shutdown_function()
1086    */
197601 1087   public function shutdown()
T 1088   {
2c3d81 1089     if (is_object($this->smtp))
A 1090       $this->smtp->disconnect();
1091
457373 1092     foreach ($this->books as $book)
A 1093       if (is_object($book))
1094         $book->close();
197601 1095
fcbf7a 1096     if (is_object($this->imap))
A 1097       $this->imap->close();
1098
197601 1099     // before closing the database connection, write session data
75da0b 1100     if ($_SERVER['REMOTE_ADDR'])
A 1101       session_write_close();
2b35c5 1102
A 1103     // write performance stats to logs/console
1104     if ($this->config->get('devel_mode')) {
1105       if (function_exists('memory_get_usage'))
1106         $mem = show_bytes(memory_get_usage());
1107       if (function_exists('memory_get_peak_usage'))
1108         $mem .= '/'.show_bytes(memory_get_peak_usage());
1109
1110       $log = $this->task . ($this->action ? '/'.$this->action : '') . ($mem ? " [$mem]" : '');
bf67d6 1111       if (defined('RCMAIL_START'))
A 1112         rcube_print_time(RCMAIL_START, $log);
1113       else
1114         console($log);
2b35c5 1115     }
197601 1116   }
b62a0d 1117
A 1118
1854c4 1119   /**
57f0c8 1120    * Generate a unique token to be used in a form request
T 1121    *
1122    * @return string The request token
1123    */
549933 1124   public function get_request_token()
57f0c8 1125   {
382b8b 1126     $sess_id = $_COOKIE[ini_get('session.name')];
A 1127     if (!$sess_id) $sess_id = session_id();
1128     return md5('RT' . $this->task . $this->config->get('des_key') . $sess_id);
57f0c8 1129   }
b62a0d 1130
A 1131
57f0c8 1132   /**
T 1133    * Check if the current request contains a valid token
1134    *
549933 1135    * @param int Request method
57f0c8 1136    * @return boolean True if request token is valid false if not
T 1137    */
549933 1138   public function check_request($mode = RCUBE_INPUT_POST)
57f0c8 1139   {
T 1140     $token = get_input_value('_token', $mode);
382b8b 1141     $sess_id = $_COOKIE[ini_get('session.name')];
A 1142     return !empty($sess_id) && $token == $this->get_request_token();
57f0c8 1143   }
b62a0d 1144
A 1145
57f0c8 1146   /**
1854c4 1147    * Create unique authorization hash
T 1148    *
1149    * @param string Session ID
1150    * @param int Timestamp
1151    * @return string The generated auth hash
1152    */
1153   private function get_auth_hash($sess_id, $ts)
1154   {
1155     $auth_string = sprintf('rcmail*sess%sR%s*Chk:%s;%s',
1156       $sess_id,
1157       $ts,
1158       $this->config->get('ip_check') ? $_SERVER['REMOTE_ADDR'] : '***.***.***.***',
1159       $_SERVER['HTTP_USER_AGENT']);
1160
1161     if (function_exists('sha1'))
1162       return sha1($auth_string);
1163     else
1164       return md5($auth_string);
1165   }
1166
2471d3 1167
1854c4 1168   /**
2471d3 1169    * Encrypt using 3DES
1854c4 1170    *
2471d3 1171    * @param string $clear clear text input
A 1172    * @param string $key encryption key to retrieve from the configuration, defaults to 'des_key'
1173    * @param boolean $base64 whether or not to base64_encode() the result before returning
1174    *
1175    * @return string encrypted text
1854c4 1176    */
2471d3 1177   public function encrypt($clear, $key = 'des_key', $base64 = true)
1854c4 1178   {
713a66 1179     if (!$clear)
A 1180       return '';
2471d3 1181     /*-
A 1182      * Add a single canary byte to the end of the clear text, which
1183      * will help find out how much of padding will need to be removed
1184      * upon decryption; see http://php.net/mcrypt_generic#68082
1185      */
1186     $clear = pack("a*H2", $clear, "80");
b62a0d 1187
2471d3 1188     if (function_exists('mcrypt_module_open') &&
A 1189         ($td = mcrypt_module_open(MCRYPT_TripleDES, "", MCRYPT_MODE_CBC, "")))
1190     {
564741 1191       $iv = $this->create_iv(mcrypt_enc_get_iv_size($td));
2471d3 1192       mcrypt_generic_init($td, $this->config->get_crypto_key($key), $iv);
A 1193       $cipher = $iv . mcrypt_generic($td, $clear);
1854c4 1194       mcrypt_generic_deinit($td);
T 1195       mcrypt_module_close($td);
1196     }
44155c 1197     else {
A 1198       @include_once('lib/des.inc');
1199
1200       if (function_exists('des')) {
1201         $des_iv_size = 8;
564741 1202         $iv = $this->create_iv($des_iv_size);
44155c 1203         $cipher = $iv . des($this->config->get_crypto_key($key), $clear, 1, 1, $iv);
A 1204       }
1205       else {
1206         raise_error(array(
1207           'code' => 500, 'type' => 'php',
1208           'file' => __FILE__, 'line' => __LINE__,
1209           'message' => "Could not perform encryption; make sure Mcrypt is installed or lib/des.inc is available"
1210         ), true, true);
1211       }
1854c4 1212     }
1a2754 1213
2471d3 1214     return $base64 ? base64_encode($cipher) : $cipher;
1854c4 1215   }
T 1216
1217   /**
2471d3 1218    * Decrypt 3DES-encrypted string
1854c4 1219    *
2471d3 1220    * @param string $cipher encrypted text
A 1221    * @param string $key encryption key to retrieve from the configuration, defaults to 'des_key'
1222    * @param boolean $base64 whether or not input is base64-encoded
1223    *
1224    * @return string decrypted text
1854c4 1225    */
2471d3 1226   public function decrypt($cipher, $key = 'des_key', $base64 = true)
1854c4 1227   {
713a66 1228     if (!$cipher)
A 1229       return '';
b62a0d 1230
2471d3 1231     $cipher = $base64 ? base64_decode($cipher) : $cipher;
A 1232
1233     if (function_exists('mcrypt_module_open') &&
1234         ($td = mcrypt_module_open(MCRYPT_TripleDES, "", MCRYPT_MODE_CBC, "")))
1235     {
9016a8 1236       $iv_size = mcrypt_enc_get_iv_size($td);
A 1237       $iv = substr($cipher, 0, $iv_size);
1238
1239       // session corruption? (#1485970)
1240       if (strlen($iv) < $iv_size)
1241         return '';
1242
1243       $cipher = substr($cipher, $iv_size);
2471d3 1244       mcrypt_generic_init($td, $this->config->get_crypto_key($key), $iv);
A 1245       $clear = mdecrypt_generic($td, $cipher);
1854c4 1246       mcrypt_generic_deinit($td);
T 1247       mcrypt_module_close($td);
1248     }
44155c 1249     else {
A 1250       @include_once('lib/des.inc');
b62a0d 1251
44155c 1252       if (function_exists('des')) {
A 1253         $des_iv_size = 8;
1254         $iv = substr($cipher, 0, $des_iv_size);
1255         $cipher = substr($cipher, $des_iv_size);
1256         $clear = des($this->config->get_crypto_key($key), $cipher, 0, 1, $iv);
1257       }
1258       else {
1259         raise_error(array(
1260           'code' => 500, 'type' => 'php',
1261           'file' => __FILE__, 'line' => __LINE__,
1262           'message' => "Could not perform decryption; make sure Mcrypt is installed or lib/des.inc is available"
1263         ), true, true);
1264       }
1854c4 1265     }
44155c 1266
2471d3 1267     /*-
A 1268      * Trim PHP's padding and the canary byte; see note in
1269      * rcmail::encrypt() and http://php.net/mcrypt_generic#68082
1270      */
1271     $clear = substr(rtrim($clear, "\0"), 0, -1);
b62a0d 1272
2471d3 1273     return $clear;
1854c4 1274   }
c719f3 1275
T 1276   /**
564741 1277    * Generates encryption initialization vector (IV)
A 1278    *
1279    * @param int Vector size
1280    * @return string Vector string
1281    */
1282   private function create_iv($size)
1283   {
1284     // mcrypt_create_iv() can be slow when system lacks entrophy
1285     // we'll generate IV vector manually
1286     $iv = '';
1287     for ($i = 0; $i < $size; $i++)
1288         $iv .= chr(mt_rand(0, 255));
1289     return $iv;
1290   }
1291
1292   /**
e019f2 1293    * Build a valid URL to this instance of Roundcube
c719f3 1294    *
T 1295    * @param mixed Either a string with the action or url parameters as key-value pairs
1296    * @return string Valid application URL
1297    */
1298   public function url($p)
1299   {
1300     if (!is_array($p))
fde466 1301       $p = array('_action' => @func_get_arg(0));
b62a0d 1302
1c932d 1303     $task = $p['_task'] ? $p['_task'] : ($p['task'] ? $p['task'] : $this->task);
cc97ea 1304     $p['_task'] = $task;
1038a6 1305     unset($p['task']);
A 1306
cf1777 1307     $url = './';
T 1308     $delm = '?';
cc97ea 1309     foreach (array_reverse($p) as $key => $val)
cf1777 1310     {
T 1311       if (!empty($val)) {
cc97ea 1312         $par = $key[0] == '_' ? $key : '_'.$key;
cf1777 1313         $url .= $delm.urlencode($par).'='.urlencode($val);
T 1314         $delm = '&';
1315       }
1316     }
c719f3 1317     return $url;
T 1318   }
cefd1d 1319
T 1320
1321   /**
1322    * Helper method to set a cookie with the current path and host settings
1323    *
1324    * @param string Cookie name
1325    * @param string Cookie value
1326    * @param string Expiration time
1327    */
1328   public static function setcookie($name, $value, $exp = 0)
1329   {
317a7d 1330     if (headers_sent())
A 1331       return;
1332
cefd1d 1333     $cookie = session_get_cookie_params();
2273d4 1334
cefd1d 1335     setcookie($name, $value, $exp, $cookie['path'], $cookie['domain'],
c96c5a 1336       rcube_https_check(), true);
cefd1d 1337   }
197601 1338 }
T 1339
1340