MediaWiki  1.23.12
Go to the documentation of this file.
1 <?php
32 class ApiPurge extends ApiBase {
33  private $mPageSet;
38  public function execute() {
39  $params = $this->extractRequestParams();
41  $forceLinkUpdate = $params['forcelinkupdate'];
42  $forceRecursiveLinkUpdate = $params['forcerecursivelinkupdate'];
43  $pageSet = $this->getPageSet();
44  $pageSet->execute();
46  $result = $pageSet->getInvalidTitlesAndRevisions();
48  foreach ( $pageSet->getGoodTitles() as $title ) {
49  $r = array();
51  $page = WikiPage::factory( $title );
52  $page->doPurge(); // Directly purge and skip the UI part of purge().
53  $r['purged'] = '';
55  if ( $forceLinkUpdate || $forceRecursiveLinkUpdate ) {
56  if ( !$this->getUser()->pingLimiter( 'linkpurge' ) ) {
57  global $wgEnableParserCache;
59  $popts = $page->makeParserOptions( 'canonical' );
61  # Parse content; note that HTML generation is only needed if we want to cache the result.
62  $content = $page->getContent( Revision::RAW );
63  $p_result = $content->getParserOutput(
64  $title,
65  $page->getLatest(),
66  $popts,
67  $wgEnableParserCache
68  );
70  # Update the links tables
71  $updates = $content->getSecondaryDataUpdates(
72  $title, null, $forceRecursiveLinkUpdate, $p_result );
73  DataUpdate::runUpdates( $updates );
75  $r['linkupdate'] = '';
77  if ( $wgEnableParserCache ) {
78  $pcache = ParserCache::singleton();
79  $pcache->save( $p_result, $page, $popts );
80  }
81  } else {
82  $error = $this->parseMsg( array( 'actionthrottledtext' ) );
83  $this->setWarning( $error['info'] );
84  $forceLinkUpdate = false;
85  }
86  }
88  $result[] = $r;
89  }
90  $apiResult = $this->getResult();
91  $apiResult->setIndexedTagName( $result, 'page' );
92  $apiResult->addValue( null, $this->getModuleName(), $result );
94  $values = $pageSet->getNormalizedTitlesAsResult( $apiResult );
95  if ( $values ) {
96  $apiResult->addValue( null, 'normalized', $values );
97  }
98  $values = $pageSet->getConvertedTitlesAsResult( $apiResult );
99  if ( $values ) {
100  $apiResult->addValue( null, 'converted', $values );
101  }
102  $values = $pageSet->getRedirectTitlesAsResult( $apiResult );
103  if ( $values ) {
104  $apiResult->addValue( null, 'redirects', $values );
105  }
106  }
112  private function getPageSet() {
113  if ( !isset( $this->mPageSet ) ) {
114  $this->mPageSet = new ApiPageSet( $this );
115  }
117  return $this->mPageSet;
118  }
120  public function isWriteMode() {
121  return true;
122  }
124  public function mustBePosted() {
125  // Anonymous users are not allowed a non-POST request
126  return !$this->getUser()->isAllowed( 'purge' );
127  }
129  public function getAllowedParams( $flags = 0 ) {
130  $result = array(
131  'forcelinkupdate' => false,
132  'forcerecursivelinkupdate' => false
133  );
134  if ( $flags ) {
135  $result += $this->getPageSet()->getFinalParams( $flags );
136  }
138  return $result;
139  }
141  public function getParamDescription() {
142  return $this->getPageSet()->getFinalParamDescription()
143  + array(
144  'forcelinkupdate' => 'Update the links tables',
145  'forcerecursivelinkupdate' => 'Update the links table, and update ' .
146  'the links tables for any page that uses this page as a template',
147  );
148  }
150  public function getResultProperties() {
151  return array(
152  ApiBase::PROP_LIST => true,
153  '' => array(
154  'ns' => array(
155  ApiBase::PROP_TYPE => 'namespace',
156  ApiBase::PROP_NULLABLE => true
157  ),
158  'title' => array(
159  ApiBase::PROP_TYPE => 'string',
160  ApiBase::PROP_NULLABLE => true
161  ),
162  'pageid' => array(
163  ApiBase::PROP_TYPE => 'integer',
164  ApiBase::PROP_NULLABLE => true
165  ),
166  'revid' => array(
167  ApiBase::PROP_TYPE => 'integer',
168  ApiBase::PROP_NULLABLE => true
169  ),
170  'invalid' => 'boolean',
171  'special' => 'boolean',
172  'missing' => 'boolean',
173  'purged' => 'boolean',
174  'linkupdate' => 'boolean',
175  'iw' => array(
176  ApiBase::PROP_TYPE => 'string',
177  ApiBase::PROP_NULLABLE => true
178  ),
179  )
180  );
181  }
183  public function getDescription() {
184  return array( 'Purge the cache for the given titles.',
185  'Requires a POST request if the user is not logged in.'
186  );
187  }
189  public function getPossibleErrors() {
190  return array_merge(
191  parent::getPossibleErrors(),
193  );
194  }
196  public function getExamples() {
197  return array(
198  'api.php?action=purge&titles=Main_Page|API' => 'Purge the "Main Page" and the "API" page',
199  );
200  }
202  public function getHelpUrls() {
203  return '';
204  }
205 }
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. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. $reader:XMLReader object $logInfo:Array of information Return false to stop further processing of the tag 'ImportHandlePageXMLTag':When parsing a XML tag in a page. $reader:XMLReader object $pageInfo:Array of information Return false to stop further processing of the tag 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information Return false to stop further processing of the tag 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. $reader:XMLReader object Return false to stop further processing of the tag 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. $reader:XMLReader object $revisionInfo:Array of information Return false to stop further processing of the tag '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 '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. '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 '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 '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 wfIsTrustedProxy() $ip:IP being check $result:Change this value to override the result of wfIsTrustedProxy() '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 User::isValidEmailAddr(), 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 'LanguageGetMagic':DEPRECATED, use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetSpecialPageAliases':DEPRECATED, use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language $specialPageAliases:associative array of magic words synonyms $lang:language code(string) '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:Associative array mapping language codes to prefixed links of the form "language:title". & $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. 'LinkBegin':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:1528
Returns the description string for this module.
Definition: ApiPurge.php:183
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php
Definition: skin.txt:62
static runUpdates( $updates)
Convenience method, calls doUpdate() on every DataUpdate in the array.
Definition: DataUpdate.php:79
parseMsg( $error)
Return the error message related to a certain array.
Definition: ApiBase.php:1982
Get the result object.
Definition: ApiBase.php:205
Returns possible properties in the result, grouped by the value of the prop parameter that shows them...
Definition: ApiPurge.php:150
Definition: styleTest.css.php:40
it s the revision text itself In either if gzip is the revision text is gzipped $flags
Definition: hooks.txt:2118
Get the User object.
Definition: ContextSource.php:132
This class contains a list of pages that the client has requested.
Definition: ApiPageSet.php:41
This abstract class implements many basic API functions, and is the base of all API classes.
Definition: ApiBase.php:42
Indicates whether this module requires write mode.
Definition: ApiPurge.php:120
Definition: ApiBase.php:73
Get a cached instance of an ApiPageSet object.
Definition: ApiPurge.php:112
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:103
Get final list of possible errors, after hooks have had a chance to tweak it as needed.
Definition: ApiBase.php:2171
Purges the cache of a page.
Definition: ApiPurge.php:38
Indicates whether this module must be called with a POST request.
Definition: ApiPurge.php:124
Definition: ApiPurge.php:33
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
Definition: ApiPurge.php:202
Definition: ApiBase.php:74
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:687
presenting them properly to the user as errors is done by the caller $title
Definition: hooks.txt:1324
static singleton()
Get an instance of this object.
Definition: ParserCache.php:35
Definition: ApiBase.php:76
const RAW
Definition: Revision.php:74
Returns a list of all possible errors returned by the module.
Definition: ApiPurge.php:189
Returns an array of parameter descriptions.
Definition: ApiPurge.php:141
setWarning( $warning)
Set warning section for this module.
Definition: ApiBase.php:245
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
Get the name of the module being executed by this instance.
Definition: ApiBase.php:148
getAllowedParams( $flags=0)
Definition: ApiPurge.php:129
API interface for page purging.
Definition: ApiPurge.php:32
Returns usage examples for this module.
Definition: ApiPurge.php:196
usually copyright or history_copyright This message must be in HTML not wikitext $subpages will be ignored and the rest of subPageSubtitle() will run. 'SkinTemplateBuildNavUrlsNav_urlsAfterPermalink' whether MediaWiki currently thinks this is a CSS JS page Hooks may change this value to override the return value of Title::isCssOrJsPage(). 'TitleIsAlwaysKnown' whether MediaWiki currently thinks this page is known isMovable() always returns false. $title whether MediaWiki currently thinks this page is movable Hooks may change this value to override the return value of Title::isMovable(). 'TitleIsWikitextPage' whether MediaWiki currently thinks this is a wikitext page Hooks may change this value to override the return value of Title::isWikitextPage() 'TitleMove' use UploadVerification and UploadVerifyFile instead where the first element is the message key and the remaining elements are used as parameters to the message based on mime etc Preferred in most cases over UploadVerification object with all info about the upload string as detected by MediaWiki Handlers will typically only apply for specific mime types object & $error
Definition: hooks.txt:2578
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
Definition: ApiQueryBase.php:339