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_Terms
 984 /** Filters users based on the job terms they assigned to one of their
 985  * jobs.
 986  * @param $val The ID of the job term, or an array of such IDs
 987  */
 988 class UFC_Job_Terms implements UserFilterCondition
 989 {
 990     private $val;
 991
 992     public function __construct($val)
 993     {
 994         if (!is_array($val)) {
 995             $val = array($val);
 996         }
 997         $this->val = $val;
 998     }
 999
1000     public function buildCondition(PlFilter &$uf)
1001     {
1002         $sub = $uf->addJobTermsFilter(count($this->val));
1003         $conditions = array();
1004         foreach ($this->val as $i => $jtid) {
1005             $conditions[] = $sub[$i] . ' = ' . XDB::escape($jtid);
1006         }
1007         return implode(' AND ', $conditions);
1008     }
1009 }
1010 // }}}
1011
1012 // {{{ class UFC_Job_Description
1013 /** Filters users based on their job description
1014  * @param $description The text being searched for
1015  * @param $fields The fields to search for (user-defined, ((sub|)sub|)sector)
1016  */
1017 class UFC_Job_Description implements UserFilterCondition
1018 {
1019
1020     private $description;
1021     private $fields;
1022
1023     public function __construct($description, $fields)
1024     {
1025         $this->fields = $fields;
1026         $this->description = $description;
1027     }
1028
1029     public function buildCondition(PlFilter &$uf)
1030     {
1031         $conds = array();
1032         if ($this->fields & UserFilter::JOB_USERDEFINED) {
1033             $sub = $uf->addJobFilter();
1034             $conds[] = $sub . '.description ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->description);
1035         }
1036         if ($this->fields & UserFilter::JOB_CV) {
1037             $uf->requireProfiles();
1038             $conds[] = 'p.cv ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->description);
1039         }
1040         if ($this->fields & UserFilter::JOB_SECTOR) {
1041             $sub = $uf->addJobSectorizationFilter(UserFilter::JOB_SECTOR);
1042             $conds[] = $sub . '.name ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->description);
1043         }
1044         if ($this->fields & UserFilter::JOB_SUBSECTOR) {
1045             $sub = $uf->addJobSectorizationFilter(UserFilter::JOB_SUBSECTOR);
1046             $conds[] = $sub . '.name ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->description);
1047         }
1048         if ($this->fields & UserFilter::JOB_SUBSUBSECTOR) {
1049             $sub = $uf->addJobSectorizationFilter(UserFilter::JOB_SUBSUBSECTOR);
1050             $conds[] = $sub . '.name ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->description);
1051             $sub = $uf->addJobSectorizationFilter(UserFilter::JOB_ALTERNATES);
1052             $conds[] = $sub . '.name ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->description);
1053         }
1054         return implode(' OR ', $conds);
1055     }
1056 }
1057 // }}}
1058
1059 // {{{ class UFC_Networking
1060 /** Filters users based on network identity (IRC, ...)
1061  * @param $type Type of network (-1 for any)
1062  * @param $value Value to search
1063  */
1064 class UFC_Networking implements UserFilterCondition
1065 {
1066     private $type;
1067     private $value;
1068
1069     public function __construct($type, $value)
1070     {
1071         $this->type = $type;
1072         $this->value = $value;
1073     }
1074
1075     public function buildCondition(PlFilter &$uf)
1076     {
1077         $sub = $uf->addNetworkingFilter();
1078         $conds = array();
1079         $conds[] = $sub . '.address ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->value);
1080         if ($this->type != -1) {
1081             $conds[] = $sub . '.nwid = ' . XDB::format('{?}', $this->type);
1082         }
1083         return implode(' AND ', $conds);
1084     }
1085 }
1086 // }}}
1087
1088 // {{{ class UFC_Phone
1089 /** Filters users based on their phone number
1090  * @param $num_type Type of number (pro/user/home)
1091  * @param $phone_type Type of phone (fixed/mobile/fax)
1092  * @param $number Phone number
1093  */
1094 class UFC_Phone implements UserFilterCondition
1095 {
1096     const NUM_PRO   = 'pro';
1097     const NUM_USER  = 'user';
1098     const NUM_HOME  = 'address';
1099     const NUM_ANY   = 'any';
1100
1101     const PHONE_FIXED   = 'fixed';
1102     const PHONE_MOBILE  = 'mobile';
1103     const PHONE_FAX     = 'fax';
1104     const PHONE_ANY     = 'any';
1105
1106     private $num_type;
1107     private $phone_type;
1108     private $number;
1109
1110     public function __construct($number, $num_type = self::NUM_ANY, $phone_type = self::PHONE_ANY)
1111     {
1112         $phone = new Phone(array('display' => $number));
1113         $phone->format();
1114         $this->number = $phone->search();
1115         $this->num_type = $num_type;
1116         $this->phone_type = $phone_type;
1117     }
1118
1119     public function buildCondition(PlFilter &$uf)
1120     {
1121         $sub = $uf->addPhoneFilter();
1122         $conds = array();
1123         $conds[] = $sub . '.search_tel = ' . XDB::format('{?}', $this->number);
1124         if ($this->num_type != self::NUM_ANY) {
1125             $conds[] = $sub . '.link_type = ' . XDB::format('{?}', $this->num_type);
1126         }
1127         if ($this->phone_type != self::PHONE_ANY) {
1128             $conds[] = $sub . '.tel_type = ' . XDB::format('{?}', $this->phone_type);
1129         }
1130         return implode(' AND ', $conds);
1131     }
1132 }
1133 // }}}
1134
1135 // {{{ class UFC_Medal
1136 /** Filters users based on their medals
1137  * @param $medal ID of the medal
1138  * @param $grade Grade of the medal (null for 'any')
1139  */
1140 class UFC_Medal implements UserFilterCondition
1141 {
1142     private $medal;
1143     private $grade;
1144
1145     public function __construct($medal, $grade = null)
1146     {
1147         $this->medal = $medal;
1148         $this->grade = $grade;
1149     }
1150
1151     public function buildCondition(PlFilter &$uf)
1152     {
1153         $conds = array();
1154         $sub = $uf->addMedalFilter();
1155         $conds[] = $sub . '.mid = ' . XDB::format('{?}', $this->medal);
1156         if ($this->grade != null) {
1157             $conds[] = $sub . '.gid = ' . XDB::format('{?}', $this->grade);
1158         }
1159         return implode(' AND ', $conds);
1160     }
1161 }
1162 // }}}
1163
1164 // {{{ class UFC_Photo
1165 /** Filters profiles with photo
1166  */
1167 class UFC_Photo implements UserFilterCondition
1168 {
1169     public function buildCondition(PlFilter &$uf)
1170     {
1171         $uf->addPhotoFilter();
1172         return 'photo.attach IS NOT NULL';
1173     }
1174 }
1175 // }}}
1176
1177 // {{{ class UFC_Mentor_Expertise
1178 /** Filters users by mentoring expertise
1179  * @param $expertise Domain of expertise
1180  */
1181 class UFC_Mentor_Expertise implements UserFilterCondition
1182 {
1183     private $expertise;
1184
1185     public function __construct($expertise)
1186     {
1187         $this->expertise = $expertise;
1188     }
1189
1190     public function buildCondition(PlFilter &$uf)
1191     {
1192         $sub = $uf->addMentorFilter(UserFilter::MENTOR_EXPERTISE);
1193         return $sub . '.expertise ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->expertise);
1194     }
1195 }
1196 // }}}
1197
1198 // {{{ class UFC_Mentor_Country
1199 /** Filters users by mentoring country
1200  * @param $country Two-letters code of country being searched
1201  */
1202 class UFC_Mentor_Country implements UserFilterCondition
1203 {
1204     private $country;
1205
1206     public function __construct()
1207     {
1208         $this->country = pl_flatten(func_get_args());
1209     }
1210
1211     public function buildCondition(PlFilter &$uf)
1212     {
1213         $sub = $uf->addMentorFilter(UserFilter::MENTOR_COUNTRY);
1214         return $sub . '.country IN ' . XDB::format('{?}', $this->country);
1215     }
1216 }
1217 // }}}
1218
1219 // {{{ class UFC_Mentor_Sectorization
1220 /** Filters users based on mentoring (sub|)sector
1221  * @param $sector ID of (sub)sector
1222  * @param $type Whether we are looking for a sector or a subsector
1223  */
1224 class UFC_Mentor_Sectorization implements UserFilterCondition
1225 {
1226     const SECTOR    = 1;
1227     const SUBSECTOR = 2;
1228     private $sector;
1229     private $type;
1230
1231     public function __construct($sector, $type = self::SECTOR)
1232     {
1233         $this->sector = $sector;
1234         $this->type = $type;
1235     }
1236
1237     public function buildCondition(PlFilter &$uf)
1238     {
1239         $sub = $uf->addMentorFilter(UserFilter::MENTOR_SECTOR);
1240         if ($this->type == self::SECTOR) {
1241             $field = 'sectorid';
1242         } else {
1243             $field = 'subsectorid';
1244         }
1245         return $sub . '.' . $field . ' = ' . XDB::format('{?}', $this->sector);
1246     }
1247 }
1248 // }}}
1249
1250 // {{{ class UFC_UserRelated
1251 /** Filters users based on a relation toward a user
1252  * @param $user User to which searched users are related
1253  */
1254 abstract class UFC_UserRelated implements UserFilterCondition
1255 {
1256     protected $user;
1257     public function __construct(PlUser &$user)
1258     {
1259         $this->user =& $user;
1260     }
1261 }
1262 // }}}
1263
1264 // {{{ class UFC_Contact
1265 /** Filters users who belong to selected user's contacts
1266  */
1267 class UFC_Contact extends UFC_UserRelated
1268 {
1269     public function buildCondition(PlFilter &$uf)
1270     {
1271         $sub = $uf->addContactFilter($this->user->id());
1272         return 'c' . $sub . '.contact IS NOT NULL';
1273     }
1274 }
1275 // }}}
1276
1277 // {{{ class UFC_WatchRegistration
1278 /** Filters users being watched by selected user
1279  */
1280 class UFC_WatchRegistration extends UFC_UserRelated
1281 {
1282     public function buildCondition(PlFilter &$uf)
1283     {
1284         if (!$this->user->watchType('registration')) {
1285             return PlFilterCondition::COND_FALSE;
1286         }
1287         $uids = $this->user->watchUsers();
1288         if (count($uids) == 0) {
1289             return PlFilterCondition::COND_FALSE;
1290         } else {
1291             return XDB::format('$UID IN {?}', $uids);
1292         }
1293     }
1294 }
1295 // }}}
1296
1297 // {{{ class UFC_WatchPromo
1298 /** Filters users belonging to a promo watched by selected user
1299  * @param $user Selected user (the one watching promo)
1300  * @param $grade Formation the user is watching
1301  */
1302 class UFC_WatchPromo extends UFC_UserRelated
1303 {
1304     private $grade;
1305     public function __construct(PlUser &$user, $grade = UserFilter::GRADE_ING)
1306     {
1307         parent::__construct($user);
1308         $this->grade = $grade;
1309     }
1310
1311     public function buildCondition(PlFilter &$uf)
1312     {
1313         $promos = $this->user->watchPromos();
1314         if (count($promos) == 0) {
1315             return PlFilterCondition::COND_FALSE;
1316         } else {
1317             $sube = $uf->addEducationFilter(true, $this->grade);
1318             $field = 'pe' . $sube . '.' . UserFilter::promoYear($this->grade);
1319             return XDB::format($field . ' IN {?}', $promos);
1320         }
1321     }
1322 }
1323 // }}}
1324
1325 // {{{ class UFC_WatchContact
1326 /** Filters users watched by selected user
1327  */
1328 class UFC_WatchContact extends UFC_Contact
1329 {
1330     public function buildCondition(PlFilter &$uf)
1331     {
1332         if (!$this->user->watchContacts()) {
1333             return PlFilterCondition::COND_FALSE;
1334         }
1335         return parent::buildCondition($uf);
1336     }
1337 }
1338 // }}}
1339
1340 // {{{ class UFC_MarketingHash
1341 /** Filters users using the hash generated
1342  * to send marketing emails to him.
1343  */
1344 class UFC_MarketingHash implements UserFilterCondition
1345 {
1346     private $hash;
1347
1348     public function __construct($hash)
1349     {
1350         $this->hash = $hash;
1351     }
1352
1353     public function buildCondition(PlFilter &$uf)
1354     {
1355         $table = $uf->addMarketingHash();
1356         return XDB::format('rm.hash = {?}', $this->hash);
1357     }
1358 }
1359 // }}}
1360
1361 /******************
1362  * ORDERS
1363  ******************/
1364
1365 // {{{ class UFO_Promo
1366 /** Orders users by promotion
1367  * @param $grade Formation whose promotion users should be sorted by (restricts results to users of that formation)
1368  * @param $desc Whether sort is descending
1369  */
1370 class UFO_Promo extends PlFilterGroupableOrder
1371 {
1372     private $grade;
1373
1374     public function __construct($grade = null, $desc = false)
1375     {
1376         parent::__construct($desc);
1377         $this->grade = $grade;
1378     }
1379
1380     protected function getSortTokens(PlFilter &$uf)
1381     {
1382         if (UserFilter::isGrade($this->grade)) {
1383             $sub = $uf->addEducationFilter($this->grade);
1384             return 'pe' . $sub . '.' . UserFilter::promoYear($this->grade);
1385         } else {
1386             $sub = $uf->addDisplayFilter();
1387             return 'pd' . $sub . '.promo';
1388         }
1389     }
1390 }
1391 // }}}
1392
1393 // {{{ class UFO_Name
1394 /** Sorts users by name
1395  * @param $type Type of name on which to sort (firstname...)
1396  * @param $variant Variant of that name to use (marital, ordinary...)
1397  * @param $particle Set to true if particles should be included in the sorting order
1398  * @param $desc If sort order should be descending
1399  */
1400 class UFO_Name extends PlFilterOrder
1401 {
1402     private $type;
1403     private $variant;
1404     private $particle;
1405
1406     public function __construct($type, $variant = null, $particle = false, $desc = false)
1407     {
1408         parent::__construct($desc);
1409         $this->type = $type;
1410         $this->variant = $variant;
1411         $this->particle = $particle;
1412     }
1413
1414     protected function getSortTokens(PlFilter &$uf)
1415     {
1416         if (Profile::isDisplayName($this->type)) {
1417             $sub = $uf->addDisplayFilter();
1418             $token = 'pd' . $sub . '.' . $this->type;
1419             if ($uf->accountsRequired()) {
1420                 $account_token = Profile::getAccountEquivalentName($this->type);
1421                 return 'IFNULL(' . $token . ', a.' . $account_token . ')';
1422             } else {
1423                 return $token;
1424             }
1425         } else {
1426             $sub = $uf->addNameFilter($this->type, $this->variant);
1427             if ($this->particle) {
1428                 return 'CONCAT(pn' . $sub . '.particle, \' \', pn' . $sub . '.name)';
1429             } else {
1430                 return 'pn' . $sub . '.name';
1431             }
1432         }
1433     }
1434 }
1435 // }}}
1436
1437 // {{{ class UFO_Score
1438 class UFO_Score extends PlFilterOrder
1439 {
1440     protected function getSortTokens(PlFilter &$uf)
1441     {
1442         $toks = $uf->getNameTokens();
1443         $scores = array();
1444
1445         // If there weren't any sort tokens, we shouldn't sort by score, sort by NULL instead
1446         if (count($toks) == 0) {
1447             return 'NULL';
1448         }
1449
1450         foreach ($toks as $sub => $token) {
1451             $scores[] = XDB::format('SUM(' . $sub . '.score + IF (' . $sub . '.token = {?}, 5, 0) )', $token);
1452         }
1453         return implode(' + ', $scores);
1454     }
1455 }
1456 // }}}
1457
1458 // {{{ class UFO_Registration
1459 /** Sorts users based on registration date
1460  */
1461 class UFO_Registration extends PlFilterOrder
1462 {
1463     protected function getSortTokens(PlFilter &$uf)
1464     {
1465         $uf->requireAccounts();
1466         return 'a.registration_date';
1467     }
1468 }
1469 // }}}
1470
1471 // {{{ class UFO_Birthday
1472 /** Sorts users based on next birthday date
1473  */
1474 class UFO_Birthday extends PlFilterOrder
1475 {
1476     protected function getSortTokens(PlFilter &$uf)
1477     {
1478         $uf->requireProfiles();
1479         return 'p.next_birthday';
1480     }
1481 }
1482 // }}}
1483
1484 // {{{ class UFO_ProfileUpdate
1485 /** Sorts users based on last profile update
1486  */
1487 class UFO_ProfileUpdate extends PlFilterOrder
1488 {
1489     protected function getSortTokens(PlFilter &$uf)
1490     {
1491         $uf->requireProfiles();
1492         return 'p.last_change';
1493     }
1494 }
1495 // }}}
1496
1497 // {{{ class UFO_Death
1498 /** Sorts users based on death date
1499  */
1500 class UFO_Death extends PlFilterOrder
1501 {
1502     protected function getSortTokens(PlFilter &$uf)
1503     {
1504         $uf->requireProfiles();
1505         return 'p.deathdate';
1506     }
1507 }
1508 // }}}
1509
1510 // {{{ class UFO_Uid
1511 /** Sorts users based on their uid
1512  */
1513 class UFO_Uid extends PlFilterOrder
1514 {
1515     protected function getSortTokens(PlFilter &$uf)
1516     {
1517         $uf->requireAccounts();
1518         return '$UID';
1519     }
1520 }
1521 // }}}
1522
1523 // {{{ class UFO_Hruid
1524 /** Sorts users based on their hruid
1525  */
1526 class UFO_Hruid extends PlFilterOrder
1527 {
1528     protected function getSortTokens(PlFilter &$uf)
1529     {
1530         $uf->requireAccounts();
1531         return 'a.hruid';
1532     }
1533 }
1534 // }}}
1535
1536 // {{{ class UFO_Pid
1537 /** Sorts users based on their pid
1538  */
1539 class UFO_Pid extends PlFilterOrder
1540 {
1541     protected function getSortTokens(PlFilter &$uf)
1542     {
1543         $uf->requireProfiles();
1544         return '$PID';
1545     }
1546 }
1547 // }}}
1548
1549 // {{{ class UFO_Hrpid
1550 /** Sorts users based on their hrpid
1551  */
1552 class UFO_Hrpid extends PlFilterOrder
1553 {
1554     protected function getSortTokens(PlFilter &$uf)
1555     {
1556         $uf->requireProfiles();
1557         return 'p.hrpid';
1558     }
1559 }
1560 // }}}
1561
1562
1563 /***********************************
1564   *********************************
1565           USER FILTER CLASS
1566   *********************************
1567  ***********************************/
1568
1569 // {{{ class UserFilter
1570 /** This class provides a convenient and centralized way of filtering users.
1571  *
1572  * Usage:
1573  * $uf = new UserFilter(new UFC_Blah($x, $y), new UFO_Coin($z, $t));
1574  *
1575  * Resulting UserFilter can be used to:
1576  * - get a list of User objects matching the filter
1577  * - get a list of UIDs matching the filter
1578  * - get the number of users matching the filter
1579  * - check whether a given User matches the filter
1580  * - filter a list of User objects depending on whether they match the filter
1581  *
1582  * Usage for UFC and UFO objects:
1583  * A UserFilter will call all private functions named XXXJoins.
1584  * These functions must return an array containing the list of join
1585  * required by the various UFC and UFO associated to the UserFilter.
1586  * Entries in those returned array are of the following form:
1587  *   'join_tablealias' => array('join_type', 'joined_table', 'join_criter')
1588  * which will be translated into :
1589  *   join_type JOIN joined_table AS join_tablealias ON (join_criter)
1590  * in the final query.
1591  *
1592  * In the join_criter text, $ME is replaced with 'join_tablealias', $PID with
1593  * profile.pid, and $UID with accounts.uid.
1594  *
1595  * For each kind of "JOIN" needed, a function named addXXXFilter() should be defined;
1596  * its parameter will be used to set various private vars of the UserFilter describing
1597  * the required joins ; such a function shall return the "join_tablealias" to use
1598  * when referring to the joined table.
1599  *
1600  * For example, if data from profile_job must be available to filter results,
1601  * the UFC object will call $uf-addJobFilter(), which will set the 'with_pj' var and
1602  * return 'pj', the short name to use when referring to profile_job; when building
1603  * the query, calling the jobJoins function will return an array containing a single
1604  * row:
1605  *   'pj' => array('left', 'profile_job', '$ME.pid = $UID');
1606  *
1607  * The 'register_optional' function can be used to generate unique table aliases when
1608  * the same table has to be joined several times with different aliases.
1609  */
1610 class UserFilter extends PlFilter
1611 {
1612     protected $joinMethods = array();
1613
1614     protected $joinMetas = array(
1615                                 '$PID' => 'p.pid',
1616                                 '$UID' => 'a.uid',
1617                                 );
1618
1619     private $root;
1620     private $sort = array();
1621     private $grouper = null;
1622     private $query = null;
1623     private $orderby = null;
1624
1625     private $lastusercount = null;
1626     private $lastprofilecount = null;
1627
1628     public function __construct($cond = null, $sort = null)
1629     {
1630         if (empty($this->joinMethods)) {
1631             $class = new ReflectionClass('UserFilter');
1632             foreach ($class->getMethods() as $method) {
1633                 $name = $method->getName();
1634                 if (substr($name, -5) == 'Joins' && $name != 'buildJoins') {
1635                     $this->joinMethods[] = $name;
1636                 }
1637             }
1638         }
1639         if (!is_null($cond)) {
1640             if ($cond instanceof PlFilterCondition) {
1641                 $this->setCondition($cond);
1642             }
1643         }
1644         if (!is_null($sort)) {
1645             if ($sort instanceof PlFilterOrder) {
1646                 $this->addSort($sort);
1647             } else if (is_array($sort)) {
1648                 foreach ($sort as $s) {
1649                     $this->addSort($s);
1650                 }
1651             }
1652         }
1653     }
1654
1655     private function buildQuery()
1656     {
1657         // The root condition is built first because some orders need info
1658         // available only once all UFC have set their conditions (UFO_Score)
1659         if (is_null($this->query)) {
1660             $where = $this->root->buildCondition($this);
1661             $where = str_replace(array_keys($this->joinMetas),
1662                                  $this->joinMetas,
1663                                  $where);
1664         }
1665         if (is_null($this->orderby)) {
1666             $orders = array();
1667             foreach ($this->sort as $sort) {
1668                 $orders = array_merge($orders, $sort->buildSort($this));
1669             }
1670             if (count($orders) == 0) {
1671                 $this->orderby = '';
1672             } else {
1673                 $this->orderby = 'ORDER BY  ' . implode(', ', $orders);
1674             }
1675             $this->orderby = str_replace(array_keys($this->joinMetas),
1676                                          $this->joinMetas,
1677                                          $this->orderby);
1678         }
1679         if (is_null($this->query)) {
1680             if ($this->with_accounts) {
1681                 $from = 'accounts AS a';
1682             } else {
1683                 $this->requireProfiles();
1684                 $from = 'profiles AS p';
1685             }
1686             $joins = $this->buildJoins();
1687             $this->query = 'FROM  ' . $from . '
1688                                ' . $joins . '
1689                            WHERE  (' . $where . ')';
1690         }
1691     }
1692
1693     public function hasGroups()
1694     {
1695         return $this->grouper != null;
1696     }
1697
1698     public function getGroups()
1699     {
1700         return $this->getUIDGroups();
1701     }
1702
1703     public function getUIDGroups()
1704     {
1705         $this->requireAccounts();
1706         $this->buildQuery();
1707         $token = $this->grouper->getGroupToken($this);
1708
1709         $groups = XDB::fetchAllRow('SELECT ' . $token . ', COUNT(a.uid)
1710                                    ' . $this->query . '
1711                                    GROUP BY  ' . $token,
1712                                    0);
1713         return $groups;
1714     }
1715
1716     public function getPIDGroups()
1717     {
1718         $this->requireProfiles();
1719         $this->buildQuery();
1720         $token = $this->grouper->getGroupToken($this);
1721
1722         $groups = XDB::fetchAllRow('SELECT ' . $token . ', COUNT(p.pid)
1723                                    ' . $this->query . '
1724                                    GROUP BY  ' . $token,
1725                                    0);
1726         return $groups;
1727     }
1728
1729     private function getUIDList($uids = null, PlLimit &$limit)
1730     {
1731         $this->requireAccounts();
1732         $this->buildQuery();
1733         $lim = $limit->getSql();
1734         $cond = '';
1735         if (!empty($uids)) {
1736             $cond = XDB::format(' AND a.uid IN {?}', $uids);
1737         }
1738         $fetched = XDB::fetchColumn('SELECT SQL_CALC_FOUND_ROWS  a.uid
1739                                     ' . $this->query . $cond . '
1740                                    GROUP BY  a.uid
1741                                     ' . $this->orderby . '
1742                                     ' . $lim);
1743         $this->lastusercount = (int)XDB::fetchOneCell('SELECT FOUND_ROWS()');
1744         return $fetched;
1745     }
1746
1747     private function getPIDList($pids = null, PlLimit &$limit)
1748     {
1749         $this->requireProfiles();
1750         $this->buildQuery();
1751         $lim = $limit->getSql();
1752         $cond = '';
1753         if (!is_null($pids)) {
1754             $cond = XDB::format(' AND p.pid IN {?}', $pids);
1755         }
1756         $fetched = XDB::fetchColumn('SELECT  SQL_CALC_FOUND_ROWS  p.pid
1757                                     ' . $this->query . $cond . '
1758                                    GROUP BY  p.pid
1759                                     ' . $this->orderby . '
1760                                     ' . $lim);
1761         $this->lastprofilecount = (int)XDB::fetchOneCell('SELECT FOUND_ROWS()');
1762         return $fetched;
1763     }
1764
1765     private static function defaultLimit($limit) {
1766         if ($limit == null) {
1767             return new PlLimit();
1768         } else {
1769             return $limit;
1770         }
1771     }
1772
1773     /** Check that the user match the given rule.
1774      */
1775     public function checkUser(PlUser &$user)
1776     {
1777         $this->requireAccounts();
1778         $this->buildQuery();
1779         $count = (int)XDB::fetchOneCell('SELECT  COUNT(*)
1780                                         ' . $this->query . XDB::format(' AND a.uid = {?}', $user->id()));
1781         return $count == 1;
1782     }
1783
1784     /** Check that the profile match the given rule.
1785      */
1786     public function checkProfile(Profile &$profile)
1787     {
1788         $this->requireProfiles();
1789         $this->buildQuery();
1790         $count = (int)XDB::fetchOneCell('SELECT  COUNT(*)
1791                                         ' . $this->query . XDB::format(' AND p.pid = {?}', $profile->id()));
1792         return $count == 1;
1793     }
1794
1795     /** Default filter is on users
1796      */
1797     public function filter(array $users, $limit = null)
1798     {
1799         return $this->filterUsers($users, self::defaultLimit($limit));
1800     }
1801
1802     /** Filter a list of users to extract the users matching the rule.
1803      */
1804     public function filterUsers(array $users, $limit = null)
1805     {
1806         $limit = self::defaultLimit($limit);
1807         $this->requireAccounts();
1808         $this->buildQuery();
1809         $table = array();
1810         $uids  = array();
1811         foreach ($users as $user) {
1812             if ($user instanceof PlUser) {
1813                 $uid = $user->id();
1814             } else {
1815                 $uid = $user;
1816             }
1817             $uids[] = $uid;
1818             $table[$uid] = $user;
1819         }
1820         $fetched = $this->getUIDList($uids, $limit);
1821         $output = array();
1822         foreach ($fetched as $uid) {
1823             $output[] = $table[$uid];
1824         }
1825         return $output;
1826     }
1827
1828     /** Filter a list of profiles to extract the users matching the rule.
1829      */
1830     public function filterProfiles(array $profiles, $limit = null)
1831     {
1832         $limit = self::defaultLimit($limit);
1833         $this->requireProfiles();
1834         $this->buildQuery();
1835         $table = array();
1836         $pids  = array();
1837         foreach ($profiles as $profile) {
1838             if ($profile instanceof Profile) {
1839                 $pid = $profile->id();
1840             } else {
1841                 $pid = $profile;
1842             }
1843             $pids[] = $pid;
1844             $table[$pid] = $profile;
1845         }
1846         $fetched = $this->getPIDList($pids, $limit);
1847         $output = array();
1848         foreach ($fetched as $pid) {
1849             $output[] = $table[$pid];
1850         }
1851         return $output;
1852     }
1853
1854     public function getUIDs($limit = null)
1855     {
1856         $limit = self::defaultLimit($limit);
1857         return $this->getUIDList(null, $limit);
1858     }
1859
1860     public function getUID($pos = 0)
1861     {
1862         $uids =$this->getUIDList(null, new PlLimit(1, $pos));
1863         if (count($uids) == 0) {
1864             return null;
1865         } else {
1866             return $uids[0];
1867         }
1868     }
1869
1870     public function getPIDs($limit = null)
1871     {
1872         $limit = self::defaultLimit($limit);
1873         return $this->getPIDList(null, $limit);
1874     }
1875
1876     public function getPID($pos = 0)
1877     {
1878         $pids =$this->getPIDList(null, new PlLimit(1, $pos));
1879         if (count($pids) == 0) {
1880             return null;
1881         } else {
1882             return $pids[0];
1883         }
1884     }
1885
1886     public function getUsers($limit = null)
1887     {
1888         return User::getBulkUsersWithUIDs($this->getUIDs($limit));
1889     }
1890
1891     public function getUser($pos = 0)
1892     {
1893         $uid = $this->getUID($pos);
1894         if ($uid == null) {
1895             return null;
1896         } else {
1897             return User::getWithUID($uid);
1898         }
1899     }
1900
1901     public function iterUsers($limit = null)
1902     {
1903         return User::iterOverUIDs($this->getUIDs($limit));
1904     }
1905
1906     public function getProfiles($limit = null, $fields = 0x0000, $visibility = null)
1907     {
1908         return Profile::getBulkProfilesWithPIDs($this->getPIDs($limit), $fields, $visibility);
1909     }
1910
1911     public function getProfile($pos = 0, $fields = 0x0000, $visibility = null)
1912     {
1913         $pid = $this->getPID($pos);
1914         if ($pid == null) {
1915             return null;
1916         } else {
1917             return Profile::get($pid, $fields, $visibility);
1918         }
1919     }
1920
1921     public function iterProfiles($limit = null, $fields = 0x0000, $visibility = null)
1922     {
1923         return Profile::iterOverPIDs($this->getPIDs($limit), true, $fields, $visibility);
1924     }
1925
1926     public function get($limit = null)
1927     {
1928         return $this->getUsers($limit);
1929     }
1930
1931
1932     public function getTotalCount()
1933     {
1934         return $this->getTotalUserCount();
1935     }
1936
1937     public function getTotalUserCount()
1938     {
1939         if (is_null($this->lastusercount)) {
1940             $this->requireAccounts();
1941             $this->buildQuery();
1942             return (int)XDB::fetchOneCell('SELECT  COUNT(DISTINCT a.uid)
1943                                           ' . $this->query);
1944         } else {
1945             return $this->lastusercount;
1946         }
1947     }
1948
1949     public function getTotalProfileCount()
1950     {
1951         if (is_null($this->lastprofilecount)) {
1952             $this->requireProfiles();
1953             $this->buildQuery();
1954             return (int)XDB::fetchOneCell('SELECT  COUNT(DISTINCT p.pid)
1955                                           ' . $this->query);
1956         } else {
1957             return $this->lastprofilecount;
1958         }
1959     }
1960
1961     public function setCondition(PlFilterCondition &$cond)
1962     {
1963         $this->root =& $cond;
1964         $this->query = null;
1965     }
1966
1967     public function addSort(PlFilterOrder &$sort)
1968     {
1969         if (count($this->sort) == 0 && $sort instanceof PlFilterGroupableOrder)
1970         {
1971             $this->grouper = $sort;
1972         }
1973         $this->sort[] = $sort;
1974         $this->orderby = null;
1975     }
1976
1977     static public function getLegacy($promo_min, $promo_max)
1978     {
1979         if ($promo_min != 0) {
1980             $min = new UFC_Promo('>=', self::GRADE_ING, intval($promo_min));
1981         } else {
1982             $min = new PFC_True();
1983         }
1984         if ($promo_max != 0) {
1985             $max = new UFC_Promo('<=', self::GRADE_ING, intval($promo_max));
1986         } else {
1987             $max = new PFC_True();
1988         }
1989         return new UserFilter(new PFC_And($min, $max));
1990     }
1991
1992     static public function sortByName()
1993     {
1994         return array(new UFO_Name(Profile::LASTNAME), new UFO_Name(Profile::FIRSTNAME));
1995     }
1996
1997     static public function sortByPromo()
1998     {
1999         return array(new UFO_Promo(), new UFO_Name(Profile::LASTNAME), new UFO_Name(Profile::FIRSTNAME));
2000     }
2001
2002     static private function getDBSuffix($string)
2003     {
2004         if (is_array($string)) {
2005             if (count($string) == 1) {
2006                 return self::getDBSuffix(array_pop($string));
2007             }
2008             return md5(implode('|', $string));
2009         } else {
2010             return preg_replace('/[^a-z0-9]/i', '', $string);
2011         }
2012     }
2013
2014
2015     /** Stores a new (and unique) table alias in the &$table table
2016      * @param   &$table Array in which the table alias must be stored
2017      * @param   $val    Value which will then be used to build the join
2018      * @return          Name of the newly created alias
2019      */
2020     private $option = 0;
2021     private function register_optional(array &$table, $val)
2022     {
2023         if (is_null($val)) {
2024             $sub   = $this->option++;
2025             $index = null;
2026         } else {
2027             $sub   = self::getDBSuffix($val);
2028             $index = $val;
2029         }
2030         $sub = '_' . $sub;
2031         $table[$sub] = $index;
2032         return $sub;
2033     }
2034
2035     /** PROFILE VS ACCOUNT
2036      */
2037     private $with_profiles  = false;
2038     private $with_accounts  = false;
2039     public function requireAccounts()
2040     {
2041         $this->with_accounts = true;
2042     }
2043
2044     public function accountsRequired()
2045     {
2046         return $this->with_accounts;
2047     }
2048
2049     public function requireProfiles()
2050     {
2051         $this->with_profiles = true;
2052     }
2053
2054     public function profilesRequired()
2055     {
2056         return $this->with_profiles;
2057     }
2058
2059     protected function accountJoins()
2060     {
2061         $joins = array();
2062         if ($this->with_profiles && $this->with_accounts) {
2063             $joins['ap'] = PlSqlJoin::left('account_profiles', '$ME.uid = $UID AND FIND_IN_SET(\'owner\', ap.perms)');
2064             $joins['p'] = PlSqlJoin::left('profiles', '$PID = ap.pid');
2065         }
2066         return $joins;
2067     }
2068
2069     /** DISPLAY
2070      */
2071     const DISPLAY = 'display';
2072     private $pd = false;
2073     public function addDisplayFilter()
2074     {
2075         $this->requireProfiles();
2076         $this->pd = true;
2077         return '';
2078     }
2079
2080     protected function displayJoins()
2081     {
2082         if ($this->pd) {
2083             return array('pd' => PlSqlJoin::left('profile_display', '$ME.pid = $PID'));
2084         } else {
2085             return array();
2086         }
2087     }
2088
2089     /** LOGGER
2090      */
2091
2092     private $with_logger = false;
2093     public function addLoggerFilter()
2094     {
2095         $this->with_logger = true;
2096         $this->requireAccounts();
2097         return 'ls';
2098     }
2099     protected function loggerJoins()
2100     {
2101         $joins = array();
2102         if ($this->with_logger) {
2103             $joins['ls'] = PlSqlJoin::left('log_sessions', '$ME.uid = $UID');
2104         }
2105         return $joins;
2106     }
2107
2108     /** NAMES
2109      */
2110
2111     static public function assertName($name)
2112     {
2113         if (!DirEnum::getID(DirEnum::NAMETYPES, $name)) {
2114             Platal::page()->kill('Invalid name type: ' . $name);
2115         }
2116     }
2117
2118     private $pn  = array();
2119     public function addNameFilter($type, $variant = null)
2120     {
2121         $this->requireProfiles();
2122         if (!is_null($variant)) {
2123             $ft  = $type . '_' . $variant;
2124         } else {
2125             $ft = $type;
2126         }
2127         $sub = '_' . $ft;
2128         self::assertName($ft);
2129
2130         if (!is_null($variant) && $variant == 'other') {
2131             $sub .= $this->option++;
2132         }
2133         $this->pn[$sub] = DirEnum::getID(DirEnum::NAMETYPES, $ft);
2134         return $sub;
2135     }
2136
2137     protected function nameJoins()
2138     {
2139         $joins = array();
2140         foreach ($this->pn as $sub => $type) {
2141             $joins['pn' . $sub] = PlSqlJoin::left('profile_name', '$ME.pid = $PID AND $ME.typeid = {?}', $type);
2142         }
2143         return $joins;
2144     }
2145
2146     /** NAMETOKENS
2147      */
2148     private $name_tokens = array();
2149     private $nb_tokens = 0;
2150
2151     public function addNameTokensFilter($token)
2152     {
2153         $this->requireProfiles();
2154         $sub = 'sn' . (1 + $this->nb_tokens);
2155         $this->nb_tokens++;
2156         $this->name_tokens[$sub] = $token;
2157         return $sub;
2158     }
2159
2160     protected function nameTokensJoins()
2161     {
2162         /* We don't return joins, since with_sn forces the SELECT to run on search_name first */
2163         $joins = array();
2164         foreach ($this->name_tokens as $sub => $token) {
2165             $joins[$sub] = PlSqlJoin::left('search_name', '$ME.pid = $PID');
2166         }
2167         return $joins;
2168     }
2169
2170     public function getNameTokens()
2171     {
2172         return $this->name_tokens;
2173     }
2174
2175     /** NATIONALITY
2176      */
2177
2178     private $with_nat = false;
2179     public function addNationalityFilter()
2180     {
2181         $this->with_nat = true;
2182         return 'ngc';
2183     }
2184
2185     protected function nationalityJoins()
2186     {
2187         $joins = array();
2188         if ($this->with_nat) {
2189             $joins['ngc'] = PlSqlJoin::left('geoloc_countries', '$ME.iso_3166_1_a2 = p.nationality1 OR $ME.iso_3166_1_a2 = p.nationality2 OR $ME.iso_3166_1_a2 = p.nationality3');
2190         }
2191         return $joins;
2192     }
2193
2194     /** EDUCATION
2195      */
2196     const GRADE_ING = 'Ing.';
2197     const GRADE_PHD = 'PhD';
2198     const GRADE_MST = 'M%';
2199     static public function isGrade($grade)
2200     {
2201         return ($grade !== 0) && ($grade == self::GRADE_ING || $grade == self::GRADE_PHD || $grade == self::GRADE_MST);
2202     }
2203
2204     static public function assertGrade($grade)
2205     {
2206         if (!self::isGrade($grade)) {
2207             Platal::page()->killError("Diplôme non valide: $grade");
2208         }
2209     }
2210
2211     static public function promoYear($grade)
2212     {
2213         // XXX: Definition of promotion for phds and masters might change in near future.
2214         return ($grade == UserFilter::GRADE_ING) ? 'entry_year' : 'grad_year';
2215     }
2216
2217     private $pepe     = array();
2218     private $with_pee = false;
2219     public function addEducationFilter($x = false, $grade = null)
2220     {
2221         $this->requireProfiles();
2222         if (!$x) {
2223             $index = $this->option;
2224             $sub   = $this->option++;
2225         } else {
2226             self::assertGrade($grade);
2227             $index = $grade;
2228             $sub   = $grade[0];
2229             $this->with_pee = true;
2230         }
2231         $sub = '_' . $sub;
2232         $this->pepe[$index] = $sub;
2233         return $sub;
2234     }
2235
2236     protected function educationJoins()
2237     {
2238         $joins = array();
2239         if ($this->with_pee) {
2240             $joins['pee'] = PlSqlJoin::inner('profile_education_enum', 'pee.abbreviation = \'X\'');
2241         }
2242         foreach ($this->pepe as $grade => $sub) {
2243             if ($this->isGrade($grade)) {
2244                 $joins['pe' . $sub] = PlSqlJoin::left('profile_education', '$ME.eduid = pee.id AND $ME.pid = $PID');
2245                 $joins['pede' . $sub] = PlSqlJoin::inner('profile_education_degree_enum', '$ME.id = pe' . $sub . '.degreeid AND $ME.abbreviation LIKE {?}', $grade);
2246             } else {
2247                 $joins['pe' . $sub] = PlSqlJoin::left('profile_education', '$ME.pid = $PID');
2248                 $joins['pee' . $sub] = PlSqlJoin::inner('profile_education_enum', '$ME.id = pe' . $sub . '.eduid');
2249                 $joins['pede' . $sub] = PlSqlJoin::inner('profile_education_degree_enum', '$ME.id = pe' . $sub . '.degreeid');
2250             }
2251         }
2252         return $joins;
2253     }
2254
2255
2256     /** GROUPS
2257      */
2258     private $gpm = array();
2259     public function addGroupFilter($group = null)
2260     {
2261         $this->requireAccounts();
2262         if (!is_null($group)) {
2263             if (is_int($group) || ctype_digit($group)) {
2264                 $index = $sub = $group;
2265             } else {
2266                 $index = $group;
2267                 $sub   = self::getDBSuffix($group);
2268             }
2269         } else {
2270             $sub = 'group_' . $this->option++;
2271             $index = null;
2272         }
2273         $sub = '_' . $sub;
2274         $this->gpm[$sub] = $index;
2275         return $sub;
2276     }
2277
2278     protected function groupJoins()
2279     {
2280         $joins = array();
2281         foreach ($this->gpm as $sub => $key) {
2282             if (is_null($key)) {
2283                 $joins['gpa' . $sub] = PlSqlJoin::inner('groups');
2284                 $joins['gpm' . $sub] = PlSqlJoin::left('group_members', '$ME.uid = $UID AND $ME.asso_id = gpa' . $sub . '.id');
2285             } else if (is_int($key) || ctype_digit($key)) {
2286                 $joins['gpm' . $sub] = PlSqlJoin::left('group_members', '$ME.uid = $UID AND $ME.asso_id = ' . $key);
2287             } else {
2288                 $joins['gpa' . $sub] = PlSqlJoin::inner('groups', '$ME.diminutif = {?}', $key);
2289                 $joins['gpm' . $sub] = PlSqlJoin::left('group_members', '$ME.uid = $UID AND $ME.asso_id = gpa' . $sub . '.id');
2290             }
2291         }
2292         return $joins;
2293     }
2294
2295     /** BINETS
2296      */
2297
2298     private $with_bi = false;
2299     private $with_bd = false;
2300     public function addBinetsFilter($with_enum = false)
2301     {
2302         $this->requireProfiles();
2303         $this->with_bi = true;
2304         if ($with_enum) {
2305             $this->with_bd = true;
2306             return 'bd';
2307         } else {
2308             return 'bi';
2309         }
2310     }
2311
2312     protected function binetsJoins()
2313     {
2314         $joins = array();
2315         if ($this->with_bi) {
2316             $joins['bi'] = PlSqlJoin::left('profile_binets', '$ME.pid = $PID');
2317         }
2318         if ($this->with_bd) {
2319             $joins['bd'] = PlSqlJoin::left('profile_binet_enum', '$ME.id = bi.binet_id');
2320         }
2321         return $joins;
2322     }
2323
2324     /** EMAILS
2325      */
2326     private $e = array();
2327     public function addEmailRedirectFilter($email = null)
2328     {
2329         $this->requireAccounts();
2330         return $this->register_optional($this->e, $email);
2331     }
2332
2333     private $ve = array();
2334     public function addVirtualEmailFilter($email = null)
2335     {
2336         $this->addAliasFilter(self::ALIAS_FORLIFE);
2337         return $this->register_optional($this->ve, $email);
2338     }
2339
2340     const ALIAS_BEST    = 'bestalias';
2341     const ALIAS_FORLIFE = 'forlife';
2342     private $al = array();
2343     public function addAliasFilter($alias = null)
2344     {
2345         $this->requireAccounts();
2346         return $this->register_optional($this->al, $alias);
2347     }
2348
2349     protected function emailJoins()
2350     {
2351         global $globals;
2352         $joins = array();
2353         foreach ($this->e as $sub=>$key) {
2354             if (is_null($key)) {
2355                 $joins['e' . $sub] = PlSqlJoin::left('emails', '$ME.uid = $UID AND $ME.flags != \'filter\'');
2356             } else {
2357                 if (!is_array($key)) {
2358                     $key = array($key);
2359                 }
2360                 $joins['e' . $sub] = PlSqlJoin::left('emails', '$ME.uid = $UID AND $ME.flags != \'filter\'
2361                                                                AND $ME.email IN {?}', $key);
2362             }
2363         }
2364         foreach ($this->al as $sub=>$key) {
2365             if (is_null($key)) {
2366                 $joins['al' . $sub] = PlSqlJoin::left('aliases', '$ME.uid = $UID AND $ME.type IN (\'alias\', \'a_vie\')');
2367             } else if ($key == self::ALIAS_BEST) {
2368                 $joins['al' . $sub] = PlSqlJoin::left('aliases', '$ME.uid = $UID AND $ME.type IN (\'alias\', \'a_vie\') AND  FIND_IN_SET(\'bestalias\', $ME.flags)');
2369             } else if ($key == self::ALIAS_FORLIFE) {
2370                 $joins['al' . $sub] = PlSqlJoin::left('aliases', '$ME.uid = $UID AND $ME.type = \'a_vie\'');
2371             } else {
2372                 if (!is_array($key)) {
2373                     $key = array($key);
2374                 }
2375                 $joins['al' . $sub] = PlSqlJoin::left('aliases', '$ME.uid = $UID AND $ME.type IN (\'alias\', \'a_vie\')
2376                                                                   AND $ME.alias IN {?}', $key);
2377             }
2378         }
2379         foreach ($this->ve as $sub=>$key) {
2380             if (is_null($key)) {
2381                 $joins['v' . $sub] = PlSqlJoin::left('virtual', '$ME.type = \'user\'');
2382             } else {
2383                 if (!is_array($key)) {
2384                     $key = array($key);
2385                 }
2386                 $joins['v' . $sub] = PlSqlJoin::left('virtual', '$ME.type = \'user\' AND $ME.alias IN {?}', $key);
2387             }
2388             $joins['vr' . $sub] = PlSqlJoin::left('virtual_redirect',
2389                                                   '$ME.vid = v' . $sub . '.vid
2390                                                    AND ($ME.redirect IN (CONCAT(al_forlife.alias, \'@\', {?}),
2391                                                                          CONCAT(al_forlife.alias, \'@\', {?}),
2392                                                                          a.email))',
2393                                                   $globals->mail->domain, $globals->mail->domain2);
2394         }
2395         return $joins;
2396     }
2397
2398
2399     /** ADDRESSES
2400      */
2401     private $with_pa = false;
2402     public function addAddressFilter()
2403     {
2404         $this->requireProfiles();
2405         $this->with_pa = true;
2406         return 'pa';
2407     }
2408
2409     private $with_pac = false;
2410     public function addAddressCountryFilter()
2411     {
2412         $this->requireProfiles();
2413         $this->addAddressFilter();
2414         $this->with_pac = true;
2415         return 'gc';
2416     }
2417
2418     private $with_pal = false;
2419     public function addAddressLocalityFilter()
2420     {
2421         $this->requireProfiles();
2422         $this->addAddressFilter();
2423         $this->with_pal = true;
2424         return 'gl';
2425     }
2426
2427     protected function addressJoins()
2428     {
2429         $joins = array();
2430         if ($this->with_pa) {
2431             $joins['pa'] = PlSqlJoin::left('profile_addresses', '$ME.pid = $PID');
2432         }
2433         if ($this->with_pac) {
2434             $joins['gc'] = PlSqlJoin::left('geoloc_countries', '$ME.iso_3166_1_a2 = pa.countryID');
2435         }
2436         if ($this->with_pal) {
2437             $joins['gl'] = PlSqlJoin::left('geoloc_localities', '$ME.id = pa.localityID');
2438         }
2439         return $joins;
2440     }
2441
2442
2443     /** CORPS
2444      */
2445
2446     private $pc = false;
2447     private $pce = array();
2448     private $pcr = false;
2449     public function addCorpsFilter($type)
2450     {
2451         $this->requireProfiles();
2452         $this->pc = true;
2453         if ($type == UFC_Corps::CURRENT) {
2454             $pce['pcec'] = 'current_corpsid';
2455             return 'pcec';
2456         } else if ($type == UFC_Corps::ORIGIN) {
2457             $pce['pceo'] = 'original_corpsid';
2458             return 'pceo';
2459         }
2460     }
2461
2462     public function addCorpsRankFilter()
2463     {
2464         $this->requireProfiles();
2465         $this->pc = true;
2466         $this->pcr = true;
2467         return 'pcr';
2468     }
2469
2470     protected function corpsJoins()
2471     {
2472         $joins = array();
2473         if ($this->pc) {
2474             $joins['pc'] = PlSqlJoin::left('profile_corps', '$ME.pid = $PID');
2475         }
2476         if ($this->pcr) {
2477             $joins['pcr'] = PlSqlJoin::left('profile_corps_rank_enum', '$ME.id = pc.rankid');
2478         }
2479         foreach($this->pce as $sub => $field) {
2480             $joins[$sub] = PlSqlJoin::left('profile_corps_enum', '$ME.id = pc.' . $field);
2481         }
2482         return $joins;
2483     }
2484
2485     /** JOBS
2486      */
2487
2488     const JOB_SECTOR        = 0x0001;
2489     const JOB_SUBSECTOR     = 0x0002;
2490     const JOB_SUBSUBSECTOR  = 0x0004;
2491     const JOB_ALTERNATES    = 0x0008;
2492     const JOB_USERDEFINED   = 0x0010;
2493     const JOB_CV            = 0x0020;
2494
2495     const JOB_SECTORIZATION = 0x000F;
2496     const JOB_ANY           = 0x003F;
2497
2498     /** Joins :
2499      * pj => profile_job
2500      * pje => profile_job_enum
2501      * pjse => profile_job_sector_enum
2502      * pjsse => profile_job_subsector_enum
2503      * pjssse => profile_job_subsubsector_enum
2504      * pja => profile_job_alternates
2505      * pjt => profile_job_terms
2506      */
2507     private $with_pj = false;
2508     private $with_pje = false;
2509     private $with_pjse = false;
2510     private $with_pjsse = false;
2511     private $with_pjssse = false;
2512     private $with_pja = false;
2513     private $with_pjt = 0;
2514
2515     public function addJobFilter()
2516     {
2517         $this->requireProfiles();
2518         $this->with_pj = true;
2519         return 'pj';
2520     }
2521
2522     public function addJobCompanyFilter()
2523     {
2524         $this->addJobFilter();
2525         $this->with_pje = true;
2526         return 'pje';
2527     }
2528
2529     public function addJobSectorizationFilter($type)
2530     {
2531         $this->addJobFilter();
2532         if ($type == self::JOB_SECTOR) {
2533             $this->with_pjse = true;
2534             return 'pjse';
2535         } else if ($type == self::JOB_SUBSECTOR) {
2536             $this->with_pjsse = true;
2537             return 'pjsse';
2538         } else if ($type == self::JOB_SUBSUBSECTOR) {
2539             $this->with_pjssse = true;
2540             return 'pjssse';
2541         } else if ($type == self::JOB_ALTERNATES) {
2542             $this->with_pja = true;
2543             return 'pja';
2544         }
2545     }
2546
2547     /**
2548      * Adds a filter on job terms of profile.
2549      * @param $nb the number of job terms to use
2550      * @return an array of the fields to filter (one for each term).
2551      * Code using this function should used returned field as is (contains table and field name).
2552      */
2553     public function addJobTermsFilter($nb = 1)
2554     {
2555         $this->with_pjt = $nb;
2556         $jobtermstable = array();
2557         for ($i = 1; $i <= $nb; ++$i) {
2558             $jobtermstable[] = 'pjtr_'.$i.'.jtid_1';
2559         }
2560         return $jobtermstable;
2561     }
2562
2563     protected function jobJoins()
2564     {
2565         $joins = array();
2566         if ($this->with_pj) {
2567             $joins['pj'] = PlSqlJoin::left('profile_job', '$ME.pid = $PID');
2568         }
2569         if ($this->with_pje) {
2570             $joins['pje'] = PlSqlJoin::left('profile_job_enum', '$ME.id = pj.jobid');
2571         }
2572         if ($this->with_pjse) {
2573             $joins['pjse'] = PlSqlJoin::left('profile_job_sector_enum', '$ME.id = pj.sectorid');
2574         }
2575         if ($this->with_pjsse) {
2576             $joins['pjsse'] = PlSqlJoin::left('profile_job_subsector_enum', '$ME.id = pj.subsectorid');
2577         }
2578         if ($this->with_pjssse) {
2579             $joins['pjssse'] = PlSqlJoin::left('profile_job_subsubsector_enum', '$ME.id = pj.subsubsectorid');
2580         }
2581         if ($this->with_pja) {
2582             $joins['pja'] = PlSqlJoin::left('profile_job_alternates', '$ME.subsubsectorid = pj.subsubsectorid');
2583         }
2584         if ($this->with_pjt > 0) {
2585             for ($i = 1; $i <= $this->with_pjt; ++$i) {
2586                 $joins['pjt_'.$i] = PlSqlJoin::left('profile_job_term', '$ME.pid = $PID');
2587                 $joins['pjtr_'.$i] = PlSqlJoin::left('profile_job_term_relation', '$ME.jtid_2 = pjt_'.$i.'.jtid');
2588             }
2589         }
2590         return $joins;
2591     }
2592
2593     /** NETWORKING
2594      */
2595
2596     private $with_pnw = false;
2597     public function addNetworkingFilter()
2598     {
2599         $this->requireAccounts();
2600         $this->with_pnw = true;
2601         return 'pnw';
2602     }
2603
2604     protected function networkingJoins()
2605     {
2606         $joins = array();
2607         if ($this->with_pnw) {
2608             $joins['pnw'] = PlSqlJoin::left('profile_networking', '$ME.pid = $PID');
2609         }
2610         return $joins;
2611     }
2612
2613     /** PHONE
2614      */
2615
2616     private $with_ptel = false;
2617
2618     public function addPhoneFilter()
2619     {
2620         $this->requireAccounts();
2621         $this->with_ptel = true;
2622         return 'ptel';
2623     }
2624
2625     protected function phoneJoins()
2626     {
2627         $joins = array();
2628         if ($this->with_ptel) {
2629             $joins['ptel'] = PlSqlJoin::left('profile_phones', '$ME.pid = $PID');
2630         }
2631         return $joins;
2632     }
2633
2634     /** MEDALS
2635      */
2636
2637     private $with_pmed = false;
2638     public function addMedalFilter()
2639     {
2640         $this->requireProfiles();
2641         $this->with_pmed = true;
2642         return 'pmed';
2643     }
2644
2645     protected function medalJoins()
2646     {
2647         $joins = array();
2648         if ($this->with_pmed) {
2649             $joins['pmed'] = PlSqlJoin::left('profile_medals', '$ME.pid = $PID');
2650         }
2651         return $joins;
2652     }
2653
2654     /** MENTORING
2655      */
2656
2657     private $pms = array();
2658     const MENTOR_EXPERTISE  = 1;
2659     const MENTOR_COUNTRY    = 2;
2660     const MENTOR_SECTOR     = 3;
2661
2662     public function addMentorFilter($type)
2663     {
2664         $this->requireAccounts();
2665         switch($type) {
2666         case self::MENTOR_EXPERTISE:
2667             $this->pms['pme'] = 'profile_mentor';
2668             return 'pme';
2669         case self::MENTOR_COUNTRY:
2670             $this->pms['pmc'] = 'profile_mentor_country';
2671             return 'pmc';
2672         case self::MENTOR_SECTOR:
2673             $this->pms['pms'] =  'profile_mentor_sector';
2674             return 'pms';
2675         default:
2676             Platal::page()->killError("Undefined mentor filter.");
2677         }
2678     }
2679
2680     protected function mentorJoins()
2681     {
2682         $joins = array();
2683         foreach ($this->pms as $sub => $tab) {
2684             $joins[$sub] = PlSqlJoin::left($tab, '$ME.pid = $PID');
2685         }
2686         return $joins;
2687     }
2688
2689     /** CONTACTS
2690      */
2691     private $cts = array();
2692     public function addContactFilter($uid = null)
2693     {
2694         $this->requireProfiles();
2695         return $this->register_optional($this->cts, is_null($uid) ? null : 'user_' . $uid);
2696     }
2697
2698     protected function contactJoins()
2699     {
2700         $joins = array();
2701         foreach ($this->cts as $sub=>$key) {
2702             if (is_null($key)) {
2703                 $joins['c' . $sub] = PlSqlJoin::left('contacts', '$ME.contact = $PID');
2704             } else {
2705                 $joins['c' . $sub] = PlSqlJoin::left('contacts', '$ME.uid = {?} AND $ME.contact = $PID', substr($key, 5));
2706             }
2707         }
2708         return $joins;
2709     }
2710
2711
2712     /** CARNET
2713      */
2714     private $wn = array();
2715     public function addWatchRegistrationFilter($uid = null)
2716     {
2717         $this->requireAccounts();
2718         return $this->register_optional($this->wn, is_null($uid) ? null : 'user_' . $uid);
2719     }
2720
2721     private $wp = array();
2722     public function addWatchPromoFilter($uid = null)
2723     {
2724         $this->requireAccounts();
2725         return $this->register_optional($this->wp, is_null($uid) ? null : 'user_' . $uid);
2726     }
2727
2728     private $w = array();
2729     public function addWatchFilter($uid = null)
2730     {
2731         $this->requireAccounts();
2732         return $this->register_optional($this->w, is_null($uid) ? null : 'user_' . $uid);
2733     }
2734
2735     protected function watchJoins()
2736     {
2737         $joins = array();
2738         foreach ($this->w as $sub=>$key) {
2739             if (is_null($key)) {
2740                 $joins['w' . $sub] = PlSqlJoin::left('watch');
2741             } else {
2742                 $joins['w' . $sub] = PlSqlJoin::left('watch', '$ME.uid = {?}', substr($key, 5));
2743             }
2744         }
2745         foreach ($this->wn as $sub=>$key) {
2746             if (is_null($key)) {
2747                 $joins['wn' . $sub] = PlSqlJoin::left('watch_nonins', '$ME.ni_id = $UID');
2748             } else {
2749                 $joins['wn' . $sub] = PlSqlJoin::left('watch_nonins', '$ME.uid = {?} AND $ME.ni_id = $UID', substr($key, 5));
2750             }
2751         }
2752         foreach ($this->wn as $sub=>$key) {
2753             if (is_null($key)) {
2754                 $joins['wn' . $sub] = PlSqlJoin::left('watch_nonins', '$ME.ni_id = $UID');
2755             } else {
2756                 $joins['wn' . $sub] = PlSqlJoin::left('watch_nonins', '$ME.uid = {?} AND $ME.ni_id = $UID', substr($key, 5));
2757             }
2758         }
2759         foreach ($this->wp as $sub=>$key) {
2760             if (is_null($key)) {
2761                 $joins['wp' . $sub] = PlSqlJoin::left('watch_promo');
2762             } else {
2763                 $joins['wp' . $sub] = PlSqlJoin::left('watch_promo', '$ME.uid = {?}', substr($key, 5));
2764             }
2765         }
2766         return $joins;
2767     }
2768
2769
2770     /** PHOTOS
2771      */
2772     private $with_photo;
2773     public function addPhotoFilter()
2774     {
2775         $this->requireProfiles();
2776         $this->with_photo = true;
2777     }
2778
2779     protected function photoJoins()
2780     {
2781         if ($this->with_photo) {
2782             return array('photo' => PlSqlJoin::left('profile_photos', '$ME.pid = $PID'));
2783         } else {
2784             return array();
2785         }
2786     }
2787
2788
2789     /** MARKETING
2790      */
2791     private $with_rm;
2792     public function addMarketingHash()
2793     {
2794         $this->requireAccounts();
2795         $this->with_rm = true;
2796     }
2797
2798     protected function marketingJoins()
2799     {
2800         if ($this->with_rm) {
2801             return array('rm' => PlSqlJoin::left('register_marketing', '$ME.uid = $UID'));
2802         } else {
2803             return array();
2804         }
2805     }
2806 }
2807 // }}}
2808
2809 // {{{ class ProfileFilter
2810 class ProfileFilter extends UserFilter
2811 {
2812     public function get($limit = null)
2813     {
2814         return $this->getProfiles($limit);
2815     }
2816
2817     public function filter(array $profiles, $limit = null)
2818     {
2819         return $this->filterProfiles($profiles, self::defaultLimit($limit));
2820     }
2821
2822     public function getTotalCount()
2823     {
2824         return $this->getTotalProfileCount();
2825     }
2826
2827     public function getGroups()
2828     {
2829         return $this->getPIDGroups();
2830     }
2831 }
2832 // }}}
2833
2834 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
2835 ?>