PhpOffice\PhpSpreadsheet\Shared\OLE Class Reference

OLE package base class. More...

Collaboration diagram for PhpOffice\PhpSpreadsheet\Shared\OLE:

Public Member Functions
	read ($file)
	Reads an OLE container from the contents of the file given. More...
	getBlockOffset ($blockId)
	getStream ($blockIdOrPps)
	Returns a stream for use with fread() etc. More...
	readPpsWks ($blockId)
	Gets information about all PPS's on the OLE container from the PPS WK's creates an OLE_PPS object for each one. More...
	isFile ($index)
	Checks whether a PPS is a File PPS or not. More...
	isRoot ($index)
	Checks whether a PPS is a Root PPS or not. More...
	ppsTotal ()
	Gives the total number of PPS's found in the OLE container. More...
	getData ($index, $position, $length)
	Gets data from a PPS If there is no PPS for the index given, it will return an empty string. More...
	getDataLength ($index)
	Gets the data length from a PPS If there is no PPS for the index given, it will return 0. More...

Static Public Member Functions
static	ascToUcs ($ascii)
	Utility function to transform ASCII text to Unicode. More...
static	localDateToOLE ($date)
	Utility function Returns a string for the OLE container with the date given. More...
static	OLE2LocalDate ($oleTimestamp)
	Returns a timestamp from an OLE container's date. More...

Data Fields
const	OLE_PPS_TYPE_ROOT = 5
const	OLE_PPS_TYPE_DIR = 1
const	OLE_PPS_TYPE_FILE = 2
const	OLE_DATA_SIZE_SMALL = 0x1000
const	OLE_LONG_INT_SIZE = 4
const	OLE_PPS_SIZE = 0x80
	$_file_handle
	$_list = []
	$root
	$bbat
	$sbat
	$bigBlockSize
	$smallBlockSize
	$bigBlockThreshold

Private Member Functions
	ppsTreeComplete ($index)
	It checks whether the PPS tree is complete (all PPS's read) starting with the given PPS (not necessarily root). More...

Static Private Member Functions
static	readInt1 ($fh)
	Reads a signed char. More...
static	readInt2 ($fh)
	Reads an unsigned short (2 octets). More...
static	readInt4 ($fh)
	Reads an unsigned long (4 octets). More...

Detailed Description

OLE package base class.

Author

Xavier Noguer xnogu.nosp@m.er@p.nosp@m.hp.ne.nosp@m.t

Christian Schmidt schmi.nosp@m.dt@p.nosp@m.hp.ne.nosp@m.t

Definition at line 43 of file OLE.php.

Member Function Documentation

ascToUcs()

static PhpOffice\PhpSpreadsheet\Shared\OLE::ascToUcs (   $ascii )

static

Utility function to transform ASCII text to Unicode.

Parameters

string

$ascii

The ASCII string to transform

Returns

string The string in Unicode

Definition at line 478 of file OLE.php.

References $i.

Referenced by PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\Root\__construct(), and PhpOffice\PhpSpreadsheet\Writer\Xls\save().

    {
        $rawname = '';
        $iMax = strlen($ascii);
        for ($i = 0; $i < $iMax; ++$i) {
            $rawname .= $ascii[$i]
                . "\x00";
        }

        return $rawname;
    }

Here is the caller graph for this function:

getBlockOffset()

PhpOffice\PhpSpreadsheet\Shared\OLE::getBlockOffset

(

$blockId

)

Parameters

int

$blockId

byte offset from beginning of file

Returns

int

Definition at line 206 of file OLE.php.

References PhpOffice\PhpSpreadsheet\Shared\OLE\$bigBlockSize.

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

    {
        return 512 + $blockId * $this->bigBlockSize;
    }

Here is the caller graph for this function:

getData()

PhpOffice\PhpSpreadsheet\Shared\OLE::getData	(		$index,
			$position,
			$length
	)

Gets data from a PPS If there is no PPS for the index given, it will return an empty string.

Parameters

int	$index	The index for the PPS
int	$position	The position from which to start reading (relative to the PPS)
int	$length	The amount of bytes to read (at most)

Returns

string The binary string containing the data requested

See also

OLE_PPS_File::getStream()

Definition at line 441 of file OLE.php.

References $data, $index, and PhpOffice\PhpSpreadsheet\Shared\OLE\getStream().

    {
        // if position is not valid return empty string
        if (!isset($this->_list[$index]) || ($position >= $this->_list[$index]->Size) || ($position < 0)) {
            return '';
        }
        $fh = $this->getStream($this->_list[$index]);
        $data = stream_get_contents($fh, $length, $position);
        fclose($fh);

        return $data;
    }

Here is the call graph for this function:

getDataLength()

PhpOffice\PhpSpreadsheet\Shared\OLE::getDataLength

(

$index

)

Gets the data length from a PPS If there is no PPS for the index given, it will return 0.

Parameters

int

$index

The index for the PPS

Returns

int The amount of bytes in data the PPS has

Definition at line 462 of file OLE.php.

References $index.

    {
        if (isset($this->_list[$index])) {
            return $this->_list[$index]->Size;
        }

        return 0;
    }

getStream()

PhpOffice\PhpSpreadsheet\Shared\OLE::getStream

(

$blockIdOrPps

)

Returns a stream for use with fread() etc.

External callers should use ::getStream().

Parameters

int | OLE\PPS

$blockIdOrPps

block id or PPS

Returns

resource read-only stream

Definition at line 219 of file OLE.php.

References PhpOffice\PhpSpreadsheet\Shared\$GLOBALS, $keys, and $path.

Referenced by PhpOffice\PhpSpreadsheet\Shared\OLE\getData(), PhpOffice\PhpSpreadsheet\Shared\OLE\read(), and PhpOffice\PhpSpreadsheet\Shared\OLE\readPpsWks().

    {
        static $isRegistered = false;
        if (!$isRegistered) {
            stream_wrapper_register('ole-chainedblockstream', ChainedBlockStream::class);
            $isRegistered = true;
        }

        // Store current instance in global array, so that it can be accessed
        // in OLE_ChainedBlockStream::stream_open().
        // Object is removed from self::$instances in OLE_Stream::close().
        $GLOBALS['_OLE_INSTANCES'][] = $this;
        $keys = array_keys($GLOBALS['_OLE_INSTANCES']);
        $instanceId = end($keys);

        $path = 'ole-chainedblockstream://oleInstanceId=' . $instanceId;
        if ($blockIdOrPps instanceof OLE\PPS) {
            $path .= '&blockId=' . $blockIdOrPps->startBlock;
            $path .= '&size=' . $blockIdOrPps->Size;
        } else {
            $path .= '&blockId=' . $blockIdOrPps;
        }

        return fopen($path, 'rb');
    }

Here is the caller graph for this function:

isFile()

PhpOffice\PhpSpreadsheet\Shared\OLE::isFile

(

$index

)

Checks whether a PPS is a File PPS or not.

If there is no PPS for the index given, it will return false.

Parameters

int

$index

The index for the PPS

Returns

bool true if it's a File PPS, false otherwise

Definition at line 392 of file OLE.php.

References $index.

    {
        if (isset($this->_list[$index])) {
            return $this->_list[$index]->Type == self::OLE_PPS_TYPE_FILE;
        }

        return false;
    }

isRoot()

PhpOffice\PhpSpreadsheet\Shared\OLE::isRoot

(

$index

)

Checks whether a PPS is a Root PPS or not.

If there is no PPS for the index given, it will return false.

Parameters

int

$index

the index for the PPS

Returns

bool true if it's a Root PPS, false otherwise

Definition at line 409 of file OLE.php.

References $index.

    {
        if (isset($this->_list[$index])) {
            return $this->_list[$index]->Type == self::OLE_PPS_TYPE_ROOT;
        }

        return false;
    }

localDateToOLE()

static PhpOffice\PhpSpreadsheet\Shared\OLE::localDateToOLE (   $date )

static

Utility function Returns a string for the OLE container with the date given.

Parameters

float | int

$date

A timestamp

Returns

string The string for the OLE container

Definition at line 498 of file OLE.php.

References $i, and $res.

Referenced by PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\getPpsWk(), and PhpOffice\PhpSpreadsheet\Writer\Xls\writeSummaryPropOle().

    {
        if (!$date) {
            return "\x00\x00\x00\x00\x00\x00\x00\x00";
        }
        $dateTime = Date::dateTimeFromTimestamp("$date");

        // factor used for separating numbers into 4 bytes parts
        $factor = 2 ** 32;

        // days from 1-1-1601 until the beggining of UNIX era
        $days = 134774;
        // calculate seconds
        $big_date = $days * 24 * 3600 + (float) $dateTime->format('U');
        // multiply just to make MS happy
        $big_date *= 10000000;

        $high_part = floor($big_date / $factor);
        // lower 4 bytes
        $low_part = floor((($big_date / $factor) - $high_part) * $factor);

        // Make HEX string
        $res = '';

        for ($i = 0; $i < 4; ++$i) {
            $hex = $low_part % 0x100;
            $res .= pack('c', $hex);
            $low_part /= 0x100;
        }
        for ($i = 0; $i < 4; ++$i) {
            $hex = $high_part % 0x100;
            $res .= pack('c', $hex);
            $high_part /= 0x100;
        }

        return $res;
    }

Here is the caller graph for this function:

OLE2LocalDate()

static PhpOffice\PhpSpreadsheet\Shared\OLE::OLE2LocalDate (   $oleTimestamp )

static

Returns a timestamp from an OLE container's date.

Parameters

string

$oleTimestamp

A binary string with the encoded date

Returns

float|int The Unix timestamp corresponding to the string

Definition at line 543 of file OLE.php.

References PhpOffice\PhpSpreadsheet\Shared\IntOrFloat\evaluate().

Referenced by PhpOffice\PhpSpreadsheet\Reader\Xls\readDocumentSummaryInformation(), and PhpOffice\PhpSpreadsheet\Reader\Xls\readSummaryInformation().

    {
        if (strlen($oleTimestamp) != 8) {
            throw new ReaderException('Expecting 8 byte string');
        }

        // convert to units of 100 ns since 1601:
        $unpackedTimestamp = unpack('v4', $oleTimestamp);
        $timestampHigh = (float) $unpackedTimestamp[4] * 65536 + (float) $unpackedTimestamp[3];
        $timestampLow = (float) $unpackedTimestamp[2] * 65536 + (float) $unpackedTimestamp[1];

        // translate to seconds since 1601:
        $timestampHigh /= 10000000;
        $timestampLow /= 10000000;

        // days from 1601 to 1970:
        $days = 134774;

        // translate to seconds since 1970:
        $unixTimestamp = floor(65536.0 * 65536.0 * $timestampHigh + $timestampLow - $days * 24 * 3600 + 0.5);

        return IntOrFloat::evaluate($unixTimestamp);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

ppsTotal()

PhpOffice\PhpSpreadsheet\Shared\OLE::ppsTotal

(

)

Gives the total number of PPS's found in the OLE container.

Returns

int The total number of PPS's found in the OLE container

Definition at line 423 of file OLE.php.

    {
        return count($this->_list);
    }

ppsTreeComplete()

PhpOffice\PhpSpreadsheet\Shared\OLE::ppsTreeComplete (   $index )

private

It checks whether the PPS tree is complete (all PPS's read) starting with the given PPS (not necessarily root).

Parameters

int

$index

The index of the PPS from which we are checking

Returns

bool Whether the PPS tree for the given PPS is complete

Definition at line 372 of file OLE.php.

References $index.

Referenced by PhpOffice\PhpSpreadsheet\Shared\OLE\readPpsWks().

    {
        return isset($this->_list[$index]) &&
            ($pps = $this->_list[$index]) &&
            ($pps->PrevPps == -1 ||
                $this->ppsTreeComplete($pps->PrevPps)) &&
            ($pps->NextPps == -1 ||
                $this->ppsTreeComplete($pps->NextPps)) &&
            ($pps->DirPps == -1 ||
                $this->ppsTreeComplete($pps->DirPps));
    }

Here is the caller graph for this function:

read()

PhpOffice\PhpSpreadsheet\Shared\OLE::read

(

$file

)

Reads an OLE container from the contents of the file given.

public

Parameters

string

$file

Returns

bool true on success, PEAR_Error on failure

Definition at line 117 of file OLE.php.

References $i, PhpOffice\PhpSpreadsheet\Shared\OLE\getBlockOffset(), PhpOffice\PhpSpreadsheet\Shared\OLE\getStream(), and PhpOffice\PhpSpreadsheet\Shared\OLE\readPpsWks().

    {
        $fh = fopen($file, 'rb');
        if (!$fh) {
            throw new ReaderException("Can't open file $file");
        }
        $this->_file_handle = $fh;

        $signature = fread($fh, 8);
        if ("\xD0\xCF\x11\xE0\xA1\xB1\x1A\xE1" != $signature) {
            throw new ReaderException("File doesn't seem to be an OLE container.");
        }
        fseek($fh, 28);
        if (fread($fh, 2) != "\xFE\xFF") {
            // This shouldn't be a problem in practice
            throw new ReaderException('Only Little-Endian encoding is supported.');
        }
        // Size of blocks and short blocks in bytes
        $this->bigBlockSize = 2 ** self::readInt2($fh);
        $this->smallBlockSize = 2 ** self::readInt2($fh);

        // Skip UID, revision number and version number
        fseek($fh, 44);
        // Number of blocks in Big Block Allocation Table
        $bbatBlockCount = self::readInt4($fh);

        // Root chain 1st block
        $directoryFirstBlockId = self::readInt4($fh);

        // Skip unused bytes
        fseek($fh, 56);
        // Streams shorter than this are stored using small blocks
        $this->bigBlockThreshold = self::readInt4($fh);
        // Block id of first sector in Short Block Allocation Table
        $sbatFirstBlockId = self::readInt4($fh);
        // Number of blocks in Short Block Allocation Table
        $sbbatBlockCount = self::readInt4($fh);
        // Block id of first sector in Master Block Allocation Table
        $mbatFirstBlockId = self::readInt4($fh);
        // Number of blocks in Master Block Allocation Table
        $mbbatBlockCount = self::readInt4($fh);
        $this->bbat = [];

        // Remaining 4 * 109 bytes of current block is beginning of Master
        // Block Allocation Table
        $mbatBlocks = [];
        for ($i = 0; $i < 109; ++$i) {
            $mbatBlocks[] = self::readInt4($fh);
        }

        // Read rest of Master Block Allocation Table (if any is left)
        $pos = $this->getBlockOffset($mbatFirstBlockId);
        for ($i = 0; $i < $mbbatBlockCount; ++$i) {
            fseek($fh, $pos);
            for ($j = 0; $j < $this->bigBlockSize / 4 - 1; ++$j) {
                $mbatBlocks[] = self::readInt4($fh);
            }
            // Last block id in each block points to next block
            $pos = $this->getBlockOffset(self::readInt4($fh));
        }

        // Read Big Block Allocation Table according to chain specified by $mbatBlocks
        for ($i = 0; $i < $bbatBlockCount; ++$i) {
            $pos = $this->getBlockOffset($mbatBlocks[$i]);
            fseek($fh, $pos);
            for ($j = 0; $j < $this->bigBlockSize / 4; ++$j) {
                $this->bbat[] = self::readInt4($fh);
            }
        }

        // Read short block allocation table (SBAT)
        $this->sbat = [];
        $shortBlockCount = $sbbatBlockCount * $this->bigBlockSize / 4;
        $sbatFh = $this->getStream($sbatFirstBlockId);
        for ($blockId = 0; $blockId < $shortBlockCount; ++$blockId) {
            $this->sbat[$blockId] = self::readInt4($sbatFh);
        }
        fclose($sbatFh);

        $this->readPpsWks($directoryFirstBlockId);

        return true;
    }

Here is the call graph for this function:

readInt1()

static PhpOffice\PhpSpreadsheet\Shared\OLE::readInt1 (   $fh )

staticprivate

Reads a signed char.

Parameters

resource

$fh

file handle

Returns

int

Definition at line 252 of file OLE.php.

    {
        [, $tmp] = unpack('c', fread($fh, 1));

        return $tmp;
    }

readInt2()

static PhpOffice\PhpSpreadsheet\Shared\OLE::readInt2 (   $fh )

staticprivate

Reads an unsigned short (2 octets).

Parameters

resource

$fh

file handle

Returns

int

Definition at line 266 of file OLE.php.

    {
        [, $tmp] = unpack('v', fread($fh, 2));

        return $tmp;
    }

readInt4()

static PhpOffice\PhpSpreadsheet\Shared\OLE::readInt4 (   $fh )

staticprivate

Reads an unsigned long (4 octets).

Parameters

resource

$fh

file handle

Returns

int

Definition at line 280 of file OLE.php.

    {
        [, $tmp] = unpack('V', fread($fh, 4));

        return $tmp;
    }

readPpsWks()

PhpOffice\PhpSpreadsheet\Shared\OLE::readPpsWks

(

$blockId

)

Gets information about all PPS's on the OLE container from the PPS WK's creates an OLE_PPS object for each one.

Parameters

int

$blockId

the block id of the first block

Returns

bool true on success, PEAR_Error on failure

Definition at line 295 of file OLE.php.

References $name, $type, PhpOffice\PhpSpreadsheet\Shared\OLE\getStream(), and PhpOffice\PhpSpreadsheet\Shared\OLE\ppsTreeComplete().

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

    {
        $fh = $this->getStream($blockId);
        for ($pos = 0; true; $pos += 128) {
            fseek($fh, $pos, SEEK_SET);
            $nameUtf16 = fread($fh, 64);
            $nameLength = self::readInt2($fh);
            $nameUtf16 = substr($nameUtf16, 0, $nameLength - 2);
            // Simple conversion from UTF-16LE to ISO-8859-1
            $name = str_replace("\x00", '', $nameUtf16);
            $type = self::readInt1($fh);
            switch ($type) {
                case self::OLE_PPS_TYPE_ROOT:
                    $pps = new OLE\PPS\Root(null, null, []);
                    $this->root = $pps;

                    break;
                case self::OLE_PPS_TYPE_DIR:
                    $pps = new OLE\PPS(null, null, null, null, null, null, null, null, null, []);

                    break;
                case self::OLE_PPS_TYPE_FILE:
                    $pps = new OLE\PPS\File($name);

                    break;
                default:
                    throw new Exception('Unsupported PPS type');
            }
            fseek($fh, 1, SEEK_CUR);
            $pps->Type = $type;
            $pps->Name = $name;
            $pps->PrevPps = self::readInt4($fh);
            $pps->NextPps = self::readInt4($fh);
            $pps->DirPps = self::readInt4($fh);
            fseek($fh, 20, SEEK_CUR);
            $pps->Time1st = self::OLE2LocalDate(fread($fh, 8));
            $pps->Time2nd = self::OLE2LocalDate(fread($fh, 8));
            $pps->startBlock = self::readInt4($fh);
            $pps->Size = self::readInt4($fh);
            $pps->No = count($this->_list);
            $this->_list[] = $pps;

            // check if the PPS tree (starting from root) is complete
            if (isset($this->root) && $this->ppsTreeComplete($this->root->No)) {
                break;
            }
        }
        fclose($fh);

        // Initialize $pps->children on directories
        foreach ($this->_list as $pps) {
            if ($pps->Type == self::OLE_PPS_TYPE_DIR || $pps->Type == self::OLE_PPS_TYPE_ROOT) {
                $nos = [$pps->DirPps];
                $pps->children = [];
                while ($nos) {
                    $no = array_pop($nos);
                    if ($no != -1) {
                        $childPps = $this->_list[$no];
                        $nos[] = $childPps->PrevPps;
                        $nos[] = $childPps->NextPps;
                        $pps->children[] = $childPps;
                    }
                }
            }
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$_file_handle

PhpOffice\PhpSpreadsheet\Shared\OLE::$_file_handle

Definition at line 57 of file OLE.php.

$_list

PhpOffice\PhpSpreadsheet\Shared\OLE::$_list = []

Definition at line 64 of file OLE.php.

$bbat

PhpOffice\PhpSpreadsheet\Shared\OLE::$bbat

Definition at line 78 of file OLE.php.

$bigBlockSize

PhpOffice\PhpSpreadsheet\Shared\OLE::$bigBlockSize

Definition at line 92 of file OLE.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\OLE\getBlockOffset().

$bigBlockThreshold

PhpOffice\PhpSpreadsheet\Shared\OLE::$bigBlockThreshold

Definition at line 106 of file OLE.php.

$root

PhpOffice\PhpSpreadsheet\Shared\OLE::$root

Definition at line 71 of file OLE.php.

$sbat

PhpOffice\PhpSpreadsheet\Shared\OLE::$sbat

Definition at line 85 of file OLE.php.

$smallBlockSize

PhpOffice\PhpSpreadsheet\Shared\OLE::$smallBlockSize

Definition at line 99 of file OLE.php.

OLE_DATA_SIZE_SMALL

const PhpOffice\PhpSpreadsheet\Shared\OLE::OLE_DATA_SIZE_SMALL = 0x1000

Definition at line 48 of file OLE.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\Root\calcSize(), PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\Root\makeSmallData(), and PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\Root\saveBigData().

OLE_LONG_INT_SIZE

const PhpOffice\PhpSpreadsheet\Shared\OLE::OLE_LONG_INT_SIZE = 4

Definition at line 49 of file OLE.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\Root\calcSize(), PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\Root\makeSmallData(), PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\Root\saveBbd(), and PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\Root\saveHeader().

OLE_PPS_SIZE

const PhpOffice\PhpSpreadsheet\Shared\OLE::OLE_PPS_SIZE = 0x80

Definition at line 50 of file OLE.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\Root\calcSize(), and PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\Root\savePps().

OLE_PPS_TYPE_DIR

const PhpOffice\PhpSpreadsheet\Shared\OLE::OLE_PPS_TYPE_DIR = 1

Definition at line 46 of file OLE.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\Root\saveBigData().

OLE_PPS_TYPE_FILE

const PhpOffice\PhpSpreadsheet\Shared\OLE::OLE_PPS_TYPE_FILE = 2

Definition at line 47 of file OLE.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\File\__construct(), PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\Root\calcSize(), and PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\Root\makeSmallData().

OLE_PPS_TYPE_ROOT

const PhpOffice\PhpSpreadsheet\Shared\OLE::OLE_PPS_TYPE_ROOT = 5

Definition at line 45 of file OLE.php.

Referenced by PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\Root\__construct(), and PhpOffice\PhpSpreadsheet\Shared\OLE\PPS\Root\saveBigData().

---

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

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