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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
|
"""
Plugin manager module.
Define the PluginManager class, the one that glues all the plugins and
the API together. Defines also a bunch of variables related to the
plugin env.
"""
import importlib
import os
import sys
import logging
from gettext import gettext as _
import tabs
from config import config
log = logging.getLogger(__name__)
plugins_dir = config.get('plugins_dir', '')
plugins_dir = plugins_dir or\
os.path.join(os.environ.get('XDG_DATA_HOME') or\
os.path.join(os.environ.get('HOME'), '.local', 'share'),
'poezio', 'plugins')
plugins_dir = os.path.expanduser(plugins_dir)
config_home = os.environ.get("XDG_CONFIG_HOME")
if not config_home:
config_home = os.path.join(os.environ.get('HOME'), '.config')
plugins_conf_dir = os.path.join(config_home, 'poezio', 'plugins')
try:
os.makedirs(plugins_dir)
except OSError:
pass
try:
os.makedirs(plugins_conf_dir)
except OSError:
pass
sys.path.append(plugins_dir)
finder = importlib.machinery.PathFinder()
class PluginManager(object):
"""
Plugin Manager
Contains all the references to the plugins
And keeps track of everything the plugin has done through the API.
"""
def __init__(self, core):
self.core = core
self.modules = {} # module name -> module object
self.plugins = {} # module name -> plugin object
self.commands = {} # module name -> dict of commands loaded for the module
self.event_handlers = {} # module name -> list of event_name/handler pairs loaded for the module
self.tab_commands = {} #module name -> dict of tab types; tab type -> commands loaded by the module
self.keys = {} # module name → dict of keys/handlers loaded for the module
self.tab_keys = {} #module name → dict of tab types; tab type → list of keybinds (tuples)
def load(self, name, notify=True):
"""
Load a plugin.
"""
if name in self.plugins:
self.unload(name)
try:
loader = finder.find_module(name)
if not loader:
self.core.information('Could not find plugin: %s' % name, 'Error')
return
module = loader.load_module()
except Exception as e:
import traceback
log.debug("Could not load plugin: \n%s", traceback.format_exc())
self.core.information("Could not load plugin: %s" % e, 'Error')
return
self.modules[name] = module
self.commands[name] = {}
self.keys[name] = {}
self.tab_keys[name] = {}
self.tab_commands[name] = {}
self.event_handlers[name] = []
self.plugins[name] = module.Plugin(self, self.core, plugins_conf_dir)
if notify:
self.core.information('Plugin %s loaded' % name, 'Info')
def unload(self, name, notify=True):
if name in self.plugins:
try:
for command in self.commands[name].keys():
del self.core.commands[command]
for key in self.keys[name].keys():
del self.core.key_func[key]
for tab in list(self.tab_commands[name].keys()):
for command in self.tab_commands[name][tab][:]:
self.del_tab_command(name, getattr(tabs, tab), command[0])
del self.tab_commands[name][tab]
for tab in list(self.tab_keys[name].keys()):
for key in self.tab_keys[name][tab][:]:
self.del_tab_key(name, getattr(tabs, tab), key[0])
del self.tab_keys[name][tab]
for event_name, handler in self.event_handlers[name][:]:
self.del_event_handler(name, event_name, handler)
self.plugins[name].unload()
del self.plugins[name]
del self.commands[name]
del self.keys[name]
del self.tab_commands[name]
del self.event_handlers[name]
if notify:
self.core.information('Plugin %s unloaded' % name, 'Info')
except Exception as e:
import traceback
log.debug("Could not unload plugin: \n%s", traceback.format_exc())
self.core.information("Could not unload plugin: %s" % e, 'Error')
def add_command(self, module_name, name, handler, help, completion=None):
"""
Add a global command.
"""
if name in self.core.commands:
raise Exception(_("Command '%s' already exists") % (name,))
commands = self.commands[module_name]
commands[name] = (handler, help, completion)
self.core.commands[name] = (handler, help, completion)
def del_command(self, module_name, name):
"""
Remove a global command added through add_command.
"""
if name in self.commands[module_name]:
del self.commands[module_name][name]
if name in self.core.commands:
del self.core.commands[name]
def add_tab_command(self, module_name, tab_type, name, handler, help, completion=None):
"""
Add a command only for a type of Tab.
"""
commands = self.tab_commands[module_name]
t = tab_type.__name__
if name in tab_type.plugin_commands:
return
if not t in commands:
commands[t] = []
commands[t].append((name, handler, help, completion))
tab_type.plugin_commands[name] = (handler, help, completion)
for tab in self.core.tabs:
if isinstance(tab, tab_type):
tab.update_commands()
def del_tab_command(self, module_name, tab_type, name):
"""
Remove a command added through add_tab_command.
"""
commands = self.tab_commands[module_name]
t = tab_type.__name__
if not t in commands:
return
for command in commands[t]:
if command[0] == name:
commands[t].remove(command)
del tab_type.plugin_commands[name]
for tab in self.core.tabs:
if isinstance(tab, tab_type) and name in tab.commands:
del tab.commands[name]
def add_tab_key(self, module_name, tab_type, key, handler):
"""
Associate a key binding to a handler only for a type of Tab.
"""
keys = self.tab_keys[module_name]
t = tab_type.__name__
if key in tab_type.plugin_keys:
return
if not t in keys:
keys[t] = []
keys[t].append((key, handler))
tab_type.plugin_keys[key] = handler
for tab in self.core.tabs:
if isinstance(tab, tab_type):
tab.update_keys()
def del_tab_key(self, module_name, tab_type, key):
"""
Remove a key binding added through add_tab_key.
"""
keys = self.tab_keys[module_name]
t = tab_type.__name__
if not t in keys:
return
for _key in keys[t]:
if _key[0] == key:
keys[t].remove(_key)
del tab_type.plugin_keys[key]
for tab in self.core.tabs:
if isinstance(tab, tab_type) and key in tab.key_func:
del tab.key_func[key]
def add_key(self, module_name, key, handler):
"""
Associate a global key binding to a handler, except if it
already exists.
"""
if key in self.core.key_func:
raise Exception(_("Key '%s' already exists") % (key,))
keys = self.keys[module_name]
keys[key] = handler
self.core.key_func[key] = handler
def del_key(self, module_name, key):
"""
Remove a global key binding added by a plugin.
"""
if key in self.keys[module_name]:
del self.keys[module_name][key]
if key in self.core.key_func:
del self.core.commands[key]
def add_event_handler(self, module_name, event_name, handler, position=0):
"""
Add an event handler. If event_name isn’t in the event list, assume
it is a sleekxmpp event.
"""
eh = self.event_handlers[module_name]
eh.append((event_name, handler))
if event_name in self.core.events.events:
self.core.events.add_event_handler(event_name, handler, position)
else:
self.core.xmpp.add_event_handler(event_name, handler)
def del_event_handler(self, module_name, event_name, handler):
"""
Remove an event handler if it exists.
"""
if event_name in self.core.events.events:
self.core.events.del_event_handler(None, handler)
else:
self.core.xmpp.del_event_handler(event_name, handler)
eh = self.event_handlers[module_name]
eh = list(filter(lambda e : e != (event_name, handler), eh))
def completion_load(self, the_input):
"""
completion function that completes the name of the plugins, from
all .py files in plugins_dir
"""
try:
names = os.listdir(plugins_dir)
except OSError as e:
self.core.information(_('Completion failed: %s' % e), 'Error')
return
plugins_files = [name[:-3] for name in names if name.endswith('.py')]
return the_input.auto_completion(plugins_files, '', quotify=False)
def completion_unload(self, the_input):
"""
completion function that completes the name of the plugins that are loaded
"""
return the_input.auto_completion(list(self.plugins.keys()), '', quotify=False)
def on_plugins_dir_change(self, new_value):
global plugins_dir
if plugins_dir in sys.path:
sys.path.remove(plugins_dir)
sys.path.append(new_value)
plugins_dir = new_value
|
