MediaWiki REL1_27
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 );
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 // Bug 53032 - 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 = '';
394 foreach ( $files as $file ) {
395 $itemHtml = Linker::linkKnown( $this->getPageTitle( "file/$file" ), htmlspecialchars( $file ) );
396 try {
397 $fileObj = $this->stash->getFile( $file );
398 $thumb = $fileObj->generateThumbName( $file, [ 'width' => 220 ] );
399 $itemHtml .=
400 $this->msg( 'word-separator' )->escaped() .
401 $this->msg( 'parentheses' )->rawParams(
403 $this->getPageTitle( "thumb/$file/$thumb" ),
404 $this->msg( 'uploadstash-thumbnail' )->escaped()
405 )
406 )->escaped();
407 } catch ( Exception $e ) {
408 }
409 $fileListItemsHtml .= Html::rawElement( 'li', [], $itemHtml );
410 }
411 $this->getOutput()->addHTML( Html::rawElement( 'ul', [], $fileListItemsHtml ) );
412 $form->displayForm( $formResult );
413 $this->getOutput()->addHTML( Html::rawElement( 'p', [], $refreshHtml ) );
414 } else {
415 $this->getOutput()->addHTML( Html::rawElement( 'p', [],
416 Html::element( 'span', [], $this->msg( 'uploadstash-nofiles' )->text() )
417 . ' '
418 . $refreshHtml
419 ) );
420 }
421
422 return true;
423 }
424}
425
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:50
const RENDER_NOW
Force rendering in the current process.
Definition File.php:58
getPath()
Return the storage path to the file.
Definition File.php:416
getSize()
Return the size of the image file, in bytes Overridden by LocalFile, UnregisteredLocalFile STUB.
Definition File.php:695
getRepo()
Returns the repository.
Definition File.php:1854
static factory( $displayFormat)
Construct a HTMLForm object for given display type.
Definition HTMLForm.php:264
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition Html.php:230
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
Definition Html.php:210
Show an error that looks like an HTTP server error.
Definition HttpError.php:30
static linkKnown( $target, $html=null, $customAttribs=[], $query=[], $options=[ 'known', 'noclasses'])
Identical to link(), except $options defaults to 'known'.
Definition Linker.php:264
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.
getConfig()
Shortcut to get main config object.
getPageTitle( $subpage=false)
Get a self-referential title object.
useTransactionalTimeLimit()
Call wfTransactionalTimeLimit() if this request was POSTed.
msg()
Wrapper around wfMessage that sets the current context.
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...
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 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
while(( $__line=Maintenance::readconsole()) !==false) print
Definition eval.php:64
const PROTO_CANONICAL
Definition Defines.php:266
this hook is for auditing only $req
Definition hooks.txt:968
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition hooks.txt:1007
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content $content
Definition hooks.txt:1040
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition hooks.txt:2413
it s the revision text itself In either if gzip is the revision text is gzipped $flags
Definition hooks.txt:2555
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:885
returning false will NOT prevent logging $e
Definition hooks.txt:1940
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:847
$files
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
$context
Definition load.php:44
$params