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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
|
# Copyright (c) 2002-2010 Infrae. All rights reserved.
# See also LICENSE.txt
# $Id: ExtensionRegistry.py 44885 2010-08-31 14:57:58Z sylvain $
from bisect import insort_right
import os.path
import pkg_resources
import types
from zope.configuration.name import resolve
from zope.interface import implements
from zope.testing import cleanup
import Products
from silva.core.conf.registry import Registry
from silva.core import interfaces
class Addable(object):
def __init__(self, meta_type, priority=0.0):
self.meta_type = meta_type
self.priority = priority
def __cmp__(self, other):
sort = cmp(self.priority, other.priority)
if sort == 0:
sort = cmp(self.meta_type['name'], other.meta_type['name'])
return sort
class BaseExtension(object):
"""Base for extensions.
"""
def __init__(self, name, install, path,
description=None, depends=(u'Silva',)):
self._name = name
self._description = description
self._install = install
self._module_name = path
if depends and not (isinstance(depends, types.ListType) or
isinstance(depends, types.TupleType)):
depends = (depends,)
self._depends = depends
@property
def name(self):
return self._name
@property
def product(self):
return self._product
@property
def module_name(self):
return self._module_name
@property
def module_directory(self):
return os.path.dirname(self.module.__file__)
@property
def module(self):
return resolve(self.module_name)
@property
def version(self):
return self._version
@property
def description(self):
return self._description
@property
def installer(self):
return self._install
@property
def depends(self):
return self._depends
def get_content(self):
# XXX Maybe rename that to get_content_types.
result = []
my_name = self.name
for content in Products.meta_types:
if content['product'] == my_name:
result.append(content)
return result
class ProductExtension(BaseExtension):
"""Extension based on a Zope product.
"""
implements(interfaces.IExtension)
def __init__(self, name, install, path,
description=None, depends=(u'Silva',)):
super(ProductExtension, self).__init__(name, install, path,
description, depends)
assert path.startswith('Products.')
self._product = path.split('.')[1]
self._version = open(os.path.join(
self.module_directory, 'version.txt')).read()
@property
def module_name(self):
return 'Products.%s' % self._product
class EggExtension(BaseExtension):
"""Extension package as an egg.
"""
implements(interfaces.IExtension)
def __init__(self, egg, name, install, path,
description=None, depends=(u'Silva',)):
super(EggExtension, self).__init__(
name, install, path, description, depends)
# We assume that the name of this egg is the name of the
# python extension.
if path.startswith('Products.'):
self._product = path.split('.', 1)[1]
else:
self._product = path
self._module_name = path
self._version = egg.version
@property
def module_name(self):
return self._module_name
class ExtensionRegistry(Registry):
implements(interfaces.IExtensionRegistry)
def __init__(self):
self.clear_registry()
# MANIPULATORS
def clear_registry(self):
"""Clear the registry. *Don't call this in regular order of operation*.
"""
self._extensions_order = []
self._extensions = {}
self._extensions_by_module = {}
self._silva_addables = []
def register(self, name, description, context, modules,
install_module=None, module_path=None,
depends_on=(u'Silva',)):
# Figure out which is the extension path.
path = None
assert not ((install_module is None) and (module_path is None))
if module_path:
path = resolve(module_path).__file__
elif isinstance(install_module, types.ModuleType):
# Installer is a module install.py which HAVE TO BE in the
# extension package.
module_path = '.'.join(install_module.__name__.split('.')[:-1])
path = install_module.__file__
else:
# Installer is a class in the __init__.py of the extension.
module_path = install_module.__module__
path = resolve(module_path).__file__
# Search throught eggs to see if extension is an egg.
ext = None
for egg in pkg_resources.working_set:
if (path.startswith(egg.location) and
path[len(egg.location)] == os.path.sep):
ext = EggExtension(
egg, name, install_module, module_path,
description, depends_on)
break
# Otherwise, that's a product.
if ext is None:
ext = ProductExtension(
name, install_module, module_path,
description, depends_on)
self._extensions[ext.name] = ext
self._extensions_by_module[ext.module_name] = ext
# Try to order based on dependencies
self._orderExtensions()
for module in modules:
self.registerClass(context, module)
def addAddable(self, meta_type, priority):
"""Allow adding an addable to silva without using the
registerClass shortcut method.
"""
meta_types = Products.meta_types
for mt_dict in meta_types:
if mt_dict['name'] == meta_type:
mt_dict['doc'] = mt_dict['instance'].__doc__
insort_right(self._silva_addables, Addable(mt_dict, priority))
def _orderExtensions(self):
"""Reorder extensions based on depends_on constraints.
"""
# make mapping from name depended on to names that depend on it
depends_on_mapping = {}
for value in self._extensions.values():
if not value.depends:
depends_on_mapping.setdefault(None, []).append(value.name)
continue
for do in value.depends:
depends_on_mapping.setdefault(do, []).append(value.name)
# if depends_on is None, this should be first in the list
added = depends_on_mapping.get(None, [])
# now add them to the list and get dependencies in turn
result = []
while added:
new_added = []
for name in added:
if name in result:
result.remove(name)
result.append(name)
new_added.extend(depends_on_mapping.get(name, []))
added = new_added
self._extensions_order = result
def install(self, name, root):
self._extensions[name].installer.install(root)
def uninstall(self, name, root):
self._extensions[name].installer.uninstall(root)
def refresh(self, name, root):
if hasattr(self._extensions[name].installer, 'refresh'):
# installer has a refresh, so use it note: the default
# refresh (in silva.core.conf.installer.DefaultInstaller)
# is to just uninstall/install. Extensions may choose to
# override this to do a custom uninstall/install which may,
# e.g. not remove a special service_<extension> object
# which contains site-specific customizations
self._extensions[name].installer.refresh(root)
else:
self._extensions[name].installer.uninstall(root)
self._extensions[name].installer.install(root)
# ACCESSORS
def get_names(self):
return self._extensions_order
def get_extension(self, name):
return self._extensions.get(name, None)
def have(self, name):
return name in self._extensions_order
def is_installed(self, name, root):
extension = self.get_extension(name)
if extension:
return extension.installer.is_installed(root)
return False
def get_name_for_class(self, class_):
path = class_.__module__
for module in self._extensions_by_module.keys():
if (path.startswith(module) and
(len(path) == len(module) or
path[len(module)] == '.')):
return self._extensions_by_module[module].name
return None
def get_addables(self):
return [addable.meta_type for addable in self._silva_addables]
def get_addable(self, content_type):
for addable in self._silva_addables:
if content_type == addable.meta_type['name']:
return addable.meta_type
return {}
extensionRegistry = ExtensionRegistry()
# Cleanup registry on test tearDown
cleanup.addCleanUp(extensionRegistry.clear_registry)
|