Fix typo (PlFilter instead of PlLimit)
[platal.git] / classes / userfilter.php
index 16e233f..20696a0 100644 (file)
@@ -47,7 +47,7 @@ class UFC_HasProfile implements UserFilterCondition
     public function buildCondition(PlFilter &$uf)
     {
         $uf->requireProfiles();
-        return 'p.pid IS NOT NULL';
+        return '$PID IS NOT NULL';
     }
 }
 // }}}
@@ -60,12 +60,9 @@ class UFC_Hruid implements UserFilterCondition
 {
     private $hruids;
 
-    public function __construct($val)
+    public function __construct()
     {
-        if (!is_array($val)) {
-            $val = array($val);
-        }
-        $this->hruids = $val;
+        $this->hruids = pl_flatten(func_get_args());
     }
 
     public function buildCondition(PlFilter &$uf)
@@ -84,12 +81,9 @@ class UFC_Hrpid implements UserFilterCondition
 {
     private $hrpids;
 
-    public function __construct($val)
+    public function __construct()
     {
-        if (!is_array($val)) {
-            $val = array($val);
-        }
-        $this->hrpids = $val;
+        $this->hrpids = pl_flatten(func_get_args());
     }
 
     public function buildCondition(PlFilter &$uf)
@@ -161,6 +155,9 @@ class UFC_Promo implements UserFilterCondition
         if ($this->grade != UserFilter::DISPLAY) {
             UserFilter::assertGrade($this->grade);
         }
+        if ($this->grade == UserFilter::DISPLAY && $this->comparison != '=') {
+            Platal::page()->killError('Comparison ' . $this->comparison . ' not allowed on displaid promo');
+        }
     }
 
     public function buildCondition(PlFilter &$uf)
@@ -227,12 +224,9 @@ class UFC_EducationSchool implements UserFilterCondition
 {
     private $val;
 
-    public function __construct($val)
+    public function __construct()
     {
-        if (!is_array($val)) {
-            $val = array($val);
-        }
-        $this->val = $val;
+        $this->val = pl_flatten(func_get_args());
     }
 
     public function buildCondition(PlFilter &$uf)
@@ -248,12 +242,9 @@ class UFC_EducationDegree implements UserFilterCondition
 {
     private $diploma;
 
-    public function __construct($diploma)
+    public function __construct()
     {
-        if (! is_array($diploma)) {
-            $diploma = array($diploma);
-        }
-        $this->diploma = $diploma;
+        $this->diploma = pl_flatten(func_get_args());
     }
 
     public function buildCondition(PlFilter &$uf)
@@ -269,18 +260,15 @@ class UFC_EducationField implements UserFilterCondition
 {
     private $val;
 
-    public function __construct($val)
+    public function __construct()
     {
-        if (!is_array($val)) {
-            $val = array($val);
-        }
-        $this->val = $val;
+        $this->val = pl_flatten(func_get_args());
     }
 
     public function buildCondition(PlFilter &$uf)
     {
         $sub = $uf->addEducationFilter();
-        return XDB::format('pee' . $sub . '.fieldid IN {?}', $this->val);
+        return XDB::format('pe' . $sub . '.fieldid IN {?}', $this->val);
     }
 }
 // }}}
@@ -293,10 +281,11 @@ class UFC_EducationField implements UserFilterCondition
  */
 class UFC_Name implements UserFilterCondition
 {
-    const PREFIX   = XDB::WILDCARD_PREFIX; // 0x001
-    const SUFFIX   = XDB::WILDCARD_SUFFIX; // 0x002
+    const EXACT    = XDB::WILDCARD_EXACT;    // 0x000
+    const PREFIX   = XDB::WILDCARD_PREFIX;   // 0x001
+    const SUFFIX   = XDB::WILDCARD_SUFFIX;   // 0x002
     const CONTAINS = XDB::WILDCARD_CONTAINS; // 0x003
-    const PARTICLE = 0x007; // self::CONTAINS | 0x004
+    const PARTICLE = 0x004;
     const VARIANTS = 0x008;
 
     private $type;
@@ -354,7 +343,11 @@ class UFC_NameTokens implements UserFilterCondition
 
     public function __construct($tokens, $flags = array(), $soundex = false, $exact = false)
     {
-        $this->tokens = $tokens;
+        if (is_array($tokens)) {
+            $this->tokens = $tokens;
+        } else {
+            $this->tokens = array($tokens);
+        }
         if (is_array($flags)) {
             $this->flags = $flags;
         } else {
@@ -366,22 +359,20 @@ class UFC_NameTokens implements UserFilterCondition
 
     public function buildCondition(PlFilter &$uf)
     {
-        $sub = $uf->addNameTokensFilter(!($this->exact || $this->soundex));
         $conds = array();
-        if ($this->soundex) {
-            $conds[] = XDB::format($sub . '.soundex IN {?}', $this->tokens);
-        } else if ($this->exact) {
-            $conds[] = XDB::format($sub . '.token IN {?}', $this->tokens);
-        } else {
-            $tokconds = array();
-            foreach ($this->tokens as $token) {
-                $tokconds[] = $sub . '.token ' . XDB::formatWildcards(XDB::WILDCARD_PREFIX, $token);
+        foreach ($this->tokens as $i => $token) {
+            $sub = $uf->addNameTokensFilter($token);
+            if ($this->soundex) {
+                $c = XDB::format($sub . '.soundex = {?}', $token);
+            } else if ($this->exact) {
+                $c = XDB::format($sub . '.token = {?}', $token);
+            } else {
+                $c = $sub . '.token ' . XDB::formatWildcards(XDB::WILDCARD_PREFIX, $token);
             }
-            $conds[] = implode(' OR ', $tokconds);
-        }
-
-        if ($this->flags != null) {
-            $conds[] = XDB::format($sub . '.flags IN {?}', $this->flags);
+            if ($this->flags != null) {
+                $c .= XDB::format(' AND ' . $sub . '.flags IN {?}', $this->flags);
+            }
+            $conds[] = $c;
         }
 
         return implode(' AND ', $conds);
@@ -394,12 +385,9 @@ class UFC_Nationality implements UserFilterCondition
 {
     private $val;
 
-    public function __construct($val)
+    public function __construct()
     {
-        if (!is_array($val)) {
-            $val = array($val);
-        }
-        $this->val = $val;
+        $this->val = pl_flatten(func_get_args());
     }
 
     public function buildCondition(PlFilter &$uf)
@@ -419,7 +407,7 @@ class UFC_Nationality implements UserFilterCondition
 // {{{ class UFC_Dead
 /** Filters users based on death date
  * @param $comparison Comparison operator
- * @param $date Date to which death date should be compared
+ * @param $date Date to which death date should be compared (DateTime object, string or timestamp)
  */
 class UFC_Dead implements UserFilterCondition
 {
@@ -429,7 +417,7 @@ class UFC_Dead implements UserFilterCondition
     public function __construct($comparison = null, $date = null)
     {
         $this->comparison = $comparison;
-        $this->date = $date;
+        $this->date = make_datetime($date);
     }
 
     public function buildCondition(PlFilter &$uf)
@@ -437,7 +425,7 @@ class UFC_Dead implements UserFilterCondition
         $uf->requireProfiles();
         $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));
+            $str .= ' AND p.deathdate ' . $this->comparison . ' ' . XDB::format('{?}', $this->date->format('Y-m-d'));
         }
         return $str;
     }
@@ -460,19 +448,19 @@ class UFC_Registered implements UserFilterCondition
     {
         $this->active = $active;
         $this->comparison = $comparison;
-        $this->date = $date;
+        $this->date = make_datetime($date);
     }
 
     public function buildCondition(PlFilter &$uf)
     {
         $uf->requireAccounts();
         if ($this->active) {
-            $date = 'a.uid IS NOT NULL AND a.state = \'active\'';
+            $date = '$UID IS NOT NULL AND a.state = \'active\'';
         } else {
-            $date = 'a.uid IS NOT NULL AND a.state != \'pending\'';
+            $date = '$UID IS NOT NULL AND a.state != \'pending\'';
         }
         if (!is_null($this->comparison)) {
-            $date .= ' AND a.registration_date ' . $this->comparison . ' ' . XDB::format('{?}', date('Y-m-d', $this->date));
+            $date .= ' AND a.registration_date != \'0000-00-00 00:00:00\' AND a.registration_date ' . $this->comparison . ' ' . XDB::format('{?}', $this->date->format('Y-m-d'));
         }
         return $date;
     }
@@ -586,12 +574,9 @@ class UFC_Binet implements UserFilterCondition
 {
     private $val;
 
-    public function __construct($val)
+    public function __construct()
     {
-        if (!is_array($val)) {
-            $val = array($val);
-        }
-        $this->val = $val;
+        $this->val = pl_flatten(func_get_args());
     }
 
     public function buildCondition(PlFilter &$uf)
@@ -610,15 +595,15 @@ class UFC_Section implements UserFilterCondition
 {
     private $section;
 
-    public function __construct($section)
+    public function __construct()
     {
-        $this->section = $section;
+        $this->section = pl_flatten(func_get_args());
     }
 
     public function buildCondition(PlFilter &$uf)
     {
         $uf->requireProfiles();
-        return 'p.section = ' . XDB::format('{?}', $this->section);
+        return XDB::format('p.section IN {?}', $this->section);
     }
 }
 // }}}
@@ -632,7 +617,7 @@ class UFC_Email implements UserFilterCondition
     private $emails;
     public function __construct()
     {
-        $this->emails = func_get_args();
+        $this->emails = pl_flatten(func_get_args());
     }
 
     public function buildCondition(PlFilter &$uf)
@@ -1187,15 +1172,15 @@ class UFC_Mentor_Country implements UserFilterCondition
 {
     private $country;
 
-    public function __construct($country)
+    public function __construct()
     {
-        $this->country = $country;
+        $this->country = pl_flatten(func_get_args());
     }
 
     public function buildCondition(PlFilter &$uf)
     {
         $sub = $uf->addMentorFilter(UserFilter::MENTOR_COUNTRY);
-        return $sub . '.country = ' . XDB::format('{?}', $this->country);
+        return $sub . '.country IN ' . XDB::format('{?}', $this->country);
     }
 }
 // }}}
@@ -1433,8 +1418,12 @@ class UFO_Score extends UserFilterOrder
 {
     protected function getSortTokens(PlFilter &$uf)
     {
-        $sub = $uf->addNameTokensFilter();
-        return 'SUM(' . $sub . '.score)';
+        $toks = $uf->getNameTokens();
+        $scores = array();
+        foreach ($toks as $sub => $token) {
+            $scores[] = XDB::format('SUM(' . $sub . '.score + IF (' . $sub . '.token = {?}, 5, 0) )', $token);
+        }
+        return implode(' + ', $scores);
     }
 }
 // }}}
@@ -1446,6 +1435,7 @@ class UFO_Registration extends UserFilterOrder
 {
     protected function getSortTokens(PlFilter &$uf)
     {
+        $uf->requireAccounts();
         return 'a.registration_date';
     }
 }
@@ -1458,6 +1448,7 @@ class UFO_Birthday extends UserFilterOrder
 {
     protected function getSortTokens(PlFilter &$uf)
     {
+        $uf->requireProfiles();
         return 'p.next_birthday';
     }
 }
@@ -1470,6 +1461,7 @@ class UFO_ProfileUpdate extends UserFilterOrder
 {
     protected function getSortTokens(PlFilter &$uf)
     {
+        $uf->requireProfiles();
         return 'p.last_change';
     }
 }
@@ -1482,11 +1474,64 @@ class UFO_Death extends UserFilterOrder
 {
     protected function getSortTokens(PlFilter &$uf)
     {
+        $uf->requireProfiles();
         return 'p.deathdate';
     }
 }
 // }}}
 
+// {{{ class UFO_Uid
+/** Sorts users based on their uid
+ */
+class UFO_Uid extends UserFilterOrder
+{
+    protected function getSortTokens(PlFilter &$uf)
+    {
+        $uf->requireAccounts();
+        return '$UID';
+    }
+}
+// }}}
+
+// {{{ class UFO_Hruid
+/** Sorts users based on their hruid
+ */
+class UFO_Hruid extends UserFilterOrder
+{
+    protected function getSortTokens(PlFilter &$uf)
+    {
+        $uf->requireAccounts();
+        return 'a.hruid';
+    }
+}
+// }}}
+
+// {{{ class UFO_Pid
+/** Sorts users based on their pid
+ */
+class UFO_Pid extends UserFilterOrder
+{
+    protected function getSortTokens(PlFilter &$uf)
+    {
+        $uf->requireProfiles();
+        return '$PID';
+    }
+}
+// }}}
+
+// {{{ class UFO_Hrpid
+/** Sorts users based on their hrpid
+ */
+class UFO_Hrpid extends UserFilterOrder
+{
+    protected function getSortTokens(PlFilter &$uf)
+    {
+        $uf->requireProfiles();
+        return 'p.hrpid';
+    }
+}
+// }}}
+
 
 /***********************************
   *********************************
@@ -1581,6 +1626,14 @@ class UserFilter extends PlFilter
 
     private function buildQuery()
     {
+        // The root condition is built first because some orders need info
+        // available only once all UFC have set their conditions (UFO_Score)
+        if (is_null($this->query)) {
+            $where = $this->root->buildCondition($this);
+            $where = str_replace(array_keys($this->joinMetas),
+                                 $this->joinMetas,
+                                 $where);
+        }
         if (is_null($this->orderby)) {
             $orders = array();
             foreach ($this->sort as $sort) {
@@ -1591,13 +1644,12 @@ class UserFilter extends PlFilter
             } else {
                 $this->orderby = 'ORDER BY  ' . implode(', ', $orders);
             }
+            $this->orderby = str_replace(array_keys($this->joinMetas),
+                                         $this->joinMetas,
+                                         $this->orderby);
         }
         if (is_null($this->query)) {
-            $where = $this->root->buildCondition($this);
-            if ($this->with_forced_sn) {
-                $this->requireProfiles();
-                $from = 'search_name AS sn';
-            } else if ($this->with_accounts) {
+            if ($this->with_accounts) {
                 $from = 'accounts AS a';
             } else {
                 $this->requireProfiles();
@@ -1743,7 +1795,7 @@ class UserFilter extends PlFilter
 
     public function getUID($pos = 0)
     {
-        $uids =$this->getUIDList(null, new PlFilter(1, $pos));
+        $uids =$this->getUIDList(null, new PlLimit(1, $pos));
         if (count($uids) == 0) {
             return null;
         } else {
@@ -1759,7 +1811,7 @@ class UserFilter extends PlFilter
 
     public function getPID($pos = 0)
     {
-        $pids =$this->getPIDList(null, new PlFilter(1, $pos));
+        $pids =$this->getPIDList(null, new PlLimit(1, $pos));
         if (count($pids) == 0) {
             return null;
         } else {
@@ -1916,7 +1968,6 @@ class UserFilter extends PlFilter
      */
     private $with_profiles  = false;
     private $with_accounts  = false;
-    private $with_forced_sn = false;
     public function requireAccounts()
     {
         $this->with_accounts = true;
@@ -1927,23 +1978,10 @@ class UserFilter extends PlFilter
         $this->with_profiles = true;
     }
 
-    /** Forces the "FROM" to use search_name instead of accounts or profiles */
-    public function forceSearchName()
-    {
-        $this->with_forced_sn = true;
-    }
-
     protected function accountJoins()
     {
         $joins = array();
-        /** Quick search is much more efficient with sn first and PID second */
-        if ($this->with_forced_sn) {
-            $joins['p'] = PlSqlJoin::left('profiles', '$PID = sn.pid');
-            if ($this->with_accounts) {
-                $joins['ap'] = PlSqlJoin::left('account_profiles', '$ME.pid = $PID');
-                $joins['a'] = PlSqlJoin::left('accounts', '$UID = ap.uid');
-            }
-        } else if ($this->with_profiles && $this->with_accounts) {
+        if ($this->with_profiles && $this->with_accounts) {
             $joins['ap'] = PlSqlJoin::left('account_profiles', '$ME.uid = $UID AND FIND_IN_SET(\'owner\', ap.perms)');
             $joins['p'] = PlSqlJoin::left('profiles', '$PID = ap.pid');
         }
@@ -2029,26 +2067,31 @@ class UserFilter extends PlFilter
 
     /** NAMETOKENS
      */
-    private $with_sn = false;
-    // Set $doingQuickSearch to true if you wish to optimize the query
-    public function addNameTokensFilter($doingQuickSearch = false)
+    private $name_tokens = array();
+    private $nb_tokens = 0;
+
+    public function addNameTokensFilter($token)
     {
         $this->requireProfiles();
-        $this->with_forced_sn = ($this->with_forced_sn || $doingQuickSearch);
-        $this->with_sn = true;
-        return 'sn';
+        $sub = 'sn' . (1 + $this->nb_tokens);
+        $this->nb_tokens++;
+        $this->name_tokens[$sub] = $token;
+        return $sub;
     }
 
     protected function nameTokensJoins()
     {
         /* We don't return joins, since with_sn forces the SELECT to run on search_name first */
-        if ($this->with_sn && !$this->with_forced_sn) {
-            return array(
-                'sn' => PlSqlJoin::left('search_name', '$ME.pid = $PID')
-            );
-        } else {
-            return array();
+        $joins = array();
+        foreach ($this->name_tokens as $sub => $token) {
+            $joins[$sub] = PlSqlJoin::left('search_name', '$ME.pid = $PID');
         }
+        return $joins;
+    }
+
+    public function getNameTokens()
+    {
+        return $this->name_tokens;
     }
 
     /** NATIONALITY