Add progress bar in pithos upload & compute md5sum
[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, progress as uiprogress
38
39
40 class FatalError(Exception):
41     pass
42
43
44 silent = False
45
46
47 def get_command(command):
48     def find_sbin_command(command, exception):
49         search_paths = ['/usr/local/sbin', '/usr/sbin', '/sbin']
50         for fullpath in map(lambda x: "%s/%s" % (x, command), search_paths):
51             if os.path.exists(fullpath) and os.access(fullpath, os.X_OK):
52                 return pbs.Command(fullpath)
53         raise exception
54
55     try:
56         return pbs.__getattr__(command)
57     except pbs.CommadNotFount as e:
58         return find_sbin_command(command, e)
59
60
61 def error(msg, new_line=True):
62     nl = "\n" if new_line else ''
63     sys.stderr.write(colored.red('Error: %s' % msg) + nl)
64
65
66 def warn(msg, new_line=True):
67     if not silent:
68         nl = "\n" if new_line else ''
69         sys.stderr.write(colored.yellow("Warning: %s" % msg) + nl)
70
71
72 def success(msg, new_line=True):
73     if not silent:
74         nl = "\n" if new_line else ''
75         sys.stdout.write(colored.green(msg) + nl)
76         if not nl:
77             sys.stdout.flush()
78
79
80 def output(msg="", new_line=True):
81     if not silent:
82         nl = "\n" if new_line else ''
83         sys.stdout.write(msg + nl)
84         if not nl:
85             sys.stdout.flush()
86
87
88 def progress(message=''):
89
90     PROGRESS_LENGTH = 32
91     MESSAGE_LENGTH = 32
92
93     def progress_generator(n=100):
94         position = 0
95         msg = message.ljust(MESSAGE_LENGTH)
96         for i in uiprogress.bar(range(n), msg, PROGRESS_LENGTH, silent):
97             if i < position:
98                 continue
99             position = yield
100         yield  # suppress the StopIteration exception
101     return progress_generator
102
103 def md5(filename, size, progress = None):
104
105     BLOCKSIZE = 2^22  # 4MB
106
107     md5 = hashlib.md5()
108     with open(filename, "r") as src:
109         left = size
110         while left > 0:
111             length = min(left, BLOCKSIZE)
112             data = src.read(length)
113             md5.update(data)
114             left -= length
115
116     return md5.hexdigest()
117
118 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :