Merge "API: HTMLize and internationalize the help, add Special:ApiHelp"
[lhc/web/wiklou.git] / includes / specialpage / SpecialPageFactory.php
index 0138cf9..febd119 100644 (file)
@@ -47,7 +47,7 @@ class SpecialPageFactory {
        /**
         * List of special page names to the subclass of SpecialPage which handles them.
         */
-       private static $list = array(
+       private static $coreList = array(
                // Maintenance Reports
                'BrokenRedirects' => 'BrokenRedirectsPage',
                'Deadendpages' => 'DeadendPagesPage',
@@ -59,7 +59,7 @@ class SpecialPageFactory {
                'Withoutinterwiki' => 'WithoutInterwikiPage',
                'Protectedpages' => 'SpecialProtectedpages',
                'Protectedtitles' => 'SpecialProtectedtitles',
-               'Shortpages' => 'ShortpagesPage',
+               'Shortpages' => 'ShortPagesPage',
                'Uncategorizedcategories' => 'UncategorizedCategoriesPage',
                'Uncategorizedimages' => 'UncategorizedImagesPage',
                'Uncategorizedpages' => 'UncategorizedPagesPage',
@@ -74,7 +74,7 @@ class SpecialPageFactory {
                'Wantedtemplates' => 'WantedTemplatesPage',
 
                // List of pages
-               'Allpages' => 'SpecialAllpages',
+               'Allpages' => 'SpecialAllPages',
                'Prefixindex' => 'SpecialPrefixindex',
                'Categories' => 'SpecialCategories',
                'Listredirects' => 'ListredirectsPage',
@@ -114,6 +114,7 @@ class SpecialPageFactory {
                // Media reports and uploads
                'Listfiles' => 'SpecialListFiles',
                'Filepath' => 'SpecialFilepath',
+               'MediaStatistics' => 'MediaStatisticsPage',
                'MIMEsearch' => 'MIMEsearchPage',
                'FileDuplicateSearch' => 'FileDuplicateSearchPage',
                'Upload' => 'SpecialUpload',
@@ -122,7 +123,7 @@ class SpecialPageFactory {
 
                // Data and tools
                'Statistics' => 'SpecialStatistics',
-               'Allmessages' => 'SpecialAllmessages',
+               'Allmessages' => 'SpecialAllMessages',
                'Version' => 'SpecialVersion',
                'Lockdb' => 'SpecialLockdb',
                'Unlockdb' => 'SpecialUnlockdb',
@@ -155,6 +156,7 @@ class SpecialPageFactory {
                'Booksources' => 'SpecialBookSources',
 
                // Unlisted / redirects
+               'ApiHelp' => 'SpecialApiHelp',
                'Blankpage' => 'SpecialBlankpage',
                'Diff' => 'SpecialDiff',
                'Emailuser' => 'SpecialEmailUser',
@@ -173,22 +175,55 @@ class SpecialPageFactory {
                'Userlogout' => 'SpecialUserlogout',
        );
 
+       private static $list;
        private static $aliases;
 
        /**
-        * Get the special page list
+        * Reset the internal list of special pages. Useful when changing $wgSpecialPages after
+        * the internal list has already been initialized, e.g. during testing.
+        */
+       public static function resetList() {
+               self::$list = null;
+               self::$aliases = null;
+       }
+
+       /**
+        * Returns a list of canonical special page names.
+        * May be used to iterate over all registered special pages.
         *
+        * @return string[]
+        */
+       public static function getNames() {
+               return array_keys( self::getPageList() );
+       }
+
+       /**
+        * Get the special page list as an array
+        *
+        * @deprecated since 1.24, use getNames() instead.
         * @return array
         */
-       static function getList() {
+       public static function getList() {
+               wfDeprecated( __FUNCTION__, '1.24' );
+               return self::getPageList();
+       }
+
+       /**
+        * Get the special page list as an array
+        *
+        * @return array
+        */
+       private static function getPageList() {
                global $wgSpecialPages;
                global $wgDisableCounters, $wgDisableInternalSearch, $wgEmailAuthentication;
                global $wgEnableEmail, $wgEnableJavaScriptTest;
                global $wgPageLanguageUseDB;
 
-               if ( !is_object( self::$list ) ) {
+               if ( !is_array( self::$list ) ) {
                        wfProfileIn( __METHOD__ );
 
+                       self::$list = self::$coreList;
+
                        if ( !$wgDisableCounters ) {
                                self::$list['Popularpages'] = 'PopularPagesPage';
                        }
@@ -231,32 +266,55 @@ class SpecialPageFactory {
 
        /**
         * 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 canonical 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).
+        * properties which can be accessed $obj->pagename - each property name is an
+        * alias, with the value being the canonical name of the special page. All
+        * registered special pages are guaranteed to map to themselves.
         * @return object
         */
-       static function getAliasList() {
+       private static function getAliasListObject() {
                if ( !is_object( self::$aliases ) ) {
                        global $wgContLang;
                        $aliases = $wgContLang->getSpecialPageAliases();
-
-                       $missingPages = self::getList();
+                       $pageList = self::getPageList();
 
                        self::$aliases = array();
+                       $keepAlias = array();
+
+                       // Force every canonical name to be an alias for itself.
+                       foreach ( $pageList as $name => $stuff ) {
+                               $caseFoldedAlias = $wgContLang->caseFold( $name );
+                               self::$aliases[$caseFoldedAlias] = $name;
+                               $keepAlias[$caseFoldedAlias] = 'canonical';
+                       }
+
                        // Check for $aliases being an array since Language::getSpecialPageAliases can return null
                        if ( is_array( $aliases ) ) {
                                foreach ( $aliases as $realName => $aliasList ) {
-                                       foreach ( $aliasList as $alias ) {
-                                               self::$aliases[$wgContLang->caseFold( $alias )] = $realName;
+                                       $aliasList = array_values( $aliasList );
+                                       foreach ( $aliasList as $i => $alias ) {
+                                               $caseFoldedAlias = $wgContLang->caseFold( $alias );
+
+                                               if ( isset( self::$aliases[$caseFoldedAlias] ) &&
+                                                       $realName === self::$aliases[$caseFoldedAlias]
+                                               ) {
+                                                       // Ignore same-realName conflicts
+                                                       continue;
+                                               }
+
+                                               if ( !isset( $keepAlias[$caseFoldedAlias] ) ) {
+                                                       self::$aliases[$caseFoldedAlias] = $realName;
+                                                       if ( !$i ) {
+                                                               $keepAlias[$caseFoldedAlias] = 'first';
+                                                       }
+                                               } elseif ( !$i ) {
+                                                       wfWarn( "First alias '$alias' for $realName conflicts with " .
+                                                               "{$keepAlias[$caseFoldedAlias]} alias for " .
+                                                               self::$aliases[$caseFoldedAlias]
+                                                       );
+                                               }
                                        }
-                                       unset( $missingPages->$realName );
                                }
                        }
-                       foreach ( $missingPages as $name => $stuff ) {
-                               self::$aliases[$wgContLang->caseFold( $name )] = $name;
-                       }
 
                        // Cast to object: func()[$key] doesn't work, but func()->$key does
                        self::$aliases = (object)self::$aliases;
@@ -279,8 +337,8 @@ class SpecialPageFactory {
 
                $caseFoldedAlias = $wgContLang->caseFold( $bits[0] );
                $caseFoldedAlias = str_replace( ' ', '_', $caseFoldedAlias );
-               if ( isset( self::getAliasList()->$caseFoldedAlias ) ) {
-                       $name = self::getAliasList()->$caseFoldedAlias;
+               if ( isset( self::getAliasListObject()->$caseFoldedAlias ) ) {
+                       $name = self::getAliasListObject()->$caseFoldedAlias;
                } else {
                        return array( null, null );
                }
@@ -331,7 +389,7 @@ class SpecialPageFactory {
        public static function exists( $name ) {
                list( $title, /*...*/ ) = self::resolveAlias( $name );
 
-               $specialPageList = self::getList();
+               $specialPageList = self::getPageList();
                return isset( $specialPageList[$title] );
        }
 
@@ -343,22 +401,39 @@ class SpecialPageFactory {
         */
        public static function getPage( $name ) {
                list( $realName, /*...*/ ) = self::resolveAlias( $name );
-               $specialPageList = self::getList();
+
+               $specialPageList = self::getPageList();
+
                if ( isset( $specialPageList[$realName] ) ) {
                        $rec = $specialPageList[$realName];
-                       if ( is_string( $rec ) ) {
-                               $className = $rec;
 
-                               return new $className;
+                       if ( is_callable( $rec ) ) {
+                               // Use callback to instantiate the special page
+                               $page = call_user_func( $rec );
+                       } elseif ( is_string( $rec ) ) {
+                               $className = $rec;
+                               $page = new $className;
                        } elseif ( is_array( $rec ) ) {
                                $className = array_shift( $rec );
                                // @deprecated, officially since 1.18, unofficially since forever
                                wfDeprecated( "Array syntax for \$wgSpecialPages is deprecated ($className), " .
                                        "define a subclass of SpecialPage instead.", '1.18' );
-                               $specialPageList[$realName] = MWFunction::newObj( $className, $rec );
+                               $page = MWFunction::newObj( $className, $rec );
+                       } elseif ( $rec instanceof SpecialPage ) {
+                               $page = $rec; //XXX: we should deep clone here
+                       } else {
+                               $page = null;
+                       }
+
+                       if ( $page instanceof SpecialPage ) {
+                               return $page;
+                       } else {
+                               // It's not a classname, nor a callback, nor a legacy constructor array,
+                               // nor a special page object. Give up.
+                               wfLogWarning( "Cannot instantiate special page $realName: bad spec!" );
+                               return null;
                        }
 
-                       return $specialPageList[$realName];
                } else {
                        return null;
                }
@@ -378,7 +453,7 @@ class SpecialPageFactory {
                        global $wgUser;
                        $user = $wgUser;
                }
-               foreach ( self::getList() as $name => $rec ) {
+               foreach ( self::getPageList() as $name => $rec ) {
                        $page = self::getPage( $name );
                        if ( $page ) { // not null
                                $page->setContext( RequestContext::getMain() );
@@ -400,7 +475,7 @@ class SpecialPageFactory {
         */
        public static function getRegularPages() {
                $pages = array();
-               foreach ( self::getList() as $name => $rec ) {
+               foreach ( self::getPageList() as $name => $rec ) {
                        $page = self::getPage( $name );
                        if ( $page->isListed() && !$page->isRestricted() ) {
                                $pages[$name] = $page;
@@ -423,7 +498,7 @@ class SpecialPageFactory {
                        global $wgUser;
                        $user = $wgUser;
                }
-               foreach ( self::getList() as $name => $rec ) {
+               foreach ( self::getPageList() as $name => $rec ) {
                        $page = self::getPage( $name );
                        if (
                                $page->isListed()
@@ -532,7 +607,7 @@ class SpecialPageFactory {
         * @param IContextSource $context
         * @return string HTML fragment
         */
-       static function capturePath( Title $title, IContextSource $context ) {
+       public static function capturePath( Title $title, IContextSource $context ) {
                global $wgOut, $wgTitle, $wgRequest, $wgUser, $wgLang;
 
                // Save current globals
@@ -569,32 +644,45 @@ class SpecialPageFactory {
         * @param string|bool $subpage
         * @return string
         */
-       static function getLocalNameFor( $name, $subpage = false ) {
+       public static function getLocalNameFor( $name, $subpage = false ) {
                global $wgContLang;
                $aliases = $wgContLang->getSpecialPageAliases();
+               $aliasList = self::getAliasListObject();
 
-               if ( isset( $aliases[$name][0] ) ) {
-                       $name = $aliases[$name][0];
-               } else {
-                       // Try harder in case someone misspelled the correct casing
+               // Find the first alias that maps back to $name
+               if ( isset( $aliases[$name] ) ) {
                        $found = false;
-                       // Check for $aliases being an array since Language::getSpecialPageAliases can return null
+                       foreach ( $aliases[$name] as $alias ) {
+                               $caseFoldedAlias = $wgContLang->caseFold( $alias );
+                               $caseFoldedAlias = str_replace( ' ', '_', $caseFoldedAlias );
+                               if ( isset( $aliasList->$caseFoldedAlias ) &&
+                                       $aliasList->$caseFoldedAlias === $name
+                               ) {
+                                       $name = $alias;
+                                       $found = true;
+                                       break;
+                               }
+                       }
+                       if ( !$found ) {
+                               wfWarn( "Did not find a usable alias for special page '$name'. " .
+                                       "It seems all defined aliases conflict?" );
+                       }
+               } else {
+                       // Check if someone misspelled the correct casing
                        if ( is_array( $aliases ) ) {
                                foreach ( $aliases as $n => $values ) {
                                        if ( strcasecmp( $name, $n ) === 0 ) {
                                                wfWarn( "Found alias defined for $n when searching for " .
                                                        "special page aliases for $name. Case mismatch?" );
-                                               $name = $values[0];
-                                               $found = true;
-                                               break;
+                                               return self::getLocalNameFor( $n, $subpage );
                                        }
                                }
                        }
-                       if ( !$found ) {
-                               wfWarn( "Did not find alias for special page '$name'. " .
-                                       "Perhaps no aliases are defined for it?" );
-                       }
+
+                       wfWarn( "Did not find alias for special page '$name'. " .
+                               "Perhaps no aliases are defined for it?" );
                }
+
                if ( $subpage !== false && !is_null( $subpage ) ) {
                        $name = "$name/$subpage";
                }
@@ -608,7 +696,7 @@ class SpecialPageFactory {
         * @param string $alias
         * @return Title|null Title or null if there is no such alias
         */
-       static function getTitleForAlias( $alias ) {
+       public static function getTitleForAlias( $alias ) {
                list( $name, $subpage ) = self::resolveAlias( $alias );
                if ( $name != null ) {
                        return SpecialPage::getTitleFor( $name, $subpage );