Go to the documentation of this file.
91 return $zdr->execute();
150 $this->
file = fopen( $this->fileName,
'r' );
152 if ( !$this->
file ) {
159 if ( $this->zip64 ) {
163 if ( $this->eocdr[
'CD size'] == 0xffffffff
164 || $this->eocdr[
'CD offset'] == 0xffffffff
165 || $this->eocdr[
'CD entries total'] == 0xffff
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.' );
179 fclose( $this->
file );
191 wfDebug( __CLASS__ .
": Fatal error: $debugMessage\n" );
204 'CD start disk' => 2,
205 'CD entries this disk' => 2,
206 'CD entries total' => 2,
209 'file comment length' => 2,
213 if ( $startPos < 0 ) {
218 $this->
error(
'zip-wrong-format',
"The file is empty." );
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." );
228 $this->eocdr = $this->
unpack( substr( $block, $sigPos ), $info );
229 $this->eocdr[
'EOCDR size'] = $structSize + $this->eocdr[
'file comment length'];
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' );
234 if ( $this->eocdr[
'disk'] !== 0
235 || $this->eocdr[
'CD start disk'] !== 0
237 $this->
error(
'zip-unsupported',
'more than one disk (in EOCDR)' );
239 $this->eocdr += $this->
unpack(
241 [
'file comment' => [
'string', $this->eocdr[
'file comment length'] ] ],
242 $sigPos + $structSize );
243 $this->eocdr[
'position'] = $startPos + $sigPos;
252 'signature' => [
'string', 4 ],
253 'eocdr64 start disk' => 4,
254 'eocdr64 offset' => 8,
255 'number of disks' => 4,
259 $start = $this->
getFileLength() - $this->eocdr[
'EOCDR size'] - $structSize;
260 $block = $this->
getBlock( $start, $structSize );
261 $this->eocdr64Locator =
$data = $this->
unpack( $block, $info );
263 if (
$data[
'signature'] !==
"PK\x06\x07" ) {
267 $this->
error(
'zip-bad',
'wrong signature on Zip64 end of central directory locator' );
276 if ( $this->eocdr64Locator[
'eocdr64 start disk'] != 0
277 || $this->eocdr64Locator[
'number of disks'] != 0
279 $this->
error(
'zip-unsupported',
'more than one disk (in EOCDR64 locator)' );
283 'signature' => [
'string', 4 ],
285 'version made by' => 2,
286 'version needed' => 2,
288 'CD start disk' => 4,
289 'CD entries this disk' => 8,
290 'CD entries total' => 8,
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' );
300 if (
$data[
'disk'] !== 0
301 ||
$data[
'CD start disk'] !== 0
303 $this->
error(
'zip-unsupported',
'more than one disk (in EOCDR64)' );
314 $size = $this->eocdr[
'CD size'];
315 $offset = $this->eocdr[
'CD offset'];
316 $endPos = $this->eocdr[
'position'];
320 if ( $offset + $size != $endPos ) {
321 $this->
error(
'zip-bad',
'the central directory does not immediately precede the end ' .
322 'of central directory record' );
325 return [ $offset, $size ];
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
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'];
359 if ( $offset + $size != $endPos ) {
360 $this->
error(
'zip-bad',
'the central directory does not immediately precede the end ' .
361 'of central directory record' );
364 return [ $offset, $size ];
373 $block = $this->
getBlock( $offset, $size );
376 'signature' => [
'string', 4 ],
377 'version made by' => 2,
378 'version needed' => 2,
380 'compression method' => 2,
384 'compressed size' => 4,
385 'uncompressed size' => 4,
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,
397 while ( $pos < $size ) {
401 if (
$data[
'signature'] !==
"PK\x01\x02" ) {
402 $this->
error(
'zip-bad',
'Invalid signature found in directory entry' );
406 'name' => [
'string',
$data[
'name length'] ],
407 'extra field' => [
'string',
$data[
'extra field length'] ],
408 'comment' => [
'string',
$data[
'comment length'] ],
410 $data += $this->
unpack( $block, $variableInfo, $pos );
413 if ( $this->zip64 && (
414 $data[
'compressed size'] == 0xffffffff
415 ||
$data[
'uncompressed size'] == 0xffffffff
416 ||
$data[
'local header offset'] == 0xffffffff )
424 if ( $this->
testBit(
$data[
'general bits'], self::GENERAL_CD_ENCRYPTED ) ) {
425 $this->
error(
'zip-unsupported',
'central directory encryption is not supported' );
432 $date =
$data[
'mod date'];
434 $year = 1980 + ( $date >> 9 );
435 $month = ( $date >> 5 ) & 15;
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 );
444 if ( $this->
testBit(
$data[
'general bits'], self::GENERAL_UTF8 ) ) {
447 $name = iconv(
'CP437',
'UTF-8',
$data[
'name'] );
453 'mtime' => $timestamp,
454 'size' =>
$data[
'uncompressed size'],
456 call_user_func( $this->callback, $userData );
473 'uncompressed size' => 8,
474 'compressed size' => 8,
475 'local header offset' => 8,
476 'disk number start' => 4,
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'] ] ],
486 $extraPos += $extra[
'size'];
488 if ( $extra[
'id'] == self::ZIP64_EXTRA_HEADER ) {
489 return $this->
unpack( $extra[
'data'], $zip64ExtraInfo );
501 if ( $this->fileLength ===
null ) {
502 $stat = fstat( $this->
file );
503 $this->fileLength = $stat[
'size'];
522 $this->
error(
'zip-bad',
"getBlock() requested position $start, " .
523 "file length is $fileLength" );
525 if ( $length ===
null ) {
528 $end = $start + $length;
530 $this->
error(
'zip-bad',
"getBlock() requested end position $end, " .
531 "file length is $fileLength" );
533 $startSeg = floor( $start / self::SEGSIZE );
534 $endSeg = ceil( $end / self::SEGSIZE );
537 for ( $segIndex = $startSeg; $segIndex <= $endSeg; $segIndex++ ) {
541 $block = substr( $block,
542 $start - $startSeg * self::SEGSIZE,
545 if ( strlen( $block ) < $length ) {
546 $this->
error(
'zip-bad',
'getBlock() returned an unexpectedly small amount of data' );
566 if ( !isset( $this->buffer[$segIndex] ) ) {
569 $this->buffer[$segIndex] =
'';
573 if ( fseek( $this->
file, $bytePos ) ) {
574 $this->
error(
'zip-bad',
"seek to $bytePos failed" );
576 $seg = fread( $this->
file, self::SEGSIZE );
577 if ( $seg ===
false ) {
578 $this->
error(
'zip-bad',
"read from $bytePos failed" );
580 $this->buffer[$segIndex] = $seg;
583 return $this->buffer[$segIndex];
594 if ( is_array(
$type ) ) {
627 function unpack( $string, $struct, $offset = 0 ) {
629 if ( $offset + $size > strlen( $string ) ) {
630 $this->
error(
'zip-bad',
'unpack() would run past the end of the supplied string' );
635 foreach ( $struct
as $key =>
$type ) {
636 if ( is_array(
$type ) ) {
638 switch ( $typeName ) {
640 $data[$key] = substr( $string, $pos, $fieldSize );
644 throw new MWException( __METHOD__ .
": invalid type \"$typeName\"" );
648 $length = intval(
$type );
653 for ( $i = $length - 1; $i >= 0; $i-- ) {
655 $value += ord( $string[$pos + $i] );
659 if (
$value > pow( 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.' );
681 return (
bool)( (
$value >> $bitIndex ) & 1 );
690 for ( $i = 0; $i < $n; $i += 16 ) {
691 printf(
"%08X ", $i );
692 for ( $j = 0; $j < 16; $j++ ) {
697 if ( $i + $j >= $n ) {
700 printf(
"%02X", ord(
$s[$i + $j] ) );
705 for ( $j = 0; $j < 16; $j++ ) {
706 if ( $i + $j >= $n ) {
708 } elseif ( ctype_print(
$s[$i + $j] ) ) {
726 $this->errorCode =
$code;
727 parent::__construct(
"ZipDirectoryReader error: $code" );
getBlock( $start, $length=null)
Get the file contents from a given offset.
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
readZip64EndOfCentralDirectoryLocator()
Read the header called the "ZIP64 end of central directory locator".
getFileLength()
Get the length of the file.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
static newFatal( $message)
Factory function for fatal errors.
findZip64CentralDirectory()
Find the location of the central directory, as would be seen by a ZIP64-compliant reader.
unpack( $string, $struct, $offset=0)
Unpack a binary structure.
Allows to change the fields on the form that will be generated $name
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 but section is usually empty its values are the globals values before the output is cached my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
findOldCentralDirectory()
Find the location of the central directory, as would be seen by a non-ZIP64 reader.
const ZIP64_EXTRA_HEADER
The "extra field" ID for ZIP64 central directory entries.
unpackZip64Extra( $extraField)
Interpret ZIP64 "extra field" data and return an associative array.
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
$buffer
A segmented cache of the file contents.
testBit( $value, $bitIndex)
Returns a bit from a given position in an integer value, converted to boolean.
A class for reading ZIP file directories, for the purposes of upload verification.
$file
The opened file resource.
hexDump( $s)
Debugging helper function which dumps a string in hexdump -C format.
execute()
Read the directory according to settings in $this.
__construct( $fileName, $callback, $options)
Private constructor.
see documentation in includes Linker php for Linker::makeImageLink & $time
getStructSize( $struct)
Get the size of a structure in bytes.
readZip64EndOfCentralDirectoryRecord()
Read the header called the "ZIP64 end of central directory record".
error( $code, $debugMessage)
Throw an error, and log a debug message.
$callback
The file data callback.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
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
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
const GENERAL_UTF8
The index of the "general field" bit for UTF-8 file names.
static newGood( $value=null)
Factory function for good results.
getSegment( $segIndex)
Get a section of the file starting at position $segIndex * self::SEGSIZE, of length self::SEGSIZE.
readEndOfCentralDirectoryRecord()
Read the header which is at the end of the central directory, unimaginatively called the "end of cent...
static read( $fileName, $callback, $options=[])
Read a ZIP file and call a function for each file discovered in it.
readCentralDirectory( $offset, $size)
Read the central directory at the given location.
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
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
$fileLength
The cached length of the file, or null if it has not been loaded yet.
const GENERAL_CD_ENCRYPTED
The index of the "general field" bit for central directory encryption.
const SEGSIZE
The segment size for the file contents cache.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of data
Internal exception class.