django-unfold 0.67.0__py3-none-any.whl → 0.69.0__py3-none-any.whl

unfold/mixins/dataset_model_admin.py

@@ -0,0 +1,62 @@
+from typing import Any
+
+from django.contrib.admin import helpers
+from django.contrib.admin.views import main
+from django.contrib.admin.views.main import IGNORED_PARAMS
+from django.http import HttpRequest
+from django.template.response import TemplateResponse
+
+
+class DatasetModelAdminMixin:
+    def changeform_view(
+        self,
+        request: HttpRequest,
+        object_id: str | None = None,
+        form_url: str = "",
+        extra_context: dict[str, Any] | None = None,
+    ) -> TemplateResponse:
+        self.request = request
+        extra_context = extra_context or {}
+        datasets = self.get_changeform_datasets(request)
+
+        # Monkeypatch IGNORED_PARAMS to add dataset page and search arguments into ignored params
+        ignored_params = []
+        for dataset in datasets:
+            ignored_params.append(f"{dataset.model._meta.model_name}-q")
+            ignored_params.append(f"{dataset.model._meta.model_name}-p")
+
+        main.IGNORED_PARAMS = (*IGNORED_PARAMS, *ignored_params)
+
+        rendered_datasets = []
+        for dataset in datasets:
+            rendered_datasets.append(
+                dataset(
+                    request=request,
+                    extra_context={
+                        "object": object_id,
+                    },
+                )
+            )
+
+        extra_context["datasets"] = rendered_datasets
+        selected = request.POST.getlist(helpers.ACTION_CHECKBOX_NAME)
+
+        if (
+            request.method == "POST"
+            and selected
+            and "dataset" in request.POST
+            and helpers.ACTION_CHECKBOX_NAME in request.POST
+        ):
+            dataset = None
+            for item in rendered_datasets:
+                if item.id == request.POST["dataset"]:
+                    dataset = item
+
+            response = dataset.model_admin_instance.response_action(
+                request, queryset=dataset.cl.get_queryset(request)
+            )
+
+            if response:
+                return response
+
+        return super().changeform_view(request, object_id, form_url, extra_context)

unfold/settings.py

@@ -79,6 +79,7 @@ CONFIG_DEFAULTS = {
     "LOGIN": {
         "image": None,
         "redirect_after": None,
+        "form": None,
     },
     "EXTENSIONS": {"modeltranslation": {"flags": {}}},
 }

unfold/sites.py

@@ -1,7 +1,8 @@
 import copy
 import time
+from collections.abc import Callable
 from http import HTTPStatus
-from typing import Any, Callable, Optional, Union
+from typing import Any
 from urllib.parse import parse_qs, urlparse
 
 from django.contrib.admin import AdminSite
@@ -46,7 +47,11 @@ class UnfoldAdminSite(AdminSite):
 
         super().__init__(name)
 
-        if self.login_form is None:
+        custom_login_form = get_config(self.settings_name)["LOGIN"]["form"]
+
+        if custom_login_form is not None:
+            self.login_form = import_string(custom_login_form)
+        elif self.login_form is None:
             self.login_form = AuthenticationForm
 
     def get_urls(self) -> list[URLPattern]:
@@ -141,7 +146,7 @@ class UnfoldAdminSite(AdminSite):
         return context
 
     def index(
-        self, request: HttpRequest, extra_context: Optional[dict[str, Any]] = None
+        self, request: HttpRequest, extra_context: dict[str, Any] | None = None
     ) -> TemplateResponse:
         app_list = self.get_app_list(request)
 
@@ -166,7 +171,7 @@ class UnfoldAdminSite(AdminSite):
         )
 
     def toggle_sidebar(
-        self, request: HttpRequest, extra_context: Optional[dict[str, Any]] = None
+        self, request: HttpRequest, extra_context: dict[str, Any] | None = None
     ) -> HttpResponse:
         if "toggle_sidebar" not in request.session:
             request.session["toggle_sidebar"] = True
@@ -214,14 +219,14 @@ class UnfoldAdminSite(AdminSite):
         request: HttpRequest,
         app_list: list[dict[str, Any]],
         search_term: str,
-        allowed_models: Optional[list[str]] = None,
+        allowed_models: list[str] | None = None,
     ) -> list[SearchResult]:
         results = []
 
         for app in app_list:
             for model in app["models"]:
                 # Skip models which are not allowed
-                if isinstance(allowed_models, (list, tuple)):
+                if isinstance(allowed_models, list | tuple):
                     if model["model"]._meta.label.lower() not in [
                         m.lower() for m in allowed_models
                     ]:
@@ -263,7 +268,7 @@ class UnfoldAdminSite(AdminSite):
         return results
 
     def search(
-        self, request: HttpRequest, extra_context: Optional[dict[str, Any]] = None
+        self, request: HttpRequest, extra_context: dict[str, Any] | None = None
     ) -> TemplateResponse:
         start_time = time.time()
 
@@ -302,10 +307,10 @@ class UnfoldAdminSite(AdminSite):
                     self._get_config("COMMAND", request).get("search_models"), request
                 )
 
-                if search_models is True or isinstance(search_models, (list, tuple)):
+                if search_models is True or isinstance(search_models, list | tuple):
                     allowed_models = (
                         search_models
-                        if isinstance(search_models, (list, tuple))
+                        if isinstance(search_models, list | tuple)
                         else None
                     )
 
@@ -340,7 +345,7 @@ class UnfoldAdminSite(AdminSite):
         )
 
     def password_change(
-        self, request: HttpRequest, extra_context: Optional[dict[str, Any]] = None
+        self, request: HttpRequest, extra_context: dict[str, Any] | None = None
     ) -> HttpResponse:
         from django.contrib.auth.views import PasswordChangeView
 
@@ -462,7 +467,7 @@ class UnfoldAdminSite(AdminSite):
         return tabs
 
     def _call_permission_callback(
-        self, callback: Union[str, Callable, None], request: HttpRequest
+        self, callback: str | Callable | None, request: HttpRequest
     ) -> bool:
         if callback is None:
             return True
@@ -490,7 +495,7 @@ class UnfoldAdminSite(AdminSite):
         return target
 
     def _get_is_active(
-        self, request: HttpRequest, link: Union[str, Callable], is_tab: bool = False
+        self, request: HttpRequest, link: str | Callable, is_tab: bool = False
     ) -> bool:
         if not isinstance(link, str):
             link = str(link)
@@ -545,9 +550,7 @@ class UnfoldAdminSite(AdminSite):
         if key in config and config[key]:
             return self._get_value(config[key], *args)
 
-    def _get_theme_images(
-        self, key: str, *args: Any
-    ) -> Union[dict[str, str], str, None]:
+    def _get_theme_images(self, key: str, *args: Any) -> dict[str, str] | str | None:
         images = self._get_config(key, *args)
 
         if isinstance(images, dict):
@@ -613,9 +616,7 @@ class UnfoldAdminSite(AdminSite):
             for item in items
         ]
 
-    def _get_value(
-        self, value: Union[str, Callable, lazy, None], *args: Any
-    ) -> Optional[str]:
+    def _get_value(self, value: str | Callable | None, *args: Any) -> str | None:
         if value is None:
             return None
 

unfold/static/admin/js/actions.js

@@ -0,0 +1,246 @@
+/*global gettext, interpolate, ngettext, Actions*/
+"use strict";
+{
+  function show(options, selector) {
+    options.parent.querySelectorAll(selector).forEach(function (el) {
+      el.classList.remove("hidden");
+    });
+  }
+
+  function hide(options, selector) {
+    options.parent.querySelectorAll(selector).forEach(function (el) {
+      el.classList.add("hidden");
+    });
+  }
+
+  function showQuestion(options) {
+    hide(options, options.acrossClears);
+    show(options, options.acrossQuestions);
+    hide(options, options.allContainer);
+  }
+
+  function showClear(options) {
+    show(options, options.acrossClears);
+    hide(options, options.acrossQuestions);
+    options.parent
+      .querySelector(options.actionContainer)
+      .classList.remove(options.selectedClass);
+    show(options, options.allContainer);
+    hide(options, options.counterContainer);
+  }
+
+  function reset(options) {
+    hide(options, options.acrossClears);
+    hide(options, options.acrossQuestions);
+    hide(options, options.allContainer);
+    show(options, options.counterContainer);
+  }
+
+  function clearAcross(options) {
+    reset(options);
+    const acrossInputs = options.parent.querySelectorAll(options.acrossInput);
+    acrossInputs.forEach(function (acrossInput) {
+      acrossInput.value = 0;
+      acrossInput.dispatchEvent(new Event("input"));
+    });
+    options.parent
+      .querySelector(options.actionContainer)
+      .classList.remove(options.selectedClass);
+  }
+
+  function checker(actionCheckboxes, options, checked) {
+    if (checked) {
+      showQuestion(options);
+    } else {
+      reset(options);
+    }
+    actionCheckboxes.forEach(function (el) {
+      el.checked = checked;
+      el.closest("tr").classList.toggle(options.selectedClass, checked);
+    });
+  }
+
+  function updateCounter(actionCheckboxes, options) {
+    const sel = Array.from(actionCheckboxes).filter(function (el) {
+      return el.checked;
+    }).length;
+    const counter = options.parent.querySelector(options.counterContainer);
+    // data-actions-icnt is defined in the generated HTML
+    // and contains the total amount of objects in the queryset
+    const actions_icnt = Number(counter.dataset.actionsIcnt);
+    counter.textContent = interpolate(
+      ngettext(
+        "%(sel)s of %(cnt)s selected",
+        "%(sel)s of %(cnt)s selected",
+        sel
+      ),
+      {
+        sel: sel,
+        cnt: actions_icnt,
+      },
+      true
+    );
+    const allToggle = options.parent.querySelector(".action-toggle");
+    allToggle.checked = sel === actionCheckboxes.length;
+    if (allToggle.checked) {
+      showQuestion(options);
+    } else {
+      clearAcross(options);
+    }
+  }
+
+  const defaults = {
+    actionContainer: "div.actions",
+    counterContainer: "span.action-counter",
+    allContainer: "div.actions span.all",
+    acrossInput: "div.actions input.select-across",
+    acrossQuestions: "div.actions span.question",
+    acrossClears: "div.actions span.clear",
+    allToggleId: "action-toggle",
+    selectedClass: "selected",
+  };
+
+  window.Actions = function (actionCheckboxes, options) {
+    options = Object.assign({}, defaults, options);
+    let list_editable_changed = false;
+    let lastChecked = null;
+    let shiftPressed = false;
+
+    document.addEventListener("keydown", (event) => {
+      shiftPressed = event.shiftKey;
+    });
+
+    document.addEventListener("keyup", (event) => {
+      shiftPressed = event.shiftKey;
+    });
+
+    const allToggle = options.parent.querySelector(".action-toggle");
+    allToggle.addEventListener("click", function (event) {
+      checker(actionCheckboxes, options, this.checked);
+      updateCounter(actionCheckboxes, options);
+    });
+
+    options.parent
+      .querySelectorAll(options.acrossQuestions + " a")
+      .forEach(function (el) {
+        el.addEventListener("click", function (event) {
+          event.preventDefault();
+          const acrossInputs = options.parent.querySelectorAll(
+            options.acrossInput
+          );
+          acrossInputs.forEach(function (acrossInput) {
+            acrossInput.value = 1;
+            acrossInput.dispatchEvent(new Event("input"));
+          });
+          showClear(options);
+        });
+      });
+
+    options.parent
+      .querySelectorAll(options.acrossClears + " a")
+      .forEach(function (el) {
+        el.addEventListener("click", function (event) {
+          event.preventDefault();
+          options.parent.querySelector(".action-toggle").checked = false;
+          clearAcross(options);
+          checker(actionCheckboxes, options, false);
+          updateCounter(actionCheckboxes, options);
+        });
+      });
+
+    function affectedCheckboxes(target, withModifier) {
+      const multiSelect = lastChecked && withModifier && lastChecked !== target;
+      if (!multiSelect) {
+        return [target];
+      }
+      const checkboxes = Array.from(actionCheckboxes);
+      const targetIndex = checkboxes.findIndex((el) => el === target);
+      const lastCheckedIndex = checkboxes.findIndex((el) => el === lastChecked);
+      const startIndex = Math.min(targetIndex, lastCheckedIndex);
+      const endIndex = Math.max(targetIndex, lastCheckedIndex);
+      const filtered = checkboxes.filter(
+        (el, index) => startIndex <= index && index <= endIndex
+      );
+      return filtered;
+    }
+
+    const resultList = options.parent.querySelector(".result-list").tBodies;
+    Array.from(resultList).forEach(function (el) {
+      el.addEventListener("change", function (event) {
+        const target = event.target;
+        if (target.classList.contains("action-select")) {
+          const checkboxes = affectedCheckboxes(target, shiftPressed);
+          checker(checkboxes, options, target.checked);
+          updateCounter(actionCheckboxes, options);
+          lastChecked = target;
+        } else {
+          list_editable_changed = true;
+        }
+      });
+    });
+
+    options.parent
+      .querySelector("button[name=index]")
+      .addEventListener("click", function (event) {
+        if (list_editable_changed) {
+          const confirmed = confirm(
+            gettext(
+              "You have unsaved changes on individual editable fields. If you run an action, your unsaved changes will be lost."
+            )
+          );
+          if (!confirmed) {
+            event.preventDefault();
+          }
+        }
+      });
+
+    const el = options.parent.querySelector("input[name=_save]");
+
+    // The button does not exist if no fields are editable.
+    if (el) {
+      el.addEventListener("click", function (event) {
+        if (document.querySelector("[name=action]").value) {
+          const text = list_editable_changed
+            ? gettext(
+                "You have selected an action, but you haven’t saved your changes to individual fields yet. Please click OK to save. You’ll need to re-run the action."
+              )
+            : gettext(
+                "You have selected an action, and you haven’t made any changes on individual fields. You’re probably looking for the Go button rather than the Save button."
+              );
+          if (!confirm(text)) {
+            event.preventDefault();
+          }
+        }
+      });
+    }
+
+    // Sync counter when navigating to the page, such as through the back
+    // button.
+    window.addEventListener("pageshow", (event) =>
+      updateCounter(actionCheckboxes, options)
+    );
+  };
+
+  // Call function fn when the DOM is loaded and ready. If it is already
+  // loaded, call the function now.
+  // http://youmightnotneedjquery.com/#ready
+  function ready(fn) {
+    if (document.readyState !== "loading") {
+      fn();
+    } else {
+      document.addEventListener("DOMContentLoaded", fn);
+    }
+  }
+
+  ready(function () {
+    document.querySelectorAll(".result-list-wrapper").forEach(function (el) {
+      const actionsEls = el.querySelectorAll("tr input.action-select");
+
+      if (actionsEls.length > 0) {
+        Actions(actionsEls, {
+          parent: el,
+        });
+      }
+    });
+  });
+}