ILIAS  release_5-2 Revision v5.2.25-18-g3f80b828510
Public Member Functions | Data Fields | Private Member Functions | Static Private Member Functions | Private Attributes
PHPExcel_Shared_OLERead Class Reference
+ Collaboration diagram for PHPExcel_Shared_OLERead:

Public Member Functions

 read ($sFileName)
 Read the file. More...
 
 getStream ($stream)
 Extract binary stream data. More...
 

Data Fields

const IDENTIFIER_OLE = IDENTIFIER_OLE
 
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 = null
 
 $summaryInformation = null
 
 $documentSummaryInformation = null
 

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 = ''
 

Detailed Description

Definition at line 31 of file OLERead.php.

Member Function Documentation

◆ _GetInt4d()

static PHPExcel_Shared_OLERead::_GetInt4d (   $data,
  $pos 
)
staticprivate

Read 4 bytes of data at specified position.

Parameters
string$data
int$pos
Returns
int

Definition at line 302 of file OLERead.php.

References $data.

303  {
304  // FIX: represent numbers correctly on 64-bit system
305  // http://sourceforge.net/tracker/index.php?func=detail&aid=1487372&group_id=99160&atid=623334
306  // Hacked by Andreas Rehm 2006 to ensure correct result of the <<24 block on 32 and 64bit systems
307  $_or_24 = ord($data[$pos + 3]);
308  if ($_or_24 >= 128) {
309  // negative number
310  $_ord_24 = -abs((256 - $_or_24) << 24);
311  } else {
312  $_ord_24 = ($_or_24 & 127) << 24;
313  }
314  return ord($data[$pos]) | (ord($data[$pos + 1]) << 8) | (ord($data[$pos + 2]) << 16) | $_ord_24;
315  }
PHPExcel_Shared_OLERead\$data
$data
Definition: OLERead.php:32

◆ _readData()

PHPExcel_Shared_OLERead::_readData (   $bl)
private

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

Parameters
int$blSector ID where the stream starts
Returns
string Data for standard stream

Definition at line 220 of file OLERead.php.

References $data, and data.

Referenced by getStream(), and read().

221  {
222  $block = $bl;
223  $data = '';
224 
225  while ($block != -2) {
226  $pos = ($block + 1) * self::BIG_BLOCK_SIZE;
227  $data .= substr($this->data, $pos, self::BIG_BLOCK_SIZE);
228  $block = self::_GetInt4d($this->bigBlockChain, $block*4);
229  }
230  return $data;
231  }
data
Add some data
Definition: 01pharSimple.php:56
PHPExcel_Shared_OLERead\$data
$data
Definition: OLERead.php:32
+ Here is the caller graph for this function:

◆ _readPropertySets()

PHPExcel_Shared_OLERead::_readPropertySets ( )
private

Read entries in the directory stream.

Definition at line 236 of file OLERead.php.

References $d, $size, and array.

Referenced by read().

236  {
237  $offset = 0;
238 
239  // loop through entires, each entry is 128 bytes
240  $entryLen = strlen($this->entry);
241  while ($offset < $entryLen) {
242  // entry data (128 bytes)
243  $d = substr($this->entry, $offset, self::PROPERTY_STORAGE_BLOCK_SIZE);
244 
245  // size in bytes of name
246  $nameSize = ord($d[self::SIZE_OF_NAME_POS]) | (ord($d[self::SIZE_OF_NAME_POS+1]) << 8);
247 
248  // type of entry
249  $type = ord($d[self::TYPE_POS]);
250 
251  // sectorID of first sector or short sector, if this entry refers to a stream (the case with workbook)
252  // sectorID of first sector of the short-stream container stream, if this entry is root entry
253  $startBlock = self::_GetInt4d($d, self::START_BLOCK_POS);
254 
255  $size = self::_GetInt4d($d, self::SIZE_POS);
256 
257  $name = str_replace("\x00", "", substr($d,0,$nameSize));
258 
259 
260  $this->props[] = array (
261  'name' => $name,
262  'type' => $type,
263  'startBlock' => $startBlock,
264  'size' => $size);
265 
266  // tmp helper to simplify checks
267  $upName = strtoupper($name);
268 
269  // Workbook directory entry (BIFF5 uses Book, BIFF8 uses Workbook)
270  if (($upName === 'WORKBOOK') || ($upName === 'BOOK')) {
271  $this->wrkbook = count($this->props) - 1;
272  }
273  else if ( $upName === 'ROOT ENTRY' || $upName === 'R') {
274  // Root entry
275  $this->rootentry = count($this->props) - 1;
276  }
277 
278  // Summary information
279  if ($name == chr(5) . 'SummaryInformation') {
280 // echo 'Summary Information<br />';
281  $this->summaryInformation = count($this->props) - 1;
282  }
283 
284  // Additional Document Summary information
285  if ($name == chr(5) . 'DocumentSummaryInformation') {
286 // echo 'Document Summary Information<br />';
287  $this->documentSummaryInformation = count($this->props) - 1;
288  }
289 
290  $offset += self::PROPERTY_STORAGE_BLOCK_SIZE;
291  }
292 
293  }
$size
$size
Definition: RandomTest.php:79
$d
for($col=0; $col< 50; $col++) $d
Definition: 40duplicateStyle.php:38
array
Create styles array
The data for the language used.
Definition: 40duplicateStyle.php:19
+ Here is the caller graph for this function:

◆ getStream()

PHPExcel_Shared_OLERead::getStream (   $stream)

Extract binary stream data.

Returns
string

Definition at line 173 of file OLERead.php.

References _readData(), and data.

174  {
175  if ($stream === NULL) {
176  return null;
177  }
178 
179  $streamData = '';
180 
181  if ($this->props[$stream]['size'] < self::SMALL_BLOCK_THRESHOLD) {
182  $rootdata = $this->_readData($this->props[$this->rootentry]['startBlock']);
183 
184  $block = $this->props[$stream]['startBlock'];
185 
186  while ($block != -2) {
187  $pos = $block * self::SMALL_BLOCK_SIZE;
188  $streamData .= substr($rootdata, $pos, self::SMALL_BLOCK_SIZE);
189 
190  $block = self::_GetInt4d($this->smallBlockChain, $block*4);
191  }
192 
193  return $streamData;
194  } else {
195  $numBlocks = $this->props[$stream]['size'] / self::BIG_BLOCK_SIZE;
196  if ($this->props[$stream]['size'] % self::BIG_BLOCK_SIZE != 0) {
197  ++$numBlocks;
198  }
199 
200  if ($numBlocks == 0) return '';
201 
202  $block = $this->props[$stream]['startBlock'];
203 
204  while ($block != -2) {
205  $pos = ($block + 1) * self::BIG_BLOCK_SIZE;
206  $streamData .= substr($this->data, $pos, self::BIG_BLOCK_SIZE);
207  $block = self::_GetInt4d($this->bigBlockChain, $block*4);
208  }
209 
210  return $streamData;
211  }
212  }
data
Add some data
Definition: 01pharSimple.php:56
PHPExcel_Shared_OLERead\_readData
_readData($bl)
Read a standard stream (by joining sectors using information from SAT)
Definition: OLERead.php:220
+ Here is the call graph for this function:

◆ read()

PHPExcel_Shared_OLERead::read (   $sFileName)

Read the file.

Parameters
$sFileNamestring Filename
Exceptions
PHPExcel_Reader_Exception

Definition at line 76 of file OLERead.php.

References _readData(), _readPropertySets(), array, and data.

77  {
78  // Check if file exists and is readable
79  if(!is_readable($sFileName)) {
80  throw new PHPExcel_Reader_Exception("Could not open " . $sFileName . " for reading! File does not exist, or it is not readable.");
81  }
82 
83  // Get the file identifier
84  // Don't bother reading the whole file until we know it's a valid OLE file
85  $this->data = file_get_contents($sFileName, FALSE, NULL, 0, 8);
86 
87  // Check OLE identifier
88  if ($this->data != self::IDENTIFIER_OLE) {
89  throw new PHPExcel_Reader_Exception('The filename ' . $sFileName . ' is not recognised as an OLE file');
90  }
91 
92  // Get the file data
93  $this->data = file_get_contents($sFileName);
94 
95  // Total number of sectors used for the SAT
96  $this->numBigBlockDepotBlocks = self::_GetInt4d($this->data, self::NUM_BIG_BLOCK_DEPOT_BLOCKS_POS);
97 
98  // SecID of the first sector of the directory stream
99  $this->rootStartBlock = self::_GetInt4d($this->data, self::ROOT_START_BLOCK_POS);
100 
101  // SecID of the first sector of the SSAT (or -2 if not extant)
102  $this->sbdStartBlock = self::_GetInt4d($this->data, self::SMALL_BLOCK_DEPOT_BLOCK_POS);
103 
104  // SecID of the first sector of the MSAT (or -2 if no additional sectors are used)
105  $this->extensionBlock = self::_GetInt4d($this->data, self::EXTENSION_BLOCK_POS);
106 
107  // Total number of sectors used by MSAT
108  $this->numExtensionBlocks = self::_GetInt4d($this->data, self::NUM_EXTENSION_BLOCK_POS);
109 
110  $bigBlockDepotBlocks = array();
111  $pos = self::BIG_BLOCK_DEPOT_BLOCKS_POS;
112 
113  $bbdBlocks = $this->numBigBlockDepotBlocks;
114 
115  if ($this->numExtensionBlocks != 0) {
116  $bbdBlocks = (self::BIG_BLOCK_SIZE - self::BIG_BLOCK_DEPOT_BLOCKS_POS)/4;
117  }
118 
119  for ($i = 0; $i < $bbdBlocks; ++$i) {
120  $bigBlockDepotBlocks[$i] = self::_GetInt4d($this->data, $pos);
121  $pos += 4;
122  }
123 
124  for ($j = 0; $j < $this->numExtensionBlocks; ++$j) {
125  $pos = ($this->extensionBlock + 1) * self::BIG_BLOCK_SIZE;
126  $blocksToRead = min($this->numBigBlockDepotBlocks - $bbdBlocks, self::BIG_BLOCK_SIZE / 4 - 1);
127 
128  for ($i = $bbdBlocks; $i < $bbdBlocks + $blocksToRead; ++$i) {
129  $bigBlockDepotBlocks[$i] = self::_GetInt4d($this->data, $pos);
130  $pos += 4;
131  }
132 
133  $bbdBlocks += $blocksToRead;
134  if ($bbdBlocks < $this->numBigBlockDepotBlocks) {
135  $this->extensionBlock = self::_GetInt4d($this->data, $pos);
136  }
137  }
138 
139  $pos = 0;
140  $this->bigBlockChain = '';
141  $bbs = self::BIG_BLOCK_SIZE / 4;
142  for ($i = 0; $i < $this->numBigBlockDepotBlocks; ++$i) {
143  $pos = ($bigBlockDepotBlocks[$i] + 1) * self::BIG_BLOCK_SIZE;
144 
145  $this->bigBlockChain .= substr($this->data, $pos, 4*$bbs);
146  $pos += 4*$bbs;
147  }
148 
149  $pos = 0;
150  $sbdBlock = $this->sbdStartBlock;
151  $this->smallBlockChain = '';
152  while ($sbdBlock != -2) {
153  $pos = ($sbdBlock + 1) * self::BIG_BLOCK_SIZE;
154 
155  $this->smallBlockChain .= substr($this->data, $pos, 4*$bbs);
156  $pos += 4*$bbs;
157 
158  $sbdBlock = self::_GetInt4d($this->bigBlockChain, $sbdBlock*4);
159  }
160 
161  // read the directory stream
162  $block = $this->rootStartBlock;
163  $this->entry = $this->_readData($block);
164 
165  $this->_readPropertySets();
166  }
data
Add some data
Definition: 01pharSimple.php:56
PHPExcel_Shared_OLERead\_readData
_readData($bl)
Read a standard stream (by joining sectors using information from SAT)
Definition: OLERead.php:220
array
Create styles array
The data for the language used.
Definition: 40duplicateStyle.php:19
PHPExcel_Shared_OLERead\_readPropertySets
_readPropertySets()
Read entries in the directory stream.
Definition: OLERead.php:236
PHPExcel_Reader_Exception
Definition: Exception.php:36
+ Here is the call graph for this function:

Field Documentation

◆ $data

PHPExcel_Shared_OLERead::$data = ''
private

Definition at line 32 of file OLERead.php.

Referenced by _GetInt4d(), and _readData().

◆ $documentSummaryInformation

PHPExcel_Shared_OLERead::$documentSummaryInformation = null

Definition at line 67 of file OLERead.php.

◆ $summaryInformation

PHPExcel_Shared_OLERead::$summaryInformation = null

Definition at line 66 of file OLERead.php.

◆ $wrkbook

PHPExcel_Shared_OLERead::$wrkbook = null

Definition at line 65 of file OLERead.php.

◆ BIG_BLOCK_DEPOT_BLOCKS_POS

const PHPExcel_Shared_OLERead::BIG_BLOCK_DEPOT_BLOCKS_POS = 0x4c

Definition at line 55 of file OLERead.php.

◆ BIG_BLOCK_SIZE

const PHPExcel_Shared_OLERead::BIG_BLOCK_SIZE = 0x200

Definition at line 38 of file OLERead.php.

◆ EXTENSION_BLOCK_POS

const PHPExcel_Shared_OLERead::EXTENSION_BLOCK_POS = 0x44

Definition at line 53 of file OLERead.php.

◆ IDENTIFIER_OLE

const PHPExcel_Shared_OLERead::IDENTIFIER_OLE = IDENTIFIER_OLE

Definition at line 35 of file OLERead.php.

◆ NUM_BIG_BLOCK_DEPOT_BLOCKS_POS

const PHPExcel_Shared_OLERead::NUM_BIG_BLOCK_DEPOT_BLOCKS_POS = 0x2c

Definition at line 50 of file OLERead.php.

◆ NUM_EXTENSION_BLOCK_POS

const PHPExcel_Shared_OLERead::NUM_EXTENSION_BLOCK_POS = 0x48

Definition at line 54 of file OLERead.php.

◆ PROPERTY_STORAGE_BLOCK_SIZE

const PHPExcel_Shared_OLERead::PROPERTY_STORAGE_BLOCK_SIZE = 0x80

Definition at line 44 of file OLERead.php.

◆ ROOT_START_BLOCK_POS

const PHPExcel_Shared_OLERead::ROOT_START_BLOCK_POS = 0x30

Definition at line 51 of file OLERead.php.

◆ SIZE_OF_NAME_POS

const PHPExcel_Shared_OLERead::SIZE_OF_NAME_POS = 0x40

Definition at line 58 of file OLERead.php.

◆ SIZE_POS

const PHPExcel_Shared_OLERead::SIZE_POS = 0x78

Definition at line 61 of file OLERead.php.

◆ SMALL_BLOCK_DEPOT_BLOCK_POS

const PHPExcel_Shared_OLERead::SMALL_BLOCK_DEPOT_BLOCK_POS = 0x3c

Definition at line 52 of file OLERead.php.

◆ SMALL_BLOCK_SIZE

const PHPExcel_Shared_OLERead::SMALL_BLOCK_SIZE = 0x40

Definition at line 41 of file OLERead.php.

◆ SMALL_BLOCK_THRESHOLD

const PHPExcel_Shared_OLERead::SMALL_BLOCK_THRESHOLD = 0x1000

Definition at line 47 of file OLERead.php.

◆ START_BLOCK_POS

const PHPExcel_Shared_OLERead::START_BLOCK_POS = 0x74

Definition at line 60 of file OLERead.php.

◆ TYPE_POS

const PHPExcel_Shared_OLERead::TYPE_POS = 0x42

Definition at line 59 of file OLERead.php.

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