Moves referent search from profile to search module
[platal.git] / classes / userfilter.php
CommitLineData
a087cc8d
FB
1<?php
2/***************************************************************************
d4c08d89 3 * Copyright (C) 2003-2010 Polytechnique.org *
a087cc8d
FB
4 * http://opensource.polytechnique.org/ *
5 * *
6 * This program is free software; you can redistribute it and/or modify *
7 * it under the terms of the GNU General Public License as published by *
8 * the Free Software Foundation; either version 2 of the License, or *
9 * (at your option) any later version. *
10 * *
11 * This program is distributed in the hope that it will be useful, *
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
14 * GNU General Public License for more details. *
15 * *
16 * You should have received a copy of the GNU General Public License *
17 * along with this program; if not, write to the Free Software *
18 * Foundation, Inc., *
19 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA *
20 ***************************************************************************/
21
d865c296
FB
22
23/******************
24 * CONDITIONS
25 ******************/
26
8363588b 27// {{{ interface UserFilterCondition
2d83cac9
RB
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
35 * with the filter.
36 */
dcc63ed5 37interface UserFilterCondition extends PlFilterCondition
a087cc8d 38{
a087cc8d 39}
8363588b 40// }}}
a087cc8d 41
77902bed 42// {{{ class UFC_HasProfile
53eae167
RB
43/** Filters users who have a profile
44 */
77902bed 45class UFC_HasProfile implements UserFilterCondition
eb1449b8 46{
dcc63ed5 47 public function buildCondition(PlFilter &$uf)
eb1449b8 48 {
aaf70eb8 49 $uf->requireProfiles();
93b0da52 50 return '$PID IS NOT NULL';
eb1449b8
FB
51 }
52}
8363588b 53// }}}
eb1449b8 54
ddba9d4f
RB
55// {{{ class UFC_Hruid
56/** Filters users based on their hruid
57 * @param $val Either an hruid, or a list of those
58 */
59class UFC_Hruid implements UserFilterCondition
60{
61 private $hruids;
62
61d1fd8b 63 public function __construct()
ddba9d4f 64 {
61d1fd8b 65 $this->hruids = pl_flatten(func_get_args());
ddba9d4f
RB
66 }
67
68 public function buildCondition(PlFilter &$uf)
69 {
7752f73f 70 $uf->requireAccounts();
bde68f05 71 return XDB::format('a.hruid IN {?}', $this->hruids);
ddba9d4f
RB
72 }
73}
74// }}}
75
3e993f7a
FB
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
79 */
80class UFC_Hrpid implements UserFilterCondition
81{
82 private $hrpids;
83
61d1fd8b 84 public function __construct()
3e993f7a 85 {
61d1fd8b 86 $this->hrpids = pl_flatten(func_get_args());
3e993f7a
FB
87 }
88
89 public function buildCondition(PlFilter &$uf)
90 {
91 $uf->requireProfiles();
bde68f05 92 return XDB::format('p.hrpid IN {?}', $this->hrpids);
3e993f7a
FB
93 }
94}
95// }}}
96
f73a4f1b
RB
97// {{{ class UFC_Ip
98/** Filters users based on one of their last IPs
99 * @param $ip IP from which connection are checked
100 */
101class UFC_Ip implements UserFilterCondition
102{
103 private $ip;
104
105 public function __construct($ip)
106 {
107 $this->ip = $ip;
108 }
109
110 public function buildCondition(PlFilter &$uf)
111 {
112 $sub = $uf->addLoggerFilter();
113 $ip = ip_to_uint($this->ip);
114 return XDB::format($sub . '.ip = {?} OR ' . $sub . '.forward_ip = {?}', $ip, $ip);
115 }
116}
117// }}}
118
d7ddf29b
RB
119// {{{ class UFC_Comment
120class UFC_Comment implements UserFilterCondition
121{
122 private $text;
123
124 public function __construct($text)
125 {
126 $this->text = $text;
127 }
128
129 public function buildCondition(PlFilter &$uf)
130 {
131 $uf->requireProfiles();
658b4c83 132 return 'p.freetext ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->text);
d7ddf29b
RB
133 }
134}
135// }}}
136
8363588b 137// {{{ class UFC_Promo
5d2e55c7 138/** Filters users based on promotion
53eae167
RB
139 * @param $comparison Comparison operator (>, =, ...)
140 * @param $grade Formation on which to restrict, UserFilter::DISPLAY for "any formation"
5d2e55c7 141 * @param $promo Promotion on which the filter is based
53eae167 142 */
a087cc8d
FB
143class UFC_Promo implements UserFilterCondition
144{
a087cc8d
FB
145
146 private $grade;
147 private $promo;
148 private $comparison;
149
150 public function __construct($comparison, $grade, $promo)
151 {
152 $this->grade = $grade;
153 $this->comparison = $comparison;
154 $this->promo = $promo;
38c6fe96
FB
155 if ($this->grade != UserFilter::DISPLAY) {
156 UserFilter::assertGrade($this->grade);
157 }
6c1e97ae 158 if ($this->grade == UserFilter::DISPLAY && $this->comparison != '=') {
999db5aa
RB
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)");
6c1e97ae 161 }
a087cc8d
FB
162 }
163
dcc63ed5 164 public function buildCondition(PlFilter &$uf)
a087cc8d 165 {
38c6fe96
FB
166 if ($this->grade == UserFilter::DISPLAY) {
167 $sub = $uf->addDisplayFilter();
1a23a02b 168 return XDB::format('pd' . $sub . '.promo ' . $this->comparison . ' {?}', $this->promo);
38c6fe96
FB
169 } else {
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);
173 }
784745ce
FB
174 }
175}
8363588b 176// }}}
784745ce 177
9e8bacfb
FB
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
182 */
57f8776b 183class UFC_SchoolId implements UserFilterCondition
9e8bacfb
FB
184{
185 const AX = 'ax';
186 const Xorg = 'xorg';
187 const School = 'school';
188
189 private $type;
190 private $id;
191
192 static public function assertType($type)
193 {
194 if ($type != self::AX && $type != self::Xorg && $type != self::School) {
195 Platal::page()->killError("Type de matricule invalide: $type");
196 }
197 }
198
199 public function __construct($type, $id)
200 {
201 $this->type = $type;
202 $this->id = $id;
203 self::assertType($type);
204 }
205
206 public function buildCondition(PlFilter &$uf)
207 {
208 $uf->requireProfiles();
209 $id = $this->id;
210 $type = $this->type;
211 if ($type == self::School) {
212 $type = self::Xorg;
213 $id = Profile::getXorgId($id);
214 }
215 return XDB::format('p.' . $type . '_id = {?}', $id);
216 }
217}
218// }}}
219
fb3b6547 220// {{{ class UFC_EducationSchool
d7ddf29b
RB
221/** Filters users by formation
222 * @param $val The formation to search (either ID or array of IDs)
223 */
fb3b6547 224class UFC_EducationSchool implements UserFilterCondition
a7f8e48a 225{
d7ddf29b 226 private $val;
a7f8e48a 227
61d1fd8b 228 public function __construct()
a7f8e48a 229 {
61d1fd8b 230 $this->val = pl_flatten(func_get_args());
a7f8e48a
RB
231 }
232
233 public function buildCondition(PlFilter &$uf)
234 {
235 $sub = $uf->addEducationFilter();
bde68f05 236 return XDB::format('pe' . $sub . '.eduid IN {?}', $this->val);
a7f8e48a
RB
237 }
238}
239// }}}
240
fb3b6547
RB
241// {{{ class UFC_EducationDegree
242class UFC_EducationDegree implements UserFilterCondition
d7ddf29b
RB
243{
244 private $diploma;
245
61d1fd8b 246 public function __construct()
d7ddf29b 247 {
61d1fd8b 248 $this->diploma = pl_flatten(func_get_args());
d7ddf29b
RB
249 }
250
251 public function buildCondition(PlFilter &$uf)
252 {
253 $sub = $uf->addEducationFilter();
d115b6df 254 return XDB::format('pe' . $sub . '.degreeid IN {?}', $this->diploma);
d7ddf29b
RB
255 }
256}
257// }}}
258
fb3b6547
RB
259// {{{ class UFC_EducationField
260class UFC_EducationField implements UserFilterCondition
d7ddf29b
RB
261{
262 private $val;
263
61d1fd8b 264 public function __construct()
d7ddf29b 265 {
61d1fd8b 266 $this->val = pl_flatten(func_get_args());
d7ddf29b
RB
267 }
268
269 public function buildCondition(PlFilter &$uf)
270 {
271 $sub = $uf->addEducationFilter();
4290d54e 272 return XDB::format('pe' . $sub . '.fieldid IN {?}', $this->val);
d7ddf29b
RB
273 }
274}
275// }}}
276
8363588b 277// {{{ class UFC_Name
53eae167 278/** Filters users based on name
5d2e55c7 279 * @param $type Type of name field on which filtering is done (firstname, lastname...)
53eae167 280 * @param $text Text on which to filter
5d2e55c7 281 * @param $mode Flag indicating search type (prefix, suffix, with particule...)
53eae167 282 */
784745ce
FB
283class UFC_Name implements UserFilterCondition
284{
706f7a0f
RB
285 const EXACT = XDB::WILDCARD_EXACT; // 0x000
286 const PREFIX = XDB::WILDCARD_PREFIX; // 0x001
287 const SUFFIX = XDB::WILDCARD_SUFFIX; // 0x002
658b4c83 288 const CONTAINS = XDB::WILDCARD_CONTAINS; // 0x003
5bb60f74 289 const PARTICLE = 0x004;
658b4c83 290 const VARIANTS = 0x008;
784745ce
FB
291
292 private $type;
293 private $text;
294 private $mode;
295
296 public function __construct($type, $text, $mode)
297 {
298 $this->type = $type;
299 $this->text = $text;
300 $this->mode = $mode;
301 }
302
303 private function buildNameQuery($type, $variant, $where, UserFilter &$uf)
304 {
305 $sub = $uf->addNameFilter($type, $variant);
306 return str_replace('$ME', 'pn' . $sub, $where);
307 }
308
dcc63ed5 309 public function buildCondition(PlFilter &$uf)
784745ce
FB
310 {
311 $left = '$ME.name';
784745ce
FB
312 if (($this->mode & self::PARTICLE) == self::PARTICLE) {
313 $left = 'CONCAT($ME.particle, \' \', $ME.name)';
314 }
658b4c83
RB
315 $right = XDB::formatWildcards($this->mode & self::CONTAINS, $this->text);
316
317 $cond = $left . $right;
784745ce 318 $conds = array($this->buildNameQuery($this->type, null, $cond, $uf));
913a4e90
RB
319 if (($this->mode & self::VARIANTS) != 0 && isset(Profile::$name_variants[$this->type])) {
320 foreach (Profile::$name_variants[$this->type] as $var) {
784745ce
FB
321 $conds[] = $this->buildNameQuery($this->type, $var, $cond, $uf);
322 }
323 }
324 return implode(' OR ', $conds);
a087cc8d
FB
325 }
326}
8363588b 327// }}}
a087cc8d 328
40585144
RB
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
334 */
335class UFC_NameTokens implements UserFilterCondition
336{
337 /* Flags */
338 const FLAG_PUBLIC = 'public';
339
340 private $tokens;
341 private $flags;
342 private $soundex;
79a0b464 343 private $exact;
40585144 344
79a0b464 345 public function __construct($tokens, $flags = array(), $soundex = false, $exact = false)
40585144 346 {
a867dfba
RB
347 if (is_array($tokens)) {
348 $this->tokens = $tokens;
349 } else {
350 $this->tokens = array($tokens);
351 }
40585144
RB
352 if (is_array($flags)) {
353 $this->flags = $flags;
354 } else {
355 $this->flags = array($flags);
356 }
357 $this->soundex = $soundex;
79a0b464 358 $this->exact = $exact;
40585144
RB
359 }
360
dcc63ed5 361 public function buildCondition(PlFilter &$uf)
40585144 362 {
40585144 363 $conds = array();
2a93b634
RB
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);
370 } else {
371 $c = $sub . '.token ' . XDB::formatWildcards(XDB::WILDCARD_PREFIX, $token);
40585144 372 }
2a93b634
RB
373 if ($this->flags != null) {
374 $c .= XDB::format(' AND ' . $sub . '.flags IN {?}', $this->flags);
375 }
376 $conds[] = $c;
40585144
RB
377 }
378
379 return implode(' AND ', $conds);
380 }
381}
382// }}}
383
0fb3713c
RB
384// {{{ class UFC_Nationality
385class UFC_Nationality implements UserFilterCondition
386{
d7ddf29b 387 private $val;
0fb3713c 388
61d1fd8b 389 public function __construct()
0fb3713c 390 {
61d1fd8b 391 $this->val = pl_flatten(func_get_args());
0fb3713c
RB
392 }
393
394 public function buildCondition(PlFilter &$uf)
395 {
d7ddf29b
RB
396 $uf->requireProfiles();
397 $nat = XDB::formatArray($this->val);
398 $conds = array(
399 'p.nationality1 IN ' . $nat,
400 'p.nationality2 IN ' . $nat,
401 'p.nationality3 IN ' . $nat,
402 );
403 return implode(' OR ', $conds);
0fb3713c
RB
404 }
405}
406// }}}
407
8363588b 408// {{{ class UFC_Dead
53eae167
RB
409/** Filters users based on death date
410 * @param $comparison Comparison operator
8fcb783a 411 * @param $date Date to which death date should be compared (DateTime object, string or timestamp)
53eae167 412 */
4927ee54
FB
413class UFC_Dead implements UserFilterCondition
414{
38c6fe96
FB
415 private $comparison;
416 private $date;
417
418 public function __construct($comparison = null, $date = null)
4927ee54 419 {
38c6fe96 420 $this->comparison = $comparison;
a0d47f5c 421 $this->date = make_datetime($date);
4927ee54
FB
422 }
423
dcc63ed5 424 public function buildCondition(PlFilter &$uf)
4927ee54 425 {
d7ddf29b 426 $uf->requireProfiles();
38c6fe96
FB
427 $str = 'p.deathdate IS NOT NULL';
428 if (!is_null($this->comparison)) {
8fcb783a 429 $str .= ' AND p.deathdate ' . $this->comparison . ' ' . XDB::format('{?}', $this->date->format('Y-m-d'));
4927ee54 430 }
38c6fe96 431 return $str;
4927ee54
FB
432 }
433}
8363588b 434// }}}
4927ee54 435
8363588b 436// {{{ class UFC_Registered
53eae167
RB
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
441 */
4927ee54
FB
442class UFC_Registered implements UserFilterCondition
443{
444 private $active;
38c6fe96
FB
445 private $comparison;
446 private $date;
447
448 public function __construct($active = false, $comparison = null, $date = null)
4927ee54 449 {
b2e8fc54 450 $this->active = $active;
38c6fe96 451 $this->comparison = $comparison;
a0d47f5c 452 $this->date = make_datetime($date);
4927ee54
FB
453 }
454
dcc63ed5 455 public function buildCondition(PlFilter &$uf)
4927ee54 456 {
d7ddf29b 457 $uf->requireAccounts();
4927ee54 458 if ($this->active) {
93b0da52 459 $date = '$UID IS NOT NULL AND a.state = \'active\'';
4927ee54 460 } else {
93b0da52 461 $date = '$UID IS NOT NULL AND a.state != \'pending\'';
38c6fe96
FB
462 }
463 if (!is_null($this->comparison)) {
c9c74e4f 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'));
4927ee54 465 }
38c6fe96 466 return $date;
4927ee54
FB
467 }
468}
8363588b 469// }}}
4927ee54 470
8363588b 471// {{{ class UFC_ProfileUpdated
53eae167
RB
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
475 */
7e735012
FB
476class UFC_ProfileUpdated implements UserFilterCondition
477{
478 private $comparison;
479 private $date;
480
481 public function __construct($comparison = null, $date = null)
482 {
483 $this->comparison = $comparison;
484 $this->date = $date;
485 }
486
dcc63ed5 487 public function buildCondition(PlFilter &$uf)
7e735012 488 {
d7ddf29b 489 $uf->requireProfiles();
7e735012
FB
490 return 'p.last_change ' . $this->comparison . XDB::format(' {?}', date('Y-m-d H:i:s', $this->date));
491 }
492}
8363588b 493// }}}
7e735012 494
8363588b 495// {{{ class UFC_Birthday
53eae167
RB
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
499 */
7e735012
FB
500class UFC_Birthday implements UserFilterCondition
501{
502 private $comparison;
503 private $date;
504
505 public function __construct($comparison = null, $date = null)
506 {
507 $this->comparison = $comparison;
508 $this->date = $date;
509 }
510
dcc63ed5 511 public function buildCondition(PlFilter &$uf)
7e735012 512 {
d7ddf29b 513 $uf->requireProfiles();
7e735012
FB
514 return 'p.next_birthday ' . $this->comparison . XDB::format(' {?}', date('Y-m-d', $this->date));
515 }
516}
8363588b 517// }}}
7e735012 518
8363588b 519// {{{ class UFC_Sex
53eae167
RB
520/** Filters users based on sex
521 * @parm $sex One of User::GENDER_MALE or User::GENDER_FEMALE, for selecting users
522 */
4927ee54
FB
523class UFC_Sex implements UserFilterCondition
524{
525 private $sex;
526 public function __construct($sex)
527 {
528 $this->sex = $sex;
529 }
530
dcc63ed5 531 public function buildCondition(PlFilter &$uf)
4927ee54
FB
532 {
533 if ($this->sex != User::GENDER_MALE && $this->sex != User::GENDER_FEMALE) {
534 return self::COND_FALSE;
535 } else {
d7ddf29b 536 $uf->requireProfiles();
24e08e33 537 return XDB::format('p.sex = {?}', $this->sex == User::GENDER_FEMALE ? 'female' : 'male');
4927ee54
FB
538 }
539 }
540}
8363588b 541// }}}
4927ee54 542
8363588b 543// {{{ class UFC_Group
53eae167 544/** Filters users based on group membership
5d2e55c7
RB
545 * @param $group Group whose members we are selecting
546 * @param $anim Whether to restrict selection to animators of that group
53eae167 547 */
4927ee54
FB
548class UFC_Group implements UserFilterCondition
549{
550 private $group;
5d2e55c7
RB
551 private $anim;
552 public function __construct($group, $anim = false)
4927ee54
FB
553 {
554 $this->group = $group;
5d2e55c7 555 $this->anim = $anim;
4927ee54
FB
556 }
557
dcc63ed5 558 public function buildCondition(PlFilter &$uf)
4927ee54
FB
559 {
560 $sub = $uf->addGroupFilter($this->group);
561 $where = 'gpm' . $sub . '.perms IS NOT NULL';
5d2e55c7 562 if ($this->anim) {
4927ee54
FB
563 $where .= ' AND gpm' . $sub . '.perms = \'admin\'';
564 }
565 return $where;
566 }
567}
8363588b 568// }}}
4927ee54 569
0fb3713c 570// {{{ class UFC_Binet
d7ddf29b
RB
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
573 */
0fb3713c
RB
574class UFC_Binet implements UserFilterCondition
575{
d7ddf29b 576 private $val;
0fb3713c 577
61d1fd8b 578 public function __construct()
0fb3713c 579 {
61d1fd8b 580 $this->val = pl_flatten(func_get_args());
0fb3713c
RB
581 }
582
583 public function buildCondition(PlFilter &$uf)
584 {
d7ddf29b 585 $sub = $uf->addBinetsFilter();
bde68f05 586 return XDB::format($sub . '.binet_id IN {?}', $this->val);
a7f8e48a
RB
587 }
588}
589// }}}
590
591// {{{ class UFC_Section
46e88fe3
RB
592/** Selects users based on section
593 * @param $section ID of the section
594 */
a7f8e48a
RB
595class UFC_Section implements UserFilterCondition
596{
597 private $section;
598
61d1fd8b 599 public function __construct()
a7f8e48a 600 {
61d1fd8b 601 $this->section = pl_flatten(func_get_args());
a7f8e48a
RB
602 }
603
604 public function buildCondition(PlFilter &$uf)
605 {
606 $uf->requireProfiles();
61d1fd8b 607 return XDB::format('p.section IN {?}', $this->section);
0fb3713c
RB
608 }
609}
610// }}}
611
8363588b 612// {{{ class UFC_Email
2d6329a2 613/** Filters users based on an email or a list of emails
53eae167
RB
614 * @param $emails List of emails whose owner must be selected
615 */
2d6329a2 616class UFC_Email implements UserFilterCondition
21401768
FB
617{
618 private $emails;
2d6329a2 619 public function __construct()
21401768 620 {
61d1fd8b 621 $this->emails = pl_flatten(func_get_args());
21401768
FB
622 }
623
dcc63ed5 624 public function buildCondition(PlFilter &$uf)
21401768 625 {
2d6329a2
FB
626 $foreign = array();
627 $virtual = array();
628 $aliases = array();
21401768
FB
629 $cond = array();
630
631 if (count($this->emails) == 0) {
dcc63ed5 632 return PlFilterCondition::COND_TRUE;
21401768
FB
633 }
634
635 foreach ($this->emails as $entry) {
636 if (User::isForeignEmailAddress($entry)) {
2d6329a2 637 $foreign[] = $entry;
21401768 638 } else if (User::isVirtualEmailAddress($entry)) {
2d6329a2 639 $virtual[] = $entry;
21401768 640 } else {
21401768 641 @list($user, $domain) = explode('@', $entry);
2d6329a2 642 $aliases[] = $user;
21401768
FB
643 }
644 }
2d6329a2
FB
645
646 if (count($foreign) > 0) {
647 $sub = $uf->addEmailRedirectFilter($foreign);
bde68f05 648 $cond[] = XDB::format('e' . $sub . '.email IS NOT NULL OR a.email IN {?}', $foreign);
2d6329a2
FB
649 }
650 if (count($virtual) > 0) {
651 $sub = $uf->addVirtualEmailFilter($virtual);
652 $cond[] = 'vr' . $sub . '.redirect IS NOT NULL';
653 }
654 if (count($aliases) > 0) {
655 $sub = $uf->addAliasFilter($aliases);
656 $cond[] = 'al' . $sub . '.alias IS NOT NULL';
657 }
21401768
FB
658 return '(' . implode(') OR (', $cond) . ')';
659 }
660}
8363588b 661// }}}
d865c296 662
8363588b 663// {{{ class UFC_Address
2b9ca54d 664abstract class UFC_Address implements UserFilterCondition
c4b24511 665{
2b9ca54d 666 /** Valid address type ('hq' is reserved for company addresses)
036d1637 667 */
2b9ca54d
RB
668 const TYPE_HOME = 1;
669 const TYPE_PRO = 2;
670 const TYPE_ANY = 3;
c4b24511 671
2b9ca54d 672 /** Text for these types
036d1637 673 */
2b9ca54d
RB
674 protected static $typetexts = array(
675 self::TYPE_HOME => 'home',
676 self::TYPE_PRO => 'pro',
677 );
678
679 protected $type;
c4b24511 680
036d1637
RB
681 /** Flags for addresses
682 */
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;
688
689 // Binary OR of those flags
690 const FLAG_ANY = 0x001F;
691
692 /** Text of these flags
693 */
2b9ca54d 694 protected static $flagtexts = array(
036d1637
RB
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',
700 );
701
2b9ca54d
RB
702 protected $flags;
703
704 public function __construct($type = null, $flags = null)
705 {
706 $this->type = $type;
707 $this->flags = $flags;
708 }
709
710 protected function initConds($sub)
711 {
712 $conds = array();
713 $types = array();
714 foreach (self::$typetexts as $flag => $type) {
715 if ($flag & $this->type) {
716 $types[] = $type;
717 }
718 }
719 if (count($types)) {
6b140032 720 $conds[] = XDB::format($sub . '.type IN {?}', $types);
2b9ca54d
RB
721 }
722
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)';
727 }
728 }
729 }
730 return $conds;
731 }
732
733}
734// }}}
735
736// {{{ class UFC_AddressText
737/** Select users based on their address, using full text search
738 * @param $text Text for filter in fulltext search
658b4c83 739 * @param $textSearchMode Mode for search (one of XDB::WILDCARD_*)
2b9ca54d
RB
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
744 */
745class UFC_AddressText extends UFC_Address
746{
2b9ca54d 747
036d1637 748 private $text;
2b9ca54d
RB
749 private $textSearchMode;
750
658b4c83 751 public function __construct($text = null, $textSearchMode = XDB::WILDCARD_CONTAINS,
2b9ca54d
RB
752 $type = null, $flags = self::FLAG_ANY, $country = null, $locality = null)
753 {
754 parent::__construct($type, $flags);
755 $this->text = $text;
756 $this->textSearchMode = $textSearchMode;
757 $this->country = $country;
758 $this->locality = $locality;
759 }
760
761 private function mkMatch($txt)
762 {
658b4c83 763 return XDB::formatWildcards($this->textSearchMode, $txt);
2b9ca54d
RB
764 }
765
766 public function buildCondition(PlFilter &$uf)
767 {
768 $sub = $uf->addAddressFilter();
769 $conds = $this->initConds($sub);
770 if ($this->text != null) {
771 $conds[] = $sub . '.text' . $this->mkMatch($this->text);
772 }
773
774 if ($this->country != null) {
775 $subc = $uf->addAddressCountryFilter();
776 $subconds = array();
777 $subconds[] = $subc . '.country' . $this->mkMatch($this->country);
778 $subconds[] = $subc . '.countryFR' . $this->mkMatch($this->country);
779 $conds[] = implode(' OR ', $subconds);
780 }
781
782 if ($this->locality != null) {
783 $subl = $uf->addAddressLocalityFilter();
784 $conds[] = $subl . '.name' . $this->mkMatch($this->locality);
785 }
786
787 return implode(' AND ', $conds);
788 }
789}
790// }}}
791
46e88fe3 792// {{{ class UFC_AddressField
2b9ca54d 793/** Filters users based on their address,
46e88fe3
RB
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
2b9ca54d
RB
796 * @param $type Filter on address type
797 * @param $flags Filter on address flags
2b9ca54d 798 */
46e88fe3 799class UFC_AddressField extends UFC_Address
2b9ca54d 800{
46e88fe3
RB
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;
806
2b9ca54d
RB
807 /** Data of the filter
808 */
46e88fe3
RB
809 private $val;
810 private $fieldtype;
036d1637 811
46e88fe3 812 public function __construct($val, $fieldtype, $type = null, $flags = self::FLAG_ANY)
036d1637 813 {
2b9ca54d 814 parent::__construct($type, $flags);
46e88fe3
RB
815
816 if (!is_array($val)) {
817 $val = array($val);
818 }
819 $this->val = $val;
820 $this->fieldtype = $fieldtype;
c4b24511
RB
821 }
822
dcc63ed5 823 public function buildCondition(PlFilter &$uf)
c4b24511 824 {
036d1637 825 $sub = $uf->addAddressFilter();
d7ddf29b 826 $conds = $this->initConds($sub);
036d1637 827
46e88fe3
RB
828 switch ($this->fieldtype) {
829 case self::FIELD_COUNTRY:
830 $field = 'countryId';
831 break;
832 case self::FIELD_ADMAREA:
833 $field = 'administrativeAreaId';
834 break;
835 case self::FIELD_SUBADMAREA:
836 $field = 'subAdministrativeAreaId';
837 break;
838 case self::FIELD_LOCALITY:
839 $field = 'localityId';
840 break;
841 case self::FIELD_ZIPCODE:
842 $field = 'postalCode';
843 break;
844 default:
61f61261 845 Platal::page()->killError('Invalid address field type: ' . $this->fieldtype);
46e88fe3 846 }
bde68f05 847 $conds[] = XDB::format($sub . '.' . $field . ' IN {?}', $this->val);
036d1637
RB
848
849 return implode(' AND ', $conds);
c4b24511
RB
850 }
851}
8363588b 852// }}}
c4b24511 853
8363588b 854// {{{ class UFC_Corps
4083b126
RB
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
858 */
859class UFC_Corps implements UserFilterCondition
860{
5d2e55c7
RB
861 const CURRENT = 1;
862 const ORIGIN = 2;
4083b126
RB
863
864 private $corps;
865 private $type;
866
867 public function __construct($corps, $type = self::CURRENT)
868 {
869 $this->corps = $corps;
870 $this->type = $type;
871 }
872
dcc63ed5 873 public function buildCondition(PlFilter &$uf)
4083b126 874 {
5d2e55c7
RB
875 /** Tables shortcuts:
876 * pc for profile_corps,
4083b126
RB
877 * pceo for profile_corps_enum - orginal
878 * pcec for profile_corps_enum - current
879 */
880 $sub = $uf->addCorpsFilter($this->type);
881 $cond = $sub . '.abbreviation = ' . $corps;
882 return $cond;
883 }
884}
8363588b 885// }}}
4083b126 886
8363588b 887// {{{ class UFC_Corps_Rank
4083b126
RB
888/** Filters users based on their rank in the corps
889 * @param $rank Rank we are looking for (abbreviation)
890 */
891class UFC_Corps_Rank implements UserFilterCondition
892{
893 private $rank;
894 public function __construct($rank)
895 {
896 $this->rank = $rank;
897 }
898
dcc63ed5 899 public function buildCondition(PlFilter &$uf)
4083b126 900 {
5d2e55c7 901 /** Tables shortcuts:
4083b126
RB
902 * pcr for profile_corps_rank
903 */
904 $sub = $uf->addCorpsRankFilter();
905 $cond = $sub . '.abbreviation = ' . $rank;
906 return $cond;
907 }
908}
8363588b 909// }}}
4083b126 910
6a99c3ac
RB
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
915 */
4e2f2ad2 916class UFC_Job_Company implements UserFilterCondition
6a99c3ac
RB
917{
918 const JOBID = 'id';
919 const JOBNAME = 'name';
920 const JOBACRONYM = 'acronym';
921
922 private $type;
923 private $value;
924
925 public function __construct($type, $value)
926 {
927 $this->assertType($type);
928 $this->type = $type;
929 $this->value = $value;
930 }
931
932 private function assertType($type)
933 {
934 if ($type != self::JOBID && $type != self::JOBNAME && $type != self::JOBACRONYM) {
5d2e55c7 935 Platal::page()->killError("Type de recherche non valide.");
6a99c3ac
RB
936 }
937 }
938
dcc63ed5 939 public function buildCondition(PlFilter &$uf)
6a99c3ac
RB
940 {
941 $sub = $uf->addJobCompanyFilter();
412e2e0f 942 $cond = $sub . '.' . $this->type . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->value);
6a99c3ac
RB
943 return $cond;
944 }
945}
946// }}}
947
948// {{{ class UFC_Job_Sectorization
949/** Filters users based on the ((sub)sub)sector they work in
46e88fe3 950 * @param $val The ID of the sector, or an array of such IDs
d7ddf29b 951 * @param $type The kind of search (subsubsector/subsector/sector)
6a99c3ac 952 */
4e2f2ad2 953class UFC_Job_Sectorization implements UserFilterCondition
6a99c3ac 954{
d7ddf29b
RB
955 private $val;
956 private $type;
6a99c3ac 957
d7ddf29b
RB
958 public function __construct($val, $type = UserFilter::JOB_SECTOR)
959 {
960 self::assertType($type);
46e88fe3
RB
961 if (!is_array($val)) {
962 $val = array($val);
963 }
d7ddf29b
RB
964 $this->val = $val;
965 $this->type = $type;
966 }
6a99c3ac 967
d7ddf29b 968 private static function assertType($type)
6a99c3ac 969 {
d7ddf29b
RB
970 if ($type != UserFilter::JOB_SECTOR && $type != UserFilter::JOB_SUBSECTOR && $type != UserFilter::JOB_SUBSUBSECTOR) {
971 Platal::page()->killError("Type de secteur non valide.");
972 }
6a99c3ac
RB
973 }
974
dcc63ed5 975 public function buildCondition(PlFilter &$uf)
6a99c3ac 976 {
d7ddf29b
RB
977 $sub = $uf->addJobSectorizationFilter($this->type);
978 return $sub . '.id = ' . XDB::format('{?}', $this->val);
6a99c3ac
RB
979 }
980}
981// }}}
982
3ac45f10
PC
983// {{{ class UFC_Job_Terms
984/** Filters users based on the job terms they assigned to one of their
985 * jobs.
986 * @param $val The ID of the job term, or an array of such IDs
987 */
988class UFC_Job_Terms implements UserFilterCondition
989{
990 private $val;
991
992 public function __construct($val)
993 {
994 if (!is_array($val)) {
995 $val = array($val);
996 }
997 $this->val = $val;
998 }
999
1000 public function buildCondition(PlFilter &$uf)
1001 {
1002 $sub = $uf->addJobTermsFilter(count($this->val));
1003 $conditions = array();
1004 foreach ($this->val as $i => $jtid) {
1005 $conditions[] = $sub[$i] . ' = ' . XDB::escape($jtid);
1006 }
1007 return implode(' AND ', $conditions);
1008 }
1009}
1010// }}}
1011
6a99c3ac
RB
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)
1016 */
4e2f2ad2 1017class UFC_Job_Description implements UserFilterCondition
6a99c3ac
RB
1018{
1019
6a99c3ac
RB
1020 private $description;
1021 private $fields;
1022
01cc5f9e 1023 public function __construct($description, $fields)
6a99c3ac
RB
1024 {
1025 $this->fields = $fields;
1026 $this->description = $description;
1027 }
1028
dcc63ed5 1029 public function buildCondition(PlFilter &$uf)
6a99c3ac
RB
1030 {
1031 $conds = array();
1032 if ($this->fields & UserFilter::JOB_USERDEFINED) {
1033 $sub = $uf->addJobFilter();
658b4c83 1034 $conds[] = $sub . '.description ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->description);
6a99c3ac 1035 }
01cc5f9e
RB
1036 if ($this->fields & UserFilter::JOB_CV) {
1037 $uf->requireProfiles();
658b4c83 1038 $conds[] = 'p.cv ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->description);
01cc5f9e 1039 }
6a99c3ac
RB
1040 if ($this->fields & UserFilter::JOB_SECTOR) {
1041 $sub = $uf->addJobSectorizationFilter(UserFilter::JOB_SECTOR);
658b4c83 1042 $conds[] = $sub . '.name ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->description);
6a99c3ac
RB
1043 }
1044 if ($this->fields & UserFilter::JOB_SUBSECTOR) {
1045 $sub = $uf->addJobSectorizationFilter(UserFilter::JOB_SUBSECTOR);
658b4c83 1046 $conds[] = $sub . '.name ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->description);
6a99c3ac
RB
1047 }
1048 if ($this->fields & UserFilter::JOB_SUBSUBSECTOR) {
1049 $sub = $uf->addJobSectorizationFilter(UserFilter::JOB_SUBSUBSECTOR);
658b4c83 1050 $conds[] = $sub . '.name ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->description);
6a99c3ac 1051 $sub = $uf->addJobSectorizationFilter(UserFilter::JOB_ALTERNATES);
658b4c83 1052 $conds[] = $sub . '.name ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->description);
6a99c3ac
RB
1053 }
1054 return implode(' OR ', $conds);
1055 }
1056}
1057// }}}
1058
0a2e9c74
RB
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
1063 */
4e2f2ad2 1064class UFC_Networking implements UserFilterCondition
0a2e9c74
RB
1065{
1066 private $type;
1067 private $value;
1068
1069 public function __construct($type, $value)
1070 {
1071 $this->type = $type;
1072 $this->value = $value;
1073 }
1074
dcc63ed5 1075 public function buildCondition(PlFilter &$uf)
0a2e9c74
RB
1076 {
1077 $sub = $uf->addNetworkingFilter();
1078 $conds = array();
658b4c83 1079 $conds[] = $sub . '.address ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->value);
0a2e9c74 1080 if ($this->type != -1) {
1f5cd004 1081 $conds[] = $sub . '.nwid = ' . XDB::format('{?}', $this->type);
0a2e9c74
RB
1082 }
1083 return implode(' AND ', $conds);
1084 }
1085}
1086// }}}
1087
6d62969e
RB
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
1093 */
4e2f2ad2 1094class UFC_Phone implements UserFilterCondition
6d62969e
RB
1095{
1096 const NUM_PRO = 'pro';
1097 const NUM_USER = 'user';
1098 const NUM_HOME = 'address';
1099 const NUM_ANY = 'any';
1100
1101 const PHONE_FIXED = 'fixed';
1102 const PHONE_MOBILE = 'mobile';
1103 const PHONE_FAX = 'fax';
1104 const PHONE_ANY = 'any';
1105
1106 private $num_type;
1107 private $phone_type;
1108 private $number;
1109
1110 public function __construct($number, $num_type = self::NUM_ANY, $phone_type = self::PHONE_ANY)
1111 {
da0a9c5a 1112 $phone = new Phone(array('display' => $number));
0b6c8b36
SJ
1113 $phone->format();
1114 $this->number = $phone->search();
6d62969e 1115 $this->num_type = $num_type;
0b6c8b36 1116 $this->phone_type = $phone_type;
6d62969e
RB
1117 }
1118
dcc63ed5 1119 public function buildCondition(PlFilter &$uf)
6d62969e
RB
1120 {
1121 $sub = $uf->addPhoneFilter();
1122 $conds = array();
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);
1126 }
1127 if ($this->phone_type != self::PHONE_ANY) {
1128 $conds[] = $sub . '.tel_type = ' . XDB::format('{?}', $this->phone_type);
1129 }
1130 return implode(' AND ', $conds);
1131 }
1132}
1133// }}}
1134
ceb512d2
RB
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')
1139 */
4e2f2ad2 1140class UFC_Medal implements UserFilterCondition
ceb512d2
RB
1141{
1142 private $medal;
1143 private $grade;
1144
1145 public function __construct($medal, $grade = null)
1146 {
1147 $this->medal = $medal;
1148 $this->grade = $grade;
1149 }
1150
dcc63ed5 1151 public function buildCondition(PlFilter &$uf)
ceb512d2
RB
1152 {
1153 $conds = array();
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);
1158 }
1159 return implode(' AND ', $conds);
1160 }
1161}
1162// }}}
1163
470d14f6
FB
1164// {{{ class UFC_Photo
1165/** Filters profiles with photo
1166 */
1167class UFC_Photo implements UserFilterCondition
1168{
1169 public function buildCondition(PlFilter &$uf)
1170 {
1171 $uf->addPhotoFilter();
1172 return 'photo.attach IS NOT NULL';
1173 }
1174}
1175// }}}
1176
671b7073
RB
1177// {{{ class UFC_Mentor_Expertise
1178/** Filters users by mentoring expertise
1179 * @param $expertise Domain of expertise
1180 */
4e2f2ad2 1181class UFC_Mentor_Expertise implements UserFilterCondition
671b7073
RB
1182{
1183 private $expertise;
1184
1185 public function __construct($expertise)
1186 {
1187 $this->expertise = $expertise;
1188 }
1189
dcc63ed5 1190 public function buildCondition(PlFilter &$uf)
671b7073
RB
1191 {
1192 $sub = $uf->addMentorFilter(UserFilter::MENTOR_EXPERTISE);
658b4c83 1193 return $sub . '.expertise ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->expertise);
671b7073
RB
1194 }
1195}
1196// }}}
1197
1198// {{{ class UFC_Mentor_Country
1199/** Filters users by mentoring country
1200 * @param $country Two-letters code of country being searched
1201 */
4e2f2ad2 1202class UFC_Mentor_Country implements UserFilterCondition
671b7073
RB
1203{
1204 private $country;
1205
61d1fd8b 1206 public function __construct()
671b7073 1207 {
61d1fd8b 1208 $this->country = pl_flatten(func_get_args());
671b7073
RB
1209 }
1210
dcc63ed5 1211 public function buildCondition(PlFilter &$uf)
671b7073
RB
1212 {
1213 $sub = $uf->addMentorFilter(UserFilter::MENTOR_COUNTRY);
61d1fd8b 1214 return $sub . '.country IN ' . XDB::format('{?}', $this->country);
671b7073
RB
1215 }
1216}
1217// }}}
1218
1219// {{{ class UFC_Mentor_Sectorization
1220/** Filters users based on mentoring (sub|)sector
c5da8574
RB
1221 * @param $sector ID of (sub)sector
1222 * @param $type Whether we are looking for a sector or a subsector
671b7073 1223 */
4e2f2ad2 1224class UFC_Mentor_Sectorization implements UserFilterCondition
671b7073 1225{
c5da8574
RB
1226 const SECTOR = 1;
1227 const SUBSECTOR = 2;
671b7073 1228 private $sector;
c5da8574 1229 private $type;
671b7073 1230
c5da8574 1231 public function __construct($sector, $type = self::SECTOR)
671b7073
RB
1232 {
1233 $this->sector = $sector;
c5da8574 1234 $this->type = $type;
671b7073
RB
1235 }
1236
dcc63ed5 1237 public function buildCondition(PlFilter &$uf)
671b7073
RB
1238 {
1239 $sub = $uf->addMentorFilter(UserFilter::MENTOR_SECTOR);
c5da8574
RB
1240 if ($this->type == self::SECTOR) {
1241 $field = 'sectorid';
1242 } else {
1243 $field = 'subsectorid';
671b7073 1244 }
c5da8574 1245 return $sub . '.' . $field . ' = ' . XDB::format('{?}', $this->sector);
671b7073
RB
1246 }
1247}
1248// }}}
1249
8363588b 1250// {{{ class UFC_UserRelated
5d2e55c7 1251/** Filters users based on a relation toward a user
53eae167
RB
1252 * @param $user User to which searched users are related
1253 */
4e7bf1e0 1254abstract class UFC_UserRelated implements UserFilterCondition
3f42a6ad 1255{
009b8ab7
FB
1256 protected $user;
1257 public function __construct(PlUser &$user)
1258 {
1259 $this->user =& $user;
3f42a6ad 1260 }
4e7bf1e0 1261}
8363588b 1262// }}}
3f42a6ad 1263
8363588b 1264// {{{ class UFC_Contact
5d2e55c7 1265/** Filters users who belong to selected user's contacts
53eae167 1266 */
4e7bf1e0
FB
1267class UFC_Contact extends UFC_UserRelated
1268{
dcc63ed5 1269 public function buildCondition(PlFilter &$uf)
3f42a6ad 1270 {
009b8ab7 1271 $sub = $uf->addContactFilter($this->user->id());
3f42a6ad
FB
1272 return 'c' . $sub . '.contact IS NOT NULL';
1273 }
1274}
8363588b 1275// }}}
3f42a6ad 1276
8363588b 1277// {{{ class UFC_WatchRegistration
53eae167
RB
1278/** Filters users being watched by selected user
1279 */
4e7bf1e0
FB
1280class UFC_WatchRegistration extends UFC_UserRelated
1281{
dcc63ed5 1282 public function buildCondition(PlFilter &$uf)
4e7bf1e0 1283 {
a87530ea 1284 if (!$this->user->watchType('registration')) {
dcc63ed5 1285 return PlFilterCondition::COND_FALSE;
009b8ab7
FB
1286 }
1287 $uids = $this->user->watchUsers();
1288 if (count($uids) == 0) {
dcc63ed5 1289 return PlFilterCondition::COND_FALSE;
009b8ab7 1290 } else {
93b0da52 1291 return XDB::format('$UID IN {?}', $uids);
009b8ab7 1292 }
4e7bf1e0
FB
1293 }
1294}
8363588b 1295// }}}
4e7bf1e0 1296
8363588b 1297// {{{ class UFC_WatchPromo
53eae167
RB
1298/** Filters users belonging to a promo watched by selected user
1299 * @param $user Selected user (the one watching promo)
1300 * @param $grade Formation the user is watching
1301 */
4e7bf1e0
FB
1302class UFC_WatchPromo extends UFC_UserRelated
1303{
1304 private $grade;
009b8ab7 1305 public function __construct(PlUser &$user, $grade = UserFilter::GRADE_ING)
4e7bf1e0 1306 {
009b8ab7 1307 parent::__construct($user);
4e7bf1e0
FB
1308 $this->grade = $grade;
1309 }
1310
dcc63ed5 1311 public function buildCondition(PlFilter &$uf)
4e7bf1e0 1312 {
009b8ab7
FB
1313 $promos = $this->user->watchPromos();
1314 if (count($promos) == 0) {
dcc63ed5 1315 return PlFilterCondition::COND_FALSE;
009b8ab7
FB
1316 } else {
1317 $sube = $uf->addEducationFilter(true, $this->grade);
1318 $field = 'pe' . $sube . '.' . UserFilter::promoYear($this->grade);
bde68f05 1319 return XDB::format($field . ' IN {?}', $promos);
009b8ab7 1320 }
4e7bf1e0
FB
1321 }
1322}
8363588b 1323// }}}
4e7bf1e0 1324
8363588b 1325// {{{ class UFC_WatchContact
53eae167
RB
1326/** Filters users watched by selected user
1327 */
009b8ab7 1328class UFC_WatchContact extends UFC_Contact
4e7bf1e0 1329{
dcc63ed5 1330 public function buildCondition(PlFilter &$uf)
4e7bf1e0 1331 {
009b8ab7 1332 if (!$this->user->watchContacts()) {
dcc63ed5 1333 return PlFilterCondition::COND_FALSE;
009b8ab7
FB
1334 }
1335 return parent::buildCondition($uf);
4e7bf1e0
FB
1336 }
1337}
8363588b 1338// }}}
4e7bf1e0 1339
48885bbe
FB
1340// {{{ class UFC_MarketingHash
1341/** Filters users using the hash generated
1342 * to send marketing emails to him.
1343 */
1344class UFC_MarketingHash implements UserFilterCondition
1345{
1346 private $hash;
1347
1348 public function __construct($hash)
1349 {
1350 $this->hash = $hash;
1351 }
1352
1353 public function buildCondition(PlFilter &$uf)
1354 {
1355 $table = $uf->addMarketingHash();
1356 return XDB::format('rm.hash = {?}', $this->hash);
1357 }
1358}
416d4244 1359// }}}
4e7bf1e0 1360
d865c296
FB
1361/******************
1362 * ORDERS
1363 ******************/
1364
8363588b 1365// {{{ class UFO_Promo
5d2e55c7
RB
1366/** Orders users by promotion
1367 * @param $grade Formation whose promotion users should be sorted by (restricts results to users of that formation)
53eae167
RB
1368 * @param $desc Whether sort is descending
1369 */
ccc951d9 1370class UFO_Promo extends PlFilterGroupableOrder
d865c296
FB
1371{
1372 private $grade;
1373
1374 public function __construct($grade = null, $desc = false)
1375 {
009b8ab7 1376 parent::__construct($desc);
d865c296 1377 $this->grade = $grade;
d865c296
FB
1378 }
1379
61f61261 1380 protected function getSortTokens(PlFilter &$uf)
d865c296
FB
1381 {
1382 if (UserFilter::isGrade($this->grade)) {
1383 $sub = $uf->addEducationFilter($this->grade);
1384 return 'pe' . $sub . '.' . UserFilter::promoYear($this->grade);
1385 } else {
1386 $sub = $uf->addDisplayFilter();
1387 return 'pd' . $sub . '.promo';
1388 }
1389 }
1390}
8363588b 1391// }}}
d865c296 1392
8363588b 1393// {{{ class UFO_Name
53eae167 1394/** Sorts users by name
5d2e55c7
RB
1395 * @param $type Type of name on which to sort (firstname...)
1396 * @param $variant Variant of that name to use (marital, ordinary...)
53eae167
RB
1397 * @param $particle Set to true if particles should be included in the sorting order
1398 * @param $desc If sort order should be descending
1399 */
ccc951d9 1400class UFO_Name extends PlFilterOrder
d865c296
FB
1401{
1402 private $type;
1403 private $variant;
1404 private $particle;
1405
1406 public function __construct($type, $variant = null, $particle = false, $desc = false)
1407 {
009b8ab7 1408 parent::__construct($desc);
d865c296
FB
1409 $this->type = $type;
1410 $this->variant = $variant;
1411 $this->particle = $particle;
d865c296
FB
1412 }
1413
61f61261 1414 protected function getSortTokens(PlFilter &$uf)
d865c296 1415 {
913a4e90 1416 if (Profile::isDisplayName($this->type)) {
d865c296 1417 $sub = $uf->addDisplayFilter();
a9ef52c9
RB
1418 $token = 'pd' . $sub . '.' . $this->type;
1419 if ($uf->accountsRequired()) {
1420 $account_token = Profile::getAccountEquivalentName($this->type);
1421 return 'IFNULL(' . $token . ', a.' . $account_token . ')';
1422 } else {
1423 return $token;
1424 }
d865c296
FB
1425 } else {
1426 $sub = $uf->addNameFilter($this->type, $this->variant);
1427 if ($this->particle) {
1428 return 'CONCAT(pn' . $sub . '.particle, \' \', pn' . $sub . '.name)';
1429 } else {
1430 return 'pn' . $sub . '.name';
1431 }
1432 }
1433 }
1434}
8363588b 1435// }}}
d865c296 1436
40585144 1437// {{{ class UFO_Score
ccc951d9 1438class UFO_Score extends PlFilterOrder
40585144 1439{
61f61261 1440 protected function getSortTokens(PlFilter &$uf)
40585144 1441 {
2a93b634
RB
1442 $toks = $uf->getNameTokens();
1443 $scores = array();
488765e3
RB
1444
1445 // If there weren't any sort tokens, we shouldn't sort by score, sort by NULL instead
1446 if (count($toks) == 0) {
1447 return 'NULL';
1448 }
1449
2a93b634
RB
1450 foreach ($toks as $sub => $token) {
1451 $scores[] = XDB::format('SUM(' . $sub . '.score + IF (' . $sub . '.token = {?}, 5, 0) )', $token);
1452 }
1453 return implode(' + ', $scores);
40585144
RB
1454 }
1455}
1456// }}}
1457
8363588b 1458// {{{ class UFO_Registration
53eae167
RB
1459/** Sorts users based on registration date
1460 */
ccc951d9 1461class UFO_Registration extends PlFilterOrder
38c6fe96 1462{
61f61261 1463 protected function getSortTokens(PlFilter &$uf)
38c6fe96 1464 {
6c1e97ae 1465 $uf->requireAccounts();
009b8ab7 1466 return 'a.registration_date';
38c6fe96 1467 }
009b8ab7 1468}
8363588b 1469// }}}
38c6fe96 1470
8363588b 1471// {{{ class UFO_Birthday
53eae167
RB
1472/** Sorts users based on next birthday date
1473 */
ccc951d9 1474class UFO_Birthday extends PlFilterOrder
009b8ab7 1475{
61f61261 1476 protected function getSortTokens(PlFilter &$uf)
38c6fe96 1477 {
6c1e97ae 1478 $uf->requireProfiles();
009b8ab7 1479 return 'p.next_birthday';
38c6fe96
FB
1480 }
1481}
8363588b 1482// }}}
38c6fe96 1483
8363588b 1484// {{{ class UFO_ProfileUpdate
53eae167
RB
1485/** Sorts users based on last profile update
1486 */
ccc951d9 1487class UFO_ProfileUpdate extends PlFilterOrder
009b8ab7 1488{
61f61261 1489 protected function getSortTokens(PlFilter &$uf)
009b8ab7 1490 {
6c1e97ae 1491 $uf->requireProfiles();
009b8ab7
FB
1492 return 'p.last_change';
1493 }
1494}
8363588b 1495// }}}
009b8ab7 1496
8363588b 1497// {{{ class UFO_Death
53eae167
RB
1498/** Sorts users based on death date
1499 */
ccc951d9 1500class UFO_Death extends PlFilterOrder
009b8ab7 1501{
61f61261 1502 protected function getSortTokens(PlFilter &$uf)
009b8ab7 1503 {
6c1e97ae 1504 $uf->requireProfiles();
009b8ab7
FB
1505 return 'p.deathdate';
1506 }
1507}
8363588b 1508// }}}
009b8ab7 1509
6c1e97ae
FB
1510// {{{ class UFO_Uid
1511/** Sorts users based on their uid
1512 */
ccc951d9 1513class UFO_Uid extends PlFilterOrder
6c1e97ae
FB
1514{
1515 protected function getSortTokens(PlFilter &$uf)
1516 {
1517 $uf->requireAccounts();
93b0da52 1518 return '$UID';
6c1e97ae
FB
1519 }
1520}
c752a130 1521// }}}
6c1e97ae
FB
1522
1523// {{{ class UFO_Hruid
1524/** Sorts users based on their hruid
1525 */
ccc951d9 1526class UFO_Hruid extends PlFilterOrder
6c1e97ae
FB
1527{
1528 protected function getSortTokens(PlFilter &$uf)
1529 {
1530 $uf->requireAccounts();
1531 return 'a.hruid';
1532 }
1533}
1534// }}}
1535
1536// {{{ class UFO_Pid
1537/** Sorts users based on their pid
1538 */
ccc951d9 1539class UFO_Pid extends PlFilterOrder
6c1e97ae
FB
1540{
1541 protected function getSortTokens(PlFilter &$uf)
1542 {
1543 $uf->requireProfiles();
93b0da52 1544 return '$PID';
6c1e97ae
FB
1545 }
1546}
c752a130 1547// }}}
6c1e97ae
FB
1548
1549// {{{ class UFO_Hrpid
1550/** Sorts users based on their hrpid
1551 */
ccc951d9 1552class UFO_Hrpid extends PlFilterOrder
6c1e97ae
FB
1553{
1554 protected function getSortTokens(PlFilter &$uf)
1555 {
1556 $uf->requireProfiles();
1557 return 'p.hrpid';
1558 }
1559}
1560// }}}
1561
009b8ab7 1562
d865c296
FB
1563/***********************************
1564 *********************************
1565 USER FILTER CLASS
1566 *********************************
1567 ***********************************/
1568
8363588b 1569// {{{ class UserFilter
2d83cac9
RB
1570/** This class provides a convenient and centralized way of filtering users.
1571 *
1572 * Usage:
1573 * $uf = new UserFilter(new UFC_Blah($x, $y), new UFO_Coin($z, $t));
1574 *
1575 * Resulting UserFilter can be used to:
1576 * - get a list of User objects matching the filter
1577 * - get a list of UIDs matching the filter
1578 * - get the number of users matching the filter
1579 * - check whether a given User matches the filter
1580 * - filter a list of User objects depending on whether they match the filter
1581 *
1582 * Usage for UFC and UFO objects:
1583 * A UserFilter will call all private functions named XXXJoins.
1584 * These functions must return an array containing the list of join
1585 * required by the various UFC and UFO associated to the UserFilter.
1586 * Entries in those returned array are of the following form:
1587 * 'join_tablealias' => array('join_type', 'joined_table', 'join_criter')
1588 * which will be translated into :
1589 * join_type JOIN joined_table AS join_tablealias ON (join_criter)
1590 * in the final query.
1591 *
1592 * In the join_criter text, $ME is replaced with 'join_tablealias', $PID with
913a4e90 1593 * profile.pid, and $UID with accounts.uid.
2d83cac9
RB
1594 *
1595 * For each kind of "JOIN" needed, a function named addXXXFilter() should be defined;
1596 * its parameter will be used to set various private vars of the UserFilter describing
1597 * the required joins ; such a function shall return the "join_tablealias" to use
1598 * when referring to the joined table.
1599 *
1600 * For example, if data from profile_job must be available to filter results,
aab2ffdd 1601 * the UFC object will call $uf-addJobFilter(), which will set the 'with_pj' var and
2d83cac9
RB
1602 * return 'pj', the short name to use when referring to profile_job; when building
1603 * the query, calling the jobJoins function will return an array containing a single
1604 * row:
1605 * 'pj' => array('left', 'profile_job', '$ME.pid = $UID');
1606 *
1607 * The 'register_optional' function can be used to generate unique table aliases when
1608 * the same table has to be joined several times with different aliases.
1609 */
9b8e5fb4 1610class UserFilter extends PlFilter
a087cc8d 1611{
9b8e5fb4 1612 protected $joinMethods = array();
7ca75030 1613
61f61261
RB
1614 protected $joinMetas = array(
1615 '$PID' => 'p.pid',
1616 '$UID' => 'a.uid',
9b8e5fb4 1617 );
d865c296 1618
a087cc8d 1619 private $root;
24e08e33 1620 private $sort = array();
ccc951d9 1621 private $grouper = null;
784745ce 1622 private $query = null;
24e08e33 1623 private $orderby = null;
784745ce 1624
2daf7250
RB
1625 private $lastusercount = null;
1626 private $lastprofilecount = null;
d865c296 1627
24e08e33 1628 public function __construct($cond = null, $sort = null)
5dd9d823 1629 {
06598c13 1630 if (empty($this->joinMethods)) {
d865c296
FB
1631 $class = new ReflectionClass('UserFilter');
1632 foreach ($class->getMethods() as $method) {
1633 $name = $method->getName();
1634 if (substr($name, -5) == 'Joins' && $name != 'buildJoins') {
06598c13 1635 $this->joinMethods[] = $name;
d865c296
FB
1636 }
1637 }
1638 }
5dd9d823 1639 if (!is_null($cond)) {
06598c13 1640 if ($cond instanceof PlFilterCondition) {
5dd9d823
FB
1641 $this->setCondition($cond);
1642 }
1643 }
24e08e33 1644 if (!is_null($sort)) {
ccc951d9 1645 if ($sort instanceof PlFilterOrder) {
24e08e33 1646 $this->addSort($sort);
d865c296
FB
1647 } else if (is_array($sort)) {
1648 foreach ($sort as $s) {
1649 $this->addSort($s);
1650 }
24e08e33
FB
1651 }
1652 }
5dd9d823
FB
1653 }
1654
784745ce
FB
1655 private function buildQuery()
1656 {
2a93b634
RB
1657 // The root condition is built first because some orders need info
1658 // available only once all UFC have set their conditions (UFO_Score)
1659 if (is_null($this->query)) {
1660 $where = $this->root->buildCondition($this);
226626ae
FB
1661 $where = str_replace(array_keys($this->joinMetas),
1662 $this->joinMetas,
1663 $where);
2a93b634 1664 }
d865c296
FB
1665 if (is_null($this->orderby)) {
1666 $orders = array();
1667 foreach ($this->sort as $sort) {
1668 $orders = array_merge($orders, $sort->buildSort($this));
1669 }
1670 if (count($orders) == 0) {
1671 $this->orderby = '';
1672 } else {
1673 $this->orderby = 'ORDER BY ' . implode(', ', $orders);
1674 }
226626ae
FB
1675 $this->orderby = str_replace(array_keys($this->joinMetas),
1676 $this->joinMetas,
1677 $this->orderby);
d865c296 1678 }
784745ce 1679 if (is_null($this->query)) {
2a93b634 1680 if ($this->with_accounts) {
b8dcf62d
RB
1681 $from = 'accounts AS a';
1682 } else {
1683 $this->requireProfiles();
1684 $from = 'profiles AS p';
1685 }
f7ea7450 1686 $joins = $this->buildJoins();
b8dcf62d 1687 $this->query = 'FROM ' . $from . '
784745ce
FB
1688 ' . $joins . '
1689 WHERE (' . $where . ')';
1690 }
1691 }
1692
ccc951d9
RB
1693 public function hasGroups()
1694 {
1695 return $this->grouper != null;
1696 }
1697
1698 public function getGroups()
1699 {
1700 return $this->getUIDGroups();
1701 }
1702
1703 public function getUIDGroups()
1704 {
1705 $this->requireAccounts();
1706 $this->buildQuery();
1707 $token = $this->grouper->getGroupToken($this);
1708
1709 $groups = XDB::fetchAllRow('SELECT ' . $token . ', COUNT(a.uid)
1710 ' . $this->query . '
1711 GROUP BY ' . $token,
1712 0);
1713 return $groups;
1714 }
1715
1716 public function getPIDGroups()
1717 {
1718 $this->requireProfiles();
1719 $this->buildQuery();
1720 $token = $this->grouper->getGroupToken($this);
1721
1722 $groups = XDB::fetchAllRow('SELECT ' . $token . ', COUNT(p.pid)
1723 ' . $this->query . '
1724 GROUP BY ' . $token,
1725 0);
1726 return $groups;
1727 }
1728
7ca75030 1729 private function getUIDList($uids = null, PlLimit &$limit)
d865c296 1730 {
b8dcf62d 1731 $this->requireAccounts();
d865c296 1732 $this->buildQuery();
7ca75030 1733 $lim = $limit->getSql();
d865c296 1734 $cond = '';
45b20ca0 1735 if (!empty($uids)) {
bde68f05 1736 $cond = XDB::format(' AND a.uid IN {?}', $uids);
d865c296
FB
1737 }
1738 $fetched = XDB::fetchColumn('SELECT SQL_CALC_FOUND_ROWS a.uid
1739 ' . $this->query . $cond . '
1740 GROUP BY a.uid
1741 ' . $this->orderby . '
7ca75030 1742 ' . $lim);
2daf7250 1743 $this->lastusercount = (int)XDB::fetchOneCell('SELECT FOUND_ROWS()');
d865c296
FB
1744 return $fetched;
1745 }
1746
043b104b
RB
1747 private function getPIDList($pids = null, PlLimit &$limit)
1748 {
1749 $this->requireProfiles();
1750 $this->buildQuery();
1751 $lim = $limit->getSql();
1752 $cond = '';
1753 if (!is_null($pids)) {
bde68f05 1754 $cond = XDB::format(' AND p.pid IN {?}', $pids);
043b104b
RB
1755 }
1756 $fetched = XDB::fetchColumn('SELECT SQL_CALC_FOUND_ROWS p.pid
1757 ' . $this->query . $cond . '
1758 GROUP BY p.pid
1759 ' . $this->orderby . '
1760 ' . $lim);
2daf7250 1761 $this->lastprofilecount = (int)XDB::fetchOneCell('SELECT FOUND_ROWS()');
043b104b
RB
1762 return $fetched;
1763 }
1764
434570c4
FB
1765 private static function defaultLimit($limit) {
1766 if ($limit == null) {
1767 return new PlLimit();
1768 } else {
1769 return $limit;
1770 }
1771 }
1772
a087cc8d
FB
1773 /** Check that the user match the given rule.
1774 */
1775 public function checkUser(PlUser &$user)
1776 {
b8dcf62d 1777 $this->requireAccounts();
784745ce
FB
1778 $this->buildQuery();
1779 $count = (int)XDB::fetchOneCell('SELECT COUNT(*)
1780 ' . $this->query . XDB::format(' AND a.uid = {?}', $user->id()));
1781 return $count == 1;
a087cc8d
FB
1782 }
1783
043b104b
RB
1784 /** Check that the profile match the given rule.
1785 */
1786 public function checkProfile(Profile &$profile)
1787 {
1788 $this->requireProfiles();
1789 $this->buildQuery();
1790 $count = (int)XDB::fetchOneCell('SELECT COUNT(*)
1791 ' . $this->query . XDB::format(' AND p.pid = {?}', $profile->id()));
1792 return $count == 1;
1793 }
1794
1795 /** Default filter is on users
a087cc8d 1796 */
434570c4 1797 public function filter(array $users, $limit = null)
a087cc8d 1798 {
434570c4 1799 return $this->filterUsers($users, self::defaultLimit($limit));
043b104b
RB
1800 }
1801
1802 /** Filter a list of users to extract the users matching the rule.
1803 */
434570c4 1804 public function filterUsers(array $users, $limit = null)
043b104b 1805 {
434570c4 1806 $limit = self::defaultLimit($limit);
b8dcf62d 1807 $this->requireAccounts();
4927ee54
FB
1808 $this->buildQuery();
1809 $table = array();
1810 $uids = array();
1811 foreach ($users as $user) {
07eb5b0e
FB
1812 if ($user instanceof PlUser) {
1813 $uid = $user->id();
1814 } else {
1815 $uid = $user;
1816 }
1817 $uids[] = $uid;
1818 $table[$uid] = $user;
4927ee54 1819 }
7ca75030 1820 $fetched = $this->getUIDList($uids, $limit);
a087cc8d 1821 $output = array();
4927ee54
FB
1822 foreach ($fetched as $uid) {
1823 $output[] = $table[$uid];
a087cc8d
FB
1824 }
1825 return $output;
1826 }
1827
043b104b
RB
1828 /** Filter a list of profiles to extract the users matching the rule.
1829 */
434570c4 1830 public function filterProfiles(array $profiles, $limit = null)
043b104b 1831 {
434570c4 1832 $limit = self::defaultLimit($limit);
043b104b
RB
1833 $this->requireProfiles();
1834 $this->buildQuery();
1835 $table = array();
1836 $pids = array();
1837 foreach ($profiles as $profile) {
1838 if ($profile instanceof Profile) {
1839 $pid = $profile->id();
1840 } else {
1841 $pid = $profile;
1842 }
1843 $pids[] = $pid;
1844 $table[$pid] = $profile;
1845 }
1846 $fetched = $this->getPIDList($pids, $limit);
1847 $output = array();
1848 foreach ($fetched as $pid) {
1849 $output[] = $table[$pid];
1850 }
1851 return $output;
1852 }
1853
434570c4 1854 public function getUIDs($limit = null)
7ca75030 1855 {
833a6e86
FB
1856 $limit = self::defaultLimit($limit);
1857 return $this->getUIDList(null, $limit);
7ca75030
RB
1858 }
1859
ad27b22e
FB
1860 public function getUID($pos = 0)
1861 {
983f3864 1862 $uids =$this->getUIDList(null, new PlLimit(1, $pos));
ad27b22e
FB
1863 if (count($uids) == 0) {
1864 return null;
1865 } else {
1866 return $uids[0];
1867 }
1868 }
1869
434570c4 1870 public function getPIDs($limit = null)
043b104b 1871 {
833a6e86
FB
1872 $limit = self::defaultLimit($limit);
1873 return $this->getPIDList(null, $limit);
043b104b
RB
1874 }
1875
ad27b22e
FB
1876 public function getPID($pos = 0)
1877 {
983f3864 1878 $pids =$this->getPIDList(null, new PlLimit(1, $pos));
ad27b22e
FB
1879 if (count($pids) == 0) {
1880 return null;
1881 } else {
1882 return $pids[0];
1883 }
1884 }
1885
434570c4 1886 public function getUsers($limit = null)
4927ee54 1887 {
7ca75030 1888 return User::getBulkUsersWithUIDs($this->getUIDs($limit));
d865c296
FB
1889 }
1890
ad27b22e
FB
1891 public function getUser($pos = 0)
1892 {
1893 $uid = $this->getUID($pos);
1894 if ($uid == null) {
1895 return null;
1896 } else {
1897 return User::getWithUID($uid);
1898 }
1899 }
1900
0d906109
RB
1901 public function iterUsers($limit = null)
1902 {
1903 return User::iterOverUIDs($this->getUIDs($limit));
1904 }
1905
00f83317 1906 public function getProfiles($limit = null, $fields = 0x0000, $visibility = null)
043b104b 1907 {
00f83317 1908 return Profile::getBulkProfilesWithPIDs($this->getPIDs($limit), $fields, $visibility);
043b104b
RB
1909 }
1910
00f83317 1911 public function getProfile($pos = 0, $fields = 0x0000, $visibility = null)
ad27b22e
FB
1912 {
1913 $pid = $this->getPID($pos);
1914 if ($pid == null) {
1915 return null;
1916 } else {
00f83317 1917 return Profile::get($pid, $fields, $visibility);
ad27b22e
FB
1918 }
1919 }
1920
00f83317 1921 public function iterProfiles($limit = null, $fields = 0x0000, $visibility = null)
0d906109 1922 {
00f83317 1923 return Profile::iterOverPIDs($this->getPIDs($limit), true, $fields, $visibility);
0d906109
RB
1924 }
1925
434570c4 1926 public function get($limit = null)
d865c296 1927 {
7ca75030 1928 return $this->getUsers($limit);
4927ee54
FB
1929 }
1930
aaf70eb8 1931
d865c296 1932 public function getTotalCount()
4927ee54 1933 {
2daf7250
RB
1934 return $this->getTotalUserCount();
1935 }
1936
1937 public function getTotalUserCount()
1938 {
1939 if (is_null($this->lastusercount)) {
1940 $this->requireAccounts();
aa21c568 1941 $this->buildQuery();
2daf7250
RB
1942 return (int)XDB::fetchOneCell('SELECT COUNT(DISTINCT a.uid)
1943 ' . $this->query);
1944 } else {
1945 return $this->lastusercount;
1946 }
1947 }
1948
1949 public function getTotalProfileCount()
1950 {
1951 if (is_null($this->lastprofilecount)) {
1952 $this->requireProfiles();
1953 $this->buildQuery();
1954 return (int)XDB::fetchOneCell('SELECT COUNT(DISTINCT p.pid)
7e735012 1955 ' . $this->query);
38c6fe96 1956 } else {
2daf7250 1957 return $this->lastprofilecount;
38c6fe96 1958 }
4927ee54
FB
1959 }
1960
9b8e5fb4 1961 public function setCondition(PlFilterCondition &$cond)
a087cc8d
FB
1962 {
1963 $this->root =& $cond;
784745ce 1964 $this->query = null;
a087cc8d
FB
1965 }
1966
9b8e5fb4 1967 public function addSort(PlFilterOrder &$sort)
24e08e33 1968 {
ccc951d9
RB
1969 if (count($this->sort) == 0 && $sort instanceof PlFilterGroupableOrder)
1970 {
1971 $this->grouper = $sort;
1972 }
d865c296
FB
1973 $this->sort[] = $sort;
1974 $this->orderby = null;
24e08e33
FB
1975 }
1976
a087cc8d
FB
1977 static public function getLegacy($promo_min, $promo_max)
1978 {
a087cc8d 1979 if ($promo_min != 0) {
784745ce 1980 $min = new UFC_Promo('>=', self::GRADE_ING, intval($promo_min));
5dd9d823 1981 } else {
88c31faf 1982 $min = new PFC_True();
a087cc8d 1983 }
a087cc8d 1984 if ($promo_max != 0) {
784745ce 1985 $max = new UFC_Promo('<=', self::GRADE_ING, intval($promo_max));
a087cc8d 1986 } else {
88c31faf 1987 $max = new PFC_True();
a087cc8d 1988 }
9b8e5fb4 1989 return new UserFilter(new PFC_And($min, $max));
a087cc8d 1990 }
784745ce 1991
07eb5b0e
FB
1992 static public function sortByName()
1993 {
913a4e90 1994 return array(new UFO_Name(Profile::LASTNAME), new UFO_Name(Profile::FIRSTNAME));
07eb5b0e
FB
1995 }
1996
1997 static public function sortByPromo()
1998 {
913a4e90 1999 return array(new UFO_Promo(), new UFO_Name(Profile::LASTNAME), new UFO_Name(Profile::FIRSTNAME));
07eb5b0e
FB
2000 }
2001
aa21c568
FB
2002 static private function getDBSuffix($string)
2003 {
2d6329a2
FB
2004 if (is_array($string)) {
2005 if (count($string) == 1) {
2006 return self::getDBSuffix(array_pop($string));
2007 }
2008 return md5(implode('|', $string));
2009 } else {
2010 return preg_replace('/[^a-z0-9]/i', '', $string);
2011 }
aa21c568
FB
2012 }
2013
2014
2d83cac9
RB
2015 /** Stores a new (and unique) table alias in the &$table table
2016 * @param &$table Array in which the table alias must be stored
2017 * @param $val Value which will then be used to build the join
2018 * @return Name of the newly created alias
2019 */
aa21c568
FB
2020 private $option = 0;
2021 private function register_optional(array &$table, $val)
2022 {
2023 if (is_null($val)) {
2024 $sub = $this->option++;
2025 $index = null;
2026 } else {
2027 $sub = self::getDBSuffix($val);
2028 $index = $val;
2029 }
2030 $sub = '_' . $sub;
2031 $table[$sub] = $index;
2032 return $sub;
2033 }
784745ce 2034
b8dcf62d
RB
2035 /** PROFILE VS ACCOUNT
2036 */
f7ea7450
RB
2037 private $with_profiles = false;
2038 private $with_accounts = false;
b8dcf62d
RB
2039 public function requireAccounts()
2040 {
2041 $this->with_accounts = true;
2042 }
2043
a9ef52c9
RB
2044 public function accountsRequired()
2045 {
2046 return $this->with_accounts;
2047 }
2048
b8dcf62d
RB
2049 public function requireProfiles()
2050 {
2051 $this->with_profiles = true;
2052 }
2053
a9ef52c9
RB
2054 public function profilesRequired()
2055 {
2056 return $this->with_profiles;
2057 }
2058
b8dcf62d
RB
2059 protected function accountJoins()
2060 {
2061 $joins = array();
2a93b634 2062 if ($this->with_profiles && $this->with_accounts) {
5c412626
FB
2063 $joins['ap'] = PlSqlJoin::left('account_profiles', '$ME.uid = $UID AND FIND_IN_SET(\'owner\', ap.perms)');
2064 $joins['p'] = PlSqlJoin::left('profiles', '$PID = ap.pid');
b8dcf62d
RB
2065 }
2066 return $joins;
2067 }
2068
d865c296
FB
2069 /** DISPLAY
2070 */
38c6fe96 2071 const DISPLAY = 'display';
d865c296
FB
2072 private $pd = false;
2073 public function addDisplayFilter()
2074 {
b8dcf62d 2075 $this->requireProfiles();
d865c296
FB
2076 $this->pd = true;
2077 return '';
2078 }
2079
9b8e5fb4 2080 protected function displayJoins()
d865c296
FB
2081 {
2082 if ($this->pd) {
5c412626 2083 return array('pd' => PlSqlJoin::left('profile_display', '$ME.pid = $PID'));
d865c296
FB
2084 } else {
2085 return array();
2086 }
2087 }
2088
f73a4f1b
RB
2089 /** LOGGER
2090 */
2091
2092 private $with_logger = false;
2093 public function addLoggerFilter()
2094 {
2095 $this->with_logger = true;
2096 $this->requireAccounts();
2097 return 'ls';
2098 }
2099 protected function loggerJoins()
2100 {
2101 $joins = array();
2102 if ($this->with_logger) {
5c412626 2103 $joins['ls'] = PlSqlJoin::left('log_sessions', '$ME.uid = $UID');
f73a4f1b
RB
2104 }
2105 return $joins;
2106 }
2107
784745ce
FB
2108 /** NAMES
2109 */
784745ce
FB
2110
2111 static public function assertName($name)
2112 {
07613cdd 2113 if (!DirEnum::getID(DirEnum::NAMETYPES, $name)) {
9b8e5fb4 2114 Platal::page()->kill('Invalid name type: ' . $name);
784745ce
FB
2115 }
2116 }
2117
2118 private $pn = array();
784745ce
FB
2119 public function addNameFilter($type, $variant = null)
2120 {
b8dcf62d 2121 $this->requireProfiles();
784745ce
FB
2122 if (!is_null($variant)) {
2123 $ft = $type . '_' . $variant;
2124 } else {
2125 $ft = $type;
2126 }
2127 $sub = '_' . $ft;
2128 self::assertName($ft);
2129
2130 if (!is_null($variant) && $variant == 'other') {
aa21c568 2131 $sub .= $this->option++;
784745ce 2132 }
07613cdd 2133 $this->pn[$sub] = DirEnum::getID(DirEnum::NAMETYPES, $ft);
784745ce
FB
2134 return $sub;
2135 }
2136
9b8e5fb4 2137 protected function nameJoins()
784745ce
FB
2138 {
2139 $joins = array();
2140 foreach ($this->pn as $sub => $type) {
5c412626 2141 $joins['pn' . $sub] = PlSqlJoin::left('profile_name', '$ME.pid = $PID AND $ME.typeid = {?}', $type);
784745ce
FB
2142 }
2143 return $joins;
2144 }
2145
40585144
RB
2146 /** NAMETOKENS
2147 */
2a93b634
RB
2148 private $name_tokens = array();
2149 private $nb_tokens = 0;
2150
2151 public function addNameTokensFilter($token)
40585144
RB
2152 {
2153 $this->requireProfiles();
2a93b634
RB
2154 $sub = 'sn' . (1 + $this->nb_tokens);
2155 $this->nb_tokens++;
2156 $this->name_tokens[$sub] = $token;
2157 return $sub;
40585144
RB
2158 }
2159
2160 protected function nameTokensJoins()
2161 {
f7ea7450 2162 /* We don't return joins, since with_sn forces the SELECT to run on search_name first */
2a93b634
RB
2163 $joins = array();
2164 foreach ($this->name_tokens as $sub => $token) {
2165 $joins[$sub] = PlSqlJoin::left('search_name', '$ME.pid = $PID');
40585144 2166 }
2a93b634
RB
2167 return $joins;
2168 }
2169
2170 public function getNameTokens()
2171 {
2172 return $this->name_tokens;
40585144
RB
2173 }
2174
a7f8e48a
RB
2175 /** NATIONALITY
2176 */
2177
2178 private $with_nat = false;
2179 public function addNationalityFilter()
2180 {
2181 $this->with_nat = true;
2182 return 'ngc';
2183 }
2184
2185 protected function nationalityJoins()
2186 {
2187 $joins = array();
2188 if ($this->with_nat) {
5c412626 2189 $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');
a7f8e48a
RB
2190 }
2191 return $joins;
2192 }
2193
784745ce
FB
2194 /** EDUCATION
2195 */
2196 const GRADE_ING = 'Ing.';
2197 const GRADE_PHD = 'PhD';
2198 const GRADE_MST = 'M%';
2199 static public function isGrade($grade)
2200 {
93c2f133 2201 return ($grade !== 0) && ($grade == self::GRADE_ING || $grade == self::GRADE_PHD || $grade == self::GRADE_MST);
784745ce
FB
2202 }
2203
2204 static public function assertGrade($grade)
2205 {
2206 if (!self::isGrade($grade)) {
ad27b22e 2207 Platal::page()->killError("Diplôme non valide: $grade");
784745ce
FB
2208 }
2209 }
2210
d865c296
FB
2211 static public function promoYear($grade)
2212 {
2213 // XXX: Definition of promotion for phds and masters might change in near future.
2214 return ($grade == UserFilter::GRADE_ING) ? 'entry_year' : 'grad_year';
2215 }
2216
784745ce
FB
2217 private $pepe = array();
2218 private $with_pee = false;
784745ce
FB
2219 public function addEducationFilter($x = false, $grade = null)
2220 {
b8dcf62d 2221 $this->requireProfiles();
784745ce 2222 if (!$x) {
aa21c568
FB
2223 $index = $this->option;
2224 $sub = $this->option++;
784745ce
FB
2225 } else {
2226 self::assertGrade($grade);
2227 $index = $grade;
2228 $sub = $grade[0];
2229 $this->with_pee = true;
2230 }
2231 $sub = '_' . $sub;
2232 $this->pepe[$index] = $sub;
2233 return $sub;
2234 }
2235
9b8e5fb4 2236 protected function educationJoins()
784745ce
FB
2237 {
2238 $joins = array();
2239 if ($this->with_pee) {
5c412626 2240 $joins['pee'] = PlSqlJoin::inner('profile_education_enum', 'pee.abbreviation = \'X\'');
784745ce
FB
2241 }
2242 foreach ($this->pepe as $grade => $sub) {
2243 if ($this->isGrade($grade)) {
5c412626
FB
2244 $joins['pe' . $sub] = PlSqlJoin::left('profile_education', '$ME.eduid = pee.id AND $ME.pid = $PID');
2245 $joins['pede' . $sub] = PlSqlJoin::inner('profile_education_degree_enum', '$ME.id = pe' . $sub . '.degreeid AND $ME.abbreviation LIKE {?}', $grade);
784745ce 2246 } else {
5c412626
FB
2247 $joins['pe' . $sub] = PlSqlJoin::left('profile_education', '$ME.pid = $PID');
2248 $joins['pee' . $sub] = PlSqlJoin::inner('profile_education_enum', '$ME.id = pe' . $sub . '.eduid');
2249 $joins['pede' . $sub] = PlSqlJoin::inner('profile_education_degree_enum', '$ME.id = pe' . $sub . '.degreeid');
784745ce
FB
2250 }
2251 }
2252 return $joins;
2253 }
4927ee54
FB
2254
2255
2256 /** GROUPS
2257 */
2258 private $gpm = array();
4927ee54
FB
2259 public function addGroupFilter($group = null)
2260 {
b8dcf62d 2261 $this->requireAccounts();
4927ee54 2262 if (!is_null($group)) {
4aae4d2c 2263 if (is_int($group) || ctype_digit($group)) {
4927ee54
FB
2264 $index = $sub = $group;
2265 } else {
2266 $index = $group;
aa21c568 2267 $sub = self::getDBSuffix($group);
4927ee54
FB
2268 }
2269 } else {
aa21c568 2270 $sub = 'group_' . $this->option++;
4927ee54
FB
2271 $index = null;
2272 }
2273 $sub = '_' . $sub;
2274 $this->gpm[$sub] = $index;
2275 return $sub;
2276 }
2277
9b8e5fb4 2278 protected function groupJoins()
4927ee54
FB
2279 {
2280 $joins = array();
2281 foreach ($this->gpm as $sub => $key) {
2282 if (is_null($key)) {
5c412626
FB
2283 $joins['gpa' . $sub] = PlSqlJoin::inner('groups');
2284 $joins['gpm' . $sub] = PlSqlJoin::left('group_members', '$ME.uid = $UID AND $ME.asso_id = gpa' . $sub . '.id');
4aae4d2c 2285 } else if (is_int($key) || ctype_digit($key)) {
5c412626 2286 $joins['gpm' . $sub] = PlSqlJoin::left('group_members', '$ME.uid = $UID AND $ME.asso_id = ' . $key);
4927ee54 2287 } else {
5c412626
FB
2288 $joins['gpa' . $sub] = PlSqlJoin::inner('groups', '$ME.diminutif = {?}', $key);
2289 $joins['gpm' . $sub] = PlSqlJoin::left('group_members', '$ME.uid = $UID AND $ME.asso_id = gpa' . $sub . '.id');
4927ee54
FB
2290 }
2291 }
2292 return $joins;
0fb3713c
RB
2293 }
2294
2295 /** BINETS
2296 */
2297
a7f8e48a
RB
2298 private $with_bi = false;
2299 private $with_bd = false;
d7ddf29b 2300 public function addBinetsFilter($with_enum = false)
0fb3713c
RB
2301 {
2302 $this->requireProfiles();
a7f8e48a
RB
2303 $this->with_bi = true;
2304 if ($with_enum) {
2305 $this->with_bd = true;
2306 return 'bd';
2307 } else {
2308 return 'bi';
2309 }
0fb3713c
RB
2310 }
2311
2312 protected function binetsJoins()
2313 {
2314 $joins = array();
a7f8e48a 2315 if ($this->with_bi) {
5c412626 2316 $joins['bi'] = PlSqlJoin::left('profile_binets', '$ME.pid = $PID');
0fb3713c 2317 }
a7f8e48a 2318 if ($this->with_bd) {
5c412626 2319 $joins['bd'] = PlSqlJoin::left('profile_binet_enum', '$ME.id = bi.binet_id');
a7f8e48a 2320 }
0fb3713c 2321 return $joins;
4927ee54 2322 }
aa21c568
FB
2323
2324 /** EMAILS
2325 */
2326 private $e = array();
2327 public function addEmailRedirectFilter($email = null)
2328 {
b8dcf62d 2329 $this->requireAccounts();
aa21c568
FB
2330 return $this->register_optional($this->e, $email);
2331 }
2332
2333 private $ve = array();
2334 public function addVirtualEmailFilter($email = null)
2335 {
21401768 2336 $this->addAliasFilter(self::ALIAS_FORLIFE);
aa21c568
FB
2337 return $this->register_optional($this->ve, $email);
2338 }
2339
21401768
FB
2340 const ALIAS_BEST = 'bestalias';
2341 const ALIAS_FORLIFE = 'forlife';
aa21c568
FB
2342 private $al = array();
2343 public function addAliasFilter($alias = null)
2344 {
b8dcf62d 2345 $this->requireAccounts();
aa21c568
FB
2346 return $this->register_optional($this->al, $alias);
2347 }
2348
9b8e5fb4 2349 protected function emailJoins()
aa21c568
FB
2350 {
2351 global $globals;
2352 $joins = array();
2353 foreach ($this->e as $sub=>$key) {
2354 if (is_null($key)) {
5c412626 2355 $joins['e' . $sub] = PlSqlJoin::left('emails', '$ME.uid = $UID AND $ME.flags != \'filter\'');
aa21c568 2356 } else {
2d6329a2
FB
2357 if (!is_array($key)) {
2358 $key = array($key);
2359 }
aab2ffdd 2360 $joins['e' . $sub] = PlSqlJoin::left('emails', '$ME.uid = $UID AND $ME.flags != \'filter\'
2f1c94e0 2361 AND $ME.email IN {?}', $key);
aa21c568
FB
2362 }
2363 }
21401768 2364 foreach ($this->al as $sub=>$key) {
aa21c568 2365 if (is_null($key)) {
5c412626 2366 $joins['al' . $sub] = PlSqlJoin::left('aliases', '$ME.uid = $UID AND $ME.type IN (\'alias\', \'a_vie\')');
21401768 2367 } else if ($key == self::ALIAS_BEST) {
5c412626 2368 $joins['al' . $sub] = PlSqlJoin::left('aliases', '$ME.uid = $UID AND $ME.type IN (\'alias\', \'a_vie\') AND FIND_IN_SET(\'bestalias\', $ME.flags)');
21401768 2369 } else if ($key == self::ALIAS_FORLIFE) {
5c412626 2370 $joins['al' . $sub] = PlSqlJoin::left('aliases', '$ME.uid = $UID AND $ME.type = \'a_vie\'');
aa21c568 2371 } else {
2d6329a2
FB
2372 if (!is_array($key)) {
2373 $key = array($key);
2374 }
aab2ffdd 2375 $joins['al' . $sub] = PlSqlJoin::left('aliases', '$ME.uid = $UID AND $ME.type IN (\'alias\', \'a_vie\')
bde68f05 2376 AND $ME.alias IN {?}', $key);
aa21c568 2377 }
aa21c568 2378 }
21401768 2379 foreach ($this->ve as $sub=>$key) {
aa21c568 2380 if (is_null($key)) {
5c412626 2381 $joins['v' . $sub] = PlSqlJoin::left('virtual', '$ME.type = \'user\'');
aa21c568 2382 } else {
2d6329a2
FB
2383 if (!is_array($key)) {
2384 $key = array($key);
2385 }
bde68f05 2386 $joins['v' . $sub] = PlSqlJoin::left('virtual', '$ME.type = \'user\' AND $ME.alias IN {?}', $key);
aa21c568 2387 }
5c412626
FB
2388 $joins['vr' . $sub] = PlSqlJoin::left('virtual_redirect',
2389 '$ME.vid = v' . $sub . '.vid
2390 AND ($ME.redirect IN (CONCAT(al_forlife.alias, \'@\', {?}),
2391 CONCAT(al_forlife.alias, \'@\', {?}),
2392 a.email))',
2393 $globals->mail->domain, $globals->mail->domain2);
aa21c568
FB
2394 }
2395 return $joins;
2396 }
3f42a6ad
FB
2397
2398
c4b24511
RB
2399 /** ADDRESSES
2400 */
036d1637 2401 private $with_pa = false;
c4b24511
RB
2402 public function addAddressFilter()
2403 {
b8dcf62d 2404 $this->requireProfiles();
036d1637
RB
2405 $this->with_pa = true;
2406 return 'pa';
c4b24511
RB
2407 }
2408
2b9ca54d
RB
2409 private $with_pac = false;
2410 public function addAddressCountryFilter()
2411 {
2412 $this->requireProfiles();
2413 $this->addAddressFilter();
2414 $this->with_pac = true;
2415 return 'gc';
2416 }
2417
d7ddf29b 2418 private $with_pal = false;
2b9ca54d
RB
2419 public function addAddressLocalityFilter()
2420 {
2421 $this->requireProfiles();
2422 $this->addAddressFilter();
2423 $this->with_pal = true;
2424 return 'gl';
2425 }
2426
9b8e5fb4 2427 protected function addressJoins()
c4b24511
RB
2428 {
2429 $joins = array();
036d1637 2430 if ($this->with_pa) {
5c412626 2431 $joins['pa'] = PlSqlJoin::left('profile_addresses', '$ME.pid = $PID');
c4b24511 2432 }
2b9ca54d 2433 if ($this->with_pac) {
5c412626 2434 $joins['gc'] = PlSqlJoin::left('geoloc_countries', '$ME.iso_3166_1_a2 = pa.countryID');
2b9ca54d
RB
2435 }
2436 if ($this->with_pal) {
5c412626 2437 $joins['gl'] = PlSqlJoin::left('geoloc_localities', '$ME.id = pa.localityID');
2b9ca54d 2438 }
c4b24511
RB
2439 return $joins;
2440 }
2441
2442
4083b126
RB
2443 /** CORPS
2444 */
2445
2446 private $pc = false;
2447 private $pce = array();
2448 private $pcr = false;
2449 public function addCorpsFilter($type)
2450 {
b8dcf62d 2451 $this->requireProfiles();
4083b126
RB
2452 $this->pc = true;
2453 if ($type == UFC_Corps::CURRENT) {
2454 $pce['pcec'] = 'current_corpsid';
2455 return 'pcec';
2456 } else if ($type == UFC_Corps::ORIGIN) {
2457 $pce['pceo'] = 'original_corpsid';
2458 return 'pceo';
2459 }
2460 }
2461
2462 public function addCorpsRankFilter()
2463 {
b8dcf62d 2464 $this->requireProfiles();
4083b126
RB
2465 $this->pc = true;
2466 $this->pcr = true;
2467 return 'pcr';
2468 }
2469
9b8e5fb4 2470 protected function corpsJoins()
4083b126
RB
2471 {
2472 $joins = array();
2473 if ($this->pc) {
5c412626 2474 $joins['pc'] = PlSqlJoin::left('profile_corps', '$ME.pid = $PID');
4083b126
RB
2475 }
2476 if ($this->pcr) {
5c412626 2477 $joins['pcr'] = PlSqlJoin::left('profile_corps_rank_enum', '$ME.id = pc.rankid');
4083b126
RB
2478 }
2479 foreach($this->pce as $sub => $field) {
5c412626 2480 $joins[$sub] = PlSqlJoin::left('profile_corps_enum', '$ME.id = pc.' . $field);
4083b126
RB
2481 }
2482 return $joins;
2483 }
2484
6a99c3ac
RB
2485 /** JOBS
2486 */
2487
61f61261
RB
2488 const JOB_SECTOR = 0x0001;
2489 const JOB_SUBSECTOR = 0x0002;
2490 const JOB_SUBSUBSECTOR = 0x0004;
2491 const JOB_ALTERNATES = 0x0008;
2492 const JOB_USERDEFINED = 0x0010;
2493 const JOB_CV = 0x0020;
2494
2495 const JOB_SECTORIZATION = 0x000F;
2496 const JOB_ANY = 0x003F;
6a99c3ac
RB
2497
2498 /** Joins :
2499 * pj => profile_job
2500 * pje => profile_job_enum
2501 * pjse => profile_job_sector_enum
2502 * pjsse => profile_job_subsector_enum
2503 * pjssse => profile_job_subsubsector_enum
2504 * pja => profile_job_alternates
3ac45f10 2505 * pjt => profile_job_terms
6a99c3ac
RB
2506 */
2507 private $with_pj = false;
2508 private $with_pje = false;
2509 private $with_pjse = false;
2510 private $with_pjsse = false;
2511 private $with_pjssse = false;
2512 private $with_pja = false;
3ac45f10 2513 private $with_pjt = 0;
6a99c3ac
RB
2514
2515 public function addJobFilter()
2516 {
b8dcf62d 2517 $this->requireProfiles();
6a99c3ac
RB
2518 $this->with_pj = true;
2519 return 'pj';
2520 }
2521
2522 public function addJobCompanyFilter()
2523 {
2524 $this->addJobFilter();
2525 $this->with_pje = true;
2526 return 'pje';
2527 }
2528
2529 public function addJobSectorizationFilter($type)
2530 {
2531 $this->addJobFilter();
2532 if ($type == self::JOB_SECTOR) {
2533 $this->with_pjse = true;
2534 return 'pjse';
2535 } else if ($type == self::JOB_SUBSECTOR) {
2536 $this->with_pjsse = true;
2537 return 'pjsse';
2538 } else if ($type == self::JOB_SUBSUBSECTOR) {
2539 $this->with_pjssse = true;
2540 return 'pjssse';
2541 } else if ($type == self::JOB_ALTERNATES) {
2542 $this->with_pja = true;
2543 return 'pja';
2544 }
2545 }
2546
3ac45f10
PC
2547 /**
2548 * Adds a filter on job terms of profile.
2549 * @param $nb the number of job terms to use
2550 * @return an array of the fields to filter (one for each term).
2551 * Code using this function should used returned field as is (contains table and field name).
2552 */
2553 public function addJobTermsFilter($nb = 1)
2554 {
2555 $this->with_pjt = $nb;
2556 $jobtermstable = array();
2557 for ($i = 1; $i <= $nb; ++$i) {
2558 $jobtermstable[] = 'pjtr_'.$i.'.jtid_1';
2559 }
2560 return $jobtermstable;
2561 }
2562
9b8e5fb4 2563 protected function jobJoins()
6a99c3ac
RB
2564 {
2565 $joins = array();
2566 if ($this->with_pj) {
5c412626 2567 $joins['pj'] = PlSqlJoin::left('profile_job', '$ME.pid = $PID');
6a99c3ac
RB
2568 }
2569 if ($this->with_pje) {
5c412626 2570 $joins['pje'] = PlSqlJoin::left('profile_job_enum', '$ME.id = pj.jobid');
6a99c3ac
RB
2571 }
2572 if ($this->with_pjse) {
5c412626 2573 $joins['pjse'] = PlSqlJoin::left('profile_job_sector_enum', '$ME.id = pj.sectorid');
6a99c3ac
RB
2574 }
2575 if ($this->with_pjsse) {
5c412626 2576 $joins['pjsse'] = PlSqlJoin::left('profile_job_subsector_enum', '$ME.id = pj.subsectorid');
6a99c3ac
RB
2577 }
2578 if ($this->with_pjssse) {
5c412626 2579 $joins['pjssse'] = PlSqlJoin::left('profile_job_subsubsector_enum', '$ME.id = pj.subsubsectorid');
6a99c3ac
RB
2580 }
2581 if ($this->with_pja) {
5c412626 2582 $joins['pja'] = PlSqlJoin::left('profile_job_alternates', '$ME.subsubsectorid = pj.subsubsectorid');
6a99c3ac 2583 }
3ac45f10
PC
2584 if ($this->with_pjt > 0) {
2585 for ($i = 1; $i <= $this->with_pjt; ++$i) {
2586 $joins['pjt_'.$i] = PlSqlJoin::left('profile_job_term', '$ME.pid = $PID');
2587 $joins['pjtr_'.$i] = PlSqlJoin::left('profile_job_term_relation', '$ME.jtid_2 = pjt_'.$i.'.jtid');
2588 }
2589 }
6a99c3ac
RB
2590 return $joins;
2591 }
2592
0a2e9c74
RB
2593 /** NETWORKING
2594 */
2595
2596 private $with_pnw = false;
2597 public function addNetworkingFilter()
2598 {
b8dcf62d 2599 $this->requireAccounts();
0a2e9c74
RB
2600 $this->with_pnw = true;
2601 return 'pnw';
2602 }
2603
9b8e5fb4 2604 protected function networkingJoins()
0a2e9c74
RB
2605 {
2606 $joins = array();
2607 if ($this->with_pnw) {
5c412626 2608 $joins['pnw'] = PlSqlJoin::left('profile_networking', '$ME.pid = $PID');
0a2e9c74
RB
2609 }
2610 return $joins;
2611 }
2612
6d62969e
RB
2613 /** PHONE
2614 */
2615
2d83cac9 2616 private $with_ptel = false;
6d62969e
RB
2617
2618 public function addPhoneFilter()
2619 {
b8dcf62d 2620 $this->requireAccounts();
2d83cac9 2621 $this->with_ptel = true;
6d62969e
RB
2622 return 'ptel';
2623 }
2624
9b8e5fb4 2625 protected function phoneJoins()
6d62969e
RB
2626 {
2627 $joins = array();
2d83cac9 2628 if ($this->with_ptel) {
5c412626 2629 $joins['ptel'] = PlSqlJoin::left('profile_phones', '$ME.pid = $PID');
6d62969e
RB
2630 }
2631 return $joins;
2632 }
2633
ceb512d2
RB
2634 /** MEDALS
2635 */
2636
2d83cac9 2637 private $with_pmed = false;
ceb512d2
RB
2638 public function addMedalFilter()
2639 {
b8dcf62d 2640 $this->requireProfiles();
2d83cac9 2641 $this->with_pmed = true;
ceb512d2
RB
2642 return 'pmed';
2643 }
2644
9b8e5fb4 2645 protected function medalJoins()
ceb512d2
RB
2646 {
2647 $joins = array();
2d83cac9 2648 if ($this->with_pmed) {
5c412626 2649 $joins['pmed'] = PlSqlJoin::left('profile_medals', '$ME.pid = $PID');
ceb512d2
RB
2650 }
2651 return $joins;
2652 }
2653
671b7073
RB
2654 /** MENTORING
2655 */
2656
2657 private $pms = array();
2658 const MENTOR_EXPERTISE = 1;
2659 const MENTOR_COUNTRY = 2;
2660 const MENTOR_SECTOR = 3;
2661
2662 public function addMentorFilter($type)
2663 {
b8dcf62d 2664 $this->requireAccounts();
671b7073 2665 switch($type) {
4a93c3a3
RB
2666 case self::MENTOR_EXPERTISE:
2667 $this->pms['pme'] = 'profile_mentor';
671b7073 2668 return 'pme';
4a93c3a3
RB
2669 case self::MENTOR_COUNTRY:
2670 $this->pms['pmc'] = 'profile_mentor_country';
671b7073 2671 return 'pmc';
4a93c3a3
RB
2672 case self::MENTOR_SECTOR:
2673 $this->pms['pms'] = 'profile_mentor_sector';
671b7073
RB
2674 return 'pms';
2675 default:
5d2e55c7 2676 Platal::page()->killError("Undefined mentor filter.");
671b7073
RB
2677 }
2678 }
2679
9b8e5fb4 2680 protected function mentorJoins()
671b7073
RB
2681 {
2682 $joins = array();
2683 foreach ($this->pms as $sub => $tab) {
5c412626 2684 $joins[$sub] = PlSqlJoin::left($tab, '$ME.pid = $PID');
671b7073
RB
2685 }
2686 return $joins;
2687 }
2688
3f42a6ad
FB
2689 /** CONTACTS
2690 */
2691 private $cts = array();
2692 public function addContactFilter($uid = null)
2693 {
c96da6c1 2694 $this->requireProfiles();
3f42a6ad
FB
2695 return $this->register_optional($this->cts, is_null($uid) ? null : 'user_' . $uid);
2696 }
2697
9b8e5fb4 2698 protected function contactJoins()
3f42a6ad
FB
2699 {
2700 $joins = array();
2701 foreach ($this->cts as $sub=>$key) {
2702 if (is_null($key)) {
5c412626 2703 $joins['c' . $sub] = PlSqlJoin::left('contacts', '$ME.contact = $PID');
3f42a6ad 2704 } else {
5c412626 2705 $joins['c' . $sub] = PlSqlJoin::left('contacts', '$ME.uid = {?} AND $ME.contact = $PID', substr($key, 5));
3f42a6ad
FB
2706 }
2707 }
2708 return $joins;
2709 }
4e7bf1e0
FB
2710
2711
2712 /** CARNET
2713 */
2714 private $wn = array();
2715 public function addWatchRegistrationFilter($uid = null)
2716 {
b8dcf62d 2717 $this->requireAccounts();
4e7bf1e0
FB
2718 return $this->register_optional($this->wn, is_null($uid) ? null : 'user_' . $uid);
2719 }
2720
2721 private $wp = array();
2722 public function addWatchPromoFilter($uid = null)
2723 {
b8dcf62d 2724 $this->requireAccounts();
4e7bf1e0
FB
2725 return $this->register_optional($this->wp, is_null($uid) ? null : 'user_' . $uid);
2726 }
2727
2728 private $w = array();
2729 public function addWatchFilter($uid = null)
2730 {
b8dcf62d 2731 $this->requireAccounts();
4e7bf1e0
FB
2732 return $this->register_optional($this->w, is_null($uid) ? null : 'user_' . $uid);
2733 }
2734
9b8e5fb4 2735 protected function watchJoins()
4e7bf1e0
FB
2736 {
2737 $joins = array();
2738 foreach ($this->w as $sub=>$key) {
2739 if (is_null($key)) {
5c412626 2740 $joins['w' . $sub] = PlSqlJoin::left('watch');
4e7bf1e0 2741 } else {
5c412626 2742 $joins['w' . $sub] = PlSqlJoin::left('watch', '$ME.uid = {?}', substr($key, 5));
4e7bf1e0
FB
2743 }
2744 }
2745 foreach ($this->wn as $sub=>$key) {
2746 if (is_null($key)) {
5c412626 2747 $joins['wn' . $sub] = PlSqlJoin::left('watch_nonins', '$ME.ni_id = $UID');
4e7bf1e0 2748 } else {
5c412626 2749 $joins['wn' . $sub] = PlSqlJoin::left('watch_nonins', '$ME.uid = {?} AND $ME.ni_id = $UID', substr($key, 5));
4e7bf1e0
FB
2750 }
2751 }
2752 foreach ($this->wn as $sub=>$key) {
2753 if (is_null($key)) {
5c412626 2754 $joins['wn' . $sub] = PlSqlJoin::left('watch_nonins', '$ME.ni_id = $UID');
4e7bf1e0 2755 } else {
5c412626 2756 $joins['wn' . $sub] = PlSqlJoin::left('watch_nonins', '$ME.uid = {?} AND $ME.ni_id = $UID', substr($key, 5));
4e7bf1e0
FB
2757 }
2758 }
2759 foreach ($this->wp as $sub=>$key) {
2760 if (is_null($key)) {
5c412626 2761 $joins['wp' . $sub] = PlSqlJoin::left('watch_promo');
4e7bf1e0 2762 } else {
5c412626 2763 $joins['wp' . $sub] = PlSqlJoin::left('watch_promo', '$ME.uid = {?}', substr($key, 5));
4e7bf1e0
FB
2764 }
2765 }
2766 return $joins;
2767 }
48885bbe
FB
2768
2769
470d14f6
FB
2770 /** PHOTOS
2771 */
2772 private $with_photo;
2773 public function addPhotoFilter()
2774 {
2775 $this->requireProfiles();
2776 $this->with_photo = true;
2777 }
2778
2779 protected function photoJoins()
2780 {
2781 if ($this->with_photo) {
2782 return array('photo' => PlSqlJoin::left('profile_photos', '$ME.pid = $PID'));
2783 } else {
2784 return array();
2785 }
2786 }
2787
2788
48885bbe
FB
2789 /** MARKETING
2790 */
2791 private $with_rm;
2792 public function addMarketingHash()
2793 {
2794 $this->requireAccounts();
2795 $this->with_rm = true;
2796 }
2797
2798 protected function marketingJoins()
2799 {
2800 if ($this->with_rm) {
5c412626 2801 return array('rm' => PlSqlJoin::left('register_marketing', '$ME.uid = $UID'));
48885bbe
FB
2802 } else {
2803 return array();
2804 }
2805 }
a087cc8d 2806}
8363588b 2807// }}}
3f42a6ad 2808
a7d9ab89
RB
2809// {{{ class ProfileFilter
2810class ProfileFilter extends UserFilter
2811{
434570c4 2812 public function get($limit = null)
a7d9ab89
RB
2813 {
2814 return $this->getProfiles($limit);
2815 }
2daf7250
RB
2816
2817 public function filter(array $profiles, $limit = null)
2818 {
2819 return $this->filterProfiles($profiles, self::defaultLimit($limit));
2820 }
2821
2822 public function getTotalCount()
2823 {
2824 return $this->getTotalProfileCount();
2825 }
ccc951d9
RB
2826
2827 public function getGroups()
2828 {
2829 return $this->getPIDGroups();
2830 }
a7d9ab89
RB
2831}
2832// }}}
2833
a087cc8d
FB
2834// vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
2835?>