def form_designer(request, domain, app_id, module_id=None, form_id=None):
def _form_uses_case(module, form):
return module and module.case_type and form.requires_case()
def _form_is_basic(form):
return form.doc_type == 'Form'
def _form_too_large(app, form):
# form less than 0.1MB, anything larger starts to have
# performance issues with fullstory
return app.blobs['{}.xml'.format(
form.unique_id)]['content_length'] > 102400
meta = get_meta(request)
track_entered_form_builder_on_hubspot.delay(request.couch_user,
request.COOKIES, meta)
app = get_app(domain, app_id)
module = None
try:
module = app.get_module(module_id)
except ModuleNotFoundException:
return bail(request, domain, app_id, not_found="module")
try:
form = module.get_form(form_id)
except IndexError:
return bail(request, domain, app_id, not_found="form")
if form.no_vellum:
messages.warning(
request,
_("You tried to edit this form in the Form Builder. "
"However, your administrator has locked this form against editing "
"in the form builder, so we have redirected you to "
"the form's front page instead."))
return back_to_main(request,
domain,
app_id=app_id,
unique_form_id=form.unique_id)
include_fullstory = False
vellum_plugins = ["modeliteration", "itemset", "atwho"]
if (toggles.COMMTRACK.enabled(domain)):
vellum_plugins.append("commtrack")
if toggles.VELLUM_SAVE_TO_CASE.enabled(domain):
vellum_plugins.append("saveToCase")
if (_form_uses_case(module, form) and _form_is_basic(form)):
vellum_plugins.append("databrowser")
vellum_features = toggles.toggles_dict(username=request.user.username,
domain=domain)
vellum_features.update(feature_previews.previews_dict(domain))
include_fullstory = not _form_too_large(app, form)
vellum_features.update({
'group_in_field_list':
app.enable_group_in_field_list,
'image_resize':
app.enable_image_resize,
'markdown_in_groups':
app.enable_markdown_in_groups,
'lookup_tables':
domain_has_privilege(domain, privileges.LOOKUP_TABLES),
'templated_intents':
domain_has_privilege(domain, privileges.TEMPLATED_INTENTS),
'custom_intents':
domain_has_privilege(domain, privileges.CUSTOM_INTENTS),
'rich_text':
True,
})
has_schedule = (getattr(module, 'has_schedule', False)
and getattr(form, 'schedule', False)
and form.schedule.enabled)
scheduler_data_nodes = []
if has_schedule:
scheduler_data_nodes = [
SCHEDULE_CURRENT_VISIT_NUMBER,
SCHEDULE_NEXT_DUE,
SCHEDULE_UNSCHEDULED_VISIT,
SCHEDULE_GLOBAL_NEXT_VISIT_DATE,
]
scheduler_data_nodes.extend([
u"next_{}".format(f.schedule_form_id)
for f in form.get_phase().get_forms()
if getattr(f, 'schedule', False) and f.schedule.enabled
])
if tours.VELLUM_CASE_MANAGEMENT.is_enabled(
request.user) and form.requires_case():
request.guided_tour = tours.VELLUM_CASE_MANAGEMENT.get_tour_data()
context = get_apps_base_context(request, domain, app)
context.update(locals())
context.update({
'vellum_debug':
settings.VELLUM_DEBUG,
'nav_form':
form,
'formdesigner':
True,
'include_fullstory':
include_fullstory,
'notifications_enabled':
request.user.is_superuser,
'notify_facility':
get_facility_for_form(domain, app_id, form.unique_id),
})
notify_form_opened(domain, request.couch_user, app_id, form.unique_id)
domain_obj = Domain.get_by_name(domain)
context.update({
'show_live_preview':
should_show_preview_app(
request,
app,
request.couch_user.username,
),
'can_preview_form':
request.couch_user.has_permission(domain, 'edit_data'),
})
core = {
'dataSourcesEndpoint':
reverse('get_form_data_schema',
kwargs={
'domain': domain,
'form_unique_id': form.get_unique_id()
}),
'dataSource': [
# DEPRECATED. Use dataSourcesEndpoint
{
'key': 'fixture',
'name': 'Fixtures',
'endpoint': reverse('fixture_metadata',
kwargs={'domain': domain}),
},
],
'form':
form.source,
'formId':
form.get_unique_id(),
'formName':
trans(form.name, app.langs),
'saveType':
'patch',
'saveUrl':
reverse('edit_form_attr',
args=[domain, app.id,
form.get_unique_id(), 'xform']),
'patchUrl':
reverse('patch_xform', args=[domain, app.id,
form.get_unique_id()]),
'allowedDataNodeReferences': [
"meta/deviceID",
"meta/instanceID",
"meta/username",
"meta/userID",
"meta/timeStart",
"meta/timeEnd",
"meta/location",
] + scheduler_data_nodes,
'activityUrl':
reverse('ping'),
'sessionid':
request.COOKIES.get('sessionid'),
'externalLinks': {
'changeSubscription':
reverse("domain_subscription_view", kwargs={'domain': domain}),
},
'invalidCaseProperties': ['name'],
}
if toggles.APP_MANAGER_V2.enabled(request.user.username):
if form.get_action_type() == 'open':
core.update({
'defaultHelpTextTemplateId': '#fd-hq-helptext-registration',
'formIconClass': 'fcc fcc-app-createform',
})
elif form.get_action_type() == 'close':
core.update({
'defaultHelpTextTemplateId': '#fd-hq-helptext-close',
'formIconClass': 'fcc fcc-app-completeform',
})
elif form.get_action_type() == 'update':
core.update({
'defaultHelpTextTemplateId': '#fd-hq-helptext-followup',
'formIconClass': 'fcc fcc-app-updateform',
})
else:
core.update({
'defaultHelpTextTemplateId': '#fd-hq-helptext-survey',
'formIconClass': 'fa fa-file-o',
})
vellum_options = {
'core': core,
'plugins': vellum_plugins,
'features': vellum_features,
'intents': {
'templates': next(app_callout_templates),
},
'javaRosa': {
'langs': app.langs,
'displayLanguage': context['lang'],
},
'uploader': {
'uploadUrls': {
'image': reverse("hqmedia_uploader_image",
args=[domain, app.id]),
'audio': reverse("hqmedia_uploader_audio",
args=[domain, app.id]),
'video': reverse("hqmedia_uploader_video",
args=[domain, app.id]),
'text': reverse("hqmedia_uploader_text", args=[domain,
app.id]),
},
'objectMap': app.get_object_map(),
'sessionid': request.COOKIES.get('sessionid'),
},
}
context.update({
'vellum_options': vellum_options,
'CKEDITOR_BASEPATH': "app_manager/js/vellum/lib/ckeditor/",
})
if not settings.VELLUM_DEBUG:
context.update({'requirejs_url': "app_manager/js/vellum/src"})
elif settings.VELLUM_DEBUG == "dev-min":
context.update({'requirejs_url': "formdesigner/_build/src"})
else:
context.update({'requirejs_url': "formdesigner/src"})
context.update({
'requirejs_args':
'version={}{}'.format(
cachebuster("app_manager/js/vellum/src/main-components.js"),
cachebuster("app_manager/js/vellum/src/local-deps.js")),
})
template = get_app_manager_template(
request.user,
'app_manager/v1/form_designer.html',
'app_manager/v2/form_designer.html',
)
response = render(request, template, context)
return response
def form_designer(request, domain, app_id, module_id=None, form_id=None,
is_user_registration=False):
meta = get_meta(request)
track_entered_form_builder_on_hubspot.delay(request.couch_user, request.COOKIES, meta)
app = get_app(domain, app_id)
module = None
if is_user_registration:
form = app.get_user_registration()
else:
try:
module = app.get_module(module_id)
except ModuleNotFoundException:
return bail(request, domain, app_id, not_found="module")
try:
form = module.get_form(form_id)
except IndexError:
return bail(request, domain, app_id, not_found="form")
if form.no_vellum:
messages.warning(request, _(
"You tried to edit this form in the Form Builder. "
"However, your administrator has locked this form against editing "
"in the form builder, so we have redirected you to "
"the form's front page instead."
))
return back_to_main(request, domain, app_id=app_id,
unique_form_id=form.unique_id)
vellum_plugins = ["modeliteration", "itemset"]
if toggles.VELLUM_TRANSACTION_QUESTION_TYPES.enabled(domain):
vellum_plugins.append("commtrack")
if toggles.VELLUM_SAVE_TO_CASE.enabled(domain):
vellum_plugins.append("saveToCase")
if toggles.VELLUM_EXPERIMENTAL_UI.enabled(domain):
vellum_plugins.append("databrowser")
vellum_features = toggles.toggles_dict(username=request.user.username,
domain=domain)
vellum_features.update({
'group_in_field_list': app.enable_group_in_field_list,
'image_resize': app.enable_image_resize,
'markdown_in_groups': app.enable_markdown_in_groups,
'lookup_tables': domain_has_privilege(domain, privileges.LOOKUP_TABLES),
'templated_intents': domain_has_privilege(domain, privileges.TEMPLATED_INTENTS),
'custom_intents': domain_has_privilege(domain, privileges.CUSTOM_INTENTS),
})
has_schedule = (
getattr(module, 'has_schedule', False) and
getattr(form, 'schedule', False) and form.schedule.enabled
)
scheduler_data_nodes = []
if has_schedule:
scheduler_data_nodes = [
SCHEDULE_CURRENT_VISIT_NUMBER,
SCHEDULE_NEXT_DUE,
SCHEDULE_UNSCHEDULED_VISIT,
SCHEDULE_GLOBAL_NEXT_VISIT_DATE,
]
scheduler_data_nodes.extend([
u"next_{}".format(f.schedule_form_id)
for f in form.get_phase().get_forms()
if getattr(f, 'schedule', False) and f.schedule.enabled
])
context = get_apps_base_context(request, domain, app)
context.update(locals())
context.update({
'vellum_debug': settings.VELLUM_DEBUG,
'nav_form': form if not is_user_registration else '',
'formdesigner': True,
'multimedia_object_map': app.get_object_map(),
'sessionid': request.COOKIES.get('sessionid'),
'features': vellum_features,
'plugins': vellum_plugins,
'app_callout_templates': next(app_callout_templates),
'scheduler_data_nodes': scheduler_data_nodes,
})
return render(request, 'app_manager/form_designer.html', context)
def _get_form_designer_view(request, domain, app, module, form):
if form.no_vellum:
messages.warning(
request,
_("You tried to edit this form in the Form Builder. "
"However, your administrator has locked this form against editing "
"in the form builder, so we have redirected you to "
"the form's front page instead."))
return back_to_main(request,
domain,
app_id=app.id,
form_unique_id=form.unique_id)
track_entered_form_builder_on_hubspot.delay(request.couch_user,
request.COOKIES,
get_meta(request))
def _form_too_large(_app, _form):
# form less than 0.1MB, anything larger starts to have
# performance issues with fullstory
return _app.blobs['{}.xml'.format(
_form.unique_id)]['content_length'] > 102400
context = get_apps_base_context(request, domain, app)
context.update(locals())
vellum_options = _get_base_vellum_options(request, domain, app,
context['lang'])
vellum_options['core'] = _get_vellum_core_context(request, domain, app,
module, form)
vellum_options['plugins'] = _get_vellum_plugins(domain, form, module)
vellum_options['features'] = _get_vellum_features(request, domain, app)
context['vellum_options'] = vellum_options
context.update({
'vellum_debug':
settings.VELLUM_DEBUG,
'nav_form':
form,
'formdesigner':
True,
'include_fullstory':
not _form_too_large(app, form),
'CKEDITOR_BASEPATH':
"app_manager/js/vellum/lib/ckeditor/",
'show_live_preview':
should_show_preview_app(
request,
app,
request.couch_user.username,
),
})
context.update(_get_requirejs_context())
context['current_app_version_url'] = reverse('current_app_version',
args=[domain, app.id])
if request.user.is_superuser:
context.update({
'notification_options':
_get_notification_options(request, domain, app, form)
})
notify_form_opened(domain, request.couch_user, app.id, form.unique_id)
return render(request, "app_manager/form_designer.html", context)
def form_designer(request, domain, app_id, module_id=None, form_id=None):
def _form_uses_case(module, form):
return module and module.case_type and form.requires_case()
def _form_is_basic(form):
return form.doc_type == 'Form'
def _form_too_large(app, form):
# form less than 0.1MB, anything larger starts to have
# performance issues with fullstory
return app.blobs['{}.xml'.format(
form.unique_id)]['content_length'] > 102400
meta = get_meta(request)
track_entered_form_builder_on_hubspot.delay(request.couch_user,
request.COOKIES, meta)
app = get_app(domain, app_id)
module = None
try:
module = app.get_module(module_id)
except ModuleNotFoundException:
return bail(request, domain, app_id, not_found="module")
try:
form = module.get_form(form_id)
except IndexError:
return bail(request, domain, app_id, not_found="form")
if form.no_vellum:
messages.warning(
request,
_("You tried to edit this form in the Form Builder. "
"However, your administrator has locked this form against editing "
"in the form builder, so we have redirected you to "
"the form's front page instead."))
return back_to_main(request,
domain,
app_id=app_id,
unique_form_id=form.unique_id)
include_fullstory = False
vellum_plugins = ["modeliteration", "itemset", "atwho"]
if (toggles.COMMTRACK.enabled(domain)):
vellum_plugins.append("commtrack")
if toggles.VELLUM_SAVE_TO_CASE.enabled(domain):
vellum_plugins.append("saveToCase")
if (_form_uses_case(module, form) and _form_is_basic(form)):
vellum_plugins.append("databrowser")
vellum_features = toggles.toggles_dict(username=request.user.username,
domain=domain)
vellum_features.update(feature_previews.previews_dict(domain))
include_fullstory = not _form_too_large(app, form)
vellum_features.update({
'group_in_field_list':
app.enable_group_in_field_list,
'image_resize':
app.enable_image_resize,
'markdown_in_groups':
app.enable_markdown_in_groups,
'lookup_tables':
domain_has_privilege(domain, privileges.LOOKUP_TABLES),
'templated_intents':
domain_has_privilege(domain, privileges.TEMPLATED_INTENTS),
'custom_intents':
domain_has_privilege(domain, privileges.CUSTOM_INTENTS),
'rich_text':
True,
})
has_schedule = (getattr(module, 'has_schedule', False)
and getattr(form, 'schedule', False)
and form.schedule.enabled)
scheduler_data_nodes = []
if has_schedule:
scheduler_data_nodes = [
SCHEDULE_CURRENT_VISIT_NUMBER,
SCHEDULE_NEXT_DUE,
SCHEDULE_UNSCHEDULED_VISIT,
SCHEDULE_GLOBAL_NEXT_VISIT_DATE,
]
scheduler_data_nodes.extend([
u"next_{}".format(f.schedule_form_id)
for f in form.get_phase().get_forms()
if getattr(f, 'schedule', False) and f.schedule.enabled
])
if tours.VELLUM_CASE_MANAGEMENT.is_enabled(
request.user) and form.requires_case():
request.guided_tour = tours.VELLUM_CASE_MANAGEMENT.get_tour_data()
vellum_base = 'corehq/apps/app_manager/static/app_manager/js/'
vellum_dir = 'vellum'
if isdir(join(vellum_base, 'vellum_beta')):
vellum_dir = 'vellum_beta'
context = get_apps_base_context(request, domain, app)
context.update(locals())
context.update({
'vellum_debug':
settings.VELLUM_DEBUG,
'nav_form':
form,
'vellum_style_path':
'app_manager/js/{}/style.css'.format(vellum_dir),
'vellum_ckeditor_path':
'app_manager/js/{}/lib/ckeditor/'.format(vellum_dir),
'vellum_js_path':
'app_manager/js/{}/src'.format(vellum_dir),
'vellum_main_components_path':
'app_manager/js/{}/src/main-components.js'.format(vellum_dir),
'vellum_local_deps_path':
'app_manager/js/{}/src/local-deps.js'.format(vellum_dir),
'formdesigner':
True,
'multimedia_object_map':
app.get_object_map(),
'sessionid':
request.COOKIES.get('sessionid'),
'features':
vellum_features,
'plugins':
vellum_plugins,
'app_callout_templates':
next(app_callout_templates),
'scheduler_data_nodes':
scheduler_data_nodes,
'include_fullstory':
include_fullstory,
'notifications_enabled':
request.user.is_superuser,
'notify_facility':
get_facility_for_form(domain, app_id, form.unique_id),
})
notify_form_opened(domain, request.couch_user, app_id, form.unique_id)
domain_obj = Domain.get_by_name(domain)
context.update({
'show_live_preview':
should_show_preview_app(
request,
app,
request.couch_user.username,
),
'can_preview_form':
request.couch_user.has_permission(domain, 'edit_data')
})
template = get_app_manager_template(
domain,
'app_manager/v1/form_designer.html',
'app_manager/v2/form_designer.html',
)
response = render(request, template, context)
return response
def form_designer(request, domain, app_id, module_id=None, form_id=None):
def _form_uses_case(module, form):
return module and module.case_type and form.requires_case()
def _form_is_basic(form):
return form.doc_type == 'Form'
def _form_too_large(app, form):
# form less than 0.1MB, anything larger starts to have
# performance issues with fullstory
return app.blobs['{}.xml'.format(form.unique_id)]['content_length'] > 102400
meta = get_meta(request)
track_entered_form_builder_on_hubspot.delay(request.couch_user, request.COOKIES, meta)
app = get_app(domain, app_id)
module = None
try:
module = app.get_module(module_id)
except ModuleNotFoundException:
return bail(request, domain, app_id, not_found="module")
try:
form = module.get_form(form_id)
except IndexError:
return bail(request, domain, app_id, not_found="form")
if form.no_vellum:
messages.warning(request, _(
"You tried to edit this form in the Form Builder. "
"However, your administrator has locked this form against editing "
"in the form builder, so we have redirected you to "
"the form's front page instead."
))
return back_to_main(request, domain, app_id=app_id,
unique_form_id=form.unique_id)
include_fullstory = False
vellum_plugins = ["modeliteration", "itemset", "atwho"]
if (toggles.COMMTRACK.enabled(domain)):
vellum_plugins.append("commtrack")
if toggles.VELLUM_SAVE_TO_CASE.enabled(domain):
vellum_plugins.append("saveToCase")
if (_form_uses_case(module, form) and _form_is_basic(form)):
vellum_plugins.append("databrowser")
vellum_features = toggles.toggles_dict(username=request.user.username,
domain=domain)
vellum_features.update(feature_previews.previews_dict(domain))
include_fullstory = not _form_too_large(app, form)
vellum_features.update({
'group_in_field_list': app.enable_group_in_field_list,
'image_resize': app.enable_image_resize,
'markdown_in_groups': app.enable_markdown_in_groups,
'lookup_tables': domain_has_privilege(domain, privileges.LOOKUP_TABLES),
'templated_intents': domain_has_privilege(domain, privileges.TEMPLATED_INTENTS),
'custom_intents': domain_has_privilege(domain, privileges.CUSTOM_INTENTS),
'rich_text': True,
})
has_schedule = (
getattr(module, 'has_schedule', False) and
getattr(form, 'schedule', False) and form.schedule.enabled
)
scheduler_data_nodes = []
if has_schedule:
scheduler_data_nodes = [
SCHEDULE_CURRENT_VISIT_NUMBER,
SCHEDULE_NEXT_DUE,
SCHEDULE_UNSCHEDULED_VISIT,
SCHEDULE_GLOBAL_NEXT_VISIT_DATE,
]
scheduler_data_nodes.extend([
u"next_{}".format(f.schedule_form_id)
for f in form.get_phase().get_forms()
if getattr(f, 'schedule', False) and f.schedule.enabled
])
if tours.VELLUM_CASE_MANAGEMENT.is_enabled(request.user) and form.requires_case():
request.guided_tour = tours.VELLUM_CASE_MANAGEMENT.get_tour_data()
context = get_apps_base_context(request, domain, app)
context.update(locals())
context.update({
'vellum_debug': settings.VELLUM_DEBUG,
'nav_form': form,
'formdesigner': True,
'multimedia_object_map': app.get_object_map(),
'sessionid': request.COOKIES.get('sessionid'),
'features': vellum_features,
'plugins': vellum_plugins,
'app_callout_templates': next(app_callout_templates),
'scheduler_data_nodes': scheduler_data_nodes,
'include_fullstory': include_fullstory,
'notifications_enabled': request.user.is_superuser,
'notify_facility': get_facility_for_form(domain, app_id, form.unique_id),
})
notify_form_opened(domain, request.couch_user, app_id, form.unique_id)
live_preview_ab = ab_tests.ABTest(ab_tests.LIVE_PREVIEW, request)
domain_obj = Domain.get_by_name(domain)
context.update({
'live_preview_ab': live_preview_ab.context,
'is_onboarding_domain': domain_obj.is_onboarding_domain,
'show_live_preview': (
toggles.PREVIEW_APP.enabled(domain)
or toggles.PREVIEW_APP.enabled(request.couch_user.username)
or (domain_obj.is_onboarding_domain
and live_preview_ab.version == ab_tests.LIVE_PREVIEW_ENABLED)
)
})
response = render(request, 'app_manager/v1/form_designer.html', context)
live_preview_ab.update_response(response)
return response
