source: pvrrd/src/pvrrd/index.php @ 619

<?php 

/*
########### SVN repository information ###################
# $Date: 2011-08-21 13:24:14 +0000 (Sun, 21 Aug 2011) $
# $Author: jemian $
# $Revision: 619 $
# $HeadURL$
# $Id: index.php 619 2011-08-21 13:24:14Z jemian $
########### SVN repository information ###################
*/

//****************************************************

$propertiesFile = 'properties.xml';
$pvListFile = 'pvlist.xml';
$defaultGallerySpan = 'week';

include('makeTagHTML.php');


/** Returns subversion revision number */
function getSvnIdStr() {
    $svn_id = '$Id: index.php 619 2011-08-21 13:24:14Z jemian $';
    $scid = trim($svn_id, "$");
    return $scid;
}

//****************************************************

function directoryBrowsing($rootDir) {
  foreach(scanDir($rootDir) as $key => $content) {
    $path = $rootDir.'/'.$content;
    if(is_file($path) && is_readable($path)) {
        print($path . "\n");
    }
  }
}

//****************************************************

function readPropertiesXML($xmlFile) {
  $doc = new DOMDocument;
  $doc->load($xmlFile);
  $propsXML = new DOMXPath($doc);
  $items = array('title', 'rrdtool', 'rrdupdate', 'rrd_file_start_time', 
        'www_plot_dir', 'rrd_logs_base_dir');
  $props = array();
  foreach($items as $key) {
    $props[$key] = $propsXML->query('/properties/'.$key)->item(0)->textContent;
  }
  $items = array(
        'spans' => 'span',
        'subdirs' => 'subdir',
  );
  foreach($items as $parent => $child) {
    $props[$parent] = array();
    $query = '//' . $parent . '/' . $child;
    foreach ($propsXML->query($query) as $entry) {
      $value = $entry->textContent;
      $name = $propsXML->query('./@name', $entry)->item(0)->textContent;
      $props[$parent][$name] = $value;
    }
  }
  return($props);
}

//****************************************************

function readPvlistXML($xmlFile) {
  $doc = new DOMDocument;
  $doc->load($xmlFile);
  $pvXML = new DOMXPath($doc);
  
  $items = array('units', 'min', 'max', 'scale');
  $pvList = array();
  foreach($pvXML->query('//PV_LIST/EPICS_PV') as $entry) {
    $pv = $pvXML->query('./@pv', $entry)->item(0)->textContent;
    $arr = array();
    $arr['pv'] = $pv;
    $arr['desc'] = trim($entry->textContent);
    foreach($items as $item) {
      $value = $pvXML->query('./@'.$item, $entry)->item(0)->textContent;
      $arr[$item] = $value;
    }
    $arr['fileRoot'] = str_replace  (':', '-', $pv);
    $pvList[] = $arr;
  }
  return($pvList);
}

//****************************************************

function showGallery($span) {
  global $propertiesFile, $pvListFile, $_SERVER;
  // show all available plots at the selected span
  // This can be very friendly for the PDA screen size
  // BUT, it loads all the PNG charts for the chosen $span
  //-----------
  // load the properties and EPICS PV list from XML configuration files
  $props = readPropertiesXML($propertiesFile);
  $pvList = readPvlistXML($pvListFile);
  //-----------
  sort($pvList);
  foreach($pvList as $arr) {
    $pngFile = sprintf('%s/%s-%s.png', 
        $props['subdirs']['fs_plot_dir'],
        $arr['fileRoot'], 
        $span);
    $htmlFile = sprintf('%s/%s.html', 
        $props['subdirs']['html_dir'],
        $arr['fileRoot']);
    $cgiFile = sprintf('%s/%s.cgi', 
        $props['subdirs']['cgi_dir'],
        $arr['fileRoot']);
    if (file_exists($pngFile)) {
      $tag = makeTagHTML(
        sprintf('img src="%s"  width="%d" height="%d"', $pngFile, 200, 80)
      );
      if (file_exists($htmlFile)) {
        // link to an HTML page if available, it shows more plots
        $href = $htmlFile;
      } else {
        // otherwise, just show the PNG full-size
        $href = $pngFile;
      }
      $a = makeTagHTML(sprintf('a href="%s"', $href), $tag);
      $body .= $a;
    }
  }
  $title = $props['title'] . " for the last " . $span;

  // make HTML head
  $head = "<!-- created by ./index.php -->\n";
  $head .= makeTagHTML('title', $title, 0);
  $head .= makeTagHTML('meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"');
  $head .= makeTagHTML('meta name="GENERATOR" content="Pete Jemian, text editor"');
  $head .= makeTagHTML('meta http-equiv="Pragma" content="no-cache"');

  // append an ending to the body
  $body .= makeTagHTML('hr', '');
  $body .= makeTagHTML('a href="documentation.html"', 'README');

  // assemble full HTML
  $parts = makeTagHTML('head', $head);
  $parts .= makeTagHTML('body', makeTagHTML('h1', $title, 0) . $body);

  // assemble everything
  $html = makeTagHTML('html', $parts);
  print($html);
}

//****************************************************

function showFullList($span) {
  global $propertiesFile, $pvListFile, $_SERVER;
  // show all data logs
  // show all available plots at the selected span
  //-----------
  // load the properties and EPICS PV list from XML configuration files
  $props = readPropertiesXML($propertiesFile);
  $pvList = readPvlistXML($pvListFile);
  //-----------
  sort($pvList);
  $row = makeTagHTML('th', 'PV');
  $row .= makeTagHTML('th', 'description');
  $row .= makeTagHTML('th', 'plot for last '.$span);
  $table = makeTagHTML('tr', $row);
  $i = 0;
  foreach($pvList as $arr) {
    $i = $i + 1;  // for coloring each table row

    $pngFile = sprintf('%s/%s-%s.png', 
        $props['subdirs']['fs_plot_dir'],
        $arr['fileRoot'], 
        $span);
    $htmlFile = sprintf('%s/%s.html', 
        $props['subdirs']['html_dir'],
        $arr['fileRoot']);
    $cgiFile = sprintf('%s/%s.cgi', 
        $props['subdirs']['cgi_dir'],
        $arr['fileRoot']);

    // @TODO: make a new PNG file with default $span

    if (file_exists($pngFile)) {
      $tag = makeTagHTML( 
        sprintf('img src="%s"  width="%d" height="%d"', $pngFile, 100, 40)
      );

      // PV name
      if (file_exists($cgiFile)) {
        // link to a RRDCGI page if available, it shows more plots
        $a = makeTagHTML(sprintf('a href="%s"', $cgiFile), $arr['pv']);
      } else {
        // otherwise, just show nothing
        $a = $arr['pv'];
      }
      $row = makeTagHTML('td', $a);

      // description
      $row .= makeTagHTML('td', $arr['desc']);

      // representative plot (recent history)
      if (file_exists($cgiFile)) {
        // link to a RRDCGI page if available, it shows more plots
        $href = $cgiFile;
      } else {
        // otherwise, just show the PNG full-size
        $href = $pngFile;
      }
      $a = makeTagHTML(sprintf('a href="%s"', $href), $tag);
      $row .= makeTagHTML('td', $a);

      // table row group
      if ( ($i % 2) == 0 ) {
        $table .= makeTagHTML('tr bgcolor="Azure"', $row);
      } else {
        $table .= makeTagHTML('tr', $row);
      }
    }
  }
  $body = makeTagHTML('table border="2"', $table);
  $title = $props['title'] . " For the last " . $span;

  // make HTML head
  $head = "<!-- created by ./index.php -->\n";
  $head .= makeTagHTML('title', $title, 0);
  $head .= makeTagHTML('meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"');
  $head .= makeTagHTML('meta name="GENERATOR" content="Pete Jemian, text editor"');
  $head .= makeTagHTML('meta http-equiv="Pragma" content="no-cache"');

  // put a title on the body
  $body = makeTagHTML('h1', $title, 0) 
        . makeTagHTML(
              'small',
              makeTagHTML('a href="documentation.html"', 'documentation')
                 . ', '
                 . 'subversion ' . getSvnIdStr(),
              0)
        . $body;


  // assemble full HTML
  $parts = makeTagHTML('head', $head);
  $parts .= makeTagHTML('body', $body);

  // assemble everything
  $html = makeTagHTML('html', $parts);
  print($html);
}

//****************************************************

function main() {
  global $propertiesFile, $pvListFile;
  print("<pre>\n");
    print("--------------------------------------\n");
    directoryBrowsing('.');
    print("--------------------------------------\n");
    $props = readPropertiesXML($propertiesFile);
    print_r($props);
    print("--------------------------------------\n");
    $pvList = readPvlistXML($pvListFile);
    print_r($pvList);
    print("--------------------------------------\n");
  print("</pre>\n");
}

//****************************************************

// main();
// construct other display methods, including form/response
// for now, this works but is bandwidth-intensive
//showGallery($defaultGallerySpan);
//
// alternative view showing a table of PV | description with links
showFullList($defaultGallerySpan);
//phpInfo();

?>