API: Add a little docu so that we might be able to make some sense of how this works ;)

[lhc/web/wiklou.git] / includes / api / ApiQueryAllpages.php

diff --git a/includes/api/ApiQueryAllpages.php b/includes/api/ApiQueryAllpages.php
index a6ad4e8..a76e4ea 100644 (file)
--- a/includes/api/ApiQueryAllpages.php
+++ b/includes/api/ApiQueryAllpages.php
@@ -5,7 +5,7 @@
  *
  * API for MediaWiki 1.8+
  *
- * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
+ * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -29,6 +29,8 @@ if (!defined('MEDIAWIKI')) {
 }
 
 /**
+ * Query module to enumerate all available pages.
+ * 
  * @addtogroup API
  */
 class ApiQueryAllpages extends ApiQueryGeneratorBase {
@@ -52,17 +54,49 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase {
 
                $db = $this->getDB();
 
-               $limit = $from = $namespace = $filterredir = $prefix = null;
-               extract($this->extractRequestParams());
-
+               $params = $this->extractRequestParams();
+               
+               // Page filters
+               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'])));
+               if (isset ($params['prefix']))
+                       $this->addWhere("page_title LIKE '" . $db->escapeLike(ApiQueryBase :: 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');
+                       $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 != '*')
+                               $this->addWhereFld('pr_level', $prlevel);
+
+                       $forceNameTitleIndex = false;
+
+               } else if (isset ($params['prlevel'])) {
+                       $this->dieUsage('prlevel may not be used without prtype', 'params');
+               }
+               
                $this->addTables('page');
-               if (!$this->addWhereIf('page_is_redirect = 1', $filterredir === 'redirects'))
-                       $this->addWhereIf('page_is_redirect = 0', $filterredir === 'nonredirects');
-               $this->addWhereFld('page_namespace', $namespace);
-               if (isset ($from))
-                       $this->addWhere('page_title>=' . $db->addQuotes(ApiQueryBase :: titleToKey($from)));
-               if (isset ($prefix))
-                       $this->addWhere("page_title LIKE '{$db->strencode(ApiQueryBase :: titleToKey($prefix))}%'");
+               if ($forceNameTitleIndex)
+                       $this->addOption('USE INDEX', 'name_title');
+               
 
                if (is_null($resultPageSet)) {
                        $this->addFields(array (
@@ -74,8 +108,8 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase {
                        $this->addFields($resultPageSet->getPageTableFields());
                }
 
-               $this->addOption('USE INDEX', 'name_title');
-               $this->addOption('LIMIT', $limit +1);
+               $limit = $params['limit'];
+               $this->addOption('LIMIT', $limit+1);
                $this->addOption('ORDER BY', 'page_namespace, page_title');
 
                $res = $this->select(__METHOD__);
@@ -85,18 +119,17 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase {
                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));
                                break;
                        }
 
                        if (is_null($resultPageSet)) {
                                $title = Title :: makeTitle($row->page_namespace, $row->page_title);
-                               if ($title->userCanRead()) {
-                                       $data[] = array(
-                                               'pageid' => intval($row->page_id),
-                                               'ns' => intval($title->getNamespace()),
-                                               'title' => $title->getPrefixedText());
-                               }
+                               $data[] = array(
+                                       'pageid' => intval($row->page_id),
+                                       'ns' => intval($title->getNamespace()),
+                                       'title' => $title->getPrefixedText());
                        } else {
                                $resultPageSet->processDbRow($row);
                        }
@@ -111,12 +144,14 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase {
        }
 
        protected function getAllowedParams() {
+               global $wgRestrictionTypes, $wgRestrictionLevels;
+               
                return array (
                        'from' => null,
                        'prefix' => null,
                        'namespace' => array (
                                ApiBase :: PARAM_DFLT => 0,
-                               ApiBase :: PARAM_TYPE => 'namespace'
+                               ApiBase :: PARAM_TYPE => 'namespace',
                        ),
                        'filterredir' => array (
                                ApiBase :: PARAM_DFLT => 'all',
@@ -126,6 +161,18 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase {
                                        'nonredirects'
                                )
                        ),
+                       'minsize' => array (
+                               ApiBase :: PARAM_TYPE => 'integer',
+                       ), 
+                       'maxsize' => array (
+                               ApiBase :: PARAM_TYPE => 'integer',
+                       ), 
+                       'prtype' => array (
+                               ApiBase :: PARAM_TYPE => $wgRestrictionTypes,
+                       ),
+                       'prlevel' => array (
+                               ApiBase :: PARAM_TYPE => $wgRestrictionLevels,
+                       ),
                        'limit' => array (
                                ApiBase :: PARAM_DFLT => 10,
                                ApiBase :: PARAM_TYPE => 'limit',
@@ -142,6 +189,10 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase {
                        'prefix' => 'Search for all page titles that begin with this value.',
                        'namespace' => 'The namespace to enumerate.',
                        'filterredir' => 'Which pages to list.',
+                       'minsize' => 'Limit to pages with at least this many bytes',
+                       '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)',
                        'limit' => 'How many total pages to return.'
                );
        }
@@ -167,4 +218,4 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase {
                return __CLASS__ . ': $Id$';
        }
 }
-?>
+