|
| 1 | +import io |
| 2 | +from typing import Any, Iterable |
| 3 | + |
| 4 | +from django.contrib import admin |
| 5 | +from django.contrib.admin.views.decorators import staff_member_required |
| 6 | +from django.contrib.auth.models import Group, Permission |
| 7 | +from django.db.models import Q |
| 8 | +from django.http import HttpRequest, HttpResponse |
| 9 | +from django.shortcuts import render |
| 10 | +from django.utils.translation import gettext_lazy as _ |
| 11 | +from openpyxl import Workbook |
| 12 | +from rest_framework import permissions, renderers, viewsets |
| 13 | +from rest_framework.response import Response |
| 14 | + |
| 15 | + |
| 16 | +def _user_has_access(user: Any) -> bool: |
| 17 | + """Allow superusers, regional admins, or users with Pending view permission.""" |
| 18 | + if not user.is_authenticated: |
| 19 | + return False |
| 20 | + if user.is_superuser: |
| 21 | + return True |
| 22 | + # Pending users permission (model view perm) |
| 23 | + if user.has_perm("registrations.view_pending"): |
| 24 | + return True |
| 25 | + # Regional admin via explicit relation or permission codename |
| 26 | + try: |
| 27 | + from api.models import UserRegion # inline import to avoid cycles |
| 28 | + |
| 29 | + if UserRegion.objects.filter(user=user).exists(): |
| 30 | + return True |
| 31 | + except Exception: |
| 32 | + pass |
| 33 | + # Fallback check: any perm codename starting with region_admin_ |
| 34 | + region_admin_perms = Permission.objects.filter(codename__startswith="region_admin_") |
| 35 | + if user.user_permissions.filter(id__in=region_admin_perms).exists(): |
| 36 | + return True |
| 37 | + if Group.objects.filter(id__in=user.groups.all()).filter(permissions__in=region_admin_perms).exists(): |
| 38 | + return True |
| 39 | + return False |
| 40 | + |
| 41 | + |
| 42 | +def _build_queryset(selected_group_ids: Iterable[int], include_superusers: bool): |
| 43 | + from django.contrib.auth import get_user_model |
| 44 | + |
| 45 | + User = get_user_model() |
| 46 | + |
| 47 | + qs = User.objects.all() |
| 48 | + |
| 49 | + # Build a single OR filter instead of union of QuerySets |
| 50 | + q = Q() |
| 51 | + if selected_group_ids: |
| 52 | + q |= Q(groups__in=selected_group_ids) |
| 53 | + if include_superusers: |
| 54 | + q |= Q(is_superuser=True) |
| 55 | + |
| 56 | + if q: |
| 57 | + qs = qs.filter(q) |
| 58 | + |
| 59 | + return qs.distinct().order_by("id") |
| 60 | + |
| 61 | + |
| 62 | +def _render_csv(users_qs) -> HttpResponse: |
| 63 | + import csv |
| 64 | + |
| 65 | + response = HttpResponse(content_type="text/csv") |
| 66 | + response["Content-Disposition"] = 'attachment; filename="users_per_permission.csv"' |
| 67 | + writer = csv.writer(response) |
| 68 | + writer.writerow(["ID", "Username", "Email", "Name", "Organization", "Active", "Staff"]) # headers |
| 69 | + for u in users_qs: |
| 70 | + name = f"{u.first_name} {u.last_name}".strip() |
| 71 | + org = getattr(getattr(u, "profile", None), "org", "") or "" |
| 72 | + writer.writerow([u.id, u.username, u.email, name, org, u.is_active, u.is_staff]) |
| 73 | + return response |
| 74 | + |
| 75 | + |
| 76 | +def _render_xlsx(users_qs) -> HttpResponse: |
| 77 | + from openpyxl.worksheet.worksheet import Worksheet |
| 78 | + |
| 79 | + wb = Workbook() |
| 80 | + ws: Worksheet = wb.active # type: ignore[assignment] |
| 81 | + # Avoid setting title if type checker is unsure |
| 82 | + try: |
| 83 | + ws.title = "Users" |
| 84 | + except Exception: |
| 85 | + pass |
| 86 | + headers = ["ID", "Username", "Email", "Name", "Organization", "Active", "Staff"] |
| 87 | + ws.append(headers) # type: ignore[attr-defined] |
| 88 | + for u in users_qs: |
| 89 | + name = f"{u.first_name} {u.last_name}".strip() |
| 90 | + org = getattr(getattr(u, "profile", None), "org", "") or "" |
| 91 | + row = [u.id, u.username, u.email, name, org, u.is_active, u.is_staff] |
| 92 | + ws.append(row) # type: ignore[attr-defined] |
| 93 | + |
| 94 | + buf = io.BytesIO() |
| 95 | + wb.save(buf) |
| 96 | + buf.seek(0) |
| 97 | + response = HttpResponse( |
| 98 | + buf.getvalue(), |
| 99 | + content_type="application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", |
| 100 | + ) |
| 101 | + response["Content-Disposition"] = 'attachment; filename="users_per_permission.xlsx"' |
| 102 | + return response |
| 103 | + |
| 104 | + |
| 105 | +REPORT_TITLE = _("Users per permission") |
| 106 | + |
| 107 | + |
| 108 | +@staff_member_required |
| 109 | +def users_per_permission_view(request: HttpRequest): |
| 110 | + # Gate access for staff who also meet custom criteria |
| 111 | + if not _user_has_access(request.user): |
| 112 | + return HttpResponse(status=403) |
| 113 | + |
| 114 | + context = admin.site.each_context(request) |
| 115 | + context.update( |
| 116 | + { |
| 117 | + "title": REPORT_TITLE, |
| 118 | + } |
| 119 | + ) |
| 120 | + |
| 121 | + all_groups = Group.objects.order_by("name") |
| 122 | + |
| 123 | + selected_group_ids = [int(gid) for gid in request.GET.getlist("groups") if gid.isdigit()] |
| 124 | + include_superusers = request.GET.get("include_superusers") == "1" |
| 125 | + export = request.GET.get("export") # "csv" | "xlsx" | None |
| 126 | + |
| 127 | + users_qs = _build_queryset(selected_group_ids, include_superusers) |
| 128 | + |
| 129 | + if export == "csv": |
| 130 | + return _render_csv(users_qs) |
| 131 | + if export == "xlsx": |
| 132 | + return _render_xlsx(users_qs) |
| 133 | + |
| 134 | + # Regular HTML render |
| 135 | + context.update( |
| 136 | + { |
| 137 | + "groups": all_groups, |
| 138 | + "selected_group_ids": selected_group_ids, |
| 139 | + "include_superusers": include_superusers, |
| 140 | + "users": users_qs[:500], # safety cap for UI |
| 141 | + "result_count": users_qs.count() if selected_group_ids or include_superusers else 0, |
| 142 | + } |
| 143 | + ) |
| 144 | + return render(request, "admin/users_per_permission.html", context) |
| 145 | + |
| 146 | + |
| 147 | +class UsersPerPermissionAccess(permissions.BasePermission): |
| 148 | + """DRF permission: allow only authenticated users that pass our custom access gate.""" |
| 149 | + |
| 150 | + def has_permission(self, request, view): # type: ignore[override] |
| 151 | + allowed = bool(request.user and request.user.is_authenticated and _user_has_access(request.user)) |
| 152 | + return True if allowed else False |
| 153 | + |
| 154 | + |
| 155 | +class UsersPerPermissionViewSet(viewsets.ViewSet): |
| 156 | + """Read-only endpoint that renders an admin-like page or exports CSV/XLSX.""" |
| 157 | + |
| 158 | + renderer_classes = [renderers.TemplateHTMLRenderer, renderers.JSONRenderer] |
| 159 | + permission_classes = [UsersPerPermissionAccess] |
| 160 | + |
| 161 | + def list(self, request: HttpRequest): |
| 162 | + all_groups = Group.objects.order_by("name") |
| 163 | + raw_groups = request.query_params.getlist("groups") |
| 164 | + try: |
| 165 | + selected_group_ids = [int(g) for g in raw_groups if g] |
| 166 | + except ValueError: |
| 167 | + selected_group_ids = [] |
| 168 | + |
| 169 | + include_superusers = str(request.query_params.get("include_superusers", "")).lower() in ("1", "true", "on", "yes") |
| 170 | + export = str(request.query_params.get("export", "")).lower() # <-- define export |
| 171 | + |
| 172 | + users_qs = _build_queryset(selected_group_ids, include_superusers) |
| 173 | + |
| 174 | + if export == "csv": |
| 175 | + return _render_csv(users_qs) |
| 176 | + if export == "xlsx": |
| 177 | + return _render_xlsx(users_qs) |
| 178 | + |
| 179 | + context = admin.site.each_context(request) |
| 180 | + context.update( |
| 181 | + { |
| 182 | + "title": REPORT_TITLE, |
| 183 | + "groups": all_groups, |
| 184 | + "selected_group_ids": selected_group_ids, |
| 185 | + "include_superusers": include_superusers, |
| 186 | + "users": users_qs[:500], |
| 187 | + "result_count": users_qs.count() if selected_group_ids or include_superusers else 0, |
| 188 | + } |
| 189 | + ) |
| 190 | + return Response(context, template_name="admin/users_per_permission.html") |
0 commit comments