<?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
*/
-
/**
* @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' ),
-
- 'Recentchanges' => new IncludableSpecialPage( 'Recentchanges' ),
- 'Upload' => new SpecialPage( 'Upload' ),
- 'Imagelist' => new SpecialPage( 'Imagelist' ),
- 'Newimages' => new IncludableSpecialPage( 'Newimages' ),
- 'Listusers' => new SpecialPage( 'Listusers' ),
- 'Statistics' => new SpecialPage( 'Statistics' ),
- 'Random' => new SpecialPage( 'Randompage' ),
- 'Lonelypages' => new SpecialPage( 'Lonelypages' ),
- 'Uncategorizedpages'=> new SpecialPage( 'Uncategorizedpages' ),
- 'Uncategorizedcategories'=> new SpecialPage( 'Uncategorizedcategories' ),
- 'Unusedcategories' => new SpecialPage( 'Unusedcategories' ),
- 'Unusedimages' => new SpecialPage( 'Unusedimages' ),
- 'Wantedpages' => new SpecialPage( 'Wantedpages' ),
- 'Mostlinked' => new SpecialPage( 'Mostlinked' ),
- 'Shortpages' => new SpecialPage( 'Shortpages' ),
- 'Longpages' => new SpecialPage( 'Longpages' ),
- 'Newpages' => new IncludableSpecialPage( 'Newpages' ),
- 'Ancientpages' => new SpecialPage( 'Ancientpages' ),
- 'Deadendpages' => new SpecialPage( 'Deadendpages' ),
- 'Allpages' => new IncludableSpecialPage( 'Allpages' ),
- 'Prefixindex' => new IncludableSpecialPage( 'Prefixindex' ) ,
- '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' ),
- "Import" => new SpecialPage( "Import", 'import' ),
- 'Lockdb' => new SpecialPage( 'Lockdb', 'siteadmin' ),
- 'Unlockdb' => new SpecialPage( 'Unlockdb', 'siteadmin' ),
- 'Userrights' => new SpecialPage( 'Userrights', 'userrights' ),
- 'MIMEsearch' => new SpecialPage( 'MIMEsearch' ),
- 'Unwatchedpages' => new SpecialPage( 'Unwatchedpages' )
-);
-
-if ( $wgUseValidation )
- $wgSpecialPages['Validate'] = new SpecialPage( 'Validate' );
-
-if( !$wgDisableCounters ) {
- $wgSpecialPages['Popularpages'] = new SpecialPage( 'Popularpages' );
-}
-
-if( !$wgDisableInternalSearch ) {
- $wgSpecialPages['Search'] = new SpecialPage( 'Search' );
-}
-
-if( $wgEmailAuthentication ) {
- $wgSpecialPages['Confirmemail'] = new UnlistedSpecialPage( 'Confirmemail' );
-}
-
-if ( $wgEnableUnwatchedpages )
- $wgSpecialPages['Unwatchedpages'] = new SpecialPage( 'Unwatchedpages' );
/**
* Parent special page class, also static functions for handling the special
*/
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;
/**#@-*/
+ /**
+ * Initialise the special page list
+ * This must be called before accessing SpecialPage::$mList
+ */
+ static function initList() {
+ global $wgSpecialPages;
+ 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
- * $obj->execute() must send HTML to $wgOut then return
- * Use this for a special page extension
+ * 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
*/
- function addPage( &$obj ) {
- global $wgSpecialPages;
- $wgSpecialPages[$obj->mName] = $obj;
+ 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] );
}
/**
* @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;
}
}
+
/**
* @static
* @param string $name
* @return mixed Title object if the redirect exists, otherwise NULL
*/
- function getRedirect( $name ) {
+ static function getRedirect( $name ) {
global $wgUser;
- switch ( $name ) {
+
+ $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':
- return Title::makeTitle( NS_USER, $wgUser->getName() );
case 'Mytalk':
- return Title::makeTitle( NS_USER_TALK, $wgUser->getName() );
- case 'Mycontributions':
- return Title::makeTitle( NS_SPECIAL, 'Contributions/' . $wgUser->getName() );
- case 'Listadmins':
- return Title::makeTitle( NS_SPECIAL, 'Listusers/sysop' ); # @bug 2832
case 'Randompage':
- return Title::makeTitle( NS_SPECIAL, 'Random' );
- default:
- return NULL;
+ $args = array( 'action' );
}
+
+ $params = array();
+ foreach( $args as $arg ) {
+ if( $val = $wgRequest->getVal( $arg, false ) )
+ $params[] = $arg . '=' . $val;
+ }
+
+ return count( $params ) ? implode( '&', $params ) : false;
+ }
+
+ /**
+ * 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
- * Returns a 2d array where the first index is the restriction name
+ * Return categorised listable special pages which are available
+ * for the current user, but not for everyone
* @static
*/
- function getPages() {
- global $wgSpecialPages;
- $pages = array(
- '' => array(),
- 'sysop' => array(),
- 'developer' => array()
- );
+ static function getRestrictedPages() {
+ global $wgUser;
+ if ( !self::$mListInitialised ) {
+ self::initList();
+ }
+ $pages = array();
- foreach ( $wgSpecialPages as $name => $page ) {
+ 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;
* @param $title a title object
* @param $including output is being captured for use in {{special:whatever}}
*/
- function executePath( &$title, $including = false ) {
- global $wgSpecialPages, $wgOut, $wgTitle;
+ static function executePath( &$title, $including = false ) {
+ global $wgOut, $wgTitle;
$fname = 'SpecialPage::executePath';
wfProfileIn( $fname );
} else {
$redir = SpecialPage::getRedirect( $name );
if ( isset( $redir ) ) {
- if ( isset( $par ) )
- $wgOut->redirect( $redir->getFullURL() . '/' . $par );
- else
- $wgOut->redirect( $redir->getFullURL() );
+ 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,follow" );
- $wgOut->errorpage( "nosuchspecialpage", "nospecialpagetext" );
+ $wgOut->setRobotpolicy( 'noindex,nofollow' );
+ $wgOut->setStatusCode( 404 );
+ $wgOut->showErrorPage( 'nosuchspecialpage', 'nospecialpagetext' );
$retVal = false;
}
}
if ( $including && !$page->includable() ) {
wfProfileOut( $fname );
return false;
- }
- if($par !== NULL) {
- $wgTitle = Title::makeTitle( NS_SPECIAL, $name );
- } else {
- $wgTitle = $title;
+ } elseif ( !$including ) {
+ if($par !== NULL) {
+ $wgTitle = Title::makeTitle( NS_SPECIAL, $name );
+ } else {
+ $wgTitle = $title;
+ }
}
$page->including( $including );
* a redirect.
* @static
*/
- function capturePath( &$title ) {
+ static function capturePath( &$title ) {
global $wgOut, $wgTitle;
$oldTitle = $wgTitle;
* 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
}
}
- # 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 including( $x = NULL ) { return wfSetVar( $this->mIncluding, $x ); }
+ 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 );
}
/**
function setHeaders() {
global $wgOut;
$wgOut->setArticleRelated( false );
- $wgOut->setRobotPolicy( "noindex,follow" );
+ $wgOut->setRobotPolicy( "noindex,nofollow" );
$wgOut->setPageTitle( $this->getDescription() );
}
* Checks user permissions, calls the function given in mFunction
*/
function execute( $par ) {
- global $wgUser, $wgOut, $wgTitle;
+ global $wgUser;
$this->setHeaders();
if(!function_exists($func) and $this->mFile) {
require_once( $this->mFile );
}
+ 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
#
dépôts / lhc / web / wiklou.git / blobdiff