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 create-protected 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 $this->run( $resultPageSet );
50 private function run( $resultPageSet = null ) {
52 $params = $this->extractRequestParams();
54 $this->addTables( 'protected_titles' );
55 $this->addFields( array( 'pt_namespace', 'pt_title', 'pt_timestamp' ) );
57 $prop = array_flip( $params['prop'] );
58 $this->addFieldsIf( 'pt_user', isset( $prop['user'] ) );
59 $this->addFieldsIf( 'pt_reason', isset( $prop['comment'] ) || isset( $prop['parsedcomment'] ) );
60 $this->addFieldsIf( 'pt_expiry', isset( $prop['expiry'] ) );
61 $this->addFieldsIf( 'pt_create_perm', isset( $prop['level'] ) );
63 $this->addWhereRange( 'pt_timestamp', $params['dir'], $params['start'], $params['end'] );
64 $this->addWhereFld( 'pt_namespace', $params['namespace'] );
65 $this->addWhereFld( 'pt_create_perm', $params['level'] );
67 if ( isset( $prop['user'] ) )
69 $this->addTables( 'user' );
70 $this->addFields( 'user_name' );
71 $this->addJoinConds( array( 'user' => array( 'LEFT JOIN',
76 $this->addOption( 'LIMIT', $params['limit'] + 1 );
77 $res = $this->select( __METHOD__ );
80 $result = $this->getResult();
81 while ( $row = $db->fetchObject( $res ) ) {
82 if ( ++ $count > $params['limit'] ) {
83 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
84 $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601, $row->pt_timestamp ) );
88 $title = Title::makeTitle( $row->pt_namespace, $row->pt_title );
89 if ( is_null( $resultPageSet ) ) {
91 ApiQueryBase::addTitleInfo( $vals, $title );
92 if ( isset( $prop['timestamp'] ) )
93 $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->pt_timestamp );
95 if ( isset( $prop['user'] ) && !is_null( $row->user_name ) )
96 $vals['user'] = $row->user_name;
98 if ( isset( $prop['comment'] ) )
99 $vals['comment'] = $row->pt_reason;
101 if ( isset( $prop['parsedcomment'] ) ) {
103 $vals['parsedcomment'] = $wgUser->getSkin()->formatComment( $row->pt_reason, $title );
106 if ( isset( $prop['expiry'] ) )
107 $vals['expiry'] = Block::decodeExpiry( $row->pt_expiry, TS_ISO_8601 );
109 if ( isset( $prop['level'] ) )
110 $vals['level'] = $row->pt_create_perm;
112 $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $vals );
114 $this->setContinueEnumParameter( 'start',
115 wfTimestamp( TS_ISO_8601, $row->pt_timestamp ) );
122 $db->freeResult( $res );
123 if ( is_null( $resultPageSet ) )
124 $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), $this->getModulePrefix() );
126 $resultPageSet->populateFromTitles( $titles );
129 public function getCacheMode( $params ) {
130 if ( !is_null( $params['prop'] ) && in_array( 'parsedcomment', $params['prop'] ) ) {
131 // formatComment() calls wfMsg() among other things
132 return 'anon-public-user-private';
138 public function getAllowedParams() {
139 global $wgRestrictionLevels;
141 'namespace' => array (
142 ApiBase :: PARAM_ISMULTI => true,
143 ApiBase :: PARAM_TYPE => 'namespace',
146 ApiBase :: PARAM_ISMULTI => true,
147 ApiBase :: PARAM_TYPE => array_diff( $wgRestrictionLevels, array( '' ) )
150 ApiBase :: PARAM_DFLT => 10,
151 ApiBase :: PARAM_TYPE => 'limit',
152 ApiBase :: PARAM_MIN => 1,
153 ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
154 ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
157 ApiBase :: PARAM_DFLT => 'older',
158 ApiBase :: PARAM_TYPE => array (
164 ApiBase :: PARAM_TYPE => 'timestamp'
167 ApiBase :: PARAM_TYPE => 'timestamp'
170 ApiBase :: PARAM_ISMULTI => true,
171 ApiBase :: PARAM_DFLT => 'timestamp|level',
172 ApiBase :: PARAM_TYPE => array(
184 public function getParamDescription() {
186 'namespace' => 'Only list titles in these namespaces',
187 'start' => 'Start listing at this protection timestamp',
188 'end' => 'Stop listing at this protection timestamp',
189 'dir' => 'The direction in which to list',
190 'limit' => 'How many total pages to return.',
191 'prop' => 'Which properties to get',
192 'level' => 'Only list titles with these protection levels',
196 public function getDescription() {
197 return 'List all titles protected from creation';
200 protected function getExamples() {
202 'api.php?action=query&list=protectedtitles',
206 public function getVersion() {
207 return __CLASS__ . ': $Id: ApiQueryProtectedTitles.php 69932 2010-07-26 08:03:21Z tstarling $';