add display_name field to models and update related forms and templates

This commit is contained in:
Eduardo Silva
2026-03-16 16:33:12 -03:00
parent c912e7bb5f
commit 51a2535e87
9 changed files with 136 additions and 46 deletions

View File

@@ -13,10 +13,9 @@ from app_gateway.models import (
class ApplicationForm(forms.ModelForm): class ApplicationForm(forms.ModelForm):
class Meta: class Meta:
model = Application model = Application
fields = ['name', 'display_name', 'upstream', 'allow_invalid_cert'] fields = ['display_name', 'upstream', 'allow_invalid_cert']
labels = { labels = {
'name': _('Name'), 'display_name': _('Name'),
'display_name': _('Display Name'),
'upstream': _('Upstream'), 'upstream': _('Upstream'),
'allow_invalid_cert': _('Allow invalid/self-signed certificate'), 'allow_invalid_cert': _('Allow invalid/self-signed certificate'),
} }
@@ -24,12 +23,12 @@ class ApplicationForm(forms.ModelForm):
def __init__(self, *args, **kwargs): def __init__(self, *args, **kwargs):
cancel_url = kwargs.pop('cancel_url', '#') cancel_url = kwargs.pop('cancel_url', '#')
super().__init__(*args, **kwargs) super().__init__(*args, **kwargs)
self.fields['display_name'].required = True
self.helper = FormHelper() self.helper = FormHelper()
self.helper.layout = Layout( self.helper.layout = Layout(
Div( Div(
Div('name', css_class='col-md-6'), Div('display_name', css_class='col-md-12'),
Div('display_name', css_class='col-md-6'),
css_class='row' css_class='row'
), ),
Div( Div(
@@ -49,12 +48,8 @@ class ApplicationForm(forms.ModelForm):
def clean(self): def clean(self):
cleaned_data = super().clean() cleaned_data = super().clean()
name = cleaned_data.get("name")
upstream = (cleaned_data.get("upstream") or "").strip() upstream = (cleaned_data.get("upstream") or "").strip()
if name == "wireguard_webadmin":
self.add_error("name", _("This is a reserved system name."))
if upstream: if upstream:
if "wireguard-webadmin:8000" in upstream: if "wireguard-webadmin:8000" in upstream:
self.add_error("upstream", _("This upstream is reserved by the system.")) self.add_error("upstream", _("This upstream is reserved by the system."))
@@ -103,9 +98,9 @@ class ApplicationHostForm(forms.ModelForm):
class AccessPolicyForm(forms.ModelForm): class AccessPolicyForm(forms.ModelForm):
class Meta: class Meta:
model = AccessPolicy model = AccessPolicy
fields = ['name', 'policy_type', 'groups', 'methods'] fields = ['display_name', 'policy_type', 'groups', 'methods']
labels = { labels = {
'name': _('Name'), 'display_name': _('Name'),
'policy_type': _('Policy Type'), 'policy_type': _('Policy Type'),
'groups': _('Allowed Groups'), 'groups': _('Allowed Groups'),
'methods': _('Authentication Methods'), 'methods': _('Authentication Methods'),
@@ -115,6 +110,7 @@ class AccessPolicyForm(forms.ModelForm):
cancel_url = kwargs.pop('cancel_url', '#') cancel_url = kwargs.pop('cancel_url', '#')
policy_type = kwargs.pop('policy_type', None) policy_type = kwargs.pop('policy_type', None)
super().__init__(*args, **kwargs) super().__init__(*args, **kwargs)
self.fields['display_name'].required = True
if self.instance and self.instance.pk: if self.instance and self.instance.pk:
policy_type = self.instance.policy_type policy_type = self.instance.policy_type
@@ -129,7 +125,7 @@ class AccessPolicyForm(forms.ModelForm):
if policy_type in ['public', 'deny']: if policy_type in ['public', 'deny']:
self.helper.layout = Layout( self.helper.layout = Layout(
Div( Div(
Div('name', css_class='col-md-12'), Div('display_name', css_class='col-md-12'),
'policy_type', 'policy_type',
css_class='row' css_class='row'
), ),
@@ -145,7 +141,7 @@ class AccessPolicyForm(forms.ModelForm):
else: else:
self.helper.layout = Layout( self.helper.layout = Layout(
Div( Div(
Div('name', css_class='col-md-12'), Div('display_name', css_class='col-md-12'),
'policy_type', 'policy_type',
css_class='row' css_class='row'
), ),
@@ -244,9 +240,9 @@ class ApplicationPolicyForm(forms.ModelForm):
class ApplicationRouteForm(forms.ModelForm): class ApplicationRouteForm(forms.ModelForm):
class Meta: class Meta:
model = ApplicationRoute model = ApplicationRoute
fields = ['name', 'path_prefix', 'policy', 'order'] fields = ['display_name', 'path_prefix', 'policy', 'order']
labels = { labels = {
'name': _('Route Name'), 'display_name': _('Route Name'),
'path_prefix': _('Path Prefix'), 'path_prefix': _('Path Prefix'),
'policy': _('Policy'), 'policy': _('Policy'),
'order': _('Order'), 'order': _('Order'),
@@ -255,11 +251,12 @@ class ApplicationRouteForm(forms.ModelForm):
def __init__(self, *args, **kwargs): def __init__(self, *args, **kwargs):
cancel_url = kwargs.pop('cancel_url', '#') cancel_url = kwargs.pop('cancel_url', '#')
super().__init__(*args, **kwargs) super().__init__(*args, **kwargs)
self.fields['display_name'].required = True
self.helper = FormHelper() self.helper = FormHelper()
self.helper.layout = Layout( self.helper.layout = Layout(
Div( Div(
Div('name', css_class='col-md-12'), Div('display_name', css_class='col-md-12'),
css_class='row' css_class='row'
), ),
Div( Div(

View File

@@ -0,0 +1,26 @@
from django.db import migrations, models
class Migration(migrations.Migration):
dependencies = [
('app_gateway', '0007_application_allow_invalid_cert'),
]
operations = [
migrations.AddField(
model_name='accesspolicy',
name='display_name',
field=models.CharField(blank=True, max_length=128),
),
migrations.AddField(
model_name='applicationroute',
name='display_name',
field=models.CharField(blank=True, max_length=128),
),
migrations.AlterField(
model_name='applicationroute',
name='name',
field=models.SlugField(max_length=64),
),
]

View File

@@ -3,7 +3,7 @@ import uuid
from django.db import models from django.db import models
from django.utils.translation import gettext_lazy as _ from django.utils.translation import gettext_lazy as _
from gatekeeper.models import GatekeeperGroup, AuthMethod from gatekeeper.models import GatekeeperGroup, AuthMethod, _unique_slug
class Application(models.Model): class Application(models.Model):
@@ -16,11 +16,13 @@ class Application(models.Model):
updated = models.DateTimeField(auto_now=True) updated = models.DateTimeField(auto_now=True)
uuid = models.UUIDField(unique=True, default=uuid.uuid4, editable=False) uuid = models.UUIDField(unique=True, default=uuid.uuid4, editable=False)
def __str__(self): def save(self, *args, **kwargs):
if self.display_name: if self.display_name:
return f"{self.display_name} ({self.name})" self.name = _unique_slug(Application, self.display_name, exclude_pk=self.pk)
else: super().save(*args, **kwargs)
return self.name
def __str__(self):
return self.display_name or self.name
class Meta: class Meta:
ordering = ['name'] ordering = ['name']
@@ -43,6 +45,7 @@ class ApplicationHost(models.Model):
class AccessPolicy(models.Model): class AccessPolicy(models.Model):
name = models.SlugField(max_length=64, unique=True) name = models.SlugField(max_length=64, unique=True)
display_name = models.CharField(max_length=128, blank=True)
policy_type = models.CharField(max_length=32, choices=(('public', _('Public')), ('protected', _('Protected')), ('deny', _('Deny')))) policy_type = models.CharField(max_length=32, choices=(('public', _('Public')), ('protected', _('Protected')), ('deny', _('Deny'))))
groups = models.ManyToManyField(GatekeeperGroup, blank=True, related_name='policies') groups = models.ManyToManyField(GatekeeperGroup, blank=True, related_name='policies')
methods = models.ManyToManyField(AuthMethod, blank=True, related_name='policies') methods = models.ManyToManyField(AuthMethod, blank=True, related_name='policies')
@@ -51,8 +54,13 @@ class AccessPolicy(models.Model):
updated = models.DateTimeField(auto_now=True) updated = models.DateTimeField(auto_now=True)
uuid = models.UUIDField(unique=True, default=uuid.uuid4, editable=False) uuid = models.UUIDField(unique=True, default=uuid.uuid4, editable=False)
def save(self, *args, **kwargs):
if self.display_name:
self.name = _unique_slug(AccessPolicy, self.display_name, exclude_pk=self.pk)
super().save(*args, **kwargs)
def __str__(self): def __str__(self):
return f"{self.name} ({self.get_policy_type_display()})" return f"{self.display_name or self.name} ({self.get_policy_type_display()})"
class Meta: class Meta:
ordering = ['name'] ordering = ['name']
@@ -78,7 +86,8 @@ class ApplicationPolicy(models.Model):
class ApplicationRoute(models.Model): class ApplicationRoute(models.Model):
application = models.ForeignKey(Application, on_delete=models.CASCADE, related_name='routes') application = models.ForeignKey(Application, on_delete=models.CASCADE, related_name='routes')
name = models.SlugField(max_length=64, help_text=_("Route identifier, used in export (e.g.: public_area)")) name = models.SlugField(max_length=64)
display_name = models.CharField(max_length=128, blank=True)
path_prefix = models.CharField(max_length=255) path_prefix = models.CharField(max_length=255)
policy = models.ForeignKey(AccessPolicy, on_delete=models.PROTECT, related_name='routes') policy = models.ForeignKey(AccessPolicy, on_delete=models.PROTECT, related_name='routes')
order = models.PositiveIntegerField(default=0) order = models.PositiveIntegerField(default=0)
@@ -87,8 +96,16 @@ class ApplicationRoute(models.Model):
updated = models.DateTimeField(auto_now=True) updated = models.DateTimeField(auto_now=True)
uuid = models.UUIDField(unique=True, default=uuid.uuid4, editable=False) uuid = models.UUIDField(unique=True, default=uuid.uuid4, editable=False)
def save(self, *args, **kwargs):
if self.display_name:
self.name = _unique_slug(
ApplicationRoute, self.display_name, exclude_pk=self.pk,
filter_kwargs={'application': self.application},
)
super().save(*args, **kwargs)
def __str__(self): def __str__(self):
return f"{self.application} {self.path_prefix} {self.policy}" return f"{self.application} {self.display_name or self.name} ({self.path_prefix})"
class Meta: class Meta:
ordering = ['application', 'order', 'path_prefix'] ordering = ['application', 'order', 'path_prefix']

View File

@@ -125,20 +125,21 @@ class GatekeeperUserForm(forms.ModelForm):
class GatekeeperGroupForm(forms.ModelForm): class GatekeeperGroupForm(forms.ModelForm):
class Meta: class Meta:
model = GatekeeperGroup model = GatekeeperGroup
fields = ['name', 'users'] fields = ['display_name', 'users']
labels = { labels = {
'name': _('Group Name'), 'display_name': _('Group Name'),
'users': _('Members'), 'users': _('Members'),
} }
def __init__(self, *args, **kwargs): def __init__(self, *args, **kwargs):
cancel_url = kwargs.pop('cancel_url', '#') cancel_url = kwargs.pop('cancel_url', '#')
super().__init__(*args, **kwargs) super().__init__(*args, **kwargs)
self.fields['display_name'].required = True
self.helper = FormHelper() self.helper = FormHelper()
self.helper.layout = Layout( self.helper.layout = Layout(
Div( Div(
Div('name', css_class='col-xl-12'), Div('display_name', css_class='col-xl-12'),
css_class='row' css_class='row'
), ),
Div( Div(
@@ -179,11 +180,11 @@ class AuthMethodForm(forms.ModelForm):
class Meta: class Meta:
model = AuthMethod model = AuthMethod
fields = [ fields = [
'name', 'auth_type', 'totp_secret', 'display_name', 'auth_type', 'totp_secret',
'oidc_provider', 'oidc_client_id', 'oidc_client_secret' 'oidc_provider', 'oidc_client_id', 'oidc_client_secret'
] ]
labels = { labels = {
'name': _('Name'), 'display_name': _('Name'),
'auth_type': _('Authentication Type'), 'auth_type': _('Authentication Type'),
'totp_secret': _('Global TOTP Secret'), 'totp_secret': _('Global TOTP Secret'),
'oidc_provider': _('OIDC Provider URL'), 'oidc_provider': _('OIDC Provider URL'),
@@ -195,6 +196,7 @@ class AuthMethodForm(forms.ModelForm):
cancel_url = kwargs.pop('cancel_url', '#') cancel_url = kwargs.pop('cancel_url', '#')
super().__init__(*args, **kwargs) super().__init__(*args, **kwargs)
self.fields['display_name'].required = True
if self.instance and self.instance.pk: if self.instance and self.instance.pk:
self.fields['auth_type'].disabled = True self.fields['auth_type'].disabled = True
exp_min = self.instance.session_expiration_minutes exp_min = self.instance.session_expiration_minutes
@@ -208,7 +210,7 @@ class AuthMethodForm(forms.ModelForm):
self.helper = FormHelper() self.helper = FormHelper()
self.helper.layout = Layout( self.helper.layout = Layout(
Div( Div(
Div('name', css_class='col-xl-6'), Div('display_name', css_class='col-xl-6'),
Div('auth_type', css_class='col-xl-6'), Div('auth_type', css_class='col-xl-6'),
css_class='row auth-type-group' css_class='row auth-type-group'
), ),

View File

@@ -0,0 +1,21 @@
from django.db import migrations, models
class Migration(migrations.Migration):
dependencies = [
('gatekeeper', '0010_alter_gatekeeperuser_email'),
]
operations = [
migrations.AddField(
model_name='authmethod',
name='display_name',
field=models.CharField(blank=True, max_length=128),
),
migrations.AddField(
model_name='gatekeepergroup',
name='display_name',
field=models.CharField(blank=True, max_length=128),
),
]

View File

@@ -1,11 +1,28 @@
import uuid import uuid
from django.db import models from django.db import models
from django.utils.text import slugify
from django.utils.translation import gettext_lazy as _ from django.utils.translation import gettext_lazy as _
def _unique_slug(model_class, display_name, exclude_pk=None, slug_field='name', filter_kwargs=None):
base = slugify(display_name) or 'item'
slug = base
counter = 1
qs = model_class.objects.all()
if exclude_pk:
qs = qs.exclude(pk=exclude_pk)
if filter_kwargs:
qs = qs.filter(**filter_kwargs)
while qs.filter(**{slug_field: slug}).exists():
slug = f"{base}-{counter}"
counter += 1
return slug
class AuthMethod(models.Model): class AuthMethod(models.Model):
name = models.SlugField(max_length=64, unique=True) name = models.SlugField(max_length=64, unique=True)
display_name = models.CharField(max_length=128, blank=True)
auth_type = models.CharField(max_length=32, choices=( auth_type = models.CharField(max_length=32, choices=(
('local_password', _('Local Password')), ('local_password', _('Local Password')),
('totp', _('One-Time Password (TOTP)')), ('totp', _('One-Time Password (TOTP)')),
@@ -31,8 +48,13 @@ class AuthMethod(models.Model):
updated = models.DateTimeField(auto_now=True) updated = models.DateTimeField(auto_now=True)
uuid = models.UUIDField(unique=True, default=uuid.uuid4, editable=False) uuid = models.UUIDField(unique=True, default=uuid.uuid4, editable=False)
def save(self, *args, **kwargs):
if self.display_name:
self.name = _unique_slug(AuthMethod, self.display_name, exclude_pk=self.pk)
super().save(*args, **kwargs)
def __str__(self): def __str__(self):
return f"{self.name} ({self.get_auth_type_display()})" return f"{self.display_name or self.name} ({self.get_auth_type_display()})"
class Meta: class Meta:
ordering = ['name'] ordering = ['name']
@@ -89,14 +111,20 @@ class GatekeeperUser(models.Model):
class GatekeeperGroup(models.Model): class GatekeeperGroup(models.Model):
name = models.SlugField(max_length=64, unique=True) name = models.SlugField(max_length=64, unique=True)
display_name = models.CharField(max_length=128, blank=True)
users = models.ManyToManyField(GatekeeperUser, blank=True, related_name='groups') users = models.ManyToManyField(GatekeeperUser, blank=True, related_name='groups')
created = models.DateTimeField(auto_now_add=True) created = models.DateTimeField(auto_now_add=True)
updated = models.DateTimeField(auto_now=True) updated = models.DateTimeField(auto_now=True)
uuid = models.UUIDField(unique=True, default=uuid.uuid4, editable=False) uuid = models.UUIDField(unique=True, default=uuid.uuid4, editable=False)
def save(self, *args, **kwargs):
if self.display_name:
self.name = _unique_slug(GatekeeperGroup, self.display_name, exclude_pk=self.pk)
super().save(*args, **kwargs)
def __str__(self): def __str__(self):
return self.name return self.display_name or self.name
class Meta: class Meta:
ordering = ['name'] ordering = ['name']

View File

@@ -75,7 +75,7 @@
<td>{{ app.routes.count }}</td> <td>{{ app.routes.count }}</td>
<td> <td>
{% if app.default_policy_config %} {% if app.default_policy_config %}
{{ app.default_policy_config.default_policy.name }} {{ app.default_policy_config.default_policy }}
{% else %} {% else %}
{% trans 'Default (Deny)' %} {% trans 'Default (Deny)' %}
{% endif %} {% endif %}
@@ -145,7 +145,7 @@
<tbody> <tbody>
{% for policy in access_policies %} {% for policy in access_policies %}
<tr> <tr>
<td>{{ policy.name }}</td> <td>{{ policy }}</td>
<td>{{ policy.get_policy_type_display }}</td> <td>{{ policy.get_policy_type_display }}</td>
<td>{{ policy.groups.count }}</td> <td>{{ policy.groups.count }}</td>
<td>{{ policy.methods.count }}</td> <td>{{ policy.methods.count }}</td>

View File

@@ -23,14 +23,13 @@
<div class="row mb-4"> <div class="row mb-4">
<div class="col-md-6"> <div class="col-md-6">
<strong>{% trans 'Name' %}:</strong> {{ application.name }}<br> <strong>{% trans 'Name' %}:</strong> {{ application }}<br>
<strong>{% trans 'Display Name' %}:</strong> {{ application.display_name }}<br>
<strong>{% trans 'Upstream' %}:</strong> <code>{{ application.upstream }}</code><br> <strong>{% trans 'Upstream' %}:</strong> <code>{{ application.upstream }}</code><br>
</div> </div>
<div class="col-md-6"> <div class="col-md-6">
<strong>{% trans 'Default Policy' %}:</strong> <strong>{% trans 'Default Policy' %}:</strong>
{% if application.default_policy_config %} {% if application.default_policy_config %}
<span>{{ application.default_policy_config.default_policy.name }}</span> <span>{{ application.default_policy_config.default_policy }}</span>
<a href="{% url 'manage_application_policy' %}?uuid={{ application.default_policy_config.uuid }}" <a href="{% url 'manage_application_policy' %}?uuid={{ application.default_policy_config.uuid }}"
class="btn btn-sm btn-outline-secondary btn-xs"><i class="fas fa-edit"></i></a> class="btn btn-sm btn-outline-secondary btn-xs"><i class="fas fa-edit"></i></a>
<a href="{% url 'delete_application_policy' %}?uuid={{ application.default_policy_config.uuid }}" <a href="{% url 'delete_application_policy' %}?uuid={{ application.default_policy_config.uuid }}"
@@ -112,9 +111,9 @@
<tbody> <tbody>
{% for route in routes %} {% for route in routes %}
<tr> <tr>
<td>{{ route.name }}</td> <td>{{ route }}</td>
<td><code>{{ route.path_prefix }}</code></td> <td><code>{{ route.path_prefix }}</code></td>
<td>{{ route.policy.name }}</td> <td>{{ route.policy }}</td>
<td>{{ route.order }}</td> <td>{{ route.order }}</td>
<td style="width: 15%"> <td style="width: 15%">
<a href="{% url 'manage_application_route' %}?uuid={{ route.uuid }}" <a href="{% url 'manage_application_route' %}?uuid={{ route.uuid }}"

View File

@@ -79,7 +79,7 @@
</td> </td>
<td> <td>
{% for group in user.groups.all %} {% for group in user.groups.all %}
<span class="badge badge-info">{{ group.name }}</span> <span class="badge badge-info">{{ group }}</span>
{% empty %} {% empty %}
<span class="text-muted"></span> <span class="text-muted"></span>
{% endfor %} {% endfor %}
@@ -125,7 +125,7 @@
<tbody> <tbody>
{% for group in groups %} {% for group in groups %}
<tr> <tr>
<td>{{ group.name }}</td> <td>{{ group }}</td>
<td>{{ group.users.count }}</td> <td>{{ group.users.count }}</td>
<td style="width: 15%"> <td style="width: 15%">
<a href="{% url 'manage_gatekeeper_group' %}?uuid={{ group.uuid }}" <a href="{% url 'manage_gatekeeper_group' %}?uuid={{ group.uuid }}"
@@ -170,7 +170,7 @@
<tbody> <tbody>
{% for method in auth_methods %} {% for method in auth_methods %}
<tr> <tr>
<td>{{ method.name }}</td> <td>{{ method }}</td>
<td>{{ method.get_auth_type_display }}</td> <td>{{ method.get_auth_type_display }}</td>
<td style="width: 15%"> <td style="width: 15%">
<a href="{% url 'manage_gatekeeper_auth_method' %}?uuid={{ method.uuid }}" <a href="{% url 'manage_gatekeeper_auth_method' %}?uuid={{ method.uuid }}"
@@ -219,7 +219,7 @@
<tr> <tr>
<td><span class="badge badge-info">{% trans 'Email' %}</span></td> <td><span class="badge badge-info">{% trans 'Email' %}</span></td>
<td>{{ email.email }}</td> <td>{{ email.email }}</td>
<td>{{ email.auth_method.name }}</td> <td>{{ email.auth_method }}</td>
<td style="width: 15%"> <td style="width: 15%">
<a href="{% url 'manage_gatekeeper_email' %}?uuid={{ email.uuid }}" <a href="{% url 'manage_gatekeeper_email' %}?uuid={{ email.uuid }}"
class="btn btn-sm btn-info" title="{% trans 'Edit' %}"> class="btn btn-sm btn-info" title="{% trans 'Edit' %}">
@@ -236,7 +236,7 @@
<tr> <tr>
<td><span class="badge badge-secondary">{% trans 'Domain' %}</span></td> <td><span class="badge badge-secondary">{% trans 'Domain' %}</span></td>
<td>{{ domain.domain }}</td> <td>{{ domain.domain }}</td>
<td>{{ domain.auth_method.name }}</td> <td>{{ domain.auth_method }}</td>
<td style="width: 15%"> <td style="width: 15%">
<a href="{% url 'manage_gatekeeper_domain' %}?uuid={{ domain.uuid }}" <a href="{% url 'manage_gatekeeper_domain' %}?uuid={{ domain.uuid }}"
class="btn btn-sm btn-info" title="{% trans 'Edit' %}"> class="btn btn-sm btn-info" title="{% trans 'Edit' %}">
@@ -288,7 +288,7 @@
<span class="badge badge-danger">{% trans 'Deny' %}</span> <span class="badge badge-danger">{% trans 'Deny' %}</span>
{% endif %} {% endif %}
</td> </td>
<td>{{ ip.auth_method.name }}</td> <td>{{ ip.auth_method }}</td>
<td style="width: 15%"> <td style="width: 15%">
<a href="{% url 'manage_gatekeeper_ip' %}?uuid={{ ip.uuid }}" <a href="{% url 'manage_gatekeeper_ip' %}?uuid={{ ip.uuid }}"
class="btn btn-sm btn-info" title="{% trans 'Edit' %}"> class="btn btn-sm btn-info" title="{% trans 'Edit' %}">