Patch from MaxSem re bug 15162 - handle throttling in the login API
[lhc/web/wiklou.git] / includes / api / ApiQueryAllpages.php
index 5ca0acc..c4ac486 100644 (file)
@@ -30,8 +30,8 @@ if (!defined('MEDIAWIKI')) {
 
 /**
  * Query module to enumerate all available pages.
- * 
- * @addtogroup API
+ *
+ * @ingroup API
  */
 class ApiQueryAllpages extends ApiQueryGeneratorBase {
 
@@ -55,27 +55,29 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase {
                $db = $this->getDB();
 
                $params = $this->extractRequestParams();
-               
+
                // Page filters
+               $this->addTables('page');
                if (!$this->addWhereIf('page_is_redirect = 1', $params['filterredir'] === 'redirects'))
                        $this->addWhereIf('page_is_redirect = 0', $params['filterredir'] === 'nonredirects');
                $this->addWhereFld('page_namespace', $params['namespace']);
-               if (!is_null($params['from']))
-                       $this->addWhere('page_title>=' . $db->addQuotes(ApiQueryBase :: titleToKey($params['from'])));
+               $dir = ($params['dir'] == 'descending' ? 'older' : 'newer');
+               $from = (is_null($params['from']) ? null : $this->titleToKey($params['from']));
+               $this->addWhereRange('page_title', $dir, $from, null);
                if (isset ($params['prefix']))
-                       $this->addWhere("page_title LIKE '" . $db->escapeLike(ApiQueryBase :: titleToKey($params['prefix'])) . "%'");
+                       $this->addWhere("page_title LIKE '" . $db->escapeLike($this->titleToKey($params['prefix'])) . "%'");
 
                $forceNameTitleIndex = true;
                if (isset ($params['minsize'])) {
                        $this->addWhere('page_len>=' . intval($params['minsize']));
                        $forceNameTitleIndex = false;
                }
-               
+
                if (isset ($params['maxsize'])) {
                        $this->addWhere('page_len<=' . intval($params['maxsize']));
                        $forceNameTitleIndex = false;
                }
-       
+
                // Page protection filtering
                if (isset ($params['prtype'])) {
                        $this->addTables('page_restrictions');
@@ -86,7 +88,7 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase {
                        $prlevel = $params['prlevel'];
                        if (!is_null($prlevel) && $prlevel != '' && $prlevel != '*')
                                $this->addWhereFld('pr_level', $prlevel);
-                               
+
                        $this->addOption('DISTINCT');
 
                        $forceNameTitleIndex = false;
@@ -94,11 +96,19 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase {
                } else if (isset ($params['prlevel'])) {
                        $this->dieUsage('prlevel may not be used without prtype', 'params');
                }
-               
-               $this->addTables('page');
+
+               if($params['filterlanglinks'] == 'withoutlanglinks') {
+                       $this->addTables('langlinks');
+                       $this->addJoinConds(array('langlinks' => array('LEFT JOIN', 'page_id=ll_from')));
+                       $this->addWhere('ll_from IS NULL');
+                       $forceNameTitleIndex = false;
+               } else if($params['filterlanglinks'] == 'withlanglinks') {
+                       $this->addTables('langlinks');
+                       $this->addWhere('page_id=ll_from');
+                       $forceNameTitleIndex = false;
+               }
                if ($forceNameTitleIndex)
                        $this->addOption('USE INDEX', 'name_title');
-               
 
                if (is_null($resultPageSet)) {
                        $this->addFields(array (
@@ -112,9 +122,6 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase {
 
                $limit = $params['limit'];
                $this->addOption('LIMIT', $limit+1);
-               $this->addOption('ORDER BY', 'page_namespace, page_title' .
-                                               ($params['dir'] == 'descending' ? ' DESC' : ''));
-
                $res = $this->select(__METHOD__);
 
                $data = array ();
@@ -123,7 +130,7 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase {
                        if (++ $count > $limit) {
                                // We've reached the one extra which shows that there are additional pages to be had. Stop here...
                                // TODO: Security issue - if the user has no right to view next title, it will still be shown
-                               $this->setContinueEnumParameter('from', ApiQueryBase :: keyToTitle($row->page_title));
+                               $this->setContinueEnumParameter('from', $this->keyToTitle($row->page_title));
                                break;
                        }
 
@@ -146,9 +153,9 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase {
                }
        }
 
-       protected function getAllowedParams() {
+       public function getAllowedParams() {
                global $wgRestrictionTypes, $wgRestrictionLevels;
-               
+
                return array (
                        'from' => null,
                        'prefix' => null,
@@ -166,10 +173,10 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase {
                        ),
                        'minsize' => array (
                                ApiBase :: PARAM_TYPE => 'integer',
-                       ), 
+                       ),
                        'maxsize' => array (
                                ApiBase :: PARAM_TYPE => 'integer',
-                       ), 
+                       ),
                        'prtype' => array (
                                ApiBase :: PARAM_TYPE => $wgRestrictionTypes,
                                ApiBase :: PARAM_ISMULTI => true
@@ -191,11 +198,19 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase {
                                        'ascending',
                                        'descending'
                                )
+                       ),
+                       'filterlanglinks' => array(
+                               ApiBase :: PARAM_TYPE => array(
+                                       'withlanglinks',
+                                       'withoutlanglinks',
+                                       'all'
+                               ),
+                               ApiBase :: PARAM_DFLT => 'all'
                        )
                );
        }
 
-       protected function getParamDescription() {
+       public function getParamDescription() {
                return array (
                        'from' => 'The page title to start enumerating from.',
                        'prefix' => 'Search for all page titles that begin with this value.',
@@ -206,11 +221,12 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase {
                        'maxsize' => 'Limit to pages with at most this many bytes',
                        'prtype' => 'Limit to protected pages only',
                        'prlevel' => 'The protection level (must be used with apprtype= parameter)',
+                       'filterlanglinks' => 'Filter based on whether a page has langlinks',
                        'limit' => 'How many total pages to return.'
                );
        }
 
-       protected function getDescription() {
+       public function getDescription() {
                return 'Enumerate all pages sequentially in a given namespace';
        }
 
@@ -231,4 +247,3 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase {
                return __CLASS__ . ': $Id$';
        }
 }
-