UniqAI/open-webui
1
0
Fork 0
mirror of https://github.com/open-webui/open-webui synced 2025-02-06 13:10:16 +00:00
Code Issues Actions 11 Packages Projects Releases Wiki Activity

fix: restore __file__ variable for imported toolkits and functions

Browse Source 
Commit cf86ba7786 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__`.
This commit is contained in:
Etienne Perot 2024-09-18 01:08:30 -07:00
parent 1743d3c6c1
commit 6477bf37fe
No known key found for this signature in database
GPG Key ID: 4D061903EEDA047E
1 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
backend/open_webui/apps/webui/utils.py
View File

@ -84,7 +84,13 @@ def load_toolkit_module_by_id(toolkit_id, content=None):
module = types.ModuleType(module_name) module = types.ModuleType(module_name)
sys.modules[module_name] = module 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: 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 # Executing the modified content in the created module's namespace
exec(content, module.__dict__) exec(content, module.__dict__)
frontmatter = extract_frontmatter(content) frontmatter = extract_frontmatter(content)
@ -96,9 +102,11 @@ def load_toolkit_module_by_id(toolkit_id, content=None):
else: else:
raise Exception("No Tools class found in the module") raise Exception("No Tools class found in the module")
except Exception as e: 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 del sys.modules[module_name] # Clean up
raise e raise e
finally:
os.close(temp_fd)
def load_function_module_by_id(function_id, content=None): 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) module = types.ModuleType(module_name)
sys.modules[module_name] = module 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: 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 # Execute the modified content in the created module's namespace
exec(content, module.__dict__) exec(content, module.__dict__)
frontmatter = extract_frontmatter(content) frontmatter = extract_frontmatter(content)
@ -134,11 +148,13 @@ def load_function_module_by_id(function_id, content=None):
else: else:
raise Exception("No Function class found in the module") raise Exception("No Function class found in the module")
except Exception as e: 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 del sys.modules[module_name] # Cleanup by removing the module in case of error
Functions.update_function_by_id(function_id, {"is_active": False}) Functions.update_function_by_id(function_id, {"is_active": False})
raise e raise e
finally:
os.close(temp_fd)
def install_frontmatter_requirements(requirements): def install_frontmatter_requirements(requirements):