3 * FusionForge user management
5 * Copyright 1999-2001, VA Linux Systems, Inc.
6 * Copyright 2009, Roland Mas
8 * This file is part of FusionForge.
10 * FusionForge is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published
12 * by the Free Software Foundation; either version 2 of the License,
13 * or (at your option) any later version.
15 * FusionForge is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with FusionForge; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
26 require_once $gfwww.'include/vote_function.php';
30 * user_get_object_by_name() - Get User object by username.
31 * user_get_object is useful so you can pool user objects/save database queries
32 * You should always use this instead of instantiating the object directly
34 * @param string The unix username - required
35 * @param int The result set handle ("SELECT * FROM USERS WHERE user_id=xx")
36 * @return a user object or false on failure
39 function &user_get_object_by_name($user_name,$res=false) {
40 $user_name = strtolower($user_name);
42 $res = db_query_params ('SELECT * FROM users WHERE user_name=$1',
45 return user_get_object(db_result($res,0,'user_id'),$res);
49 * user_get_object_by_email() - Get User object by email address
50 * Only works if sys_require_unique_email is true
52 * @param string The unix username - required
53 * @param int The result set handle ("SELECT * FROM USERS WHERE user_id=xx")
54 * @return a user object or false on failure
57 function user_get_object_by_email($email,$res=false) {
58 if (!validate_email($email)
59 || !$GLOBALS['sys_require_unique_email']) {
63 $res=db_query_params('SELECT * FROM users WHERE email=$1',
66 return user_get_object(db_result($res,0,'user_id'),$res);
70 * user_get_object() - Get User object by user ID.
71 * user_get_object is useful so you can pool user objects/save database queries
72 * You should always use this instead of instantiating the object directly
74 * @param int The ID of the user - required
75 * @param int The result set handle ("SELECT * FROM USERS WHERE user_id=xx")
76 * @return a user object or false on failure
79 function &user_get_object($user_id,$res=false) {
80 //create a common set of group objects
81 //saves a little wear on the database
83 //automatically checks group_type and
84 //returns appropriate object
87 if (!isset($USER_OBJ["_".$user_id."_"])) {
89 //the db result handle was passed in
91 $res = db_query_params ('SELECT * FROM users WHERE user_id=$1',
94 if (!$res || db_numrows($res) < 1) {
95 $USER_OBJ["_".$user_id."_"]=false;
97 $USER_OBJ["_".$user_id."_"]= new GFUser($user_id,$res);
100 return $USER_OBJ["_".$user_id."_"];
103 function &user_get_objects($id_arr) {
108 for ($i=0; $i<count($id_arr); $i++) {
110 // See if this ID already has been fetched in the cache
115 if (!isset($USER_OBJ["_".$id_arr[$i]."_"])) {
116 $fetch[]=$id_arr[$i];
118 $return[] =& $USER_OBJ["_".$id_arr[$i]."_"];
121 if (count($fetch) > 0) {
122 $res = db_query_params ('SELECT * FROM users WHERE user_id = ANY ($1)',
123 array (db_int_array_to_any_clause ($fetch))) ;
124 while ($arr =& db_fetch_array($res)) {
125 $USER_OBJ["_".$arr['user_id']."_"] = new GFUser($arr['user_id'],$arr);
126 $return[] =& $USER_OBJ["_".$arr['user_id']."_"];
132 function &user_get_objects_by_name($username_arr) {
133 $res = db_query_params ('SELECT user_id FROM users WHERE user_name = ANY ($1)',
134 array (db_string_array_to_any_clause ($username_arr))) ;
135 $arr =& util_result_column_to_array($res,0);
136 return user_get_objects($arr);
139 class GFUser extends Error {
141 * Associative array of data from db.
143 * @var array $data_array.
148 * Is this person a site super-admin?
150 * @var bool $is_super_user
155 * Is this person the logged in user?
157 * @var bool $is_logged_in
162 * Array of preferences
164 * @var array $user_pref
172 * GFUser($id,$res) - CONSTRUCTOR - GENERALLY DON'T USE THIS
174 * instead use the user_get_object() function call
176 * @param int The user_id
177 * @param int The database result set OR array of data
179 function GFUser($id=false,$res=false) {
182 //setting up an empty object
183 //probably going to call create()
187 $this->fetchData($id);
189 if (is_array($res)) {
190 $this->data_array =& $res;
191 } elseif (db_numrows($res) < 1) {
192 //function in class we extended
193 $this->setError('User Not Found');
194 $this->data_array=array();
197 //set up an associative array for use by other functions
198 db_reset_result($res);
199 $this->data_array = db_fetch_array($res);
202 $this->is_super_user=false;
203 $this->is_logged_in=false;
208 * create() - Create a new user.
210 * @param string The unix username.
211 * @param string The real firstname.
212 * @param string The real lastname.
213 * @param string The first password.
214 * @param string The confirmation password.
215 * @param string The users email address.
216 * @param string The users preferred default language.
217 * @param string The users preferred default timezone.
218 * @param string The users preference for receiving site updates by email.
219 * @param string The users preference for receiving community updates by email.
220 * @param int The ID of the language preference.
221 * @param string The users preferred timezone.
222 * @param string The users Jabber address.
223 * @param int The users Jabber preference.
224 * @param int The users theme_id.
225 * @param string The users unix_box.
226 * @param string The users address.
227 * @param string The users address part 2.
228 * @param string The users phone.
229 * @param string The users fax.
230 * @param string The users title.
231 * @param char(2) The users ISO country_code.
232 * @param bool Whether to send an email or not
233 * @returns The newly created user ID
236 function create($unix_name,$firstname,$lastname,$password1,$password2,$email,
237 $mail_site,$mail_va,$language_id,$timezone,$jabber_address,$jabber_only,$theme_id,
238 $unix_box='shell',$address='',$address2='',$phone='',$fax='',$title='',$ccode='US',$send_mail=true) {
241 $this->setError(_('You must supply a theme'));
244 if (! $GLOBALS['sys_require_unique_email']) {
246 $this->setError(_('You must supply a username'));
251 $this->setError(_('You must supply a first name'));
255 $this->setError(_('You must supply a last name'));
259 $this->setError(_('You must supply a password'));
262 if ($password1 != $password2) {
263 $this->setError(_('Passwords do not match'));
266 if (!account_pwvalid($password1)) {
267 $this->setError(_('Invalid Password:'));
270 $unix_name=strtolower($unix_name);
271 if (!account_namevalid($unix_name)) {
272 $this->setError(_('Invalid Unix Name.'));
275 if (!$SYS->sysUseUnixName($unix_name)) {
276 $this->setError(_('Unix name already taken'));
279 if (!validate_email($email)) {
280 $this->setError(_('Invalid Email Address'));
283 if ($jabber_address && !validate_email($jabber_address)) {
284 $this->setError(_('Invalid Jabber Address'));
292 if ($unix_name && db_numrows(db_query_params('SELECT user_id FROM users WHERE user_name LIKE $1',
293 array ($unix_name))) > 0) {
294 $this->setError(_('That username already exists.'));
297 if ($GLOBALS['sys_require_unique_email']) {
298 if (user_get_object_by_email ('$email')) {
299 $this->setError(_('User with this email already exists - use people search to recover your login.'));
303 if ($GLOBALS['sys_require_unique_email'] && !$unix_name) {
304 // Let's generate a loginname for the user
305 // ...based on the email address:
306 $email_array = explode ('@', $email, 2) ;
307 $email_u = $email_array [0] ;
308 $l = ereg_replace ('[^a-z0-9]', '', $email_u) ;
309 $l = substr ($l, 0, 15) ;
310 // Is the user part of the email address okay?
311 if (account_namevalid($l)
312 && db_numrows(db_query_params('SELECT user_id FROM users WHERE user_name = $1',
316 // No? What if we add a number at the end?
319 $c = substr ($l, 0, 15-strlen ("$i")) . "$i" ;
320 if (account_namevalid($c)
321 && db_numrows(db_query_params('SELECT user_id FROM users WHERE user_name = $1',
329 // If we're really unlucky, then let's go brute-force
330 while (!$unix_name) {
331 $c = substr (md5($email . rand()), 0, 15) ;
332 if (account_namevalid($c)
333 && db_numrows(db_query_params('SELECT user_id FROM users WHERE user_name = $1',
339 $unix_name=strtolower($unix_name);
340 if (!account_namevalid($unix_name)) {
341 $this->setError(_('Invalid Unix Name.'));
344 // if we got this far, it must be good
345 $confirm_hash = substr(md5($password1 . rand() . microtime()),0,16);
347 $result = db_query_params ('INSERT INTO users (user_name,user_pw,unix_pw,realname,firstname,lastname,email,add_date,status,confirm_hash,mail_siteupdates,mail_va,language,timezone,jabber_address,jabber_only,unix_box,address,address2,phone,fax,title,ccode,theme_id) VALUES ($1,$2,$3,$4,$5,$6,$7,$8,$9,$10,$11,$12,$13,$14,$15,$16,$17,$18,$19,$20,$21,$22,$23,$24)',
350 account_genunixpw($password1),
351 htmlspecialchars($firstname.' '.$lastname),
352 htmlspecialchars($firstname),
353 htmlspecialchars($lastname),
358 (($mail_site)?"1":"0"),
359 (($mail_va)?"1":"0"),
365 htmlspecialchars($address),
366 htmlspecialchars($address2),
367 htmlspecialchars($phone),
368 htmlspecialchars($fax),
369 htmlspecialchars($title),
373 $this->setError(_('Insert Failed') . db_error());
378 $id = db_insertid($result,'users','user_id');
380 $this->setError('Could Not Get USERID: ' .db_error());
385 if (!$this->fetchData($id)) {
390 $hook_params = array ();
391 $hook_params['user'] = $this;
392 $hook_params['user_id'] = $this->getID();
393 $hook_params['user_name'] = $unix_name;
394 $hook_params['user_password'] = $password1;
395 plugin_hook ("user_create", $hook_params);
398 setup_gettext_from_lang_id($language_id);
399 $this->sendRegistrationEmail();
400 setup_gettext_from_context();
409 * sendRegistrationEmail() - Send email for registration verification
411 * @return true or false
413 function sendRegistrationEmail() {
414 $message=stripcslashes(sprintf(_('Thank you for registering on the %3$s web site. You have
415 account with username %1$s created for you. In order
416 to complete your registration, visit the following url:
420 (If you don\'t see any URL above, it is likely due to a bug in your mail client.
421 Use one below, but make sure it is entered as the single line.)
429 $this->getUnixName(),
430 util_make_url ('/account/verify.php?confirm_hash=_'.$this->getConfirmHash()),
431 forge_get_config ('forge_name')));
434 sprintf(_('%1$s Account Registration'), forge_get_config ('forge_name')),
440 * delete() - remove the User from all his groups.
442 * Remove the User from all his groups and set his status to D.
444 * @param boolean Confirmation of deletion.
445 * @return true or false
447 function delete($sure) {
451 $groups = &$this->getGroups();
452 if (is_array($groups)) {
453 foreach ($groups as $group) {
454 $group->removeUser($this->getID());
459 $res = db_query_params ('DELETE FROM artifact_monitor WHERE user_id=$1',
460 array ($this->getID())) ;
462 $this->setError('ERROR - Could Not Delete From artifact_monitor: '.db_error());
466 $res = db_query_params ('DELETE FROM artifact_type_monitor WHERE user_id=$1',
467 array ($this->getID())) ;
469 $this->setError('ERROR - Could Not Delete From artifact_type_monitor: '.db_error());
473 $res = db_query_params ('DELETE FROM forum_monitored_forums WHERE user_id=$1',
474 array ($this->getID())) ;
476 $this->setError('ERROR - Could Not Delete From forum_monitored_forums: '.db_error());
480 $res = db_query_params ('DELETE FROM filemodule_monitor WHERE user_id=$1',
481 array ($this->getID())) ;
483 $this->setError('ERROR - Could Not Delete From filemodule_monitor: '.db_error());
488 $hook_params = array ();
489 $hook_params['user'] = $this;
490 $hook_params['user_id'] = $this->getID();
491 plugin_hook ("user_delete", $hook_params);
493 $this->setStatus('D');
500 * update() - update *common* properties of GFUser object.
502 * Use specific setter to change other properties.
504 * @param string The users first name.
505 * @param string The users last name.
506 * @param int The ID of the users language preference.
507 * @param string The useres timezone preference.
508 * @param string The users preference for receiving site updates by email.
509 * @param string The users preference for receiving community updates by email.
510 * @param string The users preference for being participating in "peer ratings".
511 * @param string The users Jabber account address.
512 * @param int The users Jabber preference.
513 * @param int The users theme_id preference.
514 * @param string The users address.
515 * @param string The users address2.
516 * @param string The users phone.
517 * @param string The users fax.
518 * @param string The users title.
519 * @param string The users ccode.
521 function update($firstname,$lastname,$language_id,$timezone,$mail_site,$mail_va,$use_ratings,
522 $jabber_address,$jabber_only,$theme_id,$address,$address2,$phone,$fax,$title,$ccode) {
523 $mail_site = $mail_site ? 1 : 0;
524 $mail_va = $mail_va ? 1 : 0;
525 $block_ratings = $use_ratings ? 0 : 1;
527 if ($jabber_address && !validate_email($jabber_address)) {
528 $this->setError(_('Invalid Jabber Address'));
539 $res = db_query_params ('
561 htmlspecialchars($firstname . ' ' .$lastname),
562 htmlspecialchars($firstname),
563 htmlspecialchars($lastname),
571 htmlspecialchars($address) ,
572 htmlspecialchars($address2) ,
573 htmlspecialchars($phone) ,
574 htmlspecialchars($fax) ,
575 htmlspecialchars($title) ,
581 $this->setError('ERROR - Could Not Update User Object: '.db_error());
585 // If there's a transaction from using to not
586 // using ratings, remove all rating made by the
587 // user (ratings by others should not be removed,
588 // as it opens possibility to abuse rate system)
589 if (!$use_ratings && $this->usesRatings()) {
590 vote_remove_all_ratings_by($this->getID());
592 if (!$this->fetchData($this->getID())) {
597 $hook_params = array ();
598 $hook_params['user'] = $this;
599 $hook_params['user_id'] = $this->getID();
600 plugin_hook ("user_update", $hook_params);
608 * fetchData - May need to refresh database fields.
610 * If an update occurred and you need to access the updated info.
612 * @return boolean success;
614 function fetchData($user_id) {
615 $res = db_query_params ('SELECT * FROM users WHERE user_id=$1',
617 if (!$res || db_numrows($res) < 1) {
618 $this->setError('GFUser::fetchData()::'.db_error());
621 $this->data_array =& db_fetch_array($res);
626 * getID - Simply return the user_id for this object.
628 * @return int This user's user_id number.
631 return $this->data_array['user_id'];
635 * getStatus - get the status of this user.
637 * Statuses include (A)ctive, (P)ending, (S)uspended ,(D)eleted.
639 * @return char This user's status flag.
641 function getStatus() {
642 return $this->data_array['status'];
646 * setStatus - set this user's status.
648 * @param string Status - P, A, S, or D.
649 * @return boolean success.
651 function setStatus($status) {
653 if ($status != 'P' && $status != 'A'
654 && $status != 'S' && $status != 'D') {
655 $this->setError('ERROR: Invalid status value');
660 $res = db_query_params ('UPDATE users SET status=$1 WHERE user_id=$2',
665 $this->setError('ERROR - Could Not Update User Status: '.db_error());
669 $this->data_array['status']=$status;
670 if ($status == 'D') {
671 // Remove this user from all groups
672 $res = db_query_params ('DELETE FROM user_group WHERE user_id=$1',
673 array ($this->getID())) ;
675 $this->setError('ERROR - Could Not Propogate Deleted Status: '.db_error());
680 $hook_params = array ();
681 $hook_params['user'] = $this;
682 $hook_params['user_id'] = $this->getID();
683 $hook_params['status'] = $status;
684 plugin_hook ("user_setstatus", $hook_params);
688 //plugin webcalendar, create cal_user
689 plugin_hook('add_cal_user',$this->getID());
696 * isActive - whether this user is confirmed and active.
698 * Database field status of 'A' returns true.
699 * @return boolean is_active.
701 function isActive() {
702 if ($this->getStatus()=='A') {
710 * getUnixStatus - Status of activation of unix account.
712 * @return char (N)one, (A)ctive, (S)uspended or (D)eleted
714 function getUnixStatus() {
715 return $this->data_array['unix_status'];
719 * setUnixStatus - Sets status of activation of unix account.
721 * @param string The unix status.
727 * @return boolean success.
729 function setUnixStatus($status) {
732 $res = db_query_params ('UPDATE users SET unix_status=$1 WHERE user_id=$2',
737 $this->setError('ERROR - Could Not Update User Unix Status: '.db_error());
741 if ($status == 'A') {
742 if (!$SYS->sysCheckCreateUser($this->getID())) {
743 $this->setError($SYS->getErrorMessage());
748 if ($SYS->sysCheckUser($this->getID())) {
749 if (!$SYS->sysRemoveUser($this->getID())) {
750 $this->setError($SYS->getErrorMessage());
757 $this->data_array['unix_status']=$status;
764 * getUnixName - the user's unix_name.
766 * @return string This user's unix/login name.
768 function getUnixName() {
769 return strtolower($this->data_array['user_name']);
773 * getUnixPasswd - get the user's password.
775 * @return string This user's unix crypted passwd.
777 function getUnixPasswd() {
778 return $this->data_array['unix_pw'];
782 * getUnixBox - the hostname of the unix box this user has an account on.
784 * @return string This user's shell login machine.
786 function getUnixBox() {
787 return $this->data_array['unix_box'];
791 * getMD5Passwd - the password.
793 * @return string This user's MD5-crypted passwd.
795 function getMD5Passwd() {
796 return $this->data_array['user_pw'];
799 //Added to be compatible with codendi getUserPw function
800 function getUserPw() {
801 return $this->data_array['user_pw'];
805 * getConfirmHash - the confirm hash in the db.
807 * @return string This user's confirmation hash.
809 function getConfirmHash() {
810 return $this->data_array['confirm_hash'];
814 * getEmail - the user's email address.
816 * @return string This user's email address.
818 function getEmail() {
819 return $this->data_array['email'];
823 * getSha1Email - a SHA1 encoded hash of the email URI (including mailto: prefix)
825 * @return string The SHA1 encoded value for the email
827 function getSha1Email() {
828 return sha1('mailto:'.$this->getEmail());
832 * getNewEmail - while changing an email address, it is stored here until confirmation.
834 * getNewEmail is a private operation for email change.
836 * @return string This user's new (not yet confirmed) email address.
839 function getNewEmail() {
840 return $this->data_array['email_new'];
844 * setEmail - set a new email address, which must be confirmed.
846 * @param string The email address.
847 * @return boolean success.
849 function setEmail($email) {
851 if (!strcasecmp($this->getEmail(), stripslashes($email))) {
855 if (!$email || !validate_email($email)) {
856 $this->setError('ERROR: Invalid Email');
860 if ($GLOBALS['sys_require_unique_email']) {
861 if (db_numrows(db_query_params('SELECT user_id FROM users WHERE user_id!=$1 AND (lower(email) LIKE $2 OR lower(email_new) LIKE $2)',
862 array ($this->getID(),
863 strtolower($email)))) > 0) {
864 $this->setError(_('User with this email already exists.'));
870 $res = db_query_params ('UPDATE users SET email=$1 WHERE user_id=$2',
875 $this->setError('ERROR - Could Not Update User Email: '.db_error());
879 $hook_params = array ();
880 $hook_params['user'] = $this;
881 $hook_params['user_id'] = $this->getID();
882 $hook_params['user_email'] = $email;
883 plugin_hook ("user_setemail", $hook_params);
885 if (!$this->fetchData($this->getId())) {
896 * setNewEmailAndHash - setNewEmailAndHash is a private operation for email change.
898 * @param string The email address.
899 * @param string The email hash.
900 * @return boolean success.
902 function setNewEmailAndHash($email, $hash='') {
905 $hash = substr(md5(strval(time()) . strval(mt_rand())), 0, 16);
908 if (!$email || !validate_email($email)) {
909 $this->setError('ERROR - Invalid Email');
913 if ($GLOBALS['sys_require_unique_email']) {
914 if (db_numrows(db_query_params('SELECT user_id FROM users WHERE user_id!=$1 AND (lower(email) LIKE $2 OR lower(email_new) LIKE $2)',
915 array ($this->getID(),
916 strtolower($email)))) > 0) {
917 $this->setError(_('User with this email already exists.'));
921 $res = db_query_params ('UPDATE users SET confirm_hash=$1, email_new=$2 WHERE user_id=$3',
926 $this->setError('ERROR - Could Not Update User Email And Hash: '.db_error());
929 $this->data_array['email_new'] = $email;
930 $this->data_array['confirm_hash'] = $hash;
936 * getRealName - get the user's real name.
938 * @return string This user's real name.
940 function getRealName() {
941 $last_name = $this->getLastName();
942 return $this->getFirstName(). ($last_name ? ' ' .$last_name:'');
946 * getFirstName - get the user's first name.
948 * @return string This user's first name.
950 function getFirstName() {
951 return $this->data_array['firstname'];
955 * getLastName - get the user's last name.
957 * @return string This user's last name.
959 function getLastName() {
960 return $this->data_array['lastname'];
964 * getAddDate - this user's unix time when account was opened.
966 * @return int This user's unix time when account was opened.
968 function getAddDate() {
969 return $this->data_array['add_date'];
973 * getTimeZone - this user's timezone setting.
975 * @return string This user's timezone setting.
977 function getTimeZone() {
978 return $this->data_array['timezone'];
982 * getCountryCode - this user's ccode setting.
984 * @return string This user's ccode setting.
986 function getCountryCode() {
987 return $this->data_array['ccode'];
991 * getShell - this user's preferred shell.
993 * @return string This user's preferred shell.
995 function getShell() {
996 return $this->data_array['shell'];
1000 * setShell - sets user's preferred shell.
1002 * @param string The users preferred shell.
1003 * @return boolean success.
1005 function setShell($shell) {
1007 $shells = file('/etc/shells');
1008 $shells[count($shells)] = "/bin/cvssh";
1009 $out_shells = array();
1010 foreach ($shells as $s) {
1011 if (substr($s, 0, 1) == '#') {
1014 $out_shells[] = chop($s);
1016 if (!in_array($shell, $out_shells)) {
1017 $this->setError('ERROR: Invalid Shell');
1022 $res = db_query_params ('UPDATE users SET shell=$1 WHERE user_id=$2',
1026 $this->setError('ERROR - Could Not Update User Unix Shell: '.db_error());
1030 // Now change LDAP attribute, but only if corresponding
1031 // entry exists (i.e. if user have shell access)
1032 if ($SYS->sysCheckUser($this->getID()))
1034 if (!$SYS->sysUserSetAttribute($this->getID(),"loginShell",$shell)) {
1035 $this->setError($SYS->getErrorMessage());
1040 $this->data_array['shell']=$shell;
1047 * getUnixUID() - Get the unix UID of the user
1049 * @return int This user's UID.
1051 function getUnixUID() {
1052 return $this->data_array['unix_uid'];
1056 * getUnixGID() - Get the unix GID of the user
1058 * @return int This user's GID.
1060 function getUnixGID() {
1061 return $this->data_array['unix_gid'];
1065 * getLanguage - this user's language_id from supported_languages table.
1067 * @return int This user's language_id.
1069 function getLanguage() {
1070 return $this->data_array['language'];
1074 * getJabberAddress - this user's optional jabber address.
1076 * @return string This user's jabber address.
1078 function getJabberAddress() {
1079 return $this->data_array['jabber_address'];
1083 * getJabberOnly - whether this person wants updates sent ONLY to jabber.
1085 * @return boolean This user's jabber preference.
1087 function getJabberOnly() {
1088 return $this->data_array['jabber_only'];
1092 * getAddress - get this user's address.
1094 * @return text This user's address.
1096 function getAddress() {
1097 return $this->data_array['address'];
1101 * getAddress2 - get this user's address2.
1103 * @return text This user's address2.
1105 function getAddress2() {
1106 return $this->data_array['address2'];
1110 * getPhone - get this person's phone number.
1112 * @return text This user's phone number.
1114 function getPhone() {
1115 return $this->data_array['phone'];
1119 * getFax - get this person's fax number.
1121 * @return text This user's fax.
1124 return $this->data_array['fax'];
1128 * getTitle - get this person's title.
1130 * @return text This user's title.
1132 function getTitle() {
1133 return $this->data_array['title'];
1137 * getGroups - get an array of groups this user is a member of.
1139 * @return array Array of groups.
1141 function &getGroups() {
1142 $res = db_query_params ('SELECT group_id FROM user_group WHERE user_id=$1',
1143 array ($this->getID())) ;
1144 $arr =& util_result_column_to_array($res,0);
1145 return group_get_objects($arr);
1149 * getAuthorizedKeys - the SSH authorized keys set by the user.
1151 * @return string This user's SSH authorized (public) keys.
1153 function getAuthorizedKeys() {
1154 return ereg_replace("###", "\n", $this->data_array['authorized_keys']);
1158 * setAuthorizedKeys - set the SSH authorized keys for the user.
1160 * @param string The users public keys.
1161 * @return boolean success.
1163 function setAuthorizedKeys($keys) {
1164 $keys = trim($keys);
1165 $keys = ereg_replace("\r\n", "\n", $keys); // Convert to Unix EOL
1166 $keys = ereg_replace("\n+", "\n", $keys); // Remove empty lines
1167 $keys = ereg_replace("\n", "###", $keys); // Convert EOL to marker
1169 $res = db_query_params ('UPDATE users SET authorized_keys=$1 WHERE user_id=$2',
1173 $this->setError('ERROR - Could Not Update User SSH Keys');
1176 $this->data_array['authorized_keys'] = $keys;
1182 * setLoggedIn($val) - Really only used by session code.
1184 * @param boolean The session value.
1186 function setLoggedIn($val=true) {
1187 $this->is_logged_in=$val;
1189 //if this is the logged in user, see if they are a super user
1190 $result = db_query_params ('SELECT count(*) AS count FROM user_group WHERE user_id=$1 AND group_id=1 AND admin_flags=$2',
1191 array ($this->getID(),
1194 $this->is_super_user=false;
1197 $row_count = db_fetch_array($result);
1198 $this->is_super_user = ($row_count['count'] > 0);
1203 * isLoggedIn - only used by session code.
1205 * @return boolean is_logged_in.
1207 function isLoggedIn() {
1208 return $this->is_logged_in;
1212 * deletePreference - delete a preference for this user.
1214 * @param string The unique field name for this preference.
1215 * @return boolean success.
1217 function deletePreference($preference_name) {
1218 $preference_name=strtolower(trim($preference_name));
1219 unset($this->user_pref["$preference_name"]);
1220 $res = db_query_params ('DELETE FROM user_preferences WHERE user_id=$1 AND preference_name=$2',
1221 array ($this->getID(),
1222 $preference_name)) ;
1227 * setPreference - set a new preference for this user.
1229 * @param string The unique field name for this preference.
1230 * @param string The value you are setting this preference to.
1231 * @return boolean success.
1233 function setPreference($preference_name,$value) {
1234 $preference_name=strtolower(trim($preference_name));
1235 //delete pref if not value passed in
1236 unset($this->user_pref);
1237 if (!isset($value)) {
1238 $result = db_query_params ('DELETE FROM user_preferences WHERE user_id=$1 AND preference_name=$2',
1239 array ($this->getID(),
1240 $preference_name)) ;
1242 $result = db_query_params ('UPDATE user_preferences SET preference_value=$1,set_date=$2 WHERE user_id=$3 AND preference_name=$4',
1246 $preference_name)) ;
1247 if (db_affected_rows($result) < 1) {
1249 $result = db_query_params ('INSERT INTO user_preferences (user_id,preference_name,preference_value,set_date) VALUES ($1,$2,$3,$4)',
1250 array ($this->getID(),
1260 * getPreference - get a specific preference.
1262 * @param string The unique field name for this preference.
1263 * @return the preference string or false on failure.
1265 function getPreference($preference_name) {
1266 $preference_name=strtolower(trim($preference_name));
1268 First check to see if we have already fetched the preferences
1270 if (isset($this->user_pref)) {
1271 //echo "\n\nPrefs were fetched already";
1272 if (isset($this->user_pref["$preference_name"])) {
1273 //we have fetched prefs - return part of array
1274 return $this->user_pref["$preference_name"];
1276 //we have fetched prefs, but this pref hasn't been set
1280 //we haven't returned prefs - go to the db
1281 $result = db_query_params ('SELECT preference_name,preference_value FROM user_preferences WHERE user_id=$1',
1282 array ($this->getID())) ;
1283 if (db_numrows($result) < 1) {
1284 //echo "\n\nNo Prefs Found";
1288 //iterate and put the results into an array
1289 for ($i=0; $i<db_numrows($result); $i++) {
1290 $pref["".db_result($result,$i,'preference_name').""]=db_result($result,$i,'preference_value');
1292 $this->user_pref = $pref;
1294 if (array_key_exists($preference_name,$this->user_pref)) {
1295 //we have fetched prefs - return part of array
1296 return $this->user_pref["$preference_name"];
1298 //we have fetched prefs, but this pref hasn't been set
1306 * setPasswd - Changes user's password.
1308 * @param string The plaintext password.
1309 * @return boolean success.
1311 function setPasswd($passwd) {
1313 if (!account_pwvalid($passwd)) {
1314 $this->setError('Error: '.$GLOBALS['register_error']);
1319 $md5_pw = md5 ($passwd) ;
1320 $unix_pw = account_genunixpw ($passwd) ;
1322 $res = db_query_params ('UPDATE users SET user_pw=$1, unix_pw=$2 WHERE user_id=$3',
1327 if (!$res || db_affected_rows($res) < 1) {
1328 $this->setError('ERROR - Could Not Change User Password: '.db_error());
1332 // Now change LDAP password, but only if corresponding
1333 // entry exists (i.e. if user have shell access)
1334 if ($SYS->sysCheckUser($this->getID())) {
1335 if (!$SYS->sysUserSetAttribute($this->getID(),"userPassword",'{crypt}'.$unix_pw)) {
1336 $this->setError($SYS->getErrorMessage());
1342 $hook_params = array ();
1343 $hook_params['user'] = $this;
1344 $hook_params['user_id'] = $this->getID();
1345 $hook_params['user_password'] = $passwd;
1346 plugin_hook ("user_setpasswd", $hook_params);
1352 * usesRatings - whether user participates in rating system.
1354 * @return boolean success.
1356 function usesRatings() {
1357 return !$this->data_array['block_ratings'];
1361 * getPlugins - get a list of all available user plugins
1363 * @return array array containing plugin_id => plugin_name
1365 function getPlugins() {
1366 if (!isset($this->plugins_data)) {
1367 $this->plugins_data = array () ;
1369 $res = db_query_params ('SELECT user_plugin.plugin_id, plugins.plugin_name
1370 FROM user_plugin, plugins
1371 WHERE user_plugin.user_id=$1
1372 AND user_plugin.plugin_id=plugins.plugin_id',
1373 array ($this->getID())) ;
1374 $rows = db_numrows($res);
1376 for ($i=0; $i<$rows; $i++) {
1377 $plugin_id = db_result($res,$i,'plugin_id');
1378 $this->plugins_data[$plugin_id] = db_result($res,$i,'plugin_name');
1381 return $this->plugins_data ;
1385 * usesPlugin - returns true if the user uses a particular plugin
1387 * @param string name of the plugin
1388 * @return boolean whether plugin is being used or not
1390 function usesPlugin($pluginname) {
1391 $plugins_data = $this->getPlugins() ;
1392 foreach ($plugins_data as $p_name) {
1393 if ($p_name == $pluginname) {
1401 * setPluginUse - enables/disables plugins for the user
1403 * @param string name of the plugin
1404 * @param boolean the new state
1405 * @return string database result
1407 function setPluginUse($pluginname, $val=true) {
1408 if ($val == $this->usesPlugin($pluginname)) {
1409 // State is already good, returning
1412 $res = db_query_params ('SELECT plugin_id FROM plugins WHERE plugin_name=$1',
1413 array ($pluginname)) ;
1414 $rows = db_numrows($res);
1416 // Error: no plugin by that name
1419 $plugin_id = db_result($res,0,'plugin_id');
1421 unset ($this->plugins_data) ;
1423 return db_query_params ('INSERT INTO user_plugin (user_id,plugin_id) VALUES ($1,$2)',
1424 array ($this->getID(),
1427 return db_query_params ('DELETE FROM user_plugin WHERE user_id=$1 AND plugin_id=$2',
1428 array ($this->getID(),
1434 * getMailingsPrefs - Get activity status for one of the site mailings.
1436 * @param string The id of mailing ('mail_va' for community mailings, 'mail_siteupdates' for site mailings)
1437 * @return boolean success.
1439 function getMailingsPrefs($mailing_id) {
1440 if ($mailing_id=='va') {
1441 return $this->data_array['mail_va'];
1442 } else if ($mailing_id=='site') {
1443 return $this->data_array['mail_siteupdates'];
1450 * unsubscribeFromMailings - Disable email notifications for user.
1452 * @param boolean If false, disable general site mailings, else - all.
1453 * @return boolean success.
1455 function unsubscribeFromMailings($all=false) {
1456 $res1 = $res2 = $res3 = true;
1457 $res1 = db_query_params ('UPDATE users SET mail_siteupdates=0, mail_va=0 WHERE user_id=$1',
1458 array ($this->getID())) ;
1460 $res2 = db_query_params ('DELETE FROM forum_monitored_forums WHERE user_id=$1',
1461 array ($this->getID())) ;
1462 $res3 = db_query_params ('DELETE FROM filemodule_monitor WHERE user_id=$1',
1463 array ($this->getID())) ;
1466 return $res1 && $res2 && $res3;
1470 * getThemeID - get the theme_id for this user.
1472 * @return int The theme_id.
1474 function getThemeID() {
1475 return $this->data_array['theme_id'];
1479 * getThemeID - get the theme_id for this user from the theme_prefs table.
1481 * @return int The theme_id.
1483 function setUpTheme() {
1485 // An optimization in session_getdata lets us pre-fetch this in most cases.....
1487 if (!isset($this->data_array['dirname']) || !$this->data_array['dirname']) {
1488 $res = db_query_params ('SELECT dirname FROM themes WHERE theme_id=$1',
1489 array ($this->getThemeID())) ;
1490 $this->theme=db_result($res,0,'dirname');
1492 $this->theme=$this->data_array['dirname'];
1494 if (is_file($GLOBALS['sys_themeroot'].$this->theme.'/Theme.class.php')) {
1495 $GLOBALS['sys_theme']=$this->theme;
1497 $this->theme=$GLOBALS['sys_theme'];
1499 return $this->theme;
1503 * getRole() - Get user Role object.
1505 * @param object group object
1506 * @return object Role object
1508 function getRole(&$group) {
1509 if (!$group || !is_object($group)) {
1510 $this->setError('User::getRole : Unable to get group object');
1513 $res = db_query_params ('SELECT role_id FROM user_group WHERE user_id=$1 AND group_id=$2',
1514 array ($this->getID(),
1517 $this->setError('User::getRole::DB - Could Not get role_id '.db_error());
1520 $role_id = db_result($res,0,'role_id');
1524 $role = new Role($group,$role_id);
1525 if (!$role || !is_object($role)) {
1526 $this->setError('Error Getting Role Object');
1528 } elseif ($role->isError()) {
1529 $this->setError('User::getRole::roleget::'.$role->getErrorMessage());
1535 function isMember($group_id, $type=0) {
1536 if (!session_loggedin()) {
1540 $project =& group_get_object($group_id);
1542 if (!$project || !is_object($project)) {
1546 $perm =& $project->getPermission( $this );
1547 if (!$perm || !is_object($perm) || !$perm->isMember()) {
1551 $type=strtoupper($type);
1556 return $perm->isPMAdmin();
1561 return $perm->isForumAdmin();
1565 //just in this group
1566 return $perm->isMember();
1570 //admin for this group
1571 return $perm->isAdmin();
1576 return $perm->isDocEditor();
1594 EVERYTHING BELOW HERE IS DEPRECATED
1597 DO NOT USE FOR ANY NEW CODE
1606 * user_ismember() - DEPRECATED; DO NOT USE!
1608 * @param int The Group ID
1609 * @param int The Type
1613 function user_ismember($group_id,$type=0) {
1614 if (!session_loggedin()) {
1618 $project =& group_get_object($group_id);
1620 if (!$project || !is_object($project)) {
1624 $perm =& $project->getPermission( session_get_user() );
1625 if (!$perm || !is_object($perm) || !$perm->isMember()) {
1629 $type=strtoupper($type);
1634 return $perm->isPMAdmin();
1639 return $perm->isForumAdmin();
1643 //just in this group
1644 return $perm->isMember();
1648 //admin for this group
1649 return $perm->isAdmin();
1654 return $perm->isDocEditor();
1666 * user_getname() - DEPRECATED; DO NOT USE!
1668 * @param int The User ID
1672 function user_getname($user_id = false) {
1673 // use current user if one is not passed in
1675 if (session_loggedin()) {
1676 $user=&user_get_object(user_getid());
1678 return $user->getUnixName();
1680 return 'Error getting user';
1683 return 'No User Id';
1686 $user=&user_get_object($user_id);
1688 return $user->getUnixName();
1690 return 'Invalid User';
1697 // c-file-style: "bsd"