3 * Copyright © 2009 Roan Kattouw "<Firstname>.<Lastname>@gmail.com"
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 * Query module to enumerate all create-protected pages.
28 class ApiQueryProtectedTitles
extends ApiQueryGeneratorBase
{
30 public function __construct( ApiQuery
$query, $moduleName ) {
31 parent
::__construct( $query, $moduleName, 'pt' );
34 public function execute() {
38 public function executeGenerator( $resultPageSet ) {
39 $this->run( $resultPageSet );
43 * @param ApiPageSet $resultPageSet
46 private function run( $resultPageSet = null ) {
47 $params = $this->extractRequestParams();
49 $this->addTables( 'protected_titles' );
50 $this->addFields( [ 'pt_namespace', 'pt_title', 'pt_timestamp' ] );
52 $prop = array_flip( $params['prop'] );
53 $this->addFieldsIf( 'pt_user', isset( $prop['user'] ) ||
isset( $prop['userid'] ) );
54 $this->addFieldsIf( 'pt_expiry', isset( $prop['expiry'] ) );
55 $this->addFieldsIf( 'pt_create_perm', isset( $prop['level'] ) );
57 if ( isset( $prop['comment'] ) ||
isset( $prop['parsedcomment'] ) ) {
58 $commentStore = CommentStore
::getStore();
59 $commentQuery = $commentStore->getJoin( 'pt_reason' );
60 $this->addTables( $commentQuery['tables'] );
61 $this->addFields( $commentQuery['fields'] );
62 $this->addJoinConds( $commentQuery['joins'] );
65 $this->addTimestampWhereRange( 'pt_timestamp', $params['dir'], $params['start'], $params['end'] );
66 $this->addWhereFld( 'pt_namespace', $params['namespace'] );
67 $this->addWhereFld( 'pt_create_perm', $params['level'] );
69 // Include in ORDER BY for uniqueness
70 $this->addWhereRange( 'pt_namespace', $params['dir'], null, null );
71 $this->addWhereRange( 'pt_title', $params['dir'], null, null );
73 if ( !is_null( $params['continue'] ) ) {
74 $cont = explode( '|', $params['continue'] );
75 $this->dieContinueUsageIf( count( $cont ) != 3 );
76 $op = ( $params['dir'] === 'newer' ?
'>' : '<' );
78 $continueTimestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
79 $continueNs = (int)$cont[1];
80 $this->dieContinueUsageIf( $continueNs != $cont[1] );
81 $continueTitle = $db->addQuotes( $cont[2] );
82 $this->addWhere( "pt_timestamp $op $continueTimestamp OR " .
83 "(pt_timestamp = $continueTimestamp AND " .
84 "(pt_namespace $op $continueNs OR " .
85 "(pt_namespace = $continueNs AND " .
86 "pt_title $op= $continueTitle)))"
90 if ( isset( $prop['user'] ) ) {
91 $this->addTables( 'user' );
92 $this->addFields( 'user_name' );
93 $this->addJoinConds( [ 'user' => [ 'LEFT JOIN',
98 $this->addOption( 'LIMIT', $params['limit'] +
1 );
99 $res = $this->select( __METHOD__
);
102 $result = $this->getResult();
106 foreach ( $res as $row ) {
107 if ( ++
$count > $params['limit'] ) {
108 // We've reached the one extra which shows that there are
109 // additional pages to be had. Stop here...
110 $this->setContinueEnumParameter( 'continue',
111 "$row->pt_timestamp|$row->pt_namespace|$row->pt_title"
116 $title = Title
::makeTitle( $row->pt_namespace
, $row->pt_title
);
117 if ( is_null( $resultPageSet ) ) {
119 ApiQueryBase
::addTitleInfo( $vals, $title );
120 if ( isset( $prop['timestamp'] ) ) {
121 $vals['timestamp'] = wfTimestamp( TS_ISO_8601
, $row->pt_timestamp
);
124 if ( isset( $prop['user'] ) && !is_null( $row->user_name
) ) {
125 $vals['user'] = $row->user_name
;
128 if ( isset( $prop['userid'] ) ||
/*B/C*/isset( $prop['user'] ) ) {
129 $vals['userid'] = (int)$row->pt_user
;
132 if ( isset( $prop['comment'] ) ) {
133 $vals['comment'] = $commentStore->getComment( 'pt_reason', $row )->text
;
136 if ( isset( $prop['parsedcomment'] ) ) {
137 $vals['parsedcomment'] = Linker
::formatComment(
138 $commentStore->getComment( 'pt_reason', $row )->text
, $titles
142 if ( isset( $prop['expiry'] ) ) {
143 $vals['expiry'] = ApiResult
::formatExpiry( $row->pt_expiry
);
146 if ( isset( $prop['level'] ) ) {
147 $vals['level'] = $row->pt_create_perm
;
150 $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $vals );
152 $this->setContinueEnumParameter( 'continue',
153 "$row->pt_timestamp|$row->pt_namespace|$row->pt_title"
162 if ( is_null( $resultPageSet ) ) {
163 $result->addIndexedTagName(
164 [ 'query', $this->getModuleName() ],
165 $this->getModulePrefix()
168 $resultPageSet->populateFromTitles( $titles );
172 public function getCacheMode( $params ) {
173 if ( !is_null( $params['prop'] ) && in_array( 'parsedcomment', $params['prop'] ) ) {
174 // formatComment() calls wfMessage() among other things
175 return 'anon-public-user-private';
181 public function getAllowedParams() {
184 ApiBase
::PARAM_ISMULTI
=> true,
185 ApiBase
::PARAM_TYPE
=> 'namespace',
188 ApiBase
::PARAM_ISMULTI
=> true,
189 ApiBase
::PARAM_TYPE
=> array_diff( $this->getConfig()->get( 'RestrictionLevels' ), [ '' ] )
192 ApiBase
::PARAM_DFLT
=> 10,
193 ApiBase
::PARAM_TYPE
=> 'limit',
194 ApiBase
::PARAM_MIN
=> 1,
195 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
196 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
199 ApiBase
::PARAM_DFLT
=> 'older',
200 ApiBase
::PARAM_TYPE
=> [
204 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-direction',
207 ApiBase
::PARAM_TYPE
=> 'timestamp'
210 ApiBase
::PARAM_TYPE
=> 'timestamp'
213 ApiBase
::PARAM_ISMULTI
=> true,
214 ApiBase
::PARAM_DFLT
=> 'timestamp|level',
215 ApiBase
::PARAM_TYPE
=> [
224 ApiBase
::PARAM_HELP_MSG_PER_VALUE
=> [],
227 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-continue',
232 protected function getExamplesMessages() {
234 'action=query&list=protectedtitles'
235 => 'apihelp-query+protectedtitles-example-simple',
236 'action=query&generator=protectedtitles&gptnamespace=0&prop=linkshere'
237 => 'apihelp-query+protectedtitles-example-generator',
241 public function getHelpUrls() {
242 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Protectedtitles';