Current File : /www/varak.net/wiki.varak.net/includes/api/ApiPurge.php
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
use MediaWiki\Logger\LoggerFactory;
/**
* API interface for page purging
* @ingroup API
*/
class ApiPurge extends ApiBase {
private $mPageSet = null;
/**
* Purges the cache of a page
*/
public function execute() {
$params = $this->extractRequestParams();
$continuationManager = new ApiContinuationManager( $this, [], [] );
$this->setContinuationManager( $continuationManager );
$forceLinkUpdate = $params['forcelinkupdate'];
$forceRecursiveLinkUpdate = $params['forcerecursivelinkupdate'];
$pageSet = $this->getPageSet();
$pageSet->execute();
$result = $pageSet->getInvalidTitlesAndRevisions();
$user = $this->getUser();
foreach ( $pageSet->getGoodTitles() as $title ) {
$r = [];
ApiQueryBase::addTitleInfo( $r, $title );
$page = WikiPage::factory( $title );
if ( !$user->pingLimiter( 'purge' ) ) {
// Directly purge and skip the UI part of purge()
$page->doPurge();
$r['purged'] = true;
} else {
$this->addWarning( 'apierror-ratelimited' );
}
if ( $forceLinkUpdate || $forceRecursiveLinkUpdate ) {
if ( !$user->pingLimiter( 'linkpurge' ) ) {
# Logging to better see expensive usage patterns
if ( $forceRecursiveLinkUpdate ) {
LoggerFactory::getInstance( 'RecursiveLinkPurge' )->info(
"Recursive link purge enqueued for {title}",
[
'user' => $this->getUser()->getName(),
'title' => $title->getPrefixedText()
]
);
}
$page->updateParserCache( [
'causeAction' => 'api-purge',
'causeAgent' => $this->getUser()->getName(),
] );
$page->doSecondaryDataUpdates( [
'recursive' => $forceRecursiveLinkUpdate,
'causeAction' => 'api-purge',
'causeAgent' => $this->getUser()->getName(),
'defer' => DeferredUpdates::PRESEND,
] );
$r['linkupdate'] = true;
} else {
$this->addWarning( 'apierror-ratelimited' );
$forceLinkUpdate = false;
}
}
$result[] = $r;
}
$apiResult = $this->getResult();
ApiResult::setIndexedTagName( $result, 'page' );
$apiResult->addValue( null, $this->getModuleName(), $result );
$values = $pageSet->getNormalizedTitlesAsResult( $apiResult );
if ( $values ) {
$apiResult->addValue( null, 'normalized', $values );
}
$values = $pageSet->getConvertedTitlesAsResult( $apiResult );
if ( $values ) {
$apiResult->addValue( null, 'converted', $values );
}
$values = $pageSet->getRedirectTitlesAsResult( $apiResult );
if ( $values ) {
$apiResult->addValue( null, 'redirects', $values );
}
$this->setContinuationManager( null );
$continuationManager->setContinuationIntoResult( $apiResult );
}
/**
* Get a cached instance of an ApiPageSet object
* @return ApiPageSet
*/
private function getPageSet() {
if ( $this->mPageSet === null ) {
$this->mPageSet = new ApiPageSet( $this );
}
return $this->mPageSet;
}
public function isWriteMode() {
return true;
}
public function mustBePosted() {
return true;
}
public function getAllowedParams( $flags = 0 ) {
$result = [
'forcelinkupdate' => false,
'forcerecursivelinkupdate' => false,
'continue' => [
ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
],
];
if ( $flags ) {
$result += $this->getPageSet()->getFinalParams( $flags );
}
return $result;
}
protected function getExamplesMessages() {
return [
'action=purge&titles=Main_Page|API'
=> 'apihelp-purge-example-simple',
'action=purge&generator=allpages&gapnamespace=0&gaplimit=10'
=> 'apihelp-purge-example-generator',
];
}
public function getHelpUrls() {
return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Purge';
}
}
Mini Shell