import io import logging from typing import Any from flask import request, send_file from flask_restx import Resource from pydantic import BaseModel, ConfigDict, Field from werkzeug.exceptions import Unauthorized from configs import dify_config from constants import HEADER_NAME_APP_CODE from controllers.common.errors import InvalidArgumentError from controllers.common.fields import AccessModeResponse, BinaryFileResponse, BooleanResultResponse, Parameters from controllers.common.schema import query_params_from_model, register_response_schema_models, register_schema_models from controllers.console.wraps import model_validate from controllers.web import web_ns from controllers.web.error import ( AgentNotPublishedError, AppUnavailableError, WebAppAccessServiceUnavailableError, WebAppAuthRequiredError, WebAppNotFoundError, ) from controllers.web.wraps import WebApiResource from core.plugin.impl.exc import PluginDaemonClientSideError from extensions.ext_application_services import application_services from fields.base import ResponseModel from libs.external_api import error_responses from libs.flask_restx_compat import BINARY_RESPONSE_MEDIA_TYPES_VENDOR_KEY from libs.helper import dump_response from libs.passport import PassportService from libs.token import extract_webapp_passport from models.model import App, EndUser from services.app_definition_query_service import ( AppDefinitionNotPublishedError, AppDefinitionUnavailableError, WebAppConnectionRequirement, ) from services.web_passport_service import WebAppAuthType from services.webapp_access_query_service import ( WebAppAccessAppNotFoundError, WebAppAccessReferenceRequiredError, WebAppAccessUnavailableError, ) logger = logging.getLogger(__name__) class AppAccessModeQuery(BaseModel): model_config = ConfigDict(populate_by_name=True) app_id: str | None = Field(default=None, alias="appId", description="Application ID") app_code: str | None = Field(default=None, alias="appCode", description="Application code") class AppPermissionQuery(BaseModel): model_config = ConfigDict(populate_by_name=True) app_id: str = Field(..., alias="appId", description="Application ID") class AppMetaResponse(BaseModel): tool_icons: dict[str, Any] = Field( default_factory=dict, description="Tool icon metadata keyed by tool name", ) class ConnectionReadmeQuery(BaseModel): plugin_unique_identifier: str = Field( min_length=1, description="Exact plugin artifact from connection_requirements" ) language: str = Field(default="en-US", min_length=1, description="README language, as in the Console plugin API") class ConnectionReadmeResponse(ResponseModel): readme: str class ConnectionAssetQuery(BaseModel): plugin_unique_identifier: str = Field( min_length=1, description="Exact plugin artifact from connection_requirements" ) file_name: str = Field(min_length=1, description="Asset filename relative to the plugin's _assets directory") class WebAppParametersResponse(Parameters, ResponseModel): account_login_url: str | None = Field(description="Account-origin sign-in page for the existing Web App login flow") allow_anonymous_end_user_auth: bool = Field( description="Whether Guest identities may manage and use personal Connections; does not control App entry." ) account_login_enabled: bool = Field(description="Whether explicit Account login and Passport exchange are enabled.") connection_revision: str | None = Field( description=( "Opaque revision of connection requirements, plugin artifacts and OAuth Client configurations; " "null for other app modes. Return it unchanged in connection requests and runs." ), ) requires_end_user_connections: bool = Field( description="Whether this published version declares EndUser tool connections, independent of user readiness.", ) connection_requirements: tuple[WebAppConnectionRequirement, ...] = Field( description=( "Authorization requirements and exact plugin artifacts in connection_revision, without personal state." ) ) register_schema_models(web_ns, AppAccessModeQuery, AppPermissionQuery) register_response_schema_models( web_ns, WebAppParametersResponse, AppMetaResponse, AccessModeResponse, BooleanResultResponse, ConnectionReadmeResponse, BinaryFileResponse, ) @web_ns.route("/parameters") class AppParameterApi(WebApiResource): """Resource for app variables.""" @error_responses(AgentNotPublishedError, AppUnavailableError) @web_ns.doc("Get App Parameters") @web_ns.doc(description="Retrieve the parameters for a specific app.") @web_ns.doc( responses={ 200: "Success", 400: "Bad Request", 401: "Unauthorized", 404: "App Not Found", 500: "Internal Server Error", } ) @web_ns.response(200, "Success", web_ns.models[WebAppParametersResponse.__name__]) def get(self, app_model: App, end_user: EndUser): """Retrieve app parameters.""" try: parameters = application_services().app_definitions.get_web_parameters(app_model.id, app_model.tenant_id) except AppDefinitionNotPublishedError: raise AgentNotPublishedError() from None except AppDefinitionUnavailableError: raise AppUnavailableError() from None return dump_response( WebAppParametersResponse, { **parameters, "allow_anonymous_end_user_auth": dify_config.END_USER_AUTH_ALLOW_ANONYMOUS, "account_login_enabled": dify_config.WEBAPP_ACCOUNT_PASSPORT_ENABLED, "account_login_url": f"{dify_config.CONSOLE_WEB_URL.rstrip('/')}/signin" if dify_config.WEBAPP_ACCOUNT_PASSPORT_ENABLED else None, }, ) @web_ns.route("/connections/readme") class ConnectionReadmeApi(WebApiResource): @error_responses(AgentNotPublishedError, AppUnavailableError) @web_ns.doc(params=query_params_from_model(ConnectionReadmeQuery)) @web_ns.doc(description="Read plugin documentation for a published personal Connection requirement.") @web_ns.response(200, "Plugin README", web_ns.models[ConnectionReadmeResponse.__name__]) def get(self, app_model: App, end_user: EndUser): query = ConnectionReadmeQuery.model_validate(request.args.to_dict(flat=True)) try: readme = application_services().app_definitions.get_web_plugin_readme( app_model.id, app_model.tenant_id, query.plugin_unique_identifier, query.language ) except AppDefinitionNotPublishedError: raise AgentNotPublishedError() from None except AppDefinitionUnavailableError: raise AppUnavailableError() from None return dump_response(ConnectionReadmeResponse, {"readme": readme}) @web_ns.route("/connections/asset") class ConnectionAssetApi(WebApiResource): @error_responses(AgentNotPublishedError, AppUnavailableError) @web_ns.doc(params=query_params_from_model(ConnectionAssetQuery)) @web_ns.doc( description="Read a plugin README asset for a published personal Connection requirement.", produces=["application/octet-stream"], vendor={BINARY_RESPONSE_MEDIA_TYPES_VENDOR_KEY: ["application/octet-stream"]}, ) @web_ns.response(200, "Plugin asset", web_ns.models[BinaryFileResponse.__name__]) def get(self, app_model: App, end_user: EndUser): query = ConnectionAssetQuery.model_validate(request.args.to_dict(flat=True)) try: binary = application_services().app_definitions.get_web_plugin_asset( app_model.id, app_model.tenant_id, query.plugin_unique_identifier, query.file_name ) except AppDefinitionNotPublishedError: raise AgentNotPublishedError() from None except (AppDefinitionUnavailableError, PluginDaemonClientSideError): raise AppUnavailableError() from None response = send_file(io.BytesIO(binary), mimetype="application/octet-stream") response.headers["Cache-Control"] = "no-store" return response @web_ns.route("/meta") class AppMeta(WebApiResource): @error_responses(AppUnavailableError) @web_ns.doc("Get App Meta") @web_ns.doc(description="Retrieve the metadata for a specific app.") @web_ns.doc( responses={ 200: "Success", 400: "Bad Request", 401: "Unauthorized", 404: "App Not Found", 500: "Internal Server Error", } ) @web_ns.response(200, "Success", web_ns.models[AppMetaResponse.__name__]) def get(self, app_model: App, end_user: EndUser): """Get app meta""" try: tool_icons = application_services().app_definitions.get_tool_icons(app_model.id) except AppDefinitionUnavailableError: raise AppUnavailableError() from None return dump_response(AppMetaResponse, {"tool_icons": tool_icons}) @web_ns.route("/webapp/access-mode") class AppAccessMode(Resource): @error_responses(InvalidArgumentError) @web_ns.doc("Get App Access Mode") @web_ns.doc(description="Retrieve the access mode for a web application (public or restricted).") @web_ns.doc(params=query_params_from_model(AppAccessModeQuery)) @web_ns.doc( responses={ 200: "Success", 400: "Bad Request", 404: "App Not Found", 500: "Internal Server Error", 503: "Web App Access Service Unavailable", } ) @web_ns.response(200, "Success", web_ns.models[AccessModeResponse.__name__]) @model_validate(AppAccessModeQuery) def get(self, args: AppAccessModeQuery): try: access_mode = application_services().webapp_access.get_access_mode( app_id=args.app_id, app_code=args.app_code, ) except WebAppAccessReferenceRequiredError as e: raise InvalidArgumentError(description=str(e)) from None except WebAppAccessAppNotFoundError: raise WebAppNotFoundError() from None except WebAppAccessUnavailableError: raise WebAppAccessServiceUnavailableError() from None return dump_response(AccessModeResponse, {"access_mode": access_mode}) @web_ns.route("/webapp/permission") class AppWebAuthPermission(Resource): @web_ns.doc("Check App Permission") @web_ns.doc(description="Check if user has permission to access a web application.") @web_ns.doc(params=query_params_from_model(AppPermissionQuery)) @web_ns.doc( responses={ 200: "Success", 400: "Bad Request", 401: "Unauthorized", 500: "Internal Server Error", 503: "Web App Access Service Unavailable", } ) @web_ns.response(200, "Success", web_ns.models[BooleanResultResponse.__name__]) def get(self): app_code = request.headers.get(HEADER_NAME_APP_CODE) app_id = request.args.get("appId") if not app_id or not app_code: raise ValueError("appId must be provided") webapp_access = application_services().webapp_access try: requires_permission_check = webapp_access.requires_permission_check(app_id) except WebAppAccessUnavailableError: raise WebAppAccessServiceUnavailableError() from None if not requires_permission_check: return dump_response(BooleanResultResponse, {"result": True}) try: tk = extract_webapp_passport(app_code, request) if not tk: raise Unauthorized("Access token is missing.") decoded = PassportService().verify(tk) except Unauthorized: raise WebAppAuthRequiredError() from None except Exception: logger.exception("Unexpected error during auth verification") raise if decoded.get("auth_type") != WebAppAuthType.INTERNAL: raise WebAppAuthRequiredError() user_id = decoded.get("user_id") if not user_id: raise WebAppAuthRequiredError() try: is_allowed = webapp_access.is_user_allowed(user_id=str(user_id), app_id=app_id) except WebAppAccessUnavailableError: raise WebAppAccessServiceUnavailableError() from None return dump_response(BooleanResultResponse, {"result": is_allowed})