<?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-2010 Zend Technologies USA Inc. (http://www.zend.com)

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

 * @version    $Id: Page.php 22909 2010-08-27 19:57:48Z alexander $

 */

/** 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';

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

require_once 'Zend/Pdf/Canvas/Abstract.php';

/**

 * PDF Page

 *

 * @package    Zend_Pdf

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

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

 */

class Zend_Pdf_Page extends Zend_Pdf_Canvas_Abstract

{

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

  /* Page Sizes */

    /**

     * Size representing an A4 page in portrait (tall) orientation.

     */

    const SIZE_A4                = '595:842:';

    /**

     * Size representing an A4 page in landscape (wide) orientation.

     */

    const SIZE_A4_LANDSCAPE      = '842:595:';

    /**

     * Size representing a US Letter page in portrait (tall) orientation.

     */

    const SIZE_LETTER            = '612:792:';

    /**

     * Size representing a US Letter page in landscape (wide) orientation.

     */

    const SIZE_LETTER_LANDSCAPE  = '792:612:';

  /* Shape Drawing */

    /**

     * Stroke the path only. Do not fill.

     */

    const SHAPE_DRAW_STROKE      = 0;

    /**

     * Fill the path only. Do not stroke.

     */

    const SHAPE_DRAW_FILL        = 1;

    /**

     * Fill and stroke the path.

     */

    const SHAPE_DRAW_FILL_AND_STROKE = 2;

  /* Shape Filling Methods */

    /**

     * Fill the path using the non-zero winding rule.

     */

    const FILL_METHOD_NON_ZERO_WINDING = 0;

    /**

     * Fill the path using the even-odd rule.

     */

    const FILL_METHOD_EVEN_ODD        = 1;

  /* Line Dash Types */

    /**

     * Solid line dash.

     */

    const LINE_DASHING_SOLID = 0;

    /**

     * Page dictionary (refers to an inderect Zend_Pdf_Element_Dictionary object).

     *

     * @var Zend_Pdf_Element_Reference|Zend_Pdf_Element_Object

     */

    protected $_dictionary;

    /**

     * PDF objects factory.

     *

     * @var Zend_Pdf_ElementFactory_Interface

     */

    protected $_objFactory = null;

    /**

     * Flag which signals, that page is created separately from any PDF document or

     * attached to anyone.

     *

     * @var boolean

     */

    protected $_attached;

    /**

     * Safe Graphics State semafore

     *

     * If it's false, than we can't be sure Graphics State is restored withing

     * context of previous contents stream (ex. drawing coordinate system may be rotated).

     * We should encompass existing content with save/restore GS operators

     *

     * @var boolean

     */

    protected $_safeGS;

    /**

     * Object constructor.

     * Constructor signatures:

     *

     * 1. Load PDF page from a parsed PDF file.

     *    Object factory is created by PDF parser.

     * ---------------------------------------------------------

     * new Zend_Pdf_Page(Zend_Pdf_Element_Dictionary       $pageDict,

     *                   Zend_Pdf_ElementFactory_Interface $factory);

     * ---------------------------------------------------------

     *

     * 2. Make a copy of the PDF page.

     *    New page is created in the same context as source page. Object factory is shared.

     *    Thus it will be attached to the document, but need to be placed into Zend_Pdf::$pages array

     *    to be included into output.

     * ---------------------------------------------------------

     * new Zend_Pdf_Page(Zend_Pdf_Page $page);

     * ---------------------------------------------------------

     *

     * 3. Create new page with a specified pagesize.

     *    If $factory is null then it will be created and page must be attached to the document to be

     *    included into output.

     * ---------------------------------------------------------

     * new Zend_Pdf_Page(string $pagesize, Zend_Pdf_ElementFactory_Interface $factory = null);

     * ---------------------------------------------------------

     *

     * 4. Create new page with a specified pagesize (in default user space units).

     *    If $factory is null then it will be created and page must be attached to the document to be

     *    included into output.

     * ---------------------------------------------------------

     * new Zend_Pdf_Page(numeric $width, numeric $height, Zend_Pdf_ElementFactory_Interface $factory = null);

     * ---------------------------------------------------------

     *

     *

     * @param mixed $param1

     * @param mixed $param2

     * @param mixed $param3

     * @throws Zend_Pdf_Exception

     */

    public function __construct($param1, $param2 = null, $param3 = null)

    {

        if (($param1 instanceof Zend_Pdf_Element_Reference ||

             $param1 instanceof Zend_Pdf_Element_Object

            ) &&

            $param2 instanceof Zend_Pdf_ElementFactory_Interface &&

            $param3 === null

           ) {

            switch ($param1->getType()) {

                case Zend_Pdf_Element::TYPE_DICTIONARY:

                    $this->_dictionary = $param1;

                    $this->_objFactory = $param2;

                    $this->_attached   = true;

                    $this->_safeGS     = false;

                    return;

                    break;

                case Zend_Pdf_Element::TYPE_NULL:

                    $this->_objFactory = $param2;

                    $pageWidth = $pageHeight = 0;

                    break;

                default:

                    require_once 'Zend/Pdf/Exception.php';

                    throw new Zend_Pdf_Exception('Unrecognized object type.');

                    break;

            }

        } else if ($param1 instanceof Zend_Pdf_Page && $param2 === null && $param3 === null) {

            // Duplicate existing page.

            // Let already existing content and resources to be shared between pages

            // We don't give existing content modification functionality, so we don't need "deep copy"

            $this->_objFactory = $param1->_objFactory;

            $this->_attached   = &$param1->_attached;

            $this->_safeGS     = false;

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

            foreach ($param1->_dictionary->getKeys() as $key) {

                if ($key == 'Contents') {

                    // Clone Contents property

                    $this->_dictionary->Contents = new Zend_Pdf_Element_Array();

                    if ($param1->_dictionary->Contents->getType() != Zend_Pdf_Element::TYPE_ARRAY) {

                        // Prepare array of content streams and add existing stream

                        $this->_dictionary->Contents->items[] = $param1->_dictionary->Contents;

                    } else {

                        // Clone array of the content streams

                        foreach ($param1->_dictionary->Contents->items as $srcContentStream) {

                            $this->_dictionary->Contents->items[] = $srcContentStream;

                        }

                    }

                } else {

                    $this->_dictionary->$key = $param1->_dictionary->$key;

                }

            }

            return;

        } else if (is_string($param1) &&

                   ($param2 === null || $param2 instanceof Zend_Pdf_ElementFactory_Interface) &&

                   $param3 === null) {

            if ($param2 !== null) {

                $this->_objFactory = $param2;

            } else {

                require_once 'Zend/Pdf/ElementFactory.php';

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

            }

            $this->_attached   = false;

            $this->_safeGS     = true; /** New page created. That's users App responsibility to track GS changes */

            switch (strtolower($param1)) {

                case 'a4':

                    $param1 = Zend_Pdf_Page::SIZE_A4;

                    break;

                case 'a4-landscape':

                    $param1 = Zend_Pdf_Page::SIZE_A4_LANDSCAPE;

                    break;

                case 'letter':

                    $param1 = Zend_Pdf_Page::SIZE_LETTER;

                    break;

                case 'letter-landscape':

                    $param1 = Zend_Pdf_Page::SIZE_LETTER_LANDSCAPE;

                    break;

                default:

                    // should be in "x:y" or "x:y:" form

            }

            $pageDim = explode(':', $param1);

            if(count($pageDim) == 2  ||  count($pageDim) == 3) {

                $pageWidth  = $pageDim[0];

                $pageHeight = $pageDim[1];

            } else {

                /**

                 * @todo support of user defined pagesize notations, like:

                 *       "210x297mm", "595x842", "8.5x11in", "612x792"

                 */

                require_once 'Zend/Pdf/Exception.php';

                throw new Zend_Pdf_Exception('Wrong pagesize notation.');

            }

            /**

             * @todo support of pagesize recalculation to "default user space units"

             */

        } else if (is_numeric($param1) && is_numeric($param2) &&

                   ($param3 === null || $param3 instanceof Zend_Pdf_ElementFactory_Interface)) {

            if ($param3 !== null) {

                $this->_objFactory = $param3;

            } else {

                require_once 'Zend/Pdf/ElementFactory.php';

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

            }

            $this->_attached = false;

            $this->_safeGS   = true; /** New page created. That's users App responsibility to track GS changes */

            $pageWidth  = $param1;

            $pageHeight = $param2;

        } else {

            require_once 'Zend/Pdf/Exception.php';

            throw new Zend_Pdf_Exception('Unrecognized method signature, wrong number of arguments or wrong argument types.');

        }

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

        $this->_dictionary->Type         = new Zend_Pdf_Element_Name('Page');

        require_once 'Zend/Pdf.php';

        $this->_dictionary->LastModified = new Zend_Pdf_Element_String(Zend_Pdf::pdfDate());

        $this->_dictionary->Resources    = new Zend_Pdf_Element_Dictionary();

        $this->_dictionary->MediaBox     = new Zend_Pdf_Element_Array();

        $this->_dictionary->MediaBox->items[] = new Zend_Pdf_Element_Numeric(0);

        $this->_dictionary->MediaBox->items[] = new Zend_Pdf_Element_Numeric(0);

        $this->_dictionary->MediaBox->items[] = new Zend_Pdf_Element_Numeric($pageWidth);

        $this->_dictionary->MediaBox->items[] = new Zend_Pdf_Element_Numeric($pageHeight);

        $this->_dictionary->Contents     = new Zend_Pdf_Element_Array();

    }

    /**

     * Attach resource to the canvas

     *

     * Method returns a name of the resource which can be used

     * as a resource reference within drawing instructions stream

     * Allowed types: 'ExtGState', 'ColorSpace', 'Pattern', 'Shading',

     * 'XObject', 'Font', 'Properties'

     *

     * @param string $type

     * @param Zend_Pdf_Resource $resource

     * @return string

     */

    protected function _attachResource($type, Zend_Pdf_Resource $resource)

    {

        // Check that Resources dictionary contains appropriate resource set

        if ($this->_dictionary->Resources->$type === null) {

            $this->_dictionary->Resources->touch();

            $this->_dictionary->Resources->$type = new Zend_Pdf_Element_Dictionary();

        } else {

            $this->_dictionary->Resources->$type->touch();

        }

        // Check, that resource is already attached to resource set.

        $resObject = $resource->getResource();

        foreach ($this->_dictionary->Resources->$type->getKeys() as $ResID) {

            if ($this->_dictionary->Resources->$type->$ResID === $resObject) {

                return $ResID;

            }

        }

        $idCounter = 1;

        do {

            $newResName = $type[0] . $idCounter++;

        } while ($this->_dictionary->Resources->$type->$newResName !== null);

        $this->_dictionary->Resources->$type->$newResName = $resObject;

        $this->_objFactory->attach($resource->getFactory());

        return $newResName;

    }

    /**

     * Add procedureSet to the Page description

     *

     * @param string $procSetName

     */

    protected function _addProcSet($procSetName)

    {

        // Check that Resources dictionary contains ProcSet entry

        if ($this->_dictionary->Resources->ProcSet === null) {

            $this->_dictionary->Resources->touch();

            $this->_dictionary->Resources->ProcSet = new Zend_Pdf_Element_Array();

        } else {

            $this->_dictionary->Resources->ProcSet->touch();

        }

        foreach ($this->_dictionary->Resources->ProcSet->items as $procSetEntry) {

            if ($procSetEntry->value == $procSetName) {

                // Procset is already included into a ProcSet array

                return;

            }

        }

        $this->_dictionary->Resources->ProcSet->items[] = new Zend_Pdf_Element_Name($procSetName);

    }

    /**

     * Returns dictionaries of used resources.

     *

     * Used for canvas implementations interoperability

     *

     * Structure of the returned array:

     * array(

     *   <resTypeName> => array(

     *                      <resName> => <Zend_Pdf_Resource object>,

     *                      <resName> => <Zend_Pdf_Resource object>,

     *                      <resName> => <Zend_Pdf_Resource object>,

     *                      ...

     *                    ),

     *   <resTypeName> => array(

     *                      <resName> => <Zend_Pdf_Resource object>,

     *                      <resName> => <Zend_Pdf_Resource object>,

     *                      <resName> => <Zend_Pdf_Resource object>,

     *                      ...

     *                    ),

     *   ...

     *   'ProcSet' => array()

     * )

     *

     * where ProcSet array is a list of used procedure sets names (strings).

     * Allowed procedure set names: 'PDF', 'Text', 'ImageB', 'ImageC', 'ImageI'

     *

     * @internal

     * @return array

     */

    public function getResources()

    {

        $resources = array();

        $resDictionary = $this->_dictionary->Resources;

        foreach ($resDictionary->getKeys() as $resType) {

            $resources[$resType] = array();

            if ($resType == 'ProcSet') {

                foreach ($resDictionary->ProcSet->items as $procSetEntry) {

                    $resources[$resType][] = $procSetEntry->value;

                }

            } else {

                $resMap = $resDictionary->$resType;

                foreach ($resMap->getKeys() as $resId) {

                    $resources[$resType][$resId] =new Zend_Pdf_Resource_Unified($resMap->$resId);

                }

            }

        }

        return $resources;

    }

    /**

     * Get drawing instructions stream