githubFork/roundcubemail.git

alecpl

2008-10-03 f613a1e4e004dd03d7de80ea5a45bee71d3a3454

commit \| author \| age
fba1f5	1	<?php
T	2
	3	/*
	4	+-----------------------------------------------------------------------+
	5	\| program/include/rcube_user.inc \|
	6	\| \|
	7	\| This file is part of the RoundCube Webmail client \|
286420	8	\| Copyright (C) 2005-2008, RoundCube Dev. - Switzerland \|
fba1f5	9	\| Licensed under the GNU GPL \|
T	10	\| \|
	11	\| PURPOSE: \|
	12	\| This class represents a system user linked and provides access \|
	13	\| to the related database records. \|
	14	\| \|
	15	+-----------------------------------------------------------------------+
	16	\| Author: Thomas Bruederli <roundcube@gmail.com> \|
	17	+-----------------------------------------------------------------------+
	18
	19	$Id: rcube_user.inc 933 2007-11-29 14:17:32Z thomasb $
	20
	21	*/
	22
	23
	24	/**
	25	* Class representing a system user
	26	*
45f56c	27	* @package Core
fba1f5	28	* @author Thomas Bruederli <roundcube@gmail.com>
T	29	*/
	30	class rcube_user
	31	{
197601	32	public $ID = null;
T	33	public $data = null;
29111b	34	public $language = null;
197601	35
T	36	private $db = null;
fba1f5	37
T	38
	39	/**
	40	* Object constructor
	41	*
	42	* @param object DB Database connection
	43	*/
	44	function __construct($id = null, $sql_arr = null)
	45	{
197601	46	$this->db = rcmail::get_instance()->get_dbh();
fba1f5	47
T	48	if ($id && !$sql_arr)
	49	{
197601	50	$sql_result = $this->db->query("SELECT * FROM ".get_table_name('users')." WHERE user_id=?", $id);
T	51	$sql_arr = $this->db->fetch_assoc($sql_result);
fba1f5	52	}
T	53
	54	if (!empty($sql_arr))
	55	{
	56	$this->ID = $sql_arr['user_id'];
	57	$this->data = $sql_arr;
197601	58	$this->language = $sql_arr['language'];
fba1f5	59	}
T	60	}
	61
95987c	62
fba1f5	63	/**
T	64	* Build a user name string (as e-mail address)
	65	*
	66	* @return string Full user name
	67	*/
	68	function get_username()
	69	{
	70	return $this->data['username'] ? $this->data['username'] . (!strpos($this->data['username'], '@') ? '@'.$this->data['mail_host'] : '') : false;
	71	}
	72
	73
	74	/**
	75	* Get the preferences saved for this user
	76	*
	77	* @return array Hash array with prefs
	78	*/
	79	function get_prefs()
	80	{
d6869a	81	if (!empty($this->language))
A	82	$prefs = array('language' => $this->language);
155329	83
fba1f5	84	if ($this->ID && $this->data['preferences'])
155329	85	$prefs += (array)unserialize($this->data['preferences']);
T	86
	87	return $prefs;
fba1f5	88	}
T	89
	90
	91	/**
	92	* Write the given user prefs to the user's record
	93	*
286420	94	* @param array User prefs to save
fba1f5	95	* @return boolean True on success, False on failure
T	96	*/
	97	function save_prefs($a_user_prefs)
	98	{
	99	if (!$this->ID)
	100	return false;
286420	101
T	102	$config = rcmail::get_instance()->config;
	103	$old_prefs = (array)$this->get_prefs();
fba1f5	104
T	105	// merge (partial) prefs array with existing settings
286420	106	$save_prefs = $a_user_prefs + $old_prefs;
T	107	unset($save_prefs['language']);
	108
	109	// don't save prefs with default values if they haven't been changed yet
	110	foreach ($a_user_prefs as $key => $value) {
	111	if (!isset($old_prefs[$key]) && ($value == $config->get($key)))
	112	unset($save_prefs[$key]);
	113	}
	114
197601	115	$this->db->query(
fba1f5	116	"UPDATE ".get_table_name('users')."
T	117	SET preferences=?,
	118	language=?
	119	WHERE user_id=?",
286420	120	serialize($save_prefs),
197601	121	$_SESSION['language'],
fba1f5	122	$this->ID);
T	123
197601	124	$this->language = $_SESSION['language'];
286420	125	if ($this->db->affected_rows()) {
T	126	$config->merge($a_user_prefs);
fba1f5	127	return true;
T	128	}
	129
	130	return false;
	131	}
	132
	133
	134	/**
	135	* Get default identity of this user
	136	*
	137	* @param int Identity ID. If empty, the default identity is returned
	138	* @return array Hash array with all cols of the
	139	*/
	140	function get_identity($id = null)
	141	{
	142	$sql_result = $this->list_identities($id ? sprintf('AND identity_id=%d', $id) : '');
197601	143	return $this->db->fetch_assoc($sql_result);
fba1f5	144	}
T	145
	146
	147	/**
	148	* Return a list of all identities linked with this user
	149	*
	150	* @return array List of identities
	151	*/
	152	function list_identities($sql_add = '')
	153	{
	154	// get contacts from DB
197601	155	$sql_result = $this->db->query(
fba1f5	156	"SELECT * FROM ".get_table_name('identities')."
T	157	WHERE del<>1
	158	AND user_id=?
	159	$sql_add
fc1a10	160	ORDER BY ".$this->db->quoteIdentifier('standard')." DESC, name ASC, identity_id ASC",
fba1f5	161	$this->ID);
T	162
	163	return $sql_result;
	164	}
	165
	166
	167	/**
	168	* Update a specific identity record
	169	*
	170	* @param int Identity ID
	171	* @param array Hash array with col->value pairs to save
	172	* @return boolean True if saved successfully, false if nothing changed
	173	*/
	174	function update_identity($iid, $data)
	175	{
	176	if (!$this->ID)
	177	return false;
	178
	179	$write_sql = array();
	180
	181	foreach ((array)$data as $col => $value)
	182	{
	183	$write_sql[] = sprintf("%s=%s",
197601	184	$this->db->quoteIdentifier($col),
T	185	$this->db->quote($value));
fba1f5	186	}
T	187
197601	188	$this->db->query(
fba1f5	189	"UPDATE ".get_table_name('identities')."
T	190	SET ".join(', ', $write_sql)."
	191	WHERE identity_id=?
	192	AND user_id=?
	193	AND del<>1",
	194	$iid,
	195	$this->ID);
	196
197601	197	return $this->db->affected_rows();
fba1f5	198	}
T	199
	200
	201	/**
	202	* Create a new identity record linked with this user
	203	*
	204	* @param array Hash array with col->value pairs to save
	205	* @return int The inserted identity ID or false on error
	206	*/
	207	function insert_identity($data)
	208	{
	209	if (!$this->ID)
	210	return false;
	211
	212	$insert_cols = $insert_values = array();
	213	foreach ((array)$data as $col => $value)
	214	{
197601	215	$insert_cols[] = $this->db->quoteIdentifier($col);
T	216	$insert_values[] = $this->db->quote($value);
fba1f5	217	}
T	218
197601	219	$this->db->query(
fba1f5	220	"INSERT INTO ".get_table_name('identities')."
T	221	(user_id, ".join(', ', $insert_cols).")
	222	VALUES (?, ".join(', ', $insert_values).")",
	223	$this->ID);
	224
197601	225	return $this->db->insert_id(get_sequence_name('identities'));
fba1f5	226	}
T	227
	228
	229	/**
	230	* Mark the given identity as deleted
	231	*
	232	* @param int Identity ID
	233	* @return boolean True if deleted successfully, false if nothing changed
	234	*/
	235	function delete_identity($iid)
	236	{
	237	if (!$this->ID)
	238	return false;
e3a0af	239
8779cd	240	if (!$this->ID \|\| $this->ID == '')
T	241	return false;
	242
197601	243	$sql_result = $this->db->query("SELECT count(*) AS ident_count FROM " .
e3a0af	244	get_table_name('identities') .
d45176	245	" WHERE user_id = ? AND del <> 1",
e3a0af	246	$this->ID);
T	247
197601	248	$sql_arr = $this->db->fetch_assoc($sql_result);
e3a0af	249	if ($sql_arr['ident_count'] <= 1)
T	250	return false;
fba1f5	251
197601	252	$this->db->query(
fba1f5	253	"UPDATE ".get_table_name('identities')."
T	254	SET del=1
	255	WHERE user_id=?
	256	AND identity_id=?",
	257	$this->ID,
	258	$iid);
	259
197601	260	return $this->db->affected_rows();
fba1f5	261	}
T	262
	263
	264	/**
	265	* Make this identity the default one for this user
	266	*
	267	* @param int The identity ID
	268	*/
	269	function set_default($iid)
	270	{
	271	if ($this->ID && $iid)
	272	{
197601	273	$this->db->query(
fba1f5	274	"UPDATE ".get_table_name('identities')."
197601	275	SET ".$this->db->quoteIdentifier('standard')."='0'
fba1f5	276	WHERE user_id=?
T	277	AND identity_id<>?
	278	AND del<>1",
	279	$this->ID,
	280	$iid);
	281	}
	282	}
	283
	284
	285	/**
	286	* Update user's last_login timestamp
	287	*/
	288	function touch()
	289	{
	290	if ($this->ID)
	291	{
197601	292	$this->db->query(
fba1f5	293	"UPDATE ".get_table_name('users')."
197601	294	SET last_login=".$this->db->now()."
fba1f5	295	WHERE user_id=?",
T	296	$this->ID);
	297	}
	298	}
	299
	300
	301	/**
	302	* Clear the saved object state
	303	*/
	304	function reset()
	305	{
	306	$this->ID = null;
	307	$this->data = null;
	308	}
	309
	310
	311	/**
	312	* Find a user record matching the given name and host
	313	*
	314	* @param string IMAP user name
	315	* @param string IMAP host name
	316	* @return object rcube_user New user instance
	317	*/
197601	318	static function query($user, $host)
fba1f5	319	{
197601	320	$dbh = rcmail::get_instance()->get_dbh();
fba1f5	321
ba0e78	322	// query for matching user name
T	323	$query = "SELECT * FROM ".get_table_name('users')." WHERE mail_host=? AND %s=?";
	324	$sql_result = $dbh->query(sprintf($query, 'username'), $host, $user);
	325
	326	// query for matching alias
	327	if (!($sql_arr = $dbh->fetch_assoc($sql_result))) {
	328	$sql_result = $dbh->query(sprintf($query, 'alias'), $host, $user);
	329	$sql_arr = $dbh->fetch_assoc($sql_result);
	330	}
	331
fba1f5	332	// user already registered -> overwrite username
ba0e78	333	if ($sql_arr)
fba1f5	334	return new rcube_user($sql_arr['user_id'], $sql_arr);
T	335	else
	336	return false;
	337	}
	338
	339
	340	/**
	341	* Create a new user record and return a rcube_user instance
	342	*
	343	* @param string IMAP user name
	344	* @param string IMAP host
	345	* @return object rcube_user New user instance
	346	*/
197601	347	static function create($user, $host)
fba1f5	348	{
T	349	$user_email = '';
197601	350	$rcmail = rcmail::get_instance();
T	351	$dbh = $rcmail->get_dbh();
fba1f5	352
T	353	// try to resolve user in virtusertable
197601	354	if ($rcmail->config->get('virtuser_file') && !strpos($user, '@'))
846dd7	355	$user_email = rcube_user::user2email($user);
fba1f5	356
197601	357	$dbh->query(
fba1f5	358	"INSERT INTO ".get_table_name('users')."
T	359	(created, last_login, username, mail_host, alias, language)
197601	360	VALUES (".$dbh->now().", ".$dbh->now().", ?, ?, ?, ?)",
fba1f5	361	strip_newlines($user),
T	362	strip_newlines($host),
	363	strip_newlines($user_email),
197601	364	$_SESSION['language']);
fba1f5	365
197601	366	if ($user_id = $dbh->insert_id(get_sequence_name('users')))
fba1f5	367	{
83a763	368	$mail_domain = $rcmail->config->mail_domain($host);
fba1f5	369
T	370	if ($user_email=='')
	371	$user_email = strpos($user, '@') ? $user : sprintf('%s@%s', $user, $mail_domain);
	372
	373	$user_name = $user != $user_email ? $user : '';
	374
	375	// try to resolve the e-mail address from the virtuser table
123a02	376	if (($virtuser_query = $rcmail->config->get('virtuser_query'))
A	377	&& ($sql_result = $dbh->query(preg_replace('/%u/', $dbh->escapeSimple($user), $virtuser_query)))
	378	&& ($dbh->num_rows() > 0))
fba1f5	379	{
197601	380	while ($sql_arr = $dbh->fetch_array($sql_result))
fba1f5	381	{
197601	382	$dbh->query(
fba1f5	383	"INSERT INTO ".get_table_name('identities')."
T	384	(user_id, del, standard, name, email)
	385	VALUES (?, 0, 1, ?, ?)",
	386	$user_id,
	387	strip_newlines($user_name),
	388	preg_replace('/^@/', $user . '@', $sql_arr[0]));
	389	}
	390	}
	391	else
	392	{
	393	// also create new identity records
197601	394	$dbh->query(
fba1f5	395	"INSERT INTO ".get_table_name('identities')."
T	396	(user_id, del, standard, name, email)
	397	VALUES (?, 0, 1, ?, ?)",
	398	$user_id,
	399	strip_newlines($user_name),
	400	strip_newlines($user_email));
	401	}
	402	}
	403	else
	404	{
	405	raise_error(array(
	406	'code' => 500,
	407	'type' => 'php',
	408	'line' => __LINE__,
	409	'file' => __FILE__,
	410	'message' => "Failed to create new user"), true, false);
	411	}
	412
	413	return $user_id ? new rcube_user($user_id) : false;
	414	}
	415
	416
	417	/**
	418	* Resolve username using a virtuser table
	419	*
	420	* @param string E-mail address to resolve
	421	* @return string Resolved IMAP username
	422	*/
197601	423	static function email2user($email)
fba1f5	424	{
T	425	$user = $email;
c86e94	426	$r = self::findinvirtual('^' . quotemeta($email) . '[[:space:]]');
fba1f5	427
T	428	for ($i=0; $i<count($r); $i++)
	429	{
e20033	430	$data = trim($r[$i]);
fba1f5	431	$arr = preg_split('/\s+/', $data);
T	432	if (count($arr) > 0)
	433	{
	434	$user = trim($arr[count($arr)-1]);
	435	break;
	436	}
	437	}
	438
	439	return $user;
	440	}
	441
	442
	443	/**
	444	* Resolve e-mail address from virtuser table
	445	*
	446	* @param string User name
	447	* @return string Resolved e-mail address
	448	*/
197601	449	static function user2email($user)
fba1f5	450	{
c86e94	451	$email = '';
A	452	$r = self::findinvirtual('[[:space:]]' . quotemeta($user) . '[[:space:]]*$');
fba1f5	453
T	454	for ($i=0; $i<count($r); $i++)
	455	{
	456	$data = $r[$i];
	457	$arr = preg_split('/\s+/', $data);
	458	if (count($arr) > 0)
	459	{
846dd7	460	$email = trim(str_replace('\\@', '@', $arr[0]));
fba1f5	461	break;
T	462	}
	463	}
	464
	465	return $email;
	466	}
83a763	467
T	468
	469	/**
	470	* Find matches of the given pattern in virtuser table
	471	*
	472	* @param string Regular expression to search for
	473	* @return array Matching entries
	474	*/
	475	private static function findinvirtual($pattern)
	476	{
	477	$result = array();
	478	$virtual = null;
	479
	480	if ($virtuser_file = rcmail::get_instance()->config->get('virtuser_file'))
	481	$virtual = file($virtuser_file);
	482
	483	if (empty($virtual))
	484	return $result;
	485
	486	// check each line for matches
	487	foreach ($virtual as $line)
	488	{
	489	$line = trim($line);
	490	if (empty($line) \|\| $line{0}=='#')
	491	continue;
	492
	493	if (eregi($pattern, $line))
	494	$result[] = $line;
	495	}
	496
	497	return $result;
	498	}
	499
fba1f5	500
T	501	}
	502
	503