alecpl
2010-07-26 d5d968048601fa1d519f7cfee11f23918afc186c
program/include/rcmail.php
@@ -28,10 +28,10 @@
 */
class rcmail
{
  static public $main_tasks = array('mail','settings','addressbook','login','logout','dummy');
  static public $main_tasks = array('mail','settings','addressbook','login','logout','utils','dummy');
  static private $instance;
  public $config;
  public $user;
  public $db;
@@ -43,10 +43,10 @@
  public $task;
  public $action = '';
  public $comm_path = './';
  private $texts;
  /**
   * This implements the 'singleton' design pattern
   *
@@ -61,8 +61,8 @@
    return self::$instance;
  }
  /**
   * Private constructor
   */
@@ -70,11 +70,11 @@
  {
    // load configuration
    $this->config = new rcube_config();
    register_shutdown_function(array($this, 'shutdown'));
  }
  /**
   * Initial startup function
   * to register session, create database and imap connections
@@ -107,11 +107,12 @@
    $this->action = asciiwords(get_input_value('_action', RCUBE_INPUT_GPC));
    // reset some session parameters when changing task
    if ($_SESSION['task'] != $this->task)
      $this->session->remove('page');
    // set current task to session
    $_SESSION['task'] = $this->task;
    if ($this->task != 'utils') {
      if ($this->session && $_SESSION['task'] != $this->task)
        $this->session->remove('page');
      // set current task to session
      $_SESSION['task'] = $this->task;
    }
    // init output class
    if (!empty($_REQUEST['_remote']))
@@ -125,8 +126,8 @@
    // init plugins
    $this->plugins->init();
  }
  /**
   * Setter for application task
   *
@@ -143,12 +144,12 @@
    $this->task = $task;
    $this->comm_path = $this->url(array('task' => $this->task));
    if ($this->output)
      $this->output->set_env('task', $this->task);
  }
  /**
   * Setter for system user object
   *
@@ -159,22 +160,22 @@
    if (is_object($user)) {
      $this->user = $user;
      $GLOBALS['USER'] = $this->user;
      // overwrite config with user preferences
      $this->config->set_user_prefs((array)$this->user->get_prefs());
    }
    $_SESSION['language'] = $this->user->language = $this->language_prop($this->config->get('language', $_SESSION['language']));
    // set localization
    setlocale(LC_ALL, $_SESSION['language'] . '.utf8', 'en_US.utf8');
    // workaround for http://bugs.php.net/bug.php?id=18556
    if (in_array($_SESSION['language'], array('tr_TR', 'ku', 'az_AZ')))
      setlocale(LC_CTYPE, 'en_US' . '.utf8');
    // workaround for http://bugs.php.net/bug.php?id=18556
    if (in_array($_SESSION['language'], array('tr_TR', 'ku', 'az_AZ')))
      setlocale(LC_CTYPE, 'en_US' . '.utf8');
  }
  /**
   * Check the given string and return a valid language code
   *
@@ -184,17 +185,17 @@
  private function language_prop($lang)
  {
    static $rcube_languages, $rcube_language_aliases;
    // user HTTP_ACCEPT_LANGUAGE if no language is specified
    if (empty($lang) || $lang == 'auto') {
       $accept_langs = explode(',', $_SERVER['HTTP_ACCEPT_LANGUAGE']);
       $lang = str_replace('-', '_', $accept_langs[0]);
     }
    if (empty($rcube_languages)) {
      @include(INSTALL_PATH . 'program/localization/index.inc');
    }
    // check if we have an alias for that language
    if (!isset($rcube_languages[$lang]) && isset($rcube_language_aliases[$lang])) {
      $lang = $rcube_language_aliases[$lang];
@@ -202,7 +203,7 @@
    // try the first two chars
    else if (!isset($rcube_languages[$lang])) {
      $short = substr($lang, 0, 2);
      // check if we have an alias for the short language code
      if (!isset($rcube_languages[$short]) && isset($rcube_language_aliases[$short])) {
        $lang = $rcube_language_aliases[$short];
@@ -219,8 +220,8 @@
    return $lang;
  }
  /**
   * Get the current database connection
   *
@@ -239,8 +240,8 @@
    return $this->db;
  }
  /**
   * Return instance of the internal address book class
   *
@@ -255,7 +256,7 @@
    $abook_type = strtolower($this->config->get('address_book_type'));
    $plugin = $this->plugins->exec_hook('get_address_book', array('id' => $id, 'writeable' => $writeable));
    // plugin returned instance of a rcube_addressbook
    if ($plugin['instance'] instanceof rcube_addressbook) {
      $contacts = $plugin['instance'];
@@ -278,7 +279,7 @@
    else { // $id == 'sql'
      $contacts = new rcube_contacts($this->db, $this->user->ID);
    }
    return $contacts;
  }
@@ -333,8 +334,8 @@
    return $list;
  }
  /**
   * Init output object for GUI and add common scripts.
   * This will instantiate a rcmail_template object and set
@@ -350,7 +351,7 @@
      $this->output = new rcube_template($this->task, $framed);
    // set keep-alive/check-recent interval
    if ($keep_alive = $this->session->get_keep_alive()) {
    if ($this->session && ($keep_alive = $this->session->get_keep_alive())) {
      $this->output->set_env('keep_alive', $keep_alive);
    }
@@ -366,11 +367,11 @@
    // add some basic label to client
    $this->output->add_label('loading', 'servererror');
    return $this->output;
  }
  /**
   * Create an output object for JSON responses
   *
@@ -380,7 +381,7 @@
  {
    if (!($this->output instanceof rcube_json_output))
      $this->output = new rcube_json_output($this->task);
    return $this->output;
  }
@@ -393,12 +394,12 @@
  public function smtp_init($connect = false)
  {
    $this->smtp = new rcube_smtp();
    if ($connect)
      $this->smtp->connect();
  }
  /**
   * Create global IMAP object and connect to server
   *
@@ -410,7 +411,7 @@
    // already initialized
    if (is_object($this->imap))
      return;
    $this->imap = new rcube_imap($this->db);
    $this->imap->debug_level = $this->config->get('debug_level');
    $this->imap->skip_deleted = $this->config->get('skip_deleted');
@@ -422,26 +423,27 @@
    // set pagesize from config
    $this->imap->set_pagesize($this->config->get('pagesize', 50));
    // Setting root and delimiter before establishing the connection
    // can save time detecting them using NAMESPACE and LIST
    // can save time detecting them using NAMESPACE and LIST
    $options = array(
      'auth_method' => $this->config->get('imap_auth_type', 'check'),
      'delimiter' => isset($_SESSION['imap_delimiter']) ? $_SESSION['imap_delimiter'] : $this->config->get('imap_delimiter'),
      'rootdir' => isset($_SESSION['imap_root']) ? $_SESSION['imap_root'] : $this->config->get('imap_root'),
      'debug_mode' => (bool) $this->config->get('imap_debug', 0),
      'force_caps' => (bool) $this->config->get('imap_force_caps'),
      'delimiter'   => isset($_SESSION['imap_delimiter']) ? $_SESSION['imap_delimiter'] : $this->config->get('imap_delimiter'),
      'rootdir'     => isset($_SESSION['imap_root']) ? $_SESSION['imap_root'] : $this->config->get('imap_root'),
      'debug_mode'  => (bool) $this->config->get('imap_debug', 0),
      'force_caps'  => (bool) $this->config->get('imap_force_caps'),
      'timeout'     => (int) $this->config->get('imap_timeout', 0),
    );
    $this->imap->set_options($options);
    // set global object for backward compatibility
    $GLOBALS['IMAP'] = $this->imap;
    $hook = $this->plugins->exec_hook('imap_init', array('fetch_headers' => $this->imap->fetch_add_headers));
    if ($hook['fetch_headers'])
      $this->imap->fetch_add_headers = $hook['fetch_headers'];
    // support this parameter for backward compatibility but log warning
    if ($connect) {
      $this->imap_connect();
@@ -460,7 +462,7 @@
  {
    if (!$this->imap)
      $this->imap_init();
    if ($_SESSION['imap_host'] && !$this->imap->conn->connected()) {
      if (!$this->imap->connect($_SESSION['imap_host'], $_SESSION['username'], $this->decrypt($_SESSION['password']), $_SESSION['imap_port'], $_SESSION['imap_ssl'])) {
        if ($this->output)
@@ -481,6 +483,10 @@
   */
  public function session_init()
  {
    // session started (Installer?)
    if (session_id())
      return;
    $lifetime = $this->config->get('session_lifetime', 0) * 60;
    // set session domain
@@ -495,7 +501,7 @@
    ini_set('session.cookie_secure', rcube_https_check());
    ini_set('session.name', 'roundcube_sessid');
    ini_set('session.use_cookies', 1);
    ini_set('session.use_only_cookies', 1);
    ini_set('session.use_only_cookies', 1);
    ini_set('session.serialize_handler', 'php');
    // use database for storing session data
@@ -522,6 +528,9 @@
   */
  public function session_configure()
  {
    if (!$this->session)
      return;
    $lifetime = $this->config->get('session_lifetime', 0) * 60;
    // set keep-alive/check-recent interval
@@ -566,7 +575,7 @@
      if (!$allowed)
        return false;
      }
    else if (!empty($config['default_host']) && $host != $config['default_host'])
    else if (!empty($config['default_host']) && $host != rcube_parse_host($config['default_host']))
      return false;
    // parse $host URL
@@ -576,21 +585,21 @@
      $imap_ssl = (isset($a_host['scheme']) && in_array($a_host['scheme'], array('ssl','imaps','tls'))) ? $a_host['scheme'] : null;
      if(!empty($a_host['port']))
        $imap_port = $a_host['port'];
      else if ($imap_ssl && $imap_ssl != 'tls')
      else if ($imap_ssl && $imap_ssl != 'tls' && (!$config['default_port'] || $config['default_port'] == 143))
        $imap_port = 993;
    }
    $imap_port = $imap_port ? $imap_port : $config['default_port'];
    /* Modify username with domain if required
    /* Modify username with domain if required
       Inspired by Marco <P0L0_notspam_binware.org>
    */
    // Check if we need to add domain
    if (!empty($config['username_domain']) && !strpos($username, '@')) {
      if (is_array($config['username_domain']) && isset($config['username_domain'][$host]))
        $username .= '@'.$config['username_domain'][$host];
        $username .= '@'.rcube_parse_host($config['username_domain'][$host]);
      else if (is_string($config['username_domain']))
        $username .= '@'.$config['username_domain'];
        $username .= '@'.rcube_parse_host($config['username_domain']);
    }
    // try to resolve email address from virtuser table
@@ -633,7 +642,7 @@
      else {
        raise_error(array(
          'code' => 600, 'type' => 'php',
     'file' => __FILE__, 'line' => __LINE__,
         'file' => __FILE__, 'line' => __LINE__,
          'message' => "Failed to create a user record. Maybe aborted by a plugin?"
          ), true, false);
      }
@@ -658,8 +667,8 @@
      $_SESSION['imap_ssl']  = $imap_ssl;
      $_SESSION['password']  = $this->encrypt($pass);
      $_SESSION['login_time'] = mktime();
      if ($_REQUEST['_timezone'] != '_default_')
      if (isset($_REQUEST['_timezone']) && $_REQUEST['_timezone'] != '_default_')
        $_SESSION['timezone'] = floatval($_REQUEST['_timezone']);
      // force reloading complete list of subscribed mailboxes
@@ -689,7 +698,7 @@
    if (isset($_SESSION['page'])) {
      $this->imap->set_page($_SESSION['page']);
    }
    // cache IMAP root and delimiter in session for performance reasons
    $_SESSION['imap_root'] = $this->imap->root_dir;
    $_SESSION['imap_delimiter'] = $this->imap->delimiter;
@@ -705,15 +714,15 @@
  {
    $default_host = $this->config->get('default_host');
    $host = null;
    if (is_array($default_host)) {
      $post_host = get_input_value('_host', RCUBE_INPUT_POST);
      // direct match in default_host array
      if ($default_host[$post_host] || in_array($post_host, array_values($default_host))) {
        $host = $post_host;
      }
      // try to select host by mail domain
      list($user, $domain) = explode('@', get_input_value('_user', RCUBE_INPUT_POST));
      if (!empty($domain)) {
@@ -734,7 +743,7 @@
      $host = get_input_value('_host', RCUBE_INPUT_POST);
    }
    else
      $host = $default_host;
      $host = rcube_parse_host($default_host);
    return $host;
  }
@@ -751,7 +760,7 @@
    // load localization files if not done yet
    if (empty($this->texts))
      $this->load_language();
    // extract attributes
    if (is_string($attrib))
      $attrib = array('name' => $attrib);
@@ -767,7 +776,7 @@
      return "[$name]";
    }
    // make text item array
    // make text item array
    $a_text_item = is_array($text_item) ? $text_item : array('single' => $text_item);
    // decide which text to use
@@ -817,7 +826,7 @@
  public function load_language($lang = null, $add = array())
  {
    $lang = $this->language_prop(($lang ? $lang : $_SESSION['language']));
    // load localized texts
    if (empty($this->texts) || $lang != $_SESSION['language']) {
      $this->texts = array();
@@ -841,7 +850,7 @@
        if (is_array($messages))
          $this->texts = array_merge($this->texts, $messages);
      }
      $_SESSION['language'] = $lang;
    }
@@ -920,7 +929,7 @@
  public function kill_session()
  {
    $this->plugins->exec_hook('kill_session');
    $this->session->remove();
    $_SESSION = array('language' => $this->user->language, 'auth_time' => time(), 'temp' => true);
    rcmail::setcookie('sessauth', '-del-', time() - 60);
@@ -934,8 +943,8 @@
  public function logout_actions()
  {
    $config = $this->config->all();
    // on logout action we're not connected to imap server
    // on logout action we're not connected to imap server
    if (($config['logout_purge'] && !empty($config['trash_mbox'])) || $config['logout_expunge']) {
      if (!$this->authenticate_session())
        return;
@@ -980,11 +989,14 @@
        $mem .= '/'.show_bytes(memory_get_peak_usage());
      $log = $this->task . ($this->action ? '/'.$this->action : '') . ($mem ? " [$mem]" : '');
      rcube_print_time(RCMAIL_START, $log);
      if (defined('RCMAIL_START'))
        rcube_print_time(RCMAIL_START, $log);
      else
        console($log);
    }
  }
  /**
   * Generate a unique token to be used in a form request
   *
@@ -993,14 +1005,14 @@
  public function get_request_token()
  {
    $key = $this->task;
    if (!$_SESSION['request_tokens'][$key])
      $_SESSION['request_tokens'][$key] = md5(uniqid($key . mt_rand(), true));
    return $_SESSION['request_tokens'][$key];
  }
  /**
   * Check if the current request contains a valid token
   *
@@ -1012,8 +1024,8 @@
    $token = get_input_value('_token', $mode);
    return !empty($token) && $_SESSION['request_tokens'][$this->task] == $token;
  }
  /**
   * Create unique authorization hash
   *
@@ -1055,7 +1067,7 @@
     * upon decryption; see http://php.net/mcrypt_generic#68082
     */
    $clear = pack("a*H2", $clear, "80");
    if (function_exists('mcrypt_module_open') &&
        ($td = mcrypt_module_open(MCRYPT_TripleDES, "", MCRYPT_MODE_CBC, "")))
    {
@@ -1100,7 +1112,7 @@
  {
    if (!$cipher)
      return '';
    $cipher = $base64 ? base64_decode($cipher) : $cipher;
    if (function_exists('mcrypt_module_open') &&
@@ -1115,7 +1127,7 @@
    }
    else {
      @include_once('lib/des.inc');
      if (function_exists('des')) {
        $des_iv_size = 8;
        $iv = substr($cipher, 0, $des_iv_size);
@@ -1136,7 +1148,7 @@
     * rcmail::encrypt() and http://php.net/mcrypt_generic#68082
     */
    $clear = substr(rtrim($clear, "\0"), 0, -1);
    return $clear;
  }
@@ -1150,7 +1162,7 @@
  {
    if (!is_array($p))
      $p = array('_action' => @func_get_arg(0));
    $task = $p['_task'] ? $p['_task'] : ($p['task'] ? $p['task'] : $this->task);
    $p['_task'] = $task;
    unset($p['task']);