Switch some HTMLForms in special pages to OOUI
[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 $success = $img->getRepo()->streamFile( $thumbPath, $headers );
305 if ( !$success ) {
306 wfThumbError( 500, 'Could not stream the file' );
307 }
308 return;
309 }
310
311 $user = RequestContext::getMain()->getUser();
312 if ( !wfThumbIsStandard( $img, $params ) && $user->pingLimiter( 'renderfile-nonstandard' ) ) {
313 wfThumbError( 500, wfMessage( 'actionthrottledtext' )->parse() );
314 return;
315 } elseif ( $user->pingLimiter( 'renderfile' ) ) {
316 wfThumbError( 500, wfMessage( 'actionthrottledtext' )->parse() );
317 return;
318 }
319
320 // Actually generate a new thumbnail
321 list( $thumb, $errorMsg ) = wfGenerateThumbnail( $img, $params, $thumbName, $thumbPath );
322 /** @var MediaTransformOutput|bool $thumb */
323
324 // Check for thumbnail generation errors...
325 $msg = wfMessage( 'thumbnail_error' );
326 $errorCode = 500;
327 if ( !$thumb ) {
328 $errorMsg = $errorMsg ?: $msg->rawParams( 'File::transform() returned false' )->escaped();
329 } elseif ( $thumb->isError() ) {
330 $errorMsg = $thumb->getHtmlMsg();
331 } elseif ( !$thumb->hasFile() ) {
332 $errorMsg = $msg->rawParams( 'No path supplied in thumbnail object' )->escaped();
333 } elseif ( $thumb->fileIsSource() ) {
334 $errorMsg = $msg->
335 rawParams( 'Image was not scaled, is the requested width bigger than the source?' )->escaped();
336 $errorCode = 400;
337 }
338
339 if ( $errorMsg !== false ) {
340 wfThumbError( $errorCode, $errorMsg );
341 } else {
342 // Stream the file if there were no errors
343 $success = $thumb->streamFile( $headers );
344 if ( !$success ) {
345 wfThumbError( 500, 'Could not stream the file' );
346 }
347 }
348 }
349
350 /**
351 * Actually try to generate a new thumbnail
352 *
353 * @param File $file
354 * @param array $params
355 * @param string $thumbName
356 * @param string $thumbPath
357 * @return array (MediaTransformOutput|bool, string|bool error message HTML)
358 */
359 function wfGenerateThumbnail( File $file, array $params, $thumbName, $thumbPath ) {
360 global $wgMemc, $wgAttemptFailureEpoch;
361
362 $key = wfMemcKey( 'attempt-failures', $wgAttemptFailureEpoch,
363 $file->getRepo()->getName(), $file->getSha1(), md5( $thumbName ) );
364
365 // Check if this file keeps failing to render
366 if ( $wgMemc->get( $key ) >= 4 ) {
367 return array( false, wfMessage( 'thumbnail_image-failure-limit', 4 ) );
368 }
369
370 $done = false;
371 // Record failures on PHP fatals in addition to caching exceptions
372 register_shutdown_function( function () use ( &$done, $key ) {
373 if ( !$done ) { // transform() gave a fatal
374 global $wgMemc;
375 // Randomize TTL to reduce stampedes
376 $wgMemc->incrWithInit( $key, 3600 + mt_rand( 0, 300 ) );
377 }
378 } );
379
380 $thumb = false;
381 $errorHtml = false;
382
383 // guard thumbnail rendering with PoolCounter to avoid stampedes
384 // expensive files use a separate PoolCounter config so it is possible
385 // to set up a global limit on them
386 if ( $file->isExpensiveToThumbnail() ) {
387 $poolCounterType = 'FileRenderExpensive';
388 } else {
389 $poolCounterType = 'FileRender';
390 }
391
392 // Thumbnail isn't already there, so create the new thumbnail...
393 try {
394 $work = new PoolCounterWorkViaCallback( $poolCounterType, sha1( $file->getName() ),
395 array(
396 'doWork' => function () use ( $file, $params ) {
397 return $file->transform( $params, File::RENDER_NOW );
398 },
399 'getCachedWork' => function () use ( $file, $params, $thumbPath ) {
400 // If the worker that finished made this thumbnail then use it.
401 // Otherwise, it probably made a different thumbnail for this file.
402 return $file->getRepo()->fileExists( $thumbPath )
403 ? $file->transform( $params, File::RENDER_NOW )
404 : false; // retry once more in exclusive mode
405 },
406 'fallback' => function () {
407 return wfMessage( 'generic-pool-error' )->parse();
408 },
409 'error' => function ( $status ) {
410 return $status->getHTML();
411 }
412 )
413 );
414 $result = $work->execute();
415 if ( $result instanceof MediaTransformOutput ) {
416 $thumb = $result;
417 } elseif ( is_string( $result ) ) { // error
418 $errorHtml = $result;
419 }
420 } catch ( Exception $e ) {
421 // Tried to select a page on a non-paged file?
422 }
423
424 $done = true; // no PHP fatal occured
425
426 if ( !$thumb || $thumb->isError() ) {
427 // Randomize TTL to reduce stampedes
428 $wgMemc->incrWithInit( $key, 3600 + mt_rand( 0, 300 ) );
429 }
430
431 return array( $thumb, $errorHtml );
432 }
433
434 /**
435 * Convert pathinfo type parameter, into normal request parameters
436 *
437 * So for example, if the request was redirected from
438 * /w/images/thumb/a/ab/Foo.png/120px-Foo.png. The $thumbRel parameter
439 * of this function would be set to "a/ab/Foo.png/120px-Foo.png".
440 * This method is responsible for turning that into an array
441 * with the folowing keys:
442 * * f => the filename (Foo.png)
443 * * rel404 => the whole thing (a/ab/Foo.png/120px-Foo.png)
444 * * archived => 1 (If the request is for an archived thumb)
445 * * temp => 1 (If the file is in the "temporary" zone)
446 * * thumbName => the thumbnail name, including parameters (120px-Foo.png)
447 *
448 * Transform specific parameters are set later via wfExtractThumbParams().
449 *
450 * @param string $thumbRel Thumbnail path relative to the thumb zone
451 * @return array|null Associative params array or null
452 */
453 function wfExtractThumbRequestInfo( $thumbRel ) {
454 $repo = RepoGroup::singleton()->getLocalRepo();
455
456 $hashDirReg = $subdirReg = '';
457 $hashLevels = $repo->getHashLevels();
458 for ( $i = 0; $i < $hashLevels; $i++ ) {
459 $subdirReg .= '[0-9a-f]';
460 $hashDirReg .= "$subdirReg/";
461 }
462
463 // Check if this is a thumbnail of an original in the local file repo
464 if ( preg_match( "!^((archive/)?$hashDirReg([^/]*)/([^/]*))$!", $thumbRel, $m ) ) {
465 list( /*all*/, $rel, $archOrTemp, $filename, $thumbname ) = $m;
466 // Check if this is a thumbnail of an temp file in the local file repo
467 } elseif ( preg_match( "!^(temp/)($hashDirReg([^/]*)/([^/]*))$!", $thumbRel, $m ) ) {
468 list( /*all*/, $archOrTemp, $rel, $filename, $thumbname ) = $m;
469 } else {
470 return null; // not a valid looking thumbnail request
471 }
472
473 $params = array( 'f' => $filename, 'rel404' => $rel );
474 if ( $archOrTemp === 'archive/' ) {
475 $params['archived'] = 1;
476 } elseif ( $archOrTemp === 'temp/' ) {
477 $params['temp'] = 1;
478 }
479
480 $params['thumbName'] = $thumbname;
481 return $params;
482 }
483
484 /**
485 * Convert a thumbnail name (122px-foo.png) to parameters, using
486 * file handler.
487 *
488 * @param File $file File object for file in question
489 * @param array $params Array of parameters so far
490 * @return array Parameters array with more parameters
491 */
492 function wfExtractThumbParams( $file, $params ) {
493 if ( !isset( $params['thumbName'] ) ) {
494 throw new MWException( "No thumbnail name passed to wfExtractThumbParams" );
495 }
496
497 $thumbname = $params['thumbName'];
498 unset( $params['thumbName'] );
499
500 // Do the hook first for older extensions that rely on it.
501 if ( !Hooks::run( 'ExtractThumbParameters', array( $thumbname, &$params ) ) ) {
502 // Check hooks if parameters can be extracted
503 // Hooks return false if they manage to *resolve* the parameters
504 // This hook should be considered deprecated
505 wfDeprecated( 'ExtractThumbParameters', '1.22' );
506 return $params; // valid thumbnail URL (via extension or config)
507 }
508
509 // FIXME: Files in the temp zone don't set a MIME type, which means
510 // they don't have a handler. Which means we can't parse the param
511 // string. However, not a big issue as what good is a param string
512 // if you have no handler to make use of the param string and
513 // actually generate the thumbnail.
514 $handler = $file->getHandler();
515
516 // Based on UploadStash::parseKey
517 $fileNamePos = strrpos( $thumbname, $params['f'] );
518 if ( $fileNamePos === false ) {
519 // Maybe using a short filename? (see FileRepo::nameForThumb)
520 $fileNamePos = strrpos( $thumbname, 'thumbnail' );
521 }
522
523 if ( $handler && $fileNamePos !== false ) {
524 $paramString = substr( $thumbname, 0, $fileNamePos - 1 );
525 $extraParams = $handler->parseParamString( $paramString );
526 if ( $extraParams !== false ) {
527 return $params + $extraParams;
528 }
529 }
530
531 // As a last ditch fallback, use the traditional common parameters
532 if ( preg_match( '!^(page(\d*)-)*(\d*)px-[^/]*$!', $thumbname, $matches ) ) {
533 list( /* all */, $pagefull, $pagenum, $size ) = $matches;
534 $params['width'] = $size;
535 if ( $pagenum ) {
536 $params['page'] = $pagenum;
537 }
538 return $params; // valid thumbnail URL
539 }
540 return null;
541 }
542
543 /**
544 * Output a thumbnail generation error message
545 *
546 * @param int $status
547 * @param string $msg HTML
548 * @return void
549 */
550 function wfThumbError( $status, $msg ) {
551 global $wgShowHostnames;
552
553 header( 'Cache-Control: no-cache' );
554 header( 'Content-Type: text/html; charset=utf-8' );
555 if ( $status == 400 ) {
556 HttpStatus::header( 400 );
557 } elseif ( $status == 404 ) {
558 HttpStatus::header( 404 );
559 } elseif ( $status == 403 ) {
560 HttpStatus::header( 403 );
561 header( 'Vary: Cookie' );
562 } else {
563 HttpStatus::header( 500 );
564 }
565 if ( $wgShowHostnames ) {
566 header( 'X-MW-Thumbnail-Renderer: ' . wfHostname() );
567 $url = htmlspecialchars( isset( $_SERVER['REQUEST_URI'] ) ? $_SERVER['REQUEST_URI'] : '' );
568 $hostname = htmlspecialchars( wfHostname() );
569 $debug = "<!-- $url -->\n<!-- $hostname -->\n";
570 } else {
571 $debug = '';
572 }
573 echo <<<EOT
574 <!DOCTYPE html>
575 <html><head>
576 <meta charset="UTF-8" />
577 <title>Error generating thumbnail</title>
578 </head>
579 <body>
580 <h1>Error generating thumbnail</h1>
581 <p>
582 $msg
583 </p>
584 $debug
585 </body>
586 </html>
587
588 EOT;
589 }