6 from PLC.Faults import *
7 from PLC.Method import Method
8 from PLC.Parameter import Parameter, Mixed
9 from PLC.Auth import Auth
11 from PLC.Nodes import Node, Nodes
12 from PLC.NodeNetworks import NodeNetwork, NodeNetworks
13 from PLC.NodeNetworkSettings import NodeNetworkSetting, NodeNetworkSettings
17 # Thierry on june 5 2007
19 # it turns out that having either apache (when invoked through xmlrpc)
20 # or root (when running plcsh directly) run this piece of code is
21 # problematic. In fact although we try to create intermediate dirs
22 # with mode 777, what happens is that root's umask in the plc chroot
23 # jail is set to 0022.
25 # the bottom line is, depending on who (apache or root) runs this for
26 # the first time, we can access denied issued (when root comes first)
27 # so probably we'd better implement a scheme where files are stored
28 # directly under /var/tmp or something
30 # in addition the sequels of a former run (e.g. with a non-empty
31 # filename) can prevent subsequent runs if the file is not properly
32 # cleaned up after use, which is generally the case if someone invokes
33 # this through plcsh and does not clean up
34 # so maybe a dedicated cleanup method could be useful just in case
37 # could not define this in the class..
38 boot_medium_actions = [ 'node-preview',
46 class GetBootMedium(Method):
48 This method is a redesign based on former, supposedly dedicated,
49 AdmGenerateNodeConfFile
51 As compared with its ancestor, this method provides a much more detailed
52 detailed interface, that allows to
53 (*) either just preview the node config file (in which case
54 the node key is NOT recomputed, and NOT provided in the output
55 (*) or regenerate the node config file for storage on a floppy
56 that is, exactly what the ancestor method used todo,
57 including renewing the node's key
58 (*) or regenerate the config file and bundle it inside an ISO or USB image
59 (*) or just provide the generic ISO or USB boot images
60 in which case of course the node_id_or_hostname parameter is not used
62 action is expected among the following string constants
70 Apart for the preview mode, this method generates a new node key for the
71 specified node, effectively invalidating any old boot medium.
73 Non-admins can only generate files for nodes at their sites.
75 In addition, two return mechanisms are supported.
76 (*) The default behaviour is that the file's content is returned as a
77 base64-encoded string. This is how the ancestor method used to work.
78 To use this method, pass an empty string as the file parameter.
80 (*) Or, for efficiency -- this makes sense only when the API is used
81 by the web pages that run on the same host -- the caller may provide
82 a filename, in which case the resulting file is stored in that location instead.
83 The filename argument can use the following markers, that are expanded
85 - %d : default root dir (some builtin dedicated area under /var/tmp/)
86 Using this is recommended, and enforced for non-admin users
87 - %n : the node's name when this makes sense, or a mktemp-like name when
88 generic media is requested
89 - %s : a file suffix appropriate in the context (.txt, .iso or the like)
90 - %v : the bootcd version string (e.g. 4.0)
92 With the file-based return mechanism, the method returns the full pathname
93 of the result file; it is the caller's responsability to remove
97 When the user's role is not admin, the provided directory *must* be under
101 Whenever needed, the method stores intermediate files in a
102 private area, typically not located under the web server's
103 accessible area, and are cleaned up by the method.
107 roles = ['admin', 'pi', 'tech']
111 Mixed(Node.fields['node_id'],
112 Node.fields['hostname']),
113 Parameter (str, "Action mode, expected in " + "|".join(boot_medium_actions)),
114 Parameter (str, "Empty string for verbatim result, resulting file full path otherwise"),
117 returns = Parameter(str, "Node boot medium, either inlined, or filename, depending to the filename parameter")
119 BOOTCDDIR = "/usr/share/bootcd/"
120 BOOTCUSTOM = "/usr/share/bootcd/bootcustom.sh"
121 GENERICDIR = "/var/www/html/download/"
122 NODEDIR = "/var/tmp/bootmedium/results"
123 WORKDIR = "/var/tmp/bootmedium/work"
125 # uncomment this to preserve temporary area and bootcustom logs
128 ### returns (host, domain) :
129 # 'host' : host part of the hostname
130 # 'domain' : domain part of the hostname
131 def split_hostname (self, node):
132 # Split hostname into host and domain parts
133 parts = node['hostname'].split(".", 1)
135 raise PLCInvalidArgument, "Node hostname %s is invalid"%node['hostname']
139 def floppy_contents (self, node, renew_key):
141 if node['peer_id'] is not None:
142 raise PLCInvalidArgument, "Not a local node"
144 # If we are not an admin, make sure that the caller is a
145 # member of the site at which the node is located.
146 if 'admin' not in self.caller['roles']:
147 if node['site_id'] not in self.caller['site_ids']:
148 raise PLCPermissionDenied, "Not allowed to generate a configuration file for %s"%node['hostname']
150 # Get node networks for this node
152 nodenetworks = NodeNetworks(self.api, node['nodenetwork_ids'])
153 for nodenetwork in nodenetworks:
154 if nodenetwork['is_primary']:
155 primary = nodenetwork
158 raise PLCInvalidArgument, "No primary network configured on %s"%node['hostname']
160 ( host, domain ) = self.split_hostname (node)
163 # Generate 32 random bytes
164 bytes = random.sample(xrange(0, 256), 32)
165 # Base64 encode their string representation
166 node['key'] = base64.b64encode("".join(map(chr, bytes)))
167 # XXX Boot Manager cannot handle = in the key
168 node['key'] = node['key'].replace("=", "")
172 # Generate node configuration file suitable for BootCD
176 file += 'NODE_ID="%d"\n' % node['node_id']
177 file += 'NODE_KEY="%s"\n' % node['key']
180 file += 'NET_DEVICE="%s"\n' % primary['mac'].lower()
182 file += 'IP_METHOD="%s"\n' % primary['method']
184 if primary['method'] == 'static':
185 file += 'IP_ADDRESS="%s"\n' % primary['ip']
186 file += 'IP_GATEWAY="%s"\n' % primary['gateway']
187 file += 'IP_NETMASK="%s"\n' % primary['netmask']
188 file += 'IP_NETADDR="%s"\n' % primary['network']
189 file += 'IP_BROADCASTADDR="%s"\n' % primary['broadcast']
190 file += 'IP_DNS1="%s"\n' % primary['dns1']
191 file += 'IP_DNS2="%s"\n' % (primary['dns2'] or "")
193 file += 'HOST_NAME="%s"\n' % host
194 file += 'DOMAIN_NAME="%s"\n' % domain
196 # define various nodenetwork settings attached to the primary nodenetwork
197 settings = NodeNetworkSettings (self.api, {'nodenetwork_id':nodenetwork['nodenetwork_id']})
200 for setting in settings:
201 if setting['category'] is not None:
202 categories.add(setting['category'])
204 for category in categories:
205 category_settings = NodeNetworkSettings(self.api,{'nodenetwork_id':nodenetwork['nodenetwork_id'],
206 'category':category})
207 if category_settings:
208 file += '### Category : %s\n'%category
209 for setting in category_settings:
210 file += '%s_%s="%s"\n'%(category.upper(),setting['name'].upper(),setting['value'])
212 for nodenetwork in nodenetworks:
213 if nodenetwork['method'] == 'ipmi':
214 file += 'IPMI_ADDRESS="%s"\n' % nodenetwork['ip']
215 if nodenetwork['mac']:
216 file += 'IPMI_MAC="%s"\n' % nodenetwork['mac'].lower()
221 def bootcd_version (self):
223 f = open (self.BOOTCDDIR + "/build/version.txt")
224 version=f.readline().strip()
229 def cleandir (self,tempdir):
231 os.system("rm -rf %s"%tempdir)
233 def call(self, auth, node_id_or_hostname, action, filename):
236 if action not in boot_medium_actions:
237 raise PLCInvalidArgument, "Unknown action %s"%action
239 ### compute file suffix
240 if action.find("-iso") >= 0 :
242 elif action.find("-usb") >= 0:
247 ### compute a 8 bytes random number
248 tempbytes = random.sample (xrange(0,256), 8);
250 return chr((c>>4)+65) + chr ((c&16)+65)
251 temp = "".join(map(hexa2,tempbytes))
253 ### check node if needed
254 if action.find("node-") == 0:
255 nodes = Nodes(self.api, [node_id_or_hostname])
257 raise PLCInvalidArgument, "No such node %r"%node_id_or_hostname
259 nodename = node['hostname']
266 filename = filename.replace ("%d",self.NODEDIR)
267 filename = filename.replace ("%n",nodename)
268 filename = filename.replace ("%s",suffix)
269 filename = filename.replace ("%p",self.api.config.PLC_NAME)
270 # only if filename contains "%v", bootcd is maybe not avail ?
271 if filename.find("%v") >=0:
272 filename = filename.replace ("%v",self.bootcd_version())
274 ### Check filename location
276 if 'admin' not in self.caller['roles']:
277 if ( filename.index(self.NODEDIR) != 0):
278 raise PLCInvalidArgument, "File %s not under %s"%(filename,self.NODEDIR)
280 ### output should not exist (concurrent runs ..)
281 if os.path.exists(filename):
282 raise PLCInvalidArgument, "Resulting file %s already exists"%filename
284 ### we can now safely create the file,
285 ### either we are admin or under a controlled location
286 if not os.path.exists(os.path.dirname(filename)):
288 os.makedirs (os.path.dirname(filename),0777)
290 raise PLCPermissionDenied, "Could not create dir %s"%os.path.dirname(filename)
294 if action == 'generic-iso' or action == 'generic-usb':
295 # this raises an exception if bootcd is missing
296 version = self.bootcd_version()
297 generic_name = "%s-BootCD-%s%s"%(self.api.config.PLC_NAME,
300 generic_path = "%s/%s" % (self.GENERICDIR,generic_name)
303 ret=os.system ("cp %s %s"%(generic_path,filename))
307 raise PLCPermissionDenied, "Could not copy %s into"%(generic_path,filename)
309 ### return the generic medium content as-is, just base64 encoded
310 return base64.b64encode(file(generic_path).read())
313 if action == 'node-preview':
314 floppy = self.floppy_contents (node,False)
317 file(filename,'w').write(floppy)
319 raise PLCPermissionDenied, "Could not write into %s"%filename
324 if action == 'node-floppy':
325 floppy = self.floppy_contents (node,True)
328 file(filename,'w').write(floppy)
330 raise PLCPermissionDenied, "Could not write into %s"%filename
335 ### we're left with node-iso and node-usb
336 if action == 'node-iso' or action == 'node-usb':
338 ### check we've got required material
339 version = self.bootcd_version()
340 generic_name = "%s-BootCD-%s%s"%(self.api.config.PLC_NAME,
343 generic_path = "%s/%s" % (self.GENERICDIR,generic_name)
344 if not os.path.isfile(generic_path):
345 raise PLCAPIError, "Cannot locate generic medium %s"%generic_path
347 if not os.path.isfile(self.BOOTCUSTOM):
348 raise PLCAPIError, "Cannot locate bootcustom script %s"%self.BOOTCUSTOM
350 # need a temporary area
351 tempdir = "%s/%s"%(self.WORKDIR,nodename)
352 if not os.path.isdir(tempdir):
354 os.makedirs(tempdir,0777)
356 raise PLCPermissionDenied, "Could not create dir %s"%tempdir
359 # generate floppy config
360 floppy = self.floppy_contents(node,True)
362 node_floppy = "%s/%s"%(tempdir,nodename)
364 file(node_floppy,"w").write(floppy)
366 raise PLCPermissionDenied, "Could not write into %s"%node_floppy
369 bootcustom_command = 'sudo %s -C "%s" "%s" "%s"'%(self.BOOTCUSTOM,
374 print 'bootcustom command:',bootcustom_command
375 ret=os.system(bootcustom_command)
377 raise PLCPermissionDenied,"bootcustom.sh failed to create node-specific medium"
379 node_image = "%s/%s%s"%(tempdir,nodename,suffix)
380 if not os.path.isfile (node_image):
381 raise PLCAPIError,"Unexpected location of bootcustom output - %s"%node_image
385 ret=os.system("mv %s %s"%(node_image,filename))
387 raise PLCAPIError, "Could not move node image %s into %s"%(node_image,filename)
388 self.cleandir(tempdir)
391 result = file(node_image).read()
392 self.cleandir(tempdir)
393 return base64.b64encode(result)
395 self.cleandir(tempdir)
398 # we're done here, or we missed something
399 raise PLCAPIError,'Unhandled action %s'%action