MediaWiki  master
ApiQueryProtectedTitles.php
Go to the documentation of this file.
1 <?php
29 
30  public function __construct( ApiQuery $query, $moduleName ) {
31  parent::__construct( $query, $moduleName, 'pt' );
32  }
33 
34  public function execute() {
35  $this->run();
36  }
37 
38  public function executeGenerator( $resultPageSet ) {
39  $this->run( $resultPageSet );
40  }
41 
46  private function run( $resultPageSet = null ) {
47  $params = $this->extractRequestParams();
48 
49  $this->addTables( 'protected_titles' );
50  $this->addFields( [ 'pt_namespace', 'pt_title', 'pt_timestamp' ] );
51 
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'] ) );
56 
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'] );
63  }
64 
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'] );
68 
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 );
72 
73  if ( !is_null( $params['continue'] ) ) {
74  $cont = explode( '|', $params['continue'] );
75  $this->dieContinueUsageIf( count( $cont ) != 3 );
76  $op = ( $params['dir'] === 'newer' ? '>' : '<' );
77  $db = $this->getDB();
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)))"
87  );
88  }
89 
90  if ( isset( $prop['user'] ) ) {
91  $this->addTables( 'user' );
92  $this->addFields( 'user_name' );
93  $this->addJoinConds( [ 'user' => [ 'LEFT JOIN',
94  'user_id=pt_user'
95  ] ] );
96  }
97 
98  $this->addOption( 'LIMIT', $params['limit'] + 1 );
99  $res = $this->select( __METHOD__ );
100 
101  if ( $resultPageSet === null ) {
102  $this->executeGenderCacheFromResultWrapper( $res, __METHOD__, 'pt' );
103  }
104 
105  $count = 0;
106  $result = $this->getResult();
107 
108  $titles = [];
109 
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"
116  );
117  break;
118  }
119 
120  $title = Title::makeTitle( $row->pt_namespace, $row->pt_title );
121  if ( is_null( $resultPageSet ) ) {
122  $vals = [];
124  if ( isset( $prop['timestamp'] ) ) {
125  $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->pt_timestamp );
126  }
127 
128  if ( isset( $prop['user'] ) && !is_null( $row->user_name ) ) {
129  $vals['user'] = $row->user_name;
130  }
131 
132  if ( isset( $prop['userid'] ) || /*B/C*/isset( $prop['user'] ) ) {
133  $vals['userid'] = (int)$row->pt_user;
134  }
135 
136  if ( isset( $prop['comment'] ) ) {
137  $vals['comment'] = $commentStore->getComment( 'pt_reason', $row )->text;
138  }
139 
140  if ( isset( $prop['parsedcomment'] ) ) {
141  $vals['parsedcomment'] = Linker::formatComment(
142  $commentStore->getComment( 'pt_reason', $row )->text
143  );
144  }
145 
146  if ( isset( $prop['expiry'] ) ) {
147  $vals['expiry'] = ApiResult::formatExpiry( $row->pt_expiry );
148  }
149 
150  if ( isset( $prop['level'] ) ) {
151  $vals['level'] = $row->pt_create_perm;
152  }
153 
154  $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $vals );
155  if ( !$fit ) {
156  $this->setContinueEnumParameter( 'continue',
157  "$row->pt_timestamp|$row->pt_namespace|$row->pt_title"
158  );
159  break;
160  }
161  } else {
162  $titles[] = $title;
163  }
164  }
165 
166  if ( is_null( $resultPageSet ) ) {
167  $result->addIndexedTagName(
168  [ 'query', $this->getModuleName() ],
169  $this->getModulePrefix()
170  );
171  } else {
172  $resultPageSet->populateFromTitles( $titles );
173  }
174  }
175 
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';
180  } else {
181  return 'public';
182  }
183  }
184 
185  public function getAllowedParams() {
186  return [
187  'namespace' => [
188  ApiBase::PARAM_ISMULTI => true,
189  ApiBase::PARAM_TYPE => 'namespace',
190  ],
191  'level' => [
192  ApiBase::PARAM_ISMULTI => true,
193  ApiBase::PARAM_TYPE => array_diff( $this->getConfig()->get( 'RestrictionLevels' ), [ '' ] )
194  ],
195  'limit' => [
196  ApiBase::PARAM_DFLT => 10,
197  ApiBase::PARAM_TYPE => 'limit',
198  ApiBase::PARAM_MIN => 1,
201  ],
202  'dir' => [
203  ApiBase::PARAM_DFLT => 'older',
205  'newer',
206  'older'
207  ],
208  ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
209  ],
210  'start' => [
211  ApiBase::PARAM_TYPE => 'timestamp'
212  ],
213  'end' => [
214  ApiBase::PARAM_TYPE => 'timestamp'
215  ],
216  'prop' => [
217  ApiBase::PARAM_ISMULTI => true,
218  ApiBase::PARAM_DFLT => 'timestamp|level',
220  'timestamp',
221  'user',
222  'userid',
223  'comment',
224  'parsedcomment',
225  'expiry',
226  'level'
227  ],
229  ],
230  'continue' => [
231  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
232  ],
233  ];
234  }
235 
236  protected function getExamplesMessages() {
237  return [
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',
242  ];
243  }
244 
245  public function getHelpUrls() {
246  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Protectedtitles';
247  }
248 }
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:94
getDB()
Get the Query database connection (read-only)
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:261
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
getResult()
Get the result object.
Definition: ApiBase.php:640
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:55
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:259
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE &#39;integer&#39; and &#39;limit&#39;.
Definition: ApiBase.php:97
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:761
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:164
setContinueEnumParameter( $paramName, $paramValue)
Overridden to set the generator param if in generator mode.
static formatExpiry( $expiry, $infinity='infinity')
Format an expiry timestamp for API output.
Definition: ApiResult.php:1205
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
__construct(ApiQuery $query, $moduleName)
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
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:1165
executeGenderCacheFromResultWrapper(IResultWrapper $res, $fname=__METHOD__, $fieldPrefix='page')
Preprocess the result set to fill the GenderCache with the necessary information before using self::a...
dieContinueUsageIf( $condition)
Die with the &#39;badcontinue&#39; error.
Definition: ApiBase.php:2200
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:520
addFields( $value)
Add a set of fields to select to the internal array.
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right, for PARAM_TYPE &#39;limit&#39;.
Definition: ApiBase.php:103
Query module to enumerate all create-protected pages.
This is the main query class.
Definition: ApiQuery.php:37
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:131
addTimestampWhereRange( $field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, similar to addWhereRange, but converts $start and $end t...
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:584
static getStore()
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition: ApiBase.php:528
addWhere( $value)
Add a set of WHERE clauses to the internal array.
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:58
addWhereFld( $field, $value)
Equivalent to addWhere( [ $field => $value ] )
addFieldsIf( $value, $condition)
Same as addFields(), but add the fields only if a condition is met.
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE &#39;integer&#39; and &#39;limit&#39;.
Definition: ApiBase.php:106
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...