- small code improvements

alecpl

2009-09-20 bdab2c5faf8a2b311debce0b724a0b2df02aa60c

 program/include/rcmail.php

@@ -28,13 +28,14 @@
 */
class rcmail
{
  static public $main_tasks = array('mail','settings','addressbook','login','logout');
  static public $main_tasks = array('mail','settings','addressbook','login','logout','dummy');
  
  static private $instance;
  
  public $config;
  public $user;
  public $db;
  public $smtp;
  public $imap;
  public $output;
  public $plugins;
@@ -124,7 +125,7 @@

    // reset some session parameters when changing task
    if ($_SESSION['task'] != $this->task)
      unset($_SESSION['page']);
      rcube_sess_unset('page');

    // set current task to session
    $_SESSION['task'] = $this->task;
@@ -301,10 +302,6 @@
    if (!($this->output instanceof rcube_template))
      $this->output = new rcube_template($this->task, $framed);

    foreach (array('flag_for_deletion','read_when_deleted') as $js_config_var) {
      $this->output->set_env($js_config_var, $this->config->get($js_config_var));
    }
    
    // set keep-alive/check-recent interval
    if ($keep_alive = $this->config->get('keep_alive')) {
      // be sure that it's less than session lifetime
@@ -321,10 +318,10 @@
    $this->output->set_env('task', $this->task);
    $this->output->set_env('action', $this->action);
    $this->output->set_env('comm_path', $this->comm_path);
    $this->output->set_charset($this->config->get('charset', RCMAIL_CHARSET));
    $this->output->set_charset(RCMAIL_CHARSET);

    // add some basic label to client
    $this->output->add_label('loading');
    $this->output->add_label('loading', 'servererror');
    
    return $this->output;
  }
@@ -341,6 +338,20 @@
      $this->output = new rcube_json_output($this->task);
    
    return $this->output;
  }


  /**
   * Create SMTP object and connect to server
   *
   * @param boolean True if connection should be established
   */
  public function smtp_init($connect = false)
  {
    $this->smtp = new rcube_smtp();
  
    if ($connect)
      $this->smtp->connect();
  }
  
  
@@ -367,9 +378,10 @@
    // Setting root and delimiter before iil_Connect can save time detecting them
    // using NAMESPACE and LIST 
    $options = array(
      'imap' => $this->config->get('imap_auth_type', 'check'),
      '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),
    );

    $this->imap->set_options($options);
@@ -392,7 +404,7 @@
    $conn = false;
    
    if ($_SESSION['imap_host'] && !$this->imap->conn) {
      if (!($conn = $this->imap->connect($_SESSION['imap_host'], $_SESSION['username'], $this->decrypt_passwd($_SESSION['password']), $_SESSION['imap_port'], $_SESSION['imap_ssl']))) {
      if (!($conn = $this->imap->connect($_SESSION['imap_host'], $_SESSION['username'], $this->decrypt($_SESSION['password']), $_SESSION['imap_port'], $_SESSION['imap_ssl']))) {
        if ($this->output)
          $this->output->show_message($this->imap->error_code == -1 ? 'imaperror' : 'sessionerror', 'error');
      }
@@ -469,7 +481,7 @@

    // lowercase username if it's an e-mail address (#1484473)
    if (strpos($username, '@'))
      $username = rc_strtolower($username);
      $username = mb_strtolower($username);

    // user already registered -> overwrite username
    if ($user = rcube_user::query($username, $host))
@@ -491,6 +503,13 @@
        // get existing mailboxes (but why?)
        // $a_mailboxes = $this->imap->list_mailboxes();
      }
      else {
        raise_error(array(
          'code' => 600,
          'type' => 'php',
          'message' => "Failed to create a user record. Maybe aborted by a plugin?"
          ), true, false);        
      }
    }
    else {
      raise_error(array(
@@ -511,7 +530,7 @@
      $_SESSION['imap_host'] = $host;
      $_SESSION['imap_port'] = $imap_port;
      $_SESSION['imap_ssl']  = $imap_ssl;
      $_SESSION['password']  = $this->encrypt_passwd($pass);
      $_SESSION['password']  = $this->encrypt($pass);
      $_SESSION['login_time'] = mktime();
      
      if ($_REQUEST['_timezone'] != '_default_')
@@ -793,6 +812,9 @@
   */
  public function kill_session()
  {
    $this->plugins->exec_hook('kill_session');
    
    rcube_sess_unset();
    $_SESSION = array('language' => $this->user->language, 'auth_time' => time(), 'temp' => true);
    rcmail::setcookie('sessauth', '-del-', time() - 60);
    $this->user->reset();
@@ -835,12 +857,44 @@
      $this->imap->write_cache();
    }

    if (is_object($this->smtp))
      $this->smtp->disconnect();

    if (is_object($this->contacts))
      $this->contacts->close();

    // before closing the database connection, write session data
    if ($_SERVER['REMOTE_ADDR'])
      session_write_close();
  }
  
  
  /**
   * Generate a unique token to be used in a form request
   *
   * @return string The request token
   */
  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
   *
   * @param int Request method
   * @return boolean True if request token is valid false if not
   */
  public function check_request($mode = RCUBE_INPUT_POST)
  {
    $token = get_input_value('_token', $mode);
    return !empty($token) && $_SESSION['request_tokens'][$this->task] == $token;
  }
  
  
@@ -865,64 +919,108 @@
      return md5($auth_string);
  }


  /**
   * Encrypt IMAP password using DES encryption
   * Encrypt using 3DES
   *
   * @param string Password to encrypt
   * @return string Encryprted string
   * @param string $clear clear text input
   * @param string $key encryption key to retrieve from the configuration, defaults to 'des_key'
   * @param boolean $base64 whether or not to base64_encode() the result before returning
   *
   * @return string encrypted text
   */
  public function encrypt_passwd($pass)
  public function encrypt($clear, $key = 'des_key', $base64 = true)
  {
    if (function_exists('mcrypt_module_open') && ($td = mcrypt_module_open(MCRYPT_TripleDES, "", MCRYPT_MODE_ECB, ""))) {
    if (!$clear)
      return '';
    /*-
     * Add a single canary byte to the end of the clear text, which
     * will help find out how much of padding will need to be removed
     * 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, "")))
    {
      $iv = mcrypt_create_iv(mcrypt_enc_get_iv_size($td), MCRYPT_RAND);
      mcrypt_generic_init($td, $this->config->get_des_key(), $iv);
      $cypher = mcrypt_generic($td, $pass);
      mcrypt_generic_init($td, $this->config->get_crypto_key($key), $iv);
      $cipher = $iv . mcrypt_generic($td, $clear);
      mcrypt_generic_deinit($td);
      mcrypt_module_close($td);
    }
    else if (function_exists('des')) {
      $cypher = des($this->config->get_des_key(), $pass, 1, 0, NULL);
    else if (function_exists('des'))
    {
      define('DES_IV_SIZE', 8);
      $iv = '';
      for ($i = 0; $i < constant('DES_IV_SIZE'); $i++)
        $iv .= sprintf("%c", mt_rand(0, 255));
      $cipher = $iv . des($this->config->get_crypto_key($key), $clear, 1, 1, $iv);
    }
    else {
      $cypher = $pass;

    else
    {
      raise_error(array(
        'code' => 500,
        'type' => 'php',
        'file' => __FILE__,
        'message' => "Could not convert encrypt password. Make sure Mcrypt is installed or lib/des.inc is available"
        ), true, false);
        'message' => "Could not perform encryption; make sure Mcrypt is installed or lib/des.inc is available"
      ), true, true);
    }

    return base64_encode($cypher);
  
    return $base64 ? base64_encode($cipher) : $cipher;
  }


  /**
   * Decrypt IMAP password using DES encryption
   * Decrypt 3DES-encrypted string
   *
   * @param string Encrypted password
   * @return string Plain password
   * @param string $cipher encrypted text
   * @param string $key encryption key to retrieve from the configuration, defaults to 'des_key'
   * @param boolean $base64 whether or not input is base64-encoded
   *
   * @return string decrypted text
   */
  public function decrypt_passwd($cypher)
  public function decrypt($cipher, $key = 'des_key', $base64 = true)
  {
    if (function_exists('mcrypt_module_open') && ($td = mcrypt_module_open(MCRYPT_TripleDES, "", MCRYPT_MODE_ECB, ""))) {
      $iv = mcrypt_create_iv(mcrypt_enc_get_iv_size($td), MCRYPT_RAND);
      mcrypt_generic_init($td, $this->config->get_des_key(), $iv);
      $pass = mdecrypt_generic($td, base64_decode($cypher));
    if (!$cipher)
      return '';
  
    $cipher = $base64 ? base64_decode($cipher) : $cipher;

    if (function_exists('mcrypt_module_open') &&
        ($td = mcrypt_module_open(MCRYPT_TripleDES, "", MCRYPT_MODE_CBC, "")))
    {
      $iv = substr($cipher, 0, mcrypt_enc_get_iv_size($td));
      $cipher = substr($cipher, mcrypt_enc_get_iv_size($td));
      mcrypt_generic_init($td, $this->config->get_crypto_key($key), $iv);
      $clear = mdecrypt_generic($td, $cipher);
      mcrypt_generic_deinit($td);
      mcrypt_module_close($td);
    }
    else if (function_exists('des')) {
      $pass = des($this->config->get_des_key(), base64_decode($cypher), 0, 0, NULL);
    else if (function_exists('des'))
    {
      define('DES_IV_SIZE', 8);
      $iv = substr($cipher, 0, constant('DES_IV_SIZE'));
      $cipher = substr($cipher, constant('DES_IV_SIZE'));
      $clear = des($this->config->get_crypto_key($key), $cipher, 0, 1, $iv);
    }
    else {
      $pass = base64_decode($cypher);
    else
    {
      raise_error(array(
        'code' => 500,
        'type' => 'php',
        'file' => __FILE__,
        'message' => "Could not perform decryption; make sure Mcrypt is installed or lib/des.inc is available"
      ), true, true);
    }

    return preg_replace('/\x00/', '', $pass);
  
    /*-
     * Trim PHP's padding and the canary byte; see note in
     * rcmail::encrypt() and http://php.net/mcrypt_generic#68082
     */
    $clear = substr(rtrim($clear, "\0"), 0, -1);
  
    return $clear;
  }


  /**
   * Build a valid URL to this instance of RoundCube