Moved all templates to core/ prefix to allow overriding more easily.

TreyWW · TreyWW · commit dfa7ac011f0b · 2025-01-01T17:14:32.000Z
Added more core files like middleware and auth_backends to avoid duplication

Signed-off-by: Trey &lt;73353716+TreyWW@users.noreply.github.com&gt;
diff --git a/src/billing/decorators.py b/src/billing/decorators.py
@@ -22,7 +22,7 @@ def wrapper_func(request, *args, **kwargs):
                 messages.warning(request, f"Your plan unfortunately doesn't include this feature.")
 
                 if htmx_api:
-                    return render(request, "base/toast.html", {"autohide": False})
+                    return render(request, "core/base/toast.html", {"autohide": False})
                 elif request.htmx:
                     return HttpResponseRedirect(reverse("billing:dashboard"))
                 return redirect("billing:dashboard")
diff --git a/src/billing/middleware.py b/src/billing/middleware.py
@@ -45,6 +45,6 @@ def __call__(self, request: WebRequest):
             )
 
             if request.htmx:
-                return render(request, "base/toast.html", {"autohide": False})
+                return render(request, "core/base/toast.html", {"autohide": False})
             return redirect("billing:dashboard")
         return self.get_response(request)
diff --git a/src/billing/templates/pages/billing/dashboard/dashboard.html b/src/billing/templates/pages/billing/dashboard/dashboard.html
@@ -1,4 +1,4 @@
-{% extends base|default:"base/base.html" %}
+{% extends base|default:"core/base/base.html" %}
 {% load listfilters %}
 {% block content %}
     {% load get_first_n_items from listfilters %}
diff --git a/src/billing/views/change_plan.py b/src/billing/views/change_plan.py
@@ -29,11 +29,11 @@ def change_plan_endpoint(request: WebRequest):
 
     if not plan:
         messages.error(request, "Invalid plan")
-        return render(request, "base/toast.html")
+        return render(request, "core/base/toast.html")
     elif plan.price_per_month == -1 or plan.name.lower() == "enterprise":
         print("THIS PLAN IS ENTERPRISE, currently not implemented")
         messages.error(request, "Invalid plan (not yet implemented)")
-        return render(request, "base/toast.html")
+        return render(request, "core/base/toast.html")
 
     users_plans: QuerySet[UserSubscription] = UserSubscription.filter_by_owner(request.actor)
 
@@ -49,7 +49,7 @@ def change_plan_endpoint(request: WebRequest):
             </a>
         """,
         )
-        return render(request, "base/toast.html", {"autohide": False})
+        return render(request, "core/base/toast.html", {"autohide": False})
 
     users_active_plans: QuerySet[UserSubscription] = users_plans.filter(end_date__isnull=True)
     # if users_active_plans.exists():
diff --git a/src/core/api/base/notifications.py b/src/core/api/base/notifications.py
@@ -31,7 +31,7 @@ def delete_notification(request: HtmxHttpRequest, id: int):
     if notif is None or notif.user != request.user:
         if request.htmx:
             messages.error(request, "Notification not found")
-            return render(request, "base/toasts.html")
+            return render(request, "core/base/toasts.html")
         return HttpResponse(status=404, content="Notification not found")
 
     notif.delete()
diff --git a/src/core/api/emails/status.py b/src/core/api/emails/status.py
@@ -26,13 +26,13 @@ def get_status_view(request: HtmxHttpRequest, status_id: str) -> HttpResponse:
             EMAIL_STATUS = EmailSendStatus.objects.get(user=request.user, id=status_id)
     except EmailSendStatus.DoesNotExist:
         messages.error(request, "Status not found")
-        return render(request, "base/toast.html")
+        return render(request, "core/base/toast.html")
 
     message_insight = get_message_insights(message_id=EMAIL_STATUS.aws_message_id)  # type: ignore[arg-type]
 
     if isinstance(message_insight, str):
         messages.error(request, message_insight)
-        return render(request, "base/toast.html", {"autohide": False})
+        return render(request, "core/base/toast.html", {"autohide": False})
 
     important_info = get_important_info_from_response(message_insight)
 
@@ -41,7 +41,7 @@ def get_status_view(request: HtmxHttpRequest, status_id: str) -> HttpResponse:
     EMAIL_STATUS.save()
 
     messages.success(request, f"Status updated to {important_info['status']}")
-    return render(request, "base/toast.html", {"autohide": False})
+    return render(request, "core/base/toast.html", {"autohide": False})
 
 
 @require_POST
@@ -52,7 +52,7 @@ def refresh_all_statuses_view(request: HtmxHttpRequest) -> HttpResponse:
         request, group="email-refresh_all_statuses", key="user", rate="1/m", increment=True
     ):
         messages.error(request, "Woah, slow down! Refreshing the statuses takes a while, give us a break!")
-        return render(request, "base/toast.html")
+        return render(request, "core/base/toast.html")
     if request.user.logged_in_as_team:
         ALL_STATUSES = EmailSendStatus.objects.filter(organization=request.user.logged_in_as_team)
     else:
diff --git a/src/core/api/quotas/requests.py b/src/core/api/quotas/requests.py
@@ -52,7 +52,7 @@ def submit_request(request: HtmxHttpRequest, slug) -> HttpResponse:
     QuotaUsage.create_str(request.user, "quota_increase-requests_per_month_per_quota", quota_limit.id)
 
     messages.success(request, "Successfully submitted a quota increase request")
-    return render(request, "base/toast.html")
+    return render(request, "core/base/toast.html")
 
 
 @dataclass
diff --git a/src/core/api/settings/api_keys.py b/src/core/api/settings/api_keys.py
@@ -37,7 +37,7 @@ def generate_api_key_endpoint(request: WebRequest) -> HttpResponse:
 
     if not key_obj:
         messages.error(request, key_response)
-        return render(request, "base/toast.html")
+        return render(request, "core/base/toast.html")
 
     messages.success(request, "API key generated successfully")
 
@@ -66,4 +66,4 @@ def revoke_api_key_endpoint(request: WebRequest, key_id: str) -> HttpResponse:
         messages.error(request, "This key does not exist")
     else:
         messages.success(request, "Successfully revoked the API Key")
-    return render(request, "base/toast.html")
+    return render(request, "core/base/toast.html")
diff --git a/src/core/api/settings/change_name.py b/src/core/api/settings/change_name.py
@@ -11,7 +11,7 @@ def change_account_name(request: HtmxHttpRequest):
     if not request.htmx:
         return HttpResponse("Invalid Request", status=405)
 
-    htmx_return = "base/toasts.html"
+    htmx_return = "core/base/toasts.html"
 
     first_name = request.POST.get("first_name")
     last_name = request.POST.get("last_name")
diff --git a/src/core/api/settings/preferences.py b/src/core/api/settings/preferences.py
@@ -14,7 +14,7 @@ def update_account_preferences(request):
     except UserSettings.DoesNotExist:
         usersettings = UserSettings.objects.create(user=request.user)
 
-    htmx_return = "base/toasts.html"
+    htmx_return = "core/base/toasts.html"
 
     if not request.htmx and not currency:
         return HttpResponse("Invalid Request", status=400)
diff --git a/src/core/api/teams/create_user.py b/src/core/api/teams/create_user.py
@@ -16,11 +16,11 @@ def create_user_endpoint(request: WebRequest):
 
     if not team:
         messages.error(request, "This team does not exist")
-        return render(request, "base/toast.html")
+        return render(request, "core/base/toast.html")
 
     if not team.is_owner(request.user):
         messages.error(request, "Only the team owner can create users")
-        return render(request, "base/toast.html")
+        return render(request, "core/base/toast.html")
 
     first_name = request.POST.get("first_name", "")
     last_name = request.POST.get("last_name", "")
@@ -31,7 +31,7 @@ def create_user_endpoint(request: WebRequest):
 
     if created_user.failed:
         messages.error(request, created_user.error)
-        return render(request, "base/toast.html")
+        return render(request, "core/base/toast.html")
     else:
         messages.success(request, f"The account for {first_name} was created successfully. They have been emailed instructions.")
-    return render(request, "base/toast.html")
+    return render(request, "core/base/toast.html")
diff --git a/src/core/api/teams/edit_permissions.py b/src/core/api/teams/edit_permissions.py
@@ -20,12 +20,12 @@ def edit_user_permissions_endpoint(request: WebRequest) -> HttpResponse:
 
     if not receiver:
         messages.error(request, "Invalid user")
-        return render(request, "base/toast.html")
+        return render(request, "core/base/toast.html")
 
     edit_response = edit_member_permissions(receiver, request.user.logged_in_as_team, permissions)
 
     if edit_response.success:
         messages.success(request, "User permissions saved successfully")
     else:
         messages.error(request, edit_response.error)
-    return render(request, "base/toast.html")
+    return render(request, "core/base/toast.html")
diff --git a/src/core/api/teams/switch_team.py b/src/core/api/teams/switch_team.py
@@ -50,4 +50,4 @@ def get_dropdown(request: HtmxHttpRequest):
     if not request.htmx:
         return HttpResponse("Invalid Request", status=405)
 
-    return render(request, "base/topbar/_organizations_list.html")
+    return render(request, "core/base/topbar/_organizations_list.html")
diff --git a/src/core/api/urls.py b/src/core/api/urls.py
@@ -4,7 +4,7 @@
 from django.urls import path
 
 urlpatterns = [
-    path("base/", include("core.api.base.urls")),
+    path("core/base/", include("core.api.base.urls")),
     path("teams/", include("core.api.teams.urls")),
     path("settings/", include("core.api.settings.urls")),
     path("quotas/", include("core.api.quotas.urls")),
diff --git a/src/core/auth_backends.py b/src/core/auth_backends.py
@@ -0,0 +1,22 @@
+from django.contrib.auth import get_user_model
+from django.contrib.auth.backends import ModelBackend
+
+
+class EmailInsteadOfUsernameBackend(ModelBackend):
+    def authenticate(self, request, username=None, password=None, **kwargs):
+        UserModel = get_user_model()
+
+        if username is None or password is None:
+            return
+
+        try:
+            user = UserModel.objects.get(email=username)
+        except UserModel.DoesNotExist:
+            # Run the default password hasher once to reduce the timing
+            # difference between an existing and a nonexistent user (#20760).
+            UserModel().set_password(password)
+            return None
+        else:
+            if user.check_password(password):
+                return user
+        return None
diff --git a/src/core/config.py b/src/core/config.py
@@ -1,3 +1,4 @@
+import os
 from typing import Dict, List
 
 from django.conf import settings
@@ -49,9 +50,10 @@ def __init__(self):
     def _setup(self):
         from django.conf import settings
 
-        user_options = {option[5:]: getattr(settings, option) for option in dir(settings) if option.startswith("CORE_")}
+        django_settings_options = {option[5:]: getattr(settings, option) for option in dir(settings) if option.startswith("CORE_")}
+        environ_options = {key: value for key, value in os.environ.items() if key.startswith("CORE_")}
 
-        for key, value in user_options.items():
+        for key, value in {**django_settings_options, **environ_options}.items():
             if hasattr(self, key):
                 setattr(self, key, value)
 
diff --git a/src/core/context_processors.py b/src/core/context_processors.py
@@ -0,0 +1,74 @@
+import os
+from typing import List, Optional, Dict, Any
+
+from core.service.base.breadcrumbs import get_breadcrumbs
+from django.http import HttpRequest
+from django.urls import reverse
+
+import calendar
+
+from core.utils.settings_helper import BASE_DIR, get_var
+
+from core import __version__
+
+
+## Context processors need to be put in SETTINGS TEMPLATES to be recognized
+def navbar(request):
+    # cached_navbar_items = cache.get("navbar_items")
+
+    # if cached_navbar_items is None:
+    #     navbar_items = load_navbar_items()
+    #
+    #     # Cache the sidebar items for a certain time (e.g., 3600 seconds = 1 hr)
+    #     cache.set("navbar_items", navbar_items, 60 * 60 * 3)  # 3 hrs
+    # else:
+    #     navbar_items = cached_navbar_items
+    # context = {"navbar_items": navbar_items}
+    return {}
+
+
+def extras(request: HttpRequest):
+    # import_method can be one of: "webpack", "public_cdn", "custom_cdn"
+    data: Dict[str, Any] = {}
+
+    import pathlib
+
+    def get_git_revision(base_path):
+        if not get_var("DEBUG", "").lower() == "true":
+            return "prod"
+
+        git_dir = pathlib.Path(base_path) / ".git"
+
+        # check file exists
+
+        if not git_dir.exists() or not git_dir.is_dir() or not (git_dir / "HEAD").exists():
+            return "commit not found"
+
+        with (git_dir / "HEAD").open("r") as head:
+            ref = head.readline().split(" ")[-1].strip()
+
+        if not (git_dir / ref).exists():
+            return "commit not found"
+
+        with (git_dir / ref).open("r") as git_hash:
+            return git_hash.readline().strip()
+
+    data["core_version"] = __version__
+    data["git_branch"] = get_var("BRANCH")
+    data["git_version"] = get_git_revision(BASE_DIR)
+    data["import_method"] = get_var("IMPORT_METHOD", default="webpack")
+    data["analytics"] = get_var("ANALYTICS_STRING")
+    data["calendar_util"] = calendar
+    data["day_names_sunday_first"] = [calendar.day_name[(i + 6) % 7] for i in range(7)]
+    data["day_names_monday_first"] = [day for day in calendar.day_name]
+
+    if hasattr(request, "htmx") and request.htmx.boosted:
+        data["base"] = "core/base/htmx.html"
+    else:
+        data["base"] = "core/base/base.html"
+
+    return data
+
+
+def breadcrumbs(request: HttpRequest):
+    return get_breadcrumbs(request=request)
diff --git a/src/core/middleware.py b/src/core/middleware.py
@@ -0,0 +1,74 @@
+from django.contrib.auth.models import AnonymousUser
+from django.utils.deprecation import MiddlewareMixin
+from django.contrib.auth import get_user
+from django.db import connection, OperationalError
+from django.http import HttpResponse
+
+from core.models import User
+from core.types.htmx import HtmxAnyHttpRequest
+from core.types.requests import WebRequest
+
+
+class HealthCheckMiddleware:
+    def __init__(self, get_response):
+        self.get_response = get_response
+
+    def __call__(self, request):
+        if request.path == "/api/hc/healthcheck/":
+            try:
+                status = connection.ensure_connection()
+            except OperationalError:
+                status = "error"
+
+            if not status:  # good
+                return HttpResponse(status=200, content="All operations are up and running!")
+            return HttpResponse(status=503, content="Service Unavailable")
+        return self.get_response(request)
+
+
+class HTMXPartialLoadMiddleware:
+    def __init__(self, get_response):
+        self.get_response = get_response
+
+    def __call__(self, request: HtmxAnyHttpRequest):
+        response: HttpResponse = self.get_response(request)
+
+        if hasattr(response, "retarget"):
+            response.headers["HX-Retarget"] = response.retarget
+        elif request.htmx.boosted and not response.headers.get("HX-Retarget") and not hasattr(response, "no_retarget"):
+            response.headers["HX-Retarget"] = "#main_content"
+            response.headers["HX-Reswap"] = "innerHTML"
+            # if 'data-layout="breadcrumbs"' not in str(response.content):
+            response.headers["HX-Trigger"] = "update_breadcrumbs"
+        return response
+
+
+class LastVisitedMiddleware:
+    def __init__(self, get_response):
+        self.get_response = get_response
+
+    def __call__(self, request):
+        if request.method == "GET" and "text/html" in request.headers.get("Accept", ""):
+            try:
+                request.session["last_visited"] = request.session["currently_visiting"]
+            except KeyError:
+                pass
+            current_url = request.build_absolute_uri()
+            request.session["currently_visiting"] = current_url
+        return self.get_response(request)
+
+
+class CustomUserMiddleware(MiddlewareMixin):
+    def process_request(self, request: WebRequest):
+        user = get_user(request)
+
+        # Replace request.user with CustomUser instance if authenticated
+        if user.is_authenticated:
+            request.user = User.objects.get(pk=user.pk)
+            request.team = request.user.logged_in_as_team or None
+            request.team_id = request.team.id if request.team else None
+            request.actor = request.team or request.user
+        else:
+            # If user is not authenticated, set request.user to AnonymousUser
+            request.user = AnonymousUser()  # type: ignore[assignment]
+            request.actor = request.user
diff --git a/src/core/models.py b/src/core/models.py
@@ -420,6 +420,19 @@ def has_access(self, user: User) -> bool:
             return self.user == user
 
 
+class DefaultValuesBase(OwnerBase):
+    currency = models.CharField(
+        max_length=3,
+        default="GBP",
+        choices=[(code, info["name"]) for code, info in UserSettings.CURRENCIES.items()],
+    )
+
+    client = models.OneToOneField(Client, on_delete=models.CASCADE, related_name="default_values", null=True, blank=True)
+
+    class Meta:
+        abstract = True
+
+
 class Notification(models.Model):
     action_choices = [
         ("normal", "Normal"),
diff --git a/src/core/templates/core/settings/main.html b/src/core/templates/core/settings/main.html
diff --git a/src/core/templates/core/settings/teams/leave.html b/src/core/templates/core/settings/teams/leave.html
diff --git a/src/core/templates/core/settings/teams/login_to_team.html b/src/core/templates/core/settings/teams/login_to_team.html
diff --git a/src/core/templates/core/settings/teams/main.html b/src/core/templates/core/settings/teams/main.html
diff --git a/src/core/templates/core/settings/teams/permissions.html b/src/core/templates/core/settings/teams/permissions.html
diff --git a/src/core/utils/quota_limit_ops.py b/src/core/utils/quota_limit_ops.py
diff --git a/src/core/views/auth/login.py b/src/core/views/auth/login.py

Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,6 @@ def __call__(self, request: WebRequest):`
`45`	`45`	`)`
`46`	`46`
`47`	`47`	`if request.htmx:`
`48`		`- return render(request, "base/toast.html", {"autohide": False})`
	`48`	`+ return render(request, "core/base/toast.html", {"autohide": False})`
`49`	`49`	`return redirect("billing:dashboard")`
`50`	`50`	`return self.get_response(request)`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-{% extends base\|default:"base/base.html" %}`
	`1`	`+{% extends base\|default:"core/base/base.html" %}`
`2`	`2`	`{% load listfilters %}`
`3`	`3`	`{% block content %}`
`4`	`4`	`{% load get_first_n_items from listfilters %}`