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
|
# SPDX-FileCopyrightText: © 2008-2022 Oprea Dan
# SPDX-FileCopyrightText: © 2008-2022 Bart de Koning
# SPDX-FileCopyrightText: © 2008-2022 Richard Bailey
# SPDX-FileCopyrightText: © 2008-2022 Germar Reitze
#
# SPDX-License-Identifier: GPL-2.0-or-later
#
# This file is part of the program "Back In Time" which is released under GNU
# General Public License v2 (GPLv2). See file/folder LICENSE or go to
# <https://spdx.org/licenses/GPL-2.0-or-later.html>.
import os
import sys
import tools
tools.registerBackintimePath('common')
tools.registerBackintimePath('plugins')
tools.registerBackintimePath('common', 'plugins')
tools.registerBackintimePath('qt', 'plugins')
import logger
from exceptions import StopException
class Plugin:
""" Interface methods to customize behavior for different backup steps
Back In Time allows to inform plugins (implemented in Python
files) about different steps ("events") in the backup process.
Plugins may implement special behavior to predefined
"events" that are declared in this interface class
as methods.
To implement a new plugin create a new
class that inherits from this one and implement all
methods.
Plugins are loaded by calling :py:func:`PluginManager.load`.
"""
def init(self, snapshots):
return True
def isGui(self):
"""Indicates a GUI-related plugin
The return value shall indicate if the plugin
is related to the Back In Time GUI.
Loaded GUI-related plugins are called before non-GUI-related
plugins by the PluginManager.
Returns:
True if plugin is GUI-related, otherwise False
"""
return False
def processBegin(self):
"""Called before a backup process is started.
A new snapshot is only taken if required (as configured).
Returns:
``None`` (return value will be ignored anyhow)
"""
return
def processEnd(self):
"""Called after a backup process has ended
Returns:
``None`` (return value will be ignored anyhow)
"""
return
def error(self, code, message):
"""Indicates errors during the backup process
Called to send errors in the backup process
(while taking a snapshot) to plugins.
Args:
code: A Back In Time error code
Known error codes:
1: No or no valid configuration
(check the configuration file)
2: A backup process is already running.
Make sure that automatic and manual backups
do not run at once.
3: Snapshots directory not found
(eg. when a removable drive is not mounted)
4: The requested snapshot for "now" already exists.
``message`` contains the SID (snapshot ID) then.
5: Error while taking a snapshot.
``message`` contains more information (as string).
6: New snapshot taken but with errors.
``message`` contains the SID (snapshot ID) then.
message: The error message for the code
(mostly an empty string by default)
Returns:
``None`` (return value will be ignored anyhow)
"""
return
def newSnapshot(self, snapshot_id, snapshot_path):
""" Called when the backup process has taken a new snapshot.
A new snapshot is only taken by the backup process
if required (as configured).
Args:
snapshot_id: The id of the new snapshot
snapshot_path: The path to the new snapshot
Returns:
``None`` (return value will be ignored anyhow)
"""
return
def message(self, profile_id, profile_name, level, message, timeout):
"""Send snapshot-related messages to plugins.
Args:
profile_id: Profile ID from configuration.
profile_name: Profile name from the configuration.
level: 0 = INFO, 1 = ERROR
message: Message text.
timeout: Requested timeout in seconds to process the message.
Not used at the moment. (default -1 means "no timeout")
"""
pass
def appStart(self):
""" Called when the GUI of Back In Time was started.
Not called when only the CLI command was started without the GUI.
Returns:
``None`` (return value will be ignored anyhow)
"""
return
def appExit(self):
""" Called when the GUI of Back In Time is closed
Returns:
``None`` (return value will be ignored anyhow)
"""
return
def mount(self, profileID = None):
""" Called when mounting a filesystem for the profile may be necessary.
Args:
profileID: Profile ID from the configuration
Returns:
``None`` (return value will be ignored anyhow)
"""
return
def unmount(self, profileID = None):
""" Called when unmounting a filesystem for a profile may be necessary
Args:
profileID: Profile ID from the configuration
Returns
``None`` (return value will be ignored anyhow)
"""
return
class PluginManager:
""" Central interface for loading plugins and calling their API
Back In Time allows to inform plugins (implemented in Python
files) about different steps ("events") in the backup process.
Use this class to load installed plugin classes
and call their methods (see the interface declared by
:py:class:`Plugin`).
Plugins are loaded by calling :py:func:`PluginManager.load`.
When you call a plugin function of the PluginManager it will
call this plugin function for all loaded plugins.
"""
# TODO 09/28/2022: Should inherit from + implement class "Plugin"
def __init__(self):
self.plugins = []
self.hasGuiPlugins = False
self.loaded = False
def load(self, snapshots=None, cfg=None, force=False):
"""Loads plugins
Loads all plugins from python source code files that are stored
in one of these plugin sub folders in the installation
root folder:
'plugins', 'common/plugins', 'qt/plugins'
Plugins must inherit from :py:class:`Plugin` otherwise they
are silently ignored.
Args:
snapshots (snapshots.Snapshots): Snapshot info
cfg (config.Config): Current configuration
force (bool): ``True`` to enforce reloading all plugins (``False``
does only load if not already done)
"""
if self.loaded and not force:
return
if snapshots is None:
import snapshots as snapshots_
snapshots = snapshots_.Snapshots(cfg)
self.loaded = True
self.plugins = []
self.hasGuiPlugins = False
loadedPlugins = []
# TODO 09/28/2022: Move hard coded plugin folders to configuration
for path in ('plugins', 'common/plugins', 'qt/plugins'):
fullPath = tools.backintimePath(path)
if os.path.isdir(fullPath):
logger.debug('Register plugin path %s' %fullPath, self)
tools.registerBackintimePath(path)
for f in os.listdir(fullPath):
if f not in loadedPlugins and f.endswith('.py') and not f.startswith('__'):
# logger.debug('Probing plugin %s' % f, self)
try:
module = __import__(f[: -3])
module_dict = module.__dict__
for key, value in list(module_dict.items()):
if key.startswith('__'):
continue
if type(value) is type:
# A plugin must implement this class via inheritance
if issubclass(value, Plugin):
plugin = value()
if plugin.init(snapshots):
logger.debug('Add plugin %s' %f, self)
if plugin.isGui():
self.hasGuiPlugins = True
self.plugins.insert(0, plugin)
else:
self.plugins.append(plugin)
loadedPlugins.append(f)
except BaseException as e:
logger.error('Failed to load plugin %s: %s' %(f, str(e)), self)
def processBegin(self):
ret_val = True
for plugin in self.plugins:
try:
plugin.processBegin()
except StopException:
ret_val = False
except BaseException as e:
self.logError(plugin, e)
return ret_val
def processEnd(self):
for plugin in reversed(self.plugins):
try:
plugin.processEnd()
except BaseException as e:
self.logError(plugin, e)
def error(self, code, message = ''):
for plugin in self.plugins:
try:
plugin.error(code, message)
except BaseException as e:
self.logError(plugin, e)
def newSnapshot(self, snapshot_id, snapshot_path):
for plugin in self.plugins:
try:
plugin.newSnapshot(snapshot_id, snapshot_path)
except BaseException as e:
self.logError(plugin, e)
def message(self, profile_id, profile_name, level, message, timeout = -1):
for plugin in self.plugins:
try:
plugin.message(profile_id, profile_name, level, message, timeout)
except BaseException as e:
self.logError(plugin, e)
def appStart(self):
for plugin in reversed(self.plugins):
try:
plugin.appStart()
except BaseException as e:
self.logError(plugin, e)
def appExit(self):
for plugin in reversed(self.plugins):
try:
plugin.appExit()
except BaseException as e:
self.logError(plugin, e)
def mount(self, profileID = None):
for plugin in reversed(self.plugins):
try:
plugin.mount(profileID)
except BaseException as e:
self.logError(plugin, e)
def unmount(self, profileID = None):
for plugin in reversed(self.plugins):
try:
plugin.unmount(profileID)
except BaseException as e:
self.logError(plugin, e)
def logError(self, plugin, e):
logger.error('Plugin %s %s failed: %s'
%(plugin.__module__, #plugin name
sys._getframe(1).f_code.co_name, #method name
str(e)), #exception
self, 1)
|
