Cleanup, use PlDict and last core.
[platal.git] / classes / user.php
CommitLineData
9f8ebb9f
VZ
1<?php
2/***************************************************************************
832e6fcb 3 * Copyright (C) 2003-2008 Polytechnique.org *
9f8ebb9f
VZ
4 * http://opensource.polytechnique.org/ *
5 * *
6 * This program is free software; you can redistribute it and/or modify *
7 * it under the terms of the GNU General Public License as published by *
8 * the Free Software Foundation; either version 2 of the License, or *
9 * (at your option) any later version. *
10 * *
11 * This program is distributed in the hope that it will be useful, *
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
14 * GNU General Public License for more details. *
15 * *
16 * You should have received a copy of the GNU General Public License *
17 * along with this program; if not, write to the Free Software *
18 * Foundation, Inc., *
19 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA *
20 ***************************************************************************/
21
2d96cf7b 22class User extends PlUser
9f8ebb9f 23{
3e53a496
FB
24 private $_profile_fetched = false;
25 private $_profile = null;
26
70232020 27 // Implementation of the login to uid method.
b1719b13
VZ
28 protected function getLogin($login)
29 {
30 global $globals;
31
455ea0c9
FB
32 if ($login instanceof User) {
33 $machin->id();
34 }
35
e7b93962 36 if ($login instanceof Profile) {
3e53a496
FB
37 $this->_profile = $login;
38 $this->_profile_fetched = true;
e7b93962
FB
39 $res = XDB::query('SELECT ap.uid
40 FROM account_profiles AS ap
41 WHERE ap.pid = {?} AND FIND_IN_SET(\'owner\', perms)',
42 $login->id());
43 if ($res->numRows()) {
44 return $res->fetchOneCell();
45 }
46 throw new UserNotFoundException();
47 }
48
b1719b13
VZ
49 // If $data is an integer, fetches directly the result.
50 if (is_numeric($login)) {
e7b93962
FB
51 $res = XDB::query('SELECT a.uid
52 FROM accounts AS a
53 WHERE a.uid = {?}', $login);
b1719b13 54 if ($res->numRows()) {
70232020 55 return $res->fetchOneCell();
b1719b13
VZ
56 }
57
58 throw new UserNotFoundException();
59 }
60
61 // Checks whether $login is a valid hruid or not.
e7b93962
FB
62 $res = XDB::query('SELECT a.uid
63 FROM accounts AS a
64 WHERE a.hruid = {?}', $login);
b1719b13 65 if ($res->numRows()) {
70232020 66 return $res->fetchOneCell();
b1719b13
VZ
67 }
68
69 // From now, $login can only by an email alias, or an email redirection.
70 // If it doesn't look like a valid address, appends the plat/al's main domain.
71 $login = trim(strtolower($login));
72 if (strstr($login, '@') === false) {
73 $login = $login . '@' . $globals->mail->domain;
74 }
75
76 // Checks if $login is a valid alias on the main domains.
77 list($mbox, $fqdn) = explode('@', $login);
78 if ($fqdn == $globals->mail->domain || $fqdn == $globals->mail->domain2) {
e7b93962
FB
79 $res = XDB::query('SELECT a.uid
80 FROM accounts AS a
81 INNER JOIN aliases AS al ON (al.id = a.uid AND al.type IN (\'alias\', \'a_vie\'))
82 WHERE al.alias = {?}', $mbox);
b1719b13 83 if ($res->numRows()) {
70232020 84 return $res->fetchOneCell();
b1719b13
VZ
85 }
86
e7b93962 87 /** TODO: implements this by inspecting the profile.
b1719b13 88 if (preg_match('/^(.*)\.([0-9]{4})$/u', $mbox, $matches)) {
e7b93962
FB
89 $res = XDB::query('SELECT a.uid
90 FROM accounts AS a
91 INNER JOIN aliases AS al ON (al.id = a.uid AND al.type IN ('alias', 'a_vie'))
92 WHERE al.alias = {?} AND a.promo = {?}', $matches[1], $matches[2]);
b1719b13 93 if ($res->numRows() == 1) {
70232020 94 return $res->fetchOneCell();
b1719b13 95 }
e7b93962 96 }*/
b1719b13
VZ
97
98 throw new UserNotFoundException();
99 }
100
101 // Looks for $login as an email alias from the dedicated alias domain.
102 if ($fqdn == $globals->mail->alias_dom || $fqdn == $globals->mail->alias_dom2) {
103 $res = XDB::query("SELECT redirect
104 FROM virtual_redirect
105 INNER JOIN virtual USING(vid)
106 WHERE alias = {?}", $mbox . '@' . $globals->mail->alias_dom);
107 if ($redir = $res->fetchOneCell()) {
108 // We now have a valid alias, which has to be translated to an hruid.
109 list($alias, $alias_fqdn) = explode('@', $redir);
e7b93962
FB
110 $res = XDB::query("SELECT a.uid
111 FROM accounts AS a
112 LEFT JOIN aliases AS al ON (al.id = a.uid AND al.type IN ('alias', 'a_vie'))
113 WHERE al.alias = {?}", $alias);
b1719b13 114 if ($res->numRows()) {
70232020 115 return $res->fetchOneCell();
b1719b13
VZ
116 }
117 }
118
119 throw new UserNotFoundException();
120 }
121
cb8a8977
FB
122 // Looks for an account with the given email.
123 $res = XDB::query('SELECT a.uid
124 FROM accounts AS a
125 WHERE a.email = {?}', $login);
126 if ($res->numRows() == 1) {
127 return $res->fetchOneCell();
128 }
129
b1719b13 130 // Otherwise, we do suppose $login is an email redirection.
e7b93962
FB
131 $res = XDB::query("SELECT a.uid
132 FROM accounts AS a
133 LEFT JOIN emails AS e ON (e.uid = a.uid)
b1719b13
VZ
134 WHERE e.email = {?}", $login);
135 if ($res->numRows() == 1) {
70232020 136 return $res->fetchOneCell();
b1719b13
VZ
137 }
138
139 throw new UserNotFoundException($res->fetchColumn(1));
140 }
141
832e6fcb
FB
142 protected static function loadMainFieldsFromUIDs(array $uids, $sorted = null)
143 {
45dcd6dd 144 global $globals;
832e6fcb
FB
145 $joins = '';
146 $orderby = '';
45dcd6dd 147 $fields = array();
832e6fcb
FB
148 if (!is_null($sorted)) {
149 $order = array();
150 $with_ap = false;
151 $with_pd = false;
152 foreach (explode(',', $sorted) as $part) {
153 $desc = ($part[0] == '-');
154 if ($desc) {
155 $part = substr($desc, 1);
156 }
157 switch ($part) {
158 case 'promo':
159 $with_pd = true;
160 $with_ap = true;
161 $part = 'IF (pd.promo IS NULL, \'ext\', pd.promo)';
162 break;
163 case 'full_name':
164 $part = 'a.full_name';
165 break;
166 case 'display_name':
167 $part = 'a.display_name';
168 break;
169 default:
170 $part = null;
171 }
172 if (!is_null($part)) {
173 if ($desc) {
174 $part .= ' DESC';
175 }
176 $order[] = $part;
177 }
178 }
179 if (count($order) > 0) {
180 if ($with_ap) {
181 $joins .= "LEFT JOIN account_profiles AS ap ON (ap.uid = a.uid AND FIND_IN_SET('owner', ap.perms))\n";
182 }
183 if ($with_pd) {
184 $joins .= "LEFT JOIN profile_display AS pd ON (pd.pid = ap.pid)\n";
185 }
186 $orderby = 'ORDER BY ' . implode(', ', $order);
187 }
188 }
45dcd6dd
FB
189 if ($globals->asso('id')) {
190 $joins .= XDB::format("LEFT JOIN groupex.membres AS gpm ON (gpm.uid = a.uid AND gpm.asso_id = {?})\n", $globals->asso('id'));
191 $fields[] = 'gpm.perms AS group_perms';
192 }
193 if (count($fields) > 0) {
194 $fields = ', ' . implode(', ', $fields);
a3118782
FB
195 } else {
196 $fields = '';
45dcd6dd
FB
197 }
198 $uids = array_map(array('XDB', 'escape'), $uids);
832e6fcb
FB
199 return XDB::iterator('SELECT a.uid, a.hruid, a.registration_date,
200 CONCAT(af.alias, \'@' . $globals->mail->domain . '\') AS forlife,
201 CONCAT(ab.alias, \'@' . $globals->mail->domain . '\') AS bestalias,
202 a.full_name, a.display_name, a.sex = \'female\' AS gender,
203 IF(a.state = \'active\', at.perms, \'\') AS perms,
204 a.email_format, a.is_admin, a.state, a.type, a.skin,
205 FIND_IN_SET(\'watch\', a.flags) AS watch, a.comment,
206 a.weak_password IS NOT NULL AS weak_access,
45dcd6dd 207 a.token IS NOT NULL AS token_access ' . $fields . '
832e6fcb
FB
208 FROM accounts AS a
209 INNER JOIN account_types AS at ON (at.type = a.type)
210 LEFT JOIN aliases AS af ON (af.id = a.uid AND af.type = \'a_vie\')
211 LEFT JOIN aliases AS ab ON (ab.id = a.uid AND FIND_IN_SET(\'bestalias\', ab.flags))
212 ' . $joins . '
213 WHERE a.uid IN (' . implode(', ', $uids) . ')
214 ' . $orderby);
215 }
216
70232020
VZ
217 // Implementation of the data loader.
218 protected function loadMainFields()
219 {
c4012d9b
VZ
220 if ($this->hruid !== null && $this->forlife !== null
221 && $this->bestalias !== null && $this->display_name !== null
8f2104cb 222 && $this->full_name !== null && $this->perms !== null
c4012d9b 223 && $this->gender !== null && $this->email_format !== null) {
70232020
VZ
224 return;
225 }
832e6fcb 226 $this->fillFromArray(self::loadMainFieldsFromUIDs(array($this->user_id))->next());
70232020
VZ
227 }
228
229 // Specialization of the fillFromArray method, to implement hacks to enable
230 // lazy loading of user's main properties from the session.
c4012d9b
VZ
231 // TODO(vzanotti): remove the conversion hacks once the old codebase will
232 // stop being used actively.
70232020
VZ
233 protected function fillFromArray(array $values)
234 {
235 // It might happen that the 'user_id' field is called uid in some places
236 // (eg. in sessions), so we hard link uid to user_id to prevent useless
237 // SQL requests.
238 if (!isset($values['user_id']) && isset($values['uid'])) {
239 $values['user_id'] = $values['uid'];
240 }
241
242 // Also, if display_name and full_name are not known, but the user's
243 // surname and last name are, we can construct the former two.
244 if (isset($values['prenom']) && isset($values['nom'])) {
245 if (!isset($values['display_name'])) {
246 $values['display_name'] = ($values['prenom'] ? $values['prenom'] : $values['nom']);
247 }
248 if (!isset($values['full_name'])) {
249 $values['full_name'] = $values['prenom'] . ' ' . $values['nom'];
250 }
251 }
252
c4012d9b
VZ
253 // We also need to convert the gender (usually named "femme"), and the
254 // email format parameter (valued "texte" instead of "text").
255 if (isset($values['femme'])) {
256 $values['gender'] = (bool) $values['femme'];
257 }
258 if (isset($values['mail_fmt'])) {
259 $values['email_format'] = $values['mail_fmt'];
260 }
c4012d9b 261
70232020
VZ
262 parent::fillFromArray($values);
263 }
264
50d5ec0b
FB
265 // Specialization of the buildPerms method
266 // This function build 'generic' permissions for the user. It does not take
267 // into account page specific permissions (e.g X.net group permissions)
268 protected function buildPerms()
269 {
270 if (!is_null($this->perm_flags)) {
271 return;
272 }
273 if ($this->perms === null) {
274 $this->loadMainFields();
275 }
365ba8c3 276 $this->perm_flags = self::makePerms($this->perms, $this->is_admin);
50d5ec0b
FB
277 }
278
7f1ff426
FB
279 // We do not want to store the password in the object.
280 // So, fetch it 'on demand'
281 public function password()
282 {
283 return XDB::fetchOneCell('SELECT a.password
284 FROM accounts AS a
285 WHERE a.uid = {?}', $this->id());
286 }
287
8f2104cb
FB
288 /** Overload PlUser::promo(): there no promo defined for a user in the current
289 * schema. The promo is a field from the profile.
290 */
291 public function promo()
292 {
293 if (!$this->hasProfile()) {
294 return '';
295 }
296 return $this->profile()->promo();
297 }
298
e7b93962
FB
299 /** Return the main profile attached with this account if any.
300 */
301 public function profile()
302 {
3e53a496
FB
303 if (!$this->_profile_fetched) {
304 $this->_profile_fetched = true;
305 $this->_profile = Profile::get($this);
306 }
307 return $this->_profile;
308 }
309
310 /** Return true if the user has an associated profile.
311 */
312 public function hasProfile()
313 {
314 return !is_null($this->profile());
315 }
316
3af21f99
FB
317 /** Check if the user can edit to given profile.
318 */
319 public function canEdit(Profile $profile)
320 {
321 // XXX: Check permissions (e.g. secretary permission)
322 // and flags from the profile
323 return XDB::fetchOneCell('SELECT pid
324 FROM account_profiles
325 WHERE uid = {?} AND pid = {?}',
326 $this->id(), $profile->id());
327 }
328
3e53a496
FB
329 /** Get the email alias of the user.
330 */
331 public function emailAlias()
332 {
333 global $globals;
8f2104cb
FB
334 $data = $this->emailAliases($globals->mail->alias_dom);
335 if (count($data) > 0) {
336 return array_pop($data);
337 }
338 return null;
339 }
340
341 /** Get all the aliases the user belongs to.
342 */
343 public function emailAliases($domain = null)
344 {
345 $where = '';
346 if (!is_null($domain)) {
347 $where = XDB::format(' AND alias LIKE CONCAT("%@", {?})', $domain);
348 }
349 return XDB::fetchColumn('SELECT v.alias
350 FROM virtual AS v
351 INNER JOIN virtual_redirect AS vr ON (v.vid = vr.vid)
352 WHERE (vr.redirect = {?} OR vr.redirect = {?})
353 ' . $where,
354 $this->forlifeEmail(), $this->m4xForlifeEmail());
3e53a496
FB
355 }
356
357 /** Get the alternative forlife email
358 * TODO: remove this uber-ugly hack. The issue is that you need to remove
359 * all @m4x.org addresses in virtual_redirect first.
360 * XXX: This is juste to make code more readable, to be remove as soon as possible
361 */
362 public function m4xForlifeEmail()
363 {
364 global $globals;
365 trigger_error('USING M4X FORLIFE', E_USER_NOTICE);
366 return $this->login() . '@' . $globals->mail->domain2;
e7b93962
FB
367 }
368
50d5ec0b 369 // Return permission flags for a given permission level.
365ba8c3 370 public static function makePerms($perms, $is_admin)
50d5ec0b 371 {
365ba8c3 372 $flags = new PlFlagSet($perms);
50d5ec0b 373 $flags->addFlag(PERMS_USER);
365ba8c3 374 if ($is_admin) {
50d5ec0b
FB
375 $flags->addFlag(PERMS_ADMIN);
376 }
377 return $flags;
378 }
379
b1719b13
VZ
380 // Implementation of the default user callback.
381 public static function _default_user_callback($login, $results)
382 {
b1719b13
VZ
383 $result_count = count($results);
384 if ($result_count == 0 || !S::has_perms()) {
70232020 385 Platal::page()->trigError("Il n'y a pas d'utilisateur avec l'identifiant : $login");
b1719b13 386 } else {
70232020 387 Platal::page()->trigError("Il y a $result_count utilisateurs avec cet identifiant : " . join(', ', $results));
b1719b13
VZ
388 }
389 }
70232020
VZ
390
391 // Implementation of the static email locality checker.
392 public static function isForeignEmailAddress($email)
393 {
394 global $globals;
395 if (strpos($email, '@') === false) {
396 return false;
397 }
398
399 list($user, $dom) = explode('@', $email);
400 return $dom != $globals->mail->domain &&
401 $dom != $globals->mail->domain2 &&
402 $dom != $globals->mail->alias_dom &&
403 $dom != $globals->mail->alias_dom2;
404 }
832e6fcb
FB
405
406 // Fetch a set of users from a list of UIDs
407 public static function getBuildUsersWithUIDs(array $uids, $sortby = null)
408 {
409 $fields = self::loadMainFieldsFromUIDs($uids, $sortby);
410 $users = array();
411 while (($list = $fields->next())) {
412 $users[] = User::getSilentWithValues(null, $list);
413 }
414 return $users;
415 }
9f8ebb9f
VZ
416}
417
418// vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
419?>