embient.util.php

Go to the documentation of this file.

<?php

require_once("domit/xml_domit_include.php");
require_once('domit/xml_domit_utilities.php');

define('XMLCFG',  'config.xml');

define('MAINSEC', 'embient');

// ----------------------------------------------

$embient_debug_msg = '';

$embient_dir = '';

// ----------------------------------------------

$_embient_extern_fn = array();

// ----------------------------------------------

// initialise DOMIT
DOMIT_DOMException::setErrorMode(DOMIT_ONERROR_CONTINUE);
DOMIT_DOMException::setErrorLog(false, '');

// ----------------------------------------------

function embient_debug($msg)
{
  global $embient_debug_msg;
  global $_embient_extern_fn;

  if ( !empty($_embient_extern_fn['debug']) && function_exists($_embient_extern_fn['debug']) )
  {
    call_user_func($_embient_extern_fn['debug'], $msg);
  }
  else
  {
    echo "Debug: $msg<br>";
    flush();
  }

  embient_log('debug', $msg, true);

  $msg .= "\n";

  $msg = strtr($msg, array('<' => '&lt;', '>' => '&gt;', '"' => '&quot;', ' ' => '&nbsp;'));
  $msg = strtr($msg, array('&lt;br /&gt;' => '<br />', '&lt;b&gt;' => '<b>', '&lt;/b&gt;' => '</b>', "\n" => '<br />'));

  $embient_debug_msg .= $msg;
}

function embient_error($msg, $file = __FILE__, $line = __LINE__)
{
  global $_embient_extern_fn;

  if ( !empty($_embient_extern_fn['error']) && function_exists($_embient_extern_fn['error']) )
  {
    call_user_func($_embient_extern_fn['error'], $msg, $file, $line);
  }
  else
  {
    echo "Error: $msg<br>";
    flush();
  }

  embient_log('error', "($file@$line) $msg", true);
}

/*
 * @brief Error message log facility for the active system
 *
 * @param $fn
 *   object - log function body
 */
 function embient_set_error_logger($logger)
{
  global $_embient_extern_fn;

  $_embient_extern_fn['error'] = $logger;
}

/*
 * @brief Debug message log facility for the active system
 *
 * @param $fn
 *   object - log function body
 */
 function embient_set_debug_logger($logger)
{
  global $_embient_extern_fn;

  $_embient_extern_fn['debug'] = $logger;
}

function embient_log($filename, $str, $timestamp = false)
{
  global $embient_dir;

  $handle = fopen("$embient_dir/embient.$filename.log", 'a');

  if ( $handle )
  {
    $stamp = '';

    if ( $timestamp )
    {
      $stamp = strftime("%d-%b-%Y %H:%M:%S - ");
    }

    fwrite($handle, $stamp.$str ."\n");
    fclose($handle);
  }
}

function embient_load_with_default($val, $default)
{
  return ( empty($val) ? $default : $val );
}

function embient_create_XML_tree($root)
{
  $tree = array();

  if ( $root->hasChildNodes() )
  {
    $c =& $root->childCount;

    for ($i = 0; $i < $c; $i++)
    {
      $leaf =& $root->childNodes[$i];

      if ( ! empty($leaf->nodeValue) )
      {
        return trim($leaf->getText());
      }
      else
      {
        $tree[$leaf->nodeName] = embient_create_XML_tree($leaf);
      }
    }
  }

  return empty($tree) ? '' : $tree;
}

function embient_load_config()
{
  global $embient_dir;

  $xmlcfg = new DOMIT_Document(); //instance of a DOMIT! document

  if ( ! $xmlcfg->loadXML("$embient_dir/". XMLCFG) )
  {
    embient_error("Cannot load configuration file - ". $xmlcfg->getErrorString());
    return array();
  }

  return embient_create_XML_tree($xmlcfg->documentElement);
}

function embient_save_config($conf)
{
  global $embient_dir;

  $xmlcfg =& new DOMIT_Document();
  $cfgval = array(MAINSEC => array($conf));

  DOMIT_Utilities::fromArray($xmlcfg, $cfgval );

  if ( ! $xmlcfg->saveXML("$embient_dir/". XMLCFG, true) )
  {
    embient_error("Cannot save configuration file - ". $xmlcfg->getErrorString());
    return false;
  }
  return true;
}

---