-
Notifications
You must be signed in to change notification settings - Fork 11
/
plugin_loader.py
198 lines (174 loc) · 7.7 KB
/
plugin_loader.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
import hashlib
import importlib.util
import os
import subprocess
import sys
from config import get_app_path, relay_config
from log_utils import get_logger
logger = get_logger(name="Plugins")
sorted_active_plugins = []
plugins_loaded = False
def clone_or_update_repo(repo_url, tag, plugins_dir):
# Extract the repository name from the URL
repo_name = os.path.splitext(os.path.basename(repo_url.rstrip("/")))[0]
repo_path = os.path.join(plugins_dir, repo_name)
if os.path.isdir(repo_path):
try:
subprocess.check_call(["git", "-C", repo_path, "fetch"])
subprocess.check_call(["git", "-C", repo_path, "checkout", tag])
subprocess.check_call(["git", "-C", repo_path, "pull", "origin", tag])
logger.info(f"Updated repository {repo_name} to {tag}")
except subprocess.CalledProcessError as e:
logger.error(f"Error updating repository {repo_name}: {e}")
logger.error(
f"Please manually git clone the repository {repo_url} into {repo_path}"
)
sys.exit(1)
else:
try:
os.makedirs(plugins_dir, exist_ok=True)
subprocess.check_call(
["git", "clone", "--branch", tag, repo_url], cwd=plugins_dir
)
logger.info(f"Cloned repository {repo_name} from {repo_url} at {tag}")
except subprocess.CalledProcessError as e:
logger.error(f"Error cloning repository {repo_name}: {e}")
logger.error(
f"Please manually git clone the repository {repo_url} into {repo_path}"
)
sys.exit(1)
# Install requirements if requirements.txt exists
requirements_path = os.path.join(repo_path, "requirements.txt")
if os.path.isfile(requirements_path):
try:
# Use pip to install the requirements.txt
subprocess.check_call(
[sys.executable, "-m", "pip", "install", "-r", requirements_path]
)
logger.info(f"Installed requirements for plugin {repo_name}")
except subprocess.CalledProcessError as e:
logger.error(f"Error installing requirements for plugin {repo_name}: {e}")
logger.error(
f"Please manually install the requirements from {requirements_path}"
)
sys.exit(1)
def load_plugins_from_directory(directory, recursive=False):
plugins = []
if os.path.isdir(directory):
for root, _dirs, files in os.walk(directory):
for filename in files:
if filename.endswith(".py"):
plugin_path = os.path.join(root, filename)
module_name = (
"plugin_"
+ hashlib.sha256(plugin_path.encode("utf-8")).hexdigest()
)
spec = importlib.util.spec_from_file_location(
module_name, plugin_path
)
plugin_module = importlib.util.module_from_spec(spec)
try:
spec.loader.exec_module(plugin_module)
if hasattr(plugin_module, "Plugin"):
plugins.append(plugin_module.Plugin())
else:
logger.warning(
f"{plugin_path} does not define a Plugin class."
)
except Exception as e:
logger.error(f"Error loading plugin {plugin_path}: {e}")
if not recursive:
break
else:
if not plugins_loaded: # Only log the missing directory once
logger.debug(f"Directory {directory} does not exist.")
return plugins
def load_plugins():
global sorted_active_plugins
global plugins_loaded
if plugins_loaded:
return sorted_active_plugins
logger.debug("Loading plugins...")
config = relay_config # Use relay_config loaded in config.py
# Import core plugins
from plugins.debug_plugin import Plugin as DebugPlugin
from plugins.drop_plugin import Plugin as DropPlugin
from plugins.health_plugin import Plugin as HealthPlugin
from plugins.help_plugin import Plugin as HelpPlugin
from plugins.map_plugin import Plugin as MapPlugin
from plugins.mesh_relay_plugin import Plugin as MeshRelayPlugin
from plugins.nodes_plugin import Plugin as NodesPlugin
from plugins.ping_plugin import Plugin as PingPlugin
from plugins.telemetry_plugin import Plugin as TelemetryPlugin
from plugins.weather_plugin import Plugin as WeatherPlugin
# Initial list of core plugins
core_plugins = [
HealthPlugin(),
MapPlugin(),
MeshRelayPlugin(),
PingPlugin(),
TelemetryPlugin(),
WeatherPlugin(),
HelpPlugin(),
NodesPlugin(),
DropPlugin(),
DebugPlugin(),
]
plugins = core_plugins.copy()
# Load custom plugins (non-recursive)
custom_plugins_dir = os.path.join(
get_app_path(), "plugins", "custom"
) # Use get_app_path()
plugins.extend(load_plugins_from_directory(custom_plugins_dir, recursive=False))
# Process and download community plugins
community_plugins_config = config.get("community-plugins", {})
community_plugins_dir = os.path.join(
get_app_path(), "plugins", "community"
) # Use get_app_path()
# Create community plugins directory if needed
if any(
plugin_info.get("active", False)
for plugin_info in community_plugins_config.values()
):
os.makedirs(community_plugins_dir, exist_ok=True)
for plugin_info in community_plugins_config.values():
if plugin_info.get("active", False):
repo_url = plugin_info.get("repository")
tag = plugin_info.get("tag", "master")
if repo_url:
clone_or_update_repo(repo_url, tag, community_plugins_dir)
else:
logger.error("Repository URL not specified for a community plugin")
logger.error("Please specify the repository URL in config.yaml")
sys.exit(1)
# Load community plugins (recursive)
plugins.extend(load_plugins_from_directory(community_plugins_dir, recursive=True))
# Filter and sort active plugins by priority
active_plugins = []
for plugin in plugins:
plugin_name = getattr(plugin, "plugin_name", plugin.__class__.__name__)
# Determine if the plugin is active based on the configuration
if plugin in core_plugins:
# Core plugins: default to inactive unless specified otherwise
plugin_config = config.get("plugins", {}).get(plugin_name, {})
is_active = plugin_config.get("active", False)
else:
# Custom and community plugins: default to inactive unless specified
if plugin_name in config.get("custom-plugins", {}):
plugin_config = config.get("custom-plugins", {}).get(plugin_name, {})
elif plugin_name in community_plugins_config:
plugin_config = community_plugins_config.get(plugin_name, {})
else:
plugin_config = {}
is_active = plugin_config.get("active", False)
if is_active:
plugin.priority = plugin_config.get(
"priority", getattr(plugin, "priority", 100)
)
active_plugins.append(plugin)
try:
plugin.start()
except Exception as e:
logger.error(f"Error starting plugin {plugin_name}: {e}")
sorted_active_plugins = sorted(active_plugins, key=lambda plugin: plugin.priority)
plugins_loaded = True # Set the flag to indicate that plugins have been load