1 files changed, 106 insertions, 0 deletions
diff --git a/includes/api/ApiPurge.php b/includes/api/ApiPurge.php
new file mode 100644
index 00000000..d7202a46
--- /dev/null
+++ b/includes/api/ApiPurge.php
@@ -0,0 +1,106 @@
+<?php
+
+/*
+ * Created on Sep 2, 2008
+ *
+ * API for MediaWiki 1.14+
+ *
+ * Copyright (C) 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
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * 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.
+ * http://www.gnu.org/copyleft/gpl.html
+ */
+
+if (!defined('MEDIAWIKI')) {
+	require_once ('ApiBase.php');
+}
+
+/**
+ * API interface for page purging
+ * @ingroup API
+ */
+class ApiPurge extends ApiBase {
+
+	public function __construct($main, $action) {
+		parent :: __construct($main, $action);
+	}
+
+	/**
+	 * Purges the cache of a page
+	 */
+	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'));
+		$result = array();
+		foreach($params['titles'] as $t) {
+			$r = array();
+			$title = Title::newFromText($t);
+			if(!$title instanceof Title)
+			{
+				$r['title'] = $t;
+				$r['invalid'] = '';
+				$result[] = $r;
+				continue;
+			}
+			ApiQueryBase::addTitleInfo($r, $title);
+			if(!$title->exists())
+			{
+				$r['missing'] = '';
+				$result[] = $r;
+				continue;
+			}
+			$article = new Article($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);
+	}
+
+	public function getAllowedParams() {
+		return array (
+			'titles' => array(
+				ApiBase :: PARAM_ISMULTI => true
+			)
+		);
+	}
+
+	public function getParamDescription() {
+		return array (
+			'titles' => 'A list of titles',
+		);
+	}
+
+	public function getDescription() {
+		return array (
+			'Purge the cache for the given titles.'
+		);
+	}
+
+	protected function getExamples() {
+		return array(
+			'api.php?action=purge&titles=Main_Page|API'
+		);
+	}
+
+	public function getVersion() {
+		return __CLASS__ . ': $Id: ApiPurge.php 41020 2008-09-19 00:21:03Z demon $';
+	}
+}