|
1 |
# w.c.s. - web application for online forms
|
|
2 |
# Copyright (C) 2005-2016 Entr'ouvert
|
|
3 |
#
|
|
4 |
# This program is free software; you can redistribute it and/or modify
|
|
5 |
# it under the terms of the GNU General Public License as published by
|
|
6 |
# the Free Software Foundation; either version 2 of the License, or
|
|
7 |
# (at your option) any later version.
|
|
8 |
#
|
|
9 |
# This program is distributed in the hope that it will be useful,
|
|
10 |
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
11 |
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
12 |
# GNU General Public License for more details.
|
|
13 |
#
|
|
14 |
# You should have received a copy of the GNU General Public License
|
|
15 |
# along with this program; if not, see <http://www.gnu.org/licenses/>.
|
|
16 |
|
|
17 |
import collections
|
|
18 |
import copy
|
|
19 |
import time
|
|
20 |
import xml.etree.ElementTree as ET
|
|
21 |
|
|
22 |
from quixote import get_request, get_session
|
|
23 |
|
|
24 |
from django.utils.functional import cached_property
|
|
25 |
|
|
26 |
from wcs.qommon import _
|
|
27 |
from wcs.qommon.form import (WidgetListAsTable, CompositeWidget,
|
|
28 |
SingleSelectWidget, ComputedExpressionWidget,
|
|
29 |
CheckboxWidget, StringWidget, VarnameWidget)
|
|
30 |
|
|
31 |
from wcs.logged_errors import LoggedError
|
|
32 |
from wcs.workflows import WorkflowStatusItem, register_item_class
|
|
33 |
from wcs.formdef import FormDef
|
|
34 |
from wcs.variables import LazyFormData
|
|
35 |
|
|
36 |
|
|
37 |
Mapping = collections.namedtuple('Mapping', ['varname', 'expression'])
|
|
38 |
|
|
39 |
|
|
40 |
class MappingWidget(CompositeWidget):
|
|
41 |
def __init__(self, name, value=None, to_formdef=None, **kwargs):
|
|
42 |
value = value or Mapping(None, '')
|
|
43 |
super(MappingWidget, self).__init__(name, value, **kwargs)
|
|
44 |
|
|
45 |
to_fields = self._fields_to_options(to_formdef)
|
|
46 |
|
|
47 |
self.add(SingleSelectWidget,
|
|
48 |
name='varname',
|
|
49 |
title=_('Field'),
|
|
50 |
value=value.varname,
|
|
51 |
options=to_fields)
|
|
52 |
|
|
53 |
self.add(ComputedExpressionWidget,
|
|
54 |
name='expression',
|
|
55 |
title=_('Expression'),
|
|
56 |
value=value.expression)
|
|
57 |
|
|
58 |
def _fields_to_options(self, formdef):
|
|
59 |
return [(None, '---', '')] + [
|
|
60 |
(field.varname, field.label, field.varname) for field in formdef.get_all_varname_fields()]
|
|
61 |
|
|
62 |
def _parse(self, request):
|
|
63 |
super(MappingWidget, self)._parse(request)
|
|
64 |
if self.get('varname') is not None and self.get('expression') is not None:
|
|
65 |
self.value = Mapping(varname=self.get('varname'), expression=self.get('expression'))
|
|
66 |
else:
|
|
67 |
self.value = None
|
|
68 |
|
|
69 |
|
|
70 |
class MappingsWidget(WidgetListAsTable):
|
|
71 |
readonly = False
|
|
72 |
|
|
73 |
# widget_list.js does not work with ComputedExpressionWidget,
|
|
74 |
# so we revert to quixote behabiour for adding a line
|
|
75 |
def add_media(self):
|
|
76 |
pass
|
|
77 |
|
|
78 |
def __init__(self, name, to_formdef=None, **kwargs):
|
|
79 |
self.to_formdef = to_formdef
|
|
80 |
|
|
81 |
value = kwargs.get('value')
|
|
82 |
if value:
|
|
83 |
# reorder mappings based on to_formdef fields order
|
|
84 |
value.sort(key=lambda mapping: self.ranks.get(mapping.varname, 9999))
|
|
85 |
|
|
86 |
super(MappingsWidget, self).__init__(
|
|
87 |
name,
|
|
88 |
element_type=MappingWidget,
|
|
89 |
element_kwargs={
|
|
90 |
'to_formdef': to_formdef,
|
|
91 |
},
|
|
92 |
**kwargs)
|
|
93 |
|
|
94 |
@cached_property
|
|
95 |
def ranks(self):
|
|
96 |
return {field.varname: i for i, field in enumerate(
|
|
97 |
field for field in self.to_formdef.get_all_varname_fields())}
|
|
98 |
|
|
99 |
def _parse(self, request):
|
|
100 |
super(MappingsWidget, self)._parse(request)
|
|
101 |
|
|
102 |
if self.value:
|
|
103 |
# prevent many mappings to the same field
|
|
104 |
if len(set(mapping.varname for mapping in self.value)) != len(self.value):
|
|
105 |
self.error = _('Some destination fields are duplicated')
|
|
106 |
return
|
|
107 |
|
|
108 |
# reorder mappings based on to_formdef fields order
|
|
109 |
self.value.sort(key=lambda mapping: self.ranks.get(mapping.varname, 9999))
|
|
110 |
|
|
111 |
|
|
112 |
class LazyLinkedFormData(object):
|
|
113 |
def __init__(self, part):
|
|
114 |
self.__part = part
|
|
115 |
|
|
116 |
def __getattr__(self, name):
|
|
117 |
formdata = self.__part.formdata
|
|
118 |
if formdata is not None:
|
|
119 |
return getattr(LazyFormData(self.__part.formdata), name)
|
|
120 |
raise AttributeError(name)
|
|
121 |
|
|
122 |
@property
|
|
123 |
def url(self):
|
|
124 |
formdata = self.__part.formdata
|
|
125 |
if formdata is None:
|
|
126 |
return None
|
|
127 |
if self.__part.formdata.is_draft():
|
|
128 |
return self.__part.url
|
|
129 |
else:
|
|
130 |
return self.__getattr__('url')
|
|
131 |
|
|
132 |
|
|
133 |
class LinkedFormdataSubstitutionProxy(object):
|
|
134 |
def __init__(self, parts):
|
|
135 |
self.__parts = parts
|
|
136 |
self.__formdatas = [(part.varname, part, LazyLinkedFormData(part)) for part in parts]
|
|
137 |
self.__formdatas.reverse()
|
|
138 |
self.__varnames = set(varname for varname, _1, _2 in self.__formdatas)
|
|
139 |
self.__varname = None
|
|
140 |
|
|
141 |
def __iter__(self):
|
|
142 |
for varname, part, formdata in self.__formdatas:
|
|
143 |
if self.__varname is None or self.__varname == varname:
|
|
144 |
yield formdata
|
|
145 |
|
|
146 |
def __getitem__(self, idx):
|
|
147 |
return list(self)[idx]
|
|
148 |
|
|
149 |
def __getattr__(self, name):
|
|
150 |
if self.__varname or name not in self.__varnames:
|
|
151 |
try:
|
|
152 |
first = self[0]
|
|
153 |
except KeyError:
|
|
154 |
raise AttributeError(name)
|
|
155 |
return getattr(first, name)
|
|
156 |
elif name in self.__varnames:
|
|
157 |
new_sub = copy.copy(self)
|
|
158 |
new_sub.varname = name
|
|
159 |
return new_sub
|
|
160 |
|
|
161 |
def __repr__(self):
|
|
162 |
s = '<LinkedFormdataSubstitutionProxy'
|
|
163 |
if self.__varname:
|
|
164 |
s += ' varname=%r' % self.__varname
|
|
165 |
else:
|
|
166 |
s += ' varnames=%s' % list(self.__varnames)
|
|
167 |
parts = [part for part in self.__parts if not self.__varname or part.varname == self.__varname]
|
|
168 |
s += ' forms=%s>' % ['%s-%s' % (part.formdef_id, part.formdata_id) for part in parts]
|
|
169 |
return s
|
|
170 |
|
|
171 |
|
|
172 |
class LinkedFormdataEvolutionPart(object):
|
|
173 |
def __init__(self, formdata, varname=None, label=None):
|
|
174 |
self.__formdef = formdata.formdef
|
|
175 |
self.__formdata = formdata
|
|
176 |
self.formdef_id = formdata.formdef.id
|
|
177 |
self.formdata_id = formdata.id
|
|
178 |
self.varname = varname
|
|
179 |
self.label = label
|
|
180 |
|
|
181 |
@property
|
|
182 |
def formdef(self):
|
|
183 |
if not hasattr(self, '__formdef'):
|
|
184 |
self.__formdef = FormDef.get(self.formdef_id)
|
|
185 |
return self.__formdef
|
|
186 |
|
|
187 |
@property
|
|
188 |
def formdata(self):
|
|
189 |
if not hasattr(self, '__formdata'):
|
|
190 |
self.__formdata = self.formdef.data_class().get(self.formdata_id, ignore_errors=True)
|
|
191 |
return self.__formdata
|
|
192 |
|
|
193 |
@classmethod
|
|
194 |
def get_substitution_variables(cls, formdata):
|
|
195 |
return {
|
|
196 |
'linked': LinkedFormdataSubstitutionProxy(
|
|
197 |
[part for part in formdata.iter_evolution_parts() if isinstance(part, LinkedFormdataEvolutionPart)]),
|
|
198 |
}
|
|
199 |
|
|
200 |
@property
|
|
201 |
def url(self):
|
|
202 |
if not self.formdata.is_draft():
|
|
203 |
return self.formdata.get_url(backoffice=get_request().is_in_backoffice())
|
|
204 |
elif self.formdata.backoffice_submission:
|
|
205 |
return '%s%s' % (self.formdata.formdef.get_backoffice_submission_url(), self.formdata.id)
|
|
206 |
else:
|
|
207 |
return self.formdata.get_url().rstrip('/')
|
|
208 |
|
|
209 |
def __getstate__(self):
|
|
210 |
# Forget cached values
|
|
211 |
return {k: v for k, v in self.__dict__.items() if not k.startswith('_')}
|
|
212 |
|
|
213 |
|
|
214 |
class CreateFormdataWorkflowStatusItem(WorkflowStatusItem):
|
|
215 |
description = N_('New formdata')
|
|
216 |
key = 'create_formdata'
|
|
217 |
category = 'formdata-action'
|
|
218 |
support_substitution_variables = True
|
|
219 |
|
|
220 |
label = None
|
|
221 |
formdef_slug = None
|
|
222 |
draft = True
|
|
223 |
backoffice_submission = False
|
|
224 |
keep_user = True
|
|
225 |
keep_submission_context = False
|
|
226 |
mappings = None
|
|
227 |
varname = None
|
|
228 |
|
|
229 |
def get_line_details(self):
|
|
230 |
if self.label:
|
|
231 |
s = self.label
|
|
232 |
if self.varname:
|
|
233 |
s += ' - %s' % self.varname
|
|
234 |
return s
|
|
235 |
else:
|
|
236 |
return None
|
|
237 |
|
|
238 |
@property
|
|
239 |
def formdef(self):
|
|
240 |
if self.formdef_slug and self.formdef_slug != '_same':
|
|
241 |
try:
|
|
242 |
return FormDef.get_by_urlname(self.formdef_slug)
|
|
243 |
except KeyError:
|
|
244 |
pass
|
|
245 |
return None
|
|
246 |
|
|
247 |
def add_parameters_widgets(self, form, parameters, prefix='', formdef=None):
|
|
248 |
super(CreateFormdataWorkflowStatusItem, self).add_parameters_widgets(
|
|
249 |
form, parameters, prefix=prefix, formdef=formdef)
|
|
250 |
if 'label' in parameters:
|
|
251 |
form.add(StringWidget, '%slabel' % prefix,
|
|
252 |
title=_('Label'),
|
|
253 |
value=self.label or _('Create formdata'))
|
|
254 |
if 'formdef_slug' in parameters:
|
|
255 |
list_forms = [(None, '---', '')]
|
|
256 |
list_forms += [(x.url_name, x.name, x.url_name) for x in FormDef.select(order_by='name')]
|
|
257 |
form.add(SingleSelectWidget, 'formdef_slug',
|
|
258 |
title=_('Form'),
|
|
259 |
value=self.formdef_slug,
|
|
260 |
options=list_forms)
|
|
261 |
if 'draft' in parameters:
|
|
262 |
form.add(CheckboxWidget, '%sdraft' % prefix,
|
|
263 |
title=_('Draft'),
|
|
264 |
value=self.draft,
|
|
265 |
advanced=self.draft == CreateFormdataWorkflowStatusItem.draft)
|
|
266 |
if 'backoffice_submission' in parameters:
|
|
267 |
form.add(CheckboxWidget, '%sbackoffice_submission' % prefix,
|
|
268 |
title=_('Backoffice submission'),
|
|
269 |
value=self.backoffice_submission,
|
|
270 |
advanced=self.backoffice_submission == CreateFormdataWorkflowStatusItem.backoffice_submission)
|
|
271 |
if 'keep_user' in parameters:
|
|
272 |
form.add(CheckboxWidget, '%skeep_user' % prefix,
|
|
273 |
title=_('Keep user'),
|
|
274 |
value=self.keep_user,
|
|
275 |
advanced=self.keep_user == CreateFormdataWorkflowStatusItem.keep_user)
|
|
276 |
if 'keep_submission_context' in parameters and self.keep_user:
|
|
277 |
form.add(CheckboxWidget, '%skeep_submission_context' % prefix,
|
|
278 |
title=_('Keep submission context'),
|
|
279 |
value=self.keep_submission_context,
|
|
280 |
advanced=self.keep_submission_context == CreateFormdataWorkflowStatusItem.keep_submission_context)
|
|
281 |
formdef = None
|
|
282 |
if form.get('formdef_slug'):
|
|
283 |
try:
|
|
284 |
formdef = FormDef.get_by_urlname(form.get('formdef_slug'))
|
|
285 |
except KeyError:
|
|
286 |
pass
|
|
287 |
if 'mappings' in parameters and formdef:
|
|
288 |
form.add(MappingsWidget, '%smappings' % prefix,
|
|
289 |
title=_('Mappings to new form fields'),
|
|
290 |
to_formdef=formdef,
|
|
291 |
required=True,
|
|
292 |
value=self.mappings)
|
|
293 |
if 'varname' in parameters:
|
|
294 |
form.add(VarnameWidget, '%svarname' % prefix,
|
|
295 |
title=_('Identifier'), value=self.varname,
|
|
296 |
hint=_('This is used to get generated document in expressions.'),
|
|
297 |
advanced=not(self.varname))
|
|
298 |
|
|
299 |
def submit_admin_form(self, form):
|
|
300 |
self.mappings = []
|
|
301 |
super(CreateFormdataWorkflowStatusItem, self).submit_admin_form(form)
|
|
302 |
|
|
303 |
def get_parameters(self):
|
|
304 |
return ('label', 'formdef_slug', 'draft', 'backoffice_submission',
|
|
305 |
'keep_user', 'keep_submission_context', 'mappings', 'varname')
|
|
306 |
|
|
307 |
def perform(self, formdata):
|
|
308 |
formdef = self.formdef
|
|
309 |
if not formdef:
|
|
310 |
return
|
|
311 |
|
|
312 |
new_formdata = formdef.data_class()()
|
|
313 |
new_formdata.receipt_time = time.localtime()
|
|
314 |
|
|
315 |
if self.keep_user:
|
|
316 |
new_formdata.user_id = formdata.user_id
|
|
317 |
|
|
318 |
if self.keep_submission_context and self.keep_user:
|
|
319 |
new_formdata.submission_context = formdata.submission_context or {}
|
|
320 |
new_formdata.submission_channel = formdata.submission_channel
|
|
321 |
else:
|
|
322 |
new_formdata.submission_context = {}
|
|
323 |
|
|
324 |
new_formdata.backoffice_submission = self.backoffice_submission
|
|
325 |
if self.backoffice_submission and get_request() and get_request().user is not None:
|
|
326 |
new_formdata.submission_context['agent_id'] = get_request().user.id
|
|
327 |
|
|
328 |
new_formdata.submission_context['orig_formdef_id'] = formdata.formdef.id
|
|
329 |
new_formdata.submission_context['orig_formdata_id'] = formdata.id
|
|
330 |
new_formdata.data = {}
|
|
331 |
|
|
332 |
self.apply_mappings(dest=new_formdata, src=formdata)
|
|
333 |
|
|
334 |
if self.draft:
|
|
335 |
new_formdata.status = 'draft'
|
|
336 |
new_formdata.store()
|
|
337 |
else:
|
|
338 |
new_formdata.just_created()
|
|
339 |
new_formdata.store()
|
|
340 |
new_formdata.perform_workflow()
|
|
341 |
new_formdata.store()
|
|
342 |
|
|
343 |
if new_formdata.user_id is None and not new_formdata.backoffice_submission:
|
|
344 |
get_session().mark_anonymous_formdata(new_formdata)
|
|
345 |
|
|
346 |
evo = formdata.evolution[-1]
|
|
347 |
evo.add_part(LinkedFormdataEvolutionPart(new_formdata, varname=self.varname))
|
|
348 |
formdata.store()
|
|
349 |
|
|
350 |
def apply_mappings(self, dest, src):
|
|
351 |
if not self.mappings:
|
|
352 |
return
|
|
353 |
|
|
354 |
to_id_fields = {field.varname: field for field in self.formdef.get_all_varname_fields()}
|
|
355 |
|
|
356 |
missing_fields = []
|
|
357 |
|
|
358 |
for mapping in self.mappings:
|
|
359 |
try:
|
|
360 |
dest_field = to_id_fields[mapping.varname]
|
|
361 |
except KeyError:
|
|
362 |
missing_fields.append(mapping.varname)
|
|
363 |
continue
|
|
364 |
try:
|
|
365 |
value = self.compute(mapping.expression, formdata=src, raises=True, status_item=self)
|
|
366 |
except Exception:
|
|
367 |
# already logged by self.compute
|
|
368 |
continue
|
|
369 |
|
|
370 |
try:
|
|
371 |
self._set_value(
|
|
372 |
formdata=dest,
|
|
373 |
field=dest_field,
|
|
374 |
value=value)
|
|
375 |
except Exception as e:
|
|
376 |
expression = self.get_expression(mapping.expression)
|
|
377 |
LoggedError.record('Could not assign value to field %s' % dest_field,
|
|
378 |
formdata=src, status_item=self,
|
|
379 |
expression=expression['value'], expression_type=expression['type'],
|
|
380 |
exception=e)
|
|
381 |
|
|
382 |
if missing_fields:
|
|
383 |
summary = _('Missing field %r') % missing_fields
|
|
384 |
LoggedError.record(summary, formdata=src, status_item=self)
|
|
385 |
|
|
386 |
def _set_value(self, formdata, field, value):
|
|
387 |
if field.convert_value_from_anything:
|
|
388 |
old_value = value # noqa: F841, copy value for debug
|
|
389 |
value = field.convert_value_from_anything(value)
|
|
390 |
|
|
391 |
formdata.data['%s' % field.id] = value
|
|
392 |
if field.store_display_value:
|
|
393 |
display_value = field.store_display_value(
|
|
394 |
formdata.data, field.id)
|
|
395 |
if display_value:
|
|
396 |
formdata.data['%s_display' % field.id] = display_value
|
|
397 |
if value and field.store_structured_value:
|
|
398 |
structured_value = field.store_structured_value(
|
|
399 |
formdata.data, field.id)
|
|
400 |
if structured_value:
|
|
401 |
if isinstance(structured_value, dict) and structured_value.get('id'):
|
|
402 |
# in case of list field, override id
|
|
403 |
formdata.data['%s' % field.id] = str(structured_value.get('id'))
|
|
404 |
formdata.data['%s_structured' % field.id] = structured_value
|
|
405 |
|
|
406 |
def mappings_export_to_xml(self, parent, charset, include_id=False):
|
|
407 |
container = ET.SubElement(parent, 'mappings')
|
|
408 |
for mapping in self.mappings or []:
|
|
409 |
item = ET.SubElement(container, 'mapping')
|
|
410 |
item.attrib['varname'] = unicode(mapping.varname, charset, 'replace')
|
|
411 |
item.text = unicode(mapping.expression, charset, 'replace')
|
|
412 |
|
|
413 |
def mappings_init_with_xml(self, container, charset, include_id=False):
|
|
414 |
self.mappings = []
|
|
415 |
for child in container:
|
|
416 |
varname = child.attrib.get('varname', '').encode(charset)
|
|
417 |
expression = child.text.encode(charset)
|
|
418 |
if varname:
|
|
419 |
self.mappings.append(Mapping(varname=varname, expression=expression))
|
|
420 |
|
|
421 |
register_item_class(CreateFormdataWorkflowStatusItem)
|