2 /***************************************************************************
3 * Copyright (C) 2003-2009 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 ***************************************************************************/
27 // {{{ interface UserFilterCondition
28 interface UserFilterCondition
30 const COND_TRUE
= 'TRUE';
31 const COND_FALSE
= 'FALSE';
33 /** Check that the given user matches the rule.
35 public function buildCondition(UserFilter
&$uf);
39 // {{{ class UFC_OneChild
40 abstract class UFC_OneChild
implements UserFilterCondition
44 public function __construct($child = null
)
46 if (!is_null($child) && ($child instanceof UserFilterCondition
)) {
47 $this->setChild($child);
51 public function setChild(UserFilterCondition
&$cond)
53 $this->child
=& $cond;
58 // {{{ class UFC_NChildren
59 abstract class UFC_NChildren
implements UserFilterCondition
61 protected $children = array();
63 public function __construct()
65 $children = func_get_args();
66 foreach ($children as &$child) {
67 if (!is_null($child) && ($child instanceof UserFilterCondition
)) {
68 $this->addChild($child);
73 public function addChild(UserFilterCondition
&$cond)
75 $this->children
[] =& $cond;
78 protected function catConds(array $cond, $op, $fallback)
80 if (count($cond) == 0) {
82 } else if (count($cond) == 1) {
85 return '(' . implode(') ' . $op . ' (', $cond) . ')';
92 class UFC_True
implements UserFilterCondition
94 public function buildCondition(UserFilter
&$uf)
96 return self
::COND_TRUE
;
101 // {{{ class UFC_False
102 class UFC_False
implements UserFilterCondition
104 public function buildCondition(UserFilter
&$uf)
106 return self
::COND_FALSE
;
112 class UFC_Not
extends UFC_OneChild
114 public function buildCondition(UserFilter
&$uf)
116 $val = $this->child
->buildCondition($uf);
117 if ($val == self
::COND_TRUE
) {
118 return self
::COND_FALSE
;
119 } else if ($val == self
::COND_FALSE
) {
120 return self
::COND_TRUE
;
122 return 'NOT (' . $val . ')';
129 class UFC_And
extends UFC_NChildren
131 public function buildCondition(UserFilter
&$uf)
133 if (empty($this->children
)) {
134 return self
::COND_FALSE
;
136 $true = self
::COND_FALSE
;
138 foreach ($this->children
as &$child) {
139 $val = $child->buildCondition($uf);
140 if ($val == self
::COND_TRUE
) {
141 $true = self
::COND_TRUE
;
142 } else if ($val == self
::COND_FALSE
) {
143 return self
::COND_FALSE
;
148 return $this->catConds($conds, 'AND', $true);
155 class UFC_Or
extends UFC_NChildren
157 public function buildCondition(UserFilter
&$uf)
159 if (empty($this->children
)) {
160 return self
::COND_TRUE
;
162 $true = self
::COND_TRUE
;
164 foreach ($this->children
as &$child) {
165 $val = $child->buildCondition($uf);
166 if ($val == self
::COND_TRUE
) {
167 return self
::COND_TRUE
;
168 } else if ($val == self
::COND_FALSE
) {
169 $true = self
::COND_FALSE
;
174 return $this->catConds($conds, 'OR', $true);
180 // {{{ class UFC_Profile
181 /** Filters users who have a profile
183 class UFC_Profile
implements UserFilterCondition
185 public function buildCondition(UserFilter
&$uf)
187 return '$PID IS NOT NULL';
192 // {{{ class UFC_Promo
193 /** Filters users based on promo
194 * @param $comparison Comparison operator (>, =, ...)
195 * @param $grade Formation on which to restrict, UserFilter::DISPLAY for "any formation"
196 * @param $promo Promo on which the filter is based
198 class UFC_Promo
implements UserFilterCondition
205 public function __construct($comparison, $grade, $promo)
207 $this->grade
= $grade;
208 $this->comparison
= $comparison;
209 $this->promo
= $promo;
210 if ($this->grade
!= UserFilter
::DISPLAY
) {
211 UserFilter
::assertGrade($this->grade
);
215 public function buildCondition(UserFilter
&$uf)
217 if ($this->grade
== UserFilter
::DISPLAY
) {
218 $sub = $uf->addDisplayFilter();
219 return XDB
::format('pd' . $sub . '.promo = {?}', $this->promo
);
221 $sub = $uf->addEducationFilter(true
, $this->grade
);
222 $field = 'pe' . $sub . '.' . UserFilter
::promoYear($this->grade
);
223 return $field . ' IS NOT NULL AND ' . $field . ' ' . $this->comparison
. ' ' . XDB
::format('{?}', $this->promo
);
229 // {{{ class UFC_Name
230 /** Filters users based on name
231 * @param $type Type of name field on which filtering is done (firstname, lastname, ...)
232 * @param $text Text on which to filter
233 * @param $mode flag indicating search type (prefix, suffix, with particule, ...)
235 class UFC_Name
implements UserFilterCondition
247 public function __construct($type, $text, $mode)
254 private function buildNameQuery($type, $variant, $where, UserFilter
&$uf)
256 $sub = $uf->addNameFilter($type, $variant);
257 return str_replace('$ME', 'pn' . $sub, $where);
260 public function buildCondition(UserFilter
&$uf)
264 if (($this->mode
& self
::PARTICLE
) == self
::PARTICLE
) {
265 $left = 'CONCAT($ME.particle, \' \', $ME.name)';
267 if (($this->mode
& self
::CONTAINS
) == 0) {
268 $right = XDB
::format('{?}', $this->text
);
270 } else if (($this->mode
& self
::CONTAINS
) == self
::PREFIX
) {
271 $right = XDB
::format('CONCAT({?}, \'%\')', $this->text
);
272 } else if (($this->mode
& self
::CONTAINS
) == self
::SUFFIX
) {
273 $right = XDB
::format('CONCAT(\'%\', {?})', $this->text
);
275 $right = XDB
::format('CONCAT(\'%\', {?}, \'%\')', $this->text
);
277 $cond = $left . $op . $right;
278 $conds = array($this->buildNameQuery($this->type
, null
, $cond, $uf));
279 if (($this->mode
& self
::VARIANTS
) != 0 && isset(UserFilter
::$name_variants[$this->type
])) {
280 foreach (UserFilter
::$name_variants[$this->type
] as $var) {
281 $conds[] = $this->buildNameQuery($this->type
, $var, $cond, $uf);
284 return implode(' OR ', $conds);
289 // {{{ class UFC_Dead
290 /** Filters users based on death date
291 * @param $comparison Comparison operator
292 * @param $date Date to which death date should be compared
294 class UFC_Dead
implements UserFilterCondition
299 public function __construct($comparison = null
, $date = null
)
301 $this->comparison
= $comparison;
305 public function buildCondition(UserFilter
&$uf)
307 $str = 'p.deathdate IS NOT NULL';
308 if (!is_null($this->comparison
)) {
309 $str .= ' AND p.deathdate ' . $this->comparison
. ' ' . XDB
::format('{?}', date('Y-m-d', $this->date
));
316 // {{{ class UFC_Registered
317 /** Filters users based on registration state
318 * @param $active Whether we want to use only "active" users (i.e with a valid redirection)
319 * @param $comparison Comparison operator
320 * @param $date Date to which users registration date should be compared
322 class UFC_Registered
implements UserFilterCondition
328 public function __construct($active = false
, $comparison = null
, $date = null
)
330 $this->only_active
= $active;
331 $this->comparison
= $comparison;
335 public function buildCondition(UserFilter
&$uf)
338 $date = 'a.uid IS NOT NULL AND a.state = \'active\'';
340 $date = 'a.uid IS NOT NULL AND a.state != \'pending\'';
342 if (!is_null($this->comparison
)) {
343 $date .= ' AND a.registration_date ' . $this->comparison
. ' ' . XDB
::format('{?}', date('Y-m-d', $this->date
));
350 // {{{ class UFC_ProfileUpdated
351 /** Filters users based on profile update date
352 * @param $comparison Comparison operator
353 * @param $date Date to which profile update date must be compared
355 class UFC_ProfileUpdated
implements UserFilterCondition
360 public function __construct($comparison = null
, $date = null
)
362 $this->comparison
= $comparison;
366 public function buildCondition(UserFilter
&$uf)
368 return 'p.last_change ' . $this->comparison
. XDB
::format(' {?}', date('Y-m-d H:i:s', $this->date
));
373 // {{{ class UFC_Birthday
374 /** Filters users based on next birthday date
375 * @param $comparison Comparison operator
376 * @param $date Date to which users next birthday date should be compared
378 class UFC_Birthday
implements UserFilterCondition
383 public function __construct($comparison = null
, $date = null
)
385 $this->comparison
= $comparison;
389 public function buildCondition(UserFilter
&$uf)
391 return 'p.next_birthday ' . $this->comparison
. XDB
::format(' {?}', date('Y-m-d', $this->date
));
397 /** Filters users based on sex
398 * @parm $sex One of User::GENDER_MALE or User::GENDER_FEMALE, for selecting users
400 class UFC_Sex
implements UserFilterCondition
403 public function __construct($sex)
408 public function buildCondition(UserFilter
&$uf)
410 if ($this->sex
!= User
::GENDER_MALE
&& $this->sex
!= User
::GENDER_FEMALE
) {
411 return self
::COND_FALSE
;
413 return XDB
::format('p.sex = {?}', $this->sex
== User
::GENDER_FEMALE ?
'female' : 'male');
419 // {{{ class UFC_Group
420 /** Filters users based on group membership
421 * @param $group Group whose member we are selecting
422 * @param $admin Whether to restrict selection to admins of that group
424 class UFC_Group
implements UserFilterCondition
428 public function __construct($group, $admin = false
)
430 $this->group
= $group;
431 $this->admin
= $admin;
434 public function buildCondition(UserFilter
&$uf)
436 $sub = $uf->addGroupFilter($this->group
);
437 $where = 'gpm' . $sub . '.perms IS NOT NULL';
439 $where .= ' AND gpm' . $sub . '.perms = \'admin\'';
446 // {{{ class UFC_Email
447 /** Filters users based on email address
448 * @param $email Email whose owner we are looking for
450 class UFC_Email
implements UserFilterCondition
453 public function __construct($email)
455 $this->email
= $email;
458 public function buildCondition(UserFilter
&$uf)
460 if (User
::isForeignEmailAddress($this->email
)) {
461 $sub = $uf->addEmailRedirectFilter($this->email
);
462 return XDB
::format('e' . $sub . '.email IS NOT NULL OR a.email = {?}', $this->email
);
463 } else if (User
::isVirtualEmailAddress($this->email
)) {
464 $sub = $uf->addVirtualEmailFilter($this->email
);
465 return 'vr' . $sub . '.redirect IS NOT NULL';
467 @list
($user, $domain) = explode('@', $this->email
);
468 $sub = $uf->addAliasFilter($user);
469 return 'al' . $sub . '.alias IS NOT NULL';
475 // {{{ class UFC_EmailList
476 /** Filters users base on an email list
477 * @param $emails List of emails whose owner must be selected
479 class UFC_EmailList
implements UserFilterCondition
482 public function __construct($emails)
484 $this->emails
= $emails;
487 public function buildCondition(UserFilter
&$uf)
494 if (count($this->emails
) == 0) {
495 return UserFilterCondition
::COND_TRUE
;
498 foreach ($this->emails
as $entry) {
499 if (User
::isForeignEmailAddress($entry)) {
500 if (is_null($email)) {
501 $email = $uf->addEmailRedirectFilter();
503 $cond[] = XDB
::format('e' . $email . '.email = {?} OR a.email = {?}', $entry, $entry);
504 } else if (User
::isVirtualEmailAddress($entry)) {
505 if (is_null($virtual)) {
506 $virtual = $uf->addVirtualEmailFilter();
508 $cond[] = XDB
::format('vr' . $virtual . '.redirect IS NOT NULL AND v' . $virtual . '.alias = {?}', $entry);
510 if (is_null($alias)) {
511 $alias = $uf->addAliasFilter();
513 @list
($user, $domain) = explode('@', $entry);
514 $cond[] = XDB
::format('al' . $alias . '.alias = {?}', $user);
517 return '(' . implode(') OR (', $cond) . ')';
522 // {{{ class UFC_Address
523 /** Filters users based on their address
524 * @param $field Field of the address used for filtering (city, street, ...)
525 * @param $text Text for filter
526 * @param $mode Mode for search (PREFIX, SUFFIX, ...)
528 class UFC_Address
implements UserFilterCondition
538 public function __construct($field, $text, $mode)
540 $this->field
= $field;
545 public function buildCondition(UserFilter
&$uf)
547 $left = 'pa.' . $field;
549 if (($this->mode
& self
::CONTAINS
) == 0) {
550 $right = XDB
::format('{?}', $this->text
);
552 } else if (($this->mode
& self
::CONTAINS
) == self
::PREFIX
) {
553 $right = XDB
::format('CONCAT({?}, \'%\')', $this->text
);
554 } else if (($this->mode
& self
::CONTAINS
) == self
::SUFFIX
) {
555 $right = XDB
::format('CONCAT(\'%\', {?})', $this->text
);
557 $right = XDB
::format('CONCAT(\'%\', {?}, \'%\')', $this->text
);
559 $cond = $left . $op . $right;
560 $uf->addAddressFilter();
566 // {{{ class UFC_Corps
567 /** Filters users based on the corps they belong to
568 * @param $corps Corps we are looking for (abbreviation)
569 * @param $type Whether we search for original or current corps
571 class UFC_Corps
implements UserFilterCondition
579 public function __construct($corps, $type = self
::CURRENT
)
581 $this->corps
= $corps;
585 public function buildCondition(UserFilter
&$uf)
587 /** Tables shortcuts :
588 * pc for profile corps,
589 * pceo for profile_corps_enum - orginal
590 * pcec for profile_corps_enum - current
592 $sub = $uf->addCorpsFilter($this->type
);
593 $cond = $sub . '.abbreviation = ' . $corps;
599 // {{{ class UFC_Corps_Rank
600 /** Filters users based on their rank in the corps
601 * @param $rank Rank we are looking for (abbreviation)
603 class UFC_Corps_Rank
implements UserFilterCondition
606 public function __construct($rank)
611 public function buildCondition(UserFilter
&$uf)
613 /** Tables shortcuts :
614 * pcr for profile_corps_rank
616 $sub = $uf->addCorpsRankFilter();
617 $cond = $sub . '.abbreviation = ' . $rank;
623 // {{{ class UFC_Job_Company
624 /** Filters users based on the company they belong to
625 * @param $type The field being searched (self::JOBID, self::JOBNAME or self::JOBACRONYM)
626 * @param $value The searched value
628 class UFC_Job_Company
extends UserFilterCondition
631 const JOBNAME
= 'name';
632 const JOBACRONYM
= 'acronym';
637 public function __construct($type, $value)
639 $this->assertType($type);
641 $this->value
= $value;
644 private function assertType($type)
646 if ($type != self
::JOBID
&& $type != self
::JOBNAME
&& $type != self
::JOBACRONYM
) {
647 Platal
::page()->killError("Type de recherche non valide");
651 public function buildCondition(UserFilter
&$uf)
653 $sub = $uf->addJobCompanyFilter();
654 $cond = $sub . '.' . $this->type
. ' = ' . XDB
::format('{?}', $this->value
);
660 // {{{ class UFC_Job_Sectorization
661 /** Filters users based on the ((sub)sub)sector they work in
662 * @param $sector The sector searched
663 * @param $subsector The subsector
664 * @param $subsubsector The subsubsector
666 class UFC_Job_Sectorization
extends UserFilterCondition
671 private $subsubsector;
673 public function __construct($sector = null
, $subsector = null
, $subsubsector = null
)
675 $this->sector
= $sector;
676 $this->subsector
= $subsector;
677 $this->subsubsector
= $subsubsector;
680 public function buildCondition(UserFilter
&$uf)
682 // No need to add the JobFilter, it will be done by addJobSectorizationFilter
684 if ($this->sector
!== null
) {
685 $sub = $uf->addJobSectorizationFilter(UserFilter
::JOB_SECTOR
);
686 $conds[] = $sub . '.id = ' . XDB
::format('{?}', $this->sector
);
688 if ($this->subsector
!== null
) {
689 $sub = $uf->addJobSectorizationFilter(UserFilter
::JOB_SUBSECTOR
);
690 $conds[] = $sub . '.id = ' . XDB
::format('{?}', $this->subsector
);
692 if ($this->subsubsector
!== null
) {
693 $sub = $uf->addJobSectorizationFilter(UserFilter
::JOB_SUBSUBSECTOR
);
694 $conds[] = $sub . '.id = ' . XDB
::format('{?}', $this->subsubsector
);
696 return implode(' AND ', $conds);
701 // {{{ class UFC_Job_Description
702 /** Filters users based on their job description
703 * @param $description The text being searched for
704 * @param $fields The fields to search for (user-defined, ((sub|)sub|)sector)
706 class UFC_Job_Description
extends UserFilterCondition
710 * Built with binary OR on UserFilter::JOB_*
713 const SECTORIZATION
= 15;
715 private $description;
718 public function __construct($description)
720 $this->fields
= $fields;
721 $this->description
= $description;
724 public function buildCondition(UserFilter
&$uf)
727 if ($this->fields
& UserFilter
::JOB_USERDEFINED
) {
728 $sub = $uf->addJobFilter();
729 $conds[] = $sub . '.description LIKE ' . XDB
::format('CONCAT(\'%\', {?}, \'%\')', $this->description
);
731 if ($this->fields
& UserFilter
::JOB_SECTOR
) {
732 $sub = $uf->addJobSectorizationFilter(UserFilter
::JOB_SECTOR
);
733 $conds[] = $sub . '.name LIKE ' . XDB
::format('CONCAT(\'%\', {?}, \'%\')', $this->description
);
735 if ($this->fields
& UserFilter
::JOB_SUBSECTOR
) {
736 $sub = $uf->addJobSectorizationFilter(UserFilter
::JOB_SUBSECTOR
);
737 $conds[] = $sub . '.name LIKE ' . XDB
::format('CONCAT(\'%\', {?}, \'%\')', $this->description
);
739 if ($this->fields
& UserFilter
::JOB_SUBSUBSECTOR
) {
740 $sub = $uf->addJobSectorizationFilter(UserFilter
::JOB_SUBSUBSECTOR
);
741 $conds[] = $sub . '.name LIKE ' . XDB
::format('CONCAT(\'%\', {?}, \'%\')', $this->description
);
742 $sub = $uf->addJobSectorizationFilter(UserFilter
::JOB_ALTERNATES
);
743 $conds[] = $sub . '.name LIKE ' . XDB
::format('CONCAT(\'%\', {?}, \'%\')', $this->description
);
745 return implode(' OR ', $conds);
750 // {{{ class UFC_Networking
751 /** Filters users based on network identity (IRC, ...)
752 * @param $type Type of network (-1 for any)
753 * @param $value Value to search
755 class UFC_Networking
extends UserFilterCondition
760 public function __construct($type, $value)
763 $this->value
= $value;
766 public function buildCondition(UserFilter
&$uf)
768 $sub = $uf->addNetworkingFilter();
770 $conds[] = $sub . '.address = ' . XDB
::format('CONCAT(\'%\', {?}, \'%\')', $this->value
);
771 if ($this->type
!= -1) {
772 $conds[] = $sub . '.network_type = ' . XDB
::format('{?}', $this->type
);
774 return implode(' AND ', $conds);
779 // {{{ class UFC_UserRelated
780 /** Filters users based on a relation toward on user
781 * @param $user User to which searched users are related
783 abstract class UFC_UserRelated
implements UserFilterCondition
786 public function __construct(PlUser
&$user)
788 $this->user
=& $user;
793 // {{{ class UFC_Contact
794 /** Filters users who belongs to selected user's contacts
796 class UFC_Contact
extends UFC_UserRelated
798 public function buildCondition(UserFilter
&$uf)
800 $sub = $uf->addContactFilter($this->user
->id());
801 return 'c' . $sub . '.contact IS NOT NULL';
806 // {{{ class UFC_WatchRegistration
807 /** Filters users being watched by selected user
809 class UFC_WatchRegistration
extends UFC_UserRelated
811 public function buildCondition(UserFilter
&$uf)
813 if (!$this->user
->watch('registration')) {
814 return UserFilterCondition
::COND_FALSE
;
816 $uids = $this->user
->watchUsers();
817 if (count($uids) == 0) {
818 return UserFilterCondition
::COND_FALSE
;
820 return '$UID IN ' . XDB
::formatArray($uids);
826 // {{{ class UFC_WatchPromo
827 /** Filters users belonging to a promo watched by selected user
828 * @param $user Selected user (the one watching promo)
829 * @param $grade Formation the user is watching
831 class UFC_WatchPromo
extends UFC_UserRelated
834 public function __construct(PlUser
&$user, $grade = UserFilter
::GRADE_ING
)
836 parent
::__construct($user);
837 $this->grade
= $grade;
840 public function buildCondition(UserFilter
&$uf)
842 $promos = $this->user
->watchPromos();
843 if (count($promos) == 0) {
844 return UserFilterCondition
::COND_FALSE
;
846 $sube = $uf->addEducationFilter(true
, $this->grade
);
847 $field = 'pe' . $sube . '.' . UserFilter
::promoYear($this->grade
);
848 return $field . ' IN ' . XDB
::formatArray($promos);
854 // {{{ class UFC_WatchContact
855 /** Filters users watched by selected user
857 class UFC_WatchContact
extends UFC_Contact
859 public function buildCondition(UserFilter
&$uf)
861 if (!$this->user
->watchContacts()) {
862 return UserFilterCondition
::COND_FALSE
;
864 return parent
::buildCondition($uf);
874 // {{{ class UserFilterOrder
875 abstract class UserFilterOrder
877 protected $desc = false
;
878 public function __construct($desc = false
)
883 public function buildSort(UserFilter
&$uf)
885 $sel = $this->getSortTokens($uf);
886 if (!is_array($sel)) {
890 foreach ($sel as $k=>$s) {
891 $sel[$k] = $s . ' DESC';
897 abstract protected function getSortTokens(UserFilter
&$uf);
901 // {{{ class UFO_Promo
902 /** Orders users by promo
903 * @param $grade Formation whose promo users should be sorted by (restricts results to users of that formation)
904 * @param $desc Whether sort is descending
906 class UFO_Promo
extends UserFilterOrder
910 public function __construct($grade = null
, $desc = false
)
912 parent
::__construct($desc);
913 $this->grade
= $grade;
916 protected function getSortTokens(UserFilter
&$uf)
918 if (UserFilter
::isGrade($this->grade
)) {
919 $sub = $uf->addEducationFilter($this->grade
);
920 return 'pe' . $sub . '.' . UserFilter
::promoYear($this->grade
);
922 $sub = $uf->addDisplayFilter();
923 return 'pd' . $sub . '.promo';
929 // {{{ class UFO_Name
930 /** Sorts users by name
931 * @param $type Type of name on which to sort (firstname, ...)
932 * @param $variant Variant of that name to user (marital, ordinary, ...)
933 * @param $particle Set to true if particles should be included in the sorting order
934 * @param $desc If sort order should be descending
936 class UFO_Name
extends UserFilterOrder
942 public function __construct($type, $variant = null
, $particle = false
, $desc = false
)
944 parent
::__construct($desc);
946 $this->variant
= $variant;
947 $this->particle
= $particle;
950 protected function getSortTokens(UserFilter
&$uf)
952 if (UserFilter
::isDisplayName($this->type
)) {
953 $sub = $uf->addDisplayFilter();
954 return 'pd' . $sub . '.' . $this->type
;
956 $sub = $uf->addNameFilter($this->type
, $this->variant
);
957 if ($this->particle
) {
958 return 'CONCAT(pn' . $sub . '.particle, \' \', pn' . $sub . '.name)';
960 return 'pn' . $sub . '.name';
967 // {{{ class UFO_Registration
968 /** Sorts users based on registration date
970 class UFO_Registration
extends UserFilterOrder
972 protected function getSortTokens(UserFilter
&$uf)
974 return 'a.registration_date';
979 // {{{ class UFO_Birthday
980 /** Sorts users based on next birthday date
982 class UFO_Birthday
extends UserFilterOrder
984 protected function getSortTokens(UserFilter
&$uf)
986 return 'p.next_birthday';
991 // {{{ class UFO_ProfileUpdate
992 /** Sorts users based on last profile update
994 class UFO_ProfileUpdate
extends UserFilterOrder
996 protected function getSortTokens(UserFilter
&$uf)
998 return 'p.last_change';
1003 // {{{ class UFO_Death
1004 /** Sorts users based on death date
1006 class UFO_Death
extends UserFilterOrder
1008 protected function getSortTokens(UserFilter
&$uf)
1010 return 'p.deathdate';
1016 /***********************************
1017 *********************************
1019 *********************************
1020 ***********************************/
1022 // {{{ class UserFilter
1025 static private $joinMethods = array();
1028 private $sort = array();
1029 private $query = null
;
1030 private $orderby = null
;
1032 private $lastcount = null
;
1034 public function __construct($cond = null
, $sort = null
)
1036 if (empty(self
::$joinMethods)) {
1037 $class = new ReflectionClass('UserFilter');
1038 foreach ($class->getMethods() as $method) {
1039 $name = $method->getName();
1040 if (substr($name, -5) == 'Joins' && $name != 'buildJoins') {
1041 self
::$joinMethods[] = $name;
1045 if (!is_null($cond)) {
1046 if ($cond instanceof UserFilterCondition
) {
1047 $this->setCondition($cond);
1050 if (!is_null($sort)) {
1051 if ($sort instanceof UserFilterOrder
) {
1052 $this->addSort($sort);
1053 } else if (is_array($sort)) {
1054 foreach ($sort as $s) {
1061 private function buildQuery()
1063 if (is_null($this->orderby
)) {
1065 foreach ($this->sort
as $sort) {
1066 $orders = array_merge($orders, $sort->buildSort($this));
1068 if (count($orders) == 0) {
1069 $this->orderby
= '';
1071 $this->orderby
= 'ORDER BY ' . implode(', ', $orders);
1074 if (is_null($this->query
)) {
1075 $where = $this->root
->buildCondition($this);
1076 $joins = $this->buildJoins();
1077 $this->query
= 'FROM accounts AS a
1078 LEFT JOIN account_profiles AS ap ON (ap.uid = a.uid AND FIND_IN_SET(\'owner\', ap.perms))
1079 LEFT JOIN profiles AS p ON (p.pid = ap.pid)
1081 WHERE (' . $where . ')';
1085 private function formatJoin(array $joins)
1088 foreach ($joins as $key => $infos) {
1091 if ($mode == 'inner') {
1092 $str .= 'INNER JOIN ';
1093 } else if ($mode == 'left') {
1094 $str .= 'LEFT JOIN ';
1096 Platal
::page()->kill("Join mode error");
1098 $str .= $table . ' AS ' . $key;
1099 if (isset($infos[2])) {
1100 $str .= ' ON (' . str_replace(array('$ME', '$PID', '$UID'), array($key, 'p.pid', 'a.uid'), $infos[2]) . ')';
1107 private function buildJoins()
1110 foreach (self
::$joinMethods as $method) {
1111 $joins = array_merge($joins, $this->$method());
1113 return $this->formatJoin($joins);
1116 private function getUIDList($uids = null
, $count = null
, $offset = null
)
1118 $this->buildQuery();
1120 if (!is_null($count)) {
1121 if (!is_null($offset)) {
1122 $limit = XDB
::format('LIMIT {?}, {?}', (int)$offset, (int)$count);
1124 $limit = XDB
::format('LIMIT {?}', (int)$count);
1128 if (!is_null($uids)) {
1129 $cond = ' AND a.uid IN ' . XDB
::formatArray($uids);
1131 $fetched = XDB
::fetchColumn('SELECT SQL_CALC_FOUND_ROWS a.uid
1132 ' . $this->query
. $cond . '
1134 ' . $this->orderby
. '
1136 $this->lastcount
= (int)XDB
::fetchOneCell('SELECT FOUND_ROWS()');
1140 /** Check that the user match the given rule.
1142 public function checkUser(PlUser
&$user)
1144 $this->buildQuery();
1145 $count = (int)XDB
::fetchOneCell('SELECT COUNT(*)
1146 ' . $this->query
. XDB
::format(' AND a.uid = {?}', $user->id()));
1150 /** Filter a list of user to extract the users matching the rule.
1152 public function filter(array $users, $count = null
, $offset = null
)
1154 $this->buildQuery();
1157 foreach ($users as $user) {
1158 if ($user instanceof PlUser
) {
1164 $table[$uid] = $user;
1166 $fetched = $this->getUIDList($uids, $count, $offset);
1168 foreach ($fetched as $uid) {
1169 $output[] = $table[$uid];
1174 public function getUIDs($count = null
, $offset = null
)
1176 return $this->getUIDList(null
, $count, $offset);
1179 public function getUsers($count = null
, $offset = null
)
1181 return User
::getBulkUsersWithUIDs($this->getUIDs($count, $offset));
1184 public function getTotalCount()
1186 if (is_null($this->lastcount
)) {
1187 $this->buildQuery();
1188 return (int)XDB
::fetchOneCell('SELECT COUNT(DISTINCT a.uid)
1191 return $this->lastcount
;
1195 public function setCondition(UserFilterCondition
&$cond)
1197 $this->root
=& $cond;
1198 $this->query
= null
;
1201 public function addSort(UserFilterOrder
&$sort)
1203 $this->sort
[] = $sort;
1204 $this->orderby
= null
;
1207 static public function getLegacy($promo_min, $promo_max)
1209 if ($promo_min != 0) {
1210 $min = new UFC_Promo('>=', self
::GRADE_ING
, intval($promo_min));
1212 $min = new UFC_True();
1214 if ($promo_max != 0) {
1215 $max = new UFC_Promo('<=', self
::GRADE_ING
, intval($promo_max));
1217 $max = new UFC_True();
1219 return new UserFilter(new UFC_And($min, $max));
1222 static public function sortByName()
1224 return array(new UFO_Name(self
::LASTNAME
), new UFO_Name(self
::FIRSTNAME
));
1227 static public function sortByPromo()
1229 return array(new UFO_Promo(), new UFO_Name(self
::LASTNAME
), new UFO_Name(self
::FIRSTNAME
));
1232 static private function getDBSuffix($string)
1234 return preg_replace('/[^a-z0-9]/i', '', $string);
1238 private $option = 0;
1239 private function register_optional(array &$table, $val)
1241 if (is_null($val)) {
1242 $sub = $this->option++
;
1245 $sub = self
::getDBSuffix($val);
1249 $table[$sub] = $index;
1255 const DISPLAY
= 'display';
1256 private $pd = false
;
1257 public function addDisplayFilter()
1263 private function displayJoins()
1266 return array('pd' => array('left', 'profile_display', '$ME.pid = $PID'));
1275 const LASTNAME
= 'lastname';
1276 const FIRSTNAME
= 'firstname';
1277 const NICKNAME
= 'nickname';
1278 const PSEUDONYM
= 'pseudonym';
1279 const NAME
= 'name';
1281 const VN_MARITAL
= 'marital';
1282 const VN_ORDINARY
= 'ordinary';
1283 const VN_OTHER
= 'other';
1284 const VN_INI
= 'ini';
1286 const DN_FULL
= 'directory_name';
1287 const DN_DISPLAY
= 'yourself';
1288 const DN_YOURSELF
= 'yourself';
1289 const DN_DIRECTORY
= 'directory_name';
1290 const DN_PRIVATE
= 'private_name';
1291 const DN_PUBLIC
= 'public_name';
1292 const DN_SHORT
= 'short_name';
1293 const DN_SORT
= 'sort_name';
1295 static public $name_variants = array(
1296 self
::LASTNAME
=> array(self
::VN_MARITAL
, self
::VN_ORDINARY
),
1297 self
::FIRSTNAME
=> array(self
::VN_ORDINARY
, self
::VN_INI
, self
::VN_OTHER
)
1300 static public function assertName($name)
1302 if (!Profile
::getNameTypeId($name)) {
1303 Platal
::page()->kill('Invalid name type');
1307 static public function isDisplayName($name)
1309 return $name == self
::DN_FULL ||
$name == self
::DN_DISPLAY
1310 ||
$name == self
::DN_YOURSELF ||
$name == self
::DN_DIRECTORY
1311 ||
$name == self
::DN_PRIVATE ||
$name == self
::DN_PUBLIC
1312 ||
$name == self
::DN_SHORT ||
$name == self
::DN_SORT
;
1315 private $pn = array();
1316 public function addNameFilter($type, $variant = null
)
1318 if (!is_null($variant)) {
1319 $ft = $type . '_' . $variant;
1324 self
::assertName($ft);
1326 if (!is_null($variant) && $variant == 'other') {
1327 $sub .= $this->option++
;
1329 $this->pn
[$sub] = Profile
::getNameTypeId($ft);
1333 private function nameJoins()
1336 foreach ($this->pn
as $sub => $type) {
1337 $joins['pn' . $sub] = array('left', 'profile_name', '$ME.pid = $PID AND $ME.typeid = ' . $type);
1345 const GRADE_ING
= 'Ing.';
1346 const GRADE_PHD
= 'PhD';
1347 const GRADE_MST
= 'M%';
1348 static public function isGrade($grade)
1350 return $grade == self
::GRADE_ING ||
$grade == self
::GRADE_PHD ||
$grade == self
::GRADE_MST
;
1353 static public function assertGrade($grade)
1355 if (!self
::isGrade($grade)) {
1356 Platal
::page()->killError("Diplôme non valide");
1360 static public function promoYear($grade)
1362 // XXX: Definition of promotion for phds and masters might change in near future.
1363 return ($grade == UserFilter
::GRADE_ING
) ?
'entry_year' : 'grad_year';
1366 private $pepe = array();
1367 private $with_pee = false
;
1368 public function addEducationFilter($x = false
, $grade = null
)
1371 $index = $this->option
;
1372 $sub = $this->option++
;
1374 self
::assertGrade($grade);
1377 $this->with_pee
= true
;
1380 $this->pepe
[$index] = $sub;
1384 private function educationJoins()
1387 if ($this->with_pee
) {
1388 $joins['pee'] = array('inner', 'profile_education_enum', 'pee.abbreviation = \'X\'');
1390 foreach ($this->pepe
as $grade => $sub) {
1391 if ($this->isGrade($grade)) {
1392 $joins['pe' . $sub] = array('left', 'profile_education', '$ME.eduid = pee.id AND $ME.uid = $PID');
1393 $joins['pede' . $sub] = array('inner', 'profile_education_degree_enum', '$ME.id = pe' . $sub . '.degreeid AND $ME.abbreviation LIKE ' .
1394 XDB
::format('{?}', $grade));
1396 $joins['pe' . $sub] = array('left', 'profile_education', '$ME.uid = $PID');
1397 $joins['pee' . $sub] = array('inner', 'profile_education_enum', '$ME.id = pe' . $sub . '.eduid');
1398 $joins['pede' . $sub] = array('inner', 'profile_education_degree_enum', '$ME.id = pe' . $sub . '.degreeid');
1407 private $gpm = array();
1408 public function addGroupFilter($group = null
)
1410 if (!is_null($group)) {
1411 if (ctype_digit($group)) {
1412 $index = $sub = $group;
1415 $sub = self
::getDBSuffix($group);
1418 $sub = 'group_' . $this->option++
;
1422 $this->gpm
[$sub] = $index;
1426 private function groupJoins()
1429 foreach ($this->gpm
as $sub => $key) {
1430 if (is_null($key)) {
1431 $joins['gpa' . $sub] = array('inner', 'groupex.asso');
1432 $joins['gpm' . $sub] = array('left', 'groupex.membres', '$ME.uid = $UID AND $ME.asso_id = gpa' . $sub . '.id');
1433 } else if (ctype_digit($key)) {
1434 $joins['gpm' . $sub] = array('left', 'groupex.membres', '$ME.uid = $UID AND $ME.asso_id = ' . $key);
1436 $joins['gpa' . $sub] = array('inner', 'groupex.asso', XDB
::format('$ME.diminutif = {?}', $key));
1437 $joins['gpm' . $sub] = array('left', 'groupex.membres', '$ME.uid = $UID AND $ME.asso_id = gpa' . $sub . '.id');
1445 private $e = array();
1446 public function addEmailRedirectFilter($email = null
)
1448 return $this->register_optional($this->e
, $email);
1451 private $ve = array();
1452 public function addVirtualEmailFilter($email = null
)
1454 $this->addAliasFilter(self
::ALIAS_FORLIFE
);
1455 return $this->register_optional($this->ve
, $email);
1458 const ALIAS_BEST
= 'bestalias';
1459 const ALIAS_FORLIFE
= 'forlife';
1460 private $al = array();
1461 public function addAliasFilter($alias = null
)
1463 return $this->register_optional($this->al
, $alias);
1466 private function emailJoins()
1470 foreach ($this->e
as $sub=>$key) {
1471 if (is_null($key)) {
1472 $joins['e' . $sub] = array('left', 'emails', '$ME.uid = $UID AND $ME.flags != \'filter\'');
1474 $joins['e' . $sub] = array('left', 'emails', XDB
::format('$ME.uid = $UID AND $ME.flags != \'filter\' AND $ME.email = {?}', $key));
1477 foreach ($this->al
as $sub=>$key) {
1478 if (is_null($key)) {
1479 $joins['al' . $sub] = array('left', 'aliases', '$ME.id = $UID AND $ME.type IN (\'alias\', \'a_vie\')');
1480 } else if ($key == self
::ALIAS_BEST
) {
1481 $joins['al' . $sub] = array('left', 'aliases', '$ME.id = $UID AND $ME.type IN (\'alias\', \'a_vie\') AND FIND_IN_SET(\'bestalias\', $ME.flags)');
1482 } else if ($key == self
::ALIAS_FORLIFE
) {
1483 $joins['al' . $sub] = array('left', 'aliases', '$ME.id = $UID AND $ME.type = \'a_vie\'');
1485 $joins['al' . $sub] = array('left', 'aliases', XDB
::format('$ME.id = $UID AND $ME.type IN (\'alias\', \'a_vie\') AND $ME.alias = {?}', $key));
1488 foreach ($this->ve
as $sub=>$key) {
1489 if (is_null($key)) {
1490 $joins['v' . $sub] = array('left', 'virtual', '$ME.type = \'user\'');
1492 $joins['v' . $sub] = array('left', 'virtual', XDB
::format('$ME.type = \'user\' AND $ME.alias = {?}', $key));
1494 $joins['vr' . $sub] = array('left', 'virtual_redirect', XDB
::format('$ME.vid = v' . $sub . '.vid
1495 AND ($ME.redirect IN (CONCAT(al_forlife.alias, \'@\', {?}),
1496 CONCAT(al_forlife.alias, \'@\', {?}),
1498 $globals->mail
->domain
, $globals->mail
->domain2
));
1506 private $pa = false
;
1507 public function addAddressFilter()
1512 private function addressJoins()
1516 $joins['pa'] = array('left', 'profile_address', '$ME.PID = $PID');
1525 private $pc = false
;
1526 private $pce = array();
1527 private $pcr = false
;
1528 public function addCorpsFilter($type)
1531 if ($type == UFC_Corps
::CURRENT
) {
1532 $pce['pcec'] = 'current_corpsid';
1534 } else if ($type == UFC_Corps
::ORIGIN
) {
1535 $pce['pceo'] = 'original_corpsid';
1540 public function addCorpsRankFilter()
1547 private function corpsJoins()
1551 $joins['pc'] = array('left', 'profile_corps', '$ME.uid = $UID');
1554 $joins['pcr'] = array('left', 'profile_corps_rank_enum', '$ME.id = pc.rankid');
1556 foreach($this->pce
as $sub => $field) {
1557 $joins[$sub] = array('left', 'profile_corps_enum', '$ME.id = pc.' . $field);
1565 const JOB_SECTOR
= 1;
1566 const JOB_SUBSECTOR
= 2;
1567 const JOB_SUBSUBSECTOR
= 4;
1568 const JOB_ALTERNATES
= 8;
1569 const JOB_USERDEFINED
= 16;
1573 * pje => profile_job_enum
1574 * pjse => profile_job_sector_enum
1575 * pjsse => profile_job_subsector_enum
1576 * pjssse => profile_job_subsubsector_enum
1577 * pja => profile_job_alternates
1579 private $with_pj = false
;
1580 private $with_pje = false
;
1581 private $with_pjse = false
;
1582 private $with_pjsse = false
;
1583 private $with_pjssse = false
;
1584 private $with_pja = false
;
1586 public function addJobFilter()
1588 $this->with_pj
= true
;
1592 public function addJobCompanyFilter()
1594 $this->addJobFilter();
1595 $this->with_pje
= true
;
1599 public function addJobSectorizationFilter($type)
1601 $this->addJobFilter();
1602 if ($type == self
::JOB_SECTOR
) {
1603 $this->with_pjse
= true
;
1605 } else if ($type == self
::JOB_SUBSECTOR
) {
1606 $this->with_pjsse
= true
;
1608 } else if ($type == self
::JOB_SUBSUBSECTOR
) {
1609 $this->with_pjssse
= true
;
1611 } else if ($type == self
::JOB_ALTERNATES
) {
1612 $this->with_pja
= true
;
1617 private function jobJoins()
1620 if ($this->with_pj
) {
1621 $joins['pj'] = array('left', 'profile_job', '$ME.uid = $UID');
1623 if ($this->with_pje
) {
1624 $joins['pje'] = array('left', 'profile_job_enum', '$ME.id = pj.jobid');
1626 if ($this->with_pjse
) {
1627 $joins['pjse'] = array('left', 'profile_job_sector_enum', '$ME.id = pj.sectorid');
1629 if ($this->with_pjsse
) {
1630 $joins['pjsse'] = array('left', 'profile_job_subsector_enum', '$ME.id = pj.subsectorid');
1632 if ($this->with_pjssse
) {
1633 $joins['pjssse'] = array('left', 'profile_job_subsubsector_enum', '$ME.id = pj.subsubsectorid');
1635 if ($this->with_pja
) {
1636 $joins['pja'] = array('left', 'profile_job_alternates', '$ME.subsubsectorid = pj.subsubsectorid');
1644 private $with_pnw = false
;
1645 public function addNetworkingFilter()
1647 $this->with_pnw
= true
;
1651 private function networkingJoins()
1654 if ($this->with_pnw
) {
1655 $joins['pnw'] = array('left', 'profile_networking', '$ME.uid = $UID');
1662 private $cts = array();
1663 public function addContactFilter($uid = null
)
1665 return $this->register_optional($this->cts
, is_null($uid) ? null
: 'user_' . $uid);
1668 private function contactJoins()
1671 foreach ($this->cts
as $sub=>$key) {
1672 if (is_null($key)) {
1673 $joins['c' . $sub] = array('left', 'contacts', '$ME.contact = $UID');
1675 $joins['c' . $sub] = array('left', 'contacts', XDB
::format('$ME.uid = {?} AND $ME.contact = $UID', substr($key, 5)));
1684 private $wn = array();
1685 public function addWatchRegistrationFilter($uid = null
)
1687 return $this->register_optional($this->wn
, is_null($uid) ? null
: 'user_' . $uid);
1690 private $wp = array();
1691 public function addWatchPromoFilter($uid = null
)
1693 return $this->register_optional($this->wp
, is_null($uid) ? null
: 'user_' . $uid);
1696 private $w = array();
1697 public function addWatchFilter($uid = null
)
1699 return $this->register_optional($this->w
, is_null($uid) ? null
: 'user_' . $uid);
1702 private function watchJoins()
1705 foreach ($this->w
as $sub=>$key) {
1706 if (is_null($key)) {
1707 $joins['w' . $sub] = array('left', 'watch');
1709 $joins['w' . $sub] = array('left', 'watch', XDB
::format('$ME.uid = {?}', substr($key, 5)));
1712 foreach ($this->wn
as $sub=>$key) {
1713 if (is_null($key)) {
1714 $joins['wn' . $sub] = array('left', 'watch_nonins', '$ME.ni_id = $UID');
1716 $joins['wn' . $sub] = array('left', 'watch_nonins', XDB
::format('$ME.uid = {?} AND $ME.ni_id = $UID', substr($key, 5)));
1719 foreach ($this->wn
as $sub=>$key) {
1720 if (is_null($key)) {
1721 $joins['wn' . $sub] = array('left', 'watch_nonins', '$ME.ni_id = $UID');
1723 $joins['wn' . $sub] = array('left', 'watch_nonins', XDB
::format('$ME.uid = {?} AND $ME.ni_id = $UID', substr($key, 5)));
1726 foreach ($this->wp
as $sub=>$key) {
1727 if (is_null($key)) {
1728 $joins['wp' . $sub] = array('left', 'watch_promo');
1730 $joins['wp' . $sub] = array('left', 'watch_promo', XDB
::format('$ME.uid = {?}', substr($key, 5)));
1738 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: