NEMO-custom-forms 1.0.1__tar.gz

nemo_custom_forms-1.0.1/LICENSE

@@ -0,0 +1,6 @@
+# NIST Software Licensing Statement
+NIST-developed software is provided by NIST as a public service. You may use, copy, and distribute copies of the software in any medium, provided that you keep intact this entire notice. You may improve, modify, and create derivative works of the software or any portion of the software, and you may copy and distribute such modifications or works. Modified works should carry a notice stating that you changed the software and should note the date and nature of any such change. Please explicitly acknowledge the National Institute of Standards and Technology as the source of the software.
+
+NIST-developed software is expressly provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED, IN FACT, OR ARISING BY OPERATION OF LAW, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND DATA ACCURACY. NIST NEITHER REPRESENTS NOR WARRANTS THAT THE OPERATION OF THE SOFTWARE WILL BE UNINTERRUPTED OR ERROR-FREE, OR THAT ANY DEFECTS WILL BE CORRECTED. NIST DOES NOT WARRANT OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF THE SOFTWARE OR THE RESULTS THEREOF, INCLUDING BUT NOT LIMITED TO THE CORRECTNESS, ACCURACY, RELIABILITY, OR USEFULNESS OF THE SOFTWARE.
+
+You are solely responsible for determining the appropriateness of using and distributing the software and you assume all risks associated with its use, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and the unavailability or interruption of operation. This software is not intended to be used in any situation where a failure could cause risk of injury or damage to property. The software developed by NIST employees is not subject to copyright protection within the United States.

nemo_custom_forms-1.0.1/NEMO_custom_forms/admin.py

@@ -0,0 +1,259 @@
+import json
+import os
+
+from NEMO.mixins import ModelAdminRedirectMixin
+from NEMO.models import User
+from NEMO.utilities import copy_media_file, new_model_copy
+from NEMO.widgets.dynamic_form import DynamicForm
+from django import forms
+from django.contrib import admin, messages
+from django.db import transaction
+from django.urls import reverse
+from django.utils.html import format_html
+from django.utils.safestring import mark_safe
+
+from NEMO_custom_forms.models import (
+    CustomForm,
+    CustomFormAction,
+    CustomFormActionRecord,
+    CustomFormAutomaticNumbering,
+    CustomFormDisplayColumn,
+    CustomFormDocumentType,
+    CustomFormDocuments,
+    CustomFormPDFTemplate,
+    CustomFormSpecialMapping,
+)
+from NEMO_custom_forms.utilities import custom_forms_current_numbers
+
+
+@admin.action(description="Duplicate selected templates")
+def duplicate_custom_form_template(modeladmin, request, queryset):
+    for template in queryset.all():
+        with transaction.atomic():
+            template: CustomFormPDFTemplate = template
+            template_copy = new_model_copy(template)
+            template_copy.name = "Copy of " + template.name
+            if CustomFormPDFTemplate.objects.filter(name=template_copy.name).exists():
+                messages.error(request, f"Template with name {template_copy.name} already exists. Skipping.")
+            else:
+                new_form_name = template_copy.get_filename_upload(os.path.basename(template.form.name))
+                copy_media_file(template.form.name, new_form_name)
+                template_copy.form.name = new_form_name
+                template_copy.save()
+                for display_column in template.customformdisplaycolumn_set.all():
+                    display_column_copy = new_model_copy(display_column)
+                    display_column_copy.template = template_copy
+                    display_column_copy.save()
+                old_to_new_action_ids = {}
+                for action in template.customformaction_set.all():
+                    action_copy = new_model_copy(action)
+                    action_copy.template = template_copy
+                    action_copy.save()
+                    old_to_new_action_ids[action.id] = action_copy.id
+                for special_mapping in template.customformspecialmapping_set.all():
+                    special_mapping_copy = new_model_copy(special_mapping)
+                    special_mapping_copy.template = template_copy
+                    if special_mapping.field_value_action_id:
+                        special_mapping_copy.field_value_action_id = old_to_new_action_ids[
+                            special_mapping.field_value_action_id
+                        ]
+                    special_mapping_copy.save()
+                messages.success(
+                    request,
+                    mark_safe(
+                        f"Template {template.name} successfully duplicated to <a href='{reverse('admin:NEMO_custom_forms_customformpdftemplate_change', args=[template_copy.id])}'>{template_copy.name}</a>."
+                    ),
+                )
+
+
+class CustomFormActionFormset(forms.BaseInlineFormSet):
+    model = CustomFormAction
+
+
+class CustomFormSpecialMappingFormset(forms.BaseInlineFormSet):
+    model = CustomFormSpecialMapping
+
+    def add_fields(self, form, index):
+        super().add_fields(form, index)
+        form.fields["field_value_action"].queryset = CustomFormAction.objects.filter(
+            template=self.instance
+        ).select_related("template")
+
+
+class CustomFormActionAdminInline(admin.TabularInline):
+    model = CustomFormAction
+    formset = CustomFormActionFormset
+
+    def get_queryset(self, request):
+        queryset = super().get_queryset(request).select_related("template")
+        return queryset
+
+
+class CustomFormSpecialMappingAdminInline(admin.TabularInline):
+    model = CustomFormSpecialMapping
+    formset = CustomFormSpecialMappingFormset
+
+    def get_queryset(self, request):
+        queryset = super().get_queryset(request).select_related("template", "field_value_action")
+        return queryset
+
+
+class CustomFormDisplayColumnInline(admin.TabularInline):
+    model = CustomFormDisplayColumn
+
+    def get_queryset(self, request):
+        queryset = super().get_queryset(request).select_related("template")
+        return queryset
+
+
+class CustomFormPDFTemplateForm(forms.ModelForm):
+
+    class Media:
+        js = ("admin/dynamic_form_preview/dynamic_form_preview.js",)
+        css = {"": ("admin/dynamic_form_preview/dynamic_form_preview.css",)}
+
+    class Meta:
+        widgets = {"filename_template": forms.Textarea(attrs={"rows": 4, "cols": 75})}
+
+    def clean_form_fields(self):
+        form_fields = self.cleaned_data["form_fields"]
+        try:
+            return json.dumps(json.loads(form_fields), indent=4)
+        except:
+            pass
+        return form_fields
+
+
+@admin.register(CustomFormPDFTemplate)
+class CustomFormPDFTemplateAdmin(ModelAdminRedirectMixin, admin.ModelAdmin):
+    form = CustomFormPDFTemplateForm
+    list_display = ["name", "enabled", "form", "get_create_permissions", "get_view_all_permissions"]
+    list_filter = ["enabled"]
+    readonly_fields = ["_pdf_form_fields", "_form_fields_preview"]
+    inlines = [CustomFormActionAdminInline, CustomFormSpecialMappingAdminInline, CustomFormDisplayColumnInline]
+    actions = [duplicate_custom_form_template]
+
+    def _pdf_form_fields(self, obj: CustomFormPDFTemplate):
+        if obj.form:
+            container_id = f"toggle-fields-{obj.pk}"
+            toggle_link = format_html(
+                f'<a href="javascript:void(0);" onclick="$(\'#{container_id}\').toggle()">Show/Hide Fields</a>',
+                container_id,
+            )
+            fields_list = "".join(
+                f"<li style='list-style: initial'>{field}{(': ' + str(obj.pdf_form_field_states(field))) if obj.pdf_form_field_states(field) else ''}</li>"
+                for field in obj.pdf_form_fields()
+            )
+            fields_container = format_html(
+                '<div id="{}" style="display:none;"><ul style="margin-left:10px;">{}</ul></div>',
+                container_id,
+                mark_safe(fields_list),
+            )
+            return mark_safe(f"{toggle_link}<br>{fields_container}")
+        return ""
+
+    def _form_fields_preview(self, obj: CustomFormPDFTemplate):
+        if obj.id:
+            form_validity_div = '<div id="form_validity"></div>' if obj.form_fields else ""
+            return mark_safe(
+                '<div class="dynamic_form_preview">{}{}</div><div class="help dynamic_form_preview_help">Save form to preview form fields</div>'.format(
+                    DynamicForm(obj.form_fields).render("custom_form_fields_group", obj.id),
+                    form_validity_div,
+                )
+            )
+        return ""
+
+    @admin.display(description="View all permissions", ordering="view_all_permissions")
+    def get_view_all_permissions(self, obj: CustomFormPDFTemplate):
+        return mark_safe(
+            "<br>".join(
+                str(obj.get_view_all_permissions_field().role_display(role_str, admin_display=True))
+                for role_str in obj.view_all_permissions
+            )
+        )
+
+    @admin.display(description="Create permissions", ordering="create_permissions")
+    def get_create_permissions(self, obj: CustomFormPDFTemplate):
+        return mark_safe(
+            "<br>".join(
+                str(obj.get_create_permissions_field().role_display(role_str, admin_display=True))
+                for role_str in obj.create_permissions
+            )
+        )
+
+
+class CustomFormActionRecordInline(admin.TabularInline):
+    model = CustomFormActionRecord
+
+
+class CustomFormDocumentsInline(admin.TabularInline):
+    model = CustomFormDocuments
+    extra = 1
+
+
+@admin.register(CustomFormDocumentType)
+class CustomFormDocumentTypeAdmin(admin.ModelAdmin):
+    list_display = ["name", "form_template", "display_order"]
+    list_filter = ["form_template"]
+
+
+@admin.register(CustomForm)
+class CustomFormAdmin(admin.ModelAdmin):
+    inlines = [CustomFormDocumentsInline, CustomFormActionRecordInline]
+    list_display = ["creation_time", "form_number", "status", "last_updated", "creator", "template", "cancelled"]
+    list_filter = [
+        ("creator", admin.RelatedOnlyFieldListFilter),
+        ("template", admin.RelatedOnlyFieldListFilter),
+        "status",
+        "cancelled",
+    ]
+    date_hierarchy = "last_updated"
+
+    def delete_queryset(self, request, queryset):
+        # This is needed so that the notifications for these forms are also deleted
+        for obj in queryset:
+            obj.delete()
+
+
+class CustomFormAutomaticNumberingForm(forms.ModelForm):
+
+    class Meta:
+        model = CustomFormAutomaticNumbering
+        fields = "__all__"
+        widgets = {"numbering_template": forms.Textarea(attrs={"rows": 4, "cols": 75})}
+
+
+@admin.register(CustomFormAutomaticNumbering)
+class CustomFormAutomaticNumberingAdmin(admin.ModelAdmin):
+    list_display = ["template", "enabled", "numbering_group", "numbering_per_user", "get_role_display"]
+    list_filter = ["enabled", "numbering_per_user"]
+    readonly_fields = ["custom_form_numbers"]
+    form = CustomFormAutomaticNumberingForm
+
+    @admin.display(description="Allowed role/group", ordering="role")
+    def get_role_display(self, obj: CustomFormAutomaticNumbering):
+        return obj.get_role_display(admin_display=True)
+
+    def custom_form_numbers(self, obj: CustomFormAutomaticNumbering):
+        current_number = custom_forms_current_numbers(obj.template)
+        display_list = ""
+        if current_number:
+            if obj.numbering_group and obj.numbering_per_user:
+                for group, value in current_number.items():
+                    display_list += f'<li style="list-style: inherit">{group}<ul style="margin-left: 20px">'
+                    for user_id, number in value.items():
+                        user = User.objects.filter(id=user_id).first()
+                        user = user.username if user else user_id
+                        display_list += f'<li style="list-style: inherit"><u>{user}</u>: {number}</li>'
+                    display_list += "</ul></li>"
+            elif obj.numbering_group:
+                for group, number in current_number.items():
+                    display_list += f'<li style="list-style: inherit"><u>{group}</u>: {number}</li>'
+            elif obj.numbering_per_user:
+                for user_id, number in current_number.items():
+                    user = User.objects.filter(id=user_id).first()
+                    user = user.username if user else user_id
+                    display_list += f'<li style="list-style: inherit"><u>{user}</u>: {number}</li>'
+            return mark_safe(f'Current form numbers:<ul style="margin-left: 20px">{display_list}</ul>')
+        else:
+            return "No current form numbers recorded"

nemo_custom_forms-1.0.1/NEMO_custom_forms/apps.py

@@ -0,0 +1,24 @@
+from django.apps import AppConfig
+
+
+class CustomFormsConfig(AppConfig):
+    name = "NEMO_custom_forms"
+    verbose_name = "Custom Forms"
+    default_auto_field = "django.db.models.AutoField"
+    plugin_id = 1100  # Used to make EmailCategory and other IntegerChoices ranges unique
+
+    def ready(self):
+        from django.utils.translation import gettext_lazy as _
+        from NEMO.plugins.utils import (
+            add_dynamic_notification_types,
+            add_dynamic_email_categories,
+            check_extra_dependencies,
+        )
+        from NEMO_custom_forms.utilities import CUSTOM_FORM_NOTIFICATION, CUSTOM_FORM_EMAIL_CATEGORY
+
+        check_extra_dependencies(self.name, ["NEMO", "NEMO-CE"])
+
+        add_dynamic_notification_types(
+            [(CUSTOM_FORM_NOTIFICATION, _("Custom forms action - notifies next action candidates"))]
+        )
+        add_dynamic_email_categories([(CUSTOM_FORM_EMAIL_CATEGORY, _("Custom forms"))])