MediaWiki  REL1_31
ApiPurge.php
Go to the documentation of this file.
1 <?php
2 
23 
28 class ApiPurge extends ApiBase {
29  private $mPageSet = null;
30 
34  public function execute() {
35  $user = $this->getUser();
36 
37  // Fail early if the user is blocked.
38  $block = $user->getBlock();
39  if ( $block ) {
40  $this->dieBlocked( $block );
41  }
42 
43  $params = $this->extractRequestParams();
44 
45  $continuationManager = new ApiContinuationManager( $this, [], [] );
46  $this->setContinuationManager( $continuationManager );
47 
48  $forceLinkUpdate = $params['forcelinkupdate'];
49  $forceRecursiveLinkUpdate = $params['forcerecursivelinkupdate'];
50  $pageSet = $this->getPageSet();
51  $pageSet->execute();
52 
53  $result = $pageSet->getInvalidTitlesAndRevisions();
54 
55  foreach ( $pageSet->getGoodTitles() as $title ) {
56  $r = [];
58  $page = WikiPage::factory( $title );
59  if ( !$user->pingLimiter( 'purge' ) ) {
60  // Directly purge and skip the UI part of purge()
61  $page->doPurge();
62  $r['purged'] = true;
63  } else {
64  $this->addWarning( 'apierror-ratelimited' );
65  }
66 
67  if ( $forceLinkUpdate || $forceRecursiveLinkUpdate ) {
68  if ( !$user->pingLimiter( 'linkpurge' ) ) {
69  $popts = $page->makeParserOptions( 'canonical' );
70 
71  # Parse content; note that HTML generation is only needed if we want to cache the result.
72  $content = $page->getContent( Revision::RAW );
73  if ( $content ) {
74  $enableParserCache = $this->getConfig()->get( 'EnableParserCache' );
75  $p_result = $content->getParserOutput(
76  $title,
77  $page->getLatest(),
78  $popts,
79  $enableParserCache
80  );
81 
82  # Logging to better see expensive usage patterns
83  if ( $forceRecursiveLinkUpdate ) {
84  LoggerFactory::getInstance( 'RecursiveLinkPurge' )->info(
85  "Recursive link purge enqueued for {title}",
86  [
87  'user' => $this->getUser()->getName(),
88  'title' => $title->getPrefixedText()
89  ]
90  );
91  }
92 
93  # Update the links tables
94  $updates = $content->getSecondaryDataUpdates(
95  $title, null, $forceRecursiveLinkUpdate, $p_result );
96  foreach ( $updates as $update ) {
97  $update->setCause( 'api-purge', $this->getUser()->getName() );
99  }
100 
101  $r['linkupdate'] = true;
102 
103  if ( $enableParserCache ) {
104  $pcache = MediaWikiServices::getInstance()->getParserCache();
105  $pcache->save( $p_result, $page, $popts );
106  }
107  }
108  } else {
109  $this->addWarning( 'apierror-ratelimited' );
110  $forceLinkUpdate = false;
111  }
112  }
113 
114  $result[] = $r;
115  }
116  $apiResult = $this->getResult();
118  $apiResult->addValue( null, $this->getModuleName(), $result );
119 
120  $values = $pageSet->getNormalizedTitlesAsResult( $apiResult );
121  if ( $values ) {
122  $apiResult->addValue( null, 'normalized', $values );
123  }
124  $values = $pageSet->getConvertedTitlesAsResult( $apiResult );
125  if ( $values ) {
126  $apiResult->addValue( null, 'converted', $values );
127  }
128  $values = $pageSet->getRedirectTitlesAsResult( $apiResult );
129  if ( $values ) {
130  $apiResult->addValue( null, 'redirects', $values );
131  }
132 
133  $this->setContinuationManager( null );
134  $continuationManager->setContinuationIntoResult( $apiResult );
135  }
136 
141  private function getPageSet() {
142  if ( $this->mPageSet === null ) {
143  $this->mPageSet = new ApiPageSet( $this );
144  }
145 
146  return $this->mPageSet;
147  }
148 
149  public function isWriteMode() {
150  return true;
151  }
152 
153  public function mustBePosted() {
154  return true;
155  }
156 
157  public function getAllowedParams( $flags = 0 ) {
158  $result = [
159  'forcelinkupdate' => false,
160  'forcerecursivelinkupdate' => false,
161  'continue' => [
162  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
163  ],
164  ];
165  if ( $flags ) {
166  $result += $this->getPageSet()->getFinalParams( $flags );
167  }
168 
169  return $result;
170  }
171 
172  protected function getExamplesMessages() {
173  return [
174  'action=purge&titles=Main_Page|API'
175  => 'apihelp-purge-example-simple',
176  'action=purge&generator=allpages&gapnamespace=0&gaplimit=10'
177  => 'apihelp-purge-example-generator',
178  ];
179  }
180 
181  public function getHelpUrls() {
182  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Purge';
183  }
184 }
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:247
ContextSource\getConfig
getConfig()
Definition: ContextSource.php:63
ApiBase\addWarning
addWarning( $msg, $code=null, $data=null)
Add a warning for this module.
Definition: ApiBase.php:1819
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
ApiContinuationManager
This manages continuation state.
Definition: ApiContinuationManager.php:26
ApiBase\PARAM_HELP_MSG
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:124
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:641
DeferredUpdates\addUpdate
static addUpdate(DeferrableUpdate $update, $stage=self::POSTSEND)
Add an update to the deferred list to be run later by execute()
Definition: DeferredUpdates.php:76
ApiBase\setContinuationManager
setContinuationManager(ApiContinuationManager $manager=null)
Set the continuation manager.
Definition: ApiBase.php:695
$params
$params
Definition: styleTest.css.php:40
$result
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=(\d*-\d*)") 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. '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) '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 '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: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! 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:1993
ContextSource\getUser
getUser()
Definition: ContextSource.php:120
ApiPageSet
This class contains a list of pages that the client has requested.
Definition: ApiPageSet.php:40
php
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:37
ApiBase
This abstract class implements many basic API functions, and is the base of all API classes.
Definition: ApiBase.php:37
ApiPurge\isWriteMode
isWriteMode()
Indicates whether this module requires write mode.
Definition: ApiPurge.php:149
ApiBase\dieBlocked
dieBlocked(Block $block)
Throw an ApiUsageException, which will (if uncaught) call the main module's error handler and die wit...
Definition: ApiBase.php:1935
ApiPurge\getPageSet
getPageSet()
Get a cached instance of an ApiPageSet object.
Definition: ApiPurge.php:141
WikiPage\factory
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:115
ApiPurge\execute
execute()
Purges the cache of a page.
Definition: ApiPurge.php:34
ApiPurge\mustBePosted
mustBePosted()
Indicates whether this module must be called with a POST request.
Definition: ApiPurge.php:153
ApiPurge\$mPageSet
$mPageSet
Definition: ApiPurge.php:29
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
ApiPurge\getHelpUrls
getHelpUrls()
Return links to more detailed help pages about the module.
Definition: ApiPurge.php:181
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:749
ApiResult\setIndexedTagName
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:616
Revision\RAW
const RAW
Definition: Revision.php:57
DeferredUpdates\PRESEND
const PRESEND
Definition: DeferredUpdates.php:60
as
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:22
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:521
LoggerFactory
MediaWiki Logger LoggerFactory implements a PSR[0] compatible message logging system Named Psr Log LoggerInterface instances can be obtained from the MediaWiki Logger LoggerFactory::getInstance() static method. MediaWiki\Logger\LoggerFactory expects a class implementing the MediaWiki\Logger\Spi interface to act as a factory for new Psr\Log\LoggerInterface instances. The "Spi" in MediaWiki\Logger\Spi stands for "service provider interface". An SPI is an API intended to be implemented or extended by a third party. This software design pattern is intended to enable framework extension and replaceable components. It is specifically used in the MediaWiki\Logger\LoggerFactory service to allow alternate PSR-3 logging implementations to be easily integrated with MediaWiki. The service provider interface allows the backend logging library to be implemented in multiple ways. The $wgMWLoggerDefaultSpi global provides the classname of the default MediaWiki\Logger\Spi implementation to be loaded at runtime. This can either be the name of a class implementing the MediaWiki\Logger\Spi with a zero argument const ructor or a callable that will return an MediaWiki\Logger\Spi instance. Alternately the MediaWiki\Logger\LoggerFactory MediaWiki Logger LoggerFactory
Definition: logger.txt:5
ApiPurge\getAllowedParams
getAllowedParams( $flags=0)
Definition: ApiPurge.php:157
ApiPurge
API interface for page purging.
Definition: ApiPurge.php:28
MediaWikiServices
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 MediaWikiServices
Definition: injection.txt:25
ApiPurge\getExamplesMessages
getExamplesMessages()
Returns usage examples for this module.
Definition: ApiPurge.php:172
ApiQueryBase\addTitleInfo
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
Definition: ApiQueryBase.php:482