From 69f18a09aec6e352ff021cd9c5db806f341b7e48 Mon Sep 17 00:00:00 2001
From: thomascube <thomas@roundcube.net>
Date: Fri, 01 May 2009 15:04:26 -0400
Subject: [PATCH] Add plugin hooks for creating/saving/deleting identities and contacts
---
program/include/rcube_user.php | 307 ++++++++++++++++++++++++++++----------------------
1 files changed, 171 insertions(+), 136 deletions(-)
diff --git a/program/include/rcube_user.php b/program/include/rcube_user.php
index e748758..9d5cc5f 100644
--- a/program/include/rcube_user.php
+++ b/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: |
@@ -24,13 +24,16 @@
/**
* Class representing a system user
*
- * @package core
+ * @package Core
* @author Thomas Bruederli <roundcube@gmail.com>
*/
class rcube_user
{
- var $ID = null;
- var $data = null;
+ public $ID = null;
+ public $data = null;
+ public $language = null;
+
+ private $db = null;
/**
@@ -40,32 +43,23 @@
*/
function __construct($id = null, $sql_arr = null)
{
- global $DB;
+ $this->db = rcmail::get_instance()->get_dbh();
if ($id && !$sql_arr)
{
- $sql_result = $DB->query("SELECT * FROM ".get_table_name('users')." WHERE user_id=?", $id);
- $sql_arr = $DB->fetch_assoc($sql_result);
+ $sql_result = $this->db->query("SELECT * FROM ".get_table_name('users')." WHERE user_id=?", $id);
+ $sql_arr = $this->db->fetch_assoc($sql_result);
}
if (!empty($sql_arr))
{
$this->ID = $sql_arr['user_id'];
$this->data = $sql_arr;
+ $this->language = $sql_arr['language'];
}
}
- /**
- * 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)
*
@@ -84,41 +78,52 @@
*/
function get_prefs()
{
+ if (!empty($this->language))
+ $prefs = array('language' => $this->language);
+
if ($this->ID && $this->data['preferences'])
- return 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)
{
- global $DB, $CONFIG, $sess_user_lang;
-
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();
-
- $DB->query(
+ $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),
- $sess_user_lang,
+ serialize($save_prefs),
+ $_SESSION['language'],
$this->ID);
- if ($DB->affected_rows())
- {
- $CONFIG = array_merge($CONFIG, $a_user_prefs);
+ $this->language = $_SESSION['language'];
+ if ($this->db->affected_rows()) {
+ $config->merge($a_user_prefs);
return true;
}
@@ -134,10 +139,8 @@
*/
function get_identity($id = null)
{
- global $DB;
-
$sql_result = $this->list_identities($id ? sprintf('AND identity_id=%d', $id) : '');
- return $DB->fetch_assoc($sql_result);
+ return $this->db->fetch_assoc($sql_result);
}
@@ -148,15 +151,13 @@
*/
function list_identities($sql_add = '')
{
- global $DB;
-
// get contacts from DB
- $sql_result = $DB->query(
+ $sql_result = $this->db->query(
"SELECT * FROM ".get_table_name('identities')."
WHERE del<>1
AND user_id=?
$sql_add
- ORDER BY ".$DB->quoteIdentifier('standard')." DESC, name ASC",
+ ORDER BY ".$this->db->quoteIdentifier('standard')." DESC, name ASC, identity_id ASC",
$this->ID);
return $sql_result;
@@ -172,8 +173,6 @@
*/
function update_identity($iid, $data)
{
- global $DB;
-
if (!$this->ID)
return false;
@@ -182,11 +181,11 @@
foreach ((array)$data as $col => $value)
{
$write_sql[] = sprintf("%s=%s",
- $DB->quoteIdentifier($col),
- $DB->quote($value));
+ $this->db->quoteIdentifier($col),
+ $this->db->quote($value));
}
- $DB->query(
+ $this->db->query(
"UPDATE ".get_table_name('identities')."
SET ".join(', ', $write_sql)."
WHERE identity_id=?
@@ -195,7 +194,7 @@
$iid,
$this->ID);
- return $DB->affected_rows();
+ return $this->db->affected_rows();
}
@@ -207,25 +206,23 @@
*/
function insert_identity($data)
{
- global $DB;
-
if (!$this->ID)
return false;
$insert_cols = $insert_values = array();
foreach ((array)$data as $col => $value)
{
- $insert_cols[] = $DB->quoteIdentifier($col);
- $insert_values[] = $DB->quote($value);
+ $insert_cols[] = $this->db->quoteIdentifier($col);
+ $insert_values[] = $this->db->quote($value);
}
- $DB->query(
+ $this->db->query(
"INSERT INTO ".get_table_name('identities')."
(user_id, ".join(', ', $insert_cols).")
VALUES (?, ".join(', ', $insert_values).")",
$this->ID);
- return $DB->insert_id(get_sequence_name('identities'));
+ return $this->db->insert_id(get_sequence_name('identities'));
}
@@ -237,24 +234,22 @@
*/
function delete_identity($iid)
{
- global $DB;
-
if (!$this->ID)
return false;
if (!$this->ID || $this->ID == '')
return false;
- $sql_result = $DB->query("SELECT count(*) AS ident_count FROM " .
+ $sql_result = $this->db->query("SELECT count(*) AS ident_count FROM " .
get_table_name('identities') .
" WHERE user_id = ? AND del <> 1",
$this->ID);
- $sql_arr = $DB->fetch_assoc($sql_result);
+ $sql_arr = $this->db->fetch_assoc($sql_result);
if ($sql_arr['ident_count'] <= 1)
return false;
- $DB->query(
+ $this->db->query(
"UPDATE ".get_table_name('identities')."
SET del=1
WHERE user_id=?
@@ -262,7 +257,7 @@
$this->ID,
$iid);
- return $DB->affected_rows();
+ return $this->db->affected_rows();
}
@@ -273,13 +268,11 @@
*/
function set_default($iid)
{
- global $DB;
-
if ($this->ID && $iid)
{
- $DB->query(
+ $this->db->query(
"UPDATE ".get_table_name('identities')."
- SET ".$DB->quoteIdentifier('standard')."='0'
+ SET ".$this->db->quoteIdentifier('standard')."='0'
WHERE user_id=?
AND identity_id<>?
AND del<>1",
@@ -294,13 +287,11 @@
*/
function touch()
{
- global $DB;
-
if ($this->ID)
{
- $DB->query(
+ $this->db->query(
"UPDATE ".get_table_name('users')."
- SET last_login=".$DB->now()."
+ SET last_login=".$this->db->now()."
WHERE user_id=?",
$this->ID);
}
@@ -323,22 +314,23 @@
* @param string IMAP user name
* @param string IMAP host name
* @return object rcube_user New user instance
- * @static
*/
- function query($user, $host)
+ static function query($user, $host)
{
- global $DB;
+ $dbh = rcmail::get_instance()->get_dbh();
- // query if user already registered
- $sql_result = $DB->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 = $DB->fetch_assoc($sql_result))
+ if ($sql_arr)
return new rcube_user($sql_arr['user_id'], $sql_arr);
else
return false;
@@ -351,62 +343,64 @@
* @param string IMAP user name
* @param string IMAP host
* @return object rcube_user New user instance
- * @static
*/
- function create($user, $host)
+ static function create($user, $host)
{
- global $DB, $CONFIG;
-
+ $user_name = '';
$user_email = '';
+ $rcmail = rcmail::get_instance();
- // try to resolve user in virtusertable
- if (!empty($CONFIG['virtuser_file']) && !strpos($user, '@'))
- $user_email = rcube_user::user2email($user);
+ $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'];
- $DB->query(
+ $dbh = $rcmail->get_dbh();
+
+ // 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')."
(created, last_login, username, mail_host, alias, language)
- VALUES (".$DB->now().", ".$DB->now().", ?, ?, ?, ?)",
+ VALUES (".$dbh->now().", ".$dbh->now().", ?, ?, ?, ?)",
strip_newlines($user),
strip_newlines($host),
- strip_newlines($user_email),
- $_SESSION['user_lang']);
+ strip_newlines($data['alias'] ? $data['alias'] : $user_email),
+ $_SESSION['language']);
- if ($user_id = $DB->insert_id(get_sequence_name('users')))
+ 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 : '';
+ if ($user_name == '') {
+ $user_name = $user != $user_email ? $user : '';
+ }
- // try to resolve the e-mail address from the virtuser table
- if (!empty($CONFIG['virtuser_query']) &&
- ($sql_result = $DB->query(preg_replace('/%u/', $DB->escapeSimple($user), $CONFIG['virtuser_query']))) &&
- ($DB->num_rows()>0))
- {
- while ($sql_arr = $DB->fetch_array($sql_result))
- {
- $DB->query(
+ 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) {
+ $dbh->query(
"INSERT INTO ".get_table_name('identities')."
(user_id, del, standard, name, email)
- VALUES (?, 0, 1, ?, ?)",
+ VALUES (?, 0, ?, ?, ?)",
$user_id,
+ $standard,
strip_newlines($user_name),
- preg_replace('/^@/', $user . '@', $sql_arr[0]));
- }
- }
- else
- {
- // also create new identity records
- $DB->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));
+ preg_replace('/^@/', $user . '@', $email));
+ $standard = 0;
}
}
else
@@ -424,59 +418,100 @@
/**
- * 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)
+ static function email2user($email)
{
- $user = $email;
- $r = rcmail_findinvirtual("^$email");
+ $r = self::findinvirtual('^' . quotemeta($email) . '[[:space:]]');
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
- * @static
+ * @param boolean If true returns first found entry
+ * @return mixed Resolved e-mail address string or array of strings
*/
- 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('[[:space:]]' . quotemeta($user) . '[[:space:]]*$');
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 (eregi($pattern, $line))
+ $result[] = $line;
+ }
+
+ return $result;
}
}
-?>
--
Gitblit v1.9.1