Merge branch 'platal-1.0.0'
[platal.git] / classes / user.php
CommitLineData
9f8ebb9f
VZ
1<?php
2/***************************************************************************
9f5bd98e 3 * Copyright (C) 2003-2010 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{
30962fae
FB
24 const PERM_GROUPS = 'groups';
25 const PERM_MAIL = 'mail';
26 const PERM_DIRECTORY_AX = 'directory_ax';
27 const PERM_DIRECTORY_PRIVATE = 'directory_private';
28 const PERM_EDIT_DIRECTORY = 'edit_directory';
29 const PERM_FORUMS = 'forums';
30 const PERM_LISTS = 'lists';
31 const PERM_PAYMENT = 'payment';
32
3e53a496
FB
33 private $_profile_fetched = false;
34 private $_profile = null;
35
956608bc
RB
36 // Additional fields (non core)
37 protected $promo = null;
38
70232020 39 // Implementation of the login to uid method.
b1719b13
VZ
40 protected function getLogin($login)
41 {
42 global $globals;
43
f6c58d14
VZ
44 if (!$login) {
45 throw new UserNotFoundException();
46 }
47
455ea0c9 48 if ($login instanceof User) {
14da7ef4 49 return $login->id();
455ea0c9
FB
50 }
51
e7b93962 52 if ($login instanceof Profile) {
3e53a496
FB
53 $this->_profile = $login;
54 $this->_profile_fetched = true;
e7b93962
FB
55 $res = XDB::query('SELECT ap.uid
56 FROM account_profiles AS ap
57 WHERE ap.pid = {?} AND FIND_IN_SET(\'owner\', perms)',
58 $login->id());
59 if ($res->numRows()) {
60 return $res->fetchOneCell();
61 }
62 throw new UserNotFoundException();
63 }
64
b1719b13
VZ
65 // If $data is an integer, fetches directly the result.
66 if (is_numeric($login)) {
e7b93962
FB
67 $res = XDB::query('SELECT a.uid
68 FROM accounts AS a
69 WHERE a.uid = {?}', $login);
b1719b13 70 if ($res->numRows()) {
70232020 71 return $res->fetchOneCell();
b1719b13
VZ
72 }
73
74 throw new UserNotFoundException();
75 }
76
77 // Checks whether $login is a valid hruid or not.
e7b93962
FB
78 $res = XDB::query('SELECT a.uid
79 FROM accounts AS a
80 WHERE a.hruid = {?}', $login);
b1719b13 81 if ($res->numRows()) {
70232020 82 return $res->fetchOneCell();
b1719b13
VZ
83 }
84
85 // From now, $login can only by an email alias, or an email redirection.
86 // If it doesn't look like a valid address, appends the plat/al's main domain.
87 $login = trim(strtolower($login));
88 if (strstr($login, '@') === false) {
89 $login = $login . '@' . $globals->mail->domain;
90 }
91
92 // Checks if $login is a valid alias on the main domains.
93 list($mbox, $fqdn) = explode('@', $login);
94 if ($fqdn == $globals->mail->domain || $fqdn == $globals->mail->domain2) {
e7b93962
FB
95 $res = XDB::query('SELECT a.uid
96 FROM accounts AS a
fe13bc1d 97 INNER JOIN aliases AS al ON (al.uid = a.uid AND al.type IN (\'alias\', \'a_vie\'))
e7b93962 98 WHERE al.alias = {?}', $mbox);
b1719b13 99 if ($res->numRows()) {
70232020 100 return $res->fetchOneCell();
b1719b13
VZ
101 }
102
103 if (preg_match('/^(.*)\.([0-9]{4})$/u', $mbox, $matches)) {
e7b93962 104 $res = XDB::query('SELECT a.uid
d47dcad7
SJ
105 FROM accounts AS a
106 INNER JOIN aliases AS al ON (al.uid = a.uid AND al.type IN (\'alias\', \'a_vie\'))
107 INNER JOIN account_profiles AS ap ON (a.uid = ap.uid AND FIND_IN_SET(\'owner\', ap.perms))
108 INNER JOIN profiles AS p ON (p.pid = ap.pid)
109 INNER JOIN profile_education AS pe ON (p.pid = pe.pid AND FIND_IN_SET(\'primary\', pe.flags))
110 WHERE p.hrpid = {?} OR ((pe.entry_year <= {?} AND pe.grad_year >= {?}) AND al.alias = {?})
111 GROUP BY a.uid',
112 $matches[0], $matches[2], $matches[2], $matches[1]);
b1719b13 113 if ($res->numRows() == 1) {
70232020 114 return $res->fetchOneCell();
b1719b13 115 }
d47dcad7 116 }
b1719b13
VZ
117
118 throw new UserNotFoundException();
119 }
120
121 // Looks for $login as an email alias from the dedicated alias domain.
122 if ($fqdn == $globals->mail->alias_dom || $fqdn == $globals->mail->alias_dom2) {
123 $res = XDB::query("SELECT redirect
124 FROM virtual_redirect
125 INNER JOIN virtual USING(vid)
126 WHERE alias = {?}", $mbox . '@' . $globals->mail->alias_dom);
127 if ($redir = $res->fetchOneCell()) {
128 // We now have a valid alias, which has to be translated to an hruid.
129 list($alias, $alias_fqdn) = explode('@', $redir);
e7b93962
FB
130 $res = XDB::query("SELECT a.uid
131 FROM accounts AS a
fe13bc1d 132 LEFT JOIN aliases AS al ON (al.uid = a.uid AND al.type IN ('alias', 'a_vie'))
e7b93962 133 WHERE al.alias = {?}", $alias);
b1719b13 134 if ($res->numRows()) {
70232020 135 return $res->fetchOneCell();
b1719b13
VZ
136 }
137 }
138
139 throw new UserNotFoundException();
140 }
141
cb8a8977
FB
142 // Looks for an account with the given email.
143 $res = XDB::query('SELECT a.uid
144 FROM accounts AS a
145 WHERE a.email = {?}', $login);
146 if ($res->numRows() == 1) {
147 return $res->fetchOneCell();
148 }
149
b1719b13 150 // Otherwise, we do suppose $login is an email redirection.
e7b93962
FB
151 $res = XDB::query("SELECT a.uid
152 FROM accounts AS a
153 LEFT JOIN emails AS e ON (e.uid = a.uid)
b1719b13
VZ
154 WHERE e.email = {?}", $login);
155 if ($res->numRows() == 1) {
70232020 156 return $res->fetchOneCell();
b1719b13
VZ
157 }
158
159 throw new UserNotFoundException($res->fetchColumn(1));
160 }
161
0d906109 162 protected static function loadMainFieldsFromUIDs(array $uids, $respect_order = true)
832e6fcb 163 {
6d33f1d3
FB
164 if (empty($uids)) {
165 return PlIteratorUtils::emptyIterator();
166 }
167
45dcd6dd 168 global $globals;
832e6fcb 169 $joins = '';
45dcd6dd 170 $fields = array();
45dcd6dd 171 if ($globals->asso('id')) {
eb41eda9 172 $joins .= XDB::format("LEFT JOIN group_members AS gpm ON (gpm.uid = a.uid AND gpm.asso_id = {?})\n", $globals->asso('id'));
45dcd6dd 173 $fields[] = 'gpm.perms AS group_perms';
a6761ca9 174 $fields[] = 'gpm.comm AS group_comm';
45dcd6dd
FB
175 }
176 if (count($fields) > 0) {
177 $fields = ', ' . implode(', ', $fields);
a3118782
FB
178 } else {
179 $fields = '';
45dcd6dd 180 }
0d906109
RB
181
182 if ($respect_order) {
183 $order = 'ORDER BY ' . XDB::formatCustomOrder('a.uid', $uids);
184 } else {
185 $order = '';
186 }
187
45dcd6dd 188 $uids = array_map(array('XDB', 'escape'), $uids);
0d906109 189
777c5910 190 return XDB::iterator('SELECT a.uid, a.hruid, a.registration_date, ah.alias AS homonym,
33a4f3f9
SJ
191 IF (af.alias IS NULL, NULL, CONCAT(af.alias, \'@' . $globals->mail->domain . '\')) AS forlife,
192 IF (af.alias IS NULL, NULL, CONCAT(af.alias, \'@' . $globals->mail->domain2 . '\')) AS forlife_alternate,
193 IF (ab.alias IS NULL, NULL, CONCAT(ab.alias, \'@' . $globals->mail->domain . '\')) AS bestalias,
194 IF (ab.alias IS NULL, NULL, CONCAT(ab.alias, \'@' . $globals->mail->domain2 . '\')) AS bestalias_alternate,
195 a.email, a.full_name, a.directory_name, a.display_name, a.sex = \'female\' AS gender,
7fd6dbb3 196 IF(a.state = \'active\', CONCAT(at.perms, \',\', IF(a.user_perms IS NULL, \'\', a.user_perms)), \'\') AS perms,
2914271e 197 a.user_perms, a.email_format, a.is_admin, a.state, a.type, a.skin,
832e6fcb 198 FIND_IN_SET(\'watch\', a.flags) AS watch, a.comment,
2ab3486b
SJ
199 a.weak_password IS NOT NULL AS weak_access, g.g_account_name IS NOT NULL AS googleapps,
200 a.token IS NOT NULL AS token_access, a.token, a.last_version,
201 (e.email IS NULL AND NOT FIND_IN_SET(\'googleapps\', eo.storage)) AND a.state != \'pending\' AS lost,
202 UNIX_TIMESTAMP(s.start) AS lastlogin, s.host, UNIX_TIMESTAMP(fp.last_seen) AS banana_last
2c411733 203 ' . $fields . '
832e6fcb
FB
204 FROM accounts AS a
205 INNER JOIN account_types AS at ON (at.type = a.type)
fe13bc1d
FB
206 LEFT JOIN aliases AS af ON (af.uid = a.uid AND af.type = \'a_vie\')
207 LEFT JOIN aliases AS ab ON (ab.uid = a.uid AND FIND_IN_SET(\'bestalias\', ab.flags))
777c5910 208 LEFT JOIN aliases AS ah ON (ah.uid = a.uid AND ah.type = \'homonyme\')
2c411733
FB
209 LEFT JOIN emails AS e ON (e.uid = a.uid AND e.flags = \'active\')
210 LEFT JOIN email_options AS eo ON (eo.uid = a.uid)
2ab3486b
SJ
211 LEFT JOIN gapps_accounts AS g ON (a.uid = g.l_userid AND g.g_status = \'active\')
212 LEFT JOIN log_last_sessions AS ls ON (ls.uid = a.uid)
213 LEFT JOIN log_sessions AS s ON (s.id = ls.id)
214 LEFT JOIN forum_profiles AS fp ON (fp.uid = a.uid)
d865c296 215 ' . $joins . '
832e6fcb 216 WHERE a.uid IN (' . implode(', ', $uids) . ')
0d906109
RB
217 GROUP BY a.uid
218 ' . $order);
832e6fcb
FB
219 }
220
70232020
VZ
221 // Implementation of the data loader.
222 protected function loadMainFields()
223 {
c4012d9b
VZ
224 if ($this->hruid !== null && $this->forlife !== null
225 && $this->bestalias !== null && $this->display_name !== null
8f2104cb 226 && $this->full_name !== null && $this->perms !== null
c4012d9b 227 && $this->gender !== null && $this->email_format !== null) {
70232020
VZ
228 return;
229 }
1bf36cd1 230 $this->fillFromArray(self::loadMainFieldsFromUIDs(array($this->uid))->next());
70232020
VZ
231 }
232
50d5ec0b
FB
233 // Specialization of the buildPerms method
234 // This function build 'generic' permissions for the user. It does not take
235 // into account page specific permissions (e.g X.net group permissions)
236 protected function buildPerms()
237 {
238 if (!is_null($this->perm_flags)) {
239 return;
240 }
241 if ($this->perms === null) {
242 $this->loadMainFields();
243 }
365ba8c3 244 $this->perm_flags = self::makePerms($this->perms, $this->is_admin);
50d5ec0b
FB
245 }
246
7f1ff426
FB
247 // We do not want to store the password in the object.
248 // So, fetch it 'on demand'
249 public function password()
250 {
251 return XDB::fetchOneCell('SELECT a.password
252 FROM accounts AS a
253 WHERE a.uid = {?}', $this->id());
254 }
255
280806d9
SJ
256 public function isActive()
257 {
258 return $this->state == 'active';
259 }
260
8f2104cb
FB
261 /** Overload PlUser::promo(): there no promo defined for a user in the current
262 * schema. The promo is a field from the profile.
263 */
264 public function promo()
265 {
266 if (!$this->hasProfile()) {
267 return '';
268 }
269 return $this->profile()->promo();
270 }
271
a6761ca9
FB
272 public function firstName()
273 {
274 if (!$this->hasProfile()) {
275 return $this->displayName();
276 }
277 return $this->profile()->firstName();
278 }
279
280 public function lastName()
281 {
282 if (!$this->hasProfile()) {
283 return '';
284 }
285 return $this->profile()->lastName();
286 }
287
2ab3486b
SJ
288 public function displayName()
289 {
290 if (!$this->hasProfile()) {
291 return $this->display_name;
292 }
293 return $this->profile()->yourself;
294 }
295
09e54905
SJ
296 public function fullName($with_promo = false)
297 {
298 if (!$this->hasProfile()) {
299 return $this->full_name;
300 }
301 return $this->profile()->fullName($with_promo);
302 }
303
304 public function directoryName()
305 {
306 if (!$this->hasProfile()) {
d081acb2 307 return $this->directory_name;
09e54905
SJ
308 }
309 return $this->profile()->directory_name;
310 }
311
e7b93962
FB
312 /** Return the main profile attached with this account if any.
313 */
4e698dc9 314 public function profile($forceFetch = false)
e7b93962 315 {
4e698dc9 316 if (!$this->_profile_fetched || $forceFetch) {
3e53a496
FB
317 $this->_profile_fetched = true;
318 $this->_profile = Profile::get($this);
319 }
320 return $this->_profile;
321 }
322
323 /** Return true if the user has an associated profile.
324 */
325 public function hasProfile()
326 {
327 return !is_null($this->profile());
328 }
329
3af21f99
FB
330 /** Check if the user can edit to given profile.
331 */
332 public function canEdit(Profile $profile)
333 {
334 // XXX: Check permissions (e.g. secretary permission)
335 // and flags from the profile
336 return XDB::fetchOneCell('SELECT pid
337 FROM account_profiles
338 WHERE uid = {?} AND pid = {?}',
339 $this->id(), $profile->id());
340 }
341
3e53a496
FB
342 /** Get the email alias of the user.
343 */
344 public function emailAlias()
345 {
346 global $globals;
8f2104cb
FB
347 $data = $this->emailAliases($globals->mail->alias_dom);
348 if (count($data) > 0) {
349 return array_pop($data);
350 }
351 return null;
352 }
353
354 /** Get all the aliases the user belongs to.
355 */
a6761ca9 356 public function emailAliases($domain = null, $type = 'user', $sub_state = false)
8f2104cb 357 {
a6761ca9
FB
358 $join = XDB::format('(vr.redirect = {?} OR vr.redirect = {?}) ',
359 $this->forlifeEmail(), $this->m4xForlifeEmail());
8f2104cb
FB
360 $where = '';
361 if (!is_null($domain)) {
a6761ca9
FB
362 $where = XDB::format('WHERE v.alias LIKE CONCAT("%@", {?})', $domain);
363 }
364 if (!is_null($type)) {
365 if (empty($where)) {
366 $where = XDB::format('WHERE v.type = {?}', $type);
367 } else {
368 $where .= XDB::format(' AND v.type = {?}', $type);
369 }
370 }
371 if ($sub_state) {
372 return XDB::fetchAllAssoc('alias', 'SELECT v.alias, vr.redirect IS NOT NULL AS sub
373 FROM virtual AS v
374 LEFT JOIN virtual_redirect AS vr ON (v.vid = vr.vid AND ' . $join . ')
375 ' . $where);
376 } else {
377 return XDB::fetchColumn('SELECT v.alias
378 FROM virtual AS v
379 INNER JOIN virtual_redirect AS vr ON (v.vid = vr.vid AND ' . $join . ')
380 ' . $where);
8f2104cb 381 }
3e53a496
FB
382 }
383
384 /** Get the alternative forlife email
385 * TODO: remove this uber-ugly hack. The issue is that you need to remove
386 * all @m4x.org addresses in virtual_redirect first.
387 * XXX: This is juste to make code more readable, to be remove as soon as possible
388 */
389 public function m4xForlifeEmail()
390 {
391 global $globals;
392 trigger_error('USING M4X FORLIFE', E_USER_NOTICE);
393 return $this->login() . '@' . $globals->mail->domain2;
e7b93962
FB
394 }
395
38c6fe96
FB
396
397 /** Get marketing informations
398 */
399 private function fetchMarketingData()
400 {
db8432d5 401 if (isset($this->pending_registration_date)) {
38c6fe96
FB
402 return;
403 }
db8432d5
SJ
404 $infos = XDB::fetchOneAssoc('SELECT rp.date AS pending_registration_date, rp.email AS pending_registration_email,
405 rm.last AS last_marketing_date, rm.email AS last_marketing_email
406 FROM accounts AS a
407 LEFT JOIN register_pending AS rp ON (rp.uid = a.uid)
408 LEFT JOIN register_marketing AS rm ON (rm.uid = a.uid AND rm.last != \'0000-00-00\')
409 WHERE a.uid = {?}
410 ORDER BY rm.last DESC', $this->id());
411 if (is_null($infos)) {
412 $infos = array(
413 'pending_registration_date' => null,
414 'pending_registration_email' => null,
415 'last_marketing_date' => null,
416 'last_marketing_email' => null
417 );
38c6fe96
FB
418 }
419 $this->fillFromArray($infos);
420 }
421
db8432d5 422 public function pendingRegistrationDate()
38c6fe96
FB
423 {
424 $this->fetchMarketingData();
db8432d5
SJ
425 return $this->pending_registration_date;
426 }
427
428 public function pendingRegistrationEmail()
429 {
430 $this->fetchMarketingData();
431 return $this->pending_registration_email;
432 }
433
434 public function lastMarketingDate()
435 {
436 $this->fetchMarketingData();
437 return $this->last_marketing_date;
438 }
439
440 public function lastMarketingEmail()
441 {
442 $this->fetchMarketingData();
443 return $this->last_marketing_email;
38c6fe96
FB
444 }
445
446 public function lastKnownEmail()
447 {
448 $this->fetchMarketingData();
db8432d5
SJ
449 if ($this->pending_registration_email > $this->last_marketing_date) {
450 return $this->pending_registration_email;
451 }
452 return $this->last_marketing_email;
38c6fe96
FB
453 }
454
009b8ab7 455
8d308ee4
FB
456 /** Format of the emails sent by the site
457 */
458 public function setEmailFormat($format)
459 {
460 Platal::assert($format == self::FORMAT_HTML || $format == self::FORMAT_TEXT,
461 "Invalid email format \"$format\"");
462 XDB::execute("UPDATE accounts
463 SET email_format = {?}
464 WHERE uid = {?}",
465 $format, $this->uid);
466 $this->email_format = $format;
467 }
468
009b8ab7
FB
469 /** Get watch informations
470 */
471 private function fetchWatchData()
472 {
473 if (isset($this->watch_actions)) {
474 return;
475 }
476 $watch = XDB::fetchOneAssoc('SELECT flags AS watch_flags, actions AS watch_actions,
477 UNIX_TIMESTAMP(last) AS watch_last
478 FROM watch
479 WHERE uid = {?}', $this->id());
480 $watch['watch_flags'] = new PlFlagSet($watch['watch_flags']);
481 $watch['watch_actions'] = new PlFlagSet($watch['watch_actions']);
482 $watch['watch_promos'] = XDB::fetchColumn('SELECT promo
483 FROM watch_promo
484 WHERE uid = {?}', $this->id());
485 $watch['watch_users'] = XDB::fetchColumn('SELECT ni_id
486 FROM watch_nonins
487 WHERE uid = {?}', $this->id());
488 $this->fillFromArray($watch);
489 }
490
a87530ea 491 public function watchType($type)
009b8ab7
FB
492 {
493 $this->fetchWatchData();
494 return $this->watch_actions->hasFlag($type);
495 }
496
497 public function watchContacts()
498 {
499 $this->fetchWatchData();
500 return $this->watch_flags->hasFlag('contacts');
501 }
502
503 public function watchEmail()
504 {
505 $this->fetchWatchData();
506 return $this->watch_flags->hasFlag('mail');
507 }
508
509 public function watchPromos()
510 {
511 $this->fetchWatchData();
512 return $this->watch_promos;
513 }
514
515 public function watchUsers()
516 {
517 $this->fetchWatchData();
518 return $this->watch_users;
519 }
520
521 public function watchLast()
522 {
523 $this->fetchWatchData();
524 return $this->watch_last;
525 }
526
069ddda8
FB
527 public function invalidWatchCache()
528 {
529 unset($this->watch_actions);
530 unset($this->watch_users);
531 unset($this->watch_last);
532 unset($this->watch_promos);
533 }
534
c350577b
FB
535
536 // Contacts
537 private $contacts = null;
48e683dd 538 private function fetchContacts()
c350577b 539 {
76cbe885 540 if (is_null($this->contacts)) {
c350577b
FB
541 $this->contacts = XDB::fetchAllAssoc('contact', 'SELECT *
542 FROM contacts
543 WHERE uid = {?}',
544 $this->id());
545 }
48e683dd
FB
546 }
547
548 public function iterContacts()
549 {
550 $this->fetchContacts();
a289e967 551 return Profile::iterOverPIDs(array_keys($this->contacts));
48e683dd
FB
552 }
553
554 public function getContacts()
555 {
556 $this->fetchContacts();
a289e967 557 return Profile::getBulkProfilesWithPIDs(array_keys($this->contacts));
48e683dd
FB
558 }
559
a289e967 560 public function isContact(Profile &$profile)
48e683dd
FB
561 {
562 $this->fetchContacts();
a289e967 563 return isset($this->contacts[$profile->id()]);
c350577b
FB
564 }
565
958def08
PC
566 public function isWatchedUser(Profile &$profile)
567 {
568 return in_array($profile->id(), $this->watchUsers());
569 }
570
f5ef8b57
RB
571 // Groupes X
572 private $groups = null;
573 public function groups()
574 {
575 if (is_null($this->groups)) {
576 $this->groups = XDB::fetchAllAssoc('asso_id', 'SELECT asso_id, perms, comm
185d4ea1 577 FROM group_members
f5ef8b57
RB
578 WHERE uid = {?}',
579 $this->id());
580 }
581 return $this->groups;
582 }
583
fa589f90
RB
584 public function groupNames($institutions = false)
585 {
586 if ($institutions) {
587 $where = ' AND (g.cat = \'GroupesX\' OR g.cat = \'Institutions\')';
588 } else {
589 $where = '';
590 }
591 return XDB::fetchAllAssoc('SELECT g.diminutif, g.nom, g.site
592 FROM group_members AS gm
593 LEFT JOIN groups AS g ON (g.id = gm.asso_id)
594 WHERE gm.uid = {?}' . $where,
595 $this->id());
596 }
597
6150f591
SJ
598 /**
599 * Clears a user.
600 * *always deletes in: account_lost_passwords, register_marketing,
601 * register_pending, register_subs, watch_nonins, watch, watch_promo
602 * *always keeps in: account_types, accounts, aliases, axletter_ins, carvas,
603 * group_members, homonyms, newsletter_ins, register_mstats,
604 * *deletes if $clearAll: account_auth_openid, announce_read, contacts,
605 * email_options, email_send_save, emails, forum_innd, forum_profiles,
606 * forum_subs, gapps_accounts, gapps_nicknames, group_announces_read,
607 * group_member_sub_requests, reminder, requests, requests_hidden,
608 * virtual, virtual_redirect, ML
609 * *modifies if $clearAll: accounts
610 *
611 * Use cases:
612 * *$clearAll == false: when a user dies, her family still needs to keep in
613 * touch with the community.
614 * *$clearAll == true: in every other case we want the account to be fully
615 * deleted so that it can not be used anymore.
616 */
617 public function clear($clearAll = true)
618 {
405d70cc
RB
619 $tables = array('account_lost_passwords', 'register_marketing',
620 'register_pending', 'register_subs', 'watch_nonins',
621 'watch', 'watch_promo');
622
623 foreach ($tables as $t) {
624 XDB::execute('DELETE FROM ' . $t . '
625 WHERE uid = {?}',
626 $this->id());
627 }
6150f591
SJ
628
629 if ($clearAll) {
c79e28fc
SJ
630 global $globals;
631
0e5b3438
SJ
632 $groupIds = XDB::iterator('SELECT asso_id
633 FROM group_members
634 WHERE uid = {?}',
635 $this->id());
636 while ($groupId = $groupIds->next()) {
637 $group = Group::get($groupId);
c79e28fc 638 if (!empty($group) && $group->notif_unsub) {
0e5b3438
SJ
639 $mailer = new PlMailer('xnetgrp/unsubscription-notif.mail.tpl');
640 $admins = $group->iterAdmins();
641 while ($admin = $admins->next()) {
642 $mailer->addTo($admin);
643 }
644 $mailer->assign('group', $group->shortname);
645 $mailer->assign('user', $this);
646 $mailer->assign('selfdone', false);
647 $mailer->send();
648 }
649 }
650
c79e28fc
SJ
651 $tables = array('account_auth_openid', 'announce_read', 'contacts',
652 'email_options', 'email_send_save', 'emails',
653 'forum_innd', 'forum_profiles', 'forum_subs',
654 'group_announces_read', 'group_members',
655 'group_member_sub_requests', 'reminder', 'requests',
405d70cc 656 'requests_hidden');
405d70cc
RB
657 foreach ($tables as $t) {
658 XDB::execute('DELETE FROM ' . $t . '
659 WHERE uid = {?}',
c79e28fc
SJ
660 $this->id());
661 }
662
663 foreach (array('gapps_accounts', 'gapps_nicknames') as $t) {
664 XDB::execute('DELETE FROM ' . $t . '
665 WHERE l_userid = {?}',
666 $this->id());
405d70cc
RB
667 }
668
6150f591
SJ
669 XDB::execute("UPDATE accounts
670 SET registration_date = 0, state = 'pending', password = NULL,
671 weak_password = NULL, token = NULL, is_admin = 0
672 WHERE uid = {?}",
673 $this->id());
674
675 XDB::execute('DELETE v.*
676 FROM virtual AS v
677 INNER JOIN virtual_redirect AS r ON (v.vid = r.vid)
678 WHERE redirect = {?} OR redirect = {?}',
679 $this->forlifeEmail(), $this->m4xForlifeEmail());
680 XDB::execute('DELETE FROM virtual_redirect
681 WHERE redirect = {?} OR redirect = {?}',
682 $this->forlifeEmail(), $this->m4xForlifeEmail());
683
684 if ($globals->mailstorage->googleapps_domain) {
685 require_once 'googleapps.inc.php';
686
c79e28fc
SJ
687 if (GoogleAppsAccount::account_status($this->id())) {
688 $account = new GoogleAppsAccount($this);
6150f591
SJ
689 $account->suspend();
690 }
691 }
692 }
693
694 $mmlist = new MMList($this);
a85562a0 695 $mmlist->kill($this->hruid, $clearAll);
6150f591
SJ
696 }
697
ab06182d
PC
698 // Merge all infos in other user and then clean this one
699 public function mergeIn(User &$newuser) {
33a4f3f9
SJ
700 if ($this->profile()) {
701 // Don't disable user with profile in this way.
702 global $globals;
703 Platal::page()->trigError('Impossible de fusionner les comptes ' . $this->hruid . ' et ' . $newuser->hruid .
704 '. Contacte support@' . $globals->mail->domain . '.');
ab06182d
PC
705 return false;
706 }
ab06182d 707
33a4f3f9
SJ
708 if ($this->forlifeEmail()) {
709 // If the new user is not registered and does not have already an email address,
710 // we need to give him the old user's email address if he has any.
711 if (!$newuser->perms) {
712 XDB::execute('UPDATE accounts
713 SET email = {?}
714 WHERE uid = {?} AND email IS NULL',
715 $this->forlifeEmail(), $newuser->id());
ab06182d 716 }
33a4f3f9
SJ
717 $newemail = XDB::fetchOneCell('SELECT email
718 FROM accounts
719 WHERE uid = {?}',
720 $newuser->id());
721
722 // Change email used in aliases and mailing lists.
723 if ($this->forlifeEmail() != $newemail) {
724 // virtual_redirect (email aliases)
725 XDB::execute('DELETE v1
726 FROM virtual_redirect AS v1, virtual_redirect AS v2
727 WHERE v1.vid = v2.vid AND v1.redirect = {?} AND v2.redirect = {?}',
728 $this->forlifeEmail(), $newemail);
729 XDB::execute('UPDATE virtual_redirect
730 SET redirect = {?}
731 WHERE redirect = {?}',
732 $newemail, $this->forlifeEmail());
733
734 // group mailing lists
735 $group_domains = XDB::fetchColumn('SELECT g.mail_domain
736 FROM groups AS g
737 INNER JOIN group_members AS gm ON(g.id = gm.asso_id)
738 WHERE g.mail_domain != \'\' AND gm.uid = {?}',
739 $this->id());
740 foreach ($group_domains as $mail_domain) {
741 $mmlist = new MMList($this, $mail_domain);
742 $mmlist->replace_email_in_all($this->forlifeEmail(), $newemail);
743 }
744 // main domain lists
745 $mmlist = new MMList($this);
746 $mmlist->replace_email_in_all($this->forlifeEmail(), $newemail);
747 }
748 }
749
750 // Updates user in following tables.
7f376ae0 751 foreach (array('group_announces', 'payment_transactions', 'log_sessions', 'group_events') as $table) {
33a4f3f9
SJ
752 XDB::execute('UPDATE ' . $table . '
753 SET uid = {?}
754 WHERE uid = {?}',
755 $newuser->id(), $this->id());
756 }
33a4f3f9
SJ
757
758 // Merges user in following tables, ie updates when possible, then deletes remaining occurences of the old user.
759 foreach (array('group_announces_read', 'group_event_participants', 'group_member_sub_requests', 'group_members') as $table) {
760 XDB::execute('UPDATE IGNORE ' . $table . '
761 SET uid = {?}
762 WHERE uid = {?}',
763 $newuser->id(), $this->id());
764 XDB::execute('DELETE FROM ' . $table . '
765 WHERE uid = {?}',
766 $this->id());
767 }
ab06182d 768
33a4f3f9
SJ
769 // Eventually updates last session id and deletes old user's accounts entry.
770 $lastSession = XDB::fetchOneCell('SELECT id
771 FROM log_sessions
772 WHERE uid = {?}
773 ORDER BY start DESC
774 LIMIT 1',
775 $newuser->id());
776 XDB::execute('UPDATE log_last_sessions
777 SET id = {?}
778 WHERE uid = {?}',
779 $newuser->id());
780 XDB::execute('DELETE FROM accounts
781 WHERE uid = {?}',
782 $this->id());
ab06182d
PC
783
784 return true;
785 }
786
50d5ec0b 787 // Return permission flags for a given permission level.
365ba8c3 788 public static function makePerms($perms, $is_admin)
50d5ec0b 789 {
365ba8c3 790 $flags = new PlFlagSet($perms);
50d5ec0b 791 $flags->addFlag(PERMS_USER);
365ba8c3 792 if ($is_admin) {
50d5ec0b
FB
793 $flags->addFlag(PERMS_ADMIN);
794 }
7fd6dbb3
FB
795
796 // Access to private directory implies access to 'less'-private version.
797 if ($flags->hasFlag('directory_private')) {
798 $flags->addFlag('directory_ax');
799 }
50d5ec0b
FB
800 return $flags;
801 }
802
b1719b13
VZ
803 // Implementation of the default user callback.
804 public static function _default_user_callback($login, $results)
805 {
b1719b13 806 $result_count = count($results);
dd70cd28 807 if ($result_count == 0 || !S::admin()) {
70232020 808 Platal::page()->trigError("Il n'y a pas d'utilisateur avec l'identifiant : $login");
b1719b13 809 } else {
70232020 810 Platal::page()->trigError("Il y a $result_count utilisateurs avec cet identifiant : " . join(', ', $results));
b1719b13
VZ
811 }
812 }
70232020
VZ
813
814 // Implementation of the static email locality checker.
815 public static function isForeignEmailAddress($email)
816 {
817 global $globals;
818 if (strpos($email, '@') === false) {
819 return false;
820 }
821
822 list($user, $dom) = explode('@', $email);
823 return $dom != $globals->mail->domain &&
824 $dom != $globals->mail->domain2 &&
825 $dom != $globals->mail->alias_dom &&
826 $dom != $globals->mail->alias_dom2;
827 }
832e6fcb 828
aa21c568
FB
829 public static function isVirtualEmailAddress($email)
830 {
831 global $globals;
832 if (strpos($email, '@') === false) {
833 return false;
834 }
835
836 list($user, $dom) = explode('@', $email);
837 return $dom == $globals->mail->alias_dom
838 || $dom == $globals->mail->alias_dom2;
839 }
840
61a7d279
SJ
841 /* Tries to find pending accounts with an hruid close to $login. */
842 public static function getPendingAccounts($login, $iterator = false)
843 {
844 global $globals;
845
846 if (strpos($login, '@') === false) {
847 return null;
848 }
849
850 list($login, $domain) = explode('@', $login);
851
852 if ($domain && $domain != $globals->mail->domain && $domain != $globals->mail->domain2) {
853 return null;
854 }
855
856 $sql = "SELECT uid, full_name
857 FROM accounts
858 WHERE state = 'pending' AND REPLACE(hruid, '-', '') LIKE
859 CONCAT('%', REPLACE(REPLACE(REPLACE({?}, ' ', ''), '-', ''), '\'', ''), '%')
860 ORDER BY full_name";
861 if ($iterator) {
862 return XDB::iterator($sql, $login);
863 } else {
864 $res = XDB::query($sql, $login);
865 return $res->fetchAllAssoc();
866 }
867 }
868
869
0d906109
RB
870 public static function iterOverUIDs($uids, $respect_order = true)
871 {
872 return new UserIterator(self::loadMainFieldsFromUIDs($uids, $respect_order));
873 }
874
875 /** Fetch a set of users from a list of UIDs
876 * @param $data The list of uids to fetch, or an array of arrays
877 * @param $orig If $data is an array of arrays, the subfield where uids are stored
878 * @param $dest If $data is an array of arrays, the subfield to fill with Users
879 * @param $fetchProfile Whether to fetch Profiles as well
880 * @return either an array of $uid => User, or $data with $data[$i][$dest] = User
881 */
b774ddab 882 public static function getBulkUsersWithUIDs(array $data, $orig = null, $dest = null, $fetchProfile = true)
832e6fcb 883 {
07eb5b0e
FB
884 // Fetch the list of uids
885 if (is_null($orig)) {
886 $uids = $data;
887 } else {
888 if (is_null($dest)) {
889 $dest = $orig;
890 }
891 $uids = array();
892 foreach ($data as $key=>$entry) {
893 if (isset($entry[$orig])) {
894 $uids[] = $entry[$orig];
895 }
896 }
897 }
898
899 // Fetch users
38c6fe96 900 if (count($uids) == 0) {
07eb5b0e 901 return $data;
38c6fe96 902 }
0d906109
RB
903 $users = self::iterOverUIDs($uids, true);
904
d865c296 905 $table = array();
b774ddab 906 if ($fetchProfile) {
0d906109 907 $profiles = Profile::iterOverUIDS($uids, true);
7a8da8e8
PC
908 if ($profiles != null) {
909 $profile = $profiles->next();
910 } else {
911 $profile = null;
912 }
b774ddab 913 }
0d906109
RB
914
915 /** We iterate through the users, moving in
916 * profiles when they match the user ID :
917 * there can be users without a profile, but not
918 * the other way around.
919 */
920 while (($user = $users->next())) {
b774ddab 921 if ($fetchProfile) {
7a8da8e8 922 if ($profile != null && $profile->owner_id == $user->id()) {
0d906109
RB
923 $user->_profile = $profile;
924 $profile = $profiles->next();
b774ddab
FB
925 }
926 $user->_profile_fetched = true;
927 }
0d906109 928 $table[$user->id()] = $user;
d865c296 929 }
07eb5b0e
FB
930
931 // Build the result with respect to input order.
932 if (is_null($orig)) {
0d906109 933 return $table;
07eb5b0e
FB
934 } else {
935 foreach ($data as $key=>$entry) {
936 if (isset($entry[$orig])) {
937 $entry[$dest] = $table[$entry[$orig]];
938 $data[$key] = $entry;
939 }
940 }
941 return $data;
832e6fcb 942 }
07eb5b0e
FB
943 }
944
b774ddab 945 public static function getBulkUsersFromDB($fetchProfile = true)
07eb5b0e
FB
946 {
947 $args = func_get_args();
948 $uids = call_user_func_array(array('XDB', 'fetchColumn'), $args);
b774ddab 949 return self::getBulkUsersWithUIDs($uids, null, null, $fetchProfile);
832e6fcb 950 }
9f8ebb9f
VZ
951}
952
0d906109
RB
953/** Iterator over a set of Users
954 * @param an XDB::Iterator obtained from a User::loadMainFieldsFromUIDs
955 */
956class UserIterator implements PlIterator
957{
958 private $dbiter;
959
960 public function __construct($dbiter)
961 {
962 $this->dbiter = $dbiter;
963 }
964
965 public function next()
966 {
967 $data = $this->dbiter->next();
968 if ($data == null) {
969 return null;
970 } else {
971 return User::getSilentWithValues(null, $data);
972 }
973 }
974
975 public function total()
976 {
977 return $this->dbiter->total();
978 }
979
980 public function first()
981 {
982 return $this->dbiter->first();
983 }
984
985 public function last()
986 {
987 return $this->dbiter->last();
988 }
989}
990
9f8ebb9f
VZ
991// vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
992?>