classes/userfilter.php

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