MediaWiki 1.17.4

[autoinstalls/mediawiki.git] / includes / api / ApiPurge.php

diff --git a/includes/api/ApiPurge.php b/includes/api/ApiPurge.php
index d7202a46861034c2c582e01cde2706c9a141d4aa..2f4648be2c381f2be6ea2b27f7cce067cac898e7 100644 (file)
--- a/includes/api/ApiPurge.php
+++ b/includes/api/ApiPurge.php
@@ -1,11 +1,11 @@
 <?php
 
-/*
- * Created on Sep 2, 2008
- *
+/**
  * API for MediaWiki 1.14+
  *
- * Copyright (C) 2008 Chad Horohoe
+ * Created on Sep 2, 2008
+ *
+ * Copyright © 2008 Chad Horohoe
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -19,12 +19,14 @@
  *
  * You should have received a copy of the GNU General Public License along
  * with this program; if not, write to the Free Software Foundation, Inc.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
  */
 
-if (!defined('MEDIAWIKI')) {
-       require_once ('ApiBase.php');
+if ( !defined( 'MEDIAWIKI' ) ) {
+       require_once( 'ApiBase.php' );
 }
 
 /**
@@ -33,8 +35,8 @@ if (!defined('MEDIAWIKI')) {
  */
 class ApiPurge extends ApiBase {
 
-       public function __construct($main, $action) {
-               parent :: __construct($main, $action);
+       public function __construct( $main, $action ) {
+               parent::__construct( $main, $action );
        }
 
        /**
@@ -43,57 +45,66 @@ class ApiPurge extends ApiBase {
        public function execute() {
                global $wgUser;
                $params = $this->extractRequestParams();
-               if(!$wgUser->isAllowed('purge'))
-                       $this->dieUsageMsg(array('cantpurge'));
-               if(!isset($params['titles']))
-                       $this->dieUsageMsg(array('missingparam', 'titles'));
+               if ( !$wgUser->isAllowed( 'purge' ) && !$this->getMain()->isInternalMode() &&
+                               !$this->getMain()->getRequest()->wasPosted() ) {
+                       $this->dieUsageMsg( array( 'mustbeposted', $this->getModuleName() ) );
+               }
                $result = array();
-               foreach($params['titles'] as $t) {
+               foreach ( $params['titles'] as $t ) {
                        $r = array();
-                       $title = Title::newFromText($t);
-                       if(!$title instanceof Title)
-                       {
+                       $title = Title::newFromText( $t );
+                       if ( !$title instanceof Title ) {
                                $r['title'] = $t;
                                $r['invalid'] = '';
                                $result[] = $r;
                                continue;
                        }
-                       ApiQueryBase::addTitleInfo($r, $title);
-                       if(!$title->exists())
-                       {
+                       ApiQueryBase::addTitleInfo( $r, $title );
+                       if ( !$title->exists() ) {
                                $r['missing'] = '';
                                $result[] = $r;
                                continue;
                        }
-                       $article = new Article($title);
+                       $article = MediaWiki::articleFromTitle( $title );
                        $article->doPurge(); // Directly purge and skip the UI part of purge().
                        $r['purged'] = '';
                        $result[] = $r;
                }
-               $this->getResult()->setIndexedTagName($result, 'page');
-               $this->getResult()->addValue(null, $this->getModuleName(), $result);
+               $this->getResult()->setIndexedTagName( $result, 'page' );
+               $this->getResult()->addValue( null, $this->getModuleName(), $result );
+       }
+
+       public function isWriteMode() {
+               return true;
        }
 
        public function getAllowedParams() {
-               return array (
+               return array(
                        'titles' => array(
-                               ApiBase :: PARAM_ISMULTI => true
+                               ApiBase::PARAM_ISMULTI => true,
+                               ApiBase::PARAM_REQUIRED => true
                        )
                );
        }
 
        public function getParamDescription() {
-               return array (
+               return array(
                        'titles' => 'A list of titles',
                );
        }
 
        public function getDescription() {
-               return array (
-                       'Purge the cache for the given titles.'
+               return array( 'Purge the cache for the given titles.',
+                       'This module requires a POST request if the user is not logged in.'
                );
        }
 
+       public function getPossibleErrors() {
+               return array_merge( parent::getPossibleErrors(), array(
+                       array( 'cantpurge' ),
+               ) );
+       }
+
        protected function getExamples() {
                return array(
                        'api.php?action=purge&titles=Main_Page|API'
@@ -101,6 +112,6 @@ class ApiPurge extends ApiBase {
        }
 
        public function getVersion() {
-               return __CLASS__ . ': $Id: ApiPurge.php 41020 2008-09-19 00:21:03Z demon $';
+               return __CLASS__ . ': $Id$';
        }
 }