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 ***************************************************************************/
27 // {{{ interface UserFilterCondition
28 /** This interface describe objects which filter users based
29 * on various parameters.
30 * The parameters of the filter must be given to the constructor.
31 * The buildCondition function is called by UserFilter when
32 * actually building the query. That function must call
33 * $uf->addWheteverFilter so that the UserFilter makes
34 * adequate joins. It must return the 'WHERE' condition to use
37 interface UserFilterCondition
extends PlFilterCondition
42 // {{{ class UFC_HasProfile
43 /** Filters users who have a profile
45 class UFC_HasProfile
implements UserFilterCondition
47 public function buildCondition(PlFilter
&$uf)
49 $uf->requireProfiles();
50 return '$PID IS NOT NULL';
55 // {{{ class UFC_Hruid
56 /** Filters users based on their hruid
57 * @param $val Either an hruid, or a list of those
59 class UFC_Hruid
implements UserFilterCondition
63 public function __construct()
65 $this->hruids
= pl_flatten(func_get_args());
68 public function buildCondition(PlFilter
&$uf)
70 $uf->requireAccounts();
71 return XDB
::format('a.hruid IN {?}', $this->hruids
);
76 // {{{ class UFC_Hrpid
77 /** Filters users based on the hrpid of their profiles
78 * @param $val Either an hrpid, or a list of those
80 class UFC_Hrpid
implements UserFilterCondition
84 public function __construct()
86 $this->hrpids
= pl_flatten(func_get_args());
89 public function buildCondition(PlFilter
&$uf)
91 $uf->requireProfiles();
92 return XDB
::format('p.hrpid IN {?}', $this->hrpids
);
98 /** Filters users based on one of their last IPs
99 * @param $ip IP from which connection are checked
101 class UFC_Ip
implements UserFilterCondition
105 public function __construct($ip)
110 public function buildCondition(PlFilter
&$uf)
112 $sub = $uf->addLoggerFilter();
113 $ip = ip_to_uint($this->ip
);
114 return XDB
::format($sub . '.ip = {?} OR ' . $sub . '.forward_ip = {?}', $ip, $ip);
119 // {{{ class UFC_Comment
120 class UFC_Comment
implements UserFilterCondition
124 public function __construct($text)
129 public function buildCondition(PlFilter
&$uf)
131 $uf->requireProfiles();
132 return 'p.freetext ' . XDB
::formatWildcards(XDB
::WILDCARD_CONTAINS
, $this->text
);
137 // {{{ class UFC_Promo
138 /** Filters users based on promotion
139 * @param $comparison Comparison operator (>, =, ...)
140 * @param $grade Formation on which to restrict, UserFilter::DISPLAY for "any formation"
141 * @param $promo Promotion on which the filter is based
143 class UFC_Promo
implements UserFilterCondition
150 public function __construct($comparison, $grade, $promo)
152 $this->grade
= $grade;
153 $this->comparison
= $comparison;
154 $this->promo
= $promo;
155 if ($this->grade
!= UserFilter
::DISPLAY
) {
156 UserFilter
::assertGrade($this->grade
);
158 if ($this->grade
== UserFilter
::DISPLAY
&& $this->comparison
!= '=') {
159 // XXX: we might try to guess the grade from the first char of the promo and forbid only '<= 2004', but allow '<= X2004'
160 Platal
::page()->killError("Il n'est pas possible d'appliquer la comparaison '" . $this->comparison
. "' aux promotions sans spécifier de formation (X/M/D)");
164 public function buildCondition(PlFilter
&$uf)
166 if ($this->grade
== UserFilter
::DISPLAY
) {
167 $sub = $uf->addDisplayFilter();
168 return XDB
::format('pd' . $sub . '.promo ' . $this->comparison
. ' {?}', $this->promo
);
170 $sub = $uf->addEducationFilter(true
, $this->grade
);
171 $field = 'pe' . $sub . '.' . UserFilter
::promoYear($this->grade
);
172 return $field . ' IS NOT NULL AND ' . $field . ' ' . $this->comparison
. ' ' . XDB
::format('{?}', $this->promo
);
178 // {{{ class UFC_SchoolId
179 /** Filters users based on their shoold identifier
180 * @param type Parameter type (Xorg, AX, School)
181 * @param value School id value
183 class UFC_SchoolId
implements UserFilterCondition
187 const School
= 'school';
192 static public function assertType($type)
194 if ($type != self
::AX
&& $type != self
::Xorg
&& $type != self
::School
) {
195 Platal
::page()->killError("Type de matricule invalide: $type");
199 public function __construct($type, $id)
203 self
::assertType($type);
206 public function buildCondition(PlFilter
&$uf)
208 $uf->requireProfiles();
211 if ($type == self
::School
) {
213 $id = Profile
::getXorgId($id);
215 return XDB
::format('p.' . $type . '_id = {?}', $id);
220 // {{{ class UFC_EducationSchool
221 /** Filters users by formation
222 * @param $val The formation to search (either ID or array of IDs)
224 class UFC_EducationSchool
implements UserFilterCondition
228 public function __construct()
230 $this->val
= pl_flatten(func_get_args());
233 public function buildCondition(PlFilter
&$uf)
235 $sub = $uf->addEducationFilter();
236 return XDB
::format('pe' . $sub . '.eduid IN {?}', $this->val
);
241 // {{{ class UFC_EducationDegree
242 class UFC_EducationDegree
implements UserFilterCondition
246 public function __construct()
248 $this->diploma
= pl_flatten(func_get_args());
251 public function buildCondition(PlFilter
&$uf)
253 $sub = $uf->addEducationFilter();
254 return XDB
::format('pe' . $sub . '.degreeid IN {?}', $this->diploma
);
259 // {{{ class UFC_EducationField
260 class UFC_EducationField
implements UserFilterCondition
264 public function __construct()
266 $this->val
= pl_flatten(func_get_args());
269 public function buildCondition(PlFilter
&$uf)
271 $sub = $uf->addEducationFilter();
272 return XDB
::format('pe' . $sub . '.fieldid IN {?}', $this->val
);
277 // {{{ class UFC_Name
278 /** Filters users based on name
279 * @param $type Type of name field on which filtering is done (firstname, lastname...)
280 * @param $text Text on which to filter
281 * @param $mode Flag indicating search type (prefix, suffix, with particule...)
283 class UFC_Name
implements UserFilterCondition
285 const EXACT
= XDB
::WILDCARD_EXACT
; // 0x000
286 const PREFIX
= XDB
::WILDCARD_PREFIX
; // 0x001
287 const SUFFIX
= XDB
::WILDCARD_SUFFIX
; // 0x002
288 const CONTAINS
= XDB
::WILDCARD_CONTAINS
; // 0x003
289 const PARTICLE
= 0x004;
290 const VARIANTS
= 0x008;
296 public function __construct($type, $text, $mode)
303 private function buildNameQuery($type, $variant, $where, UserFilter
&$uf)
305 $sub = $uf->addNameFilter($type, $variant);
306 return str_replace('$ME', 'pn' . $sub, $where);
309 public function buildCondition(PlFilter
&$uf)
312 if (($this->mode
& self
::PARTICLE
) == self
::PARTICLE
) {
313 $left = 'CONCAT($ME.particle, \' \', $ME.name)';
315 $right = XDB
::formatWildcards($this->mode
& self
::CONTAINS
, $this->text
);
317 $cond = $left . $right;
318 $conds = array($this->buildNameQuery($this->type
, null
, $cond, $uf));
319 if (($this->mode
& self
::VARIANTS
) != 0 && isset(Profile
::$name_variants[$this->type
])) {
320 foreach (Profile
::$name_variants[$this->type
] as $var) {
321 $conds[] = $this->buildNameQuery($this->type
, $var, $cond, $uf);
324 return implode(' OR ', $conds);
329 // {{{ class UFC_NameTokens
330 /** Selects users based on tokens in their name (for quicksearch)
331 * @param $tokens An array of tokens to search
332 * @param $flags Flags the tokens must have (e.g 'public' for public search)
333 * @param $soundex (bool) Whether those tokens are fulltext or soundex
335 class UFC_NameTokens
implements UserFilterCondition
338 const FLAG_PUBLIC
= 'public';
345 public function __construct($tokens, $flags = array(), $soundex = false
, $exact = false
)
347 if (is_array($tokens)) {
348 $this->tokens
= $tokens;
350 $this->tokens
= array($tokens);
352 if (is_array($flags)) {
353 $this->flags
= $flags;
355 $this->flags
= array($flags);
357 $this->soundex
= $soundex;
358 $this->exact
= $exact;
361 public function buildCondition(PlFilter
&$uf)
364 foreach ($this->tokens
as $i => $token) {
365 $sub = $uf->addNameTokensFilter($token);
366 if ($this->soundex
) {
367 $c = XDB
::format($sub . '.soundex = {?}', $token);
368 } else if ($this->exact
) {
369 $c = XDB
::format($sub . '.token = {?}', $token);
371 $c = $sub . '.token ' . XDB
::formatWildcards(XDB
::WILDCARD_PREFIX
, $token);
373 if ($this->flags
!= null
) {
374 $c .= XDB
::format(' AND ' . $sub . '.flags IN {?}', $this->flags
);
379 return implode(' AND ', $conds);
384 // {{{ class UFC_Nationality
385 class UFC_Nationality
implements UserFilterCondition
389 public function __construct()
391 $this->val
= pl_flatten(func_get_args());
394 public function buildCondition(PlFilter
&$uf)
396 $uf->requireProfiles();
397 $nat = XDB
::formatArray($this->val
);
399 'p.nationality1 IN ' . $nat,
400 'p.nationality2 IN ' . $nat,
401 'p.nationality3 IN ' . $nat,
403 return implode(' OR ', $conds);
408 // {{{ class UFC_Dead
409 /** Filters users based on death date
410 * @param $comparison Comparison operator
411 * @param $date Date to which death date should be compared (DateTime object, string or timestamp)
413 class UFC_Dead
implements UserFilterCondition
418 public function __construct($comparison = null
, $date = null
)
420 $this->comparison
= $comparison;
421 $this->date
= make_datetime($date);
424 public function buildCondition(PlFilter
&$uf)
426 $uf->requireProfiles();
427 $str = 'p.deathdate IS NOT NULL';
428 if (!is_null($this->comparison
)) {
429 $str .= ' AND p.deathdate ' . $this->comparison
. ' ' . XDB
::format('{?}', $this->date
->format('Y-m-d'));
436 // {{{ class UFC_Registered
437 /** Filters users based on registration state
438 * @param $active Whether we want to use only "active" users (i.e with a valid redirection)
439 * @param $comparison Comparison operator
440 * @param $date Date to which users registration date should be compared
442 class UFC_Registered
implements UserFilterCondition
448 public function __construct($active = false
, $comparison = null
, $date = null
)
450 $this->active
= $active;
451 $this->comparison
= $comparison;
452 $this->date
= make_datetime($date);
455 public function buildCondition(PlFilter
&$uf)
457 $uf->requireAccounts();
459 $date = '$UID IS NOT NULL AND a.state = \'active\'';
461 $date = '$UID IS NOT NULL AND a.state != \'pending\'';
463 if (!is_null($this->comparison
)) {
464 $date .= ' AND a.registration_date != \'0000-00-00 00:00:00\' AND a.registration_date ' . $this->comparison
. ' ' . XDB
::format('{?}', $this->date
->format('Y-m-d'));
471 // {{{ class UFC_ProfileUpdated
472 /** Filters users based on profile update date
473 * @param $comparison Comparison operator
474 * @param $date Date to which profile update date must be compared
476 class UFC_ProfileUpdated
implements UserFilterCondition
481 public function __construct($comparison = null
, $date = null
)
483 $this->comparison
= $comparison;
487 public function buildCondition(PlFilter
&$uf)
489 $uf->requireProfiles();
490 return 'p.last_change ' . $this->comparison
. XDB
::format(' {?}', date('Y-m-d H:i:s', $this->date
));
495 // {{{ class UFC_Birthday
496 /** Filters users based on next birthday date
497 * @param $comparison Comparison operator
498 * @param $date Date to which users next birthday date should be compared
500 class UFC_Birthday
implements UserFilterCondition
505 public function __construct($comparison = null
, $date = null
)
507 $this->comparison
= $comparison;
511 public function buildCondition(PlFilter
&$uf)
513 $uf->requireProfiles();
514 return 'p.next_birthday ' . $this->comparison
. XDB
::format(' {?}', date('Y-m-d', $this->date
));
520 /** Filters users based on sex
521 * @parm $sex One of User::GENDER_MALE or User::GENDER_FEMALE, for selecting users
523 class UFC_Sex
implements UserFilterCondition
526 public function __construct($sex)
531 public function buildCondition(PlFilter
&$uf)
533 if ($this->sex
!= User
::GENDER_MALE
&& $this->sex
!= User
::GENDER_FEMALE
) {
534 return self
::COND_FALSE
;
536 $uf->requireProfiles();
537 return XDB
::format('p.sex = {?}', $this->sex
== User
::GENDER_FEMALE ?
'female' : 'male');
543 // {{{ class UFC_Group
544 /** Filters users based on group membership
545 * @param $group Group whose members we are selecting
546 * @param $anim Whether to restrict selection to animators of that group
548 class UFC_Group
implements UserFilterCondition
552 public function __construct($group, $anim = false
)
554 $this->group
= $group;
558 public function buildCondition(PlFilter
&$uf)
560 $sub = $uf->addGroupFilter($this->group
);
561 $where = 'gpm' . $sub . '.perms IS NOT NULL';
563 $where .= ' AND gpm' . $sub . '.perms = \'admin\'';
570 // {{{ class UFC_Binet
571 /** Selects users based on their belonging to a given (list of) binet
572 * @param $binet either a binet_id or an array of binet_ids
574 class UFC_Binet
implements UserFilterCondition
578 public function __construct()
580 $this->val
= pl_flatten(func_get_args());
583 public function buildCondition(PlFilter
&$uf)
585 $sub = $uf->addBinetsFilter();
586 return XDB
::format($sub . '.binet_id IN {?}', $this->val
);
591 // {{{ class UFC_Section
592 /** Selects users based on section
593 * @param $section ID of the section
595 class UFC_Section
implements UserFilterCondition
599 public function __construct()
601 $this->section
= pl_flatten(func_get_args());
604 public function buildCondition(PlFilter
&$uf)
606 $uf->requireProfiles();
607 return XDB
::format('p.section IN {?}', $this->section
);
612 // {{{ class UFC_Email
613 /** Filters users based on an email or a list of emails
614 * @param $emails List of emails whose owner must be selected
616 class UFC_Email
implements UserFilterCondition
619 public function __construct()
621 $this->emails
= pl_flatten(func_get_args());
624 public function buildCondition(PlFilter
&$uf)
631 if (count($this->emails
) == 0) {
632 return PlFilterCondition
::COND_TRUE
;
635 foreach ($this->emails
as $entry) {
636 if (User
::isForeignEmailAddress($entry)) {
638 } else if (User
::isVirtualEmailAddress($entry)) {
641 @list
($user, $domain) = explode('@', $entry);
646 if (count($foreign) > 0) {
647 $sub = $uf->addEmailRedirectFilter($foreign);
648 $cond[] = XDB
::format('e' . $sub . '.email IS NOT NULL OR a.email IN {?}', $foreign);
650 if (count($virtual) > 0) {
651 $sub = $uf->addVirtualEmailFilter($virtual);
652 $cond[] = 'vr' . $sub . '.redirect IS NOT NULL';
654 if (count($aliases) > 0) {
655 $sub = $uf->addAliasFilter($aliases);
656 $cond[] = 'al' . $sub . '.alias IS NOT NULL';
658 return '(' . implode(') OR (', $cond) . ')';
663 // {{{ class UFC_Address
664 abstract class UFC_Address
implements UserFilterCondition
666 /** Valid address type ('hq' is reserved for company addresses)
672 /** Text for these types
674 protected static $typetexts = array(
675 self
::TYPE_HOME
=> 'home',
676 self
::TYPE_PRO
=> 'pro',
681 /** Flags for addresses
683 const FLAG_CURRENT
= 0x0001;
684 const FLAG_TEMP
= 0x0002;
685 const FLAG_SECOND
= 0x0004;
686 const FLAG_MAIL
= 0x0008;
687 const FLAG_CEDEX
= 0x0010;
689 // Binary OR of those flags
690 const FLAG_ANY
= 0x001F;
692 /** Text of these flags
694 protected static $flagtexts = array(
695 self
::FLAG_CURRENT
=> 'current',
696 self
::FLAG_TEMP
=> 'temporary',
697 self
::FLAG_SECOND
=> 'secondary',
698 self
::FLAG_MAIL
=> 'mail',
699 self
::FLAG_CEDEX
=> 'cedex',
704 public function __construct($type = null
, $flags = null
)
707 $this->flags
= $flags;
710 protected function initConds($sub)
714 foreach (self
::$typetexts as $flag => $type) {
715 if ($flag & $this->type
) {
720 $conds[] = XDB
::format($sub . '.type IN {?}', $types);
723 if ($this->flags
!= self
::FLAG_ANY
) {
724 foreach(self
::$flagtexts as $flag => $text) {
725 if ($flag & $this->flags
) {
726 $conds[] = 'FIND_IN_SET(' . XDB
::format('{?}', $text) . ', ' . $sub . '.flags)';
736 // {{{ class UFC_AddressText
737 /** Select users based on their address, using full text search
738 * @param $text Text for filter in fulltext search
739 * @param $textSearchMode Mode for search (one of XDB::WILDCARD_*)
740 * @param $type Filter on address type
741 * @param $flags Filter on address flags
742 * @param $country Filter on address country
743 * @param $locality Filter on address locality
745 class UFC_AddressText
extends UFC_Address
749 private $textSearchMode;
751 public function __construct($text = null
, $textSearchMode = XDB
::WILDCARD_CONTAINS
,
752 $type = null
, $flags = self
::FLAG_ANY
, $country = null
, $locality = null
)
754 parent
::__construct($type, $flags);
756 $this->textSearchMode
= $textSearchMode;
757 $this->country
= $country;
758 $this->locality
= $locality;
761 private function mkMatch($txt)
763 return XDB
::formatWildcards($this->textSearchMode
, $txt);
766 public function buildCondition(PlFilter
&$uf)
768 $sub = $uf->addAddressFilter();
769 $conds = $this->initConds($sub);
770 if ($this->text
!= null
) {
771 $conds[] = $sub . '.text' . $this->mkMatch($this->text
);
774 if ($this->country
!= null
) {
775 $subc = $uf->addAddressCountryFilter();
777 $subconds[] = $subc . '.country' . $this->mkMatch($this->country
);
778 $subconds[] = $subc . '.countryFR' . $this->mkMatch($this->country
);
779 $conds[] = implode(' OR ', $subconds);
782 if ($this->locality
!= null
) {
783 $subl = $uf->addAddressLocalityFilter();
784 $conds[] = $subl . '.name' . $this->mkMatch($this->locality
);
787 return implode(' AND ', $conds);
792 // {{{ class UFC_AddressField
793 /** Filters users based on their address,
794 * @param $val Either a code for one of the fields, or an array of such codes
795 * @param $fieldtype The type of field to look for
796 * @param $type Filter on address type
797 * @param $flags Filter on address flags
799 class UFC_AddressField
extends UFC_Address
801 const FIELD_COUNTRY
= 1;
802 const FIELD_ADMAREA
= 2;
803 const FIELD_SUBADMAREA
= 3;
804 const FIELD_LOCALITY
= 4;
805 const FIELD_ZIPCODE
= 5;
807 /** Data of the filter
812 public function __construct($val, $fieldtype, $type = null
, $flags = self
::FLAG_ANY
)
814 parent
::__construct($type, $flags);
816 if (!is_array($val)) {
820 $this->fieldtype
= $fieldtype;
823 public function buildCondition(PlFilter
&$uf)
825 $sub = $uf->addAddressFilter();
826 $conds = $this->initConds($sub);
828 switch ($this->fieldtype
) {
829 case self
::FIELD_COUNTRY
:
830 $field = 'countryId';
832 case self
::FIELD_ADMAREA
:
833 $field = 'administrativeAreaId';
835 case self
::FIELD_SUBADMAREA
:
836 $field = 'subAdministrativeAreaId';
838 case self
::FIELD_LOCALITY
:
839 $field = 'localityId';
841 case self
::FIELD_ZIPCODE
:
842 $field = 'postalCode';
845 Platal
::page()->killError('Invalid address field type: ' . $this->fieldtype
);
847 $conds[] = XDB
::format($sub . '.' . $field . ' IN {?}', $this->val
);
849 return implode(' AND ', $conds);
854 // {{{ class UFC_Corps
855 /** Filters users based on the corps they belong to
856 * @param $corps Corps we are looking for (abbreviation)
857 * @param $type Whether we search for original or current corps
859 class UFC_Corps
implements UserFilterCondition
867 public function __construct($corps, $type = self
::CURRENT
)
869 $this->corps
= $corps;
873 public function buildCondition(PlFilter
&$uf)
875 /** Tables shortcuts:
876 * pc for profile_corps,
877 * pceo for profile_corps_enum - orginal
878 * pcec for profile_corps_enum - current
880 $sub = $uf->addCorpsFilter($this->type
);
881 $cond = $sub . '.abbreviation = ' . $corps;
887 // {{{ class UFC_Corps_Rank
888 /** Filters users based on their rank in the corps
889 * @param $rank Rank we are looking for (abbreviation)
891 class UFC_Corps_Rank
implements UserFilterCondition
894 public function __construct($rank)
899 public function buildCondition(PlFilter
&$uf)
901 /** Tables shortcuts:
902 * pcr for profile_corps_rank
904 $sub = $uf->addCorpsRankFilter();
905 $cond = $sub . '.abbreviation = ' . $rank;
911 // {{{ class UFC_Job_Company
912 /** Filters users based on the company they belong to
913 * @param $type The field being searched (self::JOBID, self::JOBNAME or self::JOBACRONYM)
914 * @param $value The searched value
916 class UFC_Job_Company
implements UserFilterCondition
919 const JOBNAME
= 'name';
920 const JOBACRONYM
= 'acronym';
925 public function __construct($type, $value)
927 $this->assertType($type);
929 $this->value
= $value;
932 private function assertType($type)
934 if ($type != self
::JOBID
&& $type != self
::JOBNAME
&& $type != self
::JOBACRONYM
) {
935 Platal
::page()->killError("Type de recherche non valide.");
939 public function buildCondition(PlFilter
&$uf)
941 $sub = $uf->addJobCompanyFilter();
942 $cond = $sub . '.' . $this->type
. XDB
::formatWildcards(XDB
::WILDCARD_CONTAINS
, $this->value
);
948 // {{{ class UFC_Job_Sectorization
949 /** Filters users based on the ((sub)sub)sector they work in
950 * @param $val The ID of the sector, or an array of such IDs
951 * @param $type The kind of search (subsubsector/subsector/sector)
953 class UFC_Job_Sectorization
implements UserFilterCondition
958 public function __construct($val, $type = UserFilter
::JOB_SECTOR
)
960 self
::assertType($type);
961 if (!is_array($val)) {
968 private static function assertType($type)
970 if ($type != UserFilter
::JOB_SECTOR
&& $type != UserFilter
::JOB_SUBSECTOR
&& $type != UserFilter
::JOB_SUBSUBSECTOR
) {
971 Platal
::page()->killError("Type de secteur non valide.");
975 public function buildCondition(PlFilter
&$uf)
977 $sub = $uf->addJobSectorizationFilter($this->type
);
978 return $sub . '.id = ' . XDB
::format('{?}', $this->val
);
983 // {{{ class UFC_Job_Terms
984 /** Filters users based on the job terms they assigned to one of their
986 * @param $val The ID of the job term, or an array of such IDs
988 class UFC_Job_Terms
implements UserFilterCondition
992 public function __construct($val)
994 if (!is_array($val)) {
1000 public function buildCondition(PlFilter
&$uf)
1002 $sub = $uf->addJobTermsFilter(count($this->val
));
1003 $conditions = array();
1004 foreach ($this->val
as $i => $jtid) {
1005 $conditions[] = $sub[$i] . ' = ' . XDB
::escape($jtid);
1007 return implode(' AND ', $conditions);
1012 // {{{ class UFC_Job_Description
1013 /** Filters users based on their job description
1014 * @param $description The text being searched for
1015 * @param $fields The fields to search for (user-defined, ((sub|)sub|)sector)
1017 class UFC_Job_Description
implements UserFilterCondition
1020 private $description;
1023 public function __construct($description, $fields)
1025 $this->fields
= $fields;
1026 $this->description
= $description;
1029 public function buildCondition(PlFilter
&$uf)
1032 if ($this->fields
& UserFilter
::JOB_USERDEFINED
) {
1033 $sub = $uf->addJobFilter();
1034 $conds[] = $sub . '.description ' . XDB
::formatWildcards(XDB
::WILDCARD_CONTAINS
, $this->description
);
1036 if ($this->fields
& UserFilter
::JOB_CV
) {
1037 $uf->requireProfiles();
1038 $conds[] = 'p.cv ' . XDB
::formatWildcards(XDB
::WILDCARD_CONTAINS
, $this->description
);
1040 if ($this->fields
& UserFilter
::JOB_SECTOR
) {
1041 $sub = $uf->addJobSectorizationFilter(UserFilter
::JOB_SECTOR
);
1042 $conds[] = $sub . '.name ' . XDB
::formatWildcards(XDB
::WILDCARD_CONTAINS
, $this->description
);
1044 if ($this->fields
& UserFilter
::JOB_SUBSECTOR
) {
1045 $sub = $uf->addJobSectorizationFilter(UserFilter
::JOB_SUBSECTOR
);
1046 $conds[] = $sub . '.name ' . XDB
::formatWildcards(XDB
::WILDCARD_CONTAINS
, $this->description
);
1048 if ($this->fields
& UserFilter
::JOB_SUBSUBSECTOR
) {
1049 $sub = $uf->addJobSectorizationFilter(UserFilter
::JOB_SUBSUBSECTOR
);
1050 $conds[] = $sub . '.name ' . XDB
::formatWildcards(XDB
::WILDCARD_CONTAINS
, $this->description
);
1051 $sub = $uf->addJobSectorizationFilter(UserFilter
::JOB_ALTERNATES
);
1052 $conds[] = $sub . '.name ' . XDB
::formatWildcards(XDB
::WILDCARD_CONTAINS
, $this->description
);
1054 return implode(' OR ', $conds);
1059 // {{{ class UFC_Networking
1060 /** Filters users based on network identity (IRC, ...)
1061 * @param $type Type of network (-1 for any)
1062 * @param $value Value to search
1064 class UFC_Networking
implements UserFilterCondition
1069 public function __construct($type, $value)
1071 $this->type
= $type;
1072 $this->value
= $value;
1075 public function buildCondition(PlFilter
&$uf)
1077 $sub = $uf->addNetworkingFilter();
1079 $conds[] = $sub . '.address ' . XDB
::formatWildcards(XDB
::WILDCARD_CONTAINS
, $this->value
);
1080 if ($this->type
!= -1) {
1081 $conds[] = $sub . '.nwid = ' . XDB
::format('{?}', $this->type
);
1083 return implode(' AND ', $conds);
1088 // {{{ class UFC_Phone
1089 /** Filters users based on their phone number
1090 * @param $num_type Type of number (pro/user/home)
1091 * @param $phone_type Type of phone (fixed/mobile/fax)
1092 * @param $number Phone number
1094 class UFC_Phone
implements UserFilterCondition
1096 const NUM_PRO
= 'pro';
1097 const NUM_USER
= 'user';
1098 const NUM_HOME
= 'address';
1099 const NUM_ANY
= 'any';
1101 const PHONE_FIXED
= 'fixed';
1102 const PHONE_MOBILE
= 'mobile';
1103 const PHONE_FAX
= 'fax';
1104 const PHONE_ANY
= 'any';
1107 private $phone_type;
1110 public function __construct($number, $num_type = self
::NUM_ANY
, $phone_type = self
::PHONE_ANY
)
1112 $phone = new Phone(array('display' => $number));
1114 $this->number
= $phone->search();
1115 $this->num_type
= $num_type;
1116 $this->phone_type
= $phone_type;
1119 public function buildCondition(PlFilter
&$uf)
1121 $sub = $uf->addPhoneFilter();
1123 $conds[] = $sub . '.search_tel = ' . XDB
::format('{?}', $this->number
);
1124 if ($this->num_type
!= self
::NUM_ANY
) {
1125 $conds[] = $sub . '.link_type = ' . XDB
::format('{?}', $this->num_type
);
1127 if ($this->phone_type
!= self
::PHONE_ANY
) {
1128 $conds[] = $sub . '.tel_type = ' . XDB
::format('{?}', $this->phone_type
);
1130 return implode(' AND ', $conds);
1135 // {{{ class UFC_Medal
1136 /** Filters users based on their medals
1137 * @param $medal ID of the medal
1138 * @param $grade Grade of the medal (null for 'any')
1140 class UFC_Medal
implements UserFilterCondition
1145 public function __construct($medal, $grade = null
)
1147 $this->medal
= $medal;
1148 $this->grade
= $grade;
1151 public function buildCondition(PlFilter
&$uf)
1154 $sub = $uf->addMedalFilter();
1155 $conds[] = $sub . '.mid = ' . XDB
::format('{?}', $this->medal
);
1156 if ($this->grade
!= null
) {
1157 $conds[] = $sub . '.gid = ' . XDB
::format('{?}', $this->grade
);
1159 return implode(' AND ', $conds);
1164 // {{{ class UFC_Photo
1165 /** Filters profiles with photo
1167 class UFC_Photo
implements UserFilterCondition
1169 public function buildCondition(PlFilter
&$uf)
1171 $uf->addPhotoFilter();
1172 return 'photo.attach IS NOT NULL';
1177 // {{{ class UFC_Mentor_Expertise
1178 /** Filters users by mentoring expertise
1179 * @param $expertise Domain of expertise
1181 class UFC_Mentor_Expertise
implements UserFilterCondition
1185 public function __construct($expertise)
1187 $this->expertise
= $expertise;
1190 public function buildCondition(PlFilter
&$uf)
1192 $sub = $uf->addMentorFilter(UserFilter
::MENTOR_EXPERTISE
);
1193 return $sub . '.expertise ' . XDB
::formatWildcards(XDB
::WILDCARD_CONTAINS
, $this->expertise
);
1198 // {{{ class UFC_Mentor_Country
1199 /** Filters users by mentoring country
1200 * @param $country Two-letters code of country being searched
1202 class UFC_Mentor_Country
implements UserFilterCondition
1206 public function __construct()
1208 $this->country
= pl_flatten(func_get_args());
1211 public function buildCondition(PlFilter
&$uf)
1213 $sub = $uf->addMentorFilter(UserFilter
::MENTOR_COUNTRY
);
1214 return $sub . '.country IN ' . XDB
::format('{?}', $this->country
);
1219 // {{{ class UFC_Mentor_Terms
1220 /** Filters users based on the job terms they used in mentoring.
1221 * @param $val The ID of the job term, or an array of such IDs
1223 class UFC_Mentor_Terms
implements UserFilterCondition
1227 public function __construct($val)
1232 public function buildCondition(PlFilter
&$uf)
1234 $sub = $uf->addMentorFilter(UserFilter
::MENTOR_TERM
);
1235 return $sub . '.jtid_1 = ' . XDB
::escape($this->val
);
1240 // {{{ class UFC_Mentor_Sectorization
1241 /** Filters users based on mentoring (sub|)sector
1242 * @param $sector ID of (sub)sector
1243 * @param $type Whether we are looking for a sector or a subsector
1245 class UFC_Mentor_Sectorization
implements UserFilterCondition
1248 const SUBSECTOR
= 2;
1252 public function __construct($sector, $type = self
::SECTOR
)
1254 $this->sector
= $sector;
1255 $this->type
= $type;
1258 public function buildCondition(PlFilter
&$uf)
1260 $sub = $uf->addMentorFilter(UserFilter
::MENTOR_SECTOR
);
1261 if ($this->type
== self
::SECTOR
) {
1262 $field = 'sectorid';
1264 $field = 'subsectorid';
1266 return $sub . '.' . $field . ' = ' . XDB
::format('{?}', $this->sector
);
1271 // {{{ class UFC_UserRelated
1272 /** Filters users based on a relation toward a user
1273 * @param $user User to which searched users are related
1275 abstract class UFC_UserRelated
implements UserFilterCondition
1278 public function __construct(PlUser
&$user)
1280 $this->user
=& $user;
1285 // {{{ class UFC_Contact
1286 /** Filters users who belong to selected user's contacts
1288 class UFC_Contact
extends UFC_UserRelated
1290 public function buildCondition(PlFilter
&$uf)
1292 $sub = $uf->addContactFilter($this->user
->id());
1293 return 'c' . $sub . '.contact IS NOT NULL';
1298 // {{{ class UFC_WatchRegistration
1299 /** Filters users being watched by selected user
1301 class UFC_WatchRegistration
extends UFC_UserRelated
1303 public function buildCondition(PlFilter
&$uf)
1305 if (!$this->user
->watchType('registration')) {
1306 return PlFilterCondition
::COND_FALSE
;
1308 $uids = $this->user
->watchUsers();
1309 if (count($uids) == 0) {
1310 return PlFilterCondition
::COND_FALSE
;
1312 return XDB
::format('$UID IN {?}', $uids);
1318 // {{{ class UFC_WatchPromo
1319 /** Filters users belonging to a promo watched by selected user
1320 * @param $user Selected user (the one watching promo)
1321 * @param $grade Formation the user is watching
1323 class UFC_WatchPromo
extends UFC_UserRelated
1326 public function __construct(PlUser
&$user, $grade = UserFilter
::GRADE_ING
)
1328 parent
::__construct($user);
1329 $this->grade
= $grade;
1332 public function buildCondition(PlFilter
&$uf)
1334 $promos = $this->user
->watchPromos();
1335 if (count($promos) == 0) {
1336 return PlFilterCondition
::COND_FALSE
;
1338 $sube = $uf->addEducationFilter(true
, $this->grade
);
1339 $field = 'pe' . $sube . '.' . UserFilter
::promoYear($this->grade
);
1340 return XDB
::format($field . ' IN {?}', $promos);
1346 // {{{ class UFC_WatchContact
1347 /** Filters users watched by selected user
1349 class UFC_WatchContact
extends UFC_Contact
1351 public function buildCondition(PlFilter
&$uf)
1353 if (!$this->user
->watchContacts()) {
1354 return PlFilterCondition
::COND_FALSE
;
1356 return parent
::buildCondition($uf);
1361 // {{{ class UFC_MarketingHash
1362 /** Filters users using the hash generated
1363 * to send marketing emails to him.
1365 class UFC_MarketingHash
implements UserFilterCondition
1369 public function __construct($hash)
1371 $this->hash
= $hash;
1374 public function buildCondition(PlFilter
&$uf)
1376 $table = $uf->addMarketingHash();
1377 return XDB
::format('rm.hash = {?}', $this->hash
);
1386 // {{{ class UFO_Promo
1387 /** Orders users by promotion
1388 * @param $grade Formation whose promotion users should be sorted by (restricts results to users of that formation)
1389 * @param $desc Whether sort is descending
1391 class UFO_Promo
extends PlFilterGroupableOrder
1395 public function __construct($grade = null
, $desc = false
)
1397 parent
::__construct($desc);
1398 $this->grade
= $grade;
1401 protected function getSortTokens(PlFilter
&$uf)
1403 if (UserFilter
::isGrade($this->grade
)) {
1404 $sub = $uf->addEducationFilter($this->grade
);
1405 return 'pe' . $sub . '.' . UserFilter
::promoYear($this->grade
);
1407 $sub = $uf->addDisplayFilter();
1408 return 'pd' . $sub . '.promo';
1414 // {{{ class UFO_Name
1415 /** Sorts users by name
1416 * @param $type Type of name on which to sort (firstname...)
1417 * @param $variant Variant of that name to use (marital, ordinary...)
1418 * @param $particle Set to true if particles should be included in the sorting order
1419 * @param $desc If sort order should be descending
1421 class UFO_Name
extends PlFilterOrder
1427 public function __construct($type, $variant = null
, $particle = false
, $desc = false
)
1429 parent
::__construct($desc);
1430 $this->type
= $type;
1431 $this->variant
= $variant;
1432 $this->particle
= $particle;
1435 protected function getSortTokens(PlFilter
&$uf)
1437 if (Profile
::isDisplayName($this->type
)) {
1438 $sub = $uf->addDisplayFilter();
1439 $token = 'pd' . $sub . '.' . $this->type
;
1440 if ($uf->accountsRequired()) {
1441 $account_token = Profile
::getAccountEquivalentName($this->type
);
1442 return 'IFNULL(' . $token . ', a.' . $account_token . ')';
1447 $sub = $uf->addNameFilter($this->type
, $this->variant
);
1448 if ($this->particle
) {
1449 return 'CONCAT(pn' . $sub . '.particle, \' \', pn' . $sub . '.name)';
1451 return 'pn' . $sub . '.name';
1458 // {{{ class UFO_Score
1459 class UFO_Score
extends PlFilterOrder
1461 protected function getSortTokens(PlFilter
&$uf)
1463 $toks = $uf->getNameTokens();
1466 // If there weren't any sort tokens, we shouldn't sort by score, sort by NULL instead
1467 if (count($toks) == 0) {
1471 foreach ($toks as $sub => $token) {
1472 $scores[] = XDB
::format('SUM(' . $sub . '.score + IF (' . $sub . '.token = {?}, 5, 0) )', $token);
1474 return implode(' + ', $scores);
1479 // {{{ class UFO_Registration
1480 /** Sorts users based on registration date
1482 class UFO_Registration
extends PlFilterOrder
1484 protected function getSortTokens(PlFilter
&$uf)
1486 $uf->requireAccounts();
1487 return 'a.registration_date';
1492 // {{{ class UFO_Birthday
1493 /** Sorts users based on next birthday date
1495 class UFO_Birthday
extends PlFilterOrder
1497 protected function getSortTokens(PlFilter
&$uf)
1499 $uf->requireProfiles();
1500 return 'p.next_birthday';
1505 // {{{ class UFO_ProfileUpdate
1506 /** Sorts users based on last profile update
1508 class UFO_ProfileUpdate
extends PlFilterOrder
1510 protected function getSortTokens(PlFilter
&$uf)
1512 $uf->requireProfiles();
1513 return 'p.last_change';
1518 // {{{ class UFO_Death
1519 /** Sorts users based on death date
1521 class UFO_Death
extends PlFilterOrder
1523 protected function getSortTokens(PlFilter
&$uf)
1525 $uf->requireProfiles();
1526 return 'p.deathdate';
1531 // {{{ class UFO_Uid
1532 /** Sorts users based on their uid
1534 class UFO_Uid
extends PlFilterOrder
1536 protected function getSortTokens(PlFilter
&$uf)
1538 $uf->requireAccounts();
1544 // {{{ class UFO_Hruid
1545 /** Sorts users based on their hruid
1547 class UFO_Hruid
extends PlFilterOrder
1549 protected function getSortTokens(PlFilter
&$uf)
1551 $uf->requireAccounts();
1557 // {{{ class UFO_Pid
1558 /** Sorts users based on their pid
1560 class UFO_Pid
extends PlFilterOrder
1562 protected function getSortTokens(PlFilter
&$uf)
1564 $uf->requireProfiles();
1570 // {{{ class UFO_Hrpid
1571 /** Sorts users based on their hrpid
1573 class UFO_Hrpid
extends PlFilterOrder
1575 protected function getSortTokens(PlFilter
&$uf)
1577 $uf->requireProfiles();
1584 /***********************************
1585 *********************************
1587 *********************************
1588 ***********************************/
1590 // {{{ class UserFilter
1591 /** This class provides a convenient and centralized way of filtering users.
1594 * $uf = new UserFilter(new UFC_Blah($x, $y), new UFO_Coin($z, $t));
1596 * Resulting UserFilter can be used to:
1597 * - get a list of User objects matching the filter
1598 * - get a list of UIDs matching the filter
1599 * - get the number of users matching the filter
1600 * - check whether a given User matches the filter
1601 * - filter a list of User objects depending on whether they match the filter
1603 * Usage for UFC and UFO objects:
1604 * A UserFilter will call all private functions named XXXJoins.
1605 * These functions must return an array containing the list of join
1606 * required by the various UFC and UFO associated to the UserFilter.
1607 * Entries in those returned array are of the following form:
1608 * 'join_tablealias' => array('join_type', 'joined_table', 'join_criter')
1609 * which will be translated into :
1610 * join_type JOIN joined_table AS join_tablealias ON (join_criter)
1611 * in the final query.
1613 * In the join_criter text, $ME is replaced with 'join_tablealias', $PID with
1614 * profile.pid, and $UID with accounts.uid.
1616 * For each kind of "JOIN" needed, a function named addXXXFilter() should be defined;
1617 * its parameter will be used to set various private vars of the UserFilter describing
1618 * the required joins ; such a function shall return the "join_tablealias" to use
1619 * when referring to the joined table.
1621 * For example, if data from profile_job must be available to filter results,
1622 * the UFC object will call $uf-addJobFilter(), which will set the 'with_pj' var and
1623 * return 'pj', the short name to use when referring to profile_job; when building
1624 * the query, calling the jobJoins function will return an array containing a single
1626 * 'pj' => array('left', 'profile_job', '$ME.pid = $UID');
1628 * The 'register_optional' function can be used to generate unique table aliases when
1629 * the same table has to be joined several times with different aliases.
1631 class UserFilter
extends PlFilter
1633 protected $joinMethods = array();
1635 protected $joinMetas = array(
1641 private $sort = array();
1642 private $grouper = null
;
1643 private $query = null
;
1644 private $orderby = null
;
1646 private $lastusercount = null
;
1647 private $lastprofilecount = null
;
1649 public function __construct($cond = null
, $sort = null
)
1651 if (empty($this->joinMethods
)) {
1652 $class = new ReflectionClass('UserFilter');
1653 foreach ($class->getMethods() as $method) {
1654 $name = $method->getName();
1655 if (substr($name, -5) == 'Joins' && $name != 'buildJoins') {
1656 $this->joinMethods
[] = $name;
1660 if (!is_null($cond)) {
1661 if ($cond instanceof PlFilterCondition
) {
1662 $this->setCondition($cond);
1665 if (!is_null($sort)) {
1666 if ($sort instanceof PlFilterOrder
) {
1667 $this->addSort($sort);
1668 } else if (is_array($sort)) {
1669 foreach ($sort as $s) {
1676 private function buildQuery()
1678 // The root condition is built first because some orders need info
1679 // available only once all UFC have set their conditions (UFO_Score)
1680 if (is_null($this->query
)) {
1681 $where = $this->root
->buildCondition($this);
1682 $where = str_replace(array_keys($this->joinMetas
),
1686 if (is_null($this->orderby
)) {
1688 foreach ($this->sort
as $sort) {
1689 $orders = array_merge($orders, $sort->buildSort($this));
1691 if (count($orders) == 0) {
1692 $this->orderby
= '';
1694 $this->orderby
= 'ORDER BY ' . implode(', ', $orders);
1696 $this->orderby
= str_replace(array_keys($this->joinMetas
),
1700 if (is_null($this->query
)) {
1701 if ($this->with_accounts
) {
1702 $from = 'accounts AS a';
1704 $this->requireProfiles();
1705 $from = 'profiles AS p';
1707 $joins = $this->buildJoins();
1708 $this->query
= 'FROM ' . $from . '
1710 WHERE (' . $where . ')';
1714 public function hasGroups()
1716 return $this->grouper
!= null
;
1719 public function getGroups()
1721 return $this->getUIDGroups();
1724 public function getUIDGroups()
1726 $this->requireAccounts();
1727 $this->buildQuery();
1728 $token = $this->grouper
->getGroupToken($this);
1730 $groups = XDB
::fetchAllRow('SELECT ' . $token . ', COUNT(a.uid)
1731 ' . $this->query
. '
1732 GROUP BY ' . $token,
1737 public function getPIDGroups()
1739 $this->requireProfiles();
1740 $this->buildQuery();
1741 $token = $this->grouper
->getGroupToken($this);
1743 $groups = XDB
::fetchAllRow('SELECT ' . $token . ', COUNT(p.pid)
1744 ' . $this->query
. '
1745 GROUP BY ' . $token,
1750 private function getUIDList($uids = null
, PlLimit
&$limit)
1752 $this->requireAccounts();
1753 $this->buildQuery();
1754 $lim = $limit->getSql();
1756 if (!empty($uids)) {
1757 $cond = XDB
::format(' AND a.uid IN {?}', $uids);
1759 $fetched = XDB
::fetchColumn('SELECT SQL_CALC_FOUND_ROWS a.uid
1760 ' . $this->query
. $cond . '
1762 ' . $this->orderby
. '
1764 $this->lastusercount
= (int)XDB
::fetchOneCell('SELECT FOUND_ROWS()');
1768 private function getPIDList($pids = null
, PlLimit
&$limit)
1770 $this->requireProfiles();
1771 $this->buildQuery();
1772 $lim = $limit->getSql();
1774 if (!is_null($pids)) {
1775 $cond = XDB
::format(' AND p.pid IN {?}', $pids);
1777 $fetched = XDB
::fetchColumn('SELECT SQL_CALC_FOUND_ROWS p.pid
1778 ' . $this->query
. $cond . '
1780 ' . $this->orderby
. '
1782 $this->lastprofilecount
= (int)XDB
::fetchOneCell('SELECT FOUND_ROWS()');
1786 private static function defaultLimit($limit) {
1787 if ($limit == null
) {
1788 return new PlLimit();
1794 /** Check that the user match the given rule.
1796 public function checkUser(PlUser
&$user)
1798 $this->requireAccounts();
1799 $this->buildQuery();
1800 $count = (int)XDB
::fetchOneCell('SELECT COUNT(*)
1801 ' . $this->query
. XDB
::format(' AND a.uid = {?}', $user->id()));
1805 /** Check that the profile match the given rule.
1807 public function checkProfile(Profile
&$profile)
1809 $this->requireProfiles();
1810 $this->buildQuery();
1811 $count = (int)XDB
::fetchOneCell('SELECT COUNT(*)
1812 ' . $this->query
. XDB
::format(' AND p.pid = {?}', $profile->id()));
1816 /** Default filter is on users
1818 public function filter(array $users, $limit = null
)
1820 return $this->filterUsers($users, self
::defaultLimit($limit));
1823 /** Filter a list of users to extract the users matching the rule.
1825 public function filterUsers(array $users, $limit = null
)
1827 $limit = self
::defaultLimit($limit);
1828 $this->requireAccounts();
1829 $this->buildQuery();
1832 foreach ($users as $user) {
1833 if ($user instanceof PlUser
) {
1839 $table[$uid] = $user;
1841 $fetched = $this->getUIDList($uids, $limit);
1843 foreach ($fetched as $uid) {
1844 $output[] = $table[$uid];
1849 /** Filter a list of profiles to extract the users matching the rule.
1851 public function filterProfiles(array $profiles, $limit = null
)
1853 $limit = self
::defaultLimit($limit);
1854 $this->requireProfiles();
1855 $this->buildQuery();
1858 foreach ($profiles as $profile) {
1859 if ($profile instanceof Profile
) {
1860 $pid = $profile->id();
1865 $table[$pid] = $profile;
1867 $fetched = $this->getPIDList($pids, $limit);
1869 foreach ($fetched as $pid) {
1870 $output[] = $table[$pid];
1875 public function getUIDs($limit = null
)
1877 $limit = self
::defaultLimit($limit);
1878 return $this->getUIDList(null
, $limit);
1881 public function getUID($pos = 0)
1883 $uids =$this->getUIDList(null
, new PlLimit(1, $pos));
1884 if (count($uids) == 0) {
1891 public function getPIDs($limit = null
)
1893 $limit = self
::defaultLimit($limit);
1894 return $this->getPIDList(null
, $limit);
1897 public function getPID($pos = 0)
1899 $pids =$this->getPIDList(null
, new PlLimit(1, $pos));
1900 if (count($pids) == 0) {
1907 public function getUsers($limit = null
)
1909 return User
::getBulkUsersWithUIDs($this->getUIDs($limit));
1912 public function getUser($pos = 0)
1914 $uid = $this->getUID($pos);
1918 return User
::getWithUID($uid);
1922 public function iterUsers($limit = null
)
1924 return User
::iterOverUIDs($this->getUIDs($limit));
1927 public function getProfiles($limit = null
, $fields = 0x0000, $visibility = null
)
1929 return Profile
::getBulkProfilesWithPIDs($this->getPIDs($limit), $fields, $visibility);
1932 public function getProfile($pos = 0, $fields = 0x0000, $visibility = null
)
1934 $pid = $this->getPID($pos);
1938 return Profile
::get($pid, $fields, $visibility);
1942 public function iterProfiles($limit = null
, $fields = 0x0000, $visibility = null
)
1944 return Profile
::iterOverPIDs($this->getPIDs($limit), true
, $fields, $visibility);
1947 public function get($limit = null
)
1949 return $this->getUsers($limit);
1953 public function getTotalCount()
1955 return $this->getTotalUserCount();
1958 public function getTotalUserCount()
1960 if (is_null($this->lastusercount
)) {
1961 $this->requireAccounts();
1962 $this->buildQuery();
1963 return (int)XDB
::fetchOneCell('SELECT COUNT(DISTINCT a.uid)
1966 return $this->lastusercount
;
1970 public function getTotalProfileCount()
1972 if (is_null($this->lastprofilecount
)) {
1973 $this->requireProfiles();
1974 $this->buildQuery();
1975 return (int)XDB
::fetchOneCell('SELECT COUNT(DISTINCT p.pid)
1978 return $this->lastprofilecount
;
1982 public function setCondition(PlFilterCondition
&$cond)
1984 $this->root
=& $cond;
1985 $this->query
= null
;
1988 public function addSort(PlFilterOrder
&$sort)
1990 if (count($this->sort
) == 0 && $sort instanceof PlFilterGroupableOrder
)
1992 $this->grouper
= $sort;
1994 $this->sort
[] = $sort;
1995 $this->orderby
= null
;
1998 static public function getLegacy($promo_min, $promo_max)
2000 if ($promo_min != 0) {
2001 $min = new UFC_Promo('>=', self
::GRADE_ING
, intval($promo_min));
2003 $min = new PFC_True();
2005 if ($promo_max != 0) {
2006 $max = new UFC_Promo('<=', self
::GRADE_ING
, intval($promo_max));
2008 $max = new PFC_True();
2010 return new UserFilter(new PFC_And($min, $max));
2013 static public function sortByName()
2015 return array(new UFO_Name(Profile
::LASTNAME
), new UFO_Name(Profile
::FIRSTNAME
));
2018 static public function sortByPromo()
2020 return array(new UFO_Promo(), new UFO_Name(Profile
::LASTNAME
), new UFO_Name(Profile
::FIRSTNAME
));
2023 static private function getDBSuffix($string)
2025 if (is_array($string)) {
2026 if (count($string) == 1) {
2027 return self
::getDBSuffix(array_pop($string));
2029 return md5(implode('|', $string));
2031 return preg_replace('/[^a-z0-9]/i', '', $string);
2036 /** Stores a new (and unique) table alias in the &$table table
2037 * @param &$table Array in which the table alias must be stored
2038 * @param $val Value which will then be used to build the join
2039 * @return Name of the newly created alias
2041 private $option = 0;
2042 private function register_optional(array &$table, $val)
2044 if (is_null($val)) {
2045 $sub = $this->option++
;
2048 $sub = self
::getDBSuffix($val);
2052 $table[$sub] = $index;
2056 /** PROFILE VS ACCOUNT
2058 private $with_profiles = false
;
2059 private $with_accounts = false
;
2060 public function requireAccounts()
2062 $this->with_accounts
= true
;
2065 public function accountsRequired()
2067 return $this->with_accounts
;
2070 public function requireProfiles()
2072 $this->with_profiles
= true
;
2075 public function profilesRequired()
2077 return $this->with_profiles
;
2080 protected function accountJoins()
2083 if ($this->with_profiles
&& $this->with_accounts
) {
2084 $joins['ap'] = PlSqlJoin
::left('account_profiles', '$ME.uid = $UID AND FIND_IN_SET(\'owner\', ap.perms)');
2085 $joins['p'] = PlSqlJoin
::left('profiles', '$PID = ap.pid');
2092 const DISPLAY
= 'display';
2093 private $pd = false
;
2094 public function addDisplayFilter()
2096 $this->requireProfiles();
2101 protected function displayJoins()
2104 return array('pd' => PlSqlJoin
::left('profile_display', '$ME.pid = $PID'));
2113 private $with_logger = false
;
2114 public function addLoggerFilter()
2116 $this->with_logger
= true
;
2117 $this->requireAccounts();
2120 protected function loggerJoins()
2123 if ($this->with_logger
) {
2124 $joins['ls'] = PlSqlJoin
::left('log_sessions', '$ME.uid = $UID');
2132 static public function assertName($name)
2134 if (!DirEnum
::getID(DirEnum
::NAMETYPES
, $name)) {
2135 Platal
::page()->kill('Invalid name type: ' . $name);
2139 private $pn = array();
2140 public function addNameFilter($type, $variant = null
)
2142 $this->requireProfiles();
2143 if (!is_null($variant)) {
2144 $ft = $type . '_' . $variant;
2149 self
::assertName($ft);
2151 if (!is_null($variant) && $variant == 'other') {
2152 $sub .= $this->option++
;
2154 $this->pn
[$sub] = DirEnum
::getID(DirEnum
::NAMETYPES
, $ft);
2158 protected function nameJoins()
2161 foreach ($this->pn
as $sub => $type) {
2162 $joins['pn' . $sub] = PlSqlJoin
::left('profile_name', '$ME.pid = $PID AND $ME.typeid = {?}', $type);
2169 private $name_tokens = array();
2170 private $nb_tokens = 0;
2172 public function addNameTokensFilter($token)
2174 $this->requireProfiles();
2175 $sub = 'sn' . (1 +
$this->nb_tokens
);
2177 $this->name_tokens
[$sub] = $token;
2181 protected function nameTokensJoins()
2183 /* We don't return joins, since with_sn forces the SELECT to run on search_name first */
2185 foreach ($this->name_tokens
as $sub => $token) {
2186 $joins[$sub] = PlSqlJoin
::left('search_name', '$ME.pid = $PID');
2191 public function getNameTokens()
2193 return $this->name_tokens
;
2199 private $with_nat = false
;
2200 public function addNationalityFilter()
2202 $this->with_nat
= true
;
2206 protected function nationalityJoins()
2209 if ($this->with_nat
) {
2210 $joins['ngc'] = PlSqlJoin
::left('geoloc_countries', '$ME.iso_3166_1_a2 = p.nationality1 OR $ME.iso_3166_1_a2 = p.nationality2 OR $ME.iso_3166_1_a2 = p.nationality3');
2217 const GRADE_ING
= 'Ing.';
2218 const GRADE_PHD
= 'PhD';
2219 const GRADE_MST
= 'M%';
2220 static public function isGrade($grade)
2222 return ($grade !== 0) && ($grade == self
::GRADE_ING ||
$grade == self
::GRADE_PHD ||
$grade == self
::GRADE_MST
);
2225 static public function assertGrade($grade)
2227 if (!self
::isGrade($grade)) {
2228 Platal
::page()->killError("DiplĂ´me non valide: $grade");
2232 static public function promoYear($grade)
2234 // XXX: Definition of promotion for phds and masters might change in near future.
2235 return ($grade == UserFilter
::GRADE_ING
) ?
'entry_year' : 'grad_year';
2238 private $pepe = array();
2239 private $with_pee = false
;
2240 public function addEducationFilter($x = false
, $grade = null
)
2242 $this->requireProfiles();
2244 $index = $this->option
;
2245 $sub = $this->option++
;
2247 self
::assertGrade($grade);
2250 $this->with_pee
= true
;
2253 $this->pepe
[$index] = $sub;
2257 protected function educationJoins()
2260 if ($this->with_pee
) {
2261 $joins['pee'] = PlSqlJoin
::inner('profile_education_enum', 'pee.abbreviation = \'X\'');
2263 foreach ($this->pepe
as $grade => $sub) {
2264 if ($this->isGrade($grade)) {
2265 $joins['pe' . $sub] = PlSqlJoin
::left('profile_education', '$ME.eduid = pee.id AND $ME.pid = $PID');
2266 $joins['pede' . $sub] = PlSqlJoin
::inner('profile_education_degree_enum', '$ME.id = pe' . $sub . '.degreeid AND $ME.abbreviation LIKE {?}', $grade);
2268 $joins['pe' . $sub] = PlSqlJoin
::left('profile_education', '$ME.pid = $PID');
2269 $joins['pee' . $sub] = PlSqlJoin
::inner('profile_education_enum', '$ME.id = pe' . $sub . '.eduid');
2270 $joins['pede' . $sub] = PlSqlJoin
::inner('profile_education_degree_enum', '$ME.id = pe' . $sub . '.degreeid');
2279 private $gpm = array();
2280 public function addGroupFilter($group = null
)
2282 $this->requireAccounts();
2283 if (!is_null($group)) {
2284 if (is_int($group) ||
ctype_digit($group)) {
2285 $index = $sub = $group;
2288 $sub = self
::getDBSuffix($group);
2291 $sub = 'group_' . $this->option++
;
2295 $this->gpm
[$sub] = $index;
2299 protected function groupJoins()
2302 foreach ($this->gpm
as $sub => $key) {
2303 if (is_null($key)) {
2304 $joins['gpa' . $sub] = PlSqlJoin
::inner('groups');
2305 $joins['gpm' . $sub] = PlSqlJoin
::left('group_members', '$ME.uid = $UID AND $ME.asso_id = gpa' . $sub . '.id');
2306 } else if (is_int($key) ||
ctype_digit($key)) {
2307 $joins['gpm' . $sub] = PlSqlJoin
::left('group_members', '$ME.uid = $UID AND $ME.asso_id = ' . $key);
2309 $joins['gpa' . $sub] = PlSqlJoin
::inner('groups', '$ME.diminutif = {?}', $key);
2310 $joins['gpm' . $sub] = PlSqlJoin
::left('group_members', '$ME.uid = $UID AND $ME.asso_id = gpa' . $sub . '.id');
2319 private $with_bi = false
;
2320 private $with_bd = false
;
2321 public function addBinetsFilter($with_enum = false
)
2323 $this->requireProfiles();
2324 $this->with_bi
= true
;
2326 $this->with_bd
= true
;
2333 protected function binetsJoins()
2336 if ($this->with_bi
) {
2337 $joins['bi'] = PlSqlJoin
::left('profile_binets', '$ME.pid = $PID');
2339 if ($this->with_bd
) {
2340 $joins['bd'] = PlSqlJoin
::left('profile_binet_enum', '$ME.id = bi.binet_id');
2347 private $e = array();
2348 public function addEmailRedirectFilter($email = null
)
2350 $this->requireAccounts();
2351 return $this->register_optional($this->e
, $email);
2354 private $ve = array();
2355 public function addVirtualEmailFilter($email = null
)
2357 $this->addAliasFilter(self
::ALIAS_FORLIFE
);
2358 return $this->register_optional($this->ve
, $email);
2361 const ALIAS_BEST
= 'bestalias';
2362 const ALIAS_FORLIFE
= 'forlife';
2363 private $al = array();
2364 public function addAliasFilter($alias = null
)
2366 $this->requireAccounts();
2367 return $this->register_optional($this->al
, $alias);
2370 protected function emailJoins()
2374 foreach ($this->e
as $sub=>$key) {
2375 if (is_null($key)) {
2376 $joins['e' . $sub] = PlSqlJoin
::left('emails', '$ME.uid = $UID AND $ME.flags != \'filter\'');
2378 if (!is_array($key)) {
2381 $joins['e' . $sub] = PlSqlJoin
::left('emails', '$ME.uid = $UID AND $ME.flags != \'filter\'
2382 AND $ME.email IN {?}', $key);
2385 foreach ($this->al
as $sub=>$key) {
2386 if (is_null($key)) {
2387 $joins['al' . $sub] = PlSqlJoin
::left('aliases', '$ME.uid = $UID AND $ME.type IN (\'alias\', \'a_vie\')');
2388 } else if ($key == self
::ALIAS_BEST
) {
2389 $joins['al' . $sub] = PlSqlJoin
::left('aliases', '$ME.uid = $UID AND $ME.type IN (\'alias\', \'a_vie\') AND FIND_IN_SET(\'bestalias\', $ME.flags)');
2390 } else if ($key == self
::ALIAS_FORLIFE
) {
2391 $joins['al' . $sub] = PlSqlJoin
::left('aliases', '$ME.uid = $UID AND $ME.type = \'a_vie\'');
2393 if (!is_array($key)) {
2396 $joins['al' . $sub] = PlSqlJoin
::left('aliases', '$ME.uid = $UID AND $ME.type IN (\'alias\', \'a_vie\')
2397 AND $ME.alias IN {?}', $key);
2400 foreach ($this->ve
as $sub=>$key) {
2401 if (is_null($key)) {
2402 $joins['v' . $sub] = PlSqlJoin
::left('virtual', '$ME.type = \'user\'');
2404 if (!is_array($key)) {
2407 $joins['v' . $sub] = PlSqlJoin
::left('virtual', '$ME.type = \'user\' AND $ME.alias IN {?}', $key);
2409 $joins['vr' . $sub] = PlSqlJoin
::left('virtual_redirect',
2410 '$ME.vid = v' . $sub . '.vid
2411 AND ($ME.redirect IN (CONCAT(al_forlife.alias, \'@\', {?}),
2412 CONCAT(al_forlife.alias, \'@\', {?}),
2414 $globals->mail
->domain
, $globals->mail
->domain2
);
2422 private $with_pa = false
;
2423 public function addAddressFilter()
2425 $this->requireProfiles();
2426 $this->with_pa
= true
;
2430 private $with_pac = false
;
2431 public function addAddressCountryFilter()
2433 $this->requireProfiles();
2434 $this->addAddressFilter();
2435 $this->with_pac
= true
;
2439 private $with_pal = false
;
2440 public function addAddressLocalityFilter()
2442 $this->requireProfiles();
2443 $this->addAddressFilter();
2444 $this->with_pal
= true
;
2448 protected function addressJoins()
2451 if ($this->with_pa
) {
2452 $joins['pa'] = PlSqlJoin
::left('profile_addresses', '$ME.pid = $PID');
2454 if ($this->with_pac
) {
2455 $joins['gc'] = PlSqlJoin
::left('geoloc_countries', '$ME.iso_3166_1_a2 = pa.countryID');
2457 if ($this->with_pal
) {
2458 $joins['gl'] = PlSqlJoin
::left('geoloc_localities', '$ME.id = pa.localityID');
2467 private $pc = false
;
2468 private $pce = array();
2469 private $pcr = false
;
2470 public function addCorpsFilter($type)
2472 $this->requireProfiles();
2474 if ($type == UFC_Corps
::CURRENT
) {
2475 $pce['pcec'] = 'current_corpsid';
2477 } else if ($type == UFC_Corps
::ORIGIN
) {
2478 $pce['pceo'] = 'original_corpsid';
2483 public function addCorpsRankFilter()
2485 $this->requireProfiles();
2491 protected function corpsJoins()
2495 $joins['pc'] = PlSqlJoin
::left('profile_corps', '$ME.pid = $PID');
2498 $joins['pcr'] = PlSqlJoin
::left('profile_corps_rank_enum', '$ME.id = pc.rankid');
2500 foreach($this->pce
as $sub => $field) {
2501 $joins[$sub] = PlSqlJoin
::left('profile_corps_enum', '$ME.id = pc.' . $field);
2509 const JOB_SECTOR
= 0x0001;
2510 const JOB_SUBSECTOR
= 0x0002;
2511 const JOB_SUBSUBSECTOR
= 0x0004;
2512 const JOB_ALTERNATES
= 0x0008;
2513 const JOB_USERDEFINED
= 0x0010;
2514 const JOB_CV
= 0x0020;
2516 const JOB_SECTORIZATION
= 0x000F;
2517 const JOB_ANY
= 0x003F;
2521 * pje => profile_job_enum
2522 * pjse => profile_job_sector_enum
2523 * pjsse => profile_job_subsector_enum
2524 * pjssse => profile_job_subsubsector_enum
2525 * pja => profile_job_alternates
2526 * pjt => profile_job_terms
2528 private $with_pj = false
;
2529 private $with_pje = false
;
2530 private $with_pjse = false
;
2531 private $with_pjsse = false
;
2532 private $with_pjssse = false
;
2533 private $with_pja = false
;
2534 private $with_pjt = 0;
2536 public function addJobFilter()
2538 $this->requireProfiles();
2539 $this->with_pj
= true
;
2543 public function addJobCompanyFilter()
2545 $this->addJobFilter();
2546 $this->with_pje
= true
;
2550 public function addJobSectorizationFilter($type)
2552 $this->addJobFilter();
2553 if ($type == self
::JOB_SECTOR
) {
2554 $this->with_pjse
= true
;
2556 } else if ($type == self
::JOB_SUBSECTOR
) {
2557 $this->with_pjsse
= true
;
2559 } else if ($type == self
::JOB_SUBSUBSECTOR
) {
2560 $this->with_pjssse
= true
;
2562 } else if ($type == self
::JOB_ALTERNATES
) {
2563 $this->with_pja
= true
;
2569 * Adds a filter on job terms of profile.
2570 * @param $nb the number of job terms to use
2571 * @return an array of the fields to filter (one for each term).
2572 * Code using this function should used returned field as is (contains table and field name).
2574 public function addJobTermsFilter($nb = 1)
2576 $this->with_pjt
= $nb;
2577 $jobtermstable = array();
2578 for ($i = 1; $i <= $nb; ++
$i) {
2579 $jobtermstable[] = 'pjtr_'.$i.'.jtid_1';
2581 return $jobtermstable;
2584 protected function jobJoins()
2587 if ($this->with_pj
) {
2588 $joins['pj'] = PlSqlJoin
::left('profile_job', '$ME.pid = $PID');
2590 if ($this->with_pje
) {
2591 $joins['pje'] = PlSqlJoin
::left('profile_job_enum', '$ME.id = pj.jobid');
2593 if ($this->with_pjse
) {
2594 $joins['pjse'] = PlSqlJoin
::left('profile_job_sector_enum', '$ME.id = pj.sectorid');
2596 if ($this->with_pjsse
) {
2597 $joins['pjsse'] = PlSqlJoin
::left('profile_job_subsector_enum', '$ME.id = pj.subsectorid');
2599 if ($this->with_pjssse
) {
2600 $joins['pjssse'] = PlSqlJoin
::left('profile_job_subsubsector_enum', '$ME.id = pj.subsubsectorid');
2602 if ($this->with_pja
) {
2603 $joins['pja'] = PlSqlJoin
::left('profile_job_alternates', '$ME.subsubsectorid = pj.subsubsectorid');
2605 if ($this->with_pjt
> 0) {
2606 for ($i = 1; $i <= $this->with_pjt
; ++
$i) {
2607 $joins['pjt_'.$i] = PlSqlJoin
::left('profile_job_term', '$ME.pid = $PID');
2608 $joins['pjtr_'.$i] = PlSqlJoin
::left('profile_job_term_relation', '$ME.jtid_2 = pjt_'.$i.'.jtid');
2617 private $with_pnw = false
;
2618 public function addNetworkingFilter()
2620 $this->requireAccounts();
2621 $this->with_pnw
= true
;
2625 protected function networkingJoins()
2628 if ($this->with_pnw
) {
2629 $joins['pnw'] = PlSqlJoin
::left('profile_networking', '$ME.pid = $PID');
2637 private $with_ptel = false
;
2639 public function addPhoneFilter()
2641 $this->requireAccounts();
2642 $this->with_ptel
= true
;
2646 protected function phoneJoins()
2649 if ($this->with_ptel
) {
2650 $joins['ptel'] = PlSqlJoin
::left('profile_phones', '$ME.pid = $PID');
2658 private $with_pmed = false
;
2659 public function addMedalFilter()
2661 $this->requireProfiles();
2662 $this->with_pmed
= true
;
2666 protected function medalJoins()
2669 if ($this->with_pmed
) {
2670 $joins['pmed'] = PlSqlJoin
::left('profile_medals', '$ME.pid = $PID');
2678 private $pms = array();
2679 private $mjtr = false
;
2680 const MENTOR_EXPERTISE
= 1;
2681 const MENTOR_COUNTRY
= 2;
2682 const MENTOR_SECTOR
= 3;
2683 const MENTOR_TERM
= 4;
2685 public function addMentorFilter($type)
2687 $this->requireAccounts();
2689 case self
::MENTOR_EXPERTISE
:
2690 $this->pms
['pme'] = 'profile_mentor';
2692 case self
::MENTOR_COUNTRY
:
2693 $this->pms
['pmc'] = 'profile_mentor_country';
2695 case self
::MENTOR_SECTOR
:
2696 $this->pms
['pms'] = 'profile_mentor_sector';
2698 case self
::MENTOR_TERM
:
2699 $this->pms
['pmt'] = 'profile_mentor_term';
2703 Platal
::page()->killError("Undefined mentor filter.");
2707 protected function mentorJoins()
2710 foreach ($this->pms
as $sub => $tab) {
2711 $joins[$sub] = PlSqlJoin
::left($tab, '$ME.pid = $PID');
2714 $joins['mjtr'] = PlSqlJoin
::left('profile_job_term_relation', '$ME.jtid_2 = pmt.jtid');
2721 private $cts = array();
2722 public function addContactFilter($uid = null
)
2724 $this->requireProfiles();
2725 return $this->register_optional($this->cts
, is_null($uid) ? null
: 'user_' . $uid);
2728 protected function contactJoins()
2731 foreach ($this->cts
as $sub=>$key) {
2732 if (is_null($key)) {
2733 $joins['c' . $sub] = PlSqlJoin
::left('contacts', '$ME.contact = $PID');
2735 $joins['c' . $sub] = PlSqlJoin
::left('contacts', '$ME.uid = {?} AND $ME.contact = $PID', substr($key, 5));
2744 private $wn = array();
2745 public function addWatchRegistrationFilter($uid = null
)
2747 $this->requireAccounts();
2748 return $this->register_optional($this->wn
, is_null($uid) ? null
: 'user_' . $uid);
2751 private $wp = array();
2752 public function addWatchPromoFilter($uid = null
)
2754 $this->requireAccounts();
2755 return $this->register_optional($this->wp
, is_null($uid) ? null
: 'user_' . $uid);
2758 private $w = array();
2759 public function addWatchFilter($uid = null
)
2761 $this->requireAccounts();
2762 return $this->register_optional($this->w
, is_null($uid) ? null
: 'user_' . $uid);
2765 protected function watchJoins()
2768 foreach ($this->w
as $sub=>$key) {
2769 if (is_null($key)) {
2770 $joins['w' . $sub] = PlSqlJoin
::left('watch');
2772 $joins['w' . $sub] = PlSqlJoin
::left('watch', '$ME.uid = {?}', substr($key, 5));
2775 foreach ($this->wn
as $sub=>$key) {
2776 if (is_null($key)) {
2777 $joins['wn' . $sub] = PlSqlJoin
::left('watch_nonins', '$ME.ni_id = $UID');
2779 $joins['wn' . $sub] = PlSqlJoin
::left('watch_nonins', '$ME.uid = {?} AND $ME.ni_id = $UID', substr($key, 5));
2782 foreach ($this->wn
as $sub=>$key) {
2783 if (is_null($key)) {
2784 $joins['wn' . $sub] = PlSqlJoin
::left('watch_nonins', '$ME.ni_id = $UID');
2786 $joins['wn' . $sub] = PlSqlJoin
::left('watch_nonins', '$ME.uid = {?} AND $ME.ni_id = $UID', substr($key, 5));
2789 foreach ($this->wp
as $sub=>$key) {
2790 if (is_null($key)) {
2791 $joins['wp' . $sub] = PlSqlJoin
::left('watch_promo');
2793 $joins['wp' . $sub] = PlSqlJoin
::left('watch_promo', '$ME.uid = {?}', substr($key, 5));
2802 private $with_photo;
2803 public function addPhotoFilter()
2805 $this->requireProfiles();
2806 $this->with_photo
= true
;
2809 protected function photoJoins()
2811 if ($this->with_photo
) {
2812 return array('photo' => PlSqlJoin
::left('profile_photos', '$ME.pid = $PID'));
2822 public function addMarketingHash()
2824 $this->requireAccounts();
2825 $this->with_rm
= true
;
2828 protected function marketingJoins()
2830 if ($this->with_rm
) {
2831 return array('rm' => PlSqlJoin
::left('register_marketing', '$ME.uid = $UID'));
2839 // {{{ class ProfileFilter
2840 class ProfileFilter
extends UserFilter
2842 public function get($limit = null
)
2844 return $this->getProfiles($limit);
2847 public function filter(array $profiles, $limit = null
)
2849 return $this->filterProfiles($profiles, self
::defaultLimit($limit));
2852 public function getTotalCount()
2854 return $this->getTotalProfileCount();
2857 public function getGroups()
2859 return $this->getPIDGroups();
2864 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: