2 /***************************************************************************
3 * Copyright (C) 2003-2010 Polytechnique.org *
4 * http://opensource.polytechnique.org/ *
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. *
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. *
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 *
19 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA *
20 ***************************************************************************/
22 class User
extends PlUser
24 private $_profile_fetched = false
;
25 private $_profile = null
;
27 // Additional fields (non core)
28 protected $promo = null
;
30 // Implementation of the login to uid method.
31 protected function getLogin($login)
36 throw new UserNotFoundException();
39 if ($login instanceof User
) {
43 if ($login instanceof Profile
) {
44 $this->_profile
= $login;
45 $this->_profile_fetched
= true
;
46 $res = XDB
::query('SELECT ap.uid
47 FROM account_profiles AS ap
48 WHERE ap.pid = {?} AND FIND_IN_SET(\'owner\', perms)',
50 if ($res->numRows()) {
51 return $res->fetchOneCell();
53 throw new UserNotFoundException();
56 // If $data is an integer, fetches directly the result.
57 if (is_numeric($login)) {
58 $res = XDB
::query('SELECT a.uid
60 WHERE a.uid = {?}', $login);
61 if ($res->numRows()) {
62 return $res->fetchOneCell();
65 throw new UserNotFoundException();
68 // Checks whether $login is a valid hruid or not.
69 $res = XDB
::query('SELECT a.uid
71 WHERE a.hruid = {?}', $login);
72 if ($res->numRows()) {
73 return $res->fetchOneCell();
76 // From now, $login can only by an email alias, or an email redirection.
77 // If it doesn't look like a valid address, appends the plat/al's main domain.
78 $login = trim(strtolower($login));
79 if (strstr($login, '@') === false
) {
80 $login = $login . '@' . $globals->mail
->domain
;
83 // Checks if $login is a valid alias on the main domains.
84 list($mbox, $fqdn) = explode('@', $login);
85 if ($fqdn == $globals->mail
->domain ||
$fqdn == $globals->mail
->domain2
) {
86 $res = XDB
::query('SELECT a.uid
88 INNER JOIN aliases AS al ON (al.uid = a.uid AND al.type IN (\'alias\', \'a_vie\'))
89 WHERE al.alias = {?}', $mbox);
90 if ($res->numRows()) {
91 return $res->fetchOneCell();
94 /** TODO: implements this by inspecting the profile.
95 if (preg_match('/^(.*)\.([0-9]{4})$/u', $mbox, $matches)) {
96 $res = XDB::query('SELECT a.uid
98 INNER JOIN aliases AS al ON (al.id = a.uid AND al.type IN ('alias', 'a_vie'))
99 WHERE al.alias = {?} AND a.promo = {?}', $matches[1], $matches[2]);
100 if ($res->numRows() == 1) {
101 return $res->fetchOneCell();
105 throw new UserNotFoundException();
108 // Looks for $login as an email alias from the dedicated alias domain.
109 if ($fqdn == $globals->mail
->alias_dom ||
$fqdn == $globals->mail
->alias_dom2
) {
110 $res = XDB
::query("SELECT redirect
111 FROM virtual_redirect
112 INNER JOIN virtual USING(vid)
113 WHERE alias = {?}", $mbox . '@' . $globals->mail
->alias_dom
);
114 if ($redir = $res->fetchOneCell()) {
115 // We now have a valid alias, which has to be translated to an hruid.
116 list($alias, $alias_fqdn) = explode('@', $redir);
117 $res = XDB
::query("SELECT a.uid
119 LEFT JOIN aliases AS al ON (al.uid = a.uid AND al.type IN ('alias', 'a_vie'))
120 WHERE al.alias = {?}", $alias);
121 if ($res->numRows()) {
122 return $res->fetchOneCell();
126 throw new UserNotFoundException();
129 // Looks for an account with the given email.
130 $res = XDB
::query('SELECT a.uid
132 WHERE a.email = {?}', $login);
133 if ($res->numRows() == 1) {
134 return $res->fetchOneCell();
137 // Otherwise, we do suppose $login is an email redirection.
138 $res = XDB
::query("SELECT a.uid
140 LEFT JOIN emails AS e ON (e.uid = a.uid)
141 WHERE e.email = {?}", $login);
142 if ($res->numRows() == 1) {
143 return $res->fetchOneCell();
146 throw new UserNotFoundException($res->fetchColumn(1));
149 protected static function loadMainFieldsFromUIDs(array $uids, $respect_order = true
)
152 return PlIteratorUtils
::emptyIterator();
158 if ($globals->asso('id')) {
159 $joins .= XDB
::format("LEFT JOIN group_members AS gpm ON (gpm.uid = a.uid AND gpm.asso_id = {?})\n", $globals->asso('id'));
160 $fields[] = 'gpm.perms AS group_perms';
161 $fields[] = 'gpm.comm AS group_comm';
163 if (count($fields) > 0) {
164 $fields = ', ' . implode(', ', $fields);
169 if ($respect_order) {
170 $order = 'ORDER BY ' . XDB
::formatCustomOrder('a.uid', $uids);
175 $uids = array_map(array('XDB', 'escape'), $uids);
177 return XDB
::iterator('SELECT a.uid, a.hruid, a.registration_date, ah.alias AS homonym,
178 IF (af.alias IS NULL, a.email, CONCAT(af.alias, \'@' . $globals->mail
->domain
. '\')) AS forlife,
179 CONCAT(af.alias, \'@' . $globals->mail
->domain2
. '\') AS forlife_alternate,
180 IF (ab.alias IS NULL, a.email, CONCAT(ab.alias, \'@' . $globals->mail
->domain
. '\')) AS bestalias,
181 CONCAT(ab.alias, \'@' . $globals->mail
->domain2
. '\') AS bestalias_alternate,
182 a.full_name, a.display_name, a.sex = \'female\' AS gender,
183 IF(a.state = \'active\', at.perms, \'\') AS perms,
184 a.email_format, a.is_admin, a.state, a.type, a.skin,
185 FIND_IN_SET(\'watch\', a.flags) AS watch, a.comment,
186 a.weak_password IS NOT NULL AS weak_access,
187 a.token IS NOT NULL AS token_access,
188 (e.email IS NULL AND NOT FIND_IN_SET(\'googleapps\', eo.storage)) AND a.state != \'pending\' AS lost
191 INNER JOIN account_types AS at ON (at.type = a.type)
192 LEFT JOIN aliases AS af ON (af.uid = a.uid AND af.type = \'a_vie\')
193 LEFT JOIN aliases AS ab ON (ab.uid = a.uid AND FIND_IN_SET(\'bestalias\', ab.flags))
194 LEFT JOIN aliases AS ah ON (ah.uid = a.uid AND ah.type = \'homonyme\')
195 LEFT JOIN emails AS e ON (e.uid = a.uid AND e.flags = \'active\')
196 LEFT JOIN email_options AS eo ON (eo.uid = a.uid)
198 WHERE a.uid IN (' . implode(', ', $uids) . ')
203 // Implementation of the data loader.
204 protected function loadMainFields()
206 if ($this->hruid
!== null
&& $this->forlife
!== null
207 && $this->bestalias
!== null
&& $this->display_name
!== null
208 && $this->full_name
!== null
&& $this->perms
!== null
209 && $this->gender
!== null
&& $this->email_format
!== null
) {
212 $this->fillFromArray(self
::loadMainFieldsFromUIDs(array($this->uid
))->next());
215 // Specialization of the fillFromArray method, to implement hacks to enable
216 // lazy loading of user's main properties from the session.
217 // TODO(vzanotti): remove the conversion hacks once the old codebase will
218 // stop being used actively.
219 protected function fillFromArray(array $values)
221 // Also, if display_name and full_name are not known, but the user's
222 // surname and last name are, we can construct the former two.
223 if (isset($values['prenom']) && isset($values['nom'])) {
224 if (!isset($values['display_name'])) {
225 $values['display_name'] = ($values['prenom'] ?
$values['prenom'] : $values['nom']);
227 if (!isset($values['full_name'])) {
228 $values['full_name'] = $values['prenom'] . ' ' . $values['nom'];
232 // We also need to convert the gender (usually named "femme"), and the
233 // email format parameter (valued "texte" instead of "text").
234 if (isset($values['femme'])) {
235 $values['gender'] = (bool
) $values['femme'];
237 if (isset($values['mail_fmt'])) {
238 $values['email_format'] = $values['mail_fmt'];
241 parent
::fillFromArray($values);
244 // Specialization of the buildPerms method
245 // This function build 'generic' permissions for the user. It does not take
246 // into account page specific permissions (e.g X.net group permissions)
247 protected function buildPerms()
249 if (!is_null($this->perm_flags
)) {
252 if ($this->perms
=== null
) {
253 $this->loadMainFields();
255 $this->perm_flags
= self
::makePerms($this->perms
, $this->is_admin
);
258 // We do not want to store the password in the object.
259 // So, fetch it 'on demand'
260 public function password()
262 return XDB
::fetchOneCell('SELECT a.password
264 WHERE a.uid = {?}', $this->id());
267 public function isActive()
269 return $this->state
== 'active';
272 /** Overload PlUser::promo(): there no promo defined for a user in the current
273 * schema. The promo is a field from the profile.
275 public function promo()
277 if (!$this->hasProfile()) {
280 return $this->profile()->promo();
283 public function firstName()
285 if (!$this->hasProfile()) {
286 return $this->displayName();
288 return $this->profile()->firstName();
291 public function lastName()
293 if (!$this->hasProfile()) {
296 return $this->profile()->lastName();
299 public function fullName($with_promo = false
)
301 if (!$this->hasProfile()) {
302 return $this->full_name
;
304 return $this->profile()->fullName($with_promo);
307 public function directoryName()
309 if (!$this->hasProfile()) {
310 return $this->full_name
;
312 return $this->profile()->directory_name
;
315 /** Return the main profile attached with this account if any.
317 public function profile()
319 if (!$this->_profile_fetched
) {
320 $this->_profile_fetched
= true
;
321 $this->_profile
= Profile
::get($this);
323 return $this->_profile
;
326 /** Return true if the user has an associated profile.
328 public function hasProfile()
330 return !is_null($this->profile());
333 /** Check if the user can edit to given profile.
335 public function canEdit(Profile
$profile)
337 // XXX: Check permissions (e.g. secretary permission)
338 // and flags from the profile
339 return XDB
::fetchOneCell('SELECT pid
340 FROM account_profiles
341 WHERE uid = {?} AND pid = {?}',
342 $this->id(), $profile->id());
345 /** Get the email alias of the user.
347 public function emailAlias()
350 $data = $this->emailAliases($globals->mail
->alias_dom
);
351 if (count($data) > 0) {
352 return array_pop($data);
357 /** Get all the aliases the user belongs to.
359 public function emailAliases($domain = null
, $type = 'user', $sub_state = false
)
361 $join = XDB
::format('(vr.redirect = {?} OR vr.redirect = {?}) ',
362 $this->forlifeEmail(), $this->m4xForlifeEmail());
364 if (!is_null($domain)) {
365 $where = XDB
::format('WHERE v.alias LIKE CONCAT("%@", {?})', $domain);
367 if (!is_null($type)) {
369 $where = XDB
::format('WHERE v.type = {?}', $type);
371 $where .= XDB
::format(' AND v.type = {?}', $type);
375 return XDB
::fetchAllAssoc('alias', 'SELECT v.alias, vr.redirect IS NOT NULL AS sub
377 LEFT JOIN virtual_redirect AS vr ON (v.vid = vr.vid AND ' . $join . ')
380 return XDB
::fetchColumn('SELECT v.alias
382 INNER JOIN virtual_redirect AS vr ON (v.vid = vr.vid AND ' . $join . ')
387 /** Get the alternative forlife email
388 * TODO: remove this uber-ugly hack. The issue is that you need to remove
389 * all @m4x.org addresses in virtual_redirect first.
390 * XXX: This is juste to make code more readable, to be remove as soon as possible
392 public function m4xForlifeEmail()
395 trigger_error('USING M4X FORLIFE', E_USER_NOTICE
);
396 return $this->login() . '@' . $globals->mail
->domain2
;
400 /** Get marketing informations
402 private function fetchMarketingData()
404 if (isset($this->pending_registration_date
)) {
407 $infos = XDB
::fetchOneAssoc('SELECT rp.date AS pending_registration_date, rp.email AS pending_registration_email,
408 rm.last AS last_marketing_date, rm.email AS last_marketing_email
410 LEFT JOIN register_pending AS rp ON (rp.uid = a.uid)
411 LEFT JOIN register_marketing AS rm ON (rm.uid = a.uid AND rm.last != \'0000-00-00\')
413 ORDER BY rm.last DESC', $this->id());
414 if (is_null($infos)) {
416 'pending_registration_date' => null
,
417 'pending_registration_email' => null
,
418 'last_marketing_date' => null
,
419 'last_marketing_email' => null
422 $this->fillFromArray($infos);
425 public function pendingRegistrationDate()
427 $this->fetchMarketingData();
428 return $this->pending_registration_date
;
431 public function pendingRegistrationEmail()
433 $this->fetchMarketingData();
434 return $this->pending_registration_email
;
437 public function lastMarketingDate()
439 $this->fetchMarketingData();
440 return $this->last_marketing_date
;
443 public function lastMarketingEmail()
445 $this->fetchMarketingData();
446 return $this->last_marketing_email
;
449 public function lastKnownEmail()
451 $this->fetchMarketingData();
452 if ($this->pending_registration_email
> $this->last_marketing_date
) {
453 return $this->pending_registration_email
;
455 return $this->last_marketing_email
;
459 /** Format of the emails sent by the site
461 public function setEmailFormat($format)
463 Platal
::assert($format == self
::FORMAT_HTML ||
$format == self
::FORMAT_TEXT
,
464 "Invalid email format \"$format\"");
465 XDB
::execute("UPDATE accounts
466 SET email_format = {?}
468 $format, $this->uid
);
469 $this->email_format
= $format;
473 /** Get watch informations
475 private function fetchWatchData()
477 if (isset($this->watch_actions
)) {
480 $watch = XDB
::fetchOneAssoc('SELECT flags AS watch_flags, actions AS watch_actions,
481 UNIX_TIMESTAMP(last) AS watch_last
483 WHERE uid = {?}', $this->id());
484 $watch['watch_flags'] = new PlFlagSet($watch['watch_flags']);
485 $watch['watch_actions'] = new PlFlagSet($watch['watch_actions']);
486 $watch['watch_promos'] = XDB
::fetchColumn('SELECT promo
488 WHERE uid = {?}', $this->id());
489 $watch['watch_users'] = XDB
::fetchColumn('SELECT ni_id
491 WHERE uid = {?}', $this->id());
492 $this->fillFromArray($watch);
495 public function watchType($type)
497 $this->fetchWatchData();
498 return $this->watch_actions
->hasFlag($type);
501 public function watchContacts()
503 $this->fetchWatchData();
504 return $this->watch_flags
->hasFlag('contacts');
507 public function watchEmail()
509 $this->fetchWatchData();
510 return $this->watch_flags
->hasFlag('mail');
513 public function watchPromos()
515 $this->fetchWatchData();
516 return $this->watch_promos
;
519 public function watchUsers()
521 $this->fetchWatchData();
522 return $this->watch_users
;
525 public function watchLast()
527 $this->fetchWatchData();
528 return $this->watch_last
;
531 public function invalidWatchCache()
533 unset($this->watch_actions
);
534 unset($this->watch_users
);
535 unset($this->watch_last
);
536 unset($this->watch_promos
);
541 private $contacts = null
;
542 private function fetchContacts()
544 if (is_null($this->contacts
)) {
545 $this->contacts
= XDB
::fetchAllAssoc('contact', 'SELECT *
552 public function iterContacts()
554 $this->fetchContacts();
555 return Profile
::iterOverPIDs(array_keys($this->contacts
));
558 public function getContacts()
560 $this->fetchContacts();
561 return Profile
::getBulkProfilesWithPIDs(array_keys($this->contacts
));
564 public function isContact(Profile
&$profile)
566 $this->fetchContacts();
567 return isset($this->contacts
[$profile->id()]);
570 public function isWatchedUser(Profile
&$profile)
572 return in_array($profile->id(), $this->watchUsers());
576 private $groups = null
;
577 public function groups()
579 if (is_null($this->groups
)) {
580 $this->groups
= XDB
::fetchAllAssoc('asso_id', 'SELECT asso_id, perms, comm
585 return $this->groups
;
588 public function groupNames($institutions = false
)
591 $where = ' AND (g.cat = \'GroupesX\' OR g.cat = \'Institutions\')';
595 return XDB
::fetchAllAssoc('SELECT g.diminutif, g.nom, g.site
596 FROM group_members AS gm
597 LEFT JOIN groups AS g ON (g.id = gm.asso_id)
598 WHERE gm.uid = {?}' . $where,
604 * *always deletes in: account_lost_passwords, register_marketing,
605 * register_pending, register_subs, watch_nonins, watch, watch_promo
606 * *always keeps in: account_types, accounts, aliases, axletter_ins, carvas,
607 * group_members, homonyms, newsletter_ins, register_mstats,
608 * *deletes if $clearAll: account_auth_openid, announce_read, contacts,
609 * email_options, email_send_save, emails, forum_innd, forum_profiles,
610 * forum_subs, gapps_accounts, gapps_nicknames, group_announces_read,
611 * group_member_sub_requests, reminder, requests, requests_hidden,
612 * virtual, virtual_redirect, ML
613 * *modifies if $clearAll: accounts
616 * *$clearAll == false: when a user dies, her family still needs to keep in
617 * touch with the community.
618 * *$clearAll == true: in every other case we want the account to be fully
619 * deleted so that it can not be used anymore.
621 public function clear($clearAll = true
)
623 $tables = array('account_lost_passwords', 'register_marketing',
624 'register_pending', 'register_subs', 'watch_nonins',
625 'watch', 'watch_promo');
627 foreach ($tables as $t) {
628 XDB
::execute('DELETE FROM ' . $t . '
634 $groupIds = XDB
::iterator('SELECT asso_id
638 while ($groupId = $groupIds->next()) {
639 $group = Group
::get($groupId);
640 if ($group->notif_unsub
) {
641 $mailer = new PlMailer('xnetgrp/unsubscription-notif.mail.tpl');
642 $admins = $group->iterAdmins();
643 while ($admin = $admins->next()) {
644 $mailer->addTo($admin);
646 $mailer->assign('group', $group->shortname
);
647 $mailer->assign('user', $this);
648 $mailer->assign('selfdone', false
);
653 $tables = array('account_auth_openid', 'gannounce_read', 'contacts',
654 'email_options', 'gemail_send_save', 'emails',
655 'forum_innd', 'gforum_profiles', 'forum_subs',
656 'gapps_accounts', 'ggapps_nicknames', 'group_announces_read',
657 'group_members', 'ggroup_member_sub_requests', 'reminder', 'requests',
660 foreach ($tables as $t) {
661 XDB
::execute('DELETE FROM ' . $t . '
666 XDB
::execute("UPDATE accounts
667 SET registration_date = 0, state = 'pending', password = NULL,
668 weak_password = NULL, token = NULL, is_admin = 0
672 XDB
::execute('DELETE v.*
674 INNER JOIN virtual_redirect AS r ON (v.vid = r.vid)
675 WHERE redirect = {?} OR redirect = {?}',
676 $this->forlifeEmail(), $this->m4xForlifeEmail());
677 XDB
::execute('DELETE FROM virtual_redirect
678 WHERE redirect = {?} OR redirect = {?}',
679 $this->forlifeEmail(), $this->m4xForlifeEmail());
681 if ($globals->mailstorage
->googleapps_domain
) {
682 require_once 'googleapps.inc.php';
684 if (GoogleAppsAccount
::account_status($uid)) {
685 $account = new GoogleAppsAccount($user);
691 $mmlist = new MMList($this);
692 $mmlist->kill($alias, $clearAll);
695 // Merge all infos in other user and then clean this one
696 public function mergeIn(User
&$newuser) {
697 if ($this->profile() ||
!$newuser->id()) {
698 // don't disable user with profile in this way
701 // TODO check all tables to see if there is no other info to use
703 $newemail = $newuser->forlifeEmail();
704 if (!$newemail && $this->forlifeEmail()) {
705 XDB
::execute("UPDATE accounts
707 WHERE uid = {?} AND email IS NULL",
708 $this->forlifeEmail(), $newuser->id());
709 $newemail = $this->forlifeEmail();
712 // change email used in aliases and mailing lists
713 if ($this->forlifeEmail() != $newemail && $this->forlifeEmail()) {
714 // virtual_redirect (email aliases)
715 XDB
::execute("DELETE v1
716 FROM virtual_redirect AS v1, virtual_redirect AS v2
717 WHERE v1.vid = v2.vid AND v1.redirect = {?} AND v2.redirect = {?}",
718 $this->forlifeEmail(), $newemail);
719 XDB
::execute("UPDATE virtual_redirect
721 WHERE redirect = {?}",
722 $newemail, $this->forlifeEmail());
724 // require_once 'mmlist.php';
726 // group mailing lists
727 $group_domains = XDB
::fetchColumn("SELECT g.mail_domain
729 INNER JOIN group_members AS gm ON(g.id = gm.asso_id)
730 WHERE g.mail_domain != '' AND gm.uid = {?}",
732 foreach ($group_domains as $mail_domain) {
733 $mmlist = new MMList($this, $mail_domain);
734 $mmlist->replace_email_in_all($this->forlifeEmail(), $newmail);
737 $mmlist = new MMList($this);
738 $mmlist->replace_email_in_all($this->forlifeEmail(), $newmail);
741 // group_members (xnet group membership)
742 XDB
::execute("DELETE g1
743 FROM group_members AS g1, group_members AS g2
744 WHERE g1.uid = {?} AND g2.uid = {?} AND g1.asso_id = g2.asso_id",
745 $this->id(), $newuser->id());
746 XDB
::execute("UPDATE group_members
749 $this->id(), $newuser->id());
751 XDB
::execute("DELETE FROM accounts WHERE uid = {?}", $this->id());
756 // Return permission flags for a given permission level.
757 public static function makePerms($perms, $is_admin)
759 $flags = new PlFlagSet($perms);
760 $flags->addFlag(PERMS_USER
);
762 $flags->addFlag(PERMS_ADMIN
);
767 // Implementation of the default user callback.
768 public static function _default_user_callback($login, $results)
770 $result_count = count($results);
771 if ($result_count == 0 ||
!S
::admin()) {
772 Platal
::page()->trigError("Il n'y a pas d'utilisateur avec l'identifiant : $login");
774 Platal
::page()->trigError("Il y a $result_count utilisateurs avec cet identifiant : " . join(', ', $results));
778 // Implementation of the static email locality checker.
779 public static function isForeignEmailAddress($email)
782 if (strpos($email, '@') === false
) {
786 list($user, $dom) = explode('@', $email);
787 return $dom != $globals->mail
->domain
&&
788 $dom != $globals->mail
->domain2
&&
789 $dom != $globals->mail
->alias_dom
&&
790 $dom != $globals->mail
->alias_dom2
;
793 public static function isVirtualEmailAddress($email)
796 if (strpos($email, '@') === false
) {
800 list($user, $dom) = explode('@', $email);
801 return $dom == $globals->mail
->alias_dom
802 ||
$dom == $globals->mail
->alias_dom2
;
805 /* Tries to find pending accounts with an hruid close to $login. */
806 public static function getPendingAccounts($login, $iterator = false
)
810 if (strpos($login, '@') === false
) {
814 list($login, $domain) = explode('@', $login);
816 if ($domain && $domain != $globals->mail
->domain
&& $domain != $globals->mail
->domain2
) {
820 $sql = "SELECT uid, full_name
822 WHERE state = 'pending' AND REPLACE(hruid, '-', '') LIKE
823 CONCAT('%', REPLACE(REPLACE(REPLACE({?}, ' ', ''), '-', ''), '\'', ''), '%')
826 return XDB
::iterator($sql, $login);
828 $res = XDB
::query($sql, $login);
829 return $res->fetchAllAssoc();
834 public static function iterOverUIDs($uids, $respect_order = true
)
836 return new UserIterator(self
::loadMainFieldsFromUIDs($uids, $respect_order));
839 /** Fetch a set of users from a list of UIDs
840 * @param $data The list of uids to fetch, or an array of arrays
841 * @param $orig If $data is an array of arrays, the subfield where uids are stored
842 * @param $dest If $data is an array of arrays, the subfield to fill with Users
843 * @param $fetchProfile Whether to fetch Profiles as well
844 * @return either an array of $uid => User, or $data with $data[$i][$dest] = User
846 public static function getBulkUsersWithUIDs(array $data, $orig = null
, $dest = null
, $fetchProfile = true
)
848 // Fetch the list of uids
849 if (is_null($orig)) {
852 if (is_null($dest)) {
856 foreach ($data as $key=>$entry) {
857 if (isset($entry[$orig])) {
858 $uids[] = $entry[$orig];
864 if (count($uids) == 0) {
867 $users = self
::iterOverUIDs($uids, true
);
871 $profiles = Profile
::iterOverUIDS($uids, true
);
872 if ($profiles != null
) {
873 $profile = $profiles->next();
879 /** We iterate through the users, moving in
880 * profiles when they match the user ID :
881 * there can be users without a profile, but not
882 * the other way around.
884 while (($user = $users->next())) {
886 if ($profile != null
&& $profile->owner_id
== $user->id()) {
887 $user->_profile
= $profile;
888 $profile = $profiles->next();
890 $user->_profile_fetched
= true
;
892 $table[$user->id()] = $user;
895 // Build the result with respect to input order.
896 if (is_null($orig)) {
899 foreach ($data as $key=>$entry) {
900 if (isset($entry[$orig])) {
901 $entry[$dest] = $table[$entry[$orig]];
902 $data[$key] = $entry;
909 public static function getBulkUsersFromDB($fetchProfile = true
)
911 $args = func_get_args();
912 $uids = call_user_func_array(array('XDB', 'fetchColumn'), $args);
913 return self
::getBulkUsersWithUIDs($uids, null
, null
, $fetchProfile);
917 /** Iterator over a set of Users
918 * @param an XDB::Iterator obtained from a User::loadMainFieldsFromUIDs
920 class UserIterator
implements PlIterator
924 public function __construct($dbiter)
926 $this->dbiter
= $dbiter;
929 public function next()
931 $data = $this->dbiter
->next();
935 return User
::getSilentWithValues(null
, $data);
939 public function total()
941 return $this->dbiter
->total();
944 public function first()
946 return $this->dbiter
->first();
949 public function last()
951 return $this->dbiter
->last();
955 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: