X-Git-Url: http://git.cyclocoop.org/?a=blobdiff_plain;ds=sidebyside;f=includes%2FSpecialPage.php;h=7a6c0befb98fa0a7ae40ac9a694d87927666c8c8;hb=d9d8b099ada7d59b90938d8cfe1412a8d80127d2;hp=a5dfe77aacfafb0f048d44e1e0ef8dfcc5a9de19;hpb=295f513e8bfde3d6b378f6d6e39e5b448af2be03;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/SpecialPage.php b/includes/SpecialPage.php index a5dfe77aac..7a6c0befb9 100644 --- a/includes/SpecialPage.php +++ b/includes/SpecialPage.php @@ -1,25 +1,24 @@ heading, @see getDescription() - /*private*/ var $mName; + protected $mName; // The local name of this special page private $mLocalName; @@ -57,7 +56,7 @@ class SpecialPage { /** * Current request context - * @var RequestContext + * @var IContextSource */ protected $mContext; @@ -67,6 +66,7 @@ class SpecialPage { * @deprecated since 1.18 */ static function initList() { + wfDeprecated( __METHOD__, '1.18' ); // Noop } @@ -74,6 +74,7 @@ class SpecialPage { * @deprecated since 1.18 */ static function initAliasList() { + wfDeprecated( __METHOD__, '1.18' ); // Noop } @@ -86,6 +87,7 @@ class SpecialPage { * @deprecated since 1.18 call SpecialPageFactory method directly */ static function resolveAlias( $alias ) { + wfDeprecated( __METHOD__, '1.18' ); list( $name, /*...*/ ) = SpecialPageFactory::resolveAlias( $alias ); return $name; } @@ -112,7 +114,7 @@ class SpecialPage { * @deprecated since 1.7, warnings in 1.17, might be removed in 1.20 */ static function addPage( &$page ) { - wfDeprecated( __METHOD__ ); + wfDeprecated( __METHOD__, '1.7' ); SpecialPageFactory::getList()->{$page->mName} = $page; } @@ -124,16 +126,19 @@ class SpecialPage { * @deprecated since 1.18 call SpecialPageFactory method directly */ static function setGroup( $page, $group ) { - return SpecialPageFactory::setGroup( $page, $group ); + wfDeprecated( __METHOD__, '1.18' ); + 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 string * @deprecated since 1.18 call SpecialPageFactory method directly */ static function getGroup( &$page ) { + wfDeprecated( __METHOD__, '1.18' ); return SpecialPageFactory::getGroup( $page ); } @@ -142,8 +147,11 @@ class SpecialPage { * 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 ) { + wfDeprecated( __METHOD__, '1.18' ); unset( SpecialPageFactory::getList()->$name ); } @@ -155,6 +163,7 @@ class SpecialPage { * @deprecated since 1.18 call SpecialPageFactory method directly */ static function exists( $name ) { + wfDeprecated( __METHOD__, '1.18' ); return SpecialPageFactory::exists( $name ); } @@ -166,6 +175,7 @@ class SpecialPage { * @deprecated since 1.18 call SpecialPageFactory method directly */ static function getPage( $name ) { + wfDeprecated( __METHOD__, '1.18' ); return SpecialPageFactory::getPage( $name ); } @@ -173,10 +183,12 @@ class SpecialPage { * 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 ) { + wfDeprecated( __METHOD__, '1.18' ); return SpecialPageFactory::getPage( $alias ); } @@ -184,20 +196,24 @@ class SpecialPage { * Return categorised listable special pages which are available * for the current user, and everyone. * - * @return Associative array mapping page's name to its SpecialPage object + * @param $user User object to check permissions, $wgUser will be used + * if not provided + * @return array Associative array mapping page's name to its SpecialPage object * @deprecated since 1.18 call SpecialPageFactory method directly */ - static function getUsablePages() { - return SpecialPageFactory::getUsablePages(); + static function getUsablePages( User $user = null ) { + wfDeprecated( __METHOD__, '1.18' ); + return SpecialPageFactory::getUsablePages( $user ); } /** * Return categorised listable special pages for all users * - * @return Associative array mapping page's name to its SpecialPage object + * @return array Associative array mapping page's name to its SpecialPage object * @deprecated since 1.18 call SpecialPageFactory method directly */ static function getRegularPages() { + wfDeprecated( __METHOD__, '1.18' ); return SpecialPageFactory::getRegularPages(); } @@ -205,10 +221,11 @@ class SpecialPage { * Return categorised listable special pages which are available * for the current user, but not for everyone * - * @return Associative array mapping page's name to its SpecialPage object + * @return array Associative array mapping page's name to its SpecialPage object * @deprecated since 1.18 call SpecialPageFactory method directly */ static function getRestrictedPages() { + wfDeprecated( __METHOD__, '1.18' ); return SpecialPageFactory::getRestrictedPages(); } @@ -221,26 +238,16 @@ class SpecialPage { * page, and true if it was successful. * * @param $title Title object - * @param $context RequestContext + * @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, RequestContext &$context, $including = false ) { + public static function executePath( &$title, IContextSource &$context, $including = false ) { + wfDeprecated( __METHOD__, '1.18' ); return SpecialPageFactory::executePath( $title, $context, $including ); } - /** - * Just like executePath() except it returns the HTML instead of outputting it - * Returns false if there was no such special page, or a title object if it was - * a redirect. - * - * @return String: HTML fragment - * @deprecated since 1.18 call SpecialPageFactory method directly - */ - static function capturePath( &$title ) { - return SpecialPageFactory::capturePath( $title ); - } - /** * Get the local name for a specified canonical name * @@ -251,12 +258,15 @@ class SpecialPage { * @deprecated since 1.18 call SpecialPageFactory method directly */ static function getLocalNameFor( $name, $subpage = false ) { + wfDeprecated( __METHOD__, '1.18' ); 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 */ public static function getTitleFor( $name, $subpage = false ) { @@ -271,6 +281,8 @@ 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 */ public static function getSafeTitleFor( $name, $subpage = false ) { @@ -285,10 +297,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 ) { + wfDeprecated( __METHOD__, '1.18' ); return SpecialPageFactory::getTitleForAlias( $alias ); } @@ -304,19 +318,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; @@ -324,12 +346,12 @@ class SpecialPage { $this->mListed = $listed; $this->mIncludable = $includable; if ( !$function ) { - $this->mFunction = 'wfSpecial'.$name; + $this->mFunction = 'wfSpecial' . $name; } else { $this->mFunction = $function; } if ( $file === 'default' ) { - $this->mFile = dirname(__FILE__) . "/specials/Special$name.php"; + $this->mFile = dirname( __FILE__ ) . "/specials/Special$name.php"; } else { $this->mFile = $file; } @@ -344,11 +366,11 @@ class SpecialPage { * @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__ ); + // Deprecated messages now, remove in 1.19 or 1.20? + wfDeprecated( __METHOD__, '1.17' ); + // Sometimes $fName is SpecialPage, sometimes it's specialpage. <3 PHP + if ( strtolower( $fName ) == 'specialpage' ) { $name = isset( $a[0] ) ? $a[0] : ''; $restriction = isset( $a[1] ) ? $a[1] : ''; $listed = isset( $a[2] ) ? $a[2] : true; @@ -386,6 +408,7 @@ class SpecialPage { * @deprecated since 1.18 */ function getFile() { + wfDeprecated( __METHOD__, '1.18' ); return $this->mFile; } @@ -401,6 +424,7 @@ class SpecialPage { /** * Set whether this page is listed in Special:Specialpages, at run-time * @since r3583 (v1.3) + * @param $listed Bool * @return Bool */ function setListed( $listed ) { @@ -409,9 +433,10 @@ class SpecialPage { /** * 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) { + function listed( $x = null ) { return wfSetVar( $this->mListed, $x ); } @@ -419,23 +444,58 @@ class SpecialPage { * Whether it's allowed to transclude the special page via {{Special:Foo/params}} * @return Bool */ - public function isIncludable(){ + 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 ) { wfDeprecated( __METHOD__, '1.18' ); return wfSetVar( $this->mName, $x ); } + + /** + * 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 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 restriction( $x = null ) { wfDeprecated( __METHOD__, '1.18' ); return wfSetVar( $this->mRestriction, $x ); } + + /** + * 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 func( $x = null ) { wfDeprecated( __METHOD__, '1.18' ); return wfSetVar( $this->mFunction, $x ); } + + /** + * 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 file( $x = null ) { wfDeprecated( __METHOD__, '1.18' ); return wfSetVar( $this->mFile, $x ); } + + /** + * 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 includable( $x = null ) { wfDeprecated( __METHOD__, '1.18' ); return wfSetVar( $this->mIncludable, $x ); } /** * Whether the special page is being evaluated via transclusion + * @param $x Bool * @return Bool */ function including( $x = null ) { @@ -474,7 +534,7 @@ class SpecialPage { public function isRestricted() { global $wgGroupPermissions; // DWIM: If all anons can do something, then it is not restricted - return $this->mRestriction != '' && empty($wgGroupPermissions['*'][$this->mRestriction]); + return $this->mRestriction != '' && empty( $wgGroupPermissions['*'][$this->mRestriction] ); } /** @@ -496,6 +556,29 @@ class SpecialPage { throw new PermissionsError( $this->mRestriction ); } + /** + * Checks if userCanExecute, and if not throws a PermissionsError + * + * @since 1.19 + */ + public function checkPermissions() { + if ( !$this->userCanExecute( $this->getUser() ) ) { + $this->displayRestrictionError(); + } + } + + /** + * If the wiki is currently in readonly mode, throws a ReadOnlyError + * + * @since 1.19 + * @throws ReadOnlyError + */ + public function checkReadOnly() { + if ( wfReadOnly() ) { + throw new ReadOnlyError; + } + } + /** * Sets headers - this should be called from the execute() method of all derived classes! */ @@ -511,21 +594,20 @@ 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 ) { $this->setHeaders(); + $this->checkPermissions(); - if ( $this->userCanExecute( $this->getUser() ) ) { - $func = $this->mFunction; - // only load file if the function does not exist - if(!is_callable($func) and $this->mFile) { - require_once( $this->mFile ); - } - $this->outputHeader(); - call_user_func( $func, $par, $this ); - } else { - $this->displayRestrictionError(); + $func = $this->mFunction; + // only load file if the function does not exist + if ( !is_callable( $func ) && $this->mFile ) { + require_once( $this->mFile ); } + $this->outputHeader(); + call_user_func( $func, $par, $this ); } /** @@ -539,13 +621,14 @@ class SpecialPage { function outputHeader( $summaryMessageKey = '' ) { global $wgContLang; - if( $summaryMessageKey == '' ) { + if ( $summaryMessageKey == '' ) { $msg = $wgContLang->lc( $this->getName() ) . '-summary'; } else { $msg = $summaryMessageKey; } - if ( !wfMessage( $msg )->isBlank() and ! $this->including() ) { - $this->getOutput()->wrapWikiMsg( "