code.grnet.gr Git - snf-image-creator/blob - image_creator/dialog_util.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # Copyright 2012 GRNET S.A. All rights reserved.
   4 #
   5 # Redistribution and use in source and binary forms, with or
   6 # without modification, are permitted provided that the following
   7 # conditions are met:
   8 #
   9 #   1. Redistributions of source code must retain the above
  10 #      copyright notice, this list of conditions and the following
  11 #      disclaimer.
  12 #
  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.
  17 #
  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.
  30 #
  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.
  35
  36 """Module providing useful functions for the dialog-based version of
  37 snf-image-creator.
  38 """
  39
  40 import os
  41 from image_creator.output.dialog import GaugeOutput
  42 from image_creator.util import MD5
  43
  44 SMALL_WIDTH = 60
  45 WIDTH = 70
  46
  47
  48 def update_background_title(session):
  49     """Update the backgroud title of the dialog page"""
  50     d = session['dialog']
  51     disk = session['disk']
  52     image = session['image']
  53
  54     MB = 2 ** 20
  55
  56     size = (image.size + MB - 1) // MB
  57     shrinked = 'shrinked' in session and session['shrinked']
  58     postfix = " (shrinked)" if shrinked else ''
  59
  60     title = "OS: %s, Distro: %s, Size: %dMB%s, Source: %s" % \
  61             (image.ostype, image.distro, size, postfix,
  62              os.path.abspath(disk.source))
  63
  64     d.setBackgroundTitle(title)
  65
  66
  67 def confirm_exit(d, msg=''):
  68     """Ask the user to confirm when exiting the program"""
  69     return not d.yesno("%s Do you want to exit?" % msg, width=SMALL_WIDTH)
  70
  71
  72 def confirm_reset(d):
  73     """Ask the user to confirm a reset action"""
  74     return not d.yesno("Are you sure you want to reset everything?",
  75                        width=SMALL_WIDTH, defaultno=1)
  76
  77
  78 class Reset(Exception):
  79     """Exception used to reset the program"""
  80     pass
  81
  82
  83 def extract_metadata_string(session):
  84     """Convert image metadata to text"""
  85     metadata = ['%s=%s' % (k, v) for (k, v) in session['metadata'].items()]
  86
  87     if 'task_metadata' in session:
  88         metadata.extend("%s=yes" % m for m in session['task_metadata'])
  89
  90     return '\n'.join(metadata) + '\n'
  91
  92
  93 def extract_image(session):
  94     """Dump the image to a local file"""
  95     d = session['dialog']
  96     dir = os.getcwd()
  97     while 1:
  98         if dir and dir[-1] != os.sep:
  99             dir = dir + os.sep
 100
 101         (code, path) = d.fselect(dir, 10, 50, title="Save image as...")
 102         if code in (d.DIALOG_CANCEL, d.DIALOG_ESC):
 103             return False
 104
 105         if os.path.isdir(path):
 106             dir = path
 107             continue
 108
 109         if os.path.isdir("%s.meta" % path):
 110             d.msgbox("Can't overwrite directory `%s.meta'" % path,
 111                      width=SMALL_WIDTH)
 112             continue
 113
 114         if os.path.isdir("%s.md5sum" % path):
 115             d.msgbox("Can't overwrite directory `%s.md5sum'" % path,
 116                      width=SMALL_WIDTH)
 117             continue
 118
 119         basedir = os.path.dirname(path)
 120         name = os.path.basename(path)
 121         if not os.path.exists(basedir):
 122             d.msgbox("Directory `%s' does not exist" % basedir,
 123                      width=SMALL_WIDTH)
 124             continue
 125
 126         dir = basedir
 127         if len(name) == 0:
 128             continue
 129
 130         files = ["%s%s" % (path, ext) for ext in ('', '.meta', '.md5sum')]
 131         overwrite = filter(os.path.exists, files)
 132
 133         if len(overwrite) > 0:
 134             if d.yesno("The following file(s) exist:\n"
 135                        "%s\nDo you want to overwrite them?" %
 136                        "\n".join(overwrite), width=SMALL_WIDTH):
 137                 continue
 138
 139         gauge = GaugeOutput(d, "Image Extraction", "Extracting image...")
 140         try:
 141             image = session['image']
 142             out = image.out
 143             out.add(gauge)
 144             try:
 145                 if "checksum" not in session:
 146                     md5 = MD5(out)
 147                     session['checksum'] = md5.compute(image.device, image.size)
 148
 149                 # Extract image file
 150                 image.dump(path)
 151
 152                 # Extract metadata file
 153                 out.output("Extracting metadata file ...")
 154                 with open('%s.meta' % path, 'w') as f:
 155                     f.write(extract_metadata_string(session))
 156                 out.success('done')
 157
 158                 # Extract md5sum file
 159                 out.output("Extracting md5sum file ...")
 160                 md5str = "%s %s\n" % (session['checksum'], name)
 161                 with open('%s.md5sum' % path, 'w') as f:
 162                     f.write(md5str)
 163                 out.success("done")
 164             finally:
 165                 out.remove(gauge)
 166         finally:
 167             gauge.cleanup()
 168         d.msgbox("Image file `%s' was successfully extracted!" % path,
 169                  width=SMALL_WIDTH)
 170         break
 171
 172     return True
 173
 174 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :