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         // @todo FIXME: Visibility must be declared
  96         var $redirName, $redirSubpage;
  97
  98         function __construct(
  99                 $name, $redirName, $redirSubpage = false,
 100                 $allowedRedirectParams = array(), $addedRedirectParams = array()
 101         ) {
 102                 parent::__construct( $name );
 103                 $this->redirName = $redirName;
 104                 $this->redirSubpage = $redirSubpage;
 105                 $this->mAllowedRedirectParams = $allowedRedirectParams;
 106                 $this->mAddedRedirectParams = $addedRedirectParams;
 107         }
 108
 109         public function getRedirect( $subpage ) {
 110                 if ( $this->redirSubpage === false ) {
 111                         return SpecialPage::getTitleFor( $this->redirName, $subpage );
 112                 } else {
 113                         return SpecialPage::getTitleFor( $this->redirName, $this->redirSubpage );
 114                 }
 115         }
 116 }
 117
 118 /**
 119  * Superclass for any RedirectSpecialPage which redirects the user
 120  * to a particular article (as opposed to user contributions, logs, etc.).
 121  *
 122  * For security reasons these special pages are restricted to pass on
 123  * the following subset of GET parameters to the target page while
 124  * removing all others:
 125  *
 126  * - useskin, uselang, printable: to alter the appearance of the resulting page
 127  *
 128  * - redirect: allows viewing one's user page or talk page even if it is a
 129  * redirect.
 130  *
 131  * - rdfrom: allows redirecting to one's user page or talk page from an
 132  * external wiki with the "Redirect from..." notice.
 133  *
 134  * - limit, offset: Useful for linking to history of one's own user page or
 135  * user talk page. For example, this would be a link to "the last edit to your
 136  * user talk page in the year 2010":
 137  * http://en.wikipedia.org/wiki/Special:MyPage?offset=20110000000000&limit=1&action=history
 138  *
 139  * - feed: would allow linking to the current user's RSS feed for their user
 140  * talk page:
 141  * http://en.wikipedia.org/w/index.php?title=Special:MyTalk&action=history&feed=rss
 142  *
 143  * - preloadtitle: Can be used to provide a default section title for a
 144  * preloaded new comment on one's own talk page.
 145  *
 146  * - summary : Can be used to provide a default edit summary for a preloaded
 147  * edit to one's own user page or talk page.
 148  *
 149  * - preview: Allows showing/hiding preview on first edit regardless of user
 150  * preference, useful for preloaded edits where you know preview wouldn't be
 151  * useful.
 152  *
 153  * - internaledit, externaledit, mode: Allows forcing the use of the
 154  * internal/external editor, e.g. to force the internal editor for
 155  * short/simple preloaded edits.
 156  *
 157  * - redlink: Affects the message the user sees if their talk page/user talk
 158  * page does not currently exist. Avoids confusion for newbies with no user
 159  * pages over why they got a "permission error" following this link:
 160  * http://en.wikipedia.org/w/index.php?title=Special:MyPage&redlink=1
 161  *
 162  * - debug: determines whether the debug parameter is passed to load.php,
 163  * which disables reformatting and allows scripts to be debugged. Useful
 164  * when debugging scripts that manipulate one's own user page or talk page.
 165  *
 166  * @par Hook extension:
 167  * Extensions can add to the redirect parameters list by using the hook
 168  * RedirectSpecialArticleRedirectParams
 169  *
 170  * This hook allows extensions which add GET parameters like FlaggedRevs to
 171  * retain those parameters when redirecting using special pages.
 172  *
 173  * @par Hook extension example:
 174  * @code
 175  *    $wgHooks['RedirectSpecialArticleRedirectParams'][] =
 176  *        'MyExtensionHooks::onRedirectSpecialArticleRedirectParams';
 177  *    public static function onRedirectSpecialArticleRedirectParams( &$redirectParams ) {
 178  *        $redirectParams[] = 'stable';
 179  *        return true;
 180  *    }
 181  * @endcode
 182  *
 183  * @ingroup SpecialPage
 184  */
 185 abstract class RedirectSpecialArticle extends RedirectSpecialPage {
 186         function __construct( $name ) {
 187                 parent::__construct( $name );
 188                 $redirectParams = array(
 189                         'action',
 190                         'redirect', 'rdfrom',
 191                         # Options for preloaded edits
 192                         'preload', 'editintro', 'preloadtitle', 'summary', 'nosummary',
 193                         # Options for overriding user settings
 194                         'preview', 'internaledit', 'externaledit', 'mode', 'minor', 'watchthis',
 195                         # Options for history/diffs
 196                         'section', 'oldid', 'diff', 'dir',
 197                         'limit', 'offset', 'feed',
 198                         # Misc options
 199                         'redlink', 'debug',
 200                         # Options for action=raw; missing ctype can break JS or CSS in some browsers
 201                         'ctype', 'maxage', 'smaxage',
 202                 );
 203
 204                 wfRunHooks( "RedirectSpecialArticleRedirectParams", array( &$redirectParams ) );
 205                 $this->mAllowedRedirectParams = $redirectParams;
 206         }
 207 }