ODF with conditionals substitution

odf.php

<?php
require 'Segment.php';
class OdfException extends Exception
{}
/**
 * Templating class for odt file
 * You need PHP 5.2 at least
 * You need Zip Extension or PclZip library
 * Encoding : ISO-8859-1
 *
 * @copyright  GPL License 2008 - Julien Pauli - Cyril PIERRE de GEYER - Anaska (http://www.anaska.com)
 * @copyright  GPL License 2010 - Laurent Destailleur - [email protected]
 * @license    http://www.gnu.org/copyleft/gpl.html  GPL License
 * @version 1.4.3 (last update 2012-07-29)
 */
class Odf
{
	protected $config = array(
    	'ZIP_PROXY' => 'PclZipProxy',	// PclZipProxy, PhpZipProxy
    	'DELIMITER_LEFT' => '{',
    	'DELIMITER_RIGHT' => '}',
		'PATH_TO_TMP' => '/tmp'
		);
		protected $file;
		protected $contentXml;			// To store content of content.xml file
		protected $stylesXml;			// To store content of styles.xml file
		protected $manifestXml;			// To store content of META-INF/manifest.xml file
		protected $tmpfile;
		protected $tmpdir='';
		protected $images = array();
		protected $vars = array();
		protected $segments = array();
		const PIXEL_TO_CM = 0.026458333;
		/**
		 * Class constructor
		 *
		 * @param string $filename the name of the odt file
		 * @throws OdfException
		 */
		public function __construct($filename, $config = array())
		{
			clearstatcache();

			if (! is_array($config)) {
				throw new OdfException('Configuration data must be provided as array');
			}
			foreach ($config as $configKey => $configValue) {
				if (array_key_exists($configKey, $this->config)) {
					$this->config[$configKey] = $configValue;
				}
			}

			$md5uniqid = md5(uniqid());
			if ($this->config['PATH_TO_TMP']) $this->tmpdir = preg_replace('|[\/]$|','',$this->config['PATH_TO_TMP']);	// Remove last \ or /
			$this->tmpdir .= ($this->tmpdir?'/':'').$md5uniqid;
			$this->tmpfile = $this->tmpdir.'/'.$md5uniqid.'.odt';	// We keep .odt extension to allow OpenOffice usage during debug.

			// A working directory is required for some zip proxy like PclZipProxy
			if (in_array($this->config['ZIP_PROXY'],array('PclZipProxy')) && ! is_dir($this->config['PATH_TO_TMP'])) {
				throw new OdfException('Temporary directory '.$this->config['PATH_TO_TMP'].' must exists');
			}

			// Create tmp direcoty (will be deleted in destructor)
			if (!file_exists($this->tmpdir)) {
				$result=mkdir($this->tmpdir);
			}

			// Load zip proxy
			$zipHandler = $this->config['ZIP_PROXY'];
			if (!defined('PCLZIP_TEMPORARY_DIR')) define('PCLZIP_TEMPORARY_DIR',$this->tmpdir);
			include_once('zip/'.$zipHandler.'.php');
			if (! class_exists($this->config['ZIP_PROXY'])) {
				throw new OdfException($this->config['ZIP_PROXY'] . ' class not found - check your php settings');
			}
			$this->file = new $zipHandler($this->tmpdir);


			if ($this->file->open($filename) !== true) {	// This also create the tmpdir directory
				throw new OdfException("Error while Opening the file '$filename' - Check your odt filename");
			}
			if (($this->contentXml = $this->file->getFromName('content.xml')) === false) {
				throw new OdfException("Nothing to parse - Check that the content.xml file is correctly formed in source file '$filename'");
			}
			if (($this->manifestXml = $this->file->getFromName('META-INF/manifest.xml')) === false) {
 				throw new OdfException("Something is wrong with META-INF/manifest.xm in source file '$filename'");
			}
			if (($this->stylesXml = $this->file->getFromName('styles.xml')) === false) {
				throw new OdfException("Nothing to parse - Check that the styles.xml file is correctly formed in source file '$filename'");
			}
			$this->file->close();


			//print "tmpdir=".$tmpdir;
			//print "filename=".$filename;
			//print "tmpfile=".$tmpfile;

			copy($filename, $this->tmpfile);

			$this->_moveRowSegments();
		}

		/**
		 * Assing a template variable
		 *
		 * @param string $key name of the variable within the template
		 * @param string $value replacement value
		 * @param bool $encode if true, special XML characters are encoded
		 * @throws OdfException
		 * @return odf
		 */
		public function setVars($key, $value, $encode = true, $charset = 'ISO-8859')
		{
		    // TODO Warning string may be:
		    // <text:span text:style-name="T13">{</text:span><text:span text:style-name="T12">aaa</text:span><text:span text:style-name="T13">}</text:span>
		    // instead of {aaa} so we should enhance this function.
            //print $key.'-'.$value.'-'.strpos($this->contentXml, $this->config['DELIMITER_LEFT'] . $key . $this->config['DELIMITER_RIGHT']).'<br>';
		    if (strpos($this->contentXml, $this->config['DELIMITER_LEFT'] . $key . $this->config['DELIMITER_RIGHT']) === false) {
                //if (strpos($this->contentXml, '">'. $key . '</text;span>') === false) {
		        throw new OdfException("var $key not found in the document");
                //}
		    }
			$value = $encode ? htmlspecialchars($value) : $value;
			$value = ($charset == 'ISO-8859') ? utf8_encode($value) : $value;
			$this->vars[$this->config['DELIMITER_LEFT'] . $key . $this->config['DELIMITER_RIGHT']] = str_replace("\n", "<text:line-break/>", $value);
			return $this;
		}

		/**
		 * Assign a template variable as a picture
		 *
		 * @param string $key name of the variable within the template
		 * @param string $value path to the picture
		 * @throws OdfException
		 * @return odf
		 */
		public function setImage($key, $value)
		{
			$filename = strtok(strrchr($value, '/'), '/.');
			$file = substr(strrchr($value, '/'), 1);
			$size = @getimagesize($value);
			if ($size === false) {
				throw new OdfException("Invalid image");
			}
			list ($width, $height) = $size;
			$width *= self::PIXEL_TO_CM;
			$height *= self::PIXEL_TO_CM;
			$xml = <<<IMG
			<draw:frame draw:style-name="fr1" draw:name="$filename" text:anchor-type="char" svg:width="{$width}cm" svg:height="{$height}cm" draw:z-index="3"><draw:image xlink:href="Pictures/$file" xlink:type="simple" xlink:show="embed" xlink:actuate="onLoad"/></draw:frame>
IMG;
			$this->images[$value] = $file;
			$this->setVars($key, $xml, false);
			return $this;
		}

		/**
		 * Move segment tags for lines of tables
		 * Called automatically within the constructor
		 *
		 * @return void
		 */
		private function _moveRowSegments()
		{
			// Search all possible rows in the document
			$reg1 = "#<table:table-row[^>]*>(.*)</table:table-row>#smU";
			preg_match_all($reg1, $this->contentXml, $matches);
			for ($i = 0, $size = count($matches[0]); $i < $size; $i++) {
				// Check if the current row contains a segment row.*
				$reg2 = '#\[!--\sBEGIN\s(row.[\S]*)\s--\](.*)\[!--\sEND\s\\1\s--\]#sm';
				if (preg_match($reg2, $matches[0][$i], $matches2)) {
					$balise = str_replace('row.', '', $matches2[1]);
					// Move segment tags around the row
					$replace = array(
					'[!-- BEGIN ' . $matches2[1] . ' --]'	=> '',
					'[!-- END ' . $matches2[1] . ' --]'		=> '',
					'<table:table-row'							=> '[!-- BEGIN ' . $balise . ' --]<table:table-row',
					'</table:table-row>'						=> '</table:table-row>[!-- END ' . $balise . ' --]'
					);
					$replacedXML = str_replace(array_keys($replace), array_values($replace), $matches[0][$i]);
					$this->contentXml = str_replace($matches[0][$i], $replacedXML, $this->contentXml);
				}
			}
		}

		/**
		 * Merge template variables
		 * Called automatically for a save
		 *
                 * @param  string	$type		'content' or 'styles'
		 * @return void
		 */
		private function _parse($type='content')
		{
                    // Conditionals substitution
                    // Note: must be done before content substitution, else the variable will be replaced by its value and the conditional won't work anymore
                    foreach($this->vars as $key => $value)
                    {
                        // If value is true (not 0 nor false nor null nor empty string)
                        if($value)
                        {
                            // Remove the IF tag
                            $this->contentXml = str_replace('[!-- IF '.$key.' --]', '', $this->contentXml);
                            // Remove everything between the ELSE tag (if it exists) and the ENDIF tag
                            $reg = '@(\[!--\sELSE\s' . $key . '\s--\](.*))?\[!--\sENDIF\s' . $key . '\s--\]@smU'; // U modifier = all quantifiers are non-greedy
                            $this->contentXml = preg_replace($reg, '', $this->contentXml);
                        }
                        // Else the value is false, then two cases: no ELSE and we're done, or there is at least one place where there is an ELSE clause, then we replace it
                        else
                        {
                            // Find all conditional blocks for this variable: from IF to ELSE and to ENDIF
                            $reg = '@\[!--\sIF\s' . $key . '\s--\](.*)(\[!--\sELSE\s' . $key . '\s--\](.*))?\[!--\sENDIF\s' . $key . '\s--\]@smU'; // U modifier = all quantifiers are non-greedy
                            preg_match_all($reg, $this->contentXml, $matches, PREG_SET_ORDER);
                            foreach($matches as $match) { // For each match, if there is an ELSE clause, we replace the whole block by the value in the ELSE clause
                                if (!empty($match[3])) $this->contentXml = str_replace($match[0], $match[3], $this->contentXml);
                            }
                            // Cleanup the other conditional blocks (all the others where there were no ELSE clause, we can just remove them altogether)
                            $this->contentXml = preg_replace($reg, '', $this->contentXml);
                        }
                    }

                    // Content (variable) substitution
                    if ($type == 'content')	$this->contentXml = str_replace(array_keys($this->vars), array_values($this->vars), $this->contentXml);
                    // Styles substitution
                    if ($type == 'styles')	$this->stylesXml = str_replace(array_keys($this->vars), array_values($this->vars), $this->stylesXml);

		}

		/**
		 * Add the merged segment to the document
		 *
		 * @param Segment $segment
		 * @throws OdfException
		 * @return odf
		 */
		public function mergeSegment(Segment $segment)
		{
			if (! array_key_exists($segment->getName(), $this->segments)) {
				throw new OdfException($segment->getName() . 'cannot be parsed, has it been set yet ?');
			}
			$string = $segment->getName();
			// $reg = '@<text:p[^>]*>\[!--\sBEGIN\s' . $string . '\s--\](.*)\[!--.+END\s' . $string . '\s--\]<\/text:p>@smU';
			$reg = '@\[!--\sBEGIN\s' . $string . '\s--\](.*)\[!--.+END\s' . $string . '\s--\]@smU';
			$this->contentXml = preg_replace($reg, $segment->getXmlParsed(), $this->contentXml);
			return $this;
		}

		/**
		 * Display all the current template variables
		 *
		 * @return string
		 */
		public function printVars()
		{
			return print_r('<pre>' . print_r($this->vars, true) . '</pre>', true);
		}

		/**
		 * Display the XML content of the file from odt document
		 * as it is at the moment
		 *
		 * @return string
		 */
		public function __toString()
		{
			return $this->contentXml;
		}

		/**
		 * Display loop segments declared with setSegment()
		 *
		 * @return string
		 */
		public function printDeclaredSegments()
		{
			return '<pre>' . print_r(implode(' ', array_keys($this->segments)), true) . '</pre>';
		}

		/**
		 * Declare a segment in order to use it in a loop
		 *
		 * @param string $segment
		 * @throws OdfException
		 * @return Segment
		 */
		public function setSegment($segment)
		{
			if (array_key_exists($segment, $this->segments)) {
				return $this->segments[$segment];
			}
			// $reg = "#\[!--\sBEGIN\s$segment\s--\]<\/text:p>(.*)<text:p\s.*>\[!--\sEND\s$segment\s--\]#sm";
			$reg = "#\[!--\sBEGIN\s$segment\s--\](.*)\[!--\sEND\s$segment\s--\]#sm";
			if (preg_match($reg, html_entity_decode($this->contentXml), $m) == 0) {
				throw new OdfException("'$segment' segment not found in the document");
			}
			$this->segments[$segment] = new Segment($segment, $m[1], $this);
			return $this->segments[$segment];
		}
		/**
		 * Save the odt file on the disk
		 *
		 * @param string $file name of the desired file
		 * @throws OdfException
		 * @return void
		 */
		public function saveToDisk($file = null)
		{
			if ($file !== null && is_string($file)) {
				if (file_exists($file) && !(is_file($file) && is_writable($file))) {
					throw new OdfException('Permission denied : can\'t create ' . $file);
				}
				$this->_save();
				copy($this->tmpfile, $file);
			} else {
				$this->_save();
			}
		}

		/**
		 * Write output file onto disk
		 *
		 * @throws OdfException
		 * @return void
		 */
		private function _save()
		{
			$res=$this->file->open($this->tmpfile);    // tmpfile is odt template
			$this->_parse('content');
			$this->_parse('styles');

			if (! $this->file->addFromString('content.xml', $this->contentXml)) {
				throw new OdfException('Error during file export addFromString');
			}
			if (! $this->file->addFromString('styles.xml', $this->stylesXml)) {
				throw new OdfException('Error during file export addFromString');
			}
			foreach ($this->images as $imageKey => $imageValue) {
				$this->file->addFile($imageKey, 'Pictures/' . $imageValue);
            	$this->addImageToManifest($imageValue);
			}
        	if (! $this->file->addFromString('./META-INF/manifest.xml', $this->manifestXml)) {
            	throw new OdfException('Error during file export: manifest.xml');
        	}
			$this->file->close();
		}

		/**
		 * Update Manifest file according to added image files
		 *
		 * @param string	$file		Image file to add into manifest content
		 */
		public function addImageToManifest($file)
		{
		        $extension = explode('.', $file);
		        $add = ' <manifest:file-entry manifest:media-type="image/'.$extension[1].'" manifest:full-path="Pictures/'.$file.'"/>'."\n";
		        $this->manifestXml = str_replace('</manifest:manifest>', $add.'</manifest:manifest>', $this->manifestXml);
		}

		/**
		 * Export the file as attached file by HTTP
		 *
		 * @param string $name (optionnal)
		 * @throws OdfException
		 * @return void
		 */
		public function exportAsAttachedFile($name="")
		{
			$this->_save();
			if (headers_sent($filename, $linenum)) {
				throw new OdfException("headers already sent ($filename at $linenum)");
			}

			if( $name == "" )
			{
				$name = md5(uniqid()) . ".odt";
			}

			header('Content-type: application/vnd.oasis.opendocument.text');
			header('Content-Disposition: attachment; filename="'.$name.'"');
			readfile($this->tmpfile);
		}
		/**
		 * Returns a variable of configuration
		 *
		 * @return string The requested variable of configuration
		 */
		public function getConfig($configKey)
		{
			if (array_key_exists($configKey, $this->config)) {
				return $this->config[$configKey];
			}
			return false;
		}
		/**
		 * Returns the temporary working file
		 *
		 * @return string le chemin vers le fichier temporaire de travail
		 */
		public function getTmpfile()
		{
			return $this->tmpfile;
		}

		/**
		 * Delete the temporary file when the object is destroyed
		 */
		public function __destruct()
		{
			if (file_exists($this->tmpfile)) {
				unlink($this->tmpfile);
			}

			if (file_exists($this->tmpdir)) {
				$this->_rrmdir($this->tmpdir);
				rmdir($this->tmpdir);
			}
		}

		/**
		 * Empty the temporary working directory recursively
		 * @param $dir the temporary working directory
		 * @return void
		 */
		private function _rrmdir($dir)
		{
			if ($handle = opendir($dir)) {
				while (false !== ($file = readdir($handle))) {
					if ($file != '.' && $file != '..') {
						if (is_dir($dir . '/' . $file)) {
							$this->_rrmdir($dir . '/' . $file);
							rmdir($dir . '/' . $file);
						} else {
							unlink($dir . '/' . $file);
						}
					}
				}
				closedir($handle);
			}
		}
}

?>