X-Git-Url: http://git.onelab.eu/?p=myplc.git;a=blobdiff_plain;f=plc_config.py;h=5d6ef40c7b065581b5588bac3b6a579ea9fed210;hp=913ccfdc80f3a2849f7b45f6de1ac68c0ed5abad;hb=HEAD;hpb=26c36a2f8ba152ce101a24c95449bc2afb932b6c diff --git a/plc_config.py b/plc_config.py index 913ccfd..5d6ef40 100644 --- a/plc_config.py +++ b/plc_config.py @@ -7,18 +7,21 @@ # Mark Huang # Copyright (C) 2006 The Trustees of Princeton University # -# $Id: plc_config.py,v 1.3 2006/04/18 15:32:48 thierry Exp $ -# -import xml.dom.minidom -from StringIO import StringIO -import time -import re -import textwrap import codecs import os +import re +import sys +import textwrap +import time +import traceback import types +import xml.dom.minidom +from xml.parsers.expat import ExpatError +from StringIO import StringIO +from optparse import OptionParser +class ConfigurationException(Exception): pass class PLCConfiguration: """ @@ -37,7 +40,7 @@ class PLCConfiguration: You may also save() the configuration. If a file path or object is not specified, the configuration will be written to the file path or object that was first loaded. - + plc.save() plc.save("/etc/planetlab/plc_config.xml") """ @@ -187,7 +190,11 @@ class PLCConfiguration: Merge file into configuration store. """ - dom = xml.dom.minidom.parse(file) + try: + dom = xml.dom.minidom.parse(file) + except ExpatError, e: + raise ConfigurationException, e + if type(file) in types.StringTypes: self._files.append(os.path.abspath(file)) @@ -235,6 +242,44 @@ class PLCConfiguration: fileobj.close() + def verify(self, default, read, verify_variables={}): + """ Confirm that the existing configuration is consistent + according to the checks below. + + It looks for filled-in values in the order of, local object (self), + followed by cread (read values), and finally default values. + + Arguments: + + default configuration + site configuration + list of category/variable tuples to validate in these configurations + + Returns: + + dict of values for the category/variables passed in + If an exception is found, ConfigurationException is raised. + + """ + + validated_variables = {} + for category_id, variable_id in verify_variables.iteritems(): + category_id = category_id.lower() + variable_id = variable_id.lower() + variable_value = None + sources = (self, read, default) + for source in sources: + (category_value, variable_value) = source.get(category_id,variable_id) + if variable_value <> None: + entry = validated_variables.get(category_id,[]) + entry.append(variable_value['value']) + validated_variables["%s_%s"%(category_id.upper(),variable_id.upper())]=entry + break + if variable_value == None: + raise ConfigurationException("Cannot find %s_%s)" % \ + (category_id.upper(), + variable_id.upper())) + return validated_variables def get(self, category_id, variable_id): """ @@ -313,7 +358,7 @@ class PLCConfiguration: if not category.has_key('id') or type(category['id']) not in types.StringTypes: return - + category_id = category['id'].lower() if self._variables.has_key(category_id): @@ -375,7 +420,7 @@ class PLCConfiguration: for tag in ['name', 'value', 'description']: if variable.has_key(tag): self._set_text_of_child(variable_element, tag, variable[tag]) - + if category_element.getElementsByTagName('variablelist'): variablelist_element = category_element.getElementsByTagName('variablelist')[0] else: @@ -396,7 +441,7 @@ class PLCConfiguration: (variable, category) when found (None, None) otherwise """ - + for (category_id, (category, variables)) in self._variables.iteritems(): for variable in variables.values(): (id, name, value, comments) = self._sanitize_variable(category_id, variable) @@ -530,7 +575,7 @@ class PLCConfiguration: for attribute in ['type']: if package.has_key(attribute): packagereq_element.setAttribute(attribute, package[attribute]) - + if group_element.getElementsByTagName('packagelist'): packagelist_element = group_element.getElementsByTagName('packagelist')[0] else: @@ -781,6 +826,35 @@ DO NOT EDIT. This file was automatically generated at return buf.getvalue() + def validate_type(self, variable_type, value): + + # ideally we should use the "validate_*" methods in PLCAPI or + # even declare some checks along with the default + # configuration (using RELAX NG?) but this shall work for now. + def ip_validator(val): + import socket + try: + socket.inet_aton(val) + return True + except: return False + + def email_validator(val): + return re.match('\A[a-zA-Z0-9._%+\-]+@[a-zA-Z0-9._\-]+\.[a-zA-Z]+\Z', val) + + def boolean_validator (val): + return val in ['true', 'false'] + + validators = { + 'email' : email_validator, + 'ip': ip_validator, + 'boolean': boolean_validator, + } + + # validate it if not a know type. + validator = validators.get(variable_type, lambda x: True) + return validator(value) + + # xml.dom.minidom.Text.writexml adds surrounding whitespace to textual # data when pretty-printing. Override this behavior. @@ -796,8 +870,497 @@ class TrimTextElement(xml.dom.minidom.Element): writer.write(newl) +#################### +# GLOBAL VARIABLES +# +g_configuration=None +usual_variables=None +config_dir=None +service=None + +def noop_validator(validated_variables): + pass + + +# historically we could also configure the devel pkg.... +def init_configuration (): + global g_configuration + global usual_variables, config_dir, service + + usual_variables=g_configuration["usual_variables"] + config_dir=g_configuration["config_dir"] + service=g_configuration["service"] + + global def_default_config, def_site_config, def_consolidated_config + def_default_config= "%s/default_config.xml" % config_dir + def_site_config = "%s/configs/site.xml" % config_dir + def_consolidated_config = "%s/%s_config.xml" % (config_dir, service) + + global mainloop_usage + mainloop_usage= """Available commands: + Uppercase versions give variables comments, when available + u/U\t\t\tEdit usual variables + w\t\t\tWrite + r\t\t\tRestart %(service)s service + R\t\t\tReload %(service)s service (rebuild config files for sh, python....) + q\t\t\tQuit (without saving) + h/?\t\t\tThis help +--- + l/L [|]\tShow Locally modified variables/values + s/S [|]\tShow variables/values (all, in category, single) + e/E [|]\tEdit variables (all, in category, single) +--- + c\t\t\tList categories + v/V [|]\tList Variables (all, in category, single) +--- +Typical usage involves: u, [l,] w, r, q +""" % globals() + +def usage (): + command_usage="%prog [options] [default-xml [site-xml [consolidated-xml]]]" + init_configuration () + command_usage +=""" +\t default-xml defaults to %s +\t site-xml defaults to %s +\t consolidated-xml defaults to %s""" % (def_default_config,def_site_config, def_consolidated_config) + return command_usage + +#################### +variable_usage= """Edit Commands : +#\tShow variable comments +.\tStops prompting, return to mainloop +/\tCleans any site-defined value, reverts to default +=\tShows default value +>\tSkips to next category +?\tThis help +""" + +#################### +def get_value (config, category_id, variable_id): + (category, variable) = config.get (category_id, variable_id) + return variable['value'] + +def get_type (config, category_id, variable_id): + (category, variable) = config.get (category_id, variable_id) + return variable['type'] + +def get_current_value (cread, cwrite, category_id, variable_id): + # the value stored in cwrite, if present, is the one we want + try: + result=get_value (cwrite,category_id,variable_id) + except: + result=get_value (cread,category_id,variable_id) + return result + +# refrain from using plc_config's _sanitize +def get_varname (config, category_id, variable_id): + (category, variable) = config.get (category_id, variable_id) + return (category_id+"_"+variable['id']).upper() + +# could not avoid using _sanitize here.. +def get_name_comments (config, cid, vid): + try: + (category, variable) = config.get (cid, vid) + (id, name, value, comments) = config._sanitize_variable (cid,variable) + return (name,comments) + except: + return (None,[]) + +def print_name_comments (config, cid, vid): + (name,comments)=get_name_comments(config,cid,vid) + if name: + print "### %s" % name + if comments: + for line in comments: + print "# %s" % line + else: + print "!!! No comment associated to %s_%s" % (cid,vid) + +#################### +def list_categories (config): + result=[] + for (category_id, (category, variables)) in config.variables().iteritems(): + result += [category_id] + return result + +def print_categories (config): + print "Known categories" + for cid in list_categories(config): + print "%s" % (cid.upper()) + +#################### +def list_category (config, cid): + result=[] + for (category_id, (category, variables)) in config.variables().iteritems(): + if (cid == category_id): + for variable in variables.values(): + result += ["%s_%s" %(cid,variable['id'])] + return result + +def print_category (config, cid, show_comments=True): + cid=cid.lower() + CID=cid.upper() + vids=list_category(config,cid) + if (len(vids) == 0): + print "%s : no such category"%CID + else: + print "Category %s contains" %(CID) + for vid in vids: + print vid.upper() + +#################### +def consolidate (default_config, site_config, consolidated_config): + global service + try: + conso = PLCConfiguration (default_config) + conso.load (site_config) + conso.save (consolidated_config) + except Exception, inst: + print "Could not consolidate, %s" % (str(inst)) + return + print ("Merged\n\t%s\nand\t%s\ninto\t%s"%(default_config,site_config, + consolidated_config)) + +def reload_service (): + global service + os.system("set -x ; systemctl reload %s" % service) + +#################### +def restart_service (): + global service + print ("==================== Stopping %s" % service) + os.system("systemctl stop %s" % service) + print ("==================== Starting %s" % service) + os.system("systemctl start %s" % service) + +#################### +def prompt_variable (cdef, cread, cwrite, category, variable, + show_comments, support_next=False): + + assert category.has_key('id') + assert variable.has_key('id') + + category_id = category ['id'] + variable_id = variable['id'] + + while True: + default_value = get_value(cdef,category_id,variable_id) + variable_type = get_type(cdef,category_id,variable_id) + current_value = get_current_value(cread,cwrite,category_id, variable_id) + varname = get_varname (cread,category_id, variable_id) + + if show_comments : + print_name_comments (cdef, category_id, variable_id) + prompt = "== %s : [%s] " % (varname,current_value) + try: + answer = raw_input(prompt).strip() + except EOFError : + raise Exception ('BailOut') + except KeyboardInterrupt: + print "\n" + raise Exception ('BailOut') + + # no change + if (answer == "") or (answer == current_value): + return None + elif (answer == "."): + raise Exception ('BailOut') + elif (answer == "#"): + print_name_comments(cread,category_id,variable_id) + elif (answer == "?"): + print variable_usage.strip() + elif (answer == "="): + print ("%s defaults to %s" %(varname,default_value)) + # revert to default : remove from cwrite (i.e. site-config) + elif (answer == "/"): + cwrite.delete(category_id,variable_id) + print ("%s reverted to %s" %(varname,default_value)) + return + elif (answer == ">"): + if support_next: + raise Exception ('NextCategory') + else: + print "No support for next category" + else: + if cdef.validate_type(variable_type, answer): + variable['value'] = answer + cwrite.set(category,variable) + return + else: + print "Not a valid value" + +def prompt_variables_all (cdef, cread, cwrite, show_comments): + try: + for (category_id, (category, variables)) in cread.variables().iteritems(): + print ("========== Category = %s" % category_id.upper()) + for variable in variables.values(): + try: + newvar = prompt_variable (cdef, cread, cwrite, category, variable, + show_comments, True) + except Exception, inst: + if (str(inst) == 'NextCategory'): break + else: raise + + except Exception, inst: + if (str(inst) == 'BailOut'): return + else: raise + +def prompt_variables_category (cdef, cread, cwrite, cid, show_comments): + cid=cid.lower() + CID=cid.upper() + try: + print ("========== Category = %s" % CID) + for vid in list_category(cdef,cid): + (category,variable) = cdef.locate_varname(vid.upper()) + newvar = prompt_variable (cdef, cread, cwrite, category, variable, + show_comments, False) + except Exception, inst: + if (str(inst) == 'BailOut'): return + else: raise + +#################### +def show_variable (cdef, cread, cwrite, + category, variable,show_value,show_comments): + assert category.has_key('id') + assert variable.has_key('id') + + category_id = category ['id'] + variable_id = variable['id'] + + default_value = get_value(cdef,category_id,variable_id) + current_value = get_current_value(cread,cwrite,category_id,variable_id) + varname = get_varname (cread,category_id, variable_id) + if show_comments : + print_name_comments (cdef, category_id, variable_id) + if show_value: + print "%s = %s" % (varname,current_value) + else: + print "%s" % (varname) + +def show_variables_all (cdef, cread, cwrite, show_value, show_comments): + for (category_id, (category, variables)) in cread.variables().iteritems(): + print ("========== Category = %s" % category_id.upper()) + for variable in variables.values(): + show_variable (cdef, cread, cwrite, + category, variable,show_value,show_comments) + +def show_variables_category (cdef, cread, cwrite, cid, show_value,show_comments): + cid=cid.lower() + CID=cid.upper() + print ("========== Category = %s" % CID) + for vid in list_category(cdef,cid): + (category,variable) = cdef.locate_varname(vid.upper()) + show_variable (cdef, cread, cwrite, category, variable, + show_value,show_comments) + +#################### +re_mainloop_0arg="^(?P[uUwrRqlLsSeEcvVhH\?])[ \t]*$" +re_mainloop_1arg="^(?P[sSeEvV])[ \t]+(?P\w+)$" +matcher_mainloop_0arg=re.compile(re_mainloop_0arg) +matcher_mainloop_1arg=re.compile(re_mainloop_1arg) + +def mainloop (cdef, cread, cwrite, default_config, site_config, consolidated_config): + global service + while True: + try: + answer = raw_input("Enter command (u for usual changes, w to save, ? for help) ").strip() + except EOFError: + answer ="" + except KeyboardInterrupt: + print "\nBye" + sys.exit() + + if (answer == "") or (answer in "?hH"): + print mainloop_usage + continue + groups_parse = matcher_mainloop_0arg.match(answer) + command=None + if (groups_parse): + command = groups_parse.group('command') + arg=None + else: + groups_parse = matcher_mainloop_1arg.match(answer) + if (groups_parse): + command = groups_parse.group('command') + arg=groups_parse.group('arg') + if not command: + print ("Unknown command >%s< -- use h for help" % answer) + continue + + show_comments=command.isupper() + + mode='ALL' + if arg: + mode=None + arg=arg.lower() + variables=list_category (cdef,arg) + if len(variables): + # category_id as the category name + # variables as the list of variable names + mode='CATEGORY' + category_id=arg + arg=arg.upper() + (category,variable)=cdef.locate_varname(arg) + if variable: + # category/variable as output by locate_varname + mode='VARIABLE' + if not mode: + print "%s: no such category or variable" % arg + continue + + if command in "qQ": + # todo check confirmation + return + elif command == "w": + try: + # Confirm that various constraints are met before saving file. + validate_variables = g_configuration.get('validate_variables',{}) + validated_variables = cwrite.verify(cdef, cread, validate_variables) + validator = g_configuration.get('validator',noop_validator) + validator(validated_variables) + cwrite.save(site_config) + except ConfigurationException, e: + print "Save failed due to a configuration exception: %s" % e + break; + except: + print traceback.print_exc() + print ("Could not save -- fix write access on %s" % site_config) + break + print ("Wrote %s" % site_config) + consolidate(default_config, site_config, consolidated_config) + print ("You might want to type 'r' (restart %s), 'R' (reload %s) or 'q' (quit)" % \ + (service, service)) + elif command in "uU": + global usual_variables + try: + for varname in usual_variables: + (category,variable) = cdef.locate_varname(varname) + if not (category is None and variable is None): + prompt_variable(cdef, cread, cwrite, category, variable, False) + except Exception, inst: + if (str(inst) != 'BailOut'): + raise + elif command == "r": + restart_service() + elif command == "R": + reload_service() + elif command == "c": + print_categories(cread) + elif command in "eE": + if mode == 'ALL': + prompt_variables_all(cdef, cread, cwrite,show_comments) + elif mode == 'CATEGORY': + prompt_variables_category(cdef,cread,cwrite,category_id,show_comments) + elif mode == 'VARIABLE': + try: + prompt_variable (cdef,cread,cwrite,category,variable, + show_comments,False) + except Exception, inst: + if str(inst) != 'BailOut': + raise + elif command in "vVsSlL": + show_value=(command in "sSlL") + (c1,c2,c3) = (cdef, cread, cwrite) + if command in "lL": + (c1,c2,c3) = (cwrite,cwrite,cwrite) + if mode == 'ALL': + show_variables_all(c1,c2,c3,show_value,show_comments) + elif mode == 'CATEGORY': + show_variables_category(c1,c2,c3,category_id,show_value,show_comments) + elif mode == 'VARIABLE': + show_variable (c1,c2,c3,category,variable,show_value,show_comments) + else: + print ("Unknown command >%s< -- use h for help" % answer) + +#################### +# creates directory for file if not yet existing +def check_dir (config_file): + dirname = os.path.dirname (config_file) + if (not os.path.exists (dirname)): + try: + os.makedirs(dirname,0755) + except OSError, e: + print "Cannot create dir %s due to %s - exiting" % (dirname,e) + sys.exit(1) + + if (not os.path.exists (dirname)): + print "Cannot create dir %s - exiting" % dirname + sys.exit(1) + else: + print "Created directory %s" % dirname + +#################### +def optParserSetup(configuration): + parser = OptionParser(usage=usage()) + parser.set_defaults(config_dir=configuration['config_dir'], + service=configuration['service'], + usual_variables=configuration['usual_variables']) + parser.add_option("","--configdir",dest="config_dir",help="specify configuration directory") + parser.add_option("","--service",dest="service",help="specify /etc/init.d style service name") + parser.add_option("","--usual_variable",dest="usual_variables",action="append", help="add a usual variable") + return parser + +def main(command,argv,configuration): + global g_configuration + g_configuration=configuration + + parser = optParserSetup(configuration) + (config,args) = parser.parse_args() + if len(args)>3: + parser.error("too many arguments") + + configuration['service']=config.service + configuration['usual_variables']=config.usual_variables + configuration['config_dir']=config.config_dir + # add in new usual_variables defined on the command line + for usual_variable in config.usual_variables: + if usual_variable not in configuration['usual_variables']: + configuration['usual_variables'].append(usual_variable) + + # intialize configuration + init_configuration() + + (default_config,site_config,consolidated_config) = (def_default_config, def_site_config, def_consolidated_config) + if len(args) >= 1: + default_config=args[0] + if len(args) >= 2: + site_config=args[1] + if len(args) == 3: + consolidated_config=args[2] + + for c in (default_config,site_config,consolidated_config): + check_dir (c) + + try: + # the default settings only - read only + cdef = PLCConfiguration(default_config) + + # in effect : default settings + local settings - read only + cread = PLCConfiguration(default_config) + + except ConfigurationException, e: + print ("Error %s in default config file %s" %(e,default_config)) + return 1 + except: + print traceback.print_exc() + print ("default config files %s not found, is myplc installed ?" % default_config) + return 1 + + + # local settings only, will be modified & saved + cwrite=PLCConfiguration() + + try: + cread.load(site_config) + cwrite.load(site_config) + except: + cwrite = PLCConfiguration() + + mainloop (cdef, cread, cwrite, default_config, site_config, consolidated_config) + return 0 + if __name__ == '__main__': import sys - if len(sys.argv) > 1 and sys.argv[1] in ['build', 'install']: + if len(sys.argv) > 1 and sys.argv[1] in ['build', 'install', 'uninstall']: from distutils.core import setup setup(py_modules=["plc_config"])