searchParams.py

#!/usr/bin/env python

"""
Author : Peter Slaughter
Date   : Feb. 2013
Purpose: Maintain database of RHESsys runtime parameters
"""

import commands, csv, getopt, os, re, string, sys, time
import rhessys.constants as rpc
from rhessys.params import paramDB

paramFileRegex = re.compile('^\s*([\w.-]+)\s*([\w.-]+)#*.*$')
csvFileRegex = re.compile('^\s*(\w+)\s*,(\w+).*$')

def usage():
    print''
    print 'Program: %s' % sys.argv[0]
    print 'Purpose: Search the RHESsys parameter database and output the results'
    print ''
    print 'Syntax:'
    print '  %s --name=<class name> [--comment=<comment string>] [--endDatetime=<datetime>] --format-<format type> [--genus=<genus name>] --location=<location name> --reference=<user comment>] [--searchType=<hierarchical | constrained>] [--species=<species name>] [--startDatetime=<datetime>] [--user=<user name>] --verbose' % sys.argv[0]
    print ''
    print '    where:'
    print '      --name=<name>: any name that can uniquely identify a set of parameters' 
    print '             - example class names might be "Western Hemlock", "Ponderosa Pine, eastern Sierra"'
    print '      --comment=<comment string>: this can be any comment that will be used to search for matching records in the parameter database.'
    print '      --endDatetime=<datetime>: select parameters that were inserted into the database before the specified datetime. Datetime can'
    print '        be specified in one of the formats: "YYYY-MM-DD", "YYYY-MM-DD HH:MM" or "YYYY-MM-DD HH:MM:SS", for example "2013-04-15 10:25:00"'
    print '      --format=<format type>: valid formats are "csv" and "param"'
    print '            - if "csv" is specified, all fields from the database are written to the output file, separated by commas'
    print '            - if "param" is specified, then name, value, comment fields are output with a format that is suitable for use as a RHESsys parameter file'
    print '      --genus=<genus name>: the name of a genus that will be used for searching'
    print '      --location=<location name>: the location to search for, e.g. "Oregon"'
    print '      --type=<class type>: one of: %s' % str(rpc.VALID_TYPES)
    print '      --reference=<reference string>: this can be any reference (citation) that will be used to search for matching records in the parameter database.'
    print '      --searchType=<hierarchical | constrained>: perform a hierarchical or constrained search'
    print '      --species=<species name">: the name of a genus that will be used for searching'
    print '      --startDatetime=<datetime>: select parameters that were inserted into the database after the specified datetime. Datetime can'
    print '        be specified in one of the formats: "YYYY-MM-DD", "YYYY-MM-DD HH:MM" or "YYYY-MM-DD HH:MM:SS", for example "2013-04-15 10:25:00"'
    print '      --user=<user name>: the name of the person that will be used for searching'
    print '      --userdef=<user defined string>: a user defined string that will be used for searching'
    print ''
    print '    for example:'
    print ''
    print '        %s --searchType=hierarchical --name="Red Alder" --location="Oregon" --startDatetime="2013-04-16" --format=csv --output="red_alder_orgeon.def" ' % sys.argv[0]
    print ''
    
if __name__ == '__main__':

    comment = None
    className = None
    classType = None
    endDatetimeStr = None
    startDatetimeStr = None
    location = None
    outputFormat = "csv"
    param = None
    genus = None
    outputPath = None
    reference = None
    searchType = None
    species = None
    user = None
    verbose = False

    # Parse command line
    try:
        opts, args = getopt.getopt(sys.argv[1:], "hv", ["comment=", "endDatetime=", "startDatetime=", "format=", "genus=", "location=", "output=", "param=", "reference=", "species=", "type=", "name=", "searchType=", "user=", "verbose"]) 
    except getopt.GetoptError:
        # print help information and exit:
        print 'Error in command line:\n %s' % sys.argv
        print 'exception type= ', sys.exc_type
        print 'exception value= ', sys.exc_value
        usage()
        sys.exit(1)

    if len(opts) == 0:
        usage()
        sys.exit()

    for o, a in opts:
        if o in ("-h", "--help"):
            usage()
            sys.exit()
        elif o in ("--startDatetime"):
            startDatetimeStr = a
        elif o in ("--endDatetime"):
            endDatetimeStr = a
        elif o in ("--comment"):
            comment = a
        elif o in ("--format"):
            outputFormat = a
        elif o in ("--genus"):
            genus = a
        elif o in ("--species"):
            species = a
        elif o in ("--type"):
            classType = a
        elif o in ("--location"):
            location = a
        elif o in ("--name"):
            className = a
        elif o in ("--output"):
            outputPath = a
        elif o in ("--param"):
            param = a
        elif o in ("--reference"):
            reference = a
        elif o in ("--searchType"):
            searchType = a
            if (searchType not in rpc.SEARCH_TYPES):
                msg = "Invalid search type %s" % searchType
                usage()
                raise RuntimeError, msg
        elif o in ("--user"):
            user = a
        elif o in ("-v", "--verbose"):
            verbose = True

        if searchType == None: searchType = rpc.SEARCH_TYPE_CONSTRAINED

    if (not outputFormat in rpc.VALID_FORMATS):
        msg = "Output format must be one of the following: ", rpc.VALID_FORMATS
        raise RuntimeError, msg

    DBobj = paramDB()
    DBobj.search(searchType, classType, className, location, param, genus, species, startDatetimeStr, endDatetimeStr, user, reference)
    DBobj.write(outputPath, outputFormat)