forked from EDCD/EDMarketConnector
-
Notifications
You must be signed in to change notification settings - Fork 0
/
plug.py
304 lines (269 loc) · 10.2 KB
/
plug.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
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
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
"""
Plugin hooks for EDMC - Ian Norton, Jonathan Harris
"""
import os
import imp
import sys
import operator
import threading # We don't use it, but plugins might
from traceback import print_exc
import Tkinter as tk
import myNotebook as nb
from config import config
# List of loaded Plugins
PLUGINS = []
# For asynchronous error display
last_error = {
'msg': None,
'root': None,
}
class Plugin(object):
def __init__(self, name, loadfile):
"""
Load a single plugin
:param name: module name
:param loadfile: the main .py file
:raises Exception: Typically ImportError or OSError
"""
self.name = name # Display name.
self.folder = name # basename of plugin folder. None for internal plugins.
self.module = None # None for disabled plugins.
if loadfile:
sys.stdout.write(('loading plugin %s from "%s"\n' % (name, loadfile)).encode('utf-8'))
with open(loadfile, 'rb') as plugfile:
module = imp.load_module('plugin_%s' % name.encode('ascii', 'replace'), plugfile, loadfile.encode(sys.getfilesystemencoding()),
('.py', 'r', imp.PY_SOURCE))
newname = module.plugin_start()
self.name = newname and unicode(newname) or name
self.module = module
else:
sys.stdout.write('plugin %s disabled\n' % name)
def _get_func(self, funcname):
"""
Get a function from a plugin, else return None if it isn't implemented.
:param funcname:
:return:
"""
return getattr(self.module, funcname, None)
def get_app(self, parent):
"""
If the plugin provides mainwindow content create and return it.
:param parent: the parent frame for this entry.
:return:
"""
plugin_app = self._get_func('plugin_app')
if plugin_app:
try:
appitem = plugin_app(parent)
if isinstance(appitem, tuple):
if len(appitem) != 2 or not isinstance(appitem[0], tk.Widget) or not isinstance(appitem[1], tk.Widget):
raise AssertionError
elif not isinstance(appitem, tk.Widget):
raise AssertionError
return appitem
except:
print_exc()
return None
def get_prefs(self, parent, cmdr, is_beta):
"""
If the plugin provides a prefs frame, create and return it.
:param parent: the parent frame for this preference tab.
:param cmdr: current Cmdr name (or None). Relevant if you want to have
different settings for different user accounts.
:param is_beta: whether the player is in a Beta universe.
:return:
"""
plugin_prefs = self._get_func('plugin_prefs')
if plugin_prefs:
try:
if plugin_prefs.func_code.co_argcount == 1:
frame = plugin_prefs(parent)
else:
frame = plugin_prefs(parent, cmdr, is_beta)
if not isinstance(frame, nb.Frame):
raise AssertionError
return frame
except:
print_exc()
return None
def load_plugins(master):
"""
Find and load all plugins
:return:
"""
last_error['root'] = master
imp.acquire_lock()
internal = []
for name in os.listdir(config.internal_plugin_dir):
if name.endswith('.py') and not name[0] in ['.', '_']:
try:
plugin = Plugin(name[:-3], os.path.join(config.internal_plugin_dir, name))
plugin.folder = None # Suppress listing in Plugins prefs tab
internal.append(plugin)
except:
print_exc()
PLUGINS.extend(sorted(internal, key = lambda p: operator.attrgetter('name')(p).lower()))
found = []
for name in os.listdir(config.plugin_dir):
if name[0] in ['.', '_']:
pass
elif name.endswith('.disabled'):
name, discard = name.rsplit('.', 1)
found.append(Plugin(name, None))
else:
try:
# Add plugin's folder to Python's load path in case plugin has dependencies.
sys.path.append(os.path.join(config.plugin_dir, name))
found.append(Plugin(name, os.path.join(config.plugin_dir, name, 'load.py')))
except:
print_exc()
PLUGINS.extend(sorted(found, key = lambda p: operator.attrgetter('name')(p).lower()))
imp.release_lock()
def notify_stop():
"""
Notify each plugin that the program is closing.
If your plugin uses threads then stop and join() them before returning.
versionadded:: 2.3.7
"""
error = None
for plugin in PLUGINS:
plugin_stop = plugin._get_func('plugin_stop')
if plugin_stop:
try:
newerror = plugin_stop()
error = error or newerror
except:
print_exc()
return error
def notify_prefs_cmdr_changed(cmdr, is_beta):
"""
Notify each plugin that the Cmdr has been changed while the settings dialog is open.
Relevant if you want to have different settings for different user accounts.
:param cmdr: current Cmdr name (or None).
:param is_beta: whether the player is in a Beta universe.
:return:
"""
for plugin in PLUGINS:
prefs_cmdr_changed = plugin._get_func('prefs_cmdr_changed')
if prefs_cmdr_changed:
try:
prefs_cmdr_changed(cmdr, is_beta)
except:
print_exc()
def notify_prefs_changed(cmdr, is_beta):
"""
Notify each plugin that the settings dialog has been closed.
The prefs frame and any widgets you created in your `get_prefs()` callback
will be destroyed on return from this function, so take a copy of any
values that you want to save.
:param cmdr: current Cmdr name (or None).
:param is_beta: whether the player is in a Beta universe.
:return:
"""
for plugin in PLUGINS:
prefs_changed = plugin._get_func('prefs_changed')
if prefs_changed:
try:
if prefs_changed.func_code.co_argcount == 0:
prefs_changed()
else:
prefs_changed(cmdr, is_beta)
except:
print_exc()
def notify_journal_entry(cmdr, is_beta, system, station, entry, state):
"""
Send a journal entry to each plugin.
:param cmdr: The Cmdr name, or None if not yet known
:param system: The current system, or None if not yet known
:param station: The current station, or None if not docked or not yet known
:param entry: The journal entry as a dictionary
:param state: A dictionary containing info about the Cmdr, current ship and cargo
:param is_beta: whether the player is in a Beta universe.
:return: Error message from the first plugin that returns one (if any)
"""
error = None
for plugin in PLUGINS:
journal_entry = plugin._get_func('journal_entry')
if journal_entry:
try:
# Pass a copy of the journal entry in case the callee modifies it
if journal_entry.func_code.co_argcount == 4:
newerror = journal_entry(cmdr, system, station, dict(entry))
elif journal_entry.func_code.co_argcount == 5:
newerror = journal_entry(cmdr, system, station, dict(entry), dict(state))
else:
newerror = journal_entry(cmdr, is_beta, system, station, dict(entry), dict(state))
error = error or newerror
except:
print_exc()
return error
def notify_interaction(cmdr, is_beta, entry):
"""
Send an interaction entry to each plugin.
:param cmdr: The piloting Cmdr name
:param is_beta: whether the player is in a Beta universe.
:param entry: The interaction entry as a dictionary
:return: Error message from the first plugin that returns one (if any)
"""
error = None
for plugin in PLUGINS:
interaction = plugin._get_func('interaction')
if interaction:
try:
# Pass a copy of the interaction entry in case the callee modifies it
if interaction.func_code.co_argcount == 2:
newerror = interaction(cmdr, dict(entry))
else:
newerror = interaction(cmdr, is_beta, dict(entry))
error = error or newerror
except:
print_exc()
return error
def notify_system_changed(timestamp, system, coordinates):
"""
Send notification data to each plugin when we arrive at a new system.
:param timestamp:
:param system:
:return:
deprecated:: 2.2
Use :func:`journal_entry` with the 'FSDJump' event.
"""
for plugin in PLUGINS:
system_changed = plugin._get_func('system_changed')
if system_changed:
try:
if system_changed.func_code.co_argcount == 2:
system_changed(timestamp, system)
else:
system_changed(timestamp, system, coordinates)
except:
print_exc()
def notify_newdata(data, is_beta):
"""
Send the latest EDMC data from the FD servers to each plugin
:param data:
:param is_beta: whether the player is in a Beta universe.
:return: Error message from the first plugin that returns one (if any)
"""
error = None
for plugin in PLUGINS:
cmdr_data = plugin._get_func('cmdr_data')
if cmdr_data:
try:
if cmdr_data.func_code.co_argcount == 1:
newerror = cmdr_data(data)
else:
newerror = cmdr_data(data, is_beta)
error = error or newerror
except:
print_exc()
return error
def show_error(err):
"""
Display an error message in the status line of the main window.
:param err:
versionadded:: 2.3.7
"""
if err and last_error['root']:
last_error['msg'] = unicode(err)
last_error['root'].event_generate('<<PluginError>>', when="tail")