MediaWiki  master
SpecialRedirect.php
Go to the documentation of this file.
1 <?php
32 
40  protected $mType;
41 
49  protected $mValue;
50 
51  function __construct() {
52  parent::__construct( 'Redirect' );
53  $this->mType = null;
54  $this->mValue = null;
55  }
56 
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  }
67 
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  $userpage = Title::makeTitle( NS_USER, $username );
85 
86  return Status::newGood( $userpage->getFullURL( '', false, PROTO_CURRENT ) );
87  }
88 
94  function dispatchFile() {
95  try {
96  $title = Title::newFromTextThrow( $this->mValue, NS_FILE );
97  if ( $title && !$title->inNamespace( NS_FILE ) ) {
98  // If the given value contains a namespace enforce file namespace
100  }
101  } catch ( MalformedTitleException $e ) {
102  return Status::newFatal( $e->getMessageObject() );
103  }
104  $file = wfFindFile( $title );
105 
106  if ( !$file || !$file->exists() ) {
107  // Message: redirect-not-exists
108  return Status::newFatal( $this->getMessagePrefix() . '-not-exists' );
109  }
110  // Default behavior: Use the direct link to the file.
111  $url = $file->getUrl();
112  $request = $this->getRequest();
113  $width = $request->getInt( 'width', -1 );
114  $height = $request->getInt( 'height', -1 );
115 
116  // If a width is requested...
117  if ( $width != -1 ) {
118  $mto = $file->transform( [ 'width' => $width, 'height' => $height ] );
119  // ... and we can
120  if ( $mto && !$mto->isError() ) {
121  // ... change the URL to point to a thumbnail.
122  // Note: This url is more temporary as can change
123  // if file is reuploaded and has different aspect ratio.
124  $url = [ $mto->getUrl(), $height === -1 ? 301 : 302 ];
125  }
126  }
127 
128  return Status::newGood( $url );
129  }
130 
137  function dispatchRevision() {
138  $oldid = $this->mValue;
139  if ( !ctype_digit( $oldid ) ) {
140  // Message: redirect-not-numeric
141  return Status::newFatal( $this->getMessagePrefix() . '-not-numeric' );
142  }
143  $oldid = (int)$oldid;
144  if ( $oldid === 0 ) {
145  // Message: redirect-not-exists
146  return Status::newFatal( $this->getMessagePrefix() . '-not-exists' );
147  }
148 
149  return Status::newGood( wfAppendQuery( wfScript( 'index' ), [
150  'oldid' => $oldid
151  ] ) );
152  }
153 
159  function dispatchPage() {
160  $curid = $this->mValue;
161  if ( !ctype_digit( $curid ) ) {
162  // Message: redirect-not-numeric
163  return Status::newFatal( $this->getMessagePrefix() . '-not-numeric' );
164  }
165  $curid = (int)$curid;
166  if ( $curid === 0 ) {
167  // Message: redirect-not-exists
168  return Status::newFatal( $this->getMessagePrefix() . '-not-exists' );
169  }
170 
171  return Status::newGood( wfAppendQuery( wfScript( 'index' ), [
172  'curid' => $curid
173  ] ) );
174  }
175 
183  function dispatchLog() {
184  $logid = $this->mValue;
185  if ( !ctype_digit( $logid ) ) {
186  // Message: redirect-not-numeric
187  return Status::newFatal( $this->getMessagePrefix() . '-not-numeric' );
188  }
189  $logid = (int)$logid;
190  if ( $logid === 0 ) {
191  // Message: redirect-not-exists
192  return Status::newFatal( $this->getMessagePrefix() . '-not-exists' );
193  }
194  $query = [ 'title' => 'Special:Log', 'logid' => $logid ];
195  return Status::newGood( wfAppendQuery( wfScript( 'index' ), $query ) );
196  }
197 
206  function dispatch() {
207  // the various namespaces supported by Special:Redirect
208  switch ( $this->mType ) {
209  case 'user':
210  $status = $this->dispatchUser();
211  break;
212  case 'file':
213  $status = $this->dispatchFile();
214  break;
215  case 'revision':
216  $status = $this->dispatchRevision();
217  break;
218  case 'page':
219  $status = $this->dispatchPage();
220  break;
221  case 'logid':
222  $status = $this->dispatchLog();
223  break;
224  default:
225  $status = null;
226  break;
227  }
228  if ( $status && $status->isGood() ) {
229  // These urls can sometimes be linked from prominent places,
230  // so varnish cache.
231  $value = $status->getValue();
232  if ( is_array( $value ) ) {
233  list( $url, $code ) = $value;
234  } else {
235  $url = $value;
236  $code = 301;
237  }
238  if ( $code === 301 ) {
239  $this->getOutput()->setCdnMaxage( 60 * 60 );
240  } else {
241  $this->getOutput()->setCdnMaxage( 10 );
242  }
243  $this->getOutput()->redirect( $url, $code );
244 
245  return true;
246  }
247  if ( !is_null( $this->mValue ) ) {
248  $this->getOutput()->setStatusCode( 404 );
249 
250  return $status;
251  }
252 
253  return false;
254  }
255 
256  protected function getFormFields() {
257  $mp = $this->getMessagePrefix();
258  $ns = [
259  // subpage => message
260  // Messages: redirect-user, redirect-page, redirect-revision,
261  // redirect-file, redirect-logid
262  'user' => $mp . '-user',
263  'page' => $mp . '-page',
264  'revision' => $mp . '-revision',
265  'file' => $mp . '-file',
266  'logid' => $mp . '-logid',
267  ];
268  $a = [];
269  $a['type'] = [
270  'type' => 'select',
271  'label-message' => $mp . '-lookup', // Message: redirect-lookup
272  'options' => [],
273  'default' => current( array_keys( $ns ) ),
274  ];
275  foreach ( $ns as $n => $m ) {
276  $m = $this->msg( $m )->text();
277  $a['type']['options'][$m] = $n;
278  }
279  $a['value'] = [
280  'type' => 'text',
281  'label-message' => $mp . '-value' // Message: redirect-value
282  ];
283  // set the defaults according to the parsed subpage path
284  if ( !empty( $this->mType ) ) {
285  $a['type']['default'] = $this->mType;
286  }
287  if ( !empty( $this->mValue ) ) {
288  $a['value']['default'] = $this->mValue;
289  }
290 
291  return $a;
292  }
293 
294  public function onSubmit( array $data ) {
295  if ( !empty( $data['type'] ) && !empty( $data['value'] ) ) {
296  $this->setParameter( $data['type'] . '/' . $data['value'] );
297  }
298 
299  /* if this returns false, will show the form */
300  return $this->dispatch();
301  }
302 
303  public function onSuccess() {
304  /* do nothing, we redirect in $this->dispatch if successful. */
305  }
306 
307  protected function alterForm( HTMLForm $form ) {
308  /* display summary at top of page */
309  $this->outputHeader();
310  // tweak label on submit button
311  // Message: redirect-submit
312  $form->setSubmitTextMsg( $this->getMessagePrefix() . '-submit' );
313  /* submit form every time */
314  $form->setMethod( 'get' );
315  }
316 
317  protected function getDisplayFormat() {
318  return 'ooui';
319  }
320 
326  protected function getSubpagesForPrefixSearch() {
327  return [
328  'file',
329  'page',
330  'revision',
331  'user',
332  'logid',
333  ];
334  }
335 
339  public function requiresWrite() {
340  return false;
341  }
342 
346  public function requiresUnblock() {
347  return false;
348  }
349 
350  protected function getGroupName() {
351  return 'redirects';
352  }
353 }
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
dispatchRevision()
Handle Special:Redirect/revision/xxx (by redirecting to index.php?oldid=xxx)
dispatchPage()
Handle Special:Redirect/page/xxx (by redirecting to index.php?curid=xxx)
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
null for the local 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:1585
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
getSubpagesForPrefixSearch()
Return an array of subpages that this special page will accept.
MalformedTitleException is thrown when a TitleParser is unable to parse a title string.
onSubmit(array $data)
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Definition: router.php:42
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2159
dispatch()
Use appropriate dispatch* method to obtain a redirection URL, and either: redirect, set a 404 error code and error message, or do nothing (if $mValue wasn&#39;t set) allowing the form to be displayed.
setParameter( $subpage)
Set $mType and $mValue based on parsed value of $subpage.
$value
$mValue
The identifier/value for the redirect (which id, which file)
const PROTO_CURRENT
Definition: Defines.php:222
getOutput()
Get the OutputPage being used for this instance.
Special page which uses an HTMLForm to handle processing.
setMethod( $method='post')
Set the method used to submit the form.
Definition: HTMLForm.php:1639
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
wfAppendQuery( $url, $query)
Append a query string to an existing URL, which may or may not already have query string parameters a...
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
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. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header '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 '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:1263
alterForm(HTMLForm $form)
wfFindFile( $title, $options=[])
Find a file.
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
const NS_FILE
Definition: Defines.php:70
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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:780
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:9
static newFromTextThrow( $text, $defaultNamespace=NS_MAIN)
Like Title::newFromText(), but throws MalformedTitleException when the title is invalid, rather than returning null.
Definition: Title.php:356
dispatchUser()
Handle Special:Redirect/user/xxxx (by redirecting to User:YYYY)
static makeTitle( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:589
getMessagePrefix()
Get message prefix for HTMLForm.
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:35
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:780
static newFromId( $id)
Static factory method for creation from a given user ID.
Definition: User.php:611
msg( $key)
Wrapper around wfMessage that sets the current context.
A special page that redirects to: the user for a numeric user id, the file for a given filename...
setSubmitTextMsg( $msg)
Set the text for the submit button to a message.
Definition: HTMLForm.php:1398
dispatchLog()
Handle Special:Redirect/logid/xxx (by redirecting to index.php?title=Special:Log&logid=xxx) ...
getRequest()
Get the WebRequest being used for this instance.
static makeName( $ns, $title, $fragment='', $interwiki='', $canonicalNamespace=false)
Make a prefixed DB key from a DB key and a namespace index.
Definition: Title.php:819
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:2633
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
dispatchFile()
Handle Special:Redirect/file/xxxx.
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1473
$mType
The type of the redirect (user/file/revision)