A few comment tag tweaks.

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

diff --git a/includes/api/ApiQueryAllpages.php b/includes/api/ApiQueryAllpages.php
index 117cfa7..e858dec 100644 (file)
--- a/includes/api/ApiQueryAllpages.php
+++ b/includes/api/ApiQueryAllpages.php
@@ -1,12 +1,11 @@
 <?php
 
-
 /*
  * Created on Sep 25, 2006
  *
  * 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 +28,11 @@ if (!defined('MEDIAWIKI')) {
        require_once ('ApiQueryBase.php');
 }
 
+/**
+ * Query module to enumerate all available pages.
+ * 
+ * @addtogroup API
+ */
 class ApiQueryAllpages extends ApiQueryGeneratorBase {
 
        public function __construct($query, $moduleName) {
@@ -47,71 +51,57 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase {
        }
 
        private function run($resultPageSet = null) {
-               $limit = $from = $namespace = $filterredir = null;
-               extract($this->extractRequestParams());
 
                $db = $this->getDB();
 
-               $where = array (
-                       'page_namespace' => $namespace
-               );
-
-               if (isset ($from)) {
-                       $where[] = 'page_title>=' . $db->addQuotes(ApiQueryBase :: titleToKey($from));
-               }
+               $params = $this->extractRequestParams();
 
-               if (isset ($prefix)) {
-                       $where[] = "page_title LIKE '{$db->strencode(ApiQueryBase :: titleToKey($prefix))}%'";
-               }
-
-               if ($filterredir === 'redirects') {
-                       $where['page_is_redirect'] = 1;
-               }
-               elseif ($filterredir === 'nonredirects') {
-                       $where['page_is_redirect'] = 0;
-               }
+               $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'])));
+               if (isset ($params['prefix']))
+                       $this->addWhere("page_title LIKE '" . $db->strencode(ApiQueryBase :: titleToKey($params['prefix'])) . "%'");
 
                if (is_null($resultPageSet)) {
-                       $fields = array (
+                       $this->addFields(array (
                                'page_id',
                                'page_namespace',
                                'page_title'
-                       );
+                       ));
                } else {
-                       $fields = $resultPageSet->getPageTableFields();
+                       $this->addFields($resultPageSet->getPageTableFields());
                }
 
-               $options = array (
-                       'USE INDEX' => 'name_title',
-                       'LIMIT' => $limit +1,
-                       'ORDER BY' => 'page_namespace, page_title'
-               );
+               $this->addOption('USE INDEX', 'name_title');
+               $limit = $params['limit'];
+               $this->addOption('LIMIT', $limit+1);
+               $this->addOption('ORDER BY', 'page_namespace, page_title');
 
-               $this->profileDBIn();
-               $res = $db->select('page', $fields, $where, __METHOD__, $options);
-               $this->profileDBOut();
+               $res = $this->select(__METHOD__);
 
                $data = array ();
                $count = 0;
                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;
                        }
 
-                       $title = Title :: makeTitle($row->page_namespace, $row->page_title);
-                       // skip any pages that user has no rights to read
-                       if ($title->userCanRead()) {
-
-                               if (is_null($resultPageSet)) {
-                                       $id = intval($row->page_id);
-                                       $data[$id] = array (
-                                               'id' => $id,
-                                       'ns' => $title->getNamespace(), 'title' => $title->getPrefixedText());
-                               } else {
-                                       $resultPageSet->processDbRow($row);
+                       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());
                                }
+                       } else {
+                               $resultPageSet->processDbRow($row);
                        }
                }
                $db->freeResult($res);
@@ -124,13 +114,12 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase {
        }
 
        protected function getAllowedParams() {
-               $namespaces = $this->getQuery()->getValidNamespaces();
                return array (
                        'from' => null,
                        'prefix' => null,
                        'namespace' => array (
                                ApiBase :: PARAM_DFLT => 0,
-                               ApiBase :: PARAM_TYPE => $namespaces
+                               ApiBase :: PARAM_TYPE => 'namespace'
                        ),
                        'filterredir' => array (
                                ApiBase :: PARAM_DFLT => 'all',
@@ -144,7 +133,7 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase {
                                ApiBase :: PARAM_DFLT => 10,
                                ApiBase :: PARAM_TYPE => 'limit',
                                ApiBase :: PARAM_MIN => 1,
-                               ApiBase :: PARAM_MAX1 => ApiBase :: LIMIT_BIG1,
+                               ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
                                ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
                        )
                );
@@ -181,4 +170,4 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase {
                return __CLASS__ . ': $Id$';
        }
 }
-?>
\ No newline at end of file
+