oops
[plcapi.git] / PLC / Methods / GetBootMedium.py
index bc4c64d..c4e89d4 100644 (file)
@@ -3,6 +3,7 @@ import random
 import base64
 import os
 import os.path
+import time
 
 from PLC.Faults import *
 from PLC.Method import Method
@@ -10,8 +11,9 @@ from PLC.Parameter import Parameter, Mixed
 from PLC.Auth import Auth
 
 from PLC.Nodes import Node, Nodes
-from PLC.NodeNetworks import NodeNetwork, NodeNetworks
-from PLC.NodeNetworkSettings import NodeNetworkSetting, NodeNetworkSettings
+from PLC.Interfaces import Interface, Interfaces
+from PLC.InterfaceSettings import InterfaceSetting, InterfaceSettings
+from PLC.NodeTags import NodeTags
 
 # could not define this in the class..
 boot_medium_actions = [ 'node-preview',
@@ -22,6 +24,18 @@ boot_medium_actions = [ 'node-preview',
                         'generic-usb',
                         ]
 
+# compute a new key
+# xxx used by GetDummyBoxMedium
+def compute_key():
+    # Generate 32 random bytes
+    bytes = random.sample(xrange(0, 256), 32)
+    # Base64 encode their string representation
+    key = base64.b64encode("".join(map(chr, bytes)))
+    # Boot Manager cannot handle = in the key
+    # XXX this sounds wrong, as it might prevent proper decoding
+    key = key.replace("=", "")
+    return key
+
 class GetBootMedium(Method):
     """
     This method is a redesign based on former, supposedly dedicated, 
@@ -66,16 +80,21 @@ class GetBootMedium(Method):
         - %s : a file suffix appropriate in the context (.txt, .iso or the like)
         - %v : the bootcd version string (e.g. 4.0)
         - %p : the PLC name
+        - %f : the nodefamily
+        - %a : arch
         With the file-based return mechanism, the method returns the full pathname 
         of the result file; 
         ** WARNING **
         It is the caller's responsability to remove this file after use.
 
-    Options: an optional array of keywords. Currently supported are
-        - 'serial'
+    Options: an optional array of keywords. 
+        options are not supported for generic images
+    Currently supported are
+        - 'partition' - for USB actions only
         - 'cramfs'
-        - 'console:<console_spec>'
-        console_spec is passed as-is to bootcd/build.sh
+        - 'serial' or 'serial:<console_spec>'
+        - 'no-hangcheck'
+        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
@@ -104,9 +123,9 @@ class GetBootMedium(Method):
 
     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/"
+    BOOTCDDIR = "/usr/share/bootcd-@NODEFAMILY@/"
+    BOOTCDBUILD = "/usr/share/bootcd-@NODEFAMILY@/build.sh"
+    GENERICDIR = "/var/www/html/download-@NODEFAMILY@/"
     WORKDIR = "/var/tmp/bootmedium"
     DEBUG = False
     # uncomment this to preserve temporary area and bootcustom logs
@@ -136,10 +155,10 @@ class GetBootMedium(Method):
 
         # Get node networks for this node
         primary = None
-        nodenetworks = NodeNetworks(self.api, node['nodenetwork_ids'])
-        for nodenetwork in nodenetworks:
-            if nodenetwork['is_primary']:
-                primary = nodenetwork
+        interfaces = Interfaces(self.api, node['interface_ids'])
+        for interface in interfaces:
+            if interface['is_primary']:
+                primary = interface
                 break
         if primary is None:
             raise PLCInvalidArgument, "No primary network configured on %s"%node['hostname']
@@ -147,12 +166,7 @@ class GetBootMedium(Method):
         ( host, domain ) = self.split_hostname (node)
 
         if renew_key:
-            # Generate 32 random bytes
-            bytes = random.sample(xrange(0, 256), 32)
-            # Base64 encode their string representation
-            node['key'] = base64.b64encode("".join(map(chr, bytes)))
-            # XXX Boot Manager cannot handle = in the key
-            node['key'] = node['key'].replace("=", "")
+            node['key'] = compute_key()
             # Save it
             node.sync()
 
@@ -162,6 +176,8 @@ class GetBootMedium(Method):
         if renew_key:
             file += 'NODE_ID="%d"\n' % node['node_id']
             file += 'NODE_KEY="%s"\n' % node['key']
+            # not used anywhere, just a note for operations people
+            file += 'KEY_RENEWAL_DATE="%s"\n' % time.strftime('%Y-%m-%d at %H:%M:%S +0000',time.gmtime())
 
         if primary['mac']:
             file += 'NET_DEVICE="%s"\n' % primary['mac'].lower()
@@ -180,8 +196,8 @@ class GetBootMedium(Method):
         file += 'HOST_NAME="%s"\n' % host
         file += 'DOMAIN_NAME="%s"\n' % domain
 
-        # define various nodenetwork settings attached to the primary nodenetwork
-        settings = NodeNetworkSettings (self.api, {'nodenetwork_id':nodenetwork['nodenetwork_id']})
+        # define various interface settings attached to the primary interface
+        settings = InterfaceSettings (self.api, {'interface_id':interface['interface_id']})
 
         categories = set()
         for setting in settings:
@@ -189,29 +205,52 @@ class GetBootMedium(Method):
                 categories.add(setting['category'])
         
         for category in categories:
-            category_settings = NodeNetworkSettings(self.api,{'nodenetwork_id':nodenetwork['nodenetwork_id'],
+            category_settings = InterfaceSettings(self.api,{'interface_id':interface['interface_id'],
                                                               'category':category})
             if category_settings:
                 file += '### Category : %s\n'%category
                 for setting in category_settings:
                     file += '%s_%s="%s"\n'%(category.upper(),setting['name'].upper(),setting['value'])
 
-        for nodenetwork in nodenetworks:
-            if nodenetwork['method'] == 'ipmi':
-                file += 'IPMI_ADDRESS="%s"\n' % nodenetwork['ip']
-                if nodenetwork['mac']:
-                    file += 'IPMI_MAC="%s"\n' % nodenetwork['mac'].lower()
+        for interface in interfaces:
+            if interface['method'] == 'ipmi':
+                file += 'IPMI_ADDRESS="%s"\n' % interface['ip']
+                if interface['mac']:
+                    file += 'IPMI_MAC="%s"\n' % interface['mac'].lower()
                 break
 
         return file
 
+    # see also InstallBootstrapFS in bootmanager that does similar things
+    def get_nodefamily (self, node):
+        # get defaults from the myplc build
+        try:
+            (pldistro,arch) = file("/etc/planetlab/nodefamily").read().strip().split("-")
+        except:
+            (pldistro,arch) = ("planetlab","i386")
+            
+        # with no valid argument, return system-wide defaults
+        if not node:
+            return (pldistro,arch)
+
+        node_id=node['node_id']
+        # cannot use accessors in the API itself
+        # the 'arch' tag type is assumed to exist, see db-config
+        arch_tags = NodeTags (self.api, {'tagname':'arch','node_id':node_id},['tagvalue'])
+        if arch_tags:
+            arch=arch_tags[0]['tagvalue']
+        # ditto
+        pldistro_tags = NodeTags (self.api, {'tagname':'pldistro','node_id':node_id},['tagvalue'])
+        if pldistro_tags:
+            pldistro=pldistro_tags[0]['tagvalue']
+
+        return (pldistro,arch)
+
     def bootcd_version (self):
         try:
-            f = open (self.BOOTCDDIR + "/build/version.txt")
-            version=f.readline().strip()
-        finally:
-            f.close()
-        return version
+            return file(self.BOOTCDDIR + "/build/version.txt").readline().strip()
+        except:
+            raise Exception,"Unknown boot cd version - probably wrong bootcd dir : %s"%self.BOOTCDDIR
     
     def cleantrash (self):
         for file in self.trash:
@@ -230,29 +269,37 @@ 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 "txt" not in type:
-            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)
-
-        ### compute a 8 bytes random number
-        tempbytes = random.sample (xrange(0,256), 8);
-        def hexa2 (c):
-            return chr((c>>4)+65) + chr ((c&16)+65)
-        temp = "".join(map(hexa2,tempbytes))
+            type = "txt"
+
+        # handle / caconicalize options
+        if type == "txt":
+            if options:
+                raise PLCInvalidArgument, "Options are not supported for node configs"
+        else:
+            # create a dict for build.sh 
+            build_sh_spec={'-k':[]}
+            for option in options:
+                if option == "cramfs":
+                    build_sh_spec['cramfs']=True
+                elif option == 'partition':
+                    if type != "usb":
+                        raise PLCInvalidArgument, "option 'partition' is for USB images only"
+                    else:
+                        type="usb_partition"
+                elif option == "serial":
+                    build_sh_spec['serial']='default'
+                elif option.find("serial:") == 0:
+                    build_sh_spec['serial']=option.replace("serial:","")
+                elif option == "no-hangcheck":
+                    build_sh_spec['-k'].append('hangcheck_reboot=0')
+                else:
+                    raise PLCInvalidArgument, "unknown option %s"%option
 
         ### check node if needed
         if action.find("node-") == 0:
@@ -261,19 +308,35 @@ class GetBootMedium(Method):
                 raise PLCInvalidArgument, "No such node %r"%node_id_or_hostname
             node = nodes[0]
             nodename = node['hostname']
-            
+
         else:
             node = None
-            nodename = temp
+            # compute a 8 bytes random number
+            tempbytes = random.sample (xrange(0,256), 8);
+            def hexa2 (c): return chr((c>>4)+65) + chr ((c&16)+65)
+            nodename = "".join(map(hexa2,tempbytes))
+
+        # get nodefamily
+        (pldistro,arch) = self.get_nodefamily(node)
+        self.nodefamily="%s-%s"%(pldistro,arch)
+        # apply on globals
+        for attr in [ "BOOTCDDIR", "BOOTCDBUILD", "GENERICDIR" ]:
+            setattr(self,attr,getattr(self,attr).replace("@NODEFAMILY@",self.nodefamily))
             
         ### handle filename
+        # allow to set filename to None or any other empty value
+        if not filename: filename=''
         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)
-        # only if filename contains "%v", bootcd is maybe not avail ?
-        if filename.find("%v") >=0:
-            filename = filename.replace ("%v",self.bootcd_version())
+        # let's be cautious
+        try: filename = filename.replace ("%f", self.nodefamily)
+        except: pass
+        try: filename = filename.replace ("%a", arch)
+        except: pass
+        try: filename = filename.replace ("%v",self.bootcd_version())
+        except: pass
 
         ### Check filename location
         if filename != '':
@@ -287,15 +350,20 @@ class GetBootMedium(Method):
 
             ### we can now safely create the file, 
             ### either we are admin or under a controlled location
-            if not os.path.exists(os.path.dirname(filename)):
-                try:
-                    os.makedirs (os.path.dirname(filename),0777)
-                except:
-                    raise PLCPermissionDenied, "Could not create dir %s"%os.path.dirname(filename)
+            filedir=os.path.dirname(filename)
+            # dirname does not return "." for a local filename like its shell counterpart
+            if filedir:
+                if not os.path.exists(filedir):
+                    try:
+                        os.makedirs (filedir,0777)
+                    except:
+                        raise PLCPermissionDenied, "Could not create dir %s"%filedir
 
         
         ### 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,
@@ -355,29 +423,34 @@ class GetBootMedium(Method):
 
                 self.trash.append(floppy_file)
 
-                node_image = "%s/%s"%(self.WORKDIR,nodename)
+                node_image = "%s/%s%s"%(self.WORKDIR,nodename,suffix)
+
+                # make build's arguments
+                build_sh_options=""
+                if "cramfs" in build_sh_spec: 
+                    type += "_cramfs"
+                if "serial" in build_sh_spec: 
+                    build_sh_options += " -s %s"%build_sh_spec['serial']
+                
+                for k_option in build_sh_spec['-k']:
+                    build_sh_options += " -k %s"%k_option
 
-                # handle console
-                serial_arg=""
-                for option in options:
-                    console=option.replace("console:","")
-                    if option != console:
-                        serial_arg="-s %s"%console
+                log_file="%s.log"%node_image
                 # invoke build.sh
-                build_command = '%s -f "%s" -O "%s" -t "%s" %s &> %s.log' % (self.BOOTCDBUILD,
-                                                                             floppy_file,
-                                                                             node_image,
-                                                                             type,
-                                                                             serial_arg,
-                                                                             node_image)
+                build_command = '%s -f "%s" -o "%s" -t "%s" %s &> %s' % (self.BOOTCDBUILD,
+                                                                         floppy_file,
+                                                                         node_image,
+                                                                         type,
+                                                                         build_sh_options,
+                                                                         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())
 
-                self.trash.append("%s.log"%node_image)
-                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