aboutsummaryrefslogtreecommitdiff
path: root/autogpts/autogpt/autogpt/plugins/plugins_config.py
diff options
context:
space:
mode:
Diffstat (limited to 'autogpts/autogpt/autogpt/plugins/plugins_config.py')
-rw-r--r--autogpts/autogpt/autogpt/plugins/plugins_config.py118
1 files changed, 118 insertions, 0 deletions
diff --git a/autogpts/autogpt/autogpt/plugins/plugins_config.py b/autogpts/autogpt/autogpt/plugins/plugins_config.py
new file mode 100644
index 000000000..0494b6e38
--- /dev/null
+++ b/autogpts/autogpt/autogpt/plugins/plugins_config.py
@@ -0,0 +1,118 @@
+from __future__ import annotations
+
+import logging
+from pathlib import Path
+from typing import Union
+
+import yaml
+from pydantic import BaseModel
+
+from autogpt.plugins.plugin_config import PluginConfig
+
+logger = logging.getLogger(__name__)
+
+
+class PluginsConfig(BaseModel):
+ """Class for holding configuration of all plugins"""
+
+ plugins: dict[str, PluginConfig]
+
+ def __repr__(self):
+ return f"PluginsConfig({self.plugins})"
+
+ def get(self, name: str) -> Union[PluginConfig, None]:
+ return self.plugins.get(name)
+
+ def is_enabled(self, name) -> bool:
+ plugin_config = self.plugins.get(name)
+ return plugin_config is not None and plugin_config.enabled
+
+ @classmethod
+ def load_config(
+ cls,
+ plugins_config_file: Path,
+ plugins_denylist: list[str],
+ plugins_allowlist: list[str],
+ ) -> "PluginsConfig":
+ empty_config = cls(plugins={})
+
+ try:
+ config_data = cls.deserialize_config_file(
+ plugins_config_file,
+ plugins_denylist,
+ plugins_allowlist,
+ )
+ if type(config_data) is not dict:
+ logger.error(
+ f"Expected plugins config to be a dict, got {type(config_data)}."
+ " Continuing without plugins."
+ )
+ return empty_config
+ return cls(plugins=config_data)
+
+ except BaseException as e:
+ logger.error(
+ f"Plugin config is invalid. Continuing without plugins. Error: {e}"
+ )
+ return empty_config
+
+ @classmethod
+ def deserialize_config_file(
+ cls,
+ plugins_config_file: Path,
+ plugins_denylist: list[str],
+ plugins_allowlist: list[str],
+ ) -> dict[str, PluginConfig]:
+ if not plugins_config_file.is_file():
+ logger.warning("plugins_config.yaml does not exist, creating base config.")
+ cls.create_empty_plugins_config(
+ plugins_config_file,
+ plugins_denylist,
+ plugins_allowlist,
+ )
+
+ with open(plugins_config_file, "r") as f:
+ plugins_config = yaml.load(f, Loader=yaml.FullLoader)
+
+ plugins = {}
+ for name, plugin in plugins_config.items():
+ if type(plugin) is dict:
+ plugins[name] = PluginConfig(
+ name=name,
+ enabled=plugin.get("enabled", False),
+ config=plugin.get("config", {}),
+ )
+ elif isinstance(plugin, PluginConfig):
+ plugins[name] = plugin
+ else:
+ raise ValueError(f"Invalid plugin config data type: {type(plugin)}")
+ return plugins
+
+ @staticmethod
+ def create_empty_plugins_config(
+ plugins_config_file: Path,
+ plugins_denylist: list[str],
+ plugins_allowlist: list[str],
+ ):
+ """
+ Create an empty plugins_config.yaml file.
+ Fill it with values from old env variables.
+ """
+ base_config = {}
+
+ logger.debug(f"Legacy plugin denylist: {plugins_denylist}")
+ logger.debug(f"Legacy plugin allowlist: {plugins_allowlist}")
+
+ # Backwards-compatibility shim
+ for plugin_name in plugins_denylist:
+ base_config[plugin_name] = {"enabled": False, "config": {}}
+
+ for plugin_name in plugins_allowlist:
+ base_config[plugin_name] = {"enabled": True, "config": {}}
+
+ logger.debug(f"Constructed base plugins config: {base_config}")
+
+ logger.debug(f"Creating plugin config file {plugins_config_file}")
+ with open(plugins_config_file, "w+") as f:
+ f.write(yaml.dump(base_config))
+ return base_config