1831 lines
74 KiB
Python
1831 lines
74 KiB
Python
# w.c.s. - web application for online forms
|
|
# Copyright (C) 2005-2010 Entr'ouvert
|
|
#
|
|
# 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, see <http://www.gnu.org/licenses/>.
|
|
|
|
import copy
|
|
import json
|
|
import time
|
|
|
|
try:
|
|
import qrcode
|
|
except ImportError:
|
|
qrcode = None
|
|
|
|
from django.utils import six
|
|
from django.utils.http import quote
|
|
from django.utils.six import BytesIO
|
|
from django.utils.safestring import mark_safe
|
|
|
|
import ratelimit.utils
|
|
|
|
from quixote import (get_publisher, get_request, get_response, get_session,
|
|
get_session_manager, redirect)
|
|
from quixote.directory import Directory, AccessControlled
|
|
from quixote.util import randbytes
|
|
from quixote.form.widget import *
|
|
from quixote.html import TemplateIO, htmltext
|
|
|
|
from ..qommon import _, N_
|
|
from ..qommon.admin.emails import EmailsDirectory
|
|
from ..qommon import errors, get_cfg
|
|
from ..qommon import misc, get_logger
|
|
from ..qommon import template
|
|
from ..qommon.form import *
|
|
from ..qommon.logger import BotFilter
|
|
from ..qommon import emails
|
|
|
|
from wcs.categories import Category
|
|
from wcs.formdef import FormDef
|
|
from wcs.formdata import FormData
|
|
from wcs.forms.common import FormTemplateMixin
|
|
from wcs.variables import LazyFormDef
|
|
from wcs.roles import logged_users_role
|
|
from wcs.workflows import Workflow, WorkflowBackofficeFieldsFormDef
|
|
|
|
from wcs.qommon.admin.texts import TextsDirectory
|
|
|
|
|
|
class SubmittedDraftException(Exception):
|
|
pass
|
|
|
|
|
|
def html_top(title = None):
|
|
template.html_top(title = title, default_org = _('Forms'))
|
|
|
|
|
|
def get_user_forms(formdef):
|
|
"""Return forms data for the current user
|
|
|
|
formdef - the formdef from which we want form datas
|
|
|
|
"""
|
|
session = get_session()
|
|
user = session.get_user()
|
|
user_forms = []
|
|
if user and not user.anonymous:
|
|
user_forms = formdef.data_class().get_with_indexed_value('user_id', user.id)
|
|
return list(user_forms)
|
|
|
|
from wcs.forms.common import FormStatusPage
|
|
|
|
|
|
def tryauth(url):
|
|
# tries to log the user in before redirecting to the asked url; this won't
|
|
# do anything for local logins but will use a passive SAML request when
|
|
# configured to use an external identity provider.
|
|
if get_request().user:
|
|
return redirect(url)
|
|
ident_methods = get_cfg('identification', {}).get('methods', ['idp'])
|
|
if not 'idp' in ident_methods:
|
|
# when configured with local logins and not logged in, redirect to
|
|
# asked url.
|
|
return redirect(url)
|
|
login_url = '/login/?ReturnUrl=%s&IsPassive=true' % quote(url)
|
|
return redirect(login_url)
|
|
|
|
|
|
def auth(url):
|
|
# logs the user in before redirecting to asked url.
|
|
if get_request().user:
|
|
return redirect(url)
|
|
login_url = '/login/?ReturnUrl=%s' % quote(url)
|
|
return redirect(login_url)
|
|
|
|
|
|
def forceauth(url):
|
|
login_url = '/login/?ReturnUrl=%s&forceAuthn=true' % quote(url)
|
|
return redirect(login_url)
|
|
|
|
|
|
class TrackingCodeDirectory(Directory):
|
|
_q_exports = ['', 'load']
|
|
|
|
def __init__(self, code, formdef):
|
|
self.code = code
|
|
self.formdef = formdef
|
|
|
|
def _q_index(self):
|
|
if self.formdef is None:
|
|
raise errors.TraversalError()
|
|
form = Form()
|
|
if get_request().user and get_request().user.email:
|
|
email = get_request().user.email
|
|
else:
|
|
email = None
|
|
form.add(EmailWidget, 'email', value=email, title=_('Email'), size=25, required=True, attrs={'required': 'required'})
|
|
form.add_submit('submit', _('Send email'))
|
|
form.add_submit('cancel', _('Cancel'))
|
|
|
|
if form.get_submit() == 'cancel':
|
|
return redirect('./load')
|
|
|
|
if form.is_submitted() and not form.has_errors():
|
|
email = form.get_widget('email').parse()
|
|
data = {
|
|
'form_tracking_code': self.code,
|
|
'tracking_code': self.code,
|
|
'email': email
|
|
}
|
|
data.update(self.formdef.get_substitution_variables(minimal=True))
|
|
emails.custom_template_email('tracking-code-reminder', data,
|
|
email, fire_and_forget=True)
|
|
return redirect('./load')
|
|
|
|
html_top()
|
|
r = TemplateIO(html=True)
|
|
r += htmltext('<h2>%s</h2>') % _('Keep your tracking code')
|
|
r += TextsDirectory.get_html_text('tracking-code-email-dialog')
|
|
r += form.render()
|
|
return r.getvalue()
|
|
|
|
def load(self):
|
|
rate_limit_option = get_publisher().get_site_option('rate-limit') or '3/s 1500/d'
|
|
if rate_limit_option != 'none':
|
|
for rate_limit in rate_limit_option.split():
|
|
ratelimited = ratelimit.utils.is_ratelimited(
|
|
request=get_request().django_request,
|
|
group='trackingcode',
|
|
key='ip',
|
|
rate=rate_limit,
|
|
increment=True)
|
|
if ratelimited:
|
|
raise errors.AccessForbiddenError('rate limit reached (%s)' % rate_limit)
|
|
try:
|
|
tracking_code = get_publisher().tracking_code_class.get(self.code)
|
|
if tracking_code.formdata_id is None:
|
|
# this tracking code was not associated with any data; return a 404
|
|
raise KeyError
|
|
formdata = tracking_code.formdata
|
|
except KeyError:
|
|
raise errors.TraversalError()
|
|
if formdata.formdef.enable_tracking_codes is False:
|
|
raise errors.TraversalError()
|
|
if BotFilter.is_bot():
|
|
raise errors.AccessForbiddenError()
|
|
get_session().mark_anonymous_formdata(formdata)
|
|
return redirect(formdata.get_url())
|
|
|
|
|
|
class TrackingCodesDirectory(Directory):
|
|
_q_exports = ['load']
|
|
|
|
def __init__(self, formdef=None):
|
|
self.formdef = formdef
|
|
|
|
def load(self):
|
|
code = get_request().form.get('code')
|
|
return redirect('./%s/load' % code)
|
|
|
|
def _q_lookup(self, component):
|
|
return TrackingCodeDirectory(component, self.formdef)
|
|
|
|
|
|
class FormPage(Directory, FormTemplateMixin):
|
|
_q_exports = ['', 'tempfile', 'schema', 'tryauth',
|
|
'auth', 'forceauth', 'qrcode', 'autosave', 'code', 'removedraft', 'live']
|
|
|
|
do_not_call_in_templates = True
|
|
filling_templates = ['wcs/front/formdata_filling.html', 'wcs/formdata_filling.html']
|
|
validation_templates = ['wcs/front/formdata_validation.html', 'wcs/formdata_validation.html']
|
|
steps_templates = ['wcs/front/formdata_steps.html', 'wcs/formdata_steps.html']
|
|
formdef_class = FormDef
|
|
|
|
def __init__(self, component):
|
|
try:
|
|
self.formdef = self.formdef_class.get_by_urlname(component)
|
|
except KeyError:
|
|
raise errors.TraversalError()
|
|
|
|
self.substvars = {}
|
|
get_publisher().substitutions.feed(self)
|
|
get_publisher().substitutions.feed(self.formdef)
|
|
|
|
self.code = TrackingCodesDirectory(self.formdef)
|
|
self.action_url = '.'
|
|
self.edit_mode = False
|
|
self.user = get_request().user
|
|
get_response().breadcrumb.append( (component + '/', self.formdef.name) )
|
|
|
|
def html_top(self, *args, **kwargs):
|
|
html_top(*args, **kwargs)
|
|
|
|
def get_substitution_variables(self):
|
|
return self.substvars
|
|
|
|
def schema(self):
|
|
# backward compatibility
|
|
from wcs.api import ApiFormdefDirectory
|
|
return ApiFormdefDirectory(self.formdef).schema()
|
|
|
|
def check_role(self):
|
|
if self.formdef.roles:
|
|
if not self.user:
|
|
raise errors.AccessUnauthorizedError()
|
|
if logged_users_role().id not in self.formdef.roles and not (
|
|
self.user and self.user.is_admin):
|
|
if self.user:
|
|
user_roles = set(self.user.get_roles())
|
|
else:
|
|
user_roles = set([])
|
|
other_roles = (self.formdef.roles or [])
|
|
if self.formdef.workflow_roles:
|
|
other_roles.extend(self.formdef.workflow_roles.values())
|
|
if not user_roles.intersection(other_roles):
|
|
raise errors.AccessForbiddenError()
|
|
|
|
def has_confirmation_page(self):
|
|
if self.formdef.confirmation:
|
|
return True
|
|
if self.formdef.has_captcha:
|
|
session = get_session()
|
|
if not (session.get_user() or session.won_captcha):
|
|
return True
|
|
return False
|
|
|
|
def has_draft_support(self):
|
|
if self.edit_mode:
|
|
return False
|
|
if self.formdef.enable_tracking_codes:
|
|
return True
|
|
session = get_session()
|
|
return session.has_user()
|
|
|
|
def get_current_page_no(self, current_page):
|
|
for i, page in enumerate(self.pages):
|
|
if page is current_page:
|
|
return i + 1
|
|
return 0
|
|
|
|
def step(self, step_no, current_page):
|
|
get_logger().info('form %s - step %s' % (self.formdef.name, step_no))
|
|
|
|
page_labels = []
|
|
current_position = 1
|
|
|
|
for i, page in enumerate(self.pages):
|
|
if page is None: # monopage form
|
|
page_labels.append(_('Filling'))
|
|
else:
|
|
page_labels.append(page.label)
|
|
if page is current_page:
|
|
current_position = i + 1
|
|
|
|
if step_no > 0:
|
|
current_position = len(page_labels) + step_no
|
|
|
|
if step_no == 0:
|
|
self.substvars['current_page_no'] = current_position
|
|
|
|
if self.has_confirmation_page() and not self.edit_mode:
|
|
page_labels.append(_('Validating'))
|
|
|
|
return template.render(
|
|
list(self.get_formdef_template_variants(self.steps_templates)),
|
|
{
|
|
'page_labels': page_labels,
|
|
'current_page_no': current_position,
|
|
})
|
|
|
|
@classmethod
|
|
def iter_with_block_fields(cls, form, fields):
|
|
for field in fields:
|
|
field_key = '%s' % field.id
|
|
widget = form.get_widget('f%s' % field_key) if form else None
|
|
yield field, field_key, widget, None
|
|
if field.key == 'block':
|
|
# we only ever prefill the first item
|
|
subwidget = widget.widgets[0] if widget else None
|
|
for subfield in field.block.fields:
|
|
subfield_key = '%s$%s' % (field.id, subfield.id)
|
|
subfield_widget = subwidget.get_widget('f%s' % subfield.id) if subwidget else None
|
|
yield subfield, subfield_key, subfield_widget, field
|
|
|
|
@classmethod
|
|
def apply_field_prefills(cls, data, form, displayed_fields):
|
|
req = get_request()
|
|
had_prefill = False
|
|
for field, field_key, widget, block in cls.iter_with_block_fields(form, displayed_fields):
|
|
v = None
|
|
prefilled = False
|
|
locked = False
|
|
|
|
if field.prefill:
|
|
prefill_user = get_request().user
|
|
if get_request().is_in_backoffice():
|
|
prefill_user = get_publisher().substitutions.get_context_variables(
|
|
).get('form_user')
|
|
v, locked = field.get_prefill_value(user=prefill_user)
|
|
|
|
# always set additional attributes as they will be used for
|
|
# "live prefill", regardless of existing data.
|
|
widget.prefill_attributes = field.get_prefill_attributes()
|
|
|
|
should_prefill = bool(field.prefill)
|
|
|
|
has_current_value = False
|
|
if block:
|
|
try:
|
|
current_value = data[block.id]['data'][0][field.id]
|
|
has_current_value = True
|
|
except (IndexError, KeyError, TypeError, ValueError):
|
|
pass
|
|
else:
|
|
try:
|
|
current_value = data[field_key]
|
|
has_current_value = True
|
|
except KeyError:
|
|
pass
|
|
|
|
if has_current_value:
|
|
# existing value, update it with the new computed value
|
|
# if it's the same that was previously computed.
|
|
prefill_value = v
|
|
v = current_value
|
|
if data.get('prefilling_data', {}).get(field_key) == current_value:
|
|
# replace value with new value computed for prefill
|
|
v = prefill_value
|
|
else:
|
|
should_prefill = False
|
|
|
|
if should_prefill:
|
|
if get_request().is_in_backoffice() and (
|
|
field.prefill and field.prefill.get('type') == 'geoloc'):
|
|
# turn off prefilling from geolocation attributes if
|
|
# the form is filled from the backoffice
|
|
v = None
|
|
if v:
|
|
prefilled = True
|
|
widget.prefilled = True
|
|
|
|
if not prefilled and widget:
|
|
widget.clear_error()
|
|
widget._parsed = False
|
|
|
|
if v is not None:
|
|
# store computed value, it will be used to compare with
|
|
# submitted value if page is visited again.
|
|
if should_prefill:
|
|
if 'prefilling_data' not in data:
|
|
data['prefilling_data'] = {}
|
|
data['prefilling_data'][field_key] = v
|
|
if not isinstance(v, str) and field.convert_value_to_str:
|
|
v = field.convert_value_to_str(v)
|
|
widget.set_value(v)
|
|
widget.transfer_form_value(req)
|
|
if field.type == 'item' and v and widget.value != v:
|
|
# mark field as invalid if the value was not accepted
|
|
# (this is required by quixote>=3 as the value would
|
|
# not be evaluated in the initial GET request of the
|
|
# page).
|
|
widget.set_error(get_selection_error_text())
|
|
if locked:
|
|
widget.readonly = 'readonly'
|
|
widget.attrs['readonly'] = 'readonly'
|
|
had_prefill = True
|
|
return had_prefill
|
|
|
|
def page(self, page, page_change=True, page_error_messages=None, submit_button=None):
|
|
displayed_fields = []
|
|
|
|
session = get_session()
|
|
|
|
if page and self.pages.index(page) > 0:
|
|
magictoken = get_request().form['magictoken']
|
|
self.feed_current_data(magictoken)
|
|
|
|
form = self.create_form(page, displayed_fields)
|
|
if submit_button is True:
|
|
# submit_button at True means a non-submitting button has been
|
|
# clicked; details in [ADD_ROW_BUTTON].
|
|
form.clear_errors()
|
|
if page_error_messages:
|
|
form.add_global_errors(page_error_messages)
|
|
if getattr(session, 'ajax_form_token', None):
|
|
form.add_hidden('_ajax_form_token', session.ajax_form_token)
|
|
if get_request().is_in_backoffice():
|
|
form.attrs['data-is-backoffice'] = 'true'
|
|
form.action = self.action_url
|
|
# include a data-has-draft attribute on the <form> element when a draft
|
|
# already exists for the form; this will activate the autosave.
|
|
magictoken = get_request().form.get('magictoken')
|
|
if magictoken:
|
|
form_data = session.get_by_magictoken(magictoken, {})
|
|
if self.has_draft_support():
|
|
form.attrs['data-has-draft'] = 'yes'
|
|
else:
|
|
form_data = {}
|
|
|
|
if page == self.pages[0] and 'magictoken' not in get_request().form:
|
|
magictoken = randbytes(8)
|
|
else:
|
|
magictoken = get_request().form['magictoken']
|
|
form.add_hidden('magictoken', magictoken)
|
|
data = session.get_by_magictoken(magictoken, {})
|
|
|
|
if page == self.pages[0] and 'cancelurl' in get_request().form:
|
|
cancelurl = get_request().form['cancelurl']
|
|
if not get_publisher().is_relatable_url(cancelurl):
|
|
raise errors.RequestError('invalid cancel URL')
|
|
form_data['__cancelurl'] = cancelurl
|
|
session.add_magictoken(magictoken, form_data)
|
|
|
|
if self.edit_mode and (page is None or page == self.pages[-1]):
|
|
form.add_submit('submit', _('Save Changes'))
|
|
elif not self.has_confirmation_page() and (page is None or page == self.pages[-1]):
|
|
form.add_submit('submit', _('Submit'))
|
|
else:
|
|
form.add_submit('submit', _('Next'))
|
|
|
|
if self.pages.index(page) > 0:
|
|
form.add_submit('previous', _('Previous'))
|
|
|
|
had_prefill = False
|
|
if page_change:
|
|
# on page change, we fake a GET request so the form is not altered
|
|
# with errors from the previous submit; if the page was already
|
|
# visited, we restore values; otherwise we set req.form as empty.
|
|
req = get_request()
|
|
req.environ['REQUEST_METHOD'] = 'GET'
|
|
|
|
had_prefill = self.apply_field_prefills(data, form, displayed_fields)
|
|
|
|
if had_prefill:
|
|
# include prefilled data
|
|
transient_formdata = self.get_transient_formdata()
|
|
transient_formdata.data.update(self.formdef.get_data(form))
|
|
if self.has_draft_support():
|
|
# save to get prefilling data in database
|
|
self.save_draft(form_data)
|
|
else:
|
|
req.form = {}
|
|
|
|
else:
|
|
# not a page change, reset_locked_data() will have been called
|
|
# earlier, we use that to set appropriate fields as readonly.
|
|
for field, field_key, widget, block in self.iter_with_block_fields(form, displayed_fields):
|
|
if get_request().form.get('__locked_f%s' % field_key):
|
|
widget.readonly = 'readonly'
|
|
widget.attrs['readonly'] = 'readonly'
|
|
|
|
for field, field_key, widget, block in self.iter_with_block_fields(form, displayed_fields):
|
|
if field.prefill:
|
|
# always set additional attributes as they will be used for
|
|
# "live prefill", regardless of existing data.
|
|
widget.prefill_attributes = field.get_prefill_attributes()
|
|
|
|
self.formdef.set_live_condition_sources(form, displayed_fields)
|
|
|
|
if had_prefill:
|
|
# pass over prefilled fields that are used as live source of item
|
|
# fields
|
|
fields_to_update = set()
|
|
for field, field_key, widget, block in self.iter_with_block_fields(form, displayed_fields):
|
|
if getattr(widget, 'prefilled', False) and getattr(widget, 'live_condition_source', False):
|
|
fields_to_update.update(widget.live_condition_fields)
|
|
elif field in fields_to_update and field.type == 'item':
|
|
kwargs = {}
|
|
with get_publisher().substitutions.temporary_feed(
|
|
transient_formdata, force_mode='lazy'):
|
|
field.perform_more_widget_changes(form, kwargs)
|
|
if 'options' in kwargs and 'options_with_attributes' in kwargs:
|
|
widget.options = kwargs['options']
|
|
widget.options_with_attributes = kwargs['options_with_attributes']
|
|
|
|
self.html_top(self.formdef.name)
|
|
|
|
form.add_hidden('step', '0')
|
|
form.add_hidden('page', self.pages.index(page))
|
|
if page:
|
|
form.add_hidden('page_id', page.id)
|
|
|
|
cancel_label = _('Cancel')
|
|
if self.has_draft_support() and not (data and data.get('is_recalled_draft')):
|
|
cancel_label = _('Discard')
|
|
form.add_submit('cancel', cancel_label, css_class='cancel')
|
|
|
|
if self.has_draft_support():
|
|
form.add_submit('savedraft', _('Save Draft'), css_class='save-draft',
|
|
attrs={'style': 'display: none'})
|
|
|
|
# add fake field as honey pot
|
|
honeypot = form.add(StringWidget, 'f00', value='',
|
|
title=_('leave this field blank to prove your humanity'),
|
|
size=25)
|
|
honeypot.is_hidden = True
|
|
|
|
context = {
|
|
'view': self,
|
|
'page_no': lambda: self.get_current_page_no(page),
|
|
'form': form,
|
|
'formdef': LazyFormDef(self.formdef),
|
|
'form_side': lambda: self.form_side(0, page, data=data, magictoken=magictoken),
|
|
'steps': lambda: self.step(0, page),
|
|
}
|
|
if self.has_draft_support() and data:
|
|
context['tracking_code_box'] = lambda: self.tracking_code_box(data, magictoken)
|
|
self.modify_filling_context(context, page, data)
|
|
|
|
return template.QommonTemplateResponse(
|
|
templates=list(self.get_formdef_template_variants(self.filling_templates)),
|
|
context=context)
|
|
|
|
def modify_filling_context(self, context, page, data):
|
|
pass
|
|
|
|
def form_side(self, step_no, page, data=None, magictoken=None):
|
|
'''Create the elements that typically appear aside the main form
|
|
(tracking code and steps).'''
|
|
r = TemplateIO(html=True)
|
|
r += htmltext('<div id="side">')
|
|
if self.has_draft_support() and data:
|
|
# display tracking code box if they are enabled and there's some
|
|
# data (e.g. the user is not on a insufficient authenticiation
|
|
# context page)
|
|
r += self.tracking_code_box(data, magictoken)
|
|
r += self.step(step_no, page)
|
|
r += htmltext('</div> <!-- #side -->')
|
|
return mark_safe(str(r.getvalue()))
|
|
|
|
def tracking_code_box(self, data, magictoken):
|
|
'''Create the tracking code box, it displays the current tracking code
|
|
if enabled, and a 'remove draft' button if the current form is a draft
|
|
that has been recalled.'''
|
|
r = TemplateIO(html=True)
|
|
if self.formdef.enable_tracking_codes:
|
|
r += htmltext('<div class="tracking-code-part">')
|
|
r += htmltext('<h3>%s</h3>') % _('Tracking code')
|
|
|
|
tracking_code = None
|
|
draft_formdata_id = data.get('draft_formdata_id')
|
|
if draft_formdata_id:
|
|
try:
|
|
formdata = self.formdef.data_class().get(draft_formdata_id)
|
|
tracking_code = formdata.tracking_code
|
|
except KeyError:
|
|
pass
|
|
else:
|
|
tracking_code = data.get('future_tracking_code')
|
|
|
|
if tracking_code:
|
|
get_response().add_javascript(['popup.js'])
|
|
r += htmltext('<a data-popup href="%s">%s</a>') % (
|
|
'code/%s/' % tracking_code, tracking_code)
|
|
r += TextsDirectory.get_html_text('tracking-code-short-text')
|
|
r += htmltext('</div>') # <!-- .tracking-code-part -->
|
|
|
|
if data.get('is_recalled_draft'):
|
|
r += htmltext('<form action="removedraft" method="POST">')
|
|
r += htmltext('<input type="hidden" name="magictoken" value="%s">') % magictoken
|
|
r += htmltext('<button>%s</button>') % _('Discard Draft')
|
|
r += htmltext('</form>')
|
|
|
|
text = r.getvalue()
|
|
if not text:
|
|
return ''
|
|
|
|
if data.get('is_recalled_draft'):
|
|
return htmltext('<div id="tracking-code" class="has-discard-button">') + text + htmltext('</div>')
|
|
else:
|
|
return htmltext('<div id="tracking-code">') + text + htmltext('</div>')
|
|
|
|
def get_transient_formdata(self, magictoken=Ellipsis):
|
|
if magictoken is Ellipsis:
|
|
magictoken = get_request().form.get('magictoken')
|
|
# create a fake FormData with current submission data
|
|
formdata = FormData()
|
|
formdata._formdef = self.formdef
|
|
formdata.user = get_request().user
|
|
formdata.data = get_session().get_by_magictoken(magictoken, {})
|
|
formdata.prefilling_data = formdata.data.get('prefilling_data', {})
|
|
|
|
if self.edit_mode:
|
|
# keep associated user as it may be required as a parameter in
|
|
# data source URLs.
|
|
formdata.user = self.edited_data.user
|
|
return formdata
|
|
|
|
if get_request().is_in_backoffice():
|
|
formdata.user_id = None
|
|
draft_formdata_id = formdata.data.get('draft_formdata_id')
|
|
if draft_formdata_id:
|
|
try:
|
|
formdata = self.formdef.data_class().get(draft_formdata_id)
|
|
except KeyError: # it may not exist
|
|
pass
|
|
formdata.status = ''
|
|
return formdata
|
|
|
|
def feed_current_data(self, magictoken):
|
|
formdata = self.get_transient_formdata(magictoken)
|
|
get_publisher().substitutions.feed(formdata)
|
|
|
|
def check_disabled(self):
|
|
if self.formdef.is_disabled():
|
|
if self.formdef.disabled_redirection:
|
|
return misc.get_variadic_url(self.formdef.disabled_redirection,
|
|
get_publisher().substitutions.get_context_variables(mode='lazy'))
|
|
else:
|
|
raise errors.AccessForbiddenError()
|
|
return False
|
|
|
|
def create_form(self, *args, **kwargs):
|
|
form = self.formdef.create_form(*args, **kwargs)
|
|
form.attrs['data-live-url'] = self.formdef.get_url() + 'live'
|
|
return form
|
|
|
|
def create_view_form(self, *args, **kwargs):
|
|
return self.formdef.create_view_form(*args, **kwargs)
|
|
|
|
def check_authentication_context(self):
|
|
if not self.formdef.required_authentication_contexts:
|
|
return
|
|
if get_session().get_authentication_context() in self.formdef.required_authentication_contexts:
|
|
return
|
|
|
|
self.html_top(self.formdef.name)
|
|
r = TemplateIO(html=True)
|
|
r += self.form_side(step_no=0, page=self.pages[0])
|
|
auth_contexts = get_publisher().get_supported_authentication_contexts()
|
|
r += htmltext('<div class="errornotice" role="status">')
|
|
r += htmltext('<p>%s</p>') % _('You need a stronger authentication level to fill this form.')
|
|
r += htmltext('</div>')
|
|
root_url = get_publisher().get_root_url()
|
|
for auth_context in self.formdef.required_authentication_contexts:
|
|
r += htmltext('<p><a class="button" href="%slogin/?forceAuthn=true">%s</a></p>') % (
|
|
root_url, _('Login with %s') % auth_contexts[auth_context])
|
|
return r.getvalue()
|
|
|
|
def check_unique_submission(self):
|
|
if self.edit_mode:
|
|
return None
|
|
if not self.formdef.only_allow_one:
|
|
return None
|
|
for user_form in get_user_forms(self.formdef):
|
|
if not user_form.is_draft():
|
|
return user_form.id
|
|
return None
|
|
|
|
_pages = None
|
|
@property
|
|
def pages(self):
|
|
if self._pages:
|
|
return self._pages
|
|
current_data = self.get_transient_formdata().data
|
|
pages = []
|
|
field_page = None
|
|
with get_publisher().substitutions.freeze():
|
|
# don't let evaluation of pages alter substitution variables (this
|
|
# avoids a ConditionVars being added with current form data and
|
|
# influencing later code evaluating field visibility based on
|
|
# submitted data) (#27247).
|
|
for field in self.formdef.fields:
|
|
if field.type == 'page':
|
|
field_page = field
|
|
if field.is_visible(current_data, self.formdef):
|
|
pages.append(field)
|
|
if not field_page: # form without page fields
|
|
pages = [None]
|
|
self._pages = pages
|
|
return pages
|
|
|
|
def reset_pages_cache(self):
|
|
self._pages = None
|
|
|
|
def _q_index(self):
|
|
self.check_role()
|
|
authentication_context_check_result = self.check_authentication_context()
|
|
if authentication_context_check_result:
|
|
return authentication_context_check_result
|
|
|
|
if not self.edit_mode and self.check_disabled():
|
|
return redirect(self.check_disabled())
|
|
|
|
session = get_session()
|
|
if not session.id:
|
|
# force session to be written down, this is required so
|
|
# [session_hash_id] is available on the first page.
|
|
session.force()
|
|
|
|
if self.has_draft_support():
|
|
if get_request().form.get('_ajax_form_token'):
|
|
# _ajax_form_token is immediately removed, this prevents
|
|
# late autosave() to overwrite data after the user went to a
|
|
# different page.
|
|
try:
|
|
session.remove_form_token(get_request().form.get('_ajax_form_token'))
|
|
except ValueError:
|
|
# already got removed, this may be because the form got
|
|
# submitted twice.
|
|
pass
|
|
session.ajax_form_token = session.create_form_token()
|
|
|
|
if get_request().form.get('magictoken'):
|
|
no_magic = object()
|
|
session_magic_token = session.get_by_magictoken(
|
|
get_request().form.get('magictoken'), no_magic)
|
|
if session_magic_token is no_magic:
|
|
if (get_request().form.get('page') != '0' or
|
|
get_request().form.get('step') != '0'):
|
|
# the magictoken that has been submitted is not available
|
|
# in the session and we're not on the first page of the
|
|
# first step that means we probably lost the session in
|
|
# mid-air.
|
|
get_session().message = ('error',
|
|
_('Sorry, your session have been lost.'))
|
|
return redirect(self.formdef.get_url())
|
|
self.feed_current_data(get_request().form.get('magictoken'))
|
|
else:
|
|
self.feed_current_data(None)
|
|
if not self.edit_mode and get_request().get_method() == 'GET' and 'mt' not in get_request().form:
|
|
self.initial_hit = True
|
|
# first hit on first page, if tracking code are enabled and we
|
|
# are not editing an existing formdata, generate a new tracking
|
|
# code.
|
|
if not self.edit_mode and self.formdef.enable_tracking_codes and 'mt' not in get_request().form:
|
|
tracking_code = get_publisher().tracking_code_class()
|
|
tracking_code.store()
|
|
token = randbytes(8)
|
|
get_request().form['magictoken'] = token
|
|
session.add_magictoken(token, {'future_tracking_code': tracking_code.id})
|
|
|
|
existing_formdata = None
|
|
if self.edit_mode:
|
|
existing_formdata = self.edited_data.data
|
|
if not get_request().form:
|
|
# on the initial visit editing the form (i.e. not after
|
|
# clicking for previous or next page), we need to load the
|
|
# existing data into the session
|
|
self.edited_data.feed_session()
|
|
token = randbytes(8)
|
|
get_request().form['magictoken'] = token
|
|
session.add_magictoken(token, self.edited_data.data)
|
|
|
|
# redirect to existing formdata if form is configured to only allow one
|
|
# per user and it's already there.
|
|
existing_form_id = self.check_unique_submission()
|
|
if existing_form_id:
|
|
return redirect('%s/' % existing_form_id)
|
|
|
|
get_response().add_javascript(['jquery.js', 'qommon.forms.js'])
|
|
form = Form()
|
|
form.add_hidden('step', '-1')
|
|
form.add_hidden('page', '-1')
|
|
form.add_hidden('magictoken', '-1')
|
|
form.add_submit('cancel')
|
|
|
|
if self.has_draft_support():
|
|
form.add_submit('removedraft')
|
|
form.add_submit('savedraft')
|
|
|
|
if not form.is_submitted():
|
|
if 'mt' in get_request().form:
|
|
magictoken = get_request().form['mt']
|
|
data = session.get_by_magictoken(magictoken, {})
|
|
if not get_request().is_in_backoffice():
|
|
# don't remove magictoken as the backoffice agent may get
|
|
# the page reloaded.
|
|
session.remove_magictoken(magictoken)
|
|
if data:
|
|
# create a new one since the other has been exposed in a url
|
|
magictoken = randbytes(8)
|
|
session.add_magictoken(magictoken, data)
|
|
get_request().form['magictoken'] = magictoken
|
|
self.feed_current_data(magictoken)
|
|
if 'page_no' in data and int(data['page_no']) != 0:
|
|
page_no = int(data['page_no'])
|
|
del data['page_no']
|
|
if page_no == -1 or page_no >= len(self.pages):
|
|
req = get_request()
|
|
for k, v in data.items():
|
|
req.form['f%s' % k] = v
|
|
for field in self.formdef.fields:
|
|
if not field.id in data:
|
|
continue
|
|
if field.convert_value_to_str:
|
|
req.form['f%s' % field.id] = field.convert_value_to_str(data[field.id])
|
|
return self.validating(data)
|
|
else:
|
|
page_no = 0
|
|
return self.page(self.pages[page_no], page_change=True)
|
|
self.feed_current_data(None)
|
|
if not self.pages:
|
|
raise errors.TraversalError()
|
|
return self.page(self.pages[0])
|
|
|
|
if form.get_submit() == 'cancel':
|
|
get_logger().info('form %s - cancel' % (self.formdef.name))
|
|
if self.edit_mode:
|
|
return redirect('.')
|
|
magictoken = form.get_widget('magictoken').parse()
|
|
if self.has_draft_support():
|
|
current_draft = self.get_current_draft()
|
|
if current_draft:
|
|
discard_draft = True
|
|
if magictoken:
|
|
data = session.get_by_magictoken(magictoken, {})
|
|
if data.get('is_recalled_draft'):
|
|
discard_draft = False
|
|
if discard_draft:
|
|
current_draft.remove_self()
|
|
try:
|
|
cancelurl = session.get_by_magictoken(magictoken, {}).get('__cancelurl')
|
|
if cancelurl:
|
|
return redirect(cancelurl)
|
|
except KeyError:
|
|
pass
|
|
return self.cancelled()
|
|
|
|
try:
|
|
step = int(form.get_widget('step').parse())
|
|
except (TypeError, ValueError):
|
|
step = 0
|
|
|
|
if step == 0:
|
|
try:
|
|
page_no = int(form.get_widget('page').parse())
|
|
page = self.pages[page_no]
|
|
except (TypeError, ValueError, IndexError):
|
|
# this situation shouldn't arise (that likely means the
|
|
# page hidden field had an error in its submission), in
|
|
# that case we just fall back to the first page.
|
|
page_no = 0
|
|
page = self.pages[0]
|
|
try:
|
|
magictoken = form.get_widget('magictoken').parse()
|
|
except KeyError:
|
|
magictoken = randbytes(8)
|
|
|
|
self.feed_current_data(magictoken)
|
|
|
|
submitted_fields = []
|
|
transient_formdata = self.get_transient_formdata()
|
|
with get_publisher().substitutions.temporary_feed(
|
|
transient_formdata, force_mode='lazy'):
|
|
form = self.create_form(page=page,
|
|
displayed_fields=submitted_fields,
|
|
transient_formdata=transient_formdata)
|
|
form.add_submit('previous')
|
|
if self.has_draft_support():
|
|
form.add_submit('removedraft')
|
|
form.add_submit('savedraft')
|
|
form.add_submit('submit')
|
|
if page_no > 0 and form.get_submit() == 'previous':
|
|
return self.previous_page(page_no, magictoken)
|
|
|
|
if self.has_draft_support() and form.get_submit() == 'removedraft':
|
|
return self.removedraft()
|
|
|
|
form_data = session.get_by_magictoken(magictoken, {})
|
|
with get_publisher().substitutions.temporary_feed(
|
|
transient_formdata, force_mode='lazy'):
|
|
# reset locked data with newly submitted values, this allows
|
|
# for templates referencing fields from the sampe page.
|
|
self.reset_locked_data(form)
|
|
data = self.formdef.get_data(form)
|
|
|
|
form_data.update(data)
|
|
|
|
if self.has_draft_support() and form.get_submit() == 'savedraft':
|
|
filled = self.save_draft(form_data, page_no)
|
|
return redirect(filled.get_url())
|
|
|
|
for field in submitted_fields:
|
|
if not field.is_visible(form_data, self.formdef) and 'f%s' % field.id in form._names:
|
|
del form._names['f%s' % field.id]
|
|
|
|
page_error_messages = []
|
|
if form.get_submit() == 'submit' and page:
|
|
post_conditions = page.post_conditions or []
|
|
# create a new dictionary to hold live data, this makes sure
|
|
# a new ConditionsVars will get added to the substitution
|
|
# variables.
|
|
form_data = copy.copy(session.get_by_magictoken(magictoken, {}))
|
|
data = self.formdef.get_data(form)
|
|
form_data.update(data)
|
|
for i, post_condition in enumerate(post_conditions):
|
|
condition = post_condition.get('condition')
|
|
error_message = post_condition.get('error_message')
|
|
errored = False
|
|
try:
|
|
if not page.evaluate_condition(form_data, self.formdef, condition):
|
|
errored = True
|
|
except RuntimeError:
|
|
errored = True
|
|
if errored:
|
|
form.add(HiddenErrorWidget, 'post_condition%d' % i)
|
|
form.set_error('post_condition%d' % i, 'error')
|
|
page_error_messages.append(error_message)
|
|
|
|
if get_request().form.get('f00'): # 🍯
|
|
form.add(HiddenErrorWidget, 'honeypot')
|
|
form.set_error('honeypot', 'error')
|
|
get_logger().info('form %s - honeypot was touched' % self.formdef.name)
|
|
page_error_messages.append(_('Honey pot should be left untouched.'))
|
|
|
|
# form.get_submit() returns the name of the clicked button, and
|
|
# it will return True if the form has been submitted, but not
|
|
# by clicking on a submit widget; for example if an "add row"
|
|
# button is clicked. [ADD_ROW_BUTTON]
|
|
if form.has_errors() or form.get_submit() is True:
|
|
return self.page(page, page_change=False,
|
|
page_error_messages=page_error_messages,
|
|
submit_button=form.get_submit())
|
|
|
|
form_data = session.get_by_magictoken(magictoken, {})
|
|
with get_publisher().substitutions.temporary_feed(
|
|
transient_formdata, force_mode='lazy'):
|
|
data = self.formdef.get_data(form)
|
|
form_data.update(data)
|
|
|
|
session.add_magictoken(magictoken, form_data)
|
|
|
|
page_no += 1
|
|
|
|
draft_id = session.get_by_magictoken(magictoken, {}).get('draft_formdata_id')
|
|
if draft_id:
|
|
# if there's a draft (be it because drafts are enabled or
|
|
# because the formdata was created as a draft via the
|
|
# submission API), update it with current data.
|
|
try:
|
|
self.autosave_draft(draft_id, page_no, form_data)
|
|
except SubmittedDraftException:
|
|
if get_request().is_in_backoffice():
|
|
get_session().message = ('error', _('This form has already been submitted.'))
|
|
return redirect(get_publisher().get_backoffice_url() + '/submission/')
|
|
return template.error_page(_('This form has already been submitted.'))
|
|
elif self.has_draft_support():
|
|
# if there's no draft yet and drafts are supported, create one
|
|
filled = self.save_draft(form_data, page_no)
|
|
|
|
# the page has been successfully submitted, maybe new pages
|
|
# should be revealed.
|
|
self.feed_current_data(magictoken)
|
|
self.reset_pages_cache()
|
|
|
|
if int(page_no) == len(self.pages):
|
|
# last page has been submitted
|
|
req = get_request()
|
|
for field in self.formdef.fields:
|
|
k = field.id
|
|
if k in form_data:
|
|
v = form_data[k]
|
|
if field.convert_value_to_str:
|
|
v = field.convert_value_to_str(v)
|
|
req.form['f%s' % k] = v
|
|
if self.edit_mode:
|
|
form = self.create_view_form(form_data, use_tokens=False)
|
|
return self.submitted_existing(form)
|
|
if self.has_confirmation_page():
|
|
return self.validating(form_data)
|
|
else:
|
|
step = 1 # so it will flow to submit
|
|
# kind of restore state
|
|
form = Form()
|
|
form.add_hidden('step', '-1')
|
|
form.add_hidden('page', '-1')
|
|
form.add_hidden('magictoken', '-1')
|
|
form.add_submit('cancel')
|
|
if self.has_draft_support():
|
|
form.add_submit('removedraft')
|
|
form.add_submit('savedraft')
|
|
|
|
else:
|
|
return self.page(self.pages[page_no])
|
|
|
|
self.reset_locked_data(form)
|
|
if step == 1:
|
|
form.add_submit('previous')
|
|
magictoken = form.get_widget('magictoken').parse()
|
|
|
|
if form.get_submit() == 'previous':
|
|
return self.previous_page(len(self.pages), magictoken)
|
|
magictoken = form.get_widget('magictoken').parse()
|
|
form_data = session.get_by_magictoken(magictoken, {})
|
|
data = self.formdef.get_data(form)
|
|
form_data.update(data)
|
|
session.add_magictoken(magictoken, form_data)
|
|
|
|
step = 2 # so it will flow to submit
|
|
form = Form()
|
|
form.add_hidden('step', '-1')
|
|
form.add_hidden('page', '-1')
|
|
form.add_hidden('magictoken', '-1')
|
|
form.add_submit('cancel')
|
|
|
|
if step == 2:
|
|
form.add_submit('previous')
|
|
magictoken = form.get_widget('magictoken').parse()
|
|
self.feed_current_data(magictoken)
|
|
form_data = session.get_by_magictoken(magictoken, {})
|
|
|
|
if form.get_submit() == 'previous':
|
|
return self.previous_page(len(self.pages), magictoken)
|
|
|
|
if self.has_draft_support() and form.get_submit() == 'removedraft':
|
|
return self.removedraft()
|
|
|
|
if self.has_draft_support() and form.get_submit() == 'savedraft':
|
|
filled = self.save_draft(form_data, page_no = -1)
|
|
return redirect(filled.get_url())
|
|
|
|
# so it gets FakeFileWidget in preview mode
|
|
form = self.create_view_form(form_data,
|
|
use_tokens=self.has_confirmation_page())
|
|
if self.formdef.has_captcha and not (get_session().get_user() or get_session().won_captcha):
|
|
form.add_captcha(hint='')
|
|
if form.captcha.has_error():
|
|
return self.validating(form_data)
|
|
|
|
if form.has_errors():
|
|
# the only possible error here is a token error if the form is
|
|
# submitted a second time
|
|
return template.error_page(_('This form has already been submitted.'))
|
|
|
|
return self.submitted(form, existing_formdata)
|
|
|
|
def reset_locked_data(self, form):
|
|
# reset locked fields, making sure the user cannot alter them.
|
|
prefill_user = get_request().user
|
|
if get_request().is_in_backoffice():
|
|
prefill_user = get_publisher().substitutions.get_context_variables().get('form_user')
|
|
for field, field_key, widget, block in self.iter_with_block_fields(form, self.formdef.fields):
|
|
if not field.prefill:
|
|
continue
|
|
post_key = 'f%s' % field_key
|
|
if block:
|
|
post_key = 'f%s$element0$f%s' % (block.id, field.id)
|
|
if post_key not in get_request().form:
|
|
continue
|
|
v, locked = field.get_prefill_value(user=prefill_user)
|
|
if locked:
|
|
if not isinstance(v, six.string_types) and field.convert_value_to_str:
|
|
# convert structured data to strings as if they were
|
|
# submitted by the browser.
|
|
v = field.convert_value_to_str(v)
|
|
get_request().form[post_key] = v
|
|
if widget:
|
|
widget.set_value(v)
|
|
if block:
|
|
# child widget value was changed, mark parent widgets
|
|
# as unparsed
|
|
block_widget = form.get_widget('f%s' % block.id)
|
|
block_widget._parsed = False
|
|
block_widget.widgets[0]._parsed = False
|
|
|
|
# keep track of locked field, this will be used when
|
|
# redisplaying the same page in case of errors.
|
|
get_request().form['__locked_f%s' % field_key] = True
|
|
|
|
def previous_page(self, page_no, magictoken):
|
|
session = get_session()
|
|
form_data = session.get_by_magictoken(magictoken, {})
|
|
|
|
try:
|
|
previous_page = self.pages[int(page_no - 1)]
|
|
except IndexError:
|
|
previous_page = self.pages[0]
|
|
|
|
return self.page(previous_page, page_change=True)
|
|
|
|
def removedraft(self):
|
|
magictoken = get_request().form.get('magictoken')
|
|
if magictoken:
|
|
form_data = get_session().get_by_magictoken(magictoken, {})
|
|
if form_data.get('draft_formdata_id'):
|
|
self.formdef.data_class().remove_object(form_data.get('draft_formdata_id'))
|
|
return redirect(get_publisher().get_root_url())
|
|
|
|
def autosave_draft(self, draft_id, page_no, form_data):
|
|
try:
|
|
formdata = self.formdef.data_class().get(draft_id)
|
|
except KeyError:
|
|
return
|
|
|
|
if not formdata.status == 'draft':
|
|
raise SubmittedDraftException()
|
|
|
|
formdata.page_no = page_no
|
|
formdata.data = form_data
|
|
formdata.receipt_time = time.localtime()
|
|
if not get_request().is_in_backoffice():
|
|
formdata.user = get_request().user
|
|
formdata.store()
|
|
|
|
def autosave(self):
|
|
get_response().set_content_type('application/json')
|
|
def result_error(reason):
|
|
get_request().ignore_session = True
|
|
return json.dumps({'result': 'error', 'reason': reason})
|
|
|
|
ajax_form_token = get_request().form.get('_ajax_form_token')
|
|
if not ajax_form_token:
|
|
return result_error('no ajax form token')
|
|
if not get_session().has_form_token(ajax_form_token):
|
|
return result_error('obsolete ajax form token')
|
|
|
|
try:
|
|
page_no = int(get_request().form.get('page'))
|
|
except TypeError:
|
|
return result_error('missing page_no')
|
|
except ValueError:
|
|
return result_error('bad page_no')
|
|
|
|
magictoken = get_request().form.get('magictoken')
|
|
if not magictoken:
|
|
return result_error('missing magictoken')
|
|
|
|
session = get_session()
|
|
if not session:
|
|
return result_error('missing session')
|
|
|
|
self.feed_current_data(magictoken)
|
|
|
|
form_data = session.get_by_magictoken(magictoken, {})
|
|
if not form_data:
|
|
return result_error('missing data')
|
|
|
|
try:
|
|
page = self.pages[page_no]
|
|
except IndexError:
|
|
# XXX: this should not happen but if pages use conditionals based
|
|
# on webservice results, there can be (temporary?) inconsistencies.
|
|
return result_error('ouf ot range page_no')
|
|
form = self.create_form(page=page)
|
|
data = self.formdef.get_data(form)
|
|
if not data:
|
|
return result_error('nothing to save')
|
|
|
|
form_data.update(data)
|
|
|
|
# reload session to make sure _ajax_form_token is still valid
|
|
session = get_session_manager().get(get_session().id)
|
|
if not session:
|
|
return result_error('cannot get ajax form token (lost session)')
|
|
if not session.has_form_token(get_request().form.get('_ajax_form_token')):
|
|
return result_error('obsolete ajax form token (late check)')
|
|
|
|
try:
|
|
draft_formdata = self.save_draft(form_data, page_no)
|
|
except SubmittedDraftException:
|
|
return result_error('form has already been submitted')
|
|
|
|
return json.dumps({'result': 'success'})
|
|
|
|
def save_draft(self, data, page_no=None):
|
|
filled = self.get_current_draft() or self.formdef.data_class()()
|
|
if filled.id and filled.status != 'draft':
|
|
raise SubmittedDraftException()
|
|
filled.data = data
|
|
filled.prefilling_data = data.get('prefilling_data')
|
|
filled.status = 'draft'
|
|
if page_no is not None:
|
|
filled.page_no = page_no
|
|
filled.receipt_time = time.localtime()
|
|
session = get_session()
|
|
if get_request().is_in_backoffice():
|
|
# if submitting via backoffice store fhe formdata as is.
|
|
filled.store()
|
|
else:
|
|
# if submitting via frontoffice, attach current user, eventually
|
|
# anonymous, to the formdata
|
|
filled.user = get_request().user
|
|
filled.store()
|
|
|
|
if not filled.user_id:
|
|
get_session().mark_anonymous_formdata(filled)
|
|
|
|
data['draft_formdata_id'] = filled.id
|
|
self.set_tracking_code(filled, data)
|
|
|
|
get_logger().info('form %s - saving draft (id: %s)' % (self.formdef.name, filled.id))
|
|
|
|
return filled
|
|
|
|
def get_current_draft(self):
|
|
magictoken = get_request().form.get('magictoken')
|
|
if magictoken:
|
|
session = get_session()
|
|
form_data = session.get_by_magictoken(magictoken, {})
|
|
draft_formdata_id = form_data.get('draft_formdata_id')
|
|
if draft_formdata_id:
|
|
# there was a draft, use it.
|
|
try:
|
|
return self.formdef.data_class().get(draft_formdata_id)
|
|
except KeyError: # it may not exist
|
|
pass
|
|
return None
|
|
|
|
def live(self):
|
|
get_request().ignore_session = True
|
|
# live evaluation of fields
|
|
get_response().set_content_type('application/json')
|
|
def result_error(reason):
|
|
return json.dumps({'result': 'error', 'reason': reason})
|
|
|
|
session = get_session()
|
|
if not (session and session.id):
|
|
return result_error('missing session')
|
|
|
|
page_id = get_request().form.get('page_id')
|
|
if page_id:
|
|
for field in self.formdef.fields:
|
|
if str(field.id) == page_id:
|
|
page = field
|
|
break
|
|
else:
|
|
return result_error('unknown page_id')
|
|
else:
|
|
page = None
|
|
formdata = self.get_transient_formdata()
|
|
get_publisher().substitutions.feed(formdata)
|
|
displayed_fields = []
|
|
with get_publisher().substitutions.temporary_feed(formdata, force_mode='lazy'):
|
|
form = self.create_form(
|
|
page=page,
|
|
displayed_fields=displayed_fields,
|
|
transient_formdata=formdata)
|
|
formdata.data.update(self.formdef.get_data(form))
|
|
return FormStatusPage.live_process_fields(form, formdata, displayed_fields)
|
|
|
|
def clean_submission_context(self):
|
|
get_publisher().substitutions.unfeed(lambda x: x.__class__.__name__ == 'ConditionVars')
|
|
get_publisher().substitutions.unfeed(lambda x: isinstance(x, FormData))
|
|
|
|
def submitted(self, form, existing_formdata = None):
|
|
if existing_formdata: # modifying
|
|
filled = existing_formdata
|
|
filled.last_modification_time = time.localtime()
|
|
# XXX: what about status?
|
|
else:
|
|
filled = self.get_current_draft() or self.formdef.data_class()()
|
|
filled.just_created()
|
|
|
|
filled.data = self.formdef.get_data(form)
|
|
session = get_session()
|
|
filled.user = get_request().user
|
|
|
|
if get_request().get_path().startswith('/backoffice/'):
|
|
filled.user_id = None
|
|
|
|
# this is already checked in _q_index but it's done a second time
|
|
# just before a new form is to be stored.
|
|
existing_form_id = self.check_unique_submission()
|
|
if existing_form_id:
|
|
return redirect('%s/' % existing_form_id)
|
|
|
|
filled.store()
|
|
self.set_tracking_code(filled)
|
|
session.remove_magictoken(get_request().form.get('magictoken'))
|
|
|
|
get_logger().info('form %s - done (id: %s)' % (self.formdef.name, filled.id))
|
|
url = None
|
|
if existing_formdata is None:
|
|
self.clean_submission_context()
|
|
url = filled.perform_workflow()
|
|
|
|
if not filled.user_id:
|
|
get_session().mark_anonymous_formdata(filled)
|
|
|
|
if not url:
|
|
if get_request().get_path().startswith('/backoffice/'):
|
|
url = filled.get_url(backoffice=True)
|
|
else:
|
|
url = filled.get_url()
|
|
return redirect(url)
|
|
|
|
def cancelled(self):
|
|
return redirect(get_publisher().get_root_url())
|
|
|
|
def set_tracking_code(self, formdata, magictoken_data=None):
|
|
if not self.formdef.enable_tracking_codes:
|
|
return
|
|
if formdata.tracking_code:
|
|
return
|
|
code = get_publisher().tracking_code_class()
|
|
if magictoken_data and 'future_tracking_code' in magictoken_data:
|
|
code.id = magictoken_data['future_tracking_code']
|
|
code.formdata = formdata # this will .store() the code
|
|
|
|
def submitted_existing(self, form):
|
|
new_data = self.formdef.get_data(form)
|
|
for k, v in self.edited_data.data.items():
|
|
if k.startswith(WorkflowBackofficeFieldsFormDef.field_prefix):
|
|
new_data[k] = v
|
|
self.edited_data.data = new_data
|
|
self.edited_data.store()
|
|
# remove previous vars and formdata from substitution variables
|
|
self.clean_submission_context()
|
|
# and add new one
|
|
get_publisher().substitutions.feed(self.edited_data)
|
|
wf_status = self.edited_data.get_status()
|
|
url = None
|
|
for item in wf_status.items:
|
|
if item.id == self.edit_action_id:
|
|
wf_status = item.get_target_status(self.edited_data)
|
|
if wf_status:
|
|
self.edited_data.jump_status(wf_status[0].id)
|
|
url = self.edited_data.perform_workflow()
|
|
break
|
|
return redirect(url or '.')
|
|
|
|
def tempfile(self):
|
|
self.check_role()
|
|
if self.user and not self.user.id == get_session().user:
|
|
self.check_receiver()
|
|
try:
|
|
t = get_request().form['t']
|
|
tempfile = get_session().get_tempfile(t)
|
|
except KeyError:
|
|
raise errors.TraversalError()
|
|
if tempfile is None:
|
|
raise errors.TraversalError()
|
|
response = get_response()
|
|
if tempfile['content_type']:
|
|
response.set_content_type(tempfile['content_type'])
|
|
else:
|
|
response.set_content_type('application/octet-stream')
|
|
if tempfile['charset']:
|
|
response.set_charset(tempfile['charset'])
|
|
|
|
if get_request().form.get('thumbnail') == '1':
|
|
try:
|
|
thumbnail = misc.get_thumbnail(get_session().get_tempfile_path(t),
|
|
content_type=tempfile['content_type'])
|
|
except misc.ThumbnailError:
|
|
pass
|
|
else:
|
|
response.set_content_type('image/png')
|
|
return thumbnail
|
|
return get_session().get_tempfile_content(t).get_file_pointer().read()
|
|
|
|
def validating(self, data):
|
|
get_request().view_name = 'validation'
|
|
self.html_top(self.formdef.name)
|
|
# fake a GET request to avoid previous page POST data being carried
|
|
# over in rendering.
|
|
get_request().environ['REQUEST_METHOD'] = 'GET'
|
|
form = self.create_view_form(data)
|
|
token_widget = form.get_widget(form.TOKEN_NAME)
|
|
token_widget._parsed = True
|
|
if self.formdef.has_captcha and not (get_session().get_user() or get_session().won_captcha):
|
|
get_request().form['captcha$q'] = ''
|
|
captcha_text = TextsDirectory.get_html_text('captcha-page')
|
|
if captcha_text:
|
|
form.widgets.append(HtmlWidget(captcha_text))
|
|
form.add_captcha(hint='')
|
|
form.captcha.has_error = lambda request: False
|
|
form.add_submit('submit', _('Submit'))
|
|
form.add_submit('previous', _('Previous'))
|
|
cancel_label = _('Cancel')
|
|
if self.has_draft_support() and not (data and data.get('is_recalled_draft')):
|
|
cancel_label = _('Discard')
|
|
form.add_submit('cancel', cancel_label, css_class='cancel')
|
|
session = get_session()
|
|
if self.has_draft_support():
|
|
form.add_submit('savedraft', _('Save Draft'), css_class = 'save-draft',
|
|
attrs={'style': 'display: none'})
|
|
form.add_hidden('step', '2')
|
|
magictoken = get_request().form['magictoken']
|
|
form.add_hidden('magictoken', magictoken)
|
|
|
|
context = {
|
|
'view': self,
|
|
'form': form,
|
|
'form_side': lambda: self.form_side(step_no=1, page=None, data=data,
|
|
magictoken=magictoken),
|
|
'steps': lambda: self.step(1, None),
|
|
}
|
|
if self.has_draft_support() and data:
|
|
context['tracking_code_box'] = lambda: self.tracking_code_box(data, magictoken)
|
|
|
|
return template.QommonTemplateResponse(
|
|
templates=list(self.get_formdef_template_variants(self.validation_templates)),
|
|
context=context)
|
|
|
|
def tryauth(self):
|
|
return tryauth(self.formdef.get_url())
|
|
|
|
def auth(self):
|
|
return auth(self.formdef.get_url())
|
|
|
|
def forceauth(self):
|
|
return forceauth(self.formdef.get_url())
|
|
|
|
def qrcode(self):
|
|
img = qrcode.make(self.formdef.get_url())
|
|
s = BytesIO()
|
|
img.save(s)
|
|
if get_request().get_query() == 'download':
|
|
get_response().set_header('content-disposition',
|
|
'attachment; filename=qrcode-%s.png' % self.formdef.url_name)
|
|
get_response().set_content_type('image/png')
|
|
return s.getvalue()
|
|
|
|
@classmethod
|
|
def get_status_page_class(cls):
|
|
return PublicFormStatusPage
|
|
|
|
def _q_lookup(self, component):
|
|
try:
|
|
filled = self.formdef.data_class().get(component)
|
|
except KeyError:
|
|
raise errors.TraversalError()
|
|
|
|
return self.get_status_page_class()(self.formdef, filled)
|
|
|
|
|
|
class RootDirectory(AccessControlled, Directory):
|
|
_q_exports = ['', 'json', 'categories', 'code', 'tryauth', 'auth']
|
|
|
|
category = None
|
|
code = TrackingCodesDirectory()
|
|
|
|
def __init__(self, category = None):
|
|
self.category = category
|
|
get_publisher().substitutions.feed(category)
|
|
|
|
def tryauth(self):
|
|
if self.category:
|
|
base_url = self.category.get_url()
|
|
else:
|
|
base_url = get_publisher().get_root_url()
|
|
return tryauth(base_url)
|
|
|
|
def auth(self):
|
|
if self.category:
|
|
base_url = self.category.get_url()
|
|
else:
|
|
base_url = get_publisher().get_root_url()
|
|
return auth(base_url)
|
|
|
|
def _q_access(self):
|
|
if self.category:
|
|
response = get_response()
|
|
response.breadcrumb.append( ('%s/' % self.category.url_name, self.category.name ) )
|
|
|
|
def get_list_of_forms(self, formdefs, user):
|
|
list_forms = []
|
|
advertised_forms = []
|
|
|
|
for formdef in formdefs:
|
|
if formdef.roles:
|
|
if not user:
|
|
if formdef.always_advertise:
|
|
advertised_forms.append(formdef)
|
|
continue
|
|
if logged_users_role().id not in formdef.roles:
|
|
for q in user.get_roles():
|
|
if q in formdef.roles:
|
|
break
|
|
else:
|
|
if formdef.always_advertise:
|
|
advertised_forms.append(formdef)
|
|
continue
|
|
list_forms.append(formdef)
|
|
|
|
return list_forms, advertised_forms
|
|
|
|
def _q_index(self):
|
|
if get_request().get_header(str('Accept'), '') == 'application/json':
|
|
return self.json()
|
|
|
|
if not self.category:
|
|
redirect_url = get_cfg('misc', {}).get('homepage-redirect-url')
|
|
else:
|
|
redirect_url = self.category.redirect_url
|
|
|
|
if redirect_url:
|
|
return redirect(misc.get_variadic_url(redirect_url,
|
|
get_publisher().substitutions.get_context_variables(mode='lazy')))
|
|
|
|
template.html_top(default_org = _('Forms'))
|
|
r = TemplateIO(html=True)
|
|
|
|
session = get_session()
|
|
request = get_request()
|
|
user = request.user
|
|
|
|
if not self.category:
|
|
get_logger().info('home page')
|
|
if user:
|
|
message = TextsDirectory.get_html_text('welcome-logged')
|
|
else:
|
|
message = TextsDirectory.get_html_text('welcome-unlogged')
|
|
|
|
if message:
|
|
r += htmltext('<div id="welcome-message">')
|
|
r += message
|
|
r += htmltext('</div>')
|
|
|
|
if self.category:
|
|
all_formdefs = FormDef.select(
|
|
lambda x: str(x.category_id) == str(self.category.id),
|
|
order_by='name', ignore_errors=True)
|
|
else:
|
|
all_formdefs = FormDef.select(order_by='name', ignore_errors=True)
|
|
|
|
formdefs = [x for x in all_formdefs if (not x.is_disabled() or x.disabled_redirection)]
|
|
|
|
if not self.category and any((x for x in formdefs if x.enable_tracking_codes)):
|
|
r += htmltext('<div id="side">')
|
|
r += htmltext('<div id="tracking-code">')
|
|
r += htmltext('<h3>%s</h3>') % _('Tracking code')
|
|
r += htmltext('<form action="/code/load">')
|
|
r += htmltext('<input size="12" name="code" placeholder="%s"/>') % _('ex: RPQDFVCD')
|
|
r += htmltext('<input type="submit" value="%s"/>') % _('Load')
|
|
r += htmltext('</form>')
|
|
r += htmltext('</div>')
|
|
r += htmltext('</div> <!-- #side -->')
|
|
|
|
list_forms, advertised_forms = self.get_list_of_forms(formdefs, user)
|
|
|
|
if formdefs and not list_forms and not advertised_forms:
|
|
# there is forms, but none can be displayed
|
|
raise errors.AccessUnauthorizedError()
|
|
|
|
user_forms = []
|
|
if user:
|
|
for formdef in all_formdefs:
|
|
user_forms.extend(get_user_forms(formdef))
|
|
user_forms = [x for x in user_forms if x.formdef.is_user_allowed_read(user, x)]
|
|
epoch = time.localtime(1970)
|
|
user_forms.sort(key=lambda x: x.receipt_time or epoch)
|
|
|
|
if self.category:
|
|
r += self.form_list(list_forms, category = self.category,
|
|
session = session, user_forms = user_forms,
|
|
advertised_forms = advertised_forms)
|
|
else:
|
|
cats = Category.select()
|
|
Category.sort_by_position(cats)
|
|
one = False
|
|
for c in cats:
|
|
l2 = [x for x in list_forms if str(x.category_id) == str(c.id)]
|
|
l2_advertise = [x for x in advertised_forms if str(x.category_id) == str(c.id)]
|
|
if l2 or l2_advertise:
|
|
r += self.form_list(l2, category = c,
|
|
session = session, user_forms = user_forms,
|
|
advertised_forms = l2_advertise)
|
|
one = True
|
|
|
|
l2 = [x for x in list_forms if not x.category]
|
|
l2_advertise = [x for x in advertised_forms if not x.category]
|
|
if l2 or l2_advertise:
|
|
if one:
|
|
title = _('Misc')
|
|
else:
|
|
title = None
|
|
r += self.form_list(l2, title = title,
|
|
session = session, user_forms = user_forms,
|
|
advertised_forms = l2_advertise)
|
|
|
|
root_url = get_publisher().get_root_url()
|
|
if user:
|
|
r += self.user_forms(user_forms)
|
|
|
|
if not self.category:
|
|
r += htmltext('<p id="logout">')
|
|
if user.can_go_in_backoffice():
|
|
r += htmltext('<a href="%sbackoffice/">%s</a> - ') % (root_url, _('Back Office'))
|
|
if user.anonymous:
|
|
if get_cfg('saml_identities', {}).get('creation', 'admin') != 'admin':
|
|
r += htmltext('<a href="%sregister">%s</a> - ') % (root_url, _('Register'))
|
|
|
|
r += htmltext('<a href="%slogout">%s</a></p>') % (root_url, _('Logout'))
|
|
|
|
elif get_cfg('sp') or get_cfg('identification', {}).get('methods'):
|
|
if not self.category:
|
|
r += htmltext('<p id="login"><a href="%slogin">%s</a>') % (root_url, _('Login'))
|
|
identities_cfg = get_cfg('identities', {})
|
|
if identities_cfg.get('creation') in ('self', 'moderated'):
|
|
r += htmltext(' - <a href="%sregister">%s</a>') % (root_url, _('Register'))
|
|
r += htmltext('</p>')
|
|
return r.getvalue()
|
|
|
|
|
|
def user_forms(self, user_forms):
|
|
r = TemplateIO(html=True)
|
|
draft = [x for x in user_forms if x.is_draft() and not x.formdef.is_disabled()]
|
|
if draft:
|
|
r += htmltext('<h2 id="drafts">%s</h2>') % _('Your Current Drafts')
|
|
r += htmltext('<ul>')
|
|
for f in draft:
|
|
r += htmltext('<li><a href="/%s/%s">%s</a>, %s</li>') % (
|
|
f.formdef.url_name, f.id, f.formdef.name,
|
|
misc.localstrftime(f.receipt_time))
|
|
r += htmltext('</ul>')
|
|
|
|
# with workflows
|
|
workflows = [Workflow.get_default_workflow()] + Workflow.select(order_by = 'name')
|
|
for workflow in workflows:
|
|
# XXX: seperate endpoints from non-endpoints
|
|
for status in workflow.possible_status:
|
|
fms = [x for x in user_forms if \
|
|
x.formdef.workflow.id == workflow.id and \
|
|
(x.get_visible_status() == status)]
|
|
if not fms:
|
|
continue
|
|
r += htmltext('<h2>%s</h2>') % _('Your forms with status "%s"') % status.name
|
|
r += htmltext('<ul>')
|
|
for f in fms:
|
|
r += htmltext('<li><a href="/%s/%s/">%s</a>, %s</li>') % (
|
|
f.formdef.url_name, f.id, f.formdef.name,
|
|
misc.localstrftime(f.receipt_time))
|
|
r += htmltext('</ul>')
|
|
return r.getvalue()
|
|
|
|
|
|
def form_list(self, list, category = None, title = None,
|
|
session = None, user_forms = None, advertised_forms = []):
|
|
r = TemplateIO(html=True)
|
|
|
|
keywords = {}
|
|
for formdef in list:
|
|
for keyword in formdef.keywords_list:
|
|
keywords[keyword] = True
|
|
|
|
div_attrs = {'class': 'category'}
|
|
if keywords:
|
|
div_attrs['data-keywords'] = ' '.join(keywords)
|
|
|
|
if title:
|
|
div_attrs['id'] = 'category-%s' % misc.simplify(title)
|
|
elif category:
|
|
div_attrs['id'] = 'category-%s' % category.url_name
|
|
else:
|
|
div_attrs['id'] = 'category-misc'
|
|
|
|
r += htmltext('<div %s>' % ' '.join(
|
|
['%s="%s"' % x for x in div_attrs.items()]))
|
|
if title:
|
|
r += htmltext('<h2>%s</h2>') % title
|
|
elif category:
|
|
r += htmltext('<h2>%s</h2>') % category.name
|
|
|
|
formdefs_data = None
|
|
if self.category:
|
|
url_prefix = ''
|
|
r += self.category.get_description_html_text()
|
|
elif category:
|
|
url_prefix = '%s/' % category.url_name
|
|
else:
|
|
url_prefix = ''
|
|
r += htmltext('<ul class="catforms">')
|
|
for formdef in list:
|
|
if formdef.only_allow_one and user_forms:
|
|
if formdefs_data is None:
|
|
formdefs_data = [x.formdef.id for x in user_forms
|
|
if x.formdef.only_allow_one and not x.is_draft()]
|
|
r += htmltext('<li data-keywords="%s">') % ' '.join(formdef.keywords_list)
|
|
if formdefs_data and formdef.id in formdefs_data:
|
|
# form has already been completed
|
|
r += htmltext('%s (%s, <a href="%s%s/">%s</a>)') % (
|
|
formdef.name, _('already completed'),
|
|
url_prefix, formdef.url_name, _('review'))
|
|
else:
|
|
classes = []
|
|
if formdef.is_disabled() and formdef.disabled_redirection:
|
|
classes.append('redirection')
|
|
r += htmltext('<a class="%s" href="%s%s/">%s</a>') % (
|
|
' '.join(classes), url_prefix, formdef.url_name, formdef.name)
|
|
|
|
if formdef.description:
|
|
r += htmltext('<div class="description">%s</div>' % formdef.description)
|
|
r += htmltext('</li>')
|
|
|
|
for formdef in advertised_forms:
|
|
r += htmltext('<li class="required-authentication" data-keywords="%s">'
|
|
) % ' '.join(formdef.keywords_list)
|
|
r += htmltext('<a href="%s%s/">%s</a>') % (url_prefix, formdef.url_name, formdef.name)
|
|
r += htmltext('<span> (%s)</span>') % _('authentication required')
|
|
if formdef.description:
|
|
r += htmltext('<div class="description">%s</div>' % formdef.description)
|
|
r += htmltext('</li>')
|
|
r += htmltext('</ul>')
|
|
r += htmltext('</div>')
|
|
return r.getvalue()
|
|
|
|
def json(self):
|
|
# backward compatibility
|
|
from wcs.api import ApiFormdefsDirectory
|
|
return ApiFormdefsDirectory(self.category)._q_index()
|
|
|
|
def get_categories(self, user):
|
|
result = []
|
|
formdefs = FormDef.select(
|
|
lambda x: not x.is_disabled() or x.disabled_redirection,
|
|
order_by='name', ignore_errors=True, lightweight=True)
|
|
list_forms, advertised_forms = self.get_list_of_forms(formdefs, user)
|
|
list_forms = list_forms + advertised_forms
|
|
cats = Category.select()
|
|
Category.sort_by_position(cats)
|
|
for c in cats:
|
|
if [x for x in list_forms if str(x.category_id) == str(c.id)]:
|
|
result.append(c)
|
|
return result
|
|
|
|
def categories(self):
|
|
if self.category:
|
|
raise errors.TraversalError()
|
|
if get_request().is_json():
|
|
return self.categories_json()
|
|
template.html_top(_('Categories'))
|
|
r = TemplateIO(html=True)
|
|
user = get_request().user
|
|
for category in self.get_categories(user):
|
|
r += htmltext('<h2>%s</h2>') % category.name
|
|
r += category.get_description_html_text()
|
|
r += htmltext('<p><a href="%s/">%s</a></p>') % (category.url_name, _('All forms'))
|
|
return r.getvalue()
|
|
|
|
def categories_json(self):
|
|
# backward compatibility
|
|
from wcs.api import ApiCategoriesDirectory
|
|
return ApiCategoriesDirectory()._q_index()
|
|
|
|
def _q_lookup(self, component):
|
|
return FormPage(component)
|
|
|
|
|
|
class PublicFormStatusPage(FormStatusPage):
|
|
_q_exports_orig = ['', 'download', 'status', 'live']
|
|
form_page_class = FormPage
|
|
history_templates = ['wcs/front/formdata_history.html', 'wcs/formdata_history.html']
|
|
status_templates = ['wcs/front/formdata_status.html', 'wcs/formdata_status.html']
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
FormStatusPage.__init__(self, *args, **kwargs)
|
|
if self.filled.anonymised:
|
|
if get_session() and get_session().is_anonymous_submitter(self.filled):
|
|
return
|
|
raise errors.TraversalError()
|
|
|
|
def status(self):
|
|
return redirect('%sbackoffice/%s/%s/' % (
|
|
get_publisher().get_root_url(),
|
|
self.formdef.url_name,
|
|
str(self.filled.id)))
|
|
|
|
|
|
TextsDirectory.register('welcome-logged',
|
|
N_('Welcome text on home page for logged users'))
|
|
|
|
TextsDirectory.register('welcome-unlogged',
|
|
N_('Welcome text on home page for unlogged users'))
|
|
|
|
TextsDirectory.register('captcha-page',
|
|
N_('Explanation text before the CAPTCHA'),
|
|
default = N_('''<h3>Verification</h3>
|
|
|
|
<p>
|
|
In order to submit the form you need to complete this simple question.
|
|
</p>'''))
|
|
|
|
|
|
TextsDirectory.register('form-recorded',
|
|
N_('Message when a form has been recorded'),
|
|
category = N_('Forms'),
|
|
default = N_('The form has been recorded on {{ form_receipt_datetime }} with the number {{ form_number }}.'))
|
|
|
|
TextsDirectory.register('form-recorded-allow-one',
|
|
N_('Message when a form has been recorded, and the form is set to only allow one per user'),
|
|
category = N_('Forms'),
|
|
default = N_('The form has been recorded on {{ form_receipt_datetime }}.'))
|
|
|
|
TextsDirectory.register('check-before-submit',
|
|
N_('Message when a form is displayed before validation'),
|
|
category = N_('Forms'),
|
|
default = N_('Check values then click submit.'))
|
|
|
|
TextsDirectory.register('tracking-code-email-dialog',
|
|
N_('Message in tracking code popup dialog'),
|
|
category = N_('Forms'),
|
|
default = N_('You can get a reminder of the tracking code by email.'))
|
|
|
|
TextsDirectory.register('tracking-code-short-text',
|
|
N_('Short text in the tracking code box'),
|
|
category=N_('Forms'))
|
|
|
|
EmailsDirectory.register('tracking-code-reminder',
|
|
N_('Tracking Code'),
|
|
category = N_('Miscellaneous'),
|
|
default_subject = N_('Tracking Code reminder'),
|
|
default_body = N_('''\
|
|
Hello,
|
|
|
|
As a reminder your tracking code for {{ form_name }} is {{ form_tracking_code }}.
|
|
|
|
'''))
|