mirror of
https://github.com/Karaka-Management/Resources.git
synced 2026-01-11 13:28:40 +00:00
364 lines
11 KiB
PHP
Executable File
364 lines
11 KiB
PHP
Executable File
<?php
|
|
/**
|
|
* This file is part of PHPOffice Common
|
|
*
|
|
* PHPOffice Common is free software distributed under the terms of the GNU Lesser
|
|
* General Public License version 3 as published by the Free Software Foundation.
|
|
*
|
|
* For the full copyright and license information, please read the LICENSE
|
|
* file that was distributed with this source code. For the full list of
|
|
* contributors, visit https://github.com/PHPOffice/Common/contributors.
|
|
*
|
|
* @see https://github.com/PHPOffice/Common
|
|
*
|
|
* @copyright 2009-2016 PHPOffice Common contributors
|
|
* @license http://www.gnu.org/licenses/lgpl.txt LGPL version 3
|
|
*/
|
|
|
|
namespace PhpOffice\Common\Microsoft;
|
|
|
|
/*
|
|
if (!defined('IDENTIFIER_OLE')) {
|
|
define('IDENTIFIER_OLE', pack('CCCCCCCC', 0xD0, 0xCF, 0x11, 0xE0, 0xA1, 0xB1, 0x1A, 0xE1));
|
|
}
|
|
*/
|
|
|
|
class OLERead
|
|
{
|
|
/**
|
|
* @var string
|
|
*/
|
|
private $data = '';
|
|
|
|
// OLE identifier
|
|
public const IDENTIFIER_OLE = "\xD0\xCF\x11\xE0\xA1\xB1\x1A\xE1";
|
|
|
|
// Size of a sector = 512 bytes
|
|
public const BIG_BLOCK_SIZE = 0x200;
|
|
|
|
// Size of a short sector = 64 bytes
|
|
public const SMALL_BLOCK_SIZE = 0x40;
|
|
|
|
// Size of a directory entry always = 128 bytes
|
|
public const PROPERTY_STORAGE_BLOCK_SIZE = 0x80;
|
|
|
|
// Minimum size of a standard stream = 4096 bytes, streams smaller than this are stored as short streams
|
|
public const SMALL_BLOCK_THRESHOLD = 0x1000;
|
|
|
|
// header offsets
|
|
public const NUM_BIG_BLOCK_DEPOT_BLOCKS_POS = 0x2C;
|
|
public const ROOT_START_BLOCK_POS = 0x30;
|
|
public const SMALL_BLOCK_DEPOT_BLOCK_POS = 0x3C;
|
|
public const EXTENSION_BLOCK_POS = 0x44;
|
|
public const NUM_EXTENSION_BLOCK_POS = 0x48;
|
|
public const BIG_BLOCK_DEPOT_BLOCKS_POS = 0x4C;
|
|
|
|
// property storage offsets (directory offsets)
|
|
public const SIZE_OF_NAME_POS = 0x40;
|
|
public const TYPE_POS = 0x42;
|
|
public const START_BLOCK_POS = 0x74;
|
|
public const SIZE_POS = 0x78;
|
|
|
|
/**
|
|
* @var int|null
|
|
*/
|
|
public $summaryInformation;
|
|
/**
|
|
* @var int|null
|
|
*/
|
|
public $docSummaryInfos;
|
|
/**
|
|
* @var int|null
|
|
*/
|
|
public $powerpointDocument;
|
|
/**
|
|
* @var int|null
|
|
*/
|
|
public $currentUser;
|
|
/**
|
|
* @var int|null
|
|
*/
|
|
public $pictures;
|
|
/**
|
|
* @var int|null
|
|
*/
|
|
public $rootEntry;
|
|
/**
|
|
* @var array<int, array<string, int|string>>
|
|
*/
|
|
public $props = [];
|
|
/**
|
|
* @var string|null
|
|
*/
|
|
public $smallBlockChain;
|
|
/**
|
|
* @var string|null
|
|
*/
|
|
public $bigBlockChain;
|
|
/**
|
|
* @var string|null
|
|
*/
|
|
public $entry;
|
|
|
|
/**
|
|
* Read the file
|
|
*
|
|
* @param string $sFileName Filename
|
|
*
|
|
* @throws \Exception
|
|
*/
|
|
public function read(string $sFileName): bool
|
|
{
|
|
// Check if file exists and is readable
|
|
if (!\is_readable($sFileName)) {
|
|
return false;
|
|
//throw new \Exception('Could not open ' . $sFileName . ' for reading! File does not exist, or it is not readable.');
|
|
}
|
|
|
|
// 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($sFileName, false, null, 0, 8);
|
|
|
|
// Check OLE identifier
|
|
if ($this->data != self::IDENTIFIER_OLE) {
|
|
return false;
|
|
//throw new \Exception('The filename ' . $sFileName . ' is not recognized as an OLE file');
|
|
}
|
|
|
|
// Get the file data
|
|
$this->data = \file_get_contents($sFileName);
|
|
|
|
// Total number of sectors used for the SAT
|
|
$numBigBlkDepotBlks = self::getInt4d($this->data, self::NUM_BIG_BLOCK_DEPOT_BLOCKS_POS);
|
|
|
|
// SecID of the first sector of the directory stream
|
|
$rootStartBlock = self::getInt4d($this->data, self::ROOT_START_BLOCK_POS);
|
|
|
|
// SecID of the first sector of the SSAT (or -2 if not extant)
|
|
$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)
|
|
$extensionBlock = self::getInt4d($this->data, self::EXTENSION_BLOCK_POS);
|
|
|
|
// Total number of sectors used by MSAT
|
|
$numExtensionBlocks = self::getInt4d($this->data, self::NUM_EXTENSION_BLOCK_POS);
|
|
|
|
$bigBlockDepotBlocks = [];
|
|
$pos = self::BIG_BLOCK_DEPOT_BLOCKS_POS;
|
|
|
|
$bbdBlocks = $numBigBlkDepotBlks;
|
|
|
|
if ($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 < $numExtensionBlocks; ++$j) {
|
|
$pos = ($extensionBlock + 1) * self::BIG_BLOCK_SIZE;
|
|
$blocksToRead = \min($numBigBlkDepotBlks - $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 < $numBigBlkDepotBlks) {
|
|
$extensionBlock = self::getInt4d($this->data, $pos);
|
|
}
|
|
}
|
|
|
|
$this->bigBlockChain = '';
|
|
$bbs = self::BIG_BLOCK_SIZE / 4;
|
|
for ($i = 0; $i < $numBigBlkDepotBlks; ++$i) {
|
|
$pos = ($bigBlockDepotBlocks[$i] + 1) * self::BIG_BLOCK_SIZE;
|
|
|
|
$this->bigBlockChain .= \substr($this->data, $pos, 4 * $bbs);
|
|
$pos += 4 * $bbs;
|
|
}
|
|
|
|
$sbdBlock = $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 = $rootStartBlock;
|
|
$this->entry = $this->readData($block);
|
|
|
|
$this->readPropertySets();
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Extract binary stream data
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getStream(int $stream): ?string
|
|
{
|
|
$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;
|
|
}
|
|
|
|
/**
|
|
* Read a standard stream (by joining sectors using information from SAT)
|
|
*
|
|
* @param int $blID Sector ID where the stream starts
|
|
*
|
|
* @return string Data for standard stream
|
|
*/
|
|
private function readData(int $blID): string
|
|
{
|
|
$block = $blID;
|
|
$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;
|
|
}
|
|
|
|
/**
|
|
* Read entries in the directory stream.
|
|
*/
|
|
private function readPropertySets(): void
|
|
{
|
|
$offset = 0;
|
|
|
|
// loop through entires, each entry is 128 bytes
|
|
$entryLen = \strlen($this->entry);
|
|
while ($offset < $entryLen) {
|
|
// entry data (128 bytes)
|
|
$data = \substr($this->entry, $offset, self::PROPERTY_STORAGE_BLOCK_SIZE);
|
|
|
|
// size in bytes of name
|
|
$nameSize = \ord($data[self::SIZE_OF_NAME_POS]) | (\ord($data[self::SIZE_OF_NAME_POS + 1]) << 8);
|
|
|
|
// type of entry
|
|
$type = \ord($data[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($data, self::START_BLOCK_POS);
|
|
|
|
$size = self::getInt4d($data, self::SIZE_POS);
|
|
|
|
$name = \str_replace("\x00", '', \substr($data, 0, $nameSize));
|
|
if ($size > 0) {
|
|
$this->props[] = [
|
|
'name' => $name,
|
|
'type' => $type,
|
|
'startBlock' => $startBlock,
|
|
'size' => $size,
|
|
];
|
|
|
|
// tmp helper to simplify checks
|
|
$upName = \strtoupper($name);
|
|
|
|
switch ($upName) {
|
|
case 'ROOT ENTRY':
|
|
case 'R':
|
|
$this->rootEntry = \count($this->props) - 1;
|
|
break;
|
|
case \chr(1) . 'COMPOBJ':
|
|
break;
|
|
case \chr(1) . 'OLE':
|
|
break;
|
|
case \chr(5) . 'SUMMARYINFORMATION':
|
|
$this->summaryInformation = \count($this->props) - 1;
|
|
break;
|
|
case \chr(5) . 'DOCUMENTSUMMARYINFORMATION':
|
|
$this->docSummaryInfos = \count($this->props) - 1;
|
|
break;
|
|
case 'CURRENT USER':
|
|
$this->currentUser = \count($this->props) - 1;
|
|
break;
|
|
case 'PICTURES':
|
|
$this->pictures = \count($this->props) - 1;
|
|
break;
|
|
case 'POWERPOINT DOCUMENT':
|
|
$this->powerpointDocument = \count($this->props) - 1;
|
|
break;
|
|
default:
|
|
return;
|
|
//throw new \Exception('OLE Block Not defined: $upName : ' . $upName . ' - $name : "' . $name . '"');
|
|
}
|
|
}
|
|
|
|
$offset += self::PROPERTY_STORAGE_BLOCK_SIZE;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Read 4 bytes of data at specified position
|
|
*
|
|
* @param string $data
|
|
* @param int $pos
|
|
*
|
|
* @return int
|
|
*/
|
|
private static function getInt4d($data, $pos)
|
|
{
|
|
// FIX: represent numbers correctly on 64-bit system
|
|
// http://sourceforge.net/tracker/index.php?func=detail&aid=1487372&group_id=99160&atid=623334
|
|
// Hacked by Andreas Rehm 2006 to ensure correct result of the <<24 block on 32 and 64bit systems
|
|
$or24 = \ord($data[$pos + 3]);
|
|
if ($or24 >= 128) {
|
|
// negative number
|
|
$ord24 = -\abs((256 - $or24) << 24);
|
|
} else {
|
|
$ord24 = ($or24 & 127) << 24;
|
|
}
|
|
|
|
return \ord($data[$pos]) | (\ord($data[$pos + 1]) << 8) | (\ord($data[$pos + 2]) << 16) | $ord24;
|
|
}
|
|
}
|