MediaWiki REL1_32
ZipDirectoryReader.php
Go to the documentation of this file.
1<?php
88 public static function read( $fileName, $callback, $options = [] ) {
89 $zdr = new self( $fileName, $callback, $options );
90
91 return $zdr->execute();
92 }
93
95 protected $fileName;
96
98 protected $file;
99
101 protected $fileLength;
102
104 protected $buffer;
105
107 protected $callback;
108
110 protected $zip64 = false;
111
114
115 protected $data;
116
118 const ZIP64_EXTRA_HEADER = 0x0001;
119
121 const SEGSIZE = 16384;
122
124 const GENERAL_UTF8 = 11;
125
128
135 protected function __construct( $fileName, $callback, $options ) {
136 $this->fileName = $fileName;
137 $this->callback = $callback;
138
139 if ( isset( $options['zip64'] ) ) {
140 $this->zip64 = $options['zip64'];
141 }
142 }
143
149 function execute() {
150 $this->file = fopen( $this->fileName, 'r' );
151 $this->data = [];
152 if ( !$this->file ) {
153 return Status::newFatal( 'zip-file-open-error' );
154 }
155
156 $status = Status::newGood();
157 try {
159 if ( $this->zip64 ) {
160 list( $offset, $size ) = $this->findZip64CentralDirectory();
161 $this->readCentralDirectory( $offset, $size );
162 } else {
163 if ( $this->eocdr['CD size'] == 0xffffffff
164 || $this->eocdr['CD offset'] == 0xffffffff
165 || $this->eocdr['CD entries total'] == 0xffff
166 ) {
167 $this->error( 'zip-unsupported', 'Central directory header indicates ZIP64, ' .
168 'but we are in legacy mode. Rejecting this upload is necessary to avoid ' .
169 'opening vulnerabilities on clients using OpenJDK 7 or later.' );
170 }
171
172 list( $offset, $size ) = $this->findOldCentralDirectory();
173 $this->readCentralDirectory( $offset, $size );
174 }
175 } catch ( ZipDirectoryReaderError $e ) {
176 $status->fatal( $e->getErrorCode() );
177 }
178
179 fclose( $this->file );
180
181 return $status;
182 }
183
190 function error( $code, $debugMessage ) {
191 wfDebug( __CLASS__ . ": Fatal error: $debugMessage\n" );
192 throw new ZipDirectoryReaderError( $code );
193 }
194
201 $info = [
202 'signature' => 4,
203 'disk' => 2,
204 'CD start disk' => 2,
205 'CD entries this disk' => 2,
206 'CD entries total' => 2,
207 'CD size' => 4,
208 'CD offset' => 4,
209 'file comment length' => 2,
210 ];
211 $structSize = $this->getStructSize( $info );
212 $startPos = $this->getFileLength() - 65536 - $structSize;
213 if ( $startPos < 0 ) {
214 $startPos = 0;
215 }
216
217 if ( $this->getFileLength() === 0 ) {
218 $this->error( 'zip-wrong-format', "The file is empty." );
219 }
220
221 $block = $this->getBlock( $startPos );
222 $sigPos = strrpos( $block, "PK\x05\x06" );
223 if ( $sigPos === false ) {
224 $this->error( 'zip-wrong-format',
225 "zip file lacks EOCDR signature. It probably isn't a zip file." );
226 }
227
228 $this->eocdr = $this->unpack( substr( $block, $sigPos ), $info );
229 $this->eocdr['EOCDR size'] = $structSize + $this->eocdr['file comment length'];
230
231 if ( $structSize + $this->eocdr['file comment length'] != strlen( $block ) - $sigPos ) {
232 $this->error( 'zip-bad', 'trailing bytes after the end of the file comment' );
233 }
234 if ( $this->eocdr['disk'] !== 0
235 || $this->eocdr['CD start disk'] !== 0
236 ) {
237 $this->error( 'zip-unsupported', 'more than one disk (in EOCDR)' );
238 }
239 $this->eocdr += $this->unpack(
240 $block,
241 [ 'file comment' => [ 'string', $this->eocdr['file comment length'] ] ],
242 $sigPos + $structSize );
243 $this->eocdr['position'] = $startPos + $sigPos;
244 }
245
251 $info = [
252 'signature' => [ 'string', 4 ],
253 'eocdr64 start disk' => 4,
254 'eocdr64 offset' => 8,
255 'number of disks' => 4,
256 ];
257 $structSize = $this->getStructSize( $info );
258
259 $start = $this->getFileLength() - $this->eocdr['EOCDR size'] - $structSize;
260 $block = $this->getBlock( $start, $structSize );
261 $this->eocdr64Locator = $data = $this->unpack( $block, $info );
262
263 if ( $data['signature'] !== "PK\x06\x07" ) {
264 // Note: Java will allow this and continue to read the
265 // EOCDR64, so we have to reject the upload, we can't
266 // just use the EOCDR header instead.
267 $this->error( 'zip-bad', 'wrong signature on Zip64 end of central directory locator' );
268 }
269 }
270
276 if ( $this->eocdr64Locator['eocdr64 start disk'] != 0
277 || $this->eocdr64Locator['number of disks'] != 0
278 ) {
279 $this->error( 'zip-unsupported', 'more than one disk (in EOCDR64 locator)' );
280 }
281
282 $info = [
283 'signature' => [ 'string', 4 ],
284 'EOCDR64 size' => 8,
285 'version made by' => 2,
286 'version needed' => 2,
287 'disk' => 4,
288 'CD start disk' => 4,
289 'CD entries this disk' => 8,
290 'CD entries total' => 8,
291 'CD size' => 8,
292 'CD offset' => 8
293 ];
294 $structSize = $this->getStructSize( $info );
295 $block = $this->getBlock( $this->eocdr64Locator['eocdr64 offset'], $structSize );
296 $this->eocdr64 = $data = $this->unpack( $block, $info );
297 if ( $data['signature'] !== "PK\x06\x06" ) {
298 $this->error( 'zip-bad', 'wrong signature on Zip64 end of central directory record' );
299 }
300 if ( $data['disk'] !== 0
301 || $data['CD start disk'] !== 0
302 ) {
303 $this->error( 'zip-unsupported', 'more than one disk (in EOCDR64)' );
304 }
305 }
306
314 $size = $this->eocdr['CD size'];
315 $offset = $this->eocdr['CD offset'];
316 $endPos = $this->eocdr['position'];
317
318 // Some readers use the EOCDR position instead of the offset field
319 // to find the directory, so to be safe, we check if they both agree.
320 if ( $offset + $size != $endPos ) {
321 $this->error( 'zip-bad', 'the central directory does not immediately precede the end ' .
322 'of central directory record' );
323 }
324
325 return [ $offset, $size ];
326 }
327
335 // The spec is ambiguous about the exact rules of precedence between the
336 // ZIP64 headers and the original headers. Here we follow zip_util.c
337 // from OpenJDK 7.
338 $size = $this->eocdr['CD size'];
339 $offset = $this->eocdr['CD offset'];
340 $numEntries = $this->eocdr['CD entries total'];
341 $endPos = $this->eocdr['position'];
342 if ( $size == 0xffffffff
343 || $offset == 0xffffffff
344 || $numEntries == 0xffff
345 ) {
347
348 if ( isset( $this->eocdr64Locator['eocdr64 offset'] ) ) {
350 if ( isset( $this->eocdr64['CD offset'] ) ) {
351 $size = $this->eocdr64['CD size'];
352 $offset = $this->eocdr64['CD offset'];
353 $endPos = $this->eocdr64Locator['eocdr64 offset'];
354 }
355 }
356 }
357 // Some readers use the EOCDR position instead of the offset field
358 // to find the directory, so to be safe, we check if they both agree.
359 if ( $offset + $size != $endPos ) {
360 $this->error( 'zip-bad', 'the central directory does not immediately precede the end ' .
361 'of central directory record' );
362 }
363
364 return [ $offset, $size ];
365 }
366
372 function readCentralDirectory( $offset, $size ) {
373 $block = $this->getBlock( $offset, $size );
374
375 $fixedInfo = [
376 'signature' => [ 'string', 4 ],
377 'version made by' => 2,
378 'version needed' => 2,
379 'general bits' => 2,
380 'compression method' => 2,
381 'mod time' => 2,
382 'mod date' => 2,
383 'crc-32' => 4,
384 'compressed size' => 4,
385 'uncompressed size' => 4,
386 'name length' => 2,
387 'extra field length' => 2,
388 'comment length' => 2,
389 'disk number start' => 2,
390 'internal attrs' => 2,
391 'external attrs' => 4,
392 'local header offset' => 4,
393 ];
394 $fixedSize = $this->getStructSize( $fixedInfo );
395
396 $pos = 0;
397 while ( $pos < $size ) {
398 $data = $this->unpack( $block, $fixedInfo, $pos );
399 $pos += $fixedSize;
400
401 if ( $data['signature'] !== "PK\x01\x02" ) {
402 $this->error( 'zip-bad', 'Invalid signature found in directory entry' );
403 }
404
405 $variableInfo = [
406 'name' => [ 'string', $data['name length'] ],
407 'extra field' => [ 'string', $data['extra field length'] ],
408 'comment' => [ 'string', $data['comment length'] ],
409 ];
410 $data += $this->unpack( $block, $variableInfo, $pos );
411 $pos += $this->getStructSize( $variableInfo );
412
413 if ( $this->zip64 && (
414 $data['compressed size'] == 0xffffffff
415 || $data['uncompressed size'] == 0xffffffff
416 || $data['local header offset'] == 0xffffffff )
417 ) {
418 $zip64Data = $this->unpackZip64Extra( $data['extra field'] );
419 if ( $zip64Data ) {
420 $data = $zip64Data + $data;
421 }
422 }
423
424 if ( $this->testBit( $data['general bits'], self::GENERAL_CD_ENCRYPTED ) ) {
425 $this->error( 'zip-unsupported', 'central directory encryption is not supported' );
426 }
427
428 // Convert the timestamp into MediaWiki format
429 // For the format, please see the MS-DOS 2.0 Programmer's Reference,
430 // pages 3-5 and 3-6.
431 $time = $data['mod time'];
432 $date = $data['mod date'];
433
434 $year = 1980 + ( $date >> 9 );
435 $month = ( $date >> 5 ) & 15;
436 $day = $date & 31;
437 $hour = ( $time >> 11 ) & 31;
438 $minute = ( $time >> 5 ) & 63;
439 $second = ( $time & 31 ) * 2;
440 $timestamp = sprintf( "%04d%02d%02d%02d%02d%02d",
441 $year, $month, $day, $hour, $minute, $second );
442
443 // Convert the character set in the file name
444 if ( $this->testBit( $data['general bits'], self::GENERAL_UTF8 ) ) {
445 $name = $data['name'];
446 } else {
447 $name = iconv( 'CP437', 'UTF-8', $data['name'] );
448 }
449
450 // Compile a data array for the user, with a sensible format
451 $userData = [
452 'name' => $name,
453 'mtime' => $timestamp,
454 'size' => $data['uncompressed size'],
455 ];
456 call_user_func( $this->callback, $userData );
457 }
458 }
459
465 function unpackZip64Extra( $extraField ) {
466 $extraHeaderInfo = [
467 'id' => 2,
468 'size' => 2,
469 ];
470 $extraHeaderSize = $this->getStructSize( $extraHeaderInfo );
471
472 $zip64ExtraInfo = [
473 'uncompressed size' => 8,
474 'compressed size' => 8,
475 'local header offset' => 8,
476 'disk number start' => 4,
477 ];
478
479 $extraPos = 0;
480 while ( $extraPos < strlen( $extraField ) ) {
481 $extra = $this->unpack( $extraField, $extraHeaderInfo, $extraPos );
482 $extraPos += $extraHeaderSize;
483 $extra += $this->unpack( $extraField,
484 [ 'data' => [ 'string', $extra['size'] ] ],
485 $extraPos );
486 $extraPos += $extra['size'];
487
488 if ( $extra['id'] == self::ZIP64_EXTRA_HEADER ) {
489 return $this->unpack( $extra['data'], $zip64ExtraInfo );
490 }
491 }
492
493 return false;
494 }
495
500 function getFileLength() {
501 if ( $this->fileLength === null ) {
502 $stat = fstat( $this->file );
503 $this->fileLength = $stat['size'];
504 }
505
506 return $this->fileLength;
507 }
508
519 function getBlock( $start, $length = null ) {
520 $fileLength = $this->getFileLength();
521 if ( $start >= $fileLength ) {
522 $this->error( 'zip-bad', "getBlock() requested position $start, " .
523 "file length is $fileLength" );
524 }
525 if ( $length === null ) {
526 $length = $fileLength - $start;
527 }
528 $end = $start + $length;
529 if ( $end > $fileLength ) {
530 $this->error( 'zip-bad', "getBlock() requested end position $end, " .
531 "file length is $fileLength" );
532 }
533 $startSeg = floor( $start / self::SEGSIZE );
534 $endSeg = ceil( $end / self::SEGSIZE );
535
536 $block = '';
537 for ( $segIndex = $startSeg; $segIndex <= $endSeg; $segIndex++ ) {
538 $block .= $this->getSegment( $segIndex );
539 }
540
541 $block = substr( $block,
542 $start - $startSeg * self::SEGSIZE,
543 $length );
544
545 if ( strlen( $block ) < $length ) {
546 $this->error( 'zip-bad', 'getBlock() returned an unexpectedly small amount of data' );
547 }
548
549 return $block;
550 }
551
565 function getSegment( $segIndex ) {
566 if ( !isset( $this->buffer[$segIndex] ) ) {
567 $bytePos = $segIndex * self::SEGSIZE;
568 if ( $bytePos >= $this->getFileLength() ) {
569 $this->buffer[$segIndex] = '';
570
571 return '';
572 }
573 if ( fseek( $this->file, $bytePos ) ) {
574 $this->error( 'zip-bad', "seek to $bytePos failed" );
575 }
576 $seg = fread( $this->file, self::SEGSIZE );
577 if ( $seg === false ) {
578 $this->error( 'zip-bad', "read from $bytePos failed" );
579 }
580 $this->buffer[$segIndex] = $seg;
581 }
582
583 return $this->buffer[$segIndex];
584 }
585
591 function getStructSize( $struct ) {
592 $size = 0;
593 foreach ( $struct as $type ) {
594 if ( is_array( $type ) ) {
595 list( , $fieldSize ) = $type;
596 $size += $fieldSize;
597 } else {
598 $size += $type;
599 }
600 }
601
602 return $size;
603 }
604
627 function unpack( $string, $struct, $offset = 0 ) {
628 $size = $this->getStructSize( $struct );
629 if ( $offset + $size > strlen( $string ) ) {
630 $this->error( 'zip-bad', 'unpack() would run past the end of the supplied string' );
631 }
632
633 $data = [];
634 $pos = $offset;
635 foreach ( $struct as $key => $type ) {
636 if ( is_array( $type ) ) {
637 list( $typeName, $fieldSize ) = $type;
638 switch ( $typeName ) {
639 case 'string':
640 $data[$key] = substr( $string, $pos, $fieldSize );
641 $pos += $fieldSize;
642 break;
643 default:
644 throw new MWException( __METHOD__ . ": invalid type \"$typeName\"" );
645 }
646 } else {
647 // Unsigned little-endian integer
648 $length = intval( $type );
649
650 // Calculate the value. Use an algorithm which automatically
651 // upgrades the value to floating point if necessary.
652 $value = 0;
653 for ( $i = $length - 1; $i >= 0; $i-- ) {
654 $value *= 256;
655 $value += ord( $string[$pos + $i] );
656 }
657
658 // Throw an exception if there was loss of precision
659 if ( $value > 2 ** 52 ) {
660 $this->error( 'zip-unsupported', 'number too large to be stored in a double. ' .
661 'This could happen if we tried to unpack a 64-bit structure ' .
662 'at an invalid location.' );
663 }
664 $data[$key] = $value;
665 $pos += $length;
666 }
667 }
668
669 return $data;
670 }
671
680 function testBit( $value, $bitIndex ) {
681 return (bool)( ( $value >> $bitIndex ) & 1 );
682 }
683
688 function hexDump( $s ) {
689 $n = strlen( $s );
690 for ( $i = 0; $i < $n; $i += 16 ) {
691 printf( "%08X ", $i );
692 for ( $j = 0; $j < 16; $j++ ) {
693 print " ";
694 if ( $j == 8 ) {
695 print " ";
696 }
697 if ( $i + $j >= $n ) {
698 print " ";
699 } else {
700 printf( "%02X", ord( $s[$i + $j] ) );
701 }
702 }
703
704 print " |";
705 for ( $j = 0; $j < 16; $j++ ) {
706 if ( $i + $j >= $n ) {
707 print " ";
708 } elseif ( ctype_print( $s[$i + $j] ) ) {
709 print $s[$i + $j];
710 } else {
711 print '.';
712 }
713 }
714 print "|\n";
715 }
716 }
717}
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
MediaWiki exception.
Internal exception class.
A class for reading ZIP file directories, for the purposes of upload verification.
$callback
The file data callback.
const GENERAL_UTF8
The index of the "general field" bit for UTF-8 file names.
readEndOfCentralDirectoryRecord()
Read the header which is at the end of the central directory, unimaginatively called the "end of cent...
error( $code, $debugMessage)
Throw an error, and log a debug message.
execute()
Read the directory according to settings in $this.
__construct( $fileName, $callback, $options)
Private constructor.
readZip64EndOfCentralDirectoryRecord()
Read the header called the "ZIP64 end of central directory record".
getSegment( $segIndex)
Get a section of the file starting at position $segIndex * self::SEGSIZE, of length self::SEGSIZE.
const ZIP64_EXTRA_HEADER
The "extra field" ID for ZIP64 central directory entries.
findZip64CentralDirectory()
Find the location of the central directory, as would be seen by a ZIP64-compliant reader.
$file
The opened file resource.
static read( $fileName, $callback, $options=[])
Read a ZIP file and call a function for each file discovered in it.
testBit( $value, $bitIndex)
Returns a bit from a given position in an integer value, converted to boolean.
getFileLength()
Get the length of the file.
const GENERAL_CD_ENCRYPTED
The index of the "general field" bit for central directory encryption.
getStructSize( $struct)
Get the size of a structure in bytes.
readZip64EndOfCentralDirectoryLocator()
Read the header called the "ZIP64 end of central directory locator".
findOldCentralDirectory()
Find the location of the central directory, as would be seen by a non-ZIP64 reader.
$buffer
A segmented cache of the file contents.
hexDump( $s)
Debugging helper function which dumps a string in hexdump -C format.
getBlock( $start, $length=null)
Get the file contents from a given offset.
unpack( $string, $struct, $offset=0)
Unpack a binary structure.
const SEGSIZE
The segment size for the file contents cache.
$fileLength
The cached length of the file, or null if it has not been loaded yet.
readCentralDirectory( $offset, $size)
Read the central directory at the given location.
unpackZip64Extra( $extraField)
Interpret ZIP64 "extra field" data and return an associative array.
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
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
while(( $__line=Maintenance::readconsole()) !==false) print
Definition eval.php:64
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition hooks.txt:1841
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit '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). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition hooks.txt:1305
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition hooks.txt:2050
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 & $code
Definition hooks.txt:895
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:302
Using a hook running we can avoid having all this option specific stuff in our mainline code Using the function We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing we can concentrate it all in an extension file
Definition hooks.txt:106
returning false will NOT prevent logging $e
Definition hooks.txt:2226
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:37
This document describes the state of Postgres support in and is fairly well maintained The main code is very well while extensions are very hit and miss it is probably the most supported database after MySQL Much of the work in making MediaWiki database agnostic came about through the work of creating Postgres as and are nearing end of but without copying over all the usage comments General notes on the but these can almost always be programmed around *Although Postgres has a true BOOLEAN boolean columns are always mapped to as the code does not always treat the column as a and VARBINARY columns should simply be TEXT The only exception is when VARBINARY is used to store true binary data
Definition postgres.txt:43