plain.admin 0.14.1__py3-none-any.whl

plain/admin/templates/querystats/toolbar.html

@@ -0,0 +1,79 @@
+<form
+    data-querystats
+    action="."
+    method="get"
+    target="querystats"
+    class="relative group/querystats"
+    style="display: none;">
+    <input type="hidden" name="querystats" value="store">
+    <button type="submit" class="px-2 py-px text-xs rounded-full bg-stone-700 text-stone-300 whitespace-nowrap" data-querystats-summary></button>
+    <div data-querystats-list style="display: none;" class="absolute right-0 z-50 hidden translate-y-full -bottom-1 group/querystats-hover:block">
+        <div class="p-2 text-xs border rounded shadow-md bg-zinc-900 border-zinc-700"><table><tbody></tbody></table></div>
+    </div>
+    <script async defer>
+    // Catch errors since some browsers throw when using the new `type` option.
+    // https://bugs.webkit.org/show_bug.cgi?id=209216
+    var querystatsTimings = [];
+    function renderQuerystats() {
+        // Render the most recent timing call
+        const latestTiming = querystatsTimings[querystatsTimings.length - 1];
+        let summary = latestTiming.description;
+        if (querystatsTimings.length > 1) {
+            summary += ` *`;
+        }
+        document.querySelector('[data-querystats-summary]').innerText = summary;
+
+        // Make sure the elements are visible
+        document.querySelector('[data-querystats]').style.display = 'inline';
+
+        // Render the table rows for all timings
+        const list = document.querySelector('[data-querystats-list]');
+        if (querystatsTimings.length > 1) {
+            const tableRows = querystatsTimings.map(timing => {
+                let url = timing.url;
+                if (url.startsWith(window.location.origin)) {
+                    // Make the url relative if possible (usually is)
+                    url = url.slice(window.location.origin.length);
+                }
+                return `<tr>
+                    <td class="pr-2 font-medium whitespace-nowrap">${url}</td>
+                    <td class="whitespace-nowrap">${timing.description}</td>
+                </tr>`;
+            }).join('');
+            list.querySelector("tbody").innerHTML = tableRows;
+            list.style.display = '';
+        } else {
+            list.style.display = 'none';
+        }
+    }
+    try {
+        // Create the performance observer.
+        const po = new PerformanceObserver((list) => {
+            for (const entry of list.getEntries()) {
+                if (!entry.serverTiming) {
+                    console.warn("Server timing not available for querystats.")
+                    return;
+                }
+                for (const timing of entry.serverTiming) {
+                    if (querystatsTimings.length > 0) {
+                        if (querystatsTimings[querystatsTimings.length - 1] === timing) {
+                            // Skip duplicate timings (happens on initial load...)
+                            continue;
+                        }
+                    }
+                    if (timing.name === "querystats") {
+                        console.log("Querystats timing", entry)
+                        timing.url = entry.name;  // Store this for reference later
+                        querystatsTimings.push(timing);
+                        renderQuerystats();
+                    }
+                }
+            }
+        });
+        po.observe({type: 'navigation', buffered: true});  // Catch the regular page loads
+        po.observe({type: 'resource', buffered: true});  // Catch future ajax requests
+    } catch (e) {
+        // Do nothing if the browser doesn't support this API.
+    }
+    </script>
+</form>

plain/admin/templates/toolbar/toolbar.html

@@ -0,0 +1,91 @@
+{% if toolbar.should_render() %}
+{% set exception=toolbar.request_exception() %}
+<script src="{{ asset('toolbar/toolbar.js') }}"></script>
+<div id="plaintoolbar" class="print:hidden text-sm py-1.5 text-stone-300 bg-stone-950 fixed bottom-3 mx-3 max-w-full drop-shadow-md z-30 rounded-2xl lg:flex lg:flex-col -translate-x-1/2 left-1/2 max-h-[90vh]">
+    <div class="flex justify-between px-4 mx-auto space-x-4">
+        <div class="flex items-center">
+            <svg class="h-4 w-4" width="160" height="125" viewBox="0 0 160 125" fill="none" xmlns="http://www.w3.org/2000/svg">
+                <rect x="4.78467" y="4.79785" width="150.978" height="115.404" rx="5" stroke="#ffffff" stroke-width="8"/>
+                <path d="M151.762 60.3705C99.2596 39.3233 80.202 66.8232 8.78467 60.3705V116.2H151.762V60.3705Z" fill="#ffffff"/>
+                <path d="M51.104 8.08887H108.179V10.7668C108.179 12.6998 106.612 14.2668 104.679 14.2668H54.604C52.671 14.2668 51.104 12.6998 51.104 10.7668V8.08887Z" fill="#ffffff" stroke="#ffffff"/>
+            </svg>
+            <code class="ml-2 text-xs whitespace-nowrap text-mono">{{ toolbar.version }}</code>
+
+            {% if request.impersonator is defined %}
+            <div class="flex items-center ml-1 font-light">
+                Impersonating&nbsp;<span class="font-medium">{{ request.user }}</span>
+                </span>
+                <a href="{{ url('admin:impersonate:stop') }}" title="Stop impersonating" class="flex items-center px-1 ml-1 text-red-300 hover:text-white">
+                    <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="w-4 h-4 bi bi-x-octagon-fill" viewBox="0 0 16 16">
+                        <path d="M11.46.146A.5.5 0 0 0 11.107 0H4.893a.5.5 0 0 0-.353.146L.146 4.54A.5.5 0 0 0 0 4.893v6.214a.5.5 0 0 0 .146.353l4.394 4.394a.5.5 0 0 0 .353.146h6.214a.5.5 0 0 0 .353-.146l4.394-4.394a.5.5 0 0 0 .146-.353V4.893a.5.5 0 0 0-.146-.353L11.46.146zm-6.106 4.5L8 7.293l2.646-2.647a.5.5 0 0 1 .708.708L8.707 8l2.647 2.646a.5.5 0 0 1-.708.708L8 8.707l-2.646 2.647a.5.5 0 0 1-.708-.708L7.293 8 4.646 5.354a.5.5 0 1 1 .708-.708z"/>
+                    </svg>
+                </a>
+            </div>
+            {% endif %}
+        </div>
+        <div class="flex items-center space-x-4">
+            {% include "querystats/toolbar.html" %}
+
+            <div class="flex items-center space-x-3 transition-all">
+                <a href="{{ url('admin:index') }}" class="hover:underline">Admin</a>
+                {% if object|default(false) and object|get_admin_model_detail_url %}
+                <a class="inline-flex items-center p-1 text-blue-500 hover:text-blue-400" href="{{ object|get_admin_model_detail_url }}">
+                    <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="w-3 h-3 bi bi-database-fill" viewBox="0 0 16 16">
+                        <path d="M3.904 1.777C4.978 1.289 6.427 1 8 1s3.022.289 4.096.777C13.125 2.245 14 2.993 14 4s-.875 1.755-1.904 2.223C11.022 6.711 9.573 7 8 7s-3.022-.289-4.096-.777C2.875 5.755 2 5.007 2 4s.875-1.755 1.904-2.223"/>
+                        <path d="M2 6.161V7c0 1.007.875 1.755 1.904 2.223C4.978 9.71 6.427 10 8 10s3.022-.289 4.096-.777C13.125 8.755 14 8.007 14 7v-.839c-.457.432-1.004.751-1.49.972C11.278 7.693 9.682 8 8 8s-3.278-.307-4.51-.867c-.486-.22-1.033-.54-1.49-.972"/>
+                        <path d="M2 9.161V10c0 1.007.875 1.755 1.904 2.223C4.978 12.711 6.427 13 8 13s3.022-.289 4.096-.777C13.125 11.755 14 11.007 14 10v-.839c-.457.432-1.004.751-1.49.972-1.232.56-2.828.867-4.51.867s-3.278-.307-4.51-.867c-.486-.22-1.033-.54-1.49-.972"/>
+                        <path d="M2 12.161V13c0 1.007.875 1.755 1.904 2.223C4.978 15.711 6.427 16 8 16s3.022-.289 4.096-.777C13.125 14.755 14 14.007 14 13v-.839c-.457.432-1.004.751-1.49.972-1.232.56-2.828.867-4.51.867s-3.278-.307-4.51-.867c-.486-.22-1.033-.54-1.49-.972"/>
+                    </svg>
+                </a>
+                {% endif %}
+                {% include "toolbar/links.html" ignore missing %}
+                <button data-plaintoolbar-expand class="hover:text-orange-500" type="button">
+                    <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="w-4 h-4" viewBox="0 0 16 16">
+                        <path fill-rule="evenodd" d="M3.646 9.146a.5.5 0 0 1 .708 0L8 12.793l3.646-3.647a.5.5 0 0 1 .708.708l-4 4a.5.5 0 0 1-.708 0l-4-4a.5.5 0 0 1 0-.708zm0-2.292a.5.5 0 0 0 .708 0L8 3.207l3.646 3.647a.5.5 0 0 0 .708-.708l-4-4a.5.5 0 0 0-.708 0l-4 4a.5.5 0 0 0 0 .708z"/>
+                    </svg>
+                </button>
+            </div>
+        </div>
+    </div>
+    <div id="plaintoolbar-details" class="{% if not exception %}hidden{% endif %} p-4 overflow-auto text-sm space-y-2">
+
+        {% if exception %}
+        <div class="p-2 border-amber-500 border rounded">
+            <div class="text-amber-500 text-lg flex justify-between items-center">
+                <div>
+                    <span class="font-bold">Exception</span>
+                    {{ exception }}
+                </div>
+                <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="w-5 h-5 bi bi-exclamation-triangle-fill" viewBox="0 0 16 16">
+                    <path d="M8.982 1.566a1.13 1.13 0 0 0-1.96 0L.165 13.233c-.457.778.091 1.767.98 1.767h13.713c.889 0 1.438-.99.98-1.767zM8 5c.535 0 .954.462.9.995l-.35 3.507a.552.552 0 0 1-1.1 0L7.1 5.995A.905.905 0 0 1 8 5m.002 6a1 1 0 1 1 0 2 1 1 0 0 1 0-2"/>
+                </svg>
+            </div>
+            <div class="text-amber-400 text-xs mt-3 bg-white/5 p-2 rounded overflow-auto">
+                <pre><code>{{ exception._traceback_string }}</code></pre>
+            </div>
+        </div>
+        {% endif %}
+
+        <table>
+            <tbody>
+            {% for k, v in toolbar.metadata.items() %}
+            <tr>
+                <td class="pr-2 font-medium whitespace-nowrap">{{ k }}</td>
+                <td class="whitespace-nowrap">{{ v }}</td>
+            </tr>
+            {% endfor %}
+            </tbody>
+        </table>
+
+        {% if object|default(false) %}
+        <div class="font-mono" title="PK: {{ object.pk|default('unknown') }}">
+            {{ object.__repr__() }}
+        </div>
+        {% endif %}
+
+        <button data-plaintoolbar-hide class="hover:text-red-500" type="button">
+            Hide toolbar for 1 hour
+        </button>
+    </div>
+</div>
+{% endif %}

plain/admin/templates.py

@@ -0,0 +1,25 @@
+from plain.runtime import settings
+from plain.templates import register_template_extension, register_template_filter
+from plain.templates.jinja.extensions import InclusionTagExtension
+from plain.utils.module_loading import import_string
+
+from .views.registry import registry
+
+
+@register_template_extension
+class ToolbarExtension(InclusionTagExtension):
+    tags = {"toolbar"}
+    template_name = "toolbar/toolbar.html"
+
+    def get_context(self, context, *args, **kwargs):
+        if isinstance(settings.TOOLBAR_CLASS, str):
+            cls = import_string(settings.TOOLBAR_CLASS)
+        else:
+            cls = settings.TOOLBAR_CLASS
+        context.vars["toolbar"] = cls(request=context["request"])
+        return context
+
+
+@register_template_filter
+def get_admin_model_detail_url(obj):
+    return registry.get_model_detail_url(obj)

plain/admin/toolbar.py

@@ -0,0 +1,36 @@
+import sys
+import traceback
+
+from plain.runtime import settings
+from plain.urls.exceptions import Resolver404
+
+
+class Toolbar:
+    def __init__(self, request):
+        self.request = request
+        self.version = settings.TOOLBAR_VERSION
+        self.metadata = {
+            "Request ID": request.unique_id,
+        }
+
+    def should_render(self):
+        if settings.DEBUG:
+            return True
+
+        if hasattr(self.request, "impersonator"):
+            return self.request.impersonator.is_admin
+
+        if self.request.user:
+            return self.request.user.is_admin
+
+        return False
+
+    def request_exception(self):
+        # We can capture the exception currently being handled here, if any.
+        exception = sys.exception()
+
+        if exception and not isinstance(exception, Resolver404):
+            exception._traceback_string = "".join(
+                traceback.format_tb(exception.__traceback__)
+            )
+            return exception

plain/admin/urls.py

@@ -0,0 +1,45 @@
+from plain.http import ResponseRedirect
+from plain.urls import include, path
+
+from .impersonate import urls as impersonate_urls
+from .querystats import urls as querystats_urls
+from .views.base import AdminView
+from .views.registry import registry
+
+
+class AdminIndexView(AdminView):
+    template_name = "admin/index.html"
+    title = "Dashboard"
+    slug = ""
+
+    def get(self):
+        # Slight hack to redirect to the first view that doesn't
+        # require any url params...
+        if views := registry.get_searchable_views():
+            return ResponseRedirect(list(views)[0].get_view_url())
+
+        return super().get()
+
+
+class AdminSearchView(AdminView):
+    template_name = "admin/search.html"
+    title = "Search"
+    slug = "search"
+
+    def get_template_context(self):
+        context = super().get_template_context()
+        context["searchable_views"] = registry.get_searchable_views()
+        context["global_search_query"] = self.request.GET.get("query", "")
+        return context
+
+
+default_namespace = "admin"
+
+
+urlpatterns = [
+    path("search/", AdminSearchView, name="search"),
+    path("impersonate/", include(impersonate_urls)),
+    path("querystats/", include(querystats_urls)),
+    path("", include(registry.get_urls())),
+    path("", AdminIndexView, name="index"),
+]

plain/admin/views/__init__.py

@@ -0,0 +1,41 @@
+from .base import AdminView
+from .models import (
+    AdminModelCreateView,
+    AdminModelDeleteView,
+    AdminModelDetailView,
+    AdminModelListView,
+    AdminModelUpdateView,
+)
+from .objects import (
+    AdminCreateView,
+    AdminDeleteView,
+    AdminDetailView,
+    AdminListView,
+    AdminUpdateView,
+)
+from .registry import (
+    get_model_detail_url,
+    register_view,
+    register_viewset,
+)
+from .types import Img
+from .viewsets import AdminViewset
+
+__all__ = [
+    "AdminView",
+    "AdminListView",
+    "AdminCreateView",
+    "AdminUpdateView",
+    "AdminDetailView",
+    "AdminDeleteView",
+    "AdminViewset",
+    "AdminModelListView",
+    "AdminModelCreateView",
+    "AdminModelDetailView",
+    "AdminModelUpdateView",
+    "AdminModelDeleteView",
+    "register_viewset",
+    "register_view",
+    "get_model_detail_url",
+    "Img",
+]

plain/admin/views/base.py

@@ -0,0 +1,140 @@
+from typing import TYPE_CHECKING
+
+from plain.auth.views import AuthViewMixin
+from plain.urls import reverse
+from plain.utils import timezone
+from plain.utils.text import slugify
+from plain.views import (
+    TemplateView,
+)
+
+from .registry import registry
+from .types import Img
+
+if TYPE_CHECKING:
+    from ..cards import Card
+
+
+URL_NAMESPACE = "admin"
+
+
+class AdminView(AuthViewMixin, TemplateView):
+    admin_required = True
+
+    title: str = ""
+    slug: str = ""
+    path: str = ""
+    description: str = ""
+    image: Img | None = None
+
+    # Leave empty to hide from nav
+    #
+    # An explicit disabling of showing this url/page in the nav
+    # which importantly effects the (future) recent pages list
+    # so you can also use this for pages that can never be bookmarked
+    nav_section = "App"
+    nav_title = ""
+
+    links: dict[str] = {}
+
+    parent_view_class: "AdminView" = None
+
+    template_name = "admin/page.html"
+    cards: list["Card"] = []
+
+    def get_template_context(self):
+        context = super().get_template_context()
+        context["title"] = self.get_title()
+        context["image"] = self.get_image()
+        context["slug"] = self.get_slug()
+        context["description"] = self.get_description()
+        context["links"] = self.get_links()
+        context["parent_view_classes"] = self.get_parent_view_classes()
+        context["admin_registry"] = registry
+        context["cards"] = self.get_cards()
+        context["render_card"] = lambda card: card().render(self, self.request)
+        context["time_zone"] = timezone.get_current_timezone_name()
+        return context
+
+    @classmethod
+    def view_name(cls) -> str:
+        return f"view_{cls.get_slug()}"
+
+    @classmethod
+    def get_slug(cls) -> str:
+        if cls.slug:
+            return cls.slug
+
+        if cls.title:
+            return slugify(cls.title)
+
+        raise NotImplementedError(
+            f"Please set a slug on the {cls} class or implement get_slug()."
+        )
+
+    # Can actually use @classmethod, @staticmethod or regular method for these?
+    def get_title(self) -> str:
+        return self.title
+
+    def get_image(self) -> Img | None:
+        return self.image
+
+    def get_description(self) -> str:
+        return self.description
+
+    @classmethod
+    def get_path(cls) -> str:
+        if cls.path:
+            return cls.path
+
+        if slug := cls.get_slug():
+            return slug
+
+        raise NotImplementedError(
+            f"Please set a path on the {cls} class or implement get_slug() or get_path()."
+        )
+
+    @classmethod
+    def get_parent_view_classes(cls) -> list["AdminView"]:
+        parents = []
+        parent = cls.parent_view_class
+        while parent:
+            parents.append(parent)
+            parent = parent.parent_view_class
+        return parents
+
+    @classmethod
+    def get_nav_section(cls) -> bool:
+        if not cls.nav_section:
+            return ""
+
+        if cls.parent_view_class:
+            # Don't show child views by default
+            return ""
+
+        return cls.nav_section
+
+    @classmethod
+    def get_nav_title(cls) -> str:
+        if cls.nav_title:
+            return cls.nav_title
+
+        if cls.title:
+            return cls.title
+
+        raise NotImplementedError(
+            f"Please set a title or nav_title on the {cls} class or implement get_nav_title()."
+        )
+
+    @classmethod
+    def get_view_url(cls, obj=None) -> str:
+        if obj:
+            return reverse(f"{URL_NAMESPACE}:" + cls.view_name(), kwargs={"pk": obj.pk})
+        else:
+            return reverse(f"{URL_NAMESPACE}:" + cls.view_name())
+
+    def get_links(self) -> dict[str]:
+        return self.links.copy()
+
+    def get_cards(self):
+        return self.cards.copy()