includes/specialpage/SpecialPage.php

   1 <?php
   2 /**
   3  * Parent class for all special pages.
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  * @ingroup SpecialPage
  22  */
  23
  24 use MediaWiki\Auth\AuthManager;
  25 use MediaWiki\Linker\LinkRenderer;
  26 use MediaWiki\MediaWikiServices;
  27
  28 /**
  29  * Parent class for all special pages.
  30  *
  31  * Includes some static functions for handling the special page list deprecated
  32  * in favor of SpecialPageFactory.
  33  *
  34  * @ingroup SpecialPage
  35  */
  36 class SpecialPage implements MessageLocalizer {
  37         // The canonical name of this special page
  38         // Also used for the default <h1> heading, @see getDescription()
  39         protected $mName;
  40
  41         // The local name of this special page
  42         private $mLocalName;
  43
  44         // Minimum user level required to access this page, or "" for anyone.
  45         // Also used to categorise the pages in Special:Specialpages
  46         protected $mRestriction;
  47
  48         // Listed in Special:Specialpages?
  49         private $mListed;
  50
  51         // Whether or not this special page is being included from an article
  52         protected $mIncluding;
  53
  54         // Whether the special page can be included in an article
  55         protected $mIncludable;
  56
  57         /**
  58          * Current request context
  59          * @var IContextSource
  60          */
  61         protected $mContext;
  62
  63         /**
  64          * @var \MediaWiki\Linker\LinkRenderer|null
  65          */
  66         private $linkRenderer;
  67
  68         /**
  69          * Get a localised Title object for a specified special page name
  70          * If you don't need a full Title object, consider using TitleValue through
  71          * getTitleValueFor() below.
  72          *
  73          * @since 1.9
  74          * @since 1.21 $fragment parameter added
  75          *
  76          * @param string $name
  77          * @param string|bool $subpage Subpage string, or false to not use a subpage
  78          * @param string $fragment The link fragment (after the "#")
  79          * @return Title
  80          * @throws MWException
  81          */
  82         public static function getTitleFor( $name, $subpage = false, $fragment = '' ) {
  83                 return Title::newFromTitleValue(
  84                         self::getTitleValueFor( $name, $subpage, $fragment )
  85                 );
  86         }
  87
  88         /**
  89          * Get a localised TitleValue object for a specified special page name
  90          *
  91          * @since 1.28
  92          * @param string $name
  93          * @param string|bool $subpage Subpage string, or false to not use a subpage
  94          * @param string $fragment The link fragment (after the "#")
  95          * @return TitleValue
  96          */
  97         public static function getTitleValueFor( $name, $subpage = false, $fragment = '' ) {
  98                 $name = MediaWikiServices::getInstance()->getSpecialPageFactory()->
  99                         getLocalNameFor( $name, $subpage );
 100
 101                 return new TitleValue( NS_SPECIAL, $name, $fragment );
 102         }
 103
 104         /**
 105          * Get a localised Title object for a page name with a possibly unvalidated subpage
 106          *
 107          * @param string $name
 108          * @param string|bool $subpage Subpage string, or false to not use a subpage
 109          * @return Title|null Title object or null if the page doesn't exist
 110          */
 111         public static function getSafeTitleFor( $name, $subpage = false ) {
 112                 $name = MediaWikiServices::getInstance()->getSpecialPageFactory()->
 113                         getLocalNameFor( $name, $subpage );
 114                 if ( $name ) {
 115                         return Title::makeTitleSafe( NS_SPECIAL, $name );
 116                 } else {
 117                         return null;
 118                 }
 119         }
 120
 121         /**
 122          * Default constructor for special pages
 123          * Derivative classes should call this from their constructor
 124          *     Note that if the user does not have the required level, an error message will
 125          *     be displayed by the default execute() method, without the global function ever
 126          *     being called.
 127          *
 128          *     If you override execute(), you can recover the default behavior with userCanExecute()
 129          *     and displayRestrictionError()
 130          *
 131          * @param string $name Name of the special page, as seen in links and URLs
 132          * @param string $restriction User right required, e.g. "block" or "delete"
 133          * @param bool $listed Whether the page is listed in Special:Specialpages
 134          * @param callable|bool $function Unused
 135          * @param string $file Unused
 136          * @param bool $includable Whether the page can be included in normal pages
 137          */
 138         public function __construct(
 139                 $name = '', $restriction = '', $listed = true,
 140                 $function = false, $file = '', $includable = false
 141         ) {
 142                 $this->mName = $name;
 143                 $this->mRestriction = $restriction;
 144                 $this->mListed = $listed;
 145                 $this->mIncludable = $includable;
 146         }
 147
 148         /**
 149          * Get the name of this Special Page.
 150          * @return string
 151          */
 152         function getName() {
 153                 return $this->mName;
 154         }
 155
 156         /**
 157          * Get the permission that a user must have to execute this page
 158          * @return string
 159          */
 160         function getRestriction() {
 161                 return $this->mRestriction;
 162         }
 163
 164         // @todo FIXME: Decide which syntax to use for this, and stick to it
 165         /**
 166          * Whether this special page is listed in Special:SpecialPages
 167          * @since 1.3 (r3583)
 168          * @return bool
 169          */
 170         function isListed() {
 171                 return $this->mListed;
 172         }
 173
 174         /**
 175          * Set whether this page is listed in Special:Specialpages, at run-time
 176          * @since 1.3
 177          * @param bool $listed
 178          * @return bool
 179          */
 180         function setListed( $listed ) {
 181                 return wfSetVar( $this->mListed, $listed );
 182         }
 183
 184         /**
 185          * Get or set whether this special page is listed in Special:SpecialPages
 186          * @since 1.6
 187          * @param bool|null $x
 188          * @return bool
 189          */
 190         function listed( $x = null ) {
 191                 return wfSetVar( $this->mListed, $x );
 192         }
 193
 194         /**
 195          * Whether it's allowed to transclude the special page via {{Special:Foo/params}}
 196          * @return bool
 197          */
 198         public function isIncludable() {
 199                 return $this->mIncludable;
 200         }
 201
 202         /**
 203          * How long to cache page when it is being included.
 204          *
 205          * @note If cache time is not 0, then the current user becomes an anon
 206          *   if you want to do any per-user customizations, than this method
 207          *   must be overriden to return 0.
 208          * @since 1.26
 209          * @return int Time in seconds, 0 to disable caching altogether,
 210          *  false to use the parent page's cache settings
 211          */
 212         public function maxIncludeCacheTime() {
 213                 return $this->getConfig()->get( 'MiserMode' ) ? $this->getCacheTTL() : 0;
 214         }
 215
 216         /**
 217          * @return int Seconds that this page can be cached
 218          */
 219         protected function getCacheTTL() {
 220                 return 60 * 60;
 221         }
 222
 223         /**
 224          * Whether the special page is being evaluated via transclusion
 225          * @param bool|null $x
 226          * @return bool
 227          */
 228         function including( $x = null ) {
 229                 return wfSetVar( $this->mIncluding, $x );
 230         }
 231
 232         /**
 233          * Get the localised name of the special page
 234          * @return string
 235          */
 236         function getLocalName() {
 237                 if ( !isset( $this->mLocalName ) ) {
 238                         $this->mLocalName = MediaWikiServices::getInstance()->getSpecialPageFactory()->
 239                                 getLocalNameFor( $this->mName );
 240                 }
 241
 242                 return $this->mLocalName;
 243         }
 244
 245         /**
 246          * Is this page expensive (for some definition of expensive)?
 247          * Expensive pages are disabled or cached in miser mode.  Originally used
 248          * (and still overridden) by QueryPage and subclasses, moved here so that
 249          * Special:SpecialPages can safely call it for all special pages.
 250          *
 251          * @return bool
 252          */
 253         public function isExpensive() {
 254                 return false;
 255         }
 256
 257         /**
 258          * Is this page cached?
 259          * Expensive pages are cached or disabled in miser mode.
 260          * Used by QueryPage and subclasses, moved here so that
 261          * Special:SpecialPages can safely call it for all special pages.
 262          *
 263          * @return bool
 264          * @since 1.21
 265          */
 266         public function isCached() {
 267                 return false;
 268         }
 269
 270         /**
 271          * Can be overridden by subclasses with more complicated permissions
 272          * schemes.
 273          *
 274          * @return bool Should the page be displayed with the restricted-access
 275          *   pages?
 276          */
 277         public function isRestricted() {
 278                 // DWIM: If anons can do something, then it is not restricted
 279                 return $this->mRestriction != '' && !User::groupHasPermission( '*', $this->mRestriction );
 280         }
 281
 282         /**
 283          * Checks if the given user (identified by an object) can execute this
 284          * special page (as defined by $mRestriction).  Can be overridden by sub-
 285          * classes with more complicated permissions schemes.
 286          *
 287          * @param User $user The user to check
 288          * @return bool Does the user have permission to view the page?
 289          */
 290         public function userCanExecute( User $user ) {
 291                 return $user->isAllowed( $this->mRestriction );
 292         }
 293
 294         /**
 295          * Output an error message telling the user what access level they have to have
 296          * @throws PermissionsError
 297          */
 298         function displayRestrictionError() {
 299                 throw new PermissionsError( $this->mRestriction );
 300         }
 301
 302         /**
 303          * Checks if userCanExecute, and if not throws a PermissionsError
 304          *
 305          * @since 1.19
 306          * @return void
 307          * @throws PermissionsError
 308          */
 309         public function checkPermissions() {
 310                 if ( !$this->userCanExecute( $this->getUser() ) ) {
 311                         $this->displayRestrictionError();
 312                 }
 313         }
 314
 315         /**
 316          * If the wiki is currently in readonly mode, throws a ReadOnlyError
 317          *
 318          * @since 1.19
 319          * @return void
 320          * @throws ReadOnlyError
 321          */
 322         public function checkReadOnly() {
 323                 if ( wfReadOnly() ) {
 324                         throw new ReadOnlyError;
 325                 }
 326         }
 327
 328         /**
 329          * If the user is not logged in, throws UserNotLoggedIn error
 330          *
 331          * The user will be redirected to Special:Userlogin with the given message as an error on
 332          * the form.
 333          *
 334          * @since 1.23
 335          * @param string $reasonMsg [optional] Message key to be displayed on login page
 336          * @param string $titleMsg [optional] Passed on to UserNotLoggedIn constructor
 337          * @throws UserNotLoggedIn
 338          */
 339         public function requireLogin(
 340                 $reasonMsg = 'exception-nologin-text', $titleMsg = 'exception-nologin'
 341         ) {
 342                 if ( $this->getUser()->isAnon() ) {
 343                         throw new UserNotLoggedIn( $reasonMsg, $titleMsg );
 344                 }
 345         }
 346
 347         /**
 348          * Tells if the special page does something security-sensitive and needs extra defense against
 349          * a stolen account (e.g. a reauthentication). What exactly that will mean is decided by the
 350          * authentication framework.
 351          * @return bool|string False or the argument for AuthManager::securitySensitiveOperationStatus().
 352          *   Typically a special page needing elevated security would return its name here.
 353          */
 354         protected function getLoginSecurityLevel() {
 355                 return false;
 356         }
 357
 358         /**
 359          * Record preserved POST data after a reauthentication.
 360          *
 361          * This is called from checkLoginSecurityLevel() when returning from the
 362          * redirect for reauthentication, if the redirect had been served in
 363          * response to a POST request.
 364          *
 365          * The base SpecialPage implementation does nothing. If your subclass uses
 366          * getLoginSecurityLevel() or checkLoginSecurityLevel(), it should probably
 367          * implement this to do something with the data.
 368          *
 369          * @since 1.32
 370          * @param array $data
 371          */
 372         protected function setReauthPostData( array $data ) {
 373         }
 374
 375         /**
 376          * Verifies that the user meets the security level, possibly reauthenticating them in the process.
 377          *
 378          * This should be used when the page does something security-sensitive and needs extra defense
 379          * against a stolen account (e.g. a reauthentication). The authentication framework will make
 380          * an extra effort to make sure the user account is not compromised. What that exactly means
 381          * will depend on the system and user settings; e.g. the user might be required to log in again
 382          * unless their last login happened recently, or they might be given a second-factor challenge.
 383          *
 384          * Calling this method will result in one if these actions:
 385          * - return true: all good.
 386          * - return false and set a redirect: caller should abort; the redirect will take the user
 387          *   to the login page for reauthentication, and back.
 388          * - throw an exception if there is no way for the user to meet the requirements without using
 389          *   a different access method (e.g. this functionality is only available from a specific IP).
 390          *
 391          * Note that this does not in any way check that the user is authorized to use this special page
 392          * (use checkPermissions() for that).
 393          *
 394          * @param string|null $level A security level. Can be an arbitrary string, defaults to the page
 395          *   name.
 396          * @return bool False means a redirect to the reauthentication page has been set and processing
 397          *   of the special page should be aborted.
 398          * @throws ErrorPageError If the security level cannot be met, even with reauthentication.
 399          */
 400         protected function checkLoginSecurityLevel( $level = null ) {
 401                 $level = $level ?: $this->getName();
 402                 $key = 'SpecialPage:reauth:' . $this->getName();
 403                 $request = $this->getRequest();
 404
 405                 $securityStatus = AuthManager::singleton()->securitySensitiveOperationStatus( $level );
 406                 if ( $securityStatus === AuthManager::SEC_OK ) {
 407                         $uniqueId = $request->getVal( 'postUniqueId' );
 408                         if ( $uniqueId ) {
 409                                 $key = $key . ':' . $uniqueId;
 410                                 $session = $request->getSession();
 411                                 $data = $session->getSecret( $key );
 412                                 if ( $data ) {
 413                                         $session->remove( $key );
 414                                         $this->setReauthPostData( $data );
 415                                 }
 416                         }
 417                         return true;
 418                 } elseif ( $securityStatus === AuthManager::SEC_REAUTH ) {
 419                         $title = self::getTitleFor( 'Userlogin' );
 420                         $queryParams = $request->getQueryValues();
 421
 422                         if ( $request->wasPosted() ) {
 423                                 $data = array_diff_assoc( $request->getValues(), $request->getQueryValues() );
 424                                 if ( $data ) {
 425                                         // unique ID in case the same special page is open in multiple browser tabs
 426                                         $uniqueId = MWCryptRand::generateHex( 6 );
 427                                         $key = $key . ':' . $uniqueId;
 428                                         $queryParams['postUniqueId'] = $uniqueId;
 429                                         $session = $request->getSession();
 430                                         $session->persist(); // Just in case
 431                                         $session->setSecret( $key, $data );
 432                                 }
 433                         }
 434
 435                         $query = [
 436                                 'returnto' => $this->getFullTitle()->getPrefixedDBkey(),
 437                                 'returntoquery' => wfArrayToCgi( array_diff_key( $queryParams, [ 'title' => true ] ) ),
 438                                 'force' => $level,
 439                         ];
 440                         $url = $title->getFullURL( $query, false, PROTO_HTTPS );
 441
 442                         $this->getOutput()->redirect( $url );
 443                         return false;
 444                 }
 445
 446                 $titleMessage = wfMessage( 'specialpage-securitylevel-not-allowed-title' );
 447                 $errorMessage = wfMessage( 'specialpage-securitylevel-not-allowed' );
 448                 throw new ErrorPageError( $titleMessage, $errorMessage );
 449         }
 450
 451         /**
 452          * Return an array of subpages beginning with $search that this special page will accept.
 453          *
 454          * For example, if a page supports subpages "foo", "bar" and "baz" (as in Special:PageName/foo,
 455          * etc.):
 456          *
 457          *   - `prefixSearchSubpages( "ba" )` should return `array( "bar", "baz" )`
 458          *   - `prefixSearchSubpages( "f" )` should return `array( "foo" )`
 459          *   - `prefixSearchSubpages( "z" )` should return `array()`
 460          *   - `prefixSearchSubpages( "" )` should return `array( foo", "bar", "baz" )`
 461          *
 462          * @param string $search Prefix to search for
 463          * @param int $limit Maximum number of results to return (usually 10)
 464          * @param int $offset Number of results to skip (usually 0)
 465          * @return string[] Matching subpages
 466          */
 467         public function prefixSearchSubpages( $search, $limit, $offset ) {
 468                 $subpages = $this->getSubpagesForPrefixSearch();
 469                 if ( !$subpages ) {
 470                         return [];
 471                 }
 472
 473                 return self::prefixSearchArray( $search, $limit, $subpages, $offset );
 474         }
 475
 476         /**
 477          * Return an array of subpages that this special page will accept for prefix
 478          * searches. If this method requires a query you might instead want to implement
 479          * prefixSearchSubpages() directly so you can support $limit and $offset. This
 480          * method is better for static-ish lists of things.
 481          *
 482          * @return string[] subpages to search from
 483          */
 484         protected function getSubpagesForPrefixSearch() {
 485                 return [];
 486         }
 487
 488         /**
 489          * Perform a regular substring search for prefixSearchSubpages
 490          * @param string $search Prefix to search for
 491          * @param int $limit Maximum number of results to return (usually 10)
 492          * @param int $offset Number of results to skip (usually 0)
 493          * @return string[] Matching subpages
 494          */
 495         protected function prefixSearchString( $search, $limit, $offset ) {
 496                 $title = Title::newFromText( $search );
 497                 if ( !$title || !$title->canExist() ) {
 498                         // No prefix suggestion in special and media namespace
 499                         return [];
 500                 }
 501
 502                 $searchEngine = MediaWikiServices::getInstance()->newSearchEngine();
 503                 $searchEngine->setLimitOffset( $limit, $offset );
 504                 $searchEngine->setNamespaces( [] );
 505                 $result = $searchEngine->defaultPrefixSearch( $search );
 506                 return array_map( function ( Title $t ) {
 507                         return $t->getPrefixedText();
 508                 }, $result );
 509         }
 510
 511         /**
 512          * Helper function for implementations of prefixSearchSubpages() that
 513          * filter the values in memory (as opposed to making a query).
 514          *
 515          * @since 1.24
 516          * @param string $search
 517          * @param int $limit
 518          * @param array $subpages
 519          * @param int $offset
 520          * @return string[]
 521          */
 522         protected static function prefixSearchArray( $search, $limit, array $subpages, $offset ) {
 523                 $escaped = preg_quote( $search, '/' );
 524                 return array_slice( preg_grep( "/^$escaped/i",
 525                         array_slice( $subpages, $offset ) ), 0, $limit );
 526         }
 527
 528         /**
 529          * Sets headers - this should be called from the execute() method of all derived classes!
 530          */
 531         function setHeaders() {
 532                 $out = $this->getOutput();
 533                 $out->setArticleRelated( false );
 534                 $out->setRobotPolicy( $this->getRobotPolicy() );
 535                 $out->setPageTitle( $this->getDescription() );
 536                 if ( $this->getConfig()->get( 'UseMediaWikiUIEverywhere' ) ) {
 537                         $out->addModuleStyles( [
 538                                 'mediawiki.ui.input',
 539                                 'mediawiki.ui.radio',
 540                                 'mediawiki.ui.checkbox',
 541                         ] );
 542                 }
 543         }
 544
 545         /**
 546          * Entry point.
 547          *
 548          * @since 1.20
 549          *
 550          * @param string|null $subPage
 551          */
 552         final public function run( $subPage ) {
 553                 /**
 554                  * Gets called before @see SpecialPage::execute.
 555                  * Return false to prevent calling execute() (since 1.27+).
 556                  *
 557                  * @since 1.20
 558                  *
 559                  * @param SpecialPage $this
 560                  * @param string|null $subPage
 561                  */
 562                 if ( !Hooks::run( 'SpecialPageBeforeExecute', [ $this, $subPage ] ) ) {
 563                         return;
 564                 }
 565
 566                 if ( $this->beforeExecute( $subPage ) === false ) {
 567                         return;
 568                 }
 569                 $this->execute( $subPage );
 570                 $this->afterExecute( $subPage );
 571
 572                 /**
 573                  * Gets called after @see SpecialPage::execute.
 574                  *
 575                  * @since 1.20
 576                  *
 577                  * @param SpecialPage $this
 578                  * @param string|null $subPage
 579                  */
 580                 Hooks::run( 'SpecialPageAfterExecute', [ $this, $subPage ] );
 581         }
 582
 583         /**
 584          * Gets called before @see SpecialPage::execute.
 585          * Return false to prevent calling execute() (since 1.27+).
 586          *
 587          * @since 1.20
 588          *
 589          * @param string|null $subPage
 590          * @return bool|void
 591          */
 592         protected function beforeExecute( $subPage ) {
 593                 // No-op
 594         }
 595
 596         /**
 597          * Gets called after @see SpecialPage::execute.
 598          *
 599          * @since 1.20
 600          *
 601          * @param string|null $subPage
 602          */
 603         protected function afterExecute( $subPage ) {
 604                 // No-op
 605         }
 606
 607         /**
 608          * Default execute method
 609          * Checks user permissions
 610          *
 611          * This must be overridden by subclasses; it will be made abstract in a future version
 612          *
 613          * @param string|null $subPage
 614          */
 615         public function execute( $subPage ) {
 616                 $this->setHeaders();
 617                 $this->checkPermissions();
 618                 $securityLevel = $this->getLoginSecurityLevel();
 619                 if ( $securityLevel !== false && !$this->checkLoginSecurityLevel( $securityLevel ) ) {
 620                         return;
 621                 }
 622                 $this->outputHeader();
 623         }
 624
 625         /**
 626          * Outputs a summary message on top of special pages
 627          * Per default the message key is the canonical name of the special page
 628          * May be overridden, i.e. by extensions to stick with the naming conventions
 629          * for message keys: 'extensionname-xxx'
 630          *
 631          * @param string $summaryMessageKey Message key of the summary
 632          */
 633         function outputHeader( $summaryMessageKey = '' ) {
 634                 if ( $summaryMessageKey == '' ) {
 635                         $msg = MediaWikiServices::getInstance()->getContentLanguage()->lc( $this->getName() ) .
 636                                 '-summary';
 637                 } else {
 638                         $msg = $summaryMessageKey;
 639                 }
 640                 if ( !$this->msg( $msg )->isDisabled() && !$this->including() ) {
 641                         $this->getOutput()->wrapWikiMsg(
 642                                 "<div class='mw-specialpage-summary'>\n$1\n</div>", $msg );
 643                 }
 644         }
 645
 646         /**
 647          * Returns the name that goes in the \<h1\> in the special page itself, and
 648          * also the name that will be listed in Special:Specialpages
 649          *
 650          * Derived classes can override this, but usually it is easier to keep the
 651          * default behavior.
 652          *
 653          * @return string
 654          */
 655         function getDescription() {
 656                 return $this->msg( strtolower( $this->mName ) )->text();
 657         }
 658
 659         /**
 660          * Get a self-referential title object
 661          *
 662          * @param string|bool $subpage
 663          * @return Title
 664          * @deprecated since 1.23, use SpecialPage::getPageTitle
 665          */
 666         function getTitle( $subpage = false ) {
 667                 wfDeprecated( __METHOD__, '1.23' );
 668                 return $this->getPageTitle( $subpage );
 669         }
 670
 671         /**
 672          * Get a self-referential title object
 673          *
 674          * @param string|bool $subpage
 675          * @return Title
 676          * @since 1.23
 677          */
 678         function getPageTitle( $subpage = false ) {
 679                 return self::getTitleFor( $this->mName, $subpage );
 680         }
 681
 682         /**
 683          * Sets the context this SpecialPage is executed in
 684          *
 685          * @param IContextSource $context
 686          * @since 1.18
 687          */
 688         public function setContext( $context ) {
 689                 $this->mContext = $context;
 690         }
 691
 692         /**
 693          * Gets the context this SpecialPage is executed in
 694          *
 695          * @return IContextSource|RequestContext
 696          * @since 1.18
 697          */
 698         public function getContext() {
 699                 if ( $this->mContext instanceof IContextSource ) {
 700                         return $this->mContext;
 701                 } else {
 702                         wfDebug( __METHOD__ . " called and \$mContext is null. " .
 703                                 "Return RequestContext::getMain(); for sanity\n" );
 704
 705                         return RequestContext::getMain();
 706                 }
 707         }
 708
 709         /**
 710          * Get the WebRequest being used for this instance
 711          *
 712          * @return WebRequest
 713          * @since 1.18
 714          */
 715         public function getRequest() {
 716                 return $this->getContext()->getRequest();
 717         }
 718
 719         /**
 720          * Get the OutputPage being used for this instance
 721          *
 722          * @return OutputPage
 723          * @since 1.18
 724          */
 725         public function getOutput() {
 726                 return $this->getContext()->getOutput();
 727         }
 728
 729         /**
 730          * Shortcut to get the User executing this instance
 731          *
 732          * @return User
 733          * @since 1.18
 734          */
 735         public function getUser() {
 736                 return $this->getContext()->getUser();
 737         }
 738
 739         /**
 740          * Shortcut to get the skin being used for this instance
 741          *
 742          * @return Skin
 743          * @since 1.18
 744          */
 745         public function getSkin() {
 746                 return $this->getContext()->getSkin();
 747         }
 748
 749         /**
 750          * Shortcut to get user's language
 751          *
 752          * @return Language
 753          * @since 1.19
 754          */
 755         public function getLanguage() {
 756                 return $this->getContext()->getLanguage();
 757         }
 758
 759         /**
 760          * Shortcut to get main config object
 761          * @return Config
 762          * @since 1.24
 763          */
 764         public function getConfig() {
 765                 return $this->getContext()->getConfig();
 766         }
 767
 768         /**
 769          * Return the full title, including $par
 770          *
 771          * @return Title
 772          * @since 1.18
 773          */
 774         public function getFullTitle() {
 775                 return $this->getContext()->getTitle();
 776         }
 777
 778         /**
 779          * Return the robot policy. Derived classes that override this can change
 780          * the robot policy set by setHeaders() from the default 'noindex,nofollow'.
 781          *
 782          * @return string
 783          * @since 1.23
 784          */
 785         protected function getRobotPolicy() {
 786                 return 'noindex,nofollow';
 787         }
 788
 789         /**
 790          * Wrapper around wfMessage that sets the current context.
 791          *
 792          * @since 1.16
 793          * @return Message
 794          * @see wfMessage
 795          */
 796         public function msg( $key /* $args */ ) {
 797                 $message = $this->getContext()->msg( ...func_get_args() );
 798                 // RequestContext passes context to wfMessage, and the language is set from
 799                 // the context, but setting the language for Message class removes the
 800                 // interface message status, which breaks for example usernameless gender
 801                 // invocations. Restore the flag when not including special page in content.
 802                 if ( $this->including() ) {
 803                         $message->setInterfaceMessageFlag( false );
 804                 }
 805
 806                 return $message;
 807         }
 808
 809         /**
 810          * Adds RSS/atom links
 811          *
 812          * @param array $params
 813          */
 814         protected function addFeedLinks( $params ) {
 815                 $feedTemplate = wfScript( 'api' );
 816
 817                 foreach ( $this->getConfig()->get( 'FeedClasses' ) as $format => $class ) {
 818                         $theseParams = $params + [ 'feedformat' => $format ];
 819                         $url = wfAppendQuery( $feedTemplate, $theseParams );
 820                         $this->getOutput()->addFeedLink( $format, $url );
 821                 }
 822         }
 823
 824         /**
 825          * Adds help link with an icon via page indicators.
 826          * Link target can be overridden by a local message containing a wikilink:
 827          * the message key is: lowercase special page name + '-helppage'.
 828          * @param string $to Target MediaWiki.org page title or encoded URL.
 829          * @param bool $overrideBaseUrl Whether $url is a full URL, to avoid MW.o.
 830          * @since 1.25
 831          */
 832         public function addHelpLink( $to, $overrideBaseUrl = false ) {
 833                 if ( $this->including() ) {
 834                         return;
 835                 }
 836
 837                 $msg = $this->msg(
 838                         MediaWikiServices::getInstance()->getContentLanguage()->lc( $this->getName() ) .
 839                         '-helppage' );
 840
 841                 if ( !$msg->isDisabled() ) {
 842                         $helpUrl = Skin::makeUrl( $msg->plain() );
 843                         $this->getOutput()->addHelpLink( $helpUrl, true );
 844                 } else {
 845                         $this->getOutput()->addHelpLink( $to, $overrideBaseUrl );
 846                 }
 847         }
 848
 849         /**
 850          * Get the group that the special page belongs in on Special:SpecialPage
 851          * Use this method, instead of getGroupName to allow customization
 852          * of the group name from the wiki side
 853          *
 854          * @return string Group of this special page
 855          * @since 1.21
 856          */
 857         public function getFinalGroupName() {
 858                 $name = $this->getName();
 859
 860                 // Allow overriding the group from the wiki side
 861                 $msg = $this->msg( 'specialpages-specialpagegroup-' . strtolower( $name ) )->inContentLanguage();
 862                 if ( !$msg->isBlank() ) {
 863                         $group = $msg->text();
 864                 } else {
 865                         // Than use the group from this object
 866                         $group = $this->getGroupName();
 867                 }
 868
 869                 return $group;
 870         }
 871
 872         /**
 873          * Indicates whether this special page may perform database writes
 874          *
 875          * @return bool
 876          * @since 1.27
 877          */
 878         public function doesWrites() {
 879                 return false;
 880         }
 881
 882         /**
 883          * Under which header this special page is listed in Special:SpecialPages
 884          * See messages 'specialpages-group-*' for valid names
 885          * This method defaults to group 'other'
 886          *
 887          * @return string
 888          * @since 1.21
 889          */
 890         protected function getGroupName() {
 891                 return 'other';
 892         }
 893
 894         /**
 895          * Call wfTransactionalTimeLimit() if this request was POSTed
 896          * @since 1.26
 897          */
 898         protected function useTransactionalTimeLimit() {
 899                 if ( $this->getRequest()->wasPosted() ) {
 900                         wfTransactionalTimeLimit();
 901                 }
 902         }
 903
 904         /**
 905          * @since 1.28
 906          * @return \MediaWiki\Linker\LinkRenderer
 907          */
 908         public function getLinkRenderer() {
 909                 if ( $this->linkRenderer ) {
 910                         return $this->linkRenderer;
 911                 } else {
 912                         return MediaWikiServices::getInstance()->getLinkRenderer();
 913                 }
 914         }
 915
 916         /**
 917          * @since 1.28
 918          * @param \MediaWiki\Linker\LinkRenderer $linkRenderer
 919          */
 920         public function setLinkRenderer( LinkRenderer $linkRenderer ) {
 921                 $this->linkRenderer = $linkRenderer;
 922         }
 923 }