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 if ( !defined( 'MEDIAWIKI' ) ) {
  29         require_once( 'ApiBase.php' );
  30 }
  31
  32 /**
  33  * API interface for page purging
  34  * @ingroup API
  35  */
  36 class ApiPurge extends ApiBase {
  37
  38         public function __construct( $main, $action ) {
  39                 parent::__construct( $main, $action );
  40         }
  41
  42         /**
  43          * Purges the cache of a page
  44          */
  45         public function execute() {
  46                 global $wgUser;
  47                 $params = $this->extractRequestParams();
  48                 if ( !$wgUser->isAllowed( 'purge' ) && !$this->getMain()->isInternalMode() &&
  49                                 !$this->getMain()->getRequest()->wasPosted() ) {
  50                         $this->dieUsageMsg( array( 'mustbeposted', $this->getModuleName() ) );
  51                 }
  52
  53                 $forceLinkUpdate = $params['forcelinkupdate'];
  54
  55                 $result = array();
  56                 foreach ( $params['titles'] as $t ) {
  57                         $r = array();
  58                         $title = Title::newFromText( $t );
  59                         if ( !$title instanceof Title ) {
  60                                 $r['title'] = $t;
  61                                 $r['invalid'] = '';
  62                                 $result[] = $r;
  63                                 continue;
  64                         }
  65                         ApiQueryBase::addTitleInfo( $r, $title );
  66                         if ( !$title->exists() ) {
  67                                 $r['missing'] = '';
  68                                 $result[] = $r;
  69                                 continue;
  70                         }
  71                         $article = MediaWiki::articleFromTitle( $title, RequestContext::getMain() );
  72                         $article->doPurge(); // Directly purge and skip the UI part of purge().
  73                         $r['purged'] = '';
  74
  75                         if( $forceLinkUpdate ) {
  76                                 if ( !$wgUser->pingLimiter() ) {
  77                                         global $wgParser, $wgEnableParserCache;
  78                                         $popts = new ParserOptions();
  79                                         $p_result = $wgParser->parse( $article->getContent(), $title, $popts );
  80
  81                                         # Update the links tables
  82                                         $u = new LinksUpdate( $title, $p_result );
  83                                         $u->doUpdate();
  84
  85                                         $r['linkupdate'] = '';
  86
  87                                         if ( $wgEnableParserCache ) {
  88                                                 $pcache = ParserCache::singleton();
  89                                                 $pcache->save( $p_result, $article, $popts );
  90                                         }
  91                                 } else {
  92                                         $this->setWarning( $this->parseMsg( array( 'actionthrottledtext' ) ) );
  93                                         $forceLinkUpdate = false;
  94                                 }
  95                         }
  96
  97                         $result[] = $r;
  98                 }
  99                 $this->getResult()->setIndexedTagName( $result, 'page' );
 100                 $this->getResult()->addValue( null, $this->getModuleName(), $result );
 101         }
 102
 103         public function isWriteMode() {
 104                 return true;
 105         }
 106
 107         public function getAllowedParams() {
 108                 return array(
 109                         'titles' => array(
 110                                 ApiBase::PARAM_ISMULTI => true,
 111                                 ApiBase::PARAM_REQUIRED => true
 112                         ),
 113                         'forcelinkupdate' => false,
 114                 );
 115         }
 116
 117         public function getParamDescription() {
 118                 return array(
 119                         'titles' => 'A list of titles',
 120                         'forcelinkupdate' => 'Update the links tables',
 121                 );
 122         }
 123
 124         public function getDescription() {
 125                 return array( 'Purge the cache for the given titles.',
 126                         'This module requires a POST request if the user is not logged in.'
 127                 );
 128         }
 129
 130         public function getPossibleErrors() {
 131                 return array_merge( parent::getPossibleErrors(), array(
 132                         array( 'cantpurge' ),
 133                 ) );
 134         }
 135
 136         protected function getExamples() {
 137                 return array(
 138                         'api.php?action=purge&titles=Main_Page|API'
 139                 );
 140         }
 141
 142         public function getVersion() {
 143                 return __CLASS__ . ': $Id$';
 144         }
 145 }