forked from EmpireProject/Empire
-
-
Notifications
You must be signed in to change notification settings - Fork 573
/
plugins.py
41 lines (31 loc) · 1.18 KB
/
plugins.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
""" Utilities and helpers and etc. for plugins """
import logging
log = logging.getLogger(__name__)
class BasePlugin:
# to be overwritten by child
def __init__(self, mainMenu):
# having these multiple messages should be helpful for debugging
# user-reported errors (can narrow down where they happen)
# any future init stuff goes here
try:
# do custom user stuff
self.onLoad()
log.info(f"Initializing plugin: {self.info['Name']}")
# Register functions to the main menu
self.register(mainMenu)
# Give access to main menu
self.mainMenu = mainMenu
except Exception as e:
if self.info["Name"]:
log.error(f"{self.info['Name']} failed to initialize: {e}")
else:
log.error(f"Error initializing plugin: {e}")
def onLoad(self):
"""Things to do during init: meant to be overridden by
the inheriting plugin."""
pass
def register(self, mainMenu):
"""Any modifications made to the main menu are done here
(meant to be overriden by child)"""
pass
Plugin = BasePlugin