3 * Implements Special:Redirect
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 * http://www.gnu.org/copyleft/gpl.html
22 * @ingroup SpecialPage
26 * A special page that redirects to: the user for a numeric user id,
27 * the file for a given filename, or the page for a given revision id.
29 * @ingroup SpecialPage
32 class SpecialRedirect
extends FormSpecialPage
{
35 * The type of the redirect (user/file/revision)
43 * The identifier/value for the redirect (which id, which file)
50 function __construct() {
51 parent
::__construct( 'Redirect' );
57 * Set $mType and $mValue based on parsed value of $subpage.
59 function setParameter( $subpage ) {
60 // parse $subpage to pull out the parts
61 $parts = explode( '/', $subpage, 2 );
62 $this->mType
= count( $parts ) > 0 ?
$parts[0] : null;
63 $this->mValue
= count( $parts ) > 1 ?
$parts[1] : null;
67 * Handle Special:Redirect/user/xxxx (by redirecting to User:YYYY)
69 * @return string|null url to redirect to, or null if $mValue is invalid.
71 function dispatchUser() {
72 if ( !ctype_digit( $this->mValue
) ) {
75 $user = User
::newFromId( (int)$this->mValue
);
76 $username = $user->getName(); // load User as side-effect
77 if ( $user->isAnon() ) {
80 $userpage = Title
::makeTitle( NS_USER
, $username );
82 return $userpage->getFullURL( '', false, PROTO_CURRENT
);
86 * Handle Special:Redirect/file/xxxx
88 * @return string|null url to redirect to, or null if $mValue is not found.
90 function dispatchFile() {
91 $title = Title
::makeTitleSafe( NS_FILE
, $this->mValue
);
93 if ( !$title instanceof Title
) {
96 $file = wfFindFile( $title );
98 if ( !$file ||
!$file->exists() ) {
101 // Default behavior: Use the direct link to the file.
102 $url = $file->getURL();
103 $request = $this->getRequest();
104 $width = $request->getInt( 'width', -1 );
105 $height = $request->getInt( 'height', -1 );
107 // If a width is requested...
108 if ( $width != -1 ) {
109 $mto = $file->transform( array( 'width' => $width, 'height' => $height ) );
111 if ( $mto && !$mto->isError() ) {
112 // ... change the URL to point to a thumbnail.
113 $url = $mto->getURL();
121 * Handle Special:Redirect/revision/xxx
122 * (by redirecting to index.php?oldid=xxx)
124 * @return string|null url to redirect to, or null if $mValue is invalid.
126 function dispatchRevision() {
127 $oldid = $this->mValue
;
128 if ( !ctype_digit( $oldid ) ) {
131 $oldid = (int)$oldid;
132 if ( $oldid === 0 ) {
136 return wfAppendQuery( wfScript( 'index' ), array(
142 * Handle Special:Redirect/page/xxx (by redirecting to index.php?curid=xxx)
144 * @return string|null url to redirect to, or null if $mValue is invalid.
146 function dispatchPage() {
147 $curid = $this->mValue
;
148 if ( !ctype_digit( $curid ) ) {
151 $curid = (int)$curid;
152 if ( $curid === 0 ) {
156 return wfAppendQuery( wfScript( 'index' ), array(
162 * Use appropriate dispatch* method to obtain a redirection URL,
163 * and either: redirect, set a 404 error code and error message,
164 * or do nothing (if $mValue wasn't set) allowing the form to be
167 * @return bool true if a redirect was successfully handled.
169 function dispatch() {
170 // the various namespaces supported by Special:Redirect
171 switch ( $this->mType
) {
173 $url = $this->dispatchUser();
176 $url = $this->dispatchFile();
179 $url = $this->dispatchRevision();
182 $url = $this->dispatchPage();
185 $this->getOutput()->setStatusCode( 404 );
190 $this->getOutput()->redirect( $url );
194 if ( !is_null( $this->mValue
) ) {
195 $this->getOutput()->setStatusCode( 404 );
196 // Message: redirect-not-exists
197 $msg = $this->getMessagePrefix() . '-not-exists';
199 return Status
::newFatal( $msg );
205 protected function getFormFields() {
206 $mp = $this->getMessagePrefix();
208 // subpage => message
209 // Messages: redirect-user, redirect-page, redirect-revision,
211 'user' => $mp . '-user',
212 'page' => $mp . '-page',
213 'revision' => $mp . '-revision',
214 'file' => $mp . '-file',
219 'label-message' => $mp . '-lookup', // Message: redirect-lookup
220 'options' => array(),
221 'default' => current( array_keys( $ns ) ),
223 foreach ( $ns as $n => $m ) {
224 $m = $this->msg( $m )->text();
225 $a['type']['options'][$m] = $n;
229 'label-message' => $mp . '-value' // Message: redirect-value
231 // set the defaults according to the parsed subpage path
232 if ( !empty( $this->mType
) ) {
233 $a['type']['default'] = $this->mType
;
235 if ( !empty( $this->mValue
) ) {
236 $a['value']['default'] = $this->mValue
;
242 public function onSubmit( array $data ) {
243 if ( !empty( $data['type'] ) && !empty( $data['value'] ) ) {
244 $this->setParameter( $data['type'] . '/' . $data['value'] );
247 /* if this returns false, will show the form */
248 return $this->dispatch();
251 public function onSuccess() {
252 /* do nothing, we redirect in $this->dispatch if successful. */
255 protected function alterForm( HTMLForm
$form ) {
256 /* display summary at top of page */
257 $this->outputHeader();
258 // tweak label on submit button
259 // Message: redirect-submit
260 $form->setSubmitTextMsg( $this->getMessagePrefix() . '-submit' );
261 /* submit form every time */
262 $form->setMethod( 'get' );
265 protected function getGroupName() {