[#1657] add option to hide categories from anonymous users

- added model field (bool) for hiding categories
- modified templatetags to render categories conditionally
- added `LoginMaybeRequiredMixin` to categories views in order to
  conditionally restrict access to authenticated users

Author: pi-sigma

src/open_inwoner/components/templatetags/header_tags.py

@@ -38,6 +38,12 @@ def header(categories, request, **kwargs):
         + request: Request | the django request object.
         - has_general_faq_questions: boolean | If the FAQ menu item should be shown.
     """
+    config = SiteConfiguration.get_solo()
+    if (
+        not request.user.is_authenticated
+        and not config.display_categories_for_anonymous_users
+    ):
+        categories = None
     return {
         **kwargs,
         "categories": categories,

src/open_inwoner/configurations/admin.py

@@ -189,6 +189,10 @@ class SiteConfigurarionAdmin(OrderedInlineModelAdminMixin, SingletonModelAdmin):
                 ),
             },
         ),
+        (
+            _("Display options for anonymous users"),
+            {"fields": ("display_categories_for_anonymous_users",)},
+        ),
     )
     inlines = [SiteConfigurationPageInline]
     form = SiteConfigurarionAdminForm

src/open_inwoner/configurations/migrations/0047_siteconfiguration_display_categories_for_anonymous_users.py

@@ -0,0 +1,22 @@
+# Generated by Django 3.2.15 on 2023-08-14 14:34
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("configurations", "0046_siteconfiguration_cookie_consent"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="siteconfiguration",
+            name="display_categories_for_anonymous_users",
+            field=models.BooleanField(
+                default=True,
+                help_text="If unchecked, categories will be hidden for users who are not logged in.",
+                verbose_name="Display categories for anonymouns users",
+            ),
+        ),
+    ]

src/open_inwoner/configurations/models.py

@@ -445,6 +445,13 @@ class SiteConfiguration(SingletonModel):
         default=True,
         help_text=_("Whether file sharing via the messages is allowed or not"),
     )
+    display_categories_for_anonymous_users = models.BooleanField(
+        verbose_name=_("Display categories for anonymouns users"),
+        default=True,
+        help_text=_(
+            "If unchecked, categories will be hidden for users who are not logged in."
+        ),
+    )
 
     class Meta:
         verbose_name = _("Site Configuration")

src/open_inwoner/pdc/utils.py

@@ -1 +1,18 @@
+from django.contrib.auth.mixins import AccessMixin
+
 PRODUCT_PATH_NAME = "products"
+
+
+class LoginMaybeRequiredMixin(AccessMixin):
+    """
+    Conditional access control on a per-view basis
+
+    Access to the view is restricted to authenticated users if
+    `self.display_restricted` is `True`, which must be defined on
+    the view inheriting from this Mixin.
+    """
+
+    def dispatch(self, request, *args, **kwargs):
+        if not request.user.is_authenticated and self.display_restricted:
+            return self.handle_no_permission()
+        return super().dispatch(request, *args, **kwargs)

src/open_inwoner/pdc/views.py

@@ -9,13 +9,13 @@
 
 from open_inwoner.configurations.models import SiteConfiguration
 from open_inwoner.pdc.models.product import ProductCondition
-from open_inwoner.plans.models import Plan
 from open_inwoner.questionnaire.models import QuestionnaireStep
 
 from ..utils.views import CommonPageMixin
 from .choices import YesNo
 from .forms import ProductFinderForm
 from .models import Category, Product, ProductLocation, Question
+from .utils import LoginMaybeRequiredMixin
 
 
 class CategoryBreadcrumbMixin:
@@ -112,7 +112,9 @@ def get_context_data(self, **kwargs):
         return super().get_context_data(**kwargs)
 
 
-class CategoryListView(CommonPageMixin, ListBreadcrumbMixin, ListView):
+class CategoryListView(
+    LoginMaybeRequiredMixin, CommonPageMixin, ListBreadcrumbMixin, ListView
+):
     template_name = "pages/category/list.html"
     model = Category
 
@@ -124,9 +126,18 @@ def crumbs(self):
         config = SiteConfiguration.get_solo()
         return [(config.theme_title, reverse("products:category_list"))]
 
+    @property
+    def display_restricted(self):
+        config = SiteConfiguration.get_solo()
+        return config.display_categories_for_anonymous_users is False
+
 
 class CategoryDetailView(
-    CommonPageMixin, BaseBreadcrumbMixin, CategoryBreadcrumbMixin, DetailView
+    LoginMaybeRequiredMixin,
+    CommonPageMixin,
+    BaseBreadcrumbMixin,
+    CategoryBreadcrumbMixin,
+    DetailView,
 ):
     template_name = "pages/category/detail.html"
     model = Category
@@ -166,6 +177,11 @@ def get_context_data(self, **kwargs):
     def get_breadcrumb_name(self):
         return self.object.name
 
+    @property
+    def display_restricted(self):
+        config = SiteConfiguration.get_solo()
+        return config.display_categories_for_anonymous_users is False
+
 
 class ProductDetailView(
     CommonPageMixin, BaseBreadcrumbMixin, CategoryBreadcrumbMixin, DetailView