FU 97704: I was thinking the space was already added in this case
[lhc/web/wiklou.git] / includes / SpecialPageFactory.php
index 21590f1..210c218 100644 (file)
@@ -25,6 +25,7 @@
 /**
  * Factory for handling the special page list and generating SpecialPage objects
  * @ingroup SpecialPage
+ * @since 1.17
  */
 class SpecialPageFactory {
 
@@ -125,6 +126,8 @@ class SpecialPageFactory {
                // Page tools
                'ComparePages'              => 'SpecialComparePages',
                'Export'                    => 'SpecialExport',
+               'GlobalFileUsage'           => 'SpecialGlobalFileUsage',
+               'GlobalTemplateUsage'       => 'SpecialGlobalTemplateUsage',
                'Import'                    => 'SpecialImport',
                'Undelete'                  => 'SpecialUndelete',
                'Whatlinkshere'             => 'SpecialWhatlinkshere',
@@ -159,6 +162,7 @@ class SpecialPageFactory {
        static function getList() {
                global $wgSpecialPages;
                global $wgDisableCounters, $wgDisableInternalSearch, $wgEmailAuthentication;
+               global $wgEnableEmail;
 
                if ( !is_object( self::$mList ) ) {
                        wfProfileIn( __METHOD__ );
@@ -176,6 +180,10 @@ class SpecialPageFactory {
                                self::$mList['Invalidateemail'] = 'EmailInvalidation';
                        }
 
+                       if ( $wgEnableEmail ) {
+                               self::$mList['ChangeEmail'] = 'SpecialChangeEmail';
+                       }
+
                        // Add extension special pages
                        self::$mList = array_merge( self::$mList, $wgSpecialPages );
 
@@ -192,7 +200,12 @@ class SpecialPageFactory {
        }
 
        /**
-        * @return array
+        * Initialise and return the list of special page aliases.  Returns an object with
+        * properties which can be accessed $obj->pagename - each property is an array of
+        * aliases; the first in the array is the cannonical alias.  All registered special
+        * pages are guaranteed to have a property entry, and for that property array to
+        * contain at least one entry (English fallbacks will be added if necessary).
+        * @return Object
         */
        static function getAliasList() {
                if ( !is_object( self::$mAliases ) ) {
@@ -251,38 +264,42 @@ class SpecialPageFactory {
        /**
         * Add a page to a certain display group for Special:SpecialPages
         *
-        * @param $page Mixed: SpecialPage or string
+        * @param $page SpecialPage|string
         * @param $group String
         */
        public static function setGroup( $page, $group ) {
                global $wgSpecialPageGroups;
-               $name = is_object( $page ) ? $page->mName : $page;
+               $name = is_object( $page ) ? $page->getName() : $page;
                $wgSpecialPageGroups[$name] = $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
         */
        public static function getGroup( &$page ) {
+               $name = $page->getName();
+
                global $wgSpecialPageGroups;
                static $specialPageGroupsCache = array();
-               if ( isset( $specialPageGroupsCache[$page->mName] ) ) {
-                       return $specialPageGroupsCache[$page->mName];
+               if ( isset( $specialPageGroupsCache[$name] ) ) {
+                       return $specialPageGroupsCache[$name];
                }
-               $msg = wfMessage( 'specialpages-specialpagegroup-' . strtolower( $page->mName ) );
+               $msg = wfMessage( 'specialpages-specialpagegroup-' . strtolower( $name ) );
                if ( !$msg->isBlank() ) {
                        $group = $msg->text();
                } else {
-                       $group = isset( $wgSpecialPageGroups[$page->mName] )
-                               ? $wgSpecialPageGroups[$page->mName]
+                       $group = isset( $wgSpecialPageGroups[$name] )
+                               ? $wgSpecialPageGroups[$name]
                                : '-';
                }
                if ( $group == '-' ) {
                        $group = 'other';
                }
-               $specialPageGroupsCache[$page->mName] = $group;
+               $specialPageGroupsCache[$name] = $group;
                return $group;
        }
 
@@ -309,7 +326,7 @@ class SpecialPageFactory {
                        $rec = self::getList()->$realName;
                        if ( is_string( $rec ) ) {
                                $className = $rec;
-                               self::getList()->$realName = new $className;
+                               return new $className;
                        } elseif ( is_array( $rec ) ) {
                                // @deprecated, officially since 1.18, unofficially since forever
                                wfDebug( "Array syntax for \$wgSpecialPages is deprecated, define a subclass of SpecialPage instead." );
@@ -392,15 +409,15 @@ class SpecialPageFactory {
         * 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
         */
-       public static function executePath( Title &$title, RequestContext &$context, $including = false ) {
+       public static function executePath( Title &$title, IContextSource &$context, $including = false ) {
                wfProfileIn( __METHOD__ );
 
-               // FIXME: redirects broken due to this call
+               // @todo FIXME: Redirects broken due to this call
                $bits = explode( '/', $title->getDBkey(), 2 );
                $name = $bits[0];
                if ( !isset( $bits[1] ) ) { // bug 2087
@@ -411,10 +428,10 @@ class SpecialPageFactory {
                $page = self::getPage( $name );
                // Nonexistent?
                if ( !$page ) {
-                       $context->output->setArticleRelated( false );
-                       $context->output->setRobotPolicy( 'noindex,nofollow' );
-                       $context->output->setStatusCode( 404 );
-                       $context->output->showErrorPage( 'nosuchspecialpage', 'nospecialpagetext' );
+                       $context->getOutput()->setArticleRelated( false );
+                       $context->getOutput()->setRobotPolicy( 'noindex,nofollow' );
+                       $context->getOutput()->setStatusCode( 404 );
+                       $context->getOutput()->showErrorPage( 'nosuchspecialpage', 'nospecialpagetext' );
                        wfProfileOut( __METHOD__ );
                        return false;
                }
@@ -428,17 +445,17 @@ class SpecialPageFactory {
                        // the request. Such POST requests are possible for old extensions that
                        // generate self-links without being aware that their default name has
                        // changed.
-                       if ( $name != $page->getLocalName() && !$context->request->wasPosted() ) {
-                               $query = $_GET;
+                       if ( $name != $page->getLocalName() && !$context->getRequest()->wasPosted() ) {
+                               $query = $context->getRequest()->getQueryValues();
                                unset( $query['title'] );
                                $query = wfArrayToCGI( $query );
                                $title = $page->getTitle( $par );
                                $url = $title->getFullUrl( $query );
-                               $context->output->redirect( $url );
+                               $context->getOutput()->redirect( $url );
                                wfProfileOut( __METHOD__ );
                                return $title;
                        } else {
-                               $context->title = $page->getTitle();
+                               $context->setTitle( $page->getTitle() );
                        }
 
                } elseif ( !$page->isIncludable() ) {
@@ -458,30 +475,47 @@ class SpecialPageFactory {
        }
 
        /**
-        * 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
+        * Just like executePath() but will override global variables and execute
+        * the page in "inclusion" mode. Returns true if the excution was successful
+        * or false if there was no such special page, or a title object if it was
         * a redirect.
         *
+        * Also saves the current $wgTitle, $wgOut, $wgRequest, $wgUser and $wgLang
+        * variables so that the special page will get the context it'd expect on a
+        * normal request, and then restores them to their previous values after.
+        *
         * @param $title Title
+        * @param $context IContextSource
         *
         * @return String: HTML fragment
         */
-       static function capturePath( &$title ) {
-               global $wgOut, $wgTitle;
+       static function capturePath( Title $title, IContextSource $context ) {
+               global $wgOut, $wgTitle, $wgRequest, $wgUser, $wgLang;
 
+               // Save current globals
                $oldTitle = $wgTitle;
                $oldOut = $wgOut;
+               $oldRequest = $wgRequest;
+               $oldUser = $wgUser;
+               $oldLang = $wgLang;
 
-               $context = new RequestContext;
-               $context->setTitle( $title );
+               // Set the globals to the current context
+               $wgTitle = $title;
                $wgOut = $context->getOutput();
+               $wgRequest = $context->getRequest();
+               $wgUser = $context->getUser();
+               $wgLang = $context->getLang();
 
+               // The useful part
                $ret = self::executePath( $title, $context, true );
-               if ( $ret === true ) {
-                       $ret = $wgOut->getHTML();
-               }
+
+               // And restore that globals
                $wgTitle = $oldTitle;
                $wgOut = $oldOut;
+               $wgRequest = $oldRequest;
+               $wgUser = $oldUser;
+               $wgLang = $oldLang;
+
                return $ret;
        }
 
@@ -496,6 +530,7 @@ class SpecialPageFactory {
        static function getLocalNameFor( $name, $subpage = false ) {
                global $wgContLang;
                $aliases = $wgContLang->getSpecialPageAliases();
+
                if ( isset( $aliases[$name][0] ) ) {
                        $name = $aliases[$name][0];
                } else {
@@ -536,4 +571,4 @@ class SpecialPageFactory {
                        return null;
                }
        }
-}
\ No newline at end of file
+}