r1419: Beginning to implement the authentication API:
[bugdar.git] / includes / api_user.php
1 <?php
2 /*=====================================================================*\
3 || ###################################################################
4 || # Bugdar [#]version[#]
5 || # Copyright ©2002-[#]year[#] Blue Static
6 || #
7 || # This program is free software; you can redistribute it and/or modify
8 || # it under the terms of the GNU General Public License as published by
9 || # the Free Software Foundation; version [#]gpl[#] of the License.
10 || #
11 || # This program is distributed in the hope that it will be useful, but
12 || # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 || # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 || # more details.
15 || #
16 || # You should have received a copy of the GNU General Public License along
17 || # with this program; if not, write to the Free Software Foundation, Inc.,
18 || # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
19 || ###################################################################
20 \*=====================================================================*/
21
22 $GLOBALS['isso:callback']->load('api', null);
23
24 require_once('./includes/functions_datastore.php');
25 require_once('./includes/class_sort.php');
26
27 /**
28 * API: User
29 *
30 * @author Blue Static
31 * @copyright Copyright ©2002 - [#]year[#], Blue Static
32 * @version $Revision$
33 * @package Bugdar
34 *
35 */
36 class UserAPI extends API
37 {
38 /**
39 * Database fields
40 * @var array
41 * @access private
42 */
43 var $fields = array(
44 'userid' => array(TYPE_UINT, REQ_AUTO, 'verify_nozero'),
45 'email' => array(TYPE_STR, REQ_YES, ':self'),
46 'displayname' => array(TYPE_STR, REQ_YES, ':self'),
47 'usergroupid' => array(TYPE_UINT, REQ_YES, ':self'),
48 'password' => array(TYPE_STR, REQ_YES),
49 'salt' => array(TYPE_STR, REQ_SET),
50 'authkey' => array(TYPE_STR, REQ_SET),
51 'showemail' => array(TYPE_BOOL, REQ_NO),
52 'showcolors' => array(TYPE_BOOL, REQ_NO),
53 'languageid' => array(TYPE_UINT, REQ_NO),
54 'timezone' => array(TYPE_FLOAT,REQ_NO),
55 'usedst' => array(TYPE_BOOL, REQ_NO),
56 'hidestatuses' => array(TYPE_STR, REQ_NO, ':self'),
57 'defaultsortkey' => array(TYPE_STR, REQ_NO, ':self'),
58 'defaultsortas' => array(TYPE_STR, REQ_NO, ':self'),
59 'columnoptions' => array(TYPE_STR, REQ_NO, ':self'),
60 'authid' => array(TYPE_STR, REQ_NO)
61 );
62
63 /**
64 * Database table
65 * @var string
66 * @access private
67 */
68 var $table = 'user';
69
70 /**
71 * Table prefix
72 * @var string
73 * @access private
74 */
75 var $prefix = TABLE_PREFIX;
76
77 // ###################################################################
78 /**
79 * Set field: salt
80 *
81 * @access private
82 */
83 function set_salt()
84 {
85 $this->set('salt', $this->registry->funct->rand(array(1, 15)));
86 }
87
88 // ###################################################################
89 /**
90 * Set field: authkey
91 *
92 * @access private
93 */
94 function set_authkey()
95 {
96 $this->set('authkey', $this->registry->funct->rand());
97 }
98
99 // ###################################################################
100 /**
101 * Pre-insert
102 *
103 * @access private
104 */
105 function pre_insert()
106 {
107 $this->set('password', md5(md5($this->values['password']) . md5($this->values['salt'])));
108 }
109
110 // ###################################################################
111 /**
112 * Post-insert
113 *
114 * @access protected
115 */
116 function post_insert()
117 {
118 $this->registry->db->query("
119 INSERT INTO " . TABLE_PREFIX . "useremail
120 (userid, mask, relation)
121 VALUES
122 (" . $this->insertid . ", 32, 0),
123 (" . $this->insertid . ", 320, 1),
124 (" . $this->insertid . ", 1984, 2),
125 (" . $this->insertid . ", 64, 4),
126 (" . $this->insertid . ", 64, 8),
127 (" . $this->insertid . ", 256, 16
128 )
129 ");
130 build_assignedto();
131 }
132
133 // ###################################################################
134 /**
135 * Verify: email
136 *
137 * @access private
138 */
139 function verify_email()
140 {
141 if (!is_bool($ne = $this->verify_noempty('email')))
142 {
143 return $ne;
144 }
145
146 if (!$this->registry->funct->is_valid_email($this->values['email']))
147 {
148 return _('The specified email is invalid.');
149 }
150 if ($this->registry->db->query_first("SELECT * FROM " . TABLE_PREFIX . "user WHERE email = '" . $this->registry->db->escape_string($this->values['email']) . "' AND userid <> " . $this->registry->clean($this->values['userid'], TYPE_UINT)))
151 {
152 return _('The specified email is already in use.');
153 }
154 return true;
155 }
156
157 // ###################################################################
158 /**
159 * Verify: displayname
160 *
161 * @access private
162 */
163 function verify_displayname()
164 {
165 if (!is_bool($ne = $this->verify_noempty('displayname')))
166 {
167 return $ne;
168 }
169
170 if ($this->registry->db->query_first("SELECT * FROM " . TABLE_PREFIX . "user WHERE displayname = '" . $this->registry->db->escape_string($this->values['displayname']) . "' AND userid <> " . $this->registry->clean($this->values['userid'], TYPE_UINT)))
171 {
172 return _('That display name is already in use by another user.');
173 }
174 return true;
175 }
176
177 // ###################################################################
178 /**
179 * Verify: usergroupid
180 *
181 * @access private
182 */
183 function verify_usergroupid()
184 {
185 if (!isset($this->registry->datastore['usergroup'][ $this->values['usergroupid'] ]))
186 {
187 return false;
188 }
189 return true;
190 }
191
192 // ###################################################################
193 /**
194 * Pre-update
195 *
196 * @access private
197 */
198 function pre_update()
199 {
200 $this->set_condition();
201 $this->fetch();
202
203 if ($this->values['password'] == '')
204 {
205 $this->set('password', $this->objdata['password']);
206 }
207 else
208 {
209 $this->registry->debug("updating password = true");
210 $this->set('password', md5(md5($this->values['password']) . md5($this->objdata['salt'])));
211 }
212 }
213
214 // ###################################################################
215 /**
216 * Post-update
217 *
218 * @access protected
219 */
220 function post_update()
221 {
222 if (isset($this->values['displayname']))
223 {
224 $username = $this->registry->escape($this->values['displayname']);
225 $id = $this->values['userid'];
226
227 $this->registry->db->query("UPDATE " . TABLE_PREFIX . "bug SET username = '$username' WHERE userid = $id");
228 $this->registry->db->query("UPDATE " . TABLE_PREFIX . "bug SET lastpostbyname = '$username' WHERE lastpostby = $id");
229 $this->registry->db->query("UPDATE " . TABLE_PREFIX . "bug SET hiddenlastpostbyname = '$username' WHERE hiddenlastpostby = $id");
230 }
231
232 if (isset($this->values['displayname']) OR isset($this->values['email']))
233 {
234 build_assignedto();
235 }
236 }
237
238 // ###################################################################
239 /**
240 * Pre-delete
241 *
242 * @access protected
243 */
244 function pre_delete()
245 {
246 if ($this->values['userid'] == $this->registry->userinfo['userid'])
247 {
248 $this->error(_('You cannot delete your own account!'));
249 }
250
251 if ($this->values['usergroupid'] == 6)
252 {
253 $count = $this->registry->db->query_first("SELECT COUNT(*) AS count FROM " . TABLE_PREFIX . "user WHERE usergroupid = 6 AND userid <> " . $this->values['userid']);
254 if ($count['count'] < 1)
255 {
256 $this->error(_('At least one other administrator needs to be present before you can delete this user'));
257 }
258 }
259 }
260
261 // ###################################################################
262 /**
263 * Post-delete
264 *
265 * @access protected
266 */
267 function post_delete()
268 {
269 $this->registry->db->query("DELETE FROM " . TABLE_PREFIX . "user WHERE userid = " . $this->values['userid']);
270 $this->registry->db->query("DELETE FROM " . TABLE_PREFIX . "favorite WHERE userid = " . $this->values['userid']);
271 $this->registry->db->query("DELETE FROM " . TABLE_PREFIX . "useractivation WHERE userid = " . $this->values['userid']);
272 $this->registry->db->query("DELETE FROM " . TABLE_PREFIX . "useremail WHERE userid = " . $this->values['userid']);
273 $this->registry->db->query("DELETE FROM " . TABLE_PREFIX . "search WHERE userid = " . $this->values['userid']);
274
275 build_assignedto();
276 }
277
278 // ###################################################################
279 /**
280 * Verify: hidestatuses
281 *
282 * @access private
283 */
284 function verify_hidestatuses()
285 {
286 if (is_array($this->values['hidestatuses']))
287 {
288 $this->set('hidestatuses', implode(',', $this->values['hidestatuses']));
289 }
290
291 return true;
292 }
293
294 // ###################################################################
295 /**
296 * Verify: defaultsortkey
297 *
298 * @access private
299 */
300 function verify_defaultsortkey()
301 {
302 if (!ListSorter::fetch_by_text($this->values['defaultsortkey']))
303 {
304 return false;
305 }
306
307 return true;
308 }
309
310 // ###################################################################
311 /**
312 * Verify: defaultsortas
313 *
314 * @access private
315 */
316 function verify_defaultsortas()
317 {
318 if (!ListSorter::fetch_as_text($this->values['defaultsortas']))
319 {
320 return false;
321 }
322
323 return true;
324 }
325
326 // ###################################################################
327 /**
328 * Verify: columnoptions
329 *
330 * @access private
331 */
332 function verify_columnoptions()
333 {
334 if (is_array($this->values['columnoptions']))
335 {
336 $this->set('columnoptions', serialize($this->values['columnoptions']));
337 }
338 return true;
339 }
340 }
341
342 /*=====================================================================*\
343 || ###################################################################
344 || # $HeadURL$
345 || # $Id$
346 || ###################################################################
347 \*=====================================================================*/
348 ?>