* Further work on rev_deleted; changed to a bitfield with several data-hiding
[lhc/web/wiklou.git] / includes / SpecialPage.php
index 5d5dcd3..eb64341 100644 (file)
  * @subpackage SpecialPage
  */
 
-/**
- *
- */
-global $wgSpecialPages;
 
 /**
  * @access private
  */
 $wgSpecialPages = array(
-       'DoubleRedirects'       => new UnlistedSpecialPage ( 'DoubleRedirects' ),
-       'BrokenRedirects'       => new UnlistedSpecialPage ( 'BrokenRedirects' ),
-       'Disambiguations'       => new UnlistedSpecialPage ( 'Disambiguations' ),
+       'DoubleRedirects'       => new SpecialPage ( 'DoubleRedirects' ),
+       'BrokenRedirects'       => new SpecialPage ( 'BrokenRedirects' ),
+       'Disambiguations'       => new SpecialPage ( 'Disambiguations' ),
 
        'Userlogin'         => new SpecialPage( 'Userlogin' ),
        'Userlogout'        => new UnlistedSpecialPage( 'Userlogout' ),
        'Preferences'       => new SpecialPage( 'Preferences' ),
        'Watchlist'         => new SpecialPage( 'Watchlist' ),
-       
-       'Mytalk'                        => new UnlistedSpecialPage( 'Mytalk'),
-       'Mycontributions'       => new UnlistedSpecialPage( 'Mycontributions'),
-       'Mypage'                        => new UnlistedSpecialPage( 'Mypage'),
-       
-       'Recentchanges'     => new SpecialPage( 'Recentchanges' ),
+
+       'Recentchanges'     => new IncludableSpecialPage( 'Recentchanges' ),
        'Upload'            => new SpecialPage( 'Upload' ),
        'Imagelist'         => new SpecialPage( 'Imagelist' ),
-       'Newimages'         => new SpecialPage( 'Newimages' ),
+       'Newimages'         => new IncludableSpecialPage( 'Newimages' ),
        'Listusers'         => new SpecialPage( 'Listusers' ),
-       'Listadmins'        => new UnlistedSpecialPage( 'Listadmins' ),
        'Statistics'        => new SpecialPage( 'Statistics' ),
-       'Randompage'        => new SpecialPage( 'Randompage' ),
+       'Random'        => new SpecialPage( 'Randompage' ),
        'Lonelypages'       => new SpecialPage( 'Lonelypages' ),
        'Uncategorizedpages'=> new SpecialPage( 'Uncategorizedpages' ),
        'Uncategorizedcategories'=> new SpecialPage( 'Uncategorizedcategories' ),
-       'Unusedimages'      => new SpecialPage( 'Unusedimages' )
-);
-
-global $wgDisableCounters;
-if( !$wgDisableCounters ) {
-       $wgSpecialPages['Popularpages'] = new SpecialPage( 'Popularpages' );
-}
-
-global $wgDisableInternalSearch;
-if( !$wgDisableInternalSearch ) {
-       $wgSpecialPages['Search'] = new UnlistedSpecialPage( 'Search' );
-}
-
-$wgSpecialPages = array_merge($wgSpecialPages, array (
-       'Wantedpages'   => new SpecialPage( 'Wantedpages' ),
+       'Unusedcategories'      => new SpecialPage( 'Unusedcategories' ),
+       'Unusedimages'      => new SpecialPage( 'Unusedimages' ),
+       'Wantedpages'   => new IncludableSpecialPage( 'Wantedpages' ),
+       'Wantedcategories' => new SpecialPage( 'Wantedcategories' ),
+       'Mostlinked'    => new SpecialPage( 'Mostlinked' ),
+       'Mostlinkedcategories' => new SpecialPage( 'Mostlinkedcategories' ),
+       'Mostcategories' => new SpecialPage( 'Mostcategories' ),
+       'Mostimages' => new SpecialPage( 'Mostimages' ),
+       'Mostrevisions' => new SpecialPage( 'Mostrevisions' ),
        'Shortpages'    => new SpecialPage( 'Shortpages' ),
        'Longpages'             => new SpecialPage( 'Longpages' ),
-       'Newpages'              => new SpecialPage( 'Newpages' ),
+       'Newpages'              => new IncludableSpecialPage( 'Newpages' ),
        'Ancientpages'  => new SpecialPage( 'Ancientpages' ),
        'Deadendpages'  => new SpecialPage( 'Deadendpages' ),
-       'Allpages'              => new SpecialPage( 'Allpages' ),
+       'Allpages'              => new IncludableSpecialPage( 'Allpages' ),
+       'Prefixindex'   => new IncludableSpecialPage( 'Prefixindex' ) ,
        'Ipblocklist'   => new SpecialPage( 'Ipblocklist' ),
        'Specialpages'  => new UnlistedSpecialPage( 'Specialpages' ),
        'Contributions' => new UnlistedSpecialPage( 'Contributions' ),
@@ -84,18 +70,28 @@ $wgSpecialPages = array_merge($wgSpecialPages, array (
        'Allmessages'   => new SpecialPage( 'Allmessages' ),
        'Log'           => new SpecialPage( 'Log' ),
        'Blockip'               => new SpecialPage( 'Blockip', 'block' ),
-       'Undelete'              => new SpecialPage( 'Undelete', 'delete' ),
-       // Makesysop is obsolete, replaced by Special:Userlevels [av]
-       # 'Makesysop'           => new SpecialPage( 'Makesysop', 'userrights' ),
-
-# Special:Import is half-written
-#      "Import"                => new SpecialPage( "Import", "sysop" ),
+       'Undelete'              => new SpecialPage( 'Undelete', 'deletedhistory' ),
+       "Import"                => new SpecialPage( "Import", 'import' ),
        'Lockdb'                => new SpecialPage( 'Lockdb', 'siteadmin' ),
        'Unlockdb'              => new SpecialPage( 'Unlockdb', 'siteadmin' ),
-       'Sitesettings'  => new SpecialPage( 'Sitesettings', 'siteadmin' ),
-       'Userlevels'    => new SpecialPage( 'Userlevels', 'userrights' ),
-       'Grouplevels'   => new SpecialPage( 'Grouplevels', 'grouprights' ),
-));
+       'Userrights'    => new SpecialPage( 'Userrights', 'userrights' ),
+       'MIMEsearch'    => new SpecialPage( 'MIMEsearch' ),
+       'Unwatchedpages' => new SpecialPage( 'Unwatchedpages', 'unwatchedpages' ),
+       'Listredirects' => new SpecialPage( 'Listredirects' ),
+       'Revisiondelete' => new SpecialPage( 'Revisiondelete', 'deleterevision' ),
+);
+
+if( !$wgDisableCounters ) {
+       $wgSpecialPages['Popularpages'] = new SpecialPage( 'Popularpages' );
+}
+
+if( !$wgDisableInternalSearch ) {
+       $wgSpecialPages['Search'] = new SpecialPage( 'Search' );
+}
+
+if( $wgEmailAuthentication ) {
+       $wgSpecialPages['Confirmemail'] = new UnlistedSpecialPage( 'Confirmemail' );
+}
 
 /**
  * Parent special page class, also static functions for handling the special
@@ -129,8 +125,19 @@ class SpecialPage
         * File which needs to be included before the function above can be called
         */
        var $mFile;
+       /**
+        * Whether or not this special page is being included from an article
+        */
+       var $mIncluding;
+       /**
+        * Whether the special page can be included in an article
+        */
+       var $mIncludable;
+
+
        /**#@-*/
 
+
        /**
         * Add a page to the list of valid special pages
         * $obj->execute() must send HTML to $wgOut then return
@@ -157,7 +164,7 @@ class SpecialPage
         * @static
         * @param string $name
         */
-       function &getPage( $name ) {
+       function getPage( $name ) {
                global $wgSpecialPages;
                if ( array_key_exists( $name, $wgSpecialPages ) ) {
                        return $wgSpecialPages[$name];
@@ -166,6 +173,26 @@ class SpecialPage
                }
        }
 
+       /**
+        * @static
+        * @param string $name
+        * @return mixed Title object if the redirect exists, otherwise NULL
+        */
+       function getRedirect( $name ) {
+               global $wgUser;
+
+               $redirects = array(
+                       'Mypage' => Title::makeTitle( NS_USER, $wgUser->getName() ),
+                       'Mytalk' => Title::makeTitle( NS_USER_TALK, $wgUser->getName() ),
+                       'Mycontributions' => Title::makeTitle( NS_SPECIAL, 'Contributions/' . $wgUser->getName() ),
+                       'Listadmins' => Title::makeTitle( NS_SPECIAL, 'Listusers/sysop' ), # @bug 2832
+                       'Randompage' => Title::makeTitle( NS_SPECIAL, 'Random' )
+               );
+               wfRunHooks( 'SpecialPageGetRedirect', array( &$redirects ) );
+
+               return isset( $redirects[$name] ) ? $redirects[$name] : null;
+       }
+
        /**
         * Return categorised listable special pages
         * Returns a 2d array where the first index is the restriction name
@@ -192,33 +219,88 @@ class SpecialPage
         * The path     may contain parameters, e.g. Special:Name/Params
         * Extracts the special page name and call the execute method, passing the parameters
         *
-        * @param $title should be a title object
+        * Returns a title object if the page is redirected, false if there was no such special
+        * page, and true if it was successful.
+        *
+        * @param $title          a title object
+        * @param $including      output is being captured for use in {{special:whatever}}
         */
-       function executePath( &$title ) {
-               global $wgSpecialPages, $wgOut, $wgTitle;
+       function executePath( &$title, $including = false ) {
+               global $wgOut, $wgTitle;
+               $fname = 'SpecialPage::executePath';
+               wfProfileIn( $fname );
 
                $bits = split( "/", $title->getDBkey(), 2 );
                $name = $bits[0];
-               if( empty( $bits[1] ) ) {
+               if( !isset( $bits[1] ) ) { // bug 2087
                        $par = NULL;
                } else {
                        $par = $bits[1];
                }
 
-               $page =& SpecialPage::getPage( $name );
+               $page = SpecialPage::getPage( $name );
                if ( is_null( $page ) ) {
-                       $wgOut->setArticleRelated( false );
-                       $wgOut->setRobotpolicy( "noindex,follow" );
-                       $wgOut->errorpage( "nosuchspecialpage", "nospecialpagetext" );
+                       if ( $including ) {
+                               wfProfileOut( $fname );
+                               return false;
+                       } else {
+                               $redir = SpecialPage::getRedirect( $name );
+                               if ( isset( $redir ) ) {
+                                       if ( isset( $par ) )
+                                               $wgOut->redirect( $redir->getFullURL() . '/' . $par );
+                                       else
+                                               $wgOut->redirect( $redir->getFullURL() );
+                                       $retVal = $redir;
+                               } else {
+                                       $wgOut->setArticleRelated( false );
+                                       $wgOut->setRobotpolicy( 'noindex,follow' );
+                                       $wgOut->setStatusCode( 404 );
+                                       $wgOut->errorpage( 'nosuchspecialpage', 'nospecialpagetext' );
+                                       $retVal = false;
+                               }
+                       }
                } else {
+                       if ( $including && !$page->includable() ) {
+                               wfProfileOut( $fname );
+                               return false;
+                       }
                        if($par !== NULL) {
                                $wgTitle = Title::makeTitle( NS_SPECIAL, $name );
                        } else {
                                $wgTitle = $title;
                        }
+                       $page->including( $including );
 
+                       $profName = 'Special:' . $page->getName();
+                       wfProfileIn( $profName );
                        $page->execute( $par );
+                       wfProfileOut( $profName );
+                       $retVal = true;
                }
+               wfProfileOut( $fname );
+               return $retVal;
+       }
+
+       /**
+        * 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.
+        * @static
+        */
+       function capturePath( &$title ) {
+               global $wgOut, $wgTitle;
+
+               $oldTitle = $wgTitle;
+               $oldOut = $wgOut;
+               $wgOut = new OutputPage;
+
+               $ret = SpecialPage::executePath( $title, true );
+               if ( $ret === true ) {
+                       $ret = $wgOut->getHTML();
+               }
+               $wgTitle = $oldTitle;
+               $wgOut = $oldOut;
+               return $ret;
        }
 
        /**
@@ -237,10 +319,11 @@ class SpecialPage
         * @param string $function Function called by execute(). By default it is constructed from $name
         * @param string $file File which is included by execute(). It is also constructed from $name by default
         */
-       function SpecialPage( $name = '', $restriction = '', $listed = true, $function = false, $file = 'default' ) {
+       function SpecialPage( $name = '', $restriction = '', $listed = true, $function = false, $file = 'default', $includable = false ) {
                $this->mName = $name;
                $this->mRestriction = $restriction;
                $this->mListed = $listed;
+               $this->mIncludable = $includable;
                if ( $function == false ) {
                        $this->mFunction = 'wfSpecial'.$name;
                } else {
@@ -253,10 +336,28 @@ class SpecialPage
                }
        }
 
-       # Accessor functions, see the descriptions of the associated variables above
+       /**#@+
+         * Accessor
+         *
+         * @deprecated
+         */
        function getName() { return $this->mName; }
        function getRestriction() { return $this->mRestriction; }
+       function getFile() { return $this->mFile; }
        function isListed() { return $this->mListed; }
+       /**#@-*/
+
+       /**#@+
+         * 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 ); }
+       /**#@-*/
 
        /**
         * Checks if the given user (identified by an object) can execute this
@@ -279,11 +380,7 @@ class SpecialPage
         */
        function displayRestrictionError() {
                global $wgOut;
-               if ( $this->mRestriction == "developer" ) {
-                       $wgOut->developerRequired();
-               } else {
-                       $wgOut->sysopRequired();
-               }
+               $wgOut->permissionRequired( $this->mRestriction );
        }
 
        /**
@@ -301,21 +398,38 @@ class SpecialPage
         * Checks user permissions, calls the function given in mFunction
         */
        function execute( $par ) {
-               global $wgUser, $wgOut, $wgTitle;
+               global $wgUser;
 
                $this->setHeaders();
 
                if ( $this->userCanExecute( $wgUser ) ) {
-                       if ( $this->mFile ) {
+                       $func = $this->mFunction;
+                       // only load file if the function does not exist
+                       if(!function_exists($func) and $this->mFile) {
                                require_once( $this->mFile );
                        }
-                       $func = $this->mFunction;
-                       $func( $par );
+                       if ( wfRunHooks( 'SpecialPageExecuteBeforeHeader', array( &$this, &$par, &$func ) ) )
+                               $this->outputHeader();
+                       if ( ! wfRunHooks( 'SpecialPageExecuteBeforePage', array( &$this, &$par, &$func ) ) )
+                               return;
+                       $func( $par, $this );
+                       if ( ! wfRunHooks( 'SpecialPageExecuteAfterPage', array( &$this, &$par, &$func ) ) )
+                               return;
                } else {
                        $this->displayRestrictionError();
                }
        }
 
+       function outputHeader() {
+               global $wgOut, $wgContLang;
+
+               $msg = $wgContLang->lc( $this->name() ) . '-summary';
+               $out = wfMsg( $msg );
+               if ( ! wfEmptyMsg( $msg, $out ) and  $out !== '' and ! $this->including() )
+                       $wgOut->addWikiText( $out );
+
+       }
+
        # Returns the name that goes in the <h1> in the special page itself, and also the name that
        # will be listed in Special:Specialpages
        #
@@ -338,6 +452,7 @@ class SpecialPage
        function setListed( $listed ) {
                return wfSetVar( $this->mListed, $listed );
        }
+
 }
 
 /**
@@ -350,3 +465,15 @@ class UnlistedSpecialPage extends SpecialPage
                SpecialPage::SpecialPage( $name, $restriction, false, $function, $file );
        }
 }
+
+/**
+ * Shortcut to construct an includable special  page
+ * @package MediaWiki
+ */
+class IncludableSpecialPage extends SpecialPage
+{
+       function IncludableSpecialPage( $name, $restriction = '', $listed = true, $function = false, $file = 'default' ) {
+               SpecialPage::SpecialPage( $name, $restriction, $listed, $function, $file, true );
+       }
+}
+?>