*/
var $mAddedRedirectParams = array();
/**
- * List of special pages, followed by parameters.
- * If the only parameter is a string, that is the page name.
- * Otherwise, it is an array. The format is one of:
- ** array( 'SpecialPage', name, right )
- ** array( 'IncludableSpecialPage', name, right, listed? )
- ** array( 'UnlistedSpecialPage', name, right )
- ** array( 'SpecialRedirectToSpecial', name, page to redirect to, special page param, ... )
+ * Current request context
+ * @var RequestContext
*/
- static public $mList = array(
- # Maintenance Reports
- 'BrokenRedirects' => array( 'SpecialPage', 'BrokenRedirects' ),
- 'Deadendpages' => array( 'SpecialPage', 'Deadendpages' ),
- 'DoubleRedirects' => array( 'SpecialPage', 'DoubleRedirects' ),
- 'Longpages' => array( 'SpecialPage', 'Longpages' ),
- 'Ancientpages' => array( 'SpecialPage', 'Ancientpages' ),
- 'Lonelypages' => array( 'SpecialPage', 'Lonelypages' ),
- 'Fewestrevisions' => array( 'SpecialPage', 'Fewestrevisions' ),
- 'Withoutinterwiki' => array( 'SpecialPage', 'Withoutinterwiki' ),
- 'Protectedpages' => 'SpecialProtectedpages',
- 'Protectedtitles' => 'SpecialProtectedtitles',
- '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' ),
- 'Unusedtemplates' => array( 'SpecialPage', 'Unusedtemplates' ),
- 'Unwatchedpages' => array( 'SpecialPage', 'Unwatchedpages', 'unwatchedpages' ),
- 'Wantedcategories' => array( 'SpecialPage', 'Wantedcategories' ),
- 'Wantedfiles' => array( 'SpecialPage', 'Wantedfiles' ),
- 'Wantedpages' => array( 'IncludableSpecialPage', 'Wantedpages' ),
- 'Wantedtemplates' => array( 'SpecialPage', 'Wantedtemplates' ),
-
- # List of pages
- 'Allpages' => 'SpecialAllpages',
- 'Prefixindex' => 'SpecialPrefixindex',
- 'Categories' => 'SpecialCategories',
- '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' => 'IPBlockForm',
- 'Ipblocklist' => 'IPUnblockForm',
- 'Unblock' => array( 'SpecialRedirectToSpecial', 'Unblock', 'Ipblocklist', false, array( 'uselang', 'ip', 'id' ), array( 'action' => 'unblock' ) ),
- 'Resetpass' => 'SpecialResetpass',
- 'DeletedContributions' => 'DeletedContributionsPage',
- 'Preferences' => 'SpecialPreferences',
- 'Contributions' => 'SpecialContributions',
- 'Listgrouprights' => 'SpecialListGroupRights',
- 'Listusers' => array( 'SpecialPage', 'Listusers' ),
- 'Listadmins' => array( 'SpecialRedirectToSpecial', 'Listadmins', 'Listusers', 'sysop' ),
- 'Listbots' => array( 'SpecialRedirectToSpecial', 'Listbots', 'Listusers', 'bot' ),
- 'Activeusers' => 'SpecialActiveUsers',
- 'Userrights' => 'UserrightsPage',
- 'DisableAccount' => 'SpecialDisableAccount',
-
- # Recent changes and logs
- 'Newimages' => array( 'IncludableSpecialPage', 'Newimages' ),
- 'Log' => 'SpecialLog',
- 'Watchlist' => array( 'SpecialPage', 'Watchlist' ),
- 'Newpages' => 'SpecialNewpages',
- 'Recentchanges' => 'SpecialRecentchanges',
- 'Recentchangeslinked' => 'SpecialRecentchangeslinked',
- 'Tags' => 'SpecialTags',
-
- # Media reports and uploads
- 'Listfiles' => array( 'SpecialPage', 'Listfiles' ),
- 'Filepath' => 'SpecialFilepath',
- 'MIMEsearch' => array( 'SpecialPage', 'MIMEsearch' ),
- 'FileDuplicateSearch' => array( 'SpecialPage', 'FileDuplicateSearch' ),
- 'Upload' => 'SpecialUpload',
- 'UploadStash' => 'SpecialUploadStash',
-
- # Wiki data and tools
- 'Statistics' => 'SpecialStatistics',
- 'Allmessages' => 'SpecialAllmessages',
- 'Version' => 'SpecialVersion',
- 'Lockdb' => 'SpecialLockdb',
- 'Unlockdb' => 'SpecialUnlockdb',
-
- # Redirecting special pages
- 'LinkSearch' => array( 'SpecialPage', 'LinkSearch' ),
- 'Randompage' => 'Randompage',
- 'Randomredirect' => 'SpecialRandomredirect',
-
- # 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
- 'ComparePages' => 'SpecialComparePages',
- 'Export' => 'SpecialExport',
- 'Import' => 'SpecialImport',
- 'Undelete' => 'UndeleteForm',
- 'Whatlinkshere' => 'SpecialWhatlinkshere',
- 'MergeHistory' => 'SpecialMergeHistory',
-
- # Other
- 'Booksources' => 'SpecialBookSources',
-
- # Unlisted / redirects
- 'Blankpage' => 'SpecialBlankpage',
- 'Blockme' => 'SpecialBlockme',
- 'Emailuser' => 'SpecialEmailUser',
- 'Movepage' => 'MovePageForm',
- 'Mycontributions' => 'SpecialMycontributions',
- 'Mypage' => 'SpecialMypage',
- 'Mytalk' => 'SpecialMytalk',
- 'Myuploads' => 'SpecialMyuploads',
- 'Revisiondelete' => 'SpecialRevisionDelete',
- 'RevisionMove' => 'SpecialRevisionMove',
- 'Specialpages' => 'SpecialSpecialpages',
- 'Userlogout' => 'SpecialUserlogout',
- );
-
- static public $mAliases;
- static public $mListInitialised = false;
-
- /**#@-*/
+ protected $mContext;
/**
* Initialise the special page list
* This must be called before accessing SpecialPage::$mList
+ * @deprecated since 1.18
*/
static function initList() {
- global $wgSpecialPages;
- global $wgDisableCounters, $wgDisableInternalSearch, $wgEmailAuthentication;
-
- if ( self::$mListInitialised ) {
- return;
- }
- wfProfileIn( __METHOD__ );
-
- # Better to set this now, to avoid infinite recursion in carelessly written hooks
- self::$mListInitialised = true;
-
- if( !$wgDisableCounters ) {
- self::$mList['Popularpages'] = array( 'SpecialPage', 'Popularpages' );
- }
-
- if( !$wgDisableInternalSearch ) {
- self::$mList['Search'] = array( 'SpecialPage', 'Search' );
- }
-
- if( $wgEmailAuthentication ) {
- self::$mList['Confirmemail'] = 'EmailConfirmation';
- self::$mList['Invalidateemail'] = 'EmailInvalidation';
- }
-
- # Add extension special pages
- self::$mList = array_merge( self::$mList, $wgSpecialPages );
-
- # Run hooks
- # This hook can be used to remove undesired built-in special pages
- wfRunHooks( 'SpecialPage_initList', array( &self::$mList ) );
- wfProfileOut( __METHOD__ );
+ // Noop
}
+ /**
+ * @deprecated since 1.18
+ */
static function initAliasList() {
- if ( !is_null( self::$mAliases ) ) {
- return;
- }
-
- global $wgContLang;
- $aliases = $wgContLang->getSpecialPageAliases();
- $missingPages = self::$mList;
- self::$mAliases = array();
- foreach ( $aliases as $realName => $aliasList ) {
- foreach ( $aliasList as $alias ) {
- self::$mAliases[$wgContLang->caseFold( $alias )] = $realName;
- }
- unset( $missingPages[$realName] );
- }
- foreach ( $missingPages as $name => $stuff ) {
- self::$mAliases[$wgContLang->caseFold( $name )] = $name;
- }
+ // Noop
}
/**
*
* @param $alias String
* @return String or false
+ * @deprecated since 1.18 call SpecialPageFactory method directly
*/
static function resolveAlias( $alias ) {
- global $wgContLang;
-
- if ( !self::$mListInitialised ) self::initList();
- if ( is_null( self::$mAliases ) ) self::initAliasList();
- $caseFoldedAlias = $wgContLang->caseFold( $alias );
- $caseFoldedAlias = str_replace( ' ', '_', $caseFoldedAlias );
- if ( isset( self::$mAliases[$caseFoldedAlias] ) ) {
- return self::$mAliases[$caseFoldedAlias];
- } else {
- return false;
- }
+ list( $name, /*...*/ ) = SpecialPageFactory::resolveAlias( $alias );
+ return $name;
}
/**
*
* @param $alias String
* @return Array
+ * @deprecated since 1.18 call SpecialPageFactory method directly
*/
static function resolveAliasWithSubpage( $alias ) {
- $bits = explode( '/', $alias, 2 );
- $name = self::resolveAlias( $bits[0] );
- if( !isset( $bits[1] ) ) { // bug 2087
- $par = null;
- } else {
- $par = $bits[1];
- }
- return array( $name, $par );
+ return SpecialPageFactory::resolveAlias( $alias );
}
/**
* an associative record to $wgSpecialPages. This avoids autoloading SpecialPage.
*
* @param $page SpecialPage
- * Deprecated in 1.7, warnings in 1.17, might be removed in 1.20
+ * @deprecated in 1.7, warnings in 1.17, might be removed in 1.20
*/
static function addPage( &$page ) {
wfDeprecated( __METHOD__ );
- if ( !self::$mListInitialised ) {
- self::initList();
- }
- self::$mList[$page->mName] = $page;
+ SpecialPageFactory::getList()->{$page->mName} = $page;
}
/**
*
* @param $page Mixed: SpecialPage or string
* @param $group String
+ * @deprecated since 1.18 call SpecialPageFactory method directly
*/
static function setGroup( $page, $group ) {
- global $wgSpecialPageGroups;
- $name = is_object($page) ? $page->mName : $page;
- $wgSpecialPageGroups[$name] = $group;
+ return SpecialPageFactory::setGroup( $page, $group );
}
/**
* Add a page to a certain display group for Special:SpecialPages
*
* @param $page SpecialPage
+ * @deprecated since 1.18 call SpecialPageFactory method directly
*/
static function getGroup( &$page ) {
- global $wgSpecialPageGroups;
- static $specialPageGroupsCache = array();
- if( isset($specialPageGroupsCache[$page->mName]) ) {
- return $specialPageGroupsCache[$page->mName];
- }
- $group = wfMsg('specialpages-specialpagegroup-'.strtolower($page->mName));
- if( $group == ''
- || wfEmptyMsg('specialpages-specialpagegroup-'.strtolower($page->mName), $group ) ) {
- $group = isset($wgSpecialPageGroups[$page->mName])
- ? $wgSpecialPageGroups[$page->mName]
- : '-';
- }
- if( $group == '-' ) $group = 'other';
- $specialPageGroupsCache[$page->mName] = $group;
- return $group;
+ return SpecialPageFactory::getGroup( $page );
}
/**
* Remove a special page from the list
* Formerly used to disable expensive or dangerous special pages. The
* preferred method is now to add a SpecialPage_initList hook.
+ * @deprecated since 1.18
*/
static function removePage( $name ) {
- if ( !self::$mListInitialised ) {
- self::initList();
- }
- unset( self::$mList[$name] );
+ unset( SpecialPageFactory::getList()->$name );
}
/**
*
* @param $name String: name of a special page
* @return Boolean: true if a special page exists with this name
+ * @deprecated since 1.18 call SpecialPageFactory method directly
*/
static function exists( $name ) {
- global $wgContLang;
- if ( !self::$mListInitialised ) {
- self::initList();
- }
- if( !self::$mAliases ) {
- self::initAliasList();
- }
-
- # Remove special pages inline parameters:
- $bits = explode( '/', $name );
- $name = $wgContLang->caseFold($bits[0]);
-
- return
- array_key_exists( $name, self::$mList )
- or array_key_exists( $name, self::$mAliases )
- ;
+ return SpecialPageFactory::exists( $name );
}
/**
*
* @param $name String
* @return SpecialPage object or null if the page doesn't exist
+ * @deprecated since 1.18 call SpecialPageFactory method directly
*/
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 SpecialPageFactory::getPage( $name );
}
/**
* is no such special page.
*
* @return SpecialPage object or null if the page doesn't exist
+ * @deprecated since 1.18 call SpecialPageFactory method directly
*/
static function getPageByAlias( $alias ) {
- $realName = self::resolveAlias( $alias );
- if ( $realName ) {
- return self::getPage( $realName );
- } else {
- return null;
- }
+ return SpecialPageFactory::getPage( $alias );
}
/**
* for the current user, and everyone.
*
* @return Associative array mapping page's name to its SpecialPage object
+ * @deprecated since 1.18 call SpecialPageFactory method directly
*/
static function getUsablePages() {
- global $wgUser;
- if ( !self::$mListInitialised ) {
- self::initList();
- }
- $pages = array();
-
- foreach ( self::$mList as $name => $rec ) {
- $page = self::getPage( $name );
- if ( $page->isListed()
- && (
- !$page->isRestricted()
- || $page->userCanExecute( $wgUser )
- )
- ) {
- $pages[$name] = $page;
- }
- }
- return $pages;
+ return SpecialPageFactory::getUsablePages();
}
/**
* Return categorised listable special pages for all users
*
* @return Associative array mapping page's name to its SpecialPage object
+ * @deprecated since 1.18 call SpecialPageFactory method directly
*/
static function getRegularPages() {
- if ( !self::$mListInitialised ) {
- self::initList();
- }
- $pages = array();
-
- foreach ( self::$mList as $name => $rec ) {
- $page = self::getPage( $name );
- if ( $page->isListed() && !$page->isRestricted() ) {
- $pages[$name] = $page;
- }
- }
- return $pages;
+ return SpecialPageFactory::getRegularPages();
}
/**
* for the current user, but not for everyone
*
* @return Associative array mapping page's name to its SpecialPage object
+ * @deprecated since 1.18 call SpecialPageFactory method directly
*/
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()
- && $page->isRestricted()
- && $page->userCanExecute( $wgUser )
- ) {
- $pages[$name] = $page;
- }
- }
- return $pages;
+ return SpecialPageFactory::getRestrictedPages();
}
/**
* Execute a special page path.
- * The path may contain parameters, e.g. Special:Name/Params
+ * The path may contain parameters, e.g. Special:Name/Params
* Extracts the special page name and call the execute method, passing the parameters
*
* 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}}
+ * @param $title Title object
+ * @param $context RequestContext
+ * @param $including Bool output is being captured for use in {{special:whatever}}
+ * @deprecated since 1.18 call SpecialPageFactory method directly
*/
- static function executePath( &$title, $including = false ) {
- global $wgOut, $wgTitle, $wgRequest;
- wfProfileIn( __METHOD__ );
-
- # FIXME: redirects broken due to this call
- $bits = explode( '/', $title->getDBkey(), 2 );
- $name = $bits[0];
- if( !isset( $bits[1] ) ) { // bug 2087
- $par = null;
- } else {
- $par = $bits[1];
- }
- $page = SpecialPage::getPageByAlias( $name );
- # Nonexistent?
- if ( !$page ) {
- if ( !$including ) {
- $wgOut->setArticleRelated( false );
- $wgOut->setRobotPolicy( 'noindex,nofollow' );
- $wgOut->setStatusCode( 404 );
- $wgOut->showErrorPage( 'nosuchspecialpage', 'nospecialpagetext' );
- }
- wfProfileOut( __METHOD__ );
- return false;
- }
-
- # Check for redirect
- if ( !$including ) {
- $redirect = $page->getRedirect( $par );
- if ( $redirect ) {
- $query = $page->getRedirectQuery();
- $url = $redirect->getFullUrl( $query );
- $wgOut->redirect( $url );
- wfProfileOut( __METHOD__ );
- return $redirect;
- }
- }
-
- # Redirect to canonical alias for GET commands
- # Not for POST, we'd lose the post data, so it's best to just distribute
- # the request. Such POST requests are possible for old extensions that
- # generate self-links without being aware that their default name has
- # changed.
- if ( !$including && $name != $page->getLocalName() && !$wgRequest->wasPosted() ) {
- $query = $_GET;
- unset( $query['title'] );
- $query = wfArrayToCGI( $query );
- $title = $page->getTitle( $par );
- $url = $title->getFullUrl( $query );
- $wgOut->redirect( $url );
- wfProfileOut( __METHOD__ );
- return $redirect;
- }
-
- if ( $including && !$page->includable() ) {
- wfProfileOut( __METHOD__ );
- return false;
- } elseif ( !$including ) {
- $wgTitle = $page->getTitle();
- }
- $page->including( $including );
-
- // Execute special page
- $profName = 'Special:' . $page->name();
- wfProfileIn( $profName );
- $page->execute( $par );
- wfProfileOut( $profName );
- wfProfileOut( __METHOD__ );
- return true;
+ public static function executePath( &$title, RequestContext &$context, $including = false ) {
+ return SpecialPageFactory::executePath( $title, $context, $including );
}
/**
* a redirect.
*
* @return String: HTML fragment
+ * @deprecated since 1.18 call SpecialPageFactory method directly
*/
static function capturePath( &$title ) {
- global $wgOut, $wgTitle;
-
- $oldTitle = $wgTitle;
- $oldOut = $wgOut;
- $wgOut = new OutputPage;
- $wgOut->setTitle( $title );
-
- $ret = SpecialPage::executePath( $title, true );
- if ( $ret === true ) {
- $ret = $wgOut->getHTML();
- }
- $wgTitle = $oldTitle;
- $wgOut = $oldOut;
- return $ret;
+ return SpecialPageFactory::capturePath( $title );
}
/**
* @param $subpage Mixed: boolean false, or string
*
* @return String
+ * @deprecated since 1.18 call SpecialPageFactory method directly
*/
static function getLocalNameFor( $name, $subpage = false ) {
- global $wgContLang;
- $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 aliases are defined for it?" );
- }
- }
- if ( $subpage !== false && !is_null( $subpage ) ) {
- $name = "$name/$subpage";
- }
- return $wgContLang->ucfirst( $name );
+ return SpecialPageFactory::getLocalNameFor( $name, $subpage );
}
/**
*
* @return Title object
*/
- static function getTitleFor( $name, $subpage = false ) {
- $name = self::getLocalNameFor( $name, $subpage );
+ public static function getTitleFor( $name, $subpage = false ) {
+ $name = SpecialPageFactory::getLocalNameFor( $name, $subpage );
if ( $name ) {
return Title::makeTitle( NS_SPECIAL, $name );
} else {
*
* @return Title object or null if the page doesn't exist
*/
- static function getSafeTitleFor( $name, $subpage = false ) {
- $name = self::getLocalNameFor( $name, $subpage );
+ public static function getSafeTitleFor( $name, $subpage = false ) {
+ $name = SpecialPageFactory::getLocalNameFor( $name, $subpage );
if ( $name ) {
return Title::makeTitleSafe( NS_SPECIAL, $name );
} else {
* Get a title for a given alias
*
* @return Title or null if there is no such alias
+ * @deprecated since 1.18 call SpecialPageFactory method directly
*/
static function getTitleForAlias( $alias ) {
- $name = self::resolveAlias( $alias );
- if ( $name ) {
- return self::getTitleFor( $name );
- } else {
- return null;
- }
+ return SpecialPageFactory::getTitleForAlias( $alias );
}
/**
* @param $file String: file which is included by execute(). It is also constructed from $name by default
* @param $includable Boolean: whether the page can be included in normal pages
*/
- function __construct( $name = '', $restriction = '', $listed = true, $function = false, $file = 'default', $includable = false ) {
+ public function __construct( $name = '', $restriction = '', $listed = true, $function = false, $file = 'default', $includable = false ) {
+ $this->init( $name, $restriction, $listed, $function, $file, $includable );
+ }
+
+ /**
+ * Do the real work for the constructor, mainly so __call() can intercept
+ * calls to SpecialPage()
+ * @see __construct() for param docs
+ */
+ private function init( $name, $restriction, $listed, $function, $file, $includable ) {
$this->mName = $name;
$this->mRestriction = $restriction;
$this->mListed = $listed;
}
}
- /**#@+
- * Accessor
- *
- * @deprecated
- */
+ /**
+ * Use PHP's magic __call handler to get calls to the old PHP4 constructor
+ * because PHP E_STRICT yells at you for having __construct() and SpecialPage()
+ *
+ * @param $fName String Name of called method
+ * @param $a Array Arguments to the method
+ * @deprecated since 1.17, call parent::__construct()
+ */
+ public function __call( $fName, $a ) {
+ // Sometimes $fName is SpecialPage, sometimes it's specialpage. <3 PHP
+ if( strtolower( $fName ) == 'specialpage' ) {
+ // Deprecated messages now, remove in 1.19 or 1.20?
+ wfDeprecated( __METHOD__ );
+
+ $name = isset( $a[0] ) ? $a[0] : '';
+ $restriction = isset( $a[1] ) ? $a[1] : '';
+ $listed = isset( $a[2] ) ? $a[2] : true;
+ $function = isset( $a[3] ) ? $a[3] : false;
+ $file = isset( $a[4] ) ? $a[4] : 'default';
+ $includable = isset( $a[5] ) ? $a[5] : false;
+ $this->init( $name, $restriction, $listed, $function, $file, $includable );
+ } else {
+ $className = get_class( $this );
+ throw new MWException( "Call to undefined method $className::$fName" );
+ }
+ }
+
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) {
# Use the one below this
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 ); }
- /**#@-*/
/**
* Get the localised name of the special page
*/
function getLocalName() {
if ( !isset( $this->mLocalName ) ) {
- $this->mLocalName = self::getLocalNameFor( $this->mName );
+ $this->mLocalName = SpecialPageFactory::getLocalNameFor( $this->mName );
}
return $this->mLocalName;
}
+ /**
+ * Is this page expensive (for some definition of expensive)?
+ * Expensive pages are disabled or cached in miser mode. Originally used
+ * (and still overridden) by QueryPage and subclasses, moved here so that
+ * Special:SpecialPages can safely call it for all special pages.
+ *
+ * @return Boolean
+ */
+ public function isExpensive() {
+ return false;
+ }
+
/**
* Can be overridden by subclasses with more complicated permissions
* schemes.
* Output an error message telling the user what access level they have to have
*/
function displayRestrictionError() {
- global $wgOut;
- $wgOut->permissionRequired( $this->mRestriction );
+ throw new PermissionsError( $this->mRestriction );
}
/**
* Sets headers - this should be called from the execute() method of all derived classes!
*/
function setHeaders() {
- global $wgOut;
- $wgOut->setArticleRelated( false );
- $wgOut->setRobotPolicy( "noindex,nofollow" );
- $wgOut->setPageTitle( $this->getDescription() );
+ $out = $this->getOutput();
+ $out->setArticleRelated( false );
+ $out->setRobotPolicy( "noindex,nofollow" );
+ $out->setPageTitle( $this->getDescription() );
}
/**
* Default execute method
* Checks user permissions, calls the function given in mFunction
*
- * This may be overridden by subclasses.
+ * This must be overridden by subclasses; it will be made abstract in a future version
*/
function execute( $par ) {
- global $wgUser;
-
$this->setHeaders();
- if ( $this->userCanExecute( $wgUser ) ) {
+ if ( $this->userCanExecute( $this->getUser() ) ) {
$func = $this->mFunction;
// only load file if the function does not exist
if(!is_callable($func) and $this->mFile) {
* @param $summaryMessageKey String: message key of the summary
*/
function outputHeader( $summaryMessageKey = '' ) {
- global $wgOut, $wgContLang;
+ global $wgContLang;
if( $summaryMessageKey == '' ) {
- $msg = $wgContLang->lc( $this->name() ) . '-summary';
+ $msg = $wgContLang->lc( $this->getName() ) . '-summary';
} else {
$msg = $summaryMessageKey;
}
- $out = wfMsgNoTrans( $msg );
- if ( ! wfEmptyMsg( $msg, $out ) and $out !== '' and ! $this->including() ) {
- $wgOut->wrapWikiMsg( "<div class='mw-specialpage-summary'>\n$1\n</div>", $msg );
+ if ( !wfMessage( $msg )->isBlank() and ! $this->including() ) {
+ $this->getOutput()->wrapWikiMsg( "<div class='mw-specialpage-summary'>\n$1\n</div>", $msg );
}
}
/**
* Set whether this page is listed in Special:Specialpages, at run-time
+ *
+ * @return Bool
*/
function setListed( $listed ) {
return wfSetVar( $this->mListed, $listed );
/**
* If the special page is a redirect, then get the Title object it redirects to.
* False otherwise.
+ *
+ * @return Title|false
*/
function getRedirect( $subpage ) {
return false;
* @return String
*/
function getRedirectQuery() {
- global $wgRequest;
$params = array();
+
foreach( $this->mAllowedRedirectParams as $arg ) {
- if( ( $val = $wgRequest->getVal( $arg, null ) ) !== null )
- $params[] = $arg . '=' . $val;
+ if( $this->getContext()->request->getVal( $arg, null ) !== null ){
+ $params[$arg] = $this->getContext()->request->getVal( $arg );
+ }
}
-
+
foreach( $this->mAddedRedirectParams as $arg => $val ) {
- $params[] = $arg . '=' . $val;
+ $params[$arg] = $val;
}
-
- return count( $params ) ? implode( '&', $params ) : false;
+
+ return count( $params )
+ ? $params
+ : false;
+ }
+
+ /**
+ * Sets the context this SpecialPage is executed in
+ *
+ * @param $context RequestContext
+ * @since 1.18
+ */
+ public function setContext( $context ) {
+ $this->mContext = $context;
+ }
+
+ /**
+ * Gets the context this SpecialPage is executed in
+ *
+ * @return RequestContext
+ * @since 1.18
+ */
+ public function getContext() {
+ if ( $this->mContext instanceof RequestContext ) {
+ return $this->mContext;
+ } else {
+ wfDebug( __METHOD__ . " called and \$mContext is null. Return RequestContext::getMain(); for sanity\n" );
+ return RequestContext::getMain();
+ }
+ }
+
+ /**
+ * Get the WebRequest being used for this instance
+ *
+ * @return WebRequest
+ * @since 1.18
+ */
+ public function getRequest() {
+ return $this->getContext()->getRequest();
+ }
+
+ /**
+ * Get the OutputPage being used for this instance
+ *
+ * @return OutputPage
+ * @since 1.18
+ */
+ public function getOutput() {
+ return $this->getContext()->getOutput();
+ }
+
+ /**
+ * Shortcut to get the skin being used for this instance
+ *
+ * @return User
+ * @since 1.18
+ */
+ public function getUser() {
+ return $this->getContext()->getUser();
+ }
+
+ /**
+ * Shortcut to get the skin being used for this instance
+ *
+ * @return Skin
+ * @since 1.18
+ */
+ public function getSkin() {
+ return $this->getContext()->getSkin();
+ }
+
+ /**
+ * Return the full title, including $par
+ *
+ * @return Title
+ * @since 1.18
+ */
+ public function getFullTitle() {
+ return $this->getContext()->getTitle();
+ }
+
+ /**
+ * Wrapper around wfMessage that sets the current context. Currently this
+ * is only the title.
+ *
+ * @see wfMessage
+ */
+ public function msg( /* $args */ ) {
+ return call_user_func_array( 'wfMessage', func_get_args() )->title( $this->getFullTitle() );
}
}
* Shortcut to construct a special page alias.
* @ingroup SpecialPage
*/
-class SpecialRedirectToSpecial extends UnlistedSpecialPage {
+abstract class SpecialRedirectToSpecial extends UnlistedSpecialPage {
var $redirName, $redirSubpage;
function __construct( $name, $redirName, $redirSubpage = false, $allowedRedirectParams = array(), $addedRedirectParams = array() ) {
}
}
-/** SpecialMypage, SpecialMytalk and SpecialMycontributions special pages
+/**
+ * ListAdmins --> ListUsers/admin
+ */
+class SpecialListAdmins extends SpecialRedirectToSpecial {
+ function __construct(){
+ parent::__construct( 'ListAdmins', 'ListUsers', 'sysop' );
+ }
+}
+
+/**
+ * ListBots --> ListUsers/admin
+ */
+class SpecialListBots extends SpecialRedirectToSpecial {
+ function __construct(){
+ parent::__construct( 'ListAdmins', 'ListUsers', 'bot' );
+ }
+}
+
+/**
+ * CreateAccount --> UserLogin/signup
+ * FIXME: this (and the rest of the login frontend) needs to die a horrible painful death
+ */
+class SpecialCreateAccount extends SpecialRedirectToSpecial {
+ function __construct(){
+ parent::__construct( 'CreateAccount', 'Userlogin', 'signup', array( 'uselang' ) );
+ }
+}
+/**
+ * SpecialMypage, SpecialMytalk and SpecialMycontributions special pages
* are used to get user independant links pointing to the user page, talk
* page and list of contributions.
* This can let us cache a single copy of any generated content for all
function getRedirect( $subpage ) {
global $wgUser;
- return SpecialPage::getTitleFor( 'Contributions', $wgUser->getName() );
+ return SpecialPageFactory::getTitleFor( 'Contributions', $wgUser->getName() );
}
}
parent::__construct( 'Myuploads' );
$this->mAllowedRedirectParams = array( 'limit' );
}
-
+
function getRedirect( $subpage ) {
global $wgUser;
- return SpecialPage::getTitleFor( 'Listfiles', $wgUser->getName() );
+ return SpecialPageFactory::getTitleFor( 'Listfiles', $wgUser->getName() );
}
-}
\ No newline at end of file
+}
+
+/**
+ * Redirect from Special:PermanentLink/### to index.php?oldid=###
+ */
+class SpecialPermanentLink extends UnlistedSpecialPage {
+ function __construct() {
+ parent::__construct( 'PermanentLink' );
+ $this->mAllowedRedirectParams = array();
+ }
+
+ function getRedirect( $subpage ) {
+ $subpage = intval( $subpage );
+ $this->mAddedRedirectParams['oldid'] = $subpage;
+ return true;
+ }
+}