ArchiveBox/archivebox/api/admin.py

__package__ = "archivebox.api"

from django.contrib import admin
from django.http import HttpRequest
from signal_webhooks.admin import WebhookAdmin
from signal_webhooks.utils import get_webhook_model

from archivebox.base_models.admin import BaseModelAdmin

from archivebox.api.models import APIToken


class APITokenAdmin(BaseModelAdmin):
    list_display = ("created_at", "id", "created_by", "token_redacted", "expires")
    sort_fields = ("id", "created_at", "created_by", "expires")
    readonly_fields = ("created_at", "modified_at")
    search_fields = ("id", "created_by__username", "token")

    fieldsets = (
        (
            "Token",
            {
                "fields": ("token", "expires"),
                "classes": ("card",),
            },
        ),
        (
            "Owner",
            {
                "fields": ("created_by",),
                "classes": ("card",),
            },
        ),
        (
            "Timestamps",
            {
                "fields": ("created_at", "modified_at"),
                "classes": ("card",),
            },
        ),
    )

    list_filter = ("created_by",)
    ordering = ["-created_at"]
    list_per_page = 100


class CustomWebhookAdmin(WebhookAdmin, BaseModelAdmin):
    list_display = ("created_at", "created_by", "id", *WebhookAdmin.list_display)
    sort_fields = ("created_at", "created_by", "id", "referenced_model", "endpoint", "last_success", "last_error")
    readonly_fields = ("created_at", "modified_at", *WebhookAdmin.readonly_fields)

    fieldsets = (
        (
            "Webhook",
            {
                "fields": ("name", "signal", "referenced_model", "endpoint"),
                "classes": ("card", "wide"),
            },
        ),
        (
            "Authentication",
            {
                "fields": ("auth_token",),
                "classes": ("card",),
            },
        ),
        (
            "Status",
            {
                "fields": ("enabled", "last_success", "last_error"),
                "classes": ("card",),
            },
        ),
        (
            "Owner",
            {
                "fields": ("created_by",),
                "classes": ("card",),
            },
        ),
        (
            "Timestamps",
            {
                "fields": ("created_at", "modified_at"),
                "classes": ("card",),
            },
        ),
    )

    def lookup_allowed(self, lookup: str, value: str, request: HttpRequest | None = None) -> bool:
        """Preserve WebhookAdmin's auth token filter with Django's current admin signature."""
        return not lookup.startswith("auth_token") and admin.ModelAdmin.lookup_allowed(self, lookup, value, request)


def register_admin(admin_site: admin.AdminSite) -> None:
    admin_site.register(APIToken, APITokenAdmin)
    admin_site.register(get_webhook_model(), CustomWebhookAdmin)