feat: add ToolModule model and API for managing tool modules with workspace support

Author: liuruibin

apps/common/constants/permission_constants.py

@@ -21,6 +21,8 @@ class Group(Enum):
 
     MODEL = "MODEL"
 
+    TOOL = "TOOL"
+
 
 class Operate(Enum):
     """
@@ -111,8 +113,7 @@ class PermissionConstants(Enum):
                                                                               RoleConstants.USER])
     USER_EDIT = Permission(group=Group.USER, operate=Operate.EDIT, role_list=[RoleConstants.ADMIN])
     USER_DELETE = Permission(group=Group.USER, operate=Operate.DELETE, role_list=[RoleConstants.ADMIN])
-    TOOL_CREATE = Permission(group=Group.USER, operate=Operate.CREATE, role_list=[RoleConstants.ADMIN,
-                                                                                  RoleConstants.USER])
+
     MODEL_CREATE = Permission(group=Group.MODEL, operate=Operate.CREATE, role_list=[RoleConstants.ADMIN,
                                                                                     RoleConstants.USER])
     MODEL_READ = Permission(group=Group.MODEL, operate=Operate.READ, role_list=[RoleConstants.ADMIN,
@@ -121,6 +122,15 @@ class PermissionConstants(Enum):
                             role_list=[RoleConstants.ADMIN, RoleConstants.USER])
     MODEL_DELETE = Permission(group=Group.MODEL, operate=Operate.DELETE,
                               role_list=[RoleConstants.ADMIN, RoleConstants.USER])
+    TOOL_MODULE_CREATE = Permission(group=Group.TOOL, operate=Operate.CREATE, role_list=[RoleConstants.ADMIN,
+                                                                                         RoleConstants.USER])
+    TOOL_MODULE_READ = Permission(group=Group.TOOL, operate=Operate.READ, role_list=[RoleConstants.ADMIN,
+                                                                                     RoleConstants.USER])
+    TOOL_MODULE_EDIT = Permission(group=Group.TOOL, operate=Operate.EDIT, role_list=[RoleConstants.ADMIN,
+                                                                                     RoleConstants.USER])
+
+    TOOL_CREATE = Permission(group=Group.TOOL, operate=Operate.CREATE, role_list=[RoleConstants.ADMIN,
+                                                                                  RoleConstants.USER])
 
     def get_workspace_application_permission(self):
         return lambda r, kwargs: Permission(group=self.value.group, operate=self.value.operate,

apps/maxkb/urls.py

@@ -24,6 +24,7 @@
     path("api/", include("users.urls")),
     path("api/", include("tools.urls")),
     path("api/", include("models_provider.urls")),
+    path("api/", include("modules.urls"))
 ]
 urlpatterns += [
     path('schema/', SpectacularAPIView.as_view(), name='schema'),  # schema的配置文件的路由，下面两个ui也是根据这个配置文件来生成的

apps/modules/__init__.py

@@ -0,0 +1 @@
+# coding=utf-8

apps/modules/api/__init__.py

@@ -0,0 +1,105 @@
+# coding=utf-8
+from drf_spectacular.types import OpenApiTypes
+from drf_spectacular.utils import OpenApiParameter
+
+from common.mixins.api_mixin import APIMixin
+from common.result import ResultSerializer
+from modules.models.module import ModuleCreateRequest, ModuleEditRequest
+from modules.serializers.module import ModuleSerializer
+
+
+class ModuleCreateResponse(ResultSerializer):
+    def get_data(self):
+        return ModuleSerializer()
+
+
+class ModuleCreateAPI(APIMixin):
+    @staticmethod
+    def get_parameters():
+        return [
+            OpenApiParameter(
+                name="workspace_id",
+                description="工作空间id",
+                type=OpenApiTypes.STR,
+                location='path',
+                required=True,
+            ),
+            OpenApiParameter(
+                name="source",
+                description="菜单",
+                type=OpenApiTypes.STR,
+                enum=["APPLICATION", "KNOWLEDGE", "TOOL"],
+                location='path',
+                required=True,
+            )
+        ]
+
+    @staticmethod
+    def get_request():
+        return ModuleCreateRequest
+
+    @staticmethod
+    def get_response():
+        return ModuleCreateResponse
+
+
+class ModuleReadAPI(APIMixin):
+    @staticmethod
+    def get_parameters():
+        return [
+            OpenApiParameter(
+                name="workspace_id",
+                description="工作空间id",
+                type=OpenApiTypes.STR,
+                location='path',
+                required=True,
+            ),
+            OpenApiParameter(
+                name="source",
+                description="菜单",
+                type=OpenApiTypes.STR,
+                enum=["APPLICATION", "KNOWLEDGE", "TOOL"],
+                location='path',
+                required=True,
+            ),
+            OpenApiParameter(
+                name="module_id",
+                description="模块id",
+                type=OpenApiTypes.STR,
+                location='path',
+                required=True,
+            )
+        ]
+
+    @staticmethod
+    def get_response():
+        return ModuleCreateResponse
+
+
+class ModuleEditAPI(ModuleReadAPI):
+
+    @staticmethod
+    def get_request():
+        return ModuleEditRequest
+
+
+class ModuleTreeReadAPI(APIMixin):
+    @staticmethod
+    def get_parameters():
+        return [
+            OpenApiParameter(
+                name="workspace_id",
+                description="工作空间id",
+                type=OpenApiTypes.STR,
+                location='path',
+                required=True,
+            ),
+            OpenApiParameter(
+                name="source",
+                description="菜单",
+                type=OpenApiTypes.STR,
+                enum=["APPLICATION", "KNOWLEDGE", "TOOL"],
+                location='path',
+                required=True,
+            )
+        ]

apps/modules/api/module.py

@@ -0,0 +1,13 @@
+from django.utils.translation import gettext_lazy as _
+from rest_framework import serializers
+
+
+class ModuleCreateRequest(serializers.Serializer):
+    name = serializers.CharField(required=True, label=_('module name'))
+
+    parent_id = serializers.CharField(required=False, allow_null=True, allow_blank=True, default='root',
+                                      label=_('parent id'))
+
+
+class ModuleEditRequest(serializers.Serializer):
+    name = serializers.CharField(required=True, label=_('module name'))

apps/modules/models/__init__.py

@@ -0,0 +1 @@
+# coding=utf-8

apps/modules/models/module.py

@@ -0,0 +1,117 @@
+# -*- coding: utf-8 -*-
+
+import uuid_utils.compat as uuid
+from django.db import connection
+from django.db.models import QuerySet
+from django.utils.translation import gettext_lazy as _
+from rest_framework import serializers
+
+from common.constants.permission_constants import Group
+from modules.api.module import ModuleCreateRequest
+from tools.models import ToolModule
+
+
+def get_module_type(source):
+    if source == Group.TOOL.name:
+        return ToolModule
+    elif source == Group.APPLICATION.name:
+        # todo app module
+        return None
+    elif source == Group.KNOWLEDGE.name:
+        # todo knowledge module
+        return None
+    else:
+        return None
+
+
+class ModuleSerializer(serializers.Serializer):
+    id = serializers.CharField(required=True, label=_('module id'))
+    name = serializers.CharField(required=True, label=_('module name'))
+    user_id = serializers.CharField(required=True, label=_('module user id'))
+    workspace_id = serializers.CharField(required=False, allow_null=True, allow_blank=True, label=_('workspace id'))
+    parent_id = serializers.CharField(required=False, allow_null=True, allow_blank=True, label=_('parent id'))
+
+    class Create(serializers.Serializer):
+        user_id = serializers.UUIDField(required=True, label=_('user id'))
+        source = serializers.CharField(required=True, label=_('source'))
+
+        def insert(self, instance, with_valid=True):
+            if with_valid:
+                self.is_valid(raise_exception=True)
+                ModuleCreateRequest(data=instance).is_valid(raise_exception=True)
+
+            workspace_id = self.data.get('workspace_id', 'default')
+            parent_id = instance.get('parent_id', 'root')
+            name = instance.get('name')
+
+            Module = get_module_type(self.data.get('source'))
+            if QuerySet(Module).filter(name=name, workspace_id=workspace_id, parent_id=parent_id).exists():
+                raise serializers.ValidationError(_('Module name already exists'))
+
+            module = Module(
+                id=uuid.uuid7(),
+                name=instance.get('name'),
+                user_id=self.data.get('user_id'),
+                workspace_id=workspace_id,
+                parent_id=parent_id
+            )
+            module.save()
+            return ModuleSerializer(module).data
+
+    class Operate(serializers.Serializer):
+        id = serializers.CharField(required=True, label=_('module id'))
+        workspace_id = serializers.CharField(required=True, allow_null=True, allow_blank=True, label=_('workspace id'))
+        source = serializers.CharField(required=True, label=_('source'))
+
+        def edit(self, instance):
+            self.is_valid(raise_exception=True)
+            Module = get_module_type(self.data.get('source'))
+            if not QuerySet(Module).filter(id=self.data.get('id')).exists():
+                raise serializers.ValidationError(_('Module does not exist'))
+
+            edit_field_list = ['name']
+            edit_dict = {field: instance.get(field) for field in edit_field_list if (
+                    field in instance and instance.get(field) is not None)}
+
+            QuerySet(Module).filter(id=self.data.get('id')).update(**edit_dict)
+
+            return self.one()
+
+        def one(self):
+            self.is_valid(raise_exception=True)
+            Module = get_module_type(self.data.get('source'))
+            module = QuerySet(Module).filter(id=self.data.get('id')).first()
+            return ModuleSerializer(module).data
+
+
+class ModuleTreeSerializer(serializers.Serializer):
+    workspace_id = serializers.CharField(required=True, allow_null=True, allow_blank=True, label=_('workspace id'))
+    source = serializers.CharField(required=True, label=_('source'))
+
+    def get_module_tree(self):
+        self.is_valid(raise_exception=True)
+        with connection.cursor() as cursor:
+            query = """
+                    WITH RECURSIVE module_tree AS (SELECT id, name, user_id, workspace_id, parent_id, 1 AS level \
+                                                   FROM %s \
+                                                   WHERE parent_id = 'NONE' \
+                                                     AND workspace_id = %s \
+                                                   UNION ALL \
+                                                   SELECT m.id, \
+                                                          m.name, \
+                                                          m.user_id, \
+                                                          m.workspace_id, \
+                                                          m.parent_id, \
+                                                          mt.level + 1 \
+                                                   FROM your_app_module m \
+                                                            JOIN module_tree mt ON m.parent_id = mt.id)
+                    SELECT * \
+                    FROM module_tree
+                    ORDER BY level, name \
+                    """
+            module_table = self.data.get('source').lower() + '_module'
+            params = [module_table, self.data.get('workspace_id', 'default')]
+
+            cursor.execute(query, params)
+            columns = [col[0] for col in cursor.description]
+            return [dict(zip(columns, row)) for row in cursor.fetchall()]

apps/modules/serializers/__init__.py

@@ -0,0 +1,10 @@
+from django.urls import path
+
+from . import views
+
+app_name = "module"
+urlpatterns = [
+    path('workspace/<str:workspace_id>/<str:source>/module', views.ModuleView.Create.as_view()),
+    path('workspace/<str:workspace_id>/<str:source>/module/tree', views.ModuleTreeView.as_view()),
+    path('workspace/<str:workspace_id>/<str:source>/module/<str:module_id>', views.ModuleView.Operate.as_view()),
+]