Trigger 'create_identity' when creating a new user; Allow 'create_user' hoo...

thomascube

2009-05-14 f879f4e2f8c81f67b0a0c471c94ebed686939c49

 program/include/rcube_user.php

@@ -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 @@
{
  public $ID = null;
  public $data = null;
  public $language = 'en_US';
  public $language = null;
  
  private $db = null;
  
@@ -59,17 +59,7 @@
    }
  }

  /**
   * 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 @@
   */
  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;
    }

@@ -156,7 +157,7 @@
       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;
@@ -318,16 +319,18 @@
  {
    $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 +346,25 @@
   */
  static function create($user, $host)
  {
    $user_name  = '';
    $user_email = '';
    $rcmail = rcmail::get_instance();

    $data = $rcmail->plugins->exec_hook('create_user', array('user'=>$user, 'user_name'=>$user_name, 'user_email'=>$user_email));
    $user_name = $data['user_name'];
    $user_email = $data['user_email'];
    
    // plugin aborted this operation
    if ($data['abort'])
      return false;

    $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 ($user_email != '' && !strpos($user, '@')) {
      if ($email_list = self::user2email($user, false))
        $user_email = $email_list[0];
    }

    $dbh->query(
      "INSERT INTO ".get_table_name('users')."
@@ -357,44 +372,48 @@
       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')))
    {
      $mail_domain = rcmail_mail_domain($host);
      $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 : '';

      // 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))
        {
          $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]));
        }
      if ($user_name == '') {
        $user_name = $user != $user_email ? $user : '';
      }
      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));

      if (empty($email_list))
        $email_list[] = strip_newlines($user_email); 

      // identities_level check
      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 $email) {
        $plugin = $RCMAIL->plugins->exec_hook('create_identity', array('record' => array(
          'login' => true,
          'user_id' => $user_id,
          'name' => strip_newlines($user_name),
          'email' => $email,
          'standard' => $standard)));
          
        if (!$plugin['abort'] && $plugin['record']['name'] && $plugin['record']['email']) {
          $dbh->query(
              "INSERT INTO ".get_table_name('identities')."
                (user_id, del, standard, name, email)
               VALUES (?, 0, ?, ?, ?)",
              $user_id,
              $plugin['record']['standard'],
              $plugin['record']['name'],
              $plugin['record']['email']);
        }
        $standard = 0;
      }
    }
    else
@@ -412,54 +431,98 @@
  
  
  /**
   * 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
   * @return mixed Resolved e-mail address string or array of strings
   */
  static function user2email($user)
  static function user2email($user, $first=true)
  {
    $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[] = $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;
  }

}