feat: implement Tool model and related API for Tool management

Author: liuruibin

apps/common/constants/permission_constants.py

@@ -109,6 +109,8 @@ 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])
 
     def get_workspace_application_permission(self):
         return lambda r, kwargs: Permission(group=self.value.group, operate=self.value.operate,

apps/maxkb/settings/base.py

@@ -39,6 +39,7 @@
     'drf_spectacular',
     'drf_spectacular_sidecar',
     'users.apps.UsersConfig',
+    'tools.apps.ToolConfig',
     'common',
     'system_manage'
 ]

apps/maxkb/urls.py

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

apps/tools/__init__.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

apps/tools/admin.py

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

apps/tools/api/__init__.py

@@ -0,0 +1,20 @@
+# coding=utf-8
+
+from common.mixins.api_mixin import APIMixin
+from common.result import ResultSerializer
+from tools.serializers.tool import ToolModelSerializer, ToolCreateRequest
+
+
+class ToolCreateResponse(ResultSerializer):
+    def get_data(self):
+        return ToolModelSerializer()
+
+
+class ToolCreateAPI(APIMixin):
+    @staticmethod
+    def get_request():
+        return ToolCreateRequest
+
+    @staticmethod
+    def get_response():
+        return ToolCreateResponse

apps/tools/api/tool.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class ToolConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'tools'

apps/tools/apps.py

@@ -0,0 +1,42 @@
+# Generated by Django 5.2 on 2025-04-16 09:49
+
+import django.contrib.postgres.fields
+import django.db.models.deletion
+import uuid_utils.compat
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('users', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Tool',
+            fields=[
+                ('id', models.UUIDField(default=uuid_utils.compat.uuid7, editable=False, primary_key=True, serialize=False, verbose_name='主键id')),
+                ('name', models.CharField(max_length=64, verbose_name='函数名称')),
+                ('desc', models.CharField(max_length=128, verbose_name='描述')),
+                ('code', models.CharField(max_length=102400, verbose_name='python代码')),
+                ('input_field_list', django.contrib.postgres.fields.ArrayField(base_field=models.JSONField(default=dict, verbose_name='输入字段'), default=list, size=None, verbose_name='输入字段列表')),
+                ('init_field_list', models.JSONField(default=list, verbose_name='启动字段列表')),
+                ('icon', models.CharField(default='/ui/favicon.ico', max_length=256, verbose_name='函数库icon')),
+                ('is_active', models.BooleanField(default=True)),
+                ('permission_type', models.CharField(choices=[('SHARED', '共享'), ('PRIVATE', '私有')], default='PRIVATE', max_length=20, verbose_name='权限类型')),
+                ('tool_type', models.CharField(choices=[('INTERNAL', '内置'), ('PUBLIC', '公开')], default='PUBLIC', max_length=20, verbose_name='函数类型')),
+                ('template_id', models.UUIDField(default=None, null=True, verbose_name='模版id')),
+                ('module_id', models.UUIDField(default='root', null=True, verbose_name='模块id')),
+                ('init_params', models.CharField(max_length=102400, null=True, verbose_name='初始化参数')),
+                ('create_time', models.DateTimeField(auto_now_add=True, null=True, verbose_name='创建时间')),
+                ('update_time', models.DateTimeField(auto_now=True, null=True, verbose_name='修改时间')),
+                ('user', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='users.user', verbose_name='用户id')),
+            ],
+            options={
+                'db_table': 'tool',
+            },
+        ),
+    ]

apps/tools/migrations/0001_initial.py

@@ -0,0 +1 @@
+from .tool import *

apps/tools/migrations/__init__.py

@@ -0,0 +1,41 @@
+import uuid_utils.compat as uuid
+from django.contrib.postgres.fields import ArrayField
+from django.db import models
+
+from users.models import User
+
+
+class PermissionType(models.TextChoices):
+    SHARED = "SHARED", '共享'
+    PRIVATE = "PRIVATE", "私有"
+
+
+class ToolType(models.TextChoices):
+    INTERNAL = "INTERNAL", '内置'
+    PUBLIC = "PUBLIC", "公开"
+
+
+class Tool(models.Model):
+    id = models.UUIDField(primary_key=True, max_length=128, default=uuid.uuid7, editable=False, verbose_name="主键id")
+    user = models.ForeignKey(User, on_delete=models.CASCADE, verbose_name="用户id")
+    name = models.CharField(max_length=64, verbose_name="函数名称")
+    desc = models.CharField(max_length=128, verbose_name="描述")
+    code = models.CharField(max_length=102400, verbose_name="python代码")
+    input_field_list = ArrayField(verbose_name="输入字段列表",
+                                  base_field=models.JSONField(verbose_name="输入字段", default=dict)
+                                  , default=list)
+    init_field_list = models.JSONField(verbose_name="启动字段列表", default=list)
+    icon = models.CharField(max_length=256, verbose_name="函数库icon", default="/ui/favicon.ico")
+    is_active = models.BooleanField(default=True)
+    permission_type = models.CharField(max_length=20, verbose_name='权限类型', choices=PermissionType.choices,
+                                       default=PermissionType.PRIVATE)
+    tool_type = models.CharField(max_length=20, verbose_name='函数类型', choices=ToolType.choices,
+                                     default=ToolType.PUBLIC)
+    template_id = models.UUIDField(max_length=128, verbose_name="模版id", null=True, default=None)
+    module_id = models.UUIDField(max_length=128, verbose_name="模块id", null=True, default='root')
+    init_params = models.CharField(max_length=102400, verbose_name="初始化参数", null=True)
+    create_time = models.DateTimeField(verbose_name="创建时间", auto_now_add=True, null=True)
+    update_time = models.DateTimeField(verbose_name="修改时间", auto_now=True, null=True)
+
+    class Meta:
+        db_table = "tool"

apps/tools/models/__init__.py

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

apps/tools/models/tool.py

@@ -0,0 +1,65 @@
+# -*- coding: utf-8 -*-
+import re
+
+import uuid_utils.compat as uuid
+from django.core import validators
+from django.utils.translation import gettext_lazy as _
+from rest_framework import serializers
+
+from tools.models import Tool
+from util.field_message import ErrMessage
+
+
+class ToolModelSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = Tool
+        fields = ['id', 'name', 'icon', 'desc', 'code', 'input_field_list', 'init_field_list', 'init_params',
+                  'permission_type', 'is_active', 'user_id', 'template_id',
+                  'create_time', 'update_time']
+
+
+class ToolInputField(serializers.Serializer):
+    name = serializers.CharField(required=True, error_messages=ErrMessage.char(_('variable name')))
+    is_required = serializers.BooleanField(required=True, error_messages=ErrMessage.boolean(_('required')))
+    type = serializers.CharField(required=True, error_messages=ErrMessage.char(_('type')), validators=[
+        validators.RegexValidator(regex=re.compile("^string|int|dict|array|float$"),
+                                  message=_('fields only support string|int|dict|array|float'), code=500)
+    ])
+    source = serializers.CharField(required=True, error_messages=ErrMessage.char(_('source')), validators=[
+        validators.RegexValidator(regex=re.compile("^custom|reference$"),
+                                  message=_('The field only supports custom|reference'), code=500)
+    ])
+
+
+class ToolCreateRequest(serializers.Serializer):
+    name = serializers.CharField(required=True, error_messages=ErrMessage.char(_('tool name')))
+
+    desc = serializers.CharField(required=False, allow_null=True, allow_blank=True,
+                                 error_messages=ErrMessage.char(_('tool description')))
+
+    code = serializers.CharField(required=True, error_messages=ErrMessage.char(_('tool content')))
+
+    input_field_list = ToolInputField(required=True, many=True)
+
+    init_field_list = serializers.ListField(required=False, default=list)
+
+    is_active = serializers.BooleanField(required=False, error_messages=ErrMessage.char(_('Is active')))
+
+
+class ToolSerializer(serializers.Serializer):
+    class Create(serializers.Serializer):
+        user_id = serializers.UUIDField(required=True, error_messages=ErrMessage.uuid(_('user id')))
+
+        def insert(self, instance, with_valid=True):
+            if with_valid:
+                self.is_valid(raise_exception=True)
+                ToolCreateRequest(data=instance).is_valid(raise_exception=True)
+            tool = Tool(id=uuid.uuid7(), name=instance.get('name'), desc=instance.get('desc'),
+                        code=instance.get('code'),
+                        user_id=self.data.get('user_id'),
+                        input_field_list=instance.get('input_field_list'),
+                        init_field_list=instance.get('init_field_list'),
+                        permission_type=instance.get('permission_type'),
+                        is_active=False)
+            tool.save()
+            return ToolModelSerializer(tool).data

apps/tools/serializers/__init__.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

apps/tools/serializers/tool.py

@@ -0,0 +1,8 @@
+from django.urls import path
+
+from . import views
+
+app_name = "tool"
+urlpatterns = [
+    path('workspace/<str:workspace_id>/tool/create', views.ToolCreateView.as_view()),
+]

apps/tools/tests.py

@@ -0,0 +1 @@
+from .tool import *

apps/tools/urls.py

@@ -0,0 +1,28 @@
+from django.utils.translation import gettext_lazy as _
+from drf_spectacular.utils import extend_schema
+from rest_framework.request import Request
+from rest_framework.views import APIView
+
+from common.auth import TokenAuth
+from common.auth.authentication import has_permissions
+from common.constants.permission_constants import PermissionConstants
+from common.result import result
+from tools.api.tool import ToolCreateAPI
+from tools.serializers.tool import ToolSerializer
+
+
+class ToolCreateView(APIView):
+    authentication_classes = [TokenAuth]
+
+    @extend_schema(methods=['POST'],
+                   description=_('Create tool'),
+                   operation_id=_('Create tool'),
+                   request=ToolCreateAPI.get_request(),
+                   responses=ToolCreateAPI.get_response(),
+                   tags=[_('Tool')])
+    @has_permissions(PermissionConstants.TOOL_CREATE)
+    # @log(menu='Tool', operate="Create tool",
+    #      get_operation_object=lambda r, k: r.data.get('name'))
+    def post(self, request: Request, workspace_id: str):
+        print(workspace_id)
+        return result.success(ToolSerializer.Create(data={'user_id': request.user.id}).insert(request.data))

apps/tools/views/__init__.py

@@ -0,0 +1,72 @@
+# coding=utf-8
+"""
+    @project: maxkb
+    @Author：虎
+    @file： field_message.py
+    @date：2024/3/1 14:30
+    @desc:
+"""
+from django.utils.functional import lazy
+from rest_framework import serializers
+
+
+def value_(field, value):
+    return f"【{field}】 {value}"
+
+
+def reset_messages(field, messages):
+    return {key: lazy(value_, str)(field, messages.get(key)) for key in messages}
+
+
+def reset_message_by_field(field_text, field):
+    return reset_messages(field_text, {**field.default_error_messages, **field.__bases__[0].default_error_messages})
+
+
+class ErrMessage:
+    @staticmethod
+    def char(field: str):
+        return reset_message_by_field(field, serializers.CharField)
+
+    @staticmethod
+    def uuid(field: str):
+        return reset_messages(field, serializers.UUIDField.default_error_messages)
+
+    @staticmethod
+    def integer(field: str):
+        return reset_messages(field, serializers.IntegerField.default_error_messages)
+
+    @staticmethod
+    def list(field: str):
+        return reset_messages(field, serializers.ListField.default_error_messages)
+
+    @staticmethod
+    def boolean(field: str):
+        return reset_messages(field, serializers.BooleanField.default_error_messages)
+
+    @staticmethod
+    def dict(field: str):
+        return reset_messages(field, serializers.DictField.default_error_messages)
+
+    @staticmethod
+    def float(field: str):
+        return reset_messages(field, serializers.FloatField.default_error_messages)
+
+    @staticmethod
+    def json(field: str):
+        return reset_messages(field, serializers.JSONField.default_error_messages)
+
+    @staticmethod
+    def base(field: str):
+        return reset_messages(field, serializers.Field.default_error_messages)
+
+    @staticmethod
+    def date(field: str):
+        return reset_messages(field, serializers.DateField.default_error_messages)
+
+    @staticmethod
+    def image(field: str):
+        return reset_messages(field, serializers.ImageField.default_error_messages)
+
+    @staticmethod
+    def file(field: str):
+        return reset_messages(field, serializers.FileField.default_error_messages)

apps/tools/views/tool.py

@@ -9,11 +9,13 @@ readme = "README.md"
 python = "^3.11"
 django = "5.2"
 drf-spectacular = { extras = ["sidecar"], version = "0.28.0" }
+drf-yasg = "1.21.10"
 django-redis = "5.4.0"
 django-db-connection-pool = "1.2.5"
 psycopg = {extras = ["binary"], version = "3.2.6"}
 python-dotenv = "1.1.0"
 uuid-utils = "0.10.0"
+diskcache = "5.6.3"
 
 [build-system]
 requires = ["poetry-core"]