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         protected $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 (usually 10)
 307          * @param int $offset Number of results to skip (usually 0)
 308          * @return string[] Matching subpages
 309          */
 310         public function prefixSearchSubpages( $search, $limit, $offset ) {
 311                 $subpages = $this->getSubpagesForPrefixSearch();
 312                 if ( !$subpages ) {
 313                         return array();
 314                 }
 315
 316                 return self::prefixSearchArray( $search, $limit, $subpages, $offset );
 317         }
 318
 319         /**
 320          * Return an array of subpages that this special page will accept for prefix
 321          * searches. If this method requires a query you might instead want to implement
 322          * prefixSearchSubpages() directly so you can support $limit and $offset. This
 323          * method is better for static-ish lists of things.
 324          *
 325          * @return string[] subpages to search from
 326          */
 327         protected function getSubpagesForPrefixSearch() {
 328                 return array();
 329         }
 330
 331         /**
 332          * Helper function for implementations of prefixSearchSubpages() that
 333          * filter the values in memory (as opposed to making a query).
 334          *
 335          * @since 1.24
 336          * @param string $search
 337          * @param int $limit
 338          * @param array $subpages
 339          * @param int $offset
 340          * @return string[]
 341          */
 342         protected static function prefixSearchArray( $search, $limit, array $subpages, $offset ) {
 343                 $escaped = preg_quote( $search, '/' );
 344                 return array_slice( preg_grep( "/^$escaped/i",
 345                         array_slice( $subpages, $offset ) ), 0, $limit );
 346         }
 347
 348         /**
 349          * Sets headers - this should be called from the execute() method of all derived classes!
 350          */
 351         function setHeaders() {
 352                 $out = $this->getOutput();
 353                 $out->setArticleRelated( false );
 354                 $out->setRobotPolicy( $this->getRobotPolicy() );
 355                 $out->setPageTitle( $this->getDescription() );
 356                 if ( $this->getConfig()->get( 'UseMediaWikiUIEverywhere' ) ) {
 357                         $out->addModuleStyles( array(
 358                                 'mediawiki.ui.input',
 359                                 'mediawiki.ui.checkbox',
 360                         ) );
 361                 }
 362         }
 363
 364         /**
 365          * Entry point.
 366          *
 367          * @since 1.20
 368          *
 369          * @param string|null $subPage
 370          */
 371         final public function run( $subPage ) {
 372                 /**
 373                  * Gets called before @see SpecialPage::execute.
 374                  *
 375                  * @since 1.20
 376                  *
 377                  * @param SpecialPage $this
 378                  * @param string|null $subPage
 379                  */
 380                 Hooks::run( 'SpecialPageBeforeExecute', array( $this, $subPage ) );
 381
 382                 $this->beforeExecute( $subPage );
 383                 $this->execute( $subPage );
 384                 $this->afterExecute( $subPage );
 385
 386                 /**
 387                  * Gets called after @see SpecialPage::execute.
 388                  *
 389                  * @since 1.20
 390                  *
 391                  * @param SpecialPage $this
 392                  * @param string|null $subPage
 393                  */
 394                 Hooks::run( 'SpecialPageAfterExecute', array( $this, $subPage ) );
 395         }
 396
 397         /**
 398          * Gets called before @see SpecialPage::execute.
 399          *
 400          * @since 1.20
 401          *
 402          * @param string|null $subPage
 403          */
 404         protected function beforeExecute( $subPage ) {
 405                 // No-op
 406         }
 407
 408         /**
 409          * Gets called after @see SpecialPage::execute.
 410          *
 411          * @since 1.20
 412          *
 413          * @param string|null $subPage
 414          */
 415         protected function afterExecute( $subPage ) {
 416                 // No-op
 417         }
 418
 419         /**
 420          * Default execute method
 421          * Checks user permissions
 422          *
 423          * This must be overridden by subclasses; it will be made abstract in a future version
 424          *
 425          * @param string|null $subPage
 426          */
 427         public function execute( $subPage ) {
 428                 $this->setHeaders();
 429                 $this->checkPermissions();
 430                 $this->outputHeader();
 431         }
 432
 433         /**
 434          * Outputs a summary message on top of special pages
 435          * Per default the message key is the canonical name of the special page
 436          * May be overridden, i.e. by extensions to stick with the naming conventions
 437          * for message keys: 'extensionname-xxx'
 438          *
 439          * @param string $summaryMessageKey Message key of the summary
 440          */
 441         function outputHeader( $summaryMessageKey = '' ) {
 442                 global $wgContLang;
 443
 444                 if ( $summaryMessageKey == '' ) {
 445                         $msg = $wgContLang->lc( $this->getName() ) . '-summary';
 446                 } else {
 447                         $msg = $summaryMessageKey;
 448                 }
 449                 if ( !$this->msg( $msg )->isDisabled() && !$this->including() ) {
 450                         $this->getOutput()->wrapWikiMsg(
 451                                 "<div class='mw-specialpage-summary'>\n$1\n</div>", $msg );
 452                 }
 453         }
 454
 455         /**
 456          * Returns the name that goes in the \<h1\> in the special page itself, and
 457          * also the name that will be listed in Special:Specialpages
 458          *
 459          * Derived classes can override this, but usually it is easier to keep the
 460          * default behavior.
 461          *
 462          * @return string
 463          */
 464         function getDescription() {
 465                 return $this->msg( strtolower( $this->mName ) )->text();
 466         }
 467
 468         /**
 469          * Get a self-referential title object
 470          *
 471          * @param string|bool $subpage
 472          * @return Title
 473          * @deprecated since 1.23, use SpecialPage::getPageTitle
 474          */
 475         function getTitle( $subpage = false ) {
 476                 return $this->getPageTitle( $subpage );
 477         }
 478
 479         /**
 480          * Get a self-referential title object
 481          *
 482          * @param string|bool $subpage
 483          * @return Title
 484          * @since 1.23
 485          */
 486         function getPageTitle( $subpage = false ) {
 487                 return self::getTitleFor( $this->mName, $subpage );
 488         }
 489
 490         /**
 491          * Sets the context this SpecialPage is executed in
 492          *
 493          * @param IContextSource $context
 494          * @since 1.18
 495          */
 496         public function setContext( $context ) {
 497                 $this->mContext = $context;
 498         }
 499
 500         /**
 501          * Gets the context this SpecialPage is executed in
 502          *
 503          * @return IContextSource|RequestContext
 504          * @since 1.18
 505          */
 506         public function getContext() {
 507                 if ( $this->mContext instanceof IContextSource ) {
 508                         return $this->mContext;
 509                 } else {
 510                         wfDebug( __METHOD__ . " called and \$mContext is null. " .
 511                                 "Return RequestContext::getMain(); for sanity\n" );
 512
 513                         return RequestContext::getMain();
 514                 }
 515         }
 516
 517         /**
 518          * Get the WebRequest being used for this instance
 519          *
 520          * @return WebRequest
 521          * @since 1.18
 522          */
 523         public function getRequest() {
 524                 return $this->getContext()->getRequest();
 525         }
 526
 527         /**
 528          * Get the OutputPage being used for this instance
 529          *
 530          * @return OutputPage
 531          * @since 1.18
 532          */
 533         public function getOutput() {
 534                 return $this->getContext()->getOutput();
 535         }
 536
 537         /**
 538          * Shortcut to get the User executing this instance
 539          *
 540          * @return User
 541          * @since 1.18
 542          */
 543         public function getUser() {
 544                 return $this->getContext()->getUser();
 545         }
 546
 547         /**
 548          * Shortcut to get the skin being used for this instance
 549          *
 550          * @return Skin
 551          * @since 1.18
 552          */
 553         public function getSkin() {
 554                 return $this->getContext()->getSkin();
 555         }
 556
 557         /**
 558          * Shortcut to get user's language
 559          *
 560          * @return Language
 561          * @since 1.19
 562          */
 563         public function getLanguage() {
 564                 return $this->getContext()->getLanguage();
 565         }
 566
 567         /**
 568          * Shortcut to get main config object
 569          * @return Config
 570          * @since 1.24
 571          */
 572         public function getConfig() {
 573                 return $this->getContext()->getConfig();
 574         }
 575
 576         /**
 577          * Return the full title, including $par
 578          *
 579          * @return Title
 580          * @since 1.18
 581          */
 582         public function getFullTitle() {
 583                 return $this->getContext()->getTitle();
 584         }
 585
 586         /**
 587          * Return the robot policy. Derived classes that override this can change
 588          * the robot policy set by setHeaders() from the default 'noindex,nofollow'.
 589          *
 590          * @return string
 591          * @since 1.23
 592          */
 593         protected function getRobotPolicy() {
 594                 return 'noindex,nofollow';
 595         }
 596
 597         /**
 598          * Wrapper around wfMessage that sets the current context.
 599          *
 600          * @return Message
 601          * @see wfMessage
 602          */
 603         public function msg( /* $args */ ) {
 604                 $message = call_user_func_array(
 605                         array( $this->getContext(), 'msg' ),
 606                         func_get_args()
 607                 );
 608                 // RequestContext passes context to wfMessage, and the language is set from
 609                 // the context, but setting the language for Message class removes the
 610                 // interface message status, which breaks for example usernameless gender
 611                 // invocations. Restore the flag when not including special page in content.
 612                 if ( $this->including() ) {
 613                         $message->setInterfaceMessageFlag( false );
 614                 }
 615
 616                 return $message;
 617         }
 618
 619         /**
 620          * Adds RSS/atom links
 621          *
 622          * @param array $params
 623          */
 624         protected function addFeedLinks( $params ) {
 625                 $feedTemplate = wfScript( 'api' );
 626
 627                 foreach ( $this->getConfig()->get( 'FeedClasses' ) as $format => $class ) {
 628                         $theseParams = $params + array( 'feedformat' => $format );
 629                         $url = wfAppendQuery( $feedTemplate, $theseParams );
 630                         $this->getOutput()->addFeedLink( $format, $url );
 631                 }
 632         }
 633
 634         /**
 635          * Get the group that the special page belongs in on Special:SpecialPage
 636          * Use this method, instead of getGroupName to allow customization
 637          * of the group name from the wiki side
 638          *
 639          * @return string Group of this special page
 640          * @since 1.21
 641          */
 642         public function getFinalGroupName() {
 643                 $name = $this->getName();
 644                 $specialPageGroups = $this->getConfig()->get( 'SpecialPageGroups' );
 645
 646                 // Allow overbidding the group from the wiki side
 647                 $msg = $this->msg( 'specialpages-specialpagegroup-' . strtolower( $name ) )->inContentLanguage();
 648                 if ( !$msg->isBlank() ) {
 649                         $group = $msg->text();
 650                 } else {
 651                         // Than use the group from this object
 652                         $group = $this->getGroupName();
 653
 654                         // Group '-' is used as default to have the chance to determine,
 655                         // if the special pages overrides this method,
 656                         // if not overridden, $wgSpecialPageGroups is checked for b/c
 657                         if ( $group === '-' && isset( $specialPageGroups[$name] ) ) {
 658                                 $group = $specialPageGroups[$name];
 659                         }
 660                 }
 661
 662                 // never give '-' back, change to 'other'
 663                 if ( $group === '-' ) {
 664                         $group = 'other';
 665                 }
 666
 667                 return $group;
 668         }
 669
 670         /**
 671          * Under which header this special page is listed in Special:SpecialPages
 672          * See messages 'specialpages-group-*' for valid names
 673          * This method defaults to group 'other'
 674          *
 675          * @return string
 676          * @since 1.21
 677          */
 678         protected function getGroupName() {
 679                 // '-' used here to determine, if this group is overridden or has a hardcoded 'other'
 680                 // Needed for b/c in getFinalGroupName
 681                 return '-';
 682         }
 683 }