django-smartbase-admin 0.2.47__py3-none-any.whl → 1.0.38__py3-none-any.whl

django_smartbase_admin/admin/site.py

@@ -1,7 +1,18 @@
+from collections.abc import Callable
 from functools import update_wrapper
+from typing import Any
 
+from django.conf import settings
 from django.contrib import admin
-from django.urls import path, reverse_lazy
+from django.contrib.auth import REDIRECT_FIELD_NAME
+from django.contrib.auth.decorators import login_not_required
+from django.http import HttpRequest, HttpResponse, HttpResponseRedirect
+from django.urls import path, reverse_lazy, URLPattern, URLResolver, reverse
+from django.utils.decorators import method_decorator
+from django.utils.translation import gettext_lazy as _
+from django.views.decorators.cache import never_cache
+from django.views.decorators.csrf import csrf_protect
+from django.views.generic import TemplateView
 
 from django_smartbase_admin.engine.admin_entrypoint_view import SBAdminEntrypointView
 from django_smartbase_admin.engine.request import SBAdminViewRequestData
@@ -18,56 +29,69 @@ class SBAdminSite(admin.AdminSite):
         "sb_admin/authentification/password_change_done.html"
     )
 
-    def initialize_admin_view(self, view_function, request, **kwargs):
+    def initialize_admin_view(
+        self, view_func: Callable[..., HttpResponse], request: HttpRequest, **kwargs
+    ) -> None:
         request.current_app = "sb_admin"
         selected_view = None
         try:
-            selected_view = view_function.__self__
+            selected_view = view_func.__self__
             from django_smartbase_admin.admin.admin_base import SBAdminBaseView
 
             if not isinstance(selected_view, SBAdminBaseView):
                 selected_view = None
-        except:
+        except Exception:
             pass
         request.sbadmin_selected_view = selected_view
         kwargs["view"] = selected_view.get_id() if selected_view else None
+        SBAdminThreadLocalService.set_request(request)
         request_data = SBAdminViewRequestData.from_request_and_kwargs(request, **kwargs)
-        SBAdminThreadLocalService.set_data("request", request)
         if selected_view:
             # Initialize SBAdmin, ModelAdmin instances, class-based SBAdminEntrypointView are initialized with request_data
             selected_view.init_view_dynamic(
                 request, request_data=request_data, **kwargs
             )
 
-    def admin_view_response_wrapper(self, response, request, *args, **kwargs):
+    def admin_view_response_wrapper(
+        self, response: HttpResponse, request: HttpRequest, *args, **kwargs
+    ) -> HttpResponse:
         from django_smartbase_admin.admin.admin_base import SBAdminThirdParty
 
         if isinstance(request.sbadmin_selected_view, SBAdminThirdParty):
             response = SBAdminViewService.replace_legacy_admin_access_in_response(
                 response
             )
-
-        SBAdminThreadLocalService.clear_data()
         return response
 
-    def admin_view(self, view_function, cacheable=False):
-        def inner(request, *args, **kwargs):
-            self.initialize_admin_view(view_function, request, **kwargs)
-            return self.admin_view_response_wrapper(
-                view_function(request, *args, **kwargs), request, *args, **kwargs
-            )
-
-        return super(SBAdminSite, self).admin_view(
-            update_wrapper(inner, view_function), cacheable
-        )
-
-    def each_context(self, request):
+    def admin_view(
+        self,
+        view_func: Callable[..., HttpResponse],
+        cacheable: bool = False,
+        *,
+        public: bool = False
+    ) -> Callable[[HttpRequest, ...], HttpResponse]:
+        def inner(request: HttpRequest, *args, **kwargs):
+            self.initialize_admin_view(view_func, request, **kwargs)
+            response = view_func(request, *args, **kwargs)
+            return self.admin_view_response_wrapper(response, request, *args, **kwargs)
+
+        if not public:
+            return super().admin_view(update_wrapper(inner, view_func), cacheable)
+        # standard Django admin behaviour, expect it skips staff/permission checks
+        if not cacheable:
+            inner = never_cache(inner)
+        if not getattr(view_func, "csrf_exempt", False):
+            inner = csrf_protect(inner)
+        inner = login_not_required(inner)
+        return update_wrapper(inner, view_func)
+
+    def each_context(self, request: HttpRequest) -> dict[str, Any]:
         try:
             return request.sbadmin_selected_view.get_global_context(request)
-        except:
+        except Exception:
             return {}
 
-    def get_urls(self):
+    def get_urls(self) -> list[URLPattern | URLResolver]:
         from django.contrib.auth.views import (
             PasswordResetView,
             PasswordResetDoneView,
@@ -76,8 +100,11 @@ class SBAdminSite(admin.AdminSite):
             PasswordChangeView,
             PasswordChangeDoneView,
         )
+        from django_smartbase_admin.views.user_config_view import ColorSchemeView
 
         urls = [
+            path("login/", self.admin_view(self.login, public=True), name="login"),
+            path("logout/", self.admin_view(self.logout), name="logout"),
             path(
                 "password_change/",
                 self.admin_view(
@@ -129,19 +156,16 @@ class SBAdminSite(admin.AdminSite):
                 name="password_reset_complete",
             ),
         ]
-        for model, model_admin in self._registry.items():
-            action_view = getattr(model_admin, "action_view", None)
-            if not action_view:
-                continue
-            urls += [
+        if settings.DEBUG:
+            urls.append(
                 path(
-                    "%s/%s/<str:action>/<str:modifier>"
-                    % (model._meta.app_label, model._meta.model_name),
-                    self.admin_view(action_view),
-                    name="%s_%s_action"
-                    % (model._meta.app_label, model._meta.model_name),
-                ),
-            ]
+                    "components",
+                    TemplateView.as_view(
+                        template_name="sb_admin/includes/components.html"
+                    ),
+                    name="components",
+                )
+            )
         urls.extend(
             [
                 path(
@@ -154,6 +178,11 @@ class SBAdminSite(admin.AdminSite):
                     self.admin_view(GlobalFilterView.as_view()),
                     name="global_filter",
                 ),
+                path(
+                    "color-scheme",
+                    self.admin_view(ColorSchemeView.as_view()),
+                    name="color_scheme",
+                ),
                 path(
                     "<str:view>/<str:action>/<str:modifier>",
                     self.admin_view(SBAdminEntrypointView.as_view()),
@@ -169,5 +198,46 @@ class SBAdminSite(admin.AdminSite):
         urls.extend(super().get_urls())
         return urls
 
+    @method_decorator(never_cache)
+    @login_not_required
+    def login(self, request: HttpRequest, extra_context: dict[str, Any] | None = None):
+        """
+        Same as Django's built-in AdminSite.login view, except it allows the
+        login view class to be overridden via configuration.
+        """
+        if request.method == "GET" and self.has_permission(request):
+            # Already logged-in, redirect to admin index
+            index_path = reverse("admin:index", current_app=self.name)
+            return HttpResponseRedirect(index_path)
+
+        # Since this module gets imported in the application's root package,
+        # it cannot import models from other applications at the module level,
+        # and django.contrib.admin.forms eventually imports User.
+        from django.contrib.admin.forms import AdminAuthenticationForm
+
+        context = {
+            **self.each_context(request),
+            "title": _("Log in"),
+            "subtitle": None,
+            "app_path": request.get_full_path(),
+            "username": request.user.get_username(),
+        }
+        if (
+            REDIRECT_FIELD_NAME not in request.GET
+            and REDIRECT_FIELD_NAME not in request.POST
+        ):
+            context[REDIRECT_FIELD_NAME] = reverse("admin:index", current_app=self.name)
+        context.update(extra_context or {})
+
+        defaults = {
+            "extra_context": context,
+            "authentication_form": self.login_form or AdminAuthenticationForm,
+            "template_name": self.login_template or "admin/login.html",
+        }
+        request.current_app = self.name
+        return request.request_data.configuration.login_view_class.as_view(**defaults)(
+            request
+        )
+
 
 sb_admin_site = SBAdminSite(name="sb_admin")