Add form for contact information

Co-authored-by: David Venhoff <[email protected]>
Co-authored-by: Peter Nerlich <[email protected]>

integreat_cms/cms/fixtures/test_data.json

@@ -958,7 +958,7 @@
     "fields": {
       "title": "Integrationsbeauftragte",
       "name": "Martina Musterfrau",
-      "poi": 6,
+      "location": 6,
       "email": "[email protected]",
       "phone_number": "0123456789",
       "website": "",
@@ -973,7 +973,7 @@
     "fields": {
       "title": "Integrationsberaterin",
       "name": "Melanie Musterfrau",
-      "poi": 6,
+      "location": 6,
       "email": "[email protected]",
       "phone_number": "0987654321",
       "website": "www.random-page.com",
@@ -988,7 +988,7 @@
     "fields": {
       "title": "Integrationsbeauftragte",
       "name": "Mariana Musterfrau",
-      "poi": 6,
+      "location": 6,
       "email": "[email protected]",
       "phone_number": "0123456789",
       "website": "https://integreat-app.de/",

integreat_cms/cms/forms/__init__.py

@@ -6,6 +6,7 @@
 from __future__ import annotations
 
 from .chat.chat_message_form import ChatMessageForm
+from .contacts.contact_form import ContactForm
 from .events.event_filter_form import EventFilterForm
 from .events.event_form import EventForm
 from .events.event_translation_form import EventTranslationForm

integreat_cms/cms/forms/contacts/__init__.py

@@ -0,0 +1,3 @@
+"""
+Forms for creating and modifying contact objects
+"""

integreat_cms/cms/forms/contacts/contact_form.py

@@ -0,0 +1,62 @@
+from __future__ import annotations
+
+import logging
+from typing import TYPE_CHECKING
+
+from django import forms
+from django.utils.translation import gettext_lazy as _
+
+from ...models import Contact
+from ..custom_model_form import CustomModelForm
+
+if TYPE_CHECKING:
+    from typing import Any
+
+logger = logging.getLogger(__name__)
+
+
+class ContactForm(CustomModelForm):
+    """
+    Form for creating and modifying contact objects
+    """
+
+    class Meta:
+        """
+        This class contains additional meta configuration of the form class, see the :class:`django.forms.ModelForm`
+        for more information.
+        """
+
+        #: The model of this :class:`django.forms.ModelForm`
+        model = Contact
+        #: The fields of the model which should be handled by this form
+        fields = [
+            "title",
+            "name",
+            "location",
+            "email",
+            "phone_number",
+            "website",
+        ]
+
+    def clean(self) -> dict[str, Any]:
+        """
+        Validate the fields
+
+        :return: The cleaned form data
+        """
+        cleaned_data = super().clean()
+
+        related_location = self.instance.region.pois.filter(
+            id=self.data["location"]
+        ).first()
+
+        if related_location is None:
+            self.add_error(
+                None,
+                forms.ValidationError(
+                    _("Location cannot be empty."),
+                    code="invalid",
+                ),
+            )
+
+        return cleaned_data

integreat_cms/cms/migrations/0103_update_contact.py

@@ -0,0 +1,39 @@
+# Generated by Django 4.2.13 on 2024-08-20 16:10
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    """
+    Make the field name not mandatory.
+    Rename the field from "poi" to "location".
+    Add new fields to save whether the information must be taken over from the location.
+    """
+
+    dependencies = [
+        ("cms", "0102_alter_contact_poi"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="contact",
+            name="name",
+            field=models.CharField(blank=True, max_length=200, verbose_name="name"),
+        ),
+        migrations.RenameField(
+            model_name="contact",
+            old_name="poi",
+            new_name="location",
+        ),
+        migrations.AlterField(
+            model_name="contact",
+            name="location",
+            field=models.ForeignKey(
+                on_delete=django.db.models.deletion.PROTECT,
+                related_name="contacts",
+                to="cms.poi",
+                verbose_name="location",
+            ),
+        ),
+    ]

integreat_cms/cms/models/contact/contact.py

@@ -14,16 +14,21 @@ class Contact(AbstractBaseModel):
     """
 
     title = models.CharField(max_length=200, verbose_name=_("title"))
-    name = models.CharField(max_length=200, verbose_name=_("name"))
-    poi = models.ForeignKey(
-        POI, on_delete=models.PROTECT, verbose_name=_("POI"), related_name="contacts"
+    name = models.CharField(max_length=200, blank=True, verbose_name=_("name"))
+    location = models.ForeignKey(
+        POI,
+        on_delete=models.PROTECT,
+        verbose_name=_("location"),
+        related_name="contacts",
     )
     email = models.EmailField(
         blank=True,
         verbose_name=_("email address"),
     )
     phone_number = models.CharField(
-        max_length=250, blank=True, verbose_name=_("phone number")
+        max_length=250,
+        blank=True,
+        verbose_name=_("phone number"),
     )
     website = models.URLField(blank=True, max_length=250, verbose_name=_("website"))
     archived = models.BooleanField(
@@ -46,7 +51,7 @@ def region(self) -> Region:
 
         :return: Region this contact belongs to
         """
-        return self.poi.region
+        return self.location.region
 
     def __str__(self) -> str:
         """

integreat_cms/cms/templates/ajax_poi_form/poi_box.html

@@ -11,17 +11,24 @@
     {{ title }}
 {% endblock collapsible_box_title %}
 {% block collapsible_box_content %}
-    {% render_field form.has_not_location class+='inline-block' %}
-    <label class="secondary !inline"
-           for="{{ form.has_not_location.id_for_label }}">
-        {{ form.has_not_location.label }}
-    </label>
+    {% if current_menu_item == "events_form" %}
+        {% render_field form.has_not_location class+='inline-block' %}
+        <label class="secondary !inline"
+               for="{{ form.has_not_location.id_for_label }}">
+            {{ form.has_not_location.label }}
+        </label>
+    {% endif %}
+    {% if current_menu_item == "contacts" %}
+        <div class="help-text mt-4 font-bold">
+            {{ help_text }}
+        </div>
+    {% endif %}
     <div id="location-block"
          class="{% if form.has_not_location.value %}hidden{% endif %}">
         <label for="{{ form.location.id_for_label }}">
             {{ form.location.label }}
         </label>
-        {% translate "Name of event location" as poi_title_placeholder %}
+        {% translate "Name of location" as poi_title_placeholder %}
         <div class="relative my-2">
             <input id="poi-query-input"
                    type="search"
@@ -34,14 +41,16 @@
                    data-default-placeholder="{{ poi_title_placeholder }}" />
             <div class="absolute inset-y-0 right-0 flex items-center px-2 text-gray-800">
                 <button id="poi-remove"
-                        title="{% translate "Remove location from event" %}"
+                        title="{% translate "Remove location" %}"
                         {% if form.disabled %}disabled{% endif %}>
                     <i icon-name="trash-2" class="h-5 w-5"></i>
                 </button>
             </div>
         </div>
         <p class="text-sm italic block mt-2 mb-2">
-            {% translate "Create an event location or start typing the name of an existing location. Only published locations can be set as event venues" %}.
+            {% if current_menu_item == "events_form" %}
+                {{ help_text }}
+            {% endif %}
         </p>
         <div class="relative" id="poi-query-result">
             {% include "_poi_query_result.html" %}

integreat_cms/cms/templates/contacts/contact_form.html

@@ -0,0 +1,135 @@
+{% extends "_base.html" %}
+{% load i18n %}
+{% load widget_tweaks %}
+{% block content %}
+    {% with request.region.default_language as current_language %}
+        <form id="content_form"
+              method="post"
+              enctype="multipart/form-data"
+              data-unsaved-warning
+              {% if contact_form.disabled %}data-disable-poi-query{% endif %}>
+            {% csrf_token %}
+            <div class="flex justify-between mb-4">
+                <h1 class="heading">
+                    {% if contact_form.instance.id %}
+                        {% translate "Edit contact" %}
+                    {% else %}
+                        {% translate "Create new contact" %}
+                    {% endif %}
+                </h1>
+                <div class="flex flex-wrap justify-between gap-4">
+                    {% if perms.cms.change_contact and not contact_form.instance.archived %}
+                        <div class="flex flex-wrap gap-4">
+                            <button class="btn">
+                                {% if contact_form.instance.id %}
+                                    {% translate "Update" %}
+                                {% else %}
+                                    {% translate "Create" %}
+                                {% endif %}
+                            </button>
+                        </div>
+                    {% endif %}
+                </div>
+            </div>
+            <div class="grid xl:grid-cols-3 gap-4">
+                {% include "ajax_poi_form/poi_box.html" with form=contact_form box_id="contact-location" title=_("Connect a location") %}
+                <div id="contact_fields"
+                     class="mb-4 rounded border border-solid border-blue-500 shadow-2xl bg-white {% if not contact_form.instance.id %}hidden{% endif %}">
+                    <div class="p-4 rounded bg-water-500">
+                        <h3 class="heading font-bold text-black">
+                            <i icon-name="message-square" class="mr-2"></i> {% translate "Manage contact data" %}
+                        </h3>
+                    </div>
+                    <div class="p-4">
+                        <div class="help-text mt-4 font-bold">
+                            {% translate "Add missing data or change existing data. Select the data you want to import." %}
+                        </div>
+                        <label for="{{ contact_form.title.id_for_label }}">
+                            {{ contact_form.title.label }}
+                        </label>
+                        {% render_field contact_form.title|add_error_class:"border-red-500" %}
+                        <label for="{{ contact_form.name.id_for_label }}">
+                            {{ contact_form.name.label }}
+                        </label>
+                        {% render_field contact_form.name|add_error_class:"border-red-500" %}
+                        <label for="{{ contact_form.email.id_for_label }}">
+                            {{ contact_form.email.label }}
+                        </label>
+                        {% render_field contact_form.email|add_error_class:"border-red-500" %}
+                        <label for="{{ contact_form.phone_number.id_for_label }}">
+                            {{ contact_form.phone_number.label }}
+                        </label>
+                        {% render_field contact_form.phone_number|add_error_class:"border-red-500" %}
+                        <label for="{{ contact_form.website.id_for_label }}">
+                            {{ contact_form.website.label }}
+                        </label>
+                        {% render_field contact_form.website|add_error_class:"border-red-500" %}
+                    </div>
+                </div>
+                {% if contact_form.instance.id %}
+                    <div id="contact_usage"
+                         class="mb-4 rounded border border-solid border-blue-500 shadow-2xl bg-white">
+                        <div class="p-4 rounded bg-water-500">
+                            <h3 class="heading font-bold text-black">
+                                <i icon-name="message-square" class="mr-2"></i> {% translate "Contact information" %}
+                            </h3>
+                        </div>
+                        <div class="p-4">
+                            <div class="help-text mt-4 font-bold">
+                                {% trans "This contact is referred to in those contents." %}
+                            </div>
+                        </div>
+                        {% include "../_related_contents_table.html" with contents=referring_pages table_title=_("Pages") no_content_message=_("This contact is not currently referred to on any page.") %}
+                        {% include "../_related_contents_table.html" with contents=referring_locations table_title=_("Locations") no_content_message=_("This contact is not currently referred to in any location.") %}
+                        {% include "../_related_contents_table.html" with contents=referring_events table_title=_("Events") no_content_message=_("This contact is not currently referred to in any event.") %}
+                    </div>
+                {% endif %}
+            </div>
+            {% if contact_form.instance.id %}
+                <div class="flex flex-wrap grow justify-end gap-2 items-center">
+                    {% if perms.cms.change_contact and not contact_form.instance.archived %}
+                        <button title="{% translate "Archive contact" %}"
+                                class="btn confirmation-button btn-blue"
+                                data-confirmation-title="{{ archive_dialog_title }}"
+                                data-confirmation-text="{{ archive_dialog_text }}"
+                                data-confirmation-subject="{{ contact_form.instance.name }}"
+                                data-action="{% url 'archive_contact' contact_id=contact_form.instance.id region_slug=request.region.slug %}">
+                            <i icon-name="archive" class="mr-2"></i>
+                            {% translate "Archive this contact" %}
+                        </button>
+                    {% endif %}
+                    {% if perms.cms.change_contact and contact_form.instance.archived %}
+                        <button title="{% translate "Restore page" %}"
+                                class="btn confirmation-button btn-blue"
+                                data-confirmation-title="{{ restore_dialog_title }}"
+                                data-confirmation-text="{{ restore_dialog_text }}"
+                                data-confirmation-subject="{{ contact_form.instance.name }}"
+                                data-action="{% url 'restore_contact' contact_id=contact_form.instance.id region_slug=request.region.slug %}">
+                            <i icon-name="refresh-ccw" class="mr-2"></i> {% translate "Restore this contact" %}
+                        </button>
+                    {% endif %}
+                    {% if perms.cms.delete_contact %}
+                        <div class="flex flex-wrap gap-4">
+                            <button title="{% translate "Delete contact" %}"
+                                    class="btn confirmation-button btn-red"
+                                    data-confirmation-title="{{ delete_dialog_title }}"
+                                    data-confirmation-text="{{ delete_dialog_text }}"
+                                    data-confirmation-subject="{{ contact_form.instance.name }}"
+                                    data-action="{% url 'delete_contact' contact_id=contact_form.instance.id region_slug=request.region.slug %}">
+                                <i icon-name="trash-2" class="mr-2"></i>
+                                {% translate "Delete contact" %}
+                            </button>
+                        </div>
+                    {% endif %}
+                </div>
+            {% endif %}
+        </form>
+        <form id="ajax_poi_form"
+              name="ajax_poi_form"
+              method="post"
+              enctype="multipart/form-data"
+              data-unsaved-warning>
+        </form>
+        {% include "generic_confirmation_dialog.html" %}
+    {% endwith %}
+{% endblock content %}