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):
57 self.sysprep_regexp = re.compile('^sysprep_')
58 self.data_cleanup_regexp = re.compile('^data_cleanup_')
60 def _print_task(self, task):
63 if self.sysprep_regexp.match(name):
64 name = self.sysprep_regexp.sub("", name)
65 elif self.data_cleanup_regexp.match(name):
66 name = self.data_cleanup_regexp.sub("", name)
68 raise FatalError("%s is not a task" % name)
70 name = name.replace('_', '-')
72 output(" %s:\n %s" % (name, task.__doc__))
75 def ls(self, directory):
76 """List the name of all files under a directory"""
77 return self.g.ls(directory)
80 def find(self, directory):
81 """List the name of all files recursively under a directory"""
82 return self.g.find(directory)
84 def foreach_file(self, directory, action, **kargs):
85 """Perform an action recursively on all files under a directory.
87 The following options are allowed:
89 * maxdepth: If defined the action will not be performed on
90 files that are below this level of directories under the
93 * ftype: The action will only be performed on files of this
94 type. For a list of all allowed filetypes, see here:
95 http://libguestfs.org/guestfs.3.html#guestfs_readdir
97 * exclude: Exclude all files that follow this pattern.
99 maxdepth = None if 'maxdepth' not in kargs else kargs['maxdepth']
104 maxdepth = None if maxdepth is None else maxdepth - 1
105 kargs['maxdepth'] = maxdepth
107 exclude = None if 'exclude' not in kargs else kargs['exclude']
108 ftype = None if 'ftype' not in kargs else kargs['ftype']
109 has_ftype = lambda x, y: y is None and True or x['ftyp'] == y
111 for f in self.g.readdir(directory):
112 if f['name'] in ('.', '..'):
115 full_path = "%s/%s" % (directory, f['name'])
117 if exclude and re.match(exclude, full_path):
120 if has_ftype(f, 'd'):
121 self.foreach_file(full_path, action, **kargs)
123 if has_ftype(f, ftype):
126 def get_metadata(self):
127 """Returns some descriptive metadata about the OS."""
129 meta['ROOT_PARTITION'] = "%d" % self.g.part_to_partnum(self.root)
130 meta['OSFAMILY'] = self.g.inspect_get_type(self.root)
131 meta['OS'] = self.g.inspect_get_distro(self.root)
132 meta['DESCRIPTION'] = self.g.inspect_get_product_name(self.root)
136 def list_sysprep(self):
137 """List all sysprep actions"""
139 is_sysprep = lambda x: x.startswith('sysprep_') and \
140 callable(getattr(self, x))
141 tasks = [getattr(self, x) for x in dir(self) if is_sysprep(x)]
143 included = [t for t in tasks if not getattr(t, "excluded", False)]
144 excluded = [t for t in tasks if getattr(t, "excluded", False)]
146 return included, excluded
148 def list_data_cleanup(self):
149 """List all data_cleanup actions"""
151 is_cleanup = lambda x: x.startswith('data_cleanup_') and \
152 callable(getattr(self, x))
153 tasks = [getattr(self, x) for x in dir(self) if is_cleanup(x)]
155 included = [t for t in tasks if not getattr(t, "excluded", False)]
156 excluded = [t for t in tasks if getattr(t, "excluded", False)]
158 return included, excluded
160 def data_cleanup(self):
161 """Cleanup sensitive data out of the OS image."""
163 output('Cleaning up sensitive data out of the OS image:')
165 tasks, _ = self.list_data_cleanup()
170 output(('(%d/%d)' % (cnt, size)).ljust(7), False)
175 """Prepere system for image creation."""
177 output('Preparing system for image creation:')
179 tasks, _ = self.list_sysprep()
184 output(('(%d/%d)' % (cnt, size)).ljust(7), False)
188 def print_task(self, task):
191 if self.sysprep_regexp.match(name):
192 name = self.sysprep_regexp.sub("", name)
193 elif self.data_cleanup_regexp.match(name):
194 name = self.data_cleanup_regexp.sub("", name)
196 raise FatalError("%s is not a task" % name)
198 name = name.replace('_', '-')
200 output(" %s:\n %s" % (name, task.__doc__))
202 def print_data_cleanup(self):
203 included, excluded = self.list_data_cleanup()
205 output("Included data cleanup operations:")
206 if len(included) == 0:
209 for task in included:
210 self._print_task(task)
211 output("Ommited data cleanup operations:")
212 if len(excluded) == 0:
215 for task in excluded:
216 self._print_task(task)
218 def print_sysprep(self):
219 included, excluded = self.list_sysprep()
221 output("Included sysprep operations:")
222 if len(included) == 0:
225 for task in included:
226 self._print_task(task)
227 output("Ommited sysprep operations:")
228 if len(excluded) == 0:
231 for task in excluded:
232 self._print_task(task)
234 # vim: set sta sts=4 shiftwidth=4 sw=4 et ai :