PhpOffice\PhpSpreadsheet\Shared\OLERead Class Reference

Collaboration diagram for PhpOffice\PhpSpreadsheet\Shared\OLERead:

Public Member Functions
	read (string $pFilename)
	Read the file. More...
	getStream ($stream)
	Extract binary stream data. More...

Data Fields
const	BIG_BLOCK_SIZE = 0x200
const	SMALL_BLOCK_SIZE = 0x40
const	PROPERTY_STORAGE_BLOCK_SIZE = 0x80
const	SMALL_BLOCK_THRESHOLD = 0x1000
const	NUM_BIG_BLOCK_DEPOT_BLOCKS_POS = 0x2c
const	ROOT_START_BLOCK_POS = 0x30
const	SMALL_BLOCK_DEPOT_BLOCK_POS = 0x3c
const	EXTENSION_BLOCK_POS = 0x44
const	NUM_EXTENSION_BLOCK_POS = 0x48
const	BIG_BLOCK_DEPOT_BLOCKS_POS = 0x4c
const	SIZE_OF_NAME_POS = 0x40
const	TYPE_POS = 0x42
const	START_BLOCK_POS = 0x74
const	SIZE_POS = 0x78
	$wrkbook
	$summaryInformation
	$documentSummaryInformation

Private Member Functions
	readData ($bl)
	Read a standard stream (by joining sectors using information from SAT). More...
	readPropertySets ()
	Read entries in the directory stream. More...

Static Private Member Functions
static	getInt4d ($data, $pos)
	Read 4 bytes of data at specified position. More...

Private Attributes
	$data = ''
	$numBigBlockDepotBlocks
	$rootStartBlock
	$sbdStartBlock
	$extensionBlock
	$numExtensionBlocks
	$bigBlockChain
	$smallBlockChain
	$entry
	$rootentry
	$props = []

Detailed Description

Definition at line 7 of file OLERead.php.

Member Function Documentation

getInt4d()

static PhpOffice\PhpSpreadsheet\Shared\OLERead::getInt4d (   $data,   $pos  )

staticprivate

Read 4 bytes of data at specified position.

Parameters

string	$data
int	$pos

Returns

int

Definition at line 323 of file OLERead.php.

References PhpOffice\PhpSpreadsheet\Shared\OLERead\$data.

    {
        if ($pos < 0) {
            // Invalid position
            throw new ReaderException('Parameter pos=' . $pos . ' is invalid.');
        }

        $len = strlen($data);
        if ($len < $pos + 4) {
            $data .= str_repeat("\0", $pos + 4 - $len);
        }

        // FIX: represent numbers correctly on 64-bit system
        // http://sourceforge.net/tracker/index.php?func=detail&aid=1487372&group_id=99160&atid=623334
        // Changed by Andreas Rehm 2006 to ensure correct result of the <<24 block on 32 and 64bit systems
        $_or_24 = ord($data[$pos + 3]);
        if ($_or_24 >= 128) {
            // negative number
            $_ord_24 = -abs((256 - $_or_24) << 24);
        } else {
            $_ord_24 = ($_or_24 & 127) << 24;
        }

        return ord($data[$pos]) | (ord($data[$pos + 1]) << 8) | (ord($data[$pos + 2]) << 16) | $_ord_24;
    }

getStream()

PhpOffice\PhpSpreadsheet\Shared\OLERead::getStream

(

$stream

)

Extract binary stream data.

Parameters

int

$stream

Returns

null|string

Definition at line 193 of file OLERead.php.

References GuzzleHttp\Psr7\$stream, data, and PhpOffice\PhpSpreadsheet\Shared\OLERead\readData().

    {
        if ($stream === null) {
            return null;
        }

        $streamData = '';

        if ($this->props[$stream]['size'] < self::SMALL_BLOCK_THRESHOLD) {
            $rootdata = $this->readData($this->props[$this->rootentry]['startBlock']);

            $block = $this->props[$stream]['startBlock'];

            while ($block != -2) {
                $pos = $block * self::SMALL_BLOCK_SIZE;
                $streamData .= substr($rootdata, $pos, self::SMALL_BLOCK_SIZE);

                $block = self::getInt4d($this->smallBlockChain, $block * 4);
            }

            return $streamData;
        }
        $numBlocks = $this->props[$stream]['size'] / self::BIG_BLOCK_SIZE;
        if ($this->props[$stream]['size'] % self::BIG_BLOCK_SIZE != 0) {
            ++$numBlocks;
        }

        if ($numBlocks == 0) {
            return '';
        }

        $block = $this->props[$stream]['startBlock'];

        while ($block != -2) {
            $pos = ($block + 1) * self::BIG_BLOCK_SIZE;
            $streamData .= substr($this->data, $pos, self::BIG_BLOCK_SIZE);
            $block = self::getInt4d($this->bigBlockChain, $block * 4);
        }

        return $streamData;
    }

Here is the call graph for this function:

read()

PhpOffice\PhpSpreadsheet\Shared\OLERead::read

(

string

$pFilename

)

Read the file.

Definition at line 96 of file OLERead.php.

References $i, PhpOffice\PhpSpreadsheet\Shared\OLERead\$numBigBlockDepotBlocks, PhpOffice\PhpSpreadsheet\Shared\OLERead\$numExtensionBlocks, PhpOffice\PhpSpreadsheet\Shared\OLERead\$rootStartBlock, PhpOffice\PhpSpreadsheet\Shared\OLERead\$sbdStartBlock, PhpOffice\PhpSpreadsheet\Shared\File\assertFile(), data, PhpOffice\PhpSpreadsheet\Shared\OLERead\readData(), and PhpOffice\PhpSpreadsheet\Shared\OLERead\readPropertySets().

                                           : void
    {
        File::assertFile($pFilename);

        // Get the file identifier
        // Don't bother reading the whole file until we know it's a valid OLE file
        $this->data = file_get_contents($pFilename, false, null, 0, 8);

        // Check OLE identifier
        $identifierOle = pack('CCCCCCCC', 0xd0, 0xcf, 0x11, 0xe0, 0xa1, 0xb1, 0x1a, 0xe1);
        if ($this->data != $identifierOle) {
            throw new ReaderException('The filename ' . $pFilename . ' is not recognised as an OLE file');
        }

        // Get the file data
        $this->data = file_get_contents($pFilename);

        // Total number of sectors used for the SAT
        $this->numBigBlockDepotBlocks = self::getInt4d($this->data, self::NUM_BIG_BLOCK_DEPOT_BLOCKS_POS);

        // SecID of the first sector of the directory stream
        $this->rootStartBlock = self::getInt4d($this->data, self::ROOT_START_BLOCK_POS);

        // SecID of the first sector of the SSAT (or -2 if not extant)
        $this->sbdStartBlock = self::getInt4d($this->data, self::SMALL_BLOCK_DEPOT_BLOCK_POS);

        // SecID of the first sector of the MSAT (or -2 if no additional sectors are used)
        $this->extensionBlock = self::getInt4d($this->data, self::EXTENSION_BLOCK_POS);

        // Total number of sectors used by MSAT
        $this->numExtensionBlocks = self::getInt4d($this->data, self::NUM_EXTENSION_BLOCK_POS);

        $bigBlockDepotBlocks = [];
        $pos = self::BIG_BLOCK_DEPOT_BLOCKS_POS;

        $bbdBlocks = $this->numBigBlockDepotBlocks;

        if ($this->numExtensionBlocks != 0) {
            $bbdBlocks = (self::BIG_BLOCK_SIZE - self::BIG_BLOCK_DEPOT_BLOCKS_POS) / 4;
        }

        for ($i = 0; $i < $bbdBlocks; ++$i) {
            $bigBlockDepotBlocks[$i] = self::getInt4d($this->data, $pos);
            $pos += 4;
        }

        for ($j = 0; $j < $this->numExtensionBlocks; ++$j) {
            $pos = ($this->extensionBlock + 1) * self::BIG_BLOCK_SIZE;
            $blocksToRead = min($this->numBigBlockDepotBlocks - $bbdBlocks, self::BIG_BLOCK_SIZE / 4 - 1);

            for ($i = $bbdBlocks; $i < $bbdBlocks + $blocksToRead; ++$i) {
                $bigBlockDepotBlocks[$i] = self::getInt4d($this->data, $pos);
                $pos += 4;
            }

            $bbdBlocks += $blocksToRead;
            if ($bbdBlocks < $this->numBigBlockDepotBlocks) {
                $this->extensionBlock = self::getInt4d($this->data, $pos);
            }
        }

        $pos = 0;
        $this->bigBlockChain = '';
        $bbs = self::BIG_BLOCK_SIZE / 4;
        for ($i = 0; $i < $this->numBigBlockDepotBlocks; ++$i) {
            $pos = ($bigBlockDepotBlocks[$i] + 1) * self::BIG_BLOCK_SIZE;

            $this->bigBlockChain .= substr($this->data, $pos, 4 * $bbs);
            $pos += 4 * $bbs;
        }

        $pos = 0;
        $sbdBlock = $this->sbdStartBlock;
        $this->smallBlockChain = '';
        while ($sbdBlock != -2) {
            $pos = ($sbdBlock + 1) * self::BIG_BLOCK_SIZE;

            $this->smallBlockChain .= substr($this->data, $pos, 4 * $bbs);
            $pos += 4 * $bbs;

            $sbdBlock = self::getInt4d($this->bigBlockChain, $sbdBlock * 4);
        }

        // read the directory stream
        $block = $this->rootStartBlock;
        $this->entry = $this->readData($block);

        $this->readPropertySets();
    }

Here is the call graph for this function:

readData()

PhpOffice\PhpSpreadsheet\Shared\OLERead::readData (   $bl )

private

Read a standard stream (by joining sectors using information from SAT).

Parameters

int

$bl

Sector ID where the stream starts

Returns

string Data for standard stream

Definition at line 242 of file OLERead.php.

References PhpOffice\PhpSpreadsheet\Shared\OLERead\$data, and data.

Referenced by PhpOffice\PhpSpreadsheet\Shared\OLERead\getStream(), and PhpOffice\PhpSpreadsheet\Shared\OLERead\read().

    {
        $block = $bl;
        $data = '';

        while ($block != -2) {
            $pos = ($block + 1) * self::BIG_BLOCK_SIZE;
            $data .= substr($this->data, $pos, self::BIG_BLOCK_SIZE);
            $block = self::getInt4d($this->bigBlockChain, $block * 4);
        }

        return $data;
    }

Here is the caller graph for this function:

readPropertySets()

PhpOffice\PhpSpreadsheet\Shared\OLERead::readPropertySets ( )

private

Read entries in the directory stream.

Definition at line 259 of file OLERead.php.

References $d, $name, $size, and $type.

Referenced by PhpOffice\PhpSpreadsheet\Shared\OLERead\read().

                                       : void
    {
        $offset = 0;

        // loop through entires, each entry is 128 bytes
        $entryLen = strlen($this->entry);
        while ($offset < $entryLen) {
            // entry data (128 bytes)
            $d = substr($this->entry, $offset, self::PROPERTY_STORAGE_BLOCK_SIZE);

            // size in bytes of name
            $nameSize = ord($d[self::SIZE_OF_NAME_POS]) | (ord($d[self::SIZE_OF_NAME_POS + 1]) << 8);

            // type of entry
            $type = ord($d[self::TYPE_POS]);

            // sectorID of first sector or short sector, if this entry refers to a stream (the case with workbook)
            // sectorID of first sector of the short-stream container stream, if this entry is root entry
            $startBlock = self::getInt4d($d, self::START_BLOCK_POS);

            $size = self::getInt4d($d, self::SIZE_POS);

            $name = str_replace("\x00", '', substr($d, 0, $nameSize));

            $this->props[] = [
                'name' => $name,
                'type' => $type,
                'startBlock' => $startBlock,
                'size' => $size,
            ];

            // tmp helper to simplify checks
            $upName = strtoupper($name);

            // Workbook directory entry (BIFF5 uses Book, BIFF8 uses Workbook)
            if (($upName === 'WORKBOOK') || ($upName === 'BOOK')) {
                $this->wrkbook = count($this->props) - 1;
            } elseif ($upName === 'ROOT ENTRY' || $upName === 'R') {
                // Root entry
                $this->rootentry = count($this->props) - 1;
            }

            // Summary information
            if ($name == chr(5) . 'SummaryInformation') {
                $this->summaryInformation = count($this->props) - 1;
            }

            // Additional Document Summary information
            if ($name == chr(5) . 'DocumentSummaryInformation') {
                $this->documentSummaryInformation = count($this->props) - 1;
            }

            $offset += self::PROPERTY_STORAGE_BLOCK_SIZE;
        }
    }

Here is the caller graph for this function:

Field Documentation

$bigBlockChain

PhpOffice\PhpSpreadsheet\Shared\OLERead::$bigBlockChain

private

Definition at line 71 of file OLERead.php.

$data

PhpOffice\PhpSpreadsheet\Shared\OLERead::$data = ''

private

Definition at line 9 of file OLERead.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\OLERead\getInt4d(), and PhpOffice\PhpSpreadsheet\Shared\OLERead\readData().

$documentSummaryInformation

PhpOffice\PhpSpreadsheet\Shared\OLERead::$documentSummaryInformation

Definition at line 41 of file OLERead.php.

$entry

PhpOffice\PhpSpreadsheet\Shared\OLERead::$entry

private

Definition at line 81 of file OLERead.php.

$extensionBlock

PhpOffice\PhpSpreadsheet\Shared\OLERead::$extensionBlock

private

Definition at line 61 of file OLERead.php.

$numBigBlockDepotBlocks

PhpOffice\PhpSpreadsheet\Shared\OLERead::$numBigBlockDepotBlocks

private

Definition at line 46 of file OLERead.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\OLERead\read().

$numExtensionBlocks

PhpOffice\PhpSpreadsheet\Shared\OLERead::$numExtensionBlocks

private

Definition at line 66 of file OLERead.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\OLERead\read().

$props

PhpOffice\PhpSpreadsheet\Shared\OLERead::$props = []

private

Definition at line 91 of file OLERead.php.

$rootentry

PhpOffice\PhpSpreadsheet\Shared\OLERead::$rootentry

private

Definition at line 86 of file OLERead.php.

$rootStartBlock

PhpOffice\PhpSpreadsheet\Shared\OLERead::$rootStartBlock

private

Definition at line 51 of file OLERead.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\OLERead\read().

$sbdStartBlock

PhpOffice\PhpSpreadsheet\Shared\OLERead::$sbdStartBlock

private

Definition at line 56 of file OLERead.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\OLERead\read().

$smallBlockChain

PhpOffice\PhpSpreadsheet\Shared\OLERead::$smallBlockChain

private

Definition at line 76 of file OLERead.php.

$summaryInformation

PhpOffice\PhpSpreadsheet\Shared\OLERead::$summaryInformation

Definition at line 39 of file OLERead.php.

$wrkbook

PhpOffice\PhpSpreadsheet\Shared\OLERead::$wrkbook

Definition at line 37 of file OLERead.php.

BIG_BLOCK_DEPOT_BLOCKS_POS

const PhpOffice\PhpSpreadsheet\Shared\OLERead::BIG_BLOCK_DEPOT_BLOCKS_POS = 0x4c

Definition at line 29 of file OLERead.php.

BIG_BLOCK_SIZE

const PhpOffice\PhpSpreadsheet\Shared\OLERead::BIG_BLOCK_SIZE = 0x200

Definition at line 12 of file OLERead.php.

EXTENSION_BLOCK_POS

const PhpOffice\PhpSpreadsheet\Shared\OLERead::EXTENSION_BLOCK_POS = 0x44

Definition at line 27 of file OLERead.php.

NUM_BIG_BLOCK_DEPOT_BLOCKS_POS

const PhpOffice\PhpSpreadsheet\Shared\OLERead::NUM_BIG_BLOCK_DEPOT_BLOCKS_POS = 0x2c

Definition at line 24 of file OLERead.php.

NUM_EXTENSION_BLOCK_POS

const PhpOffice\PhpSpreadsheet\Shared\OLERead::NUM_EXTENSION_BLOCK_POS = 0x48

Definition at line 28 of file OLERead.php.

PROPERTY_STORAGE_BLOCK_SIZE

const PhpOffice\PhpSpreadsheet\Shared\OLERead::PROPERTY_STORAGE_BLOCK_SIZE = 0x80

Definition at line 18 of file OLERead.php.

ROOT_START_BLOCK_POS

const PhpOffice\PhpSpreadsheet\Shared\OLERead::ROOT_START_BLOCK_POS = 0x30

Definition at line 25 of file OLERead.php.

SIZE_OF_NAME_POS

const PhpOffice\PhpSpreadsheet\Shared\OLERead::SIZE_OF_NAME_POS = 0x40

Definition at line 32 of file OLERead.php.

SIZE_POS

const PhpOffice\PhpSpreadsheet\Shared\OLERead::SIZE_POS = 0x78

Definition at line 35 of file OLERead.php.

SMALL_BLOCK_DEPOT_BLOCK_POS

const PhpOffice\PhpSpreadsheet\Shared\OLERead::SMALL_BLOCK_DEPOT_BLOCK_POS = 0x3c

Definition at line 26 of file OLERead.php.

SMALL_BLOCK_SIZE

const PhpOffice\PhpSpreadsheet\Shared\OLERead::SMALL_BLOCK_SIZE = 0x40

Definition at line 15 of file OLERead.php.

SMALL_BLOCK_THRESHOLD

const PhpOffice\PhpSpreadsheet\Shared\OLERead::SMALL_BLOCK_THRESHOLD = 0x1000

Definition at line 21 of file OLERead.php.

START_BLOCK_POS

const PhpOffice\PhpSpreadsheet\Shared\OLERead::START_BLOCK_POS = 0x74

Definition at line 34 of file OLERead.php.

TYPE_POS

const PhpOffice\PhpSpreadsheet\Shared\OLERead::TYPE_POS = 0x42

Definition at line 33 of file OLERead.php.

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Shared/OLERead.php