class.XMLOutputStrategy.php

Go to the documentation of this file.

<?php
/**
 * wCMF - wemove Content Management Framework
 * Copyright (C) 2005-2014 wemove digital solutions GmbH
 *
 * Licensed under the terms of any of the following licenses 
 * at your choice:
 *
 * - GNU Lesser General Public License (LGPL)
 *   http://www.gnu.org/licenses/lgpl.html
 * - Eclipse Public License (EPL)
 *   http://www.eclipse.org/org/documents/epl-v10.php
 *
 * See the license.txt file distributed with this work for 
 * additional information.
 *
 * $Id: class.XMLOutputStrategy.php 1462 2014-02-04 23:52:27Z iherwig $
 */
require_once(BASE."wcmf/lib/output/class.OutputStrategy.php");
require_once(BASE."wcmf/lib/util/class.FileUtil.php");
require_once(BASE."wcmf/lib/util/class.Log.php");

/**
 * @class XMLOutputStrategy
 * @ingroup Output
 * @brief This OutputStrategy outputs an object's content in a xml file
 * using the default format.
 * @note file locking works not on NFS!
 *
 * @author      ingo herwig <ingo@wemove.com>
 */
class XMLOutputStrategy extends OutputStrategy
{
  var $_id = 0;
  var $_file = '';
  var $_docType = '';
  var $_dtd = '';
  var $_encoding = '';
  var $_fp = 0;
  var $_indent = '';
  var $_linebreak = "\n";
  var $_tagsToClose = null;
  var $_lastIndent = -1;
  var $_fileOk = false; // indicates if we can write to the file
  /**
   * Constructor.
   * @param file The output file name.
   * @param docType The document type.
   * @param dtd The document type definition name.
   * @param encoding The used encoding (default: UTF-8).
   * @param indent The number of spaces to indent (default: 2).
   * @param linebreak The linebreak char to use (default: \n).
   */
  function XMLOutputStrategy($file, $docType, $dtd, $encoding='UTF-8', $indent=2, $linebreak="\n")
  {
    $this->_file = $file;
    $this->_docType = $docType;
    $this->_dtd = $dtd;
    $this->_encoding = $encoding;
    $this->_indent = str_repeat(' ', $indent);
    $this->_linebreak = $linebreak;
    $this->_tagsToClose = array();
    $this->_fileOk = false;
  }
  /**
   * Write the xml header.
   */
  function writeHeader()
  {
    // check if file exists and is locked
    if (file_exists($this->_file))
    {
      $this->_fp = fopen($this->_file, "r");
      if (!$this->_fp)
      {
        Log::warn("Can't write to file ".$this->_file.". Another user holds the lock. Try again later.", __CLASS__);
        return;
      }
      else
        fclose($this->_fp);
    }
    // check if file exists and is locked
    $this->_fp = fopen($this->_file, "w");
    if ($this->_fp)
    {
      if(!flock ($this->_fp, LOCK_EX))
        Log::warn("Can't lock file ".$this->_file.". Proceeding without.", __CLASS__);
        
      $this->_fileOk = true;
      $this->writeToFile('<?xml version="1.0" encoding="'.$this->_encoding.'"?>'.$this->_linebreak.'<!DOCTYPE '.$this->_docType.' SYSTEM "'.$this->_dtd.'">'.$this->_linebreak);
      return true;
    }
  }
  /**
   * Write the xml footer.
   */
  function writeFooter()
  { 
    if ($this->_fileOk)
    {
      // print remaining open tags
      for ($i=0;$i<sizeOf($this->_tagsToClose);$i++)
      {
        $closeTag = $this->_tagsToClose[$i];
        $this->writeToFile(str_repeat($this->_indent, $closeTag["indent"]).'</'.$closeTag["name"].'>'.$this->_linebreak);
      }
      flock ($this->_fp, LOCK_UN);
      fclose($this->_fp);
    }
  }
  /**
   * Write the object.
   * @param obj The object to write.
   */
  function writeObject(&$obj)
  {
    if ($this->_fileOk)
    {
      $curIndent = $obj->getDepth();
      if ($curIndent < $this->_lastIndent)
      {
        // write last opened and not closed tags
        for ($i=$this->_lastIndent-$curIndent;$i>0;$i--)
        {
          $closeTag = array_shift($this->_tagsToClose);
          $this->writeToFile(str_repeat($this->_indent, $closeTag["indent"]).'</'.$closeTag["name"].'>'.$this->_linebreak);
        }
      }
      $tagName = $this->writeObjectContent($obj, $curIndent);
      if ($tagName != "")
      {
        // remember open tag if not closed
        if ($obj->getNumChildren() > 0)
        {
          $closeTag = array("name" => $tagName, "indent" => $curIndent);
          array_unshift($this->_tagsToClose, $closeTag);
        }
        else
        {
          //$this->writeToFile($this->_linebreak.str_repeat($this->_indent, $curIndent).'</'.$tagName.'>'.$this->_linebreak);
          $this->writeToFile('</'.$tagName.'>'.$this->_linebreak);
        }
        // remember current indent
        $this->_lastIndent = $curIndent;
      }
    }
  }
  /**
   * Actually write text to the file.
   * @note subclasses will override this to implement any final conversion.
   * @param text The text to write
   */
        function writeToFile($text)
        {
                fputs($this->_fp, $text);
        }
  /**
   * Write the object's content including opening tag, excluding closing tag.
   * @param obj The object to write.
   * @param curIndent The current indent.
   * @return The name of the opening tag
   */
  function writeObjectContent(&$obj, $curIndent)
  {
    // write object's content
    $elementName = $this->getElementName($obj);
    
    // open tag
    $this->writeToFile(str_repeat($this->_indent, $curIndent).'<'.$elementName);
    
    // write object id
    if ($this->isWritingOIDs())
        $this->writeToFile(' id="'.$obj->getOID().'"');
        
    // write object attributes
    $attributeNames = $obj->getValueNames(DATATYPE_ATTRIBUTE);
    foreach ($attributeNames as $curAttribute)
        $this->writeAttribute(&$obj, $curAttribute);

    // close tag
    $this->writeToFile('>');
    if ($obj->getNumChildren() > 0)
      $this->writeToFile($this->_linebreak);

    // write object element
    $elementNames = $obj->getValueNames(DATATYPE_ELEMENT);
    foreach ($elementNames as $curElement)
        $this->writeElement(&$obj, $curElement);

    return $elementName;
  }
  /**
   * Determine wether the oid should be written to the file. The default implementation returns true.
   * @note subclasses will override this to implement special application requirements.
   * @return True/False wether the oid should be written
   */
  function isWritingOIDs()
  {
        return true;
        }
  /**
   * Write an object value of type DATATYPE_ELEMENT.
   * @note subclasses will override this to implement special application requirements.
   * @param obj The object to write
   * @param name The name of the value
   */
  function writeElement(&$obj, $name)
  {
    $value = $obj->getValue($name, DATATYPE_ELEMENT);
    if ($value != '')
    {
      $value = $this->getElementValue($obj, $name, $value);
      $this->writeToFile($value);
    }
        }
  /**
   * Get the xml element name for an object. The default implementation returns the result of the getType() method.
   * @note subclasses will override this to implement special application requirements.
   * @param obj The object to write
   * @return The xml name of the element
   */
  function getElementName(&$obj)
  {
        return $obj->getType();
        }
  /**
   * Get the xml element value for an object. The default implementation replaces newlines by <br>
   * and applies htmlspecialchars to the result.
   * @note subclasses will override this to implement special application requirements.
   * @param obj The object to write
   * @param name The name of the element
   * @param value The value to write
   * @return The xml value
   */
  function getElementValue(&$obj, $name, $value)
  {
    return htmlspecialchars(preg_replace("/\r\n|\n\r|\n|\r/", "<br />", $value));
        }
  /**
   * Write an object value of type DATATYPE_ATTRIBUTE.
   * @note subclasses will override this to implement special application requirements.
   * @param obj The object to write
   * @param name The name of the value
   */
  function writeAttribute(&$obj, $name)
  {
    $value = $obj->getValue($name, DATATYPE_ATTRIBUTE);
    if ($value != '')
    {
      $value = $this->getAttributeValue($obj, $name, $value);
      $this->writeToFile(' '.$this->getAttributeName($obj, $name).'="'.$value.'"');
    }
        }
  /**
   * Get the xml attribute name for an object value. The default implementation returns the name of the attribute.
   * @note subclasses will override this to implement special application requirements.
   * @param obj The object to write
   * @param name The name of the attribute
   * @return The xml name of the attribute
   */
  function getAttributeName(&$obj, $name)
  {
    return $name;
        }
  /**
   * Get the xml attribute value for an object value. The default implementation replaces newlines by <br>
   * and applies htmlspecialchars to the result.
   * @note subclasses will override this to implement special application requirements.
   * @param obj The object to write
   * @param name The name of the attribute
   * @param value The value to write
   * @return The xml value
   */
  function getAttributeValue(&$obj, $name, $value)
  {
    return htmlspecialchars(preg_replace("/\r\n|\n\r|\n|\r/", "<br />", $value));
        }
}
?>