MediaWiki  master
ApiQueryProtectedTitles.php
Go to the documentation of this file.
1 <?php
24 
31 
33  private $commentStore;
34 
37 
44  public function __construct(
45  ApiQuery $query,
46  $moduleName,
49  ) {
50  parent::__construct( $query, $moduleName, 'pt' );
51  $this->commentStore = $commentStore;
52  $this->commentFormatter = $commentFormatter;
53  }
54 
55  public function execute() {
56  $this->run();
57  }
58 
59  public function executeGenerator( $resultPageSet ) {
60  $this->run( $resultPageSet );
61  }
62 
67  private function run( $resultPageSet = null ) {
68  $params = $this->extractRequestParams();
69 
70  $this->addTables( 'protected_titles' );
71  $this->addFields( [ 'pt_namespace', 'pt_title', 'pt_timestamp' ] );
72 
73  $prop = array_fill_keys( $params['prop'], true );
74  $this->addFieldsIf( 'pt_user', isset( $prop['user'] ) || isset( $prop['userid'] ) );
75  $this->addFieldsIf( 'pt_expiry', isset( $prop['expiry'] ) );
76  $this->addFieldsIf( 'pt_create_perm', isset( $prop['level'] ) );
77 
78  if ( isset( $prop['comment'] ) || isset( $prop['parsedcomment'] ) ) {
79  $commentQuery = $this->commentStore->getJoin( 'pt_reason' );
80  $this->addTables( $commentQuery['tables'] );
81  $this->addFields( $commentQuery['fields'] );
82  $this->addJoinConds( $commentQuery['joins'] );
83  }
84 
85  $this->addTimestampWhereRange( 'pt_timestamp', $params['dir'], $params['start'], $params['end'] );
86  $this->addWhereFld( 'pt_namespace', $params['namespace'] );
87  $this->addWhereFld( 'pt_create_perm', $params['level'] );
88 
89  // Include in ORDER BY for uniqueness
90  $this->addWhereRange( 'pt_namespace', $params['dir'], null, null );
91  $this->addWhereRange( 'pt_title', $params['dir'], null, null );
92 
93  if ( $params['continue'] !== null ) {
94  $cont = explode( '|', $params['continue'] );
95  $this->dieContinueUsageIf( count( $cont ) != 3 );
96  $op = ( $params['dir'] === 'newer' ? '>' : '<' );
97  $db = $this->getDB();
98  $continueTimestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
99  $continueNs = (int)$cont[1];
100  $this->dieContinueUsageIf( $continueNs != $cont[1] );
101  $continueTitle = $db->addQuotes( $cont[2] );
102  $this->addWhere( "pt_timestamp $op $continueTimestamp OR " .
103  "(pt_timestamp = $continueTimestamp AND " .
104  "(pt_namespace $op $continueNs OR " .
105  "(pt_namespace = $continueNs AND " .
106  "pt_title $op= $continueTitle)))"
107  );
108  }
109 
110  if ( isset( $prop['user'] ) ) {
111  $this->addTables( 'user' );
112  $this->addFields( 'user_name' );
113  $this->addJoinConds( [ 'user' => [ 'LEFT JOIN',
114  'user_id=pt_user'
115  ] ] );
116  }
117 
118  $this->addOption( 'LIMIT', $params['limit'] + 1 );
119  $res = $this->select( __METHOD__ );
120 
121  if ( $resultPageSet === null ) {
122  $this->executeGenderCacheFromResultWrapper( $res, __METHOD__, 'pt' );
123  if ( isset( $prop['parsedcomment'] ) ) {
124  $formattedComments = $this->commentFormatter->formatItems(
125  $this->commentFormatter->rows( $res )
126  ->commentKey( 'pt_reason' )
127  ->namespaceField( 'pt_namespace' )
128  ->titleField( 'pt_title' )
129  );
130  }
131  }
132 
133  $count = 0;
134  $result = $this->getResult();
135 
136  $titles = [];
137 
138  foreach ( $res as $rowOffset => $row ) {
139  if ( ++$count > $params['limit'] ) {
140  // We've reached the one extra which shows that there are
141  // additional pages to be had. Stop here...
142  $this->setContinueEnumParameter( 'continue',
143  "$row->pt_timestamp|$row->pt_namespace|$row->pt_title"
144  );
145  break;
146  }
147 
148  $title = Title::makeTitle( $row->pt_namespace, $row->pt_title );
149  if ( $resultPageSet === null ) {
150  $vals = [];
152  if ( isset( $prop['timestamp'] ) ) {
153  $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->pt_timestamp );
154  }
155 
156  if ( isset( $prop['user'] ) && $row->user_name !== null ) {
157  $vals['user'] = $row->user_name;
158  }
159 
160  if ( isset( $prop['userid'] ) || /*B/C*/isset( $prop['user'] ) ) {
161  $vals['userid'] = (int)$row->pt_user;
162  }
163 
164  if ( isset( $prop['comment'] ) ) {
165  $vals['comment'] = $this->commentStore->getComment( 'pt_reason', $row )->text;
166  }
167 
168  if ( isset( $prop['parsedcomment'] ) ) {
169  // @phan-suppress-next-line PhanTypeArraySuspiciousNullable
170  $vals['parsedcomment'] = $formattedComments[$rowOffset];
171  }
172 
173  if ( isset( $prop['expiry'] ) ) {
174  $vals['expiry'] = ApiResult::formatExpiry( $row->pt_expiry );
175  }
176 
177  if ( isset( $prop['level'] ) ) {
178  $vals['level'] = $row->pt_create_perm;
179  }
180 
181  $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $vals );
182  if ( !$fit ) {
183  $this->setContinueEnumParameter( 'continue',
184  "$row->pt_timestamp|$row->pt_namespace|$row->pt_title"
185  );
186  break;
187  }
188  } else {
189  $titles[] = $title;
190  }
191  }
192 
193  if ( $resultPageSet === null ) {
194  $result->addIndexedTagName(
195  [ 'query', $this->getModuleName() ],
196  $this->getModulePrefix()
197  );
198  } else {
199  $resultPageSet->populateFromTitles( $titles );
200  }
201  }
202 
203  public function getCacheMode( $params ) {
204  if ( $params['prop'] !== null && in_array( 'parsedcomment', $params['prop'] ) ) {
205  // formatComment() calls wfMessage() among other things
206  return 'anon-public-user-private';
207  } else {
208  return 'public';
209  }
210  }
211 
212  public function getAllowedParams() {
213  return [
214  'namespace' => [
215  ApiBase::PARAM_ISMULTI => true,
216  ApiBase::PARAM_TYPE => 'namespace',
217  ],
218  'level' => [
219  ApiBase::PARAM_ISMULTI => true,
220  ApiBase::PARAM_TYPE => array_diff( $this->getConfig()->get( 'RestrictionLevels' ), [ '' ] )
221  ],
222  'limit' => [
223  ApiBase::PARAM_DFLT => 10,
224  ApiBase::PARAM_TYPE => 'limit',
225  ApiBase::PARAM_MIN => 1,
228  ],
229  'dir' => [
230  ApiBase::PARAM_DFLT => 'older',
232  'newer',
233  'older'
234  ],
235  ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
236  ],
237  'start' => [
238  ApiBase::PARAM_TYPE => 'timestamp'
239  ],
240  'end' => [
241  ApiBase::PARAM_TYPE => 'timestamp'
242  ],
243  'prop' => [
244  ApiBase::PARAM_ISMULTI => true,
245  ApiBase::PARAM_DFLT => 'timestamp|level',
247  'timestamp',
248  'user',
249  'userid',
250  'comment',
251  'parsedcomment',
252  'expiry',
253  'level'
254  ],
256  ],
257  'continue' => [
258  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
259  ],
260  ];
261  }
262 
263  protected function getExamplesMessages() {
264  return [
265  'action=query&list=protectedtitles'
266  => 'apihelp-query+protectedtitles-example-simple',
267  'action=query&generator=protectedtitles&gptnamespace=0&prop=linkshere'
268  => 'apihelp-query+protectedtitles-example-generator',
269  ];
270  }
271 
272  public function getHelpUrls() {
273  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Protectedtitles';
274  }
275 }
ContextSource\getConfig
getConfig()
Definition: ContextSource.php:72
ApiQueryProtectedTitles\$commentFormatter
RowCommentFormatter $commentFormatter
Definition: ApiQueryProtectedTitles.php:36
ApiQueryProtectedTitles\__construct
__construct(ApiQuery $query, $moduleName, CommentStore $commentStore, RowCommentFormatter $commentFormatter)
Definition: ApiQueryProtectedTitles.php:44
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:39
ApiQueryProtectedTitles\getHelpUrls
getHelpUrls()
Return links to more detailed help pages about the module.
Definition: ApiQueryProtectedTitles.php:272
ApiQueryProtectedTitles\getAllowedParams
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiQueryProtectedTitles.php:212
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:162
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:1665
ApiBase\PARAM_TYPE
const PARAM_TYPE
Definition: ApiBase.php:81
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:628
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:67
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:30
$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:263
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:93
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:220
ApiQueryBase\getDB
getDB()
Get the Query database connection (read-only)
Definition: ApiQueryBase.php:117
ApiBase\PARAM_MAX
const PARAM_MAX
Definition: ApiBase.php:85
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:764
$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:663
ApiQueryProtectedTitles\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiQueryProtectedTitles.php:55
ApiQueryProtectedTitles\getCacheMode
getCacheMode( $params)
Get the cache mode for the data generated by this module.
Definition: ApiQueryProtectedTitles.php:203
ApiBase\getModulePrefix
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition: ApiBase.php:505
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:1626
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:33
ApiQueryProtectedTitles\executeGenerator
executeGenerator( $resultPageSet)
Execute this module as a generator.
Definition: ApiQueryProtectedTitles.php:59
ApiQueryGeneratorBase
Definition: ApiQueryGeneratorBase.php:28
MediaWiki\CommentFormatter\RowCommentFormatter
This is basically a CommentFormatter with a CommentStore dependency, allowing it to retrieve comment ...
Definition: RowCommentFormatter.php:15
ApiBase\LIMIT_BIG2
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:222
ApiBase\PARAM_DFLT
const PARAM_DFLT
Definition: ApiBase.php:73
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:497
ApiBase\PARAM_ISMULTI
const PARAM_ISMULTI
Definition: ApiBase.php:77
ApiBase\PARAM_MAX2
const PARAM_MAX2
Definition: ApiBase.php:89
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:195
ApiQueryBase\addTitleInfo
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
Definition: ApiQueryBase.php:466