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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
<?php
/**
* Special page which uses an HTMLForm to handle processing.
*
* 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
* @ingroup SpecialPage
*/
/**
* Special page which uses an HTMLForm to handle processing. This is mostly a
* clone of FormAction. More special pages should be built this way; maybe this could be
* a new structure for SpecialPages.
*
* @ingroup SpecialPage
*/
abstract class FormSpecialPage extends SpecialPage {
/**
* The sub-page of the special page.
* @var string
*/
protected $par = null;
/**
* Get an HTMLForm descriptor array
* @return array
*/
abstract protected function getFormFields();
/**
* Add pre-text to the form
* @return string HTML which will be sent to $form->addPreText()
*/
protected function preText() {
return '';
}
/**
* Add post-text to the form
* @return string HTML which will be sent to $form->addPostText()
*/
protected function postText() {
return '';
}
/**
* Play with the HTMLForm if you need to more substantially
* @param HTMLForm $form
*/
protected function alterForm( HTMLForm $form ) {
}
/**
* Get message prefix for HTMLForm
*
* @since 1.21
* @return string
*/
protected function getMessagePrefix() {
return strtolower( $this->getName() );
}
/**
* Get display format for the form. See HTMLForm documentation for available values.
*
* @since 1.25
* @return string
*/
protected function getDisplayFormat() {
return 'table';
}
/**
* Get the HTMLForm to control behavior
* @return HTMLForm|null
*/
protected function getForm() {
$form = HTMLForm::factory(
$this->getDisplayFormat(),
$this->getFormFields(),
$this->getContext(),
$this->getMessagePrefix()
);
$form->setSubmitCallback( array( $this, 'onSubmit' ) );
if ( $this->getDisplayFormat() !== 'ooui' ) {
// No legend and wrapper by default in OOUI forms, but can be set manually
// from alterForm()
$form->setWrapperLegendMsg( $this->getMessagePrefix() . '-legend' );
}
$headerMsg = $this->msg( $this->getMessagePrefix() . '-text' );
if ( !$headerMsg->isDisabled() ) {
$form->addHeaderText( $headerMsg->parseAsBlock() );
}
// Retain query parameters (uselang etc)
$params = array_diff_key(
$this->getRequest()->getQueryValues(), array( 'title' => null ) );
$form->addHiddenField( 'redirectparams', wfArrayToCgi( $params ) );
$form->addPreText( $this->preText() );
$form->addPostText( $this->postText() );
$this->alterForm( $form );
// Give hooks a chance to alter the form, adding extra fields or text etc
Hooks::run( 'SpecialPageBeforeFormDisplay', array( $this->getName(), &$form ) );
return $form;
}
/**
* Process the form on POST submission.
* @param array $data
* @param HTMLForm $form
* @return bool|string|array|Status As documented for HTMLForm::trySubmit.
*/
abstract public function onSubmit( array $data /* $form = null */ );
/**
* Do something exciting on successful processing of the form, most likely to show a
* confirmation message
* @since 1.22 Default is to do nothing
*/
public function onSuccess() {
}
/**
* Basic SpecialPage workflow: get a form, send it to the user; get some data back,
*
* @param string $par Subpage string if one was specified
*/
public function execute( $par ) {
$this->setParameter( $par );
$this->setHeaders();
// This will throw exceptions if there's a problem
$this->checkExecutePermissions( $this->getUser() );
$form = $this->getForm();
if ( $form->show() ) {
$this->onSuccess();
}
}
/**
* Maybe do something interesting with the subpage parameter
* @param string $par
*/
protected function setParameter( $par ) {
$this->par = $par;
}
/**
* Called from execute() to check if the given user can perform this action.
* Failures here must throw subclasses of ErrorPageError.
* @param User $user
* @throws UserBlockedError
* @return bool True
*/
protected function checkExecutePermissions( User $user ) {
$this->checkPermissions();
if ( $this->requiresUnblock() && $user->isBlocked() ) {
$block = $user->getBlock();
throw new UserBlockedError( $block );
}
if ( $this->requiresWrite() ) {
$this->checkReadOnly();
}
return true;
}
/**
* Whether this action requires the wiki not to be locked
* @return bool
*/
public function requiresWrite() {
return true;
}
/**
* Whether this action cannot be executed by a blocked user
* @return bool
*/
public function requiresUnblock() {
return true;
}
}
|
