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