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
|
# Plone Solutions AS <info@plonesolutions.com>
# http://www.plonesolutions.com
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
"""
utilities
$Id: utils.py,v 1.4.2.2 2004/04/21 14:39:51 tesdal Exp $
"""
__version__ = "$Revision: 1.4.2.2 $"
from types import FunctionType as function
# Method generation for ITranslatable content with language independent fields
from Products.Archetypes.ClassGen import Generator as ATGenerator, ClassGenerator as ATClassGenerator, GeneratorError, _modes
from Products.Archetypes.ArchetypeTool import registerType as registerATType, getType
from Products.LinguaPlone.config import KWARGS_TRANSLATION_KEY, RELATIONSHIP
AT_GENERATE_METHOD = []
_modes.update({
't' : { 'prefix' : 'setTranslation',
'attr' : 'translation_mutator',
'security' : 'write_permission',
},
})
class Generator(ATGenerator):
"""Generate methods for language independent fields"""
def makeMethod(self, klass, field, mode, methodName):
name = field.getName()
method = None
if mode == "r":
def generatedAccessor(self, **kw):
"""Default Accessor."""
if self.isCanonical():
if kw.has_key('schema'):
schema = kw['schema']
else:
schema = self.Schema()
kw['schema'] = schema
return schema[name].get(self, **kw)
else:
return getattr(self.getCanonical(), methodName)(**kw)
method = generatedAccessor
elif mode == "m":
def generatedEditAccessor(self, **kw):
"""Default Edit Accessor."""
if self.isCanonical():
if kw.has_key('schema'):
schema = kw['schema']
else:
schema = self.Schema()
kw['schema'] = schema
return schema[name].getRaw(self, **kw)
else:
return getattr(self.getCanonical(), methodName)(**kw)
method = generatedEditAccessor
elif mode == "w":
# the generatedMutator doesn't actually mutate, but calls a
# translation mutator on all translations, including self.
def generatedMutator(self, value, **kw):
"""Default Mutator."""
if kw.has_key('schema'):
schema = kw['schema']
else:
schema = self.Schema()
kw['schema'] = schema
translations = [t[0] for t in self.getTranslations().values()]
# reverse to return the result of the canonical mutator
translations.reverse()
translationMethodName = schema[name].translation_mutator
res = None
for t in translations:
res = getattr(t, translationMethodName)(value, **kw)
return res
method = generatedMutator
elif mode == "t":
# The translation mutator that changes data
def generatedTranslationMutator(self, value, **kw):
""" Delegated Mutator """
if kw.has_key('schema'):
schema = kw['schema']
else:
schema = self.Schema()
kw['schema'] = schema
return schema[name].set(self, value, **kw)
method = generatedTranslationMutator
else:
raise GeneratorError("""Unhandled mode for method creation:
%s:%s -> %s:%s""" %(klass.__name__,
name,
methodName,
mode))
# Zope security requires all security protected methods to have a
# function name. It uses this name to determine which roles are allowed
# to access the method.
# This code is renaming the internal name from e.g. generatedAccessor to
# methodName.
method = function(method.func_code,
method.func_globals,
methodName,
method.func_defaults,
method.func_closure,
)
setattr(klass, methodName, method)
class ClassGenerator(ATClassGenerator):
"""Generate methods for language independent fields"""
def generateClass(self, klass):
# We are going to assert a few things about the class here
# before we start, set meta_type, portal_type based on class
# name, but only if they are not set yet
if (not getattr(klass, 'meta_type', None) or
'meta_type' not in klass.__dict__):
klass.meta_type = klass.__name__
if (not getattr(klass, 'portal_type', None) or
'portal_type' not in klass.__dict__):
klass.portal_type = klass.__name__
klass.archetype_name = getattr(klass, 'archetype_name',
self.generateName(klass))
self.checkSchema(klass)
fields = klass.schema.fields()
# Find the languageIndependent fields.
fields = [field for field in fields if field.languageIndependent]
self.generateMethods(klass, fields)
def generateMethods(self, klass, fields):
generator = Generator()
for field in fields:
assert not 'm' in field.mode, 'm is an implicit mode'
assert not 't' in field.mode, 't is an implicit mode'
# Make sure we want to muck with the class for this field
if "c" not in field.generateMode: continue
type = getattr(klass, 'type')
for mode in field.mode: #(r, w)
self.handle_mode(klass, generator, type, field, mode)
if mode == 'w':
self.handle_mode(klass, generator, type, field, 'm')
self.handle_mode(klass, generator, type, field, 't')
def handle_mode(self, klass, generator, type, field, mode):
attr = _modes[mode]['attr']
# Did the field request a specific method name?
methodName = getattr(field, attr, None)
if not methodName:
methodName = generator.computeMethodName(field, mode)
# If there is already a mutator, make that the translation mutator
if methodName in klass.__dict__.keys() and mode == 'w':
setattr(klass, generator.computeMethodName(field, 't'), getattr(klass, methodName))
delattr(klass, methodName)
# Avoid name space conflicts
if not methodName in klass.__dict__.keys() \
or getattr(klass, methodName) is AT_GENERATE_METHOD:
if type.has_key(methodName):
raise GeneratorError("There is a conflict"
"between the Field(%s) and the attempt"
"to generate a method of the same name on"
"class %s" % (
methodName,
klass.__name__))
# Make a method for this klass/field/mode
generator.makeMethod(klass, field, mode, methodName)
self.updateSecurity(klass, field, mode, methodName)
# Note on the class what we did (even if the method existed)
attr = _modes[mode]['attr']
setattr(field, attr, methodName)
_cg = ClassGenerator()
generateClass = _cg.generateClass
generateMethods = _cg.generateMethods
def registerType(klass, package=None):
"""Overrides the AT registerType to enable method generation for language independent fields"""
# Generate methods for language independent fields
generateClass(klass)
# Pass on to the regular AT registerType
registerATType(klass, package)
def generateCtor(name, module):
ctor = """
def add%(name)s(self, id, **kwargs):
o = %(name)s(id)
self._setObject(id, o)
o = getattr(self, id)
canonical = None
if kwargs.has_key('%(KWARGS_TRANSLATION_KEY)s'):
canonical = kwargs.get('%(KWARGS_TRANSLATION_KEY)s')
del kwargs['%(KWARGS_TRANSLATION_KEY)s']
o.initializeArchetype(**kwargs)
if canonical is not None:
o.addReference(canonical, '%(RELATIONSHIP)s')
return id
""" % {'name':name, 'KWARGS_TRANSLATION_KEY':KWARGS_TRANSLATION_KEY, 'RELATIONSHIP':RELATIONSHIP}
exec ctor in module.__dict__
return getattr(module, "add%s" % name)
# Exact copy of ArchetypeTool.process_type, but with new generateCtor
import sys
from copy import deepcopy
from Products.Archetypes.ArchetypeTool import base_factory_type_information, modify_fti
def process_types(types, pkg_name):
content_types = ()
constructors = ()
ftis = ()
for rti in types:
typeName = rti['name']
klass = rti['klass']
module = rti['module']
if hasattr(module, "factory_type_information"):
fti = module.factory_type_information
else:
fti = deepcopy(base_factory_type_information)
modify_fti(fti, klass, pkg_name)
# Add a callback to modifty the fti
if hasattr(module, "modify_fti"):
module.modify_fti(fti[0])
else:
m = None
for k in klass.__bases__:
base_module = sys.modules[k.__module__]
if hasattr(base_module, "modify_fti"):
m = base_module
break
if m is not None:
m.modify_fti(fti[0])
ctor = getattr(module, "add%s" % typeName, None)
if ctor is None:
ctor = generateCtor(typeName, module)
content_types += (klass,)
constructors += (ctor,)
ftis += fti
return content_types, constructors, ftis
|
