Add admin settings view

Author: davegaeddert

plain-admin/plain/admin/builtin_views.py

@@ -1,12 +1,17 @@
 """Built-in admin views for core functionality."""
 
+from __future__ import annotations
+
 import json
 from typing import Any
 
-from plain.http import RedirectResponse, Response
+from plain.http import NotFoundError404, RedirectResponse, Response
+from plain.models import QuerySet
+from plain.runtime import settings as plain_settings
 
 from .models import PinnedNavItem
 from .views.base import AdminView
+from .views.objects import AdminListView
 from .views.registry import registry
 
 MAX_PINNED_ITEMS = 6
@@ -128,6 +133,82 @@ def post(self) -> Response:
         return Response("OK")
 
 
+def _setting_to_dict(name: str, defn: Any) -> dict[str, Any]:
+    return {
+        "name": name,
+        "source": defn.source,
+        "value": defn.display_value(),
+        "env_var_name": defn.env_var_name,
+        "is_secret": defn.is_secret,
+    }
+
+
+class SettingsView(AdminListView):
+    title = "App Settings"
+    description = (
+        "All framework and app settings with their current values and sources."
+    )
+    nav_section = None
+    fields = ["name", "source", "value"]
+
+    @classmethod
+    def get_view_url(cls, obj: Any = None) -> str:
+        return "/admin/settings/"
+
+    search_fields = ["name"]
+    filters = ["default", "explicit", "env"]
+    page_size = 100
+
+    _FIELD_TEMPLATES = {
+        "name": ["admin/values/setting_name.html"],
+        "source": ["admin/values/setting_source.html"],
+        "value": ["admin/values/setting_value.html"],
+    }
+
+    def get_initial_objects(self) -> list[dict[str, Any]]:
+        return [
+            _setting_to_dict(name, defn) for name, defn in plain_settings.get_settings()
+        ]
+
+    def filter_objects(
+        self, objects: list[Any] | QuerySet[Any]
+    ) -> list[Any] | QuerySet[Any]:
+        if self.filter:
+            return [obj for obj in objects if obj["source"] == self.filter]
+        return objects
+
+    def format_field_value(self, obj: Any, field: str, value: Any) -> Any:
+        if field == "source" and obj.get("env_var_name"):
+            return obj["env_var_name"]
+        return value
+
+    def get_detail_url(self, obj: Any) -> str:
+        return f"/admin/settings/{obj['name']}/"
+
+    def get_field_value_template(self, obj: Any, field: str, value: Any) -> list[str]:
+        if field in self._FIELD_TEMPLATES:
+            return self._FIELD_TEMPLATES[field]
+        return super().get_field_value_template(obj, field, value)
+
+
+class SettingDetailView(AdminView):
+    template_name = "admin/setting_detail.html"
+    parent_view_class = SettingsView
+    nav_section = None
+
+    def get_template_context(self) -> dict[str, Any]:
+        name = self.url_kwargs["name"]
+        settings_map = dict(plain_settings.get_settings())
+        defn = settings_map.get(name)
+        if defn is None:
+            raise NotFoundError404()
+
+        context = super().get_template_context()
+        context["title"] = name
+        context["setting"] = _setting_to_dict(name, defn)
+        return context
+
+
 class StyleGuideView(AdminView):
     """Style guide showing available components and patterns."""
 

plain-admin/plain/admin/templates/admin/_header.html

@@ -59,6 +59,10 @@
                 {% endif %}
                 <template>
                     <div class="py-1">
+                        <a href="{{ url('admin:settings') }}" class="flex items-center gap-2 w-full text-left px-4 py-2 text-sm text-stone-700 hover:bg-stone-100 rounded">
+                            <admin.Icon name="gear" />
+                            App Settings
+                        </a>
                         <form method="POST" action="{{ url('admin:logout') }}">
                             <button type="submit" class="flex items-center gap-2 w-full text-left px-4 py-2 text-sm text-stone-700 hover:bg-stone-100 rounded">
                                 <admin.Icon name="box-arrow-right" />

plain-admin/plain/admin/templates/admin/setting_detail.html

@@ -0,0 +1,41 @@
+{% extends "admin/base.html" %}
+
+{% use_elements %}
+
+{% block content %}
+
+<div class="card">
+    <section>
+        <dl>
+            <div class="flex gap-8 py-1.5">
+                <dt class="w-40 flex-shrink-0 text-black/50">Name</dt>
+                <dd class="min-w-0">
+                    <span class="font-mono text-sm">{{ setting.name }}</span>
+                </dd>
+            </div>
+            <div class="flex gap-8 py-1.5">
+                <dt class="w-40 flex-shrink-0 text-black/50">Source</dt>
+                <dd class="min-w-0">
+                    <span
+                        data-source="{{ setting.source }}"
+                        class="inline-flex items-center px-1.5 py-0.5 text-xs rounded-md
+                               data-[source=default]:bg-stone-100 data-[source=default]:text-stone-400
+                               data-[source=explicit]:bg-stone-200/70 data-[source=explicit]:text-stone-600
+                               data-[source=env]:bg-amber-50 data-[source=env]:text-amber-800 data-[source=env]:font-mono"
+                    >{{ setting.env_var_name or setting.source }}</span>
+                </dd>
+            </div>
+            <div class="flex gap-8 py-1.5">
+                <dt class="w-40 flex-shrink-0 text-black/50">Value</dt>
+                <dd class="min-w-0">
+                    <span
+                        data-secret="{{ setting.is_secret }}"
+                        class="font-mono text-sm break-all whitespace-pre-wrap data-[secret=True]:text-stone-400 data-[secret=True]:italic"
+                    >{{ setting.value }}</span>
+                </dd>
+            </div>
+        </dl>
+    </section>
+</div>
+
+{% endblock %}

plain-admin/plain/admin/templates/admin/values/setting_name.html

@@ -0,0 +1 @@
+<span class="font-mono text-sm">{{ value }}</span>

plain-admin/plain/admin/templates/admin/values/setting_source.html

@@ -0,0 +1,7 @@
+<span
+    data-source="{{ object.source }}"
+    class="inline-flex items-center px-1.5 py-0.5 text-xs rounded-md
+           data-[source=default]:bg-stone-100 data-[source=default]:text-stone-400
+           data-[source=explicit]:bg-stone-200/70 data-[source=explicit]:text-stone-600
+           data-[source=env]:bg-amber-50 data-[source=env]:text-amber-800 data-[source=env]:font-mono"
+>{{ value }}</span>

plain-admin/plain/admin/templates/admin/values/setting_value.html

@@ -0,0 +1,8 @@
+{% if value == "''" %}
+<span class="text-stone-300">&mdash;</span>
+{% else %}
+<span
+    data-secret="{{ object.is_secret }}"
+    class="font-mono text-sm break-all data-[secret=True]:text-stone-400 data-[secret=True]:italic"
+>{{ value }}</span>
+{% endif %}

plain-admin/plain/admin/urls.py

@@ -6,6 +6,8 @@
     AdminSearchView,
     PinNavView,
     ReorderPinnedView,
+    SettingDetailView,
+    SettingsView,
     StyleGuideView,
     UnpinNavView,
 )
@@ -20,6 +22,8 @@ class AdminRouter(Router):
     urls = [
         path("search/", AdminSearchView, name="search"),
         path("style/", StyleGuideView, name="style"),
+        path("settings/", SettingsView, name="settings"),
+        path("settings/<name>/", SettingDetailView, name="setting_detail"),
         path("logout/", LogoutView, name="logout"),
         path("_/pin/", PinNavView, name="pin"),
         path("_/unpin/", UnpinNavView, name="unpin"),

plain/plain/runtime/user_settings.py

@@ -248,6 +248,8 @@ def get_settings(
         self._setup()
         result = []
         for name, defn in sorted(self._settings.items()):
+            if name.startswith("_"):
+                continue
             if source is not None and defn.source != source:
                 continue
             result.append((name, defn))