includes/api/ApiQueryAllpages.php

   1 <?php
   2
   3
   4 /*
   5  * Created on Sep 25, 2006
   6  *
   7  * API for MediaWiki 1.8+
   8  *
   9  * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License along
  22  * with this program; if not, write to the Free Software Foundation, Inc.,
  23  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  24  * http://www.gnu.org/copyleft/gpl.html
  25  */
  26
  27 if (!defined('MEDIAWIKI')) {
  28         // Eclipse helper - will be ignored in production
  29         require_once ('ApiQueryBase.php');
  30 }
  31
  32 class ApiQueryAllpages extends ApiQueryBase {
  33
  34         public function __construct($query, $moduleName, $generator = false) {
  35                 parent :: __construct($query, $moduleName, $generator);
  36         }
  37
  38         public function execute() {
  39                 $aplimit = $apfrom = $apnamespace = $apfilterredir = null;
  40                 extract($this->extractRequestParams());
  41
  42                 $db = $this->getDB();
  43                 $where = array (
  44                         'page_namespace' => $apnamespace
  45                 );
  46                 if (isset ($apfrom))
  47                         $where[] = 'page_title>=' . $db->addQuotes(ApiQueryBase :: titleToKey($apfrom));
  48
  49                 if ($apfilterredir === 'redirects')
  50                         $where['page_is_redirect'] = 1;
  51                 else
  52                         if ($apfilterredir === 'nonredirects')
  53                                 $where['page_is_redirect'] = 0;
  54
  55                 $this->profileDBIn();
  56                 $res = $db->select('page', array (
  57                         'page_id',
  58                         'page_namespace',
  59                         'page_title'
  60                 ), $where, __CLASS__ . '::' . __METHOD__, array (
  61                         'USE INDEX' => 'name_title',
  62                         'LIMIT' => $aplimit +1,
  63                         'ORDER BY' => 'page_namespace, page_title'
  64                 ));
  65                 $this->profileDBOut();
  66
  67                 $data = array ();
  68                 ApiResult :: setIndexedTagName($data, 'p');
  69                 $count = 0;
  70                 while ($row = $db->fetchObject($res)) {
  71                         if (++ $count > $aplimit) {
  72                                 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
  73                                 $msg = array (
  74                                         'continue' => 'apfrom=' . ApiQueryBase :: keyToTitle($row->page_title
  75                                 ));
  76                                 $this->getResult()->addValue('query-status', 'allpages', $msg);
  77                                 break;
  78                         }
  79
  80                         $title = Title :: makeTitle($row->page_namespace, $row->page_title);
  81                         // skip any pages that user has no rights to read
  82                         if ($title->userCanRead()) {
  83
  84                                 $id = intval($row->page_id);
  85                                 $pagedata = array ();
  86                                 $pagedata['id'] = $id;
  87                                 if ($title->getNamespace() !== 0)
  88                                         $pagedata['ns'] = $title->getNamespace();
  89                                 $pagedata['title'] = $title->getPrefixedText();
  90
  91                                 $data[$id] = $pagedata;
  92                         }
  93                 }
  94                 $db->freeResult($res);
  95                 $this->getResult()->addValue('query', 'allpages', $data);
  96         }
  97
  98         protected function getAllowedParams() {
  99
 100                 global $wgContLang;
 101                 $validNamespaces = array ();
 102                 foreach (array_keys($wgContLang->getNamespaces()) as $ns) {
 103                         if ($ns >= 0)
 104                                 $validNamespaces[] = $ns; // strval($ns);
 105                 }
 106
 107                 return array (
 108                         'apfrom' => null,
 109                         'apnamespace' => array (
 110                                 GN_ENUM_DFLT => 0,
 111                                 GN_ENUM_TYPE => $validNamespaces
 112                         ),
 113                         'apfilterredir' => array (
 114                                 GN_ENUM_DFLT => 'all',
 115                                 GN_ENUM_TYPE => array (
 116                                         'all',
 117                                         'redirects',
 118                                         'nonredirects'
 119                                 )
 120                         ),
 121                         'aplimit' => array (
 122                                 GN_ENUM_DFLT => 10,
 123                                 GN_ENUM_TYPE => 'limit',
 124                                 GN_ENUM_MIN => 1,
 125                                 GN_ENUM_MAX1 => 500,
 126                                 GN_ENUM_MAX2 => 5000
 127                         )
 128                 );
 129         }
 130
 131         protected function getParamDescription() {
 132                 return array ();
 133         }
 134
 135         protected function getDescription() {
 136                 return 'Enumerate all pages sequentially in a given namespace';
 137         }
 138
 139         protected function getExamples() {
 140                 return array (
 141                         'api.php?action=query&list=allpages',
 142                         'api.php?action=query&list=allpages&apfrom=B&aplimit=5'
 143                 );
 144         }
 145         public function getCanGenerate() {
 146                 return true;
 147         }
 148 }
 149 ?>