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_Name
 587 /** Filters users based on name
 588  * @param $type Type of name field on which filtering is done (firstname, lastname...)
 589  * @param $text Text on which to filter
 590  * @param $mode Flag indicating search type (prefix, suffix, with particule...)
 591  */
 592 class UFC_Name extends UserFilterCondition
 593 {
 594     const EXACT    = XDB::WILDCARD_EXACT;    // 0x000
 595     const PREFIX   = XDB::WILDCARD_PREFIX;   // 0x001
 596     const SUFFIX   = XDB::WILDCARD_SUFFIX;   // 0x002
 597     const CONTAINS = XDB::WILDCARD_CONTAINS; // 0x003
 598     const PARTICLE = 0x004;
 599     const VARIANTS = 0x008;
 600
 601     private $type;
 602     private $text;
 603     private $mode;
 604
 605     public function __construct($type, $text, $mode)
 606     {
 607         $this->type = $type;
 608         $this->text = $text;
 609         $this->mode = $mode;
 610     }
 611
 612     private function buildNameQuery($type, $variant, $where, UserFilter $uf)
 613     {
 614         $sub = $uf->addNameFilter($type, $variant);
 615         return str_replace('$ME', 'pn' . $sub, $where);
 616     }
 617
 618     public function buildCondition(PlFilter $uf)
 619     {
 620         $left = '$ME.name';
 621         if (($this->mode & self::PARTICLE) == self::PARTICLE) {
 622             $left = 'CONCAT($ME.particle, \' \', $ME.name)';
 623         }
 624         $right = XDB::formatWildcards($this->mode & self::CONTAINS, $this->text);
 625
 626         $cond = $left . $right;
 627         $conds = array($this->buildNameQuery($this->type, null, $cond, $uf));
 628         if (($this->mode & self::VARIANTS) != 0 && isset(Profile::$name_variants[$this->type])) {
 629             foreach (Profile::$name_variants[$this->type] as $var) {
 630                 $conds[] = $this->buildNameQuery($this->type, $var, $cond, $uf);
 631             }
 632         }
 633         return implode(' OR ', $conds);
 634     }
 635
 636     public function export()
 637     {
 638         $export = $this->buildExport($this->type);
 639         if ($this->mode & self::VARIANTS) {
 640             $export['search_in_variants'] = true;
 641         }
 642         if ($this->mode & self::PARTICLE) {
 643             $export['search_in_particle'] = true;
 644         }
 645         $export['comparison'] = self::comparisonFromXDBWildcard($this->mode & 0x3);
 646         $export['text'] = $this->text;
 647         return $export;
 648     }
 649 }
 650 // }}}
 651 // {{{ class UFC_NameTokens
 652 /** Selects users based on tokens in their name (for quicksearch)
 653  * @param $tokens An array of tokens to search
 654  * @param $flags Flags the tokens must have (e.g 'public' for public search)
 655  * @param $soundex (bool) Whether those tokens are fulltext or soundex
 656  */
 657 class UFC_NameTokens extends UserFilterCondition
 658 {
 659     /* Flags */
 660     const FLAG_PUBLIC = 'public';
 661
 662     private $tokens;
 663     private $flags;
 664     private $soundex;
 665     private $exact;
 666     private $general_type;
 667
 668     public function __construct($tokens, $flags = array(), $soundex = false, $exact = false, $general_type = '')
 669     {
 670         if (is_array($tokens)) {
 671             $this->tokens = $tokens;
 672         } else {
 673             $this->tokens = array($tokens);
 674         }
 675         if (is_array($flags)) {
 676             $this->flags = $flags;
 677         } else {
 678             $this->flags = array($flags);
 679         }
 680         $this->soundex = $soundex;
 681         $this->exact = $exact;
 682         $this->general_type = $general_type;
 683     }
 684
 685     public function buildCondition(PlFilter $uf)
 686     {
 687         $conds = array();
 688         foreach ($this->tokens as $i => $token) {
 689             $sub = $uf->addNameTokensFilter($token);
 690             if ($this->soundex) {
 691                 $c = XDB::format($sub . '.soundex = {?}', soundex_fr($token));
 692             } else if ($this->exact) {
 693                 $c = XDB::format($sub . '.token = {?}', $token);
 694             } else {
 695                 $c = $sub . '.token ' . XDB::formatWildcards(XDB::WILDCARD_PREFIX, $token);
 696             }
 697             if ($this->flags != null) {
 698                 $c .= XDB::format(' AND ' . $sub . '.flags IN {?}', $this->flags);
 699             }
 700             if ($this->general_type) {
 701                 $c .= XDB::format(' AND ' . $sub . '.general_type = {?}', $this->general_type);
 702             }
 703             $conds[] = $c;
 704         }
 705
 706         return implode(' AND ', $conds);
 707     }
 708 }
 709 // }}}
 710 // {{{ class UFC_Nationality
 711 class UFC_Nationality extends UserFilterCondition
 712 {
 713     private $val;
 714
 715     public function __construct()
 716     {
 717         $this->val = pl_flatten(func_get_args());
 718     }
 719
 720     public function buildCondition(PlFilter $uf)
 721     {
 722         $uf->requireProfiles();
 723         $nat = XDB::formatArray($this->val);
 724         $conds = array(
 725             'p.nationality1 IN ' . $nat,
 726             'p.nationality2 IN ' . $nat,
 727             'p.nationality3 IN ' . $nat,
 728         );
 729         return implode(' OR ', $conds);
 730     }
 731 }
 732 // }}}
 733 // {{{ class UFC_Dead
 734 /** Filters users based on death date
 735  * @param $comparison Comparison operator
 736  * @param $date Date to which death date should be compared (DateTime object, string or timestamp)
 737  */
 738 class UFC_Dead extends UserFilterCondition
 739 {
 740     private $comparison;
 741     private $date;
 742
 743     public function __construct($comparison = null, $date = null)
 744     {
 745         $this->comparison = $comparison;
 746         $this->date = make_datetime($date);
 747     }
 748
 749     public function buildCondition(PlFilter $uf)
 750     {
 751         $uf->requireProfiles();
 752         $str = 'p.deathdate IS NOT NULL';
 753         if (!is_null($this->comparison)) {
 754             $str .= ' AND p.deathdate ' . $this->comparison . ' ' . XDB::format('{?}', $this->date->format('Y-m-d'));
 755         }
 756         return $str;
 757     }
 758 }
 759 // }}}
 760 // {{{ class UFC_Registered
 761 /** Filters users based on registration state
 762  * @param $active Whether we want to use only "active" users (i.e with a valid redirection)
 763  * @param $comparison Comparison operator
 764  * @param $date Date to which users registration date should be compared
 765  */
 766 class UFC_Registered extends UserFilterCondition
 767 {
 768     private $active;
 769     private $comparison;
 770     private $date;
 771
 772     public function __construct($active = false, $comparison = null, $date = null)
 773     {
 774         $this->active = $active;
 775         $this->comparison = $comparison;
 776         $this->date = make_datetime($date);
 777     }
 778
 779     public function buildCondition(PlFilter $uf)
 780     {
 781         $uf->requireAccounts();
 782         if ($this->active) {
 783             $date = '$UID IS NOT NULL AND a.state = \'active\'';
 784         } else {
 785             $date = '$UID IS NOT NULL AND a.state != \'pending\'';
 786         }
 787         if (!is_null($this->comparison)) {
 788             $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'));
 789         }
 790         return $date;
 791     }
 792 }
 793 // }}}
 794 // {{{ class UFC_ProfileUpdated
 795 /** Filters users based on profile update date
 796  * @param $comparison Comparison operator
 797  * @param $date Date to which profile update date must be compared
 798  */
 799 class UFC_ProfileUpdated extends UserFilterCondition
 800 {
 801     private $comparison;
 802     private $date;
 803
 804     public function __construct($comparison = null, $date = null)
 805     {
 806         $this->comparison = $comparison;
 807         $this->date = $date;
 808     }
 809
 810     public function buildCondition(PlFilter $uf)
 811     {
 812         $uf->requireProfiles();
 813         return 'p.last_change ' . $this->comparison . XDB::format(' {?}', date('Y-m-d H:i:s', $this->date));
 814     }
 815 }
 816 // }}}
 817 // {{{ class UFC_Birthday
 818 /** Filters users based on next birthday date
 819  * @param $comparison Comparison operator
 820  * @param $date Date to which users next birthday date should be compared
 821  */
 822 class UFC_Birthday extends UserFilterCondition
 823 {
 824     private $comparison;
 825     private $date;
 826
 827     public function __construct($comparison = null, $date = null)
 828     {
 829         $this->comparison = $comparison;
 830         $this->date = $date;
 831     }
 832
 833     public function buildCondition(PlFilter $uf)
 834     {
 835         $uf->requireProfiles();
 836         return 'p.next_birthday ' . $this->comparison . XDB::format(' {?}', date('Y-m-d', $this->date));
 837     }
 838 }
 839 // }}}
 840 // {{{ class UFC_Sex
 841 /** Filters users based on sex
 842  * @parm $sex One of User::GENDER_MALE or User::GENDER_FEMALE, for selecting users
 843  */
 844 class UFC_Sex extends UserFilterCondition
 845 {
 846     private $sex;
 847     public function __construct($sex)
 848     {
 849         $this->sex = $sex;
 850     }
 851
 852     public function buildCondition(PlFilter $uf)
 853     {
 854         if ($this->sex != User::GENDER_MALE && $this->sex != User::GENDER_FEMALE) {
 855             return self::COND_FALSE;
 856         } else {
 857             $uf->requireProfiles();
 858             return XDB::format('p.sex = {?}', $this->sex == User::GENDER_FEMALE ? 'female' : 'male');
 859         }
 860     }
 861 }
 862 // }}}
 863 // {{{ class UFC_NLSubscribed
 864 /** Filters users based on NL subscription
 865  * @param $nlid NL whose subscribers we are selecting
 866  * @param $issue Select only subscribers who have not yet received that issue
 867  */
 868 class UFC_NLSubscribed extends UserFilterCondition
 869 {
 870     private $nlid;
 871     private $issue_id;
 872     public function __construct($nlid, $issue_id)
 873     {
 874         $this->nlid = $nlid;
 875         $this->issue_id = $issue_id;
 876     }
 877
 878     public function buildCondition(PlFilter $uf)
 879     {
 880         $sub = $uf->addNewsLetterFilter($this->nlid);
 881         return XDB::format($sub . '.last < {?}', $this->issue_id);
 882     }
 883 }
 884 // }}}
 885 // {{{ class UFC_Group
 886 /** Filters users based on group membership
 887  * @param $group Group whose members we are selecting
 888  * @param $anim Whether to restrict selection to animators of that group
 889  */
 890 class UFC_Group extends UserFilterCondition
 891 {
 892     private $group;
 893     private $anim;
 894     public function __construct($group, $anim = false)
 895     {
 896         $this->group = $group;
 897         $this->anim = $anim;
 898     }
 899
 900     public function buildCondition(PlFilter $uf)
 901     {
 902         // Groups are only visible for users with perm 'groups'.
 903         if (!S::user()->checkPerms(User::PERM_GROUPS)) {
 904             return self::COND_FALSE;
 905         }
 906         $sub = $uf->addGroupFilter($this->group);
 907         $where = 'gpm' . $sub . '.perms IS NOT NULL';
 908         if ($this->anim) {
 909             $where .= ' AND gpm' . $sub . '.perms = \'admin\'';
 910         }
 911         return $where;
 912     }
 913 }
 914 // }}}
 915 // {{{ class UFC_GroupFormerMember
 916 /** Filters users based on group former membership
 917  * @param $group Group whose former members we are selecting
 918  */
 919 class UFC_GroupFormerMember extends UserFilterCondition
 920 {
 921     private $group;
 922
 923     public function __construct($group)
 924     {
 925         $this->group = $group;
 926     }
 927
 928     public function buildCondition(PlFilter $uf)
 929     {
 930         // Groups are only visible for users with perm 'groups'.
 931         if (!S::user()->checkPerms(User::PERM_GROUPS)) {
 932             return self::COND_FALSE;
 933         }
 934         $sub = $uf->addGroupFormerMemberFilter();
 935         return XDB::format('gpfm' . $sub . '.asso_id = {?}', $this->group);
 936     }
 937 }
 938 // }}}
 939 // {{{ class UFC_Binet
 940 /** Selects users based on their belonging to a given (list of) binet
 941  * @param $binet either a binet_id or an array of binet_ids
 942  */
 943 class UFC_Binet extends UserFilterCondition
 944 {
 945     private $val;
 946
 947     public function __construct()
 948     {
 949         $this->val = pl_flatten(func_get_args());
 950     }
 951
 952     public function buildCondition(PlFilter $uf)
 953     {
 954         // Binets are private.
 955         if ($uf->getVisibilityLevel() != ProfileVisibility::VIS_PRIVATE) {
 956             return self::COND_TRUE;
 957         }
 958         $sub = $uf->addBinetsFilter();
 959         return XDB::format($sub . '.binet_id IN {?}', $this->val);
 960     }
 961 }
 962 // }}}
 963 // {{{ class UFC_Section
 964 /** Selects users based on section
 965  * @param $section ID of the section
 966  */
 967 class UFC_Section extends UserFilterCondition
 968 {
 969     private $section;
 970
 971     public function __construct()
 972     {
 973         $this->section = pl_flatten(func_get_args());
 974     }
 975
 976     public function buildCondition(PlFilter $uf)
 977     {
 978         // Sections are private.
 979         if ($uf->getVisibilityLevel() != ProfileVisibility::VIS_PRIVATE) {
 980             return self::COND_TRUE;
 981         }
 982         $uf->requireProfiles();
 983         return XDB::format('p.section IN {?}', $this->section);
 984     }
 985 }
 986 // }}}
 987 // {{{ class UFC_Email
 988 /** Filters users based on an email or a list of emails
 989  * @param $emails List of emails whose owner must be selected
 990  */
 991 class UFC_Email extends UserFilterCondition
 992 {
 993     private $emails;
 994     public function __construct()
 995     {
 996         $this->emails = pl_flatten(func_get_args());
 997     }
 998
 999     public function buildCondition(PlFilter $uf)
1000     {
1001         $foreign = array();
1002         $local   = array();
1003         $cond    = array();
1004
1005         if (count($this->emails) == 0) {
1006             return PlFilterCondition::COND_TRUE;
1007         }
1008
1009         foreach ($this->emails as $entry) {
1010             if (User::isForeignEmailAddress($entry)) {
1011                 $foreign[] = $entry;
1012             } else {
1013                 list($local_part, ) = explode('@', $entry);
1014                 $local[] = $local_part;
1015             }
1016         }
1017
1018         if (count($foreign) > 0) {
1019             $sub = $uf->addEmailRedirectFilter($foreign);
1020             $cond[] = XDB::format('ra' . $sub . '.redirect IS NOT NULL OR ra' . $sub . '.redirect IN {?} OR a.email IN {?}', $foreign, $foreign);
1021         }
1022         if (count($local) > 0) {
1023             $sub = $uf->addAliasFilter($local);
1024             $cond[] = 'sa' . $sub . '.email IS NOT NULL';
1025         }
1026         return '(' . implode(') OR (', $cond) . ')';
1027     }
1028 }
1029 // }}}
1030 // {{{ class UFC_Address
1031 abstract class UFC_Address extends UserFilterCondition
1032 {
1033     /** Valid address type
1034      */
1035     const TYPE_HOME     = 1;
1036     const TYPE_PRO      = 2;
1037     const TYPE_NON_HQ   = 3;
1038     const TYPE_HQ       = 4;
1039     const TYPE_ANY      = 7;
1040
1041     /** Text for these types
1042      */
1043     protected static $typetexts = array(
1044         self::TYPE_HOME => 'home',
1045         self::TYPE_PRO  => 'pro',
1046         self::TYPE_HQ   => 'hq',
1047     );
1048
1049     protected $type;
1050
1051     /** Flags for addresses
1052      */
1053     const FLAG_CURRENT = 0x0001;
1054     const FLAG_TEMP    = 0x0002;
1055     const FLAG_SECOND  = 0x0004;
1056     const FLAG_MAIL    = 0x0008;
1057     const FLAG_CEDEX   = 0x0010;
1058
1059     // Binary OR of those flags
1060     const FLAG_ANY     = 0x001F;
1061
1062     /** Text of these flags
1063      */
1064     protected static $flagtexts = array(
1065         self::FLAG_CURRENT => 'current',
1066         self::FLAG_TEMP    => 'temporary',
1067         self::FLAG_SECOND  => 'secondary',
1068         self::FLAG_MAIL    => 'mail',
1069         self::FLAG_CEDEX   => 'cedex',
1070     );
1071
1072     protected $flags;
1073
1074     public function __construct($type = null, $flags = null)
1075     {
1076         $this->type  = $type;
1077         $this->flags = $flags;
1078     }
1079
1080     protected function initConds($sub, $vis_cond)
1081     {
1082         $conds = array($vis_cond);
1083
1084         $types = array();
1085         foreach (self::$typetexts as $flag => $type) {
1086             if ($flag & $this->type) {
1087                 $types[] = $type;
1088             }
1089         }
1090         if (count($types)) {
1091             $conds[] = XDB::format('pa' . $sub . '.type IN {?}', $types);
1092         }
1093
1094         if ($this->flags != self::FLAG_ANY) {
1095             foreach(self::$flagtexts as $flag => $text) {
1096                 if ($flag & $this->flags) {
1097                     $conds[] = 'FIND_IN_SET(' . XDB::format('{?}', $text) . ', pa' . $sub . '.flags)';
1098                 }
1099             }
1100         }
1101         return $conds;
1102     }
1103
1104 }
1105 // }}}
1106 // {{{ class UFC_AddressField
1107 /** Filters users based on their address,
1108  * @param $val Either a code for one of the fields, or an array of such codes
1109  * @param $fieldtype The type of field to look for
1110  * @param $type Filter on address type
1111  * @param $flags Filter on address flags
1112  */
1113 class UFC_AddressComponent extends UFC_Address
1114 {
1115     static $components = array('sublocality', 'locality', 'administrative_area_level_3', 'administrative_area_level_2', 'administrative_area_level_1', 'country');
1116
1117     /** Data of the filter
1118      */
1119     private $val;
1120     private $fieldtype;
1121     private $exact;
1122
1123     public function __construct($val, $fieldtype, $exact = true, $type = null, $flags = self::FLAG_ANY)
1124     {
1125         if (!in_array($fieldtype, self::$components)) {
1126             Platal::page()->killError('Invalid address field type: ' . $this->fieldtype);
1127         }
1128
1129         parent::__construct($type, $flags);
1130         if (!is_array($val)) {
1131             $val = array($val);
1132         }
1133         $this->val       = $val;
1134         $this->fieldtype = $fieldtype;
1135         $this->exact     = $exact;
1136     }
1137
1138     public function buildCondition(PlFilter $uf)
1139     {
1140         $sub = $uf->addAddressFilter($this->fieldtype);
1141         $conds = $this->initConds($sub, $uf->getVisibilityCondition('pa' . $sub . '.pub'));
1142         $conds[] = XDB::format('pace' . $sub . '.id IN {?}', $this->val);
1143
1144         return implode(' AND ', $conds);
1145     }
1146 }
1147 // }}}
1148 // {{{ class UFC_Corps
1149 /** Filters users based on the corps they belong to
1150  * @param $corps Corps we are looking for (abbreviation)
1151  * @param $type Whether we search for original or current corps
1152  */
1153 class UFC_Corps extends UserFilterCondition
1154 {
1155     const CURRENT   = 1;
1156     const ORIGIN    = 2;
1157
1158     private $corps;
1159     private $id;
1160     private $type;
1161
1162     public function __construct($corps, $id = null, $type = self::CURRENT)
1163     {
1164         $this->corps = $corps;
1165         $this->id    = $id;
1166         $this->type  = $type;
1167     }
1168
1169     public function buildCondition(PlFilter $uf)
1170     {
1171         /** Tables shortcuts:
1172          * pc for profile_corps,
1173          * pceo for profile_corps_enum - orginal
1174          * pcec for profile_corps_enum - current
1175          */
1176         $sub = $uf->addCorpsFilter($this->type);
1177         if (is_null($this->id)) {
1178             $cond = $sub . '.abbreviation = ' . $this->corps;
1179         } else {
1180             $cond = $sub . '.id = ' . $this->id;
1181         }
1182         // XXX(x2006barrois): find a way to get rid of that hardcoded
1183         // reference to 'pc'.
1184         $cond .= ' AND ' . $uf->getVisibilityCondition('pc.corps_pub');
1185         return $cond;
1186     }
1187 }
1188 // }}}
1189 // {{{ class UFC_Corps_Rank
1190 /** Filters users based on their rank in the corps
1191  * @param $rank Rank we are looking for (abbreviation)
1192  */
1193 class UFC_Corps_Rank extends UserFilterCondition
1194 {
1195     private $rank;
1196     private $id;
1197
1198     public function __construct($rank, $id = null)
1199     {
1200         $this->rank = $rank;
1201         $this->id   = $id;
1202     }
1203
1204     public function buildCondition(PlFilter $uf)
1205     {
1206         /** Tables shortcuts:
1207          * pc for profile_corps
1208          * pcr for profile_corps_rank
1209          */
1210         $sub = $uf->addCorpsRankFilter();
1211         if (is_null($this->id)) {
1212             $cond = $sub . '.abbreviation = ' . $this->rank;
1213         } else {
1214             $cond = $sub . '.id = ' . $this->id;
1215         }
1216         // XXX(x2006barrois): find a way to get rid of that hardcoded
1217         // reference to 'pc'.
1218         $cond .= ' AND ' . $uf->getVisibilityCondition('pc.corps_pub');
1219         return $cond;
1220     }
1221 }
1222 // }}}
1223 // {{{ class UFC_Job_Company
1224 /** Filters users based on the company they belong to
1225  * @param $type The field being searched (self::JOBID, self::JOBNAME or self::JOBACRONYM)
1226  * @param $value The searched value
1227  */
1228 class UFC_Job_Company extends UserFilterCondition
1229 {
1230     const JOBID = 'id';
1231     const JOBNAME = 'name';
1232     const JOBACRONYM = 'acronym';
1233
1234     private $type;
1235     private $value;
1236
1237     public function __construct($type, $value)
1238     {
1239         $this->assertType($type);
1240         $this->type = $type;
1241         $this->value = $value;
1242     }
1243
1244     private function assertType($type)
1245     {
1246         if ($type != self::JOBID && $type != self::JOBNAME && $type != self::JOBACRONYM) {
1247             Platal::page()->killError("Type de recherche non valide.");
1248         }
1249     }
1250
1251     public function buildCondition(PlFilter $uf)
1252     {
1253         $sub = $uf->addJobCompanyFilter();
1254         $cond  = $sub . '.' . $this->type . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->value);
1255         $jsub = $uf->addJobFilter();
1256         $cond .= ' AND ' . $uf->getVisibilityCondition($jsub . '.pub');
1257         return $cond;
1258     }
1259 }
1260 // }}}
1261 // {{{ class UFC_Job_Terms
1262 /** Filters users based on the job terms they assigned to one of their
1263  * jobs.
1264  * @param $val The ID of the job term, or an array of such IDs
1265  */
1266 class UFC_Job_Terms extends UserFilterCondition
1267 {
1268     private $val;
1269
1270     public function __construct($val)
1271     {
1272         if (!is_array($val)) {
1273             $val = array($val);
1274         }
1275         $this->val = $val;
1276     }
1277
1278     public function buildCondition(PlFilter $uf)
1279     {
1280         $sub = $uf->addJobTermsFilter(count($this->val));
1281         $conditions = array();
1282         foreach ($this->val as $i => $jtid) {
1283             $conditions[] = $sub[$i] . '.jtid_1 = ' . XDB::escape($jtid);
1284         }
1285         $jsub = $uf->addJobFilter();
1286         $conditions[] = $uf->getVisibilityCondition($jsub . '.pub');
1287         return implode(' AND ', $conditions);
1288     }
1289 }
1290 // }}}
1291 // {{{ class UFC_Job_Description
1292 /** Filters users based on their job description
1293  * @param $description The text being searched for
1294  * @param $fields The fields to search for (CV, user-defined)
1295  */
1296 class UFC_Job_Description extends UserFilterCondition
1297 {
1298
1299     private $description;
1300     private $fields;
1301
1302     public function __construct($description, $fields)
1303     {
1304         $this->fields = $fields;
1305         $this->description = $description;
1306     }
1307
1308     public function buildCondition(PlFilter $uf)
1309     {
1310         $conds = array();
1311
1312         $jsub = $uf->addJobFilter();
1313         // CV is private => if only CV requested, and not private,
1314         // don't do anything. Otherwise restrict to standard job visibility.
1315         if ($this->fields == UserFilter::JOB_CV) {
1316            if ($uf->getVisibilityLevel() != ProfileVisibility::VIS_PRIVATE) {
1317                return self::COND_TRUE;
1318            }
1319         }
1320         if ($this->fields & UserFilter::JOB_USERDEFINED) {
1321             $conds[] = $jsub . '.description ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->description);
1322         }
1323         if ($this->fields & UserFilter::JOB_CV && $uf->getVisibilityLevel() == ProfileVisibility::VIS_PRIVATE) {
1324             $uf->requireProfiles();
1325             $conds[] = 'p.cv ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->description);
1326         }
1327         if (count($conds) == 0) {
1328             return self::COND_TRUE;
1329         }
1330         return $uf->getVisibilityCondition($jsub . '.pub') . ' AND ( ' . implode(' OR ', $conds) . ' )';
1331     }
1332 }
1333 // }}}
1334 // {{{ class UFC_Networking
1335 /** Filters users based on network identity (IRC, ...)
1336  * @param $type Type of network (-1 for any)
1337  * @param $value Value to search
1338  */
1339 class UFC_Networking extends UserFilterCondition
1340 {
1341     private $type;
1342     private $value;
1343
1344     public function __construct($type, $value)
1345     {
1346         $this->type = $type;
1347         $this->value = $value;
1348     }
1349
1350     public function buildCondition(PlFilter $uf)
1351     {
1352         $sub = $uf->addNetworkingFilter();
1353         $conds = array();
1354         $conds[] = $uf->getVisibilityCondition($sub . '.pub');
1355         $conds[] = $sub . '.address ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->value);
1356         if ($this->type != -1) {
1357             $conds[] = $sub . '.nwid = ' . XDB::format('{?}', $this->type);
1358         }
1359         return implode(' AND ', $conds);
1360     }
1361 }
1362 // }}}
1363 // {{{ class UFC_Phone
1364 /** Filters users based on their phone number
1365  * @param $num_type Type of number (pro/user/home)
1366  * @param $phone_type Type of phone (fixed/mobile/fax)
1367  * @param $number Phone number
1368  */
1369 class UFC_Phone extends UserFilterCondition
1370 {
1371     const NUM_PRO   = 'pro';
1372     const NUM_USER  = 'user';
1373     const NUM_HOME  = 'address';
1374     const NUM_ANY   = 'any';
1375
1376     const PHONE_FIXED   = 'fixed';
1377     const PHONE_MOBILE  = 'mobile';
1378     const PHONE_FAX     = 'fax';
1379     const PHONE_ANY     = 'any';
1380
1381     private $num_type;
1382     private $phone_type;
1383     private $number;
1384
1385     public function __construct($number, $num_type = self::NUM_ANY, $phone_type = self::PHONE_ANY)
1386     {
1387         $phone = new Phone(array('display' => $number));
1388         $phone->format();
1389         $this->number = $phone->search;
1390         $this->num_type = $num_type;
1391         $this->phone_type = $phone_type;
1392     }
1393
1394     public function buildCondition(PlFilter $uf)
1395     {
1396         $sub = $uf->addPhoneFilter();
1397         $conds = array();
1398
1399         $conds[] = $uf->getVisibilityCondition($sub . '.pub');
1400
1401         $conds[] = $sub . '.search_tel = ' . XDB::format('{?}', $this->number);
1402         if ($this->num_type != self::NUM_ANY) {
1403             $conds[] = $sub . '.link_type = ' . XDB::format('{?}', $this->num_type);
1404         }
1405         if ($this->phone_type != self::PHONE_ANY) {
1406             $conds[] = $sub . '.tel_type = ' . XDB::format('{?}', $this->phone_type);
1407         }
1408         return implode(' AND ', $conds);
1409     }
1410 }
1411 // }}}
1412 // {{{ class UFC_Medal
1413 /** Filters users based on their medals
1414  * @param $medal ID of the medal
1415  * @param $grade Grade of the medal (null for 'any')
1416  */
1417 class UFC_Medal extends UserFilterCondition
1418 {
1419     private $medal;
1420     private $grade;
1421
1422     public function __construct($medal, $grade = null)
1423     {
1424         $this->medal = $medal;
1425         $this->grade = $grade;
1426     }
1427
1428     public function buildCondition(PlFilter $uf)
1429     {
1430         $conds = array();
1431
1432         // This will require profiles => table 'p' will be available.
1433         $sub = $uf->addMedalFilter();
1434
1435         $conds[] = $uf->getVisibilityCondition('p.medals_pub');
1436
1437         $conds[] = $sub . '.mid = ' . XDB::format('{?}', $this->medal);
1438         if ($this->grade != null) {
1439             $conds[] = $sub . '.gid = ' . XDB::format('{?}', $this->grade);
1440         }
1441         return implode(' AND ', $conds);
1442     }
1443 }
1444 // }}}
1445 // {{{ class UFC_Photo
1446 /** Filters profiles with photo
1447  */
1448 class UFC_Photo extends UserFilterCondition
1449 {
1450     public function buildCondition(PlFilter $uf)
1451     {
1452         $sub = $uf->addPhotoFilter();
1453         return $sub . '.attach IS NOT NULL AND ' . $uf->getVisibilityCondition($sub . '.pub');
1454     }
1455 }
1456 // }}}
1457 // {{{ class UFC_Mentor
1458 class UFC_Mentor extends UserFilterCondition
1459 {
1460     public function buildCondition(PlFilter $uf)
1461     {
1462         $sub = $uf->addMentorFilter(UserFilter::MENTOR);
1463         return $sub . '.expertise IS NOT NULL';
1464     }
1465 }
1466 // }}}
1467 // {{{ class UFC_Mentor_Expertise
1468 /** Filters users by mentoring expertise
1469  * @param $expertise Domain of expertise
1470  */
1471 class UFC_Mentor_Expertise extends UserFilterCondition
1472 {
1473     private $expertise;
1474
1475     public function __construct($expertise)
1476     {
1477         $this->expertise = $expertise;
1478     }
1479
1480     public function buildCondition(PlFilter $uf)
1481     {
1482         $sub = $uf->addMentorFilter(UserFilter::MENTOR_EXPERTISE);
1483         return $sub . '.expertise ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->expertise);
1484     }
1485 }
1486 // }}}
1487 // {{{ class UFC_Mentor_Country
1488 /** Filters users by mentoring country
1489  * @param $country Two-letters code of country being searched
1490  */
1491 class UFC_Mentor_Country extends UserFilterCondition
1492 {
1493     private $country;
1494
1495     public function __construct()
1496     {
1497         $this->country = pl_flatten(func_get_args());
1498     }
1499
1500     public function buildCondition(PlFilter $uf)
1501     {
1502         $sub = $uf->addMentorFilter(UserFilter::MENTOR_COUNTRY);
1503         return $sub . '.country IN ' . XDB::format('{?}', $this->country);
1504     }
1505 }
1506 // }}}
1507 // {{{ class UFC_Mentor_Terms
1508 /** Filters users based on the job terms they used in mentoring.
1509  * @param $val The ID of the job term, or an array of such IDs
1510  */
1511 class UFC_Mentor_Terms extends UserFilterCondition
1512 {
1513     private $val;
1514
1515     public function __construct($val)
1516     {
1517         $this->val = $val;
1518     }
1519
1520     public function buildCondition(PlFilter $uf)
1521     {
1522         $sub = $uf->addMentorFilter(UserFilter::MENTOR_TERM);
1523         return $sub . '.jtid_1 = ' . XDB::escape($this->val);
1524     }
1525 }
1526 // }}}
1527 // {{{ class UFC_UserRelated
1528 /** Filters users based on a relation toward a user
1529  * @param $user User to which searched users are related
1530  */
1531 abstract class UFC_UserRelated extends UserFilterCondition
1532 {
1533     protected $user;
1534     public function __construct(PlUser $user)
1535     {
1536         $this->user =& $user;
1537     }
1538 }
1539 // }}}
1540 // {{{ class UFC_DeltaTen
1541 class UFC_DeltaTen extends UserFilterCondition
1542 {
1543     public function buildCondition(PlFilter $uf)
1544     {
1545         $sub = $uf->addDeltaTenFilter(UserFilter::DELTATEN);
1546         return $sub . '.message IS NOT NULL';
1547     }
1548 }
1549 // }}}
1550 // {{{ class UFC_DeltaTen_Message
1551 /** Filters users by deltaten message
1552  * @param $message Message for the DeltaTen program
1553  */
1554 class UFC_DeltaTen_Message extends UserFilterCondition
1555 {
1556     private $message;
1557
1558     public function __construct($message)
1559     {
1560         $this->message = $message;
1561     }
1562
1563     public function buildCondition(PlFilter $uf)
1564     {
1565         $sub = $uf->addDeltaTenFilter(UserFilter::DELTATEN_MESSAGE);
1566         return $sub . '.message ' . XDB::formatWildcards(XDB::WILDCARD_CONTAINS, $this->message);
1567     }
1568 }
1569 // }}}
1570 // {{{ class UFC_Contact
1571 /** Filters users who belong to selected user's contacts
1572  */
1573 class UFC_Contact extends UFC_UserRelated
1574 {
1575     public function buildCondition(PlFilter $uf)
1576     {
1577         $sub = $uf->addContactFilter($this->user->id());
1578         return 'c' . $sub . '.contact IS NOT NULL';
1579     }
1580 }
1581 // }}}
1582 // {{{ class UFC_WatchRegistration
1583 /** Filters users being watched by selected user
1584  */
1585 class UFC_WatchRegistration extends UFC_UserRelated
1586 {
1587     public function buildCondition(PlFilter $uf)
1588     {
1589         if (!$this->user->watchType('registration')) {
1590             return PlFilterCondition::COND_FALSE;
1591         }
1592         $uids = $this->user->watchUsers();
1593         if (count($uids) == 0) {
1594             return PlFilterCondition::COND_FALSE;
1595         } else {
1596             return XDB::format('$UID IN {?}', $uids);
1597         }
1598     }
1599 }
1600 // }}}
1601 // {{{ class UFC_WatchPromo
1602 /** Filters users belonging to a promo watched by selected user
1603  * @param $user Selected user (the one watching promo)
1604  * @param $grade Formation the user is watching
1605  */
1606 class UFC_WatchPromo extends UFC_UserRelated
1607 {
1608     private $grade;
1609     public function __construct(PlUser $user, $grade = UserFilter::GRADE_ING)
1610     {
1611         parent::__construct($user);
1612         $this->grade = $grade;
1613     }
1614
1615     public function buildCondition(PlFilter $uf)
1616     {
1617         $promos = $this->user->watchPromos();
1618         if (count($promos) == 0) {
1619             return PlFilterCondition::COND_FALSE;
1620         } else {
1621             $sube = $uf->addEducationFilter(true, $this->grade);
1622             $field = 'pe' . $sube . '.' . UserFilter::promoYear($this->grade);
1623             return XDB::format($field . ' IN {?}', $promos);
1624         }
1625     }
1626 }
1627 // }}}
1628 // {{{ class UFC_WatchContact
1629 /** Filters users watched by selected user
1630  */
1631 class UFC_WatchContact extends UFC_Contact
1632 {
1633     public function buildCondition(PlFilter $uf)
1634     {
1635         if (!$this->user->watchContacts()) {
1636             return PlFilterCondition::COND_FALSE;
1637         }
1638         return parent::buildCondition($uf);
1639     }
1640 }
1641 // }}}
1642 // {{{ class UFC_MarketingHash
1643 /** Filters users using the hash generated
1644  * to send marketing emails to him.
1645  */
1646 class UFC_MarketingHash extends UserFilterCondition
1647 {
1648     private $hash;
1649
1650     public function __construct($hash)
1651     {
1652         $this->hash = $hash;
1653     }
1654
1655     public function buildCondition(PlFilter $uf)
1656     {
1657         $table = $uf->addMarketingHash();
1658         return XDB::format('rm.hash = {?}', $this->hash);
1659     }
1660 }
1661 // }}}
1662
1663 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
1664 ?>