Use progress for progress bar & implement register
[snf-image-creator] / image_creator / util.py
1 # Copyright 2012 GRNET S.A. All rights reserved.
2 #
3 # Redistribution and use in source and binary forms, with or
4 # without modification, are permitted provided that the following
5 # conditions are met:
6 #
7 #   1. Redistributions of source code must retain the above
8 #      copyright notice, this list of conditions and the following
9 #      disclaimer.
10 #
11 #   2. Redistributions in binary form must reproduce the above
12 #      copyright notice, this list of conditions and the following
13 #      disclaimer in the documentation and/or other materials
14 #      provided with the distribution.
15 #
16 # THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
17 # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 # WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19 # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
20 # CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
23 # USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
24 # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
26 # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 # POSSIBILITY OF SUCH DAMAGE.
28 #
29 # The views and conclusions contained in the software and
30 # documentation are those of the authors and should not be
31 # interpreted as representing official policies, either expressed
32 # or implied, of GRNET S.A.
33
34 import sys
35 import pbs
36 import hashlib
37 from clint.textui import colored
38 from progress.bar import Bar
39
40
41 class FatalError(Exception):
42     pass
43
44
45 silent = False
46
47
48 def get_command(command):
49     def find_sbin_command(command, exception):
50         search_paths = ['/usr/local/sbin', '/usr/sbin', '/sbin']
51         for fullpath in map(lambda x: "%s/%s" % (x, command), search_paths):
52             if os.path.exists(fullpath) and os.access(fullpath, os.X_OK):
53                 return pbs.Command(fullpath)
54         raise exception
55
56     try:
57         return pbs.__getattr__(command)
58     except pbs.CommadNotFount as e:
59         return find_sbin_command(command, e)
60
61
62 def error(msg, new_line=True):
63     nl = "\n" if new_line else ''
64     sys.stderr.write(colored.red('Error: %s' % msg) + nl)
65
66
67 def warn(msg, new_line=True):
68     if not silent:
69         nl = "\n" if new_line else ''
70         sys.stderr.write(colored.yellow("Warning: %s" % msg) + nl)
71
72
73 def success(msg, new_line=True):
74     if not silent:
75         nl = "\n" if new_line else ''
76         sys.stdout.write(colored.green(msg) + nl)
77         if not nl:
78             sys.stdout.flush()
79
80
81 def output(msg="", new_line=True):
82     if not silent:
83         nl = "\n" if new_line else ''
84         sys.stdout.write(msg + nl)
85         if not nl:
86             sys.stdout.flush()
87
88
89 def progress(message='', bar_type="default"):
90
91     MESSAGE_LENGTH = 30
92     
93     suffix={'default':'%(index)d/%(max)d',
94         'percent':'%(percent)d%%',
95         'b':'%(index)d/%(max)d B',
96         'kb':'%(index)d/%(max)d KB',
97         'mb':'%(index)d/%(max)d MB'}
98
99     return Bar(message=message.ljust(MESSAGE_LENGTH), fill='#', \
100                                                     suffix=suffix[bar_type])
101
102 def md5(filename, size):
103
104     BLOCKSIZE = 2 ** 22  # 4MB
105
106     progressbar = progress("Calculating md5sum:", 'mb')
107     progressbar.max = (size // (2 ** 20))
108     md5 = hashlib.md5()
109     with open(filename, "r") as src:
110         left = size
111         while left > 0:
112             length = min(left, BLOCKSIZE)
113             data = src.read(length)
114             md5.update(data)
115             left -= length
116             progressbar.goto((size - left) // (2 ** 20))
117     
118     checksum = md5.hexdigest()
119     output("\rCalculating md5sum...\033[K", False)
120     success(checksum)
121
122     return checksum
123
124 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :