Action.php

Go to the documentation of this file.

<?php
abstract class Action {

        protected $page;

        protected $context;

        protected $fields;

        private final static function getClass( $action, array $overrides ) {
                global $wgActions;
                $action = strtolower( $action );

                if ( !isset( $wgActions[$action] ) ) {
                        return null;
                }

                if ( $wgActions[$action] === false ) {
                        return false;
                } elseif ( $wgActions[$action] === true && isset( $overrides[$action] ) ) {
                        return $overrides[$action];
                } elseif ( $wgActions[$action] === true ) {
                        return ucfirst( $action ) . 'Action';
                } else {
                        return $wgActions[$action];
                }
        }

        public final static function factory( $action, Page $page, IContextSource $context = null ) {
                $class = self::getClass( $action, $page->getActionOverrides() );
                if ( $class ) {
                        $obj = new $class( $page, $context );
                        return $obj;
                }
                return $class;
        }

        public final static function getActionName( IContextSource $context ) {
                global $wgActions;

                $request = $context->getRequest();
                $actionName = $request->getVal( 'action', 'view' );

                // Check for disabled actions
                if ( isset( $wgActions[$actionName] ) && $wgActions[$actionName] === false ) {
                        $actionName = 'nosuchaction';
                }

                // Workaround for bug #20966: inability of IE to provide an action dependent
                // on which submit button is clicked.
                if ( $actionName === 'historysubmit' ) {
                        if ( $request->getBool( 'revisiondelete' ) ) {
                                $actionName = 'revisiondelete';
                        } else {
                                $actionName = 'view';
                        }
                } elseif ( $actionName == 'editredlink' ) {
                        $actionName = 'edit';
                }

                // Trying to get a WikiPage for NS_SPECIAL etc. will result
                // in WikiPage::factory throwing "Invalid or virtual namespace -1 given."
                // For SpecialPages et al, default to action=view.
                if ( !$context->canUseWikiPage() ) {
                        return 'view';
                }
                
                $action = Action::factory( $actionName, $context->getWikiPage() );
                if ( $action instanceof Action ) {
                        return $action->getName();
                }

                return 'nosuchaction';
        }

        public final static function exists( $name ) {
                return self::getClass( $name, array() ) !== null;
        }

        public final function getContext() {
                if ( $this->context instanceof IContextSource ) {
                        return $this->context;
                }
                return $this->page->getContext();
        }

        public final function getRequest() {
                return $this->getContext()->getRequest();
        }

        public final function getOutput() {
                return $this->getContext()->getOutput();
        }

        public final function getUser() {
                return $this->getContext()->getUser();
        }

        public final function getSkin() {
                return $this->getContext()->getSkin();
        }

        public final function getLanguage() {
                return $this->getContext()->getLanguage();
        }

        public final function getLang() {
                wfDeprecated( __METHOD__, '1.19' );
                return $this->getLanguage();
        }

        public final function getTitle() {
                return $this->page->getTitle();
        }

        public final function msg() {
                $params = func_get_args();
                return call_user_func_array( array( $this->getContext(), 'msg' ), $params );
        }

        protected function __construct( Page $page, IContextSource $context = null ) {
                $this->page = $page;
                $this->context = $context;
        }

        public abstract function getName();

        public function getRestriction() {
                return null;
        }

        protected function checkCanExecute( User $user ) {
                $right = $this->getRestriction();
                if ( $right !== null ) {
                        $errors = $this->getTitle()->getUserPermissionsErrors( $right, $user );
                        if ( count( $errors ) ) {
                                throw new PermissionsError( $right, $errors );
                        }
                }

                if ( $this->requiresUnblock() && $user->isBlocked() ) {
                        $block = $user->mBlock;
                        throw new UserBlockedError( $block );
                }

                // This should be checked at the end so that the user won't think the
                // error is only temporary when he also don't have the rights to execute
                // this action
                if ( $this->requiresWrite() && wfReadOnly() ) {
                        throw new ReadOnlyError();
                }
        }

        public function requiresWrite() {
                return true;
        }

        public function requiresUnblock() {
                return true;
        }

        protected function setHeaders() {
                $out = $this->getOutput();
                $out->setRobotPolicy( "noindex,nofollow" );
                $out->setPageTitle( $this->getPageTitle() );
                $this->getOutput()->setSubtitle( $this->getDescription() );
                $out->setArticleRelated( true );
        }

        protected function getPageTitle() {
                return $this->getTitle()->getPrefixedText();
        }

        protected function getDescription() {
                return wfMsgHtml( strtolower( $this->getName() ) );
        }

        public abstract function show();

        public abstract function execute();
}

abstract class FormAction extends Action {

        protected abstract function getFormFields();

        protected function preText() { return ''; }

        protected function postText() { return ''; }

        protected function alterForm( HTMLForm $form ) {}

        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 ) );

                $form = new HTMLForm( $this->fields, $this->getContext() );
                $form->setSubmitCallback( array( $this, 'onSubmit' ) );

                // 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() );
                $this->alterForm( $form );

                // Give hooks a chance to alter the form, adding extra fields or text etc
                wfRunHooks( 'ActionBeforeFormDisplay', array( $this->getName(), &$form, $this->page ) );

                return $form;
        }

        public abstract function onSubmit( $data );

        public abstract function onSuccess();

        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();
                }
        }

        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 {

        public abstract function onView();

        protected function getFormFields() {
                return false;
        }

        public function onSubmit( $data ) {
                return false;
        }

        public function onSuccess() {
                return false;
        }

        public function show() {
                $this->setHeaders();

                // This will throw exceptions if there's a problem
                $this->checkCanExecute( $this->getUser() );

                $this->getOutput()->addHTML( $this->onView() );
        }

        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 ) ) {
                                $this->context->setRequest( new FauxRequest( $data, false ) );
                        }

                        // This will throw exceptions if there's a problem
                        $this->checkCanExecute( $this->getUser() );

                        $this->onView();
                        return true;
                }
                catch ( ErrorPageError $e ) {
                        if ( $captureErrors ) {
                                return false;
                        } else {
                                throw $e;
                        }
                }
        }
}