From 6477bf37fec3f736aa659c3a9e1de1d09cad5365 Mon Sep 17 00:00:00 2001 From: Etienne Perot Date: Wed, 18 Sep 2024 01:08:30 -0700 Subject: [PATCH] fix: restore `__file__` variable for imported toolkits and functions Commit cf86ba778605bf0e7494817e83dbf940c0086277 changed the way toolkits and functions were imported to use `exec`, whereas they previously were written to files and `import`ed. The use of `exec` means that module-global variables such as `__file__` are no longer defined. This breaks https://github.com/EtiennePerot/open-webui-code-execution (code execution tool for Open WebUI), as the module needs to re-execute its own code in a subprocess in order to properly sandbox itself. This is done using `__file__` in order to know where the module's code is located. This PR creates a temporary in-memory file that contains the imported toolkit or function's code and exists only during the import process. Then it injects the path to this in-memory file as the `__file__` variable in the `exec` context. This restores the ability for the toolkit or function being imported to rely on `__file__`. --- backend/open_webui/apps/webui/utils.py | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/backend/open_webui/apps/webui/utils.py b/backend/open_webui/apps/webui/utils.py index 2d537af51..3d43b9a9a 100644 --- a/backend/open_webui/apps/webui/utils.py +++ b/backend/open_webui/apps/webui/utils.py @@ -84,7 +84,13 @@ def load_toolkit_module_by_id(toolkit_id, content=None): module = types.ModuleType(module_name) sys.modules[module_name] = module + # Create a temporary in-memory file and use it to define `__file__` so + # that it works as expected from the module's perspective. + temp_fd = os.memfd_create(f"tmp:{module_name}") try: + os.write(temp_fd, content.encode("utf-8")) + module.__dict__["__file__"] = f"/proc/{os.getpid()}/fd/{temp_fd}" + # Executing the modified content in the created module's namespace exec(content, module.__dict__) frontmatter = extract_frontmatter(content) @@ -96,9 +102,11 @@ def load_toolkit_module_by_id(toolkit_id, content=None): else: raise Exception("No Tools class found in the module") except Exception as e: - print(f"Error loading module: {toolkit_id}") + print(f"Error loading module: {toolkit_id}: {e}") del sys.modules[module_name] # Clean up raise e + finally: + os.close(temp_fd) def load_function_module_by_id(function_id, content=None): @@ -118,7 +126,13 @@ def load_function_module_by_id(function_id, content=None): module = types.ModuleType(module_name) sys.modules[module_name] = module + # Create a temporary in-memory file and use it to define `__file__` so + # that it works as expected from the module's perspective. + temp_fd = os.memfd_create(f"tmp:{module_name}") try: + os.write(temp_fd, content.encode("utf-8")) + module.__dict__["__file__"] = f"/proc/{os.getpid()}/fd/{temp_fd}" + # Execute the modified content in the created module's namespace exec(content, module.__dict__) frontmatter = extract_frontmatter(content) @@ -134,11 +148,13 @@ def load_function_module_by_id(function_id, content=None): else: raise Exception("No Function class found in the module") except Exception as e: - print(f"Error loading module: {function_id}") + print(f"Error loading module: {function_id}: {e}") del sys.modules[module_name] # Cleanup by removing the module in case of error Functions.update_function_by_id(function_id, {"is_active": False}) raise e + finally: + os.close(temp_fd) def install_frontmatter_requirements(requirements):