class.DotOutputStrategy.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.DotOutputStrategy.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.Log.php");

/**
 * @class DotOutputStrategy
 * @ingroup Output
 * @brief This OutputStrategy outputs an object's content in a dot file.
 * @note file locking works not on NFS!
 *
 * @author      ingo herwig <ingo@wemove.com>
 */
class DotOutputStrategy extends OutputStrategy
{
  var $DEFAULT_NODE_STYLE = 'height=0.1,width=1,shape=box,style=filled,color="#49B4CF",fillcolor="#49B4CF",fontcolor=white,fontsize=14,fontname="Helvetica-Bold"';
  var $DEFAULT_EDGE_STYLE = 'arrowhead=none,arrowtail=none,color="#49B4CF"';

  var $_file = '';
  var $_fp = 0;
  var $_fileOk = false; // indicates if we can write to the file
  var $_nodeIndex = 0;

  var $_nodeStyle = '';
  var $_edgeStyle = '';

  /**
   * Constructor.
   * @param file The output file name.
   * @param nodeStyle Style definition to use for nodes (see dot documentation).
   * @param edgeStyle Style definition to use for edges (see dot documentation).
   */
  function DotOutputStrategy($file, $nodeStyle='', $edgeStyle='')
  {
    $this->_file = $file;
    $this->_fileOk = false;
    
    if ($nodeStyle != '')
      $this->_nodeStyle = $nodeStyle;
    else
      $this->_nodeStyle = $this->DEFAULT_NODE_STYLE;
    if ($edgeStyle != '')
      $this->_edgeStyle = $edgeStyle;
    else
      $this->_edgeStyle = $this->DEFAULT_EDGE_STYLE;
  }
  /**
   * Write the dot 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))
      {
        $this->_fileOk = true;
        fputs($this->_fp, "digraph G {\n\n");
        fputs($this->_fp, "  node [".$this->_nodeStyle."]\n");
        fputs($this->_fp, "  edge [".$this->_edgeStyle."]\n\n");
        return true;
      }
  }
  /**
   * Write the dot footer.
   */
  function writeFooter()
  { 
    if ($this->_fileOk)
    {
      fputs($this->_fp, "\n}\n");
      flock ($this->_fp, LOCK_UN);
      fclose($this->_fp);
    }
  }
  /**
   * Write the object's content.
   * @param obj The object to write.
   */
  function writeObject(&$obj)
  {
    if (!$obj->getProperty('nodeIndex'))
      $obj->setProperty('nodeIndex', $this->getNextIndex());
      
    if ($this->_fileOk)
    {
      fputs($this->_fp, '  n'.$obj->getProperty('nodeIndex').' [label="'.$obj->getOID().'"]'."\n");
      $children = $obj->getChildren();
      for($i=0; $i<sizeOf($children); $i++)
      {
        if (!$children[$i]->getProperty('nodeIndex'))
          $children[$i]->setProperty('nodeIndex', $this->getNextIndex());
        fputs($this->_fp, '  n'.$obj->getProperty('nodeIndex').' -> n'.$children[$i]->getProperty('nodeIndex')."\n");
      }
      fputs($this->_fp, "\n");
    }
  }
  /**
   * Get the next Node index.
   * @return The next Node index.
   */
  function getNextIndex()
  {
    return $this->_nodeIndex++;
  }
}
?>