3 # Interactively prompts for variable values
4 # expected arguments are
5 # command -d [default-xml [custom-xml [ consolidated-xml ]]]
7 # we use 3 instances of PLCConfiguration throughout:
8 # cdef : models the defaults, from plc_default.xml
9 # cread : merged from plc_default & configs/site.xml
10 # cwrite : site.xml + pending changes
17 from optparse import OptionParser
19 from plc_config import PLCConfiguration
20 from plc_config import ConfigurationException
24 release_rev = "$Revision$"
29 def noop_validator(v):
32 def plc_validator(validated_variables):
33 maint_user = validated_variables["PLC_API_MAINTENANCE_USER"]
34 root_user = validated_variables["PLC_ROOT_USER"]
35 if maint_user == root_user:
36 raise ConfigurationException("PLC_API_MAINTENANCE_USER=%s cannot be the same as PLC_ROOT_USER=%s"%(maint_user,root_user))
38 flavours["plc"]={'service':"plc",
39 'usual_variables':["PLC_NAME",
45 "PLC_MAIL_SUPPORT_ADDRESS",
53 'config_dir':"/etc/planetlab",
54 'validate_variables':{"PLC_API":"MAINTENANCE_USER","PLC":"ROOT_USER"},
55 'validator':plc_validator,
58 defined_flavour = "plc"
60 # historically we could also configure the devel pkg....
61 def init_flavour (flavour):
62 global service, usual_variables
64 global defined_flavour
65 if flavours.has_key(flavour):
66 defined_flavour = flavour
68 defined_flavour = "plc"
70 flav=flavours.get(flavour,flavours["plc"])
71 service=flav["service"]
72 usual_variables=flav["usual_variables"]
73 config_dir=flav["config_dir"]
75 global def_default_config, def_site_config, def_consolidated_config
76 def_default_config= "%s/default_config.xml" % config_dir
77 def_site_config = "%s/configs/site.xml" % config_dir
78 def_consolidated_config = "%s/%s_config.xml" % (config_dir, service)
81 mainloop_usage= """Available commands:
82 Uppercase versions give variables comments, when available
83 u/U\t\t\tEdit usual variables
84 w/W\t\t\tWrite / Write & reload
85 r\t\t\tRestart %s service
86 q\t\t\tQuit (without saving)
89 l/L [<cat>|<var>]\tShow Locally modified variables/values
90 s/S [<cat>|<var>]\tShow variables/values (all, in category, single)
91 e/E [<cat>|<var>]\tEdit variables (all, in category, single)
93 c\t\t\tList categories
94 v/V [<cat>|<var>]List Variables (all, in category, single)
96 Typical usage involves: u, [l,] w, r, q
100 command_usage="%prog [options] [default-xml [site-xml [consolidated-xml]]]"
103 \t default-xml defaults to %s
104 \t site-xml defaults to %s
105 \t consolidated-xml defaults to %s""" % (def_default_config,def_site_config, def_consolidated_config)
109 variable_usage= """Edit Commands :
110 #\tShow variable comments
111 .\tStops prompting, return to mainloop
112 /\tCleans any site-defined value, reverts to default
113 =\tShows default value
114 >\tSkips to next category
119 def get_value (config, category_id, variable_id):
120 (category, variable) = config.get (category_id, variable_id)
121 return variable['value']
123 def get_current_value (cread, cwrite, category_id, variable_id):
124 # the value stored in cwrite, if present, is the one we want
126 result=get_value (cwrite,category_id,variable_id)
128 result=get_value (cread,category_id,variable_id)
131 # refrain from using plc_config's _sanitize
132 def get_varname (config, category_id, variable_id):
133 (category, variable) = config.get (category_id, variable_id)
134 return (category_id+"_"+variable['id']).upper()
136 # could not avoid using _sanitize here..
137 def get_name_comments (config, cid, vid):
139 (category, variable) = config.get (cid, vid)
140 (id, name, value, comments) = config._sanitize_variable (cid,variable)
141 return (name,comments)
145 def print_name_comments (config, cid, vid):
146 (name,comments)=get_name_comments(config,cid,vid)
148 print "### %s" % name
150 for line in comments:
153 print "!!! No comment associated to %s_%s" % (cid,vid)
156 def list_categories (config):
158 for (category_id, (category, variables)) in config.variables().iteritems():
159 result += [category_id]
162 def print_categories (config):
163 print "Known categories"
164 for cid in list_categories(config):
165 print "%s" % (cid.upper())
168 def list_category (config, cid):
170 for (category_id, (category, variables)) in config.variables().iteritems():
171 if (cid == category_id):
172 for variable in variables.values():
173 result += ["%s_%s" %(cid,variable['id'])]
176 def print_category (config, cid, show_comments=True):
179 vids=list_category(config,cid)
181 print "%s : no such category"%CID
183 print "Category %s contains" %(CID)
188 def consolidate (default_config, site_config, consolidated_config):
191 conso = PLCConfiguration (default_config)
192 conso.load (site_config)
193 conso.save (consolidated_config)
194 except Exception, inst:
195 print "Could not consolidate, %s" % (str(inst))
197 print ("Merged\n\t%s\nand\t%s\ninto\t%s"%(default_config,site_config,
198 consolidated_config))
200 def reload_service ():
202 os.system("set -x ; service %s reload" % service)
205 def restart_service ():
207 print ("==================== Stopping %s" % service)
208 os.system("service %s stop" % service)
209 print ("==================== Starting %s" % service)
210 os.system("service %s start" % service)
213 def prompt_variable (cdef, cread, cwrite, category, variable,
214 show_comments, support_next=False):
216 assert category.has_key('id')
217 assert variable.has_key('id')
219 category_id = category ['id']
220 variable_id = variable['id']
223 default_value = get_value(cdef,category_id,variable_id)
224 current_value = get_current_value(cread,cwrite,category_id, variable_id)
225 varname = get_varname (cread,category_id, variable_id)
228 print_name_comments (cdef, category_id, variable_id)
229 prompt = "== %s : [%s] " % (varname,current_value)
231 answer = raw_input(prompt).strip()
233 raise Exception ('BailOut')
234 except KeyboardInterrupt:
236 raise Exception ('BailOut')
239 if (answer == "") or (answer == current_value):
241 elif (answer == "."):
242 raise Exception ('BailOut')
243 elif (answer == "#"):
244 print_name_comments(cread,category_id,variable_id)
245 elif (answer == "?"):
246 print variable_usage.strip()
247 elif (answer == "="):
248 print ("%s defaults to %s" %(varname,default_value))
249 # revert to default : remove from cwrite (i.e. site-config)
250 elif (answer == "/"):
251 cwrite.delete(category_id,variable_id)
252 print ("%s reverted to %s" %(varname,default_value))
254 elif (answer == ">"):
256 raise Exception ('NextCategory')
258 print "No support for next category"
260 variable['value'] = answer
261 cwrite.set(category,variable)
264 def prompt_variables_all (cdef, cread, cwrite, show_comments):
266 for (category_id, (category, variables)) in cread.variables().iteritems():
267 print ("========== Category = %s" % category_id.upper())
268 for variable in variables.values():
270 newvar = prompt_variable (cdef, cread, cwrite, category, variable,
272 except Exception, inst:
273 if (str(inst) == 'NextCategory'): break
276 except Exception, inst:
277 if (str(inst) == 'BailOut'): return
280 def prompt_variables_category (cdef, cread, cwrite, cid, show_comments):
284 print ("========== Category = %s" % CID)
285 for vid in list_category(cdef,cid):
286 (category,variable) = cdef.locate_varname(vid.upper())
287 newvar = prompt_variable (cdef, cread, cwrite, category, variable,
288 show_comments, False)
289 except Exception, inst:
290 if (str(inst) == 'BailOut'): return
294 def show_variable (cdef, cread, cwrite,
295 category, variable,show_value,show_comments):
296 assert category.has_key('id')
297 assert variable.has_key('id')
299 category_id = category ['id']
300 variable_id = variable['id']
302 default_value = get_value(cdef,category_id,variable_id)
303 current_value = get_current_value(cread,cwrite,category_id,variable_id)
304 varname = get_varname (cread,category_id, variable_id)
306 print_name_comments (cdef, category_id, variable_id)
308 print "%s = %s" % (varname,current_value)
310 print "%s" % (varname)
312 def show_variables_all (cdef, cread, cwrite, show_value, show_comments):
313 for (category_id, (category, variables)) in cread.variables().iteritems():
314 print ("========== Category = %s" % category_id.upper())
315 for variable in variables.values():
316 show_variable (cdef, cread, cwrite,
317 category, variable,show_value,show_comments)
319 def show_variables_category (cdef, cread, cwrite, cid, show_value,show_comments):
322 print ("========== Category = %s" % CID)
323 for vid in list_category(cdef,cid):
324 (category,variable) = cdef.locate_varname(vid.upper())
325 show_variable (cdef, cread, cwrite, category, variable,
326 show_value,show_comments)
329 re_mainloop_0arg="^(?P<command>[uUwrRqlLsSeEcvVhH\?])[ \t]*$"
330 re_mainloop_1arg="^(?P<command>[sSeEvV])[ \t]+(?P<arg>\w+)$"
331 matcher_mainloop_0arg=re.compile(re_mainloop_0arg)
332 matcher_mainloop_1arg=re.compile(re_mainloop_1arg)
334 def mainloop (cdef, cread, cwrite, default_config, site_config, consolidated_config):
338 answer = raw_input("Enter command (u for usual changes, w to save, ? for help) ").strip()
341 except KeyboardInterrupt:
345 if (answer == "") or (answer in "?hH"):
348 groups_parse = matcher_mainloop_0arg.match(answer)
351 command = groups_parse.group('command')
354 groups_parse = matcher_mainloop_1arg.match(answer)
356 command = groups_parse.group('command')
357 arg=groups_parse.group('arg')
359 print ("Unknown command >%s< -- use h for help" % answer)
362 show_comments=command.isupper()
363 command=command.lower()
369 variables=list_category (cdef,arg)
371 # category_id as the category name
372 # variables as the list of variable names
376 (category,variable)=cdef.locate_varname(arg)
378 # category/variable as output by locate_varname
381 print "%s: no such category or variable" % arg
384 if (command in "qQ"):
385 # todo check confirmation
387 elif (command == "w"):
388 global defined_flavour
390 # Confirm that various constraints are met before saving file.
391 validate_variables = flavours[defined_flavour].get('validate_variables',{})
392 validated_variables = cwrite.verify(cdef, cread, validate_variables)
393 validator = flavours[defined_flavour].get('validator',noop_validator)
394 validator(validated_variables)
395 cwrite.save(site_config)
396 except ConfigurationException, e:
397 print "Save failed due to a configuration exception: %s" % e
400 print traceback.print_exc()
401 print ("Could not save -- fix write access on %s" % site_config)
403 print ("Wrote %s" % site_config)
404 consolidate(default_config, site_config, consolidated_config)
405 print ("You might want to type 'r' (restart %s), 'R' (reload %s) or 'q' (quit)" % \
407 elif (command == "u"):
409 for varname in usual_variables:
410 (category,variable) = cdef.locate_varname(varname)
411 prompt_variable(cdef, cread, cwrite, category, variable, False)
412 except Exception, inst:
413 if (str(inst) != 'BailOut'):
415 elif (command == "r"):
417 elif (command == "R"):
419 elif (command == "c"):
420 print_categories(cread)
421 elif (command in "eE"):
423 prompt_variables_all(cdef, cread, cwrite,show_comments)
424 elif mode == 'CATEGORY':
425 prompt_variables_category(cdef,cread,cwrite,category_id,show_comments)
426 elif mode == 'VARIABLE':
428 prompt_variable (cdef,cread,cwrite,category,variable,
430 except Exception, inst:
431 if (str(inst) != 'BailOut'):
433 elif (command in "vVsSlL"):
434 show_value=(command in "sSlL")
435 (c1,c2,c3) = (cdef, cread, cwrite)
436 if (command in "lL"):
437 (c1,c2,c3) = (cwrite,cwrite,cwrite)
439 show_variables_all(c1,c2,c3,show_value,show_comments)
440 elif mode == 'CATEGORY':
441 show_variables_category(c1,c2,c3,category_id,show_value,show_comments)
442 elif mode == 'VARIABLE':
443 show_variable (c1,c2,c3,category,variable,show_value,show_comments)
445 print ("Unknown command >%s< -- use h for help" % answer)
448 # creates directory for file if not yet existing
449 def check_dir (config_file):
450 dirname = os.path.dirname (config_file)
451 if (not os.path.exists (dirname)):
453 os.makedirs(dirname,0755)
455 print "Cannot create dir %s due to %s - exiting" % (dirname,e)
458 if (not os.path.exists (dirname)):
459 print "Cannot create dir %s - exiting" % dirname
462 print "Created directory %s" % dirname
470 parser = OptionParser(usage=usage(), version="%prog 1.0" + release_rev + release_url )
471 parser.set_defaults(flavour="plc",
472 config="flavour.config",
476 parser.add_option("","--configdir",dest="config_dir",help="specify configuration directory")
477 parser.add_option("","--service",dest="service",help="specify /etc/init.d style service name")
478 parser.add_option("","--usual_variable",dest="usual_variables",action="append", help="add a usual variable")
479 parser.add_option("","--flavour",dest="flavour", help="Sets the configuration flavour")
481 (config,args) = parser.parse_args()
483 parser.error("too many arguments")
485 if config.flavour not in flavours:
486 if config.service==None:
487 parser.error("unknown flavour '%s'" % config.flavour)
489 flavours[config.flavour]={}
490 flavour=flavours[config.flavour]
491 flavour['service']=config.service
492 flavour['usual_variables']=config.usual_variables
493 if config.config_dir==None:
494 flavour['config_dir']="/etc/%s"%config.service
496 flavour['config_dir']=config.config_dir
498 flavour=flavours[config.flavour]
500 # in case the config dir should be something other than /etc/planetlab
501 if config.config_dir <> None:
502 flavour['config_dir']=config.config_dir
504 # add in new usual_variables defined on the command line
505 for usual_variable in config.usual_variables:
506 if usual_variable not in flavour['usual_variables']:
507 flavour['usual_variables'].append(usual_variable)
510 init_flavour(config.flavour)
512 (default_config,site_config,consolidated_config) = (def_default_config, def_site_config, def_consolidated_config)
514 default_config=args[0]
518 consolidated_config=args[2]
520 for c in (default_config,site_config,consolidated_config):
524 # the default settings only - read only
525 cdef = PLCConfiguration(default_config)
527 # in effect : default settings + local settings - read only
528 cread = PLCConfiguration(default_config)
530 except ConfigurationException, e:
531 print ("Error %s in default config file %s" %(e,default_config))
534 print traceback.print_exc()
535 print ("default config files %s not found, is myplc installed ?" % default_config)
539 # local settings only, will be modified & saved
540 cwrite=PLCConfiguration()
543 cread.load(site_config)
544 cwrite.load(site_config)
546 cwrite = PLCConfiguration()
548 mainloop (cdef, cread, cwrite, default_config, site_config, consolidated_config)
551 if __name__ == '__main__':