Commit | Line | Data |
---|---|---|
cd0c2ac4 FB |
1 | <?php |
2 | /*************************************************************************** | |
12262f13 | 3 | * Copyright (C) 2003-2011 Polytechnique.org * |
cd0c2ac4 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 | ||
22 | // {{{ abstract class UserFilterCondition | |
23 | /** This class describe objects which filter users based | |
24 | * on various parameters. | |
25 | * The parameters of the filter must be given to the constructor. | |
26 | * The buildCondition function is called by UserFilter when | |
27 | * actually building the query. That function must call | |
28 | * $uf->addWheteverFilter so that the UserFilter makes | |
29 | * adequate joins. It must return the 'WHERE' condition to use | |
30 | * with the filter. | |
31 | */ | |
32 | abstract class UserFilterCondition implements PlFilterCondition | |
33 | { | |
57a4162e | 34 | const OP_EQUALS = '='; |
b3deda78 FB |
35 | const OP_GREATER = '>'; |
36 | const OP_NOTGREATER = '<='; | |
37 | const OP_LESSER = '<'; | |
38 | const OP_NOTLESSER = '>='; | |
39 | const OP_NULL = 'null'; | |
40 | const OP_NOTNULL = 'not null'; | |
41 | const OP_CONTAINS = 'contains'; | |
42 | const OP_PREFIX = 'prefix'; | |
43 | const OP_SUFFIX = 'suffix'; | |
44 | ||
45 | protected function buildExport($type) | |
46 | { | |
47 | $export = array('type' => $type); | |
48 | return $export; | |
49 | } | |
50 | ||
cd0c2ac4 FB |
51 | public function export() |
52 | { | |
53 | throw new Exception("This class is not exportable"); | |
54 | } | |
b3deda78 FB |
55 | |
56 | public static function comparisonFromXDBWildcard($wildcard) | |
57 | { | |
58 | switch ($wildcard) { | |
59 | case XDB::WILDCARD_EXACT: | |
60 | return self::OP_EQUALS; | |
61 | case XDB::WILDCARD_PREFIX: | |
62 | return self::OP_PREFIX; | |
63 | case XDB::WILDCARD_SUFFIX: | |
64 | return self::OP_SUFFIX; | |
65 | case XDB::WILDCARD_CONTAINS: | |
66 | return self::OP_CONTAINS; | |
67 | } | |
68 | throw new Exception("Unknown wildcard mode: $wildcard"); | |
69 | } | |
70 | ||
71 | public static function xdbWildcardFromComparison($comparison) | |
72 | { | |
73 | if (!self::isStringComparison($comparison)) { | |
74 | throw new Exception("Unknown string coparison: $comparison"); | |
75 | } | |
76 | switch ($comparison) { | |
77 | case self::OP_EQUALS: | |
78 | return XDB::WILDCARD_EXACT; | |
79 | case self::OP_PREFIX: | |
80 | return XDB::WILDCARD_PREFIX; | |
81 | case self::OP_SUFFIX: | |
82 | return XDB::WILDCARD_SUFFIX; | |
83 | case self::OP_CONTAINS: | |
84 | return XDB::WILDCARD_CONTAINS; | |
85 | } | |
86 | } | |
87 | ||
88 | private static function isNumericComparison($comparison) | |
89 | { | |
90 | return $comparison == self::OP_EQUALS | |
91 | || $comparison == self::OP_GREATER | |
92 | || $comparison == self::OP_NOTGREATER | |
93 | || $comparison == self::OP_LESSER | |
94 | || $comparison == self::OP_NOTLESSER; | |
95 | } | |
96 | ||
97 | private static function isStringComparison($comparison) | |
98 | { | |
99 | return $comparison == self::OP_EQUALS | |
100 | || $comparison == self::OP_CONTAINS | |
101 | || $comparison == self::OP_PREFIX | |
102 | || $comparison == self::OP_SUFFIX; | |
103 | } | |
104 | ||
105 | public static function fromExport(array $export) | |
106 | { | |
107 | $export = new PlDict($export); | |
108 | if (!$export->has('type')) { | |
109 | throw new Exception("Missing type in export"); | |
110 | } | |
111 | $type = $export->s('type'); | |
112 | $cond = null; | |
113 | switch ($type) { | |
114 | case 'and': | |
115 | case 'or': | |
116 | case 'not': | |
117 | case 'true': | |
118 | case 'false': | |
119 | $class = 'pfc_' . $type; | |
120 | $cond = new $class(); | |
121 | break; | |
122 | ||
123 | case 'host': | |
124 | if ($export->has('ip')) { | |
125 | $cond = new UFC_Ip($export->s('ip')); | |
126 | } | |
127 | break; | |
128 | ||
129 | case 'comment': | |
130 | if ($export->has('text') && $export->s('comparison') == self::OP_CONTAINS) { | |
131 | $cond = new UFC_Comment($export->s('text')); | |
132 | } | |
133 | break; | |
134 | ||
135 | case 'promo': | |
136 | if ($export->has('promo') && self::isNumericComparison($export->s('comparison'))) { | |
137 | $cond = new UFC_Promo($export->s('comparison'), | |
138 | $export->s('grade', UserFilter::DISPLAY), | |
139 | $export->s('promo')); | |
140 | } | |
141 | break; | |
142 | ||
143 | case 'lastname': | |
144 | case 'name': | |
145 | case 'firstname': | |
146 | case 'nickname': | |
147 | case 'pseudonym': | |
148 | if ($export->has('text')) { | |
149 | $flag = self::xdbWildcardFromComparison($export->s('comparison')); | |
150 | if ($export->b('search_in_variants')) { | |
151 | $flag |= UFC_Name::VARIANTS; | |
152 | } | |
153 | if ($export->b('search_in_particle')) { | |
154 | $flag |= UFC_Name::PARTICLE; | |
155 | } | |
156 | $cond = new UFC_Name($type, $export->s('text'), $flag); | |
157 | } | |
158 | break; | |
159 | ||
160 | case 'account_type': | |
161 | case 'account_perm': | |
162 | case 'hrpid': | |
163 | case 'hruid': | |
164 | $values = $export->v('values', array()); | |
165 | $class = 'ufc_' . str_replace('_', '', $type); | |
166 | $cond = new $class($values); | |
167 | break; | |
168 | ||
7563eb0c RB |
169 | case 'school_id': |
170 | $values = $export->v('values', array()); | |
171 | $school_type = $export->s('school_type'); | |
172 | $cond = new UFC_SchoolId($school_type, $values); | |
173 | break; | |
174 | ||
b3deda78 | 175 | case 'has_profile': |
df6d9034 RB |
176 | case 'has_email_redirect': |
177 | case 'has_valid_email': | |
b3deda78 FB |
178 | $class = 'ufc_' . str_replace('_', '', $type); |
179 | $cond = new $class(); | |
180 | break; | |
181 | ||
182 | default: | |
183 | throw new Exception("Unknown condition type: $type"); | |
184 | } | |
185 | if (is_null($cond)) { | |
186 | throw new Exception("Unsupported $type definition"); | |
187 | } | |
188 | if ($cond instanceof PFC_NChildren) { | |
189 | $children = $export->v('children', array()); | |
190 | foreach ($children as $child) { | |
191 | $cond->addChild(self::fromExport($child)); | |
192 | } | |
193 | } else if ($cond instanceof PFC_OneChild) { | |
194 | if ($export->has('child')) { | |
195 | $cond->setChild(self::fromExport($export->v('child'))); | |
196 | } | |
197 | } | |
198 | return $cond; | |
199 | } | |
cd0c2ac4 FB |
200 | } |
201 | // }}} | |
cd0c2ac4 FB |
202 | // {{{ class UFC_HasProfile |
203 | /** Filters users who have a profile | |
204 | */ | |
205 | class UFC_HasProfile extends UserFilterCondition | |
206 | { | |
207 | public function buildCondition(PlFilter $uf) | |
208 | { | |
209 | $uf->requireProfiles(); | |
210 | return '$PID IS NOT NULL'; | |
211 | } | |
b3deda78 FB |
212 | |
213 | public function export() | |
214 | { | |
215 | return $this->buildExport('has_profile'); | |
216 | } | |
cd0c2ac4 FB |
217 | } |
218 | // }}} | |
cd0c2ac4 FB |
219 | // {{{ class UFC_AccountType |
220 | /** Filters users who have one of the given account types | |
221 | */ | |
222 | class UFC_AccountType extends UserFilterCondition | |
223 | { | |
224 | private $types; | |
225 | ||
226 | public function __construct() | |
227 | { | |
228 | $this->types = pl_flatten(func_get_args()); | |
229 | } | |
230 | ||
231 | public function buildCondition(PlFilter $uf) | |
232 | { | |
233 | $uf->requireAccounts(); | |
234 | return XDB::format('a.type IN {?}', $this->types); | |
235 | } | |
b3deda78 FB |
236 | |
237 | public function export() | |
238 | { | |
239 | $export = $this->buildExport('account_type'); | |
240 | $export['values'] = $this->types; | |
241 | return $export; | |
242 | } | |
cd0c2ac4 FB |
243 | } |
244 | // }}} | |
cd0c2ac4 FB |
245 | // {{{ class UFC_AccountPerm |
246 | /** Filters users who have one of the given permissions | |
247 | */ | |
248 | class UFC_AccountPerm extends UserFilterCondition | |
249 | { | |
250 | private $perms; | |
251 | ||
252 | public function __construct() | |
253 | { | |
254 | $this->perms = pl_flatten(func_get_args()); | |
255 | } | |
256 | ||
257 | public function buildCondition(PlFilter $uf) | |
258 | { | |
259 | $uf->requirePerms(); | |
260 | $conds = array(); | |
261 | foreach ($this->perms as $perm) { | |
262 | $conds[] = XDB::format('FIND_IN_SET({?}, IF(a.user_perms IS NULL, at.perms, | |
263 | CONCAT(at.perms, \',\', a.user_perms)))', | |
264 | $perm); | |
265 | } | |
266 | if (empty($conds)) { | |
267 | return self::COND_TRUE; | |
268 | } else { | |
269 | return implode(' OR ', $conds); | |
270 | } | |
271 | } | |
b3deda78 FB |
272 | |
273 | public function export() | |
274 | { | |
275 | $export = $this->buildExport('account_perm'); | |
276 | $export['values'] = $this->perms; | |
277 | return $export; | |
278 | } | |
cd0c2ac4 FB |
279 | } |
280 | // }}} | |
cd0c2ac4 FB |
281 | // {{{ class UFC_Hruid |
282 | /** Filters users based on their hruid | |
283 | * @param $val Either an hruid, or a list of those | |
284 | */ | |
285 | class UFC_Hruid extends UserFilterCondition | |
286 | { | |
287 | private $hruids; | |
288 | ||
289 | public function __construct() | |
290 | { | |
291 | $this->hruids = pl_flatten(func_get_args()); | |
292 | } | |
293 | ||
294 | public function buildCondition(PlFilter $uf) | |
295 | { | |
296 | $uf->requireAccounts(); | |
297 | return XDB::format('a.hruid IN {?}', $this->hruids); | |
298 | } | |
b3deda78 FB |
299 | |
300 | public function export() | |
301 | { | |
302 | $export = $this->buildExport('hruid'); | |
303 | $export['values'] = $this->hruids; | |
304 | return $export; | |
305 | } | |
cd0c2ac4 FB |
306 | } |
307 | // }}} | |
cd0c2ac4 FB |
308 | // {{{ class UFC_Hrpid |
309 | /** Filters users based on the hrpid of their profiles | |
310 | * @param $val Either an hrpid, or a list of those | |
311 | */ | |
312 | class UFC_Hrpid extends UserFilterCondition | |
313 | { | |
314 | private $hrpids; | |
315 | ||
316 | public function __construct() | |
317 | { | |
318 | $this->hrpids = pl_flatten(func_get_args()); | |
319 | } | |
320 | ||
321 | public function buildCondition(PlFilter $uf) | |
322 | { | |
323 | $uf->requireProfiles(); | |
324 | return XDB::format('p.hrpid IN {?}', $this->hrpids); | |
325 | } | |
b3deda78 FB |
326 | |
327 | public function export() | |
328 | { | |
329 | $export = $this->buildExport('hrpid'); | |
330 | $export['values'] = $this->hrpids; | |
331 | return $export; | |
332 | } | |
cd0c2ac4 FB |
333 | } |
334 | // }}} | |
57a4162e | 335 | // {{{ class UFC_HasEmailRedirect |
df6d9034 | 336 | /** Filters users, keeping only those with a valid email redirection (only X.org accounts). |
57a4162e RB |
337 | */ |
338 | class UFC_HasEmailRedirect extends UserFilterCondition | |
339 | { | |
340 | public function buildCondition(PlFilter $uf) | |
341 | { | |
0702af29 SJ |
342 | $sub_redirect = $uf->addActiveEmailRedirectFilter(); |
343 | return 'rf.redirect IS NOT NULL'; | |
57a4162e | 344 | } |
df6d9034 RB |
345 | |
346 | public function export() | |
347 | { | |
348 | $export = $this->buildExport('has_email_redirect'); | |
349 | return $export; | |
350 | } | |
351 | } | |
352 | // }}} | |
353 | // {{{ class UFC_HasValidEmail | |
354 | /** Filters users, keeping only those with a valid email address (all accounts). | |
355 | */ | |
356 | class UFC_HasValidEmail extends UserFilterCondition | |
357 | { | |
358 | public function buildCondition(PlFilter $uf) | |
359 | { | |
360 | $sub_redirect = $uf->addEmailRedirectFilter(); | |
361 | $uf->requireAccounts(); | |
362 | return 'ra' . $sub_redirect . '.flags = \'active\' OR a.email IS NOT NULL'; | |
363 | } | |
364 | ||
365 | public function export() | |
366 | { | |
367 | $export = $this->buildExport('has_valid_email'); | |
368 | return $export; | |
369 | } | |
57a4162e RB |
370 | } |
371 | // }}} | |
cd0c2ac4 FB |
372 | // {{{ class UFC_Ip |
373 | /** Filters users based on one of their last IPs | |
374 | * @param $ip IP from which connection are checked | |
375 | */ | |
376 | class UFC_Ip extends UserFilterCondition | |
377 | { | |
378 | private $ip; | |
379 | ||
380 | public function __construct($ip) | |
381 | { | |
382 | $this->ip = $ip; | |
383 | } | |
384 | ||
385 | public function buildCondition(PlFilter $uf) | |
386 | { | |
387 | $sub = $uf->addLoggerFilter(); | |
388 | $ip = ip_to_uint($this->ip); | |
389 | return XDB::format($sub . '.ip = {?} OR ' . $sub . '.forward_ip = {?}', $ip, $ip); | |
390 | } | |
b3deda78 FB |
391 | |
392 | public function export() | |
393 | { | |
394 | $export = $this->buildExport('host'); | |
395 | $export['ip'] = $this->ip; | |
396 | return $export; | |
397 | } | |
cd0c2ac4 FB |
398 | } |
399 | // }}} | |
cd0c2ac4 FB |
400 | // {{{ class UFC_Comment |
401 | class UFC_Comment extends UserFilterCondition | |
402 | { | |
403 | private $text; | |
404 | ||
405 | public function __construct($text) | |
406 | { | |
407 | $this->text = $text; | |
408 | } | |
409 | ||
410 | public function buildCondition(PlFilter $uf) | |
411 | { | |
412 | $uf->requireProfiles(); | |
22771578 | 413 | return $uf->getVisibilityConditionForField('p.freetext_pub') . ' AND p.freetext ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->text); |
cd0c2ac4 | 414 | } |
b3deda78 FB |
415 | |
416 | public function export() | |
417 | { | |
418 | $export = $this->buildExport('comment'); | |
419 | $export['comparison'] = self::OP_CONTAINS; | |
420 | $export['text'] = $this->text; | |
421 | return $export; | |
422 | } | |
cd0c2ac4 FB |
423 | } |
424 | // }}} | |
cd0c2ac4 FB |
425 | // {{{ class UFC_Promo |
426 | /** Filters users based on promotion | |
427 | * @param $comparison Comparison operator (>, =, ...) | |
428 | * @param $grade Formation on which to restrict, UserFilter::DISPLAY for "any formation" | |
429 | * @param $promo Promotion on which the filter is based | |
430 | */ | |
431 | class UFC_Promo extends UserFilterCondition | |
432 | { | |
433 | ||
434 | private $grade; | |
435 | private $promo; | |
436 | private $comparison; | |
437 | ||
438 | public function __construct($comparison, $grade, $promo) | |
439 | { | |
440 | $this->grade = $grade; | |
441 | $this->comparison = $comparison; | |
442 | $this->promo = $promo; | |
443 | if ($this->grade != UserFilter::DISPLAY) { | |
444 | UserFilter::assertGrade($this->grade); | |
445 | } | |
446 | if ($this->grade == UserFilter::DISPLAY && $this->comparison != '=') { | |
447 | // XXX: we might try to guess the grade from the first char of the promo and forbid only '<= 2004', but allow '<= X2004' | |
448 | Platal::page()->killError("Il n'est pas possible d'appliquer la comparaison '" . $this->comparison . "' aux promotions sans spécifier de formation (X/M/D)"); | |
449 | } | |
450 | } | |
451 | ||
452 | public function buildCondition(PlFilter $uf) | |
453 | { | |
454 | if ($this->grade == UserFilter::DISPLAY) { | |
455 | $sub = $uf->addDisplayFilter(); | |
456 | return XDB::format('pd' . $sub . '.promo ' . $this->comparison . ' {?}', $this->promo); | |
457 | } else { | |
458 | $sub = $uf->addEducationFilter(true, $this->grade); | |
459 | $field = 'pe' . $sub . '.' . UserFilter::promoYear($this->grade); | |
460 | return $field . ' IS NOT NULL AND ' . $field . ' ' . $this->comparison . ' ' . XDB::format('{?}', $this->promo); | |
461 | } | |
462 | } | |
b3deda78 FB |
463 | |
464 | public function export() | |
465 | { | |
45a46551 | 466 | $export = $this->buildExport('promo'); |
b3deda78 FB |
467 | $export['comparison'] = $this->comparison; |
468 | if ($this->grade != UserFilter::DISPLAY) { | |
469 | $export['grade'] = $this->grade; | |
470 | } | |
471 | $export['promo'] = $this->promo; | |
472 | return $export; | |
473 | } | |
cd0c2ac4 FB |
474 | } |
475 | // }}} | |
cd0c2ac4 FB |
476 | // {{{ class UFC_SchoolId |
477 | /** Filters users based on their shoold identifier | |
478 | * @param type Parameter type (Xorg, AX, School) | |
479 | * @param value Array of school ids | |
480 | */ | |
481 | class UFC_SchoolId extends UserFilterCondition | |
482 | { | |
483 | const AX = 'ax'; | |
484 | const Xorg = 'xorg'; | |
485 | const School = 'school'; | |
486 | ||
487 | private $type; | |
488 | private $id; | |
489 | ||
490 | static public function assertType($type) | |
491 | { | |
492 | if ($type != self::AX && $type != self::Xorg && $type != self::School) { | |
493 | Platal::page()->killError("Type de matricule invalide: $type"); | |
494 | } | |
495 | } | |
496 | ||
497 | /** Construct a UFC_SchoolId | |
498 | * The first argument is the type, all following arguments can be either ids | |
499 | * or arrays of ids to use: | |
500 | * $ufc = new UFC_SchoolId(UFC_SchoolId::AX, $id1, $id2, array($id3, $id4)); | |
501 | */ | |
502 | public function __construct($type) | |
503 | { | |
504 | $this->type = $type; | |
505 | $ids = func_get_args(); | |
506 | array_shift($ids); | |
507 | $this->ids = pl_flatten($ids); | |
508 | self::assertType($type); | |
509 | } | |
510 | ||
511 | public function buildCondition(PlFilter $uf) | |
512 | { | |
513 | $uf->requireProfiles(); | |
514 | $ids = $this->ids; | |
515 | $type = $this->type; | |
516 | if ($type == self::School) { | |
517 | $type = self::Xorg; | |
518 | $ids = array_map(array('Profile', 'getXorgId'), $ids); | |
519 | } | |
520 | return XDB::format('p.' . $type . '_id IN {?}', $ids); | |
521 | } | |
7563eb0c RB |
522 | |
523 | public function export() | |
524 | { | |
525 | $export = $this->buildExport('school_id'); | |
526 | $export['school_type'] = $this->type; | |
527 | $export['values'] = $this->ids; | |
528 | return $export; | |
529 | } | |
cd0c2ac4 FB |
530 | } |
531 | // }}} | |
cd0c2ac4 FB |
532 | // {{{ class UFC_EducationSchool |
533 | /** Filters users by formation | |
534 | * @param $val The formation to search (either ID or array of IDs) | |
535 | */ | |
536 | class UFC_EducationSchool extends UserFilterCondition | |
537 | { | |
538 | private $val; | |
539 | ||
540 | public function __construct() | |
541 | { | |
542 | $this->val = pl_flatten(func_get_args()); | |
543 | } | |
544 | ||
545 | public function buildCondition(PlFilter $uf) | |
546 | { | |
547 | $sub = $uf->addEducationFilter(); | |
548 | return XDB::format('pe' . $sub . '.eduid IN {?}', $this->val); | |
549 | } | |
550 | } | |
551 | // }}} | |
cd0c2ac4 FB |
552 | // {{{ class UFC_EducationDegree |
553 | class UFC_EducationDegree extends UserFilterCondition | |
554 | { | |
555 | private $diploma; | |
556 | ||
557 | public function __construct() | |
558 | { | |
559 | $this->diploma = pl_flatten(func_get_args()); | |
560 | } | |
561 | ||
562 | public function buildCondition(PlFilter $uf) | |
563 | { | |
564 | $sub = $uf->addEducationFilter(); | |
565 | return XDB::format('pe' . $sub . '.degreeid IN {?}', $this->diploma); | |
566 | } | |
567 | } | |
568 | // }}} | |
cd0c2ac4 FB |
569 | // {{{ class UFC_EducationField |
570 | class UFC_EducationField extends UserFilterCondition | |
571 | { | |
572 | private $val; | |
573 | ||
574 | public function __construct() | |
575 | { | |
576 | $this->val = pl_flatten(func_get_args()); | |
577 | } | |
578 | ||
579 | public function buildCondition(PlFilter $uf) | |
580 | { | |
581 | $sub = $uf->addEducationFilter(); | |
582 | return XDB::format('pe' . $sub . '.fieldid IN {?}', $this->val); | |
583 | } | |
584 | } | |
585 | // }}} | |
3e6ab778 SJ |
586 | // {{{ class UFC_NameInitial |
587 | /** Filters users based on sort_name | |
588 | * @param $initial Initial on which to filter | |
cd0c2ac4 | 589 | */ |
3e6ab778 | 590 | class UFC_NameInitial extends UserFilterCondition |
cd0c2ac4 | 591 | { |
3e6ab778 | 592 | private $initial; |
cd0c2ac4 | 593 | |
3e6ab778 | 594 | public function __construct($initial) |
cd0c2ac4 | 595 | { |
3e6ab778 | 596 | $this->initial = $initial; |
cd0c2ac4 FB |
597 | } |
598 | ||
599 | public function buildCondition(PlFilter $uf) | |
600 | { | |
93f014c4 SJ |
601 | $table = 'sort_name'; |
602 | if ($uf->accountsRequired()) { | |
603 | $table = Profile::getAccountEquivalentName($table); | |
604 | $sub = 'a'; | |
605 | } else { | |
606 | $uf->addDisplayFilter(); | |
607 | $sub = 'pd'; | |
608 | } | |
609 | return 'SUBSTRING(' . $sub . '.' . $table . ', 1, 1) ' . XDB::formatWildcards(XDB::WILDCARD_PREFIX, $this->initial); | |
cd0c2ac4 | 610 | } |
b3deda78 FB |
611 | |
612 | public function export() | |
613 | { | |
3e6ab778 | 614 | $export = $this->buildExport($this->initial); |
b3deda78 FB |
615 | return $export; |
616 | } | |
cd0c2ac4 FB |
617 | } |
618 | // }}} | |
cd0c2ac4 FB |
619 | // {{{ class UFC_NameTokens |
620 | /** Selects users based on tokens in their name (for quicksearch) | |
621 | * @param $tokens An array of tokens to search | |
622 | * @param $flags Flags the tokens must have (e.g 'public' for public search) | |
623 | * @param $soundex (bool) Whether those tokens are fulltext or soundex | |
624 | */ | |
625 | class UFC_NameTokens extends UserFilterCondition | |
626 | { | |
627 | /* Flags */ | |
628 | const FLAG_PUBLIC = 'public'; | |
629 | ||
630 | private $tokens; | |
631 | private $flags; | |
632 | private $soundex; | |
633 | private $exact; | |
5600b2fe | 634 | private $general_type; |
cd0c2ac4 | 635 | |
5600b2fe | 636 | public function __construct($tokens, $flags = array(), $soundex = false, $exact = false, $general_type = '') |
cd0c2ac4 FB |
637 | { |
638 | if (is_array($tokens)) { | |
639 | $this->tokens = $tokens; | |
640 | } else { | |
641 | $this->tokens = array($tokens); | |
642 | } | |
643 | if (is_array($flags)) { | |
644 | $this->flags = $flags; | |
645 | } else { | |
646 | $this->flags = array($flags); | |
647 | } | |
648 | $this->soundex = $soundex; | |
649 | $this->exact = $exact; | |
5600b2fe | 650 | $this->general_type = $general_type; |
cd0c2ac4 FB |
651 | } |
652 | ||
653 | public function buildCondition(PlFilter $uf) | |
654 | { | |
655 | $conds = array(); | |
656 | foreach ($this->tokens as $i => $token) { | |
657 | $sub = $uf->addNameTokensFilter($token); | |
658 | if ($this->soundex) { | |
659 | $c = XDB::format($sub . '.soundex = {?}', soundex_fr($token)); | |
660 | } else if ($this->exact) { | |
661 | $c = XDB::format($sub . '.token = {?}', $token); | |
662 | } else { | |
663 | $c = $sub . '.token ' . XDB::formatWildcards(XDB::WILDCARD_PREFIX, $token); | |
664 | } | |
665 | if ($this->flags != null) { | |
666 | $c .= XDB::format(' AND ' . $sub . '.flags IN {?}', $this->flags); | |
667 | } | |
5600b2fe SJ |
668 | if ($this->general_type) { |
669 | $c .= XDB::format(' AND ' . $sub . '.general_type = {?}', $this->general_type); | |
670 | } | |
22771578 | 671 | $c .= ' AND (' . $uf->getVisibilityConditionAbsolute(Visibility::EXPORT_PRIVATE) . ' OR ' . $sub . '.general_type != \'nickname\')'; |
cd0c2ac4 FB |
672 | $conds[] = $c; |
673 | } | |
674 | ||
675 | return implode(' AND ', $conds); | |
676 | } | |
677 | } | |
678 | // }}} | |
cd0c2ac4 FB |
679 | // {{{ class UFC_Nationality |
680 | class UFC_Nationality extends UserFilterCondition | |
681 | { | |
682 | private $val; | |
683 | ||
684 | public function __construct() | |
685 | { | |
686 | $this->val = pl_flatten(func_get_args()); | |
687 | } | |
688 | ||
689 | public function buildCondition(PlFilter $uf) | |
690 | { | |
691 | $uf->requireProfiles(); | |
692 | $nat = XDB::formatArray($this->val); | |
693 | $conds = array( | |
694 | 'p.nationality1 IN ' . $nat, | |
695 | 'p.nationality2 IN ' . $nat, | |
696 | 'p.nationality3 IN ' . $nat, | |
697 | ); | |
698 | return implode(' OR ', $conds); | |
699 | } | |
700 | } | |
701 | // }}} | |
cd0c2ac4 FB |
702 | // {{{ class UFC_Dead |
703 | /** Filters users based on death date | |
704 | * @param $comparison Comparison operator | |
705 | * @param $date Date to which death date should be compared (DateTime object, string or timestamp) | |
706 | */ | |
707 | class UFC_Dead extends UserFilterCondition | |
708 | { | |
709 | private $comparison; | |
710 | private $date; | |
711 | ||
712 | public function __construct($comparison = null, $date = null) | |
713 | { | |
714 | $this->comparison = $comparison; | |
715 | $this->date = make_datetime($date); | |
716 | } | |
717 | ||
718 | public function buildCondition(PlFilter $uf) | |
719 | { | |
720 | $uf->requireProfiles(); | |
721 | $str = 'p.deathdate IS NOT NULL'; | |
722 | if (!is_null($this->comparison)) { | |
723 | $str .= ' AND p.deathdate ' . $this->comparison . ' ' . XDB::format('{?}', $this->date->format('Y-m-d')); | |
724 | } | |
725 | return $str; | |
726 | } | |
727 | } | |
728 | // }}} | |
cd0c2ac4 FB |
729 | // {{{ class UFC_Registered |
730 | /** Filters users based on registration state | |
731 | * @param $active Whether we want to use only "active" users (i.e with a valid redirection) | |
732 | * @param $comparison Comparison operator | |
733 | * @param $date Date to which users registration date should be compared | |
734 | */ | |
735 | class UFC_Registered extends UserFilterCondition | |
736 | { | |
737 | private $active; | |
738 | private $comparison; | |
739 | private $date; | |
740 | ||
741 | public function __construct($active = false, $comparison = null, $date = null) | |
742 | { | |
743 | $this->active = $active; | |
744 | $this->comparison = $comparison; | |
745 | $this->date = make_datetime($date); | |
746 | } | |
747 | ||
748 | public function buildCondition(PlFilter $uf) | |
749 | { | |
750 | $uf->requireAccounts(); | |
751 | if ($this->active) { | |
752 | $date = '$UID IS NOT NULL AND a.state = \'active\''; | |
753 | } else { | |
754 | $date = '$UID IS NOT NULL AND a.state != \'pending\''; | |
755 | } | |
756 | if (!is_null($this->comparison)) { | |
757 | $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')); | |
758 | } | |
759 | return $date; | |
760 | } | |
761 | } | |
762 | // }}} | |
cd0c2ac4 FB |
763 | // {{{ class UFC_ProfileUpdated |
764 | /** Filters users based on profile update date | |
765 | * @param $comparison Comparison operator | |
766 | * @param $date Date to which profile update date must be compared | |
767 | */ | |
768 | class UFC_ProfileUpdated extends UserFilterCondition | |
769 | { | |
770 | private $comparison; | |
771 | private $date; | |
772 | ||
773 | public function __construct($comparison = null, $date = null) | |
774 | { | |
775 | $this->comparison = $comparison; | |
776 | $this->date = $date; | |
777 | } | |
778 | ||
779 | public function buildCondition(PlFilter $uf) | |
780 | { | |
781 | $uf->requireProfiles(); | |
782 | return 'p.last_change ' . $this->comparison . XDB::format(' {?}', date('Y-m-d H:i:s', $this->date)); | |
783 | } | |
784 | } | |
785 | // }}} | |
cd0c2ac4 FB |
786 | // {{{ class UFC_Birthday |
787 | /** Filters users based on next birthday date | |
788 | * @param $comparison Comparison operator | |
789 | * @param $date Date to which users next birthday date should be compared | |
790 | */ | |
791 | class UFC_Birthday extends UserFilterCondition | |
792 | { | |
793 | private $comparison; | |
794 | private $date; | |
795 | ||
796 | public function __construct($comparison = null, $date = null) | |
797 | { | |
798 | $this->comparison = $comparison; | |
799 | $this->date = $date; | |
800 | } | |
801 | ||
802 | public function buildCondition(PlFilter $uf) | |
803 | { | |
804 | $uf->requireProfiles(); | |
805 | return 'p.next_birthday ' . $this->comparison . XDB::format(' {?}', date('Y-m-d', $this->date)); | |
806 | } | |
807 | } | |
808 | // }}} | |
cd0c2ac4 FB |
809 | // {{{ class UFC_Sex |
810 | /** Filters users based on sex | |
811 | * @parm $sex One of User::GENDER_MALE or User::GENDER_FEMALE, for selecting users | |
812 | */ | |
813 | class UFC_Sex extends UserFilterCondition | |
814 | { | |
815 | private $sex; | |
816 | public function __construct($sex) | |
817 | { | |
818 | $this->sex = $sex; | |
819 | } | |
820 | ||
821 | public function buildCondition(PlFilter $uf) | |
822 | { | |
823 | if ($this->sex != User::GENDER_MALE && $this->sex != User::GENDER_FEMALE) { | |
824 | return self::COND_FALSE; | |
825 | } else { | |
826 | $uf->requireProfiles(); | |
827 | return XDB::format('p.sex = {?}', $this->sex == User::GENDER_FEMALE ? 'female' : 'male'); | |
828 | } | |
829 | } | |
830 | } | |
831 | // }}} | |
57a4162e RB |
832 | // {{{ class UFC_NLSubscribed |
833 | /** Filters users based on NL subscription | |
834 | * @param $nlid NL whose subscribers we are selecting | |
835 | * @param $issue Select only subscribers who have not yet received that issue | |
836 | */ | |
837 | class UFC_NLSubscribed extends UserFilterCondition | |
838 | { | |
839 | private $nlid; | |
840 | private $issue_id; | |
841 | public function __construct($nlid, $issue_id) | |
842 | { | |
843 | $this->nlid = $nlid; | |
844 | $this->issue_id = $issue_id; | |
845 | } | |
846 | ||
847 | public function buildCondition(PlFilter $uf) | |
848 | { | |
849 | $sub = $uf->addNewsLetterFilter($this->nlid); | |
99d74704 | 850 | return XDB::format($sub . '.nlid IS NOT NULL AND ( ' . $sub . '.last IS NULL OR ' . $sub . '.last < {?})', $this->issue_id); |
57a4162e RB |
851 | } |
852 | } | |
853 | // }}} | |
cd0c2ac4 FB |
854 | // {{{ class UFC_Group |
855 | /** Filters users based on group membership | |
856 | * @param $group Group whose members we are selecting | |
857 | * @param $anim Whether to restrict selection to animators of that group | |
858 | */ | |
859 | class UFC_Group extends UserFilterCondition | |
860 | { | |
861 | private $group; | |
862 | private $anim; | |
863 | public function __construct($group, $anim = false) | |
864 | { | |
865 | $this->group = $group; | |
866 | $this->anim = $anim; | |
867 | } | |
868 | ||
869 | public function buildCondition(PlFilter $uf) | |
870 | { | |
2e982801 SJ |
871 | // Groups are only visible for users with perm 'groups'. |
872 | if (!S::user()->checkPerms(User::PERM_GROUPS)) { | |
873 | return self::COND_FALSE; | |
cd0c2ac4 FB |
874 | } |
875 | $sub = $uf->addGroupFilter($this->group); | |
876 | $where = 'gpm' . $sub . '.perms IS NOT NULL'; | |
877 | if ($this->anim) { | |
878 | $where .= ' AND gpm' . $sub . '.perms = \'admin\''; | |
879 | } | |
880 | return $where; | |
881 | } | |
882 | } | |
883 | // }}} | |
486bc076 SJ |
884 | // {{{ class UFC_GroupFormerMember |
885 | /** Filters users based on group former membership | |
886 | * @param $group Group whose former members we are selecting | |
887 | */ | |
888 | class UFC_GroupFormerMember extends UserFilterCondition | |
889 | { | |
890 | private $group; | |
891 | ||
892 | public function __construct($group) | |
893 | { | |
894 | $this->group = $group; | |
895 | } | |
896 | ||
897 | public function buildCondition(PlFilter $uf) | |
898 | { | |
899 | // Groups are only visible for users with perm 'groups'. | |
900 | if (!S::user()->checkPerms(User::PERM_GROUPS)) { | |
901 | return self::COND_FALSE; | |
902 | } | |
903 | $sub = $uf->addGroupFormerMemberFilter(); | |
904 | return XDB::format('gpfm' . $sub . '.asso_id = {?}', $this->group); | |
905 | } | |
906 | } | |
907 | // }}} | |
cd0c2ac4 FB |
908 | // {{{ class UFC_Binet |
909 | /** Selects users based on their belonging to a given (list of) binet | |
910 | * @param $binet either a binet_id or an array of binet_ids | |
911 | */ | |
912 | class UFC_Binet extends UserFilterCondition | |
913 | { | |
914 | private $val; | |
915 | ||
916 | public function __construct() | |
917 | { | |
918 | $this->val = pl_flatten(func_get_args()); | |
919 | } | |
920 | ||
921 | public function buildCondition(PlFilter $uf) | |
922 | { | |
cd0c2ac4 | 923 | $sub = $uf->addBinetsFilter(); |
22771578 RB |
924 | // Binets are private. |
925 | return XDB::format($uf->getVisibilityConditionAbsolute(Visibility::EXPORT_PRIVATE) . ' AND ' . $sub . '.binet_id IN {?}', $this->val); | |
cd0c2ac4 FB |
926 | } |
927 | } | |
928 | // }}} | |
cd0c2ac4 FB |
929 | // {{{ class UFC_Section |
930 | /** Selects users based on section | |
931 | * @param $section ID of the section | |
932 | */ | |
933 | class UFC_Section extends UserFilterCondition | |
934 | { | |
935 | private $section; | |
936 | ||
937 | public function __construct() | |
938 | { | |
939 | $this->section = pl_flatten(func_get_args()); | |
940 | } | |
941 | ||
942 | public function buildCondition(PlFilter $uf) | |
943 | { | |
944 | // Sections are private. | |
cd0c2ac4 | 945 | $uf->requireProfiles(); |
22771578 | 946 | return XDB::format($uf->getVisibilityConditionAbsolute(Visibility::EXPORT_PRIVATE) . ' AND p.section IN {?}', $this->section); |
cd0c2ac4 FB |
947 | } |
948 | } | |
949 | // }}} | |
cd0c2ac4 FB |
950 | // {{{ class UFC_Email |
951 | /** Filters users based on an email or a list of emails | |
952 | * @param $emails List of emails whose owner must be selected | |
953 | */ | |
954 | class UFC_Email extends UserFilterCondition | |
955 | { | |
956 | private $emails; | |
957 | public function __construct() | |
958 | { | |
959 | $this->emails = pl_flatten(func_get_args()); | |
960 | } | |
961 | ||
962 | public function buildCondition(PlFilter $uf) | |
963 | { | |
964 | $foreign = array(); | |
e338c7e8 SJ |
965 | $local = array(); |
966 | $cond = array(); | |
cd0c2ac4 FB |
967 | |
968 | if (count($this->emails) == 0) { | |
969 | return PlFilterCondition::COND_TRUE; | |
970 | } | |
971 | ||
972 | foreach ($this->emails as $entry) { | |
973 | if (User::isForeignEmailAddress($entry)) { | |
974 | $foreign[] = $entry; | |
cd0c2ac4 | 975 | } else { |
e338c7e8 SJ |
976 | list($local_part, ) = explode('@', $entry); |
977 | $local[] = $local_part; | |
cd0c2ac4 FB |
978 | } |
979 | } | |
980 | ||
981 | if (count($foreign) > 0) { | |
982 | $sub = $uf->addEmailRedirectFilter($foreign); | |
63bd7d2f | 983 | $cond[] = XDB::format('ra' . $sub . '.redirect IS NOT NULL OR ra' . $sub . '.redirect IN {?} OR a.email IN {?}', $foreign, $foreign); |
cd0c2ac4 | 984 | } |
e338c7e8 SJ |
985 | if (count($local) > 0) { |
986 | $sub = $uf->addAliasFilter($local); | |
987 | $cond[] = 'sa' . $sub . '.email IS NOT NULL'; | |
cd0c2ac4 FB |
988 | } |
989 | return '(' . implode(') OR (', $cond) . ')'; | |
990 | } | |
991 | } | |
992 | // }}} | |
cd0c2ac4 FB |
993 | // {{{ class UFC_Address |
994 | abstract class UFC_Address extends UserFilterCondition | |
995 | { | |
3a2985f9 | 996 | /** Valid address type |
cd0c2ac4 | 997 | */ |
3a2985f9 SJ |
998 | const TYPE_HOME = 1; |
999 | const TYPE_PRO = 2; | |
1000 | const TYPE_NON_HQ = 3; | |
1001 | const TYPE_HQ = 4; | |
1002 | const TYPE_ANY = 7; | |
cd0c2ac4 FB |
1003 | |
1004 | /** Text for these types | |
1005 | */ | |
1006 | protected static $typetexts = array( | |
1007 | self::TYPE_HOME => 'home', | |
1008 | self::TYPE_PRO => 'pro', | |
3a2985f9 | 1009 | self::TYPE_HQ => 'hq', |
cd0c2ac4 FB |
1010 | ); |
1011 | ||
1012 | protected $type; | |
1013 | ||
1014 | /** Flags for addresses | |
1015 | */ | |
1016 | const FLAG_CURRENT = 0x0001; | |
1017 | const FLAG_TEMP = 0x0002; | |
1018 | const FLAG_SECOND = 0x0004; | |
1019 | const FLAG_MAIL = 0x0008; | |
1020 | const FLAG_CEDEX = 0x0010; | |
1021 | ||
1022 | // Binary OR of those flags | |
1023 | const FLAG_ANY = 0x001F; | |
1024 | ||
1025 | /** Text of these flags | |
1026 | */ | |
1027 | protected static $flagtexts = array( | |
1028 | self::FLAG_CURRENT => 'current', | |
1029 | self::FLAG_TEMP => 'temporary', | |
1030 | self::FLAG_SECOND => 'secondary', | |
1031 | self::FLAG_MAIL => 'mail', | |
1032 | self::FLAG_CEDEX => 'cedex', | |
1033 | ); | |
1034 | ||
1035 | protected $flags; | |
1036 | ||
1037 | public function __construct($type = null, $flags = null) | |
1038 | { | |
1039 | $this->type = $type; | |
1040 | $this->flags = $flags; | |
1041 | } | |
1042 | ||
1043 | protected function initConds($sub, $vis_cond) | |
1044 | { | |
1045 | $conds = array($vis_cond); | |
1046 | ||
1047 | $types = array(); | |
1048 | foreach (self::$typetexts as $flag => $type) { | |
1049 | if ($flag & $this->type) { | |
1050 | $types[] = $type; | |
1051 | } | |
1052 | } | |
1053 | if (count($types)) { | |
3a2985f9 | 1054 | $conds[] = XDB::format('pa' . $sub . '.type IN {?}', $types); |
cd0c2ac4 FB |
1055 | } |
1056 | ||
1057 | if ($this->flags != self::FLAG_ANY) { | |
1058 | foreach(self::$flagtexts as $flag => $text) { | |
1059 | if ($flag & $this->flags) { | |
3a2985f9 | 1060 | $conds[] = 'FIND_IN_SET(' . XDB::format('{?}', $text) . ', pa' . $sub . '.flags)'; |
cd0c2ac4 FB |
1061 | } |
1062 | } | |
1063 | } | |
1064 | return $conds; | |
1065 | } | |
1066 | ||
1067 | } | |
1068 | // }}} | |
cd0c2ac4 FB |
1069 | // {{{ class UFC_AddressField |
1070 | /** Filters users based on their address, | |
1071 | * @param $val Either a code for one of the fields, or an array of such codes | |
1072 | * @param $fieldtype The type of field to look for | |
1073 | * @param $type Filter on address type | |
1074 | * @param $flags Filter on address flags | |
1075 | */ | |
3a2985f9 | 1076 | class UFC_AddressComponent extends UFC_Address |
cd0c2ac4 | 1077 | { |
e76e94fb | 1078 | static $components = array('postal_code', 'locality', 'administrative_area_level_3', 'administrative_area_level_2', 'administrative_area_level_1', 'country'); |
cd0c2ac4 FB |
1079 | |
1080 | /** Data of the filter | |
1081 | */ | |
1082 | private $val; | |
1083 | private $fieldtype; | |
3a2985f9 | 1084 | private $exact; |
cd0c2ac4 | 1085 | |
3a2985f9 | 1086 | public function __construct($val, $fieldtype, $exact = true, $type = null, $flags = self::FLAG_ANY) |
cd0c2ac4 | 1087 | { |
3a2985f9 SJ |
1088 | if (!in_array($fieldtype, self::$components)) { |
1089 | Platal::page()->killError('Invalid address field type: ' . $this->fieldtype); | |
1090 | } | |
cd0c2ac4 | 1091 | |
3a2985f9 | 1092 | parent::__construct($type, $flags); |
cd0c2ac4 FB |
1093 | if (!is_array($val)) { |
1094 | $val = array($val); | |
1095 | } | |
1096 | $this->val = $val; | |
1097 | $this->fieldtype = $fieldtype; | |
3a2985f9 | 1098 | $this->exact = $exact; |
cd0c2ac4 FB |
1099 | } |
1100 | ||
1101 | public function buildCondition(PlFilter $uf) | |
1102 | { | |
3a2985f9 | 1103 | $sub = $uf->addAddressFilter($this->fieldtype); |
22771578 | 1104 | $conds = $this->initConds($sub, $uf->getVisibilityConditionForField('pa' . $sub . '.pub')); |
a67a14b4 | 1105 | $conds[] = XDB::format('pace' . $sub . '.id IN {?}', $this->val); |
cd0c2ac4 FB |
1106 | |
1107 | return implode(' AND ', $conds); | |
1108 | } | |
1109 | } | |
1110 | // }}} | |
cd0c2ac4 FB |
1111 | // {{{ class UFC_Corps |
1112 | /** Filters users based on the corps they belong to | |
1113 | * @param $corps Corps we are looking for (abbreviation) | |
1114 | * @param $type Whether we search for original or current corps | |
1115 | */ | |
1116 | class UFC_Corps extends UserFilterCondition | |
1117 | { | |
1118 | const CURRENT = 1; | |
1119 | const ORIGIN = 2; | |
1120 | ||
1121 | private $corps; | |
00f25ab1 | 1122 | private $id; |
cd0c2ac4 FB |
1123 | private $type; |
1124 | ||
00f25ab1 | 1125 | public function __construct($corps, $id = null, $type = self::CURRENT) |
cd0c2ac4 FB |
1126 | { |
1127 | $this->corps = $corps; | |
00f25ab1 | 1128 | $this->id = $id; |
cd0c2ac4 FB |
1129 | $this->type = $type; |
1130 | } | |
1131 | ||
1132 | public function buildCondition(PlFilter $uf) | |
1133 | { | |
1134 | /** Tables shortcuts: | |
1135 | * pc for profile_corps, | |
1136 | * pceo for profile_corps_enum - orginal | |
1137 | * pcec for profile_corps_enum - current | |
1138 | */ | |
1139 | $sub = $uf->addCorpsFilter($this->type); | |
00f25ab1 SJ |
1140 | if (is_null($this->id)) { |
1141 | $cond = $sub . '.abbreviation = ' . $this->corps; | |
1142 | } else { | |
1143 | $cond = $sub . '.id = ' . $this->id; | |
1144 | } | |
1145 | // XXX(x2006barrois): find a way to get rid of that hardcoded | |
1146 | // reference to 'pc'. | |
22771578 | 1147 | $cond .= ' AND ' . $uf->getVisibilityConditionForField('pc.corps_pub'); |
cd0c2ac4 FB |
1148 | return $cond; |
1149 | } | |
1150 | } | |
1151 | // }}} | |
cd0c2ac4 FB |
1152 | // {{{ class UFC_Corps_Rank |
1153 | /** Filters users based on their rank in the corps | |
1154 | * @param $rank Rank we are looking for (abbreviation) | |
1155 | */ | |
1156 | class UFC_Corps_Rank extends UserFilterCondition | |
1157 | { | |
1158 | private $rank; | |
00f25ab1 SJ |
1159 | private $id; |
1160 | ||
1161 | public function __construct($rank, $id = null) | |
cd0c2ac4 FB |
1162 | { |
1163 | $this->rank = $rank; | |
00f25ab1 | 1164 | $this->id = $id; |
cd0c2ac4 FB |
1165 | } |
1166 | ||
1167 | public function buildCondition(PlFilter $uf) | |
1168 | { | |
1169 | /** Tables shortcuts: | |
1170 | * pc for profile_corps | |
1171 | * pcr for profile_corps_rank | |
1172 | */ | |
1173 | $sub = $uf->addCorpsRankFilter(); | |
00f25ab1 SJ |
1174 | if (is_null($this->id)) { |
1175 | $cond = $sub . '.abbreviation = ' . $this->rank; | |
1176 | } else { | |
1177 | $cond = $sub . '.id = ' . $this->id; | |
1178 | } | |
cd0c2ac4 FB |
1179 | // XXX(x2006barrois): find a way to get rid of that hardcoded |
1180 | // reference to 'pc'. | |
22771578 | 1181 | $cond .= ' AND ' . $uf->getVisibilityConditionForField('pc.corps_pub'); |
cd0c2ac4 FB |
1182 | return $cond; |
1183 | } | |
1184 | } | |
1185 | // }}} | |
cd0c2ac4 FB |
1186 | // {{{ class UFC_Job_Company |
1187 | /** Filters users based on the company they belong to | |
1188 | * @param $type The field being searched (self::JOBID, self::JOBNAME or self::JOBACRONYM) | |
1189 | * @param $value The searched value | |
1190 | */ | |
1191 | class UFC_Job_Company extends UserFilterCondition | |
1192 | { | |
1193 | const JOBID = 'id'; | |
1194 | const JOBNAME = 'name'; | |
1195 | const JOBACRONYM = 'acronym'; | |
1196 | ||
1197 | private $type; | |
1198 | private $value; | |
1199 | ||
1200 | public function __construct($type, $value) | |
1201 | { | |
1202 | $this->assertType($type); | |
1203 | $this->type = $type; | |
1204 | $this->value = $value; | |
1205 | } | |
1206 | ||
1207 | private function assertType($type) | |
1208 | { | |
1209 | if ($type != self::JOBID && $type != self::JOBNAME && $type != self::JOBACRONYM) { | |
1210 | Platal::page()->killError("Type de recherche non valide."); | |
1211 | } | |
1212 | } | |
1213 | ||
1214 | public function buildCondition(PlFilter $uf) | |
1215 | { | |
1216 | $sub = $uf->addJobCompanyFilter(); | |
1217 | $cond = $sub . '.' . $this->type . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->value); | |
1218 | $jsub = $uf->addJobFilter(); | |
22771578 | 1219 | $cond .= ' AND ' . $uf->getVisibilityConditionForField($jsub . '.pub'); |
cd0c2ac4 FB |
1220 | return $cond; |
1221 | } | |
1222 | } | |
1223 | // }}} | |
cd0c2ac4 FB |
1224 | // {{{ class UFC_Job_Terms |
1225 | /** Filters users based on the job terms they assigned to one of their | |
1226 | * jobs. | |
1227 | * @param $val The ID of the job term, or an array of such IDs | |
1228 | */ | |
1229 | class UFC_Job_Terms extends UserFilterCondition | |
1230 | { | |
1231 | private $val; | |
1232 | ||
1233 | public function __construct($val) | |
1234 | { | |
1235 | if (!is_array($val)) { | |
1236 | $val = array($val); | |
1237 | } | |
1238 | $this->val = $val; | |
1239 | } | |
1240 | ||
1241 | public function buildCondition(PlFilter $uf) | |
1242 | { | |
1243 | $sub = $uf->addJobTermsFilter(count($this->val)); | |
1244 | $conditions = array(); | |
1245 | foreach ($this->val as $i => $jtid) { | |
1246 | $conditions[] = $sub[$i] . '.jtid_1 = ' . XDB::escape($jtid); | |
1247 | } | |
1248 | $jsub = $uf->addJobFilter(); | |
22771578 | 1249 | $conditions[] = $uf->getVisibilityConditionForField($jsub . '.pub'); |
cd0c2ac4 FB |
1250 | return implode(' AND ', $conditions); |
1251 | } | |
1252 | } | |
1253 | // }}} | |
cd0c2ac4 FB |
1254 | // {{{ class UFC_Job_Description |
1255 | /** Filters users based on their job description | |
1256 | * @param $description The text being searched for | |
1257 | * @param $fields The fields to search for (CV, user-defined) | |
1258 | */ | |
1259 | class UFC_Job_Description extends UserFilterCondition | |
1260 | { | |
1261 | ||
1262 | private $description; | |
1263 | private $fields; | |
1264 | ||
1265 | public function __construct($description, $fields) | |
1266 | { | |
1267 | $this->fields = $fields; | |
1268 | $this->description = $description; | |
1269 | } | |
1270 | ||
1271 | public function buildCondition(PlFilter $uf) | |
1272 | { | |
1273 | $conds = array(); | |
1274 | ||
1275 | $jsub = $uf->addJobFilter(); | |
cd0c2ac4 FB |
1276 | if ($this->fields & UserFilter::JOB_USERDEFINED) { |
1277 | $conds[] = $jsub . '.description ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->description); | |
1278 | } | |
22771578 | 1279 | if ($this->fields & UserFilter::JOB_CV) { |
cd0c2ac4 | 1280 | $uf->requireProfiles(); |
22771578 RB |
1281 | // CV is private |
1282 | $conds[] = '( ' . $uf->getVisibilityConditionAbsolute(Visibility::EXPORT_PRIVATE) . ' AND p.cv ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->description) . ')'; | |
cd0c2ac4 | 1283 | } |
f3bfd6c9 RB |
1284 | if (count($conds) == 0) { |
1285 | return self::COND_TRUE; | |
1286 | } | |
22771578 | 1287 | return $uf->getVisibilityConditionForField($jsub . '.pub') . ' AND ( ' . implode(' OR ', $conds) . ' )'; |
cd0c2ac4 FB |
1288 | } |
1289 | } | |
1290 | // }}} | |
cd0c2ac4 FB |
1291 | // {{{ class UFC_Networking |
1292 | /** Filters users based on network identity (IRC, ...) | |
1293 | * @param $type Type of network (-1 for any) | |
1294 | * @param $value Value to search | |
1295 | */ | |
1296 | class UFC_Networking extends UserFilterCondition | |
1297 | { | |
1298 | private $type; | |
1299 | private $value; | |
1300 | ||
1301 | public function __construct($type, $value) | |
1302 | { | |
1303 | $this->type = $type; | |
1304 | $this->value = $value; | |
1305 | } | |
1306 | ||
1307 | public function buildCondition(PlFilter $uf) | |
1308 | { | |
1309 | $sub = $uf->addNetworkingFilter(); | |
1310 | $conds = array(); | |
22771578 | 1311 | $conds[] = $uf->getVisibilityConditionForField($sub . '.pub'); |
cd0c2ac4 FB |
1312 | $conds[] = $sub . '.address ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->value); |
1313 | if ($this->type != -1) { | |
1314 | $conds[] = $sub . '.nwid = ' . XDB::format('{?}', $this->type); | |
1315 | } | |
1316 | return implode(' AND ', $conds); | |
1317 | } | |
1318 | } | |
1319 | // }}} | |
cd0c2ac4 FB |
1320 | // {{{ class UFC_Phone |
1321 | /** Filters users based on their phone number | |
1322 | * @param $num_type Type of number (pro/user/home) | |
1323 | * @param $phone_type Type of phone (fixed/mobile/fax) | |
1324 | * @param $number Phone number | |
1325 | */ | |
1326 | class UFC_Phone extends UserFilterCondition | |
1327 | { | |
1328 | const NUM_PRO = 'pro'; | |
1329 | const NUM_USER = 'user'; | |
1330 | const NUM_HOME = 'address'; | |
1331 | const NUM_ANY = 'any'; | |
1332 | ||
1333 | const PHONE_FIXED = 'fixed'; | |
1334 | const PHONE_MOBILE = 'mobile'; | |
1335 | const PHONE_FAX = 'fax'; | |
1336 | const PHONE_ANY = 'any'; | |
1337 | ||
1338 | private $num_type; | |
1339 | private $phone_type; | |
1340 | private $number; | |
1341 | ||
1342 | public function __construct($number, $num_type = self::NUM_ANY, $phone_type = self::PHONE_ANY) | |
1343 | { | |
1344 | $phone = new Phone(array('display' => $number)); | |
1345 | $phone->format(); | |
14f9a5c3 | 1346 | $this->number = $phone->search; |
cd0c2ac4 FB |
1347 | $this->num_type = $num_type; |
1348 | $this->phone_type = $phone_type; | |
1349 | } | |
1350 | ||
1351 | public function buildCondition(PlFilter $uf) | |
1352 | { | |
1353 | $sub = $uf->addPhoneFilter(); | |
1354 | $conds = array(); | |
1355 | ||
22771578 | 1356 | $conds[] = $uf->getVisibilityConditionForField($sub . '.pub'); |
cd0c2ac4 FB |
1357 | |
1358 | $conds[] = $sub . '.search_tel = ' . XDB::format('{?}', $this->number); | |
1359 | if ($this->num_type != self::NUM_ANY) { | |
1360 | $conds[] = $sub . '.link_type = ' . XDB::format('{?}', $this->num_type); | |
1361 | } | |
1362 | if ($this->phone_type != self::PHONE_ANY) { | |
1363 | $conds[] = $sub . '.tel_type = ' . XDB::format('{?}', $this->phone_type); | |
1364 | } | |
1365 | return implode(' AND ', $conds); | |
1366 | } | |
1367 | } | |
1368 | // }}} | |
cd0c2ac4 FB |
1369 | // {{{ class UFC_Medal |
1370 | /** Filters users based on their medals | |
1371 | * @param $medal ID of the medal | |
1372 | * @param $grade Grade of the medal (null for 'any') | |
1373 | */ | |
1374 | class UFC_Medal extends UserFilterCondition | |
1375 | { | |
1376 | private $medal; | |
1377 | private $grade; | |
1378 | ||
1379 | public function __construct($medal, $grade = null) | |
1380 | { | |
1381 | $this->medal = $medal; | |
1382 | $this->grade = $grade; | |
1383 | } | |
1384 | ||
1385 | public function buildCondition(PlFilter $uf) | |
1386 | { | |
1387 | $conds = array(); | |
1388 | ||
1389 | // This will require profiles => table 'p' will be available. | |
1390 | $sub = $uf->addMedalFilter(); | |
1391 | ||
22771578 | 1392 | $conds[] = $uf->getVisibilityConditionForField('p.medals_pub'); |
cd0c2ac4 FB |
1393 | |
1394 | $conds[] = $sub . '.mid = ' . XDB::format('{?}', $this->medal); | |
1395 | if ($this->grade != null) { | |
1396 | $conds[] = $sub . '.gid = ' . XDB::format('{?}', $this->grade); | |
1397 | } | |
1398 | return implode(' AND ', $conds); | |
1399 | } | |
1400 | } | |
1401 | // }}} | |
cd0c2ac4 FB |
1402 | // {{{ class UFC_Photo |
1403 | /** Filters profiles with photo | |
1404 | */ | |
1405 | class UFC_Photo extends UserFilterCondition | |
1406 | { | |
1407 | public function buildCondition(PlFilter $uf) | |
1408 | { | |
1409 | $sub = $uf->addPhotoFilter(); | |
22771578 | 1410 | return $sub . '.attach IS NOT NULL AND ' . $uf->getVisibilityConditionForField($sub . '.pub'); |
cd0c2ac4 FB |
1411 | } |
1412 | } | |
1413 | // }}} | |
cd0c2ac4 FB |
1414 | // {{{ class UFC_Mentor |
1415 | class UFC_Mentor extends UserFilterCondition | |
1416 | { | |
1417 | public function buildCondition(PlFilter $uf) | |
1418 | { | |
1419 | $sub = $uf->addMentorFilter(UserFilter::MENTOR); | |
1420 | return $sub . '.expertise IS NOT NULL'; | |
1421 | } | |
1422 | } | |
1423 | // }}} | |
cd0c2ac4 FB |
1424 | // {{{ class UFC_Mentor_Expertise |
1425 | /** Filters users by mentoring expertise | |
1426 | * @param $expertise Domain of expertise | |
1427 | */ | |
1428 | class UFC_Mentor_Expertise extends UserFilterCondition | |
1429 | { | |
1430 | private $expertise; | |
1431 | ||
1432 | public function __construct($expertise) | |
1433 | { | |
1434 | $this->expertise = $expertise; | |
1435 | } | |
1436 | ||
1437 | public function buildCondition(PlFilter $uf) | |
1438 | { | |
1439 | $sub = $uf->addMentorFilter(UserFilter::MENTOR_EXPERTISE); | |
1440 | return $sub . '.expertise ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->expertise); | |
1441 | } | |
1442 | } | |
1443 | // }}} | |
cd0c2ac4 FB |
1444 | // {{{ class UFC_Mentor_Country |
1445 | /** Filters users by mentoring country | |
1446 | * @param $country Two-letters code of country being searched | |
1447 | */ | |
1448 | class UFC_Mentor_Country extends UserFilterCondition | |
1449 | { | |
1450 | private $country; | |
1451 | ||
1452 | public function __construct() | |
1453 | { | |
1454 | $this->country = pl_flatten(func_get_args()); | |
1455 | } | |
1456 | ||
1457 | public function buildCondition(PlFilter $uf) | |
1458 | { | |
1459 | $sub = $uf->addMentorFilter(UserFilter::MENTOR_COUNTRY); | |
1460 | return $sub . '.country IN ' . XDB::format('{?}', $this->country); | |
1461 | } | |
1462 | } | |
1463 | // }}} | |
cd0c2ac4 FB |
1464 | // {{{ class UFC_Mentor_Terms |
1465 | /** Filters users based on the job terms they used in mentoring. | |
1466 | * @param $val The ID of the job term, or an array of such IDs | |
1467 | */ | |
1468 | class UFC_Mentor_Terms extends UserFilterCondition | |
1469 | { | |
1470 | private $val; | |
1471 | ||
1472 | public function __construct($val) | |
1473 | { | |
1474 | $this->val = $val; | |
1475 | } | |
1476 | ||
1477 | public function buildCondition(PlFilter $uf) | |
1478 | { | |
1479 | $sub = $uf->addMentorFilter(UserFilter::MENTOR_TERM); | |
1480 | return $sub . '.jtid_1 = ' . XDB::escape($this->val); | |
1481 | } | |
1482 | } | |
1483 | // }}} | |
cd0c2ac4 FB |
1484 | // {{{ class UFC_UserRelated |
1485 | /** Filters users based on a relation toward a user | |
1486 | * @param $user User to which searched users are related | |
1487 | */ | |
1488 | abstract class UFC_UserRelated extends UserFilterCondition | |
1489 | { | |
1490 | protected $user; | |
26ba053e | 1491 | public function __construct(PlUser $user) |
cd0c2ac4 FB |
1492 | { |
1493 | $this->user =& $user; | |
1494 | } | |
1495 | } | |
1496 | // }}} | |
49707d3b RB |
1497 | // {{{ class UFC_DeltaTen |
1498 | class UFC_DeltaTen extends UserFilterCondition | |
1499 | { | |
1500 | public function buildCondition(PlFilter $uf) | |
1501 | { | |
1502 | $sub = $uf->addDeltaTenFilter(UserFilter::DELTATEN); | |
1503 | return $sub . '.message IS NOT NULL'; | |
1504 | } | |
1505 | } | |
1506 | // }}} | |
1507 | // {{{ class UFC_DeltaTen_Message | |
1508 | /** Filters users by deltaten message | |
1509 | * @param $message Message for the DeltaTen program | |
1510 | */ | |
1511 | class UFC_DeltaTen_Message extends UserFilterCondition | |
1512 | { | |
1513 | private $message; | |
1514 | ||
1515 | public function __construct($message) | |
1516 | { | |
1517 | $this->message = $message; | |
1518 | } | |
1519 | ||
1520 | public function buildCondition(PlFilter $uf) | |
1521 | { | |
1522 | $sub = $uf->addDeltaTenFilter(UserFilter::DELTATEN_MESSAGE); | |
1523 | return $sub . '.message ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->message); | |
1524 | } | |
1525 | } | |
1526 | // }}} | |
cd0c2ac4 FB |
1527 | // {{{ class UFC_Contact |
1528 | /** Filters users who belong to selected user's contacts | |
1529 | */ | |
1530 | class UFC_Contact extends UFC_UserRelated | |
1531 | { | |
1532 | public function buildCondition(PlFilter $uf) | |
1533 | { | |
1534 | $sub = $uf->addContactFilter($this->user->id()); | |
1535 | return 'c' . $sub . '.contact IS NOT NULL'; | |
1536 | } | |
1537 | } | |
1538 | // }}} | |
cd0c2ac4 FB |
1539 | // {{{ class UFC_WatchRegistration |
1540 | /** Filters users being watched by selected user | |
1541 | */ | |
1542 | class UFC_WatchRegistration extends UFC_UserRelated | |
1543 | { | |
1544 | public function buildCondition(PlFilter $uf) | |
1545 | { | |
1546 | if (!$this->user->watchType('registration')) { | |
1547 | return PlFilterCondition::COND_FALSE; | |
1548 | } | |
1549 | $uids = $this->user->watchUsers(); | |
1550 | if (count($uids) == 0) { | |
1551 | return PlFilterCondition::COND_FALSE; | |
1552 | } else { | |
1553 | return XDB::format('$UID IN {?}', $uids); | |
1554 | } | |
1555 | } | |
1556 | } | |
1557 | // }}} | |
cd0c2ac4 FB |
1558 | // {{{ class UFC_WatchPromo |
1559 | /** Filters users belonging to a promo watched by selected user | |
1560 | * @param $user Selected user (the one watching promo) | |
1561 | * @param $grade Formation the user is watching | |
1562 | */ | |
1563 | class UFC_WatchPromo extends UFC_UserRelated | |
1564 | { | |
1565 | private $grade; | |
26ba053e | 1566 | public function __construct(PlUser $user, $grade = UserFilter::GRADE_ING) |
cd0c2ac4 FB |
1567 | { |
1568 | parent::__construct($user); | |
1569 | $this->grade = $grade; | |
1570 | } | |
1571 | ||
1572 | public function buildCondition(PlFilter $uf) | |
1573 | { | |
1574 | $promos = $this->user->watchPromos(); | |
1575 | if (count($promos) == 0) { | |
1576 | return PlFilterCondition::COND_FALSE; | |
1577 | } else { | |
1578 | $sube = $uf->addEducationFilter(true, $this->grade); | |
1579 | $field = 'pe' . $sube . '.' . UserFilter::promoYear($this->grade); | |
1580 | return XDB::format($field . ' IN {?}', $promos); | |
1581 | } | |
1582 | } | |
1583 | } | |
1584 | // }}} | |
cd0c2ac4 FB |
1585 | // {{{ class UFC_WatchContact |
1586 | /** Filters users watched by selected user | |
1587 | */ | |
1588 | class UFC_WatchContact extends UFC_Contact | |
1589 | { | |
1590 | public function buildCondition(PlFilter $uf) | |
1591 | { | |
1592 | if (!$this->user->watchContacts()) { | |
1593 | return PlFilterCondition::COND_FALSE; | |
1594 | } | |
1595 | return parent::buildCondition($uf); | |
1596 | } | |
1597 | } | |
1598 | // }}} | |
cd0c2ac4 FB |
1599 | // {{{ class UFC_MarketingHash |
1600 | /** Filters users using the hash generated | |
1601 | * to send marketing emails to him. | |
1602 | */ | |
1603 | class UFC_MarketingHash extends UserFilterCondition | |
1604 | { | |
1605 | private $hash; | |
1606 | ||
1607 | public function __construct($hash) | |
1608 | { | |
1609 | $this->hash = $hash; | |
1610 | } | |
1611 | ||
1612 | public function buildCondition(PlFilter $uf) | |
1613 | { | |
1614 | $table = $uf->addMarketingHash(); | |
1615 | return XDB::format('rm.hash = {?}', $this->hash); | |
1616 | } | |
1617 | } | |
1618 | // }}} | |
148af7a9 RB |
1619 | // {{{ class UFC_PartnerSharing |
1620 | /** Filters users, keeping only those sharing data with a given partner. | |
1621 | */ | |
1622 | class UFC_PartnerSharing extends UserFilterCondition | |
1623 | { | |
1624 | const PTA = 'pta'; | |
1625 | ||
1626 | private $partner; | |
1627 | ||
1628 | public function __construct($partner) | |
1629 | { | |
1630 | $this->partner = $partner; | |
1631 | } | |
1632 | ||
1633 | public function buildCondition(PlFilter $uf) | |
1634 | { | |
1635 | $sub = $uf->addPartnerSharingFilter($this->partner); | |
1636 | return XDB::format("$sub.exposed_uid IS NOT NULL"); | |
1637 | } | |
1638 | } | |
1639 | // }}} | |
1640 | // {{{ class UFC_PartnerSharingEmail | |
1641 | /** Filters users, keeping only those allowing emails to be sent by | |
1642 | * a given partner. | |
1643 | */ | |
1644 | class UFC_PartnerSharingEmail extends UserFilterCondition | |
1645 | { | |
1646 | private $partner; | |
1647 | ||
1648 | public function __construct($partner) | |
1649 | { | |
1650 | $this->partner = $partner; | |
1651 | } | |
1652 | ||
1653 | public function buildCondition(PlFilter $uf) | |
1654 | { | |
1655 | $sub = $uf->addPartnerSharingFilter($this->partner); | |
1656 | return XDB::format("$sub.allow_email IN ('digest', 'direct')"); | |
1657 | } | |
1658 | } | |
1659 | // }}} | |
1660 | // {{{ class UFC_PartnerSharingID | |
1661 | /** Filters users according to a list of partner-known IDs | |
1662 | */ | |
1663 | class UFC_PartnerSharingID extends UserFilterCondition | |
1664 | { | |
1665 | private $partner; | |
1666 | private $ids; | |
1667 | ||
1668 | public function __construct($partner) | |
1669 | { | |
1670 | $this->partner = $partner; | |
1671 | $ids = func_get_args(); | |
1672 | array_shift($ids); | |
1673 | $this->ids = pl_flatten($ids); | |
1674 | } | |
1675 | ||
1676 | public function buildCondition(PlFilter $uf) | |
1677 | { | |
1678 | $uf->requireProfiles(); | |
1679 | $ids = $this->ids; | |
1680 | $sub = $uf->addPartnerSharingFilter($this->partner); | |
1681 | return XDB::format("$sub.exposed_uid IN {?}", $ids); | |
1682 | } | |
1683 | } | |
1684 | // }}} | |
cd0c2ac4 FB |
1685 | |
1686 | // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8: | |
1687 | ?> |