MediaWiki  1.29.1
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( $_GET );
39 }
40 
42 $mediawiki->doPostOutputShutdown( 'fast' );
43 
44 // --------------------------------------------------------------------------
45 
51 function wfThumbHandle404() {
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 
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'] ) ) {
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 ) {
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  MediaWiki\suppressWarnings();
239  $imsUnix = strtotime( $imsString );
240  MediaWiki\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?
257  'Empty return from File::thumbName'
258  );
259  }
260  $thumbName2 = $img->thumbName( $params, File::THUMB_FULL_NAME ); // b/c; "long" style
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  list( $thumb, $errorMsg ) = wfGenerateThumbnail( $img, $params, $thumbName, $thumbPath );
341 
344  // Check for thumbnail generation errors...
345  $msg = wfMessage( 'thumbnail_error' );
346  $errorCode = 500;
347 
348  if ( !$thumb ) {
349  $errorMsg = $errorMsg ?: $msg->rawParams( 'File::transform() returned false' )->escaped();
350  if ( $errorMsg instanceof MessageSpecifier &&
351  $errorMsg->getKey() === 'thumbnail_image-failure-limit'
352  ) {
353  $errorCode = 429;
354  }
355  } elseif ( $thumb->isError() ) {
356  $errorMsg = $thumb->getHtmlMsg();
357  $errorCode = $thumb->getHttpStatusCode();
358  } elseif ( !$thumb->hasFile() ) {
359  $errorMsg = $msg->rawParams( 'No path supplied in thumbnail object' )->escaped();
360  } elseif ( $thumb->fileIsSource() ) {
361  $errorMsg = $msg
362  ->rawParams( 'Image was not scaled, is the requested width bigger than the source?' )
363  ->escaped();
364  $errorCode = 400;
365  }
366 
367  if ( $errorMsg !== false ) {
368  wfThumbError( $errorCode, $errorMsg, null, [ 'file' => $thumbName, 'path' => $thumbPath ] );
369  } else {
370  // Stream the file if there were no errors
371  $status = $thumb->streamFileWithStatus( $headers );
372  if ( !$status->isOK() ) {
373  wfThumbError( 500, 'Could not stream the file', null, [
374  'file' => $thumbName, 'path' => $thumbPath,
375  'error' => $status->getWikiText( false, false, 'en' ) ] );
376  }
377  }
378 }
379 
389 function wfGenerateThumbnail( File $file, array $params, $thumbName, $thumbPath ) {
391 
393  $key = $cache->makeKey(
394  'attempt-failures',
396  $file->getRepo()->getName(),
397  $file->getSha1(),
398  md5( $thumbName )
399  );
400 
401  // Check if this file keeps failing to render
402  if ( $cache->get( $key ) >= 4 ) {
403  return [ false, wfMessage( 'thumbnail_image-failure-limit', 4 ) ];
404  }
405 
406  $done = false;
407  // Record failures on PHP fatals in addition to caching exceptions
408  register_shutdown_function( function () use ( $cache, &$done, $key ) {
409  if ( !$done ) { // transform() gave a fatal
410  // Randomize TTL to reduce stampedes
411  $cache->incrWithInit( $key, $cache::TTL_HOUR + mt_rand( 0, 300 ) );
412  }
413  } );
414 
415  $thumb = false;
416  $errorHtml = false;
417 
418  // guard thumbnail rendering with PoolCounter to avoid stampedes
419  // expensive files use a separate PoolCounter config so it is possible
420  // to set up a global limit on them
421  if ( $file->isExpensiveToThumbnail() ) {
422  $poolCounterType = 'FileRenderExpensive';
423  } else {
424  $poolCounterType = 'FileRender';
425  }
426 
427  // Thumbnail isn't already there, so create the new thumbnail...
428  try {
429  $work = new PoolCounterWorkViaCallback( $poolCounterType, sha1( $file->getName() ),
430  [
431  'doWork' => function () use ( $file, $params ) {
432  return $file->transform( $params, File::RENDER_NOW );
433  },
434  'doCachedWork' => function () use ( $file, $params, $thumbPath ) {
435  // If the worker that finished made this thumbnail then use it.
436  // Otherwise, it probably made a different thumbnail for this file.
437  return $file->getRepo()->fileExists( $thumbPath )
438  ? $file->transform( $params, File::RENDER_NOW )
439  : false; // retry once more in exclusive mode
440  },
441  'error' => function ( Status $status ) {
442  return wfMessage( 'generic-pool-error' )->parse() . '<hr>' . $status->getHTML();
443  }
444  ]
445  );
446  $result = $work->execute();
447  if ( $result instanceof MediaTransformOutput ) {
448  $thumb = $result;
449  } elseif ( is_string( $result ) ) { // error
450  $errorHtml = $result;
451  }
452  } catch ( Exception $e ) {
453  // Tried to select a page on a non-paged file?
454  }
455 
457  $done = true; // no PHP fatal occured
458 
459  if ( !$thumb || $thumb->isError() ) {
460  // Randomize TTL to reduce stampedes
461  $cache->incrWithInit( $key, $cache::TTL_HOUR + mt_rand( 0, 300 ) );
462  }
463 
464  return [ $thumb, $errorHtml ];
465 }
466 
486 function wfExtractThumbRequestInfo( $thumbRel ) {
487  $repo = RepoGroup::singleton()->getLocalRepo();
488 
489  $hashDirReg = $subdirReg = '';
490  $hashLevels = $repo->getHashLevels();
491  for ( $i = 0; $i < $hashLevels; $i++ ) {
492  $subdirReg .= '[0-9a-f]';
493  $hashDirReg .= "$subdirReg/";
494  }
495 
496  // Check if this is a thumbnail of an original in the local file repo
497  if ( preg_match( "!^((archive/)?$hashDirReg([^/]*)/([^/]*))$!", $thumbRel, $m ) ) {
498  list( /*all*/, $rel, $archOrTemp, $filename, $thumbname ) = $m;
499  // Check if this is a thumbnail of an temp file in the local file repo
500  } elseif ( preg_match( "!^(temp/)($hashDirReg([^/]*)/([^/]*))$!", $thumbRel, $m ) ) {
501  list( /*all*/, $archOrTemp, $rel, $filename, $thumbname ) = $m;
502  } else {
503  return null; // not a valid looking thumbnail request
504  }
505 
506  $params = [ 'f' => $filename, 'rel404' => $rel ];
507  if ( $archOrTemp === 'archive/' ) {
508  $params['archived'] = 1;
509  } elseif ( $archOrTemp === 'temp/' ) {
510  $params['temp'] = 1;
511  }
512 
513  $params['thumbName'] = $thumbname;
514  return $params;
515 }
516 
525 function wfExtractThumbParams( $file, $params ) {
526  if ( !isset( $params['thumbName'] ) ) {
527  throw new InvalidArgumentException( "No thumbnail name passed to wfExtractThumbParams" );
528  }
529 
530  $thumbname = $params['thumbName'];
531  unset( $params['thumbName'] );
532 
533  // Do the hook first for older extensions that rely on it.
534  if ( !Hooks::run( 'ExtractThumbParameters', [ $thumbname, &$params ] ) ) {
535  // Check hooks if parameters can be extracted
536  // Hooks return false if they manage to *resolve* the parameters
537  // This hook should be considered deprecated
538  wfDeprecated( 'ExtractThumbParameters', '1.22' );
539  return $params; // valid thumbnail URL (via extension or config)
540  }
541 
542  // FIXME: Files in the temp zone don't set a MIME type, which means
543  // they don't have a handler. Which means we can't parse the param
544  // string. However, not a big issue as what good is a param string
545  // if you have no handler to make use of the param string and
546  // actually generate the thumbnail.
547  $handler = $file->getHandler();
548 
549  // Based on UploadStash::parseKey
550  $fileNamePos = strrpos( $thumbname, $params['f'] );
551  if ( $fileNamePos === false ) {
552  // Maybe using a short filename? (see FileRepo::nameForThumb)
553  $fileNamePos = strrpos( $thumbname, 'thumbnail' );
554  }
555 
556  if ( $handler && $fileNamePos !== false ) {
557  $paramString = substr( $thumbname, 0, $fileNamePos - 1 );
558  $extraParams = $handler->parseParamString( $paramString );
559  if ( $extraParams !== false ) {
560  return $params + $extraParams;
561  }
562  }
563 
564  // As a last ditch fallback, use the traditional common parameters
565  if ( preg_match( '!^(page(\d*)-)*(\d*)px-[^/]*$!', $thumbname, $matches ) ) {
566  list( /* all */, /* pagefull */, $pagenum, $size ) = $matches;
567  $params['width'] = $size;
568  if ( $pagenum ) {
569  $params['page'] = $pagenum;
570  }
571  return $params; // valid thumbnail URL
572  }
573  return null;
574 }
575 
583 function wfThumbErrorText( $status, $msgText ) {
584  wfThumbError( $status, htmlspecialchars( $msgText ) );
585 }
586 
597 function wfThumbError( $status, $msgHtml, $msgText = null, $context = [] ) {
598  global $wgShowHostnames;
599 
600  header( 'Cache-Control: no-cache' );
601  header( 'Content-Type: text/html; charset=utf-8' );
602  if ( $status == 400 || $status == 404 || $status == 429 ) {
604  } elseif ( $status == 403 ) {
605  HttpStatus::header( 403 );
606  header( 'Vary: Cookie' );
607  } else {
608  LoggerFactory::getInstance( 'thumb' )->error( $msgText ?: $msgHtml, $context );
609  HttpStatus::header( 500 );
610  }
611  if ( $wgShowHostnames ) {
612  header( 'X-MW-Thumbnail-Renderer: ' . wfHostname() );
613  $url = htmlspecialchars(
614  isset( $_SERVER['REQUEST_URI'] ) ? $_SERVER['REQUEST_URI'] : ''
615  );
616  $hostname = htmlspecialchars( wfHostname() );
617  $debug = "<!-- $url -->\n<!-- $hostname -->\n";
618  } else {
619  $debug = '';
620  }
621  $content = <<<EOT
622 <!DOCTYPE html>
623 <html><head>
624 <meta charset="UTF-8" />
625 <title>Error generating thumbnail</title>
626 </head>
627 <body>
628 <h1>Error generating thumbnail</h1>
629 <p>
630 $msgHtml
631 </p>
632 $debug
633 </body>
634 </html>
635 
636 EOT;
637  header( 'Content-Length: ' . strlen( $content ) );
638  echo $content;
639 }
File\THUMB_FULL_NAME
const THUMB_FULL_NAME
Definition: File.php:74
$context
error also a ContextSource you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition: hooks.txt:2612
RepoGroup\singleton
static singleton()
Get a RepoGroup instance.
Definition: RepoGroup.php:59
false
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:189
wfThumbHandle404
wfThumbHandle404()
Handle a thumbnail request via thumbnail file URL.
Definition: thumb.php:51
ObjectCache\getLocalClusterInstance
static getLocalClusterInstance()
Get the main cluster-local cache object.
Definition: ObjectCache.php:357
wfThumbIsStandard
wfThumbIsStandard(File $file, array $params)
Returns true if these thumbnail parameters match one that MediaWiki requests from file description pa...
Definition: GlobalFunctions.php:3596
based
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero based
Definition: hooks.txt:2536
File\isExpensiveToThumbnail
isExpensiveToThumbnail()
True if creating thumbnails from the file is large or otherwise resource-intensive.
Definition: File.php:2268
captcha-old.count
count
Definition: captcha-old.py:225
$result
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 '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. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) '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 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) '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! 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:1954
wfTimestamp
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
Definition: GlobalFunctions.php:1994
UnregisteredLocalFile
A file object referring to either a standalone local file, or a file in a local repository with no da...
Definition: UnregisteredLocalFile.php:36
MessageSpecifier\getKey
getKey()
Returns the message key.
MessageSpecifier
Definition: MessageSpecifier.php:21
$status
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1049
File\getSha1
getSha1()
Get the SHA-1 base 36 hash of the file.
Definition: File.php:2117
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:246
wfExtractThumbRequestInfo
wfExtractThumbRequestInfo( $thumbRel)
Convert pathinfo type parameter, into normal request parameters.
Definition: thumb.php:486
NS_FILE
const NS_FILE
Definition: Defines.php:68
$params
$params
Definition: styleTest.css.php:40
wfHostname
wfHostname()
Fetch server name for use in error reporting etc.
Definition: GlobalFunctions.php:1435
PoolCounterWorkViaCallback
Convenience class for dealing with PoolCounters using callbacks.
Definition: PoolCounterWorkViaCallback.php:28
wfExtractThumbParams
wfExtractThumbParams( $file, $params)
Convert a thumbnail name (122px-foo.png) to parameters, using file handler.
Definition: thumb.php:525
php
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
Status
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: Status.php:40
$debug
$debug
Definition: mcc.php:31
$wgTrivialMimeDetection
$wgTrivialMimeDetection
Definition: thumb.php:31
$wgAttemptFailureEpoch
$wgAttemptFailureEpoch
Certain operations are avoided if there were too many recent failures, for example,...
Definition: DefaultSettings.php:1188
File
Implements some public methods and some protected utility functions which are required by multiple ch...
Definition: File.php:51
MWException
MediaWiki exception.
Definition: MWException.php:26
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:934
$starttime
$starttime
Definition: api.php:40
wfDeprecated
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
Definition: GlobalFunctions.php:1128
$content
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content $content
Definition: hooks.txt:1049
PoolCounterWork\execute
execute( $skipcache=false)
Get the result of the work (whatever it is), or the result of the error() function.
Definition: PoolCounterWork.php:104
$matches
$matches
Definition: NoLocalSettings.php:24
files
c Accompany it with the information you received as to the offer to distribute corresponding source complete source code means all the source code for all modules it plus any associated interface definition files
Definition: COPYING.txt:157
WebRequest\getPathInfo
static getPathInfo( $want='all')
Extract relevant query arguments from the http request uri's path to be merged with the normal php pr...
Definition: WebRequest.php:114
PROTO_CURRENT
const PROTO_CURRENT
Definition: Defines.php:220
$wgVaryOnXFP
$wgVaryOnXFP
Add X-Forwarded-Proto to the Vary and Key headers for API requests and RSS/Atom feeds.
Definition: DefaultSettings.php:2655
MediaWiki
This document describes the state of Postgres support in MediaWiki
Definition: postgres.txt:4
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
list
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
will
</td >< td > &</td >< td > t want your writing to be edited mercilessly and redistributed at will
Definition: All_system_messages.txt:914
Title\makeTitleSafe
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:538
$e
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2122
$mediawiki
$mediawiki
Definition: thumb.php:41
on
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:86
title
title
Definition: parserTests.txt:211
User\getGroupPermissions
static getGroupPermissions( $groups)
Get the permissions associated with a given list of groups.
Definition: User.php:4716
File\getName
getName()
Return the name of this file.
Definition: File.php:297
$handler
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves $handler
Definition: hooks.txt:783
RequestContext\getMain
static getMain()
Static methods.
Definition: RequestContext.php:468
$response
this hook is for auditing only $response
Definition: hooks.txt:783
File\RENDER_NOW
const RENDER_NOW
Force rendering in the current process.
Definition: File.php:59
File\transform
transform( $params, $flags=0)
Transform a media file.
Definition: File.php:1034
$wgArticlePath
$wgArticlePath
Definition: img_auth.php:45
MediaTransformOutput
Base class for the output of MediaHandler::doTransform() and File::transform().
Definition: MediaTransformOutput.php:29
wfGenerateThumbnail
wfGenerateThumbnail(File $file, array $params, $thumbName, $thumbPath)
Actually try to generate a new thumbnail.
Definition: thumb.php:389
$cache
$cache
Definition: mcc.php:33
HttpStatus\header
static header( $code)
Output an HTTP status code header.
Definition: HttpStatus.php:96
wfThumbErrorText
wfThumbErrorText( $status, $msgText)
Output a thumbnail generation error message.
Definition: thumb.php:583
are
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
Definition: contenthandler.txt:5
LoggerFactory
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
MediaTransformInvalidParametersException
MediaWiki exception thrown by some methods when the transform parameter array is invalid.
Definition: MediaTransformInvalidParametersException.php:26
wfMessage
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 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
File\DELETED_FILE
const DELETED_FILE
Definition: File.php:53
name
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at name
Definition: design.txt:12
File\getRepo
getRepo()
Returns the repository.
Definition: File.php:1854
MediaWikiServices
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
wfLocalFile
wfLocalFile( $title)
Get an object referring to a locally registered file.
Definition: GlobalFunctions.php:3112
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
wfThumbError
wfThumbError( $status, $msgHtml, $msgText=null, $context=[])
Output a thumbnail generation error message.
Definition: thumb.php:597
wfExpandUrl
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
Definition: GlobalFunctions.php:552
array
the array() calling protocol came about after MediaWiki 1.4rc1.
wfStreamThumb
wfStreamThumb(array $params)
Stream a thumbnail specified by parameters.
Definition: thumb.php:92