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
  28 /**
  29  * API interface for page purging
  30  * @ingroup API
  31  */
  32 class ApiPurge extends ApiBase {
  33
  34         public function __construct( $main, $action ) {
  35                 parent::__construct( $main, $action );
  36         }
  37
  38         /**
  39          * Purges the cache of a page
  40          */
  41         public function execute() {
  42                 $user = $this->getUser();
  43                 $params = $this->extractRequestParams();
  44                 if ( !$user->isAllowed( 'purge' ) && !$this->getMain()->isInternalMode() &&
  45                                 !$this->getRequest()->wasPosted() ) {
  46                         $this->dieUsageMsg( array( 'mustbeposted', $this->getModuleName() ) );
  47                 }
  48
  49                 $forceLinkUpdate = $params['forcelinkupdate'];
  50                 $pageSet = new ApiPageSet( $this );
  51                 $pageSet->execute();
  52
  53                 $result = array();
  54                 foreach( $pageSet->getInvalidTitles() as $title ) {
  55                         $r = array();
  56                         $r['title'] = $title;
  57                         $r['invalid'] = '';
  58                         $result[] = $r;
  59                 }
  60                 foreach( $pageSet->getMissingPageIDs() as $p ) {
  61                         $page = array();
  62                         $page['pageid'] = $p;
  63                         $page['missing'] = '';
  64                         $result[] = $page;
  65                 }
  66                 foreach( $pageSet->getMissingRevisionIDs() as $r ) {
  67                         $rev = array();
  68                         $rev['revid'] = $r;
  69                         $rev['missing'] = '';
  70                         $result[] = $rev;
  71                 }
  72
  73                 foreach ( $pageSet->getTitles() as $title ) {
  74                         $r = array();
  75
  76                         ApiQueryBase::addTitleInfo( $r, $title );
  77                         if ( !$title->exists() ) {
  78                                 $r['missing'] = '';
  79                                 $result[] = $r;
  80                                 continue;
  81                         }
  82
  83                         $page = WikiPage::factory( $title );
  84                         $page->doPurge(); // Directly purge and skip the UI part of purge().
  85                         $r['purged'] = '';
  86
  87                         if( $forceLinkUpdate ) {
  88                                 if ( !$user->pingLimiter() ) {
  89                                         global $wgEnableParserCache;
  90
  91                                         $popts = $page->makeParserOptions( 'canonical' );
  92
  93                                         # Parse content; note that HTML generation is only needed if we want to cache the result.
  94                                         $content = $page->getContent( Revision::RAW );
  95                                         $p_result = $content->getParserOutput( $title, $page->getLatest(), $popts, $wgEnableParserCache );
  96
  97                                         # Update the links tables
  98                                         $updates = $content->getSecondaryDataUpdates( $title, null, true, $p_result );
  99                                         DataUpdate::runUpdates( $updates );
 100
 101                                         $r['linkupdate'] = '';
 102
 103                                         if ( $wgEnableParserCache ) {
 104                                                 $pcache = ParserCache::singleton();
 105                                                 $pcache->save( $p_result, $page, $popts );
 106                                         }
 107                                 } else {
 108                                         $error = $this->parseMsg( array( 'actionthrottledtext' ) );
 109                                         $this->setWarning( $error['info'] );
 110                                         $forceLinkUpdate = false;
 111                                 }
 112                         }
 113
 114                         $result[] = $r;
 115                 }
 116                 $apiResult = $this->getResult();
 117                 $apiResult->setIndexedTagName( $result, 'page' );
 118                 $apiResult->addValue( null, $this->getModuleName(), $result );
 119         }
 120
 121         public function isWriteMode() {
 122                 return true;
 123         }
 124
 125         public function getAllowedParams() {
 126                 $psModule = new ApiPageSet( $this );
 127                 return $psModule->getAllowedParams() + array(
 128                         'forcelinkupdate' => false,
 129                 );
 130         }
 131
 132         public function getParamDescription() {
 133                 $psModule = new ApiPageSet( $this );
 134                 return $psModule->getParamDescription() + array(
 135                         'forcelinkupdate' => 'Update the links tables',
 136                 );
 137         }
 138
 139         public function getResultProperties() {
 140                 return array(
 141                         ApiBase::PROP_LIST => true,
 142                         '' => array(
 143                                 'ns' => array(
 144                                         ApiBase::PROP_TYPE => 'namespace',
 145                                         ApiBase::PROP_NULLABLE => true
 146                                 ),
 147                                 'title' => array(
 148                                         ApiBase::PROP_TYPE => 'string',
 149                                         ApiBase::PROP_NULLABLE => true
 150                                 ),
 151                                 'pageid' => array(
 152                                         ApiBase::PROP_TYPE => 'integer',
 153                                         ApiBase::PROP_NULLABLE => true
 154                                 ),
 155                                 'revid' => array(
 156                                         ApiBase::PROP_TYPE => 'integer',
 157                                         ApiBase::PROP_NULLABLE => true
 158                                 ),
 159                                 'invalid' => 'boolean',
 160                                 'missing' => 'boolean',
 161                                 'purged' => 'boolean',
 162                                 'linkupdate' => 'boolean'
 163                         )
 164                 );
 165         }
 166
 167         public function getDescription() {
 168                 return array( 'Purge the cache for the given titles.',
 169                         'Requires a POST request if the user is not logged in.'
 170                 );
 171         }
 172
 173         public function getPossibleErrors() {
 174                 $psModule = new ApiPageSet( $this );
 175                 return array_merge(
 176                         parent::getPossibleErrors(),
 177                         $psModule->getPossibleErrors()
 178                 );
 179         }
 180
 181         public function getExamples() {
 182                 return array(
 183                         'api.php?action=purge&titles=Main_Page|API' => 'Purge the "Main Page" and the "API" page',
 184                 );
 185         }
 186
 187         public function getHelpUrls() {
 188                 return 'https://www.mediawiki.org/wiki/API:Purge';
 189         }
 190 }