Move rewRevisionFromEditComplete call down till after page rows set
[lhc/web/wiklou.git] / includes / SpecialPage.php
index 9125f37..7cb791a 100644 (file)
@@ -2,32 +2,30 @@
 /**
  * SpecialPage: handling special pages and lists thereof.
  *
- * 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. 
+ * 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.
  *
- * 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 
+ * 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.
  *
- * To add a core special page, use the similar static list in 
+ * 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.
  *
- * @addtogroup SpecialPage
- */
-
-/**
- * @access private
+ * @file
+ * @ingroup SpecialPage
+ * @defgroup SpecialPage SpecialPage
  */
 
 /**
  * Parent special page class, also static functions for handling the special
  * page list.
- * @addtogroup SpecialPage
+ * @ingroup SpecialPage
  */
 class SpecialPage
 {
@@ -72,7 +70,15 @@ class SpecialPage
         * Query parameters that can be passed through redirects
         */
        var $mAllowedRedirectParams = array();
-
+       /**
+        * List of special pages, followed by parameters.
+        * If the only parameter is a string, that is the page name.
+        * Otherwise, it is an array. The format is one of:
+        ** array( 'SpecialPage', name, right )
+        ** array( 'IncludableSpecialPage', name, right, listed? )
+        ** array( 'UnlistedSpecialPage', name, right )
+        ** array( 'SpecialRedirectToSpecial', name, page to redirect to, special page param, ... )
+        */
        static public $mList = array(
                'DoubleRedirects'           => array( 'SpecialPage', 'DoubleRedirects' ),
                'BrokenRedirects'           => array( 'SpecialPage', 'BrokenRedirects' ),
@@ -80,6 +86,7 @@ class SpecialPage
 
                'Userlogin'                 => array( 'SpecialPage', 'Userlogin' ),
                'Userlogout'                => array( 'UnlistedSpecialPage', 'Userlogout' ),
+               'CreateAccount'             => array( 'SpecialRedirectToSpecial', 'CreateAccount', 'Userlogin', 'signup', array( 'uselang' ) ),
                'Preferences'               => array( 'SpecialPage', 'Preferences' ),
                'Watchlist'                 => array( 'SpecialPage', 'Watchlist' ),
 
@@ -88,8 +95,9 @@ class SpecialPage
                'Imagelist'                 => array( 'SpecialPage', 'Imagelist' ),
                'Newimages'                 => array( 'IncludableSpecialPage', 'Newimages' ),
                'Listusers'                 => array( 'SpecialPage', 'Listusers' ),
+               'Listgrouprights'           => 'SpecialListGroupRights',
                'Statistics'                => array( 'SpecialPage', 'Statistics' ),
-               'Randompage'                => array( 'SpecialPage', 'Randompage' ),
+               'Randompage'                => 'Randompage',
                'Lonelypages'               => array( 'SpecialPage', 'Lonelypages' ),
                'Uncategorizedpages'        => array( 'SpecialPage', 'Uncategorizedpages' ),
                'Uncategorizedcategories'   => array( 'SpecialPage', 'Uncategorizedcategories' ),
@@ -112,6 +120,7 @@ class SpecialPage
                'Ancientpages'              => array( 'SpecialPage', 'Ancientpages' ),
                'Deadendpages'              => array( 'SpecialPage', 'Deadendpages' ),
                'Protectedpages'            => array( 'SpecialPage', 'Protectedpages' ),
+               'Protectedtitles'           => array( 'SpecialPage', 'Protectedtitles' ),
                'Allpages'                  => array( 'IncludableSpecialPage', 'Allpages' ),
                'Prefixindex'               => array( 'IncludableSpecialPage', 'Prefixindex' ) ,
                'Ipblocklist'               => array( 'SpecialPage', 'Ipblocklist' ),
@@ -119,7 +128,7 @@ class SpecialPage
                'Contributions'             => array( 'SpecialPage', 'Contributions' ),
                'Emailuser'                 => array( 'UnlistedSpecialPage', 'Emailuser' ),
                'Whatlinkshere'             => array( 'SpecialPage', 'Whatlinkshere' ),
-               'Recentchangeslinked'       => array( 'UnlistedSpecialPage', 'Recentchangeslinked' ),
+               'Recentchangeslinked'       => array( 'SpecialPage', 'Recentchangeslinked' ),
                'Movepage'                  => array( 'UnlistedSpecialPage', 'Movepage' ),
                'Blockme'                   => array( 'UnlistedSpecialPage', 'Blockme' ),
                'Resetpass'                 => array( 'UnlistedSpecialPage', 'Resetpass' ),
@@ -131,22 +140,26 @@ class SpecialPage
                'Log'                       => array( 'SpecialPage', 'Log' ),
                'Blockip'                   => array( 'SpecialPage', 'Blockip', 'block' ),
                'Undelete'                  => array( 'SpecialPage', 'Undelete', 'deletedhistory' ),
-               'Import'                    => array( 'SpecialPage', "Import", 'import' ),
+               'Import'                    => array( 'SpecialPage', 'Import', 'import' ),
                'Lockdb'                    => array( 'SpecialPage', 'Lockdb', 'siteadmin' ),
                'Unlockdb'                  => array( 'SpecialPage', 'Unlockdb', 'siteadmin' ),
-               'Userrights'                => array( 'SpecialPage', 'Userrights', 'userrights' ),
+               'Userrights'                => 'UserrightsPage',
                'MIMEsearch'                => array( 'SpecialPage', 'MIMEsearch' ),
+               'FileDuplicateSearch'       => array( 'SpecialPage', 'FileDuplicateSearch' ),
                'Unwatchedpages'            => array( 'SpecialPage', 'Unwatchedpages', 'unwatchedpages' ),
                'Listredirects'             => array( 'SpecialPage', 'Listredirects' ),
-               'Revisiondelete'            => array( 'SpecialPage', 'Revisiondelete', 'deleterevision' ),
+               'Revisiondelete'            => array( 'UnlistedSpecialPage', 'Revisiondelete', 'deleterevision' ),
                'Unusedtemplates'           => array( 'SpecialPage', 'Unusedtemplates' ),
-               'Randomredirect'            => array( 'SpecialPage', 'Randomredirect' ),
+               'Randomredirect'            => 'SpecialRandomredirect',
                'Withoutinterwiki'          => array( 'SpecialPage', 'Withoutinterwiki' ),
+               'Filepath'                  => array( 'SpecialPage', 'Filepath' ),
 
                'Mypage'                    => array( 'SpecialMypage' ),
                'Mytalk'                    => array( 'SpecialMytalk' ),
                'Mycontributions'           => array( 'SpecialMycontributions' ),
                'Listadmins'                => array( 'SpecialRedirectToSpecial', 'Listadmins', 'Listusers', 'sysop' ),
+               'MergeHistory'              => array( 'SpecialPage', 'MergeHistory', 'mergehistory' ),
+               'Listbots'                  => array( 'SpecialRedirectToSpecial', 'Listbots', 'Listusers', 'bot' ),
        );
 
        static public $mAliases;
@@ -166,7 +179,7 @@ class SpecialPage
                        return;
                }
                wfProfileIn( __METHOD__ );
-               
+
                # Better to set this now, to avoid infinite recursion in carelessly written hooks
                self::$mListInitialised = true;
 
@@ -180,6 +193,7 @@ class SpecialPage
 
                if( $wgEmailAuthentication ) {
                        self::$mList['Confirmemail'] = 'EmailConfirmation';
+                       self::$mList['Invalidateemail'] = 'EmailInvalidation';
                }
 
                # Add extension special pages
@@ -229,7 +243,7 @@ class SpecialPage
        }
 
        /**
-        * Given a special page name with a possible subpage, return an array 
+        * Given a special page name with a possible subpage, return an array
         * where the first element is the special page name and the second is the
         * subpage.
         */
@@ -245,14 +259,11 @@ class SpecialPage
        }
 
        /**
-        * Add a page to the list of valid special pages. This used to be the preferred 
-        * method for adding special pages in extensions. It's now suggested that you add 
+        * Add a page to the list of valid special pages. This used to be the preferred
+        * method for adding special pages in extensions. It's now suggested that you add
         * an associative record to $wgSpecialPages. This avoids autoloading SpecialPage.
         *
-        * @param mixed $page Must either be an array specifying a class name and 
-        *                    constructor parameters, or an object. The object,
-        *                    when constructed, must have an execute() method which
-        *                    sends HTML to $wgOut.
+        * @param SpecialPage $page
         * @static
         */
        static function addPage( &$page ) {
@@ -262,11 +273,37 @@ class SpecialPage
                self::$mList[$page->mName] = $page;
        }
 
+       /**
+        * Add a page to a certain display group for Special:SpecialPages
+        *
+        * @param mixed $page (SpecialPage or string)
+        * @param string $group
+        * @static
+        */
+       static function setGroup( $page, $group ) {
+               global $wgSpecialPageGroups;
+               $name = is_object($page) ? $page->mName : $page;
+               $wgSpecialPageGroups[$name] = $group;
+       }
+
+       /**
+        * Add a page to a certain display group for Special:SpecialPages
+        *
+        * @param SpecialPage $page
+        * @static
+        */
+       static function getGroup( &$page ) {
+               global $wgSpecialPageGroups;
+               $group = isset($wgSpecialPageGroups[$page->mName]) ?
+                       $wgSpecialPageGroups[$page->mName] : 'other';
+               return $group;
+       }
+
        /**
         * Remove a special page from the list
-        * Formerly used to disable expensive or dangerous special pages. The 
+        * Formerly used to disable expensive or dangerous special pages. The
         * preferred method is now to add a SpecialPage_initList hook.
-        * 
+        *
         * @static
         */
        static function removePage( $name ) {
@@ -349,7 +386,7 @@ class SpecialPage
 
                foreach ( self::$mList as $name => $rec ) {
                        $page = self::getPage( $name );
-                       if ( $page->isListed() && $page->getRestriction() == '' ) {
+                       if ( $page->isListed() && !$page->isRestricted() ) {
                                $pages[$name] = $page;
                        }
                }
@@ -370,11 +407,12 @@ class SpecialPage
 
                foreach ( self::$mList as $name => $rec ) {
                        $page = self::getPage( $name );
-                       if ( $page->isListed() ) {
-                               $restriction = $page->getRestriction();
-                               if ( $restriction != '' && $wgUser->isAllowed( $restriction ) ) {
-                                       $pages[$name] = $page;
-                               }
+                       if (
+                               $page->isListed()
+                               and $page->isRestricted()
+                               and $page->userCanExecute( $wgUser )
+                       ) {
+                               $pages[$name] = $page;
                        }
                }
                return $pages;
@@ -404,7 +442,6 @@ class SpecialPage
                        $par = $bits[1];
                }
                $page = SpecialPage::getPageByAlias( $name );
-
                # Nonexistent?
                if ( !$page ) {
                        if ( !$including ) {
@@ -430,9 +467,9 @@ class SpecialPage
                }
 
                # Redirect to canonical alias for GET commands
-               # Not for POST, we'd lose the post data, so it's best to just distribute 
-               # the request. Such POST requests are possible for old extensions that 
-               # generate self-links without being aware that their default name has 
+               # Not for POST, we'd lose the post data, so it's best to just distribute
+               # the request. Such POST requests are possible for old extensions that
+               # generate self-links without being aware that their default name has
                # changed.
                if ( !$including && $name != $page->getLocalName() && !$wgRequest->wasPosted() ) {
                        $query = $_GET;
@@ -486,6 +523,11 @@ class SpecialPage
 
        /**
         * Get the local name for a specified canonical name
+        *
+        * @param $name
+        * @param mixed $subpage Boolean false, or string
+        *
+        * @return string
         */
        static function getLocalNameFor( $name, $subpage = false ) {
                global $wgContLang;
@@ -602,11 +644,26 @@ class SpecialPage
                return $this->mLocalName;
        }
 
+       /**
+        * Can be overridden by subclasses with more complicated permissions
+        * schemes.
+        *
+        * @return bool Should the page be displayed with the restricted-access
+        *   pages?
+        */
+       public function isRestricted() {
+               return $this->mRestriction != '';
+       }
+
        /**
         * Checks if the given user (identified by an object) can execute this
-        * special page (as defined by $mRestriction)
+        * special page (as defined by $mRestriction).  Can be overridden by sub-
+        * classes with more complicated permissions schemes.
+        *
+        * @param User $user The user to check
+        * @return bool Does the user have permission to view the page?
         */
-       function userCanExecute( &$user ) {
+       public function userCanExecute( $user ) {
                return $user->isAllowed( $this->mRestriction );
        }
 
@@ -632,7 +689,7 @@ class SpecialPage
         * Default execute method
         * Checks user permissions, calls the function given in mFunction
         *
-        * This may be overridden by subclasses. 
+        * This may be overridden by subclasses.
         */
        function execute( $par ) {
                global $wgUser;
@@ -642,15 +699,15 @@ class SpecialPage
                if ( $this->userCanExecute( $wgUser ) ) {
                        $func = $this->mFunction;
                        // only load file if the function does not exist
-                       if(!function_exists($func) and $this->mFile) {
+                       if(!is_callable($func) and $this->mFile) {
                                require_once( $this->mFile );
                        }
-                       # FIXME: these hooks are broken for extensions and anything else that subclasses SpecialPage. 
+                       # FIXME: these hooks are broken for extensions and anything else that subclasses SpecialPage.
                        if ( wfRunHooks( 'SpecialPageExecuteBeforeHeader', array( &$this, &$par, &$func ) ) )
                                $this->outputHeader();
                        if ( ! wfRunHooks( 'SpecialPageExecuteBeforePage', array( &$this, &$par, &$func ) ) )
                                return;
-                       $func( $par, $this );
+                       call_user_func( $func, $par, $this );
                        if ( ! wfRunHooks( 'SpecialPageExecuteAfterPage', array( &$this, &$par, &$func ) ) )
                                return;
                } else {
@@ -662,9 +719,10 @@ class SpecialPage
                global $wgOut, $wgContLang;
 
                $msg = $wgContLang->lc( $this->name() ) . '-summary';
-               $out = wfMsg( $msg );
-               if ( ! wfEmptyMsg( $msg, $out ) and  $out !== '' and ! $this->including() )
-                       $wgOut->addWikiText( $out );
+               $out = wfMsgNoTrans( $msg );
+               if ( ! wfEmptyMsg( $msg, $out ) and  $out !== '' and ! $this->including() ) {
+                       $wgOut->addWikiMsg( $msg );
+               }
 
        }
 
@@ -692,7 +750,7 @@ class SpecialPage
        }
 
        /**
-        * If the special page is a redirect, then get the Title object it redirects to. 
+        * If the special page is a redirect, then get the Title object it redirects to.
         * False otherwise.
         */
        function getRedirect( $subpage ) {
@@ -712,14 +770,14 @@ class SpecialPage
                        if( $val = $wgRequest->getVal( $arg, false ) )
                                $params[] = $arg . '=' . $val;
                }
-               
+
                return count( $params ) ? implode( '&', $params ) : false;
        }
 }
 
 /**
  * Shortcut to construct a special page which is unlisted by default
- * @addtogroup SpecialPage
+ * @ingroup SpecialPage
  */
 class UnlistedSpecialPage extends SpecialPage
 {
@@ -730,7 +788,7 @@ class UnlistedSpecialPage extends SpecialPage
 
 /**
  * Shortcut to construct an includable special  page
- * @addtogroup SpecialPage
+ * @ingroup SpecialPage
  */
 class IncludableSpecialPage extends SpecialPage
 {
@@ -741,7 +799,7 @@ class IncludableSpecialPage extends SpecialPage
 
 /**
  * Shortcut to construct a special page alias.
- * @addtogroup SpecialPage
+ * @ingroup SpecialPage
  */
 class SpecialRedirectToSpecial extends UnlistedSpecialPage {
        var $redirName, $redirSubpage;
@@ -771,12 +829,12 @@ class SpecialRedirectToSpecial extends UnlistedSpecialPage {
 
 /**
  * Shortcut to construct a special page pointing to current user user's page.
- * @addtogroup SpecialPage
+ * @ingroup SpecialPage
  */
 class SpecialMypage extends UnlistedSpecialPage {
        function __construct() {
                parent::__construct( 'Mypage' );
-               $this->mAllowedRedirectParams = array( 'action' );
+               $this->mAllowedRedirectParams = array( 'action' , 'preload' , 'editintro', 'section' );
        }
 
        function getRedirect( $subpage ) {
@@ -791,12 +849,12 @@ class SpecialMypage extends UnlistedSpecialPage {
 
 /**
  * Shortcut to construct a special page pointing to current user talk page.
- * @addtogroup SpecialPage
+ * @ingroup SpecialPage
  */
 class SpecialMytalk extends UnlistedSpecialPage {
        function __construct() {
                parent::__construct( 'Mytalk' );
-               $this->mAllowedRedirectParams = array( 'action' );
+               $this->mAllowedRedirectParams = array( 'action' , 'preload' , 'editintro', 'section' );
        }
 
        function getRedirect( $subpage ) {
@@ -811,7 +869,7 @@ class SpecialMytalk extends UnlistedSpecialPage {
 
 /**
  * Shortcut to construct a special page pointing to current user contributions.
- * @addtogroup SpecialPage
+ * @ingroup SpecialPage
  */
 class SpecialMycontributions extends UnlistedSpecialPage {
        function __construct() {
@@ -823,5 +881,3 @@ class SpecialMycontributions extends UnlistedSpecialPage {
                return SpecialPage::getTitleFor( 'Contributions', $wgUser->getName() );
        }
 }
-
-