MediaWiki  master
ApiQueryProtectedTitles.php
Go to the documentation of this file.
1 <?php
29 
31  private $commentStore;
32 
38  public function __construct(
39  ApiQuery $query,
40  $moduleName,
42  ) {
43  parent::__construct( $query, $moduleName, 'pt' );
44  $this->commentStore = $commentStore;
45  }
46 
47  public function execute() {
48  $this->run();
49  }
50 
51  public function executeGenerator( $resultPageSet ) {
52  $this->run( $resultPageSet );
53  }
54 
59  private function run( $resultPageSet = null ) {
60  $params = $this->extractRequestParams();
61 
62  $this->addTables( 'protected_titles' );
63  $this->addFields( [ 'pt_namespace', 'pt_title', 'pt_timestamp' ] );
64 
65  $prop = array_fill_keys( $params['prop'], true );
66  $this->addFieldsIf( 'pt_user', isset( $prop['user'] ) || isset( $prop['userid'] ) );
67  $this->addFieldsIf( 'pt_expiry', isset( $prop['expiry'] ) );
68  $this->addFieldsIf( 'pt_create_perm', isset( $prop['level'] ) );
69 
70  if ( isset( $prop['comment'] ) || isset( $prop['parsedcomment'] ) ) {
71  $commentQuery = $this->commentStore->getJoin( 'pt_reason' );
72  $this->addTables( $commentQuery['tables'] );
73  $this->addFields( $commentQuery['fields'] );
74  $this->addJoinConds( $commentQuery['joins'] );
75  }
76 
77  $this->addTimestampWhereRange( 'pt_timestamp', $params['dir'], $params['start'], $params['end'] );
78  $this->addWhereFld( 'pt_namespace', $params['namespace'] );
79  $this->addWhereFld( 'pt_create_perm', $params['level'] );
80 
81  // Include in ORDER BY for uniqueness
82  $this->addWhereRange( 'pt_namespace', $params['dir'], null, null );
83  $this->addWhereRange( 'pt_title', $params['dir'], null, null );
84 
85  if ( $params['continue'] !== null ) {
86  $cont = explode( '|', $params['continue'] );
87  $this->dieContinueUsageIf( count( $cont ) != 3 );
88  $op = ( $params['dir'] === 'newer' ? '>' : '<' );
89  $db = $this->getDB();
90  $continueTimestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
91  $continueNs = (int)$cont[1];
92  $this->dieContinueUsageIf( $continueNs != $cont[1] );
93  $continueTitle = $db->addQuotes( $cont[2] );
94  $this->addWhere( "pt_timestamp $op $continueTimestamp OR " .
95  "(pt_timestamp = $continueTimestamp AND " .
96  "(pt_namespace $op $continueNs OR " .
97  "(pt_namespace = $continueNs AND " .
98  "pt_title $op= $continueTitle)))"
99  );
100  }
101 
102  if ( isset( $prop['user'] ) ) {
103  $this->addTables( 'user' );
104  $this->addFields( 'user_name' );
105  $this->addJoinConds( [ 'user' => [ 'LEFT JOIN',
106  'user_id=pt_user'
107  ] ] );
108  }
109 
110  $this->addOption( 'LIMIT', $params['limit'] + 1 );
111  $res = $this->select( __METHOD__ );
112 
113  if ( $resultPageSet === null ) {
114  $this->executeGenderCacheFromResultWrapper( $res, __METHOD__, 'pt' );
115  }
116 
117  $count = 0;
118  $result = $this->getResult();
119 
120  $titles = [];
121 
122  foreach ( $res as $row ) {
123  if ( ++$count > $params['limit'] ) {
124  // We've reached the one extra which shows that there are
125  // additional pages to be had. Stop here...
126  $this->setContinueEnumParameter( 'continue',
127  "$row->pt_timestamp|$row->pt_namespace|$row->pt_title"
128  );
129  break;
130  }
131 
132  $title = Title::makeTitle( $row->pt_namespace, $row->pt_title );
133  if ( $resultPageSet === null ) {
134  $vals = [];
136  if ( isset( $prop['timestamp'] ) ) {
137  $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->pt_timestamp );
138  }
139 
140  if ( isset( $prop['user'] ) && $row->user_name !== null ) {
141  $vals['user'] = $row->user_name;
142  }
143 
144  if ( isset( $prop['userid'] ) || /*B/C*/isset( $prop['user'] ) ) {
145  $vals['userid'] = (int)$row->pt_user;
146  }
147 
148  if ( isset( $prop['comment'] ) ) {
149  $vals['comment'] = $this->commentStore->getComment( 'pt_reason', $row )->text;
150  }
151 
152  if ( isset( $prop['parsedcomment'] ) ) {
153  $vals['parsedcomment'] = Linker::formatComment(
154  $this->commentStore->getComment( 'pt_reason', $row )->text
155  );
156  }
157 
158  if ( isset( $prop['expiry'] ) ) {
159  $vals['expiry'] = ApiResult::formatExpiry( $row->pt_expiry );
160  }
161 
162  if ( isset( $prop['level'] ) ) {
163  $vals['level'] = $row->pt_create_perm;
164  }
165 
166  $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $vals );
167  if ( !$fit ) {
168  $this->setContinueEnumParameter( 'continue',
169  "$row->pt_timestamp|$row->pt_namespace|$row->pt_title"
170  );
171  break;
172  }
173  } else {
174  $titles[] = $title;
175  }
176  }
177 
178  if ( $resultPageSet === null ) {
179  $result->addIndexedTagName(
180  [ 'query', $this->getModuleName() ],
181  $this->getModulePrefix()
182  );
183  } else {
184  $resultPageSet->populateFromTitles( $titles );
185  }
186  }
187 
188  public function getCacheMode( $params ) {
189  if ( $params['prop'] !== null && in_array( 'parsedcomment', $params['prop'] ) ) {
190  // formatComment() calls wfMessage() among other things
191  return 'anon-public-user-private';
192  } else {
193  return 'public';
194  }
195  }
196 
197  public function getAllowedParams() {
198  return [
199  'namespace' => [
200  ApiBase::PARAM_ISMULTI => true,
201  ApiBase::PARAM_TYPE => 'namespace',
202  ],
203  'level' => [
204  ApiBase::PARAM_ISMULTI => true,
205  ApiBase::PARAM_TYPE => array_diff( $this->getConfig()->get( 'RestrictionLevels' ), [ '' ] )
206  ],
207  'limit' => [
208  ApiBase::PARAM_DFLT => 10,
209  ApiBase::PARAM_TYPE => 'limit',
210  ApiBase::PARAM_MIN => 1,
213  ],
214  'dir' => [
215  ApiBase::PARAM_DFLT => 'older',
217  'newer',
218  'older'
219  ],
220  ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
221  ],
222  'start' => [
223  ApiBase::PARAM_TYPE => 'timestamp'
224  ],
225  'end' => [
226  ApiBase::PARAM_TYPE => 'timestamp'
227  ],
228  'prop' => [
229  ApiBase::PARAM_ISMULTI => true,
230  ApiBase::PARAM_DFLT => 'timestamp|level',
232  'timestamp',
233  'user',
234  'userid',
235  'comment',
236  'parsedcomment',
237  'expiry',
238  'level'
239  ],
241  ],
242  'continue' => [
243  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
244  ],
245  ];
246  }
247 
248  protected function getExamplesMessages() {
249  return [
250  'action=query&list=protectedtitles'
251  => 'apihelp-query+protectedtitles-example-simple',
252  'action=query&generator=protectedtitles&gptnamespace=0&prop=linkshere'
253  => 'apihelp-query+protectedtitles-example-generator',
254  ];
255  }
256 
257  public function getHelpUrls() {
258  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Protectedtitles';
259  }
260 }
ContextSource\getConfig
getConfig()
Definition: ContextSource.php:72
ApiQueryBase\addFields
addFields( $value)
Add a set of fields to select to the internal array.
Definition: ApiQueryBase.php:212
ApiQuery
This is the main query class.
Definition: ApiQuery.php:37
ApiQueryProtectedTitles\getHelpUrls
getHelpUrls()
Return links to more detailed help pages about the module.
Definition: ApiQueryProtectedTitles.php:257
ApiQueryProtectedTitles\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiQueryProtectedTitles.php:197
ApiQueryBase\addTimestampWhereRange
addTimestampWhereRange( $field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, similar to addWhereRange, but converts $start and $end t...
Definition: ApiQueryBase.php:366
ApiBase\PARAM_HELP_MSG
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:105
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:1691
ApiBase\PARAM_TYPE
const PARAM_TYPE
Definition: ApiBase.php:72
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:571
CommentStore
Handle database storage of comments such as edit summaries and log reasons.
Definition: CommentStore.php:42
ApiQueryProtectedTitles\run
run( $resultPageSet=null)
Definition: ApiQueryProtectedTitles.php:59
ApiQueryBase\addOption
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
Definition: ApiQueryBase.php:378
ApiQueryProtectedTitles
Query module to enumerate all create-protected pages.
Definition: ApiQueryProtectedTitles.php:28
$res
$res
Definition: testCompression.php:57
ApiQueryBase\addFieldsIf
addFieldsIf( $value, $condition)
Same as addFields(), but add the fields only if a condition is met.
Definition: ApiQueryBase.php:222
ApiQueryProtectedTitles\getExamplesMessages
getExamplesMessages()
Returns usage examples for this module.
Definition: ApiQueryProtectedTitles.php:248
ApiQueryGeneratorBase\setContinueEnumParameter
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
Definition: ApiQueryGeneratorBase.php:83
ApiBase\PARAM_MIN
const PARAM_MIN
Definition: ApiBase.php:75
ApiQueryBase\executeGenderCacheFromResultWrapper
executeGenderCacheFromResultWrapper(IResultWrapper $res, $fname=__METHOD__, $fieldPrefix='page')
Preprocess the result set to fill the GenderCache with the necessary information before using self::a...
Definition: ApiQueryBase.php:626
ApiBase\LIMIT_BIG1
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:163
ApiQueryBase\getDB
getDB()
Get the Query database connection (read-only)
Definition: ApiQueryBase.php:117
ApiBase\PARAM_MAX
const PARAM_MAX
Definition: ApiBase.php:73
ApiQueryBase\addTables
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
Definition: ApiQueryBase.php:182
ApiQueryBase\select
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
Definition: ApiQueryBase.php:399
ApiBase\extractRequestParams
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:707
$title
$title
Definition: testCompression.php:38
Title\makeTitle
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:651
ApiQueryProtectedTitles\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiQueryProtectedTitles.php:47
ApiQueryProtectedTitles\getCacheMode
getCacheMode( $params)
Get the cache mode for the data generated by this module.
Definition: ApiQueryProtectedTitles.php:188
ApiBase\getModulePrefix
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition: ApiBase.php:448
ApiQueryBase\addWhereRange
addWhereRange( $field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, and an ORDER BY clause to sort in the right direction.
Definition: ApiQueryBase.php:337
ApiBase\dieContinueUsageIf
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
Definition: ApiBase.php:1563
ApiQueryBase\addJoinConds
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
Definition: ApiQueryBase.php:201
ApiQueryBase\addWhereFld
addWhereFld( $field, $value)
Equivalent to addWhere( [ $field => $value ] )
Definition: ApiQueryBase.php:282
ApiQueryProtectedTitles\$commentStore
CommentStore $commentStore
Definition: ApiQueryProtectedTitles.php:31
ApiQueryProtectedTitles\executeGenerator
executeGenerator( $resultPageSet)
Execute this module as a generator.
Definition: ApiQueryProtectedTitles.php:51
Linker\formatComment
static formatComment( $comment, $title=null, $local=false, $wikiId=null)
This function is called by all recent changes variants, by the page history, and by the user contribu...
Definition: Linker.php:1372
ApiQueryGeneratorBase
Definition: ApiQueryGeneratorBase.php:28
ApiBase\LIMIT_BIG2
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:165
ApiBase\PARAM_DFLT
const PARAM_DFLT
Definition: ApiBase.php:70
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:440
ApiBase\PARAM_ISMULTI
const PARAM_ISMULTI
Definition: ApiBase.php:71
ApiBase\PARAM_MAX2
const PARAM_MAX2
Definition: ApiBase.php:74
ApiResult\formatExpiry
static formatExpiry( $expiry, $infinity='infinity')
Format an expiry timestamp for API output.
Definition: ApiResult.php:1194
ApiQueryBase\addWhere
addWhere( $value)
Add a set of WHERE clauses to the internal array.
Definition: ApiQueryBase.php:245
ApiBase\PARAM_HELP_MSG_PER_VALUE
const PARAM_HELP_MSG_PER_VALUE
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg...
Definition: ApiBase.php:138
ApiQueryBase\addTitleInfo
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
Definition: ApiQueryBase.php:466
ApiQueryProtectedTitles\__construct
__construct(ApiQuery $query, $moduleName, CommentStore $commentStore)
Definition: ApiQueryProtectedTitles.php:38