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, FatalError
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)
140 kamaki = Kamaki(session['account'], None)
142 for f in (filename, "%s.md5sum" % filename, "%s.meta" % filename):
143 if kamaki.object_exists(f):
146 if len(overwrite) > 0:
147 if d.yesno("The following pithos object(s) already exist(s):\n"
148 "%s\nDo you want to overwrite them?" %
149 "\n".join(overwrite), width=WIDTH, defaultno=1):
152 session['upload'] = filename
155 gauge = GaugeOutput(d, "Image Upload", "Uploading...")
161 if 'checksum' not in session:
163 session['checksum'] = md5.compute(image.device, size)
167 with open(image.device, 'rb') as f:
168 session["pithos_uri"] = \
169 kamaki.upload(f, size, filename,
170 "Calculating block hashes",
171 "Uploading missing blocks")
173 out.output("Uploading md5sum file...")
174 md5str = "%s %s\n" % (session['checksum'], filename)
175 kamaki.upload(StringIO.StringIO(md5str), size=len(md5str),
176 remote_path="%s.md5sum" % filename)
179 except ClientError as e:
180 d.msgbox("Error in pithos+ client: %s" % e.message,
181 title="Pithos+ Client Error", width=SMALL_WIDTH)
182 if 'pithos_uri' in session:
183 del session['pithos_uri']
190 d.msgbox("Image file `%s' was successfully uploaded to pithos+" % filename,
196 def register_image(session):
197 """Register image with cyclades"""
198 d = session["dialog"]
202 if "account" not in session:
203 d.msgbox("You need to provide your ~okeanos credentians before you "
204 "can register an images with cyclades", width=SMALL_WIDTH)
207 if "pithos_uri" not in session:
208 d.msgbox("You need to upload the image to pithos+ before you can "
209 "register it with cyclades", width=SMALL_WIDTH)
213 (code, answer) = d.inputbox("Please provide a registration name:",
215 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
218 name = answer.strip()
220 d.msgbox("Registration name cannot be empty", width=SMALL_WIDTH)
223 ret = d.yesno("Make the image public?\\nA public image is accessible "
224 "by every user of the service.", defaultno=1,
226 if ret not in (0, 1):
229 is_public = True if ret == 0 else False
234 metadata.update(session['metadata'])
235 if 'task_metadata' in session:
236 for key in session['task_metadata']:
237 metadata[key] = 'yes'
239 img_type = "public" if is_public else "private"
240 gauge = GaugeOutput(d, "Image Registration", "Registering image...")
242 out = session['image'].out
246 out.output("Registering %s image with Cyclades..." % img_type)
247 kamaki = Kamaki(session['account'], out)
248 kamaki.register(name, session['pithos_uri'], metadata,
251 # Upload metadata file
252 out.output("Uploading metadata file...")
253 metastring = extract_metadata_string(session)
254 kamaki.upload(StringIO.StringIO(metastring),
255 size=len(metastring),
256 remote_path="%s.meta" % session['upload'])
259 out.output("Sharing metadata and md5sum files...")
260 kamaki.share("%s.meta" % session['upload'])
261 kamaki.share("%s.md5sum" % session['upload'])
263 except ClientError as e:
264 d.msgbox("Error in pithos+ client: %s" % e.message)
271 d.msgbox("%s image `%s' was successfully registered with Cyclades as `%s'"
272 % (img_type.title(), session['upload'], name), width=SMALL_WIDTH)
276 def kamaki_menu(session):
277 """Show kamaki related actions"""
278 d = session['dialog']
279 default_item = "Account"
281 if 'account' not in session:
282 token = Kamaki.get_token()
284 session['account'] = Kamaki.get_account(token)
285 if not session['account']:
286 del session['account']
287 Kamaki.save_token('') # The token was not valid. Remove it
290 account = session["account"]['username'] if "account" in session else \
292 upload = session["upload"] if "upload" in session else "<none>"
294 choices = [("Account", "Change your ~okeanos account: %s" % account),
295 ("Upload", "Upload image to pithos+"),
296 ("Register", "Register the image to cyclades: %s" % upload)]
298 (code, choice) = d.menu(
299 text="Choose one of the following or press <Back> to go back.",
300 width=WIDTH, choices=choices, cancel="Back", height=13,
301 menu_height=5, default_item=default_item,
302 title="Image Registration Menu")
304 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
307 if choice == "Account":
308 default_item = "Account"
309 (code, answer) = d.inputbox(
310 "Please provide your ~okeanos authentication token:",
311 init=session["account"]['auth_token'] if "account" in session
312 else '', width=WIDTH)
313 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
315 if len(answer) == 0 and "account" in session:
316 del session["account"]
318 token = answer.strip()
319 session['account'] = Kamaki.get_account(token)
320 if session['account'] is not None:
321 Kamaki.save_token(token)
322 default_item = "Upload"
324 del session['account']
325 d.msgbox("The token you provided is not valid!",
327 elif choice == "Upload":
328 if upload_image(session):
329 default_item = "Register"
331 default_item = "Upload"
332 elif choice == "Register":
333 if register_image(session):
336 default_item = "Register"
339 def add_property(session):
340 """Add a new property to the image"""
341 d = session['dialog']
344 (code, answer) = d.inputbox("Please provide a name for a new image"
345 " property:", width=WIDTH)
346 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
349 name = answer.strip()
351 d.msgbox("A property name cannot be empty", width=SMALL_WIDTH)
357 (code, answer) = d.inputbox("Please provide a value for image "
358 "property %s" % name, width=WIDTH)
359 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
362 value = answer.strip()
364 d.msgbox("Value cannot be empty", width=SMALL_WIDTH)
369 session['metadata'][name] = value
374 def modify_properties(session):
375 """Modify an existing image property"""
376 d = session['dialog']
380 for (key, val) in session['metadata'].items():
381 choices.append((str(key), str(val)))
383 (code, choice) = d.menu(
384 "In this menu you can edit existing image properties or add new "
385 "ones. Be careful! Most properties have special meaning and "
386 "alter the image deployment behaviour. Press <HELP> to see more "
387 "information about image properties. Press <BACK> when done.",
388 height=18, width=WIDTH, choices=choices, menu_height=10,
389 ok_label="Edit", extra_button=1, extra_label="Add", cancel="Back",
390 help_button=1, title="Image Properties")
392 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
395 elif code == d.DIALOG_OK:
396 (code, answer) = d.inputbox("Please provide a new value for the "
397 "image property with name `%s':" %
399 init=session['metadata'][choice],
401 if code not in (d.DIALOG_CANCEL, d.DIALOG_ESC):
402 value = answer.strip()
404 d.msgbox("Value cannot be empty!")
407 session['metadata'][choice] = value
409 elif code == d.DIALOG_EXTRA:
410 add_property(session)
412 help_file = get_help_file("image_properties")
413 assert os.path.exists(help_file)
414 d.textbox(help_file, title="Image Properties", width=70, height=40)
417 def delete_properties(session):
418 """Delete an image property"""
419 d = session['dialog']
422 for (key, val) in session['metadata'].items():
423 choices.append((key, "%s" % val, 0))
425 (code, to_delete) = d.checklist("Choose which properties to delete:",
426 choices=choices, width=WIDTH)
428 # If the user exits with ESC or CANCEL, the returned tag list is empty.
430 del session['metadata'][i]
434 d.msgbox("%d image properties were deleted." % cnt, width=SMALL_WIDTH)
440 def exclude_tasks(session):
441 """Exclude specific tasks from running during image deployment"""
442 d = session['dialog']
448 if 'excluded_tasks' not in session:
449 session['excluded_tasks'] = []
451 if -1 in session['excluded_tasks']:
452 if not d.yesno("Image deployment configuration is disabled. "
453 "Do you wish to enable it?", width=SMALL_WIDTH):
454 session['excluded_tasks'].remove(-1)
458 for (msg, task, osfamily) in CONFIGURATION_TASKS:
459 if session['metadata']['OSFAMILY'] in osfamily:
460 checked = 1 if index in session['excluded_tasks'] else 0
461 choices.append((str(displayed_index), msg, checked))
462 mapping[displayed_index] = index
467 (code, tags) = d.checklist(
468 text="Please choose which configuration tasks you would like to "
469 "prevent from running during image deployment. "
470 "Press <No Config> to supress any configuration. "
471 "Press <Help> for more help on the image deployment "
472 "configuration tasks.",
473 choices=choices, height=19, list_height=8, width=WIDTH,
474 help_button=1, extra_button=1, extra_label="No Config",
475 title="Exclude Configuration Tasks")
477 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
479 elif code == d.DIALOG_HELP:
480 help_file = get_help_file("configuration_tasks")
481 assert os.path.exists(help_file)
482 d.textbox(help_file, title="Configuration Tasks",
485 elif code == d.DIALOG_EXTRA:
486 session['excluded_tasks'] = [-1]
487 session['task_metadata'] = ["EXCLUDE_ALL_TASKS"]
489 elif code == d.DIALOG_OK:
490 session['excluded_tasks'] = []
492 session['excluded_tasks'].append(mapping[int(tag)])
494 exclude_metadata = []
495 for task in session['excluded_tasks']:
496 exclude_metadata.extend(CONFIGURATION_TASKS[task][1])
498 session['task_metadata'] = map(lambda x: "EXCLUDE_TASK_%s" % x,
505 def sysprep(session):
506 """Perform various system preperation tasks on the image"""
507 d = session['dialog']
508 image = session['image']
510 # Is the image already shrinked?
511 if 'shrinked' in session and session['shrinked']:
512 msg = "It seems you have shrinked the image. Running system " \
513 "preparation tasks on a shrinked image is dangerous."
515 if d.yesno("%s\n\nDo you really want to continue?" % msg,
516 width=SMALL_WIDTH, defaultno=1):
519 wrapper = textwrap.TextWrapper(width=WIDTH - 5)
521 help_title = "System Preperation Tasks"
522 sysprep_help = "%s\n%s\n\n" % (help_title, '=' * len(help_title))
524 syspreps = image.os.list_syspreps()
526 if len(syspreps) == 0:
527 d.msgbox("No system preparation task available to run!",
528 title="System Preperation", width=SMALL_WIDTH)
534 for sysprep in syspreps:
535 name, descr = image.os.sysprep_info(sysprep)
536 display_name = name.replace('-', ' ').capitalize()
537 sysprep_help += "%s\n" % display_name
538 sysprep_help += "%s\n" % ('-' * len(display_name))
539 sysprep_help += "%s\n\n" % wrapper.fill(" ".join(descr.split()))
540 enabled = 1 if sysprep.enabled else 0
541 choices.append((str(index + 1), display_name, enabled))
544 (code, tags) = d.checklist(
545 "Please choose which system preparation tasks you would like to "
546 "run on the image. Press <Help> to see details about the system "
547 "preparation tasks.", title="Run system preparation tasks",
548 choices=choices, width=70, ok_label="Run", help_button=1)
550 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
552 elif code == d.DIALOG_HELP:
553 d.scrollbox(sysprep_help, width=WIDTH)
554 elif code == d.DIALOG_OK:
555 # Enable selected syspreps and disable the rest
556 for i in range(len(syspreps)):
557 if str(i + 1) in tags:
558 image.os.enable_sysprep(syspreps[i])
560 image.os.disable_sysprep(syspreps[i])
562 if len([s for s in image.os.list_syspreps() if s.enabled]) == 0:
563 d.msgbox("No system preperation task is selected!",
564 title="System Preperation", width=SMALL_WIDTH)
567 infobox = InfoBoxOutput(d, "Image Configuration")
569 image.out.add(infobox)
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):
578 image.os.do_sysprep()
580 except FatalError as e:
581 title = "System Preparation"
582 d.msgbox("System Preparation failed: %s" % e,
583 title=title, width=SMALL_WIDTH)
585 image.out.remove(infobox)
593 """Shrink the image"""
594 d = session['dialog']
595 image = session['image']
597 shrinked = 'shrinked' in session and session['shrinked']
600 d.msgbox("The image is already shrinked!", title="Image Shrinking",
604 msg = "This operation will shrink the last partition of the image to " \
605 "reduce the total image size. If the last partition is a swap " \
606 "partition, then this partition is removed and the partition " \
607 "before that is shrinked. The removed swap partition will be " \
608 "recreated during image deployment."
610 if not d.yesno("%s\n\nDo you want to continue?" % msg, width=WIDTH,
611 height=12, title="Image Shrinking"):
612 with MetadataMonitor(session, image.meta):
613 infobox = InfoBoxOutput(d, "Image Shrinking", height=4)
614 image.out.add(infobox)
619 image.out.remove(infobox)
621 session['shrinked'] = True
622 update_background_title(session)
629 def customization_menu(session):
630 """Show image customization menu"""
631 d = session['dialog']
633 choices = [("Sysprep", "Run various image preparation tasks"),
634 ("Shrink", "Shrink image"),
635 ("View/Modify", "View/Modify image properties"),
636 ("Delete", "Delete image properties"),
637 ("Exclude", "Exclude various deployment tasks from running")]
641 actions = {"Sysprep": sysprep,
643 "View/Modify": modify_properties,
644 "Delete": delete_properties,
645 "Exclude": exclude_tasks}
647 (code, choice) = d.menu(
648 text="Choose one of the following or press <Back> to exit.",
649 width=WIDTH, choices=choices, cancel="Back", height=13,
650 menu_height=len(choices), default_item=choices[default_item][0],
651 title="Image Customization Menu")
653 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
655 elif choice in actions:
656 default_item = [entry[0] for entry in choices].index(choice)
657 if actions[choice](session):
658 default_item = (default_item + 1) % len(choices)
661 def main_menu(session):
662 """Show the main menu of the program"""
663 d = session['dialog']
665 update_background_title(session)
667 choices = [("Customize", "Customize image & ~okeanos deployment options"),
668 ("Register", "Register image to ~okeanos"),
669 ("Extract", "Dump image to local file system"),
670 ("Reset", "Reset everything and start over again"),
671 ("Help", "Get help for using snf-image-creator")]
673 default_item = "Customize"
675 actions = {"Customize": customization_menu, "Register": kamaki_menu,
676 "Extract": extract_image}
678 (code, choice) = d.menu(
679 text="Choose one of the following or press <Exit> to exit.",
680 width=WIDTH, choices=choices, cancel="Exit", height=13,
681 default_item=default_item, menu_height=len(choices),
682 title="Image Creator for ~okeanos (snf-image-creator version %s)" %
685 if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
688 elif choice == "Reset":
690 d.infobox("Resetting snf-image-creator. Please wait...",
693 elif choice == "Help":
694 d.msgbox("For help, check the online documentation:\n\nhttp://www"
695 ".synnefo.org/docs/snf-image-creator/latest/",
696 width=WIDTH, title="Help")
697 elif choice in actions:
698 actions[choice](session)
700 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :