1 # Copyright 2012 GRNET S.A. All rights reserved.
3 # Redistribution and use in source and binary forms, with or
4 # without modification, are permitted provided that the following
7 # 1. Redistributions of source code must retain the above
8 # copyright notice, this list of conditions and the following
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.
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.
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.
34 from image_creator.util import output
39 def add_prefix(target):
40 def wrapper(self, *args):
42 return map(lambda x: prefix + x, target(self, *args))
46 def exclude_task(func):
52 """Basic operating system class"""
53 def __init__(self, rootdev, ghandler):
58 def ls(self, directory):
59 """List the name of all files under a directory"""
60 return self.g.ls(directory)
63 def find(self, directory):
64 """List the name of all files recursively under a directory"""
65 return self.g.find(directory)
67 def foreach_file(self, directory, action, **kargs):
68 """Perform an action recursively on all files under a directory.
70 The following options are allowed:
72 * maxdepth: If defined the action will not be performed on
73 files that are below this level of directories under the
76 * ftype: The action will only be performed on files of this
77 type. For a list of all allowed filetypes, see here:
78 http://libguestfs.org/guestfs.3.html#guestfs_readdir
80 * exclude: Exclude all files that follow this pattern.
82 maxdepth = None if 'maxdepth' not in kargs else kargs['maxdepth']
87 maxdepth = None if maxdepth is None else maxdepth - 1
88 kargs['maxdepth'] = maxdepth
90 exclude = None if 'exclude' not in kargs else kargs['exclude']
91 ftype = None if 'ftype' not in kargs else kargs['ftype']
92 has_ftype = lambda x, y: y is None and True or x['ftyp'] == y
94 for f in self.g.readdir(directory):
95 if f['name'] in ('.', '..'):
98 full_path = "%s/%s" % (directory, f['name'])
100 if exclude and re.match(exclude, full_path):
103 if has_ftype(f, 'd'):
104 self.foreach_file(full_path, action, **kargs)
106 if has_ftype(f, ftype):
109 def get_metadata(self):
110 """Returns some descriptive metadata about the OS."""
112 meta['ROOT_PARTITION'] = "%d" % self.g.part_to_partnum(self.root)
113 meta['OSFAMILY'] = self.g.inspect_get_type(self.root)
114 meta['OS'] = self.g.inspect_get_distro(self.root)
115 meta['DESCRIPTION'] = self.g.inspect_get_product_name(self.root)
119 def data_cleanup(self):
120 """Cleanup sensitive data out of the OS image."""
122 output('Cleaning up sensitive data out of the OS image:')
124 tasks, _ = self.list_data_cleanup()
129 output(('(%d/%d)' % (cnt, size)).ljust(7), False)
134 """Prepere system for image creation."""
136 output('Preparing system for image creation:')
138 tasks, _ = self.list_sysprep()
143 output(('(%d/%d)' % (cnt, size)).ljust(7), False)
147 def list_sysprep(self):
148 """List all sysprep actions"""
150 is_sysprep = lambda x: x.startswith('sysprep_') and \
151 callable(getattr(self, x))
152 tasks = [getattr(self, x) for x in dir(self) if is_sysprep(x)]
154 included = [t for t in tasks if not getattr(t, "excluded", False)]
155 excluded = [t for t in tasks if getattr(t, "excluded", False)]
157 return included, excluded
159 def list_data_cleanup(self):
160 """List all data_cleanup actions"""
162 is_cleanup = lambda x: x.startswith('data_cleanup_') and \
163 callable(getattr(self, x))
164 tasks = [getattr(self, x) for x in dir(self) if is_cleanup(x)]
166 included = [t for t in tasks if not getattr(t, "excluded", False)]
167 excluded = [t for t in tasks if getattr(t, "excluded", False)]
169 return included, excluded
171 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :