MediaWiki  master
thumb.php
Go to the documentation of this file.
1 <?php
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
32 
33 if ( defined( 'THUMB_HANDLER' ) ) {
34  // Called from thumb_handler.php via 404; extract params from the URI...
36 } else {
37  // Called directly, use $_GET params
38  wfStreamThumb( $wgRequest->getQueryValues() );
39 }
40 
42 $mediawiki->doPostOutputShutdown( 'fast' );
43 
44 // --------------------------------------------------------------------------
45 
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 
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 
92 function wfStreamThumb( array $params ) {
93  global $wgVaryOnXFP;
94 
95  $headers = []; // HTTP headers to send
96 
97  $fileName = $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  $user = RequestContext::getMain()->getUser();
159  $permissionManager = MediaWikiServices::getInstance()->getPermissionManager();
160  $imgTitle = $img->getTitle();
161 
162  if ( !$imgTitle || !$permissionManager->userCan( 'read', $user, $imgTitle ) ) {
163  wfThumbError( 403, 'Access denied. You do not have permission to access ' .
164  'the source file.' );
165  return;
166  }
167  $headers[] = 'Cache-Control: private';
168  $varyHeader[] = 'Cookie';
169  }
170 
171  // Check if the file is hidden
172  if ( $img->isDeleted( File::DELETED_FILE ) ) {
173  wfThumbErrorText( 404, "The source file '$fileName' does not exist." );
174  return;
175  }
176 
177  // Do rendering parameters extraction from thumbnail name.
178  if ( isset( $params['thumbName'] ) ) {
179  $params = wfExtractThumbParams( $img, $params );
180  }
181  if ( $params == null ) {
182  wfThumbError( 400, 'The specified thumbnail parameters are not recognized.' );
183  return;
184  }
185 
186  // Check the source file storage path
187  if ( !$img->exists() ) {
188  $redirectedLocation = false;
189  if ( !$isTemp ) {
190  // Check for file redirect
191  // Since redirects are associated with pages, not versions of files,
192  // we look for the most current version to see if its a redirect.
193  $possRedirFile = RepoGroup::singleton()->getLocalRepo()->findFile( $img->getName() );
194  if ( $possRedirFile && !is_null( $possRedirFile->getRedirected() ) ) {
195  $redirTarget = $possRedirFile->getName();
196  $targetFile = wfLocalFile( Title::makeTitleSafe( NS_FILE, $redirTarget ) );
197  if ( $targetFile->exists() ) {
198  $newThumbName = $targetFile->thumbName( $params );
199  if ( $isOld ) {
201  $newThumbUrl = $targetFile->getArchiveThumbUrl(
202  $bits[0] . '!' . $targetFile->getName(), $newThumbName );
203  } else {
204  $newThumbUrl = $targetFile->getThumbUrl( $newThumbName );
205  }
206  $redirectedLocation = wfExpandUrl( $newThumbUrl, PROTO_CURRENT );
207  }
208  }
209  }
210 
211  if ( $redirectedLocation ) {
212  // File has been moved. Give redirect.
213  $response = RequestContext::getMain()->getRequest()->response();
214  $response->statusHeader( 302 );
215  $response->header( 'Location: ' . $redirectedLocation );
216  $response->header( 'Expires: ' .
217  gmdate( 'D, d M Y H:i:s', time() + 12 * 3600 ) . ' GMT' );
218  if ( $wgVaryOnXFP ) {
219  $varyHeader[] = 'X-Forwarded-Proto';
220  }
221  if ( count( $varyHeader ) ) {
222  $response->header( 'Vary: ' . implode( ', ', $varyHeader ) );
223  }
224  $response->header( 'Content-Length: 0' );
225  return;
226  }
227 
228  // If its not a redirect that has a target as a local file, give 404.
229  wfThumbErrorText( 404, "The source file '$fileName' does not exist." );
230  return;
231  } elseif ( $img->getPath() === false ) {
232  wfThumbErrorText( 400, "The source file '$fileName' is not locally accessible." );
233  return;
234  }
235 
236  // Check IMS against the source file
237  // This means that clients can keep a cached copy even after it has been deleted on the server
238  if ( !empty( $_SERVER['HTTP_IF_MODIFIED_SINCE'] ) ) {
239  // Fix IE brokenness
240  $imsString = preg_replace( '/;.*$/', '', $_SERVER["HTTP_IF_MODIFIED_SINCE"] );
241  // Calculate time
242  Wikimedia\suppressWarnings();
243  $imsUnix = strtotime( $imsString );
244  Wikimedia\restoreWarnings();
245  if ( wfTimestamp( TS_UNIX, $img->getTimestamp() ) <= $imsUnix ) {
246  HttpStatus::header( 304 );
247  return;
248  }
249  }
250 
251  $rel404 = $params['rel404'] ?? null;
252  unset( $params['r'] ); // ignore 'r' because we unconditionally pass File::RENDER
253  unset( $params['f'] ); // We're done with 'f' parameter.
254  unset( $params['rel404'] ); // moved to $rel404
255 
256  // Get the normalized thumbnail name from the parameters...
257  try {
258  $thumbName = $img->thumbName( $params );
259  if ( !strlen( $thumbName ) ) { // invalid params?
261  'Empty return from File::thumbName'
262  );
263  }
264  $thumbName2 = $img->thumbName( $params, File::THUMB_FULL_NAME ); // b/c; "long" style
266  wfThumbError(
267  400,
268  'The specified thumbnail parameters are not valid: ' . $e->getMessage()
269  );
270  return;
271  } catch ( MWException $e ) {
272  wfThumbError( 500, $e->getHTML(), 'Exception caught while extracting thumb name',
273  [ 'exception' => $e ] );
274  return;
275  }
276 
277  // For 404 handled thumbnails, we only use the base name of the URI
278  // for the thumb params and the parent directory for the source file name.
279  // Check that the zone relative path matches up so CDN caches won't pick
280  // up thumbs that would not be purged on source file deletion (T36231).
281  if ( $rel404 !== null ) { // thumbnail was handled via 404
282  if ( rawurldecode( $rel404 ) === $img->getThumbRel( $thumbName ) ) {
283  // Request for the canonical thumbnail name
284  } elseif ( rawurldecode( $rel404 ) === $img->getThumbRel( $thumbName2 ) ) {
285  // Request for the "long" thumbnail name; redirect to canonical name
286  $response = RequestContext::getMain()->getRequest()->response();
287  $response->statusHeader( 301 );
288  $response->header( 'Location: ' .
289  wfExpandUrl( $img->getThumbUrl( $thumbName ), PROTO_CURRENT ) );
290  $response->header( 'Expires: ' .
291  gmdate( 'D, d M Y H:i:s', time() + 7 * 86400 ) . ' GMT' );
292  if ( $wgVaryOnXFP ) {
293  $varyHeader[] = 'X-Forwarded-Proto';
294  }
295  if ( count( $varyHeader ) ) {
296  $response->header( 'Vary: ' . implode( ', ', $varyHeader ) );
297  }
298  return;
299  } else {
300  wfThumbErrorText( 404, "The given path of the specified thumbnail is incorrect;
301  expected '" . $img->getThumbRel( $thumbName ) . "' but got '" .
302  rawurldecode( $rel404 ) . "'." );
303  return;
304  }
305  }
306 
307  $dispositionType = isset( $params['download'] ) ? 'attachment' : 'inline';
308 
309  // Suggest a good name for users downloading this thumbnail
310  $headers[] =
311  "Content-Disposition: {$img->getThumbDisposition( $thumbName, $dispositionType )}";
312 
313  if ( count( $varyHeader ) ) {
314  $headers[] = 'Vary: ' . implode( ', ', $varyHeader );
315  }
316 
317  // Stream the file if it exists already...
318  $thumbPath = $img->getThumbPath( $thumbName );
319  if ( $img->getRepo()->fileExists( $thumbPath ) ) {
320  $starttime = microtime( true );
321  $status = $img->getRepo()->streamFileWithStatus( $thumbPath, $headers );
322  $streamtime = microtime( true ) - $starttime;
323 
324  if ( $status->isOK() ) {
325  MediaWikiServices::getInstance()->getStatsdDataFactory()->timing(
326  'media.thumbnail.stream', $streamtime
327  );
328  } else {
329  wfThumbError( 500, 'Could not stream the file', null, [ 'file' => $thumbName,
330  'path' => $thumbPath, 'error' => $status->getWikiText( false, false, 'en' ) ] );
331  }
332  return;
333  }
334 
335  $user = RequestContext::getMain()->getUser();
336  if ( !wfThumbIsStandard( $img, $params ) && $user->pingLimiter( 'renderfile-nonstandard' ) ) {
337  wfThumbError( 429, wfMessage( 'actionthrottledtext' )->parse() );
338  return;
339  } elseif ( $user->pingLimiter( 'renderfile' ) ) {
340  wfThumbError( 429, wfMessage( 'actionthrottledtext' )->parse() );
341  return;
342  }
343 
344  $thumbProxyUrl = $img->getRepo()->getThumbProxyUrl();
345 
346  if ( strlen( $thumbProxyUrl ) ) {
347  wfProxyThumbnailRequest( $img, $thumbName );
348  // No local fallback when in proxy mode
349  return;
350  } else {
351  // Generate the thumbnail locally
352  list( $thumb, $errorMsg ) = wfGenerateThumbnail( $img, $params, $thumbName, $thumbPath );
353  }
354 
357  // Check for thumbnail generation errors...
358  $msg = wfMessage( 'thumbnail_error' );
359  $errorCode = 500;
360 
361  if ( !$thumb ) {
362  $errorMsg = $errorMsg ?: $msg->rawParams( 'File::transform() returned false' )->escaped();
363  if ( $errorMsg instanceof MessageSpecifier &&
364  $errorMsg->getKey() === 'thumbnail_image-failure-limit'
365  ) {
366  $errorCode = 429;
367  }
368  } elseif ( $thumb->isError() ) {
369  $errorMsg = $thumb->getHtmlMsg();
370  $errorCode = $thumb->getHttpStatusCode();
371  } elseif ( !$thumb->hasFile() ) {
372  $errorMsg = $msg->rawParams( 'No path supplied in thumbnail object' )->escaped();
373  } elseif ( $thumb->fileIsSource() ) {
374  $errorMsg = $msg
375  ->rawParams( 'Image was not scaled, is the requested width bigger than the source?' )
376  ->escaped();
377  $errorCode = 400;
378  }
379 
380  if ( $errorMsg !== false ) {
381  wfThumbError( $errorCode, $errorMsg, null, [ 'file' => $thumbName, 'path' => $thumbPath ] );
382  } else {
383  // Stream the file if there were no errors
384  $status = $thumb->streamFileWithStatus( $headers );
385  if ( !$status->isOK() ) {
386  wfThumbError( 500, 'Could not stream the file', null, [
387  'file' => $thumbName, 'path' => $thumbPath,
388  'error' => $status->getWikiText( false, false, 'en' ) ] );
389  }
390  }
391 }
392 
399 function wfProxyThumbnailRequest( $img, $thumbName ) {
400  $thumbProxyUrl = $img->getRepo()->getThumbProxyUrl();
401 
402  // Instead of generating the thumbnail ourselves, we proxy the request to another service
403  $thumbProxiedUrl = $thumbProxyUrl . $img->getThumbRel( $thumbName );
404 
405  $req = MWHttpRequest::factory( $thumbProxiedUrl );
406  $secret = $img->getRepo()->getThumbProxySecret();
407 
408  // Pass a secret key shared with the proxied service if any
409  if ( strlen( $secret ) ) {
410  $req->setHeader( 'X-Swift-Secret', $secret );
411  }
412 
413  // Send request to proxied service
414  $status = $req->execute();
415 
417 
418  // Simply serve the response from the proxied service as-is
419  header( 'HTTP/1.1 ' . $req->getStatus() );
420 
421  $headers = $req->getResponseHeaders();
422 
423  foreach ( $headers as $key => $values ) {
424  foreach ( $values as $value ) {
425  header( $key . ': ' . $value, false );
426  }
427  }
428 
429  echo $req->getContent();
430 }
431 
441 function wfGenerateThumbnail( File $file, array $params, $thumbName, $thumbPath ) {
442  global $wgAttemptFailureEpoch;
443 
445  $key = $cache->makeKey(
446  'attempt-failures',
447  $wgAttemptFailureEpoch,
448  $file->getRepo()->getName(),
449  $file->getSha1(),
450  md5( $thumbName )
451  );
452 
453  // Check if this file keeps failing to render
454  if ( $cache->get( $key ) >= 4 ) {
455  return [ false, wfMessage( 'thumbnail_image-failure-limit', 4 ) ];
456  }
457 
458  $done = false;
459  // Record failures on PHP fatals in addition to caching exceptions
460  register_shutdown_function( function () use ( $cache, &$done, $key ) {
461  if ( !$done ) { // transform() gave a fatal
462  // Randomize TTL to reduce stampedes
463  $cache->incrWithInit( $key, $cache::TTL_HOUR + mt_rand( 0, 300 ) );
464  }
465  } );
466 
467  $thumb = false;
468  $errorHtml = false;
469 
470  // guard thumbnail rendering with PoolCounter to avoid stampedes
471  // expensive files use a separate PoolCounter config so it is possible
472  // to set up a global limit on them
473  if ( $file->isExpensiveToThumbnail() ) {
474  $poolCounterType = 'FileRenderExpensive';
475  } else {
476  $poolCounterType = 'FileRender';
477  }
478 
479  // Thumbnail isn't already there, so create the new thumbnail...
480  try {
481  $work = new PoolCounterWorkViaCallback( $poolCounterType, sha1( $file->getName() ),
482  [
483  'doWork' => function () use ( $file, $params ) {
484  return $file->transform( $params, File::RENDER_NOW );
485  },
486  'doCachedWork' => function () use ( $file, $params, $thumbPath ) {
487  // If the worker that finished made this thumbnail then use it.
488  // Otherwise, it probably made a different thumbnail for this file.
489  return $file->getRepo()->fileExists( $thumbPath )
490  ? $file->transform( $params, File::RENDER_NOW )
491  : false; // retry once more in exclusive mode
492  },
493  'error' => function ( Status $status ) {
494  return wfMessage( 'generic-pool-error' )->parse() . '<hr>' . $status->getHTML();
495  }
496  ]
497  );
498  $result = $work->execute();
499  if ( $result instanceof MediaTransformOutput ) {
500  $thumb = $result;
501  } elseif ( is_string( $result ) ) { // error
502  $errorHtml = $result;
503  }
504  } catch ( Exception $e ) {
505  // Tried to select a page on a non-paged file?
506  }
507 
509  $done = true; // no PHP fatal occurred
510 
511  if ( !$thumb || $thumb->isError() ) {
512  // Randomize TTL to reduce stampedes
513  $cache->incrWithInit( $key, $cache::TTL_HOUR + mt_rand( 0, 300 ) );
514  }
515 
516  return [ $thumb, $errorHtml ];
517 }
518 
538 function wfExtractThumbRequestInfo( $thumbRel ) {
539  $repo = RepoGroup::singleton()->getLocalRepo();
540 
541  $hashDirReg = $subdirReg = '';
542  $hashLevels = $repo->getHashLevels();
543  for ( $i = 0; $i < $hashLevels; $i++ ) {
544  $subdirReg .= '[0-9a-f]';
545  $hashDirReg .= "$subdirReg/";
546  }
547 
548  // Check if this is a thumbnail of an original in the local file repo
549  if ( preg_match( "!^((archive/)?$hashDirReg([^/]*)/([^/]*))$!", $thumbRel, $m ) ) {
550  list( /*all*/, $rel, $archOrTemp, $filename, $thumbname ) = $m;
551  // Check if this is a thumbnail of an temp file in the local file repo
552  } elseif ( preg_match( "!^(temp/)($hashDirReg([^/]*)/([^/]*))$!", $thumbRel, $m ) ) {
553  list( /*all*/, $archOrTemp, $rel, $filename, $thumbname ) = $m;
554  } else {
555  return null; // not a valid looking thumbnail request
556  }
557 
558  $params = [ 'f' => $filename, 'rel404' => $rel ];
559  if ( $archOrTemp === 'archive/' ) {
560  $params['archived'] = 1;
561  } elseif ( $archOrTemp === 'temp/' ) {
562  $params['temp'] = 1;
563  }
564 
565  $params['thumbName'] = $thumbname;
566  return $params;
567 }
568 
578  if ( !isset( $params['thumbName'] ) ) {
579  throw new InvalidArgumentException( "No thumbnail name passed to wfExtractThumbParams" );
580  }
581 
582  $thumbname = $params['thumbName'];
583  unset( $params['thumbName'] );
584 
585  // FIXME: Files in the temp zone don't set a MIME type, which means
586  // they don't have a handler. Which means we can't parse the param
587  // string. However, not a big issue as what good is a param string
588  // if you have no handler to make use of the param string and
589  // actually generate the thumbnail.
590  $handler = $file->getHandler();
591 
592  // Based on UploadStash::parseKey
593  $fileNamePos = strrpos( $thumbname, $params['f'] );
594  if ( $fileNamePos === false ) {
595  // Maybe using a short filename? (see FileRepo::nameForThumb)
596  $fileNamePos = strrpos( $thumbname, 'thumbnail' );
597  }
598 
599  if ( $handler && $fileNamePos !== false ) {
600  $paramString = substr( $thumbname, 0, $fileNamePos - 1 );
601  $extraParams = $handler->parseParamString( $paramString );
602  if ( $extraParams !== false ) {
603  return $params + $extraParams;
604  }
605  }
606 
607  // As a last ditch fallback, use the traditional common parameters
608  if ( preg_match( '!^(page(\d*)-)*(\d*)px-[^/]*$!', $thumbname, $matches ) ) {
609  list( /* all */, /* pagefull */, $pagenum, $size ) = $matches;
610  $params['width'] = $size;
611  if ( $pagenum ) {
612  $params['page'] = $pagenum;
613  }
614  return $params; // valid thumbnail URL
615  }
616  return null;
617 }
618 
626 function wfThumbErrorText( $status, $msgText ) {
627  wfThumbError( $status, htmlspecialchars( $msgText, ENT_NOQUOTES ) );
628 }
629 
640 function wfThumbError( $status, $msgHtml, $msgText = null, $context = [] ) {
641  global $wgShowHostnames;
642 
644 
645  header( 'Cache-Control: no-cache' );
646  header( 'Content-Type: text/html; charset=utf-8' );
647  if ( $status == 400 || $status == 404 || $status == 429 ) {
649  } elseif ( $status == 403 ) {
650  HttpStatus::header( 403 );
651  header( 'Vary: Cookie' );
652  } else {
653  LoggerFactory::getInstance( 'thumb' )->error( $msgText ?: $msgHtml, $context );
654  HttpStatus::header( 500 );
655  }
656  if ( $wgShowHostnames ) {
657  header( 'X-MW-Thumbnail-Renderer: ' . wfHostname() );
658  $url = htmlspecialchars(
659  $_SERVER['REQUEST_URI'] ?? '',
660  ENT_NOQUOTES
661  );
662  $hostname = htmlspecialchars( wfHostname(), ENT_NOQUOTES );
663  $debug = "<!-- $url -->\n<!-- $hostname -->\n";
664  } else {
665  $debug = '';
666  }
667  $content = <<<EOT
668 <!DOCTYPE html>
669 <html><head>
670 <meta charset="UTF-8" />
671 <title>Error generating thumbnail</title>
672 </head>
673 <body>
674 <h1>Error generating thumbnail</h1>
675 <p>
676 $msgHtml
677 </p>
678 $debug
679 </body>
680 </html>
681 
682 EOT;
683  header( 'Content-Length: ' . strlen( $content ) );
684  echo $content;
685 }
wfThumbErrorText( $status, $msgText)
Output a thumbnail generation error message.
Definition: thumb.php:626
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
static factory( $url, array $options=null, $caller=__METHOD__)
Generate a new request object.
static getGroupPermissions( $groups)
Get the permissions associated with a given list of groups.
Definition: User.php:4888
wfExtractThumbParams( $file, $params)
Convert a thumbnail name (122px-foo.png) to parameters, using file handler.
Definition: thumb.php:577
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
$wgTrivialMimeDetection
Definition: thumb.php:31
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Definition: router.php:42
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2159
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
wfHostname()
Fetch server name for use in error reporting etc.
transform( $params, $flags=0)
Transform a media file.
Definition: File.php:1058
$value
wfThumbHandle404()
Handle a thumbnail request via thumbnail file URL.
Definition: thumb.php:51
const PROTO_CURRENT
Definition: Defines.php:218
static getLocalClusterInstance()
Get the main cluster-local cache object.
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 MediaWikiServices
Definition: injection.txt:23
getName()
Return the name of this file.
Definition: File.php:307
getRepo()
Returns the repository.
Definition: File.php:1875
wfStreamThumb(array $params)
Stream a thumbnail specified by parameters.
Definition: thumb.php:92
this hook is for auditing only $response
Definition: hooks.txt:780
execute( $skipcache=false)
Get the result of the work (whatever it is), or the result of the error() function.
$wgArticlePath
Definition: img_auth.php:46
Base class for the output of MediaHandler::doTransform() and File::transform().
title
wfLocalFile( $title)
Get an object referring to a locally registered file.
$wgAttemptFailureEpoch
Certain operations are avoided if there were too many recent failures, for example, thumbnail generation.
getHTML()
If $wgShowExceptionDetails is true, return a HTML message with a backtrace to the error...
$wgVaryOnXFP
Add X-Forwarded-Proto to the Vary and Key headers for API requests and RSS/Atom feeds.
const DELETED_FILE
Definition: File.php:63
A file object referring to either a standalone local file, or a file in a local repository with no da...
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1980
and how to run hooks for an and one after Each event has a name
Definition: hooks.txt:6
The ContentHandler facility adds support for arbitrary content types on wiki instead of relying on wikitext for everything It was introduced in MediaWiki Each kind of and so on Built in content types are
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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:780
const THUMB_FULL_NAME
Definition: File.php:84
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1263
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
const RENDER_NOW
Force rendering in the current process.
Definition: File.php:69
Convenience class for dealing with PoolCounters using callbacks.
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
static getMain()
Get the RequestContext object associated with the main request.
static singleton()
Definition: RepoGroup.php:60
static warnIfHeadersSent()
Log a warning message if headers have already been sent.
static header( $code)
Output an HTTP status code header.
Definition: HttpStatus.php:96
$cache
Definition: mcc.php:33
$params
getSha1()
Get the SHA-1 base 36 hash of the file.
Definition: File.php:2138
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
const NS_FILE
Definition: Defines.php:66
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
Definition: distributors.txt:9
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:617
isExpensiveToThumbnail()
True if creating thumbnails from the file is large or otherwise resource-intensive.
Definition: File.php:2300
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:35
this hook is for auditing only $req
Definition: hooks.txt:979
wfProxyThumbnailRequest( $img, $thumbName)
Proxies thumbnail request to a service that handles thumbnailing.
Definition: thumb.php:399
wfThumbError( $status, $msgHtml, $msgText=null, $context=[])
Output a thumbnail generation error message.
Definition: thumb.php:640
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition: hooks.txt:2633
Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going on
Definition: hooks.txt:77
MediaWiki Logger LoggerFactory implements a PSR [0] compatible message logging system Named Psr Log LoggerInterface instances can be obtained from the MediaWiki Logger LoggerFactory::getInstance() static method. MediaWiki\Logger\LoggerFactory expects a class implementing the MediaWiki\Logger\Spi interface to act as a factory for new Psr\Log\LoggerInterface instances. The "Spi" in MediaWiki\Logger\Spi stands for "service provider interface". An SPI is an API intended to be implemented or extended by a third party. This software design pattern is intended to enable framework extension and replaceable components. It is specifically used in the MediaWiki\Logger\LoggerFactory service to allow alternate PSR-3 logging implementations to be easily integrated with MediaWiki. The service provider interface allows the backend logging library to be implemented in multiple ways. The $wgMWLoggerDefaultSpi global provides the classname of the default MediaWiki\Logger\Spi implementation to be loaded at runtime. This can either be the name of a class implementing the MediaWiki\Logger\Spi with a zero argument const ructor or a callable that will return an MediaWiki\Logger\Spi instance. Alternately the MediaWiki\Logger\LoggerFactory MediaWiki Logger LoggerFactory
Definition: logger.txt:5
if(! $wgDBerrorLogTZ) $wgRequest
Definition: Setup.php:783
MediaWiki exception thrown by some methods when the transform parameter array is invalid.
</td >< td > &</td >< td > t want your writing to be edited mercilessly and redistributed at will
$mediawiki
Definition: thumb.php:41
$debug
Definition: mcc.php:31
Implements some public methods and some protected utility functions which are required by multiple ch...
Definition: File.php:61
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation files(the "Software")
$content
Definition: pageupdater.txt:72
static getPathInfo( $want='all')
Extract relevant query arguments from the http request uri&#39;s path to be merged with the normal php pr...
Definition: WebRequest.php:116
wfThumbIsStandard(File $file, array $params)
Returns true if these thumbnail parameters match one that MediaWiki requests from file description pa...
wfGenerateThumbnail(File $file, array $params, $thumbName, $thumbPath)
Actually try to generate a new thumbnail.
Definition: thumb.php:441
wfExtractThumbRequestInfo( $thumbRel)
Convert pathinfo type parameter, into normal request parameters.
Definition: thumb.php:538
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1473
This document describes the state of Postgres support in MediaWiki
Definition: postgres.txt:4
$starttime
Definition: api.php:37
$matches
$wgShowHostnames
Expose backend server host names through the API and various HTML comments.