3 * Parent class for all special pages.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup SpecialPage
25 * Parent special page class, also static functions for handling the special
27 * @ingroup SpecialPage
31 // The canonical name of this special page
32 // Also used for the default <h1> heading, @see getDescription()
35 // The local name of this special page
38 // Minimum user level required to access this page, or "" for anyone.
39 // Also used to categorise the pages in Special:Specialpages
40 private $mRestriction;
42 // Listed in Special:Specialpages?
45 // Function name called by the default execute()
48 // File which needs to be included before the function above can be called
51 // Whether or not this special page is being included from an article
52 protected $mIncluding;
54 // Whether the special page can be included in an article
55 protected $mIncludable;
58 * Current request context
64 * Initialise the special page list
65 * This must be called before accessing SpecialPage::$mList
66 * @deprecated since 1.18
68 static function initList() {
69 wfDeprecated( __METHOD__
, '1.18' );
74 * @deprecated since 1.18
76 static function initAliasList() {
77 wfDeprecated( __METHOD__
, '1.18' );
82 * Given a special page alias, return the special page name.
83 * Returns false if there is no such alias.
85 * @param $alias String
86 * @return String or false
87 * @deprecated since 1.18 call SpecialPageFactory method directly
89 static function resolveAlias( $alias ) {
90 wfDeprecated( __METHOD__
, '1.18' );
91 list( $name, /*...*/ ) = SpecialPageFactory
::resolveAlias( $alias );
96 * Given a special page name with a possible subpage, return an array
97 * where the first element is the special page name and the second is the
100 * @param $alias String
102 * @deprecated since 1.18 call SpecialPageFactory method directly
104 static function resolveAliasWithSubpage( $alias ) {
105 return SpecialPageFactory
::resolveAlias( $alias );
109 * Add a page to a certain display group for Special:SpecialPages
111 * @param $page Mixed: SpecialPage or string
112 * @param $group String
113 * @deprecated since 1.18 call SpecialPageFactory method directly
115 static function setGroup( $page, $group ) {
116 wfDeprecated( __METHOD__
, '1.18' );
117 SpecialPageFactory
::setGroup( $page, $group );
121 * Get the group that the special page belongs in on Special:SpecialPage
123 * @param $page SpecialPage
125 * @deprecated since 1.18 call SpecialPageFactory method directly
127 static function getGroup( &$page ) {
128 wfDeprecated( __METHOD__
, '1.18' );
129 return SpecialPageFactory
::getGroup( $page );
133 * Remove a special page from the list
134 * Formerly used to disable expensive or dangerous special pages. The
135 * preferred method is now to add a SpecialPage_initList hook.
136 * @deprecated since 1.18
138 * @param string $name the page to remove
140 static function removePage( $name ) {
141 wfDeprecated( __METHOD__
, '1.18' );
142 unset( SpecialPageFactory
::getList()->$name );
146 * Check if a given name exist as a special page or as a special page alias
148 * @param string $name name of a special page
149 * @return Boolean: true if a special page exists with this name
150 * @deprecated since 1.18 call SpecialPageFactory method directly
152 static function exists( $name ) {
153 wfDeprecated( __METHOD__
, '1.18' );
154 return SpecialPageFactory
::exists( $name );
158 * Find the object with a given name and return it (or NULL)
160 * @param $name String
161 * @return SpecialPage object or null if the page doesn't exist
162 * @deprecated since 1.18 call SpecialPageFactory method directly
164 static function getPage( $name ) {
165 wfDeprecated( __METHOD__
, '1.18' );
166 return SpecialPageFactory
::getPage( $name );
170 * Get a special page with a given localised name, or NULL if there
171 * is no such special page.
173 * @param $alias String
174 * @return SpecialPage object or null if the page doesn't exist
175 * @deprecated since 1.18 call SpecialPageFactory method directly
177 static function getPageByAlias( $alias ) {
178 wfDeprecated( __METHOD__
, '1.18' );
179 return SpecialPageFactory
::getPage( $alias );
183 * Return categorised listable special pages which are available
184 * for the current user, and everyone.
186 * @param $user User object to check permissions, $wgUser will be used
188 * @return array Associative array mapping page's name to its SpecialPage object
189 * @deprecated since 1.18 call SpecialPageFactory method directly
191 static function getUsablePages( User
$user = null ) {
192 wfDeprecated( __METHOD__
, '1.18' );
193 return SpecialPageFactory
::getUsablePages( $user );
197 * Return categorised listable special pages for all users
199 * @return array Associative array mapping page's name to its SpecialPage object
200 * @deprecated since 1.18 call SpecialPageFactory method directly
202 static function getRegularPages() {
203 wfDeprecated( __METHOD__
, '1.18' );
204 return SpecialPageFactory
::getRegularPages();
208 * Return categorised listable special pages which are available
209 * for the current user, but not for everyone
211 * @return array Associative array mapping page's name to its SpecialPage object
212 * @deprecated since 1.18 call SpecialPageFactory method directly
214 static function getRestrictedPages() {
215 wfDeprecated( __METHOD__
, '1.18' );
216 return SpecialPageFactory
::getRestrictedPages();
220 * Execute a special page path.
221 * The path may contain parameters, e.g. Special:Name/Params
222 * Extracts the special page name and call the execute method, passing the parameters
224 * Returns a title object if the page is redirected, false if there was no such special
225 * page, and true if it was successful.
227 * @param $title Title object
228 * @param $context IContextSource
229 * @param $including Bool output is being captured for use in {{special:whatever}}
231 * @deprecated since 1.18 call SpecialPageFactory method directly
233 public static function executePath( &$title, IContextSource
&$context, $including = false ) {
234 wfDeprecated( __METHOD__
, '1.18' );
235 return SpecialPageFactory
::executePath( $title, $context, $including );
239 * Get the local name for a specified canonical name
241 * @param $name String
242 * @param $subpage Mixed: boolean false, or string
245 * @deprecated since 1.18 call SpecialPageFactory method directly
247 static function getLocalNameFor( $name, $subpage = false ) {
248 wfDeprecated( __METHOD__
, '1.18' );
249 return SpecialPageFactory
::getLocalNameFor( $name, $subpage );
253 * Get a localised Title object for a specified special page name
255 * @param $name String
256 * @param string|Bool $subpage subpage string, or false to not use a subpage
257 * @param string $fragment the link fragment (after the "#")
258 * @throws MWException
259 * @return Title object
261 public static function getTitleFor( $name, $subpage = false, $fragment = '' ) {
262 $name = SpecialPageFactory
::getLocalNameFor( $name, $subpage );
264 return Title
::makeTitle( NS_SPECIAL
, $name, $fragment );
266 throw new MWException( "Invalid special page name \"$name\"" );
271 * Get a localised Title object for a page name with a possibly unvalidated subpage
273 * @param $name String
274 * @param string|Bool $subpage subpage string, or false to not use a subpage
275 * @return Title object or null if the page doesn't exist
277 public static function getSafeTitleFor( $name, $subpage = false ) {
278 $name = SpecialPageFactory
::getLocalNameFor( $name, $subpage );
280 return Title
::makeTitleSafe( NS_SPECIAL
, $name );
287 * Get a title for a given alias
289 * @param $alias String
290 * @return Title or null if there is no such alias
291 * @deprecated since 1.18 call SpecialPageFactory method directly
293 static function getTitleForAlias( $alias ) {
294 wfDeprecated( __METHOD__
, '1.18' );
295 return SpecialPageFactory
::getTitleForAlias( $alias );
299 * Default constructor for special pages
300 * Derivative classes should call this from their constructor
301 * Note that if the user does not have the required level, an error message will
302 * be displayed by the default execute() method, without the global function ever
305 * If you override execute(), you can recover the default behavior with userCanExecute()
306 * and displayRestrictionError()
308 * @param string $name name of the special page, as seen in links and URLs
309 * @param string $restriction user right required, e.g. "block" or "delete"
310 * @param bool $listed whether the page is listed in Special:Specialpages
311 * @param $function Callback|Bool: function called by execute(). By default it is constructed from $name
312 * @param string $file file which is included by execute(). It is also constructed from $name by default
313 * @param bool $includable whether the page can be included in normal pages
315 public function __construct(
316 $name = '', $restriction = '', $listed = true,
317 $function = false, $file = 'default', $includable = false
319 $this->init( $name, $restriction, $listed, $function, $file, $includable );
323 * Do the real work for the constructor, mainly so __call() can intercept
324 * calls to SpecialPage()
325 * @param string $name name of the special page, as seen in links and URLs
326 * @param string $restriction user right required, e.g. "block" or "delete"
327 * @param bool $listed whether the page is listed in Special:Specialpages
328 * @param $function Callback|Bool: function called by execute(). By default it is constructed from $name
329 * @param string $file file which is included by execute(). It is also constructed from $name by default
330 * @param bool $includable whether the page can be included in normal pages
332 private function init( $name, $restriction, $listed, $function, $file, $includable ) {
333 $this->mName
= $name;
334 $this->mRestriction
= $restriction;
335 $this->mListed
= $listed;
336 $this->mIncludable
= $includable;
338 $this->mFunction
= 'wfSpecial' . $name;
340 $this->mFunction
= $function;
342 if ( $file === 'default' ) {
343 $this->mFile
= __DIR__
. "/specials/Special$name.php";
345 $this->mFile
= $file;
350 * Use PHP's magic __call handler to get calls to the old PHP4 constructor
351 * because PHP E_STRICT yells at you for having __construct() and SpecialPage()
353 * @param string $fName Name of called method
354 * @param array $a Arguments to the method
355 * @throws MWException
356 * @deprecated since 1.17, call parent::__construct()
358 public function __call( $fName, $a ) {
359 // Deprecated messages now, remove in 1.19 or 1.20?
360 wfDeprecated( __METHOD__
, '1.17' );
362 // Sometimes $fName is SpecialPage, sometimes it's specialpage. <3 PHP
363 if ( strtolower( $fName ) == 'specialpage' ) {
364 $name = isset( $a[0] ) ?
$a[0] : '';
365 $restriction = isset( $a[1] ) ?
$a[1] : '';
366 $listed = isset( $a[2] ) ?
$a[2] : true;
367 $function = isset( $a[3] ) ?
$a[3] : false;
368 $file = isset( $a[4] ) ?
$a[4] : 'default';
369 $includable = isset( $a[5] ) ?
$a[5] : false;
370 $this->init( $name, $restriction, $listed, $function, $file, $includable );
372 $className = get_class( $this );
373 throw new MWException( "Call to undefined method $className::$fName" );
378 * Get the name of this Special Page.
386 * Get the permission that a user must have to execute this page
389 function getRestriction() {
390 return $this->mRestriction
;
394 * Get the file which will be included by SpecialPage::execute() if your extension is
395 * still stuck in the past and hasn't overridden the execute() method. No modern code
396 * should want or need to know this.
398 * @deprecated since 1.18
401 wfDeprecated( __METHOD__
, '1.18' );
405 // @todo FIXME: Decide which syntax to use for this, and stick to it
407 * Whether this special page is listed in Special:SpecialPages
408 * @since r3583 (v1.3)
411 function isListed() {
412 return $this->mListed
;
415 * Set whether this page is listed in Special:Specialpages, at run-time
416 * @since r3583 (v1.3)
417 * @param $listed Bool
420 function setListed( $listed ) {
421 return wfSetVar( $this->mListed
, $listed );
424 * Get or set whether this special page is listed in Special:SpecialPages
425 * @since r11308 (v1.6)
429 function listed( $x = null ) {
430 return wfSetVar( $this->mListed
, $x );
434 * Whether it's allowed to transclude the special page via {{Special:Foo/params}}
437 public function isIncludable() {
438 return $this->mIncludable
;
442 * These mutators are very evil, as the relevant variables should not mutate. So
446 * @deprecated since 1.18
448 function name( $x = null ) { wfDeprecated( __METHOD__
, '1.18' ); return wfSetVar( $this->mName
, $x ); }
451 * These mutators are very evil, as the relevant variables should not mutate. So
455 * @deprecated since 1.18
457 function restriction( $x = null ) { wfDeprecated( __METHOD__
, '1.18' ); return wfSetVar( $this->mRestriction
, $x ); }
460 * These mutators are very evil, as the relevant variables should not mutate. So
464 * @deprecated since 1.18
466 function func( $x = null ) { wfDeprecated( __METHOD__
, '1.18' ); return wfSetVar( $this->mFunction
, $x ); }
469 * These mutators are very evil, as the relevant variables should not mutate. So
473 * @deprecated since 1.18
475 function file( $x = null ) { wfDeprecated( __METHOD__
, '1.18' ); return wfSetVar( $this->mFile
, $x ); }
478 * These mutators are very evil, as the relevant variables should not mutate. So
482 * @deprecated since 1.18
484 function includable( $x = null ) { wfDeprecated( __METHOD__
, '1.18' ); return wfSetVar( $this->mIncludable
, $x ); }
487 * Whether the special page is being evaluated via transclusion
491 function including( $x = null ) {
492 return wfSetVar( $this->mIncluding
, $x );
496 * Get the localised name of the special page
498 function getLocalName() {
499 if ( !isset( $this->mLocalName
) ) {
500 $this->mLocalName
= SpecialPageFactory
::getLocalNameFor( $this->mName
);
502 return $this->mLocalName
;
506 * Is this page expensive (for some definition of expensive)?
507 * Expensive pages are disabled or cached in miser mode. Originally used
508 * (and still overridden) by QueryPage and subclasses, moved here so that
509 * Special:SpecialPages can safely call it for all special pages.
513 public function isExpensive() {
518 * Is this page cached?
519 * Expensive pages are cached or disabled in miser mode.
520 * Used by QueryPage and subclasses, moved here so that
521 * Special:SpecialPages can safely call it for all special pages.
526 public function isCached() {
531 * Can be overridden by subclasses with more complicated permissions
534 * @return Boolean: should the page be displayed with the restricted-access
537 public function isRestricted() {
538 // DWIM: If all anons can do something, then it is not restricted
539 return $this->mRestriction
!= '' && !User
::groupHasPermission( '*', $this->mRestriction
);
543 * Checks if the given user (identified by an object) can execute this
544 * special page (as defined by $mRestriction). Can be overridden by sub-
545 * classes with more complicated permissions schemes.
547 * @param $user User: the user to check
548 * @return Boolean: does the user have permission to view the page?
550 public function userCanExecute( User
$user ) {
551 return $user->isAllowed( $this->mRestriction
);
555 * Output an error message telling the user what access level they have to have
557 function displayRestrictionError() {
558 throw new PermissionsError( $this->mRestriction
);
562 * Checks if userCanExecute, and if not throws a PermissionsError
566 public function checkPermissions() {
567 if ( !$this->userCanExecute( $this->getUser() ) ) {
568 $this->displayRestrictionError();
573 * If the wiki is currently in readonly mode, throws a ReadOnlyError
576 * @throws ReadOnlyError
578 public function checkReadOnly() {
579 if ( wfReadOnly() ) {
580 throw new ReadOnlyError
;
585 * Sets headers - this should be called from the execute() method of all derived classes!
587 function setHeaders() {
588 $out = $this->getOutput();
589 $out->setArticleRelated( false );
590 $out->setRobotPolicy( "noindex,nofollow" );
591 $out->setPageTitle( $this->getDescription() );
599 * @param $subPage string|null
601 final public function run( $subPage ) {
603 * Gets called before @see SpecialPage::execute.
607 * @param $special SpecialPage
608 * @param $subPage string|null
610 wfRunHooks( 'SpecialPageBeforeExecute', array( $this, $subPage ) );
612 $this->beforeExecute( $subPage );
613 $this->execute( $subPage );
614 $this->afterExecute( $subPage );
617 * Gets called after @see SpecialPage::execute.
621 * @param $special SpecialPage
622 * @param $subPage string|null
624 wfRunHooks( 'SpecialPageAfterExecute', array( $this, $subPage ) );
628 * Gets called before @see SpecialPage::execute.
632 * @param $subPage string|null
634 protected function beforeExecute( $subPage ) {
639 * Gets called after @see SpecialPage::execute.
643 * @param $subPage string|null
645 protected function afterExecute( $subPage ) {
650 * Default execute method
651 * Checks user permissions, calls the function given in mFunction
653 * This must be overridden by subclasses; it will be made abstract in a future version
655 * @param $subPage string|null
657 public function execute( $subPage ) {
659 $this->checkPermissions();
661 $func = $this->mFunction
;
662 // only load file if the function does not exist
663 if ( !is_callable( $func ) && $this->mFile
) {
664 require_once( $this->mFile
);
666 $this->outputHeader();
667 call_user_func( $func, $subPage, $this );
671 * Outputs a summary message on top of special pages
672 * Per default the message key is the canonical name of the special page
673 * May be overridden, i.e. by extensions to stick with the naming conventions
674 * for message keys: 'extensionname-xxx'
676 * @param string $summaryMessageKey message key of the summary
678 function outputHeader( $summaryMessageKey = '' ) {
681 if ( $summaryMessageKey == '' ) {
682 $msg = $wgContLang->lc( $this->getName() ) . '-summary';
684 $msg = $summaryMessageKey;
686 if ( !$this->msg( $msg )->isDisabled() && !$this->including() ) {
687 $this->getOutput()->wrapWikiMsg(
688 "<div class='mw-specialpage-summary'>\n$1\n</div>", $msg );
694 * Returns the name that goes in the \<h1\> in the special page itself, and
695 * also the name that will be listed in Special:Specialpages
697 * Derived classes can override this, but usually it is easier to keep the
698 * default behavior. Messages can be added at run-time, see
703 function getDescription() {
704 return $this->msg( strtolower( $this->mName
) )->text();
708 * Get a self-referential title object
710 * @param $subpage String|Bool
711 * @return Title object
713 function getTitle( $subpage = false ) {
714 return self
::getTitleFor( $this->mName
, $subpage );
718 * Sets the context this SpecialPage is executed in
720 * @param $context IContextSource
723 public function setContext( $context ) {
724 $this->mContext
= $context;
728 * Gets the context this SpecialPage is executed in
730 * @return IContextSource|RequestContext
733 public function getContext() {
734 if ( $this->mContext
instanceof IContextSource
) {
735 return $this->mContext
;
737 wfDebug( __METHOD__
. " called and \$mContext is null. Return RequestContext::getMain(); for sanity\n" );
738 return RequestContext
::getMain();
743 * Get the WebRequest being used for this instance
748 public function getRequest() {
749 return $this->getContext()->getRequest();
753 * Get the OutputPage being used for this instance
758 public function getOutput() {
759 return $this->getContext()->getOutput();
763 * Shortcut to get the User executing this instance
768 public function getUser() {
769 return $this->getContext()->getUser();
773 * Shortcut to get the skin being used for this instance
778 public function getSkin() {
779 return $this->getContext()->getSkin();
783 * Shortcut to get user's language
785 * @deprecated 1.19 Use getLanguage instead
789 public function getLang() {
790 wfDeprecated( __METHOD__
, '1.19' );
791 return $this->getLanguage();
795 * Shortcut to get user's language
800 public function getLanguage() {
801 return $this->getContext()->getLanguage();
805 * Return the full title, including $par
810 public function getFullTitle() {
811 return $this->getContext()->getTitle();
815 * Wrapper around wfMessage that sets the current context.
820 public function msg( /* $args */ ) {
821 // Note: can't use func_get_args() directly as second or later item in
822 // a parameter list until PHP 5.3 or you get a fatal error.
823 // Works fine as the first parameter, which appears elsewhere in the
824 // code base. Sighhhh.
825 $args = func_get_args();
826 $message = call_user_func_array( array( $this->getContext(), 'msg' ), $args );
827 // RequestContext passes context to wfMessage, and the language is set from
828 // the context, but setting the language for Message class removes the
829 // interface message status, which breaks for example usernameless gender
830 // invocations. Restore the flag when not including special page in content.
831 if ( $this->including() ) {
832 $message->setInterfaceMessageFlag( false );
838 * Adds RSS/atom links
840 * @param $params array
842 protected function addFeedLinks( $params ) {
843 global $wgFeedClasses;
845 $feedTemplate = wfScript( 'api' ) . '?';
847 foreach ( $wgFeedClasses as $format => $class ) {
848 $theseParams = $params +
array( 'feedformat' => $format );
849 $url = $feedTemplate . wfArrayToCgi( $theseParams );
850 $this->getOutput()->addFeedLink( $format, $url );
855 * Get the group that the special page belongs in on Special:SpecialPage
856 * Use this method, instead of getGroupName to allow customization
857 * of the group name from the wiki side
859 * @return string Group of this special page
862 public function getFinalGroupName() {
863 global $wgSpecialPageGroups;
864 $name = $this->getName();
867 // Allow overbidding the group from the wiki side
868 $msg = $this->msg( 'specialpages-specialpagegroup-' . strtolower( $name ) )->inContentLanguage();
869 if ( !$msg->isBlank() ) {
870 $group = $msg->text();
872 // Than use the group from this object
873 $group = $this->getGroupName();
875 // Group '-' is used as default to have the chance to determine,
876 // if the special pages overrides this method,
877 // if not overridden, $wgSpecialPageGroups is checked for b/c
878 if ( $group === '-' && isset( $wgSpecialPageGroups[$name] ) ) {
879 $group = $wgSpecialPageGroups[$name];
883 // never give '-' back, change to 'other'
884 if ( $group === '-' ) {
892 * Under which header this special page is listed in Special:SpecialPages
893 * See messages 'specialpages-group-*' for valid names
894 * This method defaults to group 'other'
899 protected function getGroupName() {
900 // '-' used here to determine, if this group is overridden or has a hardcoded 'other'
901 // Needed for b/c in getFinalGroupName
907 * Special page which uses an HTMLForm to handle processing. This is mostly a
908 * clone of FormAction. More special pages should be built this way; maybe this could be
909 * a new structure for SpecialPages
911 abstract class FormSpecialPage
extends SpecialPage
{
914 * Get an HTMLForm descriptor array
917 abstract protected function getFormFields();
920 * Add pre- or post-text to the form
921 * @return String HTML which will be sent to $form->addPreText()
923 protected function preText() { return ''; }
924 protected function postText() { return ''; }
927 * Play with the HTMLForm if you need to more substantially
928 * @param $form HTMLForm
930 protected function alterForm( HTMLForm
$form ) {}
933 * Get message prefix for HTMLForm
938 protected function getMessagePrefix() {
939 return strtolower( $this->getName() );
943 * Get the HTMLForm to control behavior
944 * @return HTMLForm|null
946 protected function getForm() {
947 $this->fields
= $this->getFormFields();
949 $form = new HTMLForm( $this->fields
, $this->getContext(), $this->getMessagePrefix() );
950 $form->setSubmitCallback( array( $this, 'onSubmit' ) );
951 $form->setWrapperLegend( $this->msg( $this->getMessagePrefix() . '-legend' ) );
952 $form->addHeaderText(
953 $this->msg( $this->getMessagePrefix() . '-text' )->parseAsBlock() );
955 // Retain query parameters (uselang etc)
956 $params = array_diff_key(
957 $this->getRequest()->getQueryValues(), array( 'title' => null ) );
958 $form->addHiddenField( 'redirectparams', wfArrayToCgi( $params ) );
960 $form->addPreText( $this->preText() );
961 $form->addPostText( $this->postText() );
962 $this->alterForm( $form );
964 // Give hooks a chance to alter the form, adding extra fields or text etc
965 wfRunHooks( "Special{$this->getName()}BeforeFormDisplay", array( &$form ) );
971 * Process the form on POST submission.
973 * @return Bool|Array true for success, false for didn't-try, array of errors on failure
975 abstract public function onSubmit( array $data );
978 * Do something exciting on successful processing of the form, most likely to show a
979 * confirmation message
981 abstract public function onSuccess();
984 * Basic SpecialPage workflow: get a form, send it to the user; get some data back,
986 * @param string $par Subpage string if one was specified
988 public function execute( $par ) {
989 $this->setParameter( $par );
992 // This will throw exceptions if there's a problem
993 $this->checkExecutePermissions( $this->getUser() );
995 $form = $this->getForm();
996 if ( $form->show() ) {
1002 * Maybe do something interesting with the subpage parameter
1003 * @param $par String
1005 protected function setParameter( $par ) {}
1008 * Called from execute() to check if the given user can perform this action.
1009 * Failures here must throw subclasses of ErrorPageError.
1011 * @throws UserBlockedError
1014 protected function checkExecutePermissions( User
$user ) {
1015 $this->checkPermissions();
1017 if ( $this->requiresUnblock() && $user->isBlocked() ) {
1018 $block = $user->getBlock();
1019 throw new UserBlockedError( $block );
1022 if ( $this->requiresWrite() ) {
1023 $this->checkReadOnly();
1030 * Whether this action requires the wiki not to be locked
1033 public function requiresWrite() {
1038 * Whether this action cannot be executed by a blocked user
1041 public function requiresUnblock() {
1047 * Shortcut to construct a special page which is unlisted by default
1048 * @ingroup SpecialPage
1050 class UnlistedSpecialPage
extends SpecialPage
{
1051 function __construct( $name, $restriction = '', $function = false, $file = 'default' ) {
1052 parent
::__construct( $name, $restriction, false, $function, $file );
1055 public function isListed() {
1061 * Shortcut to construct an includable special page
1062 * @ingroup SpecialPage
1064 class IncludableSpecialPage
extends SpecialPage
{
1065 function __construct(
1066 $name, $restriction = '', $listed = true, $function = false, $file = 'default'
1068 parent
::__construct( $name, $restriction, $listed, $function, $file, true );
1071 public function isIncludable() {
1077 * Shortcut to construct a special page alias.
1078 * @ingroup SpecialPage
1080 abstract class RedirectSpecialPage
extends UnlistedSpecialPage
{
1082 // Query parameters that can be passed through redirects
1083 protected $mAllowedRedirectParams = array();
1085 // Query parameters added by redirects
1086 protected $mAddedRedirectParams = array();
1088 public function execute( $par ) {
1089 $redirect = $this->getRedirect( $par );
1090 $query = $this->getRedirectQuery();
1091 // Redirect to a page title with possible query parameters
1092 if ( $redirect instanceof Title
) {
1093 $url = $redirect->getFullURL( $query );
1094 $this->getOutput()->redirect( $url );
1096 // Redirect to index.php with query parameters
1097 } elseif ( $redirect === true ) {
1099 $url = $wgScript . '?' . wfArrayToCgi( $query );
1100 $this->getOutput()->redirect( $url );
1104 throw new MWException( "RedirectSpecialPage $class doesn't redirect!" );
1109 * If the special page is a redirect, then get the Title object it redirects to.
1112 * @param string $par Subpage string
1113 * @return Title|bool
1115 abstract public function getRedirect( $par );
1118 * Return part of the request string for a special redirect page
1119 * This allows passing, e.g. action=history to Special:Mypage, etc.
1123 public function getRedirectQuery() {
1126 foreach ( $this->mAllowedRedirectParams
as $arg ) {
1127 if ( $this->getRequest()->getVal( $arg, null ) !== null ) {
1128 $params[$arg] = $this->getRequest()->getVal( $arg );
1132 foreach ( $this->mAddedRedirectParams
as $arg => $val ) {
1133 $params[$arg] = $val;
1136 return count( $params )
1142 abstract class SpecialRedirectToSpecial
extends RedirectSpecialPage
{
1143 var $redirName, $redirSubpage;
1145 function __construct(
1146 $name, $redirName, $redirSubpage = false,
1147 $allowedRedirectParams = array(), $addedRedirectParams = array()
1149 parent
::__construct( $name );
1150 $this->redirName
= $redirName;
1151 $this->redirSubpage
= $redirSubpage;
1152 $this->mAllowedRedirectParams
= $allowedRedirectParams;
1153 $this->mAddedRedirectParams
= $addedRedirectParams;
1156 public function getRedirect( $subpage ) {
1157 if ( $this->redirSubpage
=== false ) {
1158 return SpecialPage
::getTitleFor( $this->redirName
, $subpage );
1160 return SpecialPage
::getTitleFor( $this->redirName
, $this->redirSubpage
);
1166 * ListAdmins --> ListUsers/sysop
1168 class SpecialListAdmins
extends SpecialRedirectToSpecial
{
1169 function __construct() {
1170 parent
::__construct( 'Listadmins', 'Listusers', 'sysop' );
1175 * ListBots --> ListUsers/bot
1177 class SpecialListBots
extends SpecialRedirectToSpecial
{
1178 function __construct() {
1179 parent
::__construct( 'Listbots', 'Listusers', 'bot' );
1184 * CreateAccount --> UserLogin/signup
1185 * @todo FIXME: This (and the rest of the login frontend) needs to die a horrible painful death
1187 class SpecialCreateAccount
extends SpecialRedirectToSpecial
{
1188 function __construct() {
1189 parent
::__construct( 'CreateAccount', 'Userlogin', 'signup', array( 'uselang' ) );
1193 * SpecialMypage, SpecialMytalk and SpecialMycontributions special pages
1194 * are used to get user independent links pointing to the user page, talk
1195 * page and list of contributions.
1196 * This can let us cache a single copy of any generated content for all
1201 * Superclass for any RedirectSpecialPage which redirects the user
1202 * to a particular article (as opposed to user contributions, logs, etc.).
1204 * For security reasons these special pages are restricted to pass on
1205 * the following subset of GET parameters to the target page while
1206 * removing all others:
1208 * - useskin, uselang, printable: to alter the appearance of the resulting page
1210 * - redirect: allows viewing one's user page or talk page even if it is a
1213 * - rdfrom: allows redirecting to one's user page or talk page from an
1214 * external wiki with the "Redirect from..." notice.
1216 * - limit, offset: Useful for linking to history of one's own user page or
1217 * user talk page. For example, this would be a link to "the last edit to your
1218 * user talk page in the year 2010":
1219 * http://en.wikipedia.org/w/index.php?title=Special:MyPage&offset=20110000000000&limit=1&action=history
1221 * - feed: would allow linking to the current user's RSS feed for their user
1223 * http://en.wikipedia.org/w/index.php?title=Special:MyTalk&action=history&feed=rss
1225 * - preloadtitle: Can be used to provide a default section title for a
1226 * preloaded new comment on one's own talk page.
1228 * - summary : Can be used to provide a default edit summary for a preloaded
1229 * edit to one's own user page or talk page.
1231 * - preview: Allows showing/hiding preview on first edit regardless of user
1232 * preference, useful for preloaded edits where you know preview wouldn't be
1235 * - internaledit, externaledit, mode: Allows forcing the use of the
1236 * internal/external editor, e.g. to force the internal editor for
1237 * short/simple preloaded edits.
1239 * - redlink: Affects the message the user sees if their talk page/user talk
1240 * page does not currently exist. Avoids confusion for newbies with no user
1241 * pages over why they got a "permission error" following this link:
1242 * http://en.wikipedia.org/w/index.php?title=Special:MyPage&redlink=1
1244 * - debug: determines whether the debug parameter is passed to load.php,
1245 * which disables reformatting and allows scripts to be debugged. Useful
1246 * when debugging scripts that manipulate one's own user page or talk page.
1248 * @par Hook extension:
1249 * Extensions can add to the redirect parameters list by using the hook
1250 * RedirectSpecialArticleRedirectParams
1252 * This hook allows extensions which add GET parameters like FlaggedRevs to
1253 * retain those parameters when redirecting using special pages.
1255 * @par Hook extension example:
1257 * $wgHooks['RedirectSpecialArticleRedirectParams'][] =
1258 * 'MyExtensionHooks::onRedirectSpecialArticleRedirectParams';
1259 * public static function onRedirectSpecialArticleRedirectParams( &$redirectParams ) {
1260 * $redirectParams[] = 'stable';
1264 * @ingroup SpecialPage
1266 abstract class RedirectSpecialArticle
extends RedirectSpecialPage
{
1267 function __construct( $name ) {
1268 parent
::__construct( $name );
1269 $redirectParams = array(
1271 'redirect', 'rdfrom',
1272 # Options for preloaded edits
1273 'preload', 'editintro', 'preloadtitle', 'summary',
1274 # Options for overriding user settings
1275 'preview', 'internaledit', 'externaledit', 'mode',
1276 # Options for history/diffs
1277 'section', 'oldid', 'diff', 'dir',
1278 'limit', 'offset', 'feed',
1281 # Options for action=raw; missing ctype can break JS or CSS in some browsers
1282 'ctype', 'maxage', 'smaxage',
1285 wfRunHooks( "RedirectSpecialArticleRedirectParams", array( &$redirectParams ) );
1286 $this->mAllowedRedirectParams
= $redirectParams;
1291 * Shortcut to construct a special page pointing to current user user's page.
1292 * @ingroup SpecialPage
1294 class SpecialMypage
extends RedirectSpecialArticle
{
1295 function __construct() {
1296 parent
::__construct( 'Mypage' );
1299 function getRedirect( $subpage ) {
1300 if ( strval( $subpage ) !== '' ) {
1301 return Title
::makeTitle( NS_USER
, $this->getUser()->getName() . '/' . $subpage );
1303 return Title
::makeTitle( NS_USER
, $this->getUser()->getName() );
1309 * Shortcut to construct a special page pointing to current user talk page.
1310 * @ingroup SpecialPage
1312 class SpecialMytalk
extends RedirectSpecialArticle
{
1313 function __construct() {
1314 parent
::__construct( 'Mytalk' );
1317 function getRedirect( $subpage ) {
1318 if ( strval( $subpage ) !== '' ) {
1319 return Title
::makeTitle( NS_USER_TALK
, $this->getUser()->getName() . '/' . $subpage );
1321 return Title
::makeTitle( NS_USER_TALK
, $this->getUser()->getName() );
1327 * Shortcut to construct a special page pointing to current user contributions.
1328 * @ingroup SpecialPage
1330 class SpecialMycontributions
extends RedirectSpecialPage
{
1331 function __construct() {
1332 parent
::__construct( 'Mycontributions' );
1333 $this->mAllowedRedirectParams
= array( 'limit', 'namespace', 'tagfilter',
1334 'offset', 'dir', 'year', 'month', 'feed' );
1337 function getRedirect( $subpage ) {
1338 return SpecialPage
::getTitleFor( 'Contributions', $this->getUser()->getName() );
1343 * Redirect to Special:Listfiles?user=$wgUser
1345 class SpecialMyuploads
extends RedirectSpecialPage
{
1346 function __construct() {
1347 parent
::__construct( 'Myuploads' );
1348 $this->mAllowedRedirectParams
= array( 'limit' );
1351 function getRedirect( $subpage ) {
1352 return SpecialPage
::getTitleFor( 'Listfiles', $this->getUser()->getName() );
1357 * Redirect from Special:PermanentLink/### to index.php?oldid=###
1359 class SpecialPermanentLink
extends RedirectSpecialPage
{
1360 function __construct() {
1361 parent
::__construct( 'PermanentLink' );
1362 $this->mAllowedRedirectParams
= array();
1365 function getRedirect( $subpage ) {
1366 $subpage = intval( $subpage );
1367 if ( $subpage === 0 ) {
1368 # throw an error page when no subpage was given
1369 throw new ErrorPageError( 'nopagetitle', 'nopagetext' );
1371 $this->mAddedRedirectParams
['oldid'] = $subpage;