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

pi-sigma · pi-sigma · commit 57d15fef701a · 2023-08-15T17:02:13.000+02:00
- added model field (bool) for hiding categories
- added `LoginMaybeRequiredMixin` to categories views in order to
  conditionally restrict access to authenticated users
- refactored rendering of nav bar (removed inclusion tags)
diff --git a/src/open_inwoner/components/templates/components/Header/Header.html b/src/open_inwoner/components/templates/components/Header/Header.html
@@ -3,6 +3,7 @@
 {% get_solo "configurations.SiteConfiguration" as config %}
 
 {% accessibility_header request=request %}
+
 <header class="header" aria-label="Navigatie header">
     <div class="header__container">
         <div class="header__menu">
@@ -45,17 +46,17 @@
                             {% link text=link_text href="/" icon="grid_view" icon_position="before" %}
                         </li>
 
-                        {% if cms_apps.products and categories %}
+                        {% if cms_apps.products %}
                         <li class="primary-navigation__list-item dropdown-nav__toggle">
                             <a href="#" class="link link--toggle link--icon link--icon-position-before" aria-label="{% trans "Onderwerpen" %}" title="{% trans "Onderwerpen" %}" aria-expanded="false">
                                 <span >{% trans "Onderwerpen" %}</span>
                                 <span aria-hidden="true" class="material-icons-outlined ">description</span>
                                 {% icon icon="expand_more" icon_position="after" icon_outlined=True %}
                             </a>
 
-                            {% if categories %}
+                            {% if menu_categories %}
                                 <ul class="primary-navigation__list subpage-list">
-                                    {% for category in categories %}
+                                    {% for category in menu_categories %}
                                         <li class="primary-navigation__list-item">
                                             {% url 'products:category_detail' slug=category.slug as category_href %}
                                             {% link text=category.name href=category_href %}
@@ -103,7 +104,7 @@
     {% firstof config.logo.default_alt_text config.name as logo_alt_text %}
         <div class="logo__desktop">{% logo src=config.logo.file.url alt="Homepage "|add:logo_alt_text svg_height=75 %}</div>
 
-        {% primary_navigation categories=categories request=request has_general_faq_questions=has_general_faq_questions cms_apps=cms_apps show_plans=show_plans %}
+				{% include "components/Header/PrimaryNavigation.html" %}
 
         {% if cms_apps.products %}
         <nav class="header__actions" aria-label="Zoek navigatie desktop">
@@ -115,7 +116,7 @@
         </nav>
         {% endif %}
 
-        {% navigation_authenticated categories=categories request=request has_general_faq_questions=has_general_faq_questions %}
+        {% include "components/Header/NavigationAuthenticated.html" %}
     </div>
 </header>
 
diff --git a/src/open_inwoner/components/templates/components/Header/PrimaryNavigation.html b/src/open_inwoner/components/templates/components/Header/PrimaryNavigation.html
@@ -4,22 +4,21 @@
 
 <nav class="primary-navigation primary-navigation__main" aria-label="Hoofd navigatie">
     <ul class="primary-navigation__list">
-
         {% if cms_apps.products and categories %}
-        <li class="primary-navigation__list-item">
-            {% button text=_('Onderwerpen') type="button" icon="expand_more" icon_position="after" icon_outlined=True transparent=True extra_classes="primary-navigation--toggle" %}
+            {% if request.user.is_authenticated or not config.hide_categories_from_anonymous_users %}
+                <li class="primary-navigation__list-item">
+                    {% button text=_('Onderwerpen') type="button" icon="expand_more" icon_position="after" icon_outlined=True transparent=True extra_classes="primary-navigation--toggle" %}
 
-            {% if categories %}
-                <ul class="primary-navigation__list subpage-list">
-                    {% for category in categories %}
-                        <li class="primary-navigation__list-item">
-                            {% url 'products:category_detail' slug=category.slug as category_href %}
-                            {% link text=category.name href=category_href %}
-                        </li>
-                    {% endfor %}
-                </ul>
+                    <ul class="primary-navigation__list subpage-list">
+                        {% for category in categories %}
+                            <li class="primary-navigation__list-item">
+                                {% url 'products:category_detail' slug=category.slug as category_href %}
+                                {% link text=category.name href=category_href %}
+                            </li>
+                        {% endfor %}
+                    </ul>
+                </li>
             {% endif %}
-        </li>
         {% endif %}
     </ul>
 </nav>
diff --git a/src/open_inwoner/components/templatetags/header_tags.py b/src/open_inwoner/components/templatetags/header_tags.py
@@ -1,7 +1,6 @@
 from django import template
 
 from open_inwoner.configurations.models import SiteConfiguration
-from open_inwoner.questionnaire.models import QuestionnaireStep
 
 register = template.Library()
 
@@ -38,51 +37,6 @@ def header(categories, request, **kwargs):
         + request: Request | the django request object.
         - has_general_faq_questions: boolean | If the FAQ menu item should be shown.
     """
-    return {
-        **kwargs,
-        "categories": categories,
-        "request": request,
-    }
-
-
-@register.inclusion_tag("components/Header/PrimaryNavigation.html")
-def primary_navigation(categories, request, **kwargs):
-    """
-    Displaying the primary navigation
-
-    Usage:
-        {% primary_navigation categories=Category.objects.all request=request %}
-
-    Variables:
-        + categories: Category[] | The categories that should be displayed in the theme dropdown.
-        + request: Request | The django request object.
-        + questionnaire: QuestionnaireStep | The default QuestionnaireStep, if any.
-        - has_general_faq_questions: boolean | If the FAQ menu item should be shown.
-        - show_plans: boolean | If the Plan item should be shown.
-    """
-
-    return {
-        **kwargs,
-        "categories": categories,
-        "request": request,
-    }
-
-
-@register.inclusion_tag("components/Header/NavigationAuthenticated.html")
-def navigation_authenticated(categories, request, **kwargs):
-    """
-    Displaying the desktop navigation when user is authenticated
-
-    Usage:
-        {% navigation_authenticated categories=Category.objects.all request=request %}
-
-    Variables:
-        + categories: Category[] | The categories that should be displayed in the theme dropdown.
-        + request: Request | The django request object.
-        + questionnaire: QuestionnaireStep | The default QuestionnaireStep, if any.
-        - has_general_faq_questions: boolean | If the FAQ menu item should be shown.
-        - show_plans: boolean | If the Plan item should be shown.
-    """
 
     return {
         **kwargs,
diff --git a/src/open_inwoner/components/tests/test_header.py b/src/open_inwoner/components/tests/test_header.py
@@ -0,0 +1,56 @@
+from django.test import TestCase
+
+from pyquery import PyQuery
+
+from open_inwoner.accounts.tests.factories import UserFactory
+from open_inwoner.cms.products.cms_apps import ProductsApphook
+from open_inwoner.cms.tests import cms_tools
+from open_inwoner.cms.tests.cms_tools import create_apphook_page
+from open_inwoner.configurations.models import SiteConfiguration
+from open_inwoner.pdc.tests.factories import CategoryFactory
+
+
+class HeaderTest(TestCase):
+    @classmethod
+    def setUpTestData(cls):
+        cls.user = UserFactory()
+        cls.user.set_password("12345")
+        cls.user.email = "test@email.com"
+        cls.user.save()
+
+        cms_tools.create_homepage()
+
+        # PrimaryNavigation.html requires apphook + categories
+        create_apphook_page(ProductsApphook)
+        cls.published1 = CategoryFactory(
+            path="0001", name="First one", slug="first-one"
+        )
+        cls.published2 = CategoryFactory(
+            path="0002", name="Second one", slug="second-one"
+        )
+
+    def test_categories_hidden_from_anonymous_users(self):
+        config = SiteConfiguration.get_solo()
+        config.hide_categories_for_anonymous_users = True
+        config.save()
+
+        response = self.client.get("/")
+
+        doc = PyQuery(response.content)
+
+        categories = doc.find("[title='Onderwerpen']")
+        self.assertEqual(len(categories), 0)
+
+    def test_categories_not_hidden_from_anonymous_users(self):
+        config = SiteConfiguration.get_solo()
+        config.hide_categories_for_anonymous_users = False
+        config.save()
+
+        response = self.client.get("/")
+
+        doc = PyQuery(response.content)
+
+        categories = doc.find("[title='Onderwerpen']")
+        self.assertEqual(len(categories), 2)
+        self.assertEqual(categories[0].tag, "a")
+        self.assertEqual(categories[1].tag, "button")
diff --git a/src/open_inwoner/configurations/admin.py b/src/open_inwoner/configurations/admin.py
@@ -189,6 +189,10 @@ class SiteConfigurarionAdmin(OrderedInlineModelAdminMixin, SingletonModelAdmin):
                 ),
             },
         ),
+        (
+            _("Display options for anonymous users"),
+            {"fields": ("hide_categories_from_anonymous_users",)},
+        ),
     )
     inlines = [SiteConfigurationPageInline]
     form = SiteConfigurarionAdminForm
diff --git a/src/open_inwoner/configurations/migrations/0047_siteconfiguration_hide_categories_from_anonymous_users.py b/src/open_inwoner/configurations/migrations/0047_siteconfiguration_hide_categories_from_anonymous_users.py
@@ -0,0 +1,22 @@
+# Generated by Django 3.2.15 on 2023-08-15 12:53
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("configurations", "0046_siteconfiguration_cookie_consent"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="siteconfiguration",
+            name="hide_categories_from_anonymous_users",
+            field=models.BooleanField(
+                default=False,
+                help_text="If checked, categories will be hidden for users who are not logged in.",
+                verbose_name="Hide categories for anonymouns users",
+            ),
+        ),
+    ]
diff --git a/src/open_inwoner/configurations/models.py b/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"),
     )
+    hide_categories_from_anonymous_users = models.BooleanField(
+        verbose_name=_("Hide categories from anonymouns users"),
+        default=False,
+        help_text=_(
+            "If checked, categories will be hidden from users who are not logged in."
+        ),
+    )
 
     class Meta:
         verbose_name = _("Site Configuration")
diff --git a/src/open_inwoner/pdc/tests/test_views.py b/src/open_inwoner/pdc/tests/test_views.py
@@ -0,0 +1,93 @@
+from django.test import TestCase, override_settings
+from django.urls import reverse
+
+from open_inwoner.accounts.tests.factories import UserFactory
+from open_inwoner.configurations.models import SiteConfiguration
+
+from .factories import CategoryFactory
+
+
+@override_settings(ROOT_URLCONF="open_inwoner.cms.tests.urls")
+class TestCategoryListView(TestCase):
+    @classmethod
+    def setUpTestData(cls):
+        cls.user = UserFactory()
+        cls.user.set_password("12345")
+        cls.user.email = "test@email.com"
+        cls.user.save()
+
+    def test_access_restricted(self):
+        config = SiteConfiguration.get_solo()
+        config.display_categories_for_anonymous_users = False
+        config.save()
+
+        url = reverse("products:category_list")
+
+        # request with anonymous user
+        response = self.client.get(url)
+
+        self.assertEqual(response.status_code, 302)
+        self.assertEqual(response.url, "/accounts/login/?next=/products/")
+
+        # request with user logged in
+        self.client.login(email=self.user.email, password="12345")
+
+        response = self.client.get(url)
+
+        self.assertEqual(response.status_code, 200)
+
+    def test_access_not_restricted(self):
+        config = SiteConfiguration.get_solo()
+        config.display_categories_for_anonymous_users = True
+        config.save()
+
+        url = reverse("products:category_list")
+
+        # request with anonymous user
+        response = self.client.get(url)
+
+        self.assertEqual(response.status_code, 200)
+
+
+@override_settings(ROOT_URLCONF="open_inwoner.cms.tests.urls")
+class TestCategoryDetailView(TestCase):
+    @classmethod
+    def setUpTestData(cls):
+        cls.user = UserFactory()
+        cls.user.set_password("12345")
+        cls.user.email = "test@email.com"
+        cls.user.save()
+
+        cls.category = CategoryFactory.create(name="test cat")
+
+    def test_access_restricted(self):
+        config = SiteConfiguration.get_solo()
+        config.display_categories_for_anonymous_users = False
+        config.save()
+
+        url = reverse("products:category_detail", kwargs={"slug": self.category.slug})
+
+        # request with anonymous user
+        response = self.client.get(url)
+
+        self.assertEqual(response.status_code, 302)
+        self.assertEqual(response.url, "/accounts/login/?next=/products/test-cat/")
+
+        # request with user logged in
+        self.client.login(email=self.user.email, password="12345")
+
+        response = self.client.get(url)
+
+        self.assertEqual(response.status_code, 200)
+
+    def test_access_not_restricted(self):
+        config = SiteConfiguration.get_solo()
+        config.display_categories_for_anonymous_users = True
+        config.save()
+
+        url = reverse("products:category_detail", kwargs={"slug": self.category.slug})
+
+        # request with anonymous user
+        response = self.client.get(url)
+
+        self.assertEqual(response.status_code, 200)
diff --git a/src/open_inwoner/pdc/views.py b/src/open_inwoner/pdc/views.py
@@ -9,8 +9,8 @@
 
 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 open_inwoner.utils.views import LoginMaybeRequiredMixin
 
 from ..utils.views import CommonPageMixin
 from .choices import YesNo
@@ -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,21 @@ def crumbs(self):
         config = SiteConfiguration.get_solo()
         return [(config.theme_title, reverse("products:category_list"))]
 
+    @property
+    def display_restricted(self):
+        config = SiteConfiguration.get_solo()
+        import pdb
+
+        pdb.set_trace()
+        return config.hide_categories_from_anonymous_users is True
+
 
 class CategoryDetailView(
-    CommonPageMixin, BaseBreadcrumbMixin, CategoryBreadcrumbMixin, DetailView
+    LoginMaybeRequiredMixin,
+    CommonPageMixin,
+    BaseBreadcrumbMixin,
+    CategoryBreadcrumbMixin,
+    DetailView,
 ):
     template_name = "pages/category/detail.html"
     model = Category
@@ -166,6 +180,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.hide_categories_from_anonymous_users is True
+
 
 class ProductDetailView(
     CommonPageMixin, BaseBreadcrumbMixin, CategoryBreadcrumbMixin, DetailView
diff --git a/src/open_inwoner/ssd/tests/test_views.py b/src/open_inwoner/ssd/tests/test_views.py
diff --git a/src/open_inwoner/utils/context_processors.py b/src/open_inwoner/utils/context_processors.py
diff --git a/src/open_inwoner/utils/views.py b/src/open_inwoner/utils/views.py
