/
actions.py
338 lines (263 loc) · 10.9 KB
/
actions.py
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
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
# -*- coding: utf-8 -*-
from Acquisition import aq_inner
from Acquisition import aq_parent
from collective.easyform import easyformMessageFactory as _
from collective.easyform.api import get_actions
from collective.easyform.api import get_context
from collective.easyform.api import get_schema
from collective.easyform.browser.fields import AjaxSaveHandler
from collective.easyform.interfaces import IActionEditForm
from collective.easyform.interfaces import IActionFactory
from collective.easyform.interfaces import IEasyFormActionContext
from collective.easyform.interfaces import IEasyFormActionsContext
from collective.easyform.interfaces import IEasyFormActionsEditorExtender
from collective.easyform.interfaces import IExtraData
from collective.easyform.interfaces import INewAction
from collective.easyform.interfaces import ISaveData
from collective.easyform.interfaces import ISavedDataFormWrapper
from plone.autoform.form import AutoExtensibleForm
from plone.memoize.instance import memoize
from plone.schemaeditor.browser.field.traversal import FieldContext
from plone.schemaeditor.browser.schema.add_field import FieldAddForm
from plone.schemaeditor.browser.schema.listing import SchemaListing
from plone.schemaeditor.browser.schema.listing import SchemaListingPage
from plone.schemaeditor.browser.schema.traversal import SchemaContext
from plone.schemaeditor.interfaces import IFieldEditFormSchema
from plone.schemaeditor.utils import SchemaModifiedEvent
from plone.z3cform import layout
from plone.z3cform.crud import crud
from plone.z3cform.interfaces import IDeferSecurityCheck
from plone.z3cform.traversal import WrapperWidgetTraversal
from Products.Five import BrowserView
from Products.Five.browser.pagetemplatefile import ViewPageTemplateFile
from z3c.form import button
from z3c.form import field
from z3c.form import form
from zope.cachedescriptors.property import Lazy as lazy_property
from zope.component import adapter
from zope.component import getAdapters
from zope.component import queryUtility
from zope.event import notify
from zope.i18nmessageid import MessageFactory
from zope.interface import alsoProvides
from zope.interface import implementer
from zope.interface import noLongerProvides
from zope.publisher.interfaces.browser import IBrowserRequest
from zope.schema import getFieldsInOrder
from ZPublisher.BaseRequest import DefaultPublishTraverse
PMF = MessageFactory("plone")
@adapter(ISavedDataFormWrapper, IBrowserRequest)
class SavedDataTraversal(WrapperWidgetTraversal):
def traverse(self, name, ignored):
form = self._prepareForm()
alsoProvides(self.request, IDeferSecurityCheck)
form.update()
noLongerProvides(self.request, IDeferSecurityCheck)
for subform in form.subforms:
if not hasattr(subform, "subforms"):
continue
for subsubform in subform.subforms:
if not name.startswith(subsubform.prefix):
continue
for id_ in subsubform.widgets:
subformname = subsubform.prefix + subsubform.widgets.prefix + id_
if subformname == name:
target = self._form_traverse(subsubform, id_)
target.__parent__ = aq_inner(self.context)
return target
return super(SavedDataTraversal, self).traverse(name, ignored)
class SavedDataView(BrowserView):
def items(self):
return [
(name, action.__doc__)
for name, action in getFieldsInOrder(get_actions(self.context))
if ISaveData.providedBy(action)
]
class DataWrapper(dict):
def __init__(self, sid, data, parent):
self.__sid__ = sid
self.update(data)
self.__parent__ = parent
class SavedDataForm(crud.CrudForm):
template = ViewPageTemplateFile("saveddata_form.pt")
addform_factory = crud.NullForm
@property
def field(self):
return self.context.field
@property
def name(self):
return self.field.__name__
@property
def get_schema(self):
return get_schema(get_context(self.field))
def description(self):
return _(u"${items} input(s) saved", mapping={"items": self.field.itemsSaved()})
@property
def update_schema(self):
fields = field.Fields(self.get_schema)
showFields = getattr(self.field, "showFields", [])
if showFields:
fields = fields.select(*showFields)
return fields
@property
def view_schema(self):
ExtraData = self.field.ExtraData
if ExtraData:
return field.Fields(IExtraData).select(*ExtraData)
def get_items(self):
return [
(key, DataWrapper(key, value, self.context))
for key, value in self.field.getSavedFormInputItems()
]
# def add(self, data):
# storage = self.context._inputStorage
def before_update(self, item, data):
id_ = item.__sid__
item.update(data)
self.field.setDataRow(id_, item.copy())
def remove(self, id_and_item):
(id, item) = id_and_item
self.field.delDataRow(id)
@button.buttonAndHandler(PMF(u"Download"), name="download")
def handleDownload(self, action):
pass
@button.buttonAndHandler(_(u"Clear all"), name="clearall")
def handleClearAll(self, action):
self.field.clearSavedFormInput()
@implementer(ISavedDataFormWrapper)
class SavedDataFormWrapper(layout.FormWrapper):
def __call__(self):
if hasattr(self.request, "form.buttons.download"):
self.context.field.download(self.request.response)
return u""
else:
return super(SavedDataFormWrapper, self).__call__()
ActionSavedDataView = layout.wrap_form(
SavedDataForm, __wrapper_class=SavedDataFormWrapper
)
@implementer(IEasyFormActionContext)
class EasyFormActionContext(FieldContext):
"""Wrapper for published zope 3 schema fields.
"""
def publishTraverse(self, request, name):
"""It's not valid to traverse to anything below a field context.
"""
# hack to make inline validation work
# (plone.app.z3cform doesn't know the form is the default view)
if name == self.__name__:
return ActionEditView(self, request)
return DefaultPublishTraverse(self, request).publishTraverse(request, name)
@implementer(IEasyFormActionsContext)
class EasyFormActionsView(SchemaContext):
schema = None
def __init__(self, context, request):
self.schema = get_actions(context)
super(EasyFormActionsView, self).__init__(self.schema, request, name="actions")
def publishTraverse(self, request, name):
"""Look up the field whose name matches the next URL path element,
and wrap it.
"""
try:
return EasyFormActionContext(self.schema[name], self.request).__of__(self)
except KeyError:
return DefaultPublishTraverse(self, request).publishTraverse(request, name)
def browserDefault(self, request):
"""If not traversing through the schema to a field, show the
SchemaListingPage.
"""
return self, ("@@listing",)
class EasyFormActionsListing(SchemaListing):
template = ViewPageTemplateFile("actions_listing.pt")
@memoize
def _field_factory(self, field):
field_identifier = u"{0}.{1}".format(field.__module__, field.__class__.__name__)
return queryUtility(IActionFactory, name=field_identifier)
@button.buttonAndHandler(PMF(u"Save"))
def handleSaveDefaults(self, action):
data, errors = self.extractData()
if errors:
self.status = self.formErrorsMessage
return
for fname, value in data.items():
self.context.schema[fname].required = value
notify(SchemaModifiedEvent(self.context))
# update widgets to take the new defaults into account
self.updateWidgets()
self.request.response.redirect(self.context.absolute_url())
def handleModelEdit(self, action):
self.request.response.redirect("@@modeleditor")
class EasyFormActionsListingPage(SchemaListingPage):
"""Form wrapper so we can get a form with layout.
We define an explicit subclass rather than using the wrap_form method
from plone.z3cform.layout so that we can inject the schema name into
the form label.
"""
form = EasyFormActionsListing
index = ViewPageTemplateFile("model_listing.pt")
class ActionAddForm(FieldAddForm):
schema = INewAction
fields = field.Fields() # let fields be updated by AutoExtensibleForm.updateFields
label = _("Add new action")
ActionAddFormPage = layout.wrap_form(ActionAddForm)
@implementer(IActionEditForm)
class ActionEditForm(AutoExtensibleForm, form.EditForm):
def __init__(self, context, request):
super(form.EditForm, self).__init__(context, request)
self.field = context.field
def getContent(self):
return self.field
@lazy_property
def schema(self):
return IFieldEditFormSchema(self.field)
@lazy_property
def additionalSchemata(self):
schema_context = self.context.aq_parent
adapters = getAdapters(
(schema_context, self.field), IEasyFormActionsEditorExtender
)
return [v for k, v in adapters]
@button.buttonAndHandler(PMF(u"Save"), name="save")
def handleSave(self, action):
data, errors = self.extractData()
if errors:
self.status = self.formErrorsMessage
return
changes = self.applyChanges(data)
if changes:
self.status = self.successMessage
else:
self.status = self.noChangesMessage
notify(SchemaModifiedEvent(self.context.aq_parent))
self.redirectToParent()
@button.buttonAndHandler(PMF(u"Cancel"), name="cancel")
def handleCancel(self, action):
self.redirectToParent()
def redirectToParent(self):
parent = aq_parent(aq_inner(self.context))
url = parent.absolute_url()
self.request.response.redirect(url)
class ActionEditView(layout.FormWrapper):
form = ActionEditForm
def __init__(self, context, request):
super(ActionEditView, self).__init__(context, request)
self.field = context.field
@lazy_property
def label(self):
return _(
u"Edit Action '${fieldname}'", mapping={"fieldname": self.field.__name__}
)
but = button.Button("modeleditor", title=_(u"Edit XML Actions Model"))
EasyFormActionsListing.buttons += button.Buttons(but)
handler = button.Handler(but, EasyFormActionsListing.handleModelEdit)
EasyFormActionsListing.handlers.addHandler(but, handler)
class ModelEditorView(BrowserView):
"""Editor view
"""
title = _(u"Edit XML Actions Model")
def modelSource(self):
return self.context.aq_parent.actions_model
class AjaxSaveHandler(AjaxSaveHandler):
"""Handle AJAX save posts
"""
def save(self, source):
self.context.aq_parent.actions_model = source