MediaWiki REL1_30
SpecialUploadStash.php
Go to the documentation of this file.
1<?php
36 // UploadStash
37 private $stash;
38
49 const MAX_SERVE_BYTES = 1048576; // 1MB
50
51 public function __construct() {
52 parent::__construct( 'UploadStash', 'upload' );
53 }
54
55 public function doesWrites() {
56 return true;
57 }
58
66 public function execute( $subPage ) {
68
69 $this->stash = RepoGroup::singleton()->getLocalRepo()->getUploadStash( $this->getUser() );
70 $this->checkPermissions();
71
72 if ( $subPage === null || $subPage === '' ) {
73 return $this->showUploads();
74 }
75
76 return $this->showUpload( $subPage );
77 }
78
87 public function showUpload( $key ) {
88 // prevent callers from doing standard HTML output -- we'll take it from here
89 $this->getOutput()->disable();
90
91 try {
92 $params = $this->parseKey( $key );
93 if ( $params['type'] === 'thumb' ) {
94 return $this->outputThumbFromStash( $params['file'], $params['params'] );
95 } else {
96 return $this->outputLocalFile( $params['file'] );
97 }
99 $code = 404;
100 $message = $e->getMessage();
102 $code = 500;
103 $message = $e->getMessage();
104 } catch ( UploadStashBadPathException $e ) {
105 $code = 500;
106 $message = $e->getMessage();
108 $code = 500;
109 $message = 'Cannot serve a file larger than ' . self::MAX_SERVE_BYTES .
110 ' bytes. ' . $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( "Unknown type '$type'" );
133 }
134 $fileName = strtok( '/' );
135 $thumbPart = strtok( '/' );
136 $file = $this->stash->getFile( $fileName );
137 if ( $type === 'thumb' ) {
138 $srcNamePos = strrpos( $thumbPart, $fileName );
139 if ( $srcNamePos === false || $srcNamePos < 1 ) {
140 throw new UploadStashBadPathException( 'Unrecognized thumb name' );
141 }
142 $paramString = substr( $thumbPart, 0, $srcNamePos - 1 );
143
144 $handler = $file->getHandler();
145 if ( $handler ) {
146 $params = $handler->parseParamString( $paramString );
147
148 return [ 'file' => $file, 'type' => $type, 'params' => $params ];
149 } else {
150 throw new UploadStashBadPathException( 'No handler found for ' .
151 "mime {$file->getMimeType()} of file {$file->getPath()}" );
152 }
153 }
154
155 return [ 'file' => $file, 'type' => $type ];
156 }
157
166 private function outputThumbFromStash( $file, $params ) {
167 $flags = 0;
168 // this config option, if it exists, points to a "scaler", as you might find in
169 // the Wikimedia Foundation cluster. See outputRemoteScaledThumb(). This
170 // is part of our horrible NFS-based system, we create a file on a mount
171 // point here, but fetch the scaled file from somewhere else that
172 // happens to share it over NFS.
173 if ( $this->getConfig()->get( 'UploadStashScalerBaseUrl' ) ) {
174 $this->outputRemoteScaledThumb( $file, $params, $flags );
175 } else {
176 $this->outputLocallyScaledThumb( $file, $params, $flags );
177 }
178 }
179
189 private function outputLocallyScaledThumb( $file, $params, $flags ) {
190 // n.b. this is stupid, we insist on re-transforming the file every time we are invoked. We rely
191 // on HTTP caching to ensure this doesn't happen.
192
194
195 $thumbnailImage = $file->transform( $params, $flags );
196 if ( !$thumbnailImage ) {
197 throw new MWException( 'Could not obtain thumbnail' );
198 }
199
200 // we should have just generated it locally
201 if ( !$thumbnailImage->getStoragePath() ) {
202 throw new UploadStashFileNotFoundException( "no local path for scaled item" );
203 }
204
205 // now we should construct a File, so we can get MIME and other such info in a standard way
206 // n.b. MIME type may be different from original (ogx original -> jpeg thumb)
207 $thumbFile = new UnregisteredLocalFile( false,
208 $this->stash->repo, $thumbnailImage->getStoragePath(), false );
209 if ( !$thumbFile ) {
210 throw new UploadStashFileNotFoundException( "couldn't create local file object for thumbnail" );
211 }
212
213 return $this->outputLocalFile( $thumbFile );
214 }
215
235 private function outputRemoteScaledThumb( $file, $params, $flags ) {
236 // This option probably looks something like
237 // '//upload.wikimedia.org/wikipedia/test/thumb/temp'. Do not use
238 // trailing slash.
239 $scalerBaseUrl = $this->getConfig()->get( 'UploadStashScalerBaseUrl' );
240
241 if ( preg_match( '/^\/\//', $scalerBaseUrl ) ) {
242 // this is apparently a protocol-relative URL, which makes no sense in this context,
243 // since this is used for communication that's internal to the application.
244 // default to http.
245 $scalerBaseUrl = wfExpandUrl( $scalerBaseUrl, PROTO_CANONICAL );
246 }
247
248 // We need to use generateThumbName() instead of thumbName(), because
249 // the suffix needs to match the file name for the remote thumbnailer
250 // to work
251 $scalerThumbName = $file->generateThumbName( $file->getName(), $params );
252 $scalerThumbUrl = $scalerBaseUrl . '/' . $file->getUrlRel() .
253 '/' . rawurlencode( $scalerThumbName );
254
255 // make a curl call to the scaler to create a thumbnail
256 $httpOptions = [
257 'method' => 'GET',
258 'timeout' => 5 // T90599 attempt to time out cleanly
259 ];
260 $req = MWHttpRequest::factory( $scalerThumbUrl, $httpOptions, __METHOD__ );
261 $status = $req->execute();
262 if ( !$status->isOK() ) {
263 $errors = $status->getErrorsArray();
264 $errorStr = "Fetching thumbnail failed: " . print_r( $errors, 1 );
265 $errorStr .= "\nurl = $scalerThumbUrl\n";
266 throw new MWException( $errorStr );
267 }
268 $contentType = $req->getResponseHeader( "content-type" );
269 if ( !$contentType ) {
270 throw new MWException( "Missing content-type header" );
271 }
272
273 return $this->outputContents( $req->getContent(), $contentType );
274 }
275
285 private function outputLocalFile( File $file ) {
286 if ( $file->getSize() > self::MAX_SERVE_BYTES ) {
288 }
289
290 return $file->getRepo()->streamFile( $file->getPath(),
291 [ 'Content-Transfer-Encoding: binary',
292 'Expires: Sun, 17-Jan-2038 19:14:07 GMT' ]
293 );
294 }
295
304 private function outputContents( $content, $contentType ) {
305 $size = strlen( $content );
306 if ( $size > self::MAX_SERVE_BYTES ) {
308 }
309 // Cancel output buffering and gzipping if set
311 self::outputFileHeaders( $contentType, $size );
312 print $content;
313
314 return true;
315 }
316
326 private static function outputFileHeaders( $contentType, $size ) {
327 header( "Content-Type: $contentType", true );
328 header( 'Content-Transfer-Encoding: binary', true );
329 header( 'Expires: Sun, 17-Jan-2038 19:14:07 GMT', true );
330 // T55032 - It shouldn't be a problem here, but let's be safe and not cache
331 header( 'Cache-Control: private' );
332 header( "Content-Length: $size", true );
333 }
334
344 public static function tryClearStashedUploads( $formData, $form ) {
345 if ( isset( $formData['Clear'] ) ) {
346 $stash = RepoGroup::singleton()->getLocalRepo()->getUploadStash( $form->getUser() );
347 wfDebug( 'stash has: ' . print_r( $stash->listFiles(), true ) . "\n" );
348
349 if ( !$stash->clear() ) {
350 return Status::newFatal( 'uploadstash-errclear' );
351 }
352 }
353
354 return Status::newGood();
355 }
356
362 private function showUploads() {
363 // sets the title, etc.
364 $this->setHeaders();
365 $this->outputHeader();
366
367 // create the form, which will also be used to execute a callback to process incoming form data
368 // this design is extremely dubious, but supposedly HTMLForm is our standard now?
369
370 $context = new DerivativeContext( $this->getContext() );
371 $context->setTitle( $this->getPageTitle() ); // Remove subpage
372 $form = HTMLForm::factory( 'ooui', [
373 'Clear' => [
374 'type' => 'hidden',
375 'default' => true,
376 'name' => 'clear',
377 ]
378 ], $context, 'clearStashedUploads' );
379 $form->setSubmitDestructive();
380 $form->setSubmitCallback( [ __CLASS__, 'tryClearStashedUploads' ] );
381 $form->setSubmitTextMsg( 'uploadstash-clear' );
382
383 $form->prepareForm();
384 $formResult = $form->tryAuthorizedSubmit();
385
386 // show the files + form, if there are any, or just say there are none
387 $refreshHtml = Html::element( 'a',
388 [ 'href' => $this->getPageTitle()->getLocalURL() ],
389 $this->msg( 'uploadstash-refresh' )->text() );
390 $files = $this->stash->listFiles();
391 if ( $files && count( $files ) ) {
392 sort( $files );
393 $fileListItemsHtml = '';
395 foreach ( $files as $file ) {
396 $itemHtml = $linkRenderer->makeKnownLink(
397 $this->getPageTitle( "file/$file" ),
398 $file
399 );
400 try {
401 $fileObj = $this->stash->getFile( $file );
402 $thumb = $fileObj->generateThumbName( $file, [ 'width' => 220 ] );
403 $itemHtml .=
404 $this->msg( 'word-separator' )->escaped() .
405 $this->msg( 'parentheses' )->rawParams(
406 $linkRenderer->makeKnownLink(
407 $this->getPageTitle( "thumb/$file/$thumb" ),
408 $this->msg( 'uploadstash-thumbnail' )->text()
409 )
410 )->escaped();
411 } catch ( Exception $e ) {
412 }
413 $fileListItemsHtml .= Html::rawElement( 'li', [], $itemHtml );
414 }
415 $this->getOutput()->addHTML( Html::rawElement( 'ul', [], $fileListItemsHtml ) );
416 $form->displayForm( $formResult );
417 $this->getOutput()->addHTML( Html::rawElement( 'p', [], $refreshHtml ) );
418 } else {
419 $this->getOutput()->addHTML( Html::rawElement( 'p', [],
420 Html::element( 'span', [], $this->msg( 'uploadstash-nofiles' )->text() )
421 . ' '
422 . $refreshHtml
423 ) );
424 }
425
426 return true;
427 }
428}
429
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
wfResetOutputBuffers( $resetGzipEncoding=true)
Clear away any user-level output buffers, discarding contents.
An IContextSource implementation which will inherit context from another source but allow individual ...
Implements some public methods and some protected utility functions which are required by multiple ch...
Definition File.php:51
const RENDER_NOW
Force rendering in the current process.
Definition File.php:59
static factory( $displayFormat)
Construct a HTMLForm object for given display type.
Definition HTMLForm.php:277
Show an error that looks like an HTTP server error.
Definition HttpError.php:30
MediaWiki exception.
static singleton()
Get a RepoGroup instance.
Definition RepoGroup.php:59
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
getOutput()
Get the OutputPage being used for this instance.
getUser()
Shortcut to get the User executing this instance.
checkPermissions()
Checks if userCanExecute, and if not throws a PermissionsError.
getContext()
Gets the context this SpecialPage is executed in.
msg( $key)
Wrapper around wfMessage that sets the current context.
getConfig()
Shortcut to get main config object.
getPageTitle( $subpage=false)
Get a self-referential title object.
useTransactionalTimeLimit()
Call wfTransactionalTimeLimit() if this request was POSTed.
MediaWiki Linker LinkRenderer null $linkRenderer
Web access for files temporarily stored by UploadStash.
static outputFileHeaders( $contentType, $size)
Output headers for streaming.
outputLocalFile(File $file)
Output HTTP response for file Side effect: writes HTTP response to STDOUT.
outputThumbFromStash( $file, $params)
Get a thumbnail for file, either generated locally or remotely, and stream it out.
showUploads()
Default action when we don't have a subpage – just show links to the uploads we have,...
parseKey( $key)
Parse the key passed to the SpecialPage.
showUpload( $key)
If file available in stash, cats it out to the client as a simple HTTP response.
outputRemoteScaledThumb( $file, $params, $flags)
Scale a file with a remote "scaler", as exists on the Wikimedia Foundation cluster,...
const MAX_SERVE_BYTES
Since we are directly writing the file to STDOUT, we should not be reading in really big files and se...
execute( $subPage)
Execute page – can output a file directly or show a listing of them.
doesWrites()
Indicates whether this special page may perform database writes.
static tryClearStashedUploads( $formData, $form)
Static callback for the HTMLForm in showUploads, to process Note the stash has to be recreated since ...
outputLocallyScaledThumb( $file, $params, $flags)
Scale a file (probably with a locally installed imagemagick, or similar) and output it to STDOUT.
outputContents( $content, $contentType)
Output HTTP response of raw content Side effect: writes HTTP response to STDOUT.
Shortcut to construct a special page which is unlisted by default.
A file object referring to either a standalone local file, or a file in a local repository with no da...
print
Definition cleanup.php:99
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
this hook is for auditing only $req
Definition hooks.txt:988
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:863
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:2780
it s the revision text itself In either if gzip is the revision text is gzipped $flags
Definition hooks.txt:2805
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). '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:1049
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:901
returning false will NOT prevent logging $e
Definition hooks.txt:2146
const PROTO_CANONICAL
Definition Defines.php:224
$params