/
NobleTitles.py
306 lines (246 loc) · 13.6 KB
/
NobleTitles.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
from gramps.gen.datehandler import parser
from gramps.gen.display.place import displayer as place_displayer
from gramps.gen.errors import ReportError
from gramps.gen.lib import (AttributeType, EventRoleType, EventType, FamilyRelType, Person)
from gramps.gen.plug.report import (MenuReportOptions, Report, stdoptions, utils)
from gramps.gen.plug.menu import (BooleanOption, ColorOption, PersonListOption, PersonOption)
from gramps.gen.utils.db import (get_birth_or_fallback, get_death_or_fallback)
from gramps.gen.utils.file import media_path_full
from gramps.gen.utils.symbols import Symbols
from gramps.gen.utils.thumbnails import get_thumbnail_path
class NobleTitlesOptions(MenuReportOptions):
def __init__(self, name, dbase):
MenuReportOptions.__init__(self, name, dbase)
def add_menu_options(self, menu):
person_list = PersonListOption('People of interest')
menu.add_option('People of Interest', 'gidlist', person_list)
withparents = BooleanOption(('Include ancestors'), False)
menu.add_option('People of Interest', 'withparents', withparents)
withchildren = BooleanOption(('Include descendents'), False)
menu.add_option('People of Interest', 'withchildren', withchildren)
withspouses = BooleanOption(('Include spouses'), False)
menu.add_option('People of Interest', 'withspouses', withspouses)
color_males = ColorOption('Males', '#e0e0ff')
color_males.set_help('The color to use to display men')
menu.add_option('Report Options', 'colormales', color_males)
color_females = ColorOption('Females', '#ffe0e0')
color_females.set_help('The color to use to display women')
menu.add_option('Report Options', 'colorfemales', color_females)
color_unknown = ColorOption('Unknown', '#e0e0e0')
color_unknown.set_help('The color to use when the gender is unknown')
menu.add_option('Report Options', 'colorunknown', color_unknown)
locale_opt = stdoptions.add_localization_option(menu, 'Report Options')
stdoptions.add_date_format_option(menu, 'Report Options', locale_opt)
stdoptions.add_name_format_option(menu, 'Report Options')
class NobleTitles(Report):
def __init__(self, database, options, user):
Report.__init__(self, database, options, user)
self.set_locale(options.menu.get_option_by_name('trans').get_value())
stdoptions.run_date_format_option(self, options.menu)
stdoptions.run_name_format_option(self, options.menu)
self.database = database
self._gidlist = options.menu.get_option_by_name('gidlist').get_value().split()
self._withparents = options.menu.get_option_by_name('withparents').get_value()
self._withchildren = options.menu.get_option_by_name('withchildren').get_value()
self._withspouses = options.menu.get_option_by_name('withspouses').get_value()
self._usesubgraphs = options.menu.get_option_by_name('usesubgraphs').get_value()
self.fillcolor = {
Person.MALE: options.menu.get_option_by_name('colormales').get_value(),
Person.FEMALE: options.menu.get_option_by_name('colorfemales').get_value(),
Person.UNKNOWN: options.menu.get_option_by_name('colorunknown').get_value()
}
self.nodestyle = {
Person.MALE: 'solid',
Person.FEMALE: 'rounded',
Person.UNKNOWN: 'solid'
}
self.nodeshape = {
Person.MALE: 'box',
Person.FEMALE: 'box',
Person.UNKNOWN: 'hexagon'
}
symbols = Symbols()
self.symbols = {
Person.FEMALE: symbols.get_symbol_for_string(symbols.SYMBOL_FEMALE),
Person.MALE: symbols.get_symbol_for_string(symbols.SYMBOL_MALE),
Person.UNKNOWN: symbols.get_symbol_for_string(symbols.SYMBOL_ASEXUAL_SEXLESS),
'birth': symbols.get_symbol_for_string(symbols.SYMBOL_BIRTH),
'death': symbols.get_death_symbol_for_char(symbols.DEATH_SYMBOL_LATIN_CROSS),
'illegitimate': symbols.get_symbol_for_string(symbols.SYMBOL_ILLEGITIM),
'kia': symbols.get_symbol_for_string(symbols.SYMBOL_KILLED_IN_ACTION),
# marriage symbols display with extra linebreaks in Graphviz family nodes
# todo: using fallbacks for now
'engaged': symbols.get_symbol_fallback(symbols.SYMBOL_ENGAGED),
'married': symbols.get_symbol_fallback(symbols.SYMBOL_MARRIAGE),
'unmarried': symbols.get_symbol_fallback(symbols.SYMBOL_UNMARRIED_PARTNERSHIP),
'divorced': symbols.get_symbol_fallback(symbols.SYMBOL_DIVORCE)
}
def begin_report(self):
self._people = set()
self._families = set()
if not self._gidlist:
raise ReportError('Empty report', 'You did not specify any People of Interest')
for gid in self._gidlist:
person = self.database.get_person_from_gramps_id(gid)
self.add_children(person)
if self._withparents:
self.add_parents(person)
def write_report(self):
for handle in sorted(self._people):
self.write_person(self.database.get_person_from_handle(handle))
for handle in sorted(self._families):
self.write_family(self.database.get_family_from_handle(handle))
def add_children(self, person):
self._people.add(person.get_handle())
for family_handle in person.get_family_handle_list():
family = self.database.get_family_from_handle(family_handle)
for childref in family.get_child_ref_list():
child = self.database.get_person_from_handle(childref.ref)
if (self._withchildren or child.get_gramps_id() in self._gidlist):
self.add_children(child)
self._families.add(family_handle)
spouse_handle = utils.find_spouse(person, family)
if spouse_handle:
spouse = self.database.get_person_from_handle(spouse_handle)
if self._withspouses or spouse.get_gramps_id() in self._gidlist:
self._people.add(spouse_handle)
self._families.add(family_handle)
def add_parents(self, person):
self._people.add(person.get_handle())
for family_handle in person.get_parent_family_handle_list():
self._families.add(family_handle)
family = self.database.get_family_from_handle(family_handle)
father_handle = family.get_father_handle()
if father_handle:
father = self.database.get_person_from_handle(father_handle)
self.add_parents(father)
mother_handle = family.get_mother_handle()
if mother_handle:
mother = self.database.get_person_from_handle(mother_handle)
self.add_parents(mother)
def write_family(self, family):
newline = "\n"
label = ''
for event_ref in family.get_event_ref_list():
event = self.database.get_event_from_handle(event_ref.ref)
if (event.get_type() == EventType.ENGAGEMENT):
label += '%s %s%s' % (self.symbols['engaged'],
self._get_date(event.get_date_object()),
newline)
if (event.get_type() == EventType.MARRIAGE):
label += '%s %s' % (self.symbols['married'],
self._get_date(event.get_date_object()))
place = place_displayer.display_event(self.database, event)
if place:
label += '%s%s' % (newline, place)
elif ((event.get_type() == EventType.ANNULMENT) or
(event.get_type() == EventType.DIVORCE)):
label += '%s%s %s' % (newline,
self.symbols['divorced'],
self._get_date(event.get_date_object()))
if not label:
if family.get_relationship() == FamilyRelType.MARRIED:
label += self.symbols['married']
elif family.get_relationship() == FamilyRelType.UNMARRIED:
label += self.symbols['unmarried']
self.doc.add_node(node_id=family.get_gramps_id(),
label=label,
shape='ellipse',
style='solid,filled',
fillcolor='#ffffe0')
father_handle = family.get_father_handle()
mother_handle = family.get_mother_handle()
father = mother = None
if self._usesubgraphs and father_handle and mother_handle:
self.doc.start_subgraph(family.get_gramps_id())
if father_handle and father_handle in self._people:
father = self.database.get_person_from_handle(father_handle)
self.doc.add_link(id1=father.get_gramps_id(),
id2=family.get_gramps_id(),
head='none',
tail='none')
if mother_handle and mother_handle in self._people:
mother = self.database.get_person_from_handle(mother_handle)
self.doc.add_link(id1=mother.get_gramps_id(),
id2=family.get_gramps_id(),
head='none',
tail='none')
if father and mother:
self.doc.add_link(id1=father.get_gramps_id(),
id2=mother.get_gramps_id(),
style="invis",
head="none",
tail="none")
if self._usesubgraphs and father_handle and mother_handle:
self.doc.end_subgraph()
for childref in family.get_child_ref_list():
if childref.ref in self._people:
child = self.database.get_person_from_handle(childref.ref)
self.doc.add_link(id1=family.get_gramps_id(),
id2=child.get_gramps_id(),
head='none',
tail='none')
def write_person(self, person):
newline = '<br/>'
label = '<table border="0" cellspacing="2" cellpadding="0" cellborder="0"><tr><td>'
media_list = person.get_media_list()
if len(media_list) > 0:
media_handle = media_list[0].get_reference_handle()
media = self.database.get_media_from_handle(media_handle)
media_mime_type = media.get_mime_type()
if media_mime_type[0:5] == "image":
image_path = get_thumbnail_path(media_path_full(self.database, media.get_path()),
rectangle=media_list[0].get_rectangle())
if image_path:
label += '<img src="%s"/></td><td>' % image_path
label += self._name_display.display(person)
label += ' %s' % self.symbols[person.get_gender()]
for event_ref in person.get_primary_event_ref_list():
event = self.database.get_event_from_handle(event_ref.ref)
if event.get_type() == EventType.NOB_TITLE:
label += '<br/>%s' % place_displayer.display_event(self.database, event)
if event.get_description():
label += ' (%s)' % event.get_description()
label += ' %s' % self._get_date(event.get_date_object())
birth = get_birth_or_fallback(self.database, person)
if birth:
birth_symbol = self.symbols['birth']
fam_handle = person.get_main_parents_family_handle()
if fam_handle:
family = self.database.get_family_from_handle(fam_handle)
if (family.type == FamilyRelType.UNMARRIED):
birth_symbol = self.symbols['illegitimate']
birthdate = self._get_date(birth.get_date_object())
birthplace = place_displayer.display_event(self.database, birth)
label += '<br/>%s' % birth_symbol
if birthdate:
label += ' %s' % birthdate
if birth.description:
label += ' (%s)' % birth.description
if birthplace:
label += ' %s' % birthplace
death = get_death_or_fallback(self.database, person)
if death:
deathdate = self._get_date(death.get_date_object())
deathplace = place_displayer.display_event(self.database, death)
label += '<br/>%s ' % self.symbols['death']
if deathdate:
label += ' %s' % deathdate
if death.description:
label += ' (%s)' % death.description
if deathplace:
label += ' %s' % deathplace
for event_ref in person.get_primary_event_ref_list():
event = self.database.get_event_from_handle(event_ref.ref)
if event.get_type() == EventType.MILITARY_SERV:
for attribute in event_ref.get_attribute_list():
if ((attribute.get_type() == AttributeType.DESCRIPTION) and
(attribute.get_value() == 'Killed in Action')):
label += '<br/>%s %s' % (self.symbols['kia'], event.get_description())
label += '</td></tr></table>'
self.doc.add_node(node_id=person.get_gramps_id(),
label=label,
shape=self.nodeshape[person.get_gender()],
style='%s,filled' % self.nodestyle[person.get_gender()],
fillcolor=self.fillcolor[person.get_gender()],
htmloutput=True)