3 # Copyright 2012 GRNET S.A. All rights reserved.
5 # Redistribution and use in source and binary forms, with or
6 # without modification, are permitted provided that the following
9 # 1. Redistributions of source code must retain the above
10 # copyright notice, this list of conditions and the following
13 # 2. Redistributions in binary form must reproduce the above
14 # copyright notice, this list of conditions and the following
15 # disclaimer in the documentation and/or other materials
16 # provided with the distribution.
18 # THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
19 # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21 # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
22 # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
25 # USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26 # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
28 # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 # POSSIBILITY OF SUCH DAMAGE.
31 # The views and conclusions contained in the software and
32 # documentation are those of the authors and should not be
33 # interpreted as representing official policies, either expressed
34 # or implied, of GRNET S.A.
40 from image_creator import __version__ as version
41 from image_creator.util import MD5
42 from image_creator.output.dialog import GaugeOutput, InfoBoxOutput
43 from image_creator.kamaki_wrapper import Kamaki, ClientError
44 from image_creator.help import get_help_file
45 from image_creator.dialog_util import SMALL_WIDTH, WIDTH, \
46 update_background_title, confirm_reset, confirm_exit, Reset, \
47 extract_image, extract_metadata_string
49 CONFIGURATION_TASKS = [
50 ("Partition table manipulation", ["FixPartitionTable"],
51 ["linux", "windows"]),
52 ("File system resize",
53 ["FilesystemResizeUnmounted", "FilesystemResizeMounted"],
54 ["linux", "windows"]),
55 ("Swap partition configuration", ["AddSwap"], ["linux"]),
56 ("SSH keys removal", ["DeleteSSHKeys"], ["linux"]),
57 ("Temporal RDP disabling", ["DisableRemoteDesktopConnections"],
59 ("SELinux relabeling at next boot", ["SELinuxAutorelabel"], ["linux"]),
60 ("Hostname/Computer Name assignment", ["AssignHostname"],
61 ["windows", "linux"]),
62 ("Password change", ["ChangePassword"], ["windows", "linux"]),
63 ("File injection", ["EnforcePersonality"], ["windows", "linux"])
67 class MetadataMonitor(object):
68 def __init__(self, session, meta):
69 self.session = session
74 for (k, v) in self.meta.items():
77 def __exit__(self, type, value, traceback):
78 d = self.session['dialog']
83 for (k, v) in self.meta.items():
86 elif self.old[k] != v:
89 if not (len(added) or len(altered)):
92 msg = "The last action has changed some image properties:\n\n"
94 msg += "New image properties:\n"
95 for (k, v) in added.items():
96 msg += ' %s: "%s"\n' % (k, v)
99 msg += "Updated image properties:\n"
100 for (k, v) in altered.items():
101 msg += ' %s: "%s" -> "%s"\n' % (k, self.old[k], v)
104 self.session['metadata'].update(added)
105 self.session['metadata'].update(altered)
106 d.msgbox(msg, title="Image Property Changes", width=SMALL_WIDTH)
109 def upload_image(session):
110 d = session["dialog"]
111 dev = session['device']
112 meta = session['metadata']
115 if "account" not in session:
116 d.msgbox("You need to provide your ~okeanos credentials before you "
117 "can upload images to pithos+", width=SMALL_WIDTH)
121 if 'upload' in session:
122 init = session['upload']
124 init = "%s.diskdump" % meta['OS']
127 (code, answer) = d.inputbox("Please provide a filename:", init=init,
130 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
133 filename = answer.strip()
134 if len(filename) == 0:
135 d.msgbox("Filename cannot be empty", width=SMALL_WIDTH)
137 session['upload'] = filename
140 gauge = GaugeOutput(d, "Image Upload", "Uploading...")
145 if 'checksum' not in session:
147 session['checksum'] = md5.compute(session['snapshot'], size)
149 kamaki = Kamaki(session['account'], out)
152 with open(session['snapshot'], 'rb') as f:
153 session["pithos_uri"] = \
154 kamaki.upload(f, size, filename,
155 "Calculating block hashes",
156 "Uploading missing blocks")
157 # Upload metadata file
158 out.output("Uploading metadata file...")
159 metastring = extract_metadata_string(session)
160 kamaki.upload(StringIO.StringIO(metastring),
161 size=len(metastring),
162 remote_path="%s.meta" % filename)
166 out.output("Uploading md5sum file...")
167 md5str = "%s %s\n" % (session['checksum'], filename)
168 kamaki.upload(StringIO.StringIO(md5str), size=len(md5str),
169 remote_path="%s.md5sum" % filename)
172 except ClientError as e:
173 d.msgbox("Error in pithos+ client: %s" % e.message,
174 title="Pithos+ Client Error", width=SMALL_WIDTH)
175 if 'pithos_uri' in session:
176 del session['pithos_uri']
183 d.msgbox("Image file `%s' was successfully uploaded to pithos+" % filename,
189 def register_image(session):
190 d = session["dialog"]
191 dev = session['device']
195 if "account" not in session:
196 d.msgbox("You need to provide your ~okeanos credentians before you "
197 "can register an images with cyclades",
201 if "pithos_uri" not in session:
202 d.msgbox("You need to upload the image to pithos+ before you can "
203 "register it with cyclades", width=SMALL_WIDTH)
207 (code, answer) = d.inputbox("Please provide a registration name:",
209 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
212 name = answer.strip()
214 d.msgbox("Registration name cannot be empty", width=SMALL_WIDTH)
217 ret = d.yesno("Make the image public?\\nA public image is accessible "
218 "by every user of the service.", defaultno=1,
220 if ret not in (0, 1):
223 is_public = True if ret == 0 else False
228 metadata.update(session['metadata'])
229 if 'task_metadata' in session:
230 for key in session['task_metadata']:
231 metadata[key] = 'yes'
233 img_type = "public" if is_public else "private"
234 gauge = GaugeOutput(d, "Image Registration", "Registering image...")
239 out.output("Registering %s image with Cyclades..." % img_type)
241 kamaki = Kamaki(session['account'], out)
242 kamaki.register(name, session['pithos_uri'], metadata,
245 except ClientError as e:
246 d.msgbox("Error in pithos+ client: %s" % e.message)
253 d.msgbox("%s image `%s' was successfully registered with Cyclades as `%s'"
254 % (img_type.title(), session['upload'], name), width=SMALL_WIDTH)
258 def kamaki_menu(session):
259 d = session['dialog']
260 default_item = "Account"
262 if 'account' not in session:
263 token = Kamaki.get_token()
265 session['account'] = Kamaki.get_account(token)
266 if not session['account']:
267 del session['account']
268 Kamaki.save_token('') # The token was not valid. Remove it
271 account = session["account"]['username'] if "account" in session else \
273 upload = session["upload"] if "upload" in session else "<none>"
275 choices = [("Account", "Change your ~okeanos account: %s" % account),
276 ("Upload", "Upload image to pithos+"),
277 ("Register", "Register the image to cyclades: %s" % upload)]
279 (code, choice) = d.menu(
280 text="Choose one of the following or press <Back> to go back.",
281 width=WIDTH, choices=choices, cancel="Back", height=13,
282 menu_height=5, default_item=default_item,
283 title="Image Registration Menu")
285 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
288 if choice == "Account":
289 default_item = "Account"
290 (code, answer) = d.inputbox(
291 "Please provide your ~okeanos authentication token:",
292 init=session["account"]['auth_token'] if "account" in session
293 else '', width=WIDTH)
294 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
296 if len(answer) == 0 and "account" in session:
297 del session["account"]
299 token = answer.strip()
300 session['account'] = Kamaki.get_account(token)
301 if session['account'] is not None:
302 Kamaki.save_token(token)
303 default_item = "Upload"
305 del session['account']
306 d.msgbox("The token you provided is not valid!",
308 elif choice == "Upload":
309 if upload_image(session):
310 default_item = "Register"
312 default_item = "Upload"
313 elif choice == "Register":
314 if register_image(session):
317 default_item = "Register"
320 def add_property(session):
321 d = session['dialog']
324 (code, answer) = d.inputbox("Please provide a name for a new image"
325 " property:", width=WIDTH)
326 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
329 name = answer.strip()
331 d.msgbox("A property name cannot be empty", width=SMALL_WIDTH)
337 (code, answer) = d.inputbox("Please provide a value for image "
338 "property %s" % name, width=WIDTH)
339 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
342 value = answer.strip()
344 d.msgbox("Value cannot be empty", width=SMALL_WIDTH)
349 session['metadata'][name] = value
354 def modify_properties(session):
355 d = session['dialog']
359 for (key, val) in session['metadata'].items():
360 choices.append((str(key), str(val)))
362 (code, choice) = d.menu(
363 "In this menu you can edit existing image properties or add new "
364 "ones. Be careful! Most properties have special meaning and "
365 "alter the image deployment behaviour. Press <HELP> to see more "
366 "information about image properties. Press <BACK> when done.",
367 height=18, width=WIDTH, choices=choices, menu_height=10,
368 ok_label="Edit", extra_button=1, extra_label="Add", cancel="Back",
369 help_button=1, title="Image Properties")
371 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
374 elif code == d.DIALOG_OK:
375 (code, answer) = d.inputbox("Please provide a new value for the "
376 "image property with name `%s':" %
378 init=session['metadata'][choice],
380 if code not in (d.DIALOG_CANCEL, d.DIALOG_ESC):
381 value = answer.strip()
383 d.msgbox("Value cannot be empty!")
386 session['metadata'][choice] = value
388 elif code == d.DIALOG_EXTRA:
389 add_property(session)
391 help_file = get_help_file("image_properties")
392 assert os.path.exists(help_file)
393 d.textbox(help_file, title="Image Properties", width=70, height=40)
396 def delete_properties(session):
397 d = session['dialog']
400 for (key, val) in session['metadata'].items():
401 choices.append((key, "%s" % val, 0))
403 (code, to_delete) = d.checklist("Choose which properties to delete:",
404 choices=choices, width=WIDTH)
406 # If the user exits with ESC or CANCEL, the returned tag list is empty.
408 del session['metadata'][i]
412 d.msgbox("%d image properties were deleted." % cnt, width=SMALL_WIDTH)
418 def exclude_tasks(session):
419 d = session['dialog']
425 if 'excluded_tasks' not in session:
426 session['excluded_tasks'] = []
428 if -1 in session['excluded_tasks']:
429 if not d.yesno("Image deployment configuration is disabled. "
430 "Do you wish to enable it?", width=SMALL_WIDTH):
431 session['excluded_tasks'].remove(-1)
435 for (msg, task, osfamily) in CONFIGURATION_TASKS:
436 if session['metadata']['OSFAMILY'] in osfamily:
437 checked = 1 if index in session['excluded_tasks'] else 0
438 choices.append((str(displayed_index), msg, checked))
439 mapping[displayed_index] = index
444 (code, tags) = d.checklist(
445 text="Please choose which configuration tasks you would like to "
446 "prevent from running during image deployment. "
447 "Press <No Config> to supress any configuration. "
448 "Press <Help> for more help on the image deployment "
449 "configuration tasks.",
450 choices=choices, height=19, list_height=8, width=WIDTH,
451 help_button=1, extra_button=1, extra_label="No Config",
452 title="Exclude Configuration Tasks")
454 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
456 elif code == d.DIALOG_HELP:
457 help_file = get_help_file("configuration_tasks")
458 assert os.path.exists(help_file)
459 d.textbox(help_file, title="Configuration Tasks",
462 elif code == d.DIALOG_EXTRA:
463 session['excluded_tasks'] = [-1]
464 session['task_metadata'] = ["EXCLUDE_ALL_TASKS"]
466 elif code == d.DIALOG_OK:
467 session['excluded_tasks'] = []
469 session['excluded_tasks'].append(mapping[int(tag)])
471 exclude_metadata = []
472 for task in session['excluded_tasks']:
473 exclude_metadata.extend(CONFIGURATION_TASKS[task][1])
475 session['task_metadata'] = map(lambda x: "EXCLUDE_TASK_%s" % x,
482 def sysprep(session):
483 d = session['dialog']
484 image_os = session['image_os']
486 # Is the image already shrinked?
487 if 'shrinked' in session and session['shrinked']:
488 msg = "It seems you have shrinked the image. Running system " \
489 "preparation tasks on a shrinked image is dangerous."
491 if d.yesno("%s\n\nDo you really want to continue?" % msg,
492 width=SMALL_WIDTH, defaultno=1):
495 wrapper = textwrap.TextWrapper(width=WIDTH - 5)
497 help_title = "System Preperation Tasks"
498 sysprep_help = "%s\n%s\n\n" % (help_title, '=' * len(help_title))
500 if 'exec_syspreps' not in session:
501 session['exec_syspreps'] = []
503 all_syspreps = image_os.list_syspreps()
504 # Only give the user the choice between syspreps that have not ran yet
505 syspreps = [s for s in all_syspreps if s not in session['exec_syspreps']]
507 if len(syspreps) == 0:
508 d.msgbox("No system preparation task available to run!",
509 title="System Preperation", width=SMALL_WIDTH)
515 for sysprep in syspreps:
516 name, descr = image_os.sysprep_info(sysprep)
517 display_name = name.replace('-', ' ').capitalize()
518 sysprep_help += "%s\n" % display_name
519 sysprep_help += "%s\n" % ('-' * len(display_name))
520 sysprep_help += "%s\n\n" % wrapper.fill(" ".join(descr.split()))
521 enabled = 1 if sysprep.enabled else 0
522 choices.append((str(index + 1), display_name, enabled))
525 (code, tags) = d.checklist(
526 "Please choose which system preparation tasks you would like to "
527 "run on the image. Press <Help> to see details about the system "
528 "preparation tasks.", title="Run system preparation tasks",
529 choices=choices, width=70, ok_label="Run", help_button=1)
531 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
533 elif code == d.DIALOG_HELP:
534 d.scrollbox(sysprep_help, width=WIDTH)
535 elif code == d.DIALOG_OK:
536 # Enable selected syspreps and disable the rest
537 for i in range(len(syspreps)):
538 if str(i + 1) in tags:
539 image_os.enable_sysprep(syspreps[i])
540 session['exec_syspreps'].append(syspreps[i])
542 image_os.disable_sysprep(syspreps[i])
544 infobox = InfoBoxOutput(d, "Image Configuration")
546 dev = session['device']
549 dev.mount(readonly=False)
551 # The checksum is invalid. We have mounted the image rw
552 if 'checksum' in session:
553 del session['checksum']
555 # Monitor the metadata changes during syspreps
556 with MetadataMonitor(session, image_os.meta):
557 image_os.do_sysprep()
560 # Disable syspreps that have ran
561 for sysprep in session['exec_syspreps']:
562 image_os.disable_sysprep(sysprep)
566 dev.out.remove(infobox)
574 d = session['dialog']
575 dev = session['device']
577 shrinked = 'shrinked' in session and session['shrinked']
580 d.msgbox("The image is already shrinked!", title="Image Shrinking",
584 msg = "This operation will shrink the last partition of the image to " \
585 "reduce the total image size. If the last partition is a swap " \
586 "partition, then this partition is removed and the partition " \
587 "before that is shrinked. The removed swap partition will be " \
588 "recreated during image deployment."
590 if not d.yesno("%s\n\nDo you want to continue?" % msg, width=WIDTH,
591 height=12, title="Image Shrinking"):
592 with MetadataMonitor(session, dev.meta):
593 infobox = InfoBoxOutput(d, "Image Shrinking", height=4)
599 dev.out.remove(infobox)
601 session['shrinked'] = True
602 update_background_title(session)
609 def customization_menu(session):
610 d = session['dialog']
612 choices = [("Sysprep", "Run various image preparation tasks"),
613 ("Shrink", "Shrink image"),
614 ("View/Modify", "View/Modify image properties"),
615 ("Delete", "Delete image properties"),
616 ("Exclude", "Exclude various deployment tasks from running")]
620 actions = {"Sysprep": sysprep,
622 "View/Modify": modify_properties,
623 "Delete": delete_properties,
624 "Exclude": exclude_tasks}
626 (code, choice) = d.menu(
627 text="Choose one of the following or press <Back> to exit.",
628 width=WIDTH, choices=choices, cancel="Back", height=13,
629 menu_height=len(choices), default_item=choices[default_item][0],
630 title="Image Customization Menu")
632 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
634 elif choice in actions:
635 default_item = [entry[0] for entry in choices].index(choice)
636 if actions[choice](session):
637 default_item = (default_item + 1) % len(choices)
640 def main_menu(session):
641 d = session['dialog']
643 update_background_title(session)
645 choices = [("Customize", "Customize image & ~okeanos deployment options"),
646 ("Register", "Register image to ~okeanos"),
647 ("Extract", "Dump image to local file system"),
648 ("Reset", "Reset everything and start over again"),
649 ("Help", "Get help for using snf-image-creator")]
651 default_item = "Customize"
653 actions = {"Customize": customization_menu, "Register": kamaki_menu,
654 "Extract": extract_image}
656 (code, choice) = d.menu(
657 text="Choose one of the following or press <Exit> to exit.",
658 width=WIDTH, choices=choices, cancel="Exit", height=13,
659 default_item=default_item, menu_height=len(choices),
660 title="Image Creator for ~okeanos (snf-image-creator version %s)" %
663 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
666 elif choice == "Reset":
668 d.infobox("Resetting snf-image-creator. Please wait...",
671 elif choice == "Help":
672 d.msgbox("For help, check the online documentation:\n\nhttp://www"
673 ".synnefo.org/docs/snf-image-creator/latest/",
674 width=WIDTH, title="Help")
675 elif choice in actions:
676 actions[choice](session)
678 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :