Adds search on firstname/lastname/nickname (Closes #1469).
[platal.git] / include / ufbuilder.inc.php
1 <?php
2 /***************************************************************************
3 * Copyright (C) 2003-2011 Polytechnique.org *
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 // {{{ class StoredUserFilterBuilder
23 class StoredUserFilterBuilder
24 {
25 // Possible stored types (currently only 'ufb' exists)
26 const TYPE_UFB = 'ufb';
27
28 protected $ufb;
29 protected $env;
30 protected $ufc;
31
32 public function __construct(UserFilterBuilder $ufb, PlFilterCondition $ufc = null, array $env = array())
33 {
34 $this->ufb = $ufb;
35 $this->ufc = $ufc;
36 $this->env = $env;
37 }
38
39 public function export()
40 {
41 $export = new PlDict();
42 $export->set('type', self::TYPE_UFB);
43 $export->set('condition', $this->ufc->export());
44 $export->set('env', $this->env);
45 return $export;
46 }
47
48 public function getEnv()
49 {
50 return $this->env;
51 }
52
53 public function fillFromExport($export)
54 {
55 $export = new PlDict($export);
56 if (!$export->has('type')) {
57 throw new Exception("Missing 'type' field in export.");
58 }
59 if ($export->s('type') != self::TYPE_UFB) {
60 throw new Exception("Unknown type '$type' in export.");
61 }
62 $this->ufc = UserFilterCondition::fromExport($export->v('condition'));
63 $this->env = $export->v('env', array());
64 }
65
66 public function updateFromEnv($env)
67 {
68 $this->ufb->setFakeEnv($env);
69 if ($this->ufb->isValid()) {
70 $this->env = $env;
71 $this->ufc = $this->ufb->getUFC();
72 return true;
73 } else {
74 $this->ufb->clearFakeEnv();
75 return false;
76 }
77 }
78
79 public function refresh()
80 {
81 if ($this->isValid()) {
82 $this->ufc = $this->ufb->getUFC();
83 }
84 }
85
86 public function getUFC()
87 {
88 return $this->ufc;
89 }
90
91 public function isValid()
92 {
93 $this->ufb->setFakeEnv($this->env);
94 return $this->ufb->isValid();
95 }
96
97 public function isEmpty()
98 {
99 $this->ufb->setFakeEnv($this->env);
100 return $this->ufb->isEmpty();
101 }
102 }
103 // }}}
104
105 // {{{ class UserFilterBuilder
106 class UserFilterBuilder
107 {
108 private $envprefix;
109 private $fields;
110 private $valid = true;
111 private $ufc = null;
112 private $orders = array();
113 private $fake_env = null;
114
115 /** Constructor
116 * @param $fields An array of UFB_Field objects
117 * @param $envprefix Prefix to use for parts of the query
118 */
119 public function __construct($fields, $envprefix = '')
120 {
121 $this->fields = $fields;
122 $this->envprefix = $envprefix;
123 }
124
125 public function setFakeEnv($env)
126 {
127 $this->fake_env = new PlDict($env);
128 }
129
130 public function clearFakeEnv()
131 {
132 $this->fake_env = null;
133 }
134
135 /** Builds the UFC; returns as soon as a field says it is invalid
136 */
137 private function buildUFC()
138 {
139 if ($this->ufc != null) {
140 return;
141 }
142 $this->ufc = new PFC_And();
143
144 foreach ($this->fields as $field) {
145 $this->valid = $field->apply($this);
146 if (!$this->valid) {
147 return;
148 }
149 }
150 }
151
152 public function addCond(PlFilterCondition $cond)
153 {
154 $this->ufc->addChild($cond);
155 }
156
157 public function addOrder(PlFilterOrder $order)
158 {
159 $this->order[] = $order;
160 }
161
162 public function isValid()
163 {
164 $this->buildUFC();
165 return $this->valid;
166 }
167
168 public function isEmpty()
169 {
170 $this->buildUFC();
171 foreach ($this->fields as $field) {
172 if (! $field->isEmpty()) {
173 return false;
174 }
175 }
176 return true;
177 }
178
179 /** Returns the built UFC
180 * @return The UFC, or PFC_False() if an error happened
181 */
182 public function getUFC()
183 {
184 $this->buildUFC();
185 if ($this->valid) {
186 if ($this->isEmpty()) {
187 return new PFC_True();
188 } else {
189 return $this->ufc;
190 }
191 } else {
192 return new PFC_False();
193 }
194 }
195
196 /** Returns adequate orders
197 */
198 public function getOrders()
199 {
200 $this->buildUFC();
201 return $this->orders;
202 }
203
204 public function getEnvFieldNames()
205 {
206 $fields = array();
207 foreach ($this->fields as $ufbf) {
208 $fields = array_merge($fields, $ufbf->getEnvFieldNames());
209 }
210 return array_unique($fields);
211 }
212
213 public function getEnv()
214 {
215 $values = array();
216 foreach ($this->getEnvFieldNames() as $field) {
217 if ($this->has($field)) {
218 $values[$field] = $this->v($field);
219 }
220 }
221 return $values;
222 }
223
224 public function setEnv($values)
225 {
226 foreach ($this->getEnvFieldNames() as $field) {
227 if (array_key_exists($field, $values)) {
228 Env::set($this->envprefix . $field, $values[$field]);
229 }
230 }
231 }
232
233 /** Wrappers around Env::i/s/..., to add envprefix
234 */
235 public function s($key, $def = '')
236 {
237 if ($this->fake_env) {
238 return $this->fake_env->s($key, $def);
239 } else {
240 return Env::s($this->envprefix . $key, $def);
241 }
242 }
243
244 public function t($key, $def = '')
245 {
246 if ($this->fake_env) {
247 return $this->fake_env->t($key, $def);
248 } else {
249 return Env::t($this->envprefix . $key, $def);
250 }
251 }
252
253 public function i($key, $def = 0)
254 {
255 if ($this->fake_env) {
256 return $this->fake_env->i($key, $def);
257 } else {
258 return Env::i($this->envprefix . $key, $def);
259 }
260 }
261
262 public function v($key, $def = null)
263 {
264 if ($this->fake_env) {
265 return $this->fake_env->v($key, $def);
266 } else {
267 return Env::v($this->envprefix . $key, $def);
268 }
269 }
270
271 public function b($key, $def = false)
272 {
273 if ($this->fake_env) {
274 return $this->fake_env->b($key, $def);
275 } else {
276 return Env::b($this->envprefix . $key, $def);
277 }
278 }
279
280 public function has($key)
281 {
282 if ($this->fake_env) {
283 return $this->fake_env->has($key);
284 } else {
285 return Env::has($this->envprefix . $key);
286 }
287 }
288
289 public function blank($key, $strict = false)
290 {
291 if ($this->fake_env) {
292 return $this->fake_env->blank($key, $strict);
293 } else {
294 return Env::blank($key, $strict);
295 }
296 }
297
298 public function hasAlnum($key)
299 {
300 $str = $this->s($key);
301 return preg_match('/[a-z0-9]/i', $str);
302 }
303
304 public function hasAlpha($key)
305 {
306 $str = $this->s($key);
307 return preg_match('/[a-z]/i', $str);
308 }
309
310 public function isOn($key)
311 {
312 return $this->has($key) && $this->t($key) == 'on';
313 }
314 }
315 // }}}
316
317 // {{{ class UFB_QuickSearch
318 class UFB_QuickSearch extends UserFilterBuilder
319 {
320 public function __construct($envprefix = '')
321 {
322 $fields = array(
323 new UFBF_Quick('quick', 'Recherche rapide'),
324 new UFBF_NotRegistered('nonins', 'Non inscrits'),
325 );
326 parent::__construct($fields, $envprefix);
327 }
328 }
329 // }}}
330
331 // {{{ class UFB_AdvancedSearch
332 class UFB_AdvancedSearch extends UserFilterBuilder
333 {
334 /** Create a UFB_AdvancedSearch.
335 * @param $include_admin Whether to include 'admin-only' fields
336 * @param $include_ax Whether to include 'ax-only' fields
337 * @param $envprefix Optional prefix for form field names.
338 */
339 public function __construct($include_admin = false, $include_ax = false, $envprefix = '')
340 {
341 $fields = array(
342 new UFBF_Name('name', 'Nom', 'name_type'),
343 new UFBF_Promo('promo1', 'Promotion', 'egal1', 'edu_type'),
344 new UFBF_Promo('promo2', 'Promotion', 'egal2', 'edu_type'),
345 new UFBF_Sex('woman', 'Sexe'),
346 new UFBF_Registered('subscriber', 'Inscrit'),
347 new UFBF_HasEmailRedirect('has_email_redirect', 'A une redirection active'),
348 new UFBF_Dead('alive', 'En vie'),
349
350 new UFBF_Town('city', 'Ville / Code Postal'),
351 new UFBF_Country('countryTxt', 'country', 'Pays'),
352 new UFBF_AdminArea('administrativearea', 'Région'),
353 new UFBF_SubAdminArea('subadministrativearea', 'Département'),
354
355 new UFBF_JobCompany('entreprise', 'Entreprise'),
356 new UFBF_JobDescription('jobdescription', 'Fonction'),
357 new UFBF_JobCv('cv', 'CV'),
358 new UFBF_JobTerms('jobterm', 'Mots-clefs'),
359
360 new UFBF_OriginCorps('origin_corps', 'Corps d\'origine'),
361 new UFBF_CurrentCorps('current_corps', 'Corps actuel'),
362 new UFBF_CorpsRank('corps_rank', 'Grade'),
363
364 new UFBF_Nationality('nationaliteTxt', 'nationalite', 'Nationalité'),
365 new UFBF_Binet('binetTxt', 'binet', 'Binet'),
366 new UFBF_Group('groupexTxt', 'groupex', 'Groupe X'),
367 new UFBF_Section('sectionTxt', 'section', 'Section'),
368
369 new UFBF_EducationSchool('schoolTxt', 'school', "École d'application"),
370 new UFBF_EducationDegree('diplomaTxt', 'diploma', 'Diplôme'),
371 new UFBF_EducationField('fieldTxt', 'field', "Domaine d'études"),
372
373 new UFBF_Comment('free', 'Commentaire'),
374 new UFBF_Phone('phone_number', 'Téléphone'),
375 new UFBF_Networking('networking_address', 'networking_type', 'Networking et sites webs'),
376
377 new UFBF_Mentor('only_referent', 'Référent'),
378 );
379
380 if ($include_admin || $include_ax) {
381 $fields[] = new UFBF_SchoolIds('schoolid_ax', 'Matricule AX', UFC_SchoolId::AX);
382 }
383
384 parent::__construct($fields, $envprefix);
385 }
386 }
387 // }}}
388
389 // {{{ class UFB_MentorSearch
390 class UFB_MentorSearch extends UserFilterBuilder
391 {
392 public function __construct($envprefix = '')
393 {
394 $fields = array(
395 new UFBF_MentorCountry('country'),
396 new UFBF_MentorTerm('jobterm', 'jobtermText'),
397 new UFBF_MentorExpertise('expertise'),
398 );
399 parent::__construct($fields, $envprefix);
400 }
401 }
402 // }}}
403
404 // {{{ class UFB_NewsLetter
405 class UFB_NewsLetter extends UserFilterBuilder
406 {
407 const FIELDS_PROMO = 'promo';
408 const FIELDS_AXID = 'axid';
409 const FIELDS_GEO = 'geo';
410
411 public function __construct($flags, $envprefix = '')
412 {
413 $fields = array();
414 if ($flags->hasFlag(self::FIELDS_PROMO)) {
415 $fields[] = new UFBF_Promo('promo1', 'Promotion', 'egal1');
416 $fields[] = new UFBF_Promo('promo2', 'Promotion', 'egal2');
417 }
418 if ($flags->hasFlag(self::FIELDS_AXID)) {
419 $fields[] = new UFBF_SchoolIds('axid', 'Matricule AX', UFC_SchoolId::AX);
420 }
421 parent::__construct($fields, $envprefix);
422 }
423 }
424 // }}}
425
426 // {{{ class UFB_Field
427 abstract class UFB_Field
428 {
429 protected $envfield;
430 protected $formtext;
431
432 protected $empty = false;
433 protected $val = null;
434
435 /** Constructor
436 * @param $envfield Name of the field in the environment
437 * @param $formtext User-friendly name of that field
438 */
439 public function __construct($envfield, $formtext = '')
440 {
441 $this->envfield = $envfield;
442 if ($formtext != '') {
443 $this->formtext = $formtext;
444 } else {
445 $formtext = ucfirst($envfield);
446 }
447 }
448
449 /** Prints the given error message to the user, and returns false
450 * in order to be used as return $this->raise('ERROR');
451 *
452 * All %s in the $msg will be replaced with the formtext.
453 */
454 protected function raise($msg)
455 {
456 Platal::page()->trigError(str_replace('%s', $this->formtext, $msg));
457 return false;
458 }
459
460 public function apply(UserFilterBuilder $ufb) {
461 if (!$this->check($ufb)) {
462 return false;
463 }
464
465 if (!$this->isEmpty()) {
466 $ufc = $this->buildUFC($ufb);
467 if ($ufc != null) {
468 $ufb->addCond($ufc);
469 }
470 }
471 return true;
472 }
473
474 public function isEmpty()
475 {
476 return $this->empty;
477 }
478
479 /** Create the UFC associated to the field; won't be called
480 * if the field is "empty"
481 * @param $ufb UFB to which fields must be added
482 * @return UFC
483 */
484 abstract protected function buildUFC(UserFilterBuilder $ufb);
485
486 /** This function is intended to run consistency checks on the value
487 * @return boolean Whether the input is valid
488 */
489 abstract protected function check(UserFilterBuilder $ufb);
490
491 // Simple form interface
492
493 /** Retrieve a list of env field names used by that field
494 * their values will be recorded when saving the 'search' and used to prefill the form
495 * when needed.
496 */
497 public function getEnvFieldNames()
498 {
499 return array($this->envfield);
500 }
501 }
502 // }}}
503
504 // {{{ class UFBF_Text
505 abstract class UFBF_Text extends UFB_Field
506 {
507 private $minlength;
508 private $maxlength;
509
510 public function __construct($envfield, $formtext = '', $minlength = 2, $maxlength = 255)
511 {
512 parent::__construct($envfield, $formtext);
513 $this->minlength = $minlength;
514 $this->maxlength = $maxlength;
515 }
516
517 protected function check(UserFilterBuilder $ufb)
518 {
519 if ($ufb->blank($this->envfield)) {
520 $this->empty = true;
521 return true;
522 }
523
524 $this->val = $ufb->t($this->envfield);
525 if (strlen($this->val) < $this->minlength) {
526 return $this->raise("Le champ %s est trop court (minimum {$this->minlength}).");
527 } else if (strlen($this->val) > $this->maxlength) {
528 return $this->raise("Le champ %s est trop long (maximum {$this->maxlength}).");
529 } else if (preg_match(":[\]\[<>{}~§_`|%$^=]|\*\*:u", $this->val)) {
530 return $this->raise('Le champ %s contient un caractère interdit rendant la recherche impossible.');
531 }
532
533 return true;
534 }
535 }
536 // }}}
537
538 // {{{ class UFBF_Range
539 /** Subclass to use for fields which only allow integers within a range
540 */
541 abstract class UFBF_Range extends UFB_Field
542 {
543
544 private $min;
545 private $max;
546
547 public function __construct($envfield, $formtext = '', $min = 0, $max = 65535)
548 {
549 parent::__construct($envfield, $formtext);
550 $this->min = $min;
551 $this->max = $max;
552 }
553
554 protected function check(UserFilterBuilder $ufb)
555 {
556 if ($ufb->blank($this->envfield)) {
557 $this->empty = true;
558 return true;
559 }
560
561 $this->val = $ufb->i($this->envfield);
562 if ($this->val < $this->min) {
563 return $this->raise("Le champs %s est inférieur au minimum ({$this->min}).");
564 } else if ($this->val > $this->max) {
565 return $this->raise("Le champ %s est supérieur au maximum ({$this->max}).");
566 }
567 return true;
568 }
569 }
570 // }}}
571
572 // {{{ class UFBF_Index
573 /** Subclass to use for indexed fields
574 */
575 abstract class UFBF_Index extends UFB_Field
576 {
577 protected function check(UserFilterBuilder $ufb)
578 {
579 if ($ufb->blank($this->envfield)) {
580 $this->empty = true;
581 }
582 $this->val = $ufb->i($this->envfield);
583 return true;
584 }
585 }
586 // }}}
587
588 // {{{ class UFBF_Enum
589 /** Subclass to use for fields whose value must belong to a specific set of values
590 */
591 abstract class UFBF_Enum extends UFB_Field
592 {
593 protected $allowedvalues;
594
595 public function __construct($envfield, $formtext = '', $allowedvalues = array(), $strict = false)
596 {
597 parent::__construct($envfield, $formtext);
598 $this->allowedvalues = $allowedvalues;
599 $this->strict = $strict;
600 }
601
602 protected function check(UserFilterBuilder $ufb)
603 {
604 if ($ufb->blank($this->envfield)) {
605 $this->empty = true;
606 return true;
607 }
608
609 $this->val = $ufb->v($this->envfield);
610 if (! in_array($this->val, $this->allowedvalues)) {
611 if ($this->strict) {
612 return $this->raise("La valeur {$this->val} n'est pas valide pour le champ %s.");
613 } else {
614 $this->empty = true;
615 }
616 }
617 return true;
618 }
619 }
620 // }}}
621
622 // {{{ class UFBF_Bool
623 abstract class UFBF_Bool extends UFB_Field
624 {
625 protected function check(UserFilterBuilder $ufb)
626 {
627 if ($ufb->blank($this->envfield)) {
628 $this->empty = true;
629 return true;
630 }
631
632 $this->val = $ufb->b($this->envfield);
633 return true;
634 }
635 }
636 // }}}
637
638 // {{{ class UFBF_Mixed
639 /** A class for building UFBFs when the user can input either a text or an ID
640 */
641 abstract class UFBF_Mixed extends UFB_Field
642 {
643 /** Name of the DirEnum on which class is based
644 */
645 protected $direnum;
646
647 protected $envfieldindex;
648
649 public function __construct($envfieldtext, $envfieldindex, $formtext = '')
650 {
651 parent::__construct($envfieldtext, $formtext);
652 $this->envfieldindex = $envfieldindex;
653 }
654
655 protected function check(UserFilterBuilder $ufb)
656 {
657 if ($ufb->blank($this->envfieldindex) && !$ufb->hasAlnum($this->envfield)) {
658 $this->empty = true;
659 return true;
660 }
661
662 if (!$ufb->blank($this->envfieldindex)) {
663 $index = $ufb->v($this->envfieldindex);
664 if (is_int($index)) {
665 $index = intval($index);
666 } else {
667 $index = strtoupper($index);
668 }
669 $this->val = array($index);
670 } else {
671 $indexes = DirEnum::getIDs($this->direnum, $ufb->t($this->envfield),
672 $ufb->b('exact') ? XDB::WILDCARD_EXACT : XDB::WILDCARD_CONTAINS);
673 if (count($indexes) == 0) {
674 return false;
675 }
676 $this->val = $indexes;
677 }
678 return true;
679 }
680
681 public function getEnvFieldNames()
682 {
683 return array($this->envfieldindex, $this->envfield);
684 }
685 }
686 // }}}
687
688 // {{{ class UFBF_Quick
689 class UFBF_Quick extends UFB_Field
690 {
691 protected function check(UserFilterBuilder $ufb)
692 {
693 if ($ufb->blank($this->envfield)) {
694 $this->empty = true;
695 return true;
696 }
697
698 $this->val = str_replace('*', '%', replace_accent($ufb->t($this->envfield)));
699
700 return true;
701 }
702
703 protected function buildUFC(UserFilterBuilder $ufb)
704 {
705
706 $r = $s = $this->val;
707
708 /** Admin: Email, IP
709 */
710 if (S::admin() && strpos($s, '@') !== false) {
711 return new UFC_Email($s);
712 } else if (S::admin() && preg_match('/[0-9]+\.([0-9]+|%)\.([0-9]+|%)\.([0-9]+|%)/', $s)) {
713 return new UFC_Ip($s);
714 }
715
716 $conds = new PFC_And();
717
718 /** Name
719 */
720 $s = preg_replace('!\d+!', ' ', $s);
721 $strings = preg_split("![^a-z%]+!i", $s, -1, PREG_SPLIT_NO_EMPTY);
722 foreach ($strings as $key => $string) {
723 if (strlen($string) < 2) {
724 unset($strings[$key]);
725 }
726 }
727 if (count($strings) > 5) {
728 Platal::page()->trigWarning("Tu as indiqué trop d'éléments dans ta recherche, seuls les 5 premiers seront pris en compte");
729 $strings = array_slice($strings, 0, 5);
730 }
731
732 if (count($strings)) {
733 if (S::user() != null && S::user()->checkPerms('directory_private')) {
734 $flags = array();
735 } else {
736 $flags = array('public');
737 }
738 $exact =$ufb->b('exact');
739 $conds->addChild(new UFC_NameTokens($strings, $flags, $ufb->b('with_soundex'), $exact));
740
741 $ufb->addOrder(new UFO_Score());
742 }
743
744 /** Promo ranges
745 */
746 $s = preg_replace('! *- *!', '-', $r);
747 $s = preg_replace('!([<>]) *!', ' \1', $s);
748 $s = preg_replace('![^0-9xmd\-><]!i', ' ', $s);
749 $s = preg_replace('![<>\-] !', '', $s);
750 $ranges = preg_split('! +!', strtolower($s), -1, PREG_SPLIT_NO_EMPTY);
751 $grades = array('' => UserFilter::GRADE_ING, 'x' => UserFilter::GRADE_ING, 'm' => UserFilter::GRADE_MST, 'd' => UserFilter::GRADE_PHD);
752 foreach ($ranges as $r) {
753 if (preg_match('!^([xmd]?)(\d{4})$!', $r, $matches)) {
754 $conds->addChild(new UFC_Promo('=', $grades[$matches[1]], $matches[2]));
755 } elseif (preg_match('!^([xmd]?)(\d{4})-\1(\d{4})$!', $r, $matches)) {
756 $p1 = min(intval($matches[2]), intval($matches[3]));
757 $p2 = max(intval($matches[2]), intval($matches[3]));
758 $conds->addChild(new PFC_And(
759 new UFC_Promo('>=', $grades[$matches[1]], $p1),
760 new UFC_Promo('<=', $grades[$matches[1]], $p2)
761 ));
762 } elseif (preg_match('!^<([xmd]?)(\d{4})!', $r, $matches)) {
763 $conds->addChild(new UFC_Promo('<=', $grades[$matches[1]], $matches[2]));
764 } elseif (preg_match('!^>([xmd]?)(\d{4})!', $r, $matches)) {
765 $conds->addChild(new UFC_Promo('>=', $grades[$matches[1]], $matches[2]));
766 }
767 }
768
769 /** Phone number
770 */
771 $t = preg_replace('!([xmd]?\d{4}-|>|<|)[xmd]?\d{4}!i', '', $s);
772 $t = preg_replace('![<>\- ]!', '', $t);
773 if (strlen($t) > 4) {
774 $conds->addChild(new UFC_Phone($t));
775 }
776
777 return $conds;
778 }
779 }
780 // }}}
781
782 // {{{ class UFBF_SchoolIds
783 class UFBF_SchoolIds extends UFB_Field
784 {
785 // One of UFC_SchoolId types
786 protected $type;
787 protected $reversed_envfield;
788 protected $reversed = false;
789
790 public function __construct($envfield, $formtext, $type = UFC_SchoolId::AX, $reversed_envfield = '')
791 {
792 parent::__construct($envfield, $formtext);
793 $this->type = $type;
794 if ($reversed_envfield == '') {
795 $reversed_envfield = $envfield . '_reversed';
796 }
797 $this->reversed_envfield = $reversed_envfield;
798 }
799
800 protected function check(UserFilterBuilder $ufb)
801 {
802 if ($ufb->blank($this->envfield)) {
803 $this->empty = true;
804 return true;
805 }
806
807 $value = $ufb->t($this->envfield);
808 $values = explode("\r\n", $value);
809 $ids = array();
810 foreach ($values as $val) {
811 if (preg_match('/^[0-9A-Z]{0,8}$/', $val)) {
812 $ids[] = $val;
813 }
814 }
815 if (count($ids) == 0) {
816 return $this->raise("Le champ %s ne contient aucune valeur valide.");
817 }
818
819 $this->reversed = $ufb->b($this->reversed_envfield);
820 $this->val = $ids;
821 return true;
822 }
823
824 protected function buildUFC(UserFilterBuilder $ufb)
825 {
826 $ufc = new UFC_SchoolId($this->type, $this->val);
827 if ($this->reversed) {
828 return new PFC_Not($ufc);
829 } else {
830 return $ufc;
831 }
832 }
833 }
834 // }}}
835
836 // {{{ class UFBF_Name
837 class UFBF_Name extends UFBF_Text
838 {
839 private $envfieldtype;
840 private $type;
841
842 public function __construct($envfield, $formtext = '', $envfieldtype)
843 {
844 parent::__construct($envfield, $formtext);
845 $this->envfieldtype = $envfieldtype;
846 }
847
848 protected function check(UserFilterBuilder $ufb)
849 {
850 if (!parent::check($ufb)) {
851 return false;
852 }
853
854 require_once 'name.func.inc.php';
855
856 $this->val = split_name_for_search($this->val);
857 if (count($this->val) == 0) {
858 $this->empty = true;
859 }
860 $this->type = $ufb->v($this->envfieldtype);
861 if (!in_array($this->type, array('', 'lastname', 'firstname', 'nickname'))) {
862 return $this->raise("Le critère {$this->type} n'est pas valide pour le champ %s");
863 }
864 return true;
865 }
866
867 protected function buildUFC(UserFilterBuilder $ufb)
868 {
869 return new UFC_NameTokens($this->val, array(), $ufb->b('with_soundex'), $ufb->b('exact'), $this->type);
870 }
871
872 public function getEnvFieldNames()
873 {
874 return array($this->envfield, $this->envfieldtype);
875 }
876 }
877 // }}}
878
879 // {{{ class UFBF_Promo
880 class UFBF_Promo extends UFB_Field
881 {
882 private static $validcomps = array('<', '<=', '=', '>=', '>');
883 private static $validtypes = array(UserFilter::GRADE_ING, UserFilter::GRADE_PHD, UserFilter::GRADE_MST);
884 private $comp;
885 private $type;
886 private $envfieldcomp;
887 private $envfieldtype;
888
889 public function __construct($envfield, $formtext = '', $envfieldcomp, $envfieldtype)
890 {
891 parent::__construct($envfield, $formtext);
892 $this->envfieldcomp = $envfieldcomp;
893 $this->envfieldtype = $envfieldtype;
894 }
895
896 protected function check(UserFilterBuilder $ufb)
897 {
898 if ($ufb->blank($this->envfield) || $ufb->blank($this->envfieldcomp) || $ufb->blank($this->envfieldtype)) {
899 $this->empty = true;
900 return true;
901 }
902
903 $this->val = $ufb->i($this->envfield);
904 $this->comp = $ufb->v($this->envfieldcomp);
905 $this->type = $ufb->v($this->envfieldtype);
906
907 if (!in_array($this->type, self::$validtypes)) {
908 return $this->raise("Le critère {$this->type} n'est pas valide pour le champ %s");
909 }
910
911 if (!in_array($this->comp, self::$validcomps)) {
912 return $this->raise("Le critère {$this->comp} n'est pas valide pour le champ %s");
913 }
914
915 if (preg_match('/^[0-9]{2}$/', $this->val)) {
916 $this->val += 1900;
917 }
918 if ($this->val < 1900 || $this->val > 9999) {
919 return $this->raise("Le champ %s doit être une année à 4 chiffres.");
920 }
921 return true;
922 }
923
924 protected function buildUFC(UserFilterBuilder $ufb) {
925 return new UFC_Promo($this->comp, $this->type, $this->val);
926 }
927
928 public function getEnvFieldNames()
929 {
930 return array($this->envfield, $this->envfieldcomp, $this->envfieldtype);
931 }
932 }
933 // }}}
934
935 // {{{ class UFBF_Sex
936 class UFBF_Sex extends UFBF_Enum
937 {
938 public function __construct($envfield, $formtext = '')
939 {
940 parent::__construct($envfield, $formtext, array(1, 2));
941 }
942
943 private static function getVal($id)
944 {
945 switch($id) {
946 case 1:
947 return User::GENDER_MALE;
948 break;
949 case 2:
950 return User::GENDER_FEMALE;
951 break;
952 }
953 }
954
955 protected function buildUFC(UserFilterBuilder $ufb)
956 {
957 return new UFC_Sex(self::getVal($this->val));
958 }
959 }
960 // }}}
961
962 // {{{ class UFBF_NotRegistered
963 // Simple field for selecting only alive, not registered users (for quick search)
964 class UFBF_NotRegistered extends UFBF_Bool
965 {
966 protected function buildUFC(UserFilterBuilder $ufb)
967 {
968 if ($this->val) {
969 return new PFC_And(
970 new PFC_Not(new UFC_Dead()),
971 new PFC_Not(new UFC_Registered())
972 );
973 }
974 }
975 }
976 // }}}
977
978 // {{{ class UFBF_Registered
979 class UFBF_Registered extends UFBF_Enum
980 {
981 public function __construct($envfield, $formtext = '')
982 {
983 parent::__construct($envfield, $formtext, array(1, 2));
984 }
985
986 protected function buildUFC(UserFilterBuilder $ufb)
987 {
988 if ($this->val == 1) {
989 return new UFC_Registered();
990 } else if ($this->val == 2) {
991 return new PFC_Not(new UFC_Registered());
992 }
993 }
994 }
995 // }}}
996
997 // {{{ class UFBF_HasEmailRedirect
998 class UFBF_HasEmailRedirect extends UFBF_Enum
999 {
1000 public function __construct($envfield, $formtext = '')
1001 {
1002 parent::__construct($envfield, $formtext, array(1, 2));
1003 }
1004
1005 protected function buildUFC(UserFilterBuilder $ufb)
1006 {
1007 if ($this->val == 1) {
1008 return new UFC_HasEmailRedirect();
1009 } else if ($this->val == 2) {
1010 return new PFC_Not(new UFC_HasEmailRedirect());
1011 }
1012 }
1013 }
1014 // }}}
1015
1016 // {{{ class UFBF_Dead
1017 class UFBF_Dead extends UFBF_Enum
1018 {
1019 public function __construct($envfield, $formtext = '')
1020 {
1021 parent::__construct($envfield, $formtext, array(1, 2));
1022 }
1023
1024 protected function buildUFC(UserFilterBuilder $ufb)
1025 {
1026 if ($this->val == 1) {
1027 return new PFC_Not(new UFC_Dead());
1028 } else if ($this->val == 2) {
1029 return new UFC_Dead();
1030 }
1031 }
1032 }
1033 // }}}
1034
1035 // {{{ class UFBF_Town
1036 /** Retrieves a town, either from a postal code or a town name
1037 */
1038 class UFBF_Town extends UFBF_Text
1039 {
1040 const TYPE_TEXT = 1;
1041 const TYPE_ZIP = 2;
1042 const TYPE_ANY = 3;
1043
1044 private $type;
1045 private $onlycurrentfield;
1046
1047 public function __construct($envfield, $formtext = '', $type = self::TYPE_ANY, $onlycurrentfield = 'only_current')
1048 {
1049 $this->type = $type;
1050 $this->onlycurrentfield = $onlycurrentfield;
1051 parent::__construct($envfield, $formtext, 2, 30);
1052 }
1053
1054 protected function buildUFC(UserFilterBuilder $ufb)
1055 {
1056 if ($ufb->isOn($this->onlycurrentfield)) {
1057 $flags = UFC_Address::FLAG_CURRENT;
1058 } else {
1059 $flags = UFC_Address::FLAG_ANY;
1060 }
1061
1062 if (preg_match('/[0-9]/', $this->val)) {
1063 if ($this->type & self::TYPE_ZIP) {
1064 return new UFC_AddressField($this->val, UFC_AddressField::FIELD_ZIPCODE, UFC_Address::TYPE_ANY, $flags);
1065 } else {
1066 return new PFC_False();
1067 }
1068 } else {
1069 $byname = new UFC_AddressText(null, XDB::WILDCARD_CONTAINS, UFC_Address::TYPE_ANY, $flags, null, $this->val);
1070 $byzip = new UFC_AddressField($this->val, UFC_AddressField::FIELD_ZIPCODE, UFC_Address::TYPE_ANY, $flags);
1071 if ($this->type & self::TYPE_ANY) {
1072 return new PFC_Or($byname, $byzip);
1073 } else if ($this->type & self::TYPE_TEXT) {
1074 return $byname;
1075 } else {
1076 return $byzip;
1077 }
1078 }
1079 }
1080
1081 public function getEnvFieldNames()
1082 {
1083 return array($this->envfield, $this->onlycurrentfield);
1084 }
1085 }
1086 // }}}
1087
1088 // {{{ class UFBF_Country
1089 class UFBF_Country extends UFBF_Mixed
1090 {
1091 protected $direnum = DirEnum::COUNTRIES;
1092 protected $onlycurrentfield;
1093
1094 public function __construct($envfieldtext, $envfieldindex, $formtext = '', $onlycurrentfield = 'only_current')
1095 {
1096 parent::__construct($envfieldtext, $envfieldindex, $formtext);
1097 $this->onlycurrentfield = $onlycurrentfield;
1098 }
1099
1100 protected function buildUFC(UserFilterBuilder $ufb)
1101 {
1102 if ($ufb->isOn($this->onlycurrentfield)) {
1103 $flags = UFC_Address::FLAG_CURRENT;
1104 } else {
1105 $flags = UFC_Address::FLAG_ANY;
1106 }
1107
1108 return new UFC_AddressField($this->val, UFC_AddressField::FIELD_COUNTRY, UFC_Address::TYPE_ANY, $flags);
1109 }
1110
1111 public function getEnvFieldNames()
1112 {
1113 return array($this->envfield, $this->envfieldindex, $this->onlycurrentfield);
1114 }
1115 }
1116 // }}}
1117
1118 // {{{ class UFBF_AdminArea
1119 class UFBF_AdminArea extends UFBF_Index
1120 {
1121 protected $direnum = DirEnum::ADMINAREAS;
1122 protected $onlycurrentfield;
1123
1124 public function __construct($envfield, $formtext = '', $onlycurrentfield = 'only_current')
1125 {
1126 parent::__construct($envfield, $formtext);
1127 $this->onlycurrentfield = $onlycurrentfield;
1128 }
1129
1130
1131 protected function buildUFC(UserFilterBuilder $ufb)
1132 {
1133 if ($ufb->isOn($this->onlycurrentfield)) {
1134 $flags = UFC_Address::FLAG_CURRENT;
1135 } else {
1136 $flags = UFC_Address::FLAG_ANY;
1137 }
1138
1139 return new UFC_AddressField($this->val, UFC_AddressField::FIELD_ADMAREA, UFC_Address::TYPE_ANY, $flags);
1140 }
1141
1142 public function getEnvFieldNames()
1143 {
1144 return array($this->envfield, $this->onlycurrentfield);
1145 }
1146 }
1147 // }}}
1148
1149 // {{{ class UFBF_SubAdminArea
1150 class UFBF_SubAdminArea extends UFBF_Index
1151 {
1152 protected $direnum = DirEnum::SUBADMINAREAS;
1153 protected $onlycurrentfield;
1154
1155 public function __construct($envfield, $formtext = '', $onlycurrentfield = 'only_current')
1156 {
1157 parent::__construct($envfield, $formtext);
1158 $this->onlycurrentfield = $onlycurrentfield;
1159 }
1160
1161
1162 protected function buildUFC(UserFilterBuilder $ufb)
1163 {
1164 if ($ufb->isOn($this->onlycurrentfield)) {
1165 $flags = UFC_Address::FLAG_CURRENT;
1166 } else {
1167 $flags = UFC_Address::FLAG_ANY;
1168 }
1169
1170 return new UFC_AddressField($this->val, UFC_AddressField::FIELD_SUBADMAREA, UFC_Address::TYPE_ANY, $flags);
1171 }
1172
1173 public function getEnvFieldNames()
1174 {
1175 return array($this->envfield, $this->onlycurrentfield);
1176 }
1177 }
1178 // }}}
1179
1180 // {{{ class UFBF_JobCompany
1181 class UFBF_JobCompany extends UFBF_Text
1182 {
1183 private $onlymentorfield;
1184
1185 public function __construct($envfield, $formtext = '', $onlymentorfield = 'only_referent')
1186 {
1187 parent::__construct($envfield, $formtext);
1188 $this->onlymentorfield = $onlymentorfield;
1189 }
1190
1191 public function check(UserFilterBuilder $ufb) {
1192 if (parent::check($ufb)) {
1193 # No company check for mentors
1194 if ($ufb->isOn($this->onlymentorfield)) {
1195 $this->empty = true;
1196 }
1197 return true;
1198 } else {
1199 return false;
1200 }
1201 }
1202
1203 protected function buildUFC(UserFilterBuilder $ufb)
1204 {
1205 return new UFC_Job_Company(UFC_Job_Company::JOBNAME, $this->val);
1206 }
1207
1208 public function getEnvFieldNames()
1209 {
1210 return array($this->envfield, $this->onlymentorfield);
1211 }
1212 }
1213 // }}}
1214
1215 // {{{ class UFBF_JobTerms
1216 class UFBF_JobTerms extends UFBF_Index
1217 {
1218 protected function buildUFC(UserFilterBuilder $ufb)
1219 {
1220 return new UFC_Job_Terms($this->val);
1221 }
1222 }
1223 // }}}
1224
1225 // {{{ class UFBF_JobDescription
1226 class UFBF_JobDescription extends UFBF_Text
1227 {
1228 private $onlymentorfield;
1229
1230 public function __construct($envfield, $formtext = '', $onlymentorfield = 'only_referent')
1231 {
1232 parent::__construct($envfield, $formtext);
1233 $this->onlymentorfield = $onlymentorfield;
1234 }
1235
1236 protected function buildUFC(UserFilterBuilder $ufb)
1237 {
1238 if ($ufb->isOn($this->onlymentorfield)) {
1239 return new UFC_Mentor_Expertise($this->val);
1240 } else {
1241 return new UFC_Job_Description($this->val, UserFilter::JOB_USERDEFINED);
1242 }
1243 }
1244
1245 public function getEnvFieldNames()
1246 {
1247 return array($this->envfield, $this->onlymentorfield);
1248 }
1249 }
1250 // }}}
1251
1252 // {{{ class UFBF_JobCv
1253 class UFBF_JobCv extends UFBF_Text
1254 {
1255 private $onlymentorfield;
1256
1257 public function __construct($envfield, $formtext = '', $onlymentorfield = 'only_referent')
1258 {
1259 parent::__construct($envfield, $formtext);
1260 $this->onlymentorfield = $onlymentorfield;
1261 }
1262
1263 protected function buildUFC(UserFilterBuilder $ufb)
1264 {
1265 if ($ufb->isOn($this->onlymentorfield)) {
1266 return new UFC_Mentor_Expertise($this->val);
1267 } else {
1268 return new UFC_Job_Description($this->val, UserFilter::JOB_CV);
1269 }
1270 }
1271
1272 public function getEnvFieldNames()
1273 {
1274 return array($this->envfield, $this->onlymentorfield);
1275 }
1276 }
1277 // }}}
1278
1279 // {{{ class UFBF_Nationality
1280 class UFBF_Nationality extends UFBF_Mixed
1281 {
1282 protected $direnum = DirEnum::NATIONALITIES;
1283
1284 protected function buildUFC(UserFilterBuilder $ufb)
1285 {
1286 return new UFC_Nationality($this->val);
1287 }
1288 }
1289 // }}}
1290
1291 // {{{ class UFBF_Binet
1292 class UFBF_Binet extends UFBF_Mixed
1293 {
1294 protected $direnum = DirEnum::BINETS;
1295
1296 protected function buildUFC(UserFilterBuilder $ufb)
1297 {
1298 return new UFC_Binet($this->val);
1299 }
1300 }
1301 // }}}
1302
1303 // {{{ class UFBF_Group
1304 class UFBF_Group extends UFBF_Mixed
1305 {
1306 protected $direnum = DirEnum::GROUPESX;
1307
1308 protected function buildUFC(UserFilterBuilder $ufb)
1309 {
1310 if (count($this->val) == 1) {
1311 return new UFC_Group($this->val[0]);
1312 }
1313
1314 $or = new PFC_Or();
1315 foreach ($this->val as $grp) {
1316 $or->addChild(new UFC_Group($grp));
1317 }
1318 return $or;
1319 }
1320 }
1321 // }}}
1322
1323 // {{{ class UFBF_Section
1324 class UFBF_Section extends UFBF_Mixed
1325 {
1326 protected $direnum = DirEnum::SECTIONS;
1327
1328 protected function buildUFC(UserFilterBuilder $ufb)
1329 {
1330 return new UFC_Section($this->val);
1331 }
1332 }
1333 // }}}
1334
1335 // {{{ class UFBF_EducationSchool
1336 class UFBF_EducationSchool extends UFBF_Mixed
1337 {
1338 protected $direnum = DirEnum::EDUSCHOOLS;
1339
1340 protected function buildUFC(UserFilterBuilder $ufb)
1341 {
1342 return new UFC_EducationSchool($this->val);
1343 }
1344 }
1345 // }}}
1346
1347 // {{{ class UFBF_EducationDegree
1348 class UFBF_EducationDegree extends UFBF_Mixed
1349 {
1350 protected $direnum = DirEnum::EDUDEGREES;
1351
1352 protected function buildUFC(UserFilterBuilder $ufb)
1353 {
1354 return new UFC_EducationDegree($this->val);
1355 }
1356 }
1357 // }}}
1358
1359 // {{{ class UFBF_EducationField
1360 class UFBF_EducationField extends UFBF_Mixed
1361 {
1362 protected $direnum = DirEnum::EDUFIELDS;
1363
1364 protected function buildUFC(UserFilterBuilder $ufb)
1365 {
1366 return new UFC_EducationField($this->val);
1367 }
1368 }
1369 // }}}
1370
1371 // {{{ class UFBF_OriginCorps
1372 class UFBF_OriginCorps extends UFBF_Index
1373 {
1374 protected $direnum = DirEnum::ORIGINCORPS;
1375
1376 protected function buildUFC(UserFilterBuilder $ufb)
1377 {
1378 return new UFC_Corps(null, $this->val, UFC_Corps::ORIGIN);
1379 }
1380 }
1381 // }}}
1382
1383 // {{{ class UFBF_CurrentCorps
1384 class UFBF_CurrentCorps extends UFBF_Index
1385 {
1386 protected $direnum = DirEnum::CURRENTCORPS;
1387
1388 protected function buildUFC(UserFilterBuilder $ufb)
1389 {
1390 return new UFC_Corps(null, $this->val, UFC_Corps::CURRENT);
1391 }
1392 }
1393 // }}}
1394
1395 // {{{ class UFBF_CorpsRank
1396 class UFBF_CorpsRank extends UFBF_Index
1397 {
1398 protected $direnum = DirEnum::CORPSRANKS;
1399
1400 protected function buildUFC(UserFilterBuilder $ufb)
1401 {
1402 return new UFC_Corps_Rank(null, $this->val);
1403 }
1404 }
1405 // }}}
1406
1407 // {{{ class UFBF_Comment
1408 class UFBF_Comment extends UFBF_Text
1409 {
1410 protected function buildUFC(UserFilterBuilder $ufb)
1411 {
1412 return new UFC_Comment($this->val);
1413 }
1414 }
1415 // }}}
1416
1417 // {{{ class UFBF_Phone
1418 class UFBF_Phone extends UFBF_Text
1419 {
1420 protected function buildUFC(UserFilterBuilder $ufb)
1421 {
1422 return new UFC_Phone($this->val);
1423 }
1424 }
1425 // }}}
1426
1427 // {{{ class UFBF_Networking
1428 class UFBF_Networking extends UFBF_Text
1429 {
1430 private $networktypefield;
1431 private $nwtype;
1432
1433 public function __construct($envfield, $networktypefield, $formtext = '')
1434 {
1435 parent::__construct($envfield, $formtext);
1436 $this->networktypefield = $networktypefield;
1437 }
1438
1439 public function check(UserFilterBuilder $ufb)
1440 {
1441 if (parent::check($ufb)) {
1442 $this->nwtype = $ufb->i($this->networktypefield);
1443 return true;
1444 } else {
1445 return false;
1446 }
1447 }
1448
1449 public function isEmpty()
1450 {
1451 return parent::isEmpty() || $this->nwtype == 0;
1452 }
1453
1454 public function buildUFC(UserFilterBuilder $ufb)
1455 {
1456 return new UFC_Networking($this->nwtype, $this->val);
1457 }
1458
1459 public function getEnvFieldNames()
1460 {
1461 return array($this->envfield, $this->networktypefield);
1462 }
1463 }
1464 // }}}
1465
1466 // {{{ class UFBF_Mentor
1467 class UFBF_Mentor extends UFBF_Bool
1468 {
1469 protected function buildUFC(UserFilterBuilder $ufb)
1470 {
1471 return new UFC_Mentor();
1472 }
1473 }
1474 // }}}
1475
1476 // {{{ class UFBF_MentorCountry
1477 class UFBF_MentorCountry extends UFBF_Text
1478 {
1479 protected function buildUFC(UserFilterBuilder $ufb)
1480 {
1481 return new UFC_Mentor_Country($this->val);
1482 }
1483 }
1484 // }}}
1485
1486 // {{{ class UFBF_Mentorterm
1487 class UFBF_MentorTerm extends UFBF_Index
1488 {
1489 protected function buildUFC(UserFilterBuilder $ufb)
1490 {
1491 return new UFC_Mentor_Terms($this->val);
1492 }
1493 }
1494 // }}}
1495
1496 // {{{ class UFBF_MentorExpertise
1497 class UFBF_MentorExpertise extends UFBF_Text
1498 {
1499 protected function buildUFC(UserFilterBuilder $ufb)
1500 {
1501 return new UFC_Mentor_Expertise($this->val);
1502 }
1503 }
1504 // }}}
1505
1506 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
1507 ?>