From 1b52acdb56346d939eb2e26ff449697b52fa7142 Mon Sep 17 00:00:00 2001 From: Andrew Godwin Date: Wed, 16 Nov 2022 21:12:28 -0700 Subject: [PATCH] Domains management pages --- README.md | 6 +- activities/views/posts.py | 1 + core/signatures.py | 2 +- static/css/style.css | 9 +- takahe/urls.py | 7 + templates/base.html | 12 +- templates/forms/_field.html | 2 +- templates/settings/_settings_system_menu.html | 4 +- .../settings_system_domain_create.html | 39 +++++ .../settings_system_domain_delete.html | 33 ++++ .../settings/settings_system_domain_edit.html | 19 +++ .../settings/settings_system_domains.html | 28 ++++ users/models/domain.py | 7 + users/models/identity.py | 1 + users/views/settings_identity.py | 2 + users/views/settings_system.py | 148 +++++++++++++++++- 16 files changed, 308 insertions(+), 12 deletions(-) create mode 100644 templates/settings/settings_system_domain_create.html create mode 100644 templates/settings/settings_system_domain_delete.html create mode 100644 templates/settings/settings_system_domain_edit.html create mode 100644 templates/settings/settings_system_domains.html diff --git a/README.md b/README.md index db94116..5ee9c32 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,6 @@ the less sure I am about it. - [ ] Receive post edits - [x] Set content warnings on posts - [x] Show content warnings on posts -- [ ] Attach images to posts - [ ] Receive images on posts - [x] Create boosts - [x] Receive boosts @@ -65,8 +64,8 @@ the less sure I am about it. - [x] Multiple domain support - [x] Multiple identity support - [x] Serverless-friendly worker subsystem -- [ ] Settings subsystem -- [ ] Server management page +- [x] Settings subsystem +- [x] Server management page - [ ] Domain management page - [ ] Email subsystem - [ ] Signup flow @@ -75,6 +74,7 @@ the less sure I am about it. ### Beta +- [ ] Attach images to posts - [ ] Delete posts - [ ] Reply threading on post creation - [ ] Display posts with reply threads diff --git a/activities/views/posts.py b/activities/views/posts.py index 3ee35cc..d0ad813 100644 --- a/activities/views/posts.py +++ b/activities/views/posts.py @@ -108,6 +108,7 @@ class Boost(View): class Compose(FormView): template_name = "activities/compose.html" + extra_context = {"top_section": "compose"} class form_class(forms.Form): text = forms.CharField( diff --git a/core/signatures.py b/core/signatures.py index 8b52c1a..d981f87 100644 --- a/core/signatures.py +++ b/core/signatures.py @@ -59,7 +59,7 @@ class HttpSignature: elif header_name == "content-type": value = request.META["CONTENT_TYPE"] else: - value = request.META[f"HTTP_{header_name.upper()}"] + value = request.META["HTTP_%s" % header_name.upper().replace("-", "_")] headers[header_name] = value return "\n".join(f"{name.lower()}: {value}" for name, value in headers.items()) diff --git a/static/css/style.css b/static/css/style.css index 01f9076..9c45eb3 100644 --- a/static/css/style.css +++ b/static/css/style.css @@ -81,6 +81,7 @@ a { --color-bg-box: #1a2631; --color-bg-error: rgb(87, 32, 32); --color-highlight: #449c8c; + --color-delete: #8b2821; --color-text-duller: #5f6983; --color-text-dull: #99a; @@ -148,7 +149,8 @@ header menu a { border-right: 1px solid var(--color-bg-menu); } -header menu a:hover { +header menu a:hover, +header menu a.selected { border-bottom: 3px solid var(--color-highlight); } @@ -438,6 +440,11 @@ form .button { display: inline-block; } +form button.delete, +form .button.delete { + background: var(--color-delete); +} + form button.toggle, form .button.toggle { background: var(--color-bg-main); diff --git a/takahe/urls.py b/takahe/urls.py index bdb5946..0643440 100644 --- a/takahe/urls.py +++ b/takahe/urls.py @@ -17,6 +17,13 @@ urlpatterns = [ path("settings/interface/", settings_identity.InterfacePage.as_view()), path("settings/system/", settings_system.SystemSettingsRoot.as_view()), path("settings/system/basic/", settings_system.BasicPage.as_view()), + path("settings/system/domains/", settings_system.DomainsPage.as_view()), + path("settings/system/domains/create/", settings_system.DomainCreatePage.as_view()), + path("settings/system/domains//", settings_system.DomainEditPage.as_view()), + path( + "settings/system/domains//delete/", + settings_system.DomainDeletePage.as_view(), + ), # Identity views path("@/", identity.ViewIdentity.as_view()), path("@/actor/", activitypub.Actor.as_view()), diff --git a/templates/base.html b/templates/base.html index e392cb9..402dcd3 100644 --- a/templates/base.html +++ b/templates/base.html @@ -28,10 +28,16 @@ {% if user.is_authenticated %} - Compose - Settings + + Compose + + + Settings + {% if request.user.admin %} - Admin + + Admin + {% endif %}
diff --git a/templates/forms/_field.html b/templates/forms/_field.html index 120724e..740432d 100644 --- a/templates/forms/_field.html +++ b/templates/forms/_field.html @@ -5,7 +5,7 @@ {% if field.help_text %}

- {{ field.help_text }} + {{ field.help_text|linebreaksbr }}

{% endif %} {{ field.errors }} diff --git a/templates/settings/_settings_system_menu.html b/templates/settings/_settings_system_menu.html index fb4da02..9206045 100644 --- a/templates/settings/_settings_system_menu.html +++ b/templates/settings/_settings_system_menu.html @@ -1,3 +1,5 @@ diff --git a/templates/settings/settings_system_domain_create.html b/templates/settings/settings_system_domain_create.html new file mode 100644 index 0000000..54d3640 --- /dev/null +++ b/templates/settings/settings_system_domain_create.html @@ -0,0 +1,39 @@ +{% extends "base.html" %} + +{% block title %}Add Domain - System Settings{% endblock %} + +{% block content %} + {% block menu %} + {% include "settings/_settings_system_menu.html" %} + {% endblock %} +
+

Add A Domain

+

+ Use this form to add a domain that your users can create identities + on. +

+

+ Takahē supports multiple domains per server, but note that when + identities are created they are fixed to their chosen domain, + and you will not be able to delete a domain with identities on it. +

+

+ If you will be serving Takahē on the domain you choose, you can leave + the "service domain" field blank. If you would like to let users create + accounts on a domain serving something else, you must pick a unique + "service domain" that pairs up to your chosen domain name, make sure + Takahē is served on that, and add redirects + for /.well-known/webfinger, /.well-known/host-meta + and /.well-known/nodeinfo from the main domain to the + service domain. +

+ {% csrf_token %} + {% for field in form %} + {% include "forms/_field.html" %} + {% endfor %} +
+ Delete + +
+
+{% endblock %} diff --git a/templates/settings/settings_system_domain_delete.html b/templates/settings/settings_system_domain_delete.html new file mode 100644 index 0000000..220bbb9 --- /dev/null +++ b/templates/settings/settings_system_domain_delete.html @@ -0,0 +1,33 @@ +{% extends "base.html" %} + +{% block title %}Delete {{ domain.domain }} - System Settings{% endblock %} + +{% block content %} + {% block menu %} + {% include "settings/_settings_system_menu.html" %} + {% endblock %} + +
+ {% csrf_token %} + +

Deleting {{ domain.domain }}

+ + {% if num_identities %} +

+ You cannot delete this domain as it has {{ num_identities }} + identit{{ num_identities|pluralize:"y,ies" }} registered on it. +

+

+ You will need to manually remove all identities from this domain in + order to delete it. +

+ {% else %} +

Please confirm deletion of this domain - there are no identities registed on it.

+
+ Cancel + +
+ {% endif %} +
+ +{% endblock %} diff --git a/templates/settings/settings_system_domain_edit.html b/templates/settings/settings_system_domain_edit.html new file mode 100644 index 0000000..c05d5d5 --- /dev/null +++ b/templates/settings/settings_system_domain_edit.html @@ -0,0 +1,19 @@ +{% extends "base.html" %} + +{% block title %}{{ domain.domain }} - System Settings{% endblock %} + +{% block content %} + {% block menu %} + {% include "settings/_settings_system_menu.html" %} + {% endblock %} +
+ {% csrf_token %} + {% for field in form %} + {% include "forms/_field.html" %} + {% endfor %} +
+ Delete + +
+
+{% endblock %} diff --git a/templates/settings/settings_system_domains.html b/templates/settings/settings_system_domains.html new file mode 100644 index 0000000..dccde65 --- /dev/null +++ b/templates/settings/settings_system_domains.html @@ -0,0 +1,28 @@ +{% extends "base.html" %} + +{% block title %}{{ section.title }} - System Settings{% endblock %} + +{% block content %} + {% block menu %} + {% include "settings/_settings_system_menu.html" %} + {% endblock %} +
+ {% for domain in domains %} + + + + {{ domain.domain }} + + {% if domain.public %}Public{% else %}Private{% endif %} + {% if domain.service_domain %}({{ domain.service_domain }}){% endif %} + + + + {% empty %} +

You have no domains set up.

+ {% endfor %} + + Add a domain + +
+{% endblock %} diff --git a/users/models/domain.py b/users/models/domain.py index d2b17e2..af0bbab 100644 --- a/users/models/domain.py +++ b/users/models/domain.py @@ -1,5 +1,6 @@ from typing import Optional +import urlman from django.db import models @@ -47,6 +48,12 @@ class Domain(models.Model): created = models.DateTimeField(auto_now_add=True) updated = models.DateTimeField(auto_now=True) + class urls(urlman.Urls): + root = "/settings/system/domains/" + create = "/settings/system/domains/create/" + edit = "/settings/system/domains/{self.domain}/" + delete = "/settings/system/domains/{self.domain}/delete/" + @classmethod def get_remote_domain(cls, domain: str) -> "Domain": return cls.objects.get_or_create(domain=domain, local=False)[0] diff --git a/users/models/identity.py b/users/models/identity.py index 15caef4..d97f5f0 100644 --- a/users/models/identity.py +++ b/users/models/identity.py @@ -67,6 +67,7 @@ class Identity(StatorModel): blank=True, null=True, on_delete=models.PROTECT, + related_name="identities", ) name = models.CharField(max_length=500, blank=True, null=True) diff --git a/users/views/settings_identity.py b/users/views/settings_identity.py index 8c52f9e..f35928a 100644 --- a/users/views/settings_identity.py +++ b/users/views/settings_identity.py @@ -17,6 +17,8 @@ class IdentitySettingsPage(SystemSettingsPage): at the bottom of the page. Don't add this to a URL directly - subclass! """ + extra_context = {"top_section": "settings"} + options_class = Config.IdentityOptions template_name = "settings/settings_identity.html" diff --git a/users/views/settings_system.py b/users/views/settings_system.py index 52ba349..bfd9fb7 100644 --- a/users/views/settings_system.py +++ b/users/views/settings_system.py @@ -1,13 +1,16 @@ +import re from functools import partial from typing import ClassVar, Dict from django import forms -from django.shortcuts import redirect +from django.db import models +from django.shortcuts import get_object_or_404, redirect from django.utils.decorators import method_decorator -from django.views.generic import FormView, RedirectView +from django.views.generic import FormView, RedirectView, TemplateView from core.models import Config from users.decorators import identity_required +from users.models import Domain @method_decorator(identity_required, name="dispatch") @@ -27,6 +30,8 @@ class SystemSettingsPage(FormView): section: ClassVar[str] options: Dict[str, Dict[str, str]] + extra_context = {"top_section": "settings_system"} + def get_form_class(self): # Create the fields dict from the config object fields = {} @@ -93,3 +98,142 @@ class BasicPage(SystemSettingsPage): "help_text": "Used for logo background and other highlights", }, } + + +class DomainsPage(TemplateView): + + template_name = "settings/settings_system_domains.html" + + def get_context_data(self): + return { + "domains": Domain.objects.filter(local=True).order_by("domain"), + "section": "domains", + } + + +class DomainCreatePage(FormView): + + template_name = "settings/settings_system_domain_create.html" + extra_context = {"section": "domains"} + + class form_class(forms.Form): + domain = forms.CharField( + help_text="The domain displayed as part of a user's identity.\nCannot be changed after the domain has been created.", + ) + service_domain = forms.CharField( + help_text="Optional - a domain that serves Takahē if it is not running on the main domain.\nCannot be changed after the domain has been created.", + required=False, + ) + public = forms.BooleanField( + help_text="If any user on this server can create identities here", + widget=forms.Select(choices=[(True, "Public"), (False, "Private")]), + required=False, + ) + + domain_regex = re.compile( + r"^((?!-))(xn--)?[a-z0-9][a-z0-9-_]{0,61}[a-z0-9]{0,1}\.(xn--)?([a-z0-9\-]{1,61}|[a-z0-9-]{1,30}\.[a-z]{2,})$" + ) + + def clean_domain(self): + if not self.domain_regex.match(self.cleaned_data["domain"]): + raise forms.ValidationError("This does not look like a domain name") + if Domain.objects.filter( + models.Q(domain=self.cleaned_data["domain"]) + | models.Q(service_domain=self.cleaned_data["domain"]) + ): + raise forms.ValidationError("This domain name is already in use") + return self.cleaned_data["domain"] + + def clean_service_domain(self): + if not self.cleaned_data["service_domain"]: + return None + if not self.domain_regex.match(self.cleaned_data["service_domain"]): + raise forms.ValidationError("This does not look like a domain name") + if Domain.objects.filter( + models.Q(domain=self.cleaned_data["service_domain"]) + | models.Q(service_domain=self.cleaned_data["service_domain"]) + ): + raise forms.ValidationError("This domain name is already in use") + if self.cleaned_data.get("domain") == self.cleaned_data["service_domain"]: + raise forms.ValidationError( + "You cannot have the domain and service domain be the same (did you mean to leave service domain blank?)" + ) + return self.cleaned_data["service_domain"] + + def form_valid(self, form): + Domain.objects.create( + domain=form.cleaned_data["domain"], + service_domain=form.cleaned_data["service_domain"] or None, + public=form.cleaned_data["public"], + local=True, + ) + return redirect(Domain.urls.root) + + +class DomainEditPage(FormView): + + template_name = "settings/settings_system_domain_edit.html" + extra_context = {"section": "domains"} + + class form_class(forms.Form): + domain = forms.CharField( + help_text="The domain displayed as part of a user's identity.\nCannot be changed after the domain has been created.", + disabled=True, + ) + service_domain = forms.CharField( + help_text="Optional - a domain that serves Takahē if it is not running on the main domain.\nCannot be changed after the domain has been created.", + disabled=True, + required=False, + ) + public = forms.BooleanField( + help_text="If any user on this server can create identities here", + widget=forms.Select(choices=[(True, "Public"), (False, "Private")]), + required=False, + ) + + def dispatch(self, request, domain): + self.domain = get_object_or_404( + Domain.objects.filter(local=True), domain=domain + ) + return super().dispatch(request) + + def get_context_data(self): + context = super().get_context_data() + context["domain"] = self.domain + return context + + def form_valid(self, form): + self.domain.public = form.cleaned_data["public"] + self.domain.save() + return redirect(Domain.urls.root) + + def get_initial(self): + return { + "domain": self.domain.domain, + "service_domain": self.domain.service_domain, + "public": self.domain.public, + } + + +class DomainDeletePage(TemplateView): + + template_name = "settings/settings_system_domain_delete.html" + + def dispatch(self, request, domain): + self.domain = get_object_or_404( + Domain.objects.filter(public=True), domain=domain + ) + return super().dispatch(request) + + def get_context_data(self): + return { + "domain": self.domain, + "num_identities": self.domain.identities.count(), + "section": "domains", + } + + def post(self, request): + if self.domain.identities.exists(): + raise ValueError("Tried to delete domain with identities!") + self.domain.delete() + return redirect("/settings/system/domains/")