include/ufbuilder.inc.php

   1 <?php
   2 /***************************************************************************
   3  *  Copyright (C) 2003-2014 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_AddressIndex('postal_code', 'Code postal', 'POSTALCODES'),
 351             new UFBF_AddressIndex('administrative_area_level_3', 'Canton', 'ADMNISTRATIVEAREAS3'),
 352             new UFBF_AddressIndex('administrative_area_level_2', 'Département', 'ADMNISTRATIVEAREAS2'),
 353             new UFBF_AddressIndex('administrative_area_level_1', 'Région', 'ADMNISTRATIVEAREAS1'),
 354             new UFBF_AddressMixed('locality_text', 'locality', 'Ville', 'LOCALITIES'),
 355             new UFBF_AddressMixed('country_text', 'country', 'Pays', 'COUNTRIES'),
 356
 357             new UFBF_JobCompany('entreprise', 'Entreprise'),
 358             new UFBF_JobDescription('jobdescription', 'Fonction'),
 359             new UFBF_JobCv('cv', 'CV'),
 360             new UFBF_JobTerms('jobterm', 'Mots-clefs'),
 361
 362             new UFBF_OriginCorps('origin_corps', 'Corps d\'origine'),
 363             new UFBF_CurrentCorps('current_corps', 'Corps actuel'),
 364             new UFBF_CorpsRank('corps_rank', 'Grade'),
 365
 366             new UFBF_Nationality('nationalite_text', 'nationalite', 'Nationalité'),
 367             new UFBF_Binet('binet_text', 'binet', 'Binet'),
 368             new UFBF_Group('groupex_text', 'groupex', 'Groupe X'),
 369             new UFBF_Section('section_text', 'section', 'Section'),
 370
 371             new UFBF_EducationSchool('school_text', 'school', "École d'application"),
 372             new UFBF_EducationDegree('diploma_text', 'diploma', 'Diplôme'),
 373             new UFBF_EducationField('field_text', 'field', "Domaine d'études"),
 374
 375             new UFBF_Comment('free', 'Commentaire'),
 376             new UFBF_Phone('phone_number', 'Téléphone'),
 377             new UFBF_Networking('networking_address', 'networking_type', 'Networking et sites webs'),
 378
 379             new UFBF_Mentor('only_referent', 'Référent'),
 380         );
 381
 382         if ($include_admin || $include_ax) {
 383             $fields[] = new UFBF_SchoolIds('schoolid_ax', 'Matricule AX', UFC_SchoolId::AX);
 384         }
 385
 386         parent::__construct($fields, $envprefix);
 387     }
 388 }
 389 // }}}
 390
 391 // {{{ class UFB_MentorSearch
 392 class UFB_MentorSearch extends UserFilterBuilder
 393 {
 394     public function __construct($envprefix = '')
 395     {
 396         $fields = array(
 397             new UFBF_MentorCountry('country'),
 398             new UFBF_MentorTerm('jobterm', 'jobtermText'),
 399             new UFBF_MentorExpertise('expertise'),
 400         );
 401         parent::__construct($fields, $envprefix);
 402     }
 403 }
 404 // }}}
 405
 406 // {{{ class UFB_DeltaTenSearch
 407 class UFB_DeltaTenSearch extends UserFilterBuilder
 408 {
 409     public function __construct($envprefix = '')
 410     {
 411         $fields = array(
 412             new UFBF_DeltaTenMessage('deltaten_message'),
 413
 414             new UFBF_AddressIndex('administrative_area_level_2', 'Département', 'ADMNISTRATIVEAREAS2'),
 415             new UFBF_AddressIndex('administrative_area_level_1', 'Région', 'ADMNISTRATIVEAREAS1'),
 416             new UFBF_AddressMixed('locality_text', 'locality', 'Ville', 'LOCALITIES'),
 417             new UFBF_AddressMixed('country_text', 'country', 'Pays', 'COUNTRIES'),
 418
 419             new UFBF_EducationSchool('schoolTxt', 'school', "École d'application"),
 420             new UFBF_EducationDegree('diplomaTxt', 'diploma', 'Diplôme'),
 421             new UFBF_EducationField('fieldTxt', 'field', "Domaine d'études"),
 422
 423             new UFBF_JobCompany('entreprise', 'Entreprise'),
 424             new UFBF_JobDescription('jobdescription', 'Fonction'),
 425             new UFBF_JobTerms('jobterm', 'Mots-clefs'),
 426
 427             new UFBF_Nationality('nationaliteTxt', 'nationalite', 'Nationalité'),
 428             new UFBF_Binet('binetTxt', 'binet', 'Binet'),
 429             new UFBF_Group('groupexTxt', 'groupex', 'Groupe X'),
 430             new UFBF_Section('sectionTxt', 'section', 'Section'),
 431             new UFBF_Sex('woman', 'Sexe'),
 432         );
 433         parent::__construct($fields, $envprefix);
 434     }
 435 }
 436 // }}}
 437
 438 // {{{ class UFB_NewsLetter
 439 class UFB_NewsLetter extends UserFilterBuilder
 440 {
 441     const FIELDS_PROMO = 'promo';
 442     const FIELDS_AXID = 'axid';
 443     const FIELDS_GEO = 'geo';
 444
 445     public function __construct($flags, $envprefix = '')
 446     {
 447         $fields = array();
 448         if ($flags->hasFlag(self::FIELDS_PROMO)) {
 449             $fields[] = new UFBF_Promo('promo1', 'Promotion', 'egal1', 'edu_type');
 450             $fields[] = new UFBF_Promo('promo2', 'Promotion', 'egal2', 'edu_type');
 451         }
 452         if ($flags->hasFlag(self::FIELDS_AXID)) {
 453             $fields[] = new UFBF_SchoolIds('axid', 'Matricule AX', UFC_SchoolId::AX);
 454         }
 455         parent::__construct($fields, $envprefix);
 456     }
 457 }
 458 // }}}
 459
 460 // {{{ class UFB_Field
 461 abstract class UFB_Field
 462 {
 463     protected $envfield;
 464     protected $formtext;
 465
 466     protected $empty = false;
 467     protected $val = null;
 468
 469     /** Constructor
 470      * @param $envfield Name of the field in the environment
 471      * @param $formtext User-friendly name of that field
 472      */
 473     public function __construct($envfield, $formtext = '')
 474     {
 475         $this->envfield = $envfield;
 476         if ($formtext != '') {
 477             $this->formtext = $formtext;
 478         } else {
 479             $formtext = ucfirst($envfield);
 480         }
 481     }
 482
 483     /** Prints the given error message to the user, and returns false
 484      * in order to be used as return $this->raise('ERROR');
 485      *
 486      * All %s in the $msg will be replaced with the formtext.
 487      */
 488     protected function raise($msg)
 489     {
 490         Platal::page()->trigError(str_replace('%s', $this->formtext, $msg));
 491         return false;
 492     }
 493
 494     public function apply(UserFilterBuilder $ufb) {
 495         if (!$this->check($ufb)) {
 496             return false;
 497         }
 498
 499         if (!$this->isEmpty()) {
 500             $ufc = $this->buildUFC($ufb);
 501             if ($ufc != null) {
 502                 $ufb->addCond($ufc);
 503             }
 504         }
 505         return true;
 506     }
 507
 508     public function isEmpty()
 509     {
 510         return $this->empty;
 511     }
 512
 513     /** Create the UFC associated to the field; won't be called
 514      * if the field is "empty"
 515      * @param $ufb UFB to which fields must be added
 516      * @return UFC
 517      */
 518     abstract protected function buildUFC(UserFilterBuilder $ufb);
 519
 520     /** This function is intended to run consistency checks on the value
 521      * @return boolean Whether the input is valid
 522      */
 523     abstract protected function check(UserFilterBuilder $ufb);
 524
 525     // Simple form interface
 526
 527     /** Retrieve a list of env field names used by that field
 528      * their values will be recorded when saving the 'search' and used to prefill the form
 529      * when needed.
 530      */
 531     public function getEnvFieldNames()
 532     {
 533         return array($this->envfield);
 534     }
 535 }
 536 // }}}
 537
 538 // {{{ class UFBF_Text
 539 abstract class UFBF_Text extends UFB_Field
 540 {
 541     private $minlength;
 542     private $maxlength;
 543
 544     public function __construct($envfield, $formtext = '', $minlength = 2, $maxlength = 255)
 545     {
 546         parent::__construct($envfield, $formtext);
 547         $this->minlength      = $minlength;
 548         $this->maxlength      = $maxlength;
 549     }
 550
 551     protected function check(UserFilterBuilder $ufb)
 552     {
 553         if ($ufb->blank($this->envfield)) {
 554             $this->empty = true;
 555             return true;
 556         }
 557
 558         $this->val = $ufb->t($this->envfield);
 559         if (strlen($this->val) < $this->minlength) {
 560             return $this->raise("Le champ %s est trop court (minimum {$this->minlength}).");
 561         } else if (strlen($this->val) > $this->maxlength) {
 562             return $this->raise("Le champ %s est trop long (maximum {$this->maxlength}).");
 563         } else if (preg_match(":[\]\[<>{}~§_`|%$^=]|\*\*:u", $this->val)) {
 564             return $this->raise('Le champ %s contient un caractère interdit rendant la recherche impossible.');
 565         }
 566
 567         return true;
 568     }
 569 }
 570 // }}}
 571
 572 // {{{ class UFBF_Range
 573 /** Subclass to use for fields which only allow integers within a range
 574  */
 575 abstract class UFBF_Range extends UFB_Field
 576 {
 577
 578     private $min;
 579     private $max;
 580
 581     public function __construct($envfield, $formtext = '', $min = 0, $max = 65535)
 582     {
 583         parent::__construct($envfield, $formtext);
 584         $this->min = $min;
 585         $this->max = $max;
 586     }
 587
 588     protected function check(UserFilterBuilder $ufb)
 589     {
 590         if ($ufb->blank($this->envfield)) {
 591             $this->empty = true;
 592             return true;
 593         }
 594
 595         $this->val = $ufb->i($this->envfield);
 596         if ($this->val < $this->min) {
 597             return $this->raise("Le champs %s est inférieur au minimum ({$this->min}).");
 598         } else if ($this->val > $this->max) {
 599             return $this->raise("Le champ %s est supérieur au maximum ({$this->max}).");
 600         }
 601         return true;
 602     }
 603 }
 604 // }}}
 605
 606 // {{{ class UFBF_Index
 607 /** Subclass to use for indexed fields
 608  */
 609 abstract class UFBF_Index extends UFB_Field
 610 {
 611     protected function check(UserFilterBuilder $ufb)
 612     {
 613         if ($ufb->blank($this->envfield)) {
 614             $this->empty = true;
 615         }
 616         $this->val = $ufb->i($this->envfield);
 617         return true;
 618     }
 619 }
 620 // }}}
 621
 622 // {{{ class UFBF_Enum
 623 /** Subclass to use for fields whose value must belong to a specific set of values
 624  */
 625 abstract class UFBF_Enum extends UFB_Field
 626 {
 627     protected $allowedvalues;
 628
 629     public function __construct($envfield, $formtext = '', $allowedvalues = array(), $strict = false)
 630     {
 631         parent::__construct($envfield, $formtext);
 632         $this->allowedvalues = $allowedvalues;
 633         $this->strict = $strict;
 634     }
 635
 636     protected function check(UserFilterBuilder $ufb)
 637     {
 638         if ($ufb->blank($this->envfield)) {
 639             $this->empty = true;
 640             return true;
 641         }
 642
 643         $this->val = $ufb->v($this->envfield);
 644         if (! in_array($this->val, $this->allowedvalues)) {
 645             if ($this->strict) {
 646                 return $this->raise("La valeur {$this->val} n'est pas valide pour le champ %s.");
 647             } else {
 648                 $this->empty = true;
 649             }
 650         }
 651         return true;
 652     }
 653 }
 654 // }}}
 655
 656 // {{{ class UFBF_Bool
 657 abstract class UFBF_Bool extends UFB_Field
 658 {
 659     protected function check(UserFilterBuilder $ufb)
 660     {
 661         if ($ufb->blank($this->envfield)) {
 662             $this->empty = true;
 663             return true;
 664         }
 665
 666         $this->val = $ufb->b($this->envfield);
 667         return true;
 668     }
 669 }
 670 // }}}
 671
 672 // {{{ class UFBF_Mixed
 673 /** A class for building UFBFs when the user can input either a text or an ID
 674  */
 675 abstract class UFBF_Mixed extends UFB_Field
 676 {
 677     /** Name of the DirEnum on which class is based
 678      */
 679     protected $direnum;
 680
 681     protected $envfieldindex;
 682
 683     public function __construct($envfieldtext, $envfieldindex, $formtext = '')
 684     {
 685         parent::__construct($envfieldtext, $formtext);
 686         $this->envfieldindex = $envfieldindex;
 687     }
 688
 689     protected function check(UserFilterBuilder $ufb)
 690     {
 691         if ($ufb->blank($this->envfieldindex) && !$ufb->hasAlnum($this->envfield)) {
 692             $this->empty = true;
 693             return true;
 694         }
 695
 696         if (!$ufb->blank($this->envfieldindex)) {
 697             $index = $ufb->v($this->envfieldindex);
 698             if (is_int($index)) {
 699                 $index = intval($index);
 700             } else {
 701                 $index = strtoupper($index);
 702             }
 703             $this->val = array($index);
 704         } else {
 705             $indexes = DirEnum::getIDs($this->direnum, $ufb->t($this->envfield),
 706                 $ufb->b('exact') ? XDB::WILDCARD_EXACT : XDB::WILDCARD_CONTAINS);
 707             if (count($indexes) == 0) {
 708                 return false;
 709             }
 710             $this->val = $indexes;
 711         }
 712         return true;
 713     }
 714
 715     public function getEnvFieldNames()
 716     {
 717         return array($this->envfieldindex, $this->envfield);
 718     }
 719 }
 720 // }}}
 721
 722 // {{{ class UFBF_Quick
 723 class UFBF_Quick extends UFB_Field
 724 {
 725     protected function check(UserFilterBuilder $ufb)
 726     {
 727         if ($ufb->blank($this->envfield)) {
 728             $this->empty = true;
 729             return true;
 730         }
 731
 732         $this->val = str_replace('*', '%', replace_accent($ufb->t($this->envfield)));
 733
 734         return true;
 735     }
 736
 737     protected function buildUFC(UserFilterBuilder $ufb)
 738     {
 739
 740         $r = $s = $this->val;
 741
 742         /** Admin: Email, IP
 743          */
 744         if (S::admin() && strpos($s, '@') !== false) {
 745             return new UFC_Email($s);
 746         } else if (S::admin() && preg_match('/[0-9]+\.([0-9]+|%)\.([0-9]+|%)\.([0-9]+|%)/', $s)) {
 747             return new UFC_Ip($s);
 748         }
 749
 750         $conds = new PFC_And();
 751
 752         /** Name
 753          */
 754         $s = preg_replace('!\d+!', ' ', $s);
 755         $strings = preg_split("![^a-z%]+!i", $s, -1, PREG_SPLIT_NO_EMPTY);
 756         foreach ($strings as $key => $string) {
 757             if (strlen($string) < 2) {
 758                 unset($strings[$key]);
 759             }
 760         }
 761         if (count($strings) > 5) {
 762             Platal::page()->trigWarning("Tu as indiqué trop d'éléments dans ta recherche, seuls les 5 premiers seront pris en compte");
 763             $strings = array_slice($strings, 0, 5);
 764         }
 765
 766         if (count($strings)) {
 767             if (S::user() != null && S::user()->checkPerms('directory_private')) {
 768                 $flags = array();
 769             } else {
 770                 $flags = array('public');
 771             }
 772             $exact =$ufb->b('exact');
 773             $conds->addChild(new UFC_NameTokens($strings, $flags, $ufb->b('with_soundex'), $exact));
 774
 775             $ufb->addOrder(new UFO_Score());
 776         }
 777
 778         /** Promo ranges
 779          */
 780         $s = preg_replace('! *- *!', '-', $r);
 781         $s = preg_replace('!([<>]) *!', ' \1', $s);
 782         $s = preg_replace('![^0-9xmd\-><]!i', ' ', $s);
 783         $s = preg_replace('![<>\-] !', '', $s);
 784         $ranges = preg_split('! +!', strtolower($s), -1, PREG_SPLIT_NO_EMPTY);
 785         $grades = array('' => UserFilter::GRADE_ING, 'x' => UserFilter::GRADE_ING, 'm' => UserFilter::GRADE_MST, 'd' => UserFilter::GRADE_PHD);
 786         foreach ($ranges as $r) {
 787             if (preg_match('!^([xmd]?)(\d{4})$!', $r, $matches)) {
 788                 $conds->addChild(new UFC_Promo('=', $grades[$matches[1]], $matches[2]));
 789             } elseif (preg_match('!^([xmd]?)(\d{4})-\1(\d{4})$!', $r, $matches)) {
 790                 $p1 = min(intval($matches[2]), intval($matches[3]));
 791                 $p2 = max(intval($matches[2]), intval($matches[3]));
 792                 $conds->addChild(new PFC_And(
 793                     new UFC_Promo('>=', $grades[$matches[1]], $p1),
 794                     new UFC_Promo('<=', $grades[$matches[1]], $p2)
 795                 ));
 796             } elseif (preg_match('!^<([xmd]?)(\d{4})!', $r, $matches)) {
 797                 $conds->addChild(new UFC_Promo('<=', $grades[$matches[1]], $matches[2]));
 798             } elseif (preg_match('!^>([xmd]?)(\d{4})!', $r, $matches)) {
 799                 $conds->addChild(new UFC_Promo('>=', $grades[$matches[1]], $matches[2]));
 800             }
 801         }
 802
 803         /** Phone number
 804          */
 805         $t = preg_replace('!([xmd]?\d{4}-|>|<|)[xmd]?\d{4}!i', '', $s);
 806         $t = preg_replace('![<>\- ]!', '', $t);
 807         if (strlen($t) > 4) {
 808             $conds->addChild(new UFC_Phone($t));
 809         }
 810
 811         return $conds;
 812     }
 813 }
 814 // }}}
 815
 816 // {{{ class UFBF_SchoolIds
 817 class UFBF_SchoolIds extends UFB_Field
 818 {
 819     // One of UFC_SchoolId types
 820     protected $type;
 821     protected $reversed_envfield;
 822     protected $reversed = false;
 823
 824     public function __construct($envfield, $formtext, $type = UFC_SchoolId::AX, $reversed_envfield = '')
 825     {
 826         parent::__construct($envfield, $formtext);
 827         $this->type = $type;
 828         if ($reversed_envfield == '') {
 829             $reversed_envfield = $envfield . '_reversed';
 830         }
 831         $this->reversed_envfield = $reversed_envfield;
 832     }
 833
 834     protected function check(UserFilterBuilder $ufb)
 835     {
 836         if ($ufb->blank($this->envfield)) {
 837             $this->empty = true;
 838             return true;
 839         }
 840
 841         $value = $ufb->t($this->envfield);
 842         $values = explode("\n", $value);
 843         $ids = array();
 844         foreach ($values as $val) {
 845             $val = trim($val);
 846             if (preg_match('/^[0-9A-Z]{0,8}$/', $val)) {
 847                 $ids[] = $val;
 848             }
 849         }
 850         if (count($ids) == 0) {
 851             return $this->raise("Le champ %s ne contient aucune valeur valide.");
 852         }
 853
 854         $this->reversed = $ufb->b($this->reversed_envfield);
 855         $this->val = $ids;
 856         return true;
 857     }
 858
 859     protected function buildUFC(UserFilterBuilder $ufb)
 860     {
 861         $ufc = new UFC_SchoolId($this->type, $this->val);
 862         if ($this->reversed) {
 863             return new PFC_Not($ufc);
 864         } else {
 865             return $ufc;
 866         }
 867     }
 868 }
 869 // }}}
 870
 871 // {{{ class UFBF_Name
 872 class UFBF_Name extends UFBF_Text
 873 {
 874     private $envfieldtype;
 875     private $type;
 876
 877     public function __construct($envfield, $formtext = '', $envfieldtype)
 878     {
 879         parent::__construct($envfield, $formtext);
 880         $this->envfieldtype = $envfieldtype;
 881     }
 882
 883     protected function check(UserFilterBuilder $ufb)
 884     {
 885         if (!parent::check($ufb)) {
 886             return false;
 887         }
 888
 889         require_once 'name.func.inc.php';
 890
 891         $this->val = split_name_for_search($this->val);
 892         if (count($this->val) == 0) {
 893             $this->empty = true;
 894         }
 895         $this->type = $ufb->v($this->envfieldtype);
 896         if (!in_array($this->type, array('', 'lastname', 'firstname', 'nickname'))) {
 897             return $this->raise("Le critère {$this->type} n'est pas valide pour le champ %s");
 898         }
 899         return true;
 900     }
 901
 902     protected function buildUFC(UserFilterBuilder $ufb)
 903     {
 904         return new UFC_NameTokens($this->val, array(), $ufb->b('with_soundex'), $ufb->b('exact'), $this->type);
 905     }
 906
 907     public function getEnvFieldNames()
 908     {
 909         return array($this->envfield, $this->envfieldtype);
 910     }
 911 }
 912 // }}}
 913
 914 // {{{ class UFBF_Promo
 915 class UFBF_Promo extends UFB_Field
 916 {
 917     private static $validcomps = array('<', '<=', '=', '>=', '>');
 918     private static $validtypes = array(UserFilter::GRADE_ING, UserFilter::GRADE_PHD, UserFilter::GRADE_MST);
 919     private $comp;
 920     private $type;
 921     private $envfieldcomp;
 922     private $envfieldtype;
 923
 924     public function __construct($envfield, $formtext = '', $envfieldcomp, $envfieldtype)
 925     {
 926         parent::__construct($envfield, $formtext);
 927         $this->envfieldcomp = $envfieldcomp;
 928         $this->envfieldtype = $envfieldtype;
 929     }
 930
 931     protected function check(UserFilterBuilder $ufb)
 932     {
 933         if ($ufb->blank($this->envfield) || $ufb->blank($this->envfieldcomp) || $ufb->blank($this->envfieldtype)) {
 934             $this->empty = true;
 935             return true;
 936         }
 937
 938         $this->val  = $ufb->i($this->envfield);
 939         $this->comp = $ufb->v($this->envfieldcomp);
 940         $this->type = $ufb->v($this->envfieldtype);
 941
 942         if (!in_array($this->type, self::$validtypes)) {
 943             return $this->raise("Le critère {$this->type} n'est pas valide pour le champ %s");
 944         }
 945
 946         if (!in_array($this->comp, self::$validcomps)) {
 947             return $this->raise("Le critère {$this->comp} n'est pas valide pour le champ %s");
 948         }
 949
 950         if (preg_match('/^[0-9]{2}$/', $this->val)) {
 951             $this->val += 1900;
 952         }
 953         if ($this->val < 1900 || $this->val > 9999) {
 954             return $this->raise("Le champ %s doit être une année à 4 chiffres.");
 955         }
 956         return true;
 957     }
 958
 959     protected function buildUFC(UserFilterBuilder $ufb) {
 960         return new UFC_Promo($this->comp, $this->type, $this->val);
 961     }
 962
 963     public function getEnvFieldNames()
 964     {
 965         return array($this->envfield, $this->envfieldcomp, $this->envfieldtype);
 966     }
 967 }
 968 // }}}
 969
 970 // {{{ class UFBF_Sex
 971 class UFBF_Sex extends UFBF_Enum
 972 {
 973     public function __construct($envfield, $formtext = '')
 974     {
 975         parent::__construct($envfield, $formtext, array(1, 2));
 976     }
 977
 978     private static function getVal($id)
 979     {
 980         switch($id) {
 981         case 1:
 982             return User::GENDER_MALE;
 983             break;
 984         case 2:
 985             return User::GENDER_FEMALE;
 986             break;
 987         }
 988     }
 989
 990     protected function buildUFC(UserFilterBuilder $ufb)
 991     {
 992         return new UFC_Sex(self::getVal($this->val));
 993     }
 994 }
 995 // }}}
 996
 997 // {{{ class UFBF_NotRegistered
 998 // Simple field for selecting only alive, not registered users (for quick search)
 999 class UFBF_NotRegistered extends UFBF_Bool
1000 {
1001     protected function buildUFC(UserFilterBuilder $ufb)
1002     {
1003         if ($this->val) {
1004             return new PFC_And(
1005                 new PFC_Not(new UFC_Dead()),
1006                 new PFC_Not(new UFC_Registered())
1007             );
1008         }
1009     }
1010 }
1011 // }}}
1012
1013 // {{{ class UFBF_Registered
1014 class UFBF_Registered extends UFBF_Enum
1015 {
1016     public function __construct($envfield, $formtext = '')
1017     {
1018         parent::__construct($envfield, $formtext, array(1, 2));
1019     }
1020
1021     protected function buildUFC(UserFilterBuilder $ufb)
1022     {
1023         if ($this->val == 1) {
1024             return new UFC_Registered();
1025         } else if ($this->val == 2) {
1026             return new PFC_Not(new UFC_Registered());
1027         }
1028     }
1029 }
1030 // }}}
1031
1032 // {{{ class UFBF_HasEmailRedirect
1033 class UFBF_HasEmailRedirect extends UFBF_Enum
1034 {
1035     public function __construct($envfield, $formtext = '')
1036     {
1037         parent::__construct($envfield, $formtext, array(1, 2));
1038     }
1039
1040     protected function buildUFC(UserFilterBuilder $ufb)
1041     {
1042         if ($this->val == 1) {
1043             return new UFC_HasEmailRedirect();
1044         } else if ($this->val == 2) {
1045             return new PFC_Not(new UFC_HasEmailRedirect());
1046         }
1047     }
1048 }
1049 // }}}
1050
1051 // {{{ class UFBF_Dead
1052 class UFBF_Dead extends UFBF_Enum
1053 {
1054     public function __construct($envfield, $formtext = '')
1055     {
1056         parent::__construct($envfield, $formtext, array(1, 2));
1057     }
1058
1059     protected function buildUFC(UserFilterBuilder $ufb)
1060     {
1061         if ($this->val == 1) {
1062             return new PFC_Not(new UFC_Dead());
1063         } else if ($this->val == 2) {
1064             return new UFC_Dead();
1065         }
1066     }
1067 }
1068 // }}}
1069
1070 // {{{ class UFBF_AddressMixed
1071 class UFBF_AddressMixed extends UFBF_Mixed
1072 {
1073     protected $onlycurrentfield;
1074     protected $onlybestmailfield;
1075
1076     public function __construct($envfieldtext, $envfieldindex, $formtext = '', $addressfield, $onlycurrentfield = 'only_current', $onlybestmailfield = 'only_best_mail')
1077     {
1078         parent::__construct($envfieldtext, $envfieldindex, $formtext);
1079         $this->onlycurrentfield = $onlycurrentfield;
1080         $this->onlybestmailfield = $onlybestmailfield;
1081         $this->direnum = constant('DirEnum::' . $addressfield);
1082     }
1083
1084     protected function buildUFC(UserFilterBuilder $ufb)
1085     {
1086         $flags = UFC_Address::FLAG_NONE;
1087         if ($ufb->isOn($this->onlycurrentfield)) {
1088             $flags |= UFC_Address::FLAG_CURRENT;
1089         }
1090         if ($ufb->isOn($this->onlybestmailfield)) {
1091             $flags |= UFC_Address::FLAG_BEST_MAIL;
1092         }
1093         if ($flags == UFC_Address::FLAG_NONE) {
1094             $flags = UFC_Address::FLAG_ANY;
1095         }
1096
1097         return new UFC_AddressComponent($this->val, $this->envfieldindex, UFC_Address::TYPE_NON_HQ, $flags);
1098     }
1099
1100     public function getEnvFieldNames()
1101     {
1102         return array($this->envfield, $this->envfieldindex, $this->onlycurrentfield, $this->onlybestmailfield);
1103     }
1104 }
1105 // }}}
1106
1107 // {{{ class UFBF_AddressIndex
1108 class UFBF_AddressIndex extends UFBF_Index
1109 {
1110     protected $direnum;
1111     protected $onlycurrentfield;
1112     protected $onlybestmailfield;
1113
1114     public function __construct($envfield, $formtext = '', $addressfield, $onlycurrentfield = 'only_current', $onlybestmailfield = 'only_best_mail')
1115     {
1116         parent::__construct($envfield, $formtext);
1117         $this->onlycurrentfield = $onlycurrentfield;
1118         $this->onlybestmailfield = $onlybestmailfield;
1119         $this->direnum = constant('DirEnum::' . $addressfield);
1120     }
1121
1122
1123     protected function buildUFC(UserFilterBuilder $ufb)
1124     {
1125         $flags = UFC_Address::FLAG_NONE;
1126         if ($ufb->isOn($this->onlycurrentfield)) {
1127             $flags |= UFC_Address::FLAG_CURRENT;
1128         }
1129         if ($ufb->isOn($this->onlybestmailfield)) {
1130             $flags |= UFC_Address::FLAG_BEST_MAIL;
1131         }
1132         if ($flags == UFC_Address::FLAG_NONE) {
1133             $flags = UFC_Address::FLAG_ANY;
1134         }
1135
1136         return new UFC_AddressComponent($this->val, $this->envfield, UFC_Address::TYPE_NON_HQ, $flags);
1137     }
1138
1139     public function getEnvFieldNames()
1140     {
1141         return array($this->envfield, $this->onlycurrentfield, $this->onlybestmailfield);
1142     }
1143 }
1144 // }}}
1145
1146 // {{{ class UFBF_JobCompany
1147 class UFBF_JobCompany extends UFBF_Text
1148 {
1149     protected function buildUFC(UserFilterBuilder $ufb)
1150     {
1151         return new UFC_Job_Company(UFC_Job_Company::JOBNAME, $this->val);
1152     }
1153 }
1154 // }}}
1155
1156 // {{{ class UFBF_JobTerms
1157 class UFBF_JobTerms extends UFBF_Index
1158 {
1159     protected function buildUFC(UserFilterBuilder $ufb)
1160     {
1161         return new UFC_Job_Terms($this->val);
1162     }
1163 }
1164 // }}}
1165
1166 // {{{ class UFBF_JobDescription
1167 class UFBF_JobDescription extends UFBF_Text
1168 {
1169     private $onlymentorfield;
1170
1171     public function __construct($envfield, $formtext = '', $onlymentorfield = 'only_referent')
1172     {
1173         parent::__construct($envfield, $formtext);
1174         $this->onlymentorfield = $onlymentorfield;
1175     }
1176
1177     protected function buildUFC(UserFilterBuilder $ufb)
1178     {
1179         if ($ufb->isOn($this->onlymentorfield)) {
1180             return new UFC_Mentor_Expertise($this->val);
1181         } else {
1182             return new UFC_Job_Description($this->val, UserFilter::JOB_USERDEFINED);
1183         }
1184     }
1185
1186     public function getEnvFieldNames()
1187     {
1188         return array($this->envfield, $this->onlymentorfield);
1189     }
1190 }
1191 // }}}
1192
1193 // {{{ class UFBF_JobCv
1194 class UFBF_JobCv extends UFBF_Text
1195 {
1196     private $onlymentorfield;
1197
1198     public function __construct($envfield, $formtext = '', $onlymentorfield = 'only_referent')
1199     {
1200         parent::__construct($envfield, $formtext);
1201         $this->onlymentorfield = $onlymentorfield;
1202     }
1203
1204     protected function buildUFC(UserFilterBuilder $ufb)
1205     {
1206         if ($ufb->isOn($this->onlymentorfield)) {
1207             return new UFC_Mentor_Expertise($this->val);
1208         } else {
1209             return new UFC_Job_Description($this->val, UserFilter::JOB_CV);
1210         }
1211     }
1212
1213     public function getEnvFieldNames()
1214     {
1215         return array($this->envfield, $this->onlymentorfield);
1216     }
1217 }
1218 // }}}
1219
1220 // {{{ class UFBF_Nationality
1221 class UFBF_Nationality extends UFBF_Mixed
1222 {
1223     protected $direnum = DirEnum::NATIONALITIES;
1224
1225     protected function buildUFC(UserFilterBuilder $ufb)
1226     {
1227         return new UFC_Nationality($this->val);
1228     }
1229 }
1230 // }}}
1231
1232 // {{{ class UFBF_Binet
1233 class UFBF_Binet extends UFBF_Mixed
1234 {
1235     protected $direnum = DirEnum::BINETS;
1236
1237     protected function buildUFC(UserFilterBuilder $ufb)
1238     {
1239         return new UFC_Binet($this->val);
1240     }
1241 }
1242 // }}}
1243
1244 // {{{ class UFBF_Group
1245 class UFBF_Group extends UFBF_Mixed
1246 {
1247     protected $direnum = DirEnum::GROUPESX;
1248
1249     protected function buildUFC(UserFilterBuilder $ufb)
1250     {
1251         if (count($this->val) == 1) {
1252             return new UFC_Group($this->val[0]);
1253         }
1254
1255         $or = new PFC_Or();
1256         foreach ($this->val as $grp) {
1257             $or->addChild(new UFC_Group($grp));
1258         }
1259         return $or;
1260     }
1261 }
1262 // }}}
1263
1264 // {{{ class UFBF_Section
1265 class UFBF_Section extends UFBF_Mixed
1266 {
1267     protected $direnum = DirEnum::SECTIONS;
1268
1269     protected function buildUFC(UserFilterBuilder $ufb)
1270     {
1271         return new UFC_Section($this->val);
1272     }
1273 }
1274 // }}}
1275
1276 // {{{ class UFBF_EducationSchool
1277 class UFBF_EducationSchool extends UFBF_Mixed
1278 {
1279     protected $direnum = DirEnum::EDUSCHOOLS;
1280
1281     protected function buildUFC(UserFilterBuilder $ufb)
1282     {
1283         return new UFC_EducationSchool($this->val);
1284     }
1285 }
1286 // }}}
1287
1288 // {{{ class UFBF_EducationDegree
1289 class UFBF_EducationDegree extends UFBF_Mixed
1290 {
1291     protected $direnum = DirEnum::EDUDEGREES;
1292
1293     protected function buildUFC(UserFilterBuilder $ufb)
1294     {
1295         return new UFC_EducationDegree($this->val);
1296     }
1297 }
1298 // }}}
1299
1300 // {{{ class UFBF_EducationField
1301 class UFBF_EducationField extends UFBF_Mixed
1302 {
1303     protected $direnum = DirEnum::EDUFIELDS;
1304
1305     protected function buildUFC(UserFilterBuilder $ufb)
1306     {
1307         return new UFC_EducationField($this->val);
1308     }
1309 }
1310 // }}}
1311
1312 // {{{ class UFBF_OriginCorps
1313 class UFBF_OriginCorps extends UFBF_Index
1314 {
1315     protected $direnum = DirEnum::ORIGINCORPS;
1316
1317     protected function buildUFC(UserFilterBuilder $ufb)
1318     {
1319         return new UFC_Corps(null, $this->val, UFC_Corps::ORIGIN);
1320     }
1321 }
1322 // }}}
1323
1324 // {{{ class UFBF_CurrentCorps
1325 class UFBF_CurrentCorps extends UFBF_Index
1326 {
1327     protected $direnum = DirEnum::CURRENTCORPS;
1328
1329     protected function buildUFC(UserFilterBuilder $ufb)
1330     {
1331         return new UFC_Corps(null, $this->val, UFC_Corps::CURRENT);
1332     }
1333 }
1334 // }}}
1335
1336 // {{{ class UFBF_CorpsRank
1337 class UFBF_CorpsRank extends UFBF_Index
1338 {
1339     protected $direnum = DirEnum::CORPSRANKS;
1340
1341     protected function buildUFC(UserFilterBuilder $ufb)
1342     {
1343         return new UFC_Corps_Rank(null, $this->val);
1344     }
1345 }
1346 // }}}
1347
1348 // {{{ class UFBF_Comment
1349 class UFBF_Comment extends UFBF_Text
1350 {
1351     protected function buildUFC(UserFilterBuilder $ufb)
1352     {
1353         return new UFC_Comment($this->val);
1354     }
1355 }
1356 // }}}
1357
1358 // {{{ class UFBF_Phone
1359 class UFBF_Phone extends UFBF_Text
1360 {
1361     protected function buildUFC(UserFilterBuilder $ufb)
1362     {
1363         return new UFC_Phone($this->val);
1364     }
1365 }
1366 // }}}
1367
1368 // {{{ class UFBF_Networking
1369 class UFBF_Networking extends UFBF_Text
1370 {
1371     private $networktypefield;
1372     private $nwtype;
1373
1374     public function __construct($envfield, $networktypefield, $formtext = '')
1375     {
1376         parent::__construct($envfield, $formtext);
1377         $this->networktypefield  = $networktypefield;
1378     }
1379
1380     public function check(UserFilterBuilder $ufb)
1381     {
1382         if (parent::check($ufb)) {
1383             $this->nwtype = $ufb->i($this->networktypefield);
1384             return true;
1385         } else {
1386             return false;
1387         }
1388     }
1389
1390     public function isEmpty()
1391     {
1392         return parent::isEmpty() || $this->nwtype == 0;
1393     }
1394
1395     public function buildUFC(UserFilterBuilder $ufb)
1396     {
1397         return new UFC_Networking($this->nwtype, $this->val);
1398     }
1399
1400     public function getEnvFieldNames()
1401     {
1402         return array($this->envfield, $this->networktypefield);
1403     }
1404 }
1405 // }}}
1406
1407 // {{{ class UFBF_Mentor
1408 class UFBF_Mentor extends UFBF_Bool
1409 {
1410     protected function buildUFC(UserFilterBuilder $ufb)
1411     {
1412         return new UFC_Mentor();
1413     }
1414 }
1415 // }}}
1416
1417 // {{{ class UFBF_MentorCountry
1418 class UFBF_MentorCountry extends UFBF_Text
1419 {
1420     protected function buildUFC(UserFilterBuilder $ufb)
1421     {
1422         return new UFC_Mentor_Country($this->val);
1423     }
1424 }
1425 // }}}
1426
1427 // {{{ class UFBF_Mentorterm
1428 class UFBF_MentorTerm extends UFBF_Index
1429 {
1430     protected function buildUFC(UserFilterBuilder $ufb)
1431     {
1432         return new UFC_Mentor_Terms($this->val);
1433     }
1434 }
1435 // }}}
1436
1437 // {{{ class UFBF_MentorExpertise
1438 class UFBF_MentorExpertise extends UFBF_Text
1439 {
1440     protected function buildUFC(UserFilterBuilder $ufb)
1441     {
1442         return new UFC_Mentor_Expertise($this->val);
1443     }
1444 }
1445 // }}}
1446
1447 // {{{ class UFBF_DeltaTenMessage
1448 class UFBF_DeltaTenMessage extends UFBF_Text
1449 {
1450     protected function buildUFC(UserFilterBuilder $ufb)
1451     {
1452         return new UFC_DeltaTen_Message($this->val);
1453     }
1454 }
1455 // }}}
1456
1457 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker fenc=utf-8:
1458 ?>