*/
abstract class Action {
- // Page on which we're performing the action
- // @var Article
+ /**
+ * Page on which we're performing the action
+ * @var Article
+ */
protected $page;
- // RequestContext if specified; otherwise we'll use the Context from the Page
- // @var RequestContext
+ /**
+ * RequestContext if specified; otherwise we'll use the Context from the Page
+ * @var RequestContext
+ */
protected $context;
- // The fields used to create the HTMLForm
- // @var Array
+ /**
+ * The fields used to create the HTMLForm
+ * @var Array
+ */
protected $fields;
/**
* Get the Action subclass which should be used to handle this action, false if
* the action is disabled, or null if it's not recognised
* @param $action String
+ * @param $overrides Array
* @return bool|null|string
*/
- private final static function getClass( $action ){
+ private final static function getClass( $action, array $overrides ) {
global $wgActions;
$action = strtolower( $action );
- if( !isset( $wgActions[$action] ) ){
+ if ( !isset( $wgActions[$action] ) ) {
return null;
}
- if( $wgActions[$action] === false ){
+ if ( $wgActions[$action] === false ) {
return false;
- }
-
- elseif( $wgActions[$action] === true ){
+ } elseif ( $wgActions[$action] === true && isset( $overrides[$action] ) ) {
+ return $overrides[$action];
+ } elseif ( $wgActions[$action] === true ) {
return ucfirst( $action ) . 'Action';
- }
-
- else {
+ } else {
return $wgActions[$action];
}
}
* @return Action|false|null false if the action is disabled, null
* if it is not recognised
*/
- public final static function factory( $action, Article $page ){
- $class = self::getClass( $action );
- if( $class ){
+ public final static function factory( $action, Page $page ) {
+ $class = self::getClass( $action, $page->getActionOverrides() );
+ if ( $class ) {
$obj = new $class( $page );
return $obj;
}
- return null;
+ return $class;
}
/**
* @return Bool
*/
public final static function exists( $name ) {
- return self::getClass( $name ) !== null;
+ return self::getClass( $name, array() ) !== null;
}
/**
* Get the RequestContext in use here
* @return RequestContext
*/
- protected final function getContext(){
- if( $this->context instanceof RequestContext ){
+ protected final function getContext() {
+ if ( $this->context instanceof RequestContext ) {
return $this->context;
}
return $this->page->getContext();
* @return WebRequest
*/
protected final function getRequest() {
- return $this->getContext()->request;
+ return $this->getContext()->getRequest();
}
/**
* @return OutputPage
*/
protected final function getOutput() {
- return $this->getContext()->output;
+ return $this->getContext()->getOutput();
}
/**
- * Shortcut to get the skin being used for this instance
+ * Shortcut to get the User being used for this instance
*
* @return User
*/
protected final function getUser() {
- return $this->getContext()->user;
+ return $this->getContext()->getUser();
}
/**
- * Shortcut to get the skin being used for this instance
+ * Shortcut to get the Skin being used for this instance
*
* @return Skin
*/
protected final function getSkin() {
- return $this->getContext()->skin;
+ return $this->getContext()->getSkin();
+ }
+
+ /**
+ * Shortcut to get the user Language being used for this instance
+ *
+ * @return Skin
+ */
+ protected final function getLang() {
+ return $this->getContext()->getLang();
}
/**
* Shortcut to get the Title object from the page
* @return Title
*/
- protected final function getTitle(){
+ protected final function getTitle() {
return $this->page->getTitle();
}
/**
* Protected constructor: use Action::factory( $action, $page ) to actually build
* these things in the real world
- * @param Article $page
+ * @param Page $page
*/
- protected function __construct( Article $page ){
+ protected function __construct( Page $page ) {
$this->page = $page;
}
* @throws ErrorPageError
*/
protected function checkCanExecute( User $user ) {
- if( $this->requiresWrite() && wfReadOnly() ){
+ if ( $this->requiresWrite() && wfReadOnly() ) {
throw new ReadOnlyError();
}
- if( $this->getRestriction() !== null && !$user->isAllowed( $this->getRestriction() ) ){
+ if ( $this->getRestriction() !== null && !$user->isAllowed( $this->getRestriction() ) ) {
throw new PermissionsError( $this->getRestriction() );
}
- if( $this->requiresUnblock() && $user->isBlocked() ){
+ if ( $this->requiresUnblock() && $user->isBlocked() ) {
$block = $user->mBlock;
throw new UserBlockedError( $block );
}
* Whether this action requires the wiki not to be locked
* @return Bool
*/
- public function requiresWrite(){
+ public function requiresWrite() {
return true;
}
* Whether this action can still be executed by a blocked user
* @return Bool
*/
- public function requiresUnblock(){
+ public function requiresUnblock() {
return true;
}
protected function setHeaders() {
$out = $this->getOutput();
$out->setRobotPolicy( "noindex,nofollow" );
- $out->setPageTitle( $this->getTitle()->getPrefixedText() );
+ $out->setPageTitle( $this->getPageTitle() );
$this->getOutput()->setSubtitle( $this->getDescription() );
$out->setArticleRelated( true );
}
/**
* Returns the name that goes in the \<h1\> page title
*
- * Derived classes can override this, but usually it is easier to keep the
- * default behaviour. Messages can be added at run-time, see
- * MessageCache.php.
+ * @return String
+ */
+ protected function getPageTitle() {
+ return $this->getTitle()->getPrefixedText();
+ }
+
+ /**
+ * Returns the description that goes below the \<h1\> tag
*
* @return String
*/
}
/**
- * The basic pattern for actions is to display some sort of HTMLForm UI, maybe with
- * some stuff underneath (history etc); to do some processing on submission of that
- * form (delete, protect, etc) and to do something exciting on 'success', be that
- * display something new or redirect to somewhere. Some actions have more exotic
- * behaviour, but that's what subclassing is for :D
+ * The main action entry point. Do all output for display and send it to the context
+ * output. Do not use globals $wgOut, $wgRequest, etc, in implementations; use
+ * $this->getOutput(), etc.
+ * @throws ErrorPageError
*/
- public function show(){
- $this->setHeaders();
-
- // This will throw exceptions if there's a problem
- $this->checkCanExecute( $this->getUser() );
-
- $form = $this->getForm();
- if( $form instanceof HTMLForm ){
- if( $form->show() ){
- $this->onSuccess();
- }
- } else {
- // You're using the wrong type of Action
- throw new MWException( "Action::getFormFields() must produce a form. Use GetAction if you don't want one." );
- }
- }
+ public abstract function show();
/**
* Execute the action in a silent fashion: do not display anything or release any errors.
* @param $captureErrors Bool whether to catch exceptions and just return false
* @return Bool whether execution was successful
*/
- public function execute( array $data = null, $captureErrors = true ){
- try {
- // Set a new context so output doesn't leak.
- $this->context = clone $this->page->getContext();
+ public abstract function execute();
+}
- // This will throw exceptions if there's a problem
- $this->checkCanExecute( $this->getUser() );
-
- $form = $this->getForm();
- if( $form instanceof HTMLForm ){
- // Great, so there's a form. Ignore it and go straight to the submission callback
- $fields = array();
- foreach( $this->fields as $key => $params ){
- if( isset( $data[$key] ) ){
- $fields[$key] = $data[$key];
- } elseif( isset( $params['default'] ) ) {
- $fields[$key] = $params['default'];
- } else {
- $fields[$key] = null;
- }
- }
- $status = $this->onSubmit( $fields );
- if( $status === true ){
- // This might do permanent stuff
- $this->onSuccess();
- return true;
- } else {
- return false;
- }
- } else {
- // You're using the wrong type of Action
- throw new MWException( "Action::getFormFields() must produce a form. Use GetAction if you don't want one." );
- }
- }
- catch ( ErrorPageError $e ){
- if( $captureErrors ){
- return false;
- } else {
- throw $e;
- }
- }
- }
+abstract class FormAction extends Action {
/**
- * Get an HTMLForm descriptor array, or false if you don't want a form
+ * Get an HTMLForm descriptor array
* @return Array
*/
protected abstract function getFormFields();
/**
* Add pre- or post-text to the form
- * @return String
+ * @return String HTML which will be sent to $form->addPreText()
*/
- protected function preText(){ return ''; }
- protected function postText(){ return ''; }
+ protected function preText() { return ''; }
+ protected function postText() { return ''; }
/**
* Play with the HTMLForm if you need to more substantially
- * @param &$form HTMLForm
+ * @param $form HTMLForm
*/
- protected function alterForm( HTMLForm &$form ){}
+ protected function alterForm( HTMLForm $form ) {}
/**
* Get the HTMLForm to control behaviour
* @return HTMLForm|null
*/
- protected function getForm(){
+ protected function getForm() {
$this->fields = $this->getFormFields();
// Give hooks a chance to alter the form, adding extra fields or text etc
wfRunHooks( 'ActionModifyFormFields', array( $this->getName(), &$this->fields, $this->page ) );
- if( $this->fields === false ){
- return null;
- }
-
$form = new HTMLForm( $this->fields, $this->getContext() );
$form->setSubmitCallback( array( $this, 'onSubmit' ) );
- $form->addHiddenField( 'action', $this->getName() );
+
+ // Retain query parameters (uselang etc)
+ $form->addHiddenField( 'action', $this->getName() ); // Might not be the same as the query string
+ $params = array_diff_key(
+ $this->getRequest()->getQueryValues(),
+ array( 'action' => null, 'title' => null )
+ );
+ $form->addHiddenField( 'redirectparams', wfArrayToCGI( $params ) );
$form->addPreText( $this->preText() );
$form->addPostText( $this->postText() );
*/
public abstract function onSuccess();
+ /**
+ * The basic pattern for actions is to display some sort of HTMLForm UI, maybe with
+ * some stuff underneath (history etc); to do some processing on submission of that
+ * form (delete, protect, etc) and to do something exciting on 'success', be that
+ * display something new or redirect to somewhere. Some actions have more exotic
+ * behaviour, but that's what subclassing is for :D
+ */
+ public function show() {
+ $this->setHeaders();
+
+ // This will throw exceptions if there's a problem
+ $this->checkCanExecute( $this->getUser() );
+
+ $form = $this->getForm();
+ if ( $form->show() ) {
+ $this->onSuccess();
+ }
+ }
+
+ /**
+ * @see Action::execute()
+ * @throws ErrorPageError
+ * @param array|null $data
+ * @param bool $captureErrors
+ * @return bool
+ */
+ public function execute( array $data = null, $captureErrors = true ) {
+ try {
+ // Set a new context so output doesn't leak.
+ $this->context = clone $this->page->getContext();
+
+ // This will throw exceptions if there's a problem
+ $this->checkCanExecute( $this->getUser() );
+
+ $fields = array();
+ foreach ( $this->fields as $key => $params ) {
+ if ( isset( $data[$key] ) ) {
+ $fields[$key] = $data[$key];
+ } elseif ( isset( $params['default'] ) ) {
+ $fields[$key] = $params['default'];
+ } else {
+ $fields[$key] = null;
+ }
+ }
+ $status = $this->onSubmit( $fields );
+ if ( $status === true ) {
+ // This might do permanent stuff
+ $this->onSuccess();
+ return true;
+ } else {
+ return false;
+ }
+ }
+ catch ( ErrorPageError $e ) {
+ if ( $captureErrors ) {
+ return false;
+ } else {
+ throw $e;
+ }
+ }
+ }
}
/**
abstract class FormlessAction extends Action {
/**
- * Show something on GET request. This is displayed as the postText() of the HTMLForm
- * if there is one; you can always use alterForm() to add pre text if you need it. If
- * you call addPostText() from alterForm() as well as overriding this function, you
- * might get strange ordering.
+ * Show something on GET request.
* @return String|null will be added to the HTMLForm if present, or just added to the
* output if not. Return null to not add anything
*/
/**
* We don't want an HTMLForm
*/
- protected function getFormFields(){
+ protected function getFormFields() {
return false;
}
- public function onSubmit( $data ){
+ public function onSubmit( $data ) {
return false;
}
- public function onSuccess(){
+ public function onSuccess() {
return false;
}
- public function show(){
+ public function show() {
$this->setHeaders();
// This will throw exceptions if there's a problem
$this->checkCanExecute( $this->getUser() );
+
$this->getOutput()->addHTML( $this->onView() );
}
* @param $captureErrors Bool whether to catch exceptions and just return false
* @return Bool whether execution was successful
*/
- public function execute( array $data = null, $captureErrors = true){
+ public function execute( array $data = null, $captureErrors = true ) {
try {
// Set a new context so output doesn't leak.
$this->context = clone $this->page->getContext();
- if( is_array( $data ) ){
+ if ( is_array( $data ) ) {
$this->context->setRequest( new FauxRequest( $data, false ) );
}
$this->onView();
return true;
}
- catch ( ErrorPageError $e ){
- if( $captureErrors ){
+ catch ( ErrorPageError $e ) {
+ if ( $captureErrors ) {
return false;
} else {
throw $e;
}
}
}
-}
\ No newline at end of file
+}
dépôts / lhc / web / wiklou.git / blobdiff