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
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
|
# This file is part of Gajim.
#
# Gajim is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published
# by the Free Software Foundation; version 3 only.
#
# Gajim is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Gajim. If not, see <http://www.gnu.org/licenses/>.
from __future__ import annotations
from typing import Any
import logging
import os
import sys
import zipfile
from collections.abc import Callable
from importlib.util import module_from_spec
from importlib.util import spec_from_file_location
from pathlib import Path
from shutil import move
from shutil import rmtree
from types import TracebackType
from gajim.common import app
from gajim.common import configpaths
from gajim.common import modules
from gajim.common.client import Client
from gajim.common.exceptions import PluginsystemError
from gajim.common.i18n import _
from gajim.common.util.classes import Singleton
from .events import PluginAdded
from .events import PluginRemoved
from .gajimplugin import GajimPlugin
from .gajimplugin import GajimPluginException
from .helpers import GajimPluginActivateException
from .helpers import is_shipped_plugin
from .manifest import PluginManifest
log = logging.getLogger('gajim.p.manager')
RmErrorT = tuple[type[BaseException], BaseException, TracebackType]
FIELDS = ('name',
'short_name',
'version',
'description',
'authors',
'homepage')
class PluginManager(metaclass=Singleton):
'''
Main plug-in management class.
'''
def __init__(self):
self.plugins: list[GajimPlugin] = []
'''
Detected plugin classes.
Each class object in list is `GajimPlugin` subclass.
'''
self.active_plugins: list[GajimPlugin] = []
'''
Instance objects of active plugins.
These are object instances of classes held `plugins`, but only those
that were activated.
'''
self.gui_extension_points: dict[str, Any] = {}
'''
Registered GUI extension points.
'''
self.gui_extension_points_handlers: dict[str, Any] = {}
'''
Registered handlers of GUI extension points.
'''
self.encryption_plugins: dict[str, GajimPlugin] = {}
'''
Registered names with instances of encryption Plugins.
'''
self.update_plugins()
self._load_manifests()
def update_plugins(self,
replace: bool = True,
activate: bool = False,
plugin_name: str | None = None
) -> list[str]:
'''
Move plugins from the downloaded folder to the user plugin folder
:param replace: replace plugin files if they already exist.
:param activate: load and activate the plugin
:param plugin_name: if provided, update only this plugin
:return: list of updated plugins (files have been installed)
'''
updated_plugins: list[str] = []
user_dir = configpaths.get('PLUGINS_USER')
dl_dir = configpaths.get('PLUGINS_DOWNLOAD')
to_update = [plugin_name] if plugin_name else next(os.walk(dl_dir))[1]
for directory in to_update:
src_dir = dl_dir / directory
dst_dir = user_dir / directory
try:
if dst_dir.exists():
if not replace:
continue
self.delete_plugin_files(dst_dir)
move(src_dir, dst_dir)
except Exception:
log.exception('Upgrade of plugin %s failed. '
'Impossible to move files from "%s" to "%s"',
directory, src_dir, dst_dir)
continue
updated_plugins.append(directory)
if activate:
manifest = self._load_manifest(Path(dst_dir))
if manifest is None or not manifest.is_usable:
log.warning('Error while updating plugin')
continue
self.add_plugin(manifest, activate=True)
return updated_plugins
def init_plugins(self) -> None:
for plugin in self.plugins:
if not app.settings.get_plugin_setting(plugin.manifest.short_name,
'active'):
continue
if not plugin.activatable:
continue
try:
self.activate_plugin(plugin)
except GajimPluginActivateException as error:
plugin.activatable = False
plugin.available_text = str(error)
def _load_plugin_module(self,
manifest: PluginManifest
) -> type[GajimPlugin] | None:
assert manifest.path is not None
module_path = manifest.path / '__init__.py'
if not module_path.exists():
# On Windows we only ship compiled files
module_path = manifest.path / '__init__.pyc'
module_name = manifest.path.stem
try:
spec = spec_from_file_location(module_name, module_path)
if spec is None:
return None
module = module_from_spec(spec)
sys.modules[spec.name] = module
assert spec.loader is not None
spec.loader.exec_module(module)
except Exception as error:
log.warning('Error while loading module: %s', error)
return None
for module_attr_name in dir(module):
module_attr = getattr(module, module_attr_name)
if issubclass(module_attr, GajimPlugin):
module_attr.manifest = manifest
module_attr.__path__ = str(manifest.path)
return module_attr
return None
def add_plugin(self,
manifest: PluginManifest,
activate: bool = False
) -> GajimPlugin | None:
plugin_class = self._load_plugin_module(manifest)
if plugin_class is None:
return None
if manifest in [p.manifest for p in self.plugins]:
log.info('Not loading plugin %s v %s. Plugin already loaded.',
manifest.short_name,
manifest.version)
return None
try:
plugin_obj = plugin_class()
except Exception:
log.exception('Error while loading a plugin')
return None
if manifest.short_name not in app.settings.get_plugins():
app.settings.set_plugin_setting(manifest.short_name,
'active',
manifest.is_shipped)
self.plugins.append(plugin_obj)
plugin_obj.active = False
if activate:
self.activate_plugin(plugin_obj)
app.ged.raise_event(PluginAdded(manifest=manifest))
return plugin_obj
def remove_plugin(self, plugin: GajimPlugin) -> None:
'''
removes the plugin from the plugin list and deletes all loaded modules
from sys. This way we will have a fresh start when the plugin gets added
again.
'''
if plugin.active:
self.deactivate_plugin(plugin)
self.plugins.remove(plugin)
# remove modules from cache
base_package = plugin.__module__.split('.')[0]
# get the subpackages/-modules of the base_package. Add a dot to the
# name to avoid name problems (removing module_abc if base_package is
# module_ab)
modules_to_remove = [module for module in sys.modules
if module.startswith(f'{base_package}.')]
# remove the base_package itself
if base_package in sys.modules:
modules_to_remove.append(base_package)
for module_to_remove in modules_to_remove:
del sys.modules[module_to_remove]
def get_active_plugin(self, plugin_name: str) -> GajimPlugin | None:
for plugin in self.active_plugins:
if plugin.manifest.short_name == plugin_name:
return plugin
return None
def get_plugin(self, short_name: str) -> GajimPlugin | None:
for plugin in self.plugins:
if plugin.manifest.short_name == short_name:
return plugin
return None
def extension_point(self, gui_extpoint_name: str, *args: Any) -> None:
'''
Invokes all handlers (from plugins) for a particular extension point,
but doesn't add it to collection for further processing.
For example if you pass a message for encryption via extension point to
a plugin, its undesired that the call is stored and replayed on
activating the plugin. For example after an update.
:param gui_extpoint_name: name of GUI extension point.
:param args: parameters to be passed to extension point handlers
(typically and object that invokes `gui_extension_point`;
however, this can be practically anything)
:type args: tuple
'''
self._execute_all_handlers_of_gui_extension_point(
gui_extpoint_name, *args)
def gui_extension_point(self, gui_extpoint_name: str, *args: Any) -> None:
'''
Invokes all handlers (from plugins) for particular GUI extension point
and adds it to collection for further processing (eg. by plugins not
active yet).
:param gui_extpoint_name: name of GUI extension point.
:param args: parameters to be passed to extension point handlers
(typically and object that invokes `gui_extension_point`;
however, this can be practically anything)
:type args: tuple
'''
self._add_gui_extension_point_call_to_list(gui_extpoint_name, *args)
self._execute_all_handlers_of_gui_extension_point(
gui_extpoint_name,
*args)
def remove_gui_extension_point(self,
gui_extpoint_name: str,
*args: Any
) -> None:
'''
Removes GUI extension point from collection held by `PluginManager`.
From this point this particular extension point won't be visible
to plugins (eg. it won't invoke any handlers when plugin is activated).
GUI extension point is removed completely (there is no way to recover it
from inside `PluginManager`).
Removal is needed when instance object that given extension point was
connect with is destroyed (eg. ChatControl is closed or context menu
is hidden).
Each `PluginManager.gui_extension_point` call should have a call of
`PluginManager.remove_gui_extension_point` related to it.
:note: in current implementation different arguments mean different
extension points. The same arguments and the same name mean
the same extension point.
:param gui_extpoint_name: name of GUI extension point.
:param args: arguments that `PluginManager.gui_extension_point` was
called with for this extension point. This is used (along with
extension point name) to identify element to be removed.
:type args: tuple
'''
if gui_extpoint_name in self.gui_extension_points:
extension_points = list(self.gui_extension_points[
gui_extpoint_name])
for ext_point in extension_points:
if args[0] in ext_point:
self.gui_extension_points[gui_extpoint_name].remove(
ext_point)
if gui_extpoint_name not in self.gui_extension_points_handlers:
return
for handlers in self.gui_extension_points_handlers[gui_extpoint_name]:
disconnect_handler = handlers[1]
if disconnect_handler is not None:
disconnect_handler(args[0])
def _add_gui_extension_point_call_to_list(self,
gui_extpoint_name: str,
*args: Any
) -> None:
'''
Adds GUI extension point call to list of calls.
This is done only if such call hasn't been added already
(same extension point name and same arguments).
:note: This is assumption that GUI extension points are different only
if they have different name or different arguments.
:param gui_extpoint_name: GUI extension point name used to identify it
by plugins.
:param args: parameters to be passed to extension point handlers
(typically and object that invokes `gui_extension_point`;
however, this can be practically anything)
:type args: tuple
'''
if (gui_extpoint_name not in self.gui_extension_points or
args not in self.gui_extension_points[gui_extpoint_name]):
self.gui_extension_points.setdefault(gui_extpoint_name, []).append(
args)
def _execute_all_handlers_of_gui_extension_point(self,
gui_extpoint_name: str,
*args: Any
) -> None:
if gui_extpoint_name in self.gui_extension_points_handlers:
for handlers in self.gui_extension_points_handlers[
gui_extpoint_name]:
try:
handlers[0](*args)
except Exception:
log.warning('Error executing %s',
handlers[0], exc_info=True)
def _register_events_handlers_in_ged(self, plugin: GajimPlugin) -> None:
for event_name, handler in plugin.events_handlers.items():
priority = handler[0]
handler_function = handler[1]
app.ged.register_event_handler(
event_name, priority, handler_function)
def _remove_events_handler_from_ged(self, plugin: GajimPlugin) -> None:
for event_name, handler in plugin.events_handlers.items():
priority = handler[0]
handler_function = handler[1]
app.ged.remove_event_handler(
event_name, priority, handler_function)
def _remove_name_from_encryption_plugins(self,
plugin: GajimPlugin
) -> None:
if plugin.encryption_name:
del self.encryption_plugins[plugin.encryption_name]
def _register_modules_with_handlers(self, plugin: GajimPlugin) -> None:
if not hasattr(plugin, 'modules'):
return
for client in app.get_clients():
for module in plugin.modules:
instance, name = module.get_instance(client)
modules.register_single_module(client, instance, name)
for handler in instance.handlers:
client.connection.register_handler(handler)
def _unregister_modules_with_handlers(self, plugin: GajimPlugin) -> None:
if not hasattr(plugin, 'modules'):
return
for client in app.get_clients():
for module in plugin.modules:
instance = client.get_module(module.name)
modules.unregister_single_module(client, module.name)
for handler in instance.handlers:
client.connection.unregister_handler(handler)
def activate_plugin(self, plugin: GajimPlugin) -> None:
'''
:param plugin: plugin to be activated
:type plugin: class object of `GajimPlugin` subclass
'''
if not plugin.active and plugin.activatable:
self._add_gui_extension_points_handlers_from_plugin(plugin)
self._add_encryption_name_from_plugin(plugin)
self._handle_all_gui_extension_points_with_plugin(plugin)
self._register_events_handlers_in_ged(plugin)
self._register_modules_with_handlers(plugin)
self.active_plugins.append(plugin)
try:
plugin.activate()
except GajimPluginException as e:
self.deactivate_plugin(plugin)
raise GajimPluginActivateException(str(e))
app.settings.set_plugin_setting(plugin.manifest.short_name,
'active',
True)
plugin.active = True
def deactivate_plugin(self, plugin: GajimPlugin) -> None:
# remove GUI extension points handlers (provided by plug-in) from
# handlers list
for gui_extpoint_name, gui_extpoint_handlers in \
plugin.gui_extension_points.items():
self.gui_extension_points_handlers[gui_extpoint_name].remove(
gui_extpoint_handlers)
# detaching plug-in from handler GUI extension points (calling
# cleaning up method that must be provided by plug-in developer
# for each handled GUI extension point)
for gui_extpoint_name, gui_extpoint_handlers in \
plugin.gui_extension_points.items():
if gui_extpoint_name in self.gui_extension_points:
for gui_extension_point_args in self.gui_extension_points[
gui_extpoint_name]:
handler = gui_extpoint_handlers[1]
if handler:
try:
handler(*gui_extension_point_args)
except Exception:
log.warning('Error executing %s',
handler, exc_info=True)
self._remove_events_handler_from_ged(plugin)
self._remove_name_from_encryption_plugins(plugin)
# deactivate() must be before _unregister_modules_with_handlers(),
# because plugin.deactivate() may want to use the module
plugin.deactivate()
self._unregister_modules_with_handlers(plugin)
self.active_plugins.remove(plugin)
app.settings.set_plugin_setting(plugin.manifest.short_name,
'active',
False)
plugin.active = False
def _add_gui_extension_points_handlers_from_plugin(self,
plugin: GajimPlugin
) -> None:
for gui_extpoint_name, gui_extpoint_handlers in \
plugin.gui_extension_points.items():
self.gui_extension_points_handlers.setdefault(
gui_extpoint_name, []).append(gui_extpoint_handlers)
def _add_encryption_name_from_plugin(self, plugin: GajimPlugin) -> None:
if plugin.encryption_name:
self.encryption_plugins[plugin.encryption_name] = plugin
def _handle_all_gui_extension_points_with_plugin(self,
plugin: GajimPlugin
) -> None:
for gui_extpoint_name, gui_extpoint_handlers in \
plugin.gui_extension_points.items():
if gui_extpoint_name in self.gui_extension_points:
for gui_extension_point_args in self.gui_extension_points[
gui_extpoint_name]:
handler = gui_extpoint_handlers[0]
if handler:
try:
handler(*gui_extension_point_args)
except Exception:
log.warning('Error executing %s',
handler, exc_info=True)
def register_modules_for_account(self, client: Client) -> None:
'''
A new account has been added, register modules
of all active plugins
'''
for plugin in self.plugins:
if not plugin.active:
continue
if not hasattr(plugin, 'modules'):
continue
for module in plugin.modules:
instance, name = module.get_instance(client)
modules.register_single_module(client, instance, name)
for handler in instance.handlers:
client.connection.register_handler(handler)
@staticmethod
def _load_manifest(plugin_path: Path) -> PluginManifest | None:
try:
return PluginManifest.from_path(plugin_path)
except Exception as error:
log.warning('Unable to load manifest: %s', error)
return None
def _load_manifests(self) -> None:
manifests: dict[str, PluginManifest] = {}
for plugin_dir in configpaths.get_plugin_dirs():
if not plugin_dir.is_dir():
continue
for plugin_path in plugin_dir.iterdir():
manifest = self._load_manifest(plugin_path)
if manifest is None:
continue
if not manifest.is_usable:
log.info('Skipped plugin with not suitable requirements')
continue
same_plugin = manifests.get(manifest.short_name)
if same_plugin is not None:
if same_plugin.version > manifest.version:
continue
log.info('Found plugin %s %s',
manifest.short_name, manifest.version)
manifests[manifest.short_name] = manifest
for manifest in manifests.values():
self.add_plugin(manifest)
def install_from_zip(self,
zip_filename: str,
overwrite: bool = False
) -> GajimPlugin | None:
'''
Install plugin from zip and return plugin
'''
try:
zip_file = zipfile.ZipFile(zip_filename)
except zipfile.BadZipfile:
# it is not zip file
raise PluginsystemError(_('Archive corrupted'))
except OSError:
raise PluginsystemError(_('Archive empty'))
if zip_file.testzip():
# CRC error
raise PluginsystemError(_('Archive corrupted'))
dirs: list[str] = []
manifest = None
for filename in zip_file.namelist():
if (filename.startswith(('.', '/')) or ('/' not in filename)):
# members not safe
raise PluginsystemError(_('Archive is malformed'))
if filename.endswith('/') and filename.find('/', 0, -1) < 0:
dirs.append(filename.strip('/'))
if 'plugin-manifest.json' in filename.split('/')[1]:
manifest = True
if not manifest:
return None
if len(dirs) > 1:
raise PluginsystemError(_('Archive is malformed'))
plugin_name = dirs[0]
user_dir = configpaths.get('PLUGINS_USER')
plugin_path = user_dir / plugin_name
if plugin_path.exists():
# Plugin dir already exists
if not overwrite:
raise PluginsystemError(_('Plugin already exists'))
plugin = self.get_plugin_by_path(str(plugin_path))
assert isinstance(plugin, GajimPlugin)
self.uninstall_plugin(plugin)
zip_file.extractall(user_dir)
zip_file.close()
manifest = self._load_manifest(plugin_path)
if manifest is None or not manifest.is_usable:
log.warning('Error while installing from zip')
rmtree(plugin_path)
raise PluginsystemError(_('Installation failed'))
return self.add_plugin(manifest)
def delete_plugin_files(self, plugin_path: Path) -> None:
def _on_error(func: Callable[..., Any],
path: Path,
error: RmErrorT
) -> None:
if func is os.path.islink:
# if symlink
os.unlink(path)
return
# access is denied or other
raise PluginsystemError(str(error[1]))
rmtree(plugin_path, False, _on_error)
def uninstall_plugin(self, plugin: GajimPlugin) -> None:
'''
Deactivate and remove plugin from `plugins` list
'''
if not plugin:
return
self.remove_plugin(plugin)
self.delete_plugin_files(Path(plugin.__path__))
if not is_shipped_plugin(Path(plugin.__path__)):
path = configpaths.get('PLUGINS_BASE') / plugin.manifest.short_name
if path.exists():
self.delete_plugin_files(path)
path = configpaths.get('PLUGINS_DOWNLOAD') / plugin.manifest.short_name
if path.exists():
self.delete_plugin_files(path)
app.settings.remove_plugin(plugin.manifest.short_name)
app.ged.raise_event(PluginRemoved(manifest=plugin.manifest))
def get_plugin_by_path(self, plugin_dir: str) -> GajimPlugin | None:
for plugin in self.plugins:
if plugin.__path__ in plugin_dir:
return plugin
return None
|