feat: Audit log add operation object (#2681)

Author: shaohuzhang1

apps/application/views/application_version_views.py

@@ -13,6 +13,7 @@
 
 from application.serializers.application_version_serializers import ApplicationVersionSerializer
 from application.swagger_api.application_version_api import ApplicationVersionApi
+from application.views import get_application_operation_object
 from common.auth import has_permissions, TokenAuth
 from common.constants.permission_constants import PermissionConstants, CompareConstants, ViewPermission, RoleConstants, \
     Permission, Group, Operate
@@ -31,7 +32,6 @@ class ApplicationVersionView(APIView):
                          responses=result.get_api_array_response(ApplicationVersionApi.get_response_body_api()),
                          tags=[_('Application/Version')])
     @has_permissions(PermissionConstants.APPLICATION_READ, compare=CompareConstants.AND)
-    @log(menu='Application', operate="Get the application list")
     def get(self, request: Request, application_id: str):
         return result.success(
             ApplicationVersionSerializer.Query(
@@ -49,7 +49,6 @@ class Page(APIView):
                              responses=result.get_page_api_response(ApplicationVersionApi.get_response_body_api()),
                              tags=[_('Application/Version')])
         @has_permissions(PermissionConstants.APPLICATION_READ, compare=CompareConstants.AND)
-        @log(menu='Application', operate="Get the list of application versions by page")
         def get(self, request: Request, application_id: str, current_page: int, page_size: int):
             return result.success(
                 ApplicationVersionSerializer.Query(
@@ -67,7 +66,6 @@ class Operate(APIView):
                              responses=result.get_api_response(ApplicationVersionApi.get_response_body_api()),
                              tags=[_('Application/Version')])
         @has_permissions(PermissionConstants.APPLICATION_READ, compare=CompareConstants.AND)
-        @log(menu='Application', operate="Get application version details")
         def get(self, request: Request, application_id: str, work_flow_version_id: str):
             return result.success(
                 ApplicationVersionSerializer.Operate(
@@ -86,7 +84,8 @@ def get(self, request: Request, application_id: str, work_flow_version_id: str):
             [lambda r, keywords: Permission(group=Group.APPLICATION, operate=Operate.MANAGE,
                                             dynamic_tag=keywords.get('application_id'))],
             compare=CompareConstants.AND))
-        @log(menu='Application', operate="Modify application version information")
+        @log(menu='Application', operate="Modify application version information",
+             get_operation_object=lambda r, k: get_application_operation_object(k.get('application_id')))
         def put(self, request: Request, application_id: str, work_flow_version_id: str):
             return result.success(
                 ApplicationVersionSerializer.Operate(

apps/application/views/application_views.py

@@ -19,6 +19,7 @@
 from application.serializers.chat_serializers import ChatSerializers, ChatRecordSerializer
 from application.swagger_api.chat_api import ChatApi, VoteApi, ChatRecordApi, ImproveApi, ChatRecordImproveApi, \
     ChatClientHistoryApi, OpenAIChatApi
+from application.views import get_application_operation_object
 from common.auth import TokenAuth, has_permissions, OpenAIKeyAuth
 from common.constants.authentication_type import AuthenticationType
 from common.constants.permission_constants import Permission, Group, Operate, \
@@ -178,7 +179,8 @@ class Operate(APIView):
                                             dynamic_tag=keywords.get('application_id'))],
             compare=CompareConstants.AND),
             compare=CompareConstants.AND)
-        @log(menu='Application/Conversation Log', operate="Delete a conversation")
+        @log(menu='Application/Conversation Log', operate="Delete a conversation",
+             get_operation_object=lambda r, k: get_application_operation_object(k.get('application_id')))
         def delete(self, request: Request, application_id: str, chat_id: str):
             return result.success(
                 ChatSerializers.Operate(
@@ -201,7 +203,6 @@ class ClientChatHistoryPage(APIView):
                            [lambda r, keywords: Permission(group=Group.APPLICATION, operate=Operate.USE,
                                                            dynamic_tag=keywords.get('application_id'))])
         )
-        @log(menu='Application/Conversation Log', operate="Get client conversation list by paging")
         def get(self, request: Request, application_id: str, current_page: int, page_size: int):
             return result.success(ChatSerializers.ClientChatHistory(
                 data={'client_id': request.auth.client_id, 'application_id': application_id}).page(
@@ -221,7 +222,8 @@ class Operate(APIView):
                                                 dynamic_tag=keywords.get('application_id'))],
                 compare=CompareConstants.AND),
                 compare=CompareConstants.AND)
-            @log(menu='Application/Conversation Log', operate="Client deletes conversation")
+            @log(menu='Application/Conversation Log', operate="Client deletes conversation",
+                 get_operation_object=lambda r, k: get_application_operation_object(k.get('application_id')))
             def delete(self, request: Request, application_id: str, chat_id: str):
                 return result.success(
                     ChatSerializers.Operate(
@@ -239,7 +241,8 @@ def delete(self, request: Request, application_id: str, chat_id: str):
                                                 dynamic_tag=keywords.get('application_id'))],
                 compare=CompareConstants.AND),
                 compare=CompareConstants.AND)
-            @log(menu='Application/Conversation Log', operate="Client modifies dialogue summary")
+            @log(menu='Application/Conversation Log', operate="Client modifies dialogue summary",
+                 get_operation_object=lambda r, k: get_application_operation_object(k.get('application_id')))
             def put(self, request: Request, application_id: str, chat_id: str):
                 return result.success(
                     ChatSerializers.Operate(
@@ -261,7 +264,6 @@ class Page(APIView):
                            [lambda r, keywords: Permission(group=Group.APPLICATION, operate=Operate.USE,
                                                            dynamic_tag=keywords.get('application_id'))])
         )
-        @log(menu='Application/Conversation Log', operate="Get the conversation list by page")
         def get(self, request: Request, application_id: str, current_page: int, page_size: int):
             return result.success(ChatSerializers.Query(
                 data={**query_params_to_single_dict(request.query_params), 'application_id': application_id,
@@ -287,7 +289,6 @@ class Operate(APIView):
                                [lambda r, keywords: Permission(group=Group.APPLICATION, operate=Operate.USE,
                                                                dynamic_tag=keywords.get('application_id'))])
             )
-            @log(menu='Application/Conversation Log', operate="Get conversation record details")
             def get(self, request: Request, application_id: str, chat_id: str, chat_record_id: str):
                 return result.success(ChatRecordSerializer.Operate(
                     data={'application_id': application_id,
@@ -306,7 +307,6 @@ def get(self, request: Request, application_id: str, chat_id: str, chat_record_i
                            [lambda r, keywords: Permission(group=Group.APPLICATION, operate=Operate.USE,
                                                            dynamic_tag=keywords.get('application_id'))])
         )
-        @log(menu='Application/Conversation Log', operate="Get a list of conversation records")
         def get(self, request: Request, application_id: str, chat_id: str):
             return result.success(ChatRecordSerializer.Query(
                 data={'application_id': application_id,
@@ -328,7 +328,6 @@ class Page(APIView):
                                [lambda r, keywords: Permission(group=Group.APPLICATION, operate=Operate.USE,
                                                                dynamic_tag=keywords.get('application_id'))])
             )
-            @log(menu='Application/Conversation Log', operate="Get the conversation history list by page")
             def get(self, request: Request, application_id: str, chat_id: str, current_page: int, page_size: int):
                 return result.success(ChatRecordSerializer.Query(
                     data={'application_id': application_id,
@@ -352,7 +351,8 @@ class Vote(APIView):
                                [lambda r, keywords: Permission(group=Group.APPLICATION, operate=Operate.USE,
                                                                dynamic_tag=keywords.get('application_id'))])
             )
-            @log(menu='Application/Conversation Log', operate="Like, Dislike")
+            @log(menu='Application/Conversation Log', operate="Like, Dislike",
+                 get_operation_object=lambda r, k: get_application_operation_object(k.get('application_id')))
             def put(self, request: Request, application_id: str, chat_id: str, chat_record_id: str):
                 return result.success(ChatRecordSerializer.Vote(
                     data={'vote_status': request.data.get('vote_status'), 'chat_id': chat_id,
@@ -373,7 +373,6 @@ class ChatRecordImprove(APIView):
                                [lambda r, keywords: Permission(group=Group.APPLICATION, operate=Operate.USE,
                                                                dynamic_tag=keywords.get('application_id'))]
                                ))
-            @log(menu='Application/Conversation Log', operate="Get the list of marked paragraphs")
             def get(self, request: Request, application_id: str, chat_id: str, chat_record_id: str):
                 return result.success(ChatRecordSerializer.ChatRecordImprove(
                     data={'chat_id': chat_id, 'chat_record_id': chat_record_id}).get())
@@ -401,7 +400,8 @@ class Improve(APIView):
                                                                                      'dataset_id'))],
                                                  compare=CompareConstants.AND
                                                  ), compare=CompareConstants.AND)
-            @log(menu='Application/Conversation Log', operate="Annotation")
+            @log(menu='Application/Conversation Log', operate="Annotation",
+                 get_operation_object=lambda r, k: get_application_operation_object(k.get('application_id')))
             def put(self, request: Request, application_id: str, chat_id: str, chat_record_id: str, dataset_id: str,
                     document_id: str):
                 return result.success(ChatRecordSerializer.Improve(
@@ -427,7 +427,8 @@ def put(self, request: Request, application_id: str, chat_id: str, chat_record_i
                                                                                      'dataset_id'))],
                                                  compare=CompareConstants.AND
                                                  ), compare=CompareConstants.AND)
-            @log(menu='Application/Conversation Log', operate="Add to Knowledge Base")
+            @log(menu='Application/Conversation Log', operate="Add to Knowledge Base",
+                 get_operation_object=lambda r, k: get_application_operation_object(k.get('application_id')))
             def post(self, request: Request, application_id: str, dataset_id: str):
                 return result.success(ChatRecordSerializer.PostImprove().post_improve(request.data))
 
@@ -453,7 +454,8 @@ class Operate(APIView):
                                                                                          'dataset_id'))],
                                                      compare=CompareConstants.AND
                                                      ), compare=CompareConstants.AND)
-                @log(menu='Application/Conversation Log', operate="Delete a Annotation")
+                @log(menu='Application/Conversation Log', operate="Delete a Annotation",
+                     get_operation_object=lambda r, k: get_application_operation_object(k.get('application_id')))
                 def delete(self, request: Request, application_id: str, chat_id: str, chat_record_id: str,
                            dataset_id: str,
                            document_id: str, paragraph_id: str):

apps/application/views/chat_views.py

@@ -0,0 +1,21 @@
+# coding=utf-8
+"""
+    @project: MaxKB
+    @Author：虎
+    @file： common.py
+    @date：2025/3/25 16:56
+    @desc:
+"""
+
+from django.db.models import QuerySet
+
+from application.models import Application
+
+
+def get_application_operation_object(application_id):
+    application_model = QuerySet(model=Application).filter(id=application_id).first()
+    if application_model is not None:
+        return {
+            "name": application_model.name
+        }
+    return {}

apps/application/views/common.py

@@ -57,20 +57,28 @@ def _get_details(request):
     }
 
 
-def log(menu: str, operate, get_user=_get_user, get_ip_address=_get_ip_address, get_details=_get_details):
+def log(menu: str, operate, get_user=_get_user, get_ip_address=_get_ip_address, get_details=_get_details,
+        get_operation_object=None):
     """
     记录审计日志
     @param menu: 操作菜单 str
     @param operate: 操作 str|func 如果是一个函数 入参将是一个request 响应为str def operate(request): return "操作菜单"
     @param get_user: 获取用户
     @param get_ip_address:获取IP地址
     @param get_details: 获取执行详情
+    @param get_operation_object: 获取操作对象
     @return:
     """
 
     def inner(func):
         def run(view, request, **kwargs):
             status = 200
+            operation_object = {}
+            try:
+                if get_operation_object is not None:
+                    operation_object = get_operation_object(request, kwargs)
+            except Exception as e:
+                pass
             try:
                 return func(view, request, **kwargs)
             except Exception as e:
@@ -84,7 +92,8 @@ def run(view, request, **kwargs):
                 if callable(operate):
                     _operate = operate(request)
                 # 插入审计日志
-                Log(menu=menu, operate=_operate, user=user, status=status, ip_address=ip, details=details).save()
+                Log(menu=menu, operate=_operate, user=user, status=status, ip_address=ip, details=details,
+                    operation_object=operation_object).save()
 
         return run
 

apps/common/log/log.py

@@ -0,0 +1,56 @@
+# coding=utf-8
+"""
+    @project: MaxKB
+    @Author：虎
+    @file： common.py.py
+    @date：2025/3/25 15:43
+    @desc:
+"""
+from django.db.models import QuerySet
+
+from dataset.models import DataSet, Document
+
+
+def get_dataset_operation_object(dataset_id: str):
+    dataset_model = QuerySet(model=DataSet).filter(id=dataset_id).first()
+    if dataset_model is not None:
+        return {
+            "name": dataset_model.name,
+            "desc": dataset_model.desc,
+            "type": dataset_model.type,
+            "create_time": dataset_model.create_time,
+            "update_time": dataset_model.update_time
+        }
+    return {}
+
+
+def get_document_operation_object(document_id: str):
+    document_model = QuerySet(model=Document).filter(id=document_id).first()
+    if document_model is not None:
+        return {
+            "name": document_model.name,
+            "type": document_model.type,
+        }
+    return {}
+
+
+def get_document_operation_object_batch(document_id_list: str):
+    document_model_list = QuerySet(model=Document).filter(id__in=document_id_list)
+    if document_model_list is not None:
+        return {
+            "name": f'[{",".join([document_model.name for document_model in document_model_list])}]',
+            'document_list': [{'name': document_model.name, 'type': document_model.type} for document_model in
+                              document_model_list]
+        }
+    return {}
+
+
+def get_dataset_document_operation_object(dataset_dict: dict, document_dict: dict):
+    return {
+        'name': f'{dataset_dict.get("name", "")}/{document_dict.get("name", "")}',
+        'dataset_name': dataset_dict.get("name", ""),
+        'dataset_desc': dataset_dict.get("desc", ""),
+        'dataset_type': dataset_dict.get("type", ""),
+        'document_name': document_dict.get("name", ""),
+        'document_type': document_dict.get("type", ""),
+    }