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

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