972cffe66e0cb794f6d48129c450695e1e8674cf
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_UserRelated
751 /** Filters users based on a relation toward on user
752 * @param $user User to which searched users are related
754 abstract class UFC_UserRelated
implements UserFilterCondition
757 public function __construct(PlUser
&$user)
759 $this->user
=& $user;
764 // {{{ class UFC_Contact
765 /** Filters users who belongs to selected user's contacts
767 class UFC_Contact
extends UFC_UserRelated
769 public function buildCondition(UserFilter
&$uf)
771 $sub = $uf->addContactFilter($this->user
->id());
772 return 'c' . $sub . '.contact IS NOT NULL';
777 // {{{ class UFC_WatchRegistration
778 /** Filters users being watched by selected user
780 class UFC_WatchRegistration
extends UFC_UserRelated
782 public function buildCondition(UserFilter
&$uf)
784 if (!$this->user
->watch('registration')) {
785 return UserFilterCondition
::COND_FALSE
;
787 $uids = $this->user
->watchUsers();
788 if (count($uids) == 0) {
789 return UserFilterCondition
::COND_FALSE
;
791 return '$UID IN ' . XDB
::formatArray($uids);
797 // {{{ class UFC_WatchPromo
798 /** Filters users belonging to a promo watched by selected user
799 * @param $user Selected user (the one watching promo)
800 * @param $grade Formation the user is watching
802 class UFC_WatchPromo
extends UFC_UserRelated
805 public function __construct(PlUser
&$user, $grade = UserFilter
::GRADE_ING
)
807 parent
::__construct($user);
808 $this->grade
= $grade;
811 public function buildCondition(UserFilter
&$uf)
813 $promos = $this->user
->watchPromos();
814 if (count($promos) == 0) {
815 return UserFilterCondition
::COND_FALSE
;
817 $sube = $uf->addEducationFilter(true
, $this->grade
);
818 $field = 'pe' . $sube . '.' . UserFilter
::promoYear($this->grade
);
819 return $field . ' IN ' . XDB
::formatArray($promos);
825 // {{{ class UFC_WatchContact
826 /** Filters users watched by selected user
828 class UFC_WatchContact
extends UFC_Contact
830 public function buildCondition(UserFilter
&$uf)
832 if (!$this->user
->watchContacts()) {
833 return UserFilterCondition
::COND_FALSE
;
835 return parent
::buildCondition($uf);
845 // {{{ class UserFilterOrder
846 abstract class UserFilterOrder
848 protected $desc = false
;
849 public function __construct($desc = false
)
854 public function buildSort(UserFilter
&$uf)
856 $sel = $this->getSortTokens($uf);
857 if (!is_array($sel)) {
861 foreach ($sel as $k=>$s) {
862 $sel[$k] = $s . ' DESC';
868 abstract protected function getSortTokens(UserFilter
&$uf);
872 // {{{ class UFO_Promo
873 /** Orders users by promo
874 * @param $grade Formation whose promo users should be sorted by (restricts results to users of that formation)
875 * @param $desc Whether sort is descending
877 class UFO_Promo
extends UserFilterOrder
881 public function __construct($grade = null
, $desc = false
)
883 parent
::__construct($desc);
884 $this->grade
= $grade;
887 protected function getSortTokens(UserFilter
&$uf)
889 if (UserFilter
::isGrade($this->grade
)) {
890 $sub = $uf->addEducationFilter($this->grade
);
891 return 'pe' . $sub . '.' . UserFilter
::promoYear($this->grade
);
893 $sub = $uf->addDisplayFilter();
894 return 'pd' . $sub . '.promo';
900 // {{{ class UFO_Name
901 /** Sorts users by name
902 * @param $type Type of name on which to sort (firstname, ...)
903 * @param $variant Variant of that name to user (marital, ordinary, ...)
904 * @param $particle Set to true if particles should be included in the sorting order
905 * @param $desc If sort order should be descending
907 class UFO_Name
extends UserFilterOrder
913 public function __construct($type, $variant = null
, $particle = false
, $desc = false
)
915 parent
::__construct($desc);
917 $this->variant
= $variant;
918 $this->particle
= $particle;
921 protected function getSortTokens(UserFilter
&$uf)
923 if (UserFilter
::isDisplayName($this->type
)) {
924 $sub = $uf->addDisplayFilter();
925 return 'pd' . $sub . '.' . $this->type
;
927 $sub = $uf->addNameFilter($this->type
, $this->variant
);
928 if ($this->particle
) {
929 return 'CONCAT(pn' . $sub . '.particle, \' \', pn' . $sub . '.name)';
931 return 'pn' . $sub . '.name';
938 // {{{ class UFO_Registration
939 /** Sorts users based on registration date
941 class UFO_Registration
extends UserFilterOrder
943 protected function getSortTokens(UserFilter
&$uf)
945 return 'a.registration_date';
950 // {{{ class UFO_Birthday
951 /** Sorts users based on next birthday date
953 class UFO_Birthday
extends UserFilterOrder
955 protected function getSortTokens(UserFilter
&$uf)
957 return 'p.next_birthday';
962 // {{{ class UFO_ProfileUpdate
963 /** Sorts users based on last profile update
965 class UFO_ProfileUpdate
extends UserFilterOrder
967 protected function getSortTokens(UserFilter
&$uf)
969 return 'p.last_change';
974 // {{{ class UFO_Death
975 /** Sorts users based on death date
977 class UFO_Death
extends UserFilterOrder
979 protected function getSortTokens(UserFilter
&$uf)
981 return 'p.deathdate';
987 /***********************************
988 *********************************
990 *********************************
991 ***********************************/
993 // {{{ class UserFilter
996 static private $joinMethods = array();
999 private $sort = array();
1000 private $query = null
;
1001 private $orderby = null
;
1003 private $lastcount = null
;
1005 public function __construct($cond = null
, $sort = null
)
1007 if (empty(self
::$joinMethods)) {
1008 $class = new ReflectionClass('UserFilter');
1009 foreach ($class->getMethods() as $method) {
1010 $name = $method->getName();
1011 if (substr($name, -5) == 'Joins' && $name != 'buildJoins') {
1012 self
::$joinMethods[] = $name;
1016 if (!is_null($cond)) {
1017 if ($cond instanceof UserFilterCondition
) {
1018 $this->setCondition($cond);
1021 if (!is_null($sort)) {
1022 if ($sort instanceof UserFilterOrder
) {
1023 $this->addSort($sort);
1024 } else if (is_array($sort)) {
1025 foreach ($sort as $s) {
1032 private function buildQuery()
1034 if (is_null($this->orderby
)) {
1036 foreach ($this->sort
as $sort) {
1037 $orders = array_merge($orders, $sort->buildSort($this));
1039 if (count($orders) == 0) {
1040 $this->orderby
= '';
1042 $this->orderby
= 'ORDER BY ' . implode(', ', $orders);
1045 if (is_null($this->query
)) {
1046 $where = $this->root
->buildCondition($this);
1047 $joins = $this->buildJoins();
1048 $this->query
= 'FROM accounts AS a
1049 LEFT JOIN account_profiles AS ap ON (ap.uid = a.uid AND FIND_IN_SET(\'owner\', ap.perms))
1050 LEFT JOIN profiles AS p ON (p.pid = ap.pid)
1052 WHERE (' . $where . ')';
1056 private function formatJoin(array $joins)
1059 foreach ($joins as $key => $infos) {
1062 if ($mode == 'inner') {
1063 $str .= 'INNER JOIN ';
1064 } else if ($mode == 'left') {
1065 $str .= 'LEFT JOIN ';
1067 Platal
::page()->kill("Join mode error");
1069 $str .= $table . ' AS ' . $key;
1070 if (isset($infos[2])) {
1071 $str .= ' ON (' . str_replace(array('$ME', '$PID', '$UID'), array($key, 'p.pid', 'a.uid'), $infos[2]) . ')';
1078 private function buildJoins()
1081 foreach (self
::$joinMethods as $method) {
1082 $joins = array_merge($joins, $this->$method());
1084 return $this->formatJoin($joins);
1087 private function getUIDList($uids = null
, $count = null
, $offset = null
)
1089 $this->buildQuery();
1091 if (!is_null($count)) {
1092 if (!is_null($offset)) {
1093 $limit = XDB
::format('LIMIT {?}, {?}', (int)$offset, (int)$count);
1095 $limit = XDB
::format('LIMIT {?}', (int)$count);
1099 if (!is_null($uids)) {
1100 $cond = ' AND a.uid IN ' . XDB
::formatArray($uids);
1102 $fetched = XDB
::fetchColumn('SELECT SQL_CALC_FOUND_ROWS a.uid
1103 ' . $this->query
. $cond . '
1105 ' . $this->orderby
. '
1107 $this->lastcount
= (int)XDB
::fetchOneCell('SELECT FOUND_ROWS()');
1111 /** Check that the user match the given rule.
1113 public function checkUser(PlUser
&$user)
1115 $this->buildQuery();
1116 $count = (int)XDB
::fetchOneCell('SELECT COUNT(*)
1117 ' . $this->query
. XDB
::format(' AND a.uid = {?}', $user->id()));
1121 /** Filter a list of user to extract the users matching the rule.
1123 public function filter(array $users, $count = null
, $offset = null
)
1125 $this->buildQuery();
1128 foreach ($users as $user) {
1129 if ($user instanceof PlUser
) {
1135 $table[$uid] = $user;
1137 $fetched = $this->getUIDList($uids, $count, $offset);
1139 foreach ($fetched as $uid) {
1140 $output[] = $table[$uid];
1145 public function getUIDs($count = null
, $offset = null
)
1147 return $this->getUIDList(null
, $count, $offset);
1150 public function getUsers($count = null
, $offset = null
)
1152 return User
::getBulkUsersWithUIDs($this->getUIDs($count, $offset));
1155 public function getTotalCount()
1157 if (is_null($this->lastcount
)) {
1158 $this->buildQuery();
1159 return (int)XDB
::fetchOneCell('SELECT COUNT(DISTINCT a.uid)
1162 return $this->lastcount
;
1166 public function setCondition(UserFilterCondition
&$cond)
1168 $this->root
=& $cond;
1169 $this->query
= null
;
1172 public function addSort(UserFilterOrder
&$sort)
1174 $this->sort
[] = $sort;
1175 $this->orderby
= null
;
1178 static public function getLegacy($promo_min, $promo_max)
1180 if ($promo_min != 0) {
1181 $min = new UFC_Promo('>=', self
::GRADE_ING
, intval($promo_min));
1183 $min = new UFC_True();
1185 if ($promo_max != 0) {
1186 $max = new UFC_Promo('<=', self
::GRADE_ING
, intval($promo_max));
1188 $max = new UFC_True();
1190 return new UserFilter(new UFC_And($min, $max));
1193 static public function sortByName()
1195 return array(new UFO_Name(self
::LASTNAME
), new UFO_Name(self
::FIRSTNAME
));
1198 static public function sortByPromo()
1200 return array(new UFO_Promo(), new UFO_Name(self
::LASTNAME
), new UFO_Name(self
::FIRSTNAME
));
1203 static private function getDBSuffix($string)
1205 return preg_replace('/[^a-z0-9]/i', '', $string);
1209 private $option = 0;
1210 private function register_optional(array &$table, $val)
1212 if (is_null($val)) {
1213 $sub = $this->option++
;
1216 $sub = self
::getDBSuffix($val);
1220 $table[$sub] = $index;
1226 const DISPLAY
= 'display';
1227 private $pd = false
;
1228 public function addDisplayFilter()
1234 private function displayJoins()
1237 return array('pd' => array('left', 'profile_display', '$ME.pid = $PID'));
1246 const LASTNAME
= 'lastname';
1247 const FIRSTNAME
= 'firstname';
1248 const NICKNAME
= 'nickname';
1249 const PSEUDONYM
= 'pseudonym';
1250 const NAME
= 'name';
1252 const VN_MARITAL
= 'marital';
1253 const VN_ORDINARY
= 'ordinary';
1254 const VN_OTHER
= 'other';
1255 const VN_INI
= 'ini';
1257 const DN_FULL
= 'directory_name';
1258 const DN_DISPLAY
= 'yourself';
1259 const DN_YOURSELF
= 'yourself';
1260 const DN_DIRECTORY
= 'directory_name';
1261 const DN_PRIVATE
= 'private_name';
1262 const DN_PUBLIC
= 'public_name';
1263 const DN_SHORT
= 'short_name';
1264 const DN_SORT
= 'sort_name';
1266 static public $name_variants = array(
1267 self
::LASTNAME
=> array(self
::VN_MARITAL
, self
::VN_ORDINARY
),
1268 self
::FIRSTNAME
=> array(self
::VN_ORDINARY
, self
::VN_INI
, self
::VN_OTHER
)
1271 static public function assertName($name)
1273 if (!Profile
::getNameTypeId($name)) {
1274 Platal
::page()->kill('Invalid name type');
1278 static public function isDisplayName($name)
1280 return $name == self
::DN_FULL ||
$name == self
::DN_DISPLAY
1281 ||
$name == self
::DN_YOURSELF ||
$name == self
::DN_DIRECTORY
1282 ||
$name == self
::DN_PRIVATE ||
$name == self
::DN_PUBLIC
1283 ||
$name == self
::DN_SHORT ||
$name == self
::DN_SORT
;
1286 private $pn = array();
1287 public function addNameFilter($type, $variant = null
)
1289 if (!is_null($variant)) {
1290 $ft = $type . '_' . $variant;
1295 self
::assertName($ft);
1297 if (!is_null($variant) && $variant == 'other') {
1298 $sub .= $this->option++
;
1300 $this->pn
[$sub] = Profile
::getNameTypeId($ft);
1304 private function nameJoins()
1307 foreach ($this->pn
as $sub => $type) {
1308 $joins['pn' . $sub] = array('left', 'profile_name', '$ME.pid = $PID AND $ME.typeid = ' . $type);
1316 const GRADE_ING
= 'Ing.';
1317 const GRADE_PHD
= 'PhD';
1318 const GRADE_MST
= 'M%';
1319 static public function isGrade($grade)
1321 return $grade == self
::GRADE_ING ||
$grade == self
::GRADE_PHD ||
$grade == self
::GRADE_MST
;
1324 static public function assertGrade($grade)
1326 if (!self
::isGrade($grade)) {
1327 Platal
::page()->killError("Diplôme non valide");
1331 static public function promoYear($grade)
1333 // XXX: Definition of promotion for phds and masters might change in near future.
1334 return ($grade == UserFilter
::GRADE_ING
) ?
'entry_year' : 'grad_year';
1337 private $pepe = array();
1338 private $with_pee = false
;
1339 public function addEducationFilter($x = false
, $grade = null
)
1342 $index = $this->option
;
1343 $sub = $this->option++
;
1345 self
::assertGrade($grade);
1348 $this->with_pee
= true
;
1351 $this->pepe
[$index] = $sub;
1355 private function educationJoins()
1358 if ($this->with_pee
) {
1359 $joins['pee'] = array('inner', 'profile_education_enum', 'pee.abbreviation = \'X\'');
1361 foreach ($this->pepe
as $grade => $sub) {
1362 if ($this->isGrade($grade)) {
1363 $joins['pe' . $sub] = array('left', 'profile_education', '$ME.eduid = pee.id AND $ME.uid = $PID');
1364 $joins['pede' . $sub] = array('inner', 'profile_education_degree_enum', '$ME.id = pe' . $sub . '.degreeid AND $ME.abbreviation LIKE ' .
1365 XDB
::format('{?}', $grade));
1367 $joins['pe' . $sub] = array('left', 'profile_education', '$ME.uid = $PID');
1368 $joins['pee' . $sub] = array('inner', 'profile_education_enum', '$ME.id = pe' . $sub . '.eduid');
1369 $joins['pede' . $sub] = array('inner', 'profile_education_degree_enum', '$ME.id = pe' . $sub . '.degreeid');
1378 private $gpm = array();
1379 public function addGroupFilter($group = null
)
1381 if (!is_null($group)) {
1382 if (ctype_digit($group)) {
1383 $index = $sub = $group;
1386 $sub = self
::getDBSuffix($group);
1389 $sub = 'group_' . $this->option++
;
1393 $this->gpm
[$sub] = $index;
1397 private function groupJoins()
1400 foreach ($this->gpm
as $sub => $key) {
1401 if (is_null($key)) {
1402 $joins['gpa' . $sub] = array('inner', 'groupex.asso');
1403 $joins['gpm' . $sub] = array('left', 'groupex.membres', '$ME.uid = $UID AND $ME.asso_id = gpa' . $sub . '.id');
1404 } else if (ctype_digit($key)) {
1405 $joins['gpm' . $sub] = array('left', 'groupex.membres', '$ME.uid = $UID AND $ME.asso_id = ' . $key);
1407 $joins['gpa' . $sub] = array('inner', 'groupex.asso', XDB
::format('$ME.diminutif = {?}', $key));
1408 $joins['gpm' . $sub] = array('left', 'groupex.membres', '$ME.uid = $UID AND $ME.asso_id = gpa' . $sub . '.id');
1416 private $e = array();
1417 public function addEmailRedirectFilter($email = null
)
1419 return $this->register_optional($this->e
, $email);
1422 private $ve = array();
1423 public function addVirtualEmailFilter($email = null
)
1425 $this->addAliasFilter(self
::ALIAS_FORLIFE
);
1426 return $this->register_optional($this->ve
, $email);
1429 const ALIAS_BEST
= 'bestalias';
1430 const ALIAS_FORLIFE
= 'forlife';
1431 private $al = array();
1432 public function addAliasFilter($alias = null
)
1434 return $this->register_optional($this->al
, $alias);
1437 private function emailJoins()
1441 foreach ($this->e
as $sub=>$key) {
1442 if (is_null($key)) {
1443 $joins['e' . $sub] = array('left', 'emails', '$ME.uid = $UID AND $ME.flags != \'filter\'');
1445 $joins['e' . $sub] = array('left', 'emails', XDB
::format('$ME.uid = $UID AND $ME.flags != \'filter\' AND $ME.email = {?}', $key));
1448 foreach ($this->al
as $sub=>$key) {
1449 if (is_null($key)) {
1450 $joins['al' . $sub] = array('left', 'aliases', '$ME.id = $UID AND $ME.type IN (\'alias\', \'a_vie\')');
1451 } else if ($key == self
::ALIAS_BEST
) {
1452 $joins['al' . $sub] = array('left', 'aliases', '$ME.id = $UID AND $ME.type IN (\'alias\', \'a_vie\') AND FIND_IN_SET(\'bestalias\', $ME.flags)');
1453 } else if ($key == self
::ALIAS_FORLIFE
) {
1454 $joins['al' . $sub] = array('left', 'aliases', '$ME.id = $UID AND $ME.type = \'a_vie\'');
1456 $joins['al' . $sub] = array('left', 'aliases', XDB
::format('$ME.id = $UID AND $ME.type IN (\'alias\', \'a_vie\') AND $ME.alias = {?}', $key));
1459 foreach ($this->ve
as $sub=>$key) {
1460 if (is_null($key)) {
1461 $joins['v' . $sub] = array('left', 'virtual', '$ME.type = \'user\'');
1463 $joins['v' . $sub] = array('left', 'virtual', XDB
::format('$ME.type = \'user\' AND $ME.alias = {?}', $key));
1465 $joins['vr' . $sub] = array('left', 'virtual_redirect', XDB
::format('$ME.vid = v' . $sub . '.vid
1466 AND ($ME.redirect IN (CONCAT(al_forlife.alias, \'@\', {?}),
1467 CONCAT(al_forlife.alias, \'@\', {?}),
1469 $globals->mail
->domain
, $globals->mail
->domain2
));
1477 private $pa = false
;
1478 public function addAddressFilter()
1483 private function addressJoins()
1487 $joins['pa'] = array('left', 'profile_address', '$ME.PID = $PID');
1496 private $pc = false
;
1497 private $pce = array();
1498 private $pcr = false
;
1499 public function addCorpsFilter($type)
1502 if ($type == UFC_Corps
::CURRENT
) {
1503 $pce['pcec'] = 'current_corpsid';
1505 } else if ($type == UFC_Corps
::ORIGIN
) {
1506 $pce['pceo'] = 'original_corpsid';
1511 public function addCorpsRankFilter()
1518 private function corpsJoins()
1522 $joins['pc'] = array('left', 'profile_corps', '$ME.uid = $UID');
1525 $joins['pcr'] = array('left', 'profile_corps_rank_enum', '$ME.id = pc.rankid');
1527 foreach($this->pce
as $sub => $field) {
1528 $joins[$sub] = array('left', 'profile_corps_enum', '$ME.id = pc.' . $field);
1536 const JOB_SECTOR
= 1;
1537 const JOB_SUBSECTOR
= 2;
1538 const JOB_SUBSUBSECTOR
= 4;
1539 const JOB_ALTERNATES
= 8;
1540 const JOB_USERDEFINED
= 16;
1544 * pje => profile_job_enum
1545 * pjse => profile_job_sector_enum
1546 * pjsse => profile_job_subsector_enum
1547 * pjssse => profile_job_subsubsector_enum
1548 * pja => profile_job_alternates
1550 private $with_pj = false
;
1551 private $with_pje = false
;
1552 private $with_pjse = false
;
1553 private $with_pjsse = false
;
1554 private $with_pjssse = false
;
1555 private $with_pja = false
;
1557 public function addJobFilter()
1559 $this->with_pj
= true
;
1563 public function addJobCompanyFilter()
1565 $this->addJobFilter();
1566 $this->with_pje
= true
;
1570 public function addJobSectorizationFilter($type)
1572 $this->addJobFilter();
1573 if ($type == self
::JOB_SECTOR
) {
1574 $this->with_pjse
= true
;
1576 } else if ($type == self
::JOB_SUBSECTOR
) {
1577 $this->with_pjsse
= true
;
1579 } else if ($type == self
::JOB_SUBSUBSECTOR
) {
1580 $this->with_pjssse
= true
;
1582 } else if ($type == self
::JOB_ALTERNATES
) {
1583 $this->with_pja
= true
;
1588 private function jobJoins()
1591 if ($this->with_pj
) {
1592 $joins['pj'] = array('left', 'profile_job', '$ME.uid = $UID');
1594 if ($this->with_pje
) {
1595 $joins['pje'] = array('left', 'profile_job_enum', '$ME.id = pj.jobid');
1597 if ($this->with_pjse
) {
1598 $joins['pjse'] = array('left', 'profile_job_sector_enum', '$ME.id = pj.sectorid');
1600 if ($this->with_pjsse
) {
1601 $joins['pjsse'] = array('left', 'profile_job_subsector_enum', '$ME.id = pj.subsectorid');
1603 if ($this->with_pjssse
) {
1604 $joins['pjssse'] = array('left', 'profile_job_subsubsector_enum', '$ME.id = pj.subsubsectorid');
1606 if ($this->with_pja
) {
1607 $joins['pja'] = array('left', 'profile_job_alternates', '$ME.subsubsectorid = pj.subsubsectorid');
1614 private $cts = array();
1615 public function addContactFilter($uid = null
)
1617 return $this->register_optional($this->cts
, is_null($uid) ? null
: 'user_' . $uid);
1620 private function contactJoins()
1623 foreach ($this->cts
as $sub=>$key) {
1624 if (is_null($key)) {
1625 $joins['c' . $sub] = array('left', 'contacts', '$ME.contact = $UID');
1627 $joins['c' . $sub] = array('left', 'contacts', XDB
::format('$ME.uid = {?} AND $ME.contact = $UID', substr($key, 5)));
1636 private $wn = array();
1637 public function addWatchRegistrationFilter($uid = null
)
1639 return $this->register_optional($this->wn
, is_null($uid) ? null
: 'user_' . $uid);
1642 private $wp = array();
1643 public function addWatchPromoFilter($uid = null
)
1645 return $this->register_optional($this->wp
, is_null($uid) ? null
: 'user_' . $uid);
1648 private $w = array();
1649 public function addWatchFilter($uid = null
)
1651 return $this->register_optional($this->w
, is_null($uid) ? null
: 'user_' . $uid);
1654 private function watchJoins()
1657 foreach ($this->w
as $sub=>$key) {
1658 if (is_null($key)) {
1659 $joins['w' . $sub] = array('left', 'watch');
1661 $joins['w' . $sub] = array('left', 'watch', XDB
::format('$ME.uid = {?}', substr($key, 5)));
1664 foreach ($this->wn
as $sub=>$key) {
1665 if (is_null($key)) {
1666 $joins['wn' . $sub] = array('left', 'watch_nonins', '$ME.ni_id = $UID');
1668 $joins['wn' . $sub] = array('left', 'watch_nonins', XDB
::format('$ME.uid = {?} AND $ME.ni_id = $UID', substr($key, 5)));
1671 foreach ($this->wn
as $sub=>$key) {
1672 if (is_null($key)) {
1673 $joins['wn' . $sub] = array('left', 'watch_nonins', '$ME.ni_id = $UID');
1675 $joins['wn' . $sub] = array('left', 'watch_nonins', XDB
::format('$ME.uid = {?} AND $ME.ni_id = $UID', substr($key, 5)));
1678 foreach ($this->wp
as $sub=>$key) {
1679 if (is_null($key)) {
1680 $joins['wp' . $sub] = array('left', 'watch_promo');
1682 $joins['wp' . $sub] = array('left', 'watch_promo', XDB
::format('$ME.uid = {?}', substr($key, 5)));
1690 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: