diff options
Diffstat (limited to 'includes/SpecialPage.php')
| -rw-r--r-- | includes/SpecialPage.php | 1164 |
1 files changed, 599 insertions, 565 deletions
diff --git a/includes/SpecialPage.php b/includes/SpecialPage.php index 12ad517a..0b21326a 100644 --- a/includes/SpecialPage.php +++ b/includes/SpecialPage.php @@ -28,235 +28,53 @@ * @ingroup SpecialPage */ class SpecialPage { - /**#@+ - * @access private - */ - /** - * The canonical name of this special page - * Also used for the default <h1> heading, @see getDescription() - */ - var $mName; - /** - * The local name of this special page - */ - var $mLocalName; - /** - * Minimum user level required to access this page, or "" for anyone. - * Also used to categorise the pages in Special:Specialpages - */ - var $mRestriction; - /** - * Listed in Special:Specialpages? - */ - var $mListed; - /** - * Function name called by the default execute() - */ - var $mFunction; - /** - * 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; - /** - * Query parameters that can be passed through redirects - */ - var $mAllowedRedirectParams = array(); - /** - * Query parameteres added by redirects - */ - 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, ... ) - */ - 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', - - # 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', - 'Specialpages' => 'SpecialSpecialpages', - 'Userlogout' => 'SpecialUserlogout', - ); - - static public $mAliases; - 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; + // The canonical name of this special page + // Also used for the default <h1> heading, @see getDescription() + /*private*/ var $mName; - if ( self::$mListInitialised ) { - return; - } - wfProfileIn( __METHOD__ ); + // The local name of this special page + private $mLocalName; - # Better to set this now, to avoid infinite recursion in carelessly written hooks - self::$mListInitialised = true; + // Minimum user level required to access this page, or "" for anyone. + // Also used to categorise the pages in Special:Specialpages + private $mRestriction; - if( !$wgDisableCounters ) { - self::$mList['Popularpages'] = array( 'SpecialPage', 'Popularpages' ); - } + // Listed in Special:Specialpages? + private $mListed; - if( !$wgDisableInternalSearch ) { - self::$mList['Search'] = array( 'SpecialPage', 'Search' ); - } + // Function name called by the default execute() + private $mFunction; - if( $wgEmailAuthentication ) { - self::$mList['Confirmemail'] = 'EmailConfirmation'; - self::$mList['Invalidateemail'] = 'EmailInvalidation'; - } + // File which needs to be included before the function above can be called + private $mFile; - # Add extension special pages - self::$mList = array_merge( self::$mList, $wgSpecialPages ); + // Whether or not this special page is being included from an article + protected $mIncluding; - # Run hooks - # This hook can be used to remove undesired built-in special pages - wfRunHooks( 'SpecialPage_initList', array( &self::$mList ) ); - wfProfileOut( __METHOD__ ); + // Whether the special page can be included in an article + protected $mIncludable; + + /** + * Current request context + * @var IContextSource + */ + protected $mContext; + + /** + * Initialise the special page list + * This must be called before accessing SpecialPage::$mList + * @deprecated since 1.18 + */ + static function initList() { + // 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 } /** @@ -265,19 +83,11 @@ class SpecialPage { * * @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; } /** @@ -287,16 +97,10 @@ class SpecialPage { * * @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 ); } /** @@ -305,14 +109,11 @@ class SpecialPage { * 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 since 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; } /** @@ -320,46 +121,34 @@ class SpecialPage { * * @param $page Mixed: SpecialPage or string * @param $group String + * @return null + * @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 + * Get the group that the special page belongs in on Special:SpecialPage * * @param $page SpecialPage + * @return null + * @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 + * + * @param $name String the page to remove */ static function removePage( $name ) { - if ( !self::$mListInitialised ) { - self::initList(); - } - unset( self::$mList[$name] ); + unset( SpecialPageFactory::getList()->$name ); } /** @@ -367,24 +156,10 @@ class SpecialPage { * * @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 ); } /** @@ -392,39 +167,22 @@ class SpecialPage { * * @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 ); } /** * Get a special page with a given localised name, or NULL if there * is no such special page. * + * @param $alias String * @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 ); } /** @@ -432,46 +190,20 @@ class SpecialPage { * 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(); } /** @@ -479,106 +211,28 @@ class SpecialPage { * 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}} - */ - 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; + * @param $title Title object + * @param $context IContextSource + * @param $including Bool output is being captured for use in {{special:whatever}} + * @return Bool + * @deprecated since 1.18 call SpecialPageFactory method directly + */ + public static function executePath( &$title, IContextSource &$context, $including = false ) { + return SpecialPageFactory::executePath( $title, $context, $including ); } /** @@ -586,23 +240,12 @@ class SpecialPage { * Returns false if there was no such special page, or a title object if it was * a redirect. * + * @param $title Title * @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 ); } /** @@ -612,42 +255,21 @@ class SpecialPage { * @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 ); } /** * Get a localised Title object for a specified special page name * + * @param $name String + * @param $subpage String|Bool subpage string, or false to not use a 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 { @@ -658,10 +280,12 @@ class SpecialPage { /** * Get a localised Title object for a page name with a possibly unvalidated subpage * + * @param $name String + * @param $subpage String|Bool subpage string, or false to not use a subpage * @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 { @@ -672,15 +296,12 @@ class SpecialPage { /** * Get a title for a given alias * + * @param $alias String * @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 ); } /** @@ -695,19 +316,27 @@ class SpecialPage { * * @param $name String: name of the special page, as seen in links and URLs * @param $restriction String: user right required, e.g. "block" or "delete" - * @param $listed Boolean: whether the page is listed in Special:Specialpages - * @param $function Callback: function called by execute(). By default it is constructed from $name + * @param $listed Bool: whether the page is listed in Special:Specialpages + * @param $function Callback|Bool: function called by execute(). By default it is constructed from $name * @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 + * @param $includable Bool: whether the page can be included in normal pages */ - public 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 + * @param $name String: name of the special page, as seen in links and URLs + * @param $restriction String: user right required, e.g. "block" or "delete" + * @param $listed Bool: whether the page is listed in Special:Specialpages + * @param $function Callback|Bool: function called by execute(). By default it is constructed from $name + * @param $file String: file which is included by execute(). It is also constructed from $name by default + * @param $includable Bool: whether the page can be included in normal pages */ private function init( $name, $restriction, $listed, $function, $file, $includable ) { $this->mName = $name; @@ -730,15 +359,16 @@ class SpecialPage { * 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 $name String Name of called method + * @param $fName String Name of called method * @param $a Array Arguments to the method - * @deprecated Call isn't deprecated, but SpecialPage::SpecialPage() is + * @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' ) { - // Debug messages now, warnings in 1.19 or 1.20? - wfDebug( "Deprecated SpecialPage::SpecialPage() called, use __construct();\n" ); + // Deprecated messages now, remove in 1.18 or 1.20? + wfDeprecated( __METHOD__ ); + $name = isset( $a[0] ) ? $a[0] : ''; $restriction = isset( $a[1] ) ? $a[1] : ''; $listed = isset( $a[2] ) ? $a[2] : true; @@ -746,48 +376,120 @@ class SpecialPage { $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" ); } } - /**#@+ - * 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) { - # Use the one below this - wfDeprecated( __METHOD__ ); - return wfSetVar( $this->mRestriction, $x ); + /** + * Get the name of this Special Page. + * @return String + */ + function getName() { + return $this->mName; } + + /** + * Get the permission that a user must have to execute this page + * @return String + */ + function getRestriction() { + return $this->mRestriction; + } + + /** + * Get the file which will be included by SpecialPage::execute() if your extension is + * still stuck in the past and hasn't overridden the execute() method. No modern code + * should want or need to know this. + * @return String + * @deprecated since 1.18 + */ + function getFile() { + return $this->mFile; + } + + // @todo FIXME: Decide which syntax to use for this, and stick to it + /** + * Whether this special page is listed in Special:SpecialPages + * @since r3583 (v1.3) + * @return Bool + */ + function isListed() { + return $this->mListed; + } + /** + * Set whether this page is listed in Special:Specialpages, at run-time + * @since r3583 (v1.3) + * @param $listed Bool + * @return Bool + */ + function setListed( $listed ) { + return wfSetVar( $this->mListed, $listed ); + } + /** + * Get or set whether this special page is listed in Special:SpecialPages + * @since r11308 (v1.6) + * @param $x Bool + * @return Bool + */ + function listed( $x = null) { + return wfSetVar( $this->mListed, $x ); + } + + /** + * Whether it's allowed to transclude the special page via {{Special:Foo/params}} + * @return Bool + */ + public function isIncludable(){ + return $this->mIncludable; + } + + /** + * These mutators are very evil, as the relevant variables should not mutate. So + * don't use them. + * @param $x Mixed + * @return Mixed + * @deprecated since 1.18 + */ + function name( $x = null ) { return wfSetVar( $this->mName, $x ); } function restriction( $x = null) { return wfSetVar( $this->mRestriction, $x ); } - function listed( $x = null) { return wfSetVar( $this->mListed, $x ); } function func( $x = null) { return wfSetVar( $this->mFunction, $x ); } function file( $x = null) { return wfSetVar( $this->mFile, $x ); } function includable( $x = null ) { return wfSetVar( $this->mIncludable, $x ); } - function including( $x = null ) { return wfSetVar( $this->mIncluding, $x ); } - /**#@-*/ + + /** + * Whether the special page is being evaluated via transclusion + * @param $x Bool + * @return Bool + */ + 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. * @@ -808,7 +510,7 @@ class SpecialPage { * @param $user User: the user to check * @return Boolean: does the user have permission to view the page? */ - public function userCanExecute( $user ) { + public function userCanExecute( User $user ) { return $user->isAllowed( $this->mRestriction ); } @@ -816,18 +518,17 @@ class SpecialPage { * 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() ); } /** @@ -835,16 +536,16 @@ class SpecialPage { * Checks user permissions, calls the function given in mFunction * * This must be overridden by subclasses; it will be made abstract in a future version + * + * @param $par String subpage string, if one was specified */ 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) { + if( !is_callable($func) && $this->mFile ) { require_once( $this->mFile ); } $this->outputHeader(); @@ -863,16 +564,16 @@ class SpecialPage { * @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 ); } } @@ -894,6 +595,7 @@ class SpecialPage { /** * Get a self-referential title object * + * @param $subpage String|Bool * @return Title object */ function getTitle( $subpage = false ) { @@ -901,39 +603,254 @@ class SpecialPage { } /** - * Set whether this page is listed in Special:Specialpages, at run-time + * Sets the context this SpecialPage is executed in + * + * @param $context IContextSource + * @since 1.18 */ - function setListed( $listed ) { - return wfSetVar( $this->mListed, $listed ); + public function setContext( $context ) { + $this->mContext = $context; } /** - * If the special page is a redirect, then get the Title object it redirects to. - * False otherwise. + * Gets the context this SpecialPage is executed in + * + * @return IContextSource + * @since 1.18 */ - function getRedirect( $subpage ) { - return false; + public function getContext() { + if ( $this->mContext instanceof IContextSource ) { + return $this->mContext; + } else { + wfDebug( __METHOD__ . " called and \$mContext is null. Return RequestContext::getMain(); for sanity\n" ); + return RequestContext::getMain(); + } } /** - * Return part of the request string for a special redirect page - * This allows passing, e.g. action=history to Special:Mypage, etc. + * Get the WebRequest being used for this instance * - * @return String + * @return WebRequest + * @since 1.18 */ - function getRedirectQuery() { - global $wgRequest; - $params = array(); - foreach( $this->mAllowedRedirectParams as $arg ) { - if( ( $val = $wgRequest->getVal( $arg, null ) ) !== null ) - $params[] = $arg . '=' . $val; + 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 User executing 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(); + } + + /** + * Shortcut to get user's language + * + * @return Language + * @since 1.18 + */ + public function getLang() { + return $this->getContext()->getLang(); + } + + /** + * 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. + * + * @return Message + * @see wfMessage + */ + public function msg( /* $args */ ) { + // Note: can't use func_get_args() directly as second or later item in + // a parameter list until PHP 5.3 or you get a fatal error. + // Works fine as the first parameter, which appears elsewhere in the + // code base. Sighhhh. + $args = func_get_args(); + return call_user_func_array( array( $this->getContext(), 'msg' ), $args ); + } + + /** + * Adds RSS/atom links + * + * @param $params array + */ + protected function addFeedLinks( $params ) { + global $wgFeedClasses, $wgOut; + + $feedTemplate = wfScript( 'api' ) . '?'; + + foreach( $wgFeedClasses as $format => $class ) { + $theseParams = $params + array( 'feedformat' => $format ); + $url = $feedTemplate . wfArrayToCGI( $theseParams ); + $wgOut->addFeedLink( $format, $url ); } - - foreach( $this->mAddedRedirectParams as $arg => $val ) { - $params[] = $arg . '=' . $val; + } +} + +/** + * Special page which uses an HTMLForm to handle processing. This is mostly a + * clone of FormAction. More special pages should be built this way; maybe this could be + * a new structure for SpecialPages + */ +abstract class FormSpecialPage extends SpecialPage { + + /** + * Get an HTMLForm descriptor array + * @return Array + */ + protected abstract function getFormFields(); + + /** + * Add pre- or post-text to the form + * @return String HTML which will be sent to $form->addPreText() + */ + protected function preText() { return ''; } + protected function postText() { return ''; } + + /** + * Play with the HTMLForm if you need to more substantially + * @param $form HTMLForm + */ + protected function alterForm( HTMLForm $form ) {} + + /** + * Get the HTMLForm to control behaviour + * @return HTMLForm|null + */ + protected function getForm() { + $this->fields = $this->getFormFields(); + + $form = new HTMLForm( $this->fields, $this->getContext() ); + $form->setSubmitCallback( array( $this, 'onSubmit' ) ); + $form->setWrapperLegend( wfMessage( strtolower( $this->getName() ) . '-legend' ) ); + $form->addHeaderText( + wfMessage( strtolower( $this->getName() ) . '-text' )->parseAsBlock() ); + + // Retain query parameters (uselang etc) + $params = array_diff_key( + $this->getRequest()->getQueryValues(), array( 'title' => null ) ); + $form->addHiddenField( 'redirectparams', wfArrayToCGI( $params ) ); + + $form->addPreText( $this->preText() ); + $form->addPostText( $this->postText() ); + $this->alterForm( $form ); + + // Give hooks a chance to alter the form, adding extra fields or text etc + wfRunHooks( "Special{$this->getName()}BeforeFormDisplay", array( &$form ) ); + + return $form; + } + + /** + * Process the form on POST submission. + * @param $data Array + * @return Bool|Array true for success, false for didn't-try, array of errors on failure + */ + public abstract function onSubmit( array $data ); + + /** + * Do something exciting on successful processing of the form, most likely to show a + * confirmation message + */ + public abstract function onSuccess(); + + /** + * Basic SpecialPage workflow: get a form, send it to the user; get some data back, + * + * @param $par String Subpage string if one was specified + */ + public function execute( $par ) { + $this->setParameter( $par ); + $this->setHeaders(); + + // This will throw exceptions if there's a problem + $this->userCanExecute( $this->getUser() ); + + $form = $this->getForm(); + if ( $form->show() ) { + $this->onSuccess(); } - - return count( $params ) ? implode( '&', $params ) : false; + } + + /** + * Maybe do something interesting with the subpage parameter + * @param $par String + */ + protected function setParameter( $par ){} + + /** + * Checks if the given user (identified by an object) can perform this action. Can be + * overridden by sub-classes with more complicated permissions schemes. Failures here + * must throw subclasses of ErrorPageError + * + * @param $user User: the user to check, or null to use the context user + * @return Bool true + * @throws ErrorPageError + */ + public function userCanExecute( User $user ) { + if ( $this->requiresWrite() && wfReadOnly() ) { + throw new ReadOnlyError(); + } + + if ( $this->getRestriction() !== null && !$user->isAllowed( $this->getRestriction() ) ) { + throw new PermissionsError( $this->getRestriction() ); + } + + if ( $this->requiresUnblock() && $user->isBlocked() ) { + $block = $user->mBlock; + throw new UserBlockedError( $block ); + } + + return true; + } + + /** + * Whether this action requires the wiki not to be locked + * @return Bool + */ + public function requiresWrite() { + return true; + } + + /** + * Whether this action cannot be executed by a blocked user + * @return Bool + */ + public function requiresUnblock() { + return true; } } @@ -941,32 +858,107 @@ class SpecialPage { * Shortcut to construct a special page which is unlisted by default * @ingroup SpecialPage */ -class UnlistedSpecialPage extends SpecialPage -{ +class UnlistedSpecialPage extends SpecialPage { function __construct( $name, $restriction = '', $function = false, $file = 'default' ) { parent::__construct( $name, $restriction, false, $function, $file ); } + + public function isListed(){ + return false; + } } /** * Shortcut to construct an includable special page * @ingroup SpecialPage */ -class IncludableSpecialPage extends SpecialPage -{ - function __construct( $name, $restriction = '', $listed = true, $function = false, $file = 'default' ) { +class IncludableSpecialPage extends SpecialPage { + function __construct( + $name, $restriction = '', $listed = true, $function = false, $file = 'default' + ) { parent::__construct( $name, $restriction, $listed, $function, $file, true ); } + + public function isIncludable(){ + return true; + } } /** * Shortcut to construct a special page alias. * @ingroup SpecialPage */ -class SpecialRedirectToSpecial extends UnlistedSpecialPage { +abstract class RedirectSpecialPage extends UnlistedSpecialPage { + + // Query parameters that can be passed through redirects + protected $mAllowedRedirectParams = array(); + + // Query parameteres added by redirects + protected $mAddedRedirectParams = array(); + + public function execute( $par ){ + $redirect = $this->getRedirect( $par ); + $query = $this->getRedirectQuery(); + // Redirect to a page title with possible query parameters + if ( $redirect instanceof Title ) { + $url = $redirect->getFullUrl( $query ); + $this->getOutput()->redirect( $url ); + wfProfileOut( __METHOD__ ); + return $redirect; + // Redirect to index.php with query parameters + } elseif ( $redirect === true ) { + global $wgScript; + $url = $wgScript . '?' . wfArrayToCGI( $query ); + $this->getOutput()->redirect( $url ); + wfProfileOut( __METHOD__ ); + return $redirect; + } else { + $class = __CLASS__; + throw new MWException( "RedirectSpecialPage $class doesn't redirect!" ); + } + } + + /** + * If the special page is a redirect, then get the Title object it redirects to. + * False otherwise. + * + * @param $par String Subpage string + * @return Title|false + */ + abstract public function getRedirect( $par ); + + /** + * Return part of the request string for a special redirect page + * This allows passing, e.g. action=history to Special:Mypage, etc. + * + * @return String + */ + public function getRedirectQuery() { + $params = array(); + + foreach( $this->mAllowedRedirectParams as $arg ) { + if( $this->getRequest()->getVal( $arg, null ) !== null ){ + $params[$arg] = $this->getRequest()->getVal( $arg ); + } + } + + foreach( $this->mAddedRedirectParams as $arg => $val ) { + $params[$arg] = $val; + } + + return count( $params ) + ? $params + : false; + } +} + +abstract class SpecialRedirectToSpecial extends RedirectSpecialPage { var $redirName, $redirSubpage; - function __construct( $name, $redirName, $redirSubpage = false, $allowedRedirectParams = array(), $addedRedirectParams = array() ) { + function __construct( + $name, $redirName, $redirSubpage = false, + $allowedRedirectParams = array(), $addedRedirectParams = array() + ) { parent::__construct( $name ); $this->redirName = $redirName; $this->redirSubpage = $redirSubpage; @@ -974,7 +966,7 @@ class SpecialRedirectToSpecial extends UnlistedSpecialPage { $this->mAddedRedirectParams = $addedRedirectParams; } - function getRedirect( $subpage ) { + public function getRedirect( $subpage ) { if ( $this->redirSubpage === false ) { return SpecialPage::getTitleFor( $this->redirName, $subpage ); } else { @@ -983,7 +975,35 @@ class SpecialRedirectToSpecial extends UnlistedSpecialPage { } } -/** 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 + * @todo 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 @@ -994,19 +1014,20 @@ class SpecialRedirectToSpecial extends UnlistedSpecialPage { * Shortcut to construct a special page pointing to current user user's page. * @ingroup SpecialPage */ -class SpecialMypage extends UnlistedSpecialPage { +class SpecialMypage extends RedirectSpecialPage { function __construct() { parent::__construct( 'Mypage' ); $this->mAllowedRedirectParams = array( 'action' , 'preload' , 'editintro', - 'section', 'oldid', 'diff', 'dir' ); + 'section', 'oldid', 'diff', 'dir', + // Options for action=raw; missing ctype can break JS or CSS in some browsers + 'ctype', 'maxage', 'smaxage' ); } function getRedirect( $subpage ) { - global $wgUser; if ( strval( $subpage ) !== '' ) { - return Title::makeTitle( NS_USER, $wgUser->getName() . '/' . $subpage ); + return Title::makeTitle( NS_USER, $this->getUser()->getName() . '/' . $subpage ); } else { - return Title::makeTitle( NS_USER, $wgUser->getName() ); + return Title::makeTitle( NS_USER, $this->getUser()->getName() ); } } } @@ -1015,7 +1036,7 @@ class SpecialMypage extends UnlistedSpecialPage { * Shortcut to construct a special page pointing to current user talk page. * @ingroup SpecialPage */ -class SpecialMytalk extends UnlistedSpecialPage { +class SpecialMytalk extends RedirectSpecialPage { function __construct() { parent::__construct( 'Mytalk' ); $this->mAllowedRedirectParams = array( 'action' , 'preload' , 'editintro', @@ -1023,11 +1044,10 @@ class SpecialMytalk extends UnlistedSpecialPage { } function getRedirect( $subpage ) { - global $wgUser; if ( strval( $subpage ) !== '' ) { - return Title::makeTitle( NS_USER_TALK, $wgUser->getName() . '/' . $subpage ); + return Title::makeTitle( NS_USER_TALK, $this->getUser()->getName() . '/' . $subpage ); } else { - return Title::makeTitle( NS_USER_TALK, $wgUser->getName() ); + return Title::makeTitle( NS_USER_TALK, $this->getUser()->getName() ); } } } @@ -1036,7 +1056,7 @@ class SpecialMytalk extends UnlistedSpecialPage { * Shortcut to construct a special page pointing to current user contributions. * @ingroup SpecialPage */ -class SpecialMycontributions extends UnlistedSpecialPage { +class SpecialMycontributions extends RedirectSpecialPage { function __construct() { parent::__construct( 'Mycontributions' ); $this->mAllowedRedirectParams = array( 'limit', 'namespace', 'tagfilter', @@ -1044,22 +1064,36 @@ class SpecialMycontributions extends UnlistedSpecialPage { } function getRedirect( $subpage ) { - global $wgUser; - return SpecialPage::getTitleFor( 'Contributions', $wgUser->getName() ); + return SpecialPage::getTitleFor( 'Contributions', $this->getUser()->getName() ); } } /** * Redirect to Special:Listfiles?user=$wgUser */ -class SpecialMyuploads extends UnlistedSpecialPage { +class SpecialMyuploads extends RedirectSpecialPage { function __construct() { parent::__construct( 'Myuploads' ); $this->mAllowedRedirectParams = array( 'limit' ); } - + function getRedirect( $subpage ) { - global $wgUser; - return SpecialPage::getTitleFor( 'Listfiles', $wgUser->getName() ); + return SpecialPage::getTitleFor( 'Listfiles', $this->getUser()->getName() ); + } +} + +/** + * Redirect from Special:PermanentLink/### to index.php?oldid=### + */ +class SpecialPermanentLink extends RedirectSpecialPage { + function __construct() { + parent::__construct( 'PermanentLink' ); + $this->mAllowedRedirectParams = array(); + } + + function getRedirect( $subpage ) { + $subpage = intval( $subpage ); + $this->mAddedRedirectParams['oldid'] = $subpage; + return true; } } |