MediaWiki  1.28.3
thumb.php
Go to the documentation of this file.
1 <?php
25 
26 define( 'MW_NO_OUTPUT_COMPRESSION', 1 );
27 require __DIR__ . '/includes/WebStart.php';
28 
29 // Don't use fancy MIME detection, just check the file extension for jpg/gif/png
31 
32 if ( defined( 'THUMB_HANDLER' ) ) {
33  // Called from thumb_handler.php via 404; extract params from the URI...
35 } else {
36  // Called directly, use $_GET params
37  wfStreamThumb( $_GET );
38 }
39 
41 $mediawiki->doPostOutputShutdown( 'fast' );
42 
43 // --------------------------------------------------------------------------
44 
50 function wfThumbHandle404() {
52 
53  # Set action base paths so that WebRequest::getPathInfo()
54  # recognizes the "X" as the 'title' in ../thumb_handler.php/X urls.
55  # Note: If Custom per-extension repo paths are set, this may break.
56  $repo = RepoGroup::singleton()->getLocalRepo();
57  $oldArticlePath = $wgArticlePath;
58  $wgArticlePath = $repo->getZoneUrl( 'thumb' ) . '/$1';
59 
61 
62  $wgArticlePath = $oldArticlePath;
63 
64  if ( !isset( $matches['title'] ) ) {
65  wfThumbError( 404, 'Could not determine the name of the requested thumbnail.' );
66  return;
67  }
68 
69  $params = wfExtractThumbRequestInfo( $matches['title'] ); // basic wiki URL param extracting
70  if ( $params == null ) {
71  wfThumbError( 400, 'The specified thumbnail parameters are not recognized.' );
72  return;
73  }
74 
75  wfStreamThumb( $params ); // stream the thumbnail
76 }
77 
93 
94  $headers = []; // HTTP headers to send
95 
96  $fileName = isset( $params['f'] ) ? $params['f'] : '';
97 
98  // Backwards compatibility parameters
99  if ( isset( $params['w'] ) ) {
100  $params['width'] = $params['w'];
101  unset( $params['w'] );
102  }
103  if ( isset( $params['width'] ) && substr( $params['width'], -2 ) == 'px' ) {
104  // strip the px (pixel) suffix, if found
105  $params['width'] = substr( $params['width'], 0, -2 );
106  }
107  if ( isset( $params['p'] ) ) {
108  $params['page'] = $params['p'];
109  }
110 
111  // Is this a thumb of an archived file?
112  $isOld = ( isset( $params['archived'] ) && $params['archived'] );
113  unset( $params['archived'] ); // handlers don't care
114 
115  // Is this a thumb of a temp file?
116  $isTemp = ( isset( $params['temp'] ) && $params['temp'] );
117  unset( $params['temp'] ); // handlers don't care
118 
119  // Some basic input validation
120  $fileName = strtr( $fileName, '\\/', '__' );
121 
122  // Actually fetch the image. Method depends on whether it is archived or not.
123  if ( $isTemp ) {
124  $repo = RepoGroup::singleton()->getLocalRepo()->getTempRepo();
125  $img = new UnregisteredLocalFile( null, $repo,
126  # Temp files are hashed based on the name without the timestamp.
127  # The thumbnails will be hashed based on the entire name however.
128  # @todo fix this convention to actually be reasonable.
129  $repo->getZonePath( 'public' ) . '/' . $repo->getTempHashPath( $fileName ) . $fileName
130  );
131  } elseif ( $isOld ) {
132  // Format is <timestamp>!<name>
133  $bits = explode( '!', $fileName, 2 );
134  if ( count( $bits ) != 2 ) {
135  wfThumbError( 404, wfMessage( 'badtitletext' )->parse() );
136  return;
137  }
138  $title = Title::makeTitleSafe( NS_FILE, $bits[1] );
139  if ( !$title ) {
140  wfThumbError( 404, wfMessage( 'badtitletext' )->parse() );
141  return;
142  }
143  $img = RepoGroup::singleton()->getLocalRepo()->newFromArchiveName( $title, $fileName );
144  } else {
145  $img = wfLocalFile( $fileName );
146  }
147 
148  // Check the source file title
149  if ( !$img ) {
150  wfThumbError( 404, wfMessage( 'badtitletext' )->parse() );
151  return;
152  }
153 
154  // Check permissions if there are read restrictions
155  $varyHeader = [];
156  if ( !in_array( 'read', User::getGroupPermissions( [ '*' ] ), true ) ) {
157  if ( !$img->getTitle() || !$img->getTitle()->userCan( 'read' ) ) {
158  wfThumbError( 403, 'Access denied. You do not have permission to access ' .
159  'the source file.' );
160  return;
161  }
162  $headers[] = 'Cache-Control: private';
163  $varyHeader[] = 'Cookie';
164  }
165 
166  // Check if the file is hidden
167  if ( $img->isDeleted( File::DELETED_FILE ) ) {
168  wfThumbErrorText( 404, "The source file '$fileName' does not exist." );
169  return;
170  }
171 
172  // Do rendering parameters extraction from thumbnail name.
173  if ( isset( $params['thumbName'] ) ) {
174  $params = wfExtractThumbParams( $img, $params );
175  }
176  if ( $params == null ) {
177  wfThumbError( 400, 'The specified thumbnail parameters are not recognized.' );
178  return;
179  }
180 
181  // Check the source file storage path
182  if ( !$img->exists() ) {
183  $redirectedLocation = false;
184  if ( !$isTemp ) {
185  // Check for file redirect
186  // Since redirects are associated with pages, not versions of files,
187  // we look for the most current version to see if its a redirect.
188  $possRedirFile = RepoGroup::singleton()->getLocalRepo()->findFile( $img->getName() );
189  if ( $possRedirFile && !is_null( $possRedirFile->getRedirected() ) ) {
190  $redirTarget = $possRedirFile->getName();
191  $targetFile = wfLocalFile( Title::makeTitleSafe( NS_FILE, $redirTarget ) );
192  if ( $targetFile->exists() ) {
193  $newThumbName = $targetFile->thumbName( $params );
194  if ( $isOld ) {
196  $newThumbUrl = $targetFile->getArchiveThumbUrl(
197  $bits[0] . '!' . $targetFile->getName(), $newThumbName );
198  } else {
199  $newThumbUrl = $targetFile->getThumbUrl( $newThumbName );
200  }
201  $redirectedLocation = wfExpandUrl( $newThumbUrl, PROTO_CURRENT );
202  }
203  }
204  }
205 
206  if ( $redirectedLocation ) {
207  // File has been moved. Give redirect.
208  $response = RequestContext::getMain()->getRequest()->response();
209  $response->statusHeader( 302 );
210  $response->header( 'Location: ' . $redirectedLocation );
211  $response->header( 'Expires: ' .
212  gmdate( 'D, d M Y H:i:s', time() + 12 * 3600 ) . ' GMT' );
213  if ( $wgVaryOnXFP ) {
214  $varyHeader[] = 'X-Forwarded-Proto';
215  }
216  if ( count( $varyHeader ) ) {
217  $response->header( 'Vary: ' . implode( ', ', $varyHeader ) );
218  }
219  $response->header( 'Content-Length: 0' );
220  return;
221  }
222 
223  // If its not a redirect that has a target as a local file, give 404.
224  wfThumbErrorText( 404, "The source file '$fileName' does not exist." );
225  return;
226  } elseif ( $img->getPath() === false ) {
227  wfThumbErrorText( 400, "The source file '$fileName' is not locally accessible." );
228  return;
229  }
230 
231  // Check IMS against the source file
232  // This means that clients can keep a cached copy even after it has been deleted on the server
233  if ( !empty( $_SERVER['HTTP_IF_MODIFIED_SINCE'] ) ) {
234  // Fix IE brokenness
235  $imsString = preg_replace( '/;.*$/', '', $_SERVER["HTTP_IF_MODIFIED_SINCE"] );
236  // Calculate time
237  MediaWiki\suppressWarnings();
238  $imsUnix = strtotime( $imsString );
239  MediaWiki\restoreWarnings();
240  if ( wfTimestamp( TS_UNIX, $img->getTimestamp() ) <= $imsUnix ) {
241  HttpStatus::header( 304 );
242  return;
243  }
244  }
245 
246  $rel404 = isset( $params['rel404'] ) ? $params['rel404'] : null;
247  unset( $params['r'] ); // ignore 'r' because we unconditionally pass File::RENDER
248  unset( $params['f'] ); // We're done with 'f' parameter.
249  unset( $params['rel404'] ); // moved to $rel404
250 
251  // Get the normalized thumbnail name from the parameters...
252  try {
253  $thumbName = $img->thumbName( $params );
254  if ( !strlen( $thumbName ) ) { // invalid params?
256  'Empty return from File::thumbName'
257  );
258  }
259  $thumbName2 = $img->thumbName( $params, File::THUMB_FULL_NAME ); // b/c; "long" style
261  wfThumbError(
262  400,
263  'The specified thumbnail parameters are not valid: ' . $e->getMessage()
264  );
265  return;
266  } catch ( MWException $e ) {
267  wfThumbError( 500, $e->getHTML(), 'Exception caught while extracting thumb name',
268  [ 'exception' => $e ] );
269  return;
270  }
271 
272  // For 404 handled thumbnails, we only use the base name of the URI
273  // for the thumb params and the parent directory for the source file name.
274  // Check that the zone relative path matches up so squid caches won't pick
275  // up thumbs that would not be purged on source file deletion (bug 34231).
276  if ( $rel404 !== null ) { // thumbnail was handled via 404
277  if ( rawurldecode( $rel404 ) === $img->getThumbRel( $thumbName ) ) {
278  // Request for the canonical thumbnail name
279  } elseif ( rawurldecode( $rel404 ) === $img->getThumbRel( $thumbName2 ) ) {
280  // Request for the "long" thumbnail name; redirect to canonical name
281  $response = RequestContext::getMain()->getRequest()->response();
282  $response->statusHeader( 301 );
283  $response->header( 'Location: ' .
284  wfExpandUrl( $img->getThumbUrl( $thumbName ), PROTO_CURRENT ) );
285  $response->header( 'Expires: ' .
286  gmdate( 'D, d M Y H:i:s', time() + 7 * 86400 ) . ' GMT' );
287  if ( $wgVaryOnXFP ) {
288  $varyHeader[] = 'X-Forwarded-Proto';
289  }
290  if ( count( $varyHeader ) ) {
291  $response->header( 'Vary: ' . implode( ', ', $varyHeader ) );
292  }
293  return;
294  } else {
295  wfThumbErrorText( 404, "The given path of the specified thumbnail is incorrect;
296  expected '" . $img->getThumbRel( $thumbName ) . "' but got '" .
297  rawurldecode( $rel404 ) . "'." );
298  return;
299  }
300  }
301 
302  $dispositionType = isset( $params['download'] ) ? 'attachment' : 'inline';
303 
304  // Suggest a good name for users downloading this thumbnail
305  $headers[] =
306  "Content-Disposition: {$img->getThumbDisposition( $thumbName, $dispositionType )}";
307 
308  if ( count( $varyHeader ) ) {
309  $headers[] = 'Vary: ' . implode( ', ', $varyHeader );
310  }
311 
312  // Stream the file if it exists already...
313  $thumbPath = $img->getThumbPath( $thumbName );
314  if ( $img->getRepo()->fileExists( $thumbPath ) ) {
315  $starttime = microtime( true );
316  $status = $img->getRepo()->streamFileWithStatus( $thumbPath, $headers );
317  $streamtime = microtime( true ) - $starttime;
318 
319  if ( $status->isOK() ) {
320  RequestContext::getMain()->getStats()->timing( 'media.thumbnail.stream', $streamtime );
321  } else {
322  wfThumbError( 500, 'Could not stream the file', null, [ 'file' => $thumbName,
323  'path' => $thumbPath, 'error' => $status->getWikiText( false, false, 'en' ) ] );
324  }
325  return;
326  }
327 
328  $user = RequestContext::getMain()->getUser();
329  if ( !wfThumbIsStandard( $img, $params ) && $user->pingLimiter( 'renderfile-nonstandard' ) ) {
330  wfThumbError( 429, wfMessage( 'actionthrottledtext' )->parse() );
331  return;
332  } elseif ( $user->pingLimiter( 'renderfile' ) ) {
333  wfThumbError( 429, wfMessage( 'actionthrottledtext' )->parse() );
334  return;
335  }
336 
337  list( $thumb, $errorMsg ) = wfGenerateThumbnail( $img, $params, $thumbName, $thumbPath );
338 
341  // Check for thumbnail generation errors...
342  $msg = wfMessage( 'thumbnail_error' );
343  $errorCode = 500;
344  if ( !$thumb ) {
345  $errorMsg = $errorMsg ?: $msg->rawParams( 'File::transform() returned false' )->escaped();
346  if ( $errorMsg instanceof MessageSpecifier &&
347  $errorMsg->getKey() === 'thumbnail_image-failure-limit'
348  ) {
349  $errorCode = 429;
350  }
351  } elseif ( $thumb->isError() ) {
352  $errorMsg = $thumb->getHtmlMsg();
353  } elseif ( !$thumb->hasFile() ) {
354  $errorMsg = $msg->rawParams( 'No path supplied in thumbnail object' )->escaped();
355  } elseif ( $thumb->fileIsSource() ) {
356  $errorMsg = $msg
357  ->rawParams( 'Image was not scaled, is the requested width bigger than the source?' )
358  ->escaped();
359  $errorCode = 400;
360  }
361 
362  if ( $errorMsg !== false ) {
363  wfThumbError( $errorCode, $errorMsg, null, [ 'file' => $thumbName, 'path' => $thumbPath ] );
364  } else {
365  // Stream the file if there were no errors
366  $status = $thumb->streamFileWithStatus( $headers );
367  if ( !$status->isOK() ) {
368  wfThumbError( 500, 'Could not stream the file', null, [
369  'file' => $thumbName, 'path' => $thumbPath,
370  'error' => $status->getWikiText( false, false, 'en' ) ] );
371  }
372  }
373 }
374 
384 function wfGenerateThumbnail( File $file, array $params, $thumbName, $thumbPath ) {
386 
388  $key = $cache->makeKey(
389  'attempt-failures',
390  $wgAttemptFailureEpoch,
391  $file->getRepo()->getName(),
392  $file->getSha1(),
393  md5( $thumbName )
394  );
395 
396  // Check if this file keeps failing to render
397  if ( $cache->get( $key ) >= 4 ) {
398  return [ false, wfMessage( 'thumbnail_image-failure-limit', 4 ) ];
399  }
400 
401  $done = false;
402  // Record failures on PHP fatals in addition to caching exceptions
403  register_shutdown_function( function () use ( $cache, &$done, $key ) {
404  if ( !$done ) { // transform() gave a fatal
405  // Randomize TTL to reduce stampedes
406  $cache->incrWithInit( $key, $cache::TTL_HOUR + mt_rand( 0, 300 ) );
407  }
408  } );
409 
410  $thumb = false;
411  $errorHtml = false;
412 
413  // guard thumbnail rendering with PoolCounter to avoid stampedes
414  // expensive files use a separate PoolCounter config so it is possible
415  // to set up a global limit on them
416  if ( $file->isExpensiveToThumbnail() ) {
417  $poolCounterType = 'FileRenderExpensive';
418  } else {
419  $poolCounterType = 'FileRender';
420  }
421 
422  // Thumbnail isn't already there, so create the new thumbnail...
423  try {
424  $work = new PoolCounterWorkViaCallback( $poolCounterType, sha1( $file->getName() ),
425  [
426  'doWork' => function () use ( $file, $params ) {
427  return $file->transform( $params, File::RENDER_NOW );
428  },
429  'doCachedWork' => function () use ( $file, $params, $thumbPath ) {
430  // If the worker that finished made this thumbnail then use it.
431  // Otherwise, it probably made a different thumbnail for this file.
432  return $file->getRepo()->fileExists( $thumbPath )
433  ? $file->transform( $params, File::RENDER_NOW )
434  : false; // retry once more in exclusive mode
435  },
436  'error' => function ( Status $status ) {
437  return wfMessage( 'generic-pool-error' )->parse() . '<hr>' . $status->getHTML();
438  }
439  ]
440  );
441  $result = $work->execute();
442  if ( $result instanceof MediaTransformOutput ) {
443  $thumb = $result;
444  } elseif ( is_string( $result ) ) { // error
445  $errorHtml = $result;
446  }
447  } catch ( Exception $e ) {
448  // Tried to select a page on a non-paged file?
449  }
450 
452  $done = true; // no PHP fatal occured
453 
454  if ( !$thumb || $thumb->isError() ) {
455  // Randomize TTL to reduce stampedes
456  $cache->incrWithInit( $key, $cache::TTL_HOUR + mt_rand( 0, 300 ) );
457  }
458 
459  return [ $thumb, $errorHtml ];
460 }
461 
481 function wfExtractThumbRequestInfo( $thumbRel ) {
482  $repo = RepoGroup::singleton()->getLocalRepo();
483 
484  $hashDirReg = $subdirReg = '';
485  $hashLevels = $repo->getHashLevels();
486  for ( $i = 0; $i < $hashLevels; $i++ ) {
487  $subdirReg .= '[0-9a-f]';
488  $hashDirReg .= "$subdirReg/";
489  }
490 
491  // Check if this is a thumbnail of an original in the local file repo
492  if ( preg_match( "!^((archive/)?$hashDirReg([^/]*)/([^/]*))$!", $thumbRel, $m ) ) {
493  list( /*all*/, $rel, $archOrTemp, $filename, $thumbname ) = $m;
494  // Check if this is a thumbnail of an temp file in the local file repo
495  } elseif ( preg_match( "!^(temp/)($hashDirReg([^/]*)/([^/]*))$!", $thumbRel, $m ) ) {
496  list( /*all*/, $archOrTemp, $rel, $filename, $thumbname ) = $m;
497  } else {
498  return null; // not a valid looking thumbnail request
499  }
500 
501  $params = [ 'f' => $filename, 'rel404' => $rel ];
502  if ( $archOrTemp === 'archive/' ) {
503  $params['archived'] = 1;
504  } elseif ( $archOrTemp === 'temp/' ) {
505  $params['temp'] = 1;
506  }
507 
508  $params['thumbName'] = $thumbname;
509  return $params;
510 }
511 
520 function wfExtractThumbParams( $file, $params ) {
521  if ( !isset( $params['thumbName'] ) ) {
522  throw new InvalidArgumentException( "No thumbnail name passed to wfExtractThumbParams" );
523  }
524 
525  $thumbname = $params['thumbName'];
526  unset( $params['thumbName'] );
527 
528  // Do the hook first for older extensions that rely on it.
529  if ( !Hooks::run( 'ExtractThumbParameters', [ $thumbname, &$params ] ) ) {
530  // Check hooks if parameters can be extracted
531  // Hooks return false if they manage to *resolve* the parameters
532  // This hook should be considered deprecated
533  wfDeprecated( 'ExtractThumbParameters', '1.22' );
534  return $params; // valid thumbnail URL (via extension or config)
535  }
536 
537  // FIXME: Files in the temp zone don't set a MIME type, which means
538  // they don't have a handler. Which means we can't parse the param
539  // string. However, not a big issue as what good is a param string
540  // if you have no handler to make use of the param string and
541  // actually generate the thumbnail.
542  $handler = $file->getHandler();
543 
544  // Based on UploadStash::parseKey
545  $fileNamePos = strrpos( $thumbname, $params['f'] );
546  if ( $fileNamePos === false ) {
547  // Maybe using a short filename? (see FileRepo::nameForThumb)
548  $fileNamePos = strrpos( $thumbname, 'thumbnail' );
549  }
550 
551  if ( $handler && $fileNamePos !== false ) {
552  $paramString = substr( $thumbname, 0, $fileNamePos - 1 );
553  $extraParams = $handler->parseParamString( $paramString );
554  if ( $extraParams !== false ) {
555  return $params + $extraParams;
556  }
557  }
558 
559  // As a last ditch fallback, use the traditional common parameters
560  if ( preg_match( '!^(page(\d*)-)*(\d*)px-[^/]*$!', $thumbname, $matches ) ) {
561  list( /* all */, /* pagefull */, $pagenum, $size ) = $matches;
562  $params['width'] = $size;
563  if ( $pagenum ) {
564  $params['page'] = $pagenum;
565  }
566  return $params; // valid thumbnail URL
567  }
568  return null;
569 }
570 
578 function wfThumbErrorText( $status, $msgText ) {
579  wfThumbError( $status, htmlspecialchars( $msgText ) );
580 }
581 
592 function wfThumbError( $status, $msgHtml, $msgText = null, $context = [] ) {
593  global $wgShowHostnames;
594 
595  header( 'Cache-Control: no-cache' );
596  header( 'Content-Type: text/html; charset=utf-8' );
597  if ( $status == 400 || $status == 404 || $status == 429 ) {
599  } elseif ( $status == 403 ) {
600  HttpStatus::header( 403 );
601  header( 'Vary: Cookie' );
602  } else {
603  LoggerFactory::getInstance( 'thumb' )->error( $msgText ?: $msgHtml, $context );
604  HttpStatus::header( 500 );
605  }
606  if ( $wgShowHostnames ) {
607  header( 'X-MW-Thumbnail-Renderer: ' . wfHostname() );
608  $url = htmlspecialchars(
609  isset( $_SERVER['REQUEST_URI'] ) ? $_SERVER['REQUEST_URI'] : ''
610  );
611  $hostname = htmlspecialchars( wfHostname() );
612  $debug = "<!-- $url -->\n<!-- $hostname -->\n";
613  } else {
614  $debug = '';
615  }
616  $content = <<<EOT
617 <!DOCTYPE html>
618 <html><head>
619 <meta charset="UTF-8" />
620 <title>Error generating thumbnail</title>
621 </head>
622 <body>
623 <h1>Error generating thumbnail</h1>
624 <p>
625 $msgHtml
626 </p>
627 $debug
628 </body>
629 </html>
630 
631 EOT;
632  header( 'Content-Length: ' . strlen( $content ) );
633  echo $content;
634 }
#define the
table suitable for use with IDatabase::select()
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
the array() calling protocol came about after MediaWiki 1.4rc1.
$context
Definition: load.php:50
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:189
$wgTrivialMimeDetection
Definition: thumb.php:30
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException'returning false will NOT prevent logging $e
Definition: hooks.txt:2106
getKey()
Returns the message key.
execute($skipcache=false)
Get the result of the work (whatever it is), or the result of the error() function.
static header($code)
Output an HTTP status code header.
Definition: HttpStatus.php:96
wfHostname()
Fetch server name for use in error reporting etc.
wfThumbError($status, $msgHtml, $msgText=null, $context=[])
Output a thumbnail generation error message.
Definition: thumb.php:592
wfThumbHandle404()
Handle a thumbnail request via thumbnail file URL.
Definition: thumb.php:50
const PROTO_CURRENT
Definition: Defines.php:226
static getLocalClusterInstance()
Get the main cluster-local cache object.
getName()
Return the name of this file.
Definition: File.php:296
getRepo()
Returns the repository.
Definition: File.php:1853
wfStreamThumb(array $params)
Stream a thumbnail specified by parameters.
Definition: thumb.php:91
this hook is for auditing only $response
Definition: hooks.txt:806
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
wfExpandUrl($url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
$wgArticlePath
Definition: img_auth.php:45
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:52
A file object referring to either a standalone local file, or a file in a local repository with no da...
wfExtractThumbParams($file, $params)
Convert a thumbnail name (122px-foo.png) to parameters, using file handler.
Definition: thumb.php:520
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:Associative array mapping language codes to prefixed links of the form"language:title".&$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:1938
const TS_UNIX
Unix time - the number of seconds since 1970-01-01 00:00:00 UTC.
Definition: defines.php: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
wfTimestamp($outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
const THUMB_FULL_NAME
Definition: File.php:73
const RENDER_NOW
Force rendering in the current process.
Definition: File.php:58
Convenience class for dealing with PoolCounters using callbacks.
static getMain()
Static methods.
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:2495
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 unsetoffset-wrap String Wrap the message in html(usually something like"&lt
transform($params, $flags=0)
Transform a media file.
Definition: File.php:1033
static singleton()
Get a RepoGroup instance.
Definition: RepoGroup.php:59
wfExtractThumbRequestInfo($thumbRel)
Convert pathinfo type parameter, into normal request parameters.
Definition: thumb.php:481
$cache
Definition: mcc.php:33
$params
wfDeprecated($function, $version=false, $component=false, $callerOffset=2)
Throws a warning that $function is deprecated.
getSha1()
Get the SHA-1 base 36 hash of the file.
Definition: File.php:2116
static makeTitleSafe($ns, $title, $fragment= '', $interwiki= '')
Create a new Title from a namespace index and a DB key.
Definition: Title.php:535
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:957
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
const NS_FILE
Definition: Defines.php:62
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 local account $user
Definition: hooks.txt:246
isExpensiveToThumbnail()
True if creating thumbnails from the file is large or otherwise resource-intensive.
Definition: File.php:2267
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 RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist 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:1050
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")
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
wfThumbErrorText($status, $msgText)
Output a thumbnail generation error message.
Definition: thumb.php:578
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist 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:1050
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
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
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
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
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:806
$mediawiki
Definition: thumb.php:40
$debug
Definition: mcc.php:31
Implements some public methods and some protected utility functions which are required by multiple ch...
Definition: File.php:50
static getGroupPermissions($groups)
Get the permissions associated with a given list of groups.
Definition: User.php:4575
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:384
This document describes the state of Postgres support in MediaWiki
Definition: postgres.txt:4
$starttime
Definition: api.php:40
$matches