MediaWiki  REL1_31
Go to the documentation of this file.
1 <?php
40  protected $mType;
49  protected $mValue;
51  function __construct() {
52  parent::__construct( 'Redirect' );
53  $this->mType = null;
54  $this->mValue = null;
55  }
61  function setParameter( $subpage ) {
62  // parse $subpage to pull out the parts
63  $parts = explode( '/', $subpage, 2 );
64  $this->mType = count( $parts ) > 0 ? $parts[0] : null;
65  $this->mValue = count( $parts ) > 1 ? $parts[1] : null;
66  }
73  function dispatchUser() {
74  if ( !ctype_digit( $this->mValue ) ) {
75  // Message: redirect-not-numeric
76  return Status::newFatal( $this->getMessagePrefix() . '-not-numeric' );
77  }
78  $user = User::newFromId( (int)$this->mValue );
79  $username = $user->getName(); // load User as side-effect
80  if ( $user->isAnon() ) {
81  // Message: redirect-not-exists
82  return Status::newFatal( $this->getMessagePrefix() . '-not-exists' );
83  }
84  if ( $user->isHidden() && !$this->getUser()->isAllowed( 'hideuser' ) ) {
85  throw new PermissionsError( null, [ 'badaccess-group0' ] );
86  }
87  $userpage = Title::makeTitle( NS_USER, $username );
89  return Status::newGood( [
90  $userpage->getFullURL( '', false, PROTO_CURRENT ), 302
91  ] );
92  }
99  function dispatchFile() {
100  try {
101  $title = Title::newFromTextThrow( $this->mValue, NS_FILE );
102  if ( $title && !$title->inNamespace( NS_FILE ) ) {
103  // If the given value contains a namespace enforce file namespace
104  $title = Title::newFromTextThrow( Title::makeName( NS_FILE, $this->mValue ) );
105  }
106  } catch ( MalformedTitleException $e ) {
107  return Status::newFatal( $e->getMessageObject() );
108  }
109  $file = wfFindFile( $title );
111  if ( !$file || !$file->exists() ) {
112  // Message: redirect-not-exists
113  return Status::newFatal( $this->getMessagePrefix() . '-not-exists' );
114  }
115  // Default behavior: Use the direct link to the file.
116  $url = $file->getUrl();
117  $request = $this->getRequest();
118  $width = $request->getInt( 'width', -1 );
119  $height = $request->getInt( 'height', -1 );
121  // If a width is requested...
122  if ( $width != -1 ) {
123  $mto = $file->transform( [ 'width' => $width, 'height' => $height ] );
124  // ... and we can
125  if ( $mto && !$mto->isError() ) {
126  // ... change the URL to point to a thumbnail.
127  // Note: This url is more temporary as can change
128  // if file is reuploaded and has different aspect ratio.
129  $url = [ $mto->getUrl(), $height === -1 ? 301 : 302 ];
130  }
131  }
133  return Status::newGood( $url );
134  }
142  function dispatchRevision() {
143  $oldid = $this->mValue;
144  if ( !ctype_digit( $oldid ) ) {
145  // Message: redirect-not-numeric
146  return Status::newFatal( $this->getMessagePrefix() . '-not-numeric' );
147  }
148  $oldid = (int)$oldid;
149  if ( $oldid === 0 ) {
150  // Message: redirect-not-exists
151  return Status::newFatal( $this->getMessagePrefix() . '-not-exists' );
152  }
154  return Status::newGood( wfAppendQuery( wfScript( 'index' ), [
155  'oldid' => $oldid
156  ] ) );
157  }
164  function dispatchPage() {
165  $curid = $this->mValue;
166  if ( !ctype_digit( $curid ) ) {
167  // Message: redirect-not-numeric
168  return Status::newFatal( $this->getMessagePrefix() . '-not-numeric' );
169  }
170  $curid = (int)$curid;
171  if ( $curid === 0 ) {
172  // Message: redirect-not-exists
173  return Status::newFatal( $this->getMessagePrefix() . '-not-exists' );
174  }
176  return Status::newGood( wfAppendQuery( wfScript( 'index' ), [
177  'curid' => $curid
178  ] ) );
179  }
188  function dispatchLog() {
189  $logid = $this->mValue;
190  if ( !ctype_digit( $logid ) ) {
191  // Message: redirect-not-numeric
192  return Status::newFatal( $this->getMessagePrefix() . '-not-numeric' );
193  }
194  $logid = (int)$logid;
195  if ( $logid === 0 ) {
196  // Message: redirect-not-exists
197  return Status::newFatal( $this->getMessagePrefix() . '-not-exists' );
198  }
199  $query = [ 'title' => 'Special:Log', 'logid' => $logid ];
200  return Status::newGood( wfAppendQuery( wfScript( 'index' ), $query ) );
201  }
211  function dispatch() {
212  // the various namespaces supported by Special:Redirect
213  switch ( $this->mType ) {
214  case 'user':
215  $status = $this->dispatchUser();
216  break;
217  case 'file':
218  $status = $this->dispatchFile();
219  break;
220  case 'revision':
221  $status = $this->dispatchRevision();
222  break;
223  case 'page':
224  $status = $this->dispatchPage();
225  break;
226  case 'logid':
227  $status = $this->dispatchLog();
228  break;
229  default:
230  $status = null;
231  break;
232  }
233  if ( $status && $status->isGood() ) {
234  // These urls can sometimes be linked from prominent places,
235  // so varnish cache.
236  $value = $status->getValue();
237  if ( is_array( $value ) ) {
238  list( $url, $code ) = $value;
239  } else {
240  $url = $value;
241  $code = 301;
242  }
243  if ( $code === 301 ) {
244  $this->getOutput()->setCdnMaxage( 60 * 60 );
245  } else {
246  $this->getOutput()->setCdnMaxage( 10 );
247  }
248  $this->getOutput()->redirect( $url, $code );
250  return true;
251  }
252  if ( !is_null( $this->mValue ) ) {
253  $this->getOutput()->setStatusCode( 404 );
255  return $status;
256  }
258  return false;
259  }
261  protected function getFormFields() {
262  $mp = $this->getMessagePrefix();
263  $ns = [
264  // subpage => message
265  // Messages: redirect-user, redirect-page, redirect-revision,
266  // redirect-file, redirect-logid
267  'user' => $mp . '-user',
268  'page' => $mp . '-page',
269  'revision' => $mp . '-revision',
270  'file' => $mp . '-file',
271  'logid' => $mp . '-logid',
272  ];
273  $a = [];
274  $a['type'] = [
275  'type' => 'select',
276  'label-message' => $mp . '-lookup', // Message: redirect-lookup
277  'options' => [],
278  'default' => current( array_keys( $ns ) ),
279  ];
280  foreach ( $ns as $n => $m ) {
281  $m = $this->msg( $m )->text();
282  $a['type']['options'][$m] = $n;
283  }
284  $a['value'] = [
285  'type' => 'text',
286  'label-message' => $mp . '-value' // Message: redirect-value
287  ];
288  // set the defaults according to the parsed subpage path
289  if ( !empty( $this->mType ) ) {
290  $a['type']['default'] = $this->mType;
291  }
292  if ( !empty( $this->mValue ) ) {
293  $a['value']['default'] = $this->mValue;
294  }
296  return $a;
297  }
299  public function onSubmit( array $data ) {
300  if ( !empty( $data['type'] ) && !empty( $data['value'] ) ) {
301  $this->setParameter( $data['type'] . '/' . $data['value'] );
302  }
304  /* if this returns false, will show the form */
305  return $this->dispatch();
306  }
308  public function onSuccess() {
309  /* do nothing, we redirect in $this->dispatch if successful. */
310  }
312  protected function alterForm( HTMLForm $form ) {
313  /* display summary at top of page */
314  $this->outputHeader();
315  // tweak label on submit button
316  // Message: redirect-submit
317  $form->setSubmitTextMsg( $this->getMessagePrefix() . '-submit' );
318  /* submit form every time */
319  $form->setMethod( 'get' );
320  }
322  protected function getDisplayFormat() {
323  return 'ooui';
324  }
331  protected function getSubpagesForPrefixSearch() {
332  return [
333  'file',
334  'page',
335  'revision',
336  'user',
337  'logid',
338  ];
339  }
344  public function requiresWrite() {
345  return false;
346  }
351  public function requiresUnblock() {
352  return false;
353  }
355  protected function getGroupName() {
356  return 'redirects';
357  }
358 }
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:247
static newFromId( $id)
Static factory method for creation from a given user ID.
Definition: User.php:614
msg( $key)
Wrapper around wfMessage that sets the current context.
Definition: SpecialPage.php:793
static makeName( $ns, $title, $fragment='', $interwiki='', $canonicalNamespace=false)
Make a prefixed DB key from a DB key and a namespace index.
Definition: Title.php:741
Handle Special:Redirect/logid/xxx (by redirecting to index.php?title=Special:Log&logid=xxx)
Definition: SpecialRedirect.php:188
Get the OutputPage being used for this instance.
Definition: SpecialPage.php:722
the array() calling protocol came about after MediaWiki 1.4rc1.
The identifier/value for the redirect (which id, which file)
Definition: SpecialRedirect.php:49
onSubmit(array $data)
Process the form on POST submission.
Definition: SpecialRedirect.php:299
Do something exciting on successful processing of the form, most likely to show a confirmation messag...
Definition: SpecialRedirect.php:308
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
const NS_FILE
Definition: Defines.php:80
Special page which uses an HTMLForm to handle processing.
Definition: FormSpecialPage.php:31
The type of the redirect (user/file/revision)
Definition: SpecialRedirect.php:40
Show an error when a user tries to do something they do not have the necessary permissions for.
Definition: PermissionsError.php:28
setMethod( $method='post')
Set the method used to submit the form.
Definition: HTMLForm.php:1584
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
Get display format for the form.
Definition: SpecialRedirect.php:322
wfAppendQuery( $url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
Definition: GlobalFunctions.php:469
Get message prefix for HTMLForm.
Definition: FormSpecialPage.php:79
A special page that redirects to: the user for a numeric user id, the file for a given filename,...
Definition: SpecialRedirect.php:31
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
Definition: GlobalFunctions.php:2890
Use appropriate dispatch* method to obtain a redirection URL, and either: redirect,...
Definition: SpecialRedirect.php:211
Definition: Defines.php:232
Get an HTMLForm descriptor array.
Definition: SpecialRedirect.php:261
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:534
Handle Special:Redirect/revision/xxx (by redirecting to index.php?oldid=xxx)
Definition: SpecialRedirect.php:142
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
static newFromTextThrow( $text, $defaultNamespace=NS_MAIN)
Like Title::newFromText(), but throws MalformedTitleException when the title is invalid,...
Definition: Title.php:306
Definition: styleTest.css.php:45
Definition: SpecialRedirect.php:51
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
Handle Special:Redirect/file/xxxx.
Definition: SpecialRedirect.php:99
Get the WebRequest being used for this instance.
Definition: SpecialPage.php:712
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action or null $user:User who performed the tagging when the tagging is subsequent to the action or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1255
Handle Special:Redirect/user/xxxx (by redirecting to User:YYYY)
Definition: SpecialRedirect.php:73
Handle Special:Redirect/page/xxx (by redirecting to index.php?curid=xxx)
Definition: SpecialRedirect.php:164
wfFindFile( $title, $options=[])
Find a file.
Definition: GlobalFunctions.php:2853
setSubmitTextMsg( $msg)
Set the text for the submit button to a message.
Definition: HTMLForm.php:1356
Return an array of subpages that this special page will accept.
Definition: SpecialRedirect.php:331
alterForm(HTMLForm $form)
Play with the HTMLForm if you need to more substantially.
Definition: SpecialRedirect.php:312
MalformedTitleException is thrown when a TitleParser is unable to parse a title string.
Definition: MalformedTitleException.php:25
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable & $code
Definition: hooks.txt:865
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Definition: SpecialRedirect.php:355
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:22
const NS_USER
Definition: Defines.php:76
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:785
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2806
setParameter( $subpage)
Set $mType and $mValue based on parsed value of $subpage.
Definition: SpecialRedirect.php:61
null for the wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1620
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
Definition: SpecialPage.php:629
Definition: SpecialRedirect.php:344
Definition: SpecialRedirect.php:351
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2171
Object handling generic submission, CSRF protection, layout and other logic for UI forms.
Definition: HTMLForm.php:130