Followup to r53087 / r53052 - Change dieUsage to setWarning per CodeReview
[lhc/web/wiklou.git] / includes / api / ApiQueryAllpages.php
index 8f7daec..4391290 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,38 +55,55 @@ 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->titlePartToKey($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->titlePartToKey($params['prefix'])) . "%'");
 
+               if (is_null($resultPageSet)) {
+                       $selectFields = array (
+                               'page_namespace',
+                               'page_title',
+                               'page_id'
+                       );
+               } else {
+                       $selectFields = $resultPageSet->getPageTableFields();
+               }
+               $this->addFields($selectFields);
                $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'])) {
+               if (!empty ($params['prtype'])) {
                        $this->addTables('page_restrictions');
                        $this->addWhere('page_id=pr_page');
                        $this->addWhere('pr_expiry>' . $db->addQuotes($db->timestamp()));
                        $this->addWhereFld('pr_type', $params['prtype']);
 
-                       $prlevel = $params['prlevel'];
-                       if (!is_null($prlevel) && $prlevel != '' && $prlevel != '*')
+                       // Remove the empty string and '*' from the prlevel array
+                       $prlevel = array_diff($params['prlevel'], array('', '*'));
+                       if (!empty($prlevel))
                                $this->addWhereFld('pr_level', $prlevel);
-                               
+                       if ($params['prfiltercascade'] == 'cascading')
+                               $this->addWhereFld('pr_cascade', 1);
+                       if ($params['prfiltercascade'] == 'noncascading')
+                               $this->addWhereFld('pr_cascade', 0);
+
                        $this->addOption('DISTINCT');
 
                        $forceNameTitleIndex = false;
@@ -94,45 +111,52 @@ 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');
+                       $this->addOption('STRAIGHT_JOIN');
+                       // We have to GROUP BY all selected fields to stop
+                       // PostgreSQL from whining
+                       $this->addOption('GROUP BY', implode(', ', $selectFields));
+                       $forceNameTitleIndex = false;
+               }
                if ($forceNameTitleIndex)
                        $this->addOption('USE INDEX', 'name_title');
-               
 
-               if (is_null($resultPageSet)) {
-                       $this->addFields(array (
-                               'page_id',
-                               'page_namespace',
-                               'page_title'
-                       ));
-               } else {
-                       $this->addFields($resultPageSet->getPageTableFields());
-               }
+               
 
                $limit = $params['limit'];
                $this->addOption('LIMIT', $limit+1);
-               $this->addOption('ORDER BY', 'page_namespace, page_title' .
-                                               ($params['dir'] == 'ZtoA' ? ' DESC' : ''));
-
                $res = $this->select(__METHOD__);
 
-               $data = array ();
                $count = 0;
+               $result = $this->getResult();
                while ($row = $db->fetchObject($res)) {
                        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;
                        }
 
                        if (is_null($resultPageSet)) {
                                $title = Title :: makeTitle($row->page_namespace, $row->page_title);
-                               $data[] = array(
+                               $vals = array(
                                        'pageid' => intval($row->page_id),
                                        'ns' => intval($title->getNamespace()),
                                        'title' => $title->getPrefixedText());
+                               $fit = $result->addValue(array('query', $this->getModuleName()), null, $vals);
+                               if(!$fit)
+                               {
+                                       $this->setContinueEnumParameter('from', $this->keyToTitle($row->page_title));
+                                       break;
+                               }
                        } else {
                                $resultPageSet->processDbRow($row);
                        }
@@ -140,15 +164,13 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase {
                $db->freeResult($res);
 
                if (is_null($resultPageSet)) {
-                       $result = $this->getResult();
-                       $result->setIndexedTagName($data, 'p');
-                       $result->addValue('query', $this->getModuleName(), $data);
+                       $result->setIndexedTagName_internal(array('query', $this->getModuleName()), 'p');
                }
        }
 
-       protected function getAllowedParams() {
+       public function getAllowedParams() {
                global $wgRestrictionTypes, $wgRestrictionLevels;
-               
+
                return array (
                        'from' => null,
                        'prefix' => null,
@@ -166,10 +188,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
@@ -178,6 +200,14 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase {
                                ApiBase :: PARAM_TYPE => $wgRestrictionLevels,
                                ApiBase :: PARAM_ISMULTI => true
                        ),
+                       'prfiltercascade' => array (
+                               ApiBase :: PARAM_DFLT => 'all',
+                               ApiBase :: PARAM_TYPE => array (
+                                       'cascading',
+                                       'noncascading',
+                                       'all'
+                               ),
+                       ),
                        'limit' => array (
                                ApiBase :: PARAM_DFLT => 10,
                                ApiBase :: PARAM_TYPE => 'limit',
@@ -186,16 +216,24 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase {
                                ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
                        ),
                        'dir' => array (
-                               ApiBase :: PARAM_DFLT => 'AtoZ',
+                               ApiBase :: PARAM_DFLT => 'ascending',
                                ApiBase :: PARAM_TYPE => array (
-                                       'AtoZ',
-                                       'ZtoA'
+                                       '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 +244,13 @@ 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)',
+                       'prfiltercascade' => 'Filter protections based on cascadingness (ignored when apprtype isn\'t set)',
+                       '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';
        }
 
@@ -230,5 +270,4 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase {
        public function getVersion() {
                return __CLASS__ . ': $Id$';
        }
-}
-
+}
\ No newline at end of file