wppaste
WordPress

PclZip::privExtractFileInOutput( $p_entry, $p_options )

Source
wp-admin/includes/class-pclzip.php:4053

Compatibility

WordPress
core
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$p_entry
$p_options

Performance profile

How much work a call to PclZip::privExtractFileInOutput() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class
Heavy

Reads or writes the filesystem via fread().

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
9–98

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 120.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

  • filesystemfilesystem accessfread()called directly

What one call costs · 16 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost PclZip::privExtractFileInOutput() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
$v_result != 19->privReadFileHeader()
$v_result == 1 && !isset($p_options)25–41->privReadFileHeader(), ->privCheckFileHeaders()
$v_result == 1 && isset($p_options)41–68->privReadFileHeader(), ->privCheckFileHeaders(), ->privConvertHeader2FileInfo()
$v_result == 1 && !isset($p_options)44–45->privReadFileHeader(), ->privCheckFileHeaders(), gzinflate()
$v_result == 1 && !isset($p_options)49–50->privReadFileHeader(), ->privCheckFileHeaders(), fread()
$v_result == 1 && !isset($p_options)53–54->privReadFileHeader(), ->privCheckFileHeaders(), fread(), gzinflate()
$v_result == 160–62->privReadFileHeader(), ->privCheckFileHeaders(), gzinflate(), ->privConvertHeader2FileInfo()
$v_result == 1 && isset($p_options)61–85->privReadFileHeader(), ->privCheckFileHeaders(), ->privConvertHeader2FileInfo(), ->privConvertHeader2FileInfo()
$v_result == 1 && isset($p_options)64–72->privReadFileHeader(), ->privCheckFileHeaders(), ->privConvertHeader2FileInfo(), gzinflate()
$v_result == 165–67->privReadFileHeader(), ->privCheckFileHeaders(), fread(), ->privConvertHeader2FileInfo()
$v_result == 1 && isset($p_options)69–77->privReadFileHeader(), ->privCheckFileHeaders(), ->privConvertHeader2FileInfo(), fread()
$v_result == 169–71->privReadFileHeader(), ->privCheckFileHeaders(), fread(), gzinflate(), ->privConvertHeader2FileInfo()
4 further outcomes, up to 98 instructions
$v_result == 1 && isset($p_options)73–81->privReadFileHeader(), ->privCheckFileHeaders(), ->privConvertHeader2FileInfo(), fread(), gzinflate()
$v_result == 1 && isset($p_options)80–89->privReadFileHeader(), ->privCheckFileHeaders(), ->privConvertHeader2FileInfo(), gzinflate(), ->privConvertHeader2FileInfo()
$v_result == 1 && isset($p_options)85–94->privReadFileHeader(), ->privCheckFileHeaders(), ->privConvertHeader2FileInfo(), fread(), ->privConvertHeader2FileInfo()
$v_result == 1 && isset($p_options)89–98->privReadFileHeader(), ->privCheckFileHeaders(), ->privConvertHeader2FileInfo(), fread(), gzinflate(), ->privConvertHeader2FileInfo()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 120 instructions, 9–98 executed per call, 12 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 3

Used by · 1

Source code

View on Trac View on GitHub 

  function privExtractFileInOutput(&$p_entry, &$p_options)  {    $v_result=1;     // ----- Read the file header    if (($v_result = $this->privReadFileHeader($v_header)) != 1) {      return $v_result;    }      // ----- Check that the file header is coherent with $p_entry info    if ($this->privCheckFileHeaders($v_header, $p_entry) != 1) {        // TBC    }     // ----- Look for pre-extract callback    if (isset($p_options[PCLZIP_CB_PRE_EXTRACT])) {       // ----- Generate a local information      $v_local_header = array();      $this->privConvertHeader2FileInfo($p_entry, $v_local_header);       // ----- Call the callback      // Here I do not use call_user_func() because I need to send a reference to the      // header.//      eval('$v_result = '.$p_options[PCLZIP_CB_PRE_EXTRACT].'(PCLZIP_CB_PRE_EXTRACT, $v_local_header);');      $v_result = $p_options[PCLZIP_CB_PRE_EXTRACT](PCLZIP_CB_PRE_EXTRACT, $v_local_header);      if ($v_result == 0) {        // ----- Change the file status        $p_entry['status'] = "skipped";        $v_result = 1;      }       // ----- Look for abort result      if ($v_result == 2) {        // ----- This status is internal and will be changed in 'skipped'        $p_entry['status'] = "aborted";      	$v_result = PCLZIP_ERR_USER_ABORTED;      }       // ----- Update the information      // Only some fields can be modified      $p_entry['filename'] = $v_local_header['filename'];    }     // ----- Trace     // ----- Look if extraction should be done    if ($p_entry['status'] == 'ok') {       // ----- Do the extraction (if not a folder)      if (!(($p_entry['external']&0x00000010)==0x00000010)) {        // ----- Look for not compressed file        if ($p_entry['compressed_size'] == $p_entry['size']) {           // ----- Read the file in a buffer (one shot)          if ($p_entry['compressed_size'] > 0) {            $v_buffer = @fread($this->zip_fd, $p_entry['compressed_size']);          }          else {            $v_buffer = '';          }           // ----- Send the file to the output          echo $v_buffer;          unset($v_buffer);        }        else {           // ----- Read the compressed file in a buffer (one shot)          if ($p_entry['compressed_size'] > 0) {            $v_buffer = @fread($this->zip_fd, $p_entry['compressed_size']);          }          else {            $v_buffer = '';          }           // ----- Decompress the file          $v_file_content = gzinflate($v_buffer);          unset($v_buffer);

Changelog

Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-admin/includes/class-pclzip.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.