wikimedia / mediawiki

includes/api/ApiPurge.php

<?php

/**
 * API for MediaWiki 1.14+
 *
 * Created on Sep 2, 2008
 *
 * Copyright © 2008 Chad Horohoe
 *
 * 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;

	/**
	 * Purges the cache of a page
	 */
	public function execute() {
		$main = $this->getMain();
		if ( !$main->isInternalMode() && !$main->getRequest()->wasPosted() ) {
			$this->logFeatureUsage( 'purge-via-GET' );
			$this->setWarning( 'Use of action=purge via GET is deprecated. Use POST instead.' );
		}

		$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' ) ) {
				$flags = WikiPage::PURGE_ALL;
				if ( !$this->getRequest()->wasPosted() ) {
					$flags ^= WikiPage::PURGE_GLOBAL_PCACHE; // skip DB_MASTER write
				}
				// Directly purge and skip the UI part of purge()
				$page->doPurge( $flags );
				$r['purged'] = true;
			} else {
				$error = $this->parseMsg( [ 'actionthrottledtext' ] );
				$this->setWarning( $error['info'] );
			}

			if ( $forceLinkUpdate || $forceRecursiveLinkUpdate ) {
				if ( !$user->pingLimiter( 'linkpurge' ) ) {
					$popts = $page->makeParserOptions( 'canonical' );

					# Parse content; note that HTML generation is only needed if we want to cache the result.
					$content = $page->getContent( Revision::RAW );
					if ( $content ) {
						$enableParserCache = $this->getConfig()->get( 'EnableParserCache' );
						$p_result = $content->getParserOutput(
							$title,
							$page->getLatest(),
							$popts,
							$enableParserCache
						);

						# 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()
								]
							);
						}

						# Update the links tables
						$updates = $content->getSecondaryDataUpdates(
							$title, null, $forceRecursiveLinkUpdate, $p_result );
						foreach ( $updates as $update ) {
							DeferredUpdates::addUpdate( $update, DeferredUpdates::PRESEND );
						}

						$r['linkupdate'] = true;

						if ( $enableParserCache ) {
							$pcache = ParserCache::singleton();
							$pcache->save( $p_result, $page, $popts );

It seems like $page defined by \WikiPage::factory($title) on line 62 can be null; however, ParserCache::save() does not accept null, maybe add an additional type check?

						}
					}
				} else {
					$error = $this->parseMsg( [ 'actionthrottledtext' ] );
					$this->setWarning( $error['info'] );
					$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 ( !isset( $this->mPageSet ) ) {
			$this->mPageSet = new ApiPageSet( $this );
		}

		return $this->mPageSet;
	}

	public function isWriteMode() {
		return true;
	}

	public function mustBePosted() {
		// Anonymous users are not allowed a non-POST request
		return !$this->getUser()->isAllowed( 'purge' );
	}

	protected function getHelpFlags() {
		$flags = parent::getHelpFlags();

		// Claim that we must be posted for the purposes of help and paraminfo.
		// @todo Remove this when self::mustBePosted() is updated for T145649
		if ( !in_array( 'mustbeposted', $flags, true ) ) {
			$flags[] = 'mustbeposted';
		}

		return $flags;
	}

	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/API:Purge';
	}
}