API: fix copyright symbol, coding style cleanup, more braces
[lhc/web/wiklou.git] / includes / SpecialPage.php
index 25df036..80e2f7e 100644 (file)
@@ -27,8 +27,7 @@
  * page list.
  * @ingroup SpecialPage
  */
-class SpecialPage
-{
+class SpecialPage {
        /**#@+
         * @access private
         */
@@ -80,86 +79,113 @@ class SpecialPage
         ** array( 'SpecialRedirectToSpecial', name, page to redirect to, special page param, ... )
         */
        static public $mList = array(
-               'DoubleRedirects'           => array( 'SpecialPage', 'DoubleRedirects' ),
+               # Maintenance Reports
                'BrokenRedirects'           => array( 'SpecialPage', 'BrokenRedirects' ),
-               'Disambiguations'           => array( 'SpecialPage', 'Disambiguations' ),
-
-               'Userlogin'                 => array( 'SpecialPage', 'Userlogin' ),
-               'Userlogout'                => array( 'UnlistedSpecialPage', 'Userlogout' ),
-               'CreateAccount'             => array( 'SpecialRedirectToSpecial', 'CreateAccount', 'Userlogin', 'signup', array( 'uselang' ) ),
-               'Preferences'               => array( 'SpecialPage', 'Preferences' ),
-               'Watchlist'                 => array( 'SpecialPage', 'Watchlist' ),
-
-               'Recentchanges'             => array( 'IncludableSpecialPage', 'Recentchanges' ),
-               'Upload'                    => array( 'SpecialPage', 'Upload' ),
-               'Imagelist'                 => array( 'SpecialPage', 'Imagelist' ),
-               'Newimages'                 => array( 'IncludableSpecialPage', 'Newimages' ),
-               'Listusers'                 => array( 'SpecialPage', 'Listusers' ),
-               'Listgrouprights'           => 'SpecialListGroupRights',
-               'Statistics'                => array( 'SpecialPage', 'Statistics' ),
-               'Randompage'                => 'Randompage',
+               'Deadendpages'              => array( 'SpecialPage', 'Deadendpages' ),
+               'DoubleRedirects'           => array( 'SpecialPage', 'DoubleRedirects' ),
+               'Longpages'                 => array( 'SpecialPage', 'Longpages' ),
+               'Ancientpages'              => array( 'SpecialPage', 'Ancientpages' ),
                'Lonelypages'               => array( 'SpecialPage', 'Lonelypages' ),
-               'Uncategorizedpages'        => array( 'SpecialPage', 'Uncategorizedpages' ),
+               'Fewestrevisions'           => array( 'SpecialPage', 'Fewestrevisions' ),
+               'Withoutinterwiki'          => array( 'SpecialPage', 'Withoutinterwiki' ),
+               'Protectedpages'            => array( 'SpecialPage', 'Protectedpages' ),
+               'Protectedtitles'           => array( 'SpecialPage', 'Protectedtitles' ),
+               'Shortpages'                => array( 'SpecialPage', 'Shortpages' ),
                'Uncategorizedcategories'   => array( 'SpecialPage', 'Uncategorizedcategories' ),
                'Uncategorizedimages'       => array( 'SpecialPage', 'Uncategorizedimages' ),
+               'Uncategorizedpages'        => array( 'SpecialPage', 'Uncategorizedpages' ),
                'Uncategorizedtemplates'    => array( 'SpecialPage', 'Uncategorizedtemplates' ),
                'Unusedcategories'          => array( 'SpecialPage', 'Unusedcategories' ),
                'Unusedimages'              => array( 'SpecialPage', 'Unusedimages' ),
-               'Wantedpages'               => array( 'IncludableSpecialPage', 'Wantedpages' ),
+               'Unusedtemplates'           => array( 'SpecialPage', 'Unusedtemplates' ),
+               'Unwatchedpages'            => array( 'SpecialPage', 'Unwatchedpages', 'unwatchedpages' ),
                'Wantedcategories'          => array( 'SpecialPage', 'Wantedcategories' ),
-               'Mostlinked'                => array( 'SpecialPage', 'Mostlinked' ),
-               'Mostlinkedcategories'      => array( 'SpecialPage', 'Mostlinkedcategories' ),
-               'Mostlinkedtemplates'       => array( 'SpecialPage', 'Mostlinkedtemplates' ),
-               'Mostcategories'            => array( 'SpecialPage', 'Mostcategories' ),
-               'Mostimages'                => array( 'SpecialPage', 'Mostimages' ),
-               'Mostrevisions'             => array( 'SpecialPage', 'Mostrevisions' ),
-               'Fewestrevisions'           => array( 'SpecialPage', 'Fewestrevisions' ),
-               'Shortpages'                => array( 'SpecialPage', 'Shortpages' ),
-               'Longpages'                 => array( 'SpecialPage', 'Longpages' ),
-               'Newpages'                  => array( 'IncludableSpecialPage', 'Newpages' ),
-               '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' ),
-               'Specialpages'              => array( 'UnlistedSpecialPage', 'Specialpages' ),
-               'Contributions'             => array( 'SpecialPage', 'Contributions' ),
-               'Emailuser'                 => array( 'UnlistedSpecialPage', 'Emailuser' ),
-               'Whatlinkshere'             => array( 'SpecialPage', 'Whatlinkshere' ),
-               'Recentchangeslinked'       => array( 'SpecialPage', 'Recentchangeslinked' ),
-               'Movepage'                  => array( 'UnlistedSpecialPage', 'Movepage' ),
-               'Blockme'                   => array( 'UnlistedSpecialPage', 'Blockme' ),
-               'Resetpass'                 => array( 'UnlistedSpecialPage', 'Resetpass' ),
-               'Booksources'               => 'SpecialBookSources',
+               'Wantedfiles'               => array( 'SpecialPage', 'Wantedfiles' ),
+               'Wantedpages'               => array( 'IncludableSpecialPage', 'Wantedpages' ),
+               'Wantedtemplates'           => array( 'SpecialPage', 'Wantedtemplates' ),
+
+               # List of pages
+               'Allpages'                  => 'SpecialAllpages',
+               'Prefixindex'               => 'SpecialPrefixindex',
                'Categories'                => array( 'SpecialPage', 'Categories' ),
-               'Export'                    => array( 'SpecialPage', 'Export' ),
-               'Version'                   => array( 'SpecialPage', 'Version' ),
-               'Allmessages'               => array( 'SpecialPage', 'Allmessages' ),
-               'Log'                       => array( 'SpecialPage', 'Log' ),
+               'Disambiguations'           => array( 'SpecialPage', 'Disambiguations' ),
+               'Listredirects'             => array( 'SpecialPage', 'Listredirects' ),
+
+               # Login/create account
+               'Userlogin'                 => array( 'SpecialPage', 'Userlogin' ),
+               'CreateAccount'             => array( 'SpecialRedirectToSpecial', 'CreateAccount', 'Userlogin', 'signup', array( 'uselang' ) ),
+
+               # Users and rights
                'Blockip'                   => array( 'SpecialPage', 'Blockip', 'block' ),
-               'Undelete'                  => array( 'SpecialPage', 'Undelete', 'deletedhistory' ),
-               'Import'                    => array( 'SpecialPage', 'Import', 'import' ),
-               'Lockdb'                    => array( 'SpecialPage', 'Lockdb', 'siteadmin' ),
-               'Unlockdb'                  => array( 'SpecialPage', 'Unlockdb', 'siteadmin' ),
+               'Ipblocklist'               => array( 'SpecialPage', 'Ipblocklist' ),
+               'Resetpass'                 => 'SpecialResetpass',
+               'DeletedContributions'      => 'DeletedContributionsPage',
+               'Preferences'               => 'SpecialPreferences',
+               'Contributions'             => 'SpecialContributions',
+               'Listgrouprights'           => 'SpecialListGroupRights',
+               'Listusers'                 => array( 'SpecialPage', 'Listusers' ),
+               'Activeusers'               => 'SpecialActiveUsers',
                'Userrights'                => 'UserrightsPage',
+
+               # Recent changes and logs
+               'Newimages'                 => array( 'IncludableSpecialPage', 'Newimages' ),
+               'Log'                       => array( 'SpecialPage', 'Log' ),
+               'Watchlist'                 => array( 'SpecialPage', 'Watchlist' ),
+               'Newpages'                  => 'SpecialNewpages',
+               'Recentchanges'             => 'SpecialRecentchanges',
+               'Recentchangeslinked'       => 'SpecialRecentchangeslinked',
+               'Tags'                      => 'SpecialTags',
+
+               # Media reports and uploads
+               'Listfiles'                 => array( 'SpecialPage', 'Listfiles' ),
+               'Filepath'                  => array( 'SpecialPage', 'Filepath' ),
                'MIMEsearch'                => array( 'SpecialPage', 'MIMEsearch' ),
                'FileDuplicateSearch'       => array( 'SpecialPage', 'FileDuplicateSearch' ),
-               'Unwatchedpages'            => array( 'SpecialPage', 'Unwatchedpages', 'unwatchedpages' ),
-               'Listredirects'             => array( 'SpecialPage', 'Listredirects' ),
-               'Revisiondelete'            => array( 'UnlistedSpecialPage', 'Revisiondelete', 'deleterevision' ),
-               'Unusedtemplates'           => array( 'SpecialPage', 'Unusedtemplates' ),
+               'Upload'                    => 'SpecialUpload',
+
+               # Wiki data and tools
+               'Statistics'                => 'SpecialStatistics',
+               'Allmessages'               => 'SpecialAllmessages',
+               'Version'                   => 'SpecialVersion',
+               'Lockdb'                    => array( 'SpecialPage', 'Lockdb', 'siteadmin' ),
+               'Unlockdb'                  => array( 'SpecialPage', 'Unlockdb', 'siteadmin' ),
+
+               # Redirecting special pages
+               'LinkSearch'                => array( 'SpecialPage', 'LinkSearch' ),
+               'Randompage'                => 'Randompage',
                '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' ),
+               # High use pages
+               'Mostlinkedcategories'      => array( 'SpecialPage', 'Mostlinkedcategories' ),
+               'Mostimages'                => array( 'SpecialPage', 'Mostimages' ),
+               'Mostlinked'                => array( 'SpecialPage', 'Mostlinked' ),
+               'Mostlinkedtemplates'       => array( 'SpecialPage', 'Mostlinkedtemplates' ),
+               'Mostcategories'            => array( 'SpecialPage', 'Mostcategories' ),
+               'Mostrevisions'             => array( 'SpecialPage', 'Mostrevisions' ),
+
+               # Page tools
+               'Export'                    => 'SpecialExport',
+               'Import'                    => 'SpecialImport',
+               'Undelete'                  => array( 'SpecialPage', 'Undelete', 'deletedhistory' ),
+               'Whatlinkshere'             => 'SpecialWhatlinkshere',
                'MergeHistory'              => array( 'SpecialPage', 'MergeHistory', 'mergehistory' ),
+
+               # Other
+               'Booksources'               => 'SpecialBookSources',
+
+               # Unlisted / redirects
+               'Blankpage'                 => 'SpecialBlankpage',
+               'Blockme'                   => array( 'UnlistedSpecialPage', 'Blockme' ),
+               'Emailuser'                 => array( 'UnlistedSpecialPage', 'Emailuser' ),
+               'Listadmins'                => array( 'SpecialRedirectToSpecial', 'Listadmins', 'Listusers', 'sysop' ),
                'Listbots'                  => array( 'SpecialRedirectToSpecial', 'Listbots', 'Listusers', 'bot' ),
+               'Movepage'                  => array( 'UnlistedSpecialPage', 'Movepage' ),
+               'Mycontributions'           => array( 'SpecialMycontributions' ),
+               'Mypage'                    => array( 'SpecialMypage' ),
+               'Mytalk'                    => array( 'SpecialMytalk' ),
+               'Revisiondelete'            => 'SpecialRevisionDelete',
+               'Specialpages'              => array( 'UnlistedSpecialPage', 'Specialpages' ),
+               'Userlogout'                => array( 'UnlistedSpecialPage', 'Userlogout' ),
        );
 
        static public $mAliases;
@@ -251,7 +277,7 @@ class SpecialPage
                $bits = explode( '/', $alias, 2 );
                $name = self::resolveAlias( $bits[0] );
                if( !isset( $bits[1] ) ) { // bug 2087
-                       $par = NULL;
+                       $par = null;
                } else {
                        $par = $bits[1];
                }
@@ -298,9 +324,9 @@ class SpecialPage
                if( isset($specialPageGroupsCache[$page->mName]) ) {
                        return $specialPageGroupsCache[$page->mName];
                }
-               $group = wfMsg('specialpages-specialpagegroup-'.$page->mName);
+               $group = wfMsg('specialpages-specialpagegroup-'.strtolower($page->mName));
                if( $group == ''
-                || wfEmptyMsg('specialpages-specialpagegroup-'.$page->mName, $group ) ) {
+                || wfEmptyMsg('specialpages-specialpagegroup-'.strtolower($page->mName), $group ) ) {
                        $group = isset($wgSpecialPageGroups[$page->mName])
                                ? $wgSpecialPageGroups[$page->mName]
                                : '-';
@@ -368,7 +394,7 @@ class SpecialPage
                        }
                        return self::$mList[$name];
                } else {
-                       return NULL;
+                       return null;
                }
        }
 
@@ -381,7 +407,7 @@ class SpecialPage
                if ( $realName ) {
                        return self::getPage( $realName );
                } else {
-                       return NULL;
+                       return null;
                }
        }
 
@@ -437,14 +463,14 @@ class SpecialPage
         */
        static function getRestrictedPages() {
                global $wgUser;
-               if ( !self::$mListInitialised ) {
+               if( !self::$mListInitialised ) {
                        self::initList();
                }
                $pages = array();
 
-               foreach ( self::$mList as $name => $rec ) {
+               foreach( self::$mList as $name => $rec ) {
                        $page = self::getPage( $name );
-                       if (
+                       if(
                                $page->isListed()
                                && $page->isRestricted()
                                && $page->userCanExecute( $wgUser )
@@ -474,7 +500,7 @@ class SpecialPage
                $bits = explode( '/', $title->getDBkey(), 2 );
                $name = $bits[0];
                if( !isset( $bits[1] ) ) { // bug 2087
-                       $par = NULL;
+                       $par = null;
                } else {
                        $par = $bits[1];
                }
@@ -483,7 +509,7 @@ class SpecialPage
                if ( !$page ) {
                        if ( !$including ) {
                                $wgOut->setArticleRelated( false );
-                               $wgOut->setRobotpolicy( 'noindex,nofollow' );
+                               $wgOut->setRobotPolicy( 'noindex,nofollow' );
                                $wgOut->setStatusCode( 404 );
                                $wgOut->showErrorPage( 'nosuchspecialpage', 'nospecialpagetext' );
                        }
@@ -548,6 +574,7 @@ class SpecialPage
                $oldTitle = $wgTitle;
                $oldOut = $wgOut;
                $wgOut = new OutputPage;
+               $wgOut->setTitle( $title );
 
                $ret = SpecialPage::executePath( $title, true );
                if ( $ret === true ) {
@@ -571,11 +598,25 @@ class SpecialPage
                $aliases = $wgContLang->getSpecialPageAliases();
                if ( isset( $aliases[$name][0] ) ) {
                        $name = $aliases[$name][0];
+               } else {
+                       // Try harder in case someone misspelled the correct casing
+                       $found = false;
+                       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;
+                               }
+                       }
+                       if ( !$found ) wfWarn( "Did not find alias for special page '$name'.
+Perhaps no page aliases are defined for it?" );
                }
                if ( $subpage !== false && !is_null( $subpage ) ) {
                        $name = "$name/$subpage";
                }
-               return $name;
+               return $wgContLang->ucfirst( $name );
        }
 
        /**
@@ -642,7 +683,7 @@ class SpecialPage
                        $this->mFunction = $function;
                }
                if ( $file === 'default' ) {
-                       $this->mFile = dirname(__FILE__) . "/Special{$name}.php";
+                       $this->mFile = dirname(__FILE__) . "/specials/Special$name.php";
                } else {
                        $this->mFile = $file;
                }
@@ -662,13 +703,18 @@ class SpecialPage
        /**#@+
          * Accessor and mutator
          */
-       function name( $x = NULL ) { return wfSetVar( $this->mName, $x ); }
-       function restrictions( $x = NULL) { return wfSetVar( $this->mRestrictions, $x ); }
-       function listed( $x = NULL) { return wfSetVar( $this->mListed, $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 including( $x = NULL ) { return wfSetVar( $this->mIncluding, $x ); }
+       function name( $x = null ) { return wfSetVar( $this->mName, $x ); }
+       function restrictions( $x = null) {
+               # Use the one below this
+               wfDeprecated( __METHOD__ );
+               return wfSetVar( $this->mRestriction, $x );
+       }
+       function restriction( $x = null) { return wfSetVar( $this->mRestriction, $x ); }
+       function listed( $x = null) { return wfSetVar( $this->mListed, $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 including( $x = null ) { return wfSetVar( $this->mIncluding, $x ); }
        /**#@-*/
 
        /**
@@ -689,7 +735,9 @@ class SpecialPage
         *   pages?
         */
        public function isRestricted() {
-               return $this->mRestriction != '';
+               global $wgGroupPermissions;
+               // DWIM: If all anons can do something, then it is not restricted
+               return $this->mRestriction != '' && empty($wgGroupPermissions['*'][$this->mRestriction]);
        }
 
        /**
@@ -739,26 +787,32 @@ class SpecialPage
                        if(!is_callable($func) and $this->mFile) {
                                require_once( $this->mFile );
                        }
-                       # 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;
+                       $this->outputHeader();
                        call_user_func( $func, $par, $this );
-                       if ( ! wfRunHooks( 'SpecialPageExecuteAfterPage', array( &$this, &$par, &$func ) ) )
-                               return;
                } else {
                        $this->displayRestrictionError();
                }
        }
 
-       function outputHeader() {
+       /**
+        * Outputs a summary message on top of special pages
+        * Per default the message key is the canonical name of the special page
+        * May be overriden, i.e. by extensions to stick with the naming conventions
+        * for message keys: 'extensionname-xxx'
+        *
+        * @param string message key of the summary
+        */
+       function outputHeader( $summaryMessageKey = '' ) {
                global $wgOut, $wgContLang;
 
-               $msg = $wgContLang->lc( $this->name() ) . '-summary';
+               if( $summaryMessageKey == '' ) {
+                       $msg = $wgContLang->lc( $this->name() ) . '-summary';
+               } else {
+                       $msg = $summaryMessageKey;
+               }
                $out = wfMsgNoTrans( $msg );
                if ( ! wfEmptyMsg( $msg, $out ) and  $out !== '' and ! $this->including() ) {
-                       $wgOut->addWikiMsg( $msg );
+                       $wgOut->wrapWikiMsg( "<div class='mw-specialpage-summary'>\n$1</div>", $msg );
                }
 
        }
@@ -775,7 +829,7 @@ class SpecialPage
        /**
         * Get a self-referential title object
         */
-       function getTitle( $subpage = false) {
+       function getTitle( $subpage = false ) {
                return self::getTitleFor( $this->mName, $subpage );
        }
 
@@ -804,7 +858,7 @@ class SpecialPage
                global $wgRequest;
                $params = array();
                foreach( $this->mAllowedRedirectParams as $arg ) {
-                       if( $val = $wgRequest->getVal( $arg, false ) )
+                       if( ( $val = $wgRequest->getVal( $arg, null ) ) !== null )
                                $params[] = $arg . '=' . $val;
                }
 
@@ -911,6 +965,8 @@ class SpecialMytalk extends UnlistedSpecialPage {
 class SpecialMycontributions extends UnlistedSpecialPage {
        function __construct() {
                parent::__construct(  'Mycontributions' );
+               $this->mAllowedRedirectParams = array( 'limit', 'namespace', 'tagfilter',
+                       'offset', 'dir', 'year', 'month', 'feed' );
        }
 
        function getRedirect( $subpage ) {