X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;ds=sidebyside;f=PLC%2FMethods%2FGetBootMedium.py;h=4997478258a0e7eb5ef6dacdcd9a00f96d0c1976;hb=d27348bcbc24d51e78933eafc13ed1f986991179;hp=db60dca33bef8176517c28b98e8ea2181822300c;hpb=0a07df398e39869b86c733c474dd09d8a246c5aa;p=plcapi.git diff --git a/PLC/Methods/GetBootMedium.py b/PLC/Methods/GetBootMedium.py index db60dca..4997478 100644 --- a/PLC/Methods/GetBootMedium.py +++ b/PLC/Methods/GetBootMedium.py @@ -1,3 +1,4 @@ +# $Id$ import random import base64 import os @@ -12,28 +13,6 @@ from PLC.Nodes import Node, Nodes from PLC.NodeNetworks import NodeNetwork, NodeNetworks from PLC.NodeNetworkSettings import NodeNetworkSetting, NodeNetworkSettings -# -# xxx todo -# Thierry on june 5 2007 -# -# it turns out that having either apache (when invoked through xmlrpc) -# or root (when running plcsh directly) run this piece of code is -# problematic. In fact although we try to create intermediate dirs -# with mode 777, what happens is that root's umask in the plc chroot -# jail is set to 0022. -# -# the bottom line is, depending on who (apache or root) runs this for -# the first time, we can access denied issued (when root comes first) -# so probably we'd better implement a scheme where files are stored -# directly under /var/tmp or something -# -# in addition the sequels of a former run (e.g. with a non-empty -# filename) can prevent subsequent runs if the file is not properly -# cleaned up after use, which is generally the case if someone invokes -# this through plcsh and does not clean up -# so maybe a dedicated cleanup method could be useful just in case -# - # could not define this in the class.. boot_medium_actions = [ 'node-preview', 'node-floppy', @@ -50,7 +29,7 @@ class GetBootMedium(Method): As compared with its ancestor, this method provides a much more detailed detailed interface, that allows to - (*) either just preview the node config file (in which case + (*) either just preview the node config file -- in which case the node key is NOT recomputed, and NOT provided in the output (*) or regenerate the node config file for storage on a floppy that is, exactly what the ancestor method used todo, @@ -70,8 +49,6 @@ class GetBootMedium(Method): Apart for the preview mode, this method generates a new node key for the specified node, effectively invalidating any old boot medium. - Non-admins can only generate files for nodes at their sites. - In addition, two return mechanisms are supported. (*) The default behaviour is that the file's content is returned as a base64-encoded string. This is how the ancestor method used to work. @@ -90,14 +67,26 @@ class GetBootMedium(Method): - %v : the bootcd version string (e.g. 4.0) - %p : the PLC name With the file-based return mechanism, the method returns the full pathname - of the result file; it is the caller's responsability to remove - this file after use. - - Security: - When the user's role is not admin, the provided directory *must* be under - the %d area - - Housekeeping: + of the result file; + ** WARNING ** + It is the caller's responsability to remove this file after use. + + Options: an optional array of keywords. + options are not supported for generic images + Currently supported are + - 'partition' - for USB actions only + - 'cramfs' + - 'serial' or 'serial:' + console_spec (or 'default') is passed as-is to bootcd/build.sh + it is expected to be a colon separated string denoting + tty - baudrate - parity - bits + e.g. ttyS0:115200:n:8 + + Security: + - Non-admins can only generate files for nodes at their sites. + - Non-admins, when they provide a filename, *must* specify it in the %d area + + Housekeeping: Whenever needed, the method stores intermediate files in a private area, typically not located under the web server's accessible area, and are cleaned up by the method. @@ -115,13 +104,12 @@ class GetBootMedium(Method): Parameter ([str], "Options"), ] - returns = Parameter(str, "Node boot medium, either inlined, or filename, depending to the filename parameter") + returns = Parameter(str, "Node boot medium, either inlined, or filename, depending on the filename parameter") BOOTCDDIR = "/usr/share/bootcd/" BOOTCDBUILD = "/usr/share/bootcd/build.sh" GENERICDIR = "/var/www/html/download/" - NODEDIR = "/var/tmp/bootmedium/results" - WORKDIR = "/var/tmp/bootmedium/work" + WORKDIR = "/var/tmp/bootmedium" DEBUG = False # uncomment this to preserve temporary area and bootcustom logs #DEBUG = True @@ -226,13 +214,17 @@ class GetBootMedium(Method): finally: f.close() return version - - def cleandir (self,tempdir): - if not self.DEBUG: - os.system("rm -rf %s"%tempdir) + + def cleantrash (self): + for file in self.trash: + if self.DEBUG: + print 'DEBUG -- preserving',file + else: + os.unlink(file) def call(self, auth, node_id_or_hostname, action, filename, options = []): + self.trash=[] ### check action if action not in boot_medium_actions: raise PLCInvalidArgument, "Unknown action %s"%action @@ -240,23 +232,35 @@ class GetBootMedium(Method): ### compute file suffix and type if action.find("-iso") >= 0 : suffix=".iso" - type = ["iso"] + type = "iso" elif action.find("-usb") >= 0: suffix=".usb" - type = ["usb"] + type = "usb" else: suffix=".txt" - type = ["txt"] - - if type != "txt": - if 'serial' in options: - suffix = "-serial" + suffix - type.insert(1, "serial") - if 'cramfs' in options: - suffix = "-cramfs" + suffix - # XXX must be the same index as above - type.insert(1, "cramfs") - type = "_".join(type) + type = "txt" + + # handle / caconicalize options + if type is "txt": + if options: + raise PLCInvalidArgument, "Options are not supported for node configs" + else: + # create a dict for build.sh + optdict={} + for option in options: + if option is "cramfs": + optdict['cramfs']=True + elif option is 'partition': + if type is not "usb": + raise PLCInvalidArgument, "option 'partition' is for USB images only" + else: + type="usb_partition" + elif option is "serial": + optdict['serial']='default' + elif option.find("serial:") == 0: + optdict['serial']=option.replace("serial:","") + else: + raise PLCInvalidArgument, "unknown option %s"%option ### compute a 8 bytes random number tempbytes = random.sample (xrange(0,256), 8); @@ -277,7 +281,7 @@ class GetBootMedium(Method): nodename = temp ### handle filename - filename = filename.replace ("%d",self.NODEDIR) + filename = filename.replace ("%d",self.WORKDIR) filename = filename.replace ("%n",nodename) filename = filename.replace ("%s",suffix) filename = filename.replace ("%p",self.api.config.PLC_NAME) @@ -288,8 +292,8 @@ class GetBootMedium(Method): ### Check filename location if filename != '': if 'admin' not in self.caller['roles']: - if ( filename.index(self.NODEDIR) != 0): - raise PLCInvalidArgument, "File %s not under %s"%(filename,self.NODEDIR) + if ( filename.index(self.WORKDIR) != 0): + raise PLCInvalidArgument, "File %s not under %s"%(filename,self.WORKDIR) ### output should not exist (concurrent runs ..) if os.path.exists(filename): @@ -306,6 +310,8 @@ class GetBootMedium(Method): ### generic media if action == 'generic-iso' or action == 'generic-usb': + if options: + raise PLCInvalidArgument, "Options are not supported for generic images" # this raises an exception if bootcd is missing version = self.bootcd_version() generic_name = "%s-BootCD-%s%s"%(self.api.config.PLC_NAME, @@ -323,28 +329,18 @@ class GetBootMedium(Method): ### return the generic medium content as-is, just base64 encoded return base64.b64encode(file(generic_path).read()) - ### floppy preview - if action == 'node-preview': - floppy = self.floppy_contents (node,False) - if filename: - try: - file(filename,'w').write(floppy) - except: - raise PLCPermissionDenied, "Could not write into %s"%filename - return filename - else: - return floppy - - if action == 'node-floppy': - floppy = self.floppy_contents (node,True) - if filename: - try: - file(filename,'w').write(floppy) - except: - raise PLCPermissionDenied, "Could not write into %s"%filename - return filename - else: - return floppy + ### config file preview or regenerated + if action == 'node-preview' or action == 'node-floppy': + renew_key = (action == 'node-floppy') + floppy = self.floppy_contents (node,renew_key) + if filename: + try: + file(filename,'w').write(floppy) + except: + raise PLCPermissionDenied, "Could not write into %s"%filename + return filename + else: + return floppy ### we're left with node-iso and node-usb if action == 'node-iso' or action == 'node-usb': @@ -355,54 +351,67 @@ class GetBootMedium(Method): if not os.path.isfile(self.BOOTCDBUILD): raise PLCAPIError, "Cannot locate bootcd/build.sh script %s"%self.BOOTCDBUILD - # need a temporary area - tempdir = "%s/%s"%(self.WORKDIR,nodename) - if not os.path.isdir(tempdir): + # create the workdir if needed + if not os.path.isdir(self.WORKDIR): try: - os.makedirs(tempdir,0777) + os.makedirs(self.WORKDIR,0777) + os.chmod(self.WORKDIR,0777) except: - raise PLCPermissionDenied, "Could not create dir %s"%tempdir + raise PLCPermissionDenied, "Could not create dir %s"%self.WORKDIR try: # generate floppy config - floppy = self.floppy_contents(node,True) + floppy_text = self.floppy_contents(node,True) # store it - node_floppy = "%s/%s"%(tempdir,nodename) + floppy_file = "%s/%s.txt"%(self.WORKDIR,nodename) try: - file(node_floppy,"w").write(floppy) + file(floppy_file,"w").write(floppy_text) except: - raise PLCPermissionDenied, "Could not write into %s"%node_floppy + raise PLCPermissionDenied, "Could not write into %s"%floppy_file + + self.trash.append(floppy_file) + + node_image = "%s/%s%s"%(self.WORKDIR,nodename,suffix) - node_image = "%s/%s"%(tempdir,nodename) + # make build's arguments + serial_arg="" + if "cramfs" in optdict: type += "_cramfs" + if "serial" in optdict: serial_arg = "-s %s"%optdict['serial'] + log_file="%s.log"%node_image # invoke build.sh - build_command = '%s -f "%s" -O "%s" -t "%s" &> %s.log' % (self.BOOTCDBUILD, - node_floppy, - node_image, - type, - node_image) + build_command = '%s -f "%s" -o "%s" -t "%s" %s &> %s' % (self.BOOTCDBUILD, + floppy_file, + node_image, + type, + serial_arg, + log_file) if self.DEBUG: print 'build command:',build_command ret=os.system(build_command) if ret != 0: - raise PLCPermissionDenied,"build.sh failed to create node-specific medium" + raise PLCAPIError,"bootcd/build.sh failed\n%s\n%s"%( + build_command,file(log_file).read()) - node_image += suffix + self.trash.append(log_file) if not os.path.isfile (node_image): raise PLCAPIError,"Unexpected location of build.sh output - %s"%node_image - # cache result + # handle result if filename: ret=os.system("mv %s %s"%(node_image,filename)) if ret != 0: + self.trash.append(node_image) + self.cleantrash() raise PLCAPIError, "Could not move node image %s into %s"%(node_image,filename) - self.cleandir(tempdir) + self.cleantrash() return filename else: result = file(node_image).read() - self.cleandir(tempdir) + self.trash.append(node_image) + self.cleantrash() return base64.b64encode(result) except: - self.cleandir(tempdir) + self.cleantrash() raise # we're done here, or we missed something