Improve comments quality, fix minor bugs
[platal.git] / classes / userfilter.php
index 01c67ed..3bebf33 100644 (file)
  *  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA                *
  ***************************************************************************/
 
+
+/******************
+ * CONDITIONS
+ ******************/
+
+// {{{ interface UserFilterCondition
 interface UserFilterCondition
 {
     const COND_TRUE  = 'TRUE';
@@ -28,7 +34,9 @@ interface UserFilterCondition
      */
     public function buildCondition(UserFilter &$uf);
 }
+// }}}
 
+// {{{ class UFC_OneChild
 abstract class UFC_OneChild implements UserFilterCondition
 {
     protected $child;
@@ -45,7 +53,9 @@ abstract class UFC_OneChild implements UserFilterCondition
         $this->child =& $cond;
     }
 }
+// }}}
 
+// {{{ class UFC_NChildren
 abstract class UFC_NChildren implements UserFilterCondition
 {
     protected $children = array();
@@ -72,11 +82,13 @@ abstract class UFC_NChildren implements UserFilterCondition
         } else if (count($cond) == 1) {
             return $cond[0];
         } else {
-            return '(' . implode(') ' . $op . ' (', $conds) . ')';
+            return '(' . implode(') ' . $op . ' (', $cond) . ')';
         }
     }
 }
+// }}}
 
+// {{{ class UFC_True
 class UFC_True implements UserFilterCondition
 {
     public function buildCondition(UserFilter &$uf)
@@ -84,7 +96,9 @@ class UFC_True implements UserFilterCondition
         return self::COND_TRUE;
     }
 }
+// }}}
 
+// {{{ class UFC_False
 class UFC_False implements UserFilterCondition
 {
     public function buildCondition(UserFilter &$uf)
@@ -92,7 +106,9 @@ class UFC_False implements UserFilterCondition
         return self::COND_FALSE;
     }
 }
+// }}}
 
+// {{{ class UFC_Not
 class UFC_Not extends UFC_OneChild
 {
     public function buildCondition(UserFilter &$uf)
@@ -107,7 +123,9 @@ class UFC_Not extends UFC_OneChild
         }
     }
 }
+// }}}
 
+// {{{ class UFC_And
 class UFC_And extends UFC_NChildren
 {
     public function buildCondition(UserFilter &$uf)
@@ -131,7 +149,9 @@ class UFC_And extends UFC_NChildren
         }
     }
 }
+// }}}
 
+// {{{ class UFC_Or
 class UFC_Or extends UFC_NChildren
 {
     public function buildCondition(UserFilter &$uf)
@@ -155,7 +175,26 @@ class UFC_Or extends UFC_NChildren
         }
     }
 }
+// }}}
+
+// {{{ class UFC_Profile
+/** Filters users who have a profile
+ */
+class UFC_Profile implements UserFilterCondition
+{
+    public function buildCondition(UserFilter &$uf)
+    {
+        return '$PID IS NOT NULL';
+    }
+}
+// }}}
 
+// {{{ class UFC_Promo
+/** Filters users based on promotion
+ * @param $comparison Comparison operator (>, =, ...)
+ * @param $grade Formation on which to restrict, UserFilter::DISPLAY for "any formation"
+ * @param $promo Promotion on which the filter is based
+ */
 class UFC_Promo implements UserFilterCondition
 {
 
@@ -168,23 +207,31 @@ class UFC_Promo implements UserFilterCondition
         $this->grade = $grade;
         $this->comparison = $comparison;
         $this->promo = $promo;
-        UserFilter::assertGrade($this->grade);
+        if ($this->grade != UserFilter::DISPLAY) {
+            UserFilter::assertGrade($this->grade);
+        }
     }
 
     public function buildCondition(UserFilter &$uf)
     {
-        // XXX: Definition of promotion for phds and masters might change in near future.
-        if ($this->grade == UserFilter::GRADE_ING) {
-            $promo_year = 'entry_year';
+        if ($this->grade == UserFilter::DISPLAY) {
+            $sub = $uf->addDisplayFilter();
+            return XDB::format('pd' . $sub . '.promo = {?}', $this->promo);
         } else {
-            $promo_year = 'grad_year';
+            $sub = $uf->addEducationFilter(true, $this->grade);
+            $field = 'pe' . $sub . '.' . UserFilter::promoYear($this->grade);
+            return $field . ' IS NOT NULL AND ' . $field . ' ' . $this->comparison . ' ' . XDB::format('{?}', $this->promo);
         }
-        $sub = $uf->addEducationFilter(true, $this->grade);
-        $field = 'pe' . $sub . '.' . $promo_year;
-        return $field . ' IS NOT NULL AND ' . $field . ' ' . $this->comparison . ' ' . XDB::format('{?}', $this->promo);
     }
 }
+// }}}
 
+// {{{ class UFC_Name
+/** Filters users based on name
+ * @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...)
+ */
 class UFC_Name implements UserFilterCondition
 {
     const PREFIX   = 1;
@@ -229,7 +276,7 @@ class UFC_Name implements UserFilterCondition
         }
         $cond = $left . $op . $right;
         $conds = array($this->buildNameQuery($this->type, null, $cond, $uf));
-        if (($this->mode & self::VARIANTS) != 0) {
+        if (($this->mode & self::VARIANTS) != 0 && isset(UserFilter::$name_variants[$this->type])) {
             foreach (UserFilter::$name_variants[$this->type] as $var) {
                 $conds[] = $this->buildNameQuery($this->type, $var, $cond, $uf);
             }
@@ -237,217 +284,1675 @@ class UFC_Name implements UserFilterCondition
         return implode(' OR ', $conds);
     }
 }
+// }}}
 
-class UserFilter
+// {{{ class UFC_Dead
+/** Filters users based on death date
+ * @param $comparison Comparison operator
+ * @param $date Date to which death date should be compared
+ */
+class UFC_Dead implements UserFilterCondition
 {
-    private $root;
-    private $query = null;
+    private $comparison;
+    private $date;
 
-    public function __construct($cond = null)
+    public function __construct($comparison = null, $date = null)
     {
-        if (!is_null($cond)) {
-            if ($cond instanceof UserFilterCondition) {
-                $this->setCondition($cond);
-            }
-        }
+        $this->comparison = $comparison;
+        $this->date = $date;
     }
 
-    private function buildQuery()
+    public function buildCondition(UserFilter &$uf)
     {
-        if (is_null($this->query)) {
-            $where = $this->root->buildCondition($this);
-            $joins = $this->buildJoins();
-            $this->query = 'FROM  accounts AS a
-                      INNER JOIN  account_profiles AS ap ON (ap.uid = a.uid AND FIND_IN_SET(\'owner\', ap.perms))
-                      INNER JOIN  profiles AS p ON (p.pid = ap.pid)
-                               ' . $joins . '
-                           WHERE  (' . $where . ')';
+        $str = 'p.deathdate IS NOT NULL';
+        if (!is_null($this->comparison)) {
+            $str .= ' AND p.deathdate ' . $this->comparison . ' ' . XDB::format('{?}', date('Y-m-d', $this->date));
         }
+        return $str;
     }
+}
+// }}}
 
-    private function formatJoin(array $joins)
+// {{{ class UFC_Registered
+/** Filters users based on registration state
+ * @param $active Whether we want to use only "active" users (i.e with a valid redirection)
+ * @param $comparison Comparison operator
+ * @param $date Date to which users registration date should be compared
+ */
+class UFC_Registered implements UserFilterCondition
+{
+    private $active;
+    private $comparison;
+    private $date;
+
+    public function __construct($active = false, $comparison = null, $date = null)
     {
-        $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'), array($key, 'p.pid'), $infos[2]) . ')';
-            }
-            $str .= "\n";
+        $this->only_active = $active;
+        $this->comparison = $comparison;
+        $this->date = $date;
+    }
+
+    public function buildCondition(UserFilter &$uf)
+    {
+        if ($this->active) {
+            $date = 'a.uid IS NOT NULL AND a.state = \'active\'';
+        } else {
+            $date = 'a.uid IS NOT NULL AND a.state != \'pending\'';
         }
-        return $str;
+        if (!is_null($this->comparison)) {
+            $date .= ' AND a.registration_date ' . $this->comparison . ' ' . XDB::format('{?}', date('Y-m-d', $this->date));
+        }
+        return $date;
     }
+}
+// }}}
 
-    private function buildJoins()
+// {{{ class UFC_ProfileUpdated
+/** Filters users based on profile update date
+ * @param $comparison Comparison operator
+ * @param $date Date to which profile update date must be compared
+ */
+class UFC_ProfileUpdated implements UserFilterCondition
+{
+    private $comparison;
+    private $date;
+
+    public function __construct($comparison = null, $date = null)
     {
-        $joins = $this->educationJoins() + $this->nameJoins();
-        return $this->formatJoin($joins);
+        $this->comparison = $comparison;
+        $this->date = $date;
     }
 
-    /** Check that the user match the given rule.
-     */
-    public function checkUser(PlUser &$user)
+    public function buildCondition(UserFilter &$uf)
     {
-        $this->buildQuery();
-        $count = (int)XDB::fetchOneCell('SELECT  COUNT(*)
-                                        ' . $this->query . XDB::format(' AND a.uid = {?}', $user->id()));
-        return $count == 1;
+        return 'p.last_change ' . $this->comparison . XDB::format(' {?}', date('Y-m-d H:i:s', $this->date));
     }
+}
+// }}}
 
-    /** Filter a list of user to extract the users matching the rule.
-     */
-    public function filter(array $users)
+// {{{ class UFC_Birthday
+/** Filters users based on next birthday date
+ * @param $comparison Comparison operator
+ * @param $date Date to which users next birthday date should be compared
+ */
+class UFC_Birthday implements UserFilterCondition
+{
+    private $comparison;
+    private $date;
+
+    public function __construct($comparison = null, $date = null)
     {
-        $output = array();
-        foreach ($users as &$user) {
-            if ($this->checkUser($user)) {
-                $output[] = $user;
-            }
-        }
-        return $output;
+        $this->comparison = $comparison;
+        $this->date = $date;
     }
 
-    public function setCondition(UserFilterCondition &$cond)
+    public function buildCondition(UserFilter &$uf)
     {
-        $this->root =& $cond;
-        $this->query = null;
+        return 'p.next_birthday ' . $this->comparison . XDB::format(' {?}', date('Y-m-d', $this->date));
     }
+}
+// }}}
 
-    static public function getLegacy($promo_min, $promo_max)
+// {{{ class UFC_Sex
+/** Filters users based on sex
+ * @parm $sex One of User::GENDER_MALE or User::GENDER_FEMALE, for selecting users
+ */
+class UFC_Sex implements UserFilterCondition
+{
+    private $sex;
+    public function __construct($sex)
     {
-        if ($promo_min != 0) {
-            $min = new UFC_Promo('>=', self::GRADE_ING, intval($promo_min));
-        } else {
-            $min = new UFC_True();
-        }
-        if ($promo_max != 0) {
-            $max = new UFC_Promo('<=', self::GRADE_ING, intval($promo_max));
+        $this->sex = $sex;
+    }
+
+    public function buildCondition(UserFilter &$uf)
+    {
+        if ($this->sex != User::GENDER_MALE && $this->sex != User::GENDER_FEMALE) {
+            return self::COND_FALSE;
         } else {
-            $max = new UFC_True();
+            return XDB::format('p.sex = {?}', $this->sex == User::GENDER_FEMALE ? 'female' : 'male');
         }
-        return new UserFilter(new UFC_And($min, $max));
     }
+}
+// }}}
 
+// {{{ class UFC_Group
+/** Filters users based on group membership
+ * @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 $anim;
+    public function __construct($group, $anim = false)
+    {
+        $this->group = $group;
+        $this->anim = $anim;
+    }
 
-    /** NAMES
-     */
-    const LASTNAME  = 'lastname';
-    const FIRSTNAME = 'firstname';
-    const NICKNAME  = 'nickname';
-    const PSEUDONYM = 'pseudonym';
-    const NAME      = 'name';
-    const VN_MARITAL  = 'marital';
-    const VN_ORDINARY = 'ordinary';
-    const VN_OTHER    = 'other';
-    const VN_INI      = 'ini';
+    public function buildCondition(UserFilter &$uf)
+    {
+        $sub = $uf->addGroupFilter($this->group);
+        $where = 'gpm' . $sub . '.perms IS NOT NULL';
+        if ($this->anim) {
+            $where .= ' AND gpm' . $sub . '.perms = \'admin\'';
+        }
+        return $where;
+    }
+}
+// }}}
 
-    static public $name_variants = array(
-        self::LASTNAME => array(self::VN_MARITAL, self::VN_ORDINARY),
-        self::FIRSTNAME => array(self::VN_ORDINARY, self::VN_INI, self::VN_OTHER),
-        self::NICKNAME => array(), self::PSEUDONYM => array(),
-        self::NAME => array());
+// {{{ class UFC_Email
+/** Filters users based on email address
+ * @param $email Email whose owner we are looking for
+ */
+class UFC_Email implements UserFilterCondition
+{
+    private $email;
+    public function __construct($email)
+    {
+        $this->email = $email;
+    }
 
-    static public function assertName($name)
+    public function buildCondition(UserFilter &$uf)
     {
-        if (!Profile::getNameTypeId($name)) {
-            Platal::page()->kill('Invalid name type');
+        if (User::isForeignEmailAddress($this->email)) {
+            $sub = $uf->addEmailRedirectFilter($this->email);
+            return XDB::format('e' . $sub . '.email IS NOT NULL OR a.email = {?}', $this->email);
+        } else if (User::isVirtualEmailAddress($this->email)) {
+            $sub = $uf->addVirtualEmailFilter($this->email);
+            return 'vr' . $sub . '.redirect IS NOT NULL';
+        } else {
+            @list($user, $domain) = explode('@', $this->email);
+            $sub = $uf->addAliasFilter($user);
+            return 'al' . $sub . '.alias IS NOT NULL';
         }
     }
+}
+// }}}
 
-    private $pn  = array();
-    private $pno = 0;
-    public function addNameFilter($type, $variant = null)
+// {{{ class UFC_EmailList
+/** Filters users based on an email list
+ * @param $emails List of emails whose owner must be selected
+ */
+class UFC_EmailList implements UserFilterCondition
+{
+    private $emails;
+    public function __construct($emails)
     {
-        if (!is_null($variant)) {
-            $ft  = $type . '_' . $variant;
-        } else {
-            $ft = $type;
+        $this->emails = $emails;
+    }
+
+    public function buildCondition(UserFilter &$uf)
+    {
+        $email   = null;
+        $virtual = null;
+        $alias   = null;
+        $cond = array();
+
+        if (count($this->emails) == 0) {
+            return UserFilterCondition::COND_TRUE;
         }
-        $sub = '_' . $ft;
-        self::assertName($ft);
 
-        if (!is_null($variant) && $variant == 'other') {
-            $sub .= $this->pno++;
+        foreach ($this->emails as $entry) {
+            if (User::isForeignEmailAddress($entry)) {
+                if (is_null($email)) {
+                    $email = $uf->addEmailRedirectFilter();
+                }
+                $cond[] = XDB::format('e' . $email . '.email = {?} OR a.email = {?}', $entry, $entry);
+            } else if (User::isVirtualEmailAddress($entry)) {
+                if (is_null($virtual)) {
+                    $virtual = $uf->addVirtualEmailFilter();
+                }
+                $cond[] = XDB::format('vr' . $virtual . '.redirect IS NOT NULL AND v' . $virtual . '.alias = {?}', $entry);
+            } else {
+                if (is_null($alias)) {
+                    $alias = $uf->addAliasFilter();
+                }
+                @list($user, $domain) = explode('@', $entry);
+                $cond[] = XDB::format('al' . $alias . '.alias = {?}', $user);
+            }
         }
-        $this->pn[$sub] = Profile::getNameTypeId($ft);
-        return $sub;
+        return '(' . implode(') OR (', $cond) . ')';
     }
+}
+// }}}
 
-    private function nameJoins()
+// {{{ 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, ...)
+ */
+class UFC_Address implements UserFilterCondition
+{
+    const PREFIX    = 1;
+    const SUFFIX    = 2;
+    const CONTAINS  = 3;
+
+    private $field;
+    private $text;
+    private $mode;
+
+    public function __construct($field, $text, $mode)
     {
-        $joins = array();
-        foreach ($this->pn as $sub => $type) {
-            $joins['pn' . $sub] = array('left', 'profile_name', '$ME.pid = $PID AND $ME.typeid = ' . $type);
+        $this->field = $field;
+        $this->text  = $text;
+        $this->mode  = $mode;
+    }
+
+    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);
         }
-        return $joins;
+        $cond = $left . $op . $right;
+        $uf->addAddressFilter();
+        return $cond;
     }
+}
+// }}}
+
+// {{{ class UFC_Corps
+/** Filters users based on the corps they belong to
+ * @param $corps Corps we are looking for (abbreviation)
+ * @param $type Whether we search for original or current corps
+ */
+class UFC_Corps implements UserFilterCondition
+{
+    const CURRENT   = 1;
+    const ORIGIN    = 2;
 
+    private $corps;
+    private $type;
 
-    /** EDUCATION
-     */
-    const GRADE_ING = 'Ing.';
-    const GRADE_PHD = 'PhD';
-    const GRADE_MST = 'M%';
-    static public function isGrade($grade)
+    public function __construct($corps, $type = self::CURRENT)
     {
-        return $grade == self::GRADE_ING || self::$grade == GRADE_PHD || self::$grade == GRADE_MST;
+        $this->corps = $corps;
+        $this->type  = $type;
     }
 
-    static public function assertGrade($grade)
+    public function buildCondition(UserFilter &$uf)
     {
-        if (!self::isGrade($grade)) {
-            Platal::page()->killError("DiplĂ´me non valide");
-        }
+        /** Tables shortcuts:
+         * pc for profile_corps,
+         * pceo for profile_corps_enum - orginal
+         * pcec for profile_corps_enum - current
+         */
+        $sub = $uf->addCorpsFilter($this->type);
+        $cond = $sub . '.abbreviation = ' . $corps;
+        return $cond;
     }
+}
+// }}}
 
-    private $pepe     = array();
-    private $with_pee = false;
-    private $pe_g     = 0;
-    public function addEducationFilter($x = false, $grade = null)
+// {{{ class UFC_Corps_Rank
+/** Filters users based on their rank in the corps
+ * @param $rank Rank we are looking for (abbreviation)
+ */
+class UFC_Corps_Rank implements UserFilterCondition
+{
+    private $rank;
+    public function __construct($rank)
     {
-        if (!$x) {
-            $index = $this->pe_g;
-            $sub   = $this->pe_g++;
-        } else {
-            self::assertGrade($grade);
-            $index = $grade;
-            $sub   = $grade[0];
-            $this->with_pee = true;
+        $this->rank = $rank;
+    }
+
+    public function buildCondition(UserFilter &$uf)
+    {
+        /** Tables shortcuts:
+         * pcr for profile_corps_rank
+         */
+        $sub = $uf->addCorpsRankFilter();
+        $cond = $sub . '.abbreviation = ' . $rank;
+        return $cond;
+    }
+}
+// }}}
+
+// {{{ class UFC_Job_Company
+/** Filters users based on the company they belong to
+ * @param $type The field being searched (self::JOBID, self::JOBNAME or self::JOBACRONYM)
+ * @param $value The searched value
+ */
+class UFC_Job_Company extends UserFilterCondition
+{
+    const JOBID = 'id';
+    const JOBNAME = 'name';
+    const JOBACRONYM = 'acronym';
+
+    private $type;
+    private $value;
+
+    public function __construct($type, $value)
+    {
+        $this->assertType($type);
+        $this->type = $type;
+        $this->value = $value;
+    }
+
+    private function assertType($type)
+    {
+        if ($type != self::JOBID && $type != self::JOBNAME && $type != self::JOBACRONYM) {
+            Platal::page()->killError("Type de recherche non valide.");
         }
-        $sub = '_' . $sub;
-        $this->pepe[$index] = $sub;
-        return $sub;
     }
 
-    private function educationJoins()
+    public function buildCondition(UserFilter &$uf)
     {
-        $joins = array();
-        if ($this->with_pee) {
-            $joins['pee'] = array('inner', 'profile_education_enum', 'pee.abbreviation = \'X\'');
+        $sub = $uf->addJobCompanyFilter();
+        $cond  = $sub . '.' . $this->type . ' = ' . XDB::format('{?}', $this->value);
+        return $cond;
+    }
+}
+// }}}
+
+// {{{ class UFC_Job_Sectorization
+/** Filters users based on the ((sub)sub)sector they work in
+ * @param $sector The sector searched
+ * @param $subsector The subsector
+ * @param $subsubsector The subsubsector
+ */
+class UFC_Job_Sectorization extends UserFilterCondition
+{
+
+    private $sector;
+    private $subsector;
+    private $subsubsector;
+
+    public function __construct($sector = null, $subsector = null, $subsubsector = null)
+    {
+        $this->sector = $sector;
+        $this->subsector = $subsector;
+        $this->subsubsector = $subsubsector;
+    }
+
+    public function buildCondition(UserFilter &$uf)
+    {
+        // No need to add the JobFilter, it will be done by addJobSectorizationFilter
+        $conds = array();
+        if ($this->sector !== null) {
+            $sub = $uf->addJobSectorizationFilter(UserFilter::JOB_SECTOR);
+            $conds[] = $sub . '.id = ' . XDB::format('{?}', $this->sector);
         }
-        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 ' .
-                                                  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');
+        if ($this->subsector !== null) {
+            $sub = $uf->addJobSectorizationFilter(UserFilter::JOB_SUBSECTOR);
+            $conds[] = $sub . '.id = ' . XDB::format('{?}', $this->subsector);
+        }
+        if ($this->subsubsector !== null) {
+            $sub = $uf->addJobSectorizationFilter(UserFilter::JOB_SUBSUBSECTOR);
+            $conds[] = $sub . '.id = ' . XDB::format('{?}', $this->subsubsector);
+        }
+        return implode(' AND ', $conds);
+    }
+}
+// }}}
+
+// {{{ class UFC_Job_Description
+/** Filters users based on their job description
+ * @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
+{
+
+    /** Meta-filters
+     * Built with binary OR on UserFilter::JOB_*
+     */
+    const ANY = 31;
+    const SECTORIZATION = 15;
+
+    private $description;
+    private $fields;
+
+    public function __construct($description)
+    {
+        $this->fields = $fields;
+        $this->description = $description;
+    }
+
+    public function buildCondition(UserFilter &$uf)
+    {
+        $conds = array();
+        if ($this->fields & UserFilter::JOB_USERDEFINED) {
+            $sub = $uf->addJobFilter();
+            $conds[] = $sub . '.description LIKE ' . XDB::format('CONCAT(\'%\', {?}, \'%\')', $this->description);
+        }
+        if ($this->fields & UserFilter::JOB_SECTOR) {
+            $sub = $uf->addJobSectorizationFilter(UserFilter::JOB_SECTOR);
+            $conds[] = $sub . '.name LIKE ' . XDB::format('CONCAT(\'%\', {?}, \'%\')', $this->description);
+        }
+        if ($this->fields & UserFilter::JOB_SUBSECTOR) {
+            $sub = $uf->addJobSectorizationFilter(UserFilter::JOB_SUBSECTOR);
+            $conds[] = $sub . '.name LIKE ' . XDB::format('CONCAT(\'%\', {?}, \'%\')', $this->description);
+        }
+        if ($this->fields & UserFilter::JOB_SUBSUBSECTOR) {
+            $sub = $uf->addJobSectorizationFilter(UserFilter::JOB_SUBSUBSECTOR);
+            $conds[] = $sub . '.name LIKE ' . XDB::format('CONCAT(\'%\', {?}, \'%\')', $this->description);
+            $sub = $uf->addJobSectorizationFilter(UserFilter::JOB_ALTERNATES);
+            $conds[] = $sub . '.name LIKE ' . XDB::format('CONCAT(\'%\', {?}, \'%\')', $this->description);
+        }
+        return implode(' OR ', $conds);
+    }
+}
+// }}}
+
+// {{{ class UFC_Networking
+/** Filters users based on network identity (IRC, ...)
+ * @param $type Type of network (-1 for any)
+ * @param $value Value to search
+ */
+class UFC_Networking extends UserFilterCondition
+{
+    private $type;
+    private $value;
+
+    public function __construct($type, $value)
+    {
+        $this->type = $type;
+        $this->value = $value;
+    }
+
+    public function buildCondition(UserFilter &$uf)
+    {
+        $sub = $uf->addNetworkingFilter();
+        $conds = array();
+        $conds[] = $sub . '.address = ' . XDB::format('CONCAT(\'%\', {?}, \'%\')', $this->value);
+        if ($this->type != -1) {
+            $conds[] = $sub . '.network_type = ' . XDB::format('{?}', $this->type);
+        }
+        return implode(' AND ', $conds);
+    }
+}
+// }}}
+
+// {{{ class UFC_Phone
+/** Filters users based on their phone number
+ * @param $num_type Type of number (pro/user/home)
+ * @param $phone_type Type of phone (fixed/mobile/fax)
+ * @param $number Phone number
+ */
+class UFC_Phone extends UserFilterCondition
+{
+    const NUM_PRO   = 'pro';
+    const NUM_USER  = 'user';
+    const NUM_HOME  = 'address';
+    const NUM_ANY   = 'any';
+
+    const PHONE_FIXED   = 'fixed';
+    const PHONE_MOBILE  = 'mobile';
+    const PHONE_FAX     = 'fax';
+    const PHONE_ANY     = 'any';
+
+    private $num_type;
+    private $phone_type;
+    private $number;
+
+    public function __construct($number, $num_type = self::NUM_ANY, $phone_type = self::PHONE_ANY)
+    {
+        require_once('profil.inc.php');
+        $this->number = $number;
+        $this->num_type = $num_type;
+        $this->phone_type = format_phone_number($phone_type);
+    }
+
+    public function buildCondition(UserFilter &$uf)
+    {
+        $sub = $uf->addPhoneFilter();
+        $conds = array();
+        $conds[] = $sub . '.search_tel = ' . XDB::format('{?}', $this->number);
+        if ($this->num_type != self::NUM_ANY) {
+            $conds[] = $sub . '.link_type = ' . XDB::format('{?}', $this->num_type);
+        }
+        if ($this->phone_type != self::PHONE_ANY) {
+            $conds[] = $sub . '.tel_type = ' . XDB::format('{?}', $this->phone_type);
+        }
+        return implode(' AND ', $conds);
+    }
+}
+// }}}
+
+// {{{ class UFC_Medal
+/** Filters users based on their medals
+ * @param $medal ID of the medal
+ * @param $grade Grade of the medal (null for 'any')
+ */
+class UFC_Medal extends UserFilterCondition
+{
+    private $medal;
+    private $grade;
+
+    public function __construct($medal, $grade = null)
+    {
+        $this->medal = $medal;
+        $this->grade = $grade;
+    }
+
+    public function buildCondition(UserFilter &$uf)
+    {
+        $conds = array();
+        $sub = $uf->addMedalFilter();
+        $conds[] = $sub . '.mid = ' . XDB::format('{?}', $this->medal);
+        if ($this->grade != null) {
+            $conds[] = $sub . '.gid = ' . XDB::format('{?}', $this->grade);
+        }
+        return implode(' AND ', $conds);
+    }
+}
+// }}}
+
+// {{{ class UFC_Mentor_Expertise
+/** Filters users by mentoring expertise
+ * @param $expertise Domain of expertise
+ */
+class UFC_Mentor_Expertise extends 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 extends 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 extends 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 a user
+ * @param $user User to which searched users are related
+ */
+abstract class UFC_UserRelated implements UserFilterCondition
+{
+    protected $user;
+    public function __construct(PlUser &$user)
+    {
+        $this->user =& $user;
+    }
+}
+// }}}
+
+// {{{ class UFC_Contact
+/** Filters users who belong to selected user's contacts
+ */
+class UFC_Contact extends UFC_UserRelated
+{
+    public function buildCondition(UserFilter &$uf)
+    {
+        $sub = $uf->addContactFilter($this->user->id());
+        return 'c' . $sub . '.contact IS NOT NULL';
+    }
+}
+// }}}
+
+// {{{ class UFC_WatchRegistration
+/** Filters users being watched by selected user
+ */
+class UFC_WatchRegistration extends UFC_UserRelated
+{
+    public function buildCondition(UserFilter &$uf)
+    {
+        if (!$this->user->watch('registration')) {
+            return UserFilterCondition::COND_FALSE;
+        }
+        $uids = $this->user->watchUsers();
+        if (count($uids) == 0) {
+            return UserFilterCondition::COND_FALSE;
+        } else {
+            return '$UID IN ' . XDB::formatArray($uids);
+        }
+    }
+}
+// }}}
+
+// {{{ class UFC_WatchPromo
+/** Filters users belonging to a promo watched by selected user
+ * @param $user Selected user (the one watching promo)
+ * @param $grade Formation the user is watching
+ */
+class UFC_WatchPromo extends UFC_UserRelated
+{
+    private $grade;
+    public function __construct(PlUser &$user, $grade = UserFilter::GRADE_ING)
+    {
+        parent::__construct($user);
+        $this->grade = $grade;
+    }
+
+    public function buildCondition(UserFilter &$uf)
+    {
+        $promos = $this->user->watchPromos();
+        if (count($promos) == 0) {
+            return UserFilterCondition::COND_FALSE;
+        } else {
+            $sube = $uf->addEducationFilter(true, $this->grade);
+            $field = 'pe' . $sube . '.' . UserFilter::promoYear($this->grade);
+            return $field . ' IN ' . XDB::formatArray($promos);
+        }
+    }
+}
+// }}}
+
+// {{{ class UFC_WatchContact
+/** Filters users watched by selected user
+ */
+class UFC_WatchContact extends UFC_Contact
+{
+    public function buildCondition(UserFilter &$uf)
+    {
+        if (!$this->user->watchContacts()) {
+            return UserFilterCondition::COND_FALSE;
+        }
+        return parent::buildCondition($uf);
+    }
+}
+// }}}
+
+
+/******************
+ * ORDERS
+ ******************/
+
+// {{{ class UserFilterOrder
+abstract class UserFilterOrder
+{
+    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;
+    }
+
+    abstract protected function getSortTokens(UserFilter &$uf);
+}
+// }}}
+
+// {{{ class UFO_Promo
+/** 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
+{
+    private $grade;
+
+    public function __construct($grade = null, $desc = false)
+    {
+        parent::__construct($desc);
+        $this->grade = $grade;
+    }
+
+    protected function getSortTokens(UserFilter &$uf)
+    {
+        if (UserFilter::isGrade($this->grade)) {
+            $sub = $uf->addEducationFilter($this->grade);
+            return 'pe' . $sub . '.' . UserFilter::promoYear($this->grade);
+        } else {
+            $sub = $uf->addDisplayFilter();
+            return 'pd' . $sub . '.promo';
+        }
+    }
+}
+// }}}
+
+// {{{ class UFO_Name
+/** Sorts users by name
+ * @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
+ */
+class UFO_Name extends UserFilterOrder
+{
+    private $type;
+    private $variant;
+    private $particle;
+
+    public function __construct($type, $variant = null, $particle = false, $desc = false)
+    {
+        parent::__construct($desc);
+        $this->type = $type;
+        $this->variant = $variant;
+        $this->particle = $particle;
+    }
+
+    protected function getSortTokens(UserFilter &$uf)
+    {
+        if (UserFilter::isDisplayName($this->type)) {
+            $sub = $uf->addDisplayFilter();
+            return 'pd' . $sub . '.' . $this->type;
+        } else {
+            $sub = $uf->addNameFilter($this->type, $this->variant);
+            if ($this->particle) {
+                return 'CONCAT(pn' . $sub . '.particle, \' \', pn' . $sub . '.name)';
+            } else {
+                return 'pn' . $sub . '.name';
+            }
+        }
+    }
+}
+// }}}
+
+// {{{ class UFO_Registration
+/** Sorts users based on registration date
+ */
+class UFO_Registration extends UserFilterOrder
+{
+    protected function getSortTokens(UserFilter &$uf)
+    {
+        return 'a.registration_date';
+    }
+}
+// }}}
+
+// {{{ class UFO_Birthday
+/** Sorts users based on next birthday date
+ */
+class UFO_Birthday extends UserFilterOrder
+{
+    protected function getSortTokens(UserFilter &$uf)
+    {
+        return 'p.next_birthday';
+    }
+}
+// }}}
+
+// {{{ class UFO_ProfileUpdate
+/** Sorts users based on last profile update
+ */
+class UFO_ProfileUpdate extends UserFilterOrder
+{
+    protected function getSortTokens(UserFilter &$uf)
+    {
+        return 'p.last_change';
+    }
+}
+// }}}
+
+// {{{ class UFO_Death
+/** Sorts users based on death date
+ */
+class UFO_Death extends UserFilterOrder
+{
+    protected function getSortTokens(UserFilter &$uf)
+    {
+        return 'p.deathdate';
+    }
+}
+// }}}
+
+
+/***********************************
+  *********************************
+          USER FILTER CLASS
+  *********************************
+ ***********************************/
+
+// {{{ class UserFilter
+class UserFilter
+{
+    static private $joinMethods = array();
+
+    private $root;
+    private $sort = array();
+    private $query = null;
+    private $orderby = null;
+
+    private $lastcount = null;
+
+    public function __construct($cond = null, $sort = null)
+    {
+        if (empty(self::$joinMethods)) {
+            $class = new ReflectionClass('UserFilter');
+            foreach ($class->getMethods() as $method) {
+                $name = $method->getName();
+                if (substr($name, -5) == 'Joins' && $name != 'buildJoins') {
+                    self::$joinMethods[] = $name;
+                }
+            }
+        }
+        if (!is_null($cond)) {
+            if ($cond instanceof UserFilterCondition) {
+                $this->setCondition($cond);
+            }
+        }
+        if (!is_null($sort)) {
+            if ($sort instanceof UserFilterOrder) {
+                $this->addSort($sort);
+            } else if (is_array($sort)) {
+                foreach ($sort as $s) {
+                    $this->addSort($s);
+                }
+            }
+        }
+    }
+
+    private function buildQuery()
+    {
+        if (is_null($this->orderby)) {
+            $orders = array();
+            foreach ($this->sort as $sort) {
+                $orders = array_merge($orders, $sort->buildSort($this));
+            }
+            if (count($orders) == 0) {
+                $this->orderby = '';
+            } else {
+                $this->orderby = 'ORDER BY  ' . implode(', ', $orders);
+            }
+        }
+        if (is_null($this->query)) {
+            $where = $this->root->buildCondition($this);
+            $joins = $this->buildJoins();
+            $this->query = 'FROM  accounts AS a
+                       LEFT JOIN  account_profiles AS ap ON (ap.uid = a.uid AND FIND_IN_SET(\'owner\', ap.perms))
+                       LEFT JOIN  profiles AS p ON (p.pid = ap.pid)
+                               ' . $joins . '
+                           WHERE  (' . $where . ')';
+        }
+    }
+
+    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)
+    {
+        $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);
+            }
+        }
+        $cond = '';
+        if (!is_null($uids)) {
+            $cond = ' AND a.uid IN ' . XDB::formatArray($uids);
+        }
+        $fetched = XDB::fetchColumn('SELECT SQL_CALC_FOUND_ROWS  a.uid
+                                    ' . $this->query . $cond . '
+                                   GROUP BY  a.uid
+                                    ' . $this->orderby . '
+                                    ' . $limit);
+        $this->lastcount = (int)XDB::fetchOneCell('SELECT FOUND_ROWS()');
+        return $fetched;
+    }
+
+    /** Check that the user match the given rule.
+     */
+    public function checkUser(PlUser &$user)
+    {
+        $this->buildQuery();
+        $count = (int)XDB::fetchOneCell('SELECT  COUNT(*)
+                                        ' . $this->query . XDB::format(' AND a.uid = {?}', $user->id()));
+        return $count == 1;
+    }
+
+    /** Filter a list of user to extract the users matching the rule.
+     */
+    public function filter(array $users, $count = null, $offset = null)
+    {
+        $this->buildQuery();
+        $table = array();
+        $uids  = array();
+        foreach ($users as $user) {
+            if ($user instanceof PlUser) {
+                $uid = $user->id();
+            } else {
+                $uid = $user;
+            }
+            $uids[] = $uid;
+            $table[$uid] = $user;
+        }
+        $fetched = $this->getUIDList($uids, $count, $offset);
+        $output = array();
+        foreach ($fetched as $uid) {
+            $output[] = $table[$uid];
+        }
+        return $output;
+    }
+
+    public function getUIDs($count = null, $offset = null)
+    {
+        return $this->getUIDList(null, $count, $offset);
+    }
+
+    public function getUsers($count = null, $offset = null)
+    {
+        return User::getBulkUsersWithUIDs($this->getUIDs($count, $offset));
+    }
+
+    public function getTotalCount()
+    {
+        if (is_null($this->lastcount)) {
+            $this->buildQuery();
+            return (int)XDB::fetchOneCell('SELECT  COUNT(DISTINCT a.uid)
+                                          ' . $this->query);
+        } else {
+            return $this->lastcount;
+        }
+    }
+
+    public function setCondition(UserFilterCondition &$cond)
+    {
+        $this->root =& $cond;
+        $this->query = null;
+    }
+
+    public function addSort(UserFilterOrder &$sort)
+    {
+        $this->sort[] = $sort;
+        $this->orderby = null;
+    }
+
+    static public function getLegacy($promo_min, $promo_max)
+    {
+        if ($promo_min != 0) {
+            $min = new UFC_Promo('>=', self::GRADE_ING, intval($promo_min));
+        } else {
+            $min = new UFC_True();
+        }
+        if ($promo_max != 0) {
+            $max = new UFC_Promo('<=', self::GRADE_ING, intval($promo_max));
+        } else {
+            $max = new UFC_True();
+        }
+        return new UserFilter(new UFC_And($min, $max));
+    }
+
+    static public function sortByName()
+    {
+        return array(new UFO_Name(self::LASTNAME), new UFO_Name(self::FIRSTNAME));
+    }
+
+    static public function sortByPromo()
+    {
+        return array(new UFO_Promo(), new UFO_Name(self::LASTNAME), new UFO_Name(self::FIRSTNAME));
+    }
+
+    static private function getDBSuffix($string)
+    {
+        return preg_replace('/[^a-z0-9]/i', '', $string);
+    }
+
+
+    private $option = 0;
+    private function register_optional(array &$table, $val)
+    {
+        if (is_null($val)) {
+            $sub   = $this->option++;
+            $index = null;
+        } else {
+            $sub   = self::getDBSuffix($val);
+            $index = $val;
+        }
+        $sub = '_' . $sub;
+        $table[$sub] = $index;
+        return $sub;
+    }
+
+    /** DISPLAY
+     */
+    const DISPLAY = 'display';
+    private $pd = false;
+    public function addDisplayFilter()
+    {
+        $this->pd = true;
+        return '';
+    }
+
+    private function displayJoins()
+    {
+        if ($this->pd) {
+            return array('pd' => array('left', 'profile_display', '$ME.pid = $PID'));
+        } else {
+            return array();
+        }
+    }
+
+    /** NAMES
+     */
+    /* name tokens */
+    const LASTNAME  = 'lastname';
+    const FIRSTNAME = 'firstname';
+    const NICKNAME  = 'nickname';
+    const PSEUDONYM = 'pseudonym';
+    const NAME      = 'name';
+    /* name variants */
+    const VN_MARITAL  = 'marital';
+    const VN_ORDINARY = 'ordinary';
+    const VN_OTHER    = 'other';
+    const VN_INI      = 'ini';
+    /* display names */
+    const DN_FULL      = 'directory_name';
+    const DN_DISPLAY   = 'yourself';
+    const DN_YOURSELF  = 'yourself';
+    const DN_DIRECTORY = 'directory_name';
+    const DN_PRIVATE   = 'private_name';
+    const DN_PUBLIC    = 'public_name';
+    const DN_SHORT     = 'short_name';
+    const DN_SORT      = 'sort_name';
+
+    static public $name_variants = array(
+        self::LASTNAME => array(self::VN_MARITAL, self::VN_ORDINARY),
+        self::FIRSTNAME => array(self::VN_ORDINARY, self::VN_INI, self::VN_OTHER)
+    );
+
+    static public function assertName($name)
+    {
+        if (!Profile::getNameTypeId($name)) {
+            Platal::page()->kill('Invalid name type');
+        }
+    }
+
+    static public function isDisplayName($name)
+    {
+        return $name == self::DN_FULL || $name == self::DN_DISPLAY
+            || $name == self::DN_YOURSELF || $name == self::DN_DIRECTORY
+            || $name == self::DN_PRIVATE || $name == self::DN_PUBLIC
+            || $name == self::DN_SHORT || $name == self::DN_SORT;
+    }
+
+    private $pn  = array();
+    public function addNameFilter($type, $variant = null)
+    {
+        if (!is_null($variant)) {
+            $ft  = $type . '_' . $variant;
+        } else {
+            $ft = $type;
+        }
+        $sub = '_' . $ft;
+        self::assertName($ft);
+
+        if (!is_null($variant) && $variant == 'other') {
+            $sub .= $this->option++;
+        }
+        $this->pn[$sub] = Profile::getNameTypeId($ft);
+        return $sub;
+    }
+
+    private function nameJoins()
+    {
+        $joins = array();
+        foreach ($this->pn as $sub => $type) {
+            $joins['pn' . $sub] = array('left', 'profile_name', '$ME.pid = $PID AND $ME.typeid = ' . $type);
+        }
+        return $joins;
+    }
+
+
+    /** EDUCATION
+     */
+    const GRADE_ING = 'Ing.';
+    const GRADE_PHD = 'PhD';
+    const GRADE_MST = 'M%';
+    static public function isGrade($grade)
+    {
+        return $grade == self::GRADE_ING || $grade == self::GRADE_PHD || $grade == self::GRADE_MST;
+    }
+
+    static public function assertGrade($grade)
+    {
+        if (!self::isGrade($grade)) {
+            Platal::page()->killError("DiplĂ´me non valide");
+        }
+    }
+
+    static public function promoYear($grade)
+    {
+        // XXX: Definition of promotion for phds and masters might change in near future.
+        return ($grade == UserFilter::GRADE_ING) ? 'entry_year' : 'grad_year';
+    }
+
+    private $pepe     = array();
+    private $with_pee = false;
+    public function addEducationFilter($x = false, $grade = null)
+    {
+        if (!$x) {
+            $index = $this->option;
+            $sub   = $this->option++;
+        } else {
+            self::assertGrade($grade);
+            $index = $grade;
+            $sub   = $grade[0];
+            $this->with_pee = true;
+        }
+        $sub = '_' . $sub;
+        $this->pepe[$index] = $sub;
+        return $sub;
+    }
+
+    private function educationJoins()
+    {
+        $joins = array();
+        if ($this->with_pee) {
+            $joins['pee'] = array('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 ' .
+                                                  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');
+            }
+        }
+        return $joins;
+    }
+
+
+    /** GROUPS
+     */
+    private $gpm = array();
+    public function addGroupFilter($group = null)
+    {
+        if (!is_null($group)) {
+            if (ctype_digit($group)) {
+                $index = $sub = $group;
+            } else {
+                $index = $group;
+                $sub   = self::getDBSuffix($group);
+            }
+        } else {
+            $sub = 'group_' . $this->option++;
+            $index = null;
+        }
+        $sub = '_' . $sub;
+        $this->gpm[$sub] = $index;
+        return $sub;
+    }
+
+    private function groupJoins()
+    {
+        $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');
+            } else if (ctype_digit($key)) {
+                $joins['gpm' . $sub] = array('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');
+            }
+        }
+        return $joins;
+    }
+
+    /** EMAILS
+     */
+    private $e = array();
+    public function addEmailRedirectFilter($email = null)
+    {
+        return $this->register_optional($this->e, $email);
+    }
+
+    private $ve = array();
+    public function addVirtualEmailFilter($email = null)
+    {
+        $this->addAliasFilter(self::ALIAS_FORLIFE);
+        return $this->register_optional($this->ve, $email);
+    }
+
+    const ALIAS_BEST    = 'bestalias';
+    const ALIAS_FORLIFE = 'forlife';
+    private $al = array();
+    public function addAliasFilter($alias = null)
+    {
+        return $this->register_optional($this->al, $alias);
+    }
+
+    private function emailJoins()
+    {
+        global $globals;
+        $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\'');
+            } else {
+                $joins['e' . $sub] = array('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\')');
+            } 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)');
+            } else if ($key == self::ALIAS_FORLIFE) {
+                $joins['al' . $sub] = array('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));
+            }
+        }
+        foreach ($this->ve as $sub=>$key) {
+            if (is_null($key)) {
+                $joins['v' . $sub] = array('left', 'virtual', '$ME.type = \'user\'');
+            } else {
+                $joins['v' . $sub] = array('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
+                                                                                 AND ($ME.redirect IN (CONCAT(al_forlife.alias, \'@\', {?}),
+                                                                                                       CONCAT(al_forlife.alias, \'@\', {?}),
+                                                                                                       a.email))',
+                                                                                $globals->mail->domain, $globals->mail->domain2));
+        }
+        return $joins;
+    }
+
+
+    /** ADDRESSES
+     */
+    private $pa = false;
+    public function addAddressFilter()
+    {
+        $this->pa = true;
+    }
+
+    private function addressJoins()
+    {
+        $joins = array();
+        if ($this->pa) {
+            $joins['pa'] = array('left', 'profile_address', '$ME.pid = $PID');
+        }
+        return $joins;
+    }
+
+
+    /** CORPS
+     */
+
+    private $pc = false;
+    private $pce = array();
+    private $pcr = false;
+    public function addCorpsFilter($type)
+    {
+        $this->pc = true;
+        if ($type == UFC_Corps::CURRENT) {
+            $pce['pcec'] = 'current_corpsid';
+            return 'pcec';
+        } else if ($type == UFC_Corps::ORIGIN) {
+            $pce['pceo'] = 'original_corpsid';
+            return 'pceo';
+        }
+    }
+
+    public function addCorpsRankFilter()
+    {
+        $this->pc = true;
+        $this->pcr = true;
+        return 'pcr';
+    }
+
+    private function corpsJoins()
+    {
+        $joins = array();
+        if ($this->pc) {
+            $joins['pc'] = array('left', 'profile_corps', '$ME.uid = $UID');
+        }
+        if ($this->pcr) {
+            $joins['pcr'] = array('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);
+        }
+        return $joins;
+    }
+
+    /** JOBS
+     */
+
+    const JOB_SECTOR = 1;
+    const JOB_SUBSECTOR = 2;
+    const JOB_SUBSUBSECTOR = 4;
+    const JOB_ALTERNATES = 8;
+    const JOB_USERDEFINED = 16;
+
+    /** Joins :
+     * pj => profile_job
+     * pje => profile_job_enum
+     * pjse => profile_job_sector_enum
+     * pjsse => profile_job_subsector_enum
+     * pjssse => profile_job_subsubsector_enum
+     * pja => profile_job_alternates
+     */
+    private $with_pj = false;
+    private $with_pje = false;
+    private $with_pjse = false;
+    private $with_pjsse = false;
+    private $with_pjssse = false;
+    private $with_pja = false;
+
+    public function addJobFilter()
+    {
+        $this->with_pj = true;
+        return 'pj';
+    }
+
+    public function addJobCompanyFilter()
+    {
+        $this->addJobFilter();
+        $this->with_pje = true;
+        return 'pje';
+    }
+
+    public function addJobSectorizationFilter($type)
+    {
+        $this->addJobFilter();
+        if ($type == self::JOB_SECTOR) {
+            $this->with_pjse = true;
+            return 'pjse';
+        } else if ($type == self::JOB_SUBSECTOR) {
+            $this->with_pjsse = true;
+            return 'pjsse';
+        } else if ($type == self::JOB_SUBSUBSECTOR) {
+            $this->with_pjssse = true;
+            return 'pjssse';
+        } else if ($type == self::JOB_ALTERNATES) {
+            $this->with_pja = true;
+            return 'pja';
+        }
+    }
+
+    private function jobJoins()
+    {
+        $joins = array();
+        if ($this->with_pj) {
+            $joins['pj'] = array('left', 'profile_job', '$ME.uid = $UID');
+        }
+        if ($this->with_pje) {
+            $joins['pje'] = array('left', 'profile_job_enum', '$ME.id = pj.jobid');
+        }
+        if ($this->with_pjse) {
+            $joins['pjse'] = array('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');
+        }
+        if ($this->with_pjssse) {
+            $joins['pjssse'] = array('left', 'profile_job_subsubsector_enum', '$ME.id = pj.subsubsectorid');
+        }
+        if ($this->with_pja) {
+            $joins['pja'] = array('left', 'profile_job_alternates', '$ME.subsubsectorid = pj.subsubsectorid');
+        }
+        return $joins;
+    }
+
+    /** NETWORKING
+     */
+
+    private $with_pnw = false;
+    public function addNetworkingFilter()
+    {
+        $this->with_pnw = true;
+        return 'pnw';
+    }
+
+    private function networkingJoins()
+    {
+        $joins = array();
+        if ($this->with_pnw) {
+            $joins['pnw'] = array('left', 'profile_networking', '$ME.uid = $UID');
+        }
+        return $joins;
+    }
+
+    /** PHONE
+     */
+
+    private $with_phone = false;
+
+    public function addPhoneFilter()
+    {
+        $this->with_phone = true;
+        return 'ptel';
+    }
+
+    private function phoneJoins()
+    {
+        $joins = array();
+        if ($this->with_phone) {
+            $joins['ptel'] = array('left', 'profile_phone', '$ME.uid = $UID');
+        }
+        return $joins;
+    }
+
+    /** MEDALS
+     */
+
+    private $with_medals = false;
+    public function addMedalFilter()
+    {
+        $this->with_medals = true;
+        return 'pmed';
+    }
+
+    private function medalJoins()
+    {
+        $joins = array();
+        if ($this->with_medals) {
+            $joins['pmed'] = array('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] = array('left', $tab, '$ME.uid = $UID');
+        }
+        return $joins;
+    }
+
+    /** CONTACTS
+     */
+    private $cts = array();
+    public function addContactFilter($uid = null)
+    {
+        return $this->register_optional($this->cts, is_null($uid) ? null : 'user_' . $uid);
+    }
+
+    private function contactJoins()
+    {
+        $joins = array();
+        foreach ($this->cts as $sub=>$key) {
+            if (is_null($key)) {
+                $joins['c' . $sub] = array('left', 'contacts', '$ME.contact = $UID');
+            } else {
+                $joins['c' . $sub] = array('left', 'contacts', XDB::format('$ME.uid = {?} AND $ME.contact = $UID', substr($key, 5)));
+            }
+        }
+        return $joins;
+    }
+
+
+    /** CARNET
+     */
+    private $wn = array();
+    public function addWatchRegistrationFilter($uid = null)
+    {
+        return $this->register_optional($this->wn, is_null($uid) ? null : 'user_' . $uid);
+    }
+
+    private $wp = array();
+    public function addWatchPromoFilter($uid = null)
+    {
+        return $this->register_optional($this->wp, is_null($uid) ? null : 'user_' . $uid);
+    }
+
+    private $w = array();
+    public function addWatchFilter($uid = null)
+    {
+        return $this->register_optional($this->w, is_null($uid) ? null : 'user_' . $uid);
+    }
+
+    private function watchJoins()
+    {
+        $joins = array();
+        foreach ($this->w as $sub=>$key) {
+            if (is_null($key)) {
+                $joins['w' . $sub] = array('left', 'watch');
+            } else {
+                $joins['w' . $sub] = array('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');
+            } else {
+                $joins['wn' . $sub] = array('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');
+            } else {
+                $joins['wn' . $sub] = array('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');
+            } else {
+                $joins['wp' . $sub] = array('left', 'watch_promo', XDB::format('$ME.uid = {?}', substr($key, 5)));
             }
         }
         return $joins;
     }
 }
+// }}}
 
 // vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
 ?>