3 * Actions are things which can be done to pages (edit, delete, rollback, etc). They
4 * are distinct from Special Pages because an action must apply to exactly one page.
6 * To add an action in an extension, create a subclass of Action, and add the key to
7 * $wgActions. There is also the deprecated UnknownAction hook
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.
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.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
26 abstract class Action
{
29 * Page on which we're performing the action
35 * IContextSource if specified; otherwise we'll use the Context from the Page
41 * The fields used to create the HTMLForm
47 * Get the Action subclass which should be used to handle this action, false if
48 * the action is disabled, or null if it's not recognised
49 * @param $action String
50 * @param $overrides Array
51 * @return bool|null|string
53 private final static function getClass( $action, array $overrides ) {
55 $action = strtolower( $action );
57 if ( !isset( $wgActions[$action] ) ) {
61 if ( $wgActions[$action] === false ) {
63 } elseif ( $wgActions[$action] === true && isset( $overrides[$action] ) ) {
64 return $overrides[$action];
65 } elseif ( $wgActions[$action] === true ) {
66 return ucfirst( $action ) . 'Action';
68 return $wgActions[$action];
73 * Get an appropriate Action subclass for the given action
74 * @param $action String
76 * @param $context IContextSource
77 * @return Action|false|null false if the action is disabled, null
78 * if it is not recognised
80 public final static function factory( $action, Page
$page, IContextSource
$context = null ) {
81 $class = self
::getClass( $action, $page->getActionOverrides() );
83 $obj = new $class( $page, $context );
90 * Get the action that will be executed, not necessarily the one passed
91 * passed through the "action" request parameter. Actions disabled in
92 * $wgDisabledActions will be replaced by "nosuchaction".
94 * @param $context IContextSource
95 * @return string: action name
97 public final static function getActionName( IContextSource
$context ) {
98 global $wgDisabledActions;
100 $request = $context->getRequest();
101 $actionName = $request->getVal( 'action', 'view' );
103 // Check for disabled actions
104 if ( in_array( $actionName, $wgDisabledActions ) ) {
105 $actionName = 'nosuchaction';
108 // Workaround for bug #20966: inability of IE to provide an action dependent
109 // on which submit button is clicked.
110 if ( $actionName === 'historysubmit' ) {
111 if ( $request->getBool( 'revisiondelete' ) ) {
112 $actionName = 'revisiondelete';
114 $actionName = 'view';
116 } elseif ( $actionName == 'editredlink' ) {
117 $actionName = 'edit';
120 $action = Action
::factory( $actionName, $context->getWikiPage() );
121 if ( $action instanceof Action
) {
122 return $action->getName();
125 return 'nosuchaction';
129 * Check if a given action is recognised, even if it's disabled
131 * @param $name String: name of an action
134 public final static function exists( $name ) {
135 return self
::getClass( $name, array() ) !== null;
139 * Get the IContextSource in use here
140 * @return IContextSource
142 public final function getContext() {
143 if ( $this->context
instanceof IContextSource
) {
144 return $this->context
;
146 return $this->page
->getContext();
150 * Get the WebRequest being used for this instance
154 public final function getRequest() {
155 return $this->getContext()->getRequest();
159 * Get the OutputPage being used for this instance
163 public final function getOutput() {
164 return $this->getContext()->getOutput();
168 * Shortcut to get the User being used for this instance
172 public final function getUser() {
173 return $this->getContext()->getUser();
177 * Shortcut to get the Skin being used for this instance
181 public final function getSkin() {
182 return $this->getContext()->getSkin();
186 * Shortcut to get the user Language being used for this instance
190 public final function getLanguage() {
191 return $this->getContext()->getLanguage();
195 * Shortcut to get the user Language being used for this instance
197 * @deprecated 1.19 Use getLanguage instead
200 public final function getLang() {
201 wfDeprecated( __METHOD__
, '1.19' );
202 return $this->getLanguage();
206 * Shortcut to get the Title object from the page
209 public final function getTitle() {
210 return $this->page
->getTitle();
214 * Get a Message object with context set
215 * Parameters are the same as wfMessage()
217 * @return Message object
219 public final function msg() {
220 $params = func_get_args();
221 return call_user_func_array( array( $this->getContext(), 'msg' ), $params );
225 * Protected constructor: use Action::factory( $action, $page ) to actually build
226 * these things in the real world
228 * @param $context IContextSource
230 protected function __construct( Page
$page, IContextSource
$context = null ) {
232 $this->context
= $context;
236 * Return the name of the action this object responds to
237 * @return String lowercase
239 public abstract function getName();
242 * Get the permission required to perform this action. Often, but not always,
243 * the same as the action name
244 * @return String|null
246 public function getRestriction() {
251 * Checks if the given user (identified by an object) can perform this action. Can be
252 * overridden by sub-classes with more complicated permissions schemes. Failures here
253 * must throw subclasses of ErrorPageError
255 * @param $user User: the user to check, or null to use the context user
256 * @throws ErrorPageError
258 protected function checkCanExecute( User
$user ) {
259 $right = $this->getRestriction();
260 if ( $right !== null ) {
261 $errors = $this->getTitle()->getUserPermissionsErrors( $right, $user );
262 if ( count( $errors ) ) {
263 throw new PermissionsError( $right, $errors );
267 if ( $this->requiresUnblock() && $user->isBlocked() ) {
268 $block = $user->mBlock
;
269 throw new UserBlockedError( $block );
272 // This should be checked at the end so that the user won't think the
273 // error is only temporary when he also don't have the rights to execute
275 if ( $this->requiresWrite() && wfReadOnly() ) {
276 throw new ReadOnlyError();
281 * Whether this action requires the wiki not to be locked
284 public function requiresWrite() {
289 * Whether this action can still be executed by a blocked user
292 public function requiresUnblock() {
297 * Set output headers for noindexing etc. This function will not be called through
298 * the execute() entry point, so only put UI-related stuff in here.
300 protected function setHeaders() {
301 $out = $this->getOutput();
302 $out->setRobotPolicy( "noindex,nofollow" );
303 $out->setPageTitle( $this->getPageTitle() );
304 $this->getOutput()->setSubtitle( $this->getDescription() );
305 $out->setArticleRelated( true );
309 * Returns the name that goes in the \<h1\> page title
313 protected function getPageTitle() {
314 return $this->getTitle()->getPrefixedText();
318 * Returns the description that goes below the \<h1\> tag
322 protected function getDescription() {
323 return wfMsg( strtolower( $this->getName() ) );
327 * The main action entry point. Do all output for display and send it to the context
328 * output. Do not use globals $wgOut, $wgRequest, etc, in implementations; use
329 * $this->getOutput(), etc.
330 * @throws ErrorPageError
332 public abstract function show();
335 * Execute the action in a silent fashion: do not display anything or release any errors.
336 * @return Bool whether execution was successful
338 public abstract function execute();
341 abstract class FormAction
extends Action
{
344 * Get an HTMLForm descriptor array
347 protected abstract function getFormFields();
350 * Add pre- or post-text to the form
351 * @return String HTML which will be sent to $form->addPreText()
353 protected function preText() { return ''; }
358 protected function postText() { return ''; }
361 * Play with the HTMLForm if you need to more substantially
362 * @param $form HTMLForm
364 protected function alterForm( HTMLForm
$form ) {}
367 * Get the HTMLForm to control behaviour
368 * @return HTMLForm|null
370 protected function getForm() {
371 $this->fields
= $this->getFormFields();
373 // Give hooks a chance to alter the form, adding extra fields or text etc
374 wfRunHooks( 'ActionModifyFormFields', array( $this->getName(), &$this->fields
, $this->page
) );
376 $form = new HTMLForm( $this->fields
, $this->getContext() );
377 $form->setSubmitCallback( array( $this, 'onSubmit' ) );
379 // Retain query parameters (uselang etc)
380 $form->addHiddenField( 'action', $this->getName() ); // Might not be the same as the query string
381 $params = array_diff_key(
382 $this->getRequest()->getQueryValues(),
383 array( 'action' => null, 'title' => null )
385 $form->addHiddenField( 'redirectparams', wfArrayToCGI( $params ) );
387 $form->addPreText( $this->preText() );
388 $form->addPostText( $this->postText() );
389 $this->alterForm( $form );
391 // Give hooks a chance to alter the form, adding extra fields or text etc
392 wfRunHooks( 'ActionBeforeFormDisplay', array( $this->getName(), &$form, $this->page
) );
398 * Process the form on POST submission. If you return false from getFormFields(),
399 * this will obviously never be reached. If you don't want to do anything with the
400 * form, just return false here
402 * @return Bool|Array true for success, false for didn't-try, array of errors on failure
404 public abstract function onSubmit( $data );
407 * Do something exciting on successful processing of the form. This might be to show
408 * a confirmation message (watch, rollback, etc) or to redirect somewhere else (edit,
411 public abstract function onSuccess();
414 * The basic pattern for actions is to display some sort of HTMLForm UI, maybe with
415 * some stuff underneath (history etc); to do some processing on submission of that
416 * form (delete, protect, etc) and to do something exciting on 'success', be that
417 * display something new or redirect to somewhere. Some actions have more exotic
418 * behaviour, but that's what subclassing is for :D
420 public function show() {
423 // This will throw exceptions if there's a problem
424 $this->checkCanExecute( $this->getUser() );
426 $form = $this->getForm();
427 if ( $form->show() ) {
433 * @see Action::execute()
434 * @throws ErrorPageError
435 * @param array|null $data
436 * @param bool $captureErrors
439 public function execute( array $data = null, $captureErrors = true ) {
441 // Set a new context so output doesn't leak.
442 $this->context
= clone $this->page
->getContext();
444 // This will throw exceptions if there's a problem
445 $this->checkCanExecute( $this->getUser() );
448 foreach ( $this->fields
as $key => $params ) {
449 if ( isset( $data[$key] ) ) {
450 $fields[$key] = $data[$key];
451 } elseif ( isset( $params['default'] ) ) {
452 $fields[$key] = $params['default'];
454 $fields[$key] = null;
457 $status = $this->onSubmit( $fields );
458 if ( $status === true ) {
459 // This might do permanent stuff
466 catch ( ErrorPageError
$e ) {
467 if ( $captureErrors ) {
477 * Actions generally fall into two groups: the show-a-form-then-do-something-with-the-input
478 * format (protect, delete, move, etc), and the just-do-something format (watch, rollback,
481 abstract class FormlessAction
extends Action
{
484 * Show something on GET request.
485 * @return String|null will be added to the HTMLForm if present, or just added to the
486 * output if not. Return null to not add anything
488 public abstract function onView();
491 * We don't want an HTMLForm
493 protected function getFormFields() {
497 public function onSubmit( $data ) {
501 public function onSuccess() {
505 public function show() {
508 // This will throw exceptions if there's a problem
509 $this->checkCanExecute( $this->getUser() );
511 $this->getOutput()->addHTML( $this->onView() );
515 * Execute the action silently, not giving any output. Since these actions don't have
516 * forms, they probably won't have any data, but some (eg rollback) may do
517 * @param $data Array values that would normally be in the GET request
518 * @param $captureErrors Bool whether to catch exceptions and just return false
519 * @return Bool whether execution was successful
521 public function execute( array $data = null, $captureErrors = true ) {
523 // Set a new context so output doesn't leak.
524 $this->context
= clone $this->page
->getContext();
525 if ( is_array( $data ) ) {
526 $this->context
->setRequest( new FauxRequest( $data, false ) );
529 // This will throw exceptions if there's a problem
530 $this->checkCanExecute( $this->getUser() );
535 catch ( ErrorPageError
$e ) {
536 if ( $captureErrors ) {