classes/userfilter.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 require_once dirname(__FILE__) . '/userfilter/conditions.inc.php';
  23 require_once dirname(__FILE__) . '/userfilter/orders.inc.php';
  24
  25 /***********************************
  26   *********************************
  27           USER FILTER CLASS
  28   *********************************
  29  ***********************************/
  30
  31 // {{{ class UserFilter
  32 /** This class provides a convenient and centralized way of filtering users.
  33  *
  34  * Usage:
  35  * $uf = new UserFilter(new UFC_Blah($x, $y), new UFO_Coin($z, $t));
  36  *
  37  * Resulting UserFilter can be used to:
  38  * - get a list of User objects matching the filter
  39  * - get a list of UIDs matching the filter
  40  * - get the number of users matching the filter
  41  * - check whether a given User matches the filter
  42  * - filter a list of User objects depending on whether they match the filter
  43  *
  44  * Usage for UFC and UFO objects:
  45  * A UserFilter will call all private functions named XXXJoins.
  46  * These functions must return an array containing the list of join
  47  * required by the various UFC and UFO associated to the UserFilter.
  48  * Entries in those returned array are of the following form:
  49  *   'join_tablealias' => array('join_type', 'joined_table', 'join_criter')
  50  * which will be translated into :
  51  *   join_type JOIN joined_table AS join_tablealias ON (join_criter)
  52  * in the final query.
  53  *
  54  * In the join_criter text, $ME is replaced with 'join_tablealias', $PID with
  55  * profile.pid, and $UID with accounts.uid.
  56  *
  57  * For each kind of "JOIN" needed, a function named addXXXFilter() should be defined;
  58  * its parameter will be used to set various private vars of the UserFilter describing
  59  * the required joins ; such a function shall return the "join_tablealias" to use
  60  * when referring to the joined table.
  61  *
  62  * For example, if data from profile_job must be available to filter results,
  63  * the UFC object will call $uf-addJobFilter(), which will set the 'with_pj' var and
  64  * return 'pj', the short name to use when referring to profile_job; when building
  65  * the query, calling the jobJoins function will return an array containing a single
  66  * row:
  67  *   'pj' => array('left', 'profile_job', '$ME.pid = $UID');
  68  *
  69  * The 'register_optional' function can be used to generate unique table aliases when
  70  * the same table has to be joined several times with different aliases.
  71  */
  72 class UserFilter extends PlFilter
  73 {
  74     protected $joinMethods = array();
  75
  76     protected $joinMetas = array(
  77                                 '$PID' => 'p.pid',
  78                                 '$UID' => 'a.uid',
  79                                 );
  80
  81     private $root;
  82     private $sort = array();
  83     private $grouper = null;
  84     private $query = null;
  85     private $orderby = null;
  86
  87     // Store the current 'search' visibility.
  88     private $profile_visibility = null;
  89
  90     private $lastusercount = null;
  91     private $lastprofilecount = null;
  92
  93     public function __construct($cond = null, $sort = null)
  94     {
  95         if (empty($this->joinMethods)) {
  96             $class = new ReflectionClass('UserFilter');
  97             foreach ($class->getMethods() as $method) {
  98                 $name = $method->getName();
  99                 if (substr($name, -5) == 'Joins' && $name != 'buildJoins') {
 100                     $this->joinMethods[] = $name;
 101                 }
 102             }
 103         }
 104         if (!is_null($cond)) {
 105             if ($cond instanceof PlFilterCondition) {
 106                 $this->setCondition($cond);
 107             }
 108         }
 109         if (!is_null($sort)) {
 110             if ($sort instanceof PlFilterOrder) {
 111                 $this->addSort($sort);
 112             } else if (is_array($sort)) {
 113                 foreach ($sort as $s) {
 114                     $this->addSort($s);
 115                 }
 116             }
 117         }
 118
 119         // This will set the visibility to the default correct level.
 120         $this->profile_visibility = new ProfileVisibility();
 121     }
 122
 123     public function getVisibilityLevels()
 124     {
 125         return $this->profile_visibility->levels();
 126     }
 127
 128     public function getVisibilityLevel()
 129     {
 130         return $this->profile_visibility->level();
 131     }
 132
 133     public function restrictVisibilityTo($level)
 134     {
 135         $this->profile_visibility->setLevel($level);
 136     }
 137
 138     public function getVisibilityCondition($field)
 139     {
 140         return $field . ' IN ' . XDB::formatArray($this->getVisibilityLevels());
 141     }
 142
 143     private function buildQuery()
 144     {
 145         // The root condition is built first because some orders need info
 146         // available only once all UFC have set their conditions (UFO_Score)
 147         if (is_null($this->query)) {
 148             $where = $this->root->buildCondition($this);
 149             $where = str_replace(array_keys($this->joinMetas),
 150                                  $this->joinMetas,
 151                                  $where);
 152         }
 153         if (is_null($this->orderby)) {
 154             $orders = array();
 155             foreach ($this->sort as $sort) {
 156                 $orders = array_merge($orders, $sort->buildSort($this));
 157             }
 158             if (count($orders) == 0) {
 159                 $this->orderby = '';
 160             } else {
 161                 $this->orderby = 'ORDER BY  ' . implode(', ', $orders);
 162             }
 163             $this->orderby = str_replace(array_keys($this->joinMetas),
 164                                          $this->joinMetas,
 165                                          $this->orderby);
 166         }
 167         if (is_null($this->query)) {
 168             if ($this->with_accounts) {
 169                 $from = 'accounts AS a';
 170             } else {
 171                 $this->requireProfiles();
 172                 $from = 'profiles AS p';
 173             }
 174             $joins = $this->buildJoins();
 175             $this->query = 'FROM  ' . $from . '
 176                                ' . $joins . '
 177                            WHERE  (' . $where . ')';
 178         }
 179     }
 180
 181     public function hasGroups()
 182     {
 183         return $this->grouper != null;
 184     }
 185
 186     public function getGroups()
 187     {
 188         return $this->getUIDGroups();
 189     }
 190
 191     public function getUIDGroups()
 192     {
 193         $this->requireAccounts();
 194         $this->buildQuery();
 195         $token = $this->grouper->getGroupToken($this);
 196
 197         $groups = XDB::rawFetchAllRow('SELECT ' . $token . ', COUNT(a.uid)
 198                                       ' . $this->query . '
 199                                       GROUP BY  ' . $token,
 200                                       0);
 201         return $groups;
 202     }
 203
 204     public function getPIDGroups()
 205     {
 206         $this->requireProfiles();
 207         $this->buildQuery();
 208         $token = $this->grouper->getGroupToken($this);
 209
 210         $groups = XDB::rawFetchAllRow('SELECT ' . $token . ', COUNT(p.pid)
 211                                       ' . $this->query . '
 212                                       GROUP BY  ' . $token,
 213                                       0);
 214         return $groups;
 215     }
 216
 217     private function getUIDList($uids = null, PlLimit $limit)
 218     {
 219         $this->requireAccounts();
 220         $this->buildQuery();
 221         $lim = $limit->getSql();
 222         $cond = '';
 223         if (!empty($uids)) {
 224             $cond = XDB::format(' AND a.uid IN {?}', $uids);
 225         }
 226         $fetched = XDB::rawFetchColumn('SELECT SQL_CALC_FOUND_ROWS  a.uid
 227                                        ' . $this->query . $cond . '
 228                                        GROUP BY  a.uid
 229                                        ' . $this->orderby . '
 230                                        ' . $lim);
 231         $this->lastusercount = (int)XDB::fetchOneCell('SELECT FOUND_ROWS()');
 232         return $fetched;
 233     }
 234
 235     private function getPIDList($pids = null, PlLimit $limit)
 236     {
 237         $this->requireProfiles();
 238         $this->buildQuery();
 239         $lim = $limit->getSql();
 240         $cond = '';
 241         if (!is_null($pids)) {
 242             $cond = XDB::format(' AND p.pid IN {?}', $pids);
 243         }
 244         $fetched = XDB::rawFetchColumn('SELECT  SQL_CALC_FOUND_ROWS  p.pid
 245                                        ' . $this->query . $cond . '
 246                                        GROUP BY  p.pid
 247                                        ' . $this->orderby . '
 248                                        ' . $lim);
 249         $this->lastprofilecount = (int)XDB::fetchOneCell('SELECT FOUND_ROWS()');
 250         return $fetched;
 251     }
 252
 253     private static function defaultLimit($limit) {
 254         if ($limit == null) {
 255             return new PlLimit();
 256         } else {
 257             return $limit;
 258         }
 259     }
 260
 261     /** Check that the user match the given rule.
 262      */
 263     public function checkUser(PlUser $user)
 264     {
 265         $this->requireAccounts();
 266         $this->buildQuery();
 267         $count = (int)XDB::rawFetchOneCell('SELECT  COUNT(*)
 268                                            ' . $this->query
 269                                              . XDB::format(' AND a.uid = {?}', $user->id()));
 270         return $count == 1;
 271     }
 272
 273     /** Check that the profile match the given rule.
 274      */
 275     public function checkProfile(Profile $profile)
 276     {
 277         $this->requireProfiles();
 278         $this->buildQuery();
 279         $count = (int)XDB::rawFetchOneCell('SELECT  COUNT(*)
 280                                            ' . $this->query
 281                                              . XDB::format(' AND p.pid = {?}', $profile->id()));
 282         return $count == 1;
 283     }
 284
 285     /** Default filter is on users
 286      */
 287     public function filter(array $users, $limit = null)
 288     {
 289         return $this->filterUsers($users, self::defaultLimit($limit));
 290     }
 291
 292     /** Filter a list of users to extract the users matching the rule.
 293      */
 294     public function filterUsers(array $users, $limit = null)
 295     {
 296         $limit = self::defaultLimit($limit);
 297         $this->requireAccounts();
 298         $this->buildQuery();
 299         $table = array();
 300         $uids  = array();
 301         foreach ($users as $user) {
 302             if ($user instanceof PlUser) {
 303                 $uid = $user->id();
 304             } else {
 305                 $uid = $user;
 306             }
 307             $uids[] = $uid;
 308             $table[$uid] = $user;
 309         }
 310         $fetched = $this->getUIDList($uids, $limit);
 311         $output = array();
 312         foreach ($fetched as $uid) {
 313             $output[] = $table[$uid];
 314         }
 315         return $output;
 316     }
 317
 318     /** Filter a list of profiles to extract the users matching the rule.
 319      */
 320     public function filterProfiles(array $profiles, $limit = null)
 321     {
 322         $limit = self::defaultLimit($limit);
 323         $this->requireProfiles();
 324         $this->buildQuery();
 325         $table = array();
 326         $pids  = array();
 327         foreach ($profiles as $profile) {
 328             if ($profile instanceof Profile) {
 329                 $pid = $profile->id();
 330             } else {
 331                 $pid = $profile;
 332             }
 333             $pids[] = $pid;
 334             $table[$pid] = $profile;
 335         }
 336         $fetched = $this->getPIDList($pids, $limit);
 337         $output = array();
 338         foreach ($fetched as $pid) {
 339             $output[] = $table[$pid];
 340         }
 341         return $output;
 342     }
 343
 344     public function getUIDs($limit = null)
 345     {
 346         $limit = self::defaultLimit($limit);
 347         return $this->getUIDList(null, $limit);
 348     }
 349
 350     public function getUID($pos = 0)
 351     {
 352         $uids =$this->getUIDList(null, new PlLimit(1, $pos));
 353         if (count($uids) == 0) {
 354             return null;
 355         } else {
 356             return $uids[0];
 357         }
 358     }
 359
 360     public function getPIDs($limit = null)
 361     {
 362         $limit = self::defaultLimit($limit);
 363         return $this->getPIDList(null, $limit);
 364     }
 365
 366     public function getPID($pos = 0)
 367     {
 368         $pids =$this->getPIDList(null, new PlLimit(1, $pos));
 369         if (count($pids) == 0) {
 370             return null;
 371         } else {
 372             return $pids[0];
 373         }
 374     }
 375
 376     public function getUsers($limit = null)
 377     {
 378         return User::getBulkUsersWithUIDs($this->getUIDs($limit));
 379     }
 380
 381     public function getUser($pos = 0)
 382     {
 383         $uid = $this->getUID($pos);
 384         if ($uid == null) {
 385             return null;
 386         } else {
 387             return User::getWithUID($uid);
 388         }
 389     }
 390
 391     public function iterUsers($limit = null)
 392     {
 393         return User::iterOverUIDs($this->getUIDs($limit));
 394     }
 395
 396     public function getProfiles($limit = null, $fields = 0x0000, $visibility = null)
 397     {
 398         return Profile::getBulkProfilesWithPIDs($this->getPIDs($limit), $fields, $visibility);
 399     }
 400
 401     public function getProfile($pos = 0, $fields = 0x0000, $visibility = null)
 402     {
 403         $pid = $this->getPID($pos);
 404         if ($pid == null) {
 405             return null;
 406         } else {
 407             return Profile::get($pid, $fields, $visibility);
 408         }
 409     }
 410
 411     public function iterProfiles($limit = null, $fields = 0x0000, $visibility = null)
 412     {
 413         return Profile::iterOverPIDs($this->getPIDs($limit), true, $fields, $visibility);
 414     }
 415
 416     public function get($limit = null)
 417     {
 418         return $this->getUsers($limit);
 419     }
 420
 421     public function getIds($limit = null)
 422     {
 423         return $this->getUIDs();
 424     }
 425
 426     public function getTotalCount()
 427     {
 428         return $this->getTotalUserCount();
 429     }
 430
 431     public function getTotalUserCount()
 432     {
 433         if (is_null($this->lastusercount)) {
 434             $this->requireAccounts();
 435             $this->buildQuery();
 436             return (int)XDB::rawFetchOneCell('SELECT  COUNT(DISTINCT a.uid)
 437                                           ' . $this->query);
 438         } else {
 439             return $this->lastusercount;
 440         }
 441     }
 442
 443     public function getTotalProfileCount()
 444     {
 445         if (is_null($this->lastprofilecount)) {
 446             $this->requireProfiles();
 447             $this->buildQuery();
 448             return (int)XDB::rawFetchOneCell('SELECT  COUNT(DISTINCT p.pid)
 449                                           ' . $this->query);
 450         } else {
 451             return $this->lastprofilecount;
 452         }
 453     }
 454
 455     public function setCondition(PlFilterCondition $cond)
 456     {
 457         $this->root =& $cond;
 458         $this->query = null;
 459     }
 460
 461     public function addSort(PlFilterOrder $sort)
 462     {
 463         if (count($this->sort) == 0 && $sort instanceof PlFilterGroupableOrder)
 464         {
 465             $this->grouper = $sort;
 466         }
 467         $this->sort[] = $sort;
 468         $this->orderby = null;
 469     }
 470
 471     public function export()
 472     {
 473         $export = array('conditions' => $this->root->export());
 474         if (!empty($this->sort)) {
 475             $export['sorts'] = array();
 476             foreach ($this->sort as $sort) {
 477                 $export['sorts'][] = $sort->export();
 478             }
 479         }
 480         return $export;
 481     }
 482
 483     public function exportConditions()
 484     {
 485         return $this->root->export();
 486     }
 487
 488     public static function fromExport(array $export)
 489     {
 490         $export = new PlDict($export);
 491         if (!$export->has('conditions')) {
 492             throw new Exception("Cannot build a user filter without conditions");
 493         }
 494         $cond = UserFilterCondition::fromExport($export->v('conditions'));
 495         $sorts = null;
 496         if ($export->has('sorts')) {
 497             $sorts = array();
 498             foreach ($export->v('sorts') as $sort) {
 499                 $sorts[] = UserFilterOrder::fromExport($sort);
 500             }
 501         }
 502         return new UserFilter($cond, $sorts);
 503     }
 504
 505     public static function fromJSon($json)
 506     {
 507         $export = json_decode($json, true);
 508         if (is_null($export)) {
 509             throw new Exception("Invalid json: $json");
 510         }
 511         return self::fromExport($json);
 512     }
 513
 514     public static function fromExportedConditions(array $export)
 515     {
 516         $cond = UserFilterCondition::fromExport($export);
 517         return new UserFilter($cond);
 518     }
 519
 520     public static function fromJSonConditions($json)
 521     {
 522         $export = json_decode($json, true);
 523         if (is_null($export)) {
 524             throw new Exception("Invalid json: $json");
 525         }
 526         return self::fromExportedConditions($json);
 527     }
 528
 529     static public function getLegacy($promo_min, $promo_max)
 530     {
 531         if ($promo_min != 0) {
 532             $min = new UFC_Promo('>=', self::GRADE_ING, intval($promo_min));
 533         } else {
 534             $min = new PFC_True();
 535         }
 536         if ($promo_max != 0) {
 537             $max = new UFC_Promo('<=', self::GRADE_ING, intval($promo_max));
 538         } else {
 539             $max = new PFC_True();
 540         }
 541         return new UserFilter(new PFC_And($min, $max));
 542     }
 543
 544     static public function sortByName()
 545     {
 546         return array(new UFO_Name(Profile::LASTNAME), new UFO_Name(Profile::FIRSTNAME));
 547     }
 548
 549     static public function sortByPromo()
 550     {
 551         return array(new UFO_Promo(), new UFO_Name(Profile::LASTNAME), new UFO_Name(Profile::FIRSTNAME));
 552     }
 553
 554     static private function getDBSuffix($string)
 555     {
 556         if (is_array($string)) {
 557             if (count($string) == 1) {
 558                 return self::getDBSuffix(array_pop($string));
 559             }
 560             return md5(implode('|', $string));
 561         } else {
 562             return preg_replace('/[^a-z0-9]/i', '', $string);
 563         }
 564     }
 565
 566
 567     /** Stores a new (and unique) table alias in the &$table table
 568      * @param   &$table Array in which the table alias must be stored
 569      * @param   $val    Value which will then be used to build the join
 570      * @return          Name of the newly created alias
 571      */
 572     private $option = 0;
 573     private function register_optional(array &$table, $val)
 574     {
 575         if (is_null($val)) {
 576             $sub   = $this->option++;
 577             $index = null;
 578         } else {
 579             $sub   = self::getDBSuffix($val);
 580             $index = $val;
 581         }
 582         $sub = '_' . $sub;
 583         $table[$sub] = $index;
 584         return $sub;
 585     }
 586
 587     /** PROFILE VS ACCOUNT
 588      */
 589     private $with_profiles  = false;
 590     private $with_accounts  = false;
 591     public function requireAccounts()
 592     {
 593         $this->with_accounts = true;
 594     }
 595
 596     public function accountsRequired()
 597     {
 598         return $this->with_accounts;
 599     }
 600
 601     public function requireProfiles()
 602     {
 603         $this->with_profiles = true;
 604     }
 605
 606     public function profilesRequired()
 607     {
 608         return $this->with_profiles;
 609     }
 610
 611     protected function accountJoins()
 612     {
 613         $joins = array();
 614         if ($this->with_profiles && $this->with_accounts) {
 615             $joins['ap'] = PlSqlJoin::left('account_profiles', '$ME.uid = $UID AND FIND_IN_SET(\'owner\', ap.perms)');
 616             $joins['p'] = PlSqlJoin::left('profiles', '$PID = ap.pid');
 617         }
 618         return $joins;
 619     }
 620
 621     /** PERMISSIONS
 622      */
 623     private $at = false;
 624     public function requirePerms()
 625     {
 626         $this->requireAccounts();
 627         $this->at = true;
 628         return 'at';
 629     }
 630
 631     protected function permJoins()
 632     {
 633         if ($this->at) {
 634             return array('at' => PlSqlJoin::left('account_types', '$ME.type = a.type'));
 635         } else {
 636             return array();
 637         }
 638     }
 639
 640     /** DISPLAY
 641      */
 642     const DISPLAY = 'display';
 643     private $pd = false;
 644     public function addDisplayFilter()
 645     {
 646         $this->requireProfiles();
 647         $this->pd = true;
 648         return '';
 649     }
 650
 651     protected function displayJoins()
 652     {
 653         if ($this->pd) {
 654             return array('pd' => PlSqlJoin::left('profile_display', '$ME.pid = $PID'));
 655         } else {
 656             return array();
 657         }
 658     }
 659
 660     /** LOGGER
 661      */
 662
 663     private $with_logger = false;
 664     public function addLoggerFilter()
 665     {
 666         $this->with_logger = true;
 667         $this->requireAccounts();
 668         return 'ls';
 669     }
 670     protected function loggerJoins()
 671     {
 672         $joins = array();
 673         if ($this->with_logger) {
 674             $joins['ls'] = PlSqlJoin::left('log_sessions', '$ME.uid = $UID');
 675         }
 676         return $joins;
 677     }
 678
 679     /** NAMES
 680      */
 681
 682     static public function assertName($name)
 683     {
 684         if (!DirEnum::getID(DirEnum::NAMETYPES, $name)) {
 685             Platal::page()->kill('Invalid name type: ' . $name);
 686         }
 687     }
 688
 689     private $pn  = array();
 690     public function addNameFilter($type, $variant = null)
 691     {
 692         $this->requireProfiles();
 693         if (!is_null($variant)) {
 694             $ft  = $type . '_' . $variant;
 695         } else {
 696             $ft = $type;
 697         }
 698         $sub = '_' . $ft;
 699         self::assertName($ft);
 700
 701         if (!is_null($variant) && $variant == 'other') {
 702             $sub .= $this->option++;
 703         }
 704         $this->pn[$sub] = DirEnum::getID(DirEnum::NAMETYPES, $ft);
 705         return $sub;
 706     }
 707
 708     protected function nameJoins()
 709     {
 710         $joins = array();
 711         foreach ($this->pn as $sub => $type) {
 712             $joins['pn' . $sub] = PlSqlJoin::left('profile_name', '$ME.pid = $PID AND $ME.typeid = {?}', $type);
 713         }
 714         return $joins;
 715     }
 716
 717     /** NAMETOKENS
 718      */
 719     private $name_tokens = array();
 720     private $nb_tokens = 0;
 721
 722     public function addNameTokensFilter($token)
 723     {
 724         $this->requireProfiles();
 725         $sub = 'sn' . (1 + $this->nb_tokens);
 726         $this->nb_tokens++;
 727         $this->name_tokens[$sub] = $token;
 728         return $sub;
 729     }
 730
 731     protected function nameTokensJoins()
 732     {
 733         /* We don't return joins, since with_sn forces the SELECT to run on search_name first */
 734         $joins = array();
 735         foreach ($this->name_tokens as $sub => $token) {
 736             $joins[$sub] = PlSqlJoin::left('search_name', '$ME.pid = $PID');
 737         }
 738         return $joins;
 739     }
 740
 741     public function getNameTokens()
 742     {
 743         return $this->name_tokens;
 744     }
 745
 746     /** NATIONALITY
 747      */
 748
 749     private $with_nat = false;
 750     public function addNationalityFilter()
 751     {
 752         $this->with_nat = true;
 753         return 'ngc';
 754     }
 755
 756     protected function nationalityJoins()
 757     {
 758         $joins = array();
 759         if ($this->with_nat) {
 760             $joins['ngc'] = PlSqlJoin::left('geoloc_countries', '$ME.iso_3166_1_a2 = p.nationality1 OR $ME.iso_3166_1_a2 = p.nationality2 OR $ME.iso_3166_1_a2 = p.nationality3');
 761         }
 762         return $joins;
 763     }
 764
 765     /** EDUCATION
 766      */
 767     const GRADE_ING = Profile::DEGREE_X;
 768     const GRADE_PHD = Profile::DEGREE_D;
 769     const GRADE_MST = Profile::DEGREE_M;
 770     static public function isGrade($grade)
 771     {
 772         return ($grade !== 0) && ($grade == self::GRADE_ING || $grade == self::GRADE_PHD || $grade == self::GRADE_MST);
 773     }
 774
 775     static public function assertGrade($grade)
 776     {
 777         if (!self::isGrade($grade)) {
 778             Platal::page()->killError("Diplôme non valide: $grade");
 779         }
 780     }
 781
 782     static public function promoYear($grade)
 783     {
 784         // XXX: Definition of promotion for phds and masters might change in near future.
 785         return ($grade == UserFilter::GRADE_ING) ? 'entry_year' : 'grad_year';
 786     }
 787
 788     private $pepe     = array();
 789     private $with_pee = false;
 790     public function addEducationFilter($x = false, $grade = null)
 791     {
 792         $this->requireProfiles();
 793         if (!$x) {
 794             $index = $this->option;
 795             $sub   = $this->option++;
 796         } else {
 797             self::assertGrade($grade);
 798             $index = $grade;
 799             $sub   = $grade[0];
 800             $this->with_pee = true;
 801         }
 802         $sub = '_' . $sub;
 803         $this->pepe[$index] = $sub;
 804         return $sub;
 805     }
 806
 807     protected function educationJoins()
 808     {
 809         $joins = array();
 810         if ($this->with_pee) {
 811             $joins['pee'] = PlSqlJoin::inner('profile_education_enum', 'pee.abbreviation = \'X\'');
 812         }
 813         foreach ($this->pepe as $grade => $sub) {
 814             if ($this->isGrade($grade)) {
 815                 $joins['pe' . $sub] = PlSqlJoin::left('profile_education', '$ME.eduid = pee.id AND $ME.pid = $PID');
 816                 $joins['pede' . $sub] = PlSqlJoin::inner('profile_education_degree_enum', '$ME.id = pe' . $sub . '.degreeid AND $ME.degree LIKE {?}', $grade);
 817             } else {
 818                 $joins['pe' . $sub] = PlSqlJoin::left('profile_education', '$ME.pid = $PID');
 819                 $joins['pee' . $sub] = PlSqlJoin::inner('profile_education_enum', '$ME.id = pe' . $sub . '.eduid');
 820                 $joins['pede' . $sub] = PlSqlJoin::inner('profile_education_degree_enum', '$ME.id = pe' . $sub . '.degreeid');
 821             }
 822         }
 823         return $joins;
 824     }
 825
 826
 827     /** GROUPS
 828      */
 829     private $gpm = array();
 830     public function addGroupFilter($group = null)
 831     {
 832         $this->requireAccounts();
 833         if (!is_null($group)) {
 834             if (is_int($group) || ctype_digit($group)) {
 835                 $index = $sub = $group;
 836             } else {
 837                 $index = $group;
 838                 $sub   = self::getDBSuffix($group);
 839             }
 840         } else {
 841             $sub = 'group_' . $this->option++;
 842             $index = null;
 843         }
 844         $sub = '_' . $sub;
 845         $this->gpm[$sub] = $index;
 846         return $sub;
 847     }
 848
 849     private $gpfm = array();
 850     public function addGroupFormerMemberFilter()
 851     {
 852         $this->requireAccounts();
 853         $sub = '_' . $this->option++;
 854         $this->gpfm[] = $sub;
 855         return $sub;
 856     }
 857
 858     protected function groupJoins()
 859     {
 860         $joins = array();
 861         foreach ($this->gpm as $sub => $key) {
 862             if (is_null($key)) {
 863                 $joins['gpa' . $sub] = PlSqlJoin::inner('groups');
 864                 $joins['gpm' . $sub] = PlSqlJoin::left('group_members', '$ME.uid = $UID AND $ME.asso_id = gpa' . $sub . '.id');
 865             } else if (is_int($key) || ctype_digit($key)) {
 866                 $joins['gpm' . $sub] = PlSqlJoin::left('group_members', '$ME.uid = $UID AND $ME.asso_id = ' . $key);
 867             } else {
 868                 $joins['gpa' . $sub] = PlSqlJoin::inner('groups', '$ME.diminutif = {?}', $key);
 869                 $joins['gpm' . $sub] = PlSqlJoin::left('group_members', '$ME.uid = $UID AND $ME.asso_id = gpa' . $sub . '.id');
 870             }
 871         }
 872         foreach ($this->gpfm as $sub) {
 873             $joins['gpfm' . $sub] = PlSqlJoin::left('group_former_members', '$ME.uid = $UID');
 874         }
 875         return $joins;
 876     }
 877
 878     /** NLS
 879      */
 880     private $nls = array();
 881     public function addNewsLetterFilter($nlid)
 882     {
 883         $this->requireAccounts();
 884         $sub = 'nl_' . $nlid;
 885         $this->nls[$nlid] = $sub;
 886         return $sub;
 887     }
 888
 889     protected function newsLetterJoins()
 890     {
 891         $joins = array();
 892         foreach ($this->nls as $key => $sub) {
 893             $joins[$sub] = PlSqlJoin::left('newsletter_ins', '$ME.nlid = {?} AND $ME.uid = $UID', $key);
 894         }
 895         return $joins;
 896     }
 897
 898     /** BINETS
 899      */
 900
 901     private $with_bi = false;
 902     private $with_bd = false;
 903     public function addBinetsFilter($with_enum = false)
 904     {
 905         $this->requireProfiles();
 906         $this->with_bi = true;
 907         if ($with_enum) {
 908             $this->with_bd = true;
 909             return 'bd';
 910         } else {
 911             return 'bi';
 912         }
 913     }
 914
 915     protected function binetsJoins()
 916     {
 917         $joins = array();
 918         if ($this->with_bi) {
 919             $joins['bi'] = PlSqlJoin::left('profile_binets', '$ME.pid = $PID');
 920         }
 921         if ($this->with_bd) {
 922             $joins['bd'] = PlSqlJoin::left('profile_binet_enum', '$ME.id = bi.binet_id');
 923         }
 924         return $joins;
 925     }
 926
 927     /** EMAILS
 928      */
 929     private $ra = array();
 930     /** Allows filtering by redirection.
 931      * @param $email If null, enable a left join on the email redirection table
 932      *  (email_redirect_account); otherwise, perform a left join on users having
 933      *  that email as a redirection.
 934      * @return Suffix to use to access the adequate table.
 935      */
 936     public function addEmailRedirectFilter($email = null)
 937     {
 938         $this->requireAccounts();
 939         return $this->register_optional($this->ra, $email);
 940     }
 941
 942     const ALIAS_BEST      = 'bestalias';
 943     const ALIAS_FORLIFE   = 'forlife';
 944     const ALIAS_AUXILIARY = 'alias_aux';
 945     private $sa = array();
 946     /** Allows filtering by source email.
 947      * @param $email If null, enable a left join on the email source table
 948      *  (email_source_account); otherwise, perform a left join on users having
 949      *  that email as a source email.
 950      * @return Suffix to use to access the adequate table.
 951      */
 952     public function addAliasFilter($email = null)
 953     {
 954         $this->requireAccounts();
 955         return $this->register_optional($this->sa, $email);
 956     }
 957
 958     private $with_rf = false;
 959     /** Allows filtering by active redirection.
 960      * @return Suffix to use to access the adequate table.
 961      */
 962     public function addActiveEmailRedirectFilter($email = null)
 963     {
 964         $this->requireAccounts();
 965         $this->with_rf = true;
 966     }
 967
 968     protected function emailJoins()
 969     {
 970         global $globals;
 971         $joins = array();
 972         foreach ($this->ra as $sub => $redirections) {
 973             if (is_null($redirections)) {
 974                 $joins['ra' . $sub] = PlSqlJoin::left('email_redirect_account', '$ME.uid = $UID AND $ME.type != \'imap\'');
 975             } else {
 976                 if (!is_array($redirections)) {
 977                     $key = array($redirections);
 978                 }
 979                 $joins['ra' . $sub] = PlSqlJoin::left('email_redirect_account', '$ME.uid = $UID AND $ME.type != \'imap\'
 980                                                                                  AND $ME.redirect IN {?}', $redirections);
 981             }
 982         }
 983         foreach ($this->sa as $sub => $emails) {
 984             if (is_null($emails)) {
 985                 $joins['sa' . $sub] = PlSqlJoin::left('email_source_account', '$ME.uid = $UID');
 986             } else if ($sub == self::ALIAS_BEST) {
 987                 $joins['sa' . $sub] = PlSqlJoin::left('email_source_account', '$ME.uid = $UID AND FIND_IN_SET(\'bestalias\', $ME.flags)');
 988             } else if ($sub == self::ALIAS_FORLIFE) {
 989                 $joins['sa' . $sub] = PlSqlJoin::left('email_source_account', '$ME.uid = $UID AND $ME.type = \'forlife\'');
 990             } else if ($sub == self::ALIAS_AUXILIARY) {
 991                 $joins['sa' . $sub] = PlSqlJoin::left('email_source_account', '$ME.uid = $UID AND $ME.type = \'alias_aux\'');
 992             } else {
 993                 if (!is_array($emails)) {
 994                     $key = array($emails);
 995                 }
 996                 $joins['sa' . $sub] = PlSqlJoin::left('email_source_account', '$ME.uid = $UID AND $ME.email IN {?}', $emails);
 997             }
 998         }
 999         if ($this->with_rf) {
1000             $joins['rf'] = PlSqlJoin::left('email_redirect_account', '$ME.uid = $UID AND $ME.type != \'imap\' AND $ME.flags = \'active\'');;
1001         }
1002         return $joins;
1003     }
1004
1005
1006     /** ADDRESSES
1007      */
1008     private $with_pa = false;
1009     public function addAddressFilter()
1010     {
1011         $this->requireProfiles();
1012         $this->with_pa = true;
1013         return 'pa';
1014     }
1015
1016     private $with_pac = false;
1017     public function addAddressCountryFilter()
1018     {
1019         $this->requireProfiles();
1020         $this->addAddressFilter();
1021         $this->with_pac = true;
1022         return 'gc';
1023     }
1024
1025     private $with_pal = false;
1026     public function addAddressLocalityFilter()
1027     {
1028         $this->requireProfiles();
1029         $this->addAddressFilter();
1030         $this->with_pal = true;
1031         return 'gl';
1032     }
1033
1034     protected function addressJoins()
1035     {
1036         $joins = array();
1037         if ($this->with_pa) {
1038             $joins['pa'] = PlSqlJoin::left('profile_addresses', '$ME.pid = $PID');
1039         }
1040         if ($this->with_pac) {
1041             $joins['gc'] = PlSqlJoin::left('geoloc_countries', '$ME.iso_3166_1_a2 = pa.countryID');
1042         }
1043         if ($this->with_pal) {
1044             $joins['gl'] = PlSqlJoin::left('geoloc_localities', '$ME.id = pa.localityID');
1045         }
1046         return $joins;
1047     }
1048
1049
1050     /** CORPS
1051      */
1052
1053     private $pc = false;
1054     private $pce = array();
1055     private $pcr = false;
1056     public function addCorpsFilter($type)
1057     {
1058         $this->requireProfiles();
1059         $this->pc = true;
1060         if ($type == UFC_Corps::CURRENT) {
1061             $this->pce['pcec'] = 'current_corpsid';
1062             return 'pcec';
1063         } else if ($type == UFC_Corps::ORIGIN) {
1064             $this->pce['pceo'] = 'original_corpsid';
1065             return 'pceo';
1066         }
1067     }
1068
1069     public function addCorpsRankFilter()
1070     {
1071         $this->requireProfiles();
1072         $this->pc = true;
1073         $this->pcr = true;
1074         return 'pcr';
1075     }
1076
1077     protected function corpsJoins()
1078     {
1079         $joins = array();
1080         if ($this->pc) {
1081             $joins['pc'] = PlSqlJoin::left('profile_corps', '$ME.pid = $PID');
1082         }
1083         if ($this->pcr) {
1084             $joins['pcr'] = PlSqlJoin::left('profile_corps_rank_enum', '$ME.id = pc.rankid');
1085         }
1086         foreach($this->pce as $sub => $field) {
1087             $joins[$sub] = PlSqlJoin::left('profile_corps_enum', '$ME.id = pc.' . $field);
1088         }
1089         return $joins;
1090     }
1091
1092     /** JOBS
1093      */
1094
1095     const JOB_USERDEFINED = 0x0001;
1096     const JOB_CV          = 0x0002;
1097     const JOB_ANY         = 0x0003;
1098
1099     /** Joins :
1100      * pj => profile_job
1101      * pje => profile_job_enum
1102      * pjt => profile_job_terms
1103      */
1104     private $with_pj  = false;
1105     private $with_pje = false;
1106     private $with_pjt = 0;
1107
1108     public function addJobFilter()
1109     {
1110         $this->requireProfiles();
1111         $this->with_pj = true;
1112         return 'pj';
1113     }
1114
1115     public function addJobCompanyFilter()
1116     {
1117         $this->addJobFilter();
1118         $this->with_pje = true;
1119         return 'pje';
1120     }
1121
1122     /**
1123      * Adds a filter on job terms of profile.
1124      * @param $nb the number of job terms to use
1125      * @return an array of the fields to filter (one for each term).
1126      */
1127     public function addJobTermsFilter($nb = 1)
1128     {
1129         $this->with_pjt = $nb;
1130         $jobtermstable = array();
1131         for ($i = 1; $i <= $nb; ++$i) {
1132             $jobtermstable[] = 'pjtr_'.$i;
1133         }
1134         return $jobtermstable;
1135     }
1136
1137     protected function jobJoins()
1138     {
1139         $joins = array();
1140         if ($this->with_pj) {
1141             $joins['pj'] = PlSqlJoin::left('profile_job', '$ME.pid = $PID');
1142         }
1143         if ($this->with_pje) {
1144             $joins['pje'] = PlSqlJoin::left('profile_job_enum', '$ME.id = pj.jobid');
1145         }
1146         if ($this->with_pjt > 0) {
1147             for ($i = 1; $i <= $this->with_pjt; ++$i) {
1148                 $joins['pjt_'.$i] = PlSqlJoin::left('profile_job_term', '$ME.pid = $PID');
1149                 $joins['pjtr_'.$i] = PlSqlJoin::left('profile_job_term_relation', '$ME.jtid_2 = pjt_'.$i.'.jtid');
1150             }
1151         }
1152         return $joins;
1153     }
1154
1155     /** NETWORKING
1156      */
1157
1158     private $with_pnw = false;
1159     public function addNetworkingFilter()
1160     {
1161         $this->requireAccounts();
1162         $this->with_pnw = true;
1163         return 'pnw';
1164     }
1165
1166     protected function networkingJoins()
1167     {
1168         $joins = array();
1169         if ($this->with_pnw) {
1170             $joins['pnw'] = PlSqlJoin::left('profile_networking', '$ME.pid = $PID');
1171         }
1172         return $joins;
1173     }
1174
1175     /** PHONE
1176      */
1177
1178     private $with_ptel = false;
1179
1180     public function addPhoneFilter()
1181     {
1182         $this->requireAccounts();
1183         $this->with_ptel = true;
1184         return 'ptel';
1185     }
1186
1187     protected function phoneJoins()
1188     {
1189         $joins = array();
1190         if ($this->with_ptel) {
1191             $joins['ptel'] = PlSqlJoin::left('profile_phones', '$ME.pid = $PID');
1192         }
1193         return $joins;
1194     }
1195
1196     /** MEDALS
1197      */
1198
1199     private $with_pmed = false;
1200     public function addMedalFilter()
1201     {
1202         $this->requireProfiles();
1203         $this->with_pmed = true;
1204         return 'pmed';
1205     }
1206
1207     protected function medalJoins()
1208     {
1209         $joins = array();
1210         if ($this->with_pmed) {
1211             $joins['pmed'] = PlSqlJoin::left('profile_medals', '$ME.pid = $PID');
1212         }
1213         return $joins;
1214     }
1215
1216     /** DELTATEN
1217      */
1218     private $dts = array();
1219     const DELTATEN = 1;
1220     const DELTATEN_MESSAGE = 2;
1221     // TODO: terms
1222
1223     public function addDeltaTenFilter($type)
1224     {
1225         $this->requireProfiles();
1226         switch ($type) {
1227         case self::DELTATEN:
1228             $this->dts['pdt'] = 'profile_deltaten';
1229             return 'pdt';
1230         case self::DELTATEN_MESSAGE:
1231             $this->dts['pdtm'] = 'profile_deltaten';
1232             return 'pdtm';
1233         default:
1234             Platal::page()->killError("Undefined DeltaTen filter.");
1235         }
1236     }
1237
1238     protected function deltatenJoins()
1239     {
1240         $joins = array();
1241         foreach ($this->dts as $sub => $tab) {
1242             $joins[$sub] = PlSqlJoin::left($tab, '$ME.pid = $PID');
1243         }
1244         return $joins;
1245     }
1246
1247     /** MENTORING
1248      */
1249
1250     private $pms = array();
1251     private $mjtr = false;
1252     const MENTOR = 1;
1253     const MENTOR_EXPERTISE = 2;
1254     const MENTOR_COUNTRY = 3;
1255     const MENTOR_TERM = 4;
1256
1257     public function addMentorFilter($type)
1258     {
1259         $this->requireProfiles();
1260         switch($type) {
1261         case self::MENTOR:
1262             $this->pms['pm'] = 'profile_mentor';
1263             return 'pm';
1264         case self::MENTOR_EXPERTISE:
1265             $this->pms['pme'] = 'profile_mentor';
1266             return 'pme';
1267         case self::MENTOR_COUNTRY:
1268             $this->pms['pmc'] = 'profile_mentor_country';
1269             return 'pmc';
1270         case self::MENTOR_TERM:
1271             $this->pms['pmt'] = 'profile_mentor_term';
1272             $this->mjtr = true;
1273             return 'mjtr';
1274         default:
1275             Platal::page()->killError("Undefined mentor filter.");
1276         }
1277     }
1278
1279     protected function mentorJoins()
1280     {
1281         $joins = array();
1282         foreach ($this->pms as $sub => $tab) {
1283             $joins[$sub] = PlSqlJoin::left($tab, '$ME.pid = $PID');
1284         }
1285         if ($this->mjtr) {
1286             $joins['mjtr'] = PlSqlJoin::left('profile_job_term_relation', '$ME.jtid_2 = pmt.jtid');
1287         }
1288         return $joins;
1289     }
1290
1291     /** CONTACTS
1292      */
1293     private $cts = array();
1294     public function addContactFilter($uid = null)
1295     {
1296         $this->requireProfiles();
1297         return $this->register_optional($this->cts, is_null($uid) ? null : 'user_' . $uid);
1298     }
1299
1300     protected function contactJoins()
1301     {
1302         $joins = array();
1303         foreach ($this->cts as $sub=>$key) {
1304             if (is_null($key)) {
1305                 $joins['c' . $sub] = PlSqlJoin::left('contacts', '$ME.contact = $PID');
1306             } else {
1307                 $joins['c' . $sub] = PlSqlJoin::left('contacts', '$ME.uid = {?} AND $ME.contact = $PID', substr($key, 5));
1308             }
1309         }
1310         return $joins;
1311     }
1312
1313
1314     /** CARNET
1315      */
1316     private $wn = array();
1317     public function addWatchRegistrationFilter($uid = null)
1318     {
1319         $this->requireAccounts();
1320         return $this->register_optional($this->wn, is_null($uid) ? null : 'user_' . $uid);
1321     }
1322
1323     private $wp = array();
1324     public function addWatchPromoFilter($uid = null)
1325     {
1326         $this->requireAccounts();
1327         return $this->register_optional($this->wp, is_null($uid) ? null : 'user_' . $uid);
1328     }
1329
1330     private $w = array();
1331     public function addWatchFilter($uid = null)
1332     {
1333         $this->requireAccounts();
1334         return $this->register_optional($this->w, is_null($uid) ? null : 'user_' . $uid);
1335     }
1336
1337     protected function watchJoins()
1338     {
1339         $joins = array();
1340         foreach ($this->w as $sub=>$key) {
1341             if (is_null($key)) {
1342                 $joins['w' . $sub] = PlSqlJoin::left('watch');
1343             } else {
1344                 $joins['w' . $sub] = PlSqlJoin::left('watch', '$ME.uid = {?}', substr($key, 5));
1345             }
1346         }
1347         foreach ($this->wn as $sub=>$key) {
1348             if (is_null($key)) {
1349                 $joins['wn' . $sub] = PlSqlJoin::left('watch_nonins', '$ME.ni_id = $UID');
1350             } else {
1351                 $joins['wn' . $sub] = PlSqlJoin::left('watch_nonins', '$ME.uid = {?} AND $ME.ni_id = $UID', substr($key, 5));
1352             }
1353         }
1354         foreach ($this->wn as $sub=>$key) {
1355             if (is_null($key)) {
1356                 $joins['wn' . $sub] = PlSqlJoin::left('watch_nonins', '$ME.ni_id = $UID');
1357             } else {
1358                 $joins['wn' . $sub] = PlSqlJoin::left('watch_nonins', '$ME.uid = {?} AND $ME.ni_id = $UID', substr($key, 5));
1359             }
1360         }
1361         foreach ($this->wp as $sub=>$key) {
1362             if (is_null($key)) {
1363                 $joins['wp' . $sub] = PlSqlJoin::left('watch_promo');
1364             } else {
1365                 $joins['wp' . $sub] = PlSqlJoin::left('watch_promo', '$ME.uid = {?}', substr($key, 5));
1366             }
1367         }
1368         return $joins;
1369     }
1370
1371
1372     /** PHOTOS
1373      */
1374     private $with_photo;
1375     public function addPhotoFilter()
1376     {
1377         $this->requireProfiles();
1378         $this->with_photo = true;
1379         return 'photo';
1380     }
1381
1382     protected function photoJoins()
1383     {
1384         if ($this->with_photo) {
1385             return array('photo' => PlSqlJoin::left('profile_photos', '$ME.pid = $PID'));
1386         } else {
1387             return array();
1388         }
1389     }
1390
1391
1392     /** MARKETING
1393      */
1394     private $with_rm;
1395     public function addMarketingHash()
1396     {
1397         $this->requireAccounts();
1398         $this->with_rm = true;
1399     }
1400
1401     protected function marketingJoins()
1402     {
1403         if ($this->with_rm) {
1404             return array('rm' => PlSqlJoin::left('register_marketing', '$ME.uid = $UID'));
1405         } else {
1406             return array();
1407         }
1408     }
1409 }
1410 // }}}
1411 // {{{ class ProfileFilter
1412 class ProfileFilter extends UserFilter
1413 {
1414     public function get($limit = null)
1415     {
1416         return $this->getProfiles($limit);
1417     }
1418
1419     public function getIds($limit = null)
1420     {
1421         return $this->getPIDs();
1422     }
1423
1424     public function filter(array $profiles, $limit = null)
1425     {
1426         return $this->filterProfiles($profiles, self::defaultLimit($limit));
1427     }
1428
1429     public function getTotalCount()
1430     {
1431         return $this->getTotalProfileCount();
1432     }
1433
1434     public function getGroups()
1435     {
1436         return $this->getPIDGroups();
1437     }
1438 }
1439 // }}}
1440
1441 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
1442 ?>