5 * Created on Feb 13, 2009
7 * Copyright © 2009 Roan Kattouw "<Firstname>.<Lastname>@gmail.com"
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
28 * Query module to enumerate all create-protected pages.
32 class ApiQueryProtectedTitles
extends ApiQueryGeneratorBase
{
34 public function __construct( ApiQuery
$query, $moduleName ) {
35 parent
::__construct( $query, $moduleName, 'pt' );
38 public function execute() {
42 public function executeGenerator( $resultPageSet ) {
43 $this->run( $resultPageSet );
47 * @param ApiPageSet $resultPageSet
50 private function run( $resultPageSet = null ) {
51 $params = $this->extractRequestParams();
53 $this->addTables( 'protected_titles' );
54 $this->addFields( [ 'pt_namespace', 'pt_title', 'pt_timestamp' ] );
56 $prop = array_flip( $params['prop'] );
57 $this->addFieldsIf( 'pt_user', isset( $prop['user'] ) ||
isset( $prop['userid'] ) );
58 $this->addFieldsIf( 'pt_expiry', isset( $prop['expiry'] ) );
59 $this->addFieldsIf( 'pt_create_perm', isset( $prop['level'] ) );
61 if ( isset( $prop['comment'] ) ||
isset( $prop['parsedcomment'] ) ) {
62 $commentStore = new CommentStore( 'pt_reason' );
63 $commentQuery = $commentStore->getJoin();
64 $this->addTables( $commentQuery['tables'] );
65 $this->addFields( $commentQuery['fields'] );
66 $this->addJoinConds( $commentQuery['joins'] );
69 $this->addTimestampWhereRange( 'pt_timestamp', $params['dir'], $params['start'], $params['end'] );
70 $this->addWhereFld( 'pt_namespace', $params['namespace'] );
71 $this->addWhereFld( 'pt_create_perm', $params['level'] );
73 // Include in ORDER BY for uniqueness
74 $this->addWhereRange( 'pt_namespace', $params['dir'], null, null );
75 $this->addWhereRange( 'pt_title', $params['dir'], null, null );
77 if ( !is_null( $params['continue'] ) ) {
78 $cont = explode( '|', $params['continue'] );
79 $this->dieContinueUsageIf( count( $cont ) != 3 );
80 $op = ( $params['dir'] === 'newer' ?
'>' : '<' );
82 $continueTimestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
83 $continueNs = (int)$cont[1];
84 $this->dieContinueUsageIf( $continueNs != $cont[1] );
85 $continueTitle = $db->addQuotes( $cont[2] );
86 $this->addWhere( "pt_timestamp $op $continueTimestamp OR " .
87 "(pt_timestamp = $continueTimestamp AND " .
88 "(pt_namespace $op $continueNs OR " .
89 "(pt_namespace = $continueNs AND " .
90 "pt_title $op= $continueTitle)))"
94 if ( isset( $prop['user'] ) ) {
95 $this->addTables( 'user' );
96 $this->addFields( 'user_name' );
97 $this->addJoinConds( [ 'user' => [ 'LEFT JOIN',
102 $this->addOption( 'LIMIT', $params['limit'] +
1 );
103 $res = $this->select( __METHOD__
);
106 $result = $this->getResult();
110 foreach ( $res as $row ) {
111 if ( ++
$count > $params['limit'] ) {
112 // We've reached the one extra which shows that there are
113 // additional pages to be had. Stop here...
114 $this->setContinueEnumParameter( 'continue',
115 "$row->pt_timestamp|$row->pt_namespace|$row->pt_title"
120 $title = Title
::makeTitle( $row->pt_namespace
, $row->pt_title
);
121 if ( is_null( $resultPageSet ) ) {
123 ApiQueryBase
::addTitleInfo( $vals, $title );
124 if ( isset( $prop['timestamp'] ) ) {
125 $vals['timestamp'] = wfTimestamp( TS_ISO_8601
, $row->pt_timestamp
);
128 if ( isset( $prop['user'] ) && !is_null( $row->user_name
) ) {
129 $vals['user'] = $row->user_name
;
132 if ( isset( $prop['userid'] ) ||
/*B/C*/isset( $prop['user'] ) ) {
133 $vals['userid'] = (int)$row->pt_user
;
136 if ( isset( $prop['comment'] ) ) {
137 $vals['comment'] = $commentStore->getComment( $row )->text
;
140 if ( isset( $prop['parsedcomment'] ) ) {
141 $vals['parsedcomment'] = Linker
::formatComment(
142 $commentStore->getComment( $row )->text
, $titles
146 if ( isset( $prop['expiry'] ) ) {
147 $vals['expiry'] = ApiResult
::formatExpiry( $row->pt_expiry
);
150 if ( isset( $prop['level'] ) ) {
151 $vals['level'] = $row->pt_create_perm
;
154 $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $vals );
156 $this->setContinueEnumParameter( 'continue',
157 "$row->pt_timestamp|$row->pt_namespace|$row->pt_title"
166 if ( is_null( $resultPageSet ) ) {
167 $result->addIndexedTagName(
168 [ 'query', $this->getModuleName() ],
169 $this->getModulePrefix()
172 $resultPageSet->populateFromTitles( $titles );
176 public function getCacheMode( $params ) {
177 if ( !is_null( $params['prop'] ) && in_array( 'parsedcomment', $params['prop'] ) ) {
178 // formatComment() calls wfMessage() among other things
179 return 'anon-public-user-private';
185 public function getAllowedParams() {
188 ApiBase
::PARAM_ISMULTI
=> true,
189 ApiBase
::PARAM_TYPE
=> 'namespace',
192 ApiBase
::PARAM_ISMULTI
=> true,
193 ApiBase
::PARAM_TYPE
=> array_diff( $this->getConfig()->get( 'RestrictionLevels' ), [ '' ] )
196 ApiBase
::PARAM_DFLT
=> 10,
197 ApiBase
::PARAM_TYPE
=> 'limit',
198 ApiBase
::PARAM_MIN
=> 1,
199 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
200 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
203 ApiBase
::PARAM_DFLT
=> 'older',
204 ApiBase
::PARAM_TYPE
=> [
208 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-direction',
211 ApiBase
::PARAM_TYPE
=> 'timestamp'
214 ApiBase
::PARAM_TYPE
=> 'timestamp'
217 ApiBase
::PARAM_ISMULTI
=> true,
218 ApiBase
::PARAM_DFLT
=> 'timestamp|level',
219 ApiBase
::PARAM_TYPE
=> [
228 ApiBase
::PARAM_HELP_MSG_PER_VALUE
=> [],
231 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-continue',
236 protected function getExamplesMessages() {
238 'action=query&list=protectedtitles'
239 => 'apihelp-query+protectedtitles-example-simple',
240 'action=query&generator=protectedtitles&gptnamespace=0&prop=linkshere'
241 => 'apihelp-query+protectedtitles-example-generator',
245 public function getHelpUrls() {
246 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Protectedtitles';