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     protected function groupJoins()
 850     {
 851         $joins = array();
 852         foreach ($this->gpm as $sub => $key) {
 853             if (is_null($key)) {
 854                 $joins['gpa' . $sub] = PlSqlJoin::inner('groups');
 855                 $joins['gpm' . $sub] = PlSqlJoin::left('group_members', '$ME.uid = $UID AND $ME.asso_id = gpa' . $sub . '.id');
 856             } else if (is_int($key) || ctype_digit($key)) {
 857                 $joins['gpm' . $sub] = PlSqlJoin::left('group_members', '$ME.uid = $UID AND $ME.asso_id = ' . $key);
 858             } else {
 859                 $joins['gpa' . $sub] = PlSqlJoin::inner('groups', '$ME.diminutif = {?}', $key);
 860                 $joins['gpm' . $sub] = PlSqlJoin::left('group_members', '$ME.uid = $UID AND $ME.asso_id = gpa' . $sub . '.id');
 861             }
 862         }
 863         return $joins;
 864     }
 865
 866     /** NLS
 867      */
 868     private $nls = array();
 869     public function addNewsLetterFilter($nlid)
 870     {
 871         $this->requireAccounts();
 872         $sub = 'nl_' . $nlid;
 873         $this->nls[$nlid] = $sub;
 874         return $sub;
 875     }
 876
 877     protected function newsLetterJoins()
 878     {
 879         $joins = array();
 880         foreach ($this->nls as $key => $sub) {
 881             $joins[$sub] = PlSqlJoin::left('newsletter_ins', '$ME.nlid = {?} AND $ME.uid = $UID', $key);
 882         }
 883         return $joins;
 884     }
 885
 886     /** BINETS
 887      */
 888
 889     private $with_bi = false;
 890     private $with_bd = false;
 891     public function addBinetsFilter($with_enum = false)
 892     {
 893         $this->requireProfiles();
 894         $this->with_bi = true;
 895         if ($with_enum) {
 896             $this->with_bd = true;
 897             return 'bd';
 898         } else {
 899             return 'bi';
 900         }
 901     }
 902
 903     protected function binetsJoins()
 904     {
 905         $joins = array();
 906         if ($this->with_bi) {
 907             $joins['bi'] = PlSqlJoin::left('profile_binets', '$ME.pid = $PID');
 908         }
 909         if ($this->with_bd) {
 910             $joins['bd'] = PlSqlJoin::left('profile_binet_enum', '$ME.id = bi.binet_id');
 911         }
 912         return $joins;
 913     }
 914
 915     /** EMAILS
 916      */
 917     private $ra = array();
 918     /** Allows filtering by redirection.
 919      * @param $email If null, enable a left join on the email redirection table
 920      *  (email_redirect_account); otherwise, perform a left join on users having
 921      *  that email as a redirection.
 922      * @return Suffix to use to access the adequate table.
 923      */
 924     public function addEmailRedirectFilter($email = null)
 925     {
 926         $this->requireAccounts();
 927         return $this->register_optional($this->ra, $email);
 928     }
 929
 930     const ALIAS_BEST      = 'bestalias';
 931     const ALIAS_FORLIFE   = 'forlife';
 932     const ALIAS_AUXILIARY = 'alias_aux';
 933     private $sa = array();
 934     /** Allows filtering by source email.
 935      * @param $email If null, enable a left join on the email source table
 936      *  (email_source_account); otherwise, perform a left join on users having
 937      *  that email as a source email.
 938      * @return Suffix to use to access the adequate table.
 939      */
 940     public function addAliasFilter($email = null)
 941     {
 942         $this->requireAccounts();
 943         return $this->register_optional($this->sa, $email);
 944     }
 945
 946     private $with_rf = false;
 947     /** Allows filtering by active redirection.
 948      * @return Suffix to use to access the adequate table.
 949      */
 950     public function addActiveEmailRedirectFilter($email = null)
 951     {
 952         $this->requireAccounts();
 953         $this->with_rf = true;
 954     }
 955
 956     protected function emailJoins()
 957     {
 958         global $globals;
 959         $joins = array();
 960         foreach ($this->ra as $sub => $redirections) {
 961             if (is_null($redirections)) {
 962                 $joins['ra' . $sub] = PlSqlJoin::left('email_redirect_account', '$ME.uid = $UID AND $ME.type != \'imap\'');
 963             } else {
 964                 if (!is_array($redirections)) {
 965                     $key = array($redirections);
 966                 }
 967                 $joins['ra' . $sub] = PlSqlJoin::left('email_redirect_account', '$ME.uid = $UID AND $ME.type != \'imap\'
 968                                                                                  AND $ME.redirect IN {?}', $redirections);
 969             }
 970         }
 971         foreach ($this->sa as $sub => $emails) {
 972             if (is_null($emails)) {
 973                 $joins['sa' . $sub] = PlSqlJoin::left('email_source_account', '$ME.uid = $UID');
 974             } else if ($sub == self::ALIAS_BEST) {
 975                 $joins['sa' . $sub] = PlSqlJoin::left('email_source_account', '$ME.uid = $UID AND FIND_IN_SET(\'bestalias\', $ME.flags)');
 976             } else if ($sub == self::ALIAS_FORLIFE) {
 977                 $joins['sa' . $sub] = PlSqlJoin::left('email_source_account', '$ME.uid = $UID AND $ME.type = \'forlife\'');
 978             } else if ($sub == self::ALIAS_AUXILIARY) {
 979                 $joins['sa' . $sub] = PlSqlJoin::left('email_source_account', '$ME.uid = $UID AND $ME.type = \'alias_aux\'');
 980             } else {
 981                 if (!is_array($emails)) {
 982                     $key = array($emails);
 983                 }
 984                 $joins['sa' . $sub] = PlSqlJoin::left('email_source_account', '$ME.uid = $UID AND $ME.email IN {?}', $emails);
 985             }
 986         }
 987         if ($this->with_rf) {
 988             $joins['rf'] = PlSqlJoin::left('email_redirect_account', '$ME.uid = $UID AND $ME.type != \'imap\' AND $ME.flags = \'active\'');;
 989         }
 990         return $joins;
 991     }
 992
 993
 994     /** ADDRESSES
 995      */
 996     private $types = array();
 997     public function addAddressFilter($type)
 998     {
 999         $this->requireProfiles();
1000         $this->with_pa = true;
1001
1002         $sub = '_' . $this->option++;
1003         $this->types[$type] = $sub;
1004         return $sub;
1005     }
1006
1007     protected function addressJoins()
1008     {
1009         $joins = array();
1010         foreach ($this->types as $type => $sub) {
1011             $joins['pa' . $sub] = PlSqlJoin::inner('profile_addresses', '$ME.pid = $PID');
1012             $joins['pac' . $sub] = PlSqlJoin::inner('profile_addresses_components',
1013                                                     '$ME.pid = pa' . $sub . '.pid AND $ME.jobid = pa' . $sub . '.jobid AND $ME.groupid = pa' . $sub . '.groupid AND $ME.type = pa' . $sub . '.type AND $ME.id = pa' . $sub . '.id');
1014             $joins['pace' . $sub] = PlSqlJoin::inner('profile_addresses_components_enum',
1015                                                      '$ME.id = pac' . $sub . '.component_id AND FIND_IN_SET({?}, $ME.types)', $type);
1016         }
1017
1018         return $joins;
1019     }
1020
1021
1022     /** CORPS
1023      */
1024
1025     private $pc = false;
1026     private $pce = array();
1027     private $pcr = false;
1028     public function addCorpsFilter($type)
1029     {
1030         $this->requireProfiles();
1031         $this->pc = true;
1032         if ($type == UFC_Corps::CURRENT) {
1033             $this->pce['pcec'] = 'current_corpsid';
1034             return 'pcec';
1035         } else if ($type == UFC_Corps::ORIGIN) {
1036             $this->pce['pceo'] = 'original_corpsid';
1037             return 'pceo';
1038         }
1039     }
1040
1041     public function addCorpsRankFilter()
1042     {
1043         $this->requireProfiles();
1044         $this->pc = true;
1045         $this->pcr = true;
1046         return 'pcr';
1047     }
1048
1049     protected function corpsJoins()
1050     {
1051         $joins = array();
1052         if ($this->pc) {
1053             $joins['pc'] = PlSqlJoin::left('profile_corps', '$ME.pid = $PID');
1054         }
1055         if ($this->pcr) {
1056             $joins['pcr'] = PlSqlJoin::left('profile_corps_rank_enum', '$ME.id = pc.rankid');
1057         }
1058         foreach($this->pce as $sub => $field) {
1059             $joins[$sub] = PlSqlJoin::left('profile_corps_enum', '$ME.id = pc.' . $field);
1060         }
1061         return $joins;
1062     }
1063
1064     /** JOBS
1065      */
1066
1067     const JOB_USERDEFINED = 0x0001;
1068     const JOB_CV          = 0x0002;
1069     const JOB_ANY         = 0x0003;
1070
1071     /** Joins :
1072      * pj => profile_job
1073      * pje => profile_job_enum
1074      * pjt => profile_job_terms
1075      */
1076     private $with_pj  = false;
1077     private $with_pje = false;
1078     private $with_pjt = 0;
1079
1080     public function addJobFilter()
1081     {
1082         $this->requireProfiles();
1083         $this->with_pj = true;
1084         return 'pj';
1085     }
1086
1087     public function addJobCompanyFilter()
1088     {
1089         $this->addJobFilter();
1090         $this->with_pje = true;
1091         return 'pje';
1092     }
1093
1094     /**
1095      * Adds a filter on job terms of profile.
1096      * @param $nb the number of job terms to use
1097      * @return an array of the fields to filter (one for each term).
1098      */
1099     public function addJobTermsFilter($nb = 1)
1100     {
1101         $this->with_pjt = $nb;
1102         $jobtermstable = array();
1103         for ($i = 1; $i <= $nb; ++$i) {
1104             $jobtermstable[] = 'pjtr_'.$i;
1105         }
1106         return $jobtermstable;
1107     }
1108
1109     protected function jobJoins()
1110     {
1111         $joins = array();
1112         if ($this->with_pj) {
1113             $joins['pj'] = PlSqlJoin::left('profile_job', '$ME.pid = $PID');
1114         }
1115         if ($this->with_pje) {
1116             $joins['pje'] = PlSqlJoin::left('profile_job_enum', '$ME.id = pj.jobid');
1117         }
1118         if ($this->with_pjt > 0) {
1119             for ($i = 1; $i <= $this->with_pjt; ++$i) {
1120                 $joins['pjt_'.$i] = PlSqlJoin::left('profile_job_term', '$ME.pid = $PID');
1121                 $joins['pjtr_'.$i] = PlSqlJoin::left('profile_job_term_relation', '$ME.jtid_2 = pjt_'.$i.'.jtid');
1122             }
1123         }
1124         return $joins;
1125     }
1126
1127     /** NETWORKING
1128      */
1129
1130     private $with_pnw = false;
1131     public function addNetworkingFilter()
1132     {
1133         $this->requireAccounts();
1134         $this->with_pnw = true;
1135         return 'pnw';
1136     }
1137
1138     protected function networkingJoins()
1139     {
1140         $joins = array();
1141         if ($this->with_pnw) {
1142             $joins['pnw'] = PlSqlJoin::left('profile_networking', '$ME.pid = $PID');
1143         }
1144         return $joins;
1145     }
1146
1147     /** PHONE
1148      */
1149
1150     private $with_ptel = false;
1151
1152     public function addPhoneFilter()
1153     {
1154         $this->requireAccounts();
1155         $this->with_ptel = true;
1156         return 'ptel';
1157     }
1158
1159     protected function phoneJoins()
1160     {
1161         $joins = array();
1162         if ($this->with_ptel) {
1163             $joins['ptel'] = PlSqlJoin::left('profile_phones', '$ME.pid = $PID');
1164         }
1165         return $joins;
1166     }
1167
1168     /** MEDALS
1169      */
1170
1171     private $with_pmed = false;
1172     public function addMedalFilter()
1173     {
1174         $this->requireProfiles();
1175         $this->with_pmed = true;
1176         return 'pmed';
1177     }
1178
1179     protected function medalJoins()
1180     {
1181         $joins = array();
1182         if ($this->with_pmed) {
1183             $joins['pmed'] = PlSqlJoin::left('profile_medals', '$ME.pid = $PID');
1184         }
1185         return $joins;
1186     }
1187
1188     /** DELTATEN
1189      */
1190     private $dts = array();
1191     const DELTATEN = 1;
1192     const DELTATEN_MESSAGE = 2;
1193     // TODO: terms
1194
1195     public function addDeltaTenFilter($type)
1196     {
1197         $this->requireProfiles();
1198         switch ($type) {
1199         case self::DELTATEN:
1200             $this->dts['pdt'] = 'profile_deltaten';
1201             return 'pdt';
1202         case self::DELTATEN_MESSAGE:
1203             $this->dts['pdtm'] = 'profile_deltaten';
1204             return 'pdtm';
1205         default:
1206             Platal::page()->killError("Undefined DeltaTen filter.");
1207         }
1208     }
1209
1210     protected function deltatenJoins()
1211     {
1212         $joins = array();
1213         foreach ($this->dts as $sub => $tab) {
1214             $joins[$sub] = PlSqlJoin::left($tab, '$ME.pid = $PID');
1215         }
1216         return $joins;
1217     }
1218
1219     /** MENTORING
1220      */
1221
1222     private $pms = array();
1223     private $mjtr = false;
1224     const MENTOR = 1;
1225     const MENTOR_EXPERTISE = 2;
1226     const MENTOR_COUNTRY = 3;
1227     const MENTOR_TERM = 4;
1228
1229     public function addMentorFilter($type)
1230     {
1231         $this->requireProfiles();
1232         switch($type) {
1233         case self::MENTOR:
1234             $this->pms['pm'] = 'profile_mentor';
1235             return 'pm';
1236         case self::MENTOR_EXPERTISE:
1237             $this->pms['pme'] = 'profile_mentor';
1238             return 'pme';
1239         case self::MENTOR_COUNTRY:
1240             $this->pms['pmc'] = 'profile_mentor_country';
1241             return 'pmc';
1242         case self::MENTOR_TERM:
1243             $this->pms['pmt'] = 'profile_mentor_term';
1244             $this->mjtr = true;
1245             return 'mjtr';
1246         default:
1247             Platal::page()->killError("Undefined mentor filter.");
1248         }
1249     }
1250
1251     protected function mentorJoins()
1252     {
1253         $joins = array();
1254         foreach ($this->pms as $sub => $tab) {
1255             $joins[$sub] = PlSqlJoin::left($tab, '$ME.pid = $PID');
1256         }
1257         if ($this->mjtr) {
1258             $joins['mjtr'] = PlSqlJoin::left('profile_job_term_relation', '$ME.jtid_2 = pmt.jtid');
1259         }
1260         return $joins;
1261     }
1262
1263     /** CONTACTS
1264      */
1265     private $cts = array();
1266     public function addContactFilter($uid = null)
1267     {
1268         $this->requireProfiles();
1269         return $this->register_optional($this->cts, is_null($uid) ? null : 'user_' . $uid);
1270     }
1271
1272     protected function contactJoins()
1273     {
1274         $joins = array();
1275         foreach ($this->cts as $sub=>$key) {
1276             if (is_null($key)) {
1277                 $joins['c' . $sub] = PlSqlJoin::left('contacts', '$ME.contact = $PID');
1278             } else {
1279                 $joins['c' . $sub] = PlSqlJoin::left('contacts', '$ME.uid = {?} AND $ME.contact = $PID', substr($key, 5));
1280             }
1281         }
1282         return $joins;
1283     }
1284
1285
1286     /** CARNET
1287      */
1288     private $wn = array();
1289     public function addWatchRegistrationFilter($uid = null)
1290     {
1291         $this->requireAccounts();
1292         return $this->register_optional($this->wn, is_null($uid) ? null : 'user_' . $uid);
1293     }
1294
1295     private $wp = array();
1296     public function addWatchPromoFilter($uid = null)
1297     {
1298         $this->requireAccounts();
1299         return $this->register_optional($this->wp, is_null($uid) ? null : 'user_' . $uid);
1300     }
1301
1302     private $w = array();
1303     public function addWatchFilter($uid = null)
1304     {
1305         $this->requireAccounts();
1306         return $this->register_optional($this->w, is_null($uid) ? null : 'user_' . $uid);
1307     }
1308
1309     protected function watchJoins()
1310     {
1311         $joins = array();
1312         foreach ($this->w as $sub=>$key) {
1313             if (is_null($key)) {
1314                 $joins['w' . $sub] = PlSqlJoin::left('watch');
1315             } else {
1316                 $joins['w' . $sub] = PlSqlJoin::left('watch', '$ME.uid = {?}', substr($key, 5));
1317             }
1318         }
1319         foreach ($this->wn as $sub=>$key) {
1320             if (is_null($key)) {
1321                 $joins['wn' . $sub] = PlSqlJoin::left('watch_nonins', '$ME.ni_id = $UID');
1322             } else {
1323                 $joins['wn' . $sub] = PlSqlJoin::left('watch_nonins', '$ME.uid = {?} AND $ME.ni_id = $UID', substr($key, 5));
1324             }
1325         }
1326         foreach ($this->wn as $sub=>$key) {
1327             if (is_null($key)) {
1328                 $joins['wn' . $sub] = PlSqlJoin::left('watch_nonins', '$ME.ni_id = $UID');
1329             } else {
1330                 $joins['wn' . $sub] = PlSqlJoin::left('watch_nonins', '$ME.uid = {?} AND $ME.ni_id = $UID', substr($key, 5));
1331             }
1332         }
1333         foreach ($this->wp as $sub=>$key) {
1334             if (is_null($key)) {
1335                 $joins['wp' . $sub] = PlSqlJoin::left('watch_promo');
1336             } else {
1337                 $joins['wp' . $sub] = PlSqlJoin::left('watch_promo', '$ME.uid = {?}', substr($key, 5));
1338             }
1339         }
1340         return $joins;
1341     }
1342
1343
1344     /** PHOTOS
1345      */
1346     private $with_photo;
1347     public function addPhotoFilter()
1348     {
1349         $this->requireProfiles();
1350         $this->with_photo = true;
1351         return 'photo';
1352     }
1353
1354     protected function photoJoins()
1355     {
1356         if ($this->with_photo) {
1357             return array('photo' => PlSqlJoin::left('profile_photos', '$ME.pid = $PID'));
1358         } else {
1359             return array();
1360         }
1361     }
1362
1363
1364     /** MARKETING
1365      */
1366     private $with_rm;
1367     public function addMarketingHash()
1368     {
1369         $this->requireAccounts();
1370         $this->with_rm = true;
1371     }
1372
1373     protected function marketingJoins()
1374     {
1375         if ($this->with_rm) {
1376             return array('rm' => PlSqlJoin::left('register_marketing', '$ME.uid = $UID'));
1377         } else {
1378             return array();
1379         }
1380     }
1381 }
1382 // }}}
1383 // {{{ class ProfileFilter
1384 class ProfileFilter extends UserFilter
1385 {
1386     public function get($limit = null)
1387     {
1388         return $this->getProfiles($limit);
1389     }
1390
1391     public function getIds($limit = null)
1392     {
1393         return $this->getPIDs();
1394     }
1395
1396     public function filter(array $profiles, $limit = null)
1397     {
1398         return $this->filterProfiles($profiles, self::defaultLimit($limit));
1399     }
1400
1401     public function getTotalCount()
1402     {
1403         return $this->getTotalProfileCount();
1404     }
1405
1406     public function getGroups()
1407     {
1408         return $this->getPIDGroups();
1409     }
1410 }
1411 // }}}
1412
1413 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
1414 ?>