BugFix in UFC_Registered
[platal.git] / classes / userfilter.php
index 738c702..9dca690 100644 (file)
  ******************/
 
 // {{{ interface UserFilterCondition
+/** This interface describe objects which filter users based
+ *      on various parameters.
+ * The parameters of the filter must be given to the constructor.
+ * The buildCondition function is called by UserFilter when
+ *     actually building the query. That function must call
+ *     $uf->addWheteverFilter so that the UserFilter makes
+ *     adequate joins. It must return the 'WHERE' condition to use
+ *     with the filter.
+ */
 interface UserFilterCondition
 {
-    const COND_TRUE  = 'TRUE';
-    const COND_FALSE = 'FALSE';
-
     /** Check that the given user matches the rule.
      */
     public function buildCondition(UserFilter &$uf);
 }
 // }}}
 
-// {{{ class UFC_OneChild
-abstract class UFC_OneChild implements UserFilterCondition
-{
-    protected $child;
-
-    public function __construct($child = null)
-    {
-        if (!is_null($child) && ($child instanceof UserFilterCondition)) {
-            $this->setChild($child);
-        }
-    }
-
-    public function setChild(UserFilterCondition &$cond)
-    {
-        $this->child =& $cond;
-    }
-}
-// }}}
-
-// {{{ class UFC_NChildren
-abstract class UFC_NChildren implements UserFilterCondition
-{
-    protected $children = array();
-
-    public function __construct()
-    {
-        $children = func_get_args();
-        foreach ($children as &$child) {
-            if (!is_null($child) && ($child instanceof UserFilterCondition)) {
-                $this->addChild($child);
-            }
-        }
-    }
-
-    public function addChild(UserFilterCondition &$cond)
-    {
-        $this->children[] =& $cond;
-    }
-
-    protected function catConds(array $cond, $op, $fallback)
-    {
-        if (count($cond) == 0) {
-            return $fallback;
-        } else if (count($cond) == 1) {
-            return $cond[0];
-        } else {
-            return '(' . implode(') ' . $op . ' (', $cond) . ')';
-        }
-    }
-}
-// }}}
-
-// {{{ class UFC_True
-class UFC_True implements UserFilterCondition
-{
-    public function buildCondition(UserFilter &$uf)
-    {
-        return self::COND_TRUE;
-    }
-}
-// }}}
-
-// {{{ class UFC_False
-class UFC_False implements UserFilterCondition
-{
-    public function buildCondition(UserFilter &$uf)
-    {
-        return self::COND_FALSE;
-    }
-}
-// }}}
-
-// {{{ class UFC_Not
-class UFC_Not extends UFC_OneChild
-{
-    public function buildCondition(UserFilter &$uf)
-    {
-        $val = $this->child->buildCondition($uf);
-        if ($val == self::COND_TRUE) {
-            return self::COND_FALSE;
-        } else if ($val == self::COND_FALSE) {
-            return self::COND_TRUE;
-        } else {
-            return 'NOT (' . $val . ')';
-        }
-    }
-}
-// }}}
-
-// {{{ class UFC_And
-class UFC_And extends UFC_NChildren
-{
-    public function buildCondition(UserFilter &$uf)
-    {
-        if (empty($this->children)) {
-            return self::COND_FALSE;
-        } else {
-            $true = self::COND_FALSE;
-            $conds = array();
-            foreach ($this->children as &$child) {
-                $val = $child->buildCondition($uf);
-                if ($val == self::COND_TRUE) {
-                    $true = self::COND_TRUE;
-                } else if ($val == self::COND_FALSE) {
-                    return self::COND_FALSE;
-                } else {
-                    $conds[] = $val;
-                }
-            }
-            return $this->catConds($conds, 'AND', $true);
-        }
-    }
-}
-// }}}
-
-// {{{ class UFC_Or
-class UFC_Or extends UFC_NChildren
-{
-    public function buildCondition(UserFilter &$uf)
-    {
-        if (empty($this->children)) {
-            return self::COND_TRUE;
-        } else {
-            $true = self::COND_TRUE;
-            $conds = array();
-            foreach ($this->children as &$child) {
-                $val = $child->buildCondition($uf);
-                if ($val == self::COND_TRUE) {
-                    return self::COND_TRUE;
-                } else if ($val == self::COND_FALSE) {
-                    $true = self::COND_FALSE;
-                } else {
-                    $conds[] = $val;
-                }
-            }
-            return $this->catConds($conds, 'OR', $true);
-        }
-    }
-}
-// }}}
-
 // {{{ class UFC_Profile
 /** Filters users who have a profile
  */
@@ -190,10 +55,10 @@ class UFC_Profile implements UserFilterCondition
 // }}}
 
 // {{{ class UFC_Promo
-/** Filters users based on promo
+/** Filters users based on promotion
  * @param $comparison Comparison operator (>, =, ...)
  * @param $grade Formation on which to restrict, UserFilter::DISPLAY for "any formation"
- * @param $promo Promo on which the filter is based
+ * @param $promo Promotion on which the filter is based
  */
 class UFC_Promo implements UserFilterCondition
 {
@@ -216,7 +81,7 @@ class UFC_Promo implements UserFilterCondition
     {
         if ($this->grade == UserFilter::DISPLAY) {
             $sub = $uf->addDisplayFilter();
-            return XDB::format('pd' . $sub . '.promo = {?}', $this->promo);
+            return XDB::format('pd' . $sub . '.promo ' . $this->comparison . ' {?}', $this->promo);
         } else {
             $sub = $uf->addEducationFilter(true, $this->grade);
             $field = 'pe' . $sub . '.' . UserFilter::promoYear($this->grade);
@@ -228,9 +93,9 @@ class UFC_Promo implements UserFilterCondition
 
 // {{{ class UFC_Name
 /** Filters users based on name
- * @param $type Type of name field on which filtering is done (firstname, lastname...)
+ * @param $type Type of name field on which filtering is done (firstname, lastname...)
  * @param $text Text on which to filter
- * @param $mode flag indicating search type (prefix, suffix, with particule, ...)
+ * @param $mode Flag indicating search type (prefix, suffix, with particule...)
  */
 class UFC_Name implements UserFilterCondition
 {
@@ -327,7 +192,7 @@ class UFC_Registered implements UserFilterCondition
 
     public function __construct($active = false, $comparison = null, $date = null)
     {
-        $this->only_active = $active;
+        $this->active = $active;
         $this->comparison = $comparison;
         $this->date = $date;
     }
@@ -418,24 +283,24 @@ class UFC_Sex implements UserFilterCondition
 
 // {{{ class UFC_Group
 /** Filters users based on group membership
- * @param $group Group whose member we are selecting
- * @param $admin Whether to restrict selection to admins of that group
+ * @param $group Group whose members we are selecting
+ * @param $anim Whether to restrict selection to animators of that group
  */
 class UFC_Group implements UserFilterCondition
 {
     private $group;
-    private $admin;
-    public function __construct($group, $admin = false)
+    private $anim;
+    public function __construct($group, $anim = false)
     {
         $this->group = $group;
-        $this->admin = $admin;
+        $this->anim = $anim;
     }
 
     public function buildCondition(UserFilter &$uf)
     {
         $sub = $uf->addGroupFilter($this->group);
         $where = 'gpm' . $sub . '.perms IS NOT NULL';
-        if ($this->admin) {
+        if ($this->anim) {
             $where .= ' AND gpm' . $sub . '.perms = \'admin\'';
         }
         return $where;
@@ -473,7 +338,7 @@ class UFC_Email implements UserFilterCondition
 // }}}
 
 // {{{ class UFC_EmailList
-/** Filters users base on an email list
+/** Filters users based on an email list
  * @param $emails List of emails whose owner must be selected
  */
 class UFC_EmailList implements UserFilterCondition
@@ -521,44 +386,127 @@ class UFC_EmailList implements UserFilterCondition
 
 // {{{ class UFC_Address
 /** Filters users based on their address
- * @param $field Field of the address used for filtering (city, street, ...)
- * @param $text Text for filter
- * @param $mode Mode for search (PREFIX, SUFFIX, ...)
+ * @param $text Text for filter in fulltext search
+ * @param $textSearchMode Mode for search (PREFIX, SUFFIX, ...)
+ * @param $type Filter on address type
+ * @param $flags Filter on address flags
+ * @param $countryId Filter on address countryId
+ * @param $administrativeAreaId Filter on address administrativeAreaId
+ * @param $subAdministrativeAreaId Filter on address subAdministrativeAreaId
+ * @param $localityId Filter on address localityId
+ * @param $postalCode Filter on address postalCode
  */
 class UFC_Address implements UserFilterCondition
 {
-    const PREFIX    = 1;
-    const SUFFIX    = 2;
-    const CONTAINS  = 3;
+    /** Flags for text search
+     */
+    const PREFIX    = 0x0001;
+    const SUFFIX    = 0x0002;
+    const CONTAINS  = 0x0003;
 
-    private $field;
-    private $text;
-    private $mode;
+    /** Valid address type ('hq' is reserved for company addresses)
+     */
+    const TYPE_HOME = 'home';
+    const TYPE_PRO  = 'job';
 
-    public function __construct($field, $text, $mode)
-    {
-        $this->field = $field;
-        $this->text  = $text;
-        $this->mode  = $mode;
+    /** Flags for addresses
+     */
+    const FLAG_CURRENT = 0x0001;
+    const FLAG_TEMP    = 0x0002;
+    const FLAG_SECOND  = 0x0004;
+    const FLAG_MAIL    = 0x0008;
+    const FLAG_CEDEX   = 0x0010;
+
+    // Binary OR of those flags
+    const FLAG_ANY     = 0x001F;
+
+    /** Text of these flags
+     */
+    private static $flagtexts = array(
+        self::FLAG_CURRENT => 'current',
+        self::FLAG_TEMP    => 'temporary',
+        self::FLAG_SECOND  => 'secondary',
+        self::FLAG_MAIL    => 'mail',
+        self::FLAG_CEDEX   => 'cedex',
+    );
+
+    /** Data of the filter
+     */
+    private $text;
+    private $type;
+    private $flags;
+    private $countryId;
+    private $administrativeAreaId;
+    private $subAdministrativeAreaId;
+    private $localityId;
+    private $postalCode;
+
+    private $textSearchMode;
+
+    public function __construct($text = null, $textSearchMode = self::CONTAINS,
+        $type = null, $flags = self::FLAG_ANY, $countryId = null, $administrativeAreaId = null,
+        $subAdministrativeAreaId = null, $localityId = null, $postalCode = null)
+    {
+        $this->text                      = $text;
+        $this->textSearchMode            = $textSearchMode;
+        $this->type                      = $type;
+        $this->flags                     = $flags;
+        $this->countryId                 = $countryId;
+        $this->administrativeAreaId      = $administrativeAreaId;
+        $this->subAdministrativeAreaId   = $subAdministrativeAreaId;
+        $this->localityId                = $localityId;
+        $this->postalCode                = $postalCode;
     }
 
     public function buildCondition(UserFilter &$uf)
     {
-        $left = 'pa.' . $field;
-        $op   = ' LIKE ';
-        if (($this->mode & self::CONTAINS) == 0) {
-            $right = XDB::format('{?}', $this->text);
-            $op = ' = ';
-        } else if (($this->mode & self::CONTAINS) == self::PREFIX) {
-            $right = XDB::format('CONCAT({?}, \'%\')', $this->text);
-        } else if (($this->mode & self::CONTAINS) == self::SUFFIX) {
-            $right = XDB::format('CONCAT(\'%\', {?})', $this->text);
-        } else {
-            $right = XDB::format('CONCAT(\'%\', {?}, \'%\')', $this->text);
+        $sub = $uf->addAddressFilter();
+        $conds = array();
+        if ($this->text != null) {
+            $left = $sub . '.text ';
+            $op = ' LIKE ';
+            if (($this->textSearchMode & self::CONTAINS) == 0) {
+                $right = XDB::format('{?}', $this->text);
+                $op = ' = ';
+            } else if (($this->mode & self::CONTAINS) == self::PREFIX) {
+                $right = XDB::format('CONCAT({?}, \'%\')', $this->text);
+            } else if (($this->mode & self::CONTAINS) == self::SUFFIX) {
+                $right = XDB::format('CONCAT(\'%\', {?})', $this->text);
+            } else {
+                $right = XDB::format('CONCAT(\'%\', {?}, \'%\')', $this->text);
+            }
+            $conds[] = $left . $op . $right;
         }
-        $cond = $left . $op . $right;
-        $uf->addAddressFilter();
-        return $cond;
+
+        if ($this->type != null) {
+            $conds[] = $sub . '.type = ' . XDB::format('{?}', $this->type);
+        }
+
+        if ($this->flags != self::FLAG_ANY) {
+            foreach(self::$flagtexts as $flag => $text) {
+                if ($flag & $this->flags) {
+                    $conds[] = 'FIND_IN_SET(' . XDB::format('{?}', $text) . ', ' . $sub . '.flags)';
+                }
+            }
+        }
+
+        if ($this->countryId != null) {
+            $conds[] = $sub . '.countryId = ' . XDB::format('{?}', $this->countryId);
+        }
+        if ($this->administrativeAreaId != null) {
+            $conds[] = $sub . '.administrativeAreaId = ' . XDB::format('{?}', $this->administrativeAreaId);
+        }
+        if ($this->subAdministrativeAreaId != null) {
+            $conds[] = $sub . '.subAdministrativeAreaId = ' . XDB::format('{?}', $this->subAdministrativeAreaId);
+        }
+        if ($this->localityId != null) {
+            $conds[] = $sub . '.localityId = ' . XDB::format('{?}', $this->localityId);
+        }
+        if ($this->postalCode != null) {
+            $conds[] = $sub . '.postalCode = ' . XDB::format('{?}', $this->postalCode);
+        }
+
+        return implode(' AND ', $conds);
     }
 }
 // }}}
@@ -570,8 +518,8 @@ class UFC_Address implements UserFilterCondition
  */
 class UFC_Corps implements UserFilterCondition
 {
-    const CURRENT=1;
-    const ORIGIN=2;
+    const CURRENT   = 1;
+    const ORIGIN    = 2;
 
     private $corps;
     private $type;
@@ -584,8 +532,8 @@ class UFC_Corps implements UserFilterCondition
 
     public function buildCondition(UserFilter &$uf)
     {
-        /** Tables shortcuts :
-         * pc for profile corps,
+        /** Tables shortcuts:
+         * pc for profile_corps,
          * pceo for profile_corps_enum - orginal
          * pcec for profile_corps_enum - current
          */
@@ -610,7 +558,7 @@ class UFC_Corps_Rank implements UserFilterCondition
 
     public function buildCondition(UserFilter &$uf)
     {
-        /** Tables shortcuts :
+        /** Tables shortcuts:
          * pcr for profile_corps_rank
          */
         $sub = $uf->addCorpsRankFilter();
@@ -625,7 +573,7 @@ class UFC_Corps_Rank implements UserFilterCondition
  * @param $type The field being searched (self::JOBID, self::JOBNAME or self::JOBACRONYM)
  * @param $value The searched value
  */
-class UFC_Job_Company extends UserFilterCondition
+class UFC_Job_Company implements UserFilterCondition
 {
     const JOBID = 'id';
     const JOBNAME = 'name';
@@ -644,7 +592,7 @@ class UFC_Job_Company extends UserFilterCondition
     private function assertType($type)
     {
         if ($type != self::JOBID && $type != self::JOBNAME && $type != self::JOBACRONYM) {
-            Platal::page()->killError("Type de recherche non valide");
+            Platal::page()->killError("Type de recherche non valide.");
         }
     }
 
@@ -663,7 +611,7 @@ class UFC_Job_Company extends UserFilterCondition
  * @param $subsector The subsector
  * @param $subsubsector The subsubsector
  */
-class UFC_Job_Sectorization extends UserFilterCondition
+class UFC_Job_Sectorization implements UserFilterCondition
 {
 
     private $sector;
@@ -703,7 +651,7 @@ class UFC_Job_Sectorization extends UserFilterCondition
  * @param $description The text being searched for
  * @param $fields The fields to search for (user-defined, ((sub|)sub|)sector)
  */
-class UFC_Job_Description extends UserFilterCondition
+class UFC_Job_Description implements UserFilterCondition
 {
 
     /** Meta-filters
@@ -752,7 +700,7 @@ class UFC_Job_Description extends UserFilterCondition
  * @param $type Type of network (-1 for any)
  * @param $value Value to search
  */
-class UFC_Networking extends UserFilterCondition
+class UFC_Networking implements UserFilterCondition
 {
     private $type;
     private $value;
@@ -782,7 +730,7 @@ class UFC_Networking extends UserFilterCondition
  * @param $phone_type Type of phone (fixed/mobile/fax)
  * @param $number Phone number
  */
-class UFC_Phone extends UserFilterCondition
+class UFC_Phone implements UserFilterCondition
 {
     const NUM_PRO   = 'pro';
     const NUM_USER  = 'user';
@@ -827,7 +775,7 @@ class UFC_Phone extends UserFilterCondition
  * @param $medal ID of the medal
  * @param $grade Grade of the medal (null for 'any')
  */
-class UFC_Medal extends UserFilterCondition
+class UFC_Medal implements UserFilterCondition
 {
     private $medal;
     private $grade;
@@ -851,8 +799,79 @@ class UFC_Medal extends UserFilterCondition
 }
 // }}}
 
+// {{{ class UFC_Mentor_Expertise
+/** Filters users by mentoring expertise
+ * @param $expertise Domain of expertise
+ */
+class UFC_Mentor_Expertise implements UserFilterCondition
+{
+    private $expertise;
+
+    public function __construct($expertise)
+    {
+        $this->expertise = $expertise;
+    }
+
+    public function buildCondition(UserFilter &$uf)
+    {
+        $sub = $uf->addMentorFilter(UserFilter::MENTOR_EXPERTISE);
+        return $sub . '.expertise LIKE ' . XDB::format('CONCAT(\'%\', {?}, \'%\'', $this->expertise);
+    }
+}
+// }}}
+
+// {{{ class UFC_Mentor_Country
+/** Filters users by mentoring country
+ * @param $country Two-letters code of country being searched
+ */
+class UFC_Mentor_Country implements UserFilterCondition
+{
+    private $country;
+
+    public function __construct($country)
+    {
+        $this->country = $country;
+    }
+
+    public function buildCondition(UserFilter &$uf)
+    {
+        $sub = $uf->addMentorFilter(UserFilter::MENTOR_COUNTRY);
+        return $sub . '.country = ' . XDB::format('{?}', $this->country);
+    }
+}
+// }}}
+
+// {{{ class UFC_Mentor_Sectorization
+/** Filters users based on mentoring (sub|)sector
+ * @param $sector ID of sector
+ * @param $subsector Subsector (null for any)
+ */
+class UFC_Mentor_Sectorization implements UserFilterCondition
+{
+    private $sector;
+    private $subsector;
+
+    public function __construct($sector, $subsector = null)
+    {
+        $this->sector = $sector;
+        $this->subsubsector = $subsector;
+    }
+
+    public function buildCondition(UserFilter &$uf)
+    {
+        $sub = $uf->addMentorFilter(UserFilter::MENTOR_SECTOR);
+        $conds = array();
+        $conds[] = $sub . '.sectorid = ' . XDB::format('{?}', $this->sector);
+        if ($this->subsector != null) {
+            $conds[] = $sub . '.subsectorid = ' . XDB::format('{?}', $this->subsector);
+        }
+        return implode(' AND ', $conds);
+    }
+}
+// }}}
+
 // {{{ class UFC_UserRelated
-/** Filters users based on a relation toward on user
+/** Filters users based on a relation toward a user
  * @param $user User to which searched users are related
  */
 abstract class UFC_UserRelated implements UserFilterCondition
@@ -866,7 +885,7 @@ abstract class UFC_UserRelated implements UserFilterCondition
 // }}}
 
 // {{{ class UFC_Contact
-/** Filters users who belongs to selected user's contacts
+/** Filters users who belong to selected user's contacts
  */
 class UFC_Contact extends UFC_UserRelated
 {
@@ -947,35 +966,24 @@ class UFC_WatchContact extends UFC_Contact
  ******************/
 
 // {{{ class UserFilterOrder
-abstract class UserFilterOrder
+/** Base class for ordering results of a query.
+ * Parameters for the ordering must be given to the constructor ($desc for a
+ *     descending order).
+ * The getSortTokens function is used to get actual ordering part of the query.
+ */
+abstract class UserFilterOrder extends PlFilterOrder
 {
-    protected $desc = false;
-    public function __construct($desc = false)
-    {
-        $this->desc = $desc;
-    }
-
-    public function buildSort(UserFilter &$uf)
-    {
-        $sel = $this->getSortTokens($uf);
-        if (!is_array($sel)) {
-            $sel = array($sel);
-        }
-        if ($this->desc) {
-            foreach ($sel as $k=>$s) {
-                $sel[$k] = $s . ' DESC';
-            }
-        }
-        return $sel;
-    }
-
+    /** This function must return the tokens to use for ordering
+     * @param &$uf The UserFilter whose results must be ordered
+     * @return The name of the field to use for ordering results
+     */
     abstract protected function getSortTokens(UserFilter &$uf);
 }
 // }}}
 
 // {{{ class UFO_Promo
-/** Orders users by promo
- * @param $grade Formation whose promo users should be sorted by (restricts results to users of that formation)
+/** Orders users by promotion
+ * @param $grade Formation whose promotion users should be sorted by (restricts results to users of that formation)
  * @param $desc Whether sort is descending
  */
 class UFO_Promo extends UserFilterOrder
@@ -1003,8 +1011,8 @@ class UFO_Promo extends UserFilterOrder
 
 // {{{ class UFO_Name
 /** Sorts users by name
- * @param $type Type of name on which to sort (firstname...)
- * @param $variant Variant of that name to user (marital, ordinary, ...)
+ * @param $type Type of name on which to sort (firstname...)
+ * @param $variant Variant of that name to use (marital, ordinary...)
  * @param $particle Set to true if particles should be included in the sorting order
  * @param $desc If sort order should be descending
  */
@@ -1095,9 +1103,53 @@ class UFO_Death extends UserFilterOrder
  ***********************************/
 
 // {{{ class UserFilter
+/** This class provides a convenient and centralized way of filtering users.
+ *
+ * Usage:
+ * $uf = new UserFilter(new UFC_Blah($x, $y), new UFO_Coin($z, $t));
+ *
+ * Resulting UserFilter can be used to:
+ * - get a list of User objects matching the filter
+ * - get a list of UIDs matching the filter
+ * - get the number of users matching the filter
+ * - check whether a given User matches the filter
+ * - filter a list of User objects depending on whether they match the filter
+ *
+ * Usage for UFC and UFO objects:
+ * A UserFilter will call all private functions named XXXJoins.
+ * These functions must return an array containing the list of join
+ * required by the various UFC and UFO associated to the UserFilter.
+ * Entries in those returned array are of the following form:
+ *   'join_tablealias' => array('join_type', 'joined_table', 'join_criter')
+ * which will be translated into :
+ *   join_type JOIN joined_table AS join_tablealias ON (join_criter)
+ * in the final query.
+ *
+ * In the join_criter text, $ME is replaced with 'join_tablealias', $PID with
+ * profile.pid, and $UID with auth_user_md5.user_id.
+ *
+ * For each kind of "JOIN" needed, a function named addXXXFilter() should be defined;
+ * its parameter will be used to set various private vars of the UserFilter describing
+ * the required joins ; such a function shall return the "join_tablealias" to use
+ * when referring to the joined table.
+ *
+ * For example, if data from profile_job must be available to filter results,
+ * the UFC object will call $uf-addJobFilter(), which will set the 'with_pj' var and 
+ * return 'pj', the short name to use when referring to profile_job; when building
+ * the query, calling the jobJoins function will return an array containing a single
+ * row:
+ *   'pj' => array('left', 'profile_job', '$ME.pid = $UID');
+ *
+ * The 'register_optional' function can be used to generate unique table aliases when
+ * the same table has to be joined several times with different aliases.
+ */
 class UserFilter
 {
-    static private $joinMethods = array();
+    private $joinMethods = array();
+
+    private $joinMetas = array('$PID' => 'p.pid',
+                               '$UID' => 'a.uid',
+                              );
 
     private $root;
     private $sort = array();
@@ -1157,48 +1209,10 @@ class UserFilter
         }
     }
 
-    private function formatJoin(array $joins)
-    {
-        $str = '';
-        foreach ($joins as $key => $infos) {
-            $mode  = $infos[0];
-            $table = $infos[1];
-            if ($mode == 'inner') {
-                $str .= 'INNER JOIN ';
-            } else if ($mode == 'left') {
-                $str .= 'LEFT JOIN ';
-            } else {
-                Platal::page()->kill("Join mode error");
-            }
-            $str .= $table . ' AS ' . $key;
-            if (isset($infos[2])) {
-                $str .= ' ON (' . str_replace(array('$ME', '$PID', '$UID'), array($key, 'p.pid', 'a.uid'), $infos[2]) . ')';
-            }
-            $str .= "\n";
-        }
-        return $str;
-    }
-
-    private function buildJoins()
-    {
-        $joins = array();
-        foreach (self::$joinMethods as $method) {
-            $joins = array_merge($joins, $this->$method());
-        }
-        return $this->formatJoin($joins);
-    }
-
-    private function getUIDList($uids = null, $count = null, $offset = null)
+    private function getUIDList($uids = null, PlLimit &$limit)
     {
         $this->buildQuery();
-        $limit = '';
-        if (!is_null($count)) {
-            if (!is_null($offset)) {
-                $limit = XDB::format('LIMIT {?}, {?}', (int)$offset, (int)$count);
-            } else {
-                $limit = XDB::format('LIMIT {?}', (int)$count);
-            }
-        }
+        $lim = $limit->getSql();
         $cond = '';
         if (!is_null($uids)) {
             $cond = ' AND a.uid IN ' . XDB::formatArray($uids);
@@ -1207,7 +1221,7 @@ class UserFilter
                                     ' . $this->query . $cond . '
                                    GROUP BY  a.uid
                                     ' . $this->orderby . '
-                                    ' . $limit);
+                                    ' . $lim);
         $this->lastcount = (int)XDB::fetchOneCell('SELECT FOUND_ROWS()');
         return $fetched;
     }
@@ -1224,7 +1238,7 @@ class UserFilter
 
     /** Filter a list of user to extract the users matching the rule.
      */
-    public function filter(array $users, $count = null, $offset = null)
+    public function filter(array $users, PlLimit &$limit)
     {
         $this->buildQuery();
         $table = array();
@@ -1238,7 +1252,7 @@ class UserFilter
             $uids[] = $uid;
             $table[$uid] = $user;
         }
-        $fetched = $this->getUIDList($uids, $count, $offset);
+        $fetched = $this->getUIDList($uids, $limit);
         $output = array();
         foreach ($fetched as $uid) {
             $output[] = $table[$uid];
@@ -1246,14 +1260,19 @@ class UserFilter
         return $output;
     }
 
-    public function getUIDs($count = null, $offset = null)
+    public function getUIDs(PlLimit &$limit)
+    {
+        return $this->getUIDList(null, $limit);
+    }
+
+    public function getUsers(PlLimit &$limit)
     {
-        return $this->getUIDList(null, $count, $offset);
+        return User::getBulkUsersWithUIDs($this->getUIDs($limit));
     }
 
-    public function getUsers($count = null, $offset = null)
+    public function get(PlLimit &$limit)
     {
-        return User::getBulkUsersWithUIDs($this->getUIDs($count, $offset));
+        return $this->getUsers($limit);
     }
 
     public function getTotalCount()
@@ -1310,6 +1329,11 @@ class UserFilter
     }
 
 
+    /** Stores a new (and unique) table alias in the &$table table
+     * @param   &$table Array in which the table alias must be stored
+     * @param   $val    Value which will then be used to build the join
+     * @return          Name of the newly created alias
+     */
     private $option = 0;
     private function register_optional(array &$table, $val)
     {
@@ -1338,7 +1362,7 @@ class UserFilter
     private function displayJoins()
     {
         if ($this->pd) {
-            return array('pd' => array('left', 'profile_display', '$ME.pid = $PID'));
+            return array('pd' => new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'profile_display', '$ME.pid = $PID'));
         } else {
             return array();
         }
@@ -1409,7 +1433,7 @@ class UserFilter
     {
         $joins = array();
         foreach ($this->pn as $sub => $type) {
-            $joins['pn' . $sub] = array('left', 'profile_name', '$ME.pid = $PID AND $ME.typeid = ' . $type);
+            $joins['pn' . $sub] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'profile_name', '$ME.pid = $PID AND $ME.typeid = ' . $type);
         }
         return $joins;
     }
@@ -1460,17 +1484,17 @@ class UserFilter
     {
         $joins = array();
         if ($this->with_pee) {
-            $joins['pee'] = array('inner', 'profile_education_enum', 'pee.abbreviation = \'X\'');
+            $joins['pee'] = new PlSqlJoin(PlSqlJoin::MODE_INNER, 'profile_education_enum', 'pee.abbreviation = \'X\'');
         }
         foreach ($this->pepe as $grade => $sub) {
             if ($this->isGrade($grade)) {
-                $joins['pe' . $sub] = array('left', 'profile_education', '$ME.eduid = pee.id AND $ME.uid = $PID');
-                $joins['pede' . $sub] = array('inner', 'profile_education_degree_enum', '$ME.id = pe' . $sub . '.degreeid AND $ME.abbreviation LIKE ' .
+                $joins['pe' . $sub] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'profile_education', '$ME.eduid = pee.id AND $ME.uid = $PID');
+                $joins['pede' . $sub] = new PlSqlJoin(PlSqlJoin::MODE_INNER, 'profile_education_degree_enum', '$ME.id = pe' . $sub . '.degreeid AND $ME.abbreviation LIKE ' .
                                                   XDB::format('{?}', $grade));
             } else {
-                $joins['pe' . $sub] = array('left', 'profile_education', '$ME.uid = $PID');
-                $joins['pee' . $sub] = array('inner', 'profile_education_enum', '$ME.id = pe' . $sub . '.eduid');
-                $joins['pede' . $sub] = array('inner', 'profile_education_degree_enum', '$ME.id = pe' . $sub . '.degreeid');
+                $joins['pe' . $sub] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'profile_education', '$ME.uid = $PID');
+                $joins['pee' . $sub] = new PlSqlJoin(PlSqlJoin::MODE_INNER, 'profile_education_enum', '$ME.id = pe' . $sub . '.eduid');
+                $joins['pede' . $sub] = new PlSqlJoin(PlSqlJoin::MODE_INNER, 'profile_education_degree_enum', '$ME.id = pe' . $sub . '.degreeid');
             }
         }
         return $joins;
@@ -1503,13 +1527,13 @@ class UserFilter
         $joins = array();
         foreach ($this->gpm as $sub => $key) {
             if (is_null($key)) {
-                $joins['gpa' . $sub] = array('inner', 'groupex.asso');
-                $joins['gpm' . $sub] = array('left', 'groupex.membres', '$ME.uid = $UID AND $ME.asso_id = gpa' . $sub . '.id');
+                $joins['gpa' . $sub] = new PlSqlJoin(PlSqlJoin::MODE_INNER, 'groupex.asso');
+                $joins['gpm' . $sub] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'groupex.membres', '$ME.uid = $UID AND $ME.asso_id = gpa' . $sub . '.id');
             } else if (ctype_digit($key)) {
-                $joins['gpm' . $sub] = array('left', 'groupex.membres', '$ME.uid = $UID AND $ME.asso_id = ' . $key);
+                $joins['gpm' . $sub] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'groupex.membres', '$ME.uid = $UID AND $ME.asso_id = ' . $key);
             } else {
-                $joins['gpa' . $sub] = array('inner', 'groupex.asso', XDB::format('$ME.diminutif = {?}', $key));
-                $joins['gpm' . $sub] = array('left', 'groupex.membres', '$ME.uid = $UID AND $ME.asso_id = gpa' . $sub . '.id');
+                $joins['gpa' . $sub] = new PlSqlJoin(PlSqlJoin::MODE_INNER, 'groupex.asso', XDB::format('$ME.diminutif = {?}', $key));
+                $joins['gpm' . $sub] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'groupex.membres', '$ME.uid = $UID AND $ME.asso_id = gpa' . $sub . '.id');
             }
         }
         return $joins;
@@ -1544,29 +1568,29 @@ class UserFilter
         $joins = array();
         foreach ($this->e as $sub=>$key) {
             if (is_null($key)) {
-                $joins['e' . $sub] = array('left', 'emails', '$ME.uid = $UID AND $ME.flags != \'filter\'');
+                $joins['e' . $sub] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'emails', '$ME.uid = $UID AND $ME.flags != \'filter\'');
             } else {
-                $joins['e' . $sub] = array('left', 'emails', XDB::format('$ME.uid = $UID AND $ME.flags != \'filter\' AND $ME.email = {?}', $key));
+                $joins['e' . $sub] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'emails', XDB::format('$ME.uid = $UID AND $ME.flags != \'filter\' AND $ME.email = {?}', $key));
             }
         }
         foreach ($this->al as $sub=>$key) {
             if (is_null($key)) {
-                $joins['al' . $sub] = array('left', 'aliases', '$ME.id = $UID AND $ME.type IN (\'alias\', \'a_vie\')');
+                $joins['al' . $sub] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'aliases', '$ME.id = $UID AND $ME.type IN (\'alias\', \'a_vie\')');
             } else if ($key == self::ALIAS_BEST) {
-                $joins['al' . $sub] = array('left', 'aliases', '$ME.id = $UID AND $ME.type IN (\'alias\', \'a_vie\') AND  FIND_IN_SET(\'bestalias\', $ME.flags)');
+                $joins['al' . $sub] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'aliases', '$ME.id = $UID AND $ME.type IN (\'alias\', \'a_vie\') AND  FIND_IN_SET(\'bestalias\', $ME.flags)');
             } else if ($key == self::ALIAS_FORLIFE) {
-                $joins['al' . $sub] = array('left', 'aliases', '$ME.id = $UID AND $ME.type = \'a_vie\'');
+                $joins['al' . $sub] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'aliases', '$ME.id = $UID AND $ME.type = \'a_vie\'');
             } else {
-                $joins['al' . $sub] = array('left', 'aliases', XDB::format('$ME.id = $UID AND $ME.type IN (\'alias\', \'a_vie\') AND $ME.alias = {?}', $key));
+                $joins['al' . $sub] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'aliases', XDB::format('$ME.id = $UID AND $ME.type IN (\'alias\', \'a_vie\') AND $ME.alias = {?}', $key));
             }
         }
         foreach ($this->ve as $sub=>$key) {
             if (is_null($key)) {
-                $joins['v' . $sub] = array('left', 'virtual', '$ME.type = \'user\'');
+                $joins['v' . $sub] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'virtual', '$ME.type = \'user\'');
             } else {
-                $joins['v' . $sub] = array('left', 'virtual', XDB::format('$ME.type = \'user\' AND $ME.alias = {?}', $key));
+                $joins['v' . $sub] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'virtual', XDB::format('$ME.type = \'user\' AND $ME.alias = {?}', $key));
             }
-            $joins['vr' . $sub] = array('left', 'virtual_redirect', XDB::format('$ME.vid = v' . $sub . '.vid
+            $joins['vr' . $sub] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'virtual_redirect', XDB::format('$ME.vid = v' . $sub . '.vid
                                                                                  AND ($ME.redirect IN (CONCAT(al_forlife.alias, \'@\', {?}),
                                                                                                        CONCAT(al_forlife.alias, \'@\', {?}),
                                                                                                        a.email))',
@@ -1578,17 +1602,18 @@ class UserFilter
 
     /** ADDRESSES
      */
-    private $pa = false;
+    private $with_pa = false;
     public function addAddressFilter()
     {
-        $this->pa = true;
+        $this->with_pa = true;
+        return 'pa';
     }
 
     private function addressJoins()
     {
         $joins = array();
-        if ($this->pa) {
-            $joins['pa'] = array('left', 'profile_address', '$ME.PID = $PID');
+        if ($this->with_pa) {
+            $joins['pa'] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'profile_address', '$ME.pid = $PID');
         }
         return $joins;
     }
@@ -1623,13 +1648,13 @@ class UserFilter
     {
         $joins = array();
         if ($this->pc) {
-            $joins['pc'] = array('left', 'profile_corps', '$ME.uid = $UID');
+            $joins['pc'] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'profile_corps', '$ME.uid = $UID');
         }
         if ($this->pcr) {
-            $joins['pcr'] = array('left', 'profile_corps_rank_enum', '$ME.id = pc.rankid');
+            $joins['pcr'] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'profile_corps_rank_enum', '$ME.id = pc.rankid');
         }
         foreach($this->pce as $sub => $field) {
-            $joins[$sub] = array('left', 'profile_corps_enum', '$ME.id = pc.' . $field);
+            $joins[$sub] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'profile_corps_enum', '$ME.id = pc.' . $field);
         }
         return $joins;
     }
@@ -1693,22 +1718,22 @@ class UserFilter
     {
         $joins = array();
         if ($this->with_pj) {
-            $joins['pj'] = array('left', 'profile_job', '$ME.uid = $UID');
+            $joins['pj'] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'profile_job', '$ME.uid = $UID');
         }
         if ($this->with_pje) {
-            $joins['pje'] = array('left', 'profile_job_enum', '$ME.id = pj.jobid');
+            $joins['pje'] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'profile_job_enum', '$ME.id = pj.jobid');
         }
         if ($this->with_pjse) {
-            $joins['pjse'] = array('left', 'profile_job_sector_enum', '$ME.id = pj.sectorid');
+            $joins['pjse'] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'profile_job_sector_enum', '$ME.id = pj.sectorid');
         }
         if ($this->with_pjsse) {
-            $joins['pjsse'] = array('left', 'profile_job_subsector_enum', '$ME.id = pj.subsectorid');
+            $joins['pjsse'] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'profile_job_subsector_enum', '$ME.id = pj.subsectorid');
         }
         if ($this->with_pjssse) {
-            $joins['pjssse'] = array('left', 'profile_job_subsubsector_enum', '$ME.id = pj.subsubsectorid');
+            $joins['pjssse'] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'profile_job_subsubsector_enum', '$ME.id = pj.subsubsectorid');
         }
         if ($this->with_pja) {
-            $joins['pja'] = array('left', 'profile_job_alternates', '$ME.subsubsectorid = pj.subsubsectorid');
+            $joins['pja'] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'profile_job_alternates', '$ME.subsubsectorid = pj.subsubsectorid');
         }
         return $joins;
     }
@@ -1727,7 +1752,7 @@ class UserFilter
     {
         $joins = array();
         if ($this->with_pnw) {
-            $joins['pnw'] = array('left', 'profile_networking', '$ME.uid = $UID');
+            $joins['pnw'] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'profile_networking', '$ME.uid = $UID');
         }
         return $joins;
     }
@@ -1735,19 +1760,19 @@ class UserFilter
     /** PHONE
      */
 
-    private $with_phone = false;
+    private $with_ptel = false;
 
     public function addPhoneFilter()
     {
-        $this->with_phone = true;
+        $this->with_ptel = true;
         return 'ptel';
     }
 
     private function phoneJoins()
     {
         $joins = array();
-        if ($this->with_phone) {
-            $joins['ptel'] = array('left', 'profile_phone', '$ME.uid = $UID');
+        if ($this->with_ptel) {
+            $joins['ptel'] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'profile_phone', '$ME.uid = $UID');
         }
         return $joins;
     }
@@ -1755,18 +1780,52 @@ class UserFilter
     /** MEDALS
      */
 
-    private $with_medals = false;
+    private $with_pmed = false;
     public function addMedalFilter()
     {
-        $this->with_medals = true;
+        $this->with_pmed = true;
         return 'pmed';
     }
 
     private function medalJoins()
     {
         $joins = array();
-        if ($this->with_medals) {
-            $joins['pmed'] = array('left', 'profile_medals_sub', '$ME.uid = $UID');
+        if ($this->with_pmed) {
+            $joins['pmed'] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'profile_medals_sub', '$ME.uid = $UID');
+        }
+        return $joins;
+    }
+
+    /** MENTORING
+     */
+
+    private $pms = array();
+    const MENTOR_EXPERTISE  = 1;
+    const MENTOR_COUNTRY    = 2;
+    const MENTOR_SECTOR     = 3;
+
+    public function addMentorFilter($type)
+    {
+        switch($type) {
+        case MENTOR_EXPERTISE:
+            $pms['pme'] = 'profile_mentor';
+            return 'pme';
+        case MENTOR_COUNTRY:
+            $pms['pmc'] = 'profile_mentor_country';
+            return 'pmc';
+        case MENTOR_SECTOR:
+            $pms['pms'] =  'profile_mentor_sector';
+            return 'pms';
+        default:
+            Platal::page()->killError("Undefined mentor filter.");
+        }
+    }
+
+    private function mentorJoins()
+    {
+        $joins = array();
+        foreach ($this->pms as $sub => $tab) {
+            $joins[$sub] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, $tab, '$ME.uid = $UID');
         }
         return $joins;
     }
@@ -1784,9 +1843,9 @@ class UserFilter
         $joins = array();
         foreach ($this->cts as $sub=>$key) {
             if (is_null($key)) {
-                $joins['c' . $sub] = array('left', 'contacts', '$ME.contact = $UID');
+                $joins['c' . $sub] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'contacts', '$ME.contact = $UID');
             } else {
-                $joins['c' . $sub] = array('left', 'contacts', XDB::format('$ME.uid = {?} AND $ME.contact = $UID', substr($key, 5)));
+                $joins['c' . $sub] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'contacts', XDB::format('$ME.uid = {?} AND $ME.contact = $UID', substr($key, 5)));
             }
         }
         return $joins;
@@ -1818,30 +1877,30 @@ class UserFilter
         $joins = array();
         foreach ($this->w as $sub=>$key) {
             if (is_null($key)) {
-                $joins['w' . $sub] = array('left', 'watch');
+                $joins['w' . $sub] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'watch');
             } else {
-                $joins['w' . $sub] = array('left', 'watch', XDB::format('$ME.uid = {?}', substr($key, 5)));
+                $joins['w' . $sub] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'watch', XDB::format('$ME.uid = {?}', substr($key, 5)));
             }
         }
         foreach ($this->wn as $sub=>$key) {
             if (is_null($key)) {
-                $joins['wn' . $sub] = array('left', 'watch_nonins', '$ME.ni_id = $UID');
+                $joins['wn' . $sub] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'watch_nonins', '$ME.ni_id = $UID');
             } else {
-                $joins['wn' . $sub] = array('left', 'watch_nonins', XDB::format('$ME.uid = {?} AND $ME.ni_id = $UID', substr($key, 5)));
+                $joins['wn' . $sub] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'watch_nonins', XDB::format('$ME.uid = {?} AND $ME.ni_id = $UID', substr($key, 5)));
             }
         }
         foreach ($this->wn as $sub=>$key) {
             if (is_null($key)) {
-                $joins['wn' . $sub] = array('left', 'watch_nonins', '$ME.ni_id = $UID');
+                $joins['wn' . $sub] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'watch_nonins', '$ME.ni_id = $UID');
             } else {
-                $joins['wn' . $sub] = array('left', 'watch_nonins', XDB::format('$ME.uid = {?} AND $ME.ni_id = $UID', substr($key, 5)));
+                $joins['wn' . $sub] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'watch_nonins', XDB::format('$ME.uid = {?} AND $ME.ni_id = $UID', substr($key, 5)));
             }
         }
         foreach ($this->wp as $sub=>$key) {
             if (is_null($key)) {
-                $joins['wp' . $sub] = array('left', 'watch_promo');
+                $joins['wp' . $sub] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'watch_promo');
             } else {
-                $joins['wp' . $sub] = array('left', 'watch_promo', XDB::format('$ME.uid = {?}', substr($key, 5)));
+                $joins['wp' . $sub] = new PlSqlJoin(PlSqlJoin::MODE_LEFT, 'watch_promo', XDB::format('$ME.uid = {?}', substr($key, 5)));
             }
         }
         return $joins;