Add a way for packagers to override some installation details
[mediawiki.git] / includes / Action.php
bloba9891ec7723d1ed796d503c9b0fe292f7c20b236
1 <?php
2 /**
3 * Base classes for actions done on pages.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
19 * @file
22 /**
23 * @defgroup Actions Action done on pages
26 /**
27 * Actions are things which can be done to pages (edit, delete, rollback, etc). They
28 * are distinct from Special Pages because an action must apply to exactly one page.
30 * To add an action in an extension, create a subclass of Action, and add the key to
31 * $wgActions. There is also the deprecated UnknownAction hook
33 * Actions generally fall into two groups: the show-a-form-then-do-something-with-the-input
34 * format (protect, delete, move, etc), and the just-do-something format (watch, rollback,
35 * patrol, etc). The FormAction and FormlessAction classes respresent these two groups.
37 abstract class Action {
39 /**
40 * Page on which we're performing the action
41 * @var Page $page
43 protected $page;
45 /**
46 * IContextSource if specified; otherwise we'll use the Context from the Page
47 * @var IContextSource $context
49 protected $context;
51 /**
52 * The fields used to create the HTMLForm
53 * @var Array $fields
55 protected $fields;
57 /**
58 * Get the Action subclass which should be used to handle this action, false if
59 * the action is disabled, or null if it's not recognised
60 * @param $action String
61 * @param $overrides Array
62 * @return bool|null|string
64 private final static function getClass( $action, array $overrides ) {
65 global $wgActions;
66 $action = strtolower( $action );
68 if ( !isset( $wgActions[$action] ) ) {
69 return null;
72 if ( $wgActions[$action] === false ) {
73 return false;
74 } elseif ( $wgActions[$action] === true && isset( $overrides[$action] ) ) {
75 return $overrides[$action];
76 } elseif ( $wgActions[$action] === true ) {
77 return ucfirst( $action ) . 'Action';
78 } else {
79 return $wgActions[$action];
83 /**
84 * Get an appropriate Action subclass for the given action
85 * @param $action String
86 * @param $page Page
87 * @param $context IContextSource
88 * @return Action|bool|null false if the action is disabled, null
89 * if it is not recognised
91 public final static function factory( $action, Page $page, IContextSource $context = null ) {
92 $class = self::getClass( $action, $page->getActionOverrides() );
93 if ( $class ) {
94 $obj = new $class( $page, $context );
95 return $obj;
97 return $class;
101 * Get the action that will be executed, not necessarily the one passed
102 * passed through the "action" request parameter. Actions disabled in
103 * $wgActions will be replaced by "nosuchaction".
105 * @since 1.19
106 * @param $context IContextSource
107 * @return string: action name
109 public final static function getActionName( IContextSource $context ) {
110 global $wgActions;
112 $request = $context->getRequest();
113 $actionName = $request->getVal( 'action', 'view' );
115 // Check for disabled actions
116 if ( isset( $wgActions[$actionName] ) && $wgActions[$actionName] === false ) {
117 $actionName = 'nosuchaction';
120 // Workaround for bug #20966: inability of IE to provide an action dependent
121 // on which submit button is clicked.
122 if ( $actionName === 'historysubmit' ) {
123 if ( $request->getBool( 'revisiondelete' ) ) {
124 $actionName = 'revisiondelete';
125 } else {
126 $actionName = 'view';
128 } elseif ( $actionName == 'editredlink' ) {
129 $actionName = 'edit';
132 // Trying to get a WikiPage for NS_SPECIAL etc. will result
133 // in WikiPage::factory throwing "Invalid or virtual namespace -1 given."
134 // For SpecialPages et al, default to action=view.
135 if ( !$context->canUseWikiPage() ) {
136 return 'view';
139 $action = Action::factory( $actionName, $context->getWikiPage() );
140 if ( $action instanceof Action ) {
141 return $action->getName();
144 return 'nosuchaction';
148 * Check if a given action is recognised, even if it's disabled
150 * @param $name String: name of an action
151 * @return Bool
153 public final static function exists( $name ) {
154 return self::getClass( $name, array() ) !== null;
158 * Get the IContextSource in use here
159 * @return IContextSource
161 public final function getContext() {
162 if ( $this->context instanceof IContextSource ) {
163 return $this->context;
165 return $this->page->getContext();
169 * Get the WebRequest being used for this instance
171 * @return WebRequest
173 public final function getRequest() {
174 return $this->getContext()->getRequest();
178 * Get the OutputPage being used for this instance
180 * @return OutputPage
182 public final function getOutput() {
183 return $this->getContext()->getOutput();
187 * Shortcut to get the User being used for this instance
189 * @return User
191 public final function getUser() {
192 return $this->getContext()->getUser();
196 * Shortcut to get the Skin being used for this instance
198 * @return Skin
200 public final function getSkin() {
201 return $this->getContext()->getSkin();
205 * Shortcut to get the user Language being used for this instance
207 * @return Language
209 public final function getLanguage() {
210 return $this->getContext()->getLanguage();
214 * Shortcut to get the user Language being used for this instance
216 * @deprecated 1.19 Use getLanguage instead
217 * @return Language
219 public final function getLang() {
220 wfDeprecated( __METHOD__, '1.19' );
221 return $this->getLanguage();
225 * Shortcut to get the Title object from the page
226 * @return Title
228 public final function getTitle() {
229 return $this->page->getTitle();
233 * Get a Message object with context set
234 * Parameters are the same as wfMessage()
236 * @return Message object
238 public final function msg() {
239 $params = func_get_args();
240 return call_user_func_array( array( $this->getContext(), 'msg' ), $params );
244 * Protected constructor: use Action::factory( $action, $page ) to actually build
245 * these things in the real world
246 * @param $page Page
247 * @param $context IContextSource
249 protected function __construct( Page $page, IContextSource $context = null ) {
250 $this->page = $page;
251 $this->context = $context;
255 * Return the name of the action this object responds to
256 * @return String lowercase
258 public abstract function getName();
261 * Get the permission required to perform this action. Often, but not always,
262 * the same as the action name
263 * @return String|null
265 public function getRestriction() {
266 return null;
270 * Checks if the given user (identified by an object) can perform this action. Can be
271 * overridden by sub-classes with more complicated permissions schemes. Failures here
272 * must throw subclasses of ErrorPageError
274 * @param $user User: the user to check, or null to use the context user
275 * @throws ErrorPageError
276 * @return bool True on success
278 protected function checkCanExecute( User $user ) {
279 $right = $this->getRestriction();
280 if ( $right !== null ) {
281 $errors = $this->getTitle()->getUserPermissionsErrors( $right, $user );
282 if ( count( $errors ) ) {
283 throw new PermissionsError( $right, $errors );
287 if ( $this->requiresUnblock() && $user->isBlocked() ) {
288 $block = $user->getBlock();
289 throw new UserBlockedError( $block );
292 // This should be checked at the end so that the user won't think the
293 // error is only temporary when he also don't have the rights to execute
294 // this action
295 if ( $this->requiresWrite() && wfReadOnly() ) {
296 throw new ReadOnlyError();
298 return true;
302 * Whether this action requires the wiki not to be locked
303 * @return Bool
305 public function requiresWrite() {
306 return true;
310 * Whether this action can still be executed by a blocked user
311 * @return Bool
313 public function requiresUnblock() {
314 return true;
318 * Set output headers for noindexing etc. This function will not be called through
319 * the execute() entry point, so only put UI-related stuff in here.
321 protected function setHeaders() {
322 $out = $this->getOutput();
323 $out->setRobotPolicy( "noindex,nofollow" );
324 $out->setPageTitle( $this->getPageTitle() );
325 $this->getOutput()->setSubtitle( $this->getDescription() );
326 $out->setArticleRelated( true );
330 * Returns the name that goes in the \<h1\> page title
332 * @return String
334 protected function getPageTitle() {
335 return $this->getTitle()->getPrefixedText();
339 * Returns the description that goes below the \<h1\> tag
341 * @return String
343 protected function getDescription() {
344 return wfMsgHtml( strtolower( $this->getName() ) );
348 * The main action entry point. Do all output for display and send it to the context
349 * output. Do not use globals $wgOut, $wgRequest, etc, in implementations; use
350 * $this->getOutput(), etc.
351 * @throws ErrorPageError
353 public abstract function show();
356 * Execute the action in a silent fashion: do not display anything or release any errors.
357 * @return Bool whether execution was successful
359 public abstract function execute();
363 * An action which shows a form and does something based on the input from the form
365 abstract class FormAction extends Action {
368 * Get an HTMLForm descriptor array
369 * @return Array
371 protected abstract function getFormFields();
374 * Add pre- or post-text to the form
375 * @return String HTML which will be sent to $form->addPreText()
377 protected function preText() { return ''; }
380 * @return string
382 protected function postText() { return ''; }
385 * Play with the HTMLForm if you need to more substantially
386 * @param $form HTMLForm
388 protected function alterForm( HTMLForm $form ) {}
391 * Get the HTMLForm to control behaviour
392 * @return HTMLForm|null
394 protected function getForm() {
395 $this->fields = $this->getFormFields();
397 // Give hooks a chance to alter the form, adding extra fields or text etc
398 wfRunHooks( 'ActionModifyFormFields', array( $this->getName(), &$this->fields, $this->page ) );
400 $form = new HTMLForm( $this->fields, $this->getContext() );
401 $form->setSubmitCallback( array( $this, 'onSubmit' ) );
403 // Retain query parameters (uselang etc)
404 $form->addHiddenField( 'action', $this->getName() ); // Might not be the same as the query string
405 $params = array_diff_key(
406 $this->getRequest()->getQueryValues(),
407 array( 'action' => null, 'title' => null )
409 $form->addHiddenField( 'redirectparams', wfArrayToCGI( $params ) );
411 $form->addPreText( $this->preText() );
412 $form->addPostText( $this->postText() );
413 $this->alterForm( $form );
415 // Give hooks a chance to alter the form, adding extra fields or text etc
416 wfRunHooks( 'ActionBeforeFormDisplay', array( $this->getName(), &$form, $this->page ) );
418 return $form;
422 * Process the form on POST submission. If you return false from getFormFields(),
423 * this will obviously never be reached. If you don't want to do anything with the
424 * form, just return false here
425 * @param $data Array
426 * @return Bool|Array true for success, false for didn't-try, array of errors on failure
428 public abstract function onSubmit( $data );
431 * Do something exciting on successful processing of the form. This might be to show
432 * a confirmation message (watch, rollback, etc) or to redirect somewhere else (edit,
433 * protect, etc).
435 public abstract function onSuccess();
438 * The basic pattern for actions is to display some sort of HTMLForm UI, maybe with
439 * some stuff underneath (history etc); to do some processing on submission of that
440 * form (delete, protect, etc) and to do something exciting on 'success', be that
441 * display something new or redirect to somewhere. Some actions have more exotic
442 * behaviour, but that's what subclassing is for :D
444 public function show() {
445 $this->setHeaders();
447 // This will throw exceptions if there's a problem
448 $this->checkCanExecute( $this->getUser() );
450 $form = $this->getForm();
451 if ( $form->show() ) {
452 $this->onSuccess();
457 * @see Action::execute()
458 * @throws ErrorPageError
459 * @param $data array|null
460 * @param $captureErrors bool
461 * @return bool
463 public function execute( array $data = null, $captureErrors = true ) {
464 try {
465 // Set a new context so output doesn't leak.
466 $this->context = clone $this->page->getContext();
468 // This will throw exceptions if there's a problem
469 $this->checkCanExecute( $this->getUser() );
471 $fields = array();
472 foreach ( $this->fields as $key => $params ) {
473 if ( isset( $data[$key] ) ) {
474 $fields[$key] = $data[$key];
475 } elseif ( isset( $params['default'] ) ) {
476 $fields[$key] = $params['default'];
477 } else {
478 $fields[$key] = null;
481 $status = $this->onSubmit( $fields );
482 if ( $status === true ) {
483 // This might do permanent stuff
484 $this->onSuccess();
485 return true;
486 } else {
487 return false;
490 catch ( ErrorPageError $e ) {
491 if ( $captureErrors ) {
492 return false;
493 } else {
494 throw $e;
501 * An action which just does something, without showing a form first.
503 abstract class FormlessAction extends Action {
506 * Show something on GET request.
507 * @return String|null will be added to the HTMLForm if present, or just added to the
508 * output if not. Return null to not add anything
510 public abstract function onView();
513 * We don't want an HTMLForm
514 * @return bool
516 protected function getFormFields() {
517 return false;
521 * @param $data Array
522 * @return bool
524 public function onSubmit( $data ) {
525 return false;
529 * @return bool
531 public function onSuccess() {
532 return false;
535 public function show() {
536 $this->setHeaders();
538 // This will throw exceptions if there's a problem
539 $this->checkCanExecute( $this->getUser() );
541 $this->getOutput()->addHTML( $this->onView() );
545 * Execute the action silently, not giving any output. Since these actions don't have
546 * forms, they probably won't have any data, but some (eg rollback) may do
547 * @param $data Array values that would normally be in the GET request
548 * @param $captureErrors Bool whether to catch exceptions and just return false
549 * @return Bool whether execution was successful
551 public function execute( array $data = null, $captureErrors = true ) {
552 try {
553 // Set a new context so output doesn't leak.
554 $this->context = clone $this->page->getContext();
555 if ( is_array( $data ) ) {
556 $this->context->setRequest( new FauxRequest( $data, false ) );
559 // This will throw exceptions if there's a problem
560 $this->checkCanExecute( $this->getUser() );
562 $this->onView();
563 return true;
565 catch ( ErrorPageError $e ) {
566 if ( $captureErrors ) {
567 return false;
568 } else {
569 throw $e;