-
Notifications
You must be signed in to change notification settings - Fork 408
/
_quickreports.py
343 lines (312 loc) · 11.6 KB
/
_quickreports.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
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
#
# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2007 B. Malengier
# Copyright (C) 2008 Brian G. Matherly
# Copyright (C) 2011 Tim G L Lyons
#
# This program 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; either version 2 of the License, or
# (at your option) any later version.
#
# This program 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 this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
"""
This module provides the functions to build the quick report context menu's
"""
# ------------------------------------------------------------------------
#
# python modules
#
# ------------------------------------------------------------------------
from gramps.gen.const import GRAMPS_LOCALE as glocale
_ = glocale.translation.gettext
from io import StringIO
# ------------------------------------------------------------------------
#
# Set up logging
#
# ------------------------------------------------------------------------
import logging
from collections import abc
log = logging.getLogger(".quickreports")
# -------------------------------------------------------------------------
#
# GNOME modules
#
# -------------------------------------------------------------------------
from gi.repository import Gtk
# -------------------------------------------------------------------------
#
# Gramps modules
#
# -------------------------------------------------------------------------
from ...pluginmanager import GuiPluginManager
from ...uimanager import valid_action_name
from gramps.gen.plug import (
CATEGORY_QR_PERSON,
CATEGORY_QR_FAMILY,
CATEGORY_QR_MEDIA,
CATEGORY_QR_EVENT,
CATEGORY_QR_SOURCE,
CATEGORY_QR_MISC,
CATEGORY_QR_PLACE,
CATEGORY_QR_REPOSITORY,
CATEGORY_QR_NOTE,
CATEGORY_QR_CITATION,
CATEGORY_QR_SOURCE_OR_CITATION,
)
from ._textbufdoc import TextBufDoc
from gramps.gen.simple import make_basic_stylesheet
MENUITEM = (
"<item>\n"
'<attribute name="action">{prefix}.{action}</attribute>\n'
'<attribute name="label">'
"{label}</attribute>\n"
"</item>\n"
)
def flatten(L):
"""
Flattens a possibly nested list. Removes None results, too.
"""
retval = []
if isinstance(L, (list, tuple)):
for item in L:
fitem = flatten(item)
if fitem is not None:
retval.extend(fitem)
elif L is not None:
retval.append(L)
return retval
def create_web_connect_menu(dbstate, uistate, nav_group, handle, prefix):
"""
This functions querries the registered web connects. It collects
the connects of the requested category, which must be one of
nav_group.
It constructs the ui string of the menu, and it's actions. The
action callback function is constructed, using the dbstate and the
handle as input method. A tuple is returned, containing the ui
string of the menu, and its associated actions.
"""
top = (
"<placeholder id='WebConnect'><submenu>\n"
'<attribute name="label" translatable="yes">'
"Web Connection</attribute>\n"
)
ofile = StringIO()
ofile.write(top)
# select the web connects to show
pmgr = GuiPluginManager.get_instance()
plugins = pmgr.process_plugin_data("WebConnect")
try:
connections = [
plug(nav_group) if isinstance(plug, abc.Callable) else plug
for plug in plugins
]
except BaseException:
import traceback
traceback.print_exc()
connections = []
connections = flatten(connections)
connections.sort(key=lambda plug: plug.name)
actions = []
for indx, connect in enumerate(connections):
# action would be better with "connect.key", but it seems to be
# non-ASCII sometimes. So we use an action number instead.
action = "web-con-%d" % indx
ofile.write(MENUITEM.format(prefix=prefix, action=action, label=connect.name))
callback = connect(dbstate, uistate, nav_group, handle)
actions.append((action, make_web_connect_callback(callback)))
ofile.write("</submenu></placeholder>\n")
return (ofile.getvalue(), actions)
def make_web_connect_callback(func):
return lambda x, y: func(x)
def create_quickreport_menu(category, dbstate, uistate, handle, prefix, track=[]):
"""This functions querries the registered quick reports with
quick_report_list of _PluginMgr.py
It collects the reports of the requested category, which must be one of
CATEGORY_QR_PERSON, CATEGORY_QR_FAMILY,
CATEGORY_QR_EVENT, CATEGORY_QR_SOURCE, CATEGORY_QR_MEDIA,
CATEGORY_QR_PLACE, CATEGORY_QR_REPOSITORY,
CATEGORY_QR_CITATION, CATEGORY_QR_SOURCE_OR_CITATION
It constructs the ui string of the quick report menu, and it's actions
The action callback function is constructed, using the dbstate and the
handle as input method.
A tuple is returned, containing the ui string of the quick report menu,
and its associated actions
"""
top = (
"<submenu>\n"
'<attribute name="label" translatable="yes">'
"Quick View</attribute>\n"
)
actions = []
ofile = StringIO()
ofile.write(top)
# select the reports to show
showlst = []
pmgr = GuiPluginManager.get_instance()
for pdata in pmgr.get_reg_quick_reports():
if pdata.supported and pdata.category == category:
showlst.append(pdata)
showlst.sort(key=lambda x: x.name)
for pdata in showlst:
new_key = valid_action_name("qr-%s" % pdata.id)
ofile.write(MENUITEM.format(prefix=prefix, action=new_key, label=pdata.name))
actions.append(
(
new_key,
make_quick_report_callback(
pdata, category, dbstate, uistate, handle, track=track
),
)
)
ofile.write("</submenu>\n")
return (ofile.getvalue(), actions)
def make_quick_report_callback(pdata, category, dbstate, uistate, handle, track=[]):
return lambda x, y: run_report(
dbstate, uistate, category, handle, pdata, track=track
)
def get_quick_report_list(qv_category=None):
"""
Returns a list of PluginData of quick views of category qv_category
CATEGORY_QR_PERSON, CATEGORY_QR_FAMILY, CATEGORY_QR_EVENT,
CATEGORY_QR_SOURCE, CATEGORY_QR_MISC, CATEGORY_QR_PLACE,
CATEGORY_QR_REPOSITORY, CATEGORY_QR_MEDIA,
CATEGORY_QR_CITATION, CATEGORY_QR_SOURCE_OR_CITATION or None for all
"""
names = []
pmgr = GuiPluginManager.get_instance()
for pdata in pmgr.get_reg_quick_reports():
if qv_category == pdata.category or qv_category is None:
names.append(pdata) # (see below for item struct)
return names
def run_quick_report_by_name(
dbstate, uistate, report_name, handle, container=None, track=[], **kwargs
):
"""
Run a QuickView by name.
**kwargs provides a way of passing special quick views additional
arguments.
"""
report = None
pmgr = GuiPluginManager.get_instance()
for pdata in pmgr.get_reg_quick_reports():
if pdata.id == report_name:
report = pdata
break
if report:
return run_report(
dbstate,
uistate,
report.category,
handle,
report,
container=container,
track=track,
**kwargs,
)
else:
raise AttributeError("No such quick report '%s'" % report_name)
def run_quick_report_by_name_direct(report_name, database, document, handle):
"""
Useful for running one quick report from another
"""
report = None
pmgr = GuiPluginManager.get_instance()
for pdata in pmgr.get_reg_quick_reports():
if pdata.id == report_name:
report = pdata
break
if report:
# FIXME: allow auto lookup of obj like below?
d = TextBufDoc(make_basic_stylesheet(), None)
d.dbstate = document.dbstate
d.uistate = document.uistate
d.open("")
mod = pmgr.load_plugin(report)
if mod:
reportfunc = getattr(mod, report.runfunc)
retval = reportfunc(database, d, handle)
d.close()
return retval
else:
raise ImportError(
"Quick report id = '%s' could not be loaded" % report_name
)
else:
raise AttributeError("No such quick report id = '%s'" % report_name)
def run_report(
dbstate, uistate, category, handle, pdata, container=None, track=[], **kwargs
):
"""
Run a Quick Report.
Optionally container can be passed, rather than putting the report
in a new window.
**kwargs are only used for special quick views that allow additional
arguments, and that are run by run_quick_report_by_name().
"""
pmgr = GuiPluginManager.get_instance()
mod = pmgr.load_plugin(pdata)
if not mod:
print("QuickView Error: plugin does not load")
return
func = getattr(mod, pdata.runfunc)
if handle:
d = TextBufDoc(make_basic_stylesheet(), None, track=track)
d.dbstate = dbstate
d.uistate = uistate
if isinstance(handle, str): # a handle
if category == CATEGORY_QR_PERSON:
obj = dbstate.db.get_person_from_handle(handle)
elif category == CATEGORY_QR_FAMILY:
obj = dbstate.db.get_family_from_handle(handle)
elif category == CATEGORY_QR_EVENT:
obj = dbstate.db.get_event_from_handle(handle)
elif category == CATEGORY_QR_SOURCE:
obj = dbstate.db.get_source_from_handle(handle)
elif category == CATEGORY_QR_CITATION:
obj = dbstate.db.get_citation_from_handle(handle)
elif category == CATEGORY_QR_SOURCE_OR_CITATION:
if dbstate.db.has_source_handle(handle):
obj = dbstate.db.get_source_from_handle(handle)
elif dbstate.db.has_citation_handle(handle):
obj = dbstate.db.get_citation_from_handle(handle)
else:
raise ValueError("selection must be either source or citation")
elif category == CATEGORY_QR_PLACE:
obj = dbstate.db.get_place_from_handle(handle)
elif category == CATEGORY_QR_MEDIA:
obj = dbstate.db.get_media_from_handle(handle)
elif category == CATEGORY_QR_REPOSITORY:
obj = dbstate.db.get_repository_from_handle(handle)
elif category == CATEGORY_QR_NOTE:
obj = dbstate.db.get_note_from_handle(handle)
elif category == CATEGORY_QR_MISC:
obj = handle
else:
obj = None
else: # allow caller to send object directly
obj = handle
if obj:
if container:
result = d.open("", container=container)
func(dbstate.db, d, obj, **kwargs)
return result
else:
d.open("")
retval = func(dbstate.db, d, obj, **kwargs)
d.close()
return retval
else:
print("QuickView Error: failed to run report: no obj")
else:
print("QuickView Error: handle is not set")