Add user and request context for admin class (#125)

* Add user and request context for admin class

* Fix comments

Author: vsdudakov

docs/build.py

@@ -44,7 +44,10 @@ def get_versions():
     return [
         {
             "version": "0.3.4",
-            "changes": ["Fix sort by and search by relations. Fix examples."],
+            "changes": [
+                "Fix sort by and search by relations. Fix examples.",
+                "Add request/user context on BaseModelAdmin for per-request custom logic.",
+            ],
         },
         {
             "version": "0.3.3",
@@ -589,6 +592,25 @@ def get_page_context(page_url):
                     "content": "The following methods and attributes are available for model admins:",
                 },
                 {"type": "code-python", "content": inspect.getsource(BaseModelAdmin)},
+                {
+                    "type": "alert-info",
+                    "content": "Use <code>self.request</code> and <code>self.user</code> in your admin methods (permissions, save hooks, actions) to access request-scoped context.",
+                },
+                {
+                    "type": "code-python",
+                    "content": """class EventAdmin(TortoiseModelAdmin):
+    async def has_change_permission(self, user_id=None):
+        # request/user are available for current request context
+        if self.user and self.user.get("is_superuser"):
+            return True
+        return False
+
+    async def save_model(self, id, payload):
+        if self.request:
+            payload["changed_from_ip"] = getattr(self.request, "client", None)
+        return await super().save_model(id, payload)
+""",
+                },
                 {
                     "type": "text",
                     "content": "Model-admin-specific methods and attributes:",

docs/index.html

@@ -2058,6 +2058,9 @@ <h3>Methods and Attributes</h3>
 class BaseModelAdmin:
     """Base class for model admin"""
 
+    _request_context: ContextVar[Any | None]
+    _user_context: ContextVar[Any | None]
+
     # Use it only if you use several orms in your project.
     model_name_prefix: str | None = None
 
@@ -2240,6 +2243,23 @@ <h3>Methods and Attributes</h3>
         :params model_cls: an orm/db model class.
         """
         self.model_cls = model_cls
+        self._request_context = ContextVar(f"fastadmin_admin_request_context_{id(self)}", default=None)
+        self._user_context = ContextVar(f"fastadmin_admin_user_context_{id(self)}", default=None)
+
+    @property
+    def request(self) -> Any | None:
+        """Current request object for this async context."""
+        return self._request_context.get()
+
+    @property
+    def user(self) -> Any | None:
+        """Current authenticated user object for this async context."""
+        return self._user_context.get()
+
+    def set_context(self, request: Any | None = None, user: Any | None = None) -> None:
+        """Set request/user context for the current async task."""
+        self._request_context.set(request)
+        self._user_context.set(user)
 
     @staticmethod
     def get_model_pk_name(orm_model_cls: Any) -> str:
@@ -2664,6 +2684,55 @@ <h3>Methods and Attributes</h3>
 
 
 
+
+
+
+
+<p class="alert alert-info">
+  Use <code>self.request</code> and <code>self.user</code> in your admin methods (permissions, save hooks, actions) to access request-scoped context.
+</p>
+
+
+
+
+
+
+
+
+
+                
+                  
+
+
+
+
+
+
+
+
+
+
+<pre>
+  <code class="language-python">
+class EventAdmin(TortoiseModelAdmin):
+    async def has_change_permission(self, user_id=None):
+        # request/user are available for current request context
+        if self.user and self.user.get("is_superuser"):
+            return True
+        return False
+
+    async def save_model(self, id, payload):
+        if self.request:
+            payload["changed_from_ip"] = getattr(self.request, "client", None)
+        return await super().save_model(id, payload)
+
+  </code>
+</pre>
+
+
+
+                
+                  
 <p class="text-4">
   Model-admin-specific methods and attributes:
 </p>
@@ -3342,6 +3411,24 @@ <h3>v0.3.4</h3>
 
 
 
+                  
+<p class="text-4">
+  Add request/user context on BaseModelAdmin for per-request custom logic.
+</p>
+
+
+
+
+
+
+
+
+
+
+
+
+
+                
                 </section>
 
 

fastadmin/api/frameworks/django/app/api.py

@@ -64,6 +64,7 @@ async def sign_in(request: HttpRequest) -> JsonResponse:
         session_id = await api_service.sign_in(
             request.COOKIES.get(settings.ADMIN_SESSION_ID_KEY, None),
             payload,
+            request=request,
         )
 
         response = JsonResponse({})
@@ -111,7 +112,10 @@ async def me(request: HttpRequest) -> JsonResponse:
         if not user_id:
             raise AdminApiException(401, "User is not authenticated.")
         obj = await api_service.get(
-            request.COOKIES.get(settings.ADMIN_SESSION_ID_KEY, None), settings.ADMIN_USER_MODEL, user_id
+            request.COOKIES.get(settings.ADMIN_SESSION_ID_KEY, None),
+            settings.ADMIN_USER_MODEL,
+            user_id,
+            request=request,
         )
         return JsonResponse(obj)
 
@@ -143,6 +147,7 @@ async def dashboard_widget(request: HttpRequest, model: str) -> JsonResponse:
             min_x_field=min_x_field,
             max_x_field=max_x_field,
             period_x_field=period_x_field,
+            request=request,
         )
         return JsonResponse(data)
     except AdminApiException as e:
@@ -182,6 +187,7 @@ async def list_objs(request: HttpRequest, model: str) -> JsonResponse:
             filters=list_filters,
             offset=offset,
             limit=limit,
+            request=request,
         )
         return JsonResponse(
             {
@@ -212,6 +218,7 @@ async def get(request: HttpRequest, model: str, id: UUID | int | str) -> JsonRes
             request.COOKIES.get(settings.ADMIN_SESSION_ID_KEY, None),
             model,
             id,
+            request=request,
         )
         return JsonResponse(obj)
 
@@ -234,6 +241,7 @@ async def add(request: HttpRequest, model: str) -> JsonResponse:
             request.COOKIES.get(settings.ADMIN_SESSION_ID_KEY, None),
             model,
             json.loads(request.body),
+            request=request,
         )
         return JsonResponse(obj)
     except AdminApiException as e:
@@ -257,6 +265,7 @@ async def change_password(request: HttpRequest, id: UUID | int | str) -> JsonRes
             request.COOKIES.get(settings.ADMIN_SESSION_ID_KEY, None),
             id,
             json.loads(request.body),
+            request=request,
         )
         return JsonResponse(id, safe=False)
 
@@ -283,6 +292,7 @@ async def change(request: HttpRequest, model: str, id: UUID | int | str) -> Json
             model,
             id,
             json.loads(request.body),
+            request=request,
         )
         return JsonResponse(obj)
 
@@ -319,6 +329,7 @@ async def export(request: HttpRequest, model: str) -> JsonResponse:
             search=search,
             sort_by=sort_by,
             filters=list_filters,
+            request=request,
         )
         response = StreamingHttpResponse(stream, content_type=content_type)
         response.headers["Content-Disposition"] = f'attachment; filename="{file_name}"'
@@ -349,6 +360,7 @@ async def delete(
             request.COOKIES.get(settings.ADMIN_SESSION_ID_KEY, None),
             model,
             id,
+            request=request,
         )
         return JsonResponse(deleted_id, safe=False)
 
@@ -378,6 +390,7 @@ async def action(
             model,
             action,
             payload,
+            request=request,
         )
         return JsonResponse({})
 
@@ -397,5 +410,6 @@ async def configuration(request: HttpRequest) -> JsonResponse:
 
     obj = await api_service.get_configuration(
         request.COOKIES.get(settings.ADMIN_SESSION_ID_KEY, None),
+        request=request,
     )
     return JsonResponse(asdict(obj))

fastadmin/api/frameworks/fastapi/api.py

@@ -35,6 +35,7 @@ async def sign_in(
         session_id = await api_service.sign_in(
             request.cookies.get(settings.ADMIN_SESSION_ID_KEY, None),
             payload,
+            request=request,
         )
 
         response.set_cookie(settings.ADMIN_SESSION_ID_KEY, value=session_id, httponly=True)
@@ -78,7 +79,10 @@ async def me(
         if not user_id:
             raise AdminApiException(401, "User is not authenticated.")
         return await api_service.get(
-            request.cookies.get(settings.ADMIN_SESSION_ID_KEY, None), settings.ADMIN_USER_MODEL, user_id
+            request.cookies.get(settings.ADMIN_SESSION_ID_KEY, None),
+            settings.ADMIN_USER_MODEL,
+            user_id,
+            request=request,
         )
     except AdminApiException as e:
         raise HTTPException(e.status_code, detail=e.detail) from None
@@ -107,6 +111,7 @@ async def dashboard_widget(
             min_x_field=min_x_field,
             max_x_field=max_x_field,
             period_x_field=period_x_field,
+            request=request,
         )
         return data
     except AdminApiException as e:
@@ -146,6 +151,7 @@ async def list_objs(
             filters=list_filters,
             offset=offset,
             limit=limit,
+            request=request,
         )
         return {
             "total": total,
@@ -172,6 +178,7 @@ async def get(
             request.cookies.get(settings.ADMIN_SESSION_ID_KEY, None),
             model,
             id,
+            request=request,
         )
     except AdminApiException as e:
         raise HTTPException(e.status_code, detail=e.detail) from None
@@ -194,6 +201,7 @@ async def add(
             request.cookies.get(settings.ADMIN_SESSION_ID_KEY, None),
             model,
             payload,
+            request=request,
         )
     except AdminApiException as e:
         raise HTTPException(e.status_code, detail=e.detail) from None
@@ -212,7 +220,12 @@ async def change_password(
     :return: An object.
     """
     try:
-        await api_service.change_password(request.cookies.get(settings.ADMIN_SESSION_ID_KEY, None), id, payload)
+        await api_service.change_password(
+            request.cookies.get(settings.ADMIN_SESSION_ID_KEY, None),
+            id,
+            payload,
+            request=request,
+        )
         return id
     except AdminApiException as e:
         raise HTTPException(e.status_code, detail=e.detail) from None
@@ -233,7 +246,13 @@ async def change(
     :return: An object.
     """
     try:
-        return await api_service.change(request.cookies.get(settings.ADMIN_SESSION_ID_KEY, None), model, id, payload)
+        return await api_service.change(
+            request.cookies.get(settings.ADMIN_SESSION_ID_KEY, None),
+            model,
+            id,
+            payload,
+            request=request,
+        )
     except AdminApiException as e:
         raise HTTPException(e.status_code, detail=e.detail) from None
 
@@ -268,6 +287,7 @@ async def export(
             search=search,
             sort_by=sort_by,
             filters=list_filters,
+            request=request,
         )
         headers = {"Content-Disposition": f'attachment; filename="{file_name}"'}
         return StreamingResponse(
@@ -296,6 +316,7 @@ async def delete(
             request.cookies.get(settings.ADMIN_SESSION_ID_KEY, None),
             model,
             id,
+            request=request,
         )
     except AdminApiException as e:
         raise HTTPException(e.status_code, detail=e.detail) from None
@@ -321,6 +342,7 @@ async def action(
             model,
             action,
             payload,
+            request=request,
         )
     except AdminApiException as e:
         raise HTTPException(e.status_code, detail=e.detail) from None
@@ -337,4 +359,5 @@ async def configuration(
     """
     return await api_service.get_configuration(
         request.cookies.get(settings.ADMIN_SESSION_ID_KEY, None),
+        request=request,
     )