Merge pull request #444 from maykinmedia/feature/1087-add-siteimprove-analytics

[#1087] Feature/add siteimprove to configurations and admin

Author: alextreme

src/open_inwoner/configurations/admin.py

@@ -136,7 +136,15 @@ class SiteConfigurarionAdmin(OrderedInlineModelAdminMixin, SingletonModelAdmin):
         ),
         (
             _("Analytics"),
-            {"fields": ("gtm_code", "ga_code", "matomo_url", "matomo_site_id")},
+            {
+                "fields": (
+                    "gtm_code",
+                    "ga_code",
+                    "matomo_url",
+                    "matomo_site_id",
+                    "siteimprove_id",
+                )
+            },
         ),
     )
     inlines = [SiteConfigurationPageInline]

src/open_inwoner/configurations/migrations/0031_siteconfiguration_siteimprove_id.py

@@ -0,0 +1,24 @@
+# Generated by Django 3.2.15 on 2023-02-01 09:30
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("configurations", "0030_auto_20230120_1331"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="siteconfiguration",
+            name="siteimprove_id",
+            field=models.CharField(
+                blank=True,
+                default="",
+                help_text="SiteImprove ID - this can be found in the snippet example, which should contain a URL like '//siteimproveanalytics.com/js/siteanalyze_xxxxx.js'. The xxxxx part is the ID.",
+                max_length=10,
+                verbose_name="SiteImprove ID",
+            ),
+        ),
+    ]

src/open_inwoner/configurations/models.py

@@ -314,6 +314,8 @@ class SiteConfiguration(SingletonModel):
         default=True,
         help_text=_("Whether to send email about each new message the user receives"),
     )
+
+    # analytics
     gtm_code = models.CharField(
         verbose_name=_("Google Tag Manager code"),
         max_length=50,
@@ -342,6 +344,18 @@ class SiteConfiguration(SingletonModel):
         null=True,
         help_text=_("The 'idsite' of the website you're tracking in Matomo."),
     )
+    siteimprove_id = models.CharField(
+        _("SiteImprove ID"),
+        max_length=10,
+        default="",
+        blank=True,
+        help_text=_(
+            "SiteImprove ID - this can be found in the snippet example, "
+            "which should contain a URL like '//siteimproveanalytics.com/js/siteanalyze_xxxxx.js'. "
+            "The xxxxx part is the ID."
+        ),
+    )
+
     show_cases = models.BooleanField(
         verbose_name=_("Show cases"),
         default=False,
@@ -425,6 +439,10 @@ def google_enabled(self):
     def matomo_enabled(self):
         return self.matomo_url and self.matomo_site_id
 
+    @property
+    def siteimprove_enabled(self):
+        return True if self.siteimprove_id else False
+
     def get_help_text(self, request):
         current_path = request.get_full_path()