Increase $wgSVGMaxSize to 5120 pixels wide (previously 2048).
[lhc/web/wiklou.git] / thumb.php
1 <?php
2 /**
3 * PHP script to stream out an image thumbnail.
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
19 *
20 * @file
21 * @ingroup Media
22 */
23
24 define( 'MW_NO_OUTPUT_COMPRESSION', 1 );
25 require __DIR__ . '/includes/WebStart.php';
26
27 // Don't use fancy MIME detection, just check the file extension for jpg/gif/png
28 $wgTrivialMimeDetection = true;
29
30 if ( defined( 'THUMB_HANDLER' ) ) {
31 // Called from thumb_handler.php via 404; extract params from the URI...
32 wfThumbHandle404();
33 } else {
34 // Called directly, use $_GET params
35 wfStreamThumb( $_GET );
36 }
37
38 $mediawiki = new MediaWiki();
39 $mediawiki->doPostOutputShutdown( 'fast' );
40
41 //--------------------------------------------------------------------------
42
43 /**
44 * Handle a thumbnail request via thumbnail file URL
45 *
46 * @return void
47 */
48 function wfThumbHandle404() {
49 global $wgArticlePath;
50
51 # Set action base paths so that WebRequest::getPathInfo()
52 # recognizes the "X" as the 'title' in ../thumb_handler.php/X urls.
53 # Note: If Custom per-extension repo paths are set, this may break.
54 $repo = RepoGroup::singleton()->getLocalRepo();
55 $oldArticlePath = $wgArticlePath;
56 $wgArticlePath = $repo->getZoneUrl( 'thumb' ) . '/$1';
57
58 $matches = WebRequest::getPathInfo();
59
60 $wgArticlePath = $oldArticlePath;
61
62 if ( !isset( $matches['title'] ) ) {
63 wfThumbError( 404, 'Could not determine the name of the requested thumbnail.' );
64 return;
65 }
66
67 $params = wfExtractThumbRequestInfo( $matches['title'] ); // basic wiki URL param extracting
68 if ( $params == null ) {
69 wfThumbError( 400, 'The specified thumbnail parameters are not recognized.' );
70 return;
71 }
72
73 wfStreamThumb( $params ); // stream the thumbnail
74 }
75
76 /**
77 * Stream a thumbnail specified by parameters
78 *
79 * @param array $params List of thumbnailing parameters. In addition to parameters
80 * passed to the MediaHandler, this may also includes the keys:
81 * f (for filename), archived (if archived file), temp (if temp file),
82 * w (alias for width), p (alias for page), r (ignored; historical),
83 * rel404 (path for render on 404 to verify hash path correct),
84 * thumbName (thumbnail name to potentially extract more parameters from
85 * e.g. 'lossy-page1-120px-Foo.tiff' would add page, lossy and width
86 * to the parameters)
87 * @return void
88 */
89 function wfStreamThumb( array $params ) {
90 global $wgVaryOnXFP;
91
92 $headers = array(); // HTTP headers to send
93
94 $fileName = isset( $params['f'] ) ? $params['f'] : '';
95
96 // Backwards compatibility parameters
97 if ( isset( $params['w'] ) ) {
98 $params['width'] = $params['w'];
99 unset( $params['w'] );
100 }
101 if ( isset( $params['width'] ) && substr( $params['width'], -2 ) == 'px' ) {
102 // strip the px (pixel) suffix, if found
103 $params['width'] = substr( $params['width'], 0, -2 );
104 }
105 if ( isset( $params['p'] ) ) {
106 $params['page'] = $params['p'];
107 }
108
109 // Is this a thumb of an archived file?
110 $isOld = ( isset( $params['archived'] ) && $params['archived'] );
111 unset( $params['archived'] ); // handlers don't care
112
113 // Is this a thumb of a temp file?
114 $isTemp = ( isset( $params['temp'] ) && $params['temp'] );
115 unset( $params['temp'] ); // handlers don't care
116
117 // Some basic input validation
118 $fileName = strtr( $fileName, '\\/', '__' );
119
120 // Actually fetch the image. Method depends on whether it is archived or not.
121 if ( $isTemp ) {
122 $repo = RepoGroup::singleton()->getLocalRepo()->getTempRepo();
123 $img = new UnregisteredLocalFile( null, $repo,
124 # Temp files are hashed based on the name without the timestamp.
125 # The thumbnails will be hashed based on the entire name however.
126 # @todo fix this convention to actually be reasonable.
127 $repo->getZonePath( 'public' ) . '/' . $repo->getTempHashPath( $fileName ) . $fileName
128 );
129 } elseif ( $isOld ) {
130 // Format is <timestamp>!<name>
131 $bits = explode( '!', $fileName, 2 );
132 if ( count( $bits ) != 2 ) {
133 wfThumbError( 404, wfMessage( 'badtitletext' )->parse() );
134 return;
135 }
136 $title = Title::makeTitleSafe( NS_FILE, $bits[1] );
137 if ( !$title ) {
138 wfThumbError( 404, wfMessage( 'badtitletext' )->parse() );
139 return;
140 }
141 $img = RepoGroup::singleton()->getLocalRepo()->newFromArchiveName( $title, $fileName );
142 } else {
143 $img = wfLocalFile( $fileName );
144 }
145
146 // Check the source file title
147 if ( !$img ) {
148 wfThumbError( 404, wfMessage( 'badtitletext' )->parse() );
149 return;
150 }
151
152 // Check permissions if there are read restrictions
153 $varyHeader = array();
154 if ( !in_array( 'read', User::getGroupPermissions( array( '*' ) ), true ) ) {
155 if ( !$img->getTitle() || !$img->getTitle()->userCan( 'read' ) ) {
156 wfThumbError( 403, 'Access denied. You do not have permission to access ' .
157 'the source file.' );
158 return;
159 }
160 $headers[] = 'Cache-Control: private';
161 $varyHeader[] = 'Cookie';
162 }
163
164 // Check if the file is hidden
165 if ( $img->isDeleted( File::DELETED_FILE ) ) {
166 wfThumbError( 404, "The source file '$fileName' does not exist." );
167 return;
168 }
169
170 // Do rendering parameters extraction from thumbnail name.
171 if ( isset( $params['thumbName'] ) ) {
172 $params = wfExtractThumbParams( $img, $params );
173 }
174 if ( $params == null ) {
175 wfThumbError( 400, 'The specified thumbnail parameters are not recognized.' );
176 return;
177 }
178
179 // Check the source file storage path
180 if ( !$img->exists() ) {
181 $redirectedLocation = false;
182 if ( !$isTemp ) {
183 // Check for file redirect
184 // Since redirects are associated with pages, not versions of files,
185 // we look for the most current version to see if its a redirect.
186 $possRedirFile = RepoGroup::singleton()->getLocalRepo()->findFile( $img->getName() );
187 if ( $possRedirFile && !is_null( $possRedirFile->getRedirected() ) ) {
188 $redirTarget = $possRedirFile->getName();
189 $targetFile = wfLocalFile( Title::makeTitleSafe( NS_FILE, $redirTarget ) );
190 if ( $targetFile->exists() ) {
191 $newThumbName = $targetFile->thumbName( $params );
192 if ( $isOld ) {
193 $newThumbUrl = $targetFile->getArchiveThumbUrl(
194 $bits[0] . '!' . $targetFile->getName(), $newThumbName );
195 } else {
196 $newThumbUrl = $targetFile->getThumbUrl( $newThumbName );
197 }
198 $redirectedLocation = wfExpandUrl( $newThumbUrl, PROTO_CURRENT );
199 }
200 }
201 }
202
203 if ( $redirectedLocation ) {
204 // File has been moved. Give redirect.
205 $response = RequestContext::getMain()->getRequest()->response();
206 $response->statusHeader( 302 );
207 $response->header( 'Location: ' . $redirectedLocation );
208 $response->header( 'Expires: ' .
209 gmdate( 'D, d M Y H:i:s', time() + 12 * 3600 ) . ' GMT' );
210 if ( $wgVaryOnXFP ) {
211 $varyHeader[] = 'X-Forwarded-Proto';
212 }
213 if ( count( $varyHeader ) ) {
214 $response->header( 'Vary: ' . implode( ', ', $varyHeader ) );
215 }
216 return;
217 }
218
219 // If its not a redirect that has a target as a local file, give 404.
220 wfThumbError( 404, "The source file '$fileName' does not exist." );
221 return;
222 } elseif ( $img->getPath() === false ) {
223 wfThumbError( 500, "The source file '$fileName' is not locally accessible." );
224 return;
225 }
226
227 // Check IMS against the source file
228 // This means that clients can keep a cached copy even after it has been deleted on the server
229 if ( !empty( $_SERVER['HTTP_IF_MODIFIED_SINCE'] ) ) {
230 // Fix IE brokenness
231 $imsString = preg_replace( '/;.*$/', '', $_SERVER["HTTP_IF_MODIFIED_SINCE"] );
232 // Calculate time
233 MediaWiki\suppressWarnings();
234 $imsUnix = strtotime( $imsString );
235 MediaWiki\restoreWarnings();
236 if ( wfTimestamp( TS_UNIX, $img->getTimestamp() ) <= $imsUnix ) {
237 HttpStatus::header( 304 );
238 return;
239 }
240 }
241
242 $rel404 = isset( $params['rel404'] ) ? $params['rel404'] : null;
243 unset( $params['r'] ); // ignore 'r' because we unconditionally pass File::RENDER
244 unset( $params['f'] ); // We're done with 'f' parameter.
245 unset( $params['rel404'] ); // moved to $rel404
246
247 // Get the normalized thumbnail name from the parameters...
248 try {
249 $thumbName = $img->thumbName( $params );
250 if ( !strlen( $thumbName ) ) { // invalid params?
251 throw new MediaTransformInvalidParametersException( 'Empty return from File::thumbName' );
252 }
253 $thumbName2 = $img->thumbName( $params, File::THUMB_FULL_NAME ); // b/c; "long" style
254 } catch ( MediaTransformInvalidParametersException $e ) {
255 wfThumbError( 400, 'The specified thumbnail parameters are not valid: ' . $e->getMessage() );
256 return;
257 } catch ( MWException $e ) {
258 wfThumbError( 500, $e->getHTML() );
259 return;
260 }
261
262 // For 404 handled thumbnails, we only use the base name of the URI
263 // for the thumb params and the parent directory for the source file name.
264 // Check that the zone relative path matches up so squid caches won't pick
265 // up thumbs that would not be purged on source file deletion (bug 34231).
266 if ( $rel404 !== null ) { // thumbnail was handled via 404
267 if ( rawurldecode( $rel404 ) === $img->getThumbRel( $thumbName ) ) {
268 // Request for the canonical thumbnail name
269 } elseif ( rawurldecode( $rel404 ) === $img->getThumbRel( $thumbName2 ) ) {
270 // Request for the "long" thumbnail name; redirect to canonical name
271 $response = RequestContext::getMain()->getRequest()->response();
272 $response->statusHeader( 301 );
273 $response->header( 'Location: ' .
274 wfExpandUrl( $img->getThumbUrl( $thumbName ), PROTO_CURRENT ) );
275 $response->header( 'Expires: ' .
276 gmdate( 'D, d M Y H:i:s', time() + 7 * 86400 ) . ' GMT' );
277 if ( $wgVaryOnXFP ) {
278 $varyHeader[] = 'X-Forwarded-Proto';
279 }
280 if ( count( $varyHeader ) ) {
281 $response->header( 'Vary: ' . implode( ', ', $varyHeader ) );
282 }
283 return;
284 } else {
285 wfThumbError( 404, "The given path of the specified thumbnail is incorrect;
286 expected '" . $img->getThumbRel( $thumbName ) . "' but got '" .
287 rawurldecode( $rel404 ) . "'." );
288 return;
289 }
290 }
291
292 $dispositionType = isset( $params['download'] ) ? 'attachment' : 'inline';
293
294 // Suggest a good name for users downloading this thumbnail
295 $headers[] = "Content-Disposition: {$img->getThumbDisposition( $thumbName, $dispositionType )}";
296
297 if ( count( $varyHeader ) ) {
298 $headers[] = 'Vary: ' . implode( ', ', $varyHeader );
299 }
300
301 // Stream the file if it exists already...
302 $thumbPath = $img->getThumbPath( $thumbName );
303 if ( $img->getRepo()->fileExists( $thumbPath ) ) {
304 $starttime = microtime( true );
305 $success = $img->getRepo()->streamFile( $thumbPath, $headers );
306 $streamtime = microtime( true ) - $starttime;
307
308 if ( !$success ) {
309 wfThumbError( 500, 'Could not stream the file' );
310 } else {
311 RequestContext::getMain()->getStats()->timing( 'media.thumbnail.stream', $streamtime );
312 }
313 return;
314 }
315
316 $user = RequestContext::getMain()->getUser();
317 if ( !wfThumbIsStandard( $img, $params ) && $user->pingLimiter( 'renderfile-nonstandard' ) ) {
318 wfThumbError( 500, wfMessage( 'actionthrottledtext' )->parse() );
319 return;
320 } elseif ( $user->pingLimiter( 'renderfile' ) ) {
321 wfThumbError( 500, wfMessage( 'actionthrottledtext' )->parse() );
322 return;
323 }
324
325 list( $thumb, $errorMsg ) = wfGenerateThumbnail( $img, $params, $thumbName, $thumbPath );
326
327 /** @var MediaTransformOutput|bool $thumb */
328
329 // Check for thumbnail generation errors...
330 $msg = wfMessage( 'thumbnail_error' );
331 $errorCode = 500;
332 if ( !$thumb ) {
333 $errorMsg = $errorMsg ?: $msg->rawParams( 'File::transform() returned false' )->escaped();
334 } elseif ( $thumb->isError() ) {
335 $errorMsg = $thumb->getHtmlMsg();
336 } elseif ( !$thumb->hasFile() ) {
337 $errorMsg = $msg->rawParams( 'No path supplied in thumbnail object' )->escaped();
338 } elseif ( $thumb->fileIsSource() ) {
339 $errorMsg = $msg->
340 rawParams( 'Image was not scaled, is the requested width bigger than the source?' )->escaped();
341 $errorCode = 400;
342 }
343
344 if ( $errorMsg !== false ) {
345 wfThumbError( $errorCode, $errorMsg );
346 } else {
347 // Stream the file if there were no errors
348 $success = $thumb->streamFile( $headers );
349 if ( !$success ) {
350 wfThumbError( 500, 'Could not stream the file' );
351 }
352 }
353 }
354
355 /**
356 * Actually try to generate a new thumbnail
357 *
358 * @param File $file
359 * @param array $params
360 * @param string $thumbName
361 * @param string $thumbPath
362 * @return array (MediaTransformOutput|bool, string|bool error message HTML)
363 */
364 function wfGenerateThumbnail( File $file, array $params, $thumbName, $thumbPath ) {
365 global $wgMemc, $wgAttemptFailureEpoch;
366
367 $key = wfMemcKey( 'attempt-failures', $wgAttemptFailureEpoch,
368 $file->getRepo()->getName(), $file->getSha1(), md5( $thumbName ) );
369
370 // Check if this file keeps failing to render
371 if ( $wgMemc->get( $key ) >= 4 ) {
372 return array( false, wfMessage( 'thumbnail_image-failure-limit', 4 ) );
373 }
374
375 $done = false;
376 // Record failures on PHP fatals in addition to caching exceptions
377 register_shutdown_function( function () use ( &$done, $key ) {
378 if ( !$done ) { // transform() gave a fatal
379 global $wgMemc;
380 // Randomize TTL to reduce stampedes
381 $wgMemc->incrWithInit( $key, 3600 + mt_rand( 0, 300 ) );
382 }
383 } );
384
385 $thumb = false;
386 $errorHtml = false;
387
388 // guard thumbnail rendering with PoolCounter to avoid stampedes
389 // expensive files use a separate PoolCounter config so it is possible
390 // to set up a global limit on them
391 if ( $file->isExpensiveToThumbnail() ) {
392 $poolCounterType = 'FileRenderExpensive';
393 } else {
394 $poolCounterType = 'FileRender';
395 }
396
397 // Thumbnail isn't already there, so create the new thumbnail...
398 try {
399 $work = new PoolCounterWorkViaCallback( $poolCounterType, sha1( $file->getName() ),
400 array(
401 'doWork' => function () use ( $file, $params ) {
402 return $file->transform( $params, File::RENDER_NOW );
403 },
404 'getCachedWork' => function () use ( $file, $params, $thumbPath ) {
405 // If the worker that finished made this thumbnail then use it.
406 // Otherwise, it probably made a different thumbnail for this file.
407 return $file->getRepo()->fileExists( $thumbPath )
408 ? $file->transform( $params, File::RENDER_NOW )
409 : false; // retry once more in exclusive mode
410 },
411 'fallback' => function () {
412 return wfMessage( 'generic-pool-error' )->parse();
413 },
414 'error' => function ( $status ) {
415 return $status->getHTML();
416 }
417 )
418 );
419 $result = $work->execute();
420 if ( $result instanceof MediaTransformOutput ) {
421 $thumb = $result;
422 } elseif ( is_string( $result ) ) { // error
423 $errorHtml = $result;
424 }
425 } catch ( Exception $e ) {
426 // Tried to select a page on a non-paged file?
427 }
428
429 $done = true; // no PHP fatal occured
430
431 if ( !$thumb || $thumb->isError() ) {
432 // Randomize TTL to reduce stampedes
433 $wgMemc->incrWithInit( $key, 3600 + mt_rand( 0, 300 ) );
434 }
435
436 return array( $thumb, $errorHtml );
437 }
438
439 /**
440 * Convert pathinfo type parameter, into normal request parameters
441 *
442 * So for example, if the request was redirected from
443 * /w/images/thumb/a/ab/Foo.png/120px-Foo.png. The $thumbRel parameter
444 * of this function would be set to "a/ab/Foo.png/120px-Foo.png".
445 * This method is responsible for turning that into an array
446 * with the folowing keys:
447 * * f => the filename (Foo.png)
448 * * rel404 => the whole thing (a/ab/Foo.png/120px-Foo.png)
449 * * archived => 1 (If the request is for an archived thumb)
450 * * temp => 1 (If the file is in the "temporary" zone)
451 * * thumbName => the thumbnail name, including parameters (120px-Foo.png)
452 *
453 * Transform specific parameters are set later via wfExtractThumbParams().
454 *
455 * @param string $thumbRel Thumbnail path relative to the thumb zone
456 * @return array|null Associative params array or null
457 */
458 function wfExtractThumbRequestInfo( $thumbRel ) {
459 $repo = RepoGroup::singleton()->getLocalRepo();
460
461 $hashDirReg = $subdirReg = '';
462 $hashLevels = $repo->getHashLevels();
463 for ( $i = 0; $i < $hashLevels; $i++ ) {
464 $subdirReg .= '[0-9a-f]';
465 $hashDirReg .= "$subdirReg/";
466 }
467
468 // Check if this is a thumbnail of an original in the local file repo
469 if ( preg_match( "!^((archive/)?$hashDirReg([^/]*)/([^/]*))$!", $thumbRel, $m ) ) {
470 list( /*all*/, $rel, $archOrTemp, $filename, $thumbname ) = $m;
471 // Check if this is a thumbnail of an temp file in the local file repo
472 } elseif ( preg_match( "!^(temp/)($hashDirReg([^/]*)/([^/]*))$!", $thumbRel, $m ) ) {
473 list( /*all*/, $archOrTemp, $rel, $filename, $thumbname ) = $m;
474 } else {
475 return null; // not a valid looking thumbnail request
476 }
477
478 $params = array( 'f' => $filename, 'rel404' => $rel );
479 if ( $archOrTemp === 'archive/' ) {
480 $params['archived'] = 1;
481 } elseif ( $archOrTemp === 'temp/' ) {
482 $params['temp'] = 1;
483 }
484
485 $params['thumbName'] = $thumbname;
486 return $params;
487 }
488
489 /**
490 * Convert a thumbnail name (122px-foo.png) to parameters, using
491 * file handler.
492 *
493 * @param File $file File object for file in question
494 * @param array $params Array of parameters so far
495 * @return array Parameters array with more parameters
496 */
497 function wfExtractThumbParams( $file, $params ) {
498 if ( !isset( $params['thumbName'] ) ) {
499 throw new MWException( "No thumbnail name passed to wfExtractThumbParams" );
500 }
501
502 $thumbname = $params['thumbName'];
503 unset( $params['thumbName'] );
504
505 // Do the hook first for older extensions that rely on it.
506 if ( !Hooks::run( 'ExtractThumbParameters', array( $thumbname, &$params ) ) ) {
507 // Check hooks if parameters can be extracted
508 // Hooks return false if they manage to *resolve* the parameters
509 // This hook should be considered deprecated
510 wfDeprecated( 'ExtractThumbParameters', '1.22' );
511 return $params; // valid thumbnail URL (via extension or config)
512 }
513
514 // FIXME: Files in the temp zone don't set a MIME type, which means
515 // they don't have a handler. Which means we can't parse the param
516 // string. However, not a big issue as what good is a param string
517 // if you have no handler to make use of the param string and
518 // actually generate the thumbnail.
519 $handler = $file->getHandler();
520
521 // Based on UploadStash::parseKey
522 $fileNamePos = strrpos( $thumbname, $params['f'] );
523 if ( $fileNamePos === false ) {
524 // Maybe using a short filename? (see FileRepo::nameForThumb)
525 $fileNamePos = strrpos( $thumbname, 'thumbnail' );
526 }
527
528 if ( $handler && $fileNamePos !== false ) {
529 $paramString = substr( $thumbname, 0, $fileNamePos - 1 );
530 $extraParams = $handler->parseParamString( $paramString );
531 if ( $extraParams !== false ) {
532 return $params + $extraParams;
533 }
534 }
535
536 // As a last ditch fallback, use the traditional common parameters
537 if ( preg_match( '!^(page(\d*)-)*(\d*)px-[^/]*$!', $thumbname, $matches ) ) {
538 list( /* all */, $pagefull, $pagenum, $size ) = $matches;
539 $params['width'] = $size;
540 if ( $pagenum ) {
541 $params['page'] = $pagenum;
542 }
543 return $params; // valid thumbnail URL
544 }
545 return null;
546 }
547
548 /**
549 * Output a thumbnail generation error message
550 *
551 * @param int $status
552 * @param string $msg HTML
553 * @return void
554 */
555 function wfThumbError( $status, $msg ) {
556 global $wgShowHostnames;
557
558 header( 'Cache-Control: no-cache' );
559 header( 'Content-Type: text/html; charset=utf-8' );
560 if ( $status == 400 ) {
561 HttpStatus::header( 400 );
562 } elseif ( $status == 404 ) {
563 HttpStatus::header( 404 );
564 } elseif ( $status == 403 ) {
565 HttpStatus::header( 403 );
566 header( 'Vary: Cookie' );
567 } else {
568 HttpStatus::header( 500 );
569 }
570 if ( $wgShowHostnames ) {
571 header( 'X-MW-Thumbnail-Renderer: ' . wfHostname() );
572 $url = htmlspecialchars( isset( $_SERVER['REQUEST_URI'] ) ? $_SERVER['REQUEST_URI'] : '' );
573 $hostname = htmlspecialchars( wfHostname() );
574 $debug = "<!-- $url -->\n<!-- $hostname -->\n";
575 } else {
576 $debug = '';
577 }
578 $content = <<<EOT
579 <!DOCTYPE html>
580 <html><head>
581 <meta charset="UTF-8" />
582 <title>Error generating thumbnail</title>
583 </head>
584 <body>
585 <h1>Error generating thumbnail</h1>
586 <p>
587 $msg
588 </p>
589 $debug
590 </body>
591 </html>
592
593 EOT;
594 header( 'Content-Length: ' . strlen( $content ) );
595 echo $content;
596 }