User.inc
8.47 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
<?php
/**
* $Id$
*
* Represents a user as per the users table in the database.
*
* Copyright (c) 2006 Jam Warehouse http://www.jamwarehouse.com
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; using version 2 of the License.
*
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* @version $Revision$
* @author Rob Cherry, Jam Warehouse (Pty) Ltd, South Africa
* @package lib.unitmanagement
*/
require_once(KT_LIB_DIR . '/database/dbutil.inc');
class User extends KTEntity {
/** user's login name */
var $sUserName;
/** user's name (first and last) */
var $sName;
/** user's password */
var $sPassword;
/** user's maximum allowed file storage quota in bytes */
var $iQuotaMax = 1234567890;
/** user's current file storage quota in bytes */
var $iQuotaCurrent = 0;
/** user's email address */
var $sEmail = "";
/** user's mobile phone number */
var $sMobile = "";
/** notify user by mail status */
var $bEmailNotification = false;
/** notify user via sms (mobile phone) status */
var $bSmsNotification = false;
/** maxiumum concurrent sessions user may have */
var $iMaxSessions = 5;
/** primary key of language preferred by user */
var $iLanguageID;
/** internal variable used to determine if the password has changed or not */
var $bPasswordChanged = false;
/** authentication source for this user (built-in if null) */
var $iAuthenticationSourceId = null;
/** authentication details so that the source knows who this user is */
var $sAuthenticationDetails = null;
var $sAuthenticationDetails2 = null;
var $_aFieldToSelect = array(
'iId' => 'id',
'sUserName' => 'username',
'sName' => 'name',
'sPassword' => 'password',
'iQuotaMax' => 'quota_max',
'iQuotaCurrent' => 'quota_current',
'sEmail' => 'email',
'sMobile' => 'mobile',
'bEmailNotification' => 'email_notification',
'bSmsNotification' => 'sms_notification',
'iMaxSessions' => 'max_sessions',
'iLanguageID' => 'language_id',
'iAuthenticationSourceId' => 'authentication_source_id',
'sAuthenticationDetails' => 'authentication_details_s1',
'sAuthenticationDetails2' => 'authentication_details_s2',
);
var $_bUsePearError = true;
function _table() {
global $default;
return $default->users_table;
}
function getUserName() { return $this->sUserName; }
function setUserName($sNewValue) { $this->sUserName = $sNewValue; }
function setPassword($sNewValue) { $this->sPassword = $sNewValue; $this->bPasswordChanged = true; }
function getQuotaMax() { return $this->iQuotaMax; }
function setQuotaMax($iNewValue) { $this->iQuotaMax = $iNewValue; }
function setName($sNewValue) { $this->sName = $sNewValue; }
function getName() { return $this->sName; }
function getQuotaCurrent() { return $this->iQuotaCurrent; }
function getEmail() { return $this->sEmail; }
function setEmail($sNewValue) { $this->sEmail = $sNewValue; }
function getMobile() { return $this->sMobile; }
function setMobile($sNewValue) { $this->sMobile = $sNewValue; }
function getEmailNotification() { return $this->bEmailNotification; }
function setEmailNotification($bNewValue) { $this->bEmailNotification = KTUtil::anyToBool($bNewValue); }
function getSmsNotification() { return $this->bSmsNotification; }
function setSmsNotification($bNewValue) { $this->bSmsNotification = $bNewValue; }
function getMaxSessions() { return $this->iMaxSessions; }
function setMaxSessions($iNewValue) { $this->iMaxSessions = $iNewValue; }
function getLanguageID() { return $this->iLanguageIDID; }
function setLanguageID($iNewValue) { $this->iLanguageIDID = $iNewValue; }
function getAuthenticationSourceId() { return $this->iAuthenticationSourceId; }
function setAuthenticationSourceId($iNewValue) { $this->iAuthenticationSourceId = $iNewValue; }
function getAuthenticationDetails() { return $this->sAuthenticationDetails; }
function setAuthenticationDetails($sNewValue) { $this->sAuthenticationDetails = $sNewValue; }
function getAuthenticationDetails2() { return $this->sAuthenticationDetails2; }
function setAuthenticationDetails2($sNewValue) { $this->sAuthenticationDetails2 = $sNewValue; }
function &get($iId) {
return KTEntityUtil::get('User', $iId);
}
/**
* update the datastore, without overwriting the password.
*
* only works for a subset of the db values.
*/
function doLimitedUpdate() {
$sQuery = 'UPDATE ' . $this->_table() . ' SET ';
$aParams = array();
$blacklist = array(
"sPassword" => 1,
);
$aParts = array(); // quick workaround to make the join less hurtful.
foreach ($this->_aFieldToSelect as $attr => $column) {
if (!array_key_exists($attr, $blacklist)) {
$val = $this->$attr;
$aParts[] = $column . ' = ?';
$aParams[] = $val;
}
}
$sQuery .= join(', ', $aParts);
$sQuery .= ' WHERE id = ? ';
$aParams[] = $this->getId();
$res = DBUtil::runQuery(array($sQuery, $aParams));
return $res;
}
/**
* Static function
* Get a list of users
*
* @param String Where clause (not required)
*
* @return Array array of User objects, false otherwise and set $_SESSION["errorMessage"]
*/
function getList($sWhereClause = null, $aOptions = null) {
if(!is_array($aOptions)) $aOptions = array($aOptions);
$aOptions['orderby'] = KTUtil::arrayGet($aOptions, 'orderby', 'name');
return KTEntityUtil::getList2('User', $sWhereClause, $aOptions);
}
function getEmailUsers() {
$aUsers = array();
foreach (User::getList() as $oUser) {
if ($oUser->getEmail()) {
$aUsers[] = $oUser;
}
}
return $aUsers;
}
/**
* Static function
* Return the useID for the specified user
*
* @param int the id the user to lookup the unit for
* @return int the unitID, false otherwise and $_SESSION["errorMessage"] set
*/
function getUnitId() {
$ugl = KTUtil::getTableName("users_groups");
$g = KTUtil::getTableName("groups");
$aQuery = array(
"SELECT DISTINCT g.unit_id AS unit_id FROM $ugl AS ugl INNER JOIN $g AS g ON ugl.group_id = g.id WHERE ugl.user_id = ?",
array($this->iId),
);
return DBUtil::getOneResultKey($aQuery, 'unit_id');
}
/**
* static function
*
* gets the id of a user using their username
*
* @param string The username for which we want its ID
*/
function getUserID($sUsername) {
global $default;
$id = lookupID($default->users_table, "username", $sUsername);
$this->iId = $id;
}
/** Static function
* Gets the user's default top level folder for the current user
*/
function getHomeFolderID() {
$iUnitId = $this->getUnitId();
if (empty($iUnitId)) {
return false;
}
$oUnit =& Unit::get($iUnitId);
return $oUnit->getFolderId();
}
function &createFromArray($aOptions) { return KTEntityUtil::createFromArray('User', $aOptions); }
function &getByUserName($sUserName, $aOptions = null) {
return KTEntityUtil::getBy('User', 'username', $sUserName, $aOptions);
}
function getByAuthenticationSource($oSource, $aOptions = null) {
$iSourceId = KTUtil::getId($oSource);
$aOptions = KTUtil::meldOptions($aOptions, array(
'multi' => true,
));
return KTEntityUtil::getByDict('User', array(
'authentication_source_id' => $iSourceId,
), $aOptions);
}
function &getByAuthenticationSourceAndDetails($oSource, $sDetails, $aOptions = null) {
$iSourceId = KTUtil::getId($oSource);
return KTEntityUtil::getByDict('User', array(
'authentication_source_id' => $iSourceId,
'authentication_details_s1' => $sDetails,
), $aOptions);
}
}