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