MediaWiki  REL1_31
SpecialUploadStash.php
Go to the documentation of this file.
1 <?php
37  // UploadStash
38  private $stash;
39 
50  const MAX_SERVE_BYTES = 1048576; // 1MB
51 
52  public function __construct() {
53  parent::__construct( 'UploadStash', 'upload' );
54  }
55 
56  public function doesWrites() {
57  return true;
58  }
59 
67  public function execute( $subPage ) {
69 
70  $this->stash = RepoGroup::singleton()->getLocalRepo()->getUploadStash( $this->getUser() );
71  $this->checkPermissions();
72 
73  if ( $subPage === null || $subPage === '' ) {
74  return $this->showUploads();
75  }
76 
77  return $this->showUpload( $subPage );
78  }
79 
88  public function showUpload( $key ) {
89  // prevent callers from doing standard HTML output -- we'll take it from here
90  $this->getOutput()->disable();
91 
92  try {
93  $params = $this->parseKey( $key );
94  if ( $params['type'] === 'thumb' ) {
95  return $this->outputThumbFromStash( $params['file'], $params['params'] );
96  } else {
97  return $this->outputLocalFile( $params['file'] );
98  }
100  $code = 404;
101  $message = $e->getMessage();
103  $code = 500;
104  $message = $e->getMessage();
105  } catch ( UploadStashBadPathException $e ) {
106  $code = 500;
107  $message = $e->getMessage();
109  $code = 500;
110  $message = $e->getMessage();
111  } catch ( Exception $e ) {
112  $code = 500;
113  $message = $e->getMessage();
114  }
115 
116  throw new HttpError( $code, $message );
117  }
118 
128  private function parseKey( $key ) {
129  $type = strtok( $key, '/' );
130 
131  if ( $type !== 'file' && $type !== 'thumb' ) {
132  throw new UploadStashBadPathException(
133  wfMessage( 'uploadstash-bad-path-unknown-type', $type )
134  );
135  }
136  $fileName = strtok( '/' );
137  $thumbPart = strtok( '/' );
138  $file = $this->stash->getFile( $fileName );
139  if ( $type === 'thumb' ) {
140  $srcNamePos = strrpos( $thumbPart, $fileName );
141  if ( $srcNamePos === false || $srcNamePos < 1 ) {
142  throw new UploadStashBadPathException(
143  wfMessage( 'uploadstash-bad-path-unrecognized-thumb-name' )
144  );
145  }
146  $paramString = substr( $thumbPart, 0, $srcNamePos - 1 );
147 
148  $handler = $file->getHandler();
149  if ( $handler ) {
150  $params = $handler->parseParamString( $paramString );
151 
152  return [ 'file' => $file, 'type' => $type, 'params' => $params ];
153  } else {
154  throw new UploadStashBadPathException(
155  wfMessage( 'uploadstash-bad-path-no-handler', $file->getMimeType(), $file->getPath() )
156  );
157  }
158  }
159 
160  return [ 'file' => $file, 'type' => $type ];
161  }
162 
171  private function outputThumbFromStash( $file, $params ) {
172  $flags = 0;
173  // this config option, if it exists, points to a "scaler", as you might find in
174  // the Wikimedia Foundation cluster. See outputRemoteScaledThumb(). This
175  // is part of our horrible NFS-based system, we create a file on a mount
176  // point here, but fetch the scaled file from somewhere else that
177  // happens to share it over NFS.
178  if ( $this->getConfig()->get( 'UploadStashScalerBaseUrl' ) ) {
179  $this->outputRemoteScaledThumb( $file, $params, $flags );
180  } else {
181  $this->outputLocallyScaledThumb( $file, $params, $flags );
182  }
183  }
184 
194  private function outputLocallyScaledThumb( $file, $params, $flags ) {
195  // n.b. this is stupid, we insist on re-transforming the file every time we are invoked. We rely
196  // on HTTP caching to ensure this doesn't happen.
197 
198  $flags |= File::RENDER_NOW;
199 
200  $thumbnailImage = $file->transform( $params, $flags );
201  if ( !$thumbnailImage ) {
203  wfMessage( 'uploadstash-file-not-found-no-thumb' )
204  );
205  }
206 
207  // we should have just generated it locally
208  if ( !$thumbnailImage->getStoragePath() ) {
210  wfMessage( 'uploadstash-file-not-found-no-local-path' )
211  );
212  }
213 
214  // now we should construct a File, so we can get MIME and other such info in a standard way
215  // n.b. MIME type may be different from original (ogx original -> jpeg thumb)
216  $thumbFile = new UnregisteredLocalFile( false,
217  $this->stash->repo, $thumbnailImage->getStoragePath(), false );
218  if ( !$thumbFile ) {
220  wfMessage( 'uploadstash-file-not-found-no-object' )
221  );
222  }
223 
224  return $this->outputLocalFile( $thumbFile );
225  }
226 
246  private function outputRemoteScaledThumb( $file, $params, $flags ) {
247  // This option probably looks something like
248  // '//upload.wikimedia.org/wikipedia/test/thumb/temp'. Do not use
249  // trailing slash.
250  $scalerBaseUrl = $this->getConfig()->get( 'UploadStashScalerBaseUrl' );
251 
252  if ( preg_match( '/^\/\//', $scalerBaseUrl ) ) {
253  // this is apparently a protocol-relative URL, which makes no sense in this context,
254  // since this is used for communication that's internal to the application.
255  // default to http.
256  $scalerBaseUrl = wfExpandUrl( $scalerBaseUrl, PROTO_CANONICAL );
257  }
258 
259  // We need to use generateThumbName() instead of thumbName(), because
260  // the suffix needs to match the file name for the remote thumbnailer
261  // to work
262  $scalerThumbName = $file->generateThumbName( $file->getName(), $params );
263  $scalerThumbUrl = $scalerBaseUrl . '/' . $file->getUrlRel() .
264  '/' . rawurlencode( $scalerThumbName );
265 
266  // make a curl call to the scaler to create a thumbnail
267  $httpOptions = [
268  'method' => 'GET',
269  'timeout' => 5 // T90599 attempt to time out cleanly
270  ];
271  $req = MWHttpRequest::factory( $scalerThumbUrl, $httpOptions, __METHOD__ );
272  $status = $req->execute();
273  if ( !$status->isOK() ) {
274  $errors = $status->getErrorsArray();
276  wfMessage(
277  'uploadstash-file-not-found-no-remote-thumb',
278  print_r( $errors, 1 ),
279  $scalerThumbUrl
280  )
281  );
282  }
283  $contentType = $req->getResponseHeader( "content-type" );
284  if ( !$contentType ) {
286  wfMessage( 'uploadstash-file-not-found-missing-content-type' )
287  );
288  }
289 
290  return $this->outputContents( $req->getContent(), $contentType );
291  }
292 
302  private function outputLocalFile( File $file ) {
303  if ( $file->getSize() > self::MAX_SERVE_BYTES ) {
305  wfMessage( 'uploadstash-file-too-large', self::MAX_SERVE_BYTES )
306  );
307  }
308 
309  return $file->getRepo()->streamFile( $file->getPath(),
310  [ 'Content-Transfer-Encoding: binary',
311  'Expires: Sun, 17-Jan-2038 19:14:07 GMT' ]
312  );
313  }
314 
323  private function outputContents( $content, $contentType ) {
324  $size = strlen( $content );
325  if ( $size > self::MAX_SERVE_BYTES ) {
327  wfMessage( 'uploadstash-file-too-large', self::MAX_SERVE_BYTES )
328  );
329  }
330  // Cancel output buffering and gzipping if set
332  self::outputFileHeaders( $contentType, $size );
333  print $content;
334 
335  return true;
336  }
337 
347  private static function outputFileHeaders( $contentType, $size ) {
348  header( "Content-Type: $contentType", true );
349  header( 'Content-Transfer-Encoding: binary', true );
350  header( 'Expires: Sun, 17-Jan-2038 19:14:07 GMT', true );
351  // T55032 - It shouldn't be a problem here, but let's be safe and not cache
352  header( 'Cache-Control: private' );
353  header( "Content-Length: $size", true );
354  }
355 
365  public static function tryClearStashedUploads( $formData, $form ) {
366  if ( isset( $formData['Clear'] ) ) {
367  $stash = RepoGroup::singleton()->getLocalRepo()->getUploadStash( $form->getUser() );
368  wfDebug( 'stash has: ' . print_r( $stash->listFiles(), true ) . "\n" );
369 
370  if ( !$stash->clear() ) {
371  return Status::newFatal( 'uploadstash-errclear' );
372  }
373  }
374 
375  return Status::newGood();
376  }
377 
383  private function showUploads() {
384  // sets the title, etc.
385  $this->setHeaders();
386  $this->outputHeader();
387 
388  // create the form, which will also be used to execute a callback to process incoming form data
389  // this design is extremely dubious, but supposedly HTMLForm is our standard now?
390 
391  $context = new DerivativeContext( $this->getContext() );
392  $context->setTitle( $this->getPageTitle() ); // Remove subpage
393  $form = HTMLForm::factory( 'ooui', [
394  'Clear' => [
395  'type' => 'hidden',
396  'default' => true,
397  'name' => 'clear',
398  ]
399  ], $context, 'clearStashedUploads' );
400  $form->setSubmitDestructive();
401  $form->setSubmitCallback( [ __CLASS__, 'tryClearStashedUploads' ] );
402  $form->setSubmitTextMsg( 'uploadstash-clear' );
403 
404  $form->prepareForm();
405  $formResult = $form->tryAuthorizedSubmit();
406 
407  // show the files + form, if there are any, or just say there are none
408  $refreshHtml = Html::element( 'a',
409  [ 'href' => $this->getPageTitle()->getLocalURL() ],
410  $this->msg( 'uploadstash-refresh' )->text() );
411  $files = $this->stash->listFiles();
412  if ( $files && count( $files ) ) {
413  sort( $files );
414  $fileListItemsHtml = '';
415  $linkRenderer = $this->getLinkRenderer();
416  foreach ( $files as $file ) {
417  $itemHtml = $linkRenderer->makeKnownLink(
418  $this->getPageTitle( "file/$file" ),
419  $file
420  );
421  try {
422  $fileObj = $this->stash->getFile( $file );
423  $thumb = $fileObj->generateThumbName( $file, [ 'width' => 220 ] );
424  $itemHtml .=
425  $this->msg( 'word-separator' )->escaped() .
426  $this->msg( 'parentheses' )->rawParams(
427  $linkRenderer->makeKnownLink(
428  $this->getPageTitle( "thumb/$file/$thumb" ),
429  $this->msg( 'uploadstash-thumbnail' )->text()
430  )
431  )->escaped();
432  } catch ( Exception $e ) {
433  }
434  $fileListItemsHtml .= Html::rawElement( 'li', [], $itemHtml );
435  }
436  $this->getOutput()->addHTML( Html::rawElement( 'ul', [], $fileListItemsHtml ) );
437  $form->displayForm( $formResult );
438  $this->getOutput()->addHTML( Html::rawElement( 'p', [], $refreshHtml ) );
439  } else {
440  $this->getOutput()->addHTML( Html::rawElement( 'p', [],
441  Html::element( 'span', [], $this->msg( 'uploadstash-nofiles' )->text() )
442  . ' '
443  . $refreshHtml
444  ) );
445  }
446 
447  return true;
448  }
449 }
450 
456 }
SpecialPage\getPageTitle
getPageTitle( $subpage=false)
Get a self-referential title object.
Definition: SpecialPage.php:675
File\getPath
getPath()
Return the storage path to the file.
Definition: File.php:417
$handler
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 modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves $handler
Definition: hooks.txt:903
SpecialUploadStash\tryClearStashedUploads
static tryClearStashedUploads( $formData, $form)
Static callback for the HTMLForm in showUploads, to process Note the stash has to be recreated since ...
Definition: SpecialUploadStash.php:365
wfResetOutputBuffers
wfResetOutputBuffers( $resetGzipEncoding=true)
Clear away any user-level output buffers, discarding contents.
Definition: GlobalFunctions.php:1788
PROTO_CANONICAL
const PROTO_CANONICAL
Definition: Defines.php:233
RepoGroup\singleton
static singleton()
Get a RepoGroup instance.
Definition: RepoGroup.php:59
SpecialPage\msg
msg( $key)
Wrapper around wfMessage that sets the current context.
Definition: SpecialPage.php:793
SpecialUploadStash\$stash
$stash
Definition: SpecialUploadStash.php:38
UploadStashBadPathException
Definition: UploadStash.php:805
SpecialPage\getOutput
getOutput()
Get the OutputPage being used for this instance.
Definition: SpecialPage.php:722
wfMessage
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
UnlistedSpecialPage
Shortcut to construct a special page which is unlisted by default.
Definition: UnlistedSpecialPage.php:29
text
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition: design.txt:18
UnregisteredLocalFile
A file object referring to either a standalone local file, or a file in a local repository with no da...
Definition: UnregisteredLocalFile.php:36
SpecialPage\checkPermissions
checkPermissions()
Checks if userCanExecute, and if not throws a PermissionsError.
Definition: SpecialPage.php:306
StatusValue\newFatal
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
$params
$params
Definition: styleTest.css.php:40
SpecialUploadStash\outputRemoteScaledThumb
outputRemoteScaledThumb( $file, $params, $flags)
Scale a file with a remote "scaler", as exists on the Wikimedia Foundation cluster,...
Definition: SpecialUploadStash.php:246
SpecialPage\useTransactionalTimeLimit
useTransactionalTimeLimit()
Call wfTransactionalTimeLimit() if this request was POSTed.
Definition: SpecialPage.php:897
SpecialUploadStash\execute
execute( $subPage)
Execute page – can output a file directly or show a listing of them.
Definition: SpecialUploadStash.php:67
SpecialUploadStash\outputLocalFile
outputLocalFile(File $file)
Output HTTP response for file Side effect: writes HTTP response to STDOUT.
Definition: SpecialUploadStash.php:302
HttpError
Show an error that looks like an HTTP server error.
Definition: HttpError.php:30
php
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
DerivativeContext
An IContextSource implementation which will inherit context from another source but allow individual ...
Definition: DerivativeContext.php:30
File
Implements some public methods and some protected utility functions which are required by multiple ch...
Definition: File.php:51
SpecialPage\getConfig
getConfig()
Shortcut to get main config object.
Definition: SpecialPage.php:761
SpecialUploadStash
Web access for files temporarily stored by UploadStash.
Definition: SpecialUploadStash.php:36
SpecialUploadStash\parseKey
parseKey( $key)
Parse the key passed to the SpecialPage.
Definition: SpecialUploadStash.php:128
HTMLForm\factory
static factory( $displayFormat)
Construct a HTMLForm object for given display type.
Definition: HTMLForm.php:279
UploadStashZeroLengthFileException
Definition: UploadStash.php:817
SpecialUploadStash\doesWrites
doesWrites()
Indicates whether this special page may perform database writes.
Definition: SpecialUploadStash.php:56
SpecialUploadStash\outputFileHeaders
static outputFileHeaders( $contentType, $size)
Output headers for streaming.
Definition: SpecialUploadStash.php:347
SpecialPage\setHeaders
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
Definition: SpecialPage.php:527
SpecialPage\getUser
getUser()
Shortcut to get the User executing this instance.
Definition: SpecialPage.php:732
wfDebug
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
Definition: GlobalFunctions.php:994
SpecialPage\getContext
getContext()
Gets the context this SpecialPage is executed in.
Definition: SpecialPage.php:695
SpecialUploadStash\MAX_SERVE_BYTES
const MAX_SERVE_BYTES
Since we are directly writing the file to STDOUT, we should not be reading in really big files and se...
Definition: SpecialUploadStash.php:50
StatusValue\newGood
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
UploadStashFileNotFoundException
Definition: UploadStash.php:799
SpecialUploadStash\outputLocallyScaledThumb
outputLocallyScaledThumb( $file, $params, $flags)
Scale a file (probably with a locally installed imagemagick, or similar) and output it to STDOUT.
Definition: SpecialUploadStash.php:194
$status
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
SpecialUploadStash\showUploads
showUploads()
Default action when we don't have a subpage – just show links to the uploads we have,...
Definition: SpecialUploadStash.php:383
$req
this hook is for auditing only $req
Definition: hooks.txt:990
File\RENDER_NOW
const RENDER_NOW
Force rendering in the current process.
Definition: File.php:59
SpecialPage\getLinkRenderer
getLinkRenderer()
Definition: SpecialPage.php:907
print
print
Definition: opensearch_desc.php:46
$code
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
SpecialUploadStash\__construct
__construct()
Definition: SpecialUploadStash.php:52
as
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
Html\rawElement
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition: Html.php:209
SpecialUploadStash\outputThumbFromStash
outputThumbFromStash( $file, $params)
Get a thumbnail for file, either generated locally or remotely, and stream it out.
Definition: SpecialUploadStash.php:171
File\getRepo
getRepo()
Returns the repository.
Definition: File.php:1874
SpecialPage\$linkRenderer
MediaWiki Linker LinkRenderer null $linkRenderer
Definition: SpecialPage.php:66
SpecialUploadStash\outputContents
outputContents( $content, $contentType)
Output HTTP response of raw content Side effect: writes HTTP response to STDOUT.
Definition: SpecialUploadStash.php:323
Html\element
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:231
SpecialUploadStashTooLargeException
Definition: SpecialUploadStash.php:455
$context
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 and they can depend only on the ResourceLoaderContext $context
Definition: hooks.txt:2811
SpecialPage\outputHeader
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
SpecialUploadStash\showUpload
showUpload( $key)
If file available in stash, cats it out to the client as a simple HTTP response.
Definition: SpecialUploadStash.php:88
File\getSize
getSize()
Return the size of the image file, in bytes Overridden by LocalFile, UnregisteredLocalFile STUB.
Definition: File.php:715
MWHttpRequest\factory
static factory( $url, array $options=null, $caller=__METHOD__)
Generate a new request object Deprecated:
Definition: MWHttpRequest.php:184
wfExpandUrl
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
Definition: GlobalFunctions.php:521
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2171
UploadStashException
Definition: UploadStash.php:773
$type
$type
Definition: testCompression.php:48