source: pvrrd/cgiCreate.py @ 206

#!/usr/bin/env python

'''
 create CGI scripts for each PV (& RRD database)
'''
########### SVN repository information ###################
# $Date: 2010-08-18 20:28:25 +0000 (Wed, 18 Aug 2010) $
# $Author: jemian $
# $Revision: 206 $
# $HeadURL$
# $Id: cgiCreate.py 206 2010-08-18 20:28:25Z jemian $
########### SVN repository information ###################

###############################################################################

import xmlSupport
import os.path
from makeTagHTML import makeTagHTML
import time


###############################################################################

def makeGraphEntry(pvEntry, rrd, span, cgi, desc ,yTitle, properties):
    spanName = span['name']
    png = os.path.join(
        properties['rrd_logs_base_dir'],
        'plots',
        pvEntry['fileRoot'] + '-' + spanName + '.png'
    )
    graph  = 'RRD::GRAPH' + "\n"
    graph += '  ' + png + "\n"
    graph += '  --imgformat=PNG' + "\n"
    #### NEEDS WORK HERE on the directory & path name
    img = 'img src="../plots/%s"  width="%lu" height="%lu"'
    graph += "  --imginfo '" + makeTagHTML(img, '', 0).strip() + "'\n"
    graph += '  --lazy --start ' + span['value'] + ' --end now' + "\n"
    graph += '  --interlaced' + "\n"
    graph += '  --slope-mode' + "\n"
    graph += '  --title "' + desc + '"' + "\n"
    graph += '  --vertical-label="' + yTitle + '"' + "\n"
    graph += '  --units-exponent 0' + "\n"
    if (pvEntry['scale'] == 'log'):
        graph += '  --alt-autoscale' + "\n"
        graph += '  --logarithmic' + "\n"
    if (pvEntry['scale'] == 'lin'):
        graph += '  --alt-autoscale' + "\n"
        graph += '  --alt-y-grid' + "\n"
    graph += '  DEF:a=' + rrd + ':EPICS:AVERAGE' + "\n"
    graph += '  DEF:aH=' + rrd + ':EPICS:MAX' + "\n"
    graph += '  DEF:aL=' + rrd + ':EPICS:MIN' + "\n"
    graph += '  VDEF:mean=a,AVERAGE' + "\n"
    graph += '  COMMENT:"   PV=' + yTitle + '   average\:"' + "\n"
    graph += '  GPRINT:mean:"%lg"' + "\n"
    graph += '  COMMENT:"\\n"' + "\n"
    graph += '  COMMENT:"   "' + "\n"
    graph += '  LINE1:aH#ccccff:max' + "\n"
    graph += '  LINE1:aL#ffcccc:min' + "\n"
    graph += '  LINE2:a#ff0000:average' + "\n"
    rrdCmd = '<RRD::TIME::NOW %Y-%m-%d,%H\:%M\:%S>'
    graph += '  COMMENT:"   plotted\: ' + rrdCmd + '\\n"'+ "\n"
    return "<" + graph + ">"

###############################################################################

def write_text_file(fileName, content):
    f = open(fileName, 'w')
    f.write(content)
    f.close()
    return fileName


###############################################################################

def write_executable_text_file(fileName, content):
    write_text_file(fileName, content)
    os.chmod(fileName, 0775)
    return fileName


###############################################################################

def createPvCGI (pv, rrd, properties):
    yTitle = pv['pv'].replace(':', '\:')
    desc = pv['desc']
    cgi = os.path.join(
      properties['rrd_logs_base_dir'],
      properties['subdirs']['cgi_dir'],
      pvEntry['fileRoot'] + '.cgi'
    )
    script = '#!'+properties['rrd']['rrdcgi']+"\n"
    script += "<!-- \n"
    script += "  auto-created " + time.ctime() + "\n"
    script += "  using " + properties['rrd']['rrdcgi'] + "\n"
    script += "  and " + cgi + "\n"
    script += "-->\n"
    head = makeTagHTML(
        'head',
        makeTagHTML('meta http-equiv="Pragma"  content="no-cache"')
        +makeTagHTML('meta http-equiv="Refresh" content="300"')
        +makeTagHTML('title', desc, 0)
    )
    #------------
    # cannot use makeTagHTML since rrdcgi does not accept short-form closing tags
    body = "<RRD::GOODFOR -300>"
    body += makeTagHTML('h1', desc, 0) + "\n"
    table = ''
    row = makeTagHTML('td', "database last updated:", 0)+"\n"
    row += makeTagHTML('td', "<RRD::TIME::LAST " + rrd + " %c>", 0)
    table += makeTagHTML('tr', row)+"\n"
    row = makeTagHTML('td', "CGI executed:", 0)+"\n"
    row += makeTagHTML('td', "<RRD::TIME::NOW %c>", 0)
    table += makeTagHTML('tr', row)+"\n"
    db = makeTagHTML('table', table)+"\n"
    body += makeTagHTML('small', makeTagHTML('tt', db))+"\n"
    #------------
    table = ''
    for spanName in properties['spans']['names']:
        row = makeTagHTML(
          'em',
          makeTagHTML('small', "data for last "+spanName, 0).strip(),
          0
        ) + "\n"
        row += makeTagHTML('br') + "\n"
        # make graph entry
        row += makeGraphEntry(
                pv,
                rrd,
                properties['spans'][spanName],
                cgi,
                desc ,
                yTitle,
                properties
        )
        table += makeTagHTML('tr', makeTagHTML('td', row))
    body += makeTagHTML('table', table)+"\n"
    #------------
    html = makeTagHTML(
        'html',
        head + "\n"
        + makeTagHTML('body', body.strip())
    )
    script += html
    write_executable_text_file(cgi, script)
    print "created CGI file: ", cgi

###############################################################################

cfg = xmlSupport.readConfigurationXML('/home/joule/WEB33/www/rrd')

for pvEntry in cfg['pvList']:
    rrd = os.path.join(
      cfg['properties']['rrd_logs_base_dir'],
      cfg['properties']['subdirs']['rrd_file_dir'],
      pvEntry['fileRoot'] + '.rrd'
    )
    # only create those RRD files that do not already exist
    if (os.path.exists(rrd)):
        #print "found " + rrd
        createPvCGI (pvEntry, rrd, cfg['properties'])
    else:
        # do not create CGI file if there is no RRD, no data to show
        print "!!! need to create " + rrd

###############################################################################