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 """Monitors image metadata chages"""
69 def __init__(self, session, meta):
70 self.session = session
75 for (k, v) in self.meta.items():
78 def __exit__(self, type, value, traceback):
79 d = self.session['dialog']
84 for (k, v) in self.meta.items():
87 elif self.old[k] != v:
90 if not (len(added) or len(altered)):
93 msg = "The last action has changed some image properties:\n\n"
95 msg += "New image properties:\n"
96 for (k, v) in added.items():
97 msg += ' %s: "%s"\n' % (k, v)
100 msg += "Updated image properties:\n"
101 for (k, v) in altered.items():
102 msg += ' %s: "%s" -> "%s"\n' % (k, self.old[k], v)
105 self.session['metadata'].update(added)
106 self.session['metadata'].update(altered)
107 d.msgbox(msg, title="Image Property Changes", width=SMALL_WIDTH)
110 def upload_image(session):
111 """Upload the image to pithos+"""
112 d = session["dialog"]
113 image = session['image']
114 meta = session['metadata']
117 if "account" not in session:
118 d.msgbox("You need to provide your ~okeanos credentials before you "
119 "can upload images to pithos+", width=SMALL_WIDTH)
123 if 'upload' in session:
124 init = session['upload']
126 init = "%s.diskdump" % meta['OS']
129 (code, answer) = d.inputbox("Please provide a filename:", init=init,
132 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
135 filename = answer.strip()
136 if len(filename) == 0:
137 d.msgbox("Filename cannot be empty", width=SMALL_WIDTH)
139 session['upload'] = filename
142 gauge = GaugeOutput(d, "Image Upload", "Uploading...")
147 if 'checksum' not in session:
149 session['checksum'] = md5.compute(image.device, size)
151 kamaki = Kamaki(session['account'], out)
154 with open(image.device, 'rb') as f:
155 session["pithos_uri"] = \
156 kamaki.upload(f, size, filename,
157 "Calculating block hashes",
158 "Uploading missing blocks")
159 # Upload metadata file
160 out.output("Uploading metadata file...")
161 metastring = extract_metadata_string(session)
162 kamaki.upload(StringIO.StringIO(metastring),
163 size=len(metastring),
164 remote_path="%s.meta" % filename)
168 out.output("Uploading md5sum file...")
169 md5str = "%s %s\n" % (session['checksum'], filename)
170 kamaki.upload(StringIO.StringIO(md5str), size=len(md5str),
171 remote_path="%s.md5sum" % filename)
174 except ClientError as e:
175 d.msgbox("Error in pithos+ client: %s" % e.message,
176 title="Pithos+ Client Error", width=SMALL_WIDTH)
177 if 'pithos_uri' in session:
178 del session['pithos_uri']
185 d.msgbox("Image file `%s' was successfully uploaded to pithos+" % filename,
191 def register_image(session):
192 """Register image with cyclades"""
193 d = session["dialog"]
197 if "account" not in session:
198 d.msgbox("You need to provide your ~okeanos credentians before you "
199 "can register an images with cyclades", width=SMALL_WIDTH)
202 if "pithos_uri" not in session:
203 d.msgbox("You need to upload the image to pithos+ before you can "
204 "register it with cyclades", width=SMALL_WIDTH)
208 (code, answer) = d.inputbox("Please provide a registration name:",
210 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
213 name = answer.strip()
215 d.msgbox("Registration name cannot be empty", width=SMALL_WIDTH)
218 ret = d.yesno("Make the image public?\\nA public image is accessible "
219 "by every user of the service.", defaultno=1,
221 if ret not in (0, 1):
224 is_public = True if ret == 0 else False
229 metadata.update(session['metadata'])
230 if 'task_metadata' in session:
231 for key in session['task_metadata']:
232 metadata[key] = 'yes'
234 img_type = "public" if is_public else "private"
235 gauge = GaugeOutput(d, "Image Registration", "Registering image...")
237 out = session['image'].out
240 out.output("Registering %s image with Cyclades..." % img_type)
242 kamaki = Kamaki(session['account'], out)
243 kamaki.register(name, session['pithos_uri'], metadata,
246 except ClientError as e:
247 d.msgbox("Error in pithos+ client: %s" % e.message)
254 d.msgbox("%s image `%s' was successfully registered with Cyclades as `%s'"
255 % (img_type.title(), session['upload'], name), width=SMALL_WIDTH)
259 def kamaki_menu(session):
260 """Show kamaki related actions"""
261 d = session['dialog']
262 default_item = "Account"
264 if 'account' not in session:
265 token = Kamaki.get_token()
267 session['account'] = Kamaki.get_account(token)
268 if not session['account']:
269 del session['account']
270 Kamaki.save_token('') # The token was not valid. Remove it
273 account = session["account"]['username'] if "account" in session else \
275 upload = session["upload"] if "upload" in session else "<none>"
277 choices = [("Account", "Change your ~okeanos account: %s" % account),
278 ("Upload", "Upload image to pithos+"),
279 ("Register", "Register the image to cyclades: %s" % upload)]
281 (code, choice) = d.menu(
282 text="Choose one of the following or press <Back> to go back.",
283 width=WIDTH, choices=choices, cancel="Back", height=13,
284 menu_height=5, default_item=default_item,
285 title="Image Registration Menu")
287 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
290 if choice == "Account":
291 default_item = "Account"
292 (code, answer) = d.inputbox(
293 "Please provide your ~okeanos authentication token:",
294 init=session["account"]['auth_token'] if "account" in session
295 else '', width=WIDTH)
296 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
298 if len(answer) == 0 and "account" in session:
299 del session["account"]
301 token = answer.strip()
302 session['account'] = Kamaki.get_account(token)
303 if session['account'] is not None:
304 Kamaki.save_token(token)
305 default_item = "Upload"
307 del session['account']
308 d.msgbox("The token you provided is not valid!",
310 elif choice == "Upload":
311 if upload_image(session):
312 default_item = "Register"
314 default_item = "Upload"
315 elif choice == "Register":
316 if register_image(session):
319 default_item = "Register"
322 def add_property(session):
323 """Add a new property to the image"""
324 d = session['dialog']
327 (code, answer) = d.inputbox("Please provide a name for a new image"
328 " property:", width=WIDTH)
329 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
332 name = answer.strip()
334 d.msgbox("A property name cannot be empty", width=SMALL_WIDTH)
340 (code, answer) = d.inputbox("Please provide a value for image "
341 "property %s" % name, width=WIDTH)
342 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
345 value = answer.strip()
347 d.msgbox("Value cannot be empty", width=SMALL_WIDTH)
352 session['metadata'][name] = value
357 def modify_properties(session):
358 """Modify an existing image property"""
359 d = session['dialog']
363 for (key, val) in session['metadata'].items():
364 choices.append((str(key), str(val)))
366 (code, choice) = d.menu(
367 "In this menu you can edit existing image properties or add new "
368 "ones. Be careful! Most properties have special meaning and "
369 "alter the image deployment behaviour. Press <HELP> to see more "
370 "information about image properties. Press <BACK> when done.",
371 height=18, width=WIDTH, choices=choices, menu_height=10,
372 ok_label="Edit", extra_button=1, extra_label="Add", cancel="Back",
373 help_button=1, title="Image Properties")
375 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
378 elif code == d.DIALOG_OK:
379 (code, answer) = d.inputbox("Please provide a new value for the "
380 "image property with name `%s':" %
382 init=session['metadata'][choice],
384 if code not in (d.DIALOG_CANCEL, d.DIALOG_ESC):
385 value = answer.strip()
387 d.msgbox("Value cannot be empty!")
390 session['metadata'][choice] = value
392 elif code == d.DIALOG_EXTRA:
393 add_property(session)
395 help_file = get_help_file("image_properties")
396 assert os.path.exists(help_file)
397 d.textbox(help_file, title="Image Properties", width=70, height=40)
400 def delete_properties(session):
401 """Delete an image property"""
402 d = session['dialog']
405 for (key, val) in session['metadata'].items():
406 choices.append((key, "%s" % val, 0))
408 (code, to_delete) = d.checklist("Choose which properties to delete:",
409 choices=choices, width=WIDTH)
411 # If the user exits with ESC or CANCEL, the returned tag list is empty.
413 del session['metadata'][i]
417 d.msgbox("%d image properties were deleted." % cnt, width=SMALL_WIDTH)
423 def exclude_tasks(session):
424 """Exclude specific tasks from running during image deployment"""
425 d = session['dialog']
431 if 'excluded_tasks' not in session:
432 session['excluded_tasks'] = []
434 if -1 in session['excluded_tasks']:
435 if not d.yesno("Image deployment configuration is disabled. "
436 "Do you wish to enable it?", width=SMALL_WIDTH):
437 session['excluded_tasks'].remove(-1)
441 for (msg, task, osfamily) in CONFIGURATION_TASKS:
442 if session['metadata']['OSFAMILY'] in osfamily:
443 checked = 1 if index in session['excluded_tasks'] else 0
444 choices.append((str(displayed_index), msg, checked))
445 mapping[displayed_index] = index
450 (code, tags) = d.checklist(
451 text="Please choose which configuration tasks you would like to "
452 "prevent from running during image deployment. "
453 "Press <No Config> to supress any configuration. "
454 "Press <Help> for more help on the image deployment "
455 "configuration tasks.",
456 choices=choices, height=19, list_height=8, width=WIDTH,
457 help_button=1, extra_button=1, extra_label="No Config",
458 title="Exclude Configuration Tasks")
460 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
462 elif code == d.DIALOG_HELP:
463 help_file = get_help_file("configuration_tasks")
464 assert os.path.exists(help_file)
465 d.textbox(help_file, title="Configuration Tasks",
468 elif code == d.DIALOG_EXTRA:
469 session['excluded_tasks'] = [-1]
470 session['task_metadata'] = ["EXCLUDE_ALL_TASKS"]
472 elif code == d.DIALOG_OK:
473 session['excluded_tasks'] = []
475 session['excluded_tasks'].append(mapping[int(tag)])
477 exclude_metadata = []
478 for task in session['excluded_tasks']:
479 exclude_metadata.extend(CONFIGURATION_TASKS[task][1])
481 session['task_metadata'] = map(lambda x: "EXCLUDE_TASK_%s" % x,
488 def sysprep(session):
489 """Perform various system preperation tasks on the image"""
490 d = session['dialog']
491 image = session['image']
493 # Is the image already shrinked?
494 if 'shrinked' in session and session['shrinked']:
495 msg = "It seems you have shrinked the image. Running system " \
496 "preparation tasks on a shrinked image is dangerous."
498 if d.yesno("%s\n\nDo you really want to continue?" % msg,
499 width=SMALL_WIDTH, defaultno=1):
502 wrapper = textwrap.TextWrapper(width=WIDTH - 5)
504 help_title = "System Preperation Tasks"
505 sysprep_help = "%s\n%s\n\n" % (help_title, '=' * len(help_title))
507 if 'exec_syspreps' not in session:
508 session['exec_syspreps'] = []
510 all_syspreps = image.os.list_syspreps()
511 # Only give the user the choice between syspreps that have not ran yet
512 syspreps = [s for s in all_syspreps if s not in session['exec_syspreps']]
514 if len(syspreps) == 0:
515 d.msgbox("No system preparation task available to run!",
516 title="System Preperation", width=SMALL_WIDTH)
522 for sysprep in syspreps:
523 name, descr = image.os.sysprep_info(sysprep)
524 display_name = name.replace('-', ' ').capitalize()
525 sysprep_help += "%s\n" % display_name
526 sysprep_help += "%s\n" % ('-' * len(display_name))
527 sysprep_help += "%s\n\n" % wrapper.fill(" ".join(descr.split()))
528 enabled = 1 if sysprep.enabled else 0
529 choices.append((str(index + 1), display_name, enabled))
532 (code, tags) = d.checklist(
533 "Please choose which system preparation tasks you would like to "
534 "run on the image. Press <Help> to see details about the system "
535 "preparation tasks.", title="Run system preparation tasks",
536 choices=choices, width=70, ok_label="Run", help_button=1)
538 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
540 elif code == d.DIALOG_HELP:
541 d.scrollbox(sysprep_help, width=WIDTH)
542 elif code == d.DIALOG_OK:
543 # Enable selected syspreps and disable the rest
544 for i in range(len(syspreps)):
545 if str(i + 1) in tags:
546 image.os.enable_sysprep(syspreps[i])
547 session['exec_syspreps'].append(syspreps[i])
549 image.os.disable_sysprep(syspreps[i])
551 infobox = InfoBoxOutput(d, "Image Configuration")
553 image.out.add(infobox)
555 image.mount(readonly=False)
558 "Unable to execute the system preparation tasks."
559 if not image.mounted:
561 "%s Couldn't mount the media." % err_msg,
562 title="System Preperation", width=SMALL_WIDTH)
564 elif image.mounted_ro:
566 "%s Couldn't mount the media read-write."
567 % err_msg, title="System Preperation",
571 # The checksum is invalid. We have mounted the image rw
572 if 'checksum' in session:
573 del session['checksum']
575 # Monitor the metadata changes during syspreps
576 with MetadataMonitor(session, image.os.meta):
577 image.os.do_sysprep()
580 # Disable syspreps that have ran
581 for sysprep in session['exec_syspreps']:
582 image.os.disable_sysprep(sysprep)
586 image.out.remove(infobox)
594 """Shrink the image"""
595 d = session['dialog']
596 image = session['image']
598 shrinked = 'shrinked' in session and session['shrinked']
601 d.msgbox("The image is already shrinked!", title="Image Shrinking",
605 msg = "This operation will shrink the last partition of the image to " \
606 "reduce the total image size. If the last partition is a swap " \
607 "partition, then this partition is removed and the partition " \
608 "before that is shrinked. The removed swap partition will be " \
609 "recreated during image deployment."
611 if not d.yesno("%s\n\nDo you want to continue?" % msg, width=WIDTH,
612 height=12, title="Image Shrinking"):
613 with MetadataMonitor(session, image.meta):
614 infobox = InfoBoxOutput(d, "Image Shrinking", height=4)
615 image.out.add(infobox)
620 image.out.remove(infobox)
622 session['shrinked'] = True
623 update_background_title(session)
630 def customization_menu(session):
631 """Show image customization menu"""
632 d = session['dialog']
634 choices = [("Sysprep", "Run various image preparation tasks"),
635 ("Shrink", "Shrink image"),
636 ("View/Modify", "View/Modify image properties"),
637 ("Delete", "Delete image properties"),
638 ("Exclude", "Exclude various deployment tasks from running")]
642 actions = {"Sysprep": sysprep,
644 "View/Modify": modify_properties,
645 "Delete": delete_properties,
646 "Exclude": exclude_tasks}
648 (code, choice) = d.menu(
649 text="Choose one of the following or press <Back> to exit.",
650 width=WIDTH, choices=choices, cancel="Back", height=13,
651 menu_height=len(choices), default_item=choices[default_item][0],
652 title="Image Customization Menu")
654 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
656 elif choice in actions:
657 default_item = [entry[0] for entry in choices].index(choice)
658 if actions[choice](session):
659 default_item = (default_item + 1) % len(choices)
662 def main_menu(session):
663 """Show the main menu of the program"""
664 d = session['dialog']
666 update_background_title(session)
668 choices = [("Customize", "Customize image & ~okeanos deployment options"),
669 ("Register", "Register image to ~okeanos"),
670 ("Extract", "Dump image to local file system"),
671 ("Reset", "Reset everything and start over again"),
672 ("Help", "Get help for using snf-image-creator")]
674 default_item = "Customize"
676 actions = {"Customize": customization_menu, "Register": kamaki_menu,
677 "Extract": extract_image}
679 (code, choice) = d.menu(
680 text="Choose one of the following or press <Exit> to exit.",
681 width=WIDTH, choices=choices, cancel="Exit", height=13,
682 default_item=default_item, menu_height=len(choices),
683 title="Image Creator for ~okeanos (snf-image-creator version %s)" %
686 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
689 elif choice == "Reset":
691 d.infobox("Resetting snf-image-creator. Please wait...",
694 elif choice == "Help":
695 d.msgbox("For help, check the online documentation:\n\nhttp://www"
696 ".synnefo.org/docs/snf-image-creator/latest/",
697 width=WIDTH, title="Help")
698 elif choice in actions:
699 actions[choice](session)
701 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :