Add a way for packagers to override some installation details
[lhc/web/wiklou.git] / includes / SpecialPage.php
index 10e906a..9e6717f 100644 (file)
@@ -1,25 +1,24 @@
 <?php
 /**
- * SpecialPage: handling special pages and lists thereof.
+ * Parent class for all special pages.
  *
- * To add a special page in an extension, add to $wgSpecialPages either
- * an object instance or an array containing the name and constructor
- * parameters. The latter is preferred for performance reasons.
+ * 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.
  *
- * The object instantiated must be either an instance of SpecialPage or a
- * sub-class thereof. It must have an execute() method, which sends the HTML
- * for the special page to $wgOut. The parent class has an execute() method
- * which distributes the call to the historical global functions. Additionally,
- * execute() also checks if the user has the necessary access privileges
- * and bails out if not.
+ * 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.
  *
- * To add a core special page, use the similar static list in
- * SpecialPage::$mList. To remove a core static special page at runtime, use
- * a SpecialPage_initList hook.
+ * 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
- * @defgroup SpecialPage SpecialPage
  */
 
 /**
@@ -31,7 +30,7 @@ class SpecialPage {
 
        // The canonical name of this special page
        // Also used for the default <h1> heading, @see getDescription()
-       /*private*/ var $mName;
+       protected $mName;
 
        // The local name of this special page
        private $mLocalName;
@@ -57,7 +56,7 @@ class SpecialPage {
 
        /**
         * Current request context
-        * @var RequestContext
+        * @var IContextSource
         */
        protected $mContext;
 
@@ -67,6 +66,7 @@ class SpecialPage {
         * @deprecated since 1.18
         */
        static function initList() {
+               wfDeprecated( __METHOD__, '1.18' );
                // Noop
        }
 
@@ -74,6 +74,7 @@ class SpecialPage {
         * @deprecated since 1.18
         */
        static function initAliasList() {
+               wfDeprecated( __METHOD__, '1.18' );
                // Noop
        }
 
@@ -86,6 +87,7 @@ class SpecialPage {
         * @deprecated since 1.18 call SpecialPageFactory method directly
         */
        static function resolveAlias( $alias ) {
+               wfDeprecated( __METHOD__, '1.18' );
                list( $name, /*...*/ ) = SpecialPageFactory::resolveAlias( $alias );
                return $name;
        }
@@ -112,7 +114,7 @@ class SpecialPage {
         * @deprecated since 1.7, warnings in 1.17, might be removed in 1.20
         */
        static function addPage( &$page ) {
-               wfDeprecated( __METHOD__ );
+               wfDeprecated( __METHOD__, '1.7' );
                SpecialPageFactory::getList()->{$page->mName} = $page;
        }
 
@@ -124,16 +126,19 @@ class SpecialPage {
         * @deprecated since 1.18 call SpecialPageFactory method directly
         */
        static function setGroup( $page, $group ) {
-               return SpecialPageFactory::setGroup( $page, $group );
+               wfDeprecated( __METHOD__, '1.18' );
+               SpecialPageFactory::setGroup( $page, $group );
        }
 
        /**
-        * Add a page to a certain display group for Special:SpecialPages
+        * Get the group that the special page belongs in on Special:SpecialPage
         *
         * @param $page SpecialPage
+        * @return string
         * @deprecated since 1.18 call SpecialPageFactory method directly
         */
        static function getGroup( &$page ) {
+               wfDeprecated( __METHOD__, '1.18' );
                return SpecialPageFactory::getGroup( $page );
        }
 
@@ -142,8 +147,11 @@ class SpecialPage {
         * Formerly used to disable expensive or dangerous special pages. The
         * preferred method is now to add a SpecialPage_initList hook.
         * @deprecated since 1.18
+        *
+        * @param $name String the page to remove
         */
        static function removePage( $name ) {
+               wfDeprecated( __METHOD__, '1.18' );
                unset( SpecialPageFactory::getList()->$name );
        }
 
@@ -155,6 +163,7 @@ class SpecialPage {
         * @deprecated since 1.18 call SpecialPageFactory method directly
         */
        static function exists( $name ) {
+               wfDeprecated( __METHOD__, '1.18' );
                return SpecialPageFactory::exists( $name );
        }
 
@@ -166,6 +175,7 @@ class SpecialPage {
         * @deprecated since 1.18 call SpecialPageFactory method directly
         */
        static function getPage( $name ) {
+               wfDeprecated( __METHOD__, '1.18' );
                return SpecialPageFactory::getPage( $name );
        }
 
@@ -173,10 +183,12 @@ class SpecialPage {
         * Get a special page with a given localised name, or NULL if there
         * is no such special page.
         *
+        * @param $alias String
         * @return SpecialPage object or null if the page doesn't exist
         * @deprecated since 1.18 call SpecialPageFactory method directly
         */
        static function getPageByAlias( $alias ) {
+               wfDeprecated( __METHOD__, '1.18' );
                return SpecialPageFactory::getPage( $alias );
        }
 
@@ -184,20 +196,24 @@ class SpecialPage {
         * Return categorised listable special pages which are available
         * for the current user, and everyone.
         *
-        * @return Associative array mapping page's name to its SpecialPage object
+        * @param $user User object to check permissions, $wgUser will be used
+        *              if not provided
+        * @return array Associative array mapping page's name to its SpecialPage object
         * @deprecated since 1.18 call SpecialPageFactory method directly
         */
-       static function getUsablePages() {
-               return SpecialPageFactory::getUsablePages();
+       static function getUsablePages( User $user = null ) {
+               wfDeprecated( __METHOD__, '1.18' );
+               return SpecialPageFactory::getUsablePages( $user );
        }
 
        /**
         * Return categorised listable special pages for all users
         *
-        * @return Associative array mapping page's name to its SpecialPage object
+        * @return array Associative array mapping page's name to its SpecialPage object
         * @deprecated since 1.18 call SpecialPageFactory method directly
         */
        static function getRegularPages() {
+               wfDeprecated( __METHOD__, '1.18' );
                return SpecialPageFactory::getRegularPages();
        }
 
@@ -205,10 +221,11 @@ class SpecialPage {
         * Return categorised listable special pages which are available
         * for the current user, but not for everyone
         *
-        * @return Associative array mapping page's name to its SpecialPage object
+        * @return array Associative array mapping page's name to its SpecialPage object
         * @deprecated since 1.18 call SpecialPageFactory method directly
         */
        static function getRestrictedPages() {
+               wfDeprecated( __METHOD__, '1.18' );
                return SpecialPageFactory::getRestrictedPages();
        }
 
@@ -221,26 +238,16 @@ class SpecialPage {
         * page, and true if it was successful.
         *
         * @param $title          Title object
-        * @param $context        RequestContext
+        * @param $context        IContextSource
         * @param $including      Bool output is being captured for use in {{special:whatever}}
+        * @return Bool
         * @deprecated since 1.18 call SpecialPageFactory method directly
         */
-       public static function executePath( &$title, RequestContext &$context, $including = false ) {
+       public static function executePath( &$title, IContextSource &$context, $including = false ) {
+               wfDeprecated( __METHOD__, '1.18' );
                return SpecialPageFactory::executePath( $title, $context, $including );
        }
 
-       /**
-        * Just like executePath() except it returns the HTML instead of outputting it
-        * Returns false if there was no such special page, or a title object if it was
-        * a redirect.
-        *
-        * @return String: HTML fragment
-        * @deprecated since 1.18 call SpecialPageFactory method directly
-        */
-       static function capturePath( &$title ) {
-               return SpecialPageFactory::capturePath( $title );
-       }
-
        /**
         * Get the local name for a specified canonical name
         *
@@ -251,12 +258,15 @@ class SpecialPage {
         * @deprecated since 1.18 call SpecialPageFactory method directly
         */
        static function getLocalNameFor( $name, $subpage = false ) {
+               wfDeprecated( __METHOD__, '1.18' );
                return SpecialPageFactory::getLocalNameFor( $name, $subpage );
        }
 
        /**
         * Get a localised Title object for a specified special page name
         *
+        * @param $name String
+        * @param $subpage String|Bool subpage string, or false to not use a subpage
         * @return Title object
         */
        public static function getTitleFor( $name, $subpage = false ) {
@@ -271,6 +281,8 @@ class SpecialPage {
        /**
         * Get a localised Title object for a page name with a possibly unvalidated subpage
         *
+        * @param $name String
+        * @param $subpage String|Bool subpage string, or false to not use a subpage
         * @return Title object or null if the page doesn't exist
         */
        public static function getSafeTitleFor( $name, $subpage = false ) {
@@ -285,10 +297,12 @@ class SpecialPage {
        /**
         * Get a title for a given alias
         *
+        * @param $alias String
         * @return Title or null if there is no such alias
         * @deprecated since 1.18 call SpecialPageFactory method directly
         */
        static function getTitleForAlias( $alias ) {
+               wfDeprecated( __METHOD__, '1.18' );
                return SpecialPageFactory::getTitleForAlias( $alias );
        }
 
@@ -304,19 +318,27 @@ class SpecialPage {
         *
         * @param $name String: name of the special page, as seen in links and URLs
         * @param $restriction String: user right required, e.g. "block" or "delete"
-        * @param $listed Boolean: whether the page is listed in Special:Specialpages
-        * @param $function Callback: function called by execute(). By default it is constructed from $name
+        * @param $listed Bool: whether the page is listed in Special:Specialpages
+        * @param $function Callback|Bool: function called by execute(). By default it is constructed from $name
         * @param $file String: file which is included by execute(). It is also constructed from $name by default
-        * @param $includable Boolean: whether the page can be included in normal pages
+        * @param $includable Bool: whether the page can be included in normal pages
         */
-       public function __construct( $name = '', $restriction = '', $listed = true, $function = false, $file = 'default', $includable = false ) {
+       public function __construct(
+               $name = '', $restriction = '', $listed = true,
+               $function = false, $file = 'default', $includable = false
+       ) {
                $this->init( $name, $restriction, $listed, $function, $file, $includable );
        }
 
        /**
         * Do the real work for the constructor, mainly so __call() can intercept
         * calls to SpecialPage()
-        * @see __construct() for param docs
+        * @param $name String: name of the special page, as seen in links and URLs
+        * @param $restriction String: user right required, e.g. "block" or "delete"
+        * @param $listed Bool: whether the page is listed in Special:Specialpages
+        * @param $function Callback|Bool: function called by execute(). By default it is constructed from $name
+        * @param $file String: file which is included by execute(). It is also constructed from $name by default
+        * @param $includable Bool: whether the page can be included in normal pages
         */
        private function init( $name, $restriction, $listed, $function, $file, $includable ) {
                $this->mName = $name;
@@ -324,12 +346,12 @@ class SpecialPage {
                $this->mListed = $listed;
                $this->mIncludable = $includable;
                if ( !$function ) {
-                       $this->mFunction = 'wfSpecial'.$name;
+                       $this->mFunction = 'wfSpecial' . $name;
                } else {
                        $this->mFunction = $function;
                }
                if ( $file === 'default' ) {
-                       $this->mFile = dirname(__FILE__) . "/specials/Special$name.php";
+                       $this->mFile = dirname( __FILE__ ) . "/specials/Special$name.php";
                } else {
                        $this->mFile = $file;
                }
@@ -344,11 +366,11 @@ class SpecialPage {
         * @deprecated since 1.17, call parent::__construct()
         */
        public function __call( $fName, $a ) {
-               // Sometimes $fName is SpecialPage, sometimes it's specialpage. <3 PHP
-               if( strtolower( $fName ) == 'specialpage' ) {
-                       // Deprecated messages now, remove in 1.19 or 1.20?
-                       wfDeprecated( __METHOD__ );
+               // Deprecated messages now, remove in 1.19 or 1.20?
+               wfDeprecated( __METHOD__, '1.17' );
 
+               // Sometimes $fName is SpecialPage, sometimes it's specialpage. <3 PHP
+               if ( strtolower( $fName ) == 'specialpage' ) {
                        $name = isset( $a[0] ) ? $a[0] : '';
                        $restriction = isset( $a[1] ) ? $a[1] : '';
                        $listed = isset( $a[2] ) ? $a[2] : true;
@@ -386,6 +408,7 @@ class SpecialPage {
         * @deprecated since 1.18
         */
        function getFile() {
+               wfDeprecated( __METHOD__, '1.18' );
                return $this->mFile;
        }
 
@@ -401,6 +424,7 @@ class SpecialPage {
        /**
         * Set whether this page is listed in Special:Specialpages, at run-time
         * @since r3583 (v1.3)
+        * @param $listed Bool
         * @return Bool
         */
        function setListed( $listed ) {
@@ -409,9 +433,10 @@ class SpecialPage {
        /**
         * Get or set whether this special page is listed in Special:SpecialPages
         * @since r11308 (v1.6)
+        * @param $x Bool
         * @return Bool
         */
-       function listed( $x = null) {
+       function listed( $x = null ) {
                return wfSetVar( $this->mListed, $x );
        }
 
@@ -419,23 +444,58 @@ class SpecialPage {
         * Whether it's allowed to transclude the special page via {{Special:Foo/params}}
         * @return Bool
         */
-       public function isIncludable(){
+       public function isIncludable() {
                return $this->mIncludable;
        }
 
        /**
         * These mutators are very evil, as the relevant variables should not mutate.  So
         * don't use them.
+        * @param $x Mixed
+        * @return Mixed
         * @deprecated since 1.18
         */
-       function name( $x = null ) { return wfSetVar( $this->mName, $x ); }
-       function restriction( $x = null) { return wfSetVar( $this->mRestriction, $x ); }
-       function func( $x = null) { return wfSetVar( $this->mFunction, $x ); }
-       function file( $x = null) { return wfSetVar( $this->mFile, $x ); }
-       function includable( $x = null ) { return wfSetVar( $this->mIncludable, $x ); }
+       function name( $x = null ) { wfDeprecated( __METHOD__, '1.18' ); return wfSetVar( $this->mName, $x ); }
+
+       /**
+        * These mutators are very evil, as the relevant variables should not mutate.  So
+        * don't use them.
+        * @param $x Mixed
+        * @return Mixed
+        * @deprecated since 1.18
+        */
+       function restriction( $x = null ) { wfDeprecated( __METHOD__, '1.18' ); return wfSetVar( $this->mRestriction, $x ); }
+
+       /**
+        * These mutators are very evil, as the relevant variables should not mutate.  So
+        * don't use them.
+        * @param $x Mixed
+        * @return Mixed
+        * @deprecated since 1.18
+        */
+       function func( $x = null ) { wfDeprecated( __METHOD__, '1.18' ); return wfSetVar( $this->mFunction, $x ); }
+
+       /**
+        * These mutators are very evil, as the relevant variables should not mutate.  So
+        * don't use them.
+        * @param $x Mixed
+        * @return Mixed
+        * @deprecated since 1.18
+        */
+       function file( $x = null ) { wfDeprecated( __METHOD__, '1.18' ); return wfSetVar( $this->mFile, $x ); }
+
+       /**
+        * These mutators are very evil, as the relevant variables should not mutate.  So
+        * don't use them.
+        * @param $x Mixed
+        * @return Mixed
+        * @deprecated since 1.18
+        */
+       function includable( $x = null ) { wfDeprecated( __METHOD__, '1.18' ); return wfSetVar( $this->mIncludable, $x ); }
 
        /**
         * Whether the special page is being evaluated via transclusion
+        * @param $x Bool
         * @return Bool
         */
        function including( $x = null ) {
@@ -474,7 +534,7 @@ class SpecialPage {
        public function isRestricted() {
                global $wgGroupPermissions;
                // DWIM: If all anons can do something, then it is not restricted
-               return $this->mRestriction != '' && empty($wgGroupPermissions['*'][$this->mRestriction]);
+               return $this->mRestriction != '' && empty( $wgGroupPermissions['*'][$this->mRestriction] );
        }
 
        /**
@@ -496,6 +556,29 @@ class SpecialPage {
                throw new PermissionsError( $this->mRestriction );
        }
 
+       /**
+        * Checks if userCanExecute, and if not throws a PermissionsError
+        *
+        * @since 1.19
+        */
+       public function checkPermissions() {
+               if ( !$this->userCanExecute( $this->getUser() ) ) {
+                       $this->displayRestrictionError();
+               }
+       }
+
+       /**
+        * If the wiki is currently in readonly mode, throws a ReadOnlyError
+        *
+        * @since 1.19
+        * @throws ReadOnlyError
+        */
+       public function checkReadOnly() {
+               if ( wfReadOnly() ) {
+                       throw new ReadOnlyError;
+               }
+       }
+
        /**
         * Sets headers - this should be called from the execute() method of all derived classes!
         */
@@ -511,21 +594,20 @@ class SpecialPage {
         * Checks user permissions, calls the function given in mFunction
         *
         * This must be overridden by subclasses; it will be made abstract in a future version
+        *
+        * @param $par String subpage string, if one was specified
         */
        function execute( $par ) {
                $this->setHeaders();
+               $this->checkPermissions();
 
-               if ( $this->userCanExecute( $this->getUser() ) ) {
-                       $func = $this->mFunction;
-                       // only load file if the function does not exist
-                       if(!is_callable($func) and $this->mFile) {
-                               require_once( $this->mFile );
-                       }
-                       $this->outputHeader();
-                       call_user_func( $func, $par, $this );
-               } else {
-                       $this->displayRestrictionError();
+               $func = $this->mFunction;
+               // only load file if the function does not exist
+               if ( !is_callable( $func ) && $this->mFile ) {
+                       require_once( $this->mFile );
                }
+               $this->outputHeader();
+               call_user_func( $func, $par, $this );
        }
 
        /**
@@ -539,13 +621,14 @@ class SpecialPage {
        function outputHeader( $summaryMessageKey = '' ) {
                global $wgContLang;
 
-               if( $summaryMessageKey == '' ) {
+               if ( $summaryMessageKey == '' ) {
                        $msg = $wgContLang->lc( $this->getName() ) . '-summary';
                } else {
                        $msg = $summaryMessageKey;
                }
-               if ( !wfMessage( $msg )->isBlank() and ! $this->including() ) {
-                       $this->getOutput()->wrapWikiMsg( "<div class='mw-specialpage-summary'>\n$1\n</div>", $msg );
+               if ( !$this->msg( $msg )->isDisabled() && !$this->including() ) {
+                       $this->getOutput()->wrapWikiMsg(
+                               "<div class='mw-specialpage-summary'>\n$1\n</div>", $msg );
                }
 
        }
@@ -561,12 +644,13 @@ class SpecialPage {
         * @return String
         */
        function getDescription() {
-               return wfMsg( strtolower( $this->mName ) );
+               return $this->msg( strtolower( $this->mName ) )->text();
        }
 
        /**
         * Get a self-referential title object
         *
+        * @param $subpage String|Bool
         * @return Title object
         */
        function getTitle( $subpage = false ) {
@@ -576,7 +660,7 @@ class SpecialPage {
        /**
         * Sets the context this SpecialPage is executed in
         *
-        * @param $context RequestContext
+        * @param $context IContextSource
         * @since 1.18
         */
        public function setContext( $context ) {
@@ -586,11 +670,11 @@ class SpecialPage {
        /**
         * Gets the context this SpecialPage is executed in
         *
-        * @return RequestContext
+        * @return IContextSource|RequestContext
         * @since 1.18
         */
        public function getContext() {
-               if ( $this->mContext instanceof RequestContext ) {
+               if ( $this->mContext instanceof IContextSource ) {
                        return $this->mContext;
                } else {
                        wfDebug( __METHOD__ . " called and \$mContext is null. Return RequestContext::getMain(); for sanity\n" );
@@ -619,7 +703,7 @@ class SpecialPage {
        }
 
        /**
-        * Shortcut to get the skin being used for this instance
+        * Shortcut to get the User executing this instance
         *
         * @return User
         * @since 1.18
@@ -641,11 +725,23 @@ class SpecialPage {
        /**
         * Shortcut to get user's language
         *
+        * @deprecated 1.19 Use getLanguage instead
         * @return Language
-        * @since 1.19
+        * @since 1.18
         */
        public function getLang() {
-               return $this->getContext()->getLang();
+               wfDeprecated( __METHOD__, '1.19' );
+               return $this->getLanguage();
+       }
+
+       /**
+        * Shortcut to get user's language
+        *
+        * @return Language
+        * @since 1.19
+        */
+       public function getLanguage() {
+               return $this->getContext()->getLanguage();
        }
 
        /**
@@ -659,13 +755,26 @@ class SpecialPage {
        }
 
        /**
-        * Wrapper around wfMessage that sets the current context. Currently this
-        * is only the title.
+        * Wrapper around wfMessage that sets the current context.
         *
+        * @return Message
         * @see wfMessage
         */
        public function msg( /* $args */ ) {
-               return call_user_func_array( 'wfMessage', func_get_args() )->title( $this->getFullTitle() );
+               // Note: can't use func_get_args() directly as second or later item in
+               // a parameter list until PHP 5.3 or you get a fatal error.
+               // Works fine as the first parameter, which appears elsewhere in the
+               // code base. Sighhhh.
+               $args = func_get_args();
+               $message = call_user_func_array( array( $this->getContext(), 'msg' ), $args );
+               // RequestContext passes context to wfMessage, and the language is set from
+               // the context, but setting the language for Message class removes the
+               // interface message status, which breaks for example usernameless gender
+               // invokations. Restore the flag when not including special page in content.
+               if ( $this->including() ) {
+                       $message->setInterfaceMessageFlag( false );
+               }
+               return $message;
        }
 
        /**
@@ -674,14 +783,14 @@ class SpecialPage {
         * @param $params array
         */
        protected function addFeedLinks( $params ) {
-               global $wgFeedClasses, $wgOut;
+               global $wgFeedClasses;
 
                $feedTemplate = wfScript( 'api' ) . '?';
 
-               foreach( $wgFeedClasses as $format => $class ) {
+               foreach ( $wgFeedClasses as $format => $class ) {
                        $theseParams = $params + array( 'feedformat' => $format );
                        $url = $feedTemplate . wfArrayToCGI( $theseParams );
-                       $wgOut->addFeedLink( $format, $url );
+                       $this->getOutput()->addFeedLink( $format, $url );
                }
        }
 }
@@ -719,16 +828,15 @@ abstract class FormSpecialPage extends SpecialPage {
        protected function getForm() {
                $this->fields = $this->getFormFields();
 
-               // Give hooks a chance to alter the form, adding extra fields or text etc
-               wfRunHooks( "Special{$this->getName()}ModifyFormFields", array( &$this->fields ) );
-
                $form = new HTMLForm( $this->fields, $this->getContext() );
                $form->setSubmitCallback( array( $this, 'onSubmit' ) );
-               $form->setWrapperLegend( wfMessage( strtolower( $this->getName() ) . '-legend' ) );
-               $form->addHeaderText( wfMessage( strtolower( $this->getName() ) . '-text' )->parseAsBlock() );
+               $form->setWrapperLegend( $this->msg( strtolower( $this->getName() ) . '-legend' ) );
+               $form->addHeaderText(
+                       $this->msg( strtolower( $this->getName() ) . '-text' )->parseAsBlock() );
 
                // Retain query parameters (uselang etc)
-               $params = array_diff_key( $this->getRequest()->getQueryValues(), array( 'title' => null ) );
+               $params = array_diff_key(
+                       $this->getRequest()->getQueryValues(), array( 'title' => null ) );
                $form->addHiddenField( 'redirectparams', wfArrayToCGI( $params ) );
 
                $form->addPreText( $this->preText() );
@@ -756,13 +864,15 @@ abstract class FormSpecialPage extends SpecialPage {
 
        /**
         * Basic SpecialPage workflow: get a form, send it to the user; get some data back,
+        *
+        * @param $par String 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->userCanExecute( $this->getUser() );
+               $this->checkExecutePermissions( $this->getUser() );
 
                $form = $this->getForm();
                if ( $form->show() ) {
@@ -774,30 +884,27 @@ abstract class FormSpecialPage extends SpecialPage {
         * Maybe do something interesting with the subpage parameter
         * @param $par String
         */
-       protected function setParameter( $par ){}
+       protected function setParameter( $par ) {}
 
        /**
-        * Checks if the given user (identified by an object) can perform this action.  Can be
-        * overridden by sub-classes with more complicated permissions schemes.  Failures here
-        * must throw subclasses of ErrorPageError
-        *
-        * @param $user User: the user to check, or null to use the context user
+        * Called from execute() to check if the given user can perform this action.
+        * Failures here must throw subclasses of ErrorPageError.
+        * @param $user User
+        * @return Bool true
         * @throws ErrorPageError
         */
-       public function userCanExecute( User $user ) {
-               if ( $this->requiresWrite() && wfReadOnly() ) {
-                       throw new ReadOnlyError();
-               }
-
-               if ( $this->getRestriction() !== null && !$user->isAllowed( $this->getRestriction() ) ) {
-                       throw new PermissionsError( $this->getRestriction() );
-               }
+       protected function checkExecutePermissions( User $user ) {
+               $this->checkPermissions();
 
                if ( $this->requiresUnblock() && $user->isBlocked() ) {
-                       $block = $user->mBlock;
+                       $block = $user->getBlock();
                        throw new UserBlockedError( $block );
                }
 
+               if ( $this->requiresWrite() ) {
+                       $this->checkReadOnly();
+               }
+
                return true;
        }
 
@@ -822,13 +929,12 @@ abstract class FormSpecialPage extends SpecialPage {
  * Shortcut to construct a special page which is unlisted by default
  * @ingroup SpecialPage
  */
-class UnlistedSpecialPage extends SpecialPage
-{
+class UnlistedSpecialPage extends SpecialPage {
        function __construct( $name, $restriction = '', $function = false, $file = 'default' ) {
                parent::__construct( $name, $restriction, false, $function, $file );
        }
 
-       public function isListed(){
+       public function isListed() {
                return false;
        }
 }
@@ -837,13 +943,14 @@ class UnlistedSpecialPage extends SpecialPage
  * Shortcut to construct an includable special  page
  * @ingroup SpecialPage
  */
-class IncludableSpecialPage extends SpecialPage
-{
-       function __construct( $name, $restriction = '', $listed = true, $function = false, $file = 'default' ) {
+class IncludableSpecialPage extends SpecialPage {
+       function __construct(
+               $name, $restriction = '', $listed = true, $function = false, $file = 'default'
+       ) {
                parent::__construct( $name, $restriction, $listed, $function, $file, true );
        }
 
-       public function isIncludable(){
+       public function isIncludable() {
                return true;
        }
 }
@@ -860,7 +967,7 @@ abstract class RedirectSpecialPage extends UnlistedSpecialPage {
        // Query parameteres added by redirects
        protected $mAddedRedirectParams = array();
 
-       public function execute( $par ){
+       public function execute( $par ) {
                $redirect = $this->getRedirect( $par );
                $query = $this->getRedirectQuery();
                // Redirect to a page title with possible query parameters
@@ -886,7 +993,8 @@ abstract class RedirectSpecialPage extends UnlistedSpecialPage {
         * If the special page is a redirect, then get the Title object it redirects to.
         * False otherwise.
         *
-        * @return Title|false
+        * @param $par String Subpage string
+        * @return Title|bool
         */
        abstract public function getRedirect( $par );
 
@@ -899,13 +1007,13 @@ abstract class RedirectSpecialPage extends UnlistedSpecialPage {
        public function getRedirectQuery() {
                $params = array();
 
-               foreach( $this->mAllowedRedirectParams as $arg ) {
-                       if( $this->getRequest()->getVal( $arg, null ) !== null ){
+               foreach ( $this->mAllowedRedirectParams as $arg ) {
+                       if ( $this->getRequest()->getVal( $arg, null ) !== null ) {
                                $params[$arg] = $this->getRequest()->getVal( $arg );
                        }
                }
 
-               foreach( $this->mAddedRedirectParams as $arg => $val ) {
+               foreach ( $this->mAddedRedirectParams as $arg => $val ) {
                        $params[$arg] = $val;
                }
 
@@ -916,10 +1024,12 @@ abstract class RedirectSpecialPage extends UnlistedSpecialPage {
 }
 
 abstract class SpecialRedirectToSpecial extends RedirectSpecialPage {
-
        var $redirName, $redirSubpage;
 
-       function __construct( $name, $redirName, $redirSubpage = false, $allowedRedirectParams = array(), $addedRedirectParams = array() ) {
+       function __construct(
+               $name, $redirName, $redirSubpage = false,
+               $allowedRedirectParams = array(), $addedRedirectParams = array()
+       ) {
                parent::__construct( $name );
                $this->redirName = $redirName;
                $this->redirSubpage = $redirSubpage;
@@ -937,20 +1047,20 @@ abstract class SpecialRedirectToSpecial extends RedirectSpecialPage {
 }
 
 /**
- * ListAdmins --> ListUsers/admin
+ * ListAdmins --> ListUsers/sysop
  */
 class SpecialListAdmins extends SpecialRedirectToSpecial {
-       function __construct(){
-               parent::__construct( 'ListAdmins', 'ListUsers', 'sysop' );
+       function __construct() {
+               parent::__construct( 'Listadmins', 'Listusers', 'sysop' );
        }
 }
 
 /**
- * ListBots --> ListUsers/admin
+ * ListBots --> ListUsers/bot
  */
 class SpecialListBots extends SpecialRedirectToSpecial {
-       function __construct(){
-               parent::__construct( 'ListAdmins', 'ListUsers', 'bot' );
+       function __construct() {
+               parent::__construct( 'Listbots', 'Listusers', 'bot' );
        }
 }
 
@@ -959,7 +1069,7 @@ class SpecialListBots extends SpecialRedirectToSpecial {
  * @todo FIXME: This (and the rest of the login frontend) needs to die a horrible painful death
  */
 class SpecialCreateAccount extends SpecialRedirectToSpecial {
-       function __construct(){
+       function __construct() {
                parent::__construct( 'CreateAccount', 'Userlogin', 'signup', array( 'uselang' ) );
        }
 }
@@ -978,16 +1088,17 @@ class SpecialCreateAccount extends SpecialRedirectToSpecial {
 class SpecialMypage extends RedirectSpecialPage {
        function __construct() {
                parent::__construct( 'Mypage' );
-               $this->mAllowedRedirectParams = array( 'action' , 'preload' , 'editintro',
-                       'section', 'oldid', 'diff', 'dir' );
+               $this->mAllowedRedirectParams = array( 'action', 'preload', 'preloadtitle', 'editintro',
+                       'section', 'oldid', 'diff', 'dir',
+                       // Options for action=raw; missing ctype can break JS or CSS in some browsers
+                       'ctype', 'maxage', 'smaxage' );
        }
 
        function getRedirect( $subpage ) {
-               global $wgUser;
                if ( strval( $subpage ) !== '' ) {
-                       return Title::makeTitle( NS_USER, $wgUser->getName() . '/' . $subpage );
+                       return Title::makeTitle( NS_USER, $this->getUser()->getName() . '/' . $subpage );
                } else {
-                       return Title::makeTitle( NS_USER, $wgUser->getName() );
+                       return Title::makeTitle( NS_USER, $this->getUser()->getName() );
                }
        }
 }
@@ -999,16 +1110,15 @@ class SpecialMypage extends RedirectSpecialPage {
 class SpecialMytalk extends RedirectSpecialPage {
        function __construct() {
                parent::__construct( 'Mytalk' );
-               $this->mAllowedRedirectParams = array( 'action' , 'preload' , 'editintro',
+               $this->mAllowedRedirectParams = array( 'action', 'preload', 'preloadtitle', 'editintro',
                        'section', 'oldid', 'diff', 'dir' );
        }
 
        function getRedirect( $subpage ) {
-               global $wgUser;
                if ( strval( $subpage ) !== '' ) {
-                       return Title::makeTitle( NS_USER_TALK, $wgUser->getName() . '/' . $subpage );
+                       return Title::makeTitle( NS_USER_TALK, $this->getUser()->getName() . '/' . $subpage );
                } else {
-                       return Title::makeTitle( NS_USER_TALK, $wgUser->getName() );
+                       return Title::makeTitle( NS_USER_TALK, $this->getUser()->getName() );
                }
        }
 }
@@ -1025,8 +1135,7 @@ class SpecialMycontributions extends RedirectSpecialPage {
        }
 
        function getRedirect( $subpage ) {
-               global $wgUser;
-               return SpecialPage::getTitleFor( 'Contributions', $wgUser->getName() );
+               return SpecialPage::getTitleFor( 'Contributions', $this->getUser()->getName() );
        }
 }
 
@@ -1040,8 +1149,7 @@ class SpecialMyuploads extends RedirectSpecialPage {
        }
 
        function getRedirect( $subpage ) {
-               global $wgUser;
-               return SpecialPage::getTitleFor( 'Listfiles', $wgUser->getName() );
+               return SpecialPage::getTitleFor( 'Listfiles', $this->getUser()->getName() );
        }
 }
 
@@ -1056,6 +1164,10 @@ class SpecialPermanentLink extends RedirectSpecialPage {
 
        function getRedirect( $subpage ) {
                $subpage = intval( $subpage );
+               if ( $subpage === 0 ) {
+                       # throw an error page when no subpage was given
+                       throw new ErrorPageError( 'nopagetitle', 'nopagetext' );
+               }
                $this->mAddedRedirectParams['oldid'] = $subpage;
                return true;
        }