* Non-working API to facilitate dev collaboration. Do not enable this yet in localset...
[lhc/web/wiklou.git] / includes / SpecialPage.php
index 3d7cba2..294c05e 100644 (file)
 <?php
 /**
- * SpecialPage: handling special pages and lists thereof
- * $wgSpecialPages is a list of all SpecialPage objects. These objects are
- * either instances of SpecialPage or a sub-class thereof. They 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.
+ * SpecialPage: handling special pages and lists thereof.
  *
- * To add a special page at run-time, use SpecialPage::addPage().
- * DO NOT manipulate this array at run-time.
+ * 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 
+ * and bails out if not.
+ *
+ * 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.
  *
  * @package MediaWiki
  * @subpackage SpecialPage
  */
 
-
-/**
- *
- */
-global $wgSpecialPages;
-
 /**
  * @access private
  */
-$wgSpecialPages = array(
-       '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' ),
-       'Upload'            => new SpecialPage( 'Upload' ),
-       'Imagelist'         => new SpecialPage( 'Imagelist' ),
-       'Newimages'         => new SpecialPage( 'Newimages' ),
-       'Listusers'         => new SpecialPage( 'Listusers' ),
-       'Listadmins'        => new UnlistedSpecialPage( 'Listadmins' ),
-       'Statistics'        => new SpecialPage( 'Statistics' ),
-       'Randompage'        => new SpecialPage( 'Randompage' ),
-       'Lonelypages'       => new SpecialPage( 'Lonelypages' ),
-       'Uncategorizedpages'=> new SpecialPage( 'Uncategorizedpages' ),
-       'Uncategorizedcategories'=> new SpecialPage( 'Uncategorizedcategories' ),
-       'Unusedimages'      => new SpecialPage( 'Unusedimages' )
-);
-
-global $wgUseValidation ;
-if ( $wgUseValidation )
-       $wgSpecialPages['Validate'] = new SpecialPage( 'Validate' );
-
-global $wgDisableCounters;
-if( !$wgDisableCounters ) {
-       $wgSpecialPages['Popularpages'] = new SpecialPage( 'Popularpages' );
-}
-
-global $wgDisableInternalSearch;
-if( !$wgDisableInternalSearch ) {
-       $wgSpecialPages['Search'] = new UnlistedSpecialPage( 'Search' );
-}
-
-global $wgEmailAuthentication;
-if( $wgEmailAuthentication ) {
-       $wgSpecialPages['Confirmemail'] = new UnlistedSpecialPage( 'Confirmemail' );
-}
-
-$wgSpecialPages = array_merge($wgSpecialPages, array (
-       'Wantedpages'   => new SpecialPage( 'Wantedpages' ),
-       'Shortpages'    => new SpecialPage( 'Shortpages' ),
-       'Longpages'             => new SpecialPage( 'Longpages' ),
-       'Newpages'              => new SpecialPage( 'Newpages' ),
-       'Ancientpages'  => new SpecialPage( 'Ancientpages' ),
-       'Deadendpages'  => new SpecialPage( 'Deadendpages' ),
-       'Allpages'              => new SpecialPage( 'Allpages' ),
-       'Ipblocklist'   => new SpecialPage( 'Ipblocklist' ),
-       'Specialpages'  => new UnlistedSpecialPage( 'Specialpages' ),
-       'Contributions' => new UnlistedSpecialPage( 'Contributions' ),
-       'Emailuser'             => new UnlistedSpecialPage( 'Emailuser' ),
-       'Whatlinkshere' => new UnlistedSpecialPage( 'Whatlinkshere' ),
-       'Recentchangeslinked' => new UnlistedSpecialPage( 'Recentchangeslinked' ),
-       'Movepage'              => new UnlistedSpecialPage( 'Movepage' ),
-       'Blockme'       => new UnlistedSpecialPage( 'Blockme' ),
-       'Booksources'   => new SpecialPage( 'Booksources' ),
-       'Categories'    => new SpecialPage( 'Categories' ),
-       'Export'                => new SpecialPage( 'Export' ),
-       'Version'               => new SpecialPage( 'Version' ),
-       'Allmessages'   => new SpecialPage( 'Allmessages' ),
-       'Log'           => new SpecialPage( 'Log' ),
-       'Blockip'               => new SpecialPage( 'Blockip', 'block' ),
-       'Undelete'              => new SpecialPage( 'Undelete', 'delete' ),
-       "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' ),
-));
 
 /**
  * Parent special page class, also static functions for handling the special
@@ -135,27 +57,151 @@ 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;
+
+       static public $mList = array(
+               'DoubleRedirects'       => array( 'SpecialPage', 'DoubleRedirects' ),
+               'BrokenRedirects'       => array( 'SpecialPage', 'BrokenRedirects' ),
+               'Disambiguations'       => array( 'SpecialPage', 'Disambiguations' ),
+
+               'Userlogin'         => array( 'SpecialPage', 'Userlogin' ),
+               'Userlogout'        => array( 'UnlistedSpecialPage', 'Userlogout' ),
+               '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' ),
+               'Statistics'        => array( 'SpecialPage', 'Statistics' ),
+               'Random'            => array( 'SpecialPage', 'Randompage' ),
+               'Lonelypages'       => array( 'SpecialPage', 'Lonelypages' ),
+               'Uncategorizedpages'=> array( 'SpecialPage', 'Uncategorizedpages' ),
+               'Uncategorizedcategories'=> array( 'SpecialPage', 'Uncategorizedcategories' ),
+               'Uncategorizedimages' => array( 'SpecialPage', 'Uncategorizedimages' ),
+               'Unusedcategories'      => array( 'SpecialPage', 'Unusedcategories' ),
+               'Unusedimages'      => array( 'SpecialPage', 'Unusedimages' ),
+               'Wantedpages'       => array( 'IncludableSpecialPage', 'Wantedpages' ),
+               'Wantedcategories'  => array( 'SpecialPage', 'Wantedcategories' ),
+               'Mostlinked'        => array( 'SpecialPage', 'Mostlinked' ),
+               'Mostlinkedcategories' => array( 'SpecialPage', 'Mostlinkedcategories' ),
+               'Mostcategories'    => array( 'SpecialPage', 'Mostcategories' ),
+               'Mostimages'        => array( 'SpecialPage', 'Mostimages' ),
+               'Mostrevisions'     => array( 'SpecialPage', 'Mostrevisions' ),
+               'Shortpages'        => array( 'SpecialPage', 'Shortpages' ),
+               'Longpages'                 => array( 'SpecialPage', 'Longpages' ),
+               'Newpages'                  => array( 'IncludableSpecialPage', 'Newpages' ),
+               'Ancientpages'      => array( 'SpecialPage', 'Ancientpages' ),
+               'Deadendpages'      => array( 'SpecialPage', 'Deadendpages' ),
+               'Allpages'                  => array( 'IncludableSpecialPage', 'Allpages' ),
+               'Prefixindex'       => array( 'IncludableSpecialPage', 'Prefixindex' ) ,
+               'Ipblocklist'       => array( 'SpecialPage', 'Ipblocklist' ),
+               'Specialpages'      => array( 'UnlistedSpecialPage', 'Specialpages' ),
+               'Contributions'     => array( 'UnlistedSpecialPage', 'Contributions' ),
+               'Emailuser'                 => array( 'UnlistedSpecialPage', 'Emailuser' ),
+               'Whatlinkshere'     => array( 'UnlistedSpecialPage', 'Whatlinkshere' ),
+               'Recentchangeslinked' => array( 'UnlistedSpecialPage', 'Recentchangeslinked' ),
+               'Movepage'                  => array( 'UnlistedSpecialPage', 'Movepage' ),
+               'Blockme'           => array( 'UnlistedSpecialPage', 'Blockme' ),
+               'Booksources'       => array( 'SpecialPage', 'Booksources' ),
+               'Categories'        => array( 'SpecialPage', 'Categories' ),
+               'Export'                    => array( 'SpecialPage', 'Export' ),
+               'Version'                   => array( 'SpecialPage', 'Version' ),
+               'Allmessages'       => array( 'SpecialPage', 'Allmessages' ),
+               'Log'               => array( 'SpecialPage', 'Log' ),
+               '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' ),
+               'Userrights'        => array( 'SpecialPage', 'Userrights', 'userrights' ),
+               'MIMEsearch'        => array( 'SpecialPage', 'MIMEsearch' ),
+               'Unwatchedpages'    => array( 'SpecialPage', 'Unwatchedpages', 'unwatchedpages' ),
+               'Listredirects'     => array( 'SpecialPage', 'Listredirects' ),
+               'Revisiondelete'    => array( 'SpecialPage', 'Revisiondelete', 'deleterevision' ),
+               'Unusedtemplates'   => array( 'SpecialPage', 'Unusedtemplates' ),
+               'Randomredirect'    => array( 'SpecialPage', 'Randomredirect' ),
+       );
+
+       static public $mListInitialised = false;
+
        /**#@-*/
 
        /**
-        * Add a page to the list of valid special pages
-        * $obj->execute() must send HTML to $wgOut then return
-        * Use this for a special page extension
-        * @static
+        * Initialise the special page list
+        * This must be called before accessing SpecialPage::$mList
         */
-       function addPage( &$obj ) {
+       static function initList() {
                global $wgSpecialPages;
-               $wgSpecialPages[$obj->mName] = $obj;
+               global $wgDisableCounters, $wgDisableInternalSearch, $wgEmailAuthentication;
+
+               if ( self::$mListInitialised ) {
+                       return;
+               }
+               wfProfileIn( __METHOD__ );
+               
+               if( !$wgDisableCounters ) {
+                       self::$mList['Popularpages'] = array( 'SpecialPage', 'Popularpages' );
+               }
+
+               if( !$wgDisableInternalSearch ) {
+                       self::$mList['Search'] = array( 'SpecialPage', 'Search' );
+               }
+
+               if( $wgEmailAuthentication ) {
+                       self::$mList['Confirmemail'] = array( 'UnlistedSpecialPage', 'Confirmemail' );
+               }
+
+               # Add extension special pages
+               self::$mList = array_merge( self::$mList, $wgSpecialPages );
+
+               # Better to set this now, to avoid infinite recursion in carelessly written hooks
+               self::$mListInitialised = true;
+
+               # Run hooks
+               # This hook can be used to remove undesired built-in special pages
+               wfRunHooks( 'SpecialPage_initList', array( &self::$mList ) );
+               wfProfileOut( __METHOD__ );
+       }
+
+       /**
+        * 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.
+        * @static
+        */
+       static function addPage( &$page ) {
+               if ( !self::$mListInitialised ) {
+                       self::initList();
+               }
+               self::$mList[$page->mName] = $page;
        }
 
        /**
         * Remove a special page from the list
-        * Occasionally used to disable expensive or dangerous special pages
+        * Formerly used to disable expensive or dangerous special pages. The 
+        * preferred method is now to add a SpecialPage_initList hook.
+        * 
         * @static
         */
-       function removePage( $name ) {
-               global $wgSpecialPages;
-               unset( $wgSpecialPages[$name] );
+       static function removePage( $name ) {
+               if ( !self::$mListInitialised ) {
+                       self::initList();
+               }
+               unset( self::$mList[$name] );
        }
 
        /**
@@ -163,31 +209,113 @@ class SpecialPage
         * @static
         * @param string $name
         */
-       function &getPage( $name ) {
-               global $wgSpecialPages;
-               if ( array_key_exists( $name, $wgSpecialPages ) ) {
-                       return $wgSpecialPages[$name];
+       static function getPage( $name ) {
+               if ( !self::$mListInitialised ) {
+                       self::initList();
+               }
+               if ( array_key_exists( $name, self::$mList ) ) {
+                       $rec = self::$mList[$name];
+                       if ( is_string( $rec ) ) {
+                               $className = $rec;
+                               self::$mList[$name] = new $className;
+                       } elseif ( is_array( $rec ) ) {
+                               $className = array_shift( $rec );
+                               self::$mList[$name] = wfCreateObject( $className, $rec );
+                       }
+                       return self::$mList[$name];
                } else {
                        return NULL;
                }
        }
 
+
        /**
-        * Return categorised listable special pages
-        * Returns a 2d array where the first index is the restriction name
         * @static
+        * @param string $name
+        * @return mixed Title object if the redirect exists, otherwise NULL
         */
-       function getPages() {
-               global $wgSpecialPages;
-               $pages = array(
-                 '' => array(),
-                 'sysop' => array(),
-                 'developer' => array()
+       static 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
+                       'Logs' => Title::makeTitle( NS_SPECIAL, 'Log' ),
+                       'Randompage' => Title::makeTitle( NS_SPECIAL, 'Random' ),
+                       'Userlist' => Title::makeTitle( NS_SPECIAL, 'Listusers' )
                );
+               wfRunHooks( 'SpecialPageGetRedirect', array( &$redirects ) );
+
+               return isset( $redirects[$name] ) ? $redirects[$name] : null;
+       }
+
+       /**
+        * Return part of the request string for a special redirect page
+        * This allows passing, e.g. action=history to Special:Mypage, etc.
+        *
+        * @param $name Name of the redirect page
+        * @return string
+        */
+       function getRedirectParams( $name ) {
+               global $wgRequest;
+               
+               $args = array();
+               switch( $name ) {
+                       case 'Mypage':
+                       case 'Mytalk':
+                       case 'Randompage':
+                               $args = array( 'action' );
+               }
+               
+               $params = array();
+               foreach( $args as $arg ) {
+                       if( $val = $wgRequest->getVal( $arg, false ) )
+                               $params[] = $arg . '=' . $val;
+               }
+               
+               return count( $params ) ? implode( '&', $params ) : false;
+       }       
 
-               foreach ( $wgSpecialPages as $name => $page ) {
+       /**
+        * Return categorised listable special pages for all users
+        * @static
+        */
+       static function getRegularPages() {
+               if ( !self::$mListInitialised ) {
+                       self::initList();
+               }
+               $pages = array();
+
+               foreach ( self::$mList as $name => $rec ) {
+                       $page = self::getPage( $name );
+                       if ( $page->isListed() && $page->getRestriction() == '' ) {
+                               $pages[$name] = $page;
+                       }
+               }
+               return $pages;
+       }
+
+       /**
+        * Return categorised listable special pages which are available
+        * for the current user, but not for everyone
+        * @static
+        */
+       static function getRestrictedPages() {
+               global $wgUser;
+               if ( !self::$mListInitialised ) {
+                       self::initList();
+               }
+               $pages = array();
+
+               foreach ( self::$mList as $name => $rec ) {
+                       $page = self::getPage( $name );
                        if ( $page->isListed() ) {
-                               $pages[$page->getRestriction()][$page->getName()] =& $wgSpecialPages[$name];
+                               $restriction = $page->getRestriction();
+                               if ( $restriction != '' && $wgUser->isAllowed( $restriction ) ) {
+                                       $pages[$name] = $page;
+                               }
                        }
                }
                return $pages;
@@ -198,33 +326,96 @@ 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;
+       static 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" );
-               } else {
-                       if($par !== NULL) {
-                               $wgTitle = Title::makeTitle( NS_SPECIAL, $name );
+                       if ( $including ) {
+                               wfProfileOut( $fname );
+                               return false;
                        } else {
-                               $wgTitle = $title;
+                               $redir = SpecialPage::getRedirect( $name );
+                               if ( isset( $redir ) ) {
+                                       if( $par )
+                                               $redir = Title::makeTitle( $redir->getNamespace(), $redir->getText() . '/' . $par );
+                                       $params = SpecialPage::getRedirectParams( $name );
+                                       if( $params ) {
+                                               $url = $redir->getFullUrl( $params );
+                                       } else {
+                                               $url = $redir->getFullUrl();
+                                       }
+                                       $wgOut->redirect( $url );
+                                       $retVal = $redir;
+                                       $wgOut->redirect( $url );
+                                       $retVal = $redir;
+                               } else {
+                                       $wgOut->setArticleRelated( false );
+                                       $wgOut->setRobotpolicy( 'noindex,nofollow' );
+                                       $wgOut->setStatusCode( 404 );
+                                       $wgOut->showErrorPage( 'nosuchspecialpage', 'nospecialpagetext' );
+                                       $retVal = false;
+                               }
                        }
+               } else {
+                       if ( $including && !$page->includable() ) {
+                               wfProfileOut( $fname );
+                               return false;
+                       } elseif ( !$including ) {
+                               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
+        */
+       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;
        }
 
        /**
@@ -238,15 +429,16 @@ class SpecialPage
         *     and displayRestrictionError()
         *
         * @param string $name Name of the special page, as seen in links and URLs
-        * @param string $restriction Minimum user level required, e.g. "sysop" or "developer".
+        * @param string $restriction User right required, e.g. "block" or "delete"
         * @param boolean $listed Whether the page is listed in Special:Specialpages
         * @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 {
@@ -259,26 +451,35 @@ 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 isListed() { return $this->mListed; }
        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
         * special page (as defined by $mRestriction)
         */
        function userCanExecute( &$user ) {
-               if ( $this->mRestriction == "" ) {
-                       return true;
-               } else {
-                       if ( in_array( $this->mRestriction, $user->getRights() ) ) {
-                               return true;
-                       } else {
-                               return false;
-                       }
-               }
+               return $user->isAllowed( $this->mRestriction );
        }
 
        /**
@@ -286,11 +487,7 @@ class SpecialPage
         */
        function displayRestrictionError() {
                global $wgOut;
-               if ( $this->mRestriction == "developer" ) {
-                       $wgOut->developerRequired();
-               } else {
-                       $wgOut->sysopRequired();
-               }
+               $wgOut->permissionRequired( $this->mRestriction );
        }
 
        /**
@@ -299,7 +496,7 @@ class SpecialPage
        function setHeaders() {
                global $wgOut;
                $wgOut->setArticleRelated( false );
-               $wgOut->setRobotPolicy( "noindex,follow" );
+               $wgOut->setRobotPolicy( "noindex,nofollow" );
                $wgOut->setPageTitle( $this->getDescription() );
        }
 
@@ -308,21 +505,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
        #
@@ -345,6 +559,7 @@ class SpecialPage
        function setListed( $listed ) {
                return wfSetVar( $this->mListed, $listed );
        }
+
 }
 
 /**
@@ -357,4 +572,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 );
+       }
+}
 ?>