MediaWiki REL1_30
thumb.php
Go to the documentation of this file.
1<?php
26
27define( 'MW_NO_OUTPUT_COMPRESSION', 1 );
28require __DIR__ . '/includes/WebStart.php';
29
30// Don't use fancy MIME detection, just check the file extension for jpg/gif/png
32
33if ( 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
51function wfThumbHandle404() {
52 global $wgArticlePath;
53
54 # Set action base paths so that WebRequest::getPathInfo()
55 # recognizes the "X" as the 'title' in ../thumb_handler.php/X urls.
56 # Note: If Custom per-extension repo paths are set, this may break.
57 $repo = RepoGroup::singleton()->getLocalRepo();
58 $oldArticlePath = $wgArticlePath;
59 $wgArticlePath = $repo->getZoneUrl( 'thumb' ) . '/$1';
60
61 $matches = WebRequest::getPathInfo();
62
63 $wgArticlePath = $oldArticlePath;
64
65 if ( !isset( $matches['title'] ) ) {
66 wfThumbError( 404, 'Could not determine the name of the requested thumbnail.' );
67 return;
68 }
69
70 $params = wfExtractThumbRequestInfo( $matches['title'] ); // basic wiki URL param extracting
71 if ( $params == null ) {
72 wfThumbError( 400, 'The specified thumbnail parameters are not recognized.' );
73 return;
74 }
75
76 wfStreamThumb( $params ); // stream the thumbnail
77}
78
92function wfStreamThumb( array $params ) {
93 global $wgVaryOnXFP;
94
95 $headers = []; // HTTP headers to send
96
97 $fileName = isset( $params['f'] ) ? $params['f'] : '';
98
99 // Backwards compatibility parameters
100 if ( isset( $params['w'] ) ) {
101 $params['width'] = $params['w'];
102 unset( $params['w'] );
103 }
104 if ( isset( $params['width'] ) && substr( $params['width'], -2 ) == 'px' ) {
105 // strip the px (pixel) suffix, if found
106 $params['width'] = substr( $params['width'], 0, -2 );
107 }
108 if ( isset( $params['p'] ) ) {
109 $params['page'] = $params['p'];
110 }
111
112 // Is this a thumb of an archived file?
113 $isOld = ( isset( $params['archived'] ) && $params['archived'] );
114 unset( $params['archived'] ); // handlers don't care
115
116 // Is this a thumb of a temp file?
117 $isTemp = ( isset( $params['temp'] ) && $params['temp'] );
118 unset( $params['temp'] ); // handlers don't care
119
120 // Some basic input validation
121 $fileName = strtr( $fileName, '\\/', '__' );
122
123 // Actually fetch the image. Method depends on whether it is archived or not.
124 if ( $isTemp ) {
125 $repo = RepoGroup::singleton()->getLocalRepo()->getTempRepo();
126 $img = new UnregisteredLocalFile( null, $repo,
127 # Temp files are hashed based on the name without the timestamp.
128 # The thumbnails will be hashed based on the entire name however.
129 # @todo fix this convention to actually be reasonable.
130 $repo->getZonePath( 'public' ) . '/' . $repo->getTempHashPath( $fileName ) . $fileName
131 );
132 } elseif ( $isOld ) {
133 // Format is <timestamp>!<name>
134 $bits = explode( '!', $fileName, 2 );
135 if ( count( $bits ) != 2 ) {
136 wfThumbError( 404, wfMessage( 'badtitletext' )->parse() );
137 return;
138 }
139 $title = Title::makeTitleSafe( NS_FILE, $bits[1] );
140 if ( !$title ) {
141 wfThumbError( 404, wfMessage( 'badtitletext' )->parse() );
142 return;
143 }
144 $img = RepoGroup::singleton()->getLocalRepo()->newFromArchiveName( $title, $fileName );
145 } else {
146 $img = wfLocalFile( $fileName );
147 }
148
149 // Check the source file title
150 if ( !$img ) {
151 wfThumbError( 404, wfMessage( 'badtitletext' )->parse() );
152 return;
153 }
154
155 // Check permissions if there are read restrictions
156 $varyHeader = [];
157 if ( !in_array( 'read', User::getGroupPermissions( [ '*' ] ), true ) ) {
158 if ( !$img->getTitle() || !$img->getTitle()->userCan( 'read' ) ) {
159 wfThumbError( 403, 'Access denied. You do not have permission to access ' .
160 'the source file.' );
161 return;
162 }
163 $headers[] = 'Cache-Control: private';
164 $varyHeader[] = 'Cookie';
165 }
166
167 // Check if the file is hidden
168 if ( $img->isDeleted( File::DELETED_FILE ) ) {
169 wfThumbErrorText( 404, "The source file '$fileName' does not exist." );
170 return;
171 }
172
173 // Do rendering parameters extraction from thumbnail name.
174 if ( isset( $params['thumbName'] ) ) {
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
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
389function wfGenerateThumbnail( File $file, array $params, $thumbName, $thumbPath ) {
391
392 $cache = ObjectCache::getLocalClusterInstance();
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
486function 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
525function 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 // FIXME: Files in the temp zone don't set a MIME type, which means
534 // they don't have a handler. Which means we can't parse the param
535 // string. However, not a big issue as what good is a param string
536 // if you have no handler to make use of the param string and
537 // actually generate the thumbnail.
538 $handler = $file->getHandler();
539
540 // Based on UploadStash::parseKey
541 $fileNamePos = strrpos( $thumbname, $params['f'] );
542 if ( $fileNamePos === false ) {
543 // Maybe using a short filename? (see FileRepo::nameForThumb)
544 $fileNamePos = strrpos( $thumbname, 'thumbnail' );
545 }
546
547 if ( $handler && $fileNamePos !== false ) {
548 $paramString = substr( $thumbname, 0, $fileNamePos - 1 );
549 $extraParams = $handler->parseParamString( $paramString );
550 if ( $extraParams !== false ) {
551 return $params + $extraParams;
552 }
553 }
554
555 // As a last ditch fallback, use the traditional common parameters
556 if ( preg_match( '!^(page(\d*)-)*(\d*)px-[^/]*$!', $thumbname, $matches ) ) {
557 list( /* all */, /* pagefull */, $pagenum, $size ) = $matches;
558 $params['width'] = $size;
559 if ( $pagenum ) {
560 $params['page'] = $pagenum;
561 }
562 return $params; // valid thumbnail URL
563 }
564 return null;
565}
566
574function wfThumbErrorText( $status, $msgText ) {
575 wfThumbError( $status, htmlspecialchars( $msgText ) );
576}
577
588function wfThumbError( $status, $msgHtml, $msgText = null, $context = [] ) {
589 global $wgShowHostnames;
590
591 header( 'Cache-Control: no-cache' );
592 header( 'Content-Type: text/html; charset=utf-8' );
593 if ( $status == 400 || $status == 404 || $status == 429 ) {
595 } elseif ( $status == 403 ) {
596 HttpStatus::header( 403 );
597 header( 'Vary: Cookie' );
598 } else {
599 LoggerFactory::getInstance( 'thumb' )->error( $msgText ?: $msgHtml, $context );
600 HttpStatus::header( 500 );
601 }
602 if ( $wgShowHostnames ) {
603 header( 'X-MW-Thumbnail-Renderer: ' . wfHostname() );
604 $url = htmlspecialchars(
605 isset( $_SERVER['REQUEST_URI'] ) ? $_SERVER['REQUEST_URI'] : ''
606 );
607 $hostname = htmlspecialchars( wfHostname() );
608 $debug = "<!-- $url -->\n<!-- $hostname -->\n";
609 } else {
610 $debug = '';
611 }
612 $content = <<<EOT
613<!DOCTYPE html>
614<html><head>
615<meta charset="UTF-8" />
616<title>Error generating thumbnail</title>
617</head>
618<body>
619<h1>Error generating thumbnail</h1>
620<p>
621$msgHtml
622</p>
623$debug
624</body>
625</html>
626
627EOT;
628 header( 'Content-Length: ' . strlen( $content ) );
629 echo $content;
630}
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:158
$wgShowHostnames
Expose backend server host names through the API and various HTML comments.
$wgVaryOnXFP
Add X-Forwarded-Proto to the Vary and Key headers for API requests and RSS/Atom feeds.
$wgAttemptFailureEpoch
Certain operations are avoided if there were too many recent failures, for example,...
wfThumbIsStandard(File $file, array $params)
Returns true if these thumbnail parameters match one that MediaWiki requests from file description pa...
wfLocalFile( $title)
Get an object referring to a locally registered file.
wfHostname()
Fetch server name for use in error reporting etc.
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
$starttime
Definition api.php:40
Implements some public methods and some protected utility functions which are required by multiple ch...
Definition File.php:51
const RENDER_NOW
Force rendering in the current process.
Definition File.php:59
const DELETED_FILE
Definition File.php:53
const THUMB_FULL_NAME
Definition File.php:74
static header( $code)
Output an HTTP status code header.
MediaWiki exception.
MediaWiki exception thrown by some methods when the transform parameter array is invalid.
Base class for the output of MediaHandler::doTransform() and File::transform().
PSR-3 logger instance factory.
MediaWikiServices is the service locator for the application scope of MediaWiki.
Convenience class for dealing with PoolCounters using callbacks.
execute( $skipcache=false)
Get the result of the work (whatever it is), or the result of the error() function.
static singleton()
Get a RepoGroup instance.
Definition RepoGroup.php:59
static getMain()
Static methods.
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition Status.php:40
A file object referring to either a standalone local file, or a file in a local repository with no da...
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
when a variable name is used in a function
Definition design.txt:94
namespace being checked & $result
Definition hooks.txt:2293
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:2780
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;div ...>$1&lt;/div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
this hook is for auditing only $response
Definition hooks.txt:781
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. '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 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object '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). '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:1049
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:901
returning false will NOT prevent logging $e
Definition hooks.txt:2146
const NS_FILE
Definition Defines.php:71
const PROTO_CURRENT
Definition Defines.php:223
$wgArticlePath
Definition img_auth.php:45
getKey()
Returns the message key.
$debug
Definition mcc.php:31
$cache
Definition mcc.php:33
A helper class for throttling authentication attempts.
$params
wfThumbHandle404()
Handle a thumbnail request via thumbnail file URL.
Definition thumb.php:51
wfThumbError( $status, $msgHtml, $msgText=null, $context=[])
Output a thumbnail generation error message.
Definition thumb.php:588
wfStreamThumb(array $params)
Stream a thumbnail specified by parameters.
Definition thumb.php:92
wfGenerateThumbnail(File $file, array $params, $thumbName, $thumbPath)
Actually try to generate a new thumbnail.
Definition thumb.php:389
wfExtractThumbRequestInfo( $thumbRel)
Convert pathinfo type parameter, into normal request parameters.
Definition thumb.php:486
$wgTrivialMimeDetection
Definition thumb.php:31
wfThumbErrorText( $status, $msgText)
Output a thumbnail generation error message.
Definition thumb.php:574
wfExtractThumbParams( $file, $params)
Convert a thumbnail name (122px-foo.png) to parameters, using file handler.
Definition thumb.php:525
$mediawiki
Definition thumb.php:41