#!/usr/bin/env python
-
+# -*- coding: utf-8 -*-
+#
# Copyright 2012 GRNET S.A. All rights reserved.
#
# Redistribution and use in source and binary forms, with or
# interpreted as representing official policies, either expressed
# or implied, of GRNET S.A.
+"""This module is the entrance point for the dialog-based version of the
+snf-image-creator program. The main function will create a dialog where the
+user is asked if he wants to use the program in expert or wizard mode.
+"""
+
import dialog
import sys
import os
+import stat
import textwrap
import signal
-import StringIO
+import optparse
+import types
from image_creator import __version__ as version
-from image_creator.util import FatalError, MD5
-from image_creator.output.dialog import InitializationOutput, GaugeOutput
+from image_creator.util import FatalError
+from image_creator.output import Output
+from image_creator.output.cli import SimpleOutput
+from image_creator.output.dialog import GaugeOutput
+from image_creator.output.composite import CompositeOutput
from image_creator.disk import Disk
-from image_creator.os_type import os_cls
-from image_creator.kamaki_wrapper import Kamaki, ClientError
-
-MSGBOX_WIDTH = 60
-YESNO_WIDTH = 50
-MENU_WIDTH = 70
-INPUTBOX_WIDTH = 70
-
-CONFIGURATION_TASKS = {
- "FixPartitionTable":
- "Enlarge last partition to use all the available space",
- "FilesystemResizeUnmounted":
- "Resize file system to use all the available space",
- "AddSwap": "Set up the swap partition and add an entry in fstab",
- "DeleteSSHKeys": "Remove ssh keys and in some cases recreate them",
- "DisableRemoteDesktopConnections":
- "Temporary Disable Remote Desktop Connections",
- "40SELinuxAutorelabel": "Force the system to relabel at next boot",
- "AssignHostname": "Assign Hostname/Computer Name to the instance",
- "ChangePassword": "Changes Password for specified users",
- "EnforcePersonality": "Inject files to the instance",
- "FilesystemResizeMounted":
- "Resize filesystem to use all the available space"}
-
-
-class Reset(Exception):
- pass
-
-
-def confirm_exit(d, msg=''):
- return not d.yesno("%s Do you want to exit?" % msg, width=YESNO_WIDTH)
-
-
-def confirm_reset(d):
- return not d.yesno(
- "Are you sure you want to reset everything?",
- width=YESNO_WIDTH)
-
-
-def extract_image(session):
- d = session['dialog']
- dir = os.getcwd()
- while 1:
- if dir and dir[-1] != os.sep:
- dir = dir + os.sep
-
- (code, path) = d.fselect(dir, 10, 50, title="Save image as...")
- if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
- return False
-
- if os.path.isdir(path):
- dir = path
- continue
-
- if os.path.isdir("%s.meta" % path):
- d.msgbox("Can't overwrite directory `%s.meta'" % path,
- width=MSGBOX_WIDTH)
- continue
-
- if os.path.isdir("%s.md5sum" % path):
- d.msgbox("Can't overwrite directory `%s.md5sum'" % path,
- width=MSGBOX_WIDTH)
- continue
-
- basedir = os.path.dirname(path)
- name = os.path.basename(path)
- if not os.path.exists(basedir):
- d.msgbox("Directory `%s' does not exist" % basedir,
- width=MSGBOX_WIDTH)
- continue
-
- dir = basedir
- if len(name) == 0:
- continue
-
- files = ["%s%s" % (path, ext) for ext in ('', '.meta', '.md5sum')]
- overwrite = filter(os.path.exists, files)
-
- if len(overwrite) > 0:
- if d.yesno("The following file(s) exist:\n"
- "%s\nDo you want to overwrite them?" %
- "\n".join(overwrite), width=YESNO_WIDTH):
- continue
-
- out = GaugeOutput(d, "Image Extraction", "Extracting image...")
- try:
- dev = session['device']
- if "checksum" not in session:
- size = dev.meta['SIZE']
- md5 = MD5(out)
- session['checksum'] = md5.compute(session['snapshot'], size)
-
- # Extract image file
- dev.out = out
- dev.dump(path)
-
- # Extract metadata file
- out.output("Extracting metadata file...")
- metastring = '\n'.join(
- ['%s=%s' % (k, v) for (k, v) in session['metadata'].items()])
- metastring += '\n'
- with open('%s.meta' % path, 'w') as f:
- f.write(metastring)
- out.success('done')
-
- # Extract md5sum file
- out.output("Extracting md5sum file...")
- md5str = "%s %s\n" % (session['checksum'], name)
- with open('%s.md5sum' % path, 'w') as f:
- f.write(md5str)
- out.success("done")
-
- finally:
- out.cleanup()
- d.msgbox("Image file `%s' was successfully extracted!" % path,
- width=MSGBOX_WIDTH)
- break
-
- return True
-
-
-def upload_image(session):
- d = session["dialog"]
- size = session['device'].meta['SIZE']
-
- if "account" not in session:
- d.msgbox("You need to provide your ~okeanos login username before you "
- "can upload images to pithos+", width=MSGBOX_WIDTH)
- return False
-
- if "token" not in session:
- d.msgbox("You need to provide your ~okeanos account authentication "
- "token before you can upload images to pithos+",
- width=MSGBOX_WIDTH)
- return False
-
- while 1:
- init = session["upload"] if "upload" in session else ''
- (code, answer) = d.inputbox("Please provide a filename:", init=init,
- width=INPUTBOX_WIDTH)
-
- if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
- return False
-
- filename = answer.strip()
- if len(filename) == 0:
- d.msgbox("Filename cannot be empty", width=MSGBOX_WIDTH)
- continue
-
- break
-
- out = GaugeOutput(d, "Image Upload", "Uploading...")
- if 'checksum' not in session:
- md5 = MD5(out)
- session['checksum'] = md5.compute(session['snapshot'], size)
- try:
- kamaki = Kamaki(session['account'], session['token'], out)
- try:
- # Upload image file
- with open(session['snapshot'], 'rb') as f:
- session["upload"] = kamaki.upload(f, size, filename,
- "Calculating block hashes",
- "Uploading missing blocks")
- # Upload metadata file
- out.output("Uploading metadata file...")
- metastring = '\n'.join(
- ['%s=%s' % (k, v) for (k, v) in session['metadata'].items()])
- metastring += '\n'
- kamaki.upload(StringIO.StringIO(metastring), size=len(metastring),
- remote_path="%s.meta" % filename)
- out.success("done")
-
- # Upload md5sum file
- out.output("Uploading md5sum file...")
- md5str = "%s %s\n" % (session['checksum'], filename)
- kamaki.upload(StringIO.StringIO(md5str), size=len(md5str),
- remote_path="%s.md5sum" % filename)
- out.success("done")
-
- except ClientError as e:
- d.msgbox("Error in pithos+ client: %s" % e.message,
- title="Pithos+ Client Error", width=MSGBOX_WIDTH)
- if 'upload' in session:
- del session['upload']
- return False
- finally:
- out.cleanup()
-
- d.msgbox("Image file `%s' was successfully uploaded to pithos+" % filename,
- width=MSGBOX_WIDTH)
- return True
-
+from image_creator.dialog_wizard import start_wizard
+from image_creator.dialog_menu import main_menu
+from image_creator.dialog_util import SMALL_WIDTH, WIDTH, confirm_exit, \
+ Reset, update_background_title
-def register_image(session):
- d = session["dialog"]
- if "account" not in session:
- d.msgbox("You need to provide your ~okeanos login username before you "
- "can register an images to cyclades",
- width=MSGBOX_WIDTH)
- return False
+def create_image(d, media, out, tmp):
+ """Create an image out of `media'"""
+ d.setBackgroundTitle('snf-image-creator')
- if "token" not in session:
- d.msgbox("You need to provide your ~okeanos account authentication "
- "token before you can register an images to cyclades",
- width=MSGBOX_WIDTH)
- return False
+ gauge = GaugeOutput(d, "Initialization", "Initializing...")
+ out.add(gauge)
+ disk = Disk(media, out, tmp)
- if "upload" not in session:
- d.msgbox("You need to have an image uploaded to pithos+ before you "
- "can register it to cyclades",
- width=MSGBOX_WIDTH)
- return False
-
- while 1:
- (code, answer) = d.inputbox("Please provide a registration name:"
- " be registered:", width=INPUTBOX_WIDTH)
- if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
- return False
-
- name = answer.strip()
- if len(name) == 0:
- d.msgbox("Registration name cannot be empty", width=MSGBOX_WIDTH)
- continue
- break
+ def signal_handler(signum, frame):
+ gauge.cleanup()
+ disk.cleanup()
- out = GaugeOutput(d, "Image Registration", "Registrating image...")
+ signal.signal(signal.SIGINT, signal_handler)
+ signal.signal(signal.SIGTERM, signal_handler)
try:
- out.output("Registring image to cyclades...")
- try:
- kamaki = Kamaki(session['account'], session['token'], out)
- kamaki.register(name, session['upload'], session['metadata'])
- out.success('done')
- except ClientError as e:
- d.msgbox("Error in pithos+ client: %s" % e.message)
- return False
- finally:
- out.cleanup()
-
- d.msgbox("Image `%s' was successfully registered to cyclades as `%s'" %
- (session['upload'], name), width=MSGBOX_WIDTH)
- return True
-
-
-def kamaki_menu(session):
- d = session['dialog']
- default_item = "Account"
- while 1:
- account = session["account"] if "account" in session else "<none>"
- token = session["token"] if "token" in session else "<none>"
- upload = session["upload"] if "upload" in session else "<none>"
- (code, choice) = d.menu(
- "Choose one of the following or press <Back> to go back.",
- width=MENU_WIDTH,
- choices=[("Account", "Change your ~okeanos username: %s" %
- account),
- ("Token", "Change your ~okeanos token: %s" % token),
- ("Upload", "Upload image to pithos+"),
- ("Register", "Register image to cyclades: %s" % upload)],
- cancel="Back",
- default_item=default_item,
- help_button=1,
- title="Image Registration Menu")
-
- if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
- return False
-
- if choice == "Account":
- default_item = "Account"
- (code, answer) = d.inputbox(
- "Please provide your ~okeanos account e-mail address:",
- init=session["account"] if "account" in session else '',
- width=70)
- if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
- continue
- if len(answer) == 0 and "account" in session:
- del session["account"]
- else:
- session["account"] = answer.strip()
- default_item = "Token"
- elif choice == "Token":
- default_item = "Token"
- (code, answer) = d.inputbox(
- "Please provide your ~okeanos account authetication token:",
- init=session["token"] if "token" in session else '',
- width=70)
- if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
- continue
- if len(answer) == 0 and "token" in session:
- del session["token"]
- else:
- session["token"] = answer.strip()
- default_item = "Upload"
- elif choice == "Upload":
- if upload_image(session):
- default_item = "Register"
- else:
- default_item = "Upload"
- elif choice == "Register":
- if register_image(session):
- return True
- else:
- default_item = "Register"
-
-
-def add_property(session):
- d = session['dialog']
-
- while 1:
- (code, answer) = d.inputbox("Please provide a name for a new image"
- " property:", width=INPUTBOX_WIDTH)
- if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
- return False
-
- name = answer.strip()
- if len(name) == 0:
- d.msgbox("A property name cannot be empty", width=MSGBOX_WIDTH)
- continue
-
- break
-
- while 1:
- (code, answer) = d.inputbox("Please provide a value for image "
- "property %s" % name, width=INPUTBOX_WIDTH)
- if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
- return False
-
- value = answer.strip()
- if len(value) == 0:
- d.msgbox("Value cannot be empty", width=MSGBOX_WIDTH)
- continue
-
- break
-
- session['metadata'][name] = value
-
- return True
-
-
-def modify_properties(session):
- d = session['dialog']
-
- while 1:
- choices = []
- for (key, val) in session['metadata'].items():
- choices.append((str(key), str(val)))
-
- (code, choice) = d.menu(
- "In this menu you can edit existing image properties or add new "
- "ones. Be carefull! Most properties have special meaning and "
- "alter the image deployment behaviour. Press <HELP> to see more "
- "information about image properties. Press <BACK> when done.",
- height=18,
- width=MENU_WIDTH,
- choices=choices, menu_height=10,
- ok_label="EDIT", extra_button=1, extra_label="ADD", cancel="BACK",
- help_button=1, help_label="HELP", title="Image Metadata")
-
- if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
- break
- # Edit button
- elif code == d.DIALOG_OK:
- (code, answer) = d.inputbox("Please provide a new value for "
- "the image property with name `%s':" % choice,
- init=session['metadata'][choice], width=INPUTBOX_WIDTH)
- if code not in (d.DIALOG_CANCEL, d.DIALOG_ESC):
- value = answer.strip()
- if len(value) == 0:
- d.msgbox("Value cannot be empty!")
- continue
- else:
- session['metadata'][choice] = value
- # ADD button
- elif code == d.DIALOG_EXTRA:
- add_property(session)
-
-
-def delete_properties(session):
- d = session['dialog']
-
- choices = []
- for (key, val) in session['metadata'].items():
- choices.append((key, "%s" % val, 0))
-
- (code, to_delete) = d.checklist("Choose which properties to delete:",
- choices=choices)
- count = len(to_delete)
- # If the user exits with ESC or CANCEL, the returned tag list is empty.
- for i in to_delete:
- del session['metadata'][i]
-
- if count > 0:
- d.msgbox("%d image properties were deleted.", width=MSGBOX_WIDTH)
-
-
-def exclude_task(session):
- d = session['dialog']
-
- choices = []
- for (key, val) in session['metadata'].items():
- choices.append((key, "%s" % val, 0))
-
- (code, to_delete) = d.checklist("Choose which properties to delete:",
- choices=choices)
- count = len(to_delete)
- # If the user exits with ESC or CANCEL, the returned tag list is empty.
- for i in to_delete:
- del session['metadata'][i]
-
- if count > 0:
- d.msgbox("%d image properties were deleted.", width=MSGBOX_WIDTH)
-
+ snapshot = disk.snapshot()
+ image = disk.get_image(snapshot)
-def deploy_menu(session):
- d = session['dialog']
+ out.output("Collecting image metadata ...")
+ metadata = {}
+ for (key, value) in image.meta.items():
+ metadata[str(key)] = str(value)
- default_item = "View/Modify"
- actions = {"View/Modify": modify_properties, "Delete": delete_properties}
- while 1:
- (code, choice) = d.menu(
- "Choose one of the following or press <Back> to exit.",
- width=MENU_WIDTH,
- choices=[("View/Modify", "View/Modify image properties"),
- ("Delete", "Delete image properties"),
- ("Exclude", "Exclude configuration tasks from running")],
- cancel="Back",
- default_item=default_item,
- title="Image Deployment Menu")
+ for (key, value) in image.os.meta.items():
+ metadata[str(key)] = str(value)
- if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
- break
- elif choice in actions:
- default_item = choice
- actions[choice](session)
+ out.success("done")
+ gauge.cleanup()
+ out.remove(gauge)
+ # Make sure the signal handler does not call gauge.cleanup again
+ def dummy(self):
+ pass
+ gauge.cleanup = type(GaugeOutput.cleanup)(dummy, gauge, GaugeOutput)
-def main_menu(session):
- d = session['dialog']
- dev = session['device']
- d.setBackgroundTitle("OS: %s, Distro: %s" % (dev.ostype, dev.distro))
- actions = {"Deploy": deploy_menu,
- "Register": kamaki_menu,
- "Extract": extract_image}
- default_item = "Customize"
+ session = {"dialog": d,
+ "disk": disk,
+ "image": image,
+ "metadata": metadata}
- while 1:
- (code, choice) = d.menu(
- "Choose one of the following or press <Exit> to exit.",
- width=MENU_WIDTH,
- choices=[("Customize", "Run various image customization tasks"),
- ("Deploy", "Configure ~okeanos image deployment options"),
- ("Register", "Register image to ~okeanos"),
- ("Extract", "Dump image to local file system"),
- ("Reset", "Reset everything and start over again"),
- ("Help", "Get help for using snf-image-creator")],
- cancel="Exit",
- default_item=default_item,
- title="Image Creator for ~okeanos (snf-image-creator version %s)" %
- version)
+ msg = "snf-image-creator detected a %s system on the input media. " \
+ "Would you like to run a wizard to assist you through the " \
+ "image creation process?\n\nChoose <Wizard> to run the wizard," \
+ " <Expert> to run the snf-image-creator in expert mode or " \
+ "press ESC to quit the program." \
+ % (image.ostype if image.ostype == image.distro or
+ image.distro == "unknown" else "%s (%s)" %
+ (image.ostype, image.distro))
+
+ update_background_title(session)
+
+ while True:
+ code = d.yesno(msg, width=WIDTH, height=12, yes_label="Wizard",
+ no_label="Expert")
+ if code == d.DIALOG_OK:
+ if start_wizard(session):
+ break
+ elif code == d.DIALOG_CANCEL:
+ main_menu(session)
+ break
- if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
if confirm_exit(d):
break
- else:
- continue
- if choice == "Reset":
- if confirm_reset(d):
- d.infobox("Resetting snf-image-creator. Please wait...")
- raise Reset
- else:
- continue
- elif choice in actions:
- actions[choice](session)
+ d.infobox("Thank you for using snf-image-creator. Bye", width=53)
+ finally:
+ disk.cleanup()
+
+ return 0
def select_file(d, media):
- root = os.sep
+ """Select a media file"""
+ if media == '/':
+ return '/'
+
+ default = os.getcwd() + os.sep
while 1:
if media is not None:
if not os.path.exists(media):
- d.msgbox("The file you choose does not exist",
- width=MSGBOX_WIDTH)
+ d.msgbox("The file `%s' you choose does not exist." % media,
+ width=SMALL_WIDTH)
else:
- break
-
- (code, media) = d.fselect(root, 10, 50,
- title="Please select input media")
+ mode = os.stat(media).st_mode
+ if not stat.S_ISDIR(mode):
+ break
+ default = media
+
+ (code, media) = d.fselect(default, 10, 60, extra_button=1,
+ title="Please select an input media.",
+ extra_label="Bundle Host")
if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
if confirm_exit(d, "You canceled the media selection dialog box."):
sys.exit(0)
else:
media = None
continue
+ elif code == d.DIALOG_EXTRA:
+ return '/'
return media
-def collect_metadata(dev, out):
-
- out.output("Collecting image metadata...")
- metadata = dev.meta
- dev.mount(readonly=True)
- cls = os_cls(dev.distro, dev.ostype)
- image_os = cls(dev.root, dev.g, out)
- dev.umount()
- metadata.update(image_os.meta)
- out.success("done")
-
- return metadata
-
-
-def image_creator(d):
- basename = os.path.basename(sys.argv[0])
- usage = "Usage: %s [input_media]" % basename
- if len(sys.argv) > 2:
- sys.stderr.write("%s\n" % usage)
- return 1
+def _dialog_form(self, text, height=20, width=60, form_height=15, fields=[],
+ **kwargs):
+ """Display a form box.
- if os.geteuid() != 0:
- raise FatalError("You must run %s as root" % basename)
+ fields is in the form: [(label1, item1, item_length1), ...]
+ """
- media = select_file(d, sys.argv[1] if len(sys.argv) == 2 else None)
+ cmd = ["--form", text, str(height), str(width), str(form_height)]
- out = InitializationOutput(d)
- disk = Disk(media, out)
+ label_len = 0
+ for field in fields:
+ if len(field[0]) > label_len:
+ label_len = len(field[0])
- def signal_handler(signum, fram):
- out.cleanup()
- disk.cleanup()
+ input_len = width - label_len - 1
- signal.signal(signal.SIGINT, signal_handler)
- try:
- snapshot = disk.snapshot()
- dev = disk.get_device(snapshot)
+ line = 1
+ for field in fields:
+ label = field[0]
+ item = field[1]
+ item_len = field[2]
+ cmd.extend((label, str(line), str(1), item, str(line),
+ str(label_len + 1), str(input_len), str(item_len)))
+ line += 1
- metadata = collect_metadata(dev, out)
- out.cleanup()
+ code, output = self._perform(*(cmd,), **kwargs)
- # Make sure the signal handler does not call out.cleanup again
- def dummy(self):
- pass
- instancemethod = type(InitializationOutput.cleanup)
- out.cleanup = instancemethod(dummy, out, InitializationOutput)
-
- session = {"dialog": d,
- "disk": disk,
- "snapshot": snapshot,
- "device": dev,
- "metadata": metadata}
-
- main_menu(session)
- d.infobox("Thank you for using snf-image-creator. Bye", width=53)
- finally:
- disk.cleanup()
+ if not output:
+ return (code, [])
- return 0
+ return (code, output.splitlines())
def main():
+ # In OpenSUSE dialog is buggy under xterm
+ if os.environ['TERM'] == 'xterm':
+ os.environ['TERM'] = 'linux'
+
d = dialog.Dialog(dialog="dialog")
# Add extra button in dialog library
dialog._common_args_syntax["extra_label"] = \
lambda string: ("--extra-label", string)
- while 1:
- try:
+ # Allow yes-no label overwriting
+ dialog._common_args_syntax["yes_label"] = \
+ lambda string: ("--yes-label", string)
+
+ dialog._common_args_syntax["no_label"] = \
+ lambda string: ("--no-label", string)
+
+ # Monkey-patch pythondialog to include support for form dialog boxes
+ if not hasattr(dialog, 'form'):
+ d.form = types.MethodType(_dialog_form, d)
+
+ usage = "Usage: %prog [options] [<input_media>]"
+ parser = optparse.OptionParser(version=version, usage=usage)
+ parser.add_option("-l", "--logfile", type="string", dest="logfile",
+ default=None, help="log all messages to FILE",
+ metavar="FILE")
+ parser.add_option("--tmpdir", type="string", dest="tmp", default=None,
+ help="create large temporary image files under DIR",
+ metavar="DIR")
+
+ options, args = parser.parse_args(sys.argv[1:])
+
+ if len(args) > 1:
+ parser.error("Wrong number of arguments")
+
+ d.setBackgroundTitle('snf-image-creator')
+
+ try:
+ if os.geteuid() != 0:
+ raise FatalError("You must run %s as root" %
+ parser.get_prog_name())
+
+ if options.tmp is not None and not os.path.isdir(options.tmp):
+ raise FatalError("The directory `%s' specified with --tmpdir is "
+ "not valid" % options.tmp)
+
+ logfile = None
+ if options.logfile is not None:
try:
- ret = image_creator(d)
- sys.exit(ret)
- except FatalError as e:
- msg = textwrap.fill(str(e), width=70)
- d.infobox(msg, width=70, title="Fatal Error")
- sys.exit(1)
- except Reset:
- continue
+ logfile = open(options.logfile, 'w')
+ except IOError as e:
+ raise FatalError(
+ "Unable to open logfile `%s' for writing. Reason: %s" %
+ (options.logfile, e.strerror))
+
+ media = select_file(d, args[0] if len(args) == 1 else None)
+
+ try:
+ log = SimpleOutput(False, logfile) if logfile is not None \
+ else Output()
+ while 1:
+ try:
+ out = CompositeOutput([log])
+ out.output("Starting %s v%s ..." %
+ (parser.get_prog_name(), version))
+ ret = create_image(d, media, out, options.tmp)
+ sys.exit(ret)
+ except Reset:
+ log.output("Resetting everything ...")
+ continue
+ finally:
+ if logfile is not None:
+ logfile.close()
+ except FatalError as e:
+ msg = textwrap.fill(str(e), width=WIDTH)
+ d.infobox(msg, width=WIDTH, title="Fatal Error")
+ sys.exit(1)
# vim: set sta sts=4 shiftwidth=4 sw=4 et ai :