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                                 // Directly purge and skip the UI part of purge()
  59                                 $page->doPurge( WikiPage::PURGE_ALL );
  60                                 $r['purged'] = true;
  61                         } else {
  62                                 $this->addWarning( 'apierror-ratelimited' );
  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                                         if ( $content ) {
  72                                                 $enableParserCache = $this->getConfig()->get( 'EnableParserCache' );
  73                                                 $p_result = $content->getParserOutput(
  74                                                         $title,
  75                                                         $page->getLatest(),
  76                                                         $popts,
  77                                                         $enableParserCache
  78                                                 );
  79
  80                                                 # Logging to better see expensive usage patterns
  81                                                 if ( $forceRecursiveLinkUpdate ) {
  82                                                         LoggerFactory::getInstance( 'RecursiveLinkPurge' )->info(
  83                                                                 "Recursive link purge enqueued for {title}",
  84                                                                 [
  85                                                                         'user' => $this->getUser()->getName(),
  86                                                                         'title' => $title->getPrefixedText()
  87                                                                 ]
  88                                                         );
  89                                                 }
  90
  91                                                 # Update the links tables
  92                                                 $updates = $content->getSecondaryDataUpdates(
  93                                                         $title, null, $forceRecursiveLinkUpdate, $p_result );
  94                                                 foreach ( $updates as $update ) {
  95                                                         DeferredUpdates::addUpdate( $update, DeferredUpdates::PRESEND );
  96                                                 }
  97
  98                                                 $r['linkupdate'] = true;
  99
 100                                                 if ( $enableParserCache ) {
 101                                                         $pcache = ParserCache::singleton();
 102                                                         $pcache->save( $p_result, $page, $popts );
 103                                                 }
 104                                         }
 105                                 } else {
 106                                         $this->addWarning( 'apierror-ratelimited' );
 107                                         $forceLinkUpdate = false;
 108                                 }
 109                         }
 110
 111                         $result[] = $r;
 112                 }
 113                 $apiResult = $this->getResult();
 114                 ApiResult::setIndexedTagName( $result, 'page' );
 115                 $apiResult->addValue( null, $this->getModuleName(), $result );
 116
 117                 $values = $pageSet->getNormalizedTitlesAsResult( $apiResult );
 118                 if ( $values ) {
 119                         $apiResult->addValue( null, 'normalized', $values );
 120                 }
 121                 $values = $pageSet->getConvertedTitlesAsResult( $apiResult );
 122                 if ( $values ) {
 123                         $apiResult->addValue( null, 'converted', $values );
 124                 }
 125                 $values = $pageSet->getRedirectTitlesAsResult( $apiResult );
 126                 if ( $values ) {
 127                         $apiResult->addValue( null, 'redirects', $values );
 128                 }
 129
 130                 $this->setContinuationManager( null );
 131                 $continuationManager->setContinuationIntoResult( $apiResult );
 132         }
 133
 134         /**
 135          * Get a cached instance of an ApiPageSet object
 136          * @return ApiPageSet
 137          */
 138         private function getPageSet() {
 139                 if ( !isset( $this->mPageSet ) ) {
 140                         $this->mPageSet = new ApiPageSet( $this );
 141                 }
 142
 143                 return $this->mPageSet;
 144         }
 145
 146         public function isWriteMode() {
 147                 return true;
 148         }
 149
 150         public function mustBePosted() {
 151                 return true;
 152         }
 153
 154         public function getAllowedParams( $flags = 0 ) {
 155                 $result = [
 156                         'forcelinkupdate' => false,
 157                         'forcerecursivelinkupdate' => false,
 158                         'continue' => [
 159                                 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
 160                         ],
 161                 ];
 162                 if ( $flags ) {
 163                         $result += $this->getPageSet()->getFinalParams( $flags );
 164                 }
 165
 166                 return $result;
 167         }
 168
 169         protected function getExamplesMessages() {
 170                 return [
 171                         'action=purge&titles=Main_Page|API'
 172                                 => 'apihelp-purge-example-simple',
 173                         'action=purge&generator=allpages&gapnamespace=0&gaplimit=10'
 174                                 => 'apihelp-purge-example-generator',
 175                 ];
 176         }
 177
 178         public function getHelpUrls() {
 179                 return 'https://www.mediawiki.org/wiki/API:Purge';
 180         }
 181 }