1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
<?php
/**
* API for MediaWiki 1.14+
*
* 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
* 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.,
* 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' );
}
/**
* 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->getMain()->isInternalMode() &&
!$this->getMain()->getRequest()->wasPosted() ) {
$this->dieUsageMsg( array( 'mustbeposted', $this->getModuleName() ) );
}
$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 = 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 );
}
public function isWriteMode() {
return true;
}
public function getAllowedParams() {
return array(
'titles' => array(
ApiBase::PARAM_ISMULTI => true,
ApiBase::PARAM_REQUIRED => true
)
);
}
public function getParamDescription() {
return array(
'titles' => 'A list of titles',
);
}
public function getDescription() {
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'
);
}
public function getVersion() {
return __CLASS__ . ': $Id: ApiPurge.php 74944 2010-10-18 09:19:20Z catrope $';
}
}
|
