<?php
/**
- * SpecialPage: handling special pages and lists thereof.
+ * Parent class for all special pages.
*
- * To add a special page in an extension, add to $wgSpecialPages either
- * an object instance or an array containing the name and constructor
- * parameters. The latter is preferred for performance reasons.
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
*
- * The object instantiated must be either an instance of SpecialPage or a
- * sub-class thereof. It must have an execute() method, which sends the HTML
- * for the special page to $wgOut. The parent class has an execute() method
- * which distributes the call to the historical global functions. Additionally,
- * execute() also checks if the user has the necessary access privileges
- * and bails out if not.
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
*
- * To add a core special page, use the similar static list in
- * SpecialPage::$mList. To remove a core static special page at runtime, use
- * a SpecialPage_initList hook.
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
*
* @file
* @ingroup SpecialPage
- * @defgroup SpecialPage SpecialPage
*/
/**
// The canonical name of this special page
// Also used for the default <h1> heading, @see getDescription()
- /*private*/ var $mName;
+ protected $mName;
// The local name of this special page
private $mLocalName;
/**
* Current request context
- * @var RequestContext
+ * @var IContextSource
*/
protected $mContext;
* @deprecated since 1.18
*/
static function initList() {
+ wfDeprecated( __METHOD__, '1.18' );
// Noop
}
* @deprecated since 1.18
*/
static function initAliasList() {
+ wfDeprecated( __METHOD__, '1.18' );
// Noop
}
* @deprecated since 1.18 call SpecialPageFactory method directly
*/
static function resolveAlias( $alias ) {
+ wfDeprecated( __METHOD__, '1.18' );
list( $name, /*...*/ ) = SpecialPageFactory::resolveAlias( $alias );
return $name;
}
* @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;
}
*
* @param $page Mixed: SpecialPage or string
* @param $group String
- * @return null
* @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 );
}
/**
* Get the group that the special page belongs in on Special:SpecialPage
*
* @param $page SpecialPage
- * @return null
+ * @return string
* @deprecated since 1.18 call SpecialPageFactory method directly
*/
static function getGroup( &$page ) {
+ wfDeprecated( __METHOD__, '1.18' );
return SpecialPageFactory::getGroup( $page );
}
* @param $name String the page to remove
*/
static function removePage( $name ) {
+ wfDeprecated( __METHOD__, '1.18' );
unset( SpecialPageFactory::getList()->$name );
}
* @deprecated since 1.18 call SpecialPageFactory method directly
*/
static function exists( $name ) {
+ wfDeprecated( __METHOD__, '1.18' );
return SpecialPageFactory::exists( $name );
}
* @deprecated since 1.18 call SpecialPageFactory method directly
*/
static function getPage( $name ) {
+ wfDeprecated( __METHOD__, '1.18' );
return SpecialPageFactory::getPage( $name );
}
* @deprecated since 1.18 call SpecialPageFactory method directly
*/
static function getPageByAlias( $alias ) {
+ wfDeprecated( __METHOD__, '1.18' );
return SpecialPageFactory::getPage( $alias );
}
* 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();
}
* 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();
}
* 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.
- *
- * @param $title Title
- * @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
*
* @deprecated since 1.18 call SpecialPageFactory method directly
*/
static function getLocalNameFor( $name, $subpage = false ) {
+ wfDeprecated( __METHOD__, '1.18' );
return SpecialPageFactory::getLocalNameFor( $name, $subpage );
}
* @deprecated since 1.18 call SpecialPageFactory method directly
*/
static function getTitleForAlias( $alias ) {
+ wfDeprecated( __METHOD__, '1.18' );
return SpecialPageFactory::getTitleForAlias( $alias );
}
$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;
}
* @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;
* @deprecated since 1.18
*/
function getFile() {
+ wfDeprecated( __METHOD__, '1.18' );
return $this->mFile;
}
* @param $x Bool
* @return Bool
*/
- function listed( $x = null) {
+ 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(){
+ public function isIncludable() {
return $this->mIncludable;
}
* @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 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 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
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] );
}
/**
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!
*/
*/
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 );
}
/**
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() ) {
+ if ( !$this->msg( $msg )->isDisabled() && !$this->including() ) {
$this->getOutput()->wrapWikiMsg(
"<div class='mw-specialpage-summary'>\n$1\n</div>", $msg );
}
* @return String
*/
function getDescription() {
- return wfMsg( strtolower( $this->mName ) );
+ return $this->msg( strtolower( $this->mName ) )->text();
}
/**
/**
* Sets the context this SpecialPage is executed in
*
- * @param $context RequestContext
+ * @param $context IContextSource
* @since 1.18
*/
public function setContext( $context ) {
/**
* Gets the context this SpecialPage is executed in
*
- * @return RequestContext
+ * @return IContextSource|RequestContext
* @since 1.18
*/
public function getContext() {
- if ( $this->mContext instanceof RequestContext ) {
+ if ( $this->mContext instanceof IContextSource ) {
return $this->mContext;
} else {
wfDebug( __METHOD__ . " called and \$mContext is null. Return RequestContext::getMain(); for sanity\n" );
}
/**
- * Shortcut to get the skin being used for this instance
+ * Shortcut to get the User executing this instance
*
* @return User
* @since 1.18
/**
* Shortcut to get user's language
*
+ * @deprecated 1.19 Use getLanguage instead
* @return Language
- * @since 1.19
+ * @since 1.18
*/
public function getLang() {
- return $this->getContext()->getLang();
+ wfDeprecated( __METHOD__, '1.19' );
+ return $this->getLanguage();
+ }
+
+ /**
+ * Shortcut to get user's language
+ *
+ * @return Language
+ * @since 1.19
+ */
+ public function getLanguage() {
+ return $this->getContext()->getLanguage();
}
/**
}
/**
- * Wrapper around wfMessage that sets the current context. Currently this
- * is only the title.
+ * Wrapper around wfMessage that sets the current context.
*
* @return Message
* @see wfMessage
*/
public function msg( /* $args */ ) {
- return call_user_func_array( 'wfMessage',
- func_get_args() )->title( $this->getFullTitle() );
+ // 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();
+ $message = call_user_func_array( array( $this->getContext(), 'msg' ), $args );
+ // RequestContext passes context to wfMessage, and the language is set from
+ // the context, but setting the language for Message class removes the
+ // interface message status, which breaks for example usernameless gender
+ // invokations. Restore the flag when not including special page in content.
+ if ( $this->including() ) {
+ $message->setInterfaceMessageFlag( false );
+ }
+ return $message;
}
/**
* @param $params array
*/
protected function addFeedLinks( $params ) {
- global $wgFeedClasses, $wgOut;
+ global $wgFeedClasses;
$feedTemplate = wfScript( 'api' ) . '?';
- foreach( $wgFeedClasses as $format => $class ) {
+ foreach ( $wgFeedClasses as $format => $class ) {
$theseParams = $params + array( 'feedformat' => $format );
$url = $feedTemplate . wfArrayToCGI( $theseParams );
- $wgOut->addFeedLink( $format, $url );
+ $this->getOutput()->addFeedLink( $format, $url );
}
}
}
protected function getForm() {
$this->fields = $this->getFormFields();
- // Give hooks a chance to alter the form, adding extra fields or text etc
- wfRunHooks( "Special{$this->getName()}ModifyFormFields", array( &$this->fields ) );
-
$form = new HTMLForm( $this->fields, $this->getContext() );
$form->setSubmitCallback( array( $this, 'onSubmit' ) );
- $form->setWrapperLegend( wfMessage( strtolower( $this->getName() ) . '-legend' ) );
+ $form->setWrapperLegend( $this->msg( strtolower( $this->getName() ) . '-legend' ) );
$form->addHeaderText(
- wfMessage( strtolower( $this->getName() ) . '-text' )->parseAsBlock() );
+ $this->msg( strtolower( $this->getName() ) . '-text' )->parseAsBlock() );
// Retain query parameters (uselang etc)
$params = array_diff_key(
$this->setHeaders();
// This will throw exceptions if there's a problem
- $this->userCanExecute( $this->getUser() );
+ $this->checkExecutePermissions( $this->getUser() );
$form = $this->getForm();
if ( $form->show() ) {
* Maybe do something interesting with the subpage parameter
* @param $par String
*/
- protected function setParameter( $par ){}
+ 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
+ * Called from execute() to check if the given user can perform this action.
+ * Failures here must throw subclasses of ErrorPageError.
+ * @param $user 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() );
- }
+ protected function checkExecutePermissions( User $user ) {
+ $this->checkPermissions();
if ( $this->requiresUnblock() && $user->isBlocked() ) {
- $block = $user->mBlock;
+ $block = $user->getBlock();
throw new UserBlockedError( $block );
}
+ if ( $this->requiresWrite() ) {
+ $this->checkReadOnly();
+ }
+
return true;
}
* 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(){
+ public function isListed() {
return false;
}
}
* Shortcut to construct an includable special page
* @ingroup SpecialPage
*/
-class IncludableSpecialPage extends SpecialPage
-{
+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(){
+ public function isIncludable() {
return true;
}
}
// Query parameteres added by redirects
protected $mAddedRedirectParams = array();
- public function execute( $par ){
+ public function execute( $par ) {
$redirect = $this->getRedirect( $par );
$query = $this->getRedirectQuery();
// Redirect to a page title with possible query parameters
* False otherwise.
*
* @param $par String Subpage string
- * @return Title|false
+ * @return Title|bool
*/
abstract public function getRedirect( $par );
public function getRedirectQuery() {
$params = array();
- foreach( $this->mAllowedRedirectParams as $arg ) {
- if( $this->getRequest()->getVal( $arg, null ) !== null ){
+ foreach ( $this->mAllowedRedirectParams as $arg ) {
+ if ( $this->getRequest()->getVal( $arg, null ) !== null ) {
$params[$arg] = $this->getRequest()->getVal( $arg );
}
}
- foreach( $this->mAddedRedirectParams as $arg => $val ) {
+ foreach ( $this->mAddedRedirectParams as $arg => $val ) {
$params[$arg] = $val;
}
}
/**
- * ListAdmins --> ListUsers/admin
+ * ListAdmins --> ListUsers/sysop
*/
class SpecialListAdmins extends SpecialRedirectToSpecial {
- function __construct(){
- parent::__construct( 'ListAdmins', 'ListUsers', 'sysop' );
+ function __construct() {
+ parent::__construct( 'Listadmins', 'Listusers', 'sysop' );
}
}
/**
- * ListBots --> ListUsers/admin
+ * ListBots --> ListUsers/bot
*/
class SpecialListBots extends SpecialRedirectToSpecial {
- function __construct(){
- parent::__construct( 'ListAdmins', 'ListUsers', 'bot' );
+ function __construct() {
+ parent::__construct( 'Listbots', 'Listusers', 'bot' );
}
}
* @todo FIXME: This (and the rest of the login frontend) needs to die a horrible painful death
*/
class SpecialCreateAccount extends SpecialRedirectToSpecial {
- function __construct(){
+ function __construct() {
parent::__construct( 'CreateAccount', 'Userlogin', 'signup', array( 'uselang' ) );
}
}
class SpecialMypage extends RedirectSpecialPage {
function __construct() {
parent::__construct( 'Mypage' );
- $this->mAllowedRedirectParams = array( 'action' , 'preload' , 'editintro',
- 'section', 'oldid', 'diff', 'dir' );
+ $this->mAllowedRedirectParams = array( 'action', 'preload', 'preloadtitle', 'editintro',
+ 'section', 'oldid', 'diff', 'dir',
+ // Options for action=raw; missing ctype can break JS or CSS in some browsers
+ 'ctype', 'maxage', 'smaxage' );
}
function getRedirect( $subpage ) {
class SpecialMytalk extends RedirectSpecialPage {
function __construct() {
parent::__construct( 'Mytalk' );
- $this->mAllowedRedirectParams = array( 'action' , 'preload' , 'editintro',
+ $this->mAllowedRedirectParams = array( 'action', 'preload', 'preloadtitle', 'editintro',
'section', 'oldid', 'diff', 'dir' );
}
function getRedirect( $subpage ) {
$subpage = intval( $subpage );
+ if ( $subpage === 0 ) {
+ # throw an error page when no subpage was given
+ throw new ErrorPageError( 'nopagetitle', 'nopagetext' );
+ }
$this->mAddedRedirectParams['oldid'] = $subpage;
return true;
}
dépôts / lhc / web / wiklou.git / blobdiff