classes/userfilter/conditions.inc.php

   1 <?php
   2 /***************************************************************************
   3  *  Copyright (C) 2003-2011 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 // {{{ abstract class UserFilterCondition
  23 /** This class describe objects which filter users based
  24  *      on various parameters.
  25  * The parameters of the filter must be given to the constructor.
  26  * The buildCondition function is called by UserFilter when
  27  *     actually building the query. That function must call
  28  *     $uf->addWheteverFilter so that the UserFilter makes
  29  *     adequate joins. It must return the 'WHERE' condition to use
  30  *     with the filter.
  31  */
  32 abstract class UserFilterCondition implements PlFilterCondition
  33 {
  34     const OP_EQUALS     = '=';
  35     const OP_GREATER    = '>';
  36     const OP_NOTGREATER = '<=';
  37     const OP_LESSER     = '<';
  38     const OP_NOTLESSER  = '>=';
  39     const OP_NULL       = 'null';
  40     const OP_NOTNULL    = 'not null';
  41     const OP_CONTAINS   = 'contains';
  42     const OP_PREFIX     = 'prefix';
  43     const OP_SUFFIX     = 'suffix';
  44
  45     protected function buildExport($type)
  46     {
  47         $export = array('type' => $type);
  48         return $export;
  49     }
  50
  51     public function export()
  52     {
  53         throw new Exception("This class is not exportable");
  54     }
  55
  56     public static function comparisonFromXDBWildcard($wildcard)
  57     {
  58         switch ($wildcard) {
  59           case XDB::WILDCARD_EXACT:
  60             return self::OP_EQUALS;
  61           case XDB::WILDCARD_PREFIX:
  62             return self::OP_PREFIX;
  63           case XDB::WILDCARD_SUFFIX:
  64             return self::OP_SUFFIX;
  65           case XDB::WILDCARD_CONTAINS:
  66             return self::OP_CONTAINS;
  67         }
  68         throw new Exception("Unknown wildcard mode: $wildcard");
  69     }
  70
  71     public static function xdbWildcardFromComparison($comparison)
  72     {
  73         if (!self::isStringComparison($comparison)) {
  74             throw new Exception("Unknown string coparison: $comparison");
  75         }
  76         switch ($comparison) {
  77           case self::OP_EQUALS:
  78             return XDB::WILDCARD_EXACT;
  79           case self::OP_PREFIX:
  80             return XDB::WILDCARD_PREFIX;
  81           case self::OP_SUFFIX:
  82             return XDB::WILDCARD_SUFFIX;
  83           case self::OP_CONTAINS:
  84             return XDB::WILDCARD_CONTAINS;
  85         }
  86     }
  87
  88     private static function isNumericComparison($comparison)
  89     {
  90         return $comparison == self::OP_EQUALS
  91             || $comparison == self::OP_GREATER
  92             || $comparison == self::OP_NOTGREATER
  93             || $comparison == self::OP_LESSER
  94             || $comparison == self::OP_NOTLESSER;
  95     }
  96
  97     private static function isStringComparison($comparison)
  98     {
  99         return $comparison == self::OP_EQUALS
 100             || $comparison == self::OP_CONTAINS
 101             || $comparison == self::OP_PREFIX
 102             || $comparison == self::OP_SUFFIX;
 103     }
 104
 105     public static function fromExport(array $export)
 106     {
 107         $export = new PlDict($export);
 108         if (!$export->has('type')) {
 109             throw new Exception("Missing type in export");
 110         }
 111         $type = $export->s('type');
 112         $cond = null;
 113         switch ($type) {
 114           case 'and':
 115           case 'or':
 116           case 'not':
 117           case 'true':
 118           case 'false':
 119             $class = 'pfc_' . $type;
 120             $cond = new $class();
 121             break;
 122
 123           case 'host':
 124             if ($export->has('ip')) {
 125                 $cond = new UFC_Ip($export->s('ip'));
 126             }
 127             break;
 128
 129           case 'comment':
 130             if ($export->has('text') && $export->s('comparison') == self::OP_CONTAINS) {
 131                 $cond = new UFC_Comment($export->s('text'));
 132             }
 133             break;
 134
 135           case 'promo':
 136             if ($export->has('promo') && self::isNumericComparison($export->s('comparison'))) {
 137                 $cond = new UFC_Promo($export->s('comparison'),
 138                                       $export->s('grade', UserFilter::DISPLAY),
 139                                       $export->s('promo'));
 140             }
 141             break;
 142
 143           case 'lastname':
 144           case 'name':
 145           case 'firstname':
 146           case 'nickname':
 147           case 'pseudonym':
 148             if ($export->has('text')) {
 149                 $flag = self::xdbWildcardFromComparison($export->s('comparison'));
 150                 if ($export->b('search_in_variants')) {
 151                     $flag |= UFC_Name::VARIANTS;
 152                 }
 153                 if ($export->b('search_in_particle')) {
 154                     $flag |= UFC_Name::PARTICLE;
 155                 }
 156                 $cond = new UFC_Name($type, $export->s('text'), $flag);
 157             }
 158             break;
 159
 160           case 'account_type':
 161           case 'account_perm':
 162           case 'hrpid':
 163           case 'hruid':
 164             $values = $export->v('values', array());
 165             $class = 'ufc_' . str_replace('_', '', $type);
 166             $cond = new $class($values);
 167             break;
 168
 169           case 'school_id':
 170             $values = $export->v('values', array());
 171             $school_type = $export->s('school_type');
 172             $cond = new UFC_SchoolId($school_type, $values);
 173             break;
 174
 175           case 'has_profile':
 176           case 'has_email_redirect':
 177           case 'has_valid_email':
 178             $class = 'ufc_' . str_replace('_', '', $type);
 179             $cond = new $class();
 180             break;
 181
 182           default:
 183             throw new Exception("Unknown condition type: $type");
 184         }
 185         if (is_null($cond)) {
 186             throw new Exception("Unsupported $type definition");
 187         }
 188         if ($cond instanceof PFC_NChildren) {
 189             $children = $export->v('children', array());
 190             foreach ($children as $child) {
 191                 $cond->addChild(self::fromExport($child));
 192             }
 193         } else if ($cond instanceof PFC_OneChild) {
 194             if ($export->has('child')) {
 195                 $cond->setChild(self::fromExport($export->v('child')));
 196             }
 197         }
 198         return $cond;
 199     }
 200 }
 201 // }}}
 202 // {{{ class UFC_HasProfile
 203 /** Filters users who have a profile
 204  */
 205 class UFC_HasProfile extends UserFilterCondition
 206 {
 207     public function buildCondition(PlFilter $uf)
 208     {
 209         $uf->requireProfiles();
 210         return '$PID IS NOT NULL';
 211     }
 212
 213     public function export()
 214     {
 215         return $this->buildExport('has_profile');
 216     }
 217 }
 218 // }}}
 219 // {{{ class UFC_AccountType
 220 /** Filters users who have one of the given account types
 221  */
 222 class UFC_AccountType extends UserFilterCondition
 223 {
 224     private $types;
 225
 226     public function __construct()
 227     {
 228         $this->types = pl_flatten(func_get_args());
 229     }
 230
 231     public function buildCondition(PlFilter $uf)
 232     {
 233         $uf->requireAccounts();
 234         return XDB::format('a.type IN {?}', $this->types);
 235     }
 236
 237     public function export()
 238     {
 239         $export = $this->buildExport('account_type');
 240         $export['values'] = $this->types;
 241         return $export;
 242     }
 243 }
 244 // }}}
 245 // {{{ class UFC_AccountPerm
 246 /** Filters users who have one of the given permissions
 247  */
 248 class UFC_AccountPerm extends UserFilterCondition
 249 {
 250     private $perms;
 251
 252     public function __construct()
 253     {
 254         $this->perms = pl_flatten(func_get_args());
 255     }
 256
 257     public function buildCondition(PlFilter $uf)
 258     {
 259         $uf->requirePerms();
 260         $conds = array();
 261         foreach ($this->perms as $perm) {
 262             $conds[] = XDB::format('FIND_IN_SET({?}, IF(a.user_perms IS NULL, at.perms,
 263                                                         CONCAT(at.perms, \',\', a.user_perms)))',
 264                                    $perm);
 265         }
 266         if (empty($conds)) {
 267             return self::COND_TRUE;
 268         } else {
 269             return implode(' OR ', $conds);
 270         }
 271     }
 272
 273     public function export()
 274     {
 275         $export = $this->buildExport('account_perm');
 276         $export['values'] = $this->perms;
 277         return $export;
 278     }
 279 }
 280 // }}}
 281 // {{{ class UFC_Hruid
 282 /** Filters users based on their hruid
 283  * @param $val Either an hruid, or a list of those
 284  */
 285 class UFC_Hruid extends UserFilterCondition
 286 {
 287     private $hruids;
 288
 289     public function __construct()
 290     {
 291         $this->hruids = pl_flatten(func_get_args());
 292     }
 293
 294     public function buildCondition(PlFilter $uf)
 295     {
 296         $uf->requireAccounts();
 297         return XDB::format('a.hruid IN {?}', $this->hruids);
 298     }
 299
 300     public function export()
 301     {
 302         $export = $this->buildExport('hruid');
 303         $export['values'] = $this->hruids;
 304         return $export;
 305     }
 306 }
 307 // }}}
 308 // {{{ class UFC_Hrpid
 309 /** Filters users based on the hrpid of their profiles
 310  * @param $val Either an hrpid, or a list of those
 311  */
 312 class UFC_Hrpid extends UserFilterCondition
 313 {
 314     private $hrpids;
 315
 316     public function __construct()
 317     {
 318         $this->hrpids = pl_flatten(func_get_args());
 319     }
 320
 321     public function buildCondition(PlFilter $uf)
 322     {
 323         $uf->requireProfiles();
 324         return XDB::format('p.hrpid IN {?}', $this->hrpids);
 325     }
 326
 327     public function export()
 328     {
 329         $export = $this->buildExport('hrpid');
 330         $export['values'] = $this->hrpids;
 331         return $export;
 332     }
 333 }
 334 // }}}
 335 // {{{ class UFC_HasEmailRedirect
 336 /** Filters users, keeping only those with a valid email redirection (only X.org accounts).
 337  */
 338 class UFC_HasEmailRedirect extends UserFilterCondition
 339 {
 340     public function buildCondition(PlFilter $uf)
 341     {
 342         $sub_redirect = $uf->addActiveEmailRedirectFilter();
 343         return 'rf.redirect IS NOT NULL';
 344     }
 345
 346     public function export()
 347     {
 348         $export = $this->buildExport('has_email_redirect');
 349         return $export;
 350     }
 351 }
 352 // }}}
 353 // {{{ class UFC_HasValidEmail
 354 /** Filters users, keeping only those with a valid email address (all accounts).
 355  */
 356 class UFC_HasValidEmail extends UserFilterCondition
 357 {
 358     public function buildCondition(PlFilter $uf)
 359     {
 360         $sub_redirect = $uf->addEmailRedirectFilter();
 361         $uf->requireAccounts();
 362         return 'ra' . $sub_redirect . '.flags = \'active\' OR a.email IS NOT NULL';
 363     }
 364
 365     public function export()
 366     {
 367         $export = $this->buildExport('has_valid_email');
 368         return $export;
 369     }
 370 }
 371 // }}}
 372 // {{{ class UFC_Ip
 373 /** Filters users based on one of their last IPs
 374  * @param $ip IP from which connection are checked
 375  */
 376 class UFC_Ip extends UserFilterCondition
 377 {
 378     private $ip;
 379
 380     public function __construct($ip)
 381     {
 382         $this->ip = $ip;
 383     }
 384
 385     public function buildCondition(PlFilter $uf)
 386     {
 387         $sub = $uf->addLoggerFilter();
 388         $ip = ip_to_uint($this->ip);
 389         return XDB::format($sub . '.ip = {?} OR ' . $sub . '.forward_ip = {?}', $ip, $ip);
 390     }
 391
 392     public function export()
 393     {
 394         $export = $this->buildExport('host');
 395         $export['ip'] = $this->ip;
 396         return $export;
 397     }
 398 }
 399 // }}}
 400 // {{{ class UFC_Comment
 401 class UFC_Comment extends UserFilterCondition
 402 {
 403     private $text;
 404
 405     public function __construct($text)
 406     {
 407         $this->text = $text;
 408     }
 409
 410     public function buildCondition(PlFilter $uf)
 411     {
 412         $uf->requireProfiles();
 413         return $uf->getVisibilityCondition('p.freetext_pub') . ' AND p.freetext ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->text);
 414     }
 415
 416     public function export()
 417     {
 418         $export = $this->buildExport('comment');
 419         $export['comparison'] = self::OP_CONTAINS;
 420         $export['text'] = $this->text;
 421         return $export;
 422     }
 423 }
 424 // }}}
 425 // {{{ class UFC_Promo
 426 /** Filters users based on promotion
 427  * @param $comparison Comparison operator (>, =, ...)
 428  * @param $grade Formation on which to restrict, UserFilter::DISPLAY for "any formation"
 429  * @param $promo Promotion on which the filter is based
 430  */
 431 class UFC_Promo extends UserFilterCondition
 432 {
 433
 434     private $grade;
 435     private $promo;
 436     private $comparison;
 437
 438     public function __construct($comparison, $grade, $promo)
 439     {
 440         $this->grade = $grade;
 441         $this->comparison = $comparison;
 442         $this->promo = $promo;
 443         if ($this->grade != UserFilter::DISPLAY) {
 444             UserFilter::assertGrade($this->grade);
 445         }
 446         if ($this->grade == UserFilter::DISPLAY && $this->comparison != '=') {
 447             // XXX: we might try to guess the grade from the first char of the promo and forbid only '<= 2004', but allow '<= X2004'
 448             Platal::page()->killError("Il n'est pas possible d'appliquer la comparaison '" . $this->comparison . "' aux promotions sans spécifier de formation (X/M/D)");
 449         }
 450     }
 451
 452     public function buildCondition(PlFilter $uf)
 453     {
 454         if ($this->grade == UserFilter::DISPLAY) {
 455             $sub = $uf->addDisplayFilter();
 456             return XDB::format('pd' . $sub . '.promo ' . $this->comparison . ' {?}', $this->promo);
 457         } else {
 458             $sub = $uf->addEducationFilter(true, $this->grade);
 459             $field = 'pe' . $sub . '.' . UserFilter::promoYear($this->grade);
 460             return $field . ' IS NOT NULL AND ' . $field . ' ' . $this->comparison . ' ' . XDB::format('{?}', $this->promo);
 461         }
 462     }
 463
 464     public function export()
 465     {
 466         $export = $this->buildExport('promo');
 467         $export['comparison'] = $this->comparison;
 468         if ($this->grade != UserFilter::DISPLAY) {
 469             $export['grade'] = $this->grade;
 470         }
 471         $export['promo'] = $this->promo;
 472         return $export;
 473     }
 474 }
 475 // }}}
 476 // {{{ class UFC_SchoolId
 477 /** Filters users based on their shoold identifier
 478  * @param type Parameter type (Xorg, AX, School)
 479  * @param value Array of school ids
 480  */
 481 class UFC_SchoolId extends UserFilterCondition
 482 {
 483     const AX     = 'ax';
 484     const Xorg   = 'xorg';
 485     const School = 'school';
 486
 487     private $type;
 488     private $id;
 489
 490     static public function assertType($type)
 491     {
 492         if ($type != self::AX && $type != self::Xorg && $type != self::School) {
 493             Platal::page()->killError("Type de matricule invalide: $type");
 494         }
 495     }
 496
 497     /** Construct a UFC_SchoolId
 498      * The first argument is the type, all following arguments can be either ids
 499      * or arrays of ids to use:
 500      * $ufc = new UFC_SchoolId(UFC_SchoolId::AX, $id1, $id2, array($id3, $id4));
 501      */
 502     public function __construct($type)
 503     {
 504         $this->type = $type;
 505         $ids = func_get_args();
 506         array_shift($ids);
 507         $this->ids   = pl_flatten($ids);
 508         self::assertType($type);
 509     }
 510
 511     public function buildCondition(PlFilter $uf)
 512     {
 513         $uf->requireProfiles();
 514         $ids = $this->ids;
 515         $type = $this->type;
 516         if ($type == self::School) {
 517             $type = self::Xorg;
 518             $ids  = array_map(array('Profile', 'getXorgId'), $ids);
 519         }
 520         return XDB::format('p.' . $type . '_id IN {?}', $ids);
 521     }
 522
 523     public function export()
 524     {
 525         $export = $this->buildExport('school_id');
 526         $export['school_type'] = $this->type;
 527         $export['values'] = $this->ids;
 528         return $export;
 529     }
 530 }
 531 // }}}
 532 // {{{ class UFC_EducationSchool
 533 /** Filters users by formation
 534  * @param $val The formation to search (either ID or array of IDs)
 535  */
 536 class UFC_EducationSchool extends UserFilterCondition
 537 {
 538     private $val;
 539
 540     public function __construct()
 541     {
 542         $this->val = pl_flatten(func_get_args());
 543     }
 544
 545     public function buildCondition(PlFilter $uf)
 546     {
 547         $sub = $uf->addEducationFilter();
 548         return XDB::format('pe' . $sub . '.eduid IN {?}', $this->val);
 549     }
 550 }
 551 // }}}
 552 // {{{ class UFC_EducationDegree
 553 class UFC_EducationDegree extends UserFilterCondition
 554 {
 555     private $diploma;
 556
 557     public function __construct()
 558     {
 559         $this->diploma = pl_flatten(func_get_args());
 560     }
 561
 562     public function buildCondition(PlFilter $uf)
 563     {
 564         $sub = $uf->addEducationFilter();
 565         return XDB::format('pe' . $sub . '.degreeid IN {?}', $this->diploma);
 566     }
 567 }
 568 // }}}
 569 // {{{ class UFC_EducationField
 570 class UFC_EducationField extends UserFilterCondition
 571 {
 572     private $val;
 573
 574     public function __construct()
 575     {
 576         $this->val = pl_flatten(func_get_args());
 577     }
 578
 579     public function buildCondition(PlFilter $uf)
 580     {
 581         $sub = $uf->addEducationFilter();
 582         return XDB::format('pe' . $sub . '.fieldid IN {?}', $this->val);
 583     }
 584 }
 585 // }}}
 586 // {{{ class UFC_NameInitial
 587 /** Filters users based on sort_name
 588  * @param $initial Initial on which to filter
 589  */
 590 class UFC_NameInitial extends UserFilterCondition
 591 {
 592     private $initial;
 593
 594     public function __construct($initial)
 595     {
 596         $this->initial = $initial;
 597     }
 598
 599     public function buildCondition(PlFilter $uf)
 600     {
 601         $table = 'sort_name';
 602         if ($uf->accountsRequired()) {
 603             $table = Profile::getAccountEquivalentName($table);
 604             $sub = 'a';
 605         } else {
 606             $uf->addDisplayFilter();
 607             $sub = 'pd';
 608         }
 609         return 'SUBSTRING(' . $sub . '.' . $table . ', 1, 1) ' . XDB::formatWildcards(XDB::WILDCARD_PREFIX, $this->initial);
 610     }
 611
 612     public function export()
 613     {
 614         $export = $this->buildExport($this->initial);
 615         return $export;
 616     }
 617 }
 618 // }}}
 619 // {{{ class UFC_NameTokens
 620 /** Selects users based on tokens in their name (for quicksearch)
 621  * @param $tokens An array of tokens to search
 622  * @param $flags Flags the tokens must have (e.g 'public' for public search)
 623  * @param $soundex (bool) Whether those tokens are fulltext or soundex
 624  */
 625 class UFC_NameTokens extends UserFilterCondition
 626 {
 627     /* Flags */
 628     const FLAG_PUBLIC = 'public';
 629
 630     private $tokens;
 631     private $flags;
 632     private $soundex;
 633     private $exact;
 634     private $general_type;
 635
 636     public function __construct($tokens, $flags = array(), $soundex = false, $exact = false, $general_type = '')
 637     {
 638         if (is_array($tokens)) {
 639             $this->tokens = $tokens;
 640         } else {
 641             $this->tokens = array($tokens);
 642         }
 643         if (is_array($flags)) {
 644             $this->flags = $flags;
 645         } else {
 646             $this->flags = array($flags);
 647         }
 648         $this->soundex = $soundex;
 649         $this->exact = $exact;
 650         $this->general_type = $general_type;
 651     }
 652
 653     public function buildCondition(PlFilter $uf)
 654     {
 655         $conds = array();
 656         foreach ($this->tokens as $i => $token) {
 657             $sub = $uf->addNameTokensFilter($token);
 658             if ($this->soundex) {
 659                 $c = XDB::format($sub . '.soundex = {?}', soundex_fr($token));
 660             } else if ($this->exact) {
 661                 $c = XDB::format($sub . '.token = {?}', $token);
 662             } else {
 663                 $c = $sub . '.token ' . XDB::formatWildcards(XDB::WILDCARD_PREFIX, $token);
 664             }
 665             if ($this->flags != null) {
 666                 $c .= XDB::format(' AND ' . $sub . '.flags IN {?}', $this->flags);
 667             }
 668             if ($this->general_type) {
 669                 $c .= XDB::format(' AND ' . $sub . '.general_type = {?}', $this->general_type);
 670             }
 671             $conds[] = $c;
 672         }
 673
 674         return implode(' AND ', $conds);
 675     }
 676 }
 677 // }}}
 678 // {{{ class UFC_Nationality
 679 class UFC_Nationality extends UserFilterCondition
 680 {
 681     private $val;
 682
 683     public function __construct()
 684     {
 685         $this->val = pl_flatten(func_get_args());
 686     }
 687
 688     public function buildCondition(PlFilter $uf)
 689     {
 690         $uf->requireProfiles();
 691         $nat = XDB::formatArray($this->val);
 692         $conds = array(
 693             'p.nationality1 IN ' . $nat,
 694             'p.nationality2 IN ' . $nat,
 695             'p.nationality3 IN ' . $nat,
 696         );
 697         return implode(' OR ', $conds);
 698     }
 699 }
 700 // }}}
 701 // {{{ class UFC_Dead
 702 /** Filters users based on death date
 703  * @param $comparison Comparison operator
 704  * @param $date Date to which death date should be compared (DateTime object, string or timestamp)
 705  */
 706 class UFC_Dead extends UserFilterCondition
 707 {
 708     private $comparison;
 709     private $date;
 710
 711     public function __construct($comparison = null, $date = null)
 712     {
 713         $this->comparison = $comparison;
 714         $this->date = make_datetime($date);
 715     }
 716
 717     public function buildCondition(PlFilter $uf)
 718     {
 719         $uf->requireProfiles();
 720         $str = 'p.deathdate IS NOT NULL';
 721         if (!is_null($this->comparison)) {
 722             $str .= ' AND p.deathdate ' . $this->comparison . ' ' . XDB::format('{?}', $this->date->format('Y-m-d'));
 723         }
 724         return $str;
 725     }
 726 }
 727 // }}}
 728 // {{{ class UFC_Registered
 729 /** Filters users based on registration state
 730  * @param $active Whether we want to use only "active" users (i.e with a valid redirection)
 731  * @param $comparison Comparison operator
 732  * @param $date Date to which users registration date should be compared
 733  */
 734 class UFC_Registered extends UserFilterCondition
 735 {
 736     private $active;
 737     private $comparison;
 738     private $date;
 739
 740     public function __construct($active = false, $comparison = null, $date = null)
 741     {
 742         $this->active = $active;
 743         $this->comparison = $comparison;
 744         $this->date = make_datetime($date);
 745     }
 746
 747     public function buildCondition(PlFilter $uf)
 748     {
 749         $uf->requireAccounts();
 750         if ($this->active) {
 751             $date = '$UID IS NOT NULL AND a.state = \'active\'';
 752         } else {
 753             $date = '$UID IS NOT NULL AND a.state != \'pending\'';
 754         }
 755         if (!is_null($this->comparison)) {
 756             $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'));
 757         }
 758         return $date;
 759     }
 760 }
 761 // }}}
 762 // {{{ class UFC_ProfileUpdated
 763 /** Filters users based on profile update date
 764  * @param $comparison Comparison operator
 765  * @param $date Date to which profile update date must be compared
 766  */
 767 class UFC_ProfileUpdated extends UserFilterCondition
 768 {
 769     private $comparison;
 770     private $date;
 771
 772     public function __construct($comparison = null, $date = null)
 773     {
 774         $this->comparison = $comparison;
 775         $this->date = $date;
 776     }
 777
 778     public function buildCondition(PlFilter $uf)
 779     {
 780         $uf->requireProfiles();
 781         return 'p.last_change ' . $this->comparison . XDB::format(' {?}', date('Y-m-d H:i:s', $this->date));
 782     }
 783 }
 784 // }}}
 785 // {{{ class UFC_Birthday
 786 /** Filters users based on next birthday date
 787  * @param $comparison Comparison operator
 788  * @param $date Date to which users next birthday date should be compared
 789  */
 790 class UFC_Birthday extends UserFilterCondition
 791 {
 792     private $comparison;
 793     private $date;
 794
 795     public function __construct($comparison = null, $date = null)
 796     {
 797         $this->comparison = $comparison;
 798         $this->date = $date;
 799     }
 800
 801     public function buildCondition(PlFilter $uf)
 802     {
 803         $uf->requireProfiles();
 804         return 'p.next_birthday ' . $this->comparison . XDB::format(' {?}', date('Y-m-d', $this->date));
 805     }
 806 }
 807 // }}}
 808 // {{{ class UFC_Sex
 809 /** Filters users based on sex
 810  * @parm $sex One of User::GENDER_MALE or User::GENDER_FEMALE, for selecting users
 811  */
 812 class UFC_Sex extends UserFilterCondition
 813 {
 814     private $sex;
 815     public function __construct($sex)
 816     {
 817         $this->sex = $sex;
 818     }
 819
 820     public function buildCondition(PlFilter $uf)
 821     {
 822         if ($this->sex != User::GENDER_MALE && $this->sex != User::GENDER_FEMALE) {
 823             return self::COND_FALSE;
 824         } else {
 825             $uf->requireProfiles();
 826             return XDB::format('p.sex = {?}', $this->sex == User::GENDER_FEMALE ? 'female' : 'male');
 827         }
 828     }
 829 }
 830 // }}}
 831 // {{{ class UFC_NLSubscribed
 832 /** Filters users based on NL subscription
 833  * @param $nlid NL whose subscribers we are selecting
 834  * @param $issue Select only subscribers who have not yet received that issue
 835  */
 836 class UFC_NLSubscribed extends UserFilterCondition
 837 {
 838     private $nlid;
 839     private $issue_id;
 840     public function __construct($nlid, $issue_id)
 841     {
 842         $this->nlid = $nlid;
 843         $this->issue_id = $issue_id;
 844     }
 845
 846     public function buildCondition(PlFilter $uf)
 847     {
 848         $sub = $uf->addNewsLetterFilter($this->nlid);
 849         return XDB::format($sub . '.last < {?}', $this->issue_id);
 850     }
 851 }
 852 // }}}
 853 // {{{ class UFC_Group
 854 /** Filters users based on group membership
 855  * @param $group Group whose members we are selecting
 856  * @param $anim Whether to restrict selection to animators of that group
 857  */
 858 class UFC_Group extends UserFilterCondition
 859 {
 860     private $group;
 861     private $anim;
 862     public function __construct($group, $anim = false)
 863     {
 864         $this->group = $group;
 865         $this->anim = $anim;
 866     }
 867
 868     public function buildCondition(PlFilter $uf)
 869     {
 870         // Groups are only visible for users with perm 'groups'.
 871         if (!S::user()->checkPerms(User::PERM_GROUPS)) {
 872             return self::COND_FALSE;
 873         }
 874         $sub = $uf->addGroupFilter($this->group);
 875         $where = 'gpm' . $sub . '.perms IS NOT NULL';
 876         if ($this->anim) {
 877             $where .= ' AND gpm' . $sub . '.perms = \'admin\'';
 878         }
 879         return $where;
 880     }
 881 }
 882 // }}}
 883 // {{{ class UFC_GroupFormerMember
 884 /** Filters users based on group former membership
 885  * @param $group Group whose former members we are selecting
 886  */
 887 class UFC_GroupFormerMember extends UserFilterCondition
 888 {
 889     private $group;
 890
 891     public function __construct($group)
 892     {
 893         $this->group = $group;
 894     }
 895
 896     public function buildCondition(PlFilter $uf)
 897     {
 898         // Groups are only visible for users with perm 'groups'.
 899         if (!S::user()->checkPerms(User::PERM_GROUPS)) {
 900             return self::COND_FALSE;
 901         }
 902         $sub = $uf->addGroupFormerMemberFilter();
 903         return XDB::format('gpfm' . $sub . '.asso_id = {?}', $this->group);
 904     }
 905 }
 906 // }}}
 907 // {{{ class UFC_Binet
 908 /** Selects users based on their belonging to a given (list of) binet
 909  * @param $binet either a binet_id or an array of binet_ids
 910  */
 911 class UFC_Binet extends UserFilterCondition
 912 {
 913     private $val;
 914
 915     public function __construct()
 916     {
 917         $this->val = pl_flatten(func_get_args());
 918     }
 919
 920     public function buildCondition(PlFilter $uf)
 921     {
 922         // Binets are private.
 923         if ($uf->getVisibilityLevel() != ProfileVisibility::VIS_PRIVATE) {
 924             return self::COND_TRUE;
 925         }
 926         $sub = $uf->addBinetsFilter();
 927         return XDB::format($sub . '.binet_id IN {?}', $this->val);
 928     }
 929 }
 930 // }}}
 931 // {{{ class UFC_Section
 932 /** Selects users based on section
 933  * @param $section ID of the section
 934  */
 935 class UFC_Section extends UserFilterCondition
 936 {
 937     private $section;
 938
 939     public function __construct()
 940     {
 941         $this->section = pl_flatten(func_get_args());
 942     }
 943
 944     public function buildCondition(PlFilter $uf)
 945     {
 946         // Sections are private.
 947         if ($uf->getVisibilityLevel() != ProfileVisibility::VIS_PRIVATE) {
 948             return self::COND_TRUE;
 949         }
 950         $uf->requireProfiles();
 951         return XDB::format('p.section IN {?}', $this->section);
 952     }
 953 }
 954 // }}}
 955 // {{{ class UFC_Email
 956 /** Filters users based on an email or a list of emails
 957  * @param $emails List of emails whose owner must be selected
 958  */
 959 class UFC_Email extends UserFilterCondition
 960 {
 961     private $emails;
 962     public function __construct()
 963     {
 964         $this->emails = pl_flatten(func_get_args());
 965     }
 966
 967     public function buildCondition(PlFilter $uf)
 968     {
 969         $foreign = array();
 970         $local   = array();
 971         $cond    = array();
 972
 973         if (count($this->emails) == 0) {
 974             return PlFilterCondition::COND_TRUE;
 975         }
 976
 977         foreach ($this->emails as $entry) {
 978             if (User::isForeignEmailAddress($entry)) {
 979                 $foreign[] = $entry;
 980             } else {
 981                 list($local_part, ) = explode('@', $entry);
 982                 $local[] = $local_part;
 983             }
 984         }
 985
 986         if (count($foreign) > 0) {
 987             $sub = $uf->addEmailRedirectFilter($foreign);
 988             $cond[] = XDB::format('ra' . $sub . '.redirect IS NOT NULL OR ra' . $sub . '.redirect IN {?} OR a.email IN {?}', $foreign, $foreign);
 989         }
 990         if (count($local) > 0) {
 991             $sub = $uf->addAliasFilter($local);
 992             $cond[] = 'sa' . $sub . '.email IS NOT NULL';
 993         }
 994         return '(' . implode(') OR (', $cond) . ')';
 995     }
 996 }
 997 // }}}
 998 // {{{ class UFC_Address
 999 abstract class UFC_Address extends UserFilterCondition
1000 {
1001     /** Valid address type
1002      */
1003     const TYPE_HOME     = 1;
1004     const TYPE_PRO      = 2;
1005     const TYPE_NON_HQ   = 3;
1006     const TYPE_HQ       = 4;
1007     const TYPE_ANY      = 7;
1008
1009     /** Text for these types
1010      */
1011     protected static $typetexts = array(
1012         self::TYPE_HOME => 'home',
1013         self::TYPE_PRO  => 'pro',
1014         self::TYPE_HQ   => 'hq',
1015     );
1016
1017     protected $type;
1018
1019     /** Flags for addresses
1020      */
1021     const FLAG_CURRENT = 0x0001;
1022     const FLAG_TEMP    = 0x0002;
1023     const FLAG_SECOND  = 0x0004;
1024     const FLAG_MAIL    = 0x0008;
1025     const FLAG_CEDEX   = 0x0010;
1026
1027     // Binary OR of those flags
1028     const FLAG_ANY     = 0x001F;
1029
1030     /** Text of these flags
1031      */
1032     protected static $flagtexts = array(
1033         self::FLAG_CURRENT => 'current',
1034         self::FLAG_TEMP    => 'temporary',
1035         self::FLAG_SECOND  => 'secondary',
1036         self::FLAG_MAIL    => 'mail',
1037         self::FLAG_CEDEX   => 'cedex',
1038     );
1039
1040     protected $flags;
1041
1042     public function __construct($type = null, $flags = null)
1043     {
1044         $this->type  = $type;
1045         $this->flags = $flags;
1046     }
1047
1048     protected function initConds($sub, $vis_cond)
1049     {
1050         $conds = array($vis_cond);
1051
1052         $types = array();
1053         foreach (self::$typetexts as $flag => $type) {
1054             if ($flag & $this->type) {
1055                 $types[] = $type;
1056             }
1057         }
1058         if (count($types)) {
1059             $conds[] = XDB::format('pa' . $sub . '.type IN {?}', $types);
1060         }
1061
1062         if ($this->flags != self::FLAG_ANY) {
1063             foreach(self::$flagtexts as $flag => $text) {
1064                 if ($flag & $this->flags) {
1065                     $conds[] = 'FIND_IN_SET(' . XDB::format('{?}', $text) . ', pa' . $sub . '.flags)';
1066                 }
1067             }
1068         }
1069         return $conds;
1070     }
1071
1072 }
1073 // }}}
1074 // {{{ class UFC_AddressField
1075 /** Filters users based on their address,
1076  * @param $val Either a code for one of the fields, or an array of such codes
1077  * @param $fieldtype The type of field to look for
1078  * @param $type Filter on address type
1079  * @param $flags Filter on address flags
1080  */
1081 class UFC_AddressComponent extends UFC_Address
1082 {
1083     static $components = array('postal_code', 'locality', 'administrative_area_level_3', 'administrative_area_level_2', 'administrative_area_level_1', 'country');
1084
1085     /** Data of the filter
1086      */
1087     private $val;
1088     private $fieldtype;
1089     private $exact;
1090
1091     public function __construct($val, $fieldtype, $exact = true, $type = null, $flags = self::FLAG_ANY)
1092     {
1093         if (!in_array($fieldtype, self::$components)) {
1094             Platal::page()->killError('Invalid address field type: ' . $this->fieldtype);
1095         }
1096
1097         parent::__construct($type, $flags);
1098         if (!is_array($val)) {
1099             $val = array($val);
1100         }
1101         $this->val       = $val;
1102         $this->fieldtype = $fieldtype;
1103         $this->exact     = $exact;
1104     }
1105
1106     public function buildCondition(PlFilter $uf)
1107     {
1108         $sub = $uf->addAddressFilter($this->fieldtype);
1109         $conds = $this->initConds($sub, $uf->getVisibilityCondition('pa' . $sub . '.pub'));
1110         $conds[] = XDB::format('pace' . $sub . '.id IN {?}', $this->val);
1111
1112         return implode(' AND ', $conds);
1113     }
1114 }
1115 // }}}
1116 // {{{ class UFC_Corps
1117 /** Filters users based on the corps they belong to
1118  * @param $corps Corps we are looking for (abbreviation)
1119  * @param $type Whether we search for original or current corps
1120  */
1121 class UFC_Corps extends UserFilterCondition
1122 {
1123     const CURRENT   = 1;
1124     const ORIGIN    = 2;
1125
1126     private $corps;
1127     private $id;
1128     private $type;
1129
1130     public function __construct($corps, $id = null, $type = self::CURRENT)
1131     {
1132         $this->corps = $corps;
1133         $this->id    = $id;
1134         $this->type  = $type;
1135     }
1136
1137     public function buildCondition(PlFilter $uf)
1138     {
1139         /** Tables shortcuts:
1140          * pc for profile_corps,
1141          * pceo for profile_corps_enum - orginal
1142          * pcec for profile_corps_enum - current
1143          */
1144         $sub = $uf->addCorpsFilter($this->type);
1145         if (is_null($this->id)) {
1146             $cond = $sub . '.abbreviation = ' . $this->corps;
1147         } else {
1148             $cond = $sub . '.id = ' . $this->id;
1149         }
1150         // XXX(x2006barrois): find a way to get rid of that hardcoded
1151         // reference to 'pc'.
1152         $cond .= ' AND ' . $uf->getVisibilityCondition('pc.corps_pub');
1153         return $cond;
1154     }
1155 }
1156 // }}}
1157 // {{{ class UFC_Corps_Rank
1158 /** Filters users based on their rank in the corps
1159  * @param $rank Rank we are looking for (abbreviation)
1160  */
1161 class UFC_Corps_Rank extends UserFilterCondition
1162 {
1163     private $rank;
1164     private $id;
1165
1166     public function __construct($rank, $id = null)
1167     {
1168         $this->rank = $rank;
1169         $this->id   = $id;
1170     }
1171
1172     public function buildCondition(PlFilter $uf)
1173     {
1174         /** Tables shortcuts:
1175          * pc for profile_corps
1176          * pcr for profile_corps_rank
1177          */
1178         $sub = $uf->addCorpsRankFilter();
1179         if (is_null($this->id)) {
1180             $cond = $sub . '.abbreviation = ' . $this->rank;
1181         } else {
1182             $cond = $sub . '.id = ' . $this->id;
1183         }
1184         // XXX(x2006barrois): find a way to get rid of that hardcoded
1185         // reference to 'pc'.
1186         $cond .= ' AND ' . $uf->getVisibilityCondition('pc.corps_pub');
1187         return $cond;
1188     }
1189 }
1190 // }}}
1191 // {{{ class UFC_Job_Company
1192 /** Filters users based on the company they belong to
1193  * @param $type The field being searched (self::JOBID, self::JOBNAME or self::JOBACRONYM)
1194  * @param $value The searched value
1195  */
1196 class UFC_Job_Company extends UserFilterCondition
1197 {
1198     const JOBID = 'id';
1199     const JOBNAME = 'name';
1200     const JOBACRONYM = 'acronym';
1201
1202     private $type;
1203     private $value;
1204
1205     public function __construct($type, $value)
1206     {
1207         $this->assertType($type);
1208         $this->type = $type;
1209         $this->value = $value;
1210     }
1211
1212     private function assertType($type)
1213     {
1214         if ($type != self::JOBID && $type != self::JOBNAME && $type != self::JOBACRONYM) {
1215             Platal::page()->killError("Type de recherche non valide.");
1216         }
1217     }
1218
1219     public function buildCondition(PlFilter $uf)
1220     {
1221         $sub = $uf->addJobCompanyFilter();
1222         $cond  = $sub . '.' . $this->type . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->value);
1223         $jsub = $uf->addJobFilter();
1224         $cond .= ' AND ' . $uf->getVisibilityCondition($jsub . '.pub');
1225         return $cond;
1226     }
1227 }
1228 // }}}
1229 // {{{ class UFC_Job_Terms
1230 /** Filters users based on the job terms they assigned to one of their
1231  * jobs.
1232  * @param $val The ID of the job term, or an array of such IDs
1233  */
1234 class UFC_Job_Terms extends UserFilterCondition
1235 {
1236     private $val;
1237
1238     public function __construct($val)
1239     {
1240         if (!is_array($val)) {
1241             $val = array($val);
1242         }
1243         $this->val = $val;
1244     }
1245
1246     public function buildCondition(PlFilter $uf)
1247     {
1248         $sub = $uf->addJobTermsFilter(count($this->val));
1249         $conditions = array();
1250         foreach ($this->val as $i => $jtid) {
1251             $conditions[] = $sub[$i] . '.jtid_1 = ' . XDB::escape($jtid);
1252         }
1253         $jsub = $uf->addJobFilter();
1254         $conditions[] = $uf->getVisibilityCondition($jsub . '.pub');
1255         return implode(' AND ', $conditions);
1256     }
1257 }
1258 // }}}
1259 // {{{ class UFC_Job_Description
1260 /** Filters users based on their job description
1261  * @param $description The text being searched for
1262  * @param $fields The fields to search for (CV, user-defined)
1263  */
1264 class UFC_Job_Description extends UserFilterCondition
1265 {
1266
1267     private $description;
1268     private $fields;
1269
1270     public function __construct($description, $fields)
1271     {
1272         $this->fields = $fields;
1273         $this->description = $description;
1274     }
1275
1276     public function buildCondition(PlFilter $uf)
1277     {
1278         $conds = array();
1279
1280         $jsub = $uf->addJobFilter();
1281         // CV is private => if only CV requested, and not private,
1282         // don't do anything. Otherwise restrict to standard job visibility.
1283         if ($this->fields == UserFilter::JOB_CV) {
1284            if ($uf->getVisibilityLevel() != ProfileVisibility::VIS_PRIVATE) {
1285                return self::COND_TRUE;
1286            }
1287         }
1288         if ($this->fields & UserFilter::JOB_USERDEFINED) {
1289             $conds[] = $jsub . '.description ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->description);
1290         }
1291         if ($this->fields & UserFilter::JOB_CV && $uf->getVisibilityLevel() == ProfileVisibility::VIS_PRIVATE) {
1292             $uf->requireProfiles();
1293             $conds[] = 'p.cv ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->description);
1294         }
1295         if (count($conds) == 0) {
1296             return self::COND_TRUE;
1297         }
1298         return $uf->getVisibilityCondition($jsub . '.pub') . ' AND ( ' . implode(' OR ', $conds) . ' )';
1299     }
1300 }
1301 // }}}
1302 // {{{ class UFC_Networking
1303 /** Filters users based on network identity (IRC, ...)
1304  * @param $type Type of network (-1 for any)
1305  * @param $value Value to search
1306  */
1307 class UFC_Networking extends UserFilterCondition
1308 {
1309     private $type;
1310     private $value;
1311
1312     public function __construct($type, $value)
1313     {
1314         $this->type = $type;
1315         $this->value = $value;
1316     }
1317
1318     public function buildCondition(PlFilter $uf)
1319     {
1320         $sub = $uf->addNetworkingFilter();
1321         $conds = array();
1322         $conds[] = $uf->getVisibilityCondition($sub . '.pub');
1323         $conds[] = $sub . '.address ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->value);
1324         if ($this->type != -1) {
1325             $conds[] = $sub . '.nwid = ' . XDB::format('{?}', $this->type);
1326         }
1327         return implode(' AND ', $conds);
1328     }
1329 }
1330 // }}}
1331 // {{{ class UFC_Phone
1332 /** Filters users based on their phone number
1333  * @param $num_type Type of number (pro/user/home)
1334  * @param $phone_type Type of phone (fixed/mobile/fax)
1335  * @param $number Phone number
1336  */
1337 class UFC_Phone extends UserFilterCondition
1338 {
1339     const NUM_PRO   = 'pro';
1340     const NUM_USER  = 'user';
1341     const NUM_HOME  = 'address';
1342     const NUM_ANY   = 'any';
1343
1344     const PHONE_FIXED   = 'fixed';
1345     const PHONE_MOBILE  = 'mobile';
1346     const PHONE_FAX     = 'fax';
1347     const PHONE_ANY     = 'any';
1348
1349     private $num_type;
1350     private $phone_type;
1351     private $number;
1352
1353     public function __construct($number, $num_type = self::NUM_ANY, $phone_type = self::PHONE_ANY)
1354     {
1355         $phone = new Phone(array('display' => $number));
1356         $phone->format();
1357         $this->number = $phone->search;
1358         $this->num_type = $num_type;
1359         $this->phone_type = $phone_type;
1360     }
1361
1362     public function buildCondition(PlFilter $uf)
1363     {
1364         $sub = $uf->addPhoneFilter();
1365         $conds = array();
1366
1367         $conds[] = $uf->getVisibilityCondition($sub . '.pub');
1368
1369         $conds[] = $sub . '.search_tel = ' . XDB::format('{?}', $this->number);
1370         if ($this->num_type != self::NUM_ANY) {
1371             $conds[] = $sub . '.link_type = ' . XDB::format('{?}', $this->num_type);
1372         }
1373         if ($this->phone_type != self::PHONE_ANY) {
1374             $conds[] = $sub . '.tel_type = ' . XDB::format('{?}', $this->phone_type);
1375         }
1376         return implode(' AND ', $conds);
1377     }
1378 }
1379 // }}}
1380 // {{{ class UFC_Medal
1381 /** Filters users based on their medals
1382  * @param $medal ID of the medal
1383  * @param $grade Grade of the medal (null for 'any')
1384  */
1385 class UFC_Medal extends UserFilterCondition
1386 {
1387     private $medal;
1388     private $grade;
1389
1390     public function __construct($medal, $grade = null)
1391     {
1392         $this->medal = $medal;
1393         $this->grade = $grade;
1394     }
1395
1396     public function buildCondition(PlFilter $uf)
1397     {
1398         $conds = array();
1399
1400         // This will require profiles => table 'p' will be available.
1401         $sub = $uf->addMedalFilter();
1402
1403         $conds[] = $uf->getVisibilityCondition('p.medals_pub');
1404
1405         $conds[] = $sub . '.mid = ' . XDB::format('{?}', $this->medal);
1406         if ($this->grade != null) {
1407             $conds[] = $sub . '.gid = ' . XDB::format('{?}', $this->grade);
1408         }
1409         return implode(' AND ', $conds);
1410     }
1411 }
1412 // }}}
1413 // {{{ class UFC_Photo
1414 /** Filters profiles with photo
1415  */
1416 class UFC_Photo extends UserFilterCondition
1417 {
1418     public function buildCondition(PlFilter $uf)
1419     {
1420         $sub = $uf->addPhotoFilter();
1421         return $sub . '.attach IS NOT NULL AND ' . $uf->getVisibilityCondition($sub . '.pub');
1422     }
1423 }
1424 // }}}
1425 // {{{ class UFC_Mentor
1426 class UFC_Mentor extends UserFilterCondition
1427 {
1428     public function buildCondition(PlFilter $uf)
1429     {
1430         $sub = $uf->addMentorFilter(UserFilter::MENTOR);
1431         return $sub . '.expertise IS NOT NULL';
1432     }
1433 }
1434 // }}}
1435 // {{{ class UFC_Mentor_Expertise
1436 /** Filters users by mentoring expertise
1437  * @param $expertise Domain of expertise
1438  */
1439 class UFC_Mentor_Expertise extends UserFilterCondition
1440 {
1441     private $expertise;
1442
1443     public function __construct($expertise)
1444     {
1445         $this->expertise = $expertise;
1446     }
1447
1448     public function buildCondition(PlFilter $uf)
1449     {
1450         $sub = $uf->addMentorFilter(UserFilter::MENTOR_EXPERTISE);
1451         return $sub . '.expertise ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->expertise);
1452     }
1453 }
1454 // }}}
1455 // {{{ class UFC_Mentor_Country
1456 /** Filters users by mentoring country
1457  * @param $country Two-letters code of country being searched
1458  */
1459 class UFC_Mentor_Country extends UserFilterCondition
1460 {
1461     private $country;
1462
1463     public function __construct()
1464     {
1465         $this->country = pl_flatten(func_get_args());
1466     }
1467
1468     public function buildCondition(PlFilter $uf)
1469     {
1470         $sub = $uf->addMentorFilter(UserFilter::MENTOR_COUNTRY);
1471         return $sub . '.country IN ' . XDB::format('{?}', $this->country);
1472     }
1473 }
1474 // }}}
1475 // {{{ class UFC_Mentor_Terms
1476 /** Filters users based on the job terms they used in mentoring.
1477  * @param $val The ID of the job term, or an array of such IDs
1478  */
1479 class UFC_Mentor_Terms extends UserFilterCondition
1480 {
1481     private $val;
1482
1483     public function __construct($val)
1484     {
1485         $this->val = $val;
1486     }
1487
1488     public function buildCondition(PlFilter $uf)
1489     {
1490         $sub = $uf->addMentorFilter(UserFilter::MENTOR_TERM);
1491         return $sub . '.jtid_1 = ' . XDB::escape($this->val);
1492     }
1493 }
1494 // }}}
1495 // {{{ class UFC_UserRelated
1496 /** Filters users based on a relation toward a user
1497  * @param $user User to which searched users are related
1498  */
1499 abstract class UFC_UserRelated extends UserFilterCondition
1500 {
1501     protected $user;
1502     public function __construct(PlUser $user)
1503     {
1504         $this->user =& $user;
1505     }
1506 }
1507 // }}}
1508 // {{{ class UFC_DeltaTen
1509 class UFC_DeltaTen extends UserFilterCondition
1510 {
1511     public function buildCondition(PlFilter $uf)
1512     {
1513         $sub = $uf->addDeltaTenFilter(UserFilter::DELTATEN);
1514         return $sub . '.message IS NOT NULL';
1515     }
1516 }
1517 // }}}
1518 // {{{ class UFC_DeltaTen_Message
1519 /** Filters users by deltaten message
1520  * @param $message Message for the DeltaTen program
1521  */
1522 class UFC_DeltaTen_Message extends UserFilterCondition
1523 {
1524     private $message;
1525
1526     public function __construct($message)
1527     {
1528         $this->message = $message;
1529     }
1530
1531     public function buildCondition(PlFilter $uf)
1532     {
1533         $sub = $uf->addDeltaTenFilter(UserFilter::DELTATEN_MESSAGE);
1534         return $sub . '.message ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->message);
1535     }
1536 }
1537 // }}}
1538 // {{{ class UFC_Contact
1539 /** Filters users who belong to selected user's contacts
1540  */
1541 class UFC_Contact extends UFC_UserRelated
1542 {
1543     public function buildCondition(PlFilter $uf)
1544     {
1545         $sub = $uf->addContactFilter($this->user->id());
1546         return 'c' . $sub . '.contact IS NOT NULL';
1547     }
1548 }
1549 // }}}
1550 // {{{ class UFC_WatchRegistration
1551 /** Filters users being watched by selected user
1552  */
1553 class UFC_WatchRegistration extends UFC_UserRelated
1554 {
1555     public function buildCondition(PlFilter $uf)
1556     {
1557         if (!$this->user->watchType('registration')) {
1558             return PlFilterCondition::COND_FALSE;
1559         }
1560         $uids = $this->user->watchUsers();
1561         if (count($uids) == 0) {
1562             return PlFilterCondition::COND_FALSE;
1563         } else {
1564             return XDB::format('$UID IN {?}', $uids);
1565         }
1566     }
1567 }
1568 // }}}
1569 // {{{ class UFC_WatchPromo
1570 /** Filters users belonging to a promo watched by selected user
1571  * @param $user Selected user (the one watching promo)
1572  * @param $grade Formation the user is watching
1573  */
1574 class UFC_WatchPromo extends UFC_UserRelated
1575 {
1576     private $grade;
1577     public function __construct(PlUser $user, $grade = UserFilter::GRADE_ING)
1578     {
1579         parent::__construct($user);
1580         $this->grade = $grade;
1581     }
1582
1583     public function buildCondition(PlFilter $uf)
1584     {
1585         $promos = $this->user->watchPromos();
1586         if (count($promos) == 0) {
1587             return PlFilterCondition::COND_FALSE;
1588         } else {
1589             $sube = $uf->addEducationFilter(true, $this->grade);
1590             $field = 'pe' . $sube . '.' . UserFilter::promoYear($this->grade);
1591             return XDB::format($field . ' IN {?}', $promos);
1592         }
1593     }
1594 }
1595 // }}}
1596 // {{{ class UFC_WatchContact
1597 /** Filters users watched by selected user
1598  */
1599 class UFC_WatchContact extends UFC_Contact
1600 {
1601     public function buildCondition(PlFilter $uf)
1602     {
1603         if (!$this->user->watchContacts()) {
1604             return PlFilterCondition::COND_FALSE;
1605         }
1606         return parent::buildCondition($uf);
1607     }
1608 }
1609 // }}}
1610 // {{{ class UFC_MarketingHash
1611 /** Filters users using the hash generated
1612  * to send marketing emails to him.
1613  */
1614 class UFC_MarketingHash extends UserFilterCondition
1615 {
1616     private $hash;
1617
1618     public function __construct($hash)
1619     {
1620         $this->hash = $hash;
1621     }
1622
1623     public function buildCondition(PlFilter $uf)
1624     {
1625         $table = $uf->addMarketingHash();
1626         return XDB::format('rm.hash = {?}', $this->hash);
1627     }
1628 }
1629 // }}}
1630
1631 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
1632 ?>