includes/specialpage/RedirectSpecialPage.php

   1 <?php
   2 /**
   3  * Shortcuts to construct a special page alias.
   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  * Shortcut to construct a special page alias.
  26  *
  27  * @ingroup SpecialPage
  28  */
  29 abstract class RedirectSpecialPage extends UnlistedSpecialPage {
  30         // Query parameters that can be passed through redirects
  31         protected $mAllowedRedirectParams = array();
  32
  33         // Query parameters added by redirects
  34         protected $mAddedRedirectParams = array();
  35
  36         public function execute( $par ) {
  37                 $redirect = $this->getRedirect( $par );
  38                 $query = $this->getRedirectQuery();
  39                 // Redirect to a page title with possible query parameters
  40                 if ( $redirect instanceof Title ) {
  41                         $url = $redirect->getFullURL( $query );
  42                         $this->getOutput()->redirect( $url );
  43
  44                         return $redirect;
  45                 } elseif ( $redirect === true ) {
  46                         // Redirect to index.php with query parameters
  47                         $url = wfAppendQuery( wfScript( 'index' ), $query );
  48                         $this->getOutput()->redirect( $url );
  49
  50                         return $redirect;
  51                 } else {
  52                         $class = get_class( $this );
  53                         throw new MWException( "RedirectSpecialPage $class doesn't redirect!" );
  54                 }
  55         }
  56
  57         /**
  58          * If the special page is a redirect, then get the Title object it redirects to.
  59          * False otherwise.
  60          *
  61          * @param string $par Subpage string
  62          * @return Title|bool
  63          */
  64         abstract public function getRedirect( $par );
  65
  66         /**
  67          * Return part of the request string for a special redirect page
  68          * This allows passing, e.g. action=history to Special:Mypage, etc.
  69          *
  70          * @return string
  71          */
  72         public function getRedirectQuery() {
  73                 $params = array();
  74
  75                 foreach ( $this->mAllowedRedirectParams as $arg ) {
  76                         if ( $this->getRequest()->getVal( $arg, null ) !== null ) {
  77                                 $params[$arg] = $this->getRequest()->getVal( $arg );
  78                         }
  79                 }
  80
  81                 foreach ( $this->mAddedRedirectParams as $arg => $val ) {
  82                         $params[$arg] = $val;
  83                 }
  84
  85                 return count( $params )
  86                         ? $params
  87                         : false;
  88         }
  89 }
  90
  91 /**
  92  * @ingroup SpecialPage
  93  */
  94 abstract class SpecialRedirectToSpecial extends RedirectSpecialPage {
  95         /** @var string Name of redirect target */
  96         protected $redirName;
  97
  98         /** @var string Name of subpage of redirect target */
  99         protected $redirSubpage;
 100
 101         function __construct(
 102                 $name, $redirName, $redirSubpage = false,
 103                 $allowedRedirectParams = array(), $addedRedirectParams = array()
 104         ) {
 105                 parent::__construct( $name );
 106                 $this->redirName = $redirName;
 107                 $this->redirSubpage = $redirSubpage;
 108                 $this->mAllowedRedirectParams = $allowedRedirectParams;
 109                 $this->mAddedRedirectParams = $addedRedirectParams;
 110         }
 111
 112         public function getRedirect( $subpage ) {
 113                 if ( $this->redirSubpage === false ) {
 114                         return SpecialPage::getTitleFor( $this->redirName, $subpage );
 115                 } else {
 116                         return SpecialPage::getTitleFor( $this->redirName, $this->redirSubpage );
 117                 }
 118         }
 119 }
 120
 121 /**
 122  * Superclass for any RedirectSpecialPage which redirects the user
 123  * to a particular article (as opposed to user contributions, logs, etc.).
 124  *
 125  * For security reasons these special pages are restricted to pass on
 126  * the following subset of GET parameters to the target page while
 127  * removing all others:
 128  *
 129  * - useskin, uselang, printable: to alter the appearance of the resulting page
 130  *
 131  * - redirect: allows viewing one's user page or talk page even if it is a
 132  * redirect.
 133  *
 134  * - rdfrom: allows redirecting to one's user page or talk page from an
 135  * external wiki with the "Redirect from..." notice.
 136  *
 137  * - limit, offset: Useful for linking to history of one's own user page or
 138  * user talk page. For example, this would be a link to "the last edit to your
 139  * user talk page in the year 2010":
 140  * http://en.wikipedia.org/wiki/Special:MyPage?offset=20110000000000&limit=1&action=history
 141  *
 142  * - feed: would allow linking to the current user's RSS feed for their user
 143  * talk page:
 144  * http://en.wikipedia.org/w/index.php?title=Special:MyTalk&action=history&feed=rss
 145  *
 146  * - preloadtitle: Can be used to provide a default section title for a
 147  * preloaded new comment on one's own talk page.
 148  *
 149  * - summary : Can be used to provide a default edit summary for a preloaded
 150  * edit to one's own user page or talk page.
 151  *
 152  * - preview: Allows showing/hiding preview on first edit regardless of user
 153  * preference, useful for preloaded edits where you know preview wouldn't be
 154  * useful.
 155  *
 156  * - redlink: Affects the message the user sees if their talk page/user talk
 157  * page does not currently exist. Avoids confusion for newbies with no user
 158  * pages over why they got a "permission error" following this link:
 159  * http://en.wikipedia.org/w/index.php?title=Special:MyPage&redlink=1
 160  *
 161  * - debug: determines whether the debug parameter is passed to load.php,
 162  * which disables reformatting and allows scripts to be debugged. Useful
 163  * when debugging scripts that manipulate one's own user page or talk page.
 164  *
 165  * @par Hook extension:
 166  * Extensions can add to the redirect parameters list by using the hook
 167  * RedirectSpecialArticleRedirectParams
 168  *
 169  * This hook allows extensions which add GET parameters like FlaggedRevs to
 170  * retain those parameters when redirecting using special pages.
 171  *
 172  * @par Hook extension example:
 173  * @code
 174  *    $wgHooks['RedirectSpecialArticleRedirectParams'][] =
 175  *        'MyExtensionHooks::onRedirectSpecialArticleRedirectParams';
 176  *    public static function onRedirectSpecialArticleRedirectParams( &$redirectParams ) {
 177  *        $redirectParams[] = 'stable';
 178  *        return true;
 179  *    }
 180  * @endcode
 181  *
 182  * @ingroup SpecialPage
 183  */
 184 abstract class RedirectSpecialArticle extends RedirectSpecialPage {
 185         function __construct( $name ) {
 186                 parent::__construct( $name );
 187                 $redirectParams = array(
 188                         'action',
 189                         'redirect', 'rdfrom',
 190                         # Options for preloaded edits
 191                         'preload', 'editintro', 'preloadtitle', 'summary', 'nosummary',
 192                         # Options for overriding user settings
 193                         'preview', 'minor', 'watchthis',
 194                         # Options for history/diffs
 195                         'section', 'oldid', 'diff', 'dir',
 196                         'limit', 'offset', 'feed',
 197                         # Misc options
 198                         'redlink', 'debug',
 199                         # Options for action=raw; missing ctype can break JS or CSS in some browsers
 200                         'ctype', 'maxage', 'smaxage',
 201                 );
 202
 203                 wfRunHooks( "RedirectSpecialArticleRedirectParams", array( &$redirectParams ) );
 204                 $this->mAllowedRedirectParams = $redirectParams;
 205         }
 206 }