classes/userfilter.php

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