includes/api/ApiPurge.php

   1 <?php
   2
   3 /**
   4  * API for MediaWiki 1.14+
   5  *
   6  * Created on Sep 2, 2008
   7  *
   8  * Copyright © 2008 Chad Horohoe
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License along
  21  * with this program; if not, write to the Free Software Foundation, Inc.,
  22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  23  * http://www.gnu.org/copyleft/gpl.html
  24  *
  25  * @file
  26  */
  27 use MediaWiki\Logger\LoggerFactory;
  28
  29 /**
  30  * API interface for page purging
  31  * @ingroup API
  32  */
  33 class ApiPurge extends ApiBase {
  34         private $mPageSet;
  35
  36         /**
  37          * Purges the cache of a page
  38          */
  39         public function execute() {
  40                 $params = $this->extractRequestParams();
  41
  42                 $continuationManager = new ApiContinuationManager( $this, [], [] );
  43                 $this->setContinuationManager( $continuationManager );
  44
  45                 $forceLinkUpdate = $params['forcelinkupdate'];
  46                 $forceRecursiveLinkUpdate = $params['forcerecursivelinkupdate'];
  47                 $pageSet = $this->getPageSet();
  48                 $pageSet->execute();
  49
  50                 $result = $pageSet->getInvalidTitlesAndRevisions();
  51                 $user = $this->getUser();
  52
  53                 foreach ( $pageSet->getGoodTitles() as $title ) {
  54                         $r = [];
  55                         ApiQueryBase::addTitleInfo( $r, $title );
  56                         $page = WikiPage::factory( $title );
  57                         if ( !$user->pingLimiter( 'purge' ) ) {
  58                                 $page->doPurge(); // Directly purge and skip the UI part of purge().
  59                                 $r['purged'] = true;
  60                         } else {
  61                                 $error = $this->parseMsg( [ 'actionthrottledtext' ] );
  62                                 $this->setWarning( $error['info'] );
  63                         }
  64
  65                         if ( $forceLinkUpdate || $forceRecursiveLinkUpdate ) {
  66                                 if ( !$user->pingLimiter( 'linkpurge' ) ) {
  67                                         $popts = $page->makeParserOptions( 'canonical' );
  68
  69                                         # Parse content; note that HTML generation is only needed if we want to cache the result.
  70                                         $content = $page->getContent( Revision::RAW );
  71                                         $enableParserCache = $this->getConfig()->get( 'EnableParserCache' );
  72                                         $p_result = $content->getParserOutput(
  73                                                 $title,
  74                                                 $page->getLatest(),
  75                                                 $popts,
  76                                                 $enableParserCache
  77                                         );
  78
  79                                         # Logging to better see expensive usage patterns
  80                                         if ( $forceRecursiveLinkUpdate ) {
  81                                                 LoggerFactory::getInstance( 'RecursiveLinkPurge' )->info(
  82                                                         "Recursive link purge enqueued for {title}",
  83                                                         [
  84                                                                 'user' => $this->getUser()->getName(),
  85                                                                 'title' => $title->getPrefixedText()
  86                                                         ]
  87                                                 );
  88                                         }
  89
  90                                         # Update the links tables
  91                                         $updates = $content->getSecondaryDataUpdates(
  92                                                 $title, null, $forceRecursiveLinkUpdate, $p_result );
  93                                         DataUpdate::runUpdates( $updates );
  94
  95                                         $r['linkupdate'] = true;
  96
  97                                         if ( $enableParserCache ) {
  98                                                 $pcache = ParserCache::singleton();
  99                                                 $pcache->save( $p_result, $page, $popts );
 100                                         }
 101                                 } else {
 102                                         $error = $this->parseMsg( [ 'actionthrottledtext' ] );
 103                                         $this->setWarning( $error['info'] );
 104                                         $forceLinkUpdate = false;
 105                                 }
 106                         }
 107
 108                         $result[] = $r;
 109                 }
 110                 $apiResult = $this->getResult();
 111                 ApiResult::setIndexedTagName( $result, 'page' );
 112                 $apiResult->addValue( null, $this->getModuleName(), $result );
 113
 114                 $values = $pageSet->getNormalizedTitlesAsResult( $apiResult );
 115                 if ( $values ) {
 116                         $apiResult->addValue( null, 'normalized', $values );
 117                 }
 118                 $values = $pageSet->getConvertedTitlesAsResult( $apiResult );
 119                 if ( $values ) {
 120                         $apiResult->addValue( null, 'converted', $values );
 121                 }
 122                 $values = $pageSet->getRedirectTitlesAsResult( $apiResult );
 123                 if ( $values ) {
 124                         $apiResult->addValue( null, 'redirects', $values );
 125                 }
 126
 127                 $this->setContinuationManager( null );
 128                 $continuationManager->setContinuationIntoResult( $apiResult );
 129         }
 130
 131         /**
 132          * Get a cached instance of an ApiPageSet object
 133          * @return ApiPageSet
 134          */
 135         private function getPageSet() {
 136                 if ( !isset( $this->mPageSet ) ) {
 137                         $this->mPageSet = new ApiPageSet( $this );
 138                 }
 139
 140                 return $this->mPageSet;
 141         }
 142
 143         public function isWriteMode() {
 144                 return true;
 145         }
 146
 147         public function mustBePosted() {
 148                 // Anonymous users are not allowed a non-POST request
 149                 return !$this->getUser()->isAllowed( 'purge' );
 150         }
 151
 152         public function getAllowedParams( $flags = 0 ) {
 153                 $result = [
 154                         'forcelinkupdate' => false,
 155                         'forcerecursivelinkupdate' => false,
 156                         'continue' => [
 157                                 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
 158                         ],
 159                 ];
 160                 if ( $flags ) {
 161                         $result += $this->getPageSet()->getFinalParams( $flags );
 162                 }
 163
 164                 return $result;
 165         }
 166
 167         protected function getExamplesMessages() {
 168                 return [
 169                         'action=purge&titles=Main_Page|API'
 170                                 => 'apihelp-purge-example-simple',
 171                         'action=purge&generator=allpages&gapnamespace=0&gaplimit=10'
 172                                 => 'apihelp-purge-example-generator',
 173                 ];
 174         }
 175
 176         public function getHelpUrls() {
 177                 return 'https://www.mediawiki.org/wiki/API:Purge';
 178         }
 179 }