4 * Created on Feb 13, 2009
6 * API for MediaWiki 1.8+
8 * Copyright (C) 2009 Roan Kattouw <Firstname>.<Lastname>@home.nl
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.
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.
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
26 if (!defined('MEDIAWIKI')) {
27 // Eclipse helper - will be ignored in production
28 require_once ('ApiQueryBase.php');
32 * Query module to enumerate all available pages.
36 class ApiQueryProtectedTitles
extends ApiQueryGeneratorBase
{
38 public function __construct($query, $moduleName) {
39 parent
:: __construct($query, $moduleName, 'pt');
42 public function execute() {
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');
50 $this->run($resultPageSet);
53 private function run($resultPageSet = null) {
55 $params = $this->extractRequestParams();
57 $this->addTables('protected_titles');
58 $this->addFields(array('pt_namespace', 'pt_title', 'pt_timestamp'));
60 $prop = array_flip($params['prop']);
61 $this->addFieldsIf('pt_user', isset($prop['user']));
62 $this->addFieldsIf('pt_reason', isset($prop['comment']));
63 $this->addFieldsIf('pt_expiry', isset($prop['expiry']));
64 $this->addFieldsIf('pt_create_perm', isset($prop['level']));
66 $this->addWhereRange('pt_timestamp', $params['dir'], $params['start'], $params['end']);
67 $this->addWhereFld('pt_namespace', $params['namespace']);
68 $this->addWhereFld('pt_create_perm', $params['level']);
70 if(isset($prop['user']))
72 $this->addTables('user');
73 $this->addFields('user_name');
74 $this->addJoinConds(array('user' => array('LEFT JOIN',
79 $this->addOption('LIMIT', $params['limit'] +
1);
80 $res = $this->select(__METHOD__
);
83 $result = $this->getResult();
84 while ($row = $db->fetchObject($res)) {
85 if (++
$count > $params['limit']) {
86 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
87 $this->setContinueEnumParameter('start', wfTimestamp(TS_ISO_8601
, $row->pt_timestamp
));
91 $title = Title
::makeTitle($row->pt_namespace
, $row->pt_title
);
92 if (is_null($resultPageSet)) {
94 ApiQueryBase
::addTitleInfo($vals, $title);
95 if(isset($prop['timestamp']))
96 $vals['timestamp'] = wfTimestamp(TS_ISO_8601
, $row->pt_timestamp
);
97 if(isset($prop['user']) && !is_null($row->user_name
))
98 $vals['user'] = $row->user_name
;
99 if(isset($prop['comment']))
100 $vals['comment'] = $row->pt_reason
;
101 if(isset($prop['expiry']))
102 $vals['expiry'] = Block
::decodeExpiry($row->pt_expiry
, TS_ISO_8601
);
103 if(isset($prop['level']))
104 $vals['level'] = $row->pt_create_perm
;
106 $fit = $result->addValue(array('query', $this->getModuleName()), null, $vals);
109 $this->setContinueEnumParameter('start',
110 wfTimestamp(TS_ISO_8601
, $row->pt_timestamp
));
117 $db->freeResult($res);
118 if(is_null($resultPageSet))
119 $result->setIndexedTagName_internal(array('query', $this->getModuleName()), $this->getModulePrefix());
121 $resultPageSet->populateFromTitles($titles);
124 public function getAllowedParams() {
125 global $wgRestrictionLevels;
127 'namespace' => array (
128 ApiBase
:: PARAM_ISMULTI
=> true,
129 ApiBase
:: PARAM_TYPE
=> 'namespace',
132 ApiBase
:: PARAM_ISMULTI
=> true,
133 ApiBase
:: PARAM_TYPE
=> array_diff($wgRestrictionLevels, array(''))
136 ApiBase
:: PARAM_DFLT
=> 10,
137 ApiBase
:: PARAM_TYPE
=> 'limit',
138 ApiBase
:: PARAM_MIN
=> 1,
139 ApiBase
:: PARAM_MAX
=> ApiBase
:: LIMIT_BIG1
,
140 ApiBase
:: PARAM_MAX2
=> ApiBase
:: LIMIT_BIG2
143 ApiBase
:: PARAM_DFLT
=> 'ascending',
144 ApiBase
:: PARAM_TYPE
=> array (
150 ApiBase
:: PARAM_TYPE
=> 'timestamp'
153 ApiBase
:: PARAM_TYPE
=> 'timestamp'
156 ApiBase
:: PARAM_ISMULTI
=> true,
157 ApiBase
:: PARAM_DFLT
=> 'timestamp|level',
158 ApiBase
:: PARAM_TYPE
=> array(
169 public function getParamDescription() {
171 'namespace' => 'Only list titles in these namespaces',
172 'start' => 'Start listing at this protection timestamp',
173 'end' => 'Stop listing at this protection timestamp',
174 'dir' => 'The direction in which to list',
175 'limit' => 'How many total pages to return.',
176 'prop' => 'Which properties to get',
180 public function getDescription() {
181 return 'List all titles protected from creation';
184 protected function getExamples() {
186 'api.php?action=query&list=protectedtitles',
190 public function getVersion() {
191 return __CLASS__
. ': $Id$';