Completed
Pull Request — master (#349)
by
unknown
05:52
created

RawDataParser::decodeStream()   D

Complexity

Conditions 21
Paths 51

Size

Total Lines 56
Code Lines 32

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 22
CRAP Score 31.7889

Importance

Changes 2
Bugs 1 Features 1
Metric Value
cc 21
eloc 32
c 2
b 1
f 1
nc 51
nop 4
dl 0
loc 56
ccs 22
cts 31
cp 0.7097
crap 31.7889
rs 4.1666

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
3
/**
4
 * This file is based on code of tecnickcom/TCPDF PDF library.
5
 *
6
 * Original author Nicola Asuni ([email protected]) and
7
 * contributors (https://github.com/tecnickcom/TCPDF/graphs/contributors).
8
 *
9
 * @see https://github.com/tecnickcom/TCPDF
10
 *
11
 * Original code was licensed on the terms of the LGPL v3.
12
 *
13
 * ------------------------------------------------------------------------------
14
 *
15
 * @file This file is part of the PdfParser library.
16
 *
17
 * @author  Konrad Abicht <[email protected]>
18
 * @date    2020-01-06
19
 *
20
 * @license LGPLv3
21
 * @url     <https://github.com/smalot/pdfparser>
22
 *
23
 *  PdfParser is a pdf library written in PHP, extraction oriented.
24
 *  Copyright (C) 2017 - Sébastien MALOT <[email protected]>
25
 *
26
 *  This program is free software: you can redistribute it and/or modify
27
 *  it under the terms of the GNU Lesser General Public License as published by
28
 *  the Free Software Foundation, either version 3 of the License, or
29
 *  (at your option) any later version.
30
 *
31
 *  This program is distributed in the hope that it will be useful,
32
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
33
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
34
 *  GNU Lesser General Public License for more details.
35
 *
36
 *  You should have received a copy of the GNU Lesser General Public License
37
 *  along with this program.
38
 *  If not, see <http://www.pdfparser.org/sites/default/LICENSE.txt>.
39
 */
40
41
namespace Smalot\PdfParser\RawData;
42
43
use Exception;
44
45
class RawDataParser
46
{
47
    /**
48
     * Configuration array.
49
     */
50
    protected $cfg = [
51
        // if `true` ignore filter decoding errors
52
        'ignore_filter_decoding_errors' => true,
53
        // if `true` ignore missing filter decoding errors
54
        'ignore_missing_filter_decoders' => true,
55
    ];
56
57
    protected $filterHelper;
58
    protected $objects;
59
60
    /**
61
     * @param array $cfg Configuration array, default is []
62
     */
63 11
    public function __construct($cfg = [])
64
    {
65
        // merge given array with default values
66 11
        $this->cfg = array_merge($this->cfg, $cfg);
67
68 11
        $this->filterHelper = new FilterHelper();
69 11
    }
70
71
    /**
72
     * Decode the specified stream.
73
     *
74
     * @param string $pdfData PDF data
75
     * @param array  $xref
76
     * @param array  $sdic    Stream's dictionary array
77
     * @param string $stream  Stream to decode
78
     *
79
     * @return array containing decoded stream data and remaining filters
80
     */
81 10
    protected function decodeStream($pdfData, $xref, $sdic, $stream)
82
    {
83
        // get stream length and filters
84 10
        $slength = \strlen($stream);
85 10
        if ($slength <= 0) {
86
            return ['', []];
87
        }
88 10
        $filters = [];
89 10
        foreach ($sdic as $k => $v) {
90 10
            if ('/' == $v[0]) {
91 10
                if (('Length' == $v[1]) and (isset($sdic[($k + 1)])) and ('numeric' == $sdic[($k + 1)][0])) {
92
                    // get declared stream length
93 10
                    $declength = (int) ($sdic[($k + 1)][1]);
94 10
                    if ($declength < $slength) {
95 10
                        $stream = substr($stream, 0, $declength);
96 10
                        $slength = $declength;
97
                    }
98 10
                } elseif (('Filter' == $v[1]) and (isset($sdic[($k + 1)]))) {
99
                    // resolve indirect object
100 10
                    $objval = $this->getObjectVal($pdfData, $xref, $sdic[($k + 1)]);
101 10
                    if ('/' == $objval[0]) {
102
                        // single filter
103 10
                        $filters[] = $objval[1];
104
                    } elseif ('[' == $objval[0]) {
105
                        // array of filters
106
                        foreach ($objval[1] as $flt) {
107
                            if ('/' == $flt[0]) {
108
                                $filters[] = $flt[1];
109
                            }
110
                        }
111
                    }
112
                }
113
            }
114
        }
115
116
        // decode the stream
117 10
        $remaining_filters = [];
118 10
        foreach ($filters as $filter) {
119 10
            if (\in_array($filter, $this->filterHelper->getAvailableFilters())) {
120
                try {
121 10
                    $stream = $this->filterHelper->decodeFilter($filter, $stream);
122
                } catch (Exception $e) {
123
                    $emsg = $e->getMessage();
124
                    if ((('~' == $emsg[0]) && !$this->cfg['ignore_missing_filter_decoders'])
125
                        || (('~' != $emsg[0]) && !$this->cfg['ignore_filter_decoding_errors'])
126
                    ) {
127 10
                        throw new Exception($e->getMessage());
128
                    }
129
                }
130
            } else {
131
                // add missing filter to array
132 2
                $remaining_filters[] = $filter;
133
            }
134
        }
135
136 10
        return [$stream, $remaining_filters];
137
    }
138
139
    /**
140
     * Decode the Cross-Reference section
141
     *
142
     * @param string $pdfData   PDF data
143
     * @param int    $startxref Offset at which the xref section starts (position of the 'xref' keyword)
144
     * @param array  $xref      Previous xref array (if any)
145
     *
146
     * @return array containing xref and trailer data
147
     */
148 9
    protected function decodeXref($pdfData, $startxref, $xref = [])
149
    {
150 9
        $startxref += 4; // 4 is the length of the word 'xref'
151
        // skip initial white space chars: \x00 null (NUL), \x09 horizontal tab (HT), \x0A line feed (LF), \x0C form feed (FF), \x0D carriage return (CR), \x20 space (SP)
152 9
        $offset = $startxref + strspn($pdfData, "\x00\x09\x0a\x0c\x0d\x20", $startxref);
153
        // initialize object number
154 9
        $obj_num = 0;
155
        // search for cross-reference entries or subsection
156 9
        while (preg_match('/([0-9]+)[\x20]([0-9]+)[\x20]?([nf]?)(\r\n|[\x20]?[\r\n])/', $pdfData, $matches, PREG_OFFSET_CAPTURE, $offset) > 0) {
157 9
            if ($matches[0][1] != $offset) {
158
                // we are on another section
159
                break;
160
            }
161 9
            $offset += \strlen($matches[0][0]);
162 9
            if ('n' == $matches[3][0]) {
163
                // create unique object index: [object number]_[generation number]
164 9
                $index = $obj_num.'_'.(int) ($matches[2][0]);
165
                // check if object already exist
166 9
                if (!isset($xref['xref'][$index])) {
167
                    // store object offset position
168 9
                    $xref['xref'][$index] = (int) ($matches[1][0]);
169
                }
170 9
                ++$obj_num;
171 9
            } elseif ('f' == $matches[3][0]) {
172 9
                ++$obj_num;
173
            } else {
174
                // object number (index)
175 9
                $obj_num = (int) ($matches[1][0]);
176
            }
177
        }
178
        // get trailer data
179 9
        if (preg_match('/trailer[\s]*<<(.*)>>/isU', $pdfData, $matches, PREG_OFFSET_CAPTURE, $offset) > 0) {
180 9
            $trailer_data = $matches[1][0];
181 9
            if (!isset($xref['trailer']) or empty($xref['trailer'])) {
182
                // get only the last updated version
183 9
                $xref['trailer'] = [];
184
                // parse trailer_data
185 9
                if (preg_match('/Size[\s]+([0-9]+)/i', $trailer_data, $matches) > 0) {
186 9
                    $xref['trailer']['size'] = (int) ($matches[1]);
187
                }
188 9
                if (preg_match('/Root[\s]+([0-9]+)[\s]+([0-9]+)[\s]+R/i', $trailer_data, $matches) > 0) {
189 9
                    $xref['trailer']['root'] = (int) ($matches[1]).'_'.(int) ($matches[2]);
190
                }
191 9
                if (preg_match('/Encrypt[\s]+([0-9]+)[\s]+([0-9]+)[\s]+R/i', $trailer_data, $matches) > 0) {
192
                    $xref['trailer']['encrypt'] = (int) ($matches[1]).'_'.(int) ($matches[2]);
193
                }
194 9
                if (preg_match('/Info[\s]+([0-9]+)[\s]+([0-9]+)[\s]+R/i', $trailer_data, $matches) > 0) {
195 9
                    $xref['trailer']['info'] = (int) ($matches[1]).'_'.(int) ($matches[2]);
196
                }
197 9
                if (preg_match('/ID[\s]*[\[][\s]*[<]([^>]*)[>][\s]*[<]([^>]*)[>]/i', $trailer_data, $matches) > 0) {
198 8
                    $xref['trailer']['id'] = [];
199 8
                    $xref['trailer']['id'][0] = $matches[1];
200 8
                    $xref['trailer']['id'][1] = $matches[2];
201
                }
202
            }
203 9
            if (preg_match('/Prev[\s]+([0-9]+)/i', $trailer_data, $matches) > 0) {
204
                // get previous xref
205 9
                $xref = $this->getXrefData($pdfData, (int) ($matches[1]), $xref);
206
            }
207
        } else {
208
            throw new Exception('Unable to find trailer');
209
        }
210
211 9
        return $xref;
212
    }
213
214
    /**
215
     * Decode the Cross-Reference Stream section
216
     *
217
     * @param string $pdfData   PDF data
218
     * @param int    $startxref Offset at which the xref section starts
219
     * @param array  $xref      Previous xref array (if any)
220
     *
221
     * @return array containing xref and trailer data
222
     *
223
     * @throws Exception if unknown PNG predictor detected
224
     */
225 1
    protected function decodeXrefStream($pdfData, $startxref, $xref = [])
226
    {
227
        // try to read Cross-Reference Stream
228 1
        $xrefobj = $this->getRawObject($pdfData, $startxref);
229 1
        $xrefcrs = $this->getIndirectObject($pdfData, $xref, $xrefobj[1], $startxref, true);
230 1
        if (!isset($xref['trailer']) or empty($xref['trailer'])) {
231
            // get only the last updated version
232 1
            $xref['trailer'] = [];
233 1
            $filltrailer = true;
234
        } else {
235 1
            $filltrailer = false;
236
        }
237 1
        if (!isset($xref['xref'])) {
238 1
            $xref['xref'] = [];
239
        }
240 1
        $valid_crs = false;
241 1
        $columns = 0;
242 1
        $sarr = $xrefcrs[0][1];
243 1
        if (!\is_array($sarr)) {
244
            $sarr = [];
245
        }
246
247 1
        $wb = [];
248
249 1
        foreach ($sarr as $k => $v) {
250
            if (
251 1
                ('/' == $v[0])
252 1
                && ('Type' == $v[1])
253
                && (
254 1
                    isset($sarr[($k + 1)])
255 1
                    && '/' == $sarr[($k + 1)][0]
256 1
                    && 'XRef' == $sarr[($k + 1)][1]
257
                )
258
            ) {
259 1
                $valid_crs = true;
260 1
            } elseif (('/' == $v[0]) and ('Index' == $v[1]) and (isset($sarr[($k + 1)]))) {
261
                // first object number in the subsection
262 1
                $index_first = (int) ($sarr[($k + 1)][1][0][1]);
263 1
            } elseif (('/' == $v[0]) and ('Prev' == $v[1]) and (isset($sarr[($k + 1)]) and ('numeric' == $sarr[($k + 1)][0]))) {
264
                // get previous xref offset
265 1
                $prevxref = (int) ($sarr[($k + 1)][1]);
266 1
            } elseif (('/' == $v[0]) and ('W' == $v[1]) and (isset($sarr[($k + 1)]))) {
267
                // number of bytes (in the decoded stream) of the corresponding field
268 1
                $wb[0] = (int) ($sarr[($k + 1)][1][0][1]);
269 1
                $wb[1] = (int) ($sarr[($k + 1)][1][1][1]);
270 1
                $wb[2] = (int) ($sarr[($k + 1)][1][2][1]);
271 1
            } elseif (('/' == $v[0]) and ('DecodeParms' == $v[1]) and (isset($sarr[($k + 1)][1]))) {
272 1
                $decpar = $sarr[($k + 1)][1];
273 1
                foreach ($decpar as $kdc => $vdc) {
274
                    if (
275 1
                        '/' == $vdc[0]
276 1
                        && 'Columns' == $vdc[1]
277
                        && (
278 1
                            isset($decpar[($kdc + 1)])
279 1
                            && 'numeric' == $decpar[($kdc + 1)][0]
280
                        )
281
                    ) {
282 1
                        $columns = (int) ($decpar[($kdc + 1)][1]);
283
                    } elseif (
284 1
                        '/' == $vdc[0]
285 1
                        && 'Predictor' == $vdc[1]
286
                        && (
287 1
                            isset($decpar[($kdc + 1)])
288 1
                            && 'numeric' == $decpar[($kdc + 1)][0]
289
                        )
290
                    ) {
291 1
                        $predictor = (int) ($decpar[($kdc + 1)][1]);
0 ignored issues
show
Unused Code introduced by
The assignment to $predictor is dead and can be removed.
Loading history...
292
                    }
293
                }
294 1
            } elseif ($filltrailer) {
295 1
                if (('/' == $v[0]) and ('Size' == $v[1]) and (isset($sarr[($k + 1)]) and ('numeric' == $sarr[($k + 1)][0]))) {
296 1
                    $xref['trailer']['size'] = $sarr[($k + 1)][1];
297 1
                } elseif (('/' == $v[0]) and ('Root' == $v[1]) and (isset($sarr[($k + 1)]) and ('objref' == $sarr[($k + 1)][0]))) {
298 1
                    $xref['trailer']['root'] = $sarr[($k + 1)][1];
299 1
                } elseif (('/' == $v[0]) and ('Info' == $v[1]) and (isset($sarr[($k + 1)]) and ('objref' == $sarr[($k + 1)][0]))) {
300 1
                    $xref['trailer']['info'] = $sarr[($k + 1)][1];
301 1
                } elseif (('/' == $v[0]) and ('Encrypt' == $v[1]) and (isset($sarr[($k + 1)]) and ('objref' == $sarr[($k + 1)][0]))) {
302
                    $xref['trailer']['encrypt'] = $sarr[($k + 1)][1];
303 1
                } elseif (('/' == $v[0]) and ('ID' == $v[1]) and (isset($sarr[($k + 1)]))) {
304 1
                    $xref['trailer']['id'] = [];
305 1
                    $xref['trailer']['id'][0] = $sarr[($k + 1)][1][0][1];
306 1
                    $xref['trailer']['id'][1] = $sarr[($k + 1)][1][1][1];
307
                }
308
            }
309
        }
310
311
        // decode data
312 1
        if ($valid_crs and isset($xrefcrs[1][3][0])) {
313
            // number of bytes in a row
314 1
            $rowlen = ($columns + 1);
315
            // convert the stream into an array of integers
316 1
            $sdata = unpack('C*', $xrefcrs[1][3][0]);
317
            // split the rows
318 1
            $sdata = array_chunk($sdata, $rowlen);
0 ignored issues
show
Bug introduced by
It seems like $sdata can also be of type false; however, parameter $input of array_chunk() does only seem to accept array, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

318
            $sdata = array_chunk(/** @scrutinizer ignore-type */ $sdata, $rowlen);
Loading history...
319
            // initialize decoded array
320 1
            $ddata = [];
321
            // initialize first row with zeros
322 1
            $prev_row = array_fill(0, $rowlen, 0);
323
            // for each row apply PNG unpredictor
324 1
            foreach ($sdata as $k => $row) {
325
                // initialize new row
326 1
                $ddata[$k] = [];
327
                // get PNG predictor value
328 1
                $predictor = (10 + $row[0]);
329
                // for each byte on the row
330 1
                for ($i = 1; $i <= $columns; ++$i) {
331
                    // new index
332 1
                    $j = ($i - 1);
333 1
                    $row_up = $prev_row[$j];
334 1
                    if (1 == $i) {
335 1
                        $row_left = 0;
336 1
                        $row_upleft = 0;
337
                    } else {
338 1
                        $row_left = $row[($i - 1)];
339 1
                        $row_upleft = $prev_row[($j - 1)];
340
                    }
341 1
                    switch ($predictor) {
342 1
                        case 10:  // PNG prediction (on encoding, PNG None on all rows)
343
                            $ddata[$k][$j] = $row[$i];
344
                            break;
345
346 1
                        case 11:  // PNG prediction (on encoding, PNG Sub on all rows)
347
                            $ddata[$k][$j] = (($row[$i] + $row_left) & 0xff);
348
                            break;
349
350 1
                        case 12:  // PNG prediction (on encoding, PNG Up on all rows)
351 1
                            $ddata[$k][$j] = (($row[$i] + $row_up) & 0xff);
352 1
                            break;
353
354
                        case 13:  // PNG prediction (on encoding, PNG Average on all rows)
355
                            $ddata[$k][$j] = (($row[$i] + (($row_left + $row_up) / 2)) & 0xff);
356
                            break;
357
358
                        case 14:  // PNG prediction (on encoding, PNG Paeth on all rows)
359
                            // initial estimate
360
                            $p = ($row_left + $row_up - $row_upleft);
361
                            // distances
362
                            $pa = abs($p - $row_left);
363
                            $pb = abs($p - $row_up);
364
                            $pc = abs($p - $row_upleft);
365
                            $pmin = min($pa, $pb, $pc);
366
                            // return minimum distance
367
                            switch ($pmin) {
368
                                case $pa:
369
                                    $ddata[$k][$j] = (($row[$i] + $row_left) & 0xff);
370
                                    break;
371
372
                                case $pb:
373
                                    $ddata[$k][$j] = (($row[$i] + $row_up) & 0xff);
374
                                    break;
375
376
                                case $pc:
377
                                    $ddata[$k][$j] = (($row[$i] + $row_upleft) & 0xff);
378
                                    break;
379
                            }
380
                            break;
381
382
                        default:  // PNG prediction (on encoding, PNG optimum)
383
                            throw new Exception('Unknown PNG predictor');
384
                    }
385
                }
386 1
                $prev_row = $ddata[$k];
387
            } // end for each row
388
            // complete decoding
389 1
            $sdata = [];
390
            // for every row
391 1
            foreach ($ddata as $k => $row) {
392
                // initialize new row
393 1
                $sdata[$k] = [0, 0, 0];
394 1
                if (0 == $wb[0]) {
395
                    // default type field
396
                    $sdata[$k][0] = 1;
397
                }
398 1
                $i = 0; // count bytes in the row
399
                // for every column
400 1
                for ($c = 0; $c < 3; ++$c) {
401
                    // for every byte on the column
402 1
                    for ($b = 0; $b < $wb[$c]; ++$b) {
403 1
                        if (isset($row[$i])) {
404 1
                            $sdata[$k][$c] += ($row[$i] << (($wb[$c] - 1 - $b) * 8));
405
                        }
406 1
                        ++$i;
407
                    }
408
                }
409
            }
410 1
            $ddata = [];
0 ignored issues
show
Unused Code introduced by
The assignment to $ddata is dead and can be removed.
Loading history...
411
            // fill xref
412 1
            if (isset($index_first)) {
413 1
                $obj_num = $index_first;
414
            } else {
415 1
                $obj_num = 0;
416
            }
417 1
            foreach ($sdata as $k => $row) {
418 1
                switch ($row[0]) {
419 1
                    case 0:  // (f) linked list of free objects
420 1
                            break;
421
422 1
                    case 1:  // (n) objects that are in use but are not compressed
423
                            // create unique object index: [object number]_[generation number]
424 1
                            $index = $obj_num.'_'.$row[2];
425
                            // check if object already exist
426 1
                            if (!isset($xref['xref'][$index])) {
427
                                // store object offset position
428 1
                                $xref['xref'][$index] = $row[1];
429
                            }
430 1
                            break;
431
432 1
                    case 2:  // compressed objects
433
                            // $row[1] = object number of the object stream in which this object is stored
434
                            // $row[2] = index of this object within the object stream
435 1
                            $index = $row[1].'_0_'.$row[2];
436 1
                            $xref['xref'][$index] = -1;
437 1
                            break;
438
439
                    default:  // null objects
440
                            break;
441
                }
442 1
                ++$obj_num;
443
            }
444
        } // end decoding data
445 1
        if (isset($prevxref)) {
446
            // get previous xref
447 1
            $xref = $this->getXrefData($pdfData, $prevxref, $xref);
448
        }
449
450 1
        return $xref;
451
    }
452
453
    /**
454
     * Get content of indirect object.
455
     *
456
     * @param string $pdfData  PDF data
457
     * @param array  $xref
458
     * @param string $objRef   Object number and generation number separated by underscore character
459
     * @param int    $offset   Object offset
460
     * @param bool   $decoding If true decode streams
461
     *
462
     * @return array containing object data
463
     *
464
     * @throws Exception if invalid object reference found
465
     */
466 10
    protected function getIndirectObject($pdfData, $xref, $objRef, $offset = 0, $decoding = true)
467
    {
468
        /*
469
         * build indirect object header
470
         */
471
        // $objHeader = "[object number] [generation number] obj"
472 10
        $objRefArr = explode('_', $objRef);
473 10
        if (2 !== \count($objRefArr)) {
474
            throw new Exception('Invalid object reference for $obj.');
475
        }
476 10
        $objHeader = $objRefArr[0].' '.$objRefArr[1].' obj';
477
478
        /*
479
         * check if we are in position
480
         */
481
        // ignore whitespace characters at offset (NUL, HT, LF, FF, CR, SP)
482 10
        $offset += strspn($pdfData, "\0\t\n\f\r ", $offset);
483
        // ignore leading zeros for object number
484 10
        $offset += strspn($pdfData, '0', $offset);
485 10
        if (substr($pdfData, $offset, \strlen($objHeader)) !== $objHeader) {
486
            // an indirect reference to an undefined object shall be considered a reference to the null object
487
            return ['null', 'null', $offset];
488
        }
489
490
        /*
491
         * get content
492
         */
493
        // starting position of object content
494 10
        $offset += \strlen($objHeader);
495 10
        $objContentArr = [];
496 10
        $i = 0; // object main index
497
        do {
498 10
            $oldOffset = $offset;
499
            // get element
500 10
            $element = $this->getRawObject($pdfData, $offset);
501 10
            $offset = $element[2];
502
            // decode stream using stream's dictionary information
503 10
            if ($decoding && ('stream' === $element[0]) && (isset($objContentArr[($i - 1)][0])) && ('<<' === $objContentArr[($i - 1)][0])) {
504 10
                $element[3] = $this->decodeStream($pdfData, $xref, $objContentArr[($i - 1)][1], $element[1]);
505
            }
506 10
            $objContentArr[$i] = $element;
507 10
            ++$i;
508 10
        } while (('endobj' !== $element[0]) && ($offset !== $oldOffset));
509
        // remove closing delimiter
510 10
        array_pop($objContentArr);
511
512
        /*
513
         * return raw object content
514
         */
515 10
        return $objContentArr;
516
    }
517
518
    /**
519
     * Get the content of object, resolving indirect object reference if necessary.
520
     *
521
     * @param string $pdfData PDF data
522
     * @param array  $obj     Object value
523
     *
524
     * @return array containing object data
525
     *
526
     * @throws Exception
527
     */
528 10
    protected function getObjectVal($pdfData, $xref, $obj)
529
    {
530 10
        if ('objref' == $obj[0]) {
531
            // reference to indirect object
532
            if (isset($this->objects[$obj[1]])) {
533
                // this object has been already parsed
534
                return $this->objects[$obj[1]];
535
            } elseif (isset($xref[$obj[1]])) {
536
                // parse new object
537
                $this->objects[$obj[1]] = $this->getIndirectObject($pdfData, $xref, $obj[1], $xref[$obj[1]], false);
538
539
                return $this->objects[$obj[1]];
540
            }
541
        }
542
543 10
        return $obj;
544
    }
545
546
    /**
547
     * Get object type, raw value and offset to next object
548
     *
549
     * @param int $offset Object offset
550
     *
551
     * @return array containing object type, raw value and offset to next object
552
     */
553 10
    protected function getRawObject($pdfData, $offset = 0)
554
    {
555 10
        $objtype = ''; // object type to be returned
556 10
        $objval = ''; // object value to be returned
557
558
        /*
559
         * skip initial white space chars:
560
         *      \x00 null (NUL)
561
         *      \x09 horizontal tab (HT)
562
         *      \x0A line feed (LF)
563
         *      \x0C form feed (FF)
564
         *      \x0D carriage return (CR)
565
         *      \x20 space (SP)
566
         */
567 10
        $offset += strspn($pdfData, "\x00\x09\x0a\x0c\x0d\x20", $offset);
568
569
        // get first char
570 10
        $char = $pdfData[$offset];
571
        // get object type
572 10
        switch ($char) {
573 10
            case '%':  // \x25 PERCENT SIGN
574
                    // skip comment and search for next token
575
                    $next = strcspn($pdfData, "\r\n", $offset);
576
                    if ($next > 0) {
577
                        $offset += $next;
578
579
                        return $this->getRawObject($pdfData, $offset);
580
                    }
581
                    break;
582
583 10
            case '/':  // \x2F SOLIDUS
584
                    // name object
585 10
                    $objtype = $char;
586 10
                    ++$offset;
587 10
                    $pregResult = preg_match(
588 10
                        '/^([^\x00\x09\x0a\x0c\x0d\x20\s\x28\x29\x3c\x3e\x5b\x5d\x7b\x7d\x2f\x25]+)/',
589 10
                        substr($pdfData, $offset, 256),
590
                        $matches
591
                    );
592 10
                    if (1 == $pregResult) {
593 10
                        $objval = $matches[1]; // unescaped value
594 10
                        $offset += \strlen($objval);
595
                    }
596 10
                    break;
597
598 10
            case '(':   // \x28 LEFT PARENTHESIS
599 10
            case ')':  // \x29 RIGHT PARENTHESIS
600
                    // literal string object
601 10
                    $objtype = $char;
602 10
                    ++$offset;
603 10
                    $strpos = $offset;
604 10
                    if ('(' == $char) {
605 10
                        $open_bracket = 1;
606 10
                        while ($open_bracket > 0) {
607 10
                            if (!isset($pdfData[$strpos])) {
608
                                break;
609
                            }
610 10
                            $ch = $pdfData[$strpos];
611 10
                            switch ($ch) {
612 10
                                case '\\':  // REVERSE SOLIDUS (5Ch) (Backslash)
613
                                        // skip next character
614 8
                                        ++$strpos;
615 8
                                        break;
616
617 10
                                case '(':  // LEFT PARENHESIS (28h)
618
                                        ++$open_bracket;
619
                                        break;
620
621 10
                                case ')':  // RIGHT PARENTHESIS (29h)
622 10
                                        --$open_bracket;
623 10
                                        break;
624
                            }
625 10
                            ++$strpos;
626
                        }
627 10
                        $objval = substr($pdfData, $offset, ($strpos - $offset - 1));
628 10
                        $offset = $strpos;
629
                    }
630 10
                    break;
631
632 10
            case '[':   // \x5B LEFT SQUARE BRACKET
633 10
            case ']':  // \x5D RIGHT SQUARE BRACKET
634
                    // array object
635 10
                    $objtype = $char;
636 10
                    ++$offset;
637 10
                    if ('[' == $char) {
638
                        // get array content
639 10
                        $objval = [];
640
                        do {
641
                            // get element
642 10
                            $element = $this->getRawObject($pdfData, $offset);
643 10
                            $offset = $element[2];
644 10
                            $objval[] = $element;
645 10
                        } while (']' != $element[0]);
646
                        // remove closing delimiter
647 10
                        array_pop($objval);
648
                    }
649 10
                    break;
650
651 10
            case '<':  // \x3C LESS-THAN SIGN
652 10
            case '>':  // \x3E GREATER-THAN SIGN
653 10
                    if (isset($pdfData[($offset + 1)]) and ($pdfData[($offset + 1)] == $char)) {
654
                        // dictionary object
655 10
                        $objtype = $char.$char;
656 10
                        $offset += 2;
657 10
                        if ('<' == $char) {
658
                            // get array content
659 10
                            $objval = [];
660
                            do {
661
                                // get element
662 10
                                $element = $this->getRawObject($pdfData, $offset);
663 10
                                $offset = $element[2];
664 10
                                $objval[] = $element;
665 10
                            } while ('>>' != $element[0]);
666
                            // remove closing delimiter
667 10
                            array_pop($objval);
668
                        }
669
                    } else {
670
                        // hexadecimal string object
671 1
                        $objtype = $char;
672 1
                        ++$offset;
673 1
                        $pregResult = preg_match(
674 1
                            '/^([0-9A-Fa-f\x09\x0a\x0c\x0d\x20]+)>/iU',
675 1
                            substr($pdfData, $offset),
676
                            $matches
677
                        );
678 1
                        if (('<' == $char) && 1 == $pregResult) {
679
                            // remove white space characters
680 1
                            $objval = strtr($matches[1], "\x09\x0a\x0c\x0d\x20", '');
681 1
                            $offset += \strlen($matches[0]);
682
                        } elseif (false !== ($endpos = strpos($pdfData, '>', $offset))) {
683
                            $offset = $endpos + 1;
684
                        }
685
                    }
686 10
                    break;
687
688
            default:
689 10
                    if ('endobj' == substr($pdfData, $offset, 6)) {
690
                        // indirect object
691 10
                        $objtype = 'endobj';
692 10
                        $offset += 6;
693 10
                    } elseif ('null' == substr($pdfData, $offset, 4)) {
694
                        // null object
695
                        $objtype = 'null';
696
                        $offset += 4;
697
                        $objval = 'null';
698 10
                    } elseif ('true' == substr($pdfData, $offset, 4)) {
699
                        // boolean true object
700 1
                        $objtype = 'boolean';
701 1
                        $offset += 4;
702 1
                        $objval = 'true';
703 10
                    } elseif ('false' == substr($pdfData, $offset, 5)) {
704
                        // boolean false object
705
                        $objtype = 'boolean';
706
                        $offset += 5;
707
                        $objval = 'false';
708 10
                    } elseif ('stream' == substr($pdfData, $offset, 6)) {
709
                        // start stream object
710 10
                        $objtype = 'stream';
711 10
                        $offset += 6;
712 10
                        if (1 == preg_match('/^([\r]?[\n])/isU', substr($pdfData, $offset), $matches)) {
713 10
                            $offset += \strlen($matches[0]);
714 10
                            $pregResult = preg_match(
715 10
                                '/(endstream)[\x09\x0a\x0c\x0d\x20]/isU',
716 10
                                substr($pdfData, $offset),
717
                                $matches,
718 10
                                PREG_OFFSET_CAPTURE
719
                            );
720 10
                            if (1 == $pregResult) {
721 10
                                $objval = substr($pdfData, $offset, $matches[0][1]);
722 10
                                $offset += $matches[1][1];
723
                            }
724
                        }
725 10
                    } elseif ('endstream' == substr($pdfData, $offset, 9)) {
726
                        // end stream object
727 10
                        $objtype = 'endstream';
728 10
                        $offset += 9;
729 10
                    } elseif (1 == preg_match('/^([0-9]+)[\s]+([0-9]+)[\s]+R/iU', substr($pdfData, $offset, 33), $matches)) {
730
                        // indirect object reference
731 10
                        $objtype = 'objref';
732 10
                        $offset += \strlen($matches[0]);
733 10
                        $objval = (int) ($matches[1]).'_'.(int) ($matches[2]);
734 10
                    } elseif (1 == preg_match('/^([0-9]+)[\s]+([0-9]+)[\s]+obj/iU', substr($pdfData, $offset, 33), $matches)) {
735
                        // object start
736 1
                        $objtype = 'obj';
737 1
                        $objval = (int) ($matches[1]).'_'.(int) ($matches[2]);
738 1
                        $offset += \strlen($matches[0]);
739 10
                    } elseif (($numlen = strspn($pdfData, '+-.0123456789', $offset)) > 0) {
740
                        // numeric object
741 10
                        $objtype = 'numeric';
742 10
                        $objval = substr($pdfData, $offset, $numlen);
743 10
                        $offset += $numlen;
744
                    }
745 10
                    break;
746
        }
747
748 10
        return [$objtype, $objval, $offset];
749
    }
750
751
    /**
752
     * Get Cross-Reference (xref) table and trailer data from PDF document data.
753
     *
754
     * @param string $pdfData
755
     * @param int    $offset  xref offset (if know)
756
     * @param array  $xref    previous xref array (if any)
757
     *
758
     * @return array containing xref and trailer data
759
     *
760
     * @throws Exception if it was unable to find startxref
761
     * @throws Exception if it was unable to find xref
762
     */
763 11
    protected function getXrefData($pdfData, $offset = 0, $xref = [])
764
    {
765 11
        $startxrefPreg = preg_match(
766 11
            '/[\r\n]startxref[\s]*[\r\n]+([0-9]+)[\s]*[\r\n]+%%EOF/i',
767
            $pdfData,
768
            $matches,
769 11
            PREG_OFFSET_CAPTURE,
770
            $offset
771
        );
772
773 11
        if (0 == $offset) {
774
            // find last startxref
775 11
            $pregResult = preg_match_all(
776 11
                '/[\r\n]startxref[\s]*[\r\n]+([0-9]+)[\s]*[\r\n]+%%EOF/i',
777
                $pdfData, $matches,
778 11
                PREG_SET_ORDER,
779
                $offset
780
            );
781 11
            if (0 == $pregResult) {
782
                throw new Exception('Unable to find startxref');
783
            }
784 11
            $matches = array_pop($matches);
785 11
            $startxref = $matches[1];
786 1
        } elseif (strpos($pdfData, 'xref', $offset) == $offset) {
787
            // Already pointing at the xref table
788
            $startxref = $offset;
789 1
        } elseif (preg_match('/([0-9]+[\s][0-9]+[\s]obj)/i', $pdfData, $matches, PREG_OFFSET_CAPTURE, $offset)) {
790
            // Cross-Reference Stream object
791 1
            $startxref = $offset;
792
        } elseif ($startxrefPreg) {
793
            // startxref found
794
            $startxref = $matches[1][0];
795
        } else {
796
            throw new Exception('Unable to find startxref');
797
        }
798
799 11
        if ($startxref > \strlen($pdfData)) {
800 1
            throw new Exception('Unable to find xref (PDF corrupted?)');
801
        }
802
803
        // check xref position
804 10
        if (strpos($pdfData, 'xref', $startxref) == $startxref) {
805
            // Cross-Reference
806 9
            $xref = $this->decodeXref($pdfData, $startxref, $xref);
807
        } else {
808
            // Cross-Reference Stream
809 1
            $xref = $this->decodeXrefStream($pdfData, $startxref, $xref);
810
        }
811 10
        if (empty($xref)) {
812
            throw new Exception('Unable to find xref');
813
        }
814
815 10
        return $xref;
816
    }
817
818
    /**
819
     * Parses PDF data and returns extracted data as array.
820
     *
821
     * @param string $data PDF data to parse
822
     *
823
     * @return array array of parsed PDF document objects
824
     *
825
     * @throws Exception if empty PDF data given
826
     * @throws Exception if PDF data missing %PDF header
827
     */
828 11
    public function parseData($data)
829
    {
830 11
        if (empty($data)) {
831
            throw new Exception('Empty PDF data given.');
832
        }
833
        // find the pdf header starting position
834 11
        if (false === ($trimpos = strpos($data, '%PDF-'))) {
835
            throw new Exception('Invalid PDF data: missing %PDF header.');
836
        }
837
838
        // get PDF content string
839 11
        $pdfData = substr($data, $trimpos);
840
841
        // get xref and trailer data
842 11
        $xref = $this->getXrefData($pdfData);
843
844
        // parse all document objects
845 10
        $objects = [];
846 10
        foreach ($xref['xref'] as $obj => $offset) {
847 10
            if (!isset($objects[$obj]) and ($offset > 0)) {
848
                // decode objects with positive offset
849 10
                $objects[$obj] = $this->getIndirectObject($pdfData, $xref, $obj, $offset, true);
850
            }
851
        }
852
853 10
        return [$xref, $objects];
854
    }
855
}
856