MediaWiki  master
Go to the documentation of this file.
1 <?php
30  public function __construct( ApiQuery $query, $moduleName ) {
31  parent::__construct( $query, $moduleName, 'pt' );
32  }
34  public function execute() {
35  $this->run();
36  }
38  public function executeGenerator( $resultPageSet ) {
39  $this->run( $resultPageSet );
40  }
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'] );
63  }
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' ? '>' : '<' );
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  }
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  }
98  $this->addOption( 'LIMIT', $params['limit'] + 1 );
99  $res = $this->select( __METHOD__ );
101  $count = 0;
102  $result = $this->getResult();
104  $titles = [];
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"
112  );
113  break;
114  }
116  $title = Title::makeTitle( $row->pt_namespace, $row->pt_title );
117  if ( is_null( $resultPageSet ) ) {
118  $vals = [];
120  if ( isset( $prop['timestamp'] ) ) {
121  $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->pt_timestamp );
122  }
124  if ( isset( $prop['user'] ) && !is_null( $row->user_name ) ) {
125  $vals['user'] = $row->user_name;
126  }
128  if ( isset( $prop['userid'] ) || /*B/C*/isset( $prop['user'] ) ) {
129  $vals['userid'] = (int)$row->pt_user;
130  }
132  if ( isset( $prop['comment'] ) ) {
133  $vals['comment'] = $commentStore->getComment( 'pt_reason', $row )->text;
134  }
136  if ( isset( $prop['parsedcomment'] ) ) {
137  $vals['parsedcomment'] = Linker::formatComment(
138  $commentStore->getComment( 'pt_reason', $row )->text
139  );
140  }
142  if ( isset( $prop['expiry'] ) ) {
143  $vals['expiry'] = ApiResult::formatExpiry( $row->pt_expiry );
144  }
146  if ( isset( $prop['level'] ) ) {
147  $vals['level'] = $row->pt_create_perm;
148  }
150  $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $vals );
151  if ( !$fit ) {
152  $this->setContinueEnumParameter( 'continue',
153  "$row->pt_timestamp|$row->pt_namespace|$row->pt_title"
154  );
155  break;
156  }
157  } else {
158  $titles[] = $title;
159  }
160  }
162  if ( is_null( $resultPageSet ) ) {
163  $result->addIndexedTagName(
164  [ 'query', $this->getModuleName() ],
165  $this->getModulePrefix()
166  );
167  } else {
168  $resultPageSet->populateFromTitles( $titles );
169  }
170  }
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';
176  } else {
177  return 'public';
178  }
179  }
181  public function getAllowedParams() {
182  return [
183  'namespace' => [
184  ApiBase::PARAM_ISMULTI => true,
185  ApiBase::PARAM_TYPE => 'namespace',
186  ],
187  'level' => [
188  ApiBase::PARAM_ISMULTI => true,
189  ApiBase::PARAM_TYPE => array_diff( $this->getConfig()->get( 'RestrictionLevels' ), [ '' ] )
190  ],
191  'limit' => [
192  ApiBase::PARAM_DFLT => 10,
193  ApiBase::PARAM_TYPE => 'limit',
194  ApiBase::PARAM_MIN => 1,
197  ],
198  'dir' => [
199  ApiBase::PARAM_DFLT => 'older',
201  'newer',
202  'older'
203  ],
204  ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
205  ],
206  'start' => [
207  ApiBase::PARAM_TYPE => 'timestamp'
208  ],
209  'end' => [
210  ApiBase::PARAM_TYPE => 'timestamp'
211  ],
212  'prop' => [
213  ApiBase::PARAM_ISMULTI => true,
214  ApiBase::PARAM_DFLT => 'timestamp|level',
216  'timestamp',
217  'user',
218  'userid',
219  'comment',
220  'parsedcomment',
221  'expiry',
222  'level'
223  ],
225  ],
226  'continue' => [
227  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
228  ],
229  ];
230  }
232  protected function getExamplesMessages() {
233  return [
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',
238  ];
239  }
241  public function getHelpUrls() {
242  return '';
243  }
244 }
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:94
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.
return true to allow those checks to and false if checking is done remove or add to the links of a group of changes in EnhancedChangesList Hook subscribers can return false to omit this line from recentchanges use this to change the tables headers change it to an object instance and return false override the list derivative used $groups Array of ChangesListFilterGroup objects(added in 1.34) 'FileDeleteComplete' null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1535
Get the result object.
Definition: ApiBase.php:640
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:55
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:259
(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
((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.
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\*-\*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1981
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:1162
Definition: database.txt:21
dieContinueUsageIf( $condition)
Die with the &#39;badcontinue&#39; error.
Definition: ApiBase.php:2200
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:773
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:918
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:36
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
(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:592
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
static getStore()
linkcache txt The LinkCache class maintains a list of article titles and the information about whether or not the article exists in the database This is used to mark up links when displaying a page If the same link appears more than once on any page then it only has to be looked up once In most cases link lookups are done in batches with the LinkBatch class or the equivalent in so the link cache is mostly useful for short snippets of parsed and for links in the navigation areas of the skin The link cache was formerly used to track links used in a document for the purposes of updating the link tables This application is now deprecated To create a you can use the following $titles
Definition: linkcache.txt:17
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.
(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.
(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...