apps/projects: add per-project guest users permissions

Author: partizipation

CHANGELOG.md

@@ -7,6 +7,9 @@ This project (not yet) adheres to [Semantic Versioning](https://semver.org/spec/
 
 ### Unreleased
 
+- projects: add per-project `allow_guest_users` setting to control guest user
+  participation (requires `A4_ENABLE_GUEST_USERS` and django-guest-user).
+
 ## meinBerlin-v2606.3
 
 ### Added

adhocracy4/dashboard/forms.py

@@ -1,6 +1,7 @@
 import datetime
 
 from django import forms
+from django.conf import settings
 from django.contrib.auth import get_user_model
 from django.forms import RadioSelect
 from django.forms import inlineformset_factory
@@ -22,6 +23,28 @@
 User = get_user_model()
 
 
+def _coerce_bool_choice(value):
+    if isinstance(value, bool):
+        return value
+    if value in ("True", "true", "1", 1):
+        return True
+    if value in ("False", "false", "0", 0):
+        return False
+    raise ValueError(f"Invalid boolean choice: {value!r}")
+
+
+ALLOW_GUEST_USERS_CHOICES = (
+    (
+        False,
+        _("Only registered users can participate"),
+    ),
+    (
+        True,
+        _("Registered and guest users can participate"),
+    ),
+)
+
+
 class ProjectCreateForm(forms.ModelForm):
     class Meta:
         model = project_models.Project
@@ -71,9 +94,10 @@ class Meta:
             "tile_image_alt_text",
             "tile_image_copyright",
             "is_archived",
+            "allow_guest_users",
             "access",
         ]
-        required_for_project_publish = ["name", "description"]
+        required_for_project_publish = ["name", "description", "allow_guest_users"]
         widgets = {
             "access": RadioSelect(
                 choices=[
@@ -86,6 +110,25 @@ class Meta:
             ),
         }
 
+    @classmethod
+    def get_required_fields(cls):
+        required = super().get_required_fields()
+        if not getattr(settings, "A4_ENABLE_GUEST_USERS", False):
+            return [field for field in required if field != "allow_guest_users"]
+        return required
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        if not getattr(settings, "A4_ENABLE_GUEST_USERS", False):
+            self.fields.pop("allow_guest_users", None)
+        else:
+            self.fields["allow_guest_users"] = forms.TypedChoiceField(
+                label=_("Participants"),
+                choices=ALLOW_GUEST_USERS_CHOICES,
+                coerce=_coerce_bool_choice,
+                widget=RadioSelect(),
+            )
+
 
 class ProjectInformationForm(ProjectDashboardForm):
     contact_heading = _("Contact for questions")

adhocracy4/dashboard/templates/a4dashboard/includes/form_field.html

@@ -1,8 +1,12 @@
 {% extends "a4forms/includes/form_field.html" %}
-{% load i18n %}
+{% load i18n a4dashboard_tags %}
+
+{% block required_indicator %}
+    {% if field.field.required or field.field.required_for_publish %}<span role="presentation" title="{% translate 'This field is required' %}">*</span>{% endif %}
+{% endblock %}
 
 {% block after_label %}
-    {% if field.field.required_for_publish and not field.value %}
+    {% if field.field.required_for_publish and field|publish_value_missing %}
         <i class="fa fa-exclamation-circle u-danger" title="{% translate 'Missing field for publication' %}" aria-label="{% translate 'Missing field for publication' %}"></i>
     {% endif %}
 {% endblock %}

adhocracy4/dashboard/templates/a4dashboard/includes/project_basic_form.html

@@ -8,6 +8,12 @@
 
 {% include 'a4dashboard/includes/form_field.html' with field=form.description %}
 
+{% if form.allow_guest_users %}
+<section class="u-bottom-divider">
+    {% include 'a4dashboard/includes/form_field.html' with field=form.allow_guest_users %}
+</section>
+{% endif %}
+
 {% include 'a4dashboard/includes/form_field.html' with field=form.access %}
 
 {% if project.has_finished %}

adhocracy4/dashboard/templatetags/a4dashboard_tags.py

@@ -5,6 +5,14 @@
 register = template.Library()
 
 
+@register.filter
+def publish_value_missing(bound_field):
+    value = bound_field.value
+    if value is True or value is False:
+        return False
+    return value is None or value == ""
+
+
 @register.simple_tag
 def get_phase_name(type):
     name = phases.content[type].name

adhocracy4/forms/templates/a4forms/includes/form_field.html

@@ -2,7 +2,7 @@
 
 <div class="form-group">
     <label for="{{ field.id_for_label }}">
-        {{ field.label }}{% if field.field.required %}<span role="presentation" title="{% translate 'This field is required' %}">*</span>{% endif %}
+        {{ field.label }}{% block required_indicator %}{% if field.field.required %}<span role="presentation" title="{% translate 'This field is required' %}">*</span>{% endif %}{% endblock %}
         {% block after_label %}
         {% endblock %}
     </label>

adhocracy4/projects/guest_users.py

@@ -0,0 +1,17 @@
+from django.apps import apps
+
+
+def is_guest_user(user) -> bool:
+    """Return whether user is a temporary guest (django-guest-user).
+
+    If django-guest-user is not installed, always returns False.
+    """
+    if not user.is_authenticated:
+        return False
+    if not apps.is_installed("guest_user"):
+        return False
+    try:
+        from guest_user.functions import is_guest_user as _is_guest_user
+    except ImportError:
+        return False
+    return _is_guest_user(user)

adhocracy4/projects/migrations/0054_project_allow_guest_users.py

@@ -0,0 +1,23 @@
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("a4projects", "0053_alter_project_description"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="project",
+            name="allow_guest_users",
+            field=models.BooleanField(
+                default=True,
+                help_text=(
+                    "Whether guest users may participate in this project. "
+                    "Only applies when guest users are enabled for the platform."
+                ),
+                verbose_name="Allow guest users to participate",
+            ),
+        ),
+    ]

adhocracy4/projects/models.py

@@ -21,6 +21,7 @@
 from adhocracy4.models import base
 
 from .enums import Access
+from .guest_users import is_guest_user
 from .utils import get_module_clusters
 from .utils import get_module_clusters_dict
 
@@ -293,6 +294,15 @@ class Project(
 
     is_app_accessible = models.BooleanField(default=False)
 
+    allow_guest_users = models.BooleanField(
+        default=True,
+        verbose_name=_("Allow guest users to participate"),
+        help_text=_(
+            "Whether guest users may participate in this project. "
+            "Only applies when guest users are enabled for the platform."
+        ),
+    )
+
     objects = ProjectManager()
 
     class Meta:
@@ -328,11 +338,14 @@ def has_member(self, user):
         Everybody is member of all public projects and private projects can
         be joined as moderator or participant.
         """
-        return (
+        is_member = (
             (user.is_authenticated and self.is_public)
             or (user in self.participants.all())
             or (user in self.moderators.all())
         )
+        if is_member and is_guest_user(user) and not self.allow_guest_users:
+            return False
+        return is_member
 
     def is_group_member(self, user):
         if self.group:

adhocracy4/projects/predicates.py

@@ -72,3 +72,14 @@ def has_context_started(user, item):
     if item:
         return has_started(user, item.project)
     return False
+
+
+@rules.predicate
+def guest_may_participate(user, project):
+    if not project:
+        return True
+    from .guest_users import is_guest_user
+
+    if not is_guest_user(user):
+        return True
+    return project.allow_guest_users