MediaWiki  master
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 
134  protected function __construct( $fileName, $callback, $options ) {
135  $this->fileName = $fileName;
136  $this->callback = $callback;
137 
138  if ( isset( $options['zip64'] ) ) {
139  $this->zip64 = $options['zip64'];
140  }
141  }
142 
148  function execute() {
149  $this->file = fopen( $this->fileName, 'r' );
150  $this->data = [];
151  if ( !$this->file ) {
152  return Status::newFatal( 'zip-file-open-error' );
153  }
154 
156  try {
158  if ( $this->zip64 ) {
159  list( $offset, $size ) = $this->findZip64CentralDirectory();
160  $this->readCentralDirectory( $offset, $size );
161  } else {
162  if ( $this->eocdr['CD size'] == 0xffffffff
163  || $this->eocdr['CD offset'] == 0xffffffff
164  || $this->eocdr['CD entries total'] == 0xffff
165  ) {
166  $this->error( 'zip-unsupported', 'Central directory header indicates ZIP64, ' .
167  'but we are in legacy mode. Rejecting this upload is necessary to avoid ' .
168  'opening vulnerabilities on clients using OpenJDK 7 or later.' );
169  }
170 
171  list( $offset, $size ) = $this->findOldCentralDirectory();
172  $this->readCentralDirectory( $offset, $size );
173  }
174  } catch ( ZipDirectoryReaderError $e ) {
175  $status->fatal( $e->getErrorCode() );
176  }
177 
178  fclose( $this->file );
179 
180  return $status;
181  }
182 
189  function error( $code, $debugMessage ) {
190  wfDebug( __CLASS__ . ": Fatal error: $debugMessage\n" );
191  throw new ZipDirectoryReaderError( $code );
192  }
193 
200  $info = [
201  'signature' => 4,
202  'disk' => 2,
203  'CD start disk' => 2,
204  'CD entries this disk' => 2,
205  'CD entries total' => 2,
206  'CD size' => 4,
207  'CD offset' => 4,
208  'file comment length' => 2,
209  ];
210  $structSize = $this->getStructSize( $info );
211  $startPos = $this->getFileLength() - 65536 - $structSize;
212  if ( $startPos < 0 ) {
213  $startPos = 0;
214  }
215 
216  if ( $this->getFileLength() === 0 ) {
217  $this->error( 'zip-wrong-format', "The file is empty." );
218  }
219 
220  $block = $this->getBlock( $startPos );
221  $sigPos = strrpos( $block, "PK\x05\x06" );
222  if ( $sigPos === false ) {
223  $this->error( 'zip-wrong-format',
224  "zip file lacks EOCDR signature. It probably isn't a zip file." );
225  }
226 
227  $this->eocdr = $this->unpack( substr( $block, $sigPos ), $info );
228  $this->eocdr['EOCDR size'] = $structSize + $this->eocdr['file comment length'];
229 
230  if ( $structSize + $this->eocdr['file comment length'] != strlen( $block ) - $sigPos ) {
231  // T40432: MS binary documents frequently embed ZIP files
232  $this->error( 'zip-wrong-format', 'there is a ZIP signature but it is not at ' .
233  'the end of the file. It could be an OLE file with a ZIP file embedded.' );
234  }
235  if ( $this->eocdr['disk'] !== 0
236  || $this->eocdr['CD start disk'] !== 0
237  ) {
238  $this->error( 'zip-unsupported', 'more than one disk (in EOCDR)' );
239  }
240  $this->eocdr += $this->unpack(
241  $block,
242  [ 'file comment' => [ 'string', $this->eocdr['file comment length'] ] ],
243  $sigPos + $structSize );
244  $this->eocdr['position'] = $startPos + $sigPos;
245  }
246 
252  $info = [
253  'signature' => [ 'string', 4 ],
254  'eocdr64 start disk' => 4,
255  'eocdr64 offset' => 8,
256  'number of disks' => 4,
257  ];
258  $structSize = $this->getStructSize( $info );
259 
260  $start = $this->getFileLength() - $this->eocdr['EOCDR size'] - $structSize;
261  $block = $this->getBlock( $start, $structSize );
262  $this->eocdr64Locator = $data = $this->unpack( $block, $info );
263 
264  if ( $data['signature'] !== "PK\x06\x07" ) {
265  // Note: Java will allow this and continue to read the
266  // EOCDR64, so we have to reject the upload, we can't
267  // just use the EOCDR header instead.
268  $this->error( 'zip-bad', 'wrong signature on Zip64 end of central directory locator' );
269  }
270  }
271 
277  if ( $this->eocdr64Locator['eocdr64 start disk'] != 0
278  || $this->eocdr64Locator['number of disks'] != 0
279  ) {
280  $this->error( 'zip-unsupported', 'more than one disk (in EOCDR64 locator)' );
281  }
282 
283  $info = [
284  'signature' => [ 'string', 4 ],
285  'EOCDR64 size' => 8,
286  'version made by' => 2,
287  'version needed' => 2,
288  'disk' => 4,
289  'CD start disk' => 4,
290  'CD entries this disk' => 8,
291  'CD entries total' => 8,
292  'CD size' => 8,
293  'CD offset' => 8
294  ];
295  $structSize = $this->getStructSize( $info );
296  $block = $this->getBlock( $this->eocdr64Locator['eocdr64 offset'], $structSize );
297  $this->eocdr64 = $data = $this->unpack( $block, $info );
298  if ( $data['signature'] !== "PK\x06\x06" ) {
299  $this->error( 'zip-bad', 'wrong signature on Zip64 end of central directory record' );
300  }
301  if ( $data['disk'] !== 0
302  || $data['CD start disk'] !== 0
303  ) {
304  $this->error( 'zip-unsupported', 'more than one disk (in EOCDR64)' );
305  }
306  }
307 
315  $size = $this->eocdr['CD size'];
316  $offset = $this->eocdr['CD offset'];
317  $endPos = $this->eocdr['position'];
318 
319  // Some readers use the EOCDR position instead of the offset field
320  // to find the directory, so to be safe, we check if they both agree.
321  if ( $offset + $size != $endPos ) {
322  $this->error( 'zip-bad', 'the central directory does not immediately precede the end ' .
323  'of central directory record' );
324  }
325 
326  return [ $offset, $size ];
327  }
328 
336  // The spec is ambiguous about the exact rules of precedence between the
337  // ZIP64 headers and the original headers. Here we follow zip_util.c
338  // from OpenJDK 7.
339  $size = $this->eocdr['CD size'];
340  $offset = $this->eocdr['CD offset'];
341  $numEntries = $this->eocdr['CD entries total'];
342  $endPos = $this->eocdr['position'];
343  if ( $size == 0xffffffff
344  || $offset == 0xffffffff
345  || $numEntries == 0xffff
346  ) {
348 
349  if ( isset( $this->eocdr64Locator['eocdr64 offset'] ) ) {
351  if ( isset( $this->eocdr64['CD offset'] ) ) {
352  $size = $this->eocdr64['CD size'];
353  $offset = $this->eocdr64['CD offset'];
354  $endPos = $this->eocdr64Locator['eocdr64 offset'];
355  }
356  }
357  }
358  // Some readers use the EOCDR position instead of the offset field
359  // to find the directory, so to be safe, we check if they both agree.
360  if ( $offset + $size != $endPos ) {
361  $this->error( 'zip-bad', 'the central directory does not immediately precede the end ' .
362  'of central directory record' );
363  }
364 
365  return [ $offset, $size ];
366  }
367 
373  function readCentralDirectory( $offset, $size ) {
374  $block = $this->getBlock( $offset, $size );
375 
376  $fixedInfo = [
377  'signature' => [ 'string', 4 ],
378  'version made by' => 2,
379  'version needed' => 2,
380  'general bits' => 2,
381  'compression method' => 2,
382  'mod time' => 2,
383  'mod date' => 2,
384  'crc-32' => 4,
385  'compressed size' => 4,
386  'uncompressed size' => 4,
387  'name length' => 2,
388  'extra field length' => 2,
389  'comment length' => 2,
390  'disk number start' => 2,
391  'internal attrs' => 2,
392  'external attrs' => 4,
393  'local header offset' => 4,
394  ];
395  $fixedSize = $this->getStructSize( $fixedInfo );
396 
397  $pos = 0;
398  while ( $pos < $size ) {
399  $data = $this->unpack( $block, $fixedInfo, $pos );
400  $pos += $fixedSize;
401 
402  if ( $data['signature'] !== "PK\x01\x02" ) {
403  $this->error( 'zip-bad', 'Invalid signature found in directory entry' );
404  }
405 
406  $variableInfo = [
407  'name' => [ 'string', $data['name length'] ],
408  'extra field' => [ 'string', $data['extra field length'] ],
409  'comment' => [ 'string', $data['comment length'] ],
410  ];
411  $data += $this->unpack( $block, $variableInfo, $pos );
412  $pos += $this->getStructSize( $variableInfo );
413 
414  if ( $this->zip64 && (
415  $data['compressed size'] == 0xffffffff
416  || $data['uncompressed size'] == 0xffffffff
417  || $data['local header offset'] == 0xffffffff )
418  ) {
419  $zip64Data = $this->unpackZip64Extra( $data['extra field'] );
420  if ( $zip64Data ) {
421  $data = $zip64Data + $data;
422  }
423  }
424 
425  if ( $this->testBit( $data['general bits'], self::GENERAL_CD_ENCRYPTED ) ) {
426  $this->error( 'zip-unsupported', 'central directory encryption is not supported' );
427  }
428 
429  // Convert the timestamp into MediaWiki format
430  // For the format, please see the MS-DOS 2.0 Programmer's Reference,
431  // pages 3-5 and 3-6.
432  $time = $data['mod time'];
433  $date = $data['mod date'];
434 
435  $year = 1980 + ( $date >> 9 );
436  $month = ( $date >> 5 ) & 15;
437  $day = $date & 31;
438  $hour = ( $time >> 11 ) & 31;
439  $minute = ( $time >> 5 ) & 63;
440  $second = ( $time & 31 ) * 2;
441  $timestamp = sprintf( "%04d%02d%02d%02d%02d%02d",
442  $year, $month, $day, $hour, $minute, $second );
443 
444  // Convert the character set in the file name
445  if ( $this->testBit( $data['general bits'], self::GENERAL_UTF8 ) ) {
446  $name = $data['name'];
447  } else {
448  $name = iconv( 'CP437', 'UTF-8', $data['name'] );
449  }
450 
451  // Compile a data array for the user, with a sensible format
452  $userData = [
453  'name' => $name,
454  'mtime' => $timestamp,
455  'size' => $data['uncompressed size'],
456  ];
457  call_user_func( $this->callback, $userData );
458  }
459  }
460 
466  function unpackZip64Extra( $extraField ) {
467  $extraHeaderInfo = [
468  'id' => 2,
469  'size' => 2,
470  ];
471  $extraHeaderSize = $this->getStructSize( $extraHeaderInfo );
472 
473  $zip64ExtraInfo = [
474  'uncompressed size' => 8,
475  'compressed size' => 8,
476  'local header offset' => 8,
477  'disk number start' => 4,
478  ];
479 
480  $extraPos = 0;
481  while ( $extraPos < strlen( $extraField ) ) {
482  $extra = $this->unpack( $extraField, $extraHeaderInfo, $extraPos );
483  $extraPos += $extraHeaderSize;
484  $extra += $this->unpack( $extraField,
485  [ 'data' => [ 'string', $extra['size'] ] ],
486  $extraPos );
487  $extraPos += $extra['size'];
488 
489  if ( $extra['id'] == self::ZIP64_EXTRA_HEADER ) {
490  return $this->unpack( $extra['data'], $zip64ExtraInfo );
491  }
492  }
493 
494  return false;
495  }
496 
501  function getFileLength() {
502  if ( $this->fileLength === null ) {
503  $stat = fstat( $this->file );
504  $this->fileLength = $stat['size'];
505  }
506 
507  return $this->fileLength;
508  }
509 
520  function getBlock( $start, $length = null ) {
521  $fileLength = $this->getFileLength();
522  if ( $start >= $fileLength ) {
523  $this->error( 'zip-bad', "getBlock() requested position $start, " .
524  "file length is $fileLength" );
525  }
526  if ( $length === null ) {
527  $length = $fileLength - $start;
528  }
529  $end = $start + $length;
530  if ( $end > $fileLength ) {
531  $this->error( 'zip-bad', "getBlock() requested end position $end, " .
532  "file length is $fileLength" );
533  }
534  $startSeg = floor( $start / self::SEGSIZE );
535  $endSeg = ceil( $end / self::SEGSIZE );
536 
537  $block = '';
538  for ( $segIndex = $startSeg; $segIndex <= $endSeg; $segIndex++ ) {
539  $block .= $this->getSegment( $segIndex );
540  }
541 
542  $block = substr( $block,
543  $start - $startSeg * self::SEGSIZE,
544  $length );
545 
546  if ( strlen( $block ) < $length ) {
547  $this->error( 'zip-bad', 'getBlock() returned an unexpectedly small amount of data' );
548  }
549 
550  return $block;
551  }
552 
566  function getSegment( $segIndex ) {
567  if ( !isset( $this->buffer[$segIndex] ) ) {
568  $bytePos = $segIndex * self::SEGSIZE;
569  if ( $bytePos >= $this->getFileLength() ) {
570  $this->buffer[$segIndex] = '';
571 
572  return '';
573  }
574  if ( fseek( $this->file, $bytePos ) ) {
575  $this->error( 'zip-bad', "seek to $bytePos failed" );
576  }
577  $seg = fread( $this->file, self::SEGSIZE );
578  if ( $seg === false ) {
579  $this->error( 'zip-bad', "read from $bytePos failed" );
580  }
581  $this->buffer[$segIndex] = $seg;
582  }
583 
584  return $this->buffer[$segIndex];
585  }
586 
592  function getStructSize( $struct ) {
593  $size = 0;
594  foreach ( $struct as $type ) {
595  if ( is_array( $type ) ) {
596  list( , $fieldSize ) = $type;
597  $size += $fieldSize;
598  } else {
599  $size += $type;
600  }
601  }
602 
603  return $size;
604  }
605 
628  function unpack( $string, $struct, $offset = 0 ) {
629  $size = $this->getStructSize( $struct );
630  if ( $offset + $size > strlen( $string ) ) {
631  $this->error( 'zip-bad', 'unpack() would run past the end of the supplied string' );
632  }
633 
634  $data = [];
635  $pos = $offset;
636  foreach ( $struct as $key => $type ) {
637  if ( is_array( $type ) ) {
638  list( $typeName, $fieldSize ) = $type;
639  switch ( $typeName ) {
640  case 'string':
641  $data[$key] = substr( $string, $pos, $fieldSize );
642  $pos += $fieldSize;
643  break;
644  default:
645  throw new MWException( __METHOD__ . ": invalid type \"$typeName\"" );
646  }
647  } else {
648  // Unsigned little-endian integer
649  $length = intval( $type );
650 
651  // Calculate the value. Use an algorithm which automatically
652  // upgrades the value to floating point if necessary.
653  $value = 0;
654  for ( $i = $length - 1; $i >= 0; $i-- ) {
655  $value *= 256;
656  $value += ord( $string[$pos + $i] );
657  }
658 
659  // Throw an exception if there was loss of precision
660  if ( $value > 2 ** 52 ) {
661  $this->error( 'zip-unsupported', 'number too large to be stored in a double. ' .
662  'This could happen if we tried to unpack a 64-bit structure ' .
663  'at an invalid location.' );
664  }
665  $data[$key] = $value;
666  $pos += $length;
667  }
668  }
669 
670  return $data;
671  }
672 
681  function testBit( $value, $bitIndex ) {
682  return (bool)( ( $value >> $bitIndex ) & 1 );
683  }
684 
689  function hexDump( $s ) {
690  $n = strlen( $s );
691  for ( $i = 0; $i < $n; $i += 16 ) {
692  printf( "%08X ", $i );
693  for ( $j = 0; $j < 16; $j++ ) {
694  print " ";
695  if ( $j == 8 ) {
696  print " ";
697  }
698  if ( $i + $j >= $n ) {
699  print " ";
700  } else {
701  printf( "%02X", ord( $s[$i + $j] ) );
702  }
703  }
704 
705  print " |";
706  for ( $j = 0; $j < 16; $j++ ) {
707  if ( $i + $j >= $n ) {
708  print " ";
709  } elseif ( ctype_print( $s[$i + $j] ) ) {
710  print $s[$i + $j];
711  } else {
712  print '.';
713  }
714  }
715  print "|\n";
716  }
717  }
718 }
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.
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
Definition: hooks.txt:6
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
$callback
The file data callback.
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.
const GENERAL_UTF8
The index of the "general field" bit for UTF-8 file names.
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2159
getBlock( $start, $length=null)
Get the file contents from a given offset.
$value
getFileLength()
Get the length of the file.
$zip64
The ZIP64 mode.
execute()
Read the directory according to settings in $this.
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1799
getSegment( $segIndex)
Get a section of the file starting at position $segIndex * self::SEGSIZE, of length self::SEGSIZE...
readZip64EndOfCentralDirectoryRecord()
Read the header called the "ZIP64 end of central directory record".
readZip64EndOfCentralDirectoryLocator()
Read the header called the "ZIP64 end of central directory locator".
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
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 '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:1263
const SEGSIZE
The segment size for the file contents cache.
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:91
$eocdr
Stored headers.
testBit( $value, $bitIndex)
Returns a bit from a given position in an integer value, converted to boolean.
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
readEndOfCentralDirectoryRecord()
Read the header which is at the end of the central directory, unimaginatively called the "end of cent...
A class for reading ZIP file directories, for the purposes of upload verification.
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:1982
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
__construct( $fileName, $callback, $options)
findOldCentralDirectory()
Find the location of the central directory, as would be seen by a non-ZIP64 reader.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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:780
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
Definition: distributors.txt:9
hexDump( $s)
Debugging helper function which dumps a string in hexdump -C format.
Internal exception class.
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
readCentralDirectory( $offset, $size)
Read the central directory at the given location.
unpackZip64Extra( $extraField)
Interpret ZIP64 "extra field" data and return an associative array.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
$file
The opened file resource.
const ZIP64_EXTRA_HEADER
The "extra field" ID for ZIP64 central directory entries.
$fileName
The file name.
static read( $fileName, $callback, $options=[])
Read a ZIP file and call a function for each file discovered in it.
error( $code, $debugMessage)
Throw an error, and log a debug message.
$buffer
A segmented cache of the file contents.
$fileLength
The cached length of the file, or null if it has not been loaded yet.