includes/api/ApiQueryAllpages.php

   1 <?php
   2
   3 /*
   4  * Created on Sep 25, 2006
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23  * http://www.gnu.org/copyleft/gpl.html
  24  */
  25
  26 if (!defined('MEDIAWIKI')) {
  27         // Eclipse helper - will be ignored in production
  28         require_once ('ApiQueryBase.php');
  29 }
  30
  31 /**
  32  * Query module to enumerate all available pages.
  33  *
  34  * @addtogroup API
  35  */
  36 class ApiQueryAllpages extends ApiQueryGeneratorBase {
  37
  38         public function __construct($query, $moduleName) {
  39                 parent :: __construct($query, $moduleName, 'ap');
  40         }
  41
  42         public function execute() {
  43                 $this->run();
  44         }
  45
  46         public function executeGenerator($resultPageSet) {
  47                 if ($resultPageSet->isResolvingRedirects())
  48                         $this->dieUsage('Use "gapfilterredir=nonredirects" option instead of "redirects" when using allpages as a generator', 'params');
  49
  50                 $this->run($resultPageSet);
  51         }
  52
  53         private function run($resultPageSet = null) {
  54
  55                 $db = $this->getDB();
  56
  57                 $limit = $from = $namespace = $filterredir = $prefix = null;
  58                 extract($this->extractRequestParams());
  59
  60                 $this->addTables('page');
  61                 if (!$this->addWhereIf('page_is_redirect = 1', $filterredir === 'redirects'))
  62                         $this->addWhereIf('page_is_redirect = 0', $filterredir === 'nonredirects');
  63                 $this->addWhereFld('page_namespace', $namespace);
  64                 if (isset ($from))
  65                         $this->addWhere('page_title>=' . $db->addQuotes(ApiQueryBase :: titleToKey($from)));
  66                 if (isset ($prefix))
  67                         $this->addWhere("page_title LIKE '{$db->strencode(ApiQueryBase :: titleToKey($prefix))}%'");
  68
  69                 if (is_null($resultPageSet)) {
  70                         $this->addFields(array (
  71                                 'page_id',
  72                                 'page_namespace',
  73                                 'page_title'
  74                         ));
  75                 } else {
  76                         $this->addFields($resultPageSet->getPageTableFields());
  77                 }
  78
  79                 $this->addOption('USE INDEX', 'name_title');
  80                 $this->addOption('LIMIT', $limit +1);
  81                 $this->addOption('ORDER BY', 'page_namespace, page_title');
  82
  83                 $res = $this->select(__METHOD__);
  84
  85                 $data = array ();
  86                 $count = 0;
  87                 while ($row = $db->fetchObject($res)) {
  88                         if (++ $count > $limit) {
  89                                 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
  90                                 $this->setContinueEnumParameter('from', ApiQueryBase :: keyToTitle($row->page_title));
  91                                 break;
  92                         }
  93
  94                         if (is_null($resultPageSet)) {
  95                                 $title = Title :: makeTitle($row->page_namespace, $row->page_title);
  96                                 if ($title->userCanRead()) {
  97                                         $data[] = array(
  98                                                 'pageid' => intval($row->page_id),
  99                                                 'ns' => intval($title->getNamespace()),
 100                                                 'title' => $title->getPrefixedText());
 101                                 }
 102                         } else {
 103                                 $resultPageSet->processDbRow($row);
 104                         }
 105                 }
 106                 $db->freeResult($res);
 107
 108                 if (is_null($resultPageSet)) {
 109                         $result = $this->getResult();
 110                         $result->setIndexedTagName($data, 'p');
 111                         $result->addValue('query', $this->getModuleName(), $data);
 112                 }
 113         }
 114
 115         protected function getAllowedParams() {
 116                 return array (
 117                         'from' => null,
 118                         'prefix' => null,
 119                         'namespace' => array (
 120                                 ApiBase :: PARAM_DFLT => 0,
 121                                 ApiBase :: PARAM_TYPE => 'namespace'
 122                         ),
 123                         'filterredir' => array (
 124                                 ApiBase :: PARAM_DFLT => 'all',
 125                                 ApiBase :: PARAM_TYPE => array (
 126                                         'all',
 127                                         'redirects',
 128                                         'nonredirects'
 129                                 )
 130                         ),
 131                         'limit' => array (
 132                                 ApiBase :: PARAM_DFLT => 10,
 133                                 ApiBase :: PARAM_TYPE => 'limit',
 134                                 ApiBase :: PARAM_MIN => 1,
 135                                 ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
 136                                 ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
 137                         )
 138                 );
 139         }
 140
 141         protected function getParamDescription() {
 142                 return array (
 143                         'from' => 'The page title to start enumerating from.',
 144                         'prefix' => 'Search for all page titles that begin with this value.',
 145                         'namespace' => 'The namespace to enumerate.',
 146                         'filterredir' => 'Which pages to list.',
 147                         'limit' => 'How many total pages to return.'
 148                 );
 149         }
 150
 151         protected function getDescription() {
 152                 return 'Enumerate all pages sequentially in a given namespace';
 153         }
 154
 155         protected function getExamples() {
 156                 return array (
 157                         'Simple Use',
 158                         ' Show a list of pages starting at the letter "B"',
 159                         '  api.php?action=query&list=allpages&apfrom=B',
 160                         'Using as Generator',
 161                         ' Show info about 4 pages starting at the letter "T"',
 162                         '  api.php?action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info',
 163                         ' Show content of first 2 non-redirect pages begining at "Re"',
 164                         '  api.php?action=query&generator=allpages&gaplimit=2&gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content'
 165                 );
 166         }
 167
 168         public function getVersion() {
 169                 return __CLASS__ . ': $Id$';
 170         }
 171 }
 172