278 lines
11 KiB
Python
278 lines
11 KiB
Python
import json
|
|
import logging
|
|
from typing import Optional, Union
|
|
|
|
from configs import dify_config
|
|
from core.tools.__base.tool import Tool
|
|
from core.tools.__base.tool_runtime import ToolRuntime
|
|
from core.tools.builtin_tool.provider import BuiltinToolProviderController
|
|
from core.tools.custom_tool.provider import ApiToolProviderController
|
|
from core.tools.entities.api_entities import ToolApiEntity, ToolProviderApiEntity
|
|
from core.tools.entities.common_entities import I18nObject
|
|
from core.tools.entities.tool_bundle import ApiToolBundle
|
|
from core.tools.entities.tool_entities import (
|
|
ApiProviderAuthType,
|
|
ToolParameter,
|
|
ToolProviderType,
|
|
)
|
|
from core.tools.plugin_tool.provider import PluginToolProviderController
|
|
from core.tools.utils.configuration import ProviderConfigEncrypter
|
|
from core.tools.workflow_as_tool.provider import WorkflowToolProviderController
|
|
from core.tools.workflow_as_tool.tool import WorkflowTool
|
|
from models.tools import ApiToolProvider, BuiltinToolProvider, WorkflowToolProvider
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class ToolTransformService:
|
|
@classmethod
|
|
def get_tool_provider_icon_url(cls, provider_type: str, provider_name: str, icon: str | dict) -> Union[str, dict]:
|
|
"""
|
|
get tool provider icon url
|
|
"""
|
|
url_prefix = dify_config.CONSOLE_API_URL + "/console/api/workspaces/current/tool-provider/"
|
|
|
|
if provider_type == ToolProviderType.BUILT_IN.value:
|
|
return url_prefix + "builtin/" + provider_name + "/icon"
|
|
elif provider_type in {ToolProviderType.API.value, ToolProviderType.WORKFLOW.value}:
|
|
try:
|
|
if isinstance(icon, str):
|
|
return json.loads(icon)
|
|
return icon
|
|
except:
|
|
return {"background": "#252525", "content": "\ud83d\ude01"}
|
|
|
|
return ""
|
|
|
|
@staticmethod
|
|
def repack_provider(provider: Union[dict, ToolProviderApiEntity]):
|
|
"""
|
|
repack provider
|
|
|
|
:param provider: the provider dict
|
|
"""
|
|
if isinstance(provider, dict) and "icon" in provider:
|
|
provider["icon"] = ToolTransformService.get_tool_provider_icon_url(
|
|
provider_type=provider["type"], provider_name=provider["name"], icon=provider["icon"]
|
|
)
|
|
elif isinstance(provider, ToolProviderApiEntity):
|
|
provider.icon = ToolTransformService.get_tool_provider_icon_url(
|
|
provider_type=provider.type.value, provider_name=provider.name, icon=provider.icon
|
|
)
|
|
|
|
@classmethod
|
|
def builtin_provider_to_user_provider(
|
|
cls,
|
|
provider_controller: BuiltinToolProviderController | PluginToolProviderController,
|
|
db_provider: Optional[BuiltinToolProvider],
|
|
decrypt_credentials: bool = True,
|
|
) -> ToolProviderApiEntity:
|
|
"""
|
|
convert provider controller to user provider
|
|
"""
|
|
result = ToolProviderApiEntity(
|
|
id=provider_controller.entity.identity.name,
|
|
author=provider_controller.entity.identity.author,
|
|
name=provider_controller.entity.identity.name,
|
|
description=provider_controller.entity.identity.description,
|
|
icon=provider_controller.entity.identity.icon,
|
|
label=provider_controller.entity.identity.label,
|
|
type=ToolProviderType.BUILT_IN,
|
|
masked_credentials={},
|
|
is_team_authorization=False,
|
|
tools=[],
|
|
labels=provider_controller.tool_labels,
|
|
)
|
|
|
|
# get credentials schema
|
|
schema = provider_controller.get_credentials_schema()
|
|
for name, value in schema.items():
|
|
if result.masked_credentials:
|
|
result.masked_credentials[name] = ""
|
|
|
|
# check if the provider need credentials
|
|
if not provider_controller.need_credentials:
|
|
result.is_team_authorization = True
|
|
result.allow_delete = False
|
|
elif db_provider:
|
|
result.is_team_authorization = True
|
|
|
|
if decrypt_credentials:
|
|
credentials = db_provider.credentials
|
|
|
|
# init tool configuration
|
|
tool_configuration = ProviderConfigEncrypter(
|
|
tenant_id=db_provider.tenant_id,
|
|
config=provider_controller.get_credentials_schema(),
|
|
provider_type=provider_controller.provider_type.value,
|
|
provider_identity=provider_controller.entity.identity.name,
|
|
)
|
|
# decrypt the credentials and mask the credentials
|
|
decrypted_credentials = tool_configuration.decrypt(data=credentials)
|
|
masked_credentials = tool_configuration.mask_tool_credentials(data=decrypted_credentials)
|
|
|
|
result.masked_credentials = masked_credentials
|
|
result.original_credentials = decrypted_credentials
|
|
|
|
return result
|
|
|
|
@staticmethod
|
|
def api_provider_to_controller(
|
|
db_provider: ApiToolProvider,
|
|
) -> ApiToolProviderController:
|
|
"""
|
|
convert provider controller to user provider
|
|
"""
|
|
# package tool provider controller
|
|
controller = ApiToolProviderController.from_db(
|
|
db_provider=db_provider,
|
|
auth_type=ApiProviderAuthType.API_KEY
|
|
if db_provider.credentials["auth_type"] == "api_key"
|
|
else ApiProviderAuthType.NONE,
|
|
)
|
|
|
|
return controller
|
|
|
|
@staticmethod
|
|
def workflow_provider_to_controller(db_provider: WorkflowToolProvider) -> WorkflowToolProviderController:
|
|
"""
|
|
convert provider controller to provider
|
|
"""
|
|
return WorkflowToolProviderController.from_db(db_provider)
|
|
|
|
@staticmethod
|
|
def workflow_provider_to_user_provider(
|
|
provider_controller: WorkflowToolProviderController, labels: list[str] | None = None
|
|
):
|
|
"""
|
|
convert provider controller to user provider
|
|
"""
|
|
return ToolProviderApiEntity(
|
|
id=provider_controller.provider_id,
|
|
author=provider_controller.entity.identity.author,
|
|
name=provider_controller.entity.identity.name,
|
|
description=provider_controller.entity.identity.description,
|
|
icon=provider_controller.entity.identity.icon,
|
|
label=provider_controller.entity.identity.label,
|
|
type=ToolProviderType.WORKFLOW,
|
|
masked_credentials={},
|
|
is_team_authorization=True,
|
|
tools=[],
|
|
labels=labels or [],
|
|
)
|
|
|
|
@classmethod
|
|
def api_provider_to_user_provider(
|
|
cls,
|
|
provider_controller: ApiToolProviderController,
|
|
db_provider: ApiToolProvider,
|
|
decrypt_credentials: bool = True,
|
|
labels: list[str] | None = None,
|
|
) -> ToolProviderApiEntity:
|
|
"""
|
|
convert provider controller to user provider
|
|
"""
|
|
username = "Anonymous"
|
|
try:
|
|
user = db_provider.user
|
|
if not user:
|
|
raise ValueError("user not found")
|
|
|
|
username = user.name
|
|
except Exception as e:
|
|
logger.error(f"failed to get user name for api provider {db_provider.id}: {str(e)}")
|
|
|
|
# add provider into providers
|
|
credentials = db_provider.credentials
|
|
result = ToolProviderApiEntity(
|
|
id=db_provider.id,
|
|
author=username,
|
|
name=db_provider.name,
|
|
description=I18nObject(
|
|
en_US=db_provider.description,
|
|
zh_Hans=db_provider.description,
|
|
),
|
|
icon=db_provider.icon,
|
|
label=I18nObject(
|
|
en_US=db_provider.name,
|
|
zh_Hans=db_provider.name,
|
|
),
|
|
type=ToolProviderType.API,
|
|
masked_credentials={},
|
|
is_team_authorization=True,
|
|
tools=[],
|
|
labels=labels or [],
|
|
)
|
|
|
|
if decrypt_credentials:
|
|
# init tool configuration
|
|
tool_configuration = ProviderConfigEncrypter(
|
|
tenant_id=db_provider.tenant_id,
|
|
config=provider_controller.get_credentials_schema(),
|
|
provider_type=provider_controller.provider_type.value,
|
|
provider_identity=provider_controller.entity.identity.name,
|
|
)
|
|
|
|
# decrypt the credentials and mask the credentials
|
|
decrypted_credentials = tool_configuration.decrypt(data=credentials)
|
|
masked_credentials = tool_configuration.mask_tool_credentials(data=decrypted_credentials)
|
|
|
|
result.masked_credentials = masked_credentials
|
|
|
|
return result
|
|
|
|
@staticmethod
|
|
def tool_to_user_tool(
|
|
tool: Union[ApiToolBundle, WorkflowTool, Tool],
|
|
tenant_id: str,
|
|
credentials: dict | None = None,
|
|
labels: list[str] | None = None,
|
|
) -> ToolApiEntity:
|
|
"""
|
|
convert tool to user tool
|
|
"""
|
|
if isinstance(tool, Tool):
|
|
# fork tool runtime
|
|
tool = tool.fork_tool_runtime(
|
|
runtime=ToolRuntime(
|
|
credentials=credentials or {},
|
|
tenant_id=tenant_id,
|
|
)
|
|
)
|
|
|
|
# get tool parameters
|
|
parameters = tool.entity.parameters or []
|
|
# get tool runtime parameters
|
|
runtime_parameters = tool.get_runtime_parameters() or []
|
|
# override parameters
|
|
current_parameters = parameters.copy()
|
|
for runtime_parameter in runtime_parameters:
|
|
found = False
|
|
for index, parameter in enumerate(current_parameters):
|
|
if parameter.name == runtime_parameter.name and parameter.form == runtime_parameter.form:
|
|
current_parameters[index] = runtime_parameter
|
|
found = True
|
|
break
|
|
|
|
if not found and runtime_parameter.form == ToolParameter.ToolParameterForm.FORM:
|
|
current_parameters.append(runtime_parameter)
|
|
|
|
return ToolApiEntity(
|
|
author=tool.entity.identity.author,
|
|
name=tool.entity.identity.name,
|
|
label=tool.entity.identity.label,
|
|
description=tool.entity.description.human if tool.entity.description else I18nObject(en_US=""),
|
|
output_schema=tool.entity.output_schema,
|
|
parameters=current_parameters,
|
|
labels=labels or [],
|
|
)
|
|
if isinstance(tool, ApiToolBundle):
|
|
return ToolApiEntity(
|
|
author=tool.author,
|
|
name=tool.operation_id,
|
|
label=I18nObject(en_US=tool.operation_id, zh_Hans=tool.operation_id),
|
|
description=I18nObject(en_US=tool.summary or "", zh_Hans=tool.summary or ""),
|
|
parameters=tool.parameters,
|
|
labels=labels or [],
|
|
)
|