]> git.donarmstrong.com Git - roundcube.git/blobdiff - program/include/rcube_user.php
Don't let www-data overwrite debian-db.php. Closes: #608976.
[roundcube.git] / program / include / rcube_user.php
index c808d079ee865f9d0d299492634e503d35b2f413..c2cad1121289d318ac73b749757c12f8c3dff96e 100644 (file)
@@ -5,7 +5,7 @@
  | program/include/rcube_user.inc                                        |
  |                                                                       |
  | This file is part of the RoundCube Webmail client                     |
- | Copyright (C) 2005-2007, RoundCube Dev. - Switzerland                 |
+ | Copyright (C) 2005-2009, RoundCube Dev. - Switzerland                 |
  | Licensed under the GNU GPL                                            |
  |                                                                       |
  | PURPOSE:                                                              |
@@ -31,7 +31,7 @@ class rcube_user
 {
   public $ID = null;
   public $data = null;
-  public $language = 'en_US';
+  public $language = null;
   
   private $db = null;
   
@@ -59,17 +59,7 @@ class rcube_user
     }
   }
 
-  /**
-   * PHP 4 object constructor
-   *
-   * @see  rcube_user::__construct
-   */
-  function rcube_user($id = null, $sql_arr = null)
-  {
-    $this->__construct($id, $sql_arr);
-  }
-  
-  
+
   /**
    * Build a user name string (as e-mail address)
    *
@@ -88,41 +78,52 @@ class rcube_user
    */
   function get_prefs()
   {
+    if (!empty($this->language))
+      $prefs = array('language' => $this->language);
+    
     if ($this->ID && $this->data['preferences'])
-      return array('language' => $this->language) + unserialize($this->data['preferences']);
-    else
-      return array();
+      $prefs += (array)unserialize($this->data['preferences']);
+    
+    return $prefs;
   }
   
   
   /**
    * Write the given user prefs to the user's record
    *
-   * @param mixed User prefs to save
+   * @param array User prefs to save
    * @return boolean True on success, False on failure
    */
   function save_prefs($a_user_prefs)
   {
     if (!$this->ID)
       return false;
+      
+    $config = rcmail::get_instance()->config;
+    $old_prefs = (array)$this->get_prefs();
 
     // merge (partial) prefs array with existing settings
-    $a_user_prefs += (array)$this->get_prefs();
-    unset($a_user_prefs['language']);
-
+    $save_prefs = $a_user_prefs + $old_prefs;
+    unset($save_prefs['language']);
+    
+    // don't save prefs with default values if they haven't been changed yet
+    foreach ($a_user_prefs as $key => $value) {
+      if (!isset($old_prefs[$key]) && ($value == $config->get($key)))
+        unset($save_prefs[$key]);
+    }
+    
     $this->db->query(
       "UPDATE ".get_table_name('users')."
        SET    preferences=?,
               language=?
        WHERE  user_id=?",
-      serialize($a_user_prefs),
+      serialize($save_prefs),
       $_SESSION['language'],
       $this->ID);
 
     $this->language = $_SESSION['language'];
-    if ($this->db->affected_rows())
-    {
-      rcmail::get_instance()->config->merge($a_user_prefs);
+    if ($this->db->affected_rows()) {
+      $config->merge($a_user_prefs);
       return true;
     }
 
@@ -134,12 +135,12 @@ class rcube_user
    * Get default identity of this user
    *
    * @param int  Identity ID. If empty, the default identity is returned
-   * @return array Hash array with all cols of the 
+   * @return array Hash array with all cols of the identity record
    */
   function get_identity($id = null)
   {
-    $sql_result = $this->list_identities($id ? sprintf('AND identity_id=%d', $id) : '');
-    return $this->db->fetch_assoc($sql_result);
+    $result = $this->list_identities($id ? sprintf('AND identity_id=%d', $id) : '');
+    return $result[0];
   }
   
   
@@ -156,10 +157,15 @@ class rcube_user
        WHERE  del<>1
        AND    user_id=?
        $sql_add
-       ORDER BY ".$this->db->quoteIdentifier('standard')." DESC, name ASC",
+       ORDER BY ".$this->db->quoteIdentifier('standard')." DESC, name ASC, identity_id ASC",
       $this->ID);
     
-    return $sql_result;
+    $result = array();
+    while ($sql_arr = $this->db->fetch_assoc($sql_result)) {
+      $result[] = $sql_arr;
+    }
+    
+    return $result;
   }
   
   
@@ -175,23 +181,24 @@ class rcube_user
     if (!$this->ID)
       return false;
     
-    $write_sql = array();
+    $query_cols = $query_params = array();
     
     foreach ((array)$data as $col => $value)
     {
-      $write_sql[] = sprintf("%s=%s",
-        $this->db->quoteIdentifier($col),
-        $this->db->quote($value));
+      $query_cols[] = $this->db->quoteIdentifier($col) . '=?';
+      $query_params[] = $value;
     }
-    
-    $this->db->query(
-      "UPDATE ".get_table_name('identities')."
-       SET ".join(', ', $write_sql)."
+    $query_params[] = $iid;
+    $query_params[] = $this->ID;
+
+    $sql = "UPDATE ".get_table_name('identities')."
+       SET ".join(', ', $query_cols)."
        WHERE  identity_id=?
        AND    user_id=?
-       AND    del<>1",
-      $iid,
-      $this->ID);
+       AND    del<>1";
+
+    call_user_func_array(array($this->db, 'query'),
+                        array_merge(array($sql), $query_params));
     
     return $this->db->affected_rows();
   }
@@ -212,16 +219,19 @@ class rcube_user
     foreach ((array)$data as $col => $value)
     {
       $insert_cols[] = $this->db->quoteIdentifier($col);
-      $insert_values[] = $this->db->quote($value);
+      $insert_values[] = $value;
     }
+    $insert_cols[] = 'user_id';
+    $insert_values[] = $this->ID;
 
-    $this->db->query(
-      "INSERT INTO ".get_table_name('identities')."
-        (user_id, ".join(', ', $insert_cols).")
-       VALUES (?, ".join(', ', $insert_values).")",
-      $this->ID);
+    $sql = "INSERT INTO ".get_table_name('identities')."
+        (".join(', ', $insert_cols).")
+       VALUES (".join(', ', array_pad(array(), sizeof($insert_values), '?')).")";
 
-    return $this->db->insert_id(get_sequence_name('identities'));
+    call_user_func_array(array($this->db, 'query'),
+                        array_merge(array($sql), $insert_values));
+
+    return $this->db->insert_id('identities');
   }
   
   
@@ -318,16 +328,18 @@ class rcube_user
   {
     $dbh = rcmail::get_instance()->get_dbh();
     
-    // query if user already registered
-    $sql_result = $dbh->query(
-      "SELECT * FROM ".get_table_name('users')."
-       WHERE  mail_host=? AND (username=? OR alias=?)",
-      $host,
-      $user,
-      $user);
-      
+    // query for matching user name
+    $query = "SELECT * FROM ".get_table_name('users')." WHERE mail_host=? AND %s=?";
+    $sql_result = $dbh->query(sprintf($query, 'username'), $host, $user);
+    
+    // query for matching alias
+    if (!($sql_arr = $dbh->fetch_assoc($sql_result))) {
+      $sql_result = $dbh->query(sprintf($query, 'alias'), $host, $user);
+      $sql_arr = $dbh->fetch_assoc($sql_result);
+    }
+    
     // user already registered -> overwrite username
-    if ($sql_arr = $dbh->fetch_assoc($sql_result))
+    if ($sql_arr)
       return new rcube_user($sql_arr['user_id'], $sql_arr);
     else
       return false;
@@ -343,13 +355,26 @@ class rcube_user
    */
   static function create($user, $host)
   {
+    $user_name  = '';
     $user_email = '';
     $rcmail = rcmail::get_instance();
-    $dbh = $rcmail->get_dbh();
 
-    // try to resolve user in virtusertable
-    if ($rcmail->config->get('virtuser_file') && !strpos($user, '@'))
-      $user_email = rcube_user::user2email($user);
+    // try to resolve user in virtuser table and file
+    if ($email_list = self::user2email($user, false, true)) {
+      $user_email = is_array($email_list[0]) ? $email_list[0][0] : $email_list[0];
+    }
+
+    $data = $rcmail->plugins->exec_hook('create_user',
+       array('user'=>$user, 'user_name'=>$user_name, 'user_email'=>$user_email));
+
+    // plugin aborted this operation
+    if ($data['abort'])
+      return false;
+
+    $user_name = $data['user_name'];
+    $user_email = $data['user_email'];
+
+    $dbh = $rcmail->get_dbh();
 
     $dbh->query(
       "INSERT INTO ".get_table_name('users')."
@@ -357,44 +382,65 @@ class rcube_user
        VALUES (".$dbh->now().", ".$dbh->now().", ?, ?, ?, ?)",
       strip_newlines($user),
       strip_newlines($host),
-      strip_newlines($user_email),
+      strip_newlines($data['alias'] ? $data['alias'] : $user_email),
       $_SESSION['language']);
 
-    if ($user_id = $dbh->insert_id(get_sequence_name('users')))
+    if ($user_id = $dbh->insert_id('users'))
     {
-      $mail_domain = rcmail_mail_domain($host);
+      // create rcube_user instance to make plugin hooks work
+      $user_instance = new rcube_user($user_id);
+      $rcmail->user = $user_instance;
+
+      $mail_domain = $rcmail->config->mail_domain($host);
 
       if ($user_email=='')
         $user_email = strpos($user, '@') ? $user : sprintf('%s@%s', $user, $mail_domain);
 
-      $user_name = $user != $user_email ? $user : '';
+      if ($user_name == '') {
+        $user_name = $user != $user_email ? $user : '';
+      }
 
-      // try to resolve the e-mail address from the virtuser table
-      if ($virtuser_query = $rcmail->config->get('virtuser_query') &&
-          ($sql_result = $dbh->query(preg_replace('/%u/', $dbh->escapeSimple($user), $virtuser_query))) &&
-          ($dbh->num_rows() > 0))
-      {
-        while ($sql_arr = $dbh->fetch_array($sql_result))
-        {
+      if (empty($email_list))
+        $email_list[] = strip_newlines($user_email);
+      // identities_level check
+      else if (count($email_list) > 1 && $rcmail->config->get('identities_level', 0) > 1)
+        $email_list = array($email_list[0]);
+
+      // create new identities records
+      $standard = 1;
+      foreach ($email_list as $row) {
+        if (is_array($row)) {
+          $email = $row[0];
+          $name = $row[1] ? $row[1] : $user_name;
+        }
+        else {
+          $email = $row;
+          $name = $user_name;
+        }
+
+        $plugin = $rcmail->plugins->exec_hook('create_identity', array(
+          'login' => true,
+          'record' => array(
+            'user_id' => $user_id,
+            'name' => strip_newlines($name),
+            'email' => $email,
+            'standard' => $standard,
+            'signature' => '',
+          ),
+        ));
+          
+        if (!$plugin['abort'] && $plugin['record']['email']) {
           $dbh->query(
-            "INSERT INTO ".get_table_name('identities')."
-              (user_id, del, standard, name, email)
-             VALUES (?, 0, 1, ?, ?)",
-            $user_id,
-            strip_newlines($user_name),
-            preg_replace('/^@/', $user . '@', $sql_arr[0]));
+              "INSERT INTO ".get_table_name('identities')."
+                (user_id, del, standard, name, email, signature)
+               VALUES (?, 0, ?, ?, ?, ?)",
+              $user_id,
+              $plugin['record']['standard'],
+              $plugin['record']['name'] != NULL ? $plugin['record']['name'] : '',
+              $plugin['record']['email'],
+              $plugin['record']['signature']);
         }
-      }
-      else
-      {
-        // also create new identity records
-        $dbh->query(
-          "INSERT INTO ".get_table_name('identities')."
-            (user_id, del, standard, name, email)
-           VALUES (?, 0, 1, ?, ?)",
-          $user_id,
-          strip_newlines($user_name),
-          strip_newlines($user_email));
+        $standard = 0;
       }
     }
     else
@@ -407,59 +453,104 @@ class rcube_user
         'message' => "Failed to create new user"), true, false);
     }
     
-    return $user_id ? new rcube_user($user_id) : false;
+    return $user_id ? $user_instance : false;
   }
   
   
   /**
-   * Resolve username using a virtuser table
+   * Resolve username using a virtuser file
    *
    * @param string E-mail address to resolve
    * @return string Resolved IMAP username
    */
   static function email2user($email)
   {
-    $user = $email;
-    $r = rcmail_findinvirtual("^$email");
+    $r = self::findinvirtual('/^' . preg_quote($email, '/') . '\s/');
 
     for ($i=0; $i<count($r); $i++)
     {
-      $data = $r[$i];
+      $data = trim($r[$i]);
       $arr = preg_split('/\s+/', $data);
       if (count($arr) > 0)
-      {
-        $user = trim($arr[count($arr)-1]);
-        break;
-      }
+        return trim($arr[count($arr)-1]);
     }
 
-    return $user;
+    return NULL;
   }
 
 
   /**
-   * Resolve e-mail address from virtuser table
+   * Resolve e-mail address from virtuser file/table
    *
    * @param string User name
-   * @return string Resolved e-mail address
+   * @param boolean If true returns first found entry
+   * @param boolean If true returns email as array (email and name for identity)
+   * @return mixed Resolved e-mail address string or array of strings
    */
-  static function user2email($user)
+  static function user2email($user, $first=true, $extended=false)
   {
-    $email = "";
-    $r = rcmail_findinvirtual("$user$");
+    $result = array();
+    $rcmail = rcmail::get_instance();
+    $dbh = $rcmail->get_dbh();
 
+    // SQL lookup
+    if ($virtuser_query = $rcmail->config->get('virtuser_query')) {
+      $sql_result = $dbh->query(preg_replace('/%u/', $dbh->escapeSimple($user), $virtuser_query));
+      while ($sql_arr = $dbh->fetch_array($sql_result))
+        if (strpos($sql_arr[0], '@')) {
+          $result[] = ($extended && count($sql_arr) > 1) ? $sql_arr : $sql_arr[0];
+          if ($first)
+            return $result[0];
+        }
+    }
+    // File lookup
+    $r = self::findinvirtual('/\s' . preg_quote($user, '/') . '\s*$/');
     for ($i=0; $i<count($r); $i++)
     {
       $data = $r[$i];
       $arr = preg_split('/\s+/', $data);
-      if (count($arr) > 0)
+      if (count($arr) > 0 && strpos($arr[0], '@'))
       {
-        $email = trim(str_replace('\\@', '@', $arr[0]));
-        break;
+        $result[] = trim(str_replace('\\@', '@', $arr[0]));
+
+        if ($first)
+          return $result[0];
       }
     }
-
-    return $email;
+    
+    return empty($result) ? NULL : $result;
+  }
+  
+  
+  /**
+   * Find matches of the given pattern in virtuser file
+   * 
+   * @param string Regular expression to search for
+   * @return array Matching entries
+   */
+  private static function findinvirtual($pattern)
+  {
+    $result = array();
+    $virtual = null;
+    
+    if ($virtuser_file = rcmail::get_instance()->config->get('virtuser_file'))
+      $virtual = file($virtuser_file);
+    
+    if (empty($virtual))
+      return $result;
+    
+    // check each line for matches
+    foreach ($virtual as $line)
+    {
+      $line = trim($line);
+      if (empty($line) || $line{0}=='#')
+        continue;
+        
+      if (preg_match($pattern, $line))
+        $result[] = $line;
+    }
+    
+    return $result;
   }
 
 }