<?php

/**

 * Zend Framework

 *

 * LICENSE

 *

 * This source file is subject to the new BSD license that is bundled

 * with this package in the file LICENSE.txt.

 * It is also available through the world-wide-web at this URL:

 * http://framework.zend.com/license/new-bsd

 * If you did not receive a copy of the license and are unable to

 * obtain it through the world-wide-web, please send an email

 * to license@zend.com so we can send you a copy immediately.

 *

 * @category   Zend

 * @package    Zend_Pdf

 * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 * @version    $Id: Pdf.php 24593 2012-01-05 20:35:02Z matthew $

 */

/** User land classes and interfaces turned on by Zend/Pdf.php file inclusion. */

/** @todo Section should be removed with ZF 2.0 release as obsolete            */

/** Zend_Pdf_Page */

require_once 'Zend/Pdf/Page.php';

/** Zend_Pdf_Style */

require_once 'Zend/Pdf/Style.php';

/** Zend_Pdf_Color_GrayScale */

require_once 'Zend/Pdf/Color/GrayScale.php';

/** Zend_Pdf_Color_Rgb */

require_once 'Zend/Pdf/Color/Rgb.php';

/** Zend_Pdf_Color_Cmyk */

require_once 'Zend/Pdf/Color/Cmyk.php';

/** Zend_Pdf_Color_Html */

require_once 'Zend/Pdf/Color/Html.php';

/** Zend_Pdf_Image */

require_once 'Zend/Pdf/Image.php';

/** Zend_Pdf_Font */

require_once 'Zend/Pdf/Font.php';

/** Zend_Pdf_Resource_Extractor */

require_once 'Zend/Pdf/Resource/Extractor.php';

/** Zend_Pdf_Canvas */

require_once 'Zend/Pdf/Canvas.php';

/** Internally used classes */

require_once 'Zend/Pdf/Element.php';

require_once 'Zend/Pdf/Element/Array.php';

require_once 'Zend/Pdf/Element/String/Binary.php';

require_once 'Zend/Pdf/Element/Boolean.php';

require_once 'Zend/Pdf/Element/Dictionary.php';

require_once 'Zend/Pdf/Element/Name.php';

require_once 'Zend/Pdf/Element/Null.php';

require_once 'Zend/Pdf/Element/Numeric.php';

require_once 'Zend/Pdf/Element/String.php';

/**

 * General entity which describes PDF document.

 * It implements document abstraction with a document level operations.

 *

 * Class is used to create new PDF document or load existing document.

 * See details in a class constructor description

 *

 * Class agregates document level properties and entities (pages, bookmarks,

 * document level actions, attachments, form object, etc)

 *

 * @category   Zend

 * @package    Zend_Pdf

 * @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 */

class Zend_Pdf

{

  /**** Class Constants ****/

    /**

     * Version number of generated PDF documents.

     */

    const PDF_VERSION = '1.4';

    /**

     * PDF file header.

     */

    const PDF_HEADER  = "%PDF-1.4\n%\xE2\xE3\xCF\xD3\n";

    /**

     * Pages collection

     *

     * @todo implement it as a class, which supports ArrayAccess and Iterator interfaces,

     *       to provide incremental parsing and pages tree updating.

     *       That will give good performance and memory (PDF size) benefits.

     *

     * @var array   - array of Zend_Pdf_Page object

     */

    public $pages = array();

    /**

     * Document properties

     *

     * It's an associative array with PDF meta information, values may

     * be string, boolean or float.

     * Returned array could be used directly to access, add, modify or remove

     * document properties.

     *

     * Standard document properties: Title (must be set for PDF/X documents), Author,

     * Subject, Keywords (comma separated list), Creator (the name of the application,

     * that created document, if it was converted from other format), Trapped (must be

     * true, false or null, can not be null for PDF/X documents)

     *

     * @var array

     */

    public $properties = array();

    /**

     * Original properties set.

     *

     * Used for tracking properties changes

     *

     * @var array

     */

    protected $_originalProperties = array();

    /**

     * Document level javascript

     *

     * @var string

     */

    protected $_javaScript = null;

    /**

     * Document named destinations or "GoTo..." actions, used to refer

     * document parts from outside PDF

     *

     * @var array   - array of Zend_Pdf_Target objects

     */

    protected $_namedTargets = array();

    /**

     * Document outlines

     *

     * @var array - array of Zend_Pdf_Outline objects

     */

    public $outlines = array();

    /**

     * Original document outlines list

     * Used to track outlines update

     *

     * @var array - array of Zend_Pdf_Outline objects

     */

    protected $_originalOutlines = array();

    /**

     * Original document outlines open elements count

     * Used to track outlines update

     *

     * @var integer

     */

    protected $_originalOpenOutlinesCount = 0;

    /**

     * Pdf trailer (last or just created)

     *

     * @var Zend_Pdf_Trailer

     */

    protected $_trailer = null;

    /**

     * PDF objects factory.

     *

     * @var Zend_Pdf_ElementFactory_Interface

     */

    protected $_objFactory = null;

    /**

     * Memory manager for stream objects

     *

     * @var Zend_Memory_Manager|null

     */

    protected static $_memoryManager = null;

    /**

     * Pdf file parser.

     * It's not used, but has to be destroyed only with Zend_Pdf object

     *

     * @var Zend_Pdf_Parser

     */

    protected $_parser;

    /**

     * List of inheritable attributesfor pages tree

     *

     * @var array

     */

    protected static $_inheritableAttributes = array('Resources', 'MediaBox', 'CropBox', 'Rotate');

    /**

     * True if the object is a newly created PDF document (affects save() method behavior)

     * False otherwise

     *

     * @var boolean

     */

    protected $_isNewDocument = true;

    /**

     * Request used memory manager

     *

     * @return Zend_Memory_Manager

     */

    static public function getMemoryManager()

    {

        if (self::$_memoryManager === null) {

            require_once 'Zend/Memory.php';

            self::$_memoryManager = Zend_Memory::factory('none');

        }

        return self::$_memoryManager;

    }

    /**

     * Set user defined memory manager

     *

     * @param Zend_Memory_Manager $memoryManager

     */

    static public function setMemoryManager(Zend_Memory_Manager $memoryManager)

    {

        self::$_memoryManager = $memoryManager;

    }

    /**

     * Create new PDF document from a $source string

     *

     * @param string $source

     * @param integer $revision

     * @return Zend_Pdf

     */

    public static function parse(&$source = null, $revision = null)

    {

        return new Zend_Pdf($source, $revision);

    }

    /**

     * Load PDF document from a file

     *

     * @param string $source

     * @param integer $revision

     * @return Zend_Pdf

     */

    public static function load($source = null, $revision = null)

    {

        return new Zend_Pdf($source, $revision, true);

    }

    /**

     * Render PDF document and save it.

     *

     * If $updateOnly is true and it's not a new document, then it only

     * appends new section to the end of file.

     *

     * @param string $filename

     * @param boolean $updateOnly

     * @throws Zend_Pdf_Exception

     */

    public function save($filename, $updateOnly = false)

    {

        if (($file = @fopen($filename, $updateOnly ? 'ab':'wb')) === false ) {

            require_once 'Zend/Pdf/Exception.php';

            throw new Zend_Pdf_Exception( "Can not open '$filename' file for writing." );

        }

        $this->render($updateOnly, $file);

        fclose($file);

    }

    /**

     * Creates or loads PDF document.

     *

     * If $source is null, then it creates a new document.

     *

     * If $source is a string and $load is false, then it loads document

     * from a binary string.

     *

     * If $source is a string and $load is true, then it loads document

     * from a file.

     * $revision used to roll back document to specified version

     * (0 - current version, 1 - previous version, 2 - ...)

     *

     * @param string  $source - PDF file to load

     * @param integer $revision

     * @throws Zend_Pdf_Exception

     * @return Zend_Pdf

     */

    public function __construct($source = null, $revision = null, $load = false)

    {

        require_once 'Zend/Pdf/ElementFactory.php';

        $this->_objFactory = Zend_Pdf_ElementFactory::createFactory(1);

        if ($source !== null) {

            require_once 'Zend/Pdf/Parser.php';

            $this->_parser           = new Zend_Pdf_Parser($source, $this->_objFactory, $load);

            $this->_pdfHeaderVersion = $this->_parser->getPDFVersion();

            $this->_trailer          = $this->_parser->getTrailer();

            if ($this->_trailer->Encrypt !== null) {

                require_once 'Zend/Pdf/Exception.php';

                throw new Zend_Pdf_Exception('Encrypted document modification is not supported');

            }

            if ($revision !== null) {

                $this->rollback($revision);

            } else {

                $this->_loadPages($this->_trailer->Root->Pages);

            }

            $this->_loadNamedDestinations($this->_trailer->Root, $this->_parser->getPDFVersion());

            $this->_loadOutlines($this->_trailer->Root);

            if ($this->_trailer->Info !== null) {

                $this->properties = $this->_trailer->Info->toPhp();

                if (isset($this->properties['Trapped'])) {

                    switch ($this->properties['Trapped']) {

                        case 'True':

                            $this->properties['Trapped'] = true;

                            break;

                        case 'False':

                            $this->properties['Trapped'] = false;

                            break;

                        case 'Unknown':

                            $this->properties['Trapped'] = null;

                            break;

                        default:

                            // Wrong property value

                            // Do nothing

                            break;

                    }

                }

                $this->_originalProperties = $this->properties;

            }

            $this->_isNewDocument = false;

        } else {

            $this->_pdfHeaderVersion = Zend_Pdf::PDF_VERSION;

            $trailerDictionary = new Zend_Pdf_Element_Dictionary();

            /**

             * Document id

             */

            $docId = md5(uniqid(rand(), true));   // 32 byte (128 bit) identifier

            $docIdLow  = substr($docId,  0, 16);  // first 16 bytes

            $docIdHigh = substr($docId, 16, 16);  // second 16 bytes

            $trailerDictionary->ID = new Zend_Pdf_Element_Array();

            $trailerDictionary->ID->items[] = new Zend_Pdf_Element_String_Binary($docIdLow);

            $trailerDictionary->ID->items[] = new Zend_Pdf_Element_String_Binary($docIdHigh);

            $trailerDictionary->Size = new Zend_Pdf_Element_Numeric(0);

            require_once 'Zend/Pdf/Trailer/Generator.php';

            $this->_trailer = new Zend_Pdf_Trailer_Generator($trailerDictionary);

            /**

             * Document catalog indirect object.

             */

            $docCatalog = $this->_objFactory->newObject(new Zend_Pdf_Element_Dictionary());

            $docCatalog->Type    = new Zend_Pdf_Element_Name('Catalog');

            $docCatalog->Version = new Zend_Pdf_Element_Name(Zend_Pdf::PDF_VERSION);

            $this->_trailer->Root = $docCatalog;

            /**

             * Pages container

             */

            $docPages = $this->_objFactory->newObject(new Zend_Pdf_Element_Dictionary());

            $docPages->Type  = new Zend_Pdf_Element_Name('Pages');

            $docPages->Kids  = new Zend_Pdf_Element_Array();

            $docPages->Count = new Zend_Pdf_Element_Numeric(0);

            $docCatalog->Pages = $docPages;

        }

    }

    /**

     * Retrive number of revisions.

     *

     * @return integer

     */

    public function revisions()

    {

        $revisions = 1;

        $currentTrailer = $this->_trailer;

        while ($currentTrailer->getPrev() !== null && $currentTrailer->getPrev()->Root !== null ) {

            $revisions++;

            $currentTrailer = $currentTrailer->getPrev();

        }

        return $revisions++;

    }

    /**

     * Rollback document $steps number of revisions.

     * This method must be invoked before any changes, applied to the document.

     * Otherwise behavior is undefined.

     *

     * @param integer $steps

     */

    public function rollback($steps)

    {

        for ($count = 0; $count < $steps; $count++) {

            if ($this->_trailer->getPrev() !== null && $this->_trailer->getPrev()->Root !== null) {

                $this->_trailer = $this->_trailer->getPrev();

            } else {

                break;

            }

        }

        $this->_objFactory->setObjectCount($this->_trailer->Size->value);

        // Mark content as modified to force new trailer generation at render time

        $this->_trailer->Root->touch();

        $this->pages = array();

        $this->_loadPages($this->_trailer->Root->Pages);

    }

    /**

     * Load pages recursively

     *

     * @param Zend_Pdf_Element_Reference $pages

     * @param array|null $attributes

     */

    protected function _loadPages(Zend_Pdf_Element_Reference $pages, $attributes = array())