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 /**
  25  * Parent class for all special pages.
  26  *
  27  * Includes some static functions for handling the special page list deprecated
  28  * in favor of SpecialPageFactory.
  29  *
  30  * @ingroup SpecialPage
  31  */
  32 class SpecialPage {
  33         // The canonical name of this special page
  34         // Also used for the default <h1> heading, @see getDescription()
  35         protected $mName;
  36
  37         // The local name of this special page
  38         private $mLocalName;
  39
  40         // Minimum user level required to access this page, or "" for anyone.
  41         // Also used to categorise the pages in Special:Specialpages
  42         private $mRestriction;
  43
  44         // Listed in Special:Specialpages?
  45         private $mListed;
  46
  47         // Whether or not this special page is being included from an article
  48         protected $mIncluding;
  49
  50         // Whether the special page can be included in an article
  51         protected $mIncludable;
  52
  53         /**
  54          * Current request context
  55          * @var IContextSource
  56          */
  57         protected $mContext;
  58
  59         /**
  60          * Get a localised Title object for a specified special page name
  61          *
  62          * @param string $name
  63          * @param string|bool $subpage Subpage string, or false to not use a subpage
  64          * @param string $fragment The link fragment (after the "#")
  65          * @return Title
  66          * @throws MWException
  67          */
  68         public static function getTitleFor( $name, $subpage = false, $fragment = '' ) {
  69                 $name = SpecialPageFactory::getLocalNameFor( $name, $subpage );
  70
  71                 return Title::makeTitle( NS_SPECIAL, $name, $fragment );
  72         }
  73
  74         /**
  75          * Get a localised Title object for a page name with a possibly unvalidated subpage
  76          *
  77          * @param string $name
  78          * @param string|bool $subpage Subpage string, or false to not use a subpage
  79          * @return Title|null Title object or null if the page doesn't exist
  80          */
  81         public static function getSafeTitleFor( $name, $subpage = false ) {
  82                 $name = SpecialPageFactory::getLocalNameFor( $name, $subpage );
  83                 if ( $name ) {
  84                         return Title::makeTitleSafe( NS_SPECIAL, $name );
  85                 } else {
  86                         return null;
  87                 }
  88         }
  89
  90         /**
  91          * Default constructor for special pages
  92          * Derivative classes should call this from their constructor
  93          *     Note that if the user does not have the required level, an error message will
  94          *     be displayed by the default execute() method, without the global function ever
  95          *     being called.
  96          *
  97          *     If you override execute(), you can recover the default behavior with userCanExecute()
  98          *     and displayRestrictionError()
  99          *
 100          * @param string $name Name of the special page, as seen in links and URLs
 101          * @param string $restriction User right required, e.g. "block" or "delete"
 102          * @param bool $listed Whether the page is listed in Special:Specialpages
 103          * @param callable|bool $function Unused
 104          * @param string $file Unused
 105          * @param bool $includable Whether the page can be included in normal pages
 106          */
 107         public function __construct(
 108                 $name = '', $restriction = '', $listed = true,
 109                 $function = false, $file = '', $includable = false
 110         ) {
 111                 $this->mName = $name;
 112                 $this->mRestriction = $restriction;
 113                 $this->mListed = $listed;
 114                 $this->mIncludable = $includable;
 115         }
 116
 117         /**
 118          * Get the name of this Special Page.
 119          * @return string
 120          */
 121         function getName() {
 122                 return $this->mName;
 123         }
 124
 125         /**
 126          * Get the permission that a user must have to execute this page
 127          * @return string
 128          */
 129         function getRestriction() {
 130                 return $this->mRestriction;
 131         }
 132
 133         // @todo FIXME: Decide which syntax to use for this, and stick to it
 134         /**
 135          * Whether this special page is listed in Special:SpecialPages
 136          * @since 1.3 (r3583)
 137          * @return bool
 138          */
 139         function isListed() {
 140                 return $this->mListed;
 141         }
 142
 143         /**
 144          * Set whether this page is listed in Special:Specialpages, at run-time
 145          * @since 1.3
 146          * @param bool $listed
 147          * @return bool
 148          */
 149         function setListed( $listed ) {
 150                 return wfSetVar( $this->mListed, $listed );
 151         }
 152
 153         /**
 154          * Get or set whether this special page is listed in Special:SpecialPages
 155          * @since 1.6
 156          * @param bool $x
 157          * @return bool
 158          */
 159         function listed( $x = null ) {
 160                 return wfSetVar( $this->mListed, $x );
 161         }
 162
 163         /**
 164          * Whether it's allowed to transclude the special page via {{Special:Foo/params}}
 165          * @return bool
 166          */
 167         public function isIncludable() {
 168                 return $this->mIncludable;
 169         }
 170
 171         /**
 172          * Whether the special page is being evaluated via transclusion
 173          * @param bool $x
 174          * @return bool
 175          */
 176         function including( $x = null ) {
 177                 return wfSetVar( $this->mIncluding, $x );
 178         }
 179
 180         /**
 181          * Get the localised name of the special page
 182          * @return string
 183          */
 184         function getLocalName() {
 185                 if ( !isset( $this->mLocalName ) ) {
 186                         $this->mLocalName = SpecialPageFactory::getLocalNameFor( $this->mName );
 187                 }
 188
 189                 return $this->mLocalName;
 190         }
 191
 192         /**
 193          * Is this page expensive (for some definition of expensive)?
 194          * Expensive pages are disabled or cached in miser mode.  Originally used
 195          * (and still overridden) by QueryPage and subclasses, moved here so that
 196          * Special:SpecialPages can safely call it for all special pages.
 197          *
 198          * @return bool
 199          */
 200         public function isExpensive() {
 201                 return false;
 202         }
 203
 204         /**
 205          * Is this page cached?
 206          * Expensive pages are cached or disabled in miser mode.
 207          * Used by QueryPage and subclasses, moved here so that
 208          * Special:SpecialPages can safely call it for all special pages.
 209          *
 210          * @return bool
 211          * @since 1.21
 212          */
 213         public function isCached() {
 214                 return false;
 215         }
 216
 217         /**
 218          * Can be overridden by subclasses with more complicated permissions
 219          * schemes.
 220          *
 221          * @return bool Should the page be displayed with the restricted-access
 222          *   pages?
 223          */
 224         public function isRestricted() {
 225                 // DWIM: If anons can do something, then it is not restricted
 226                 return $this->mRestriction != '' && !User::groupHasPermission( '*', $this->mRestriction );
 227         }
 228
 229         /**
 230          * Checks if the given user (identified by an object) can execute this
 231          * special page (as defined by $mRestriction).  Can be overridden by sub-
 232          * classes with more complicated permissions schemes.
 233          *
 234          * @param User $user The user to check
 235          * @return bool Does the user have permission to view the page?
 236          */
 237         public function userCanExecute( User $user ) {
 238                 return $user->isAllowed( $this->mRestriction );
 239         }
 240
 241         /**
 242          * Output an error message telling the user what access level they have to have
 243          * @throws PermissionsError
 244          */
 245         function displayRestrictionError() {
 246                 throw new PermissionsError( $this->mRestriction );
 247         }
 248
 249         /**
 250          * Checks if userCanExecute, and if not throws a PermissionsError
 251          *
 252          * @since 1.19
 253          * @return void
 254          * @throws PermissionsError
 255          */
 256         public function checkPermissions() {
 257                 if ( !$this->userCanExecute( $this->getUser() ) ) {
 258                         $this->displayRestrictionError();
 259                 }
 260         }
 261
 262         /**
 263          * If the wiki is currently in readonly mode, throws a ReadOnlyError
 264          *
 265          * @since 1.19
 266          * @return void
 267          * @throws ReadOnlyError
 268          */
 269         public function checkReadOnly() {
 270                 if ( wfReadOnly() ) {
 271                         throw new ReadOnlyError;
 272                 }
 273         }
 274
 275         /**
 276          * If the user is not logged in, throws UserNotLoggedIn error
 277          *
 278          * The user will be redirected to Special:Userlogin with the given message as an error on
 279          * the form.
 280          *
 281          * @since 1.23
 282          * @param string $reasonMsg [optional] Message key to be displayed on login page
 283          * @param string $titleMsg [optional] Passed on to UserNotLoggedIn constructor
 284          * @throws UserNotLoggedIn
 285          */
 286         public function requireLogin(
 287                 $reasonMsg = 'exception-nologin-text', $titleMsg = 'exception-nologin'
 288         ) {
 289                 if ( $this->getUser()->isAnon() ) {
 290                         throw new UserNotLoggedIn( $reasonMsg, $titleMsg );
 291                 }
 292         }
 293
 294         /**
 295          * Return an array of subpages beginning with $search that this special page will accept.
 296          *
 297          * For example, if a page supports subpages "foo", "bar" and "baz" (as in Special:PageName/foo,
 298          * etc.):
 299          *
 300          *   - `prefixSearchSubpages( "ba" )` should return `array( "bar", "baz" )`
 301          *   - `prefixSearchSubpages( "f" )` should return `array( "foo" )`
 302          *   - `prefixSearchSubpages( "z" )` should return `array()`
 303          *   - `prefixSearchSubpages( "" )` should return `array( foo", "bar", "baz" )`
 304          *
 305          * @param string $search Prefix to search for
 306          * @param int $limit Maximum number of results to return
 307          * @return string[] Matching subpages
 308          */
 309         public function prefixSearchSubpages( $search, $limit = 10 ) {
 310                 return array();
 311         }
 312
 313         /**
 314          * Helper function for implementations of prefixSearchSubpages() that
 315          * filter the values in memory (as oppposed to making a query).
 316          *
 317          * @since 1.24
 318          * @param string $search
 319          * @param int $limit
 320          * @param array $subpages
 321          * @return string[]
 322          */
 323         protected static function prefixSearchArray( $search, $limit, array $subpages ) {
 324                 $escaped = preg_quote( $search, '/' );
 325                 return array_slice( preg_grep( "/^$escaped/i", $subpages ), 0, $limit );
 326         }
 327
 328         /**
 329          * Sets headers - this should be called from the execute() method of all derived classes!
 330          */
 331         function setHeaders() {
 332                 $out = $this->getOutput();
 333                 $out->setArticleRelated( false );
 334                 $out->setRobotPolicy( $this->getRobotPolicy() );
 335                 $out->setPageTitle( $this->getDescription() );
 336         }
 337
 338         /**
 339          * Entry point.
 340          *
 341          * @since 1.20
 342          *
 343          * @param string|null $subPage
 344          */
 345         final public function run( $subPage ) {
 346                 /**
 347                  * Gets called before @see SpecialPage::execute.
 348                  *
 349                  * @since 1.20
 350                  *
 351                  * @param SpecialPage $this
 352                  * @param string|null $subPage
 353                  */
 354                 wfRunHooks( 'SpecialPageBeforeExecute', array( $this, $subPage ) );
 355
 356                 $this->beforeExecute( $subPage );
 357                 $this->execute( $subPage );
 358                 $this->afterExecute( $subPage );
 359
 360                 /**
 361                  * Gets called after @see SpecialPage::execute.
 362                  *
 363                  * @since 1.20
 364                  *
 365                  * @param SpecialPage $this
 366                  * @param string|null $subPage
 367                  */
 368                 wfRunHooks( 'SpecialPageAfterExecute', array( $this, $subPage ) );
 369         }
 370
 371         /**
 372          * Gets called before @see SpecialPage::execute.
 373          *
 374          * @since 1.20
 375          *
 376          * @param string|null $subPage
 377          */
 378         protected function beforeExecute( $subPage ) {
 379                 // No-op
 380         }
 381
 382         /**
 383          * Gets called after @see SpecialPage::execute.
 384          *
 385          * @since 1.20
 386          *
 387          * @param string|null $subPage
 388          */
 389         protected function afterExecute( $subPage ) {
 390                 // No-op
 391         }
 392
 393         /**
 394          * Default execute method
 395          * Checks user permissions
 396          *
 397          * This must be overridden by subclasses; it will be made abstract in a future version
 398          *
 399          * @param string|null $subPage
 400          */
 401         public function execute( $subPage ) {
 402                 $this->setHeaders();
 403                 $this->checkPermissions();
 404                 $this->outputHeader();
 405         }
 406
 407         /**
 408          * Outputs a summary message on top of special pages
 409          * Per default the message key is the canonical name of the special page
 410          * May be overridden, i.e. by extensions to stick with the naming conventions
 411          * for message keys: 'extensionname-xxx'
 412          *
 413          * @param string $summaryMessageKey Message key of the summary
 414          */
 415         function outputHeader( $summaryMessageKey = '' ) {
 416                 global $wgContLang;
 417
 418                 if ( $summaryMessageKey == '' ) {
 419                         $msg = $wgContLang->lc( $this->getName() ) . '-summary';
 420                 } else {
 421                         $msg = $summaryMessageKey;
 422                 }
 423                 if ( !$this->msg( $msg )->isDisabled() && !$this->including() ) {
 424                         $this->getOutput()->wrapWikiMsg(
 425                                 "<div class='mw-specialpage-summary'>\n$1\n</div>", $msg );
 426                 }
 427         }
 428
 429         /**
 430          * Returns the name that goes in the \<h1\> in the special page itself, and
 431          * also the name that will be listed in Special:Specialpages
 432          *
 433          * Derived classes can override this, but usually it is easier to keep the
 434          * default behavior.
 435          *
 436          * @return string
 437          */
 438         function getDescription() {
 439                 return $this->msg( strtolower( $this->mName ) )->text();
 440         }
 441
 442         /**
 443          * Get a self-referential title object
 444          *
 445          * @param string|bool $subpage
 446          * @return Title
 447          * @deprecated since 1.23, use SpecialPage::getPageTitle
 448          */
 449         function getTitle( $subpage = false ) {
 450                 return $this->getPageTitle( $subpage );
 451         }
 452
 453         /**
 454          * Get a self-referential title object
 455          *
 456          * @param string|bool $subpage
 457          * @return Title
 458          * @since 1.23
 459          */
 460         function getPageTitle( $subpage = false ) {
 461                 return self::getTitleFor( $this->mName, $subpage );
 462         }
 463
 464         /**
 465          * Sets the context this SpecialPage is executed in
 466          *
 467          * @param IContextSource $context
 468          * @since 1.18
 469          */
 470         public function setContext( $context ) {
 471                 $this->mContext = $context;
 472         }
 473
 474         /**
 475          * Gets the context this SpecialPage is executed in
 476          *
 477          * @return IContextSource|RequestContext
 478          * @since 1.18
 479          */
 480         public function getContext() {
 481                 if ( $this->mContext instanceof IContextSource ) {
 482                         return $this->mContext;
 483                 } else {
 484                         wfDebug( __METHOD__ . " called and \$mContext is null. " .
 485                                 "Return RequestContext::getMain(); for sanity\n" );
 486
 487                         return RequestContext::getMain();
 488                 }
 489         }
 490
 491         /**
 492          * Get the WebRequest being used for this instance
 493          *
 494          * @return WebRequest
 495          * @since 1.18
 496          */
 497         public function getRequest() {
 498                 return $this->getContext()->getRequest();
 499         }
 500
 501         /**
 502          * Get the OutputPage being used for this instance
 503          *
 504          * @return OutputPage
 505          * @since 1.18
 506          */
 507         public function getOutput() {
 508                 return $this->getContext()->getOutput();
 509         }
 510
 511         /**
 512          * Shortcut to get the User executing this instance
 513          *
 514          * @return User
 515          * @since 1.18
 516          */
 517         public function getUser() {
 518                 return $this->getContext()->getUser();
 519         }
 520
 521         /**
 522          * Shortcut to get the skin being used for this instance
 523          *
 524          * @return Skin
 525          * @since 1.18
 526          */
 527         public function getSkin() {
 528                 return $this->getContext()->getSkin();
 529         }
 530
 531         /**
 532          * Shortcut to get user's language
 533          *
 534          * @return Language
 535          * @since 1.19
 536          */
 537         public function getLanguage() {
 538                 return $this->getContext()->getLanguage();
 539         }
 540
 541         /**
 542          * Shortcut to get main config object
 543          * @return Config
 544          * @since 1.24
 545          */
 546         public function getConfig() {
 547                 return $this->getContext()->getConfig();
 548         }
 549
 550         /**
 551          * Return the full title, including $par
 552          *
 553          * @return Title
 554          * @since 1.18
 555          */
 556         public function getFullTitle() {
 557                 return $this->getContext()->getTitle();
 558         }
 559
 560         /**
 561          * Return the robot policy. Derived classes that override this can change
 562          * the robot policy set by setHeaders() from the default 'noindex,nofollow'.
 563          *
 564          * @return string
 565          * @since 1.23
 566          */
 567         protected function getRobotPolicy() {
 568                 return 'noindex,nofollow';
 569         }
 570
 571         /**
 572          * Wrapper around wfMessage that sets the current context.
 573          *
 574          * @return Message
 575          * @see wfMessage
 576          */
 577         public function msg( /* $args */ ) {
 578                 $message = call_user_func_array(
 579                         array( $this->getContext(), 'msg' ),
 580                         func_get_args()
 581                 );
 582                 // RequestContext passes context to wfMessage, and the language is set from
 583                 // the context, but setting the language for Message class removes the
 584                 // interface message status, which breaks for example usernameless gender
 585                 // invocations. Restore the flag when not including special page in content.
 586                 if ( $this->including() ) {
 587                         $message->setInterfaceMessageFlag( false );
 588                 }
 589
 590                 return $message;
 591         }
 592
 593         /**
 594          * Adds RSS/atom links
 595          *
 596          * @param array $params
 597          */
 598         protected function addFeedLinks( $params ) {
 599                 $feedTemplate = wfScript( 'api' );
 600
 601                 foreach ( $this->getConfig()->get( 'FeedClasses' ) as $format => $class ) {
 602                         $theseParams = $params + array( 'feedformat' => $format );
 603                         $url = wfAppendQuery( $feedTemplate, $theseParams );
 604                         $this->getOutput()->addFeedLink( $format, $url );
 605                 }
 606         }
 607
 608         /**
 609          * Get the group that the special page belongs in on Special:SpecialPage
 610          * Use this method, instead of getGroupName to allow customization
 611          * of the group name from the wiki side
 612          *
 613          * @return string Group of this special page
 614          * @since 1.21
 615          */
 616         public function getFinalGroupName() {
 617                 $name = $this->getName();
 618                 $specialPageGroups = $this->getConfig()->get( 'SpecialPageGroups' );
 619
 620                 // Allow overbidding the group from the wiki side
 621                 $msg = $this->msg( 'specialpages-specialpagegroup-' . strtolower( $name ) )->inContentLanguage();
 622                 if ( !$msg->isBlank() ) {
 623                         $group = $msg->text();
 624                 } else {
 625                         // Than use the group from this object
 626                         $group = $this->getGroupName();
 627
 628                         // Group '-' is used as default to have the chance to determine,
 629                         // if the special pages overrides this method,
 630                         // if not overridden, $wgSpecialPageGroups is checked for b/c
 631                         if ( $group === '-' && isset( $specialPageGroups[$name] ) ) {
 632                                 $group = $specialPageGroups[$name];
 633                         }
 634                 }
 635
 636                 // never give '-' back, change to 'other'
 637                 if ( $group === '-' ) {
 638                         $group = 'other';
 639                 }
 640
 641                 return $group;
 642         }
 643
 644         /**
 645          * Under which header this special page is listed in Special:SpecialPages
 646          * See messages 'specialpages-group-*' for valid names
 647          * This method defaults to group 'other'
 648          *
 649          * @return string
 650          * @since 1.21
 651          */
 652         protected function getGroupName() {
 653                 // '-' used here to determine, if this group is overridden or has a hardcoded 'other'
 654                 // Needed for b/c in getFinalGroupName
 655                 return '-';
 656         }
 657 }