includes/api/ApiPurge.php

   1 <?php
   2
   3 /*
   4  * Created on Sep 2, 2008
   5  *
   6  * API for MediaWiki 1.14+
   7  *
   8  * Copyright (C) 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  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23  * http://www.gnu.org/copyleft/gpl.html
  24  */
  25
  26 if (!defined('MEDIAWIKI')) {
  27         require_once ('ApiBase.php');
  28 }
  29
  30 /**
  31  * API interface for page purging
  32  * @ingroup API
  33  */
  34 class ApiPurge extends ApiBase {
  35
  36         public function __construct($main, $action) {
  37                 parent :: __construct($main, $action);
  38         }
  39
  40         /**
  41          * Purges the cache of a page
  42          */
  43         public function execute() {
  44                 global $wgUser;
  45                 $params = $this->extractRequestParams();
  46                 if(!$wgUser->isAllowed('purge'))
  47                         $this->dieUsageMsg(array('cantpurge'));
  48                 if(!isset($params['titles']))
  49                         $this->dieUsageMsg(array('missingparam', 'titles'));
  50                 $result = array();
  51                 foreach($params['titles'] as $t) {
  52                         $r = array();
  53                         $title = Title::newFromText($t);
  54                         if(!$title instanceof Title)
  55                         {
  56                                 $r['title'] = $t;
  57                                 $r['invalid'] = '';
  58                                 $result[] = $r;
  59                                 continue;
  60                         }
  61                         ApiQueryBase::addTitleInfo($r, $title);
  62                         if(!$title->exists())
  63                         {
  64                                 $r['missing'] = '';
  65                                 $result[] = $r;
  66                                 continue;
  67                         }
  68                         $article = new Article($title);
  69                         $article->doPurge(); // Directly purge and skip the UI part of purge().
  70                         $r['purged'] = '';
  71                         $result[] = $r;
  72                 }
  73                 $this->getResult()->setIndexedTagName($result, 'page');
  74                 $this->getResult()->addValue(null, $this->getModuleName(), $result);
  75         }
  76
  77         public function getAllowedParams() {
  78                 return array (
  79                         'titles' => array(
  80                                 ApiBase :: PARAM_ISMULTI => true
  81                         )
  82                 );
  83         }
  84
  85         public function getParamDescription() {
  86                 return array (
  87                         'titles' => 'A list of titles',
  88                 );
  89         }
  90
  91         public function getDescription() {
  92                 return array (
  93                         'Purge the cache for the given titles.'
  94                 );
  95         }
  96
  97         protected function getExamples() {
  98                 return array(
  99                         'api.php?action=purge&titles=Main_Page|API'
 100                 );
 101         }
 102
 103         public function getVersion() {
 104                 return __CLASS__ . ': $Id$';
 105         }
 106 }