file_factory.py 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292
  1. import mimetypes
  2. from collections.abc import Callable, Mapping, Sequence
  3. from typing import Any, cast
  4. import httpx
  5. from sqlalchemy import select
  6. from constants import AUDIO_EXTENSIONS, DOCUMENT_EXTENSIONS, IMAGE_EXTENSIONS, VIDEO_EXTENSIONS
  7. from core.file import File, FileBelongsTo, FileTransferMethod, FileType, FileUploadConfig
  8. from core.helper import ssrf_proxy
  9. from extensions.ext_database import db
  10. from models import MessageFile, ToolFile, UploadFile
  11. def build_from_message_files(
  12. *,
  13. message_files: Sequence["MessageFile"],
  14. tenant_id: str,
  15. config: FileUploadConfig,
  16. ) -> Sequence[File]:
  17. results = [
  18. build_from_message_file(message_file=file, tenant_id=tenant_id, config=config)
  19. for file in message_files
  20. if file.belongs_to != FileBelongsTo.ASSISTANT
  21. ]
  22. return results
  23. def build_from_message_file(
  24. *,
  25. message_file: "MessageFile",
  26. tenant_id: str,
  27. config: FileUploadConfig,
  28. ):
  29. mapping = {
  30. "transfer_method": message_file.transfer_method,
  31. "url": message_file.url,
  32. "id": message_file.id,
  33. "type": message_file.type,
  34. "upload_file_id": message_file.upload_file_id,
  35. }
  36. return build_from_mapping(
  37. mapping=mapping,
  38. tenant_id=tenant_id,
  39. config=config,
  40. )
  41. def build_from_mapping(
  42. *,
  43. mapping: Mapping[str, Any],
  44. tenant_id: str,
  45. config: FileUploadConfig | None = None,
  46. ) -> File:
  47. transfer_method = FileTransferMethod.value_of(mapping.get("transfer_method"))
  48. build_functions: dict[FileTransferMethod, Callable] = {
  49. FileTransferMethod.LOCAL_FILE: _build_from_local_file,
  50. FileTransferMethod.REMOTE_URL: _build_from_remote_url,
  51. FileTransferMethod.TOOL_FILE: _build_from_tool_file,
  52. }
  53. build_func = build_functions.get(transfer_method)
  54. if not build_func:
  55. raise ValueError(f"Invalid file transfer method: {transfer_method}")
  56. file = build_func(
  57. mapping=mapping,
  58. tenant_id=tenant_id,
  59. transfer_method=transfer_method,
  60. )
  61. if config and not _is_file_valid_with_config(
  62. input_file_type=mapping.get("type", FileType.CUSTOM),
  63. file_extension=file.extension,
  64. file_transfer_method=file.transfer_method,
  65. config=config,
  66. ):
  67. raise ValueError(f"File validation failed for file: {file.filename}")
  68. return file
  69. def build_from_mappings(
  70. *,
  71. mappings: Sequence[Mapping[str, Any]],
  72. config: FileUploadConfig | None = None,
  73. tenant_id: str,
  74. ) -> Sequence[File]:
  75. files = [
  76. build_from_mapping(
  77. mapping=mapping,
  78. tenant_id=tenant_id,
  79. config=config,
  80. )
  81. for mapping in mappings
  82. ]
  83. if (
  84. config
  85. # If image config is set.
  86. and config.image_config
  87. # And the number of image files exceeds the maximum limit
  88. and sum(1 for _ in (filter(lambda x: x.type == FileType.IMAGE, files))) > config.image_config.number_limits
  89. ):
  90. raise ValueError(f"Number of image files exceeds the maximum limit {config.image_config.number_limits}")
  91. if config and config.number_limits and len(files) > config.number_limits:
  92. raise ValueError(f"Number of files exceeds the maximum limit {config.number_limits}")
  93. return files
  94. def _build_from_local_file(
  95. *,
  96. mapping: Mapping[str, Any],
  97. tenant_id: str,
  98. transfer_method: FileTransferMethod,
  99. ) -> File:
  100. stmt = select(UploadFile).where(
  101. UploadFile.id == mapping.get("upload_file_id"),
  102. UploadFile.tenant_id == tenant_id,
  103. )
  104. row = db.session.scalar(stmt)
  105. if row is None:
  106. raise ValueError("Invalid upload file")
  107. file_type = FileType(mapping.get("type", "custom"))
  108. file_type = _standardize_file_type(file_type, extension="." + row.extension, mime_type=row.mime_type)
  109. return File(
  110. id=mapping.get("id"),
  111. filename=row.name,
  112. extension="." + row.extension,
  113. mime_type=row.mime_type,
  114. tenant_id=tenant_id,
  115. type=file_type,
  116. transfer_method=transfer_method,
  117. remote_url=row.source_url,
  118. related_id=mapping.get("upload_file_id"),
  119. size=row.size,
  120. )
  121. def _build_from_remote_url(
  122. *,
  123. mapping: Mapping[str, Any],
  124. tenant_id: str,
  125. transfer_method: FileTransferMethod,
  126. ) -> File:
  127. url = mapping.get("url")
  128. if not url:
  129. raise ValueError("Invalid file url")
  130. mime_type, filename, file_size = _get_remote_file_info(url)
  131. extension = mimetypes.guess_extension(mime_type) or "." + filename.split(".")[-1] if "." in filename else ".bin"
  132. file_type = FileType(mapping.get("type", "custom"))
  133. file_type = _standardize_file_type(file_type, extension=extension, mime_type=mime_type)
  134. return File(
  135. id=mapping.get("id"),
  136. filename=filename,
  137. tenant_id=tenant_id,
  138. type=file_type,
  139. transfer_method=transfer_method,
  140. remote_url=url,
  141. mime_type=mime_type,
  142. extension=extension,
  143. size=file_size,
  144. )
  145. def _get_remote_file_info(url: str):
  146. file_size = -1
  147. filename = url.split("/")[-1].split("?")[0] or "unknown_file"
  148. mime_type = mimetypes.guess_type(filename)[0] or ""
  149. resp = ssrf_proxy.head(url, follow_redirects=True)
  150. resp = cast(httpx.Response, resp)
  151. if resp.status_code == httpx.codes.OK:
  152. if content_disposition := resp.headers.get("Content-Disposition"):
  153. filename = str(content_disposition.split("filename=")[-1].strip('"'))
  154. file_size = int(resp.headers.get("Content-Length", file_size))
  155. mime_type = mime_type or str(resp.headers.get("Content-Type", ""))
  156. return mime_type, filename, file_size
  157. def _build_from_tool_file(
  158. *,
  159. mapping: Mapping[str, Any],
  160. tenant_id: str,
  161. transfer_method: FileTransferMethod,
  162. ) -> File:
  163. tool_file = (
  164. db.session.query(ToolFile)
  165. .filter(
  166. ToolFile.id == mapping.get("tool_file_id"),
  167. ToolFile.tenant_id == tenant_id,
  168. )
  169. .first()
  170. )
  171. if tool_file is None:
  172. raise ValueError(f"ToolFile {mapping.get('tool_file_id')} not found")
  173. extension = "." + tool_file.file_key.split(".")[-1] if "." in tool_file.file_key else ".bin"
  174. file_type = FileType(mapping.get("type", "custom"))
  175. file_type = _standardize_file_type(file_type, extension=extension, mime_type=tool_file.mimetype)
  176. return File(
  177. id=mapping.get("id"),
  178. tenant_id=tenant_id,
  179. filename=tool_file.name,
  180. type=file_type,
  181. transfer_method=transfer_method,
  182. remote_url=tool_file.original_url,
  183. related_id=tool_file.id,
  184. extension=extension,
  185. mime_type=tool_file.mimetype,
  186. size=tool_file.size,
  187. )
  188. def _is_file_valid_with_config(
  189. *,
  190. input_file_type: str,
  191. file_extension: str,
  192. file_transfer_method: FileTransferMethod,
  193. config: FileUploadConfig,
  194. ) -> bool:
  195. if (
  196. config.allowed_file_types
  197. and input_file_type not in config.allowed_file_types
  198. and input_file_type != FileType.CUSTOM
  199. ):
  200. return False
  201. if (
  202. input_file_type == FileType.CUSTOM
  203. and config.allowed_file_extensions is not None
  204. and file_extension not in config.allowed_file_extensions
  205. ):
  206. return False
  207. if input_file_type == FileType.IMAGE and config.image_config:
  208. if config.image_config.transfer_methods and file_transfer_method not in config.image_config.transfer_methods:
  209. return False
  210. return True
  211. def _standardize_file_type(file_type: FileType, /, *, extension: str = "", mime_type: str = "") -> FileType:
  212. """
  213. If custom type, try to guess the file type by extension and mime_type.
  214. """
  215. if file_type != FileType.CUSTOM:
  216. return FileType(file_type)
  217. guessed_type = None
  218. if extension:
  219. guessed_type = _get_file_type_by_extension(extension)
  220. if guessed_type is None and mime_type:
  221. guessed_type = _get_file_type_by_mimetype(mime_type)
  222. return guessed_type or FileType.CUSTOM
  223. def _get_file_type_by_extension(extension: str) -> FileType | None:
  224. extension = extension.lstrip(".")
  225. if extension in IMAGE_EXTENSIONS:
  226. return FileType.IMAGE
  227. elif extension in VIDEO_EXTENSIONS:
  228. return FileType.VIDEO
  229. elif extension in AUDIO_EXTENSIONS:
  230. return FileType.AUDIO
  231. elif extension in DOCUMENT_EXTENSIONS:
  232. return FileType.DOCUMENT
  233. def _get_file_type_by_mimetype(mime_type: str) -> FileType | None:
  234. if "image" in mime_type:
  235. file_type = FileType.IMAGE
  236. elif "video" in mime_type:
  237. file_type = FileType.VIDEO
  238. elif "audio" in mime_type:
  239. file_type = FileType.AUDIO
  240. elif "text" in mime_type or "pdf" in mime_type:
  241. file_type = FileType.DOCUMENT
  242. else:
  243. file_type = FileType.CUSTOM
  244. return file_type