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
96 Options: an optional array of keywords. Currently supported are
101 When the user's role is not admin, the provided directory *must* be under
105 Whenever needed, the method stores intermediate files in a
106 private area, typically not located under the web server's
107 accessible area, and are cleaned up by the method.
111 roles = ['admin', 'pi', 'tech']
115 Mixed(Node.fields['node_id'],
116 Node.fields['hostname']),
117 Parameter (str, "Action mode, expected in " + "|".join(boot_medium_actions)),
118 Parameter (str, "Empty string for verbatim result, resulting file full path otherwise"),
119 Parameter ([str], "Options"),
122 returns = Parameter(str, "Node boot medium, either inlined, or filename, depending to the filename parameter")
124 BOOTCDDIR = "/usr/share/bootcd/"
125 BOOTCDBUILD = "/usr/share/bootcd/build.sh"
126 GENERICDIR = "/var/www/html/download/"
127 NODEDIR = "/var/tmp/bootmedium/results"
128 WORKDIR = "/var/tmp/bootmedium/work"
130 # uncomment this to preserve temporary area and bootcustom logs
133 ### returns (host, domain) :
134 # 'host' : host part of the hostname
135 # 'domain' : domain part of the hostname
136 def split_hostname (self, node):
137 # Split hostname into host and domain parts
138 parts = node['hostname'].split(".", 1)
140 raise PLCInvalidArgument, "Node hostname %s is invalid"%node['hostname']
144 def floppy_contents (self, node, renew_key):
146 if node['peer_id'] is not None:
147 raise PLCInvalidArgument, "Not a local node"
149 # If we are not an admin, make sure that the caller is a
150 # member of the site at which the node is located.
151 if 'admin' not in self.caller['roles']:
152 if node['site_id'] not in self.caller['site_ids']:
153 raise PLCPermissionDenied, "Not allowed to generate a configuration file for %s"%node['hostname']
155 # Get node networks for this node
157 nodenetworks = NodeNetworks(self.api, node['nodenetwork_ids'])
158 for nodenetwork in nodenetworks:
159 if nodenetwork['is_primary']:
160 primary = nodenetwork
163 raise PLCInvalidArgument, "No primary network configured on %s"%node['hostname']
165 ( host, domain ) = self.split_hostname (node)
168 # Generate 32 random bytes
169 bytes = random.sample(xrange(0, 256), 32)
170 # Base64 encode their string representation
171 node['key'] = base64.b64encode("".join(map(chr, bytes)))
172 # XXX Boot Manager cannot handle = in the key
173 node['key'] = node['key'].replace("=", "")
177 # Generate node configuration file suitable for BootCD
181 file += 'NODE_ID="%d"\n' % node['node_id']
182 file += 'NODE_KEY="%s"\n' % node['key']
185 file += 'NET_DEVICE="%s"\n' % primary['mac'].lower()
187 file += 'IP_METHOD="%s"\n' % primary['method']
189 if primary['method'] == 'static':
190 file += 'IP_ADDRESS="%s"\n' % primary['ip']
191 file += 'IP_GATEWAY="%s"\n' % primary['gateway']
192 file += 'IP_NETMASK="%s"\n' % primary['netmask']
193 file += 'IP_NETADDR="%s"\n' % primary['network']
194 file += 'IP_BROADCASTADDR="%s"\n' % primary['broadcast']
195 file += 'IP_DNS1="%s"\n' % primary['dns1']
196 file += 'IP_DNS2="%s"\n' % (primary['dns2'] or "")
198 file += 'HOST_NAME="%s"\n' % host
199 file += 'DOMAIN_NAME="%s"\n' % domain
201 # define various nodenetwork settings attached to the primary nodenetwork
202 settings = NodeNetworkSettings (self.api, {'nodenetwork_id':nodenetwork['nodenetwork_id']})
205 for setting in settings:
206 if setting['category'] is not None:
207 categories.add(setting['category'])
209 for category in categories:
210 category_settings = NodeNetworkSettings(self.api,{'nodenetwork_id':nodenetwork['nodenetwork_id'],
211 'category':category})
212 if category_settings:
213 file += '### Category : %s\n'%category
214 for setting in category_settings:
215 file += '%s_%s="%s"\n'%(category.upper(),setting['name'].upper(),setting['value'])
217 for nodenetwork in nodenetworks:
218 if nodenetwork['method'] == 'ipmi':
219 file += 'IPMI_ADDRESS="%s"\n' % nodenetwork['ip']
220 if nodenetwork['mac']:
221 file += 'IPMI_MAC="%s"\n' % nodenetwork['mac'].lower()
226 def bootcd_version (self):
228 f = open (self.BOOTCDDIR + "/build/version.txt")
229 version=f.readline().strip()
234 def cleandir (self,tempdir):
236 os.system("rm -rf %s"%tempdir)
238 def call(self, auth, node_id_or_hostname, action, filename, options = []):
241 if action not in boot_medium_actions:
242 raise PLCInvalidArgument, "Unknown action %s"%action
244 ### compute file suffix and type
245 if action.find("-iso") >= 0 :
248 elif action.find("-usb") >= 0:
256 if 'serial' in options:
257 suffix = "-serial" + suffix
258 type.insert(1, "serial")
259 if 'cramfs' in options:
260 suffix = "-cramfs" + suffix
261 # XXX must be the same index as above
262 type.insert(1, "cramfs")
263 type = "_".join(type)
265 ### compute a 8 bytes random number
266 tempbytes = random.sample (xrange(0,256), 8);
268 return chr((c>>4)+65) + chr ((c&16)+65)
269 temp = "".join(map(hexa2,tempbytes))
271 ### check node if needed
272 if action.find("node-") == 0:
273 nodes = Nodes(self.api, [node_id_or_hostname])
275 raise PLCInvalidArgument, "No such node %r"%node_id_or_hostname
277 nodename = node['hostname']
284 filename = filename.replace ("%d",self.NODEDIR)
285 filename = filename.replace ("%n",nodename)
286 filename = filename.replace ("%s",suffix)
287 filename = filename.replace ("%p",self.api.config.PLC_NAME)
288 # only if filename contains "%v", bootcd is maybe not avail ?
289 if filename.find("%v") >=0:
290 filename = filename.replace ("%v",self.bootcd_version())
292 ### Check filename location
294 if 'admin' not in self.caller['roles']:
295 if ( filename.index(self.NODEDIR) != 0):
296 raise PLCInvalidArgument, "File %s not under %s"%(filename,self.NODEDIR)
298 ### output should not exist (concurrent runs ..)
299 if os.path.exists(filename):
300 raise PLCInvalidArgument, "Resulting file %s already exists"%filename
302 ### we can now safely create the file,
303 ### either we are admin or under a controlled location
304 if not os.path.exists(os.path.dirname(filename)):
306 os.makedirs (os.path.dirname(filename),0777)
308 raise PLCPermissionDenied, "Could not create dir %s"%os.path.dirname(filename)
312 if action == 'generic-iso' or action == 'generic-usb':
313 # this raises an exception if bootcd is missing
314 version = self.bootcd_version()
315 generic_name = "%s-BootCD-%s%s"%(self.api.config.PLC_NAME,
318 generic_path = "%s/%s" % (self.GENERICDIR,generic_name)
321 ret=os.system ("cp %s %s"%(generic_path,filename))
325 raise PLCPermissionDenied, "Could not copy %s into"%(generic_path,filename)
327 ### return the generic medium content as-is, just base64 encoded
328 return base64.b64encode(file(generic_path).read())
331 if action == 'node-preview':
332 floppy = self.floppy_contents (node,False)
335 file(filename,'w').write(floppy)
337 raise PLCPermissionDenied, "Could not write into %s"%filename
342 if action == 'node-floppy':
343 floppy = self.floppy_contents (node,True)
346 file(filename,'w').write(floppy)
348 raise PLCPermissionDenied, "Could not write into %s"%filename
353 ### we're left with node-iso and node-usb
354 if action == 'node-iso' or action == 'node-usb':
356 ### check we've got required material
357 version = self.bootcd_version()
359 if not os.path.isfile(self.BOOTCDBUILD):
360 raise PLCAPIError, "Cannot locate bootcd/build.sh script %s"%self.BOOTCDBUILD
362 # need a temporary area
363 tempdir = "%s/%s"%(self.WORKDIR,nodename)
364 if not os.path.isdir(tempdir):
366 os.makedirs(tempdir,0777)
368 raise PLCPermissionDenied, "Could not create dir %s"%tempdir
371 # generate floppy config
372 floppy = self.floppy_contents(node,True)
374 node_floppy = "%s/%s"%(tempdir,nodename)
376 file(node_floppy,"w").write(floppy)
378 raise PLCPermissionDenied, "Could not write into %s"%node_floppy
380 node_image = "%s/%s"%(tempdir,nodename)
382 build_command = '%s -f "%s" -O "%s" -t "%s" &> %s.log' % (self.BOOTCDBUILD,
388 print 'build command:',build_command
389 ret=os.system(build_command)
391 raise PLCPermissionDenied,"build.sh failed to create node-specific medium"
394 if not os.path.isfile (node_image):
395 raise PLCAPIError,"Unexpected location of build.sh output - %s"%node_image
399 ret=os.system("mv %s %s"%(node_image,filename))
401 raise PLCAPIError, "Could not move node image %s into %s"%(node_image,filename)
402 self.cleandir(tempdir)
405 result = file(node_image).read()
406 self.cleandir(tempdir)
407 return base64.b64encode(result)
409 self.cleandir(tempdir)
412 # we're done here, or we missed something
413 raise PLCAPIError,'Unhandled action %s'%action