classes/userfilter.php

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