1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
# Methods and API for anaconda/firstboot 3rd party addons
#
# Copyright (C) 2012 Red Hat, Inc.
#
# This copyrighted material is made available to anyone wishing to use,
# modify, copy, or redistribute it subject to the terms and conditions of
# the GNU General Public License v.2, or (at your option) any later version.
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY expressed or implied, including the implied warranties of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
# Public License for more details. You should have received a copy of the
# GNU General Public License along with this program; if not, write to the
# Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA. Any Red Hat trademarks that are incorporated in the
# source code or documentation are not subject to the GNU General Public
# License and may only be used or replicated with the express permission of
# Red Hat, Inc.
#
# Red Hat Author(s): Martin Sivak <msivak@redhat.com>
#
__all__ = ["AddonSection", "AddonRegistry", "AddonData", "collect_addon_paths"]
import os
from pykickstart.sections import Section
from pykickstart.options import KSOptionParser
def collect_addon_paths(toplevel_addon_paths, ui_subdir="gui"):
"""This method looks into the directories present
in toplevel_addon_paths and registers each subdirectory
as a new addon identified by that subdirectory name.
It then registers spokes, categories and data (ks)
paths for the application to use. By default is looks
for spokes and categories in <addon>/gui/ subdirectory
but that can be changed using the ui_subdir argument."""
module_paths = {
"spokes": [],
"ks": [],
"categories": []
}
for path in toplevel_addon_paths:
try:
directories = os.listdir(path)
except OSError:
directories = []
for addon_id in directories:
addon_ks_path = os.path.join(path, addon_id, "ks")
if os.path.isdir(addon_ks_path):
module_paths["ks"].append(("%s.ks.%%s" % addon_id, addon_ks_path))
addon_spoke_path = os.path.join(path, addon_id, ui_subdir, "spokes")
if os.path.isdir(addon_spoke_path):
module_paths["spokes"].append(("%s.%s.spokes.%%s" % (addon_id, ui_subdir), addon_spoke_path))
addon_category_path = os.path.join(path, addon_id, ui_subdir, "categories")
if os.path.isdir(addon_spoke_path):
module_paths["categories"].append(("%s.%s.categories.%%s" % (addon_id, ui_subdir), addon_category_path))
return module_paths
class AddonRegistry(object):
"""This class represents the ksdata.addons object and
maintains the ids and data structures for loaded
addons.
It acts as a proxy during kickstart save.
"""
def __init__(self, dictionary):
self.__dict__ = dictionary
def __str__(self):
return reduce(lambda acc,(id, addon): acc + "%%addon %s\n%s%%end\n" % (id, str(addon)),
self.__dict__.iteritems(), "")
# pylint: disable-msg=C0103
def execute(self, storage, ksdata, instClass, users):
"""This method calls execute on all the registered addons."""
for k, v in self.__dict__.iteritems():
if hasattr(v, "execute"):
v.execute(storage, ksdata, instClass, users)
def setup(self, storage, ksdata, instClass):
"""This method calls setup on all the registered addons."""
for k, v in self.__dict__.iteritems():
if hasattr(v, "setup"):
v.setup(storage, ksdata, instClass)
class AddonData(object):
"""This is a common parent class for loading and storing
3rd party data to kickstart. It is instantiated by
kickstart parser and stored as ksdata.addons.<name>
to be used in the user interfaces.
The mandatory method handle_line receives all lines
from the corresponding addon section in kickstart and
the mandatory __str__ implementation is responsible for
returning the proper kickstart text (to be placed into
the %addon section) back.
There is also a mandatory method execute, which should
make all the described changes to the installed system.
"""
def __init__(self, name):
self.name = name
self.content = ""
def __str__(self):
return self.content
# pylint: disable-msg=C0103
def setup(self, storage, ksdata, instClass):
"""Make the changes to the install system.
This method is called before the installation
is started and directly from spokes. It must be possible
to call it multiple times without breaking the environment."""
pass
def execute(self, storage, ksdata, instClass, users):
"""Make the changes to the underlying system.
This method is called only once in the post-install
setup phase.
"""
pass
def handle_line(self, line):
"""Process one kickstart line."""
self.content += line
class AddonSection(Section):
sectionOpen = "%addon"
def __init__(self, *args, **kwargs):
Section.__init__(self, *args, **kwargs)
self.addon_id = None
def handleLine(self, line):
if not self.handler:
return
if not self.addon_id:
return
addon = getattr(self.handler.addons, self.addon_id)
addon.handle_line(line)
def handleHeader(self, lineno, args):
"""Process the arguments to the %addon header."""
Section.handleHeader(self, lineno, args)
op = KSOptionParser(version=self.version)
(_opts, extra) = op.parse_args(args=args[1:], lineno=lineno)
self.addon_id = extra[0]
# if the addon is not registered, create dummy placeholder for it
if self.addon_id and not hasattr(self.handler.addons, self.addon_id):
setattr(self.handler.addons, self.addon_id, AddonData(self.addon_id))
|
