-
Notifications
You must be signed in to change notification settings - Fork 0
/
FamilyBook.py
625 lines (538 loc) · 24.4 KB
/
FamilyBook.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
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
# $Id$
"""Reports/Text Reports/Family Book"""
#------------------------------------------------------------------------
#
# Standard Python modules
#
#------------------------------------------------------------------------
import string
from collections import defaultdict
from functools import partial
#------------------------------------------------------------------------
#
# Gramps modules
#
#------------------------------------------------------------------------
from gramps.gen.display.name import displayer
from gramps.gen.display.place import displayer as place_displayer
from gramps.gen.lib import Date, Event, EventType, FamilyRelType, Name, NameType, Person, Family, Place, EventRoleType, NoteType
from gramps.gen.lib import StyledText, StyledTextTag, StyledTextTagType
from gramps.gen.plug import docgen
from gramps.gen.plug.menu import BooleanOption, EnumeratedListOption, PersonOption
from gramps.gen.plug.report import MenuReportOptions
from gramps.gen.plug.report import Report
from gramps.gen.plug.report import stdoptions
from gramps.gen.plug.report import utils
import gramps.gen.datehandler
from gramps.gen.relationship import get_relationship_calculator
from gramps.gen.const import GRAMPS_LOCALE as glocale
try:
_trans = glocale.get_addon_translator(__file__)
except ValueError:
_trans = glocale.translation
_ = _trans.gettext
#------------------------------------------------------------------------
#
# Constants
#
#------------------------------------------------------------------------
empty_birth = Event()
empty_birth.set_type(EventType.BIRTH)
empty_marriage = Event()
empty_marriage.set_type(EventType.MARRIAGE)
#------------------------------------------------------------------------
#
# FamilyBook report
#
#------------------------------------------------------------------------
class FamilyBook(Report):
def __init__(self, database, options, user):
"""
Initialize the report.
@param database: the Gramps database instance
@param options: instance of the Options class for this report
@param user: a gramps.gen.user.User() instance
"""
Report.__init__(self, database, options, user)
self.user = user
menu = options.menu
self.citation_handles = set()
self.set_locale(options.menu.get_option_by_name('trans').get_value())
stdoptions.run_date_format_option(self, menu)
self.rlocale = self._locale
self.person_id = menu.get_option_by_name('pid').get_value()
self.document_class = 'memoir'
self.styleName = 'default'
self.language = 'russian'
def write_report(self):
"""
Build the actual report.
"""
mark1 = docgen.IndexMark(_('Family Book'), docgen.INDEX_TYPE_TOC, 1)
self.doc.start_paragraph('FSR-Key')
self.doc.write_text('', mark1) # for use in a TOC in a book report
self.doc.end_paragraph()
self.doc.start_paragraph('FSR-Normal')
self.doc.write_text('\\documentclass[11pt, msmallroyalvopaper, openany]{')
self.doc.write_text(self.document_class)
self.doc.write_text('}\n')
self.doc.write_text('\\usepackage[utf8]{inputenc}\n')
self.doc.write_text('\\usepackage[')
self.doc.write_text(self.language)
self.doc.write_text(']{babel}\n')
self.doc.write_text('\\usepackage{caption}\n')
self.doc.write_text('\\usepackage{graphicx}\n')
self.doc.write_text('\\usepackage{wrapfig}\n')
self.doc.write_text('\\usepackage{multicol}\n')
self.doc.write_text('\\usepackage[superscript,biblabel]{cite}\n')
self.doc.write_text('\\setcounter{secnumdepth}{-1}\n')
self.doc.write_text('\n% styling\n')
self.doc.write_text('\\tightlists\n')
self.doc.write_text('\\usepackage{calc}\n')
self.doc.write_text('\\usepackage{enumitem}\n')
self.doc.write_text('\\usepackage{pgfornament}\n')
self.doc.write_text('\\chapterstyle{bringhurst}\n')
self.doc.write_text('\\definecolor{steelgrey}{rgb}{0.62, 0.62, 0.62}\n')
self.doc.write_text('\\newcommand*{\\sclabel}[1]{\\normalfont\\scshape #1}\n')
self.doc.write_text('\\newcommand{\\fbNoteSeparator}{\\begin{center}\\noindent\\pgfornament[width=2em,color=steelgrey]{94}\\medskip\end{center}}\n')
self.doc.write_text('\\newcommand{\\fbBeginPersonDescription}{\\begin{description}[before=\\renewcommand{\\makelabel}{\\sclabel},leftmargin=!,labelwidth=\\widthof{\\sclabel{Похоронена}}]}\n')
self.doc.write_text('\\newcommand{\\fbEndPersonDescription}{\\end{description}}\n')
# self.doc.write_text('\\newcommand{\\fbBeginPersonDescription}{\\begin{flexlabelled}{sclabel}{2em}{1.0em}{1.0em}{2em}{0pt}}\n')
# self.doc.write_text('\\newcommand{\\fbEndPersonDescription}{\\end{flexlabelled}}\n')
self.doc.write_text('\\newcommand{\\fbPersonDescriptionItem}[2]{\\item[#1] #2}\n')
self.doc.write_text('% end of styling\n\n')
self.doc.write_text('\\begin{document}\n')
self.doc.write_text('\\tableofcontents\n')
self.doc.write_text('\\part{Персоналии}\n')
self.doc.end_paragraph()
self._build_obj_dict()
# person = self.database.get_person_from_gramps_id(self.person_id)
# (rank, ahnentafel, person_key) = self.__calc_person_key(person)
# self.__process_person(person)
person_list = list(self.obj_dict[Person].keys())
person_list.sort(key = lambda x: self.obj_dict[Person][x][0])
for person_handle in person_list:
person = self.database.get_person_from_handle(person_handle)
self.__process_person(person)
self.doc.start_paragraph('FSR-Normal')
self.doc.write_text('\\part{Места}\n')
self.doc.end_paragraph()
self.doc.start_paragraph('FSR-Normal')
self.doc.write_text('\\begin{thebibliography}{99}\n')
self.doc.write_text('\\scriptsize\n')
for cit_handle in self.citation_handles:
self.doc.write_text(self.__make_bib_item(cit_handle))
self.doc.write_text('\\end{thebibliography}\n')
self.doc.write_text('\\end{document}\n')
self.doc.end_paragraph()
def __make_bib_item(self, cit_handle):
cit = self.database.get_citation_from_handle(cit_handle)
src_handle = cit.get_reference_handle()
src = self.database.get_source_from_handle(src_handle)
s = '\\bibitem{'
s = s + cit.get_gramps_id()
s = s + '} '
s = s + src.get_title()
if not s.endswith('.'):
s = s + '.'
if src.get_author() != '':
a = src.get_author()
if not a.endswith('.'):
a = a + '.'
s = s + ' {\\itshape '
s = s + a
s = s + '}'
if src.get_publication_info() != '':
pub = ' '
pub = pub + src.get_publication_info()
if not pub.endswith('.'):
pub = pub + '.'
s = s + pub
s = s + '~// '
s = s + cit.get_page()
if not s.endswith('.'):
s = s + '.'
s = s + '\n'
return s
def _build_obj_dict(self):
_obj_class_list = (Person, Place)
# setup a dictionary of the required structure
self.obj_dict = defaultdict(lambda: defaultdict(set))
self.bkref_dict = defaultdict(lambda: defaultdict(set))
# initialise the dictionary to empty in case no objects of any
# particular class are included in the web report
for obj_class in _obj_class_list:
self.obj_dict[obj_class] = defaultdict(set)
ind_list = self.database.iter_person_handles()
# ind_list = self.filter.apply(self.database, ind_list, user=self.user)
for handle in ind_list:
self._add_person(handle)
# Debug output
# log.debug("final object dictionary \n" +
# "".join(("%s: %s\n" % item) for item in self.obj_dict.items()))
# log.debug("final backref dictionary \n" +
# "".join(("%s: %s\n" % item) for item in self.bkref_dict.items()))
def _add_person(self, person_handle, bkref_class = None, bkref_handle = None):
'''
Add person_handle to the L{self.obj_dict}, and recursively all referenced objects
'''
# Update the dictionaries of objects back references
if (bkref_class is not None):
self.bkref_dict[Person][person_handle].add((bkref_class, bkref_handle, None))
# Check if the person is already added
if (person_handle in self.obj_dict[Person]): return
# Add person in the dictionaries of objects
person = self.database.get_person_from_handle(person_handle)
if (not person): return
if (not self.__is_person_valid(person)): return
person_name = self.__person_name(person)
self.obj_dict[Person][person_handle] = [person_name, person.gramps_id, len(self.obj_dict[Person])]
# Person events
# evt_ref_list = person.get_event_ref_list()
# if evt_ref_list:
# for evt_ref in evt_ref_list:
# self._add_event(evt_ref.ref, Person, person_handle, evt_ref)
# Person citations
# for citation_handle in person.get_citation_list():
# self._add_citation(citation_handle, Person, person_handle)
# Person name citations
# for name in [person.get_primary_name()] + \
# person.get_alternate_names():
# for citation_handle in name.get_citation_list():
# self._add_citation(citation_handle, Person, person_handle)
# LDS Ordinance citations
# for lds_ord in person.get_lds_ord_list():
# for citation_handle in lds_ord.get_citation_list():
# self._add_citation(citation_handle, Person, person_handle)
# Attribute citations
# for attr in person.get_attribute_list():
# for citation_handle in attr.get_citation_list():
# self._add_citation(citation_handle, Person, person_handle)
# Person families
# family_handle_list = person.get_family_handle_list()
# if family_handle_list:
# for family_handle in person.get_family_handle_list():
# self._add_family(family_handle, Person, person_handle)
# Person media
# for media_ref in person.get_media_list():
# media_handle = media_ref.get_reference_handle()
# self._add_media(media_handle, Person, person_handle, media_ref)
# Association citations
# for assoc in person.get_person_ref_list():
# for citation_handle in assoc.get_citation_list():
# self._add_citation(citation_handle, Person, person_handle)
# Addresses citations
# for addr in person.get_address_list():
# for citation_handle in addr.get_citation_list():
# self._add_citation(citation_handle, Person, person_handle)
def __person_name(self, person):
"""
Construct person name.
@param person: Person object.
"""
maindenName = ''
if int(person.get_primary_name().get_type()) == NameType.MARRIED:
for alt_name in person.get_alternate_names():
if int(alt_name.get_type()) == NameType.BIRTH:
maindenName = ' (' + alt_name.get_surname() + ')'
return displayer.display_name(person.get_primary_name()) + maindenName
def __is_person_valid(self, person):
"""
Checks if person should be added to the book.
@param person: Person object.
"""
if person.get_primary_name().get_surname() == '':
return False
event_ref = person.get_birth_ref()
if event_ref is None:
return False
return True
def __lowercase_first_letter(self, str):
res = str[0].lower() + str[1:]
return res
def __needs_trailing_dot(self, str):
if not str.endswith('.'):
str = str + '.'
return str
def __prepare_tex_for_latex(self, str):
str = str.replace(' ', '~')
return str
def __add_person_overview(self, title, value):
if value is not None:
self.doc.write_text('\\fbPersonDescriptionItem{')
self.doc.write_text(title)
self.doc.write_text('}{')
self.doc.write_text(value)
self.doc.write_text('}\n')
def __get_source_cites(self, event):
cites = ''
for cit_handle in event.get_citation_list():
if cit_handle:
cit = self.database.get_citation_from_handle(cit_handle)
if cites != '':
cites = cites + ', '
cites = cites + cit.get_gramps_id()
self.citation_handles.add(cit_handle)
if cites != '':
cites = '~\cite{' + cites + '}'
return cites
def __add_person_event(self, person, event, title, disp_date = False):
if event is None:
return
str = ''
if disp_date:
dt = self.rlocale.get_date(event.get_date_object())
if dt:
str = '\\mbox{' + dt + '}'
if event.get_place_handle():
if str != '':
str = str + ', '
str = str + place_displayer.display_event(self.database, event)
if str != '':
if event.get_description():
str = str + ' (' + self.__lowercase_first_letter(event.get_description()) + ')'
str = self.__needs_trailing_dot(str)
cites = self.__get_source_cites(event)
self.__add_person_overview(title, str + cites)
def __add_person_event_ref(self, person, event_ref, title, disp_date = False):
if event_ref is None:
return
if event_ref.get_role() != EventRoleType.PRIMARY:
return
event = self.database.get_event_from_handle(event_ref.ref)
self.__add_person_event(person, event, title, disp_date)
def __add_person_birth(self, person):
if int(person.get_gender()) == Person.FEMALE:
title = "Родилась" # TODO
else:
title = "Родился" # TODO
self.__add_person_event_ref(person, person.get_birth_ref(), title, True)
def __add_person_death(self, person):
if int(person.get_gender()) == Person.FEMALE:
title = "Умерла" # TODO
else:
title = "Умер" # TODO
self.__add_person_event_ref(person, person.get_death_ref(), title, True)
def __make_person_parent(self, parent):
s = self.__person_name(parent)
if self.__is_person_valid(parent):
s = s + ', ' + 'с.' + '~\\pageref{' + parent.get_gramps_id() + '}' # TODO
return self.__needs_trailing_dot(s)
def __add_person_parent(self, parent, title):
self.__add_person_overview(title, self.__make_person_parent(parent))
def __process_person(self, person):
self.doc.start_paragraph('FSR-Normal')
self.doc.write_text('\\chapter{')
self.doc.write_text(self.__person_name(person))
self.doc.write_text('}\n')
self.doc.write_text('\\label{')
self.doc.write_text(person.get_gramps_id())
self.doc.write_text('}\n')
self.doc.write_text('\\small\n')
self.doc.write_text('\\fbBeginPersonDescription\n')
self.__add_person_birth(person)
self.__add_person_death(person)
for event_ref in person.get_primary_event_ref_list():
event = self.database.get_event_from_handle(event_ref.ref)
if event and int(event.get_type()) == EventType.BURIAL:
if int(person.get_gender()) == Person.FEMALE:
title = "Похоронена" # TODO
else:
title = "Похоронен" # TODO
self.__add_person_event(person, event, title, False)
parents = set()
for fam_handle in person.get_parent_family_handle_list():
family = self.database.get_family_from_handle(fam_handle)
father_handle = family.get_father_handle()
if father_handle and not(father_handle in parents):
father = self.database.get_person_from_handle(father_handle)
self.__add_person_parent(father, _("Father"))
parents.add(father_handle)
mother_handle = family.get_mother_handle()
if mother_handle and not(mother_handle in parents):
mother = self.database.get_person_from_handle(mother_handle)
self.__add_person_parent(mother, _("Mother"))
parents.add(mother_handle)
s = ''
for fam_handle in person.get_family_handle_list():
family = self.database.get_family_from_handle(fam_handle)
s2 = ''
if int(person.get_gender()) == Person.FEMALE:
father_handle = family.get_father_handle()
if father_handle:
husband = self.database.get_person_from_handle(father_handle)
s2 = self.__make_person_parent(husband)
else:
mother_handle = family.get_mother_handle()
if mother_handle:
wife = self.database.get_person_from_handle(mother_handle)
s2 = self.__make_person_parent(wife)
if s2 != '':
if s != '':
s = s + ' \\\\\n'
s = s + s2
if s != '':
if int(person.get_gender()) == Person.FEMALE:
title = "Супруг" # TODO
else:
title = "Супруга" # TODO
self.__add_person_overview(title, s)
self.doc.write_text('\\fbEndPersonDescription\n')
self.doc.write_text('\\normalsize\n')
s = ''
for note_handle in person.get_note_list():
note = self.database.get_note_from_handle(note_handle)
if int(note.get_type()) == NoteType.PERSON:
s = s + '\\fbNoteSeparator\n\n'
s = s + self.__prepare_tex_for_latex(note.get())
s = s + '\n\n'
self.doc.write_text(s)
self.doc.end_paragraph()
#------------------------------------------------------------------------
#
# MenuReportOptions
#
#------------------------------------------------------------------------
class FamilyBookOptions(MenuReportOptions):
"""
Defines options and provides handling interface.
"""
RECURSE_NONE = 0
RECURSE_SIDE = 1
RECURSE_ALL = 2
def __init__(self, name, dbase):
self.__db = dbase
self.__pid = None
MenuReportOptions.__init__(self, name, dbase)
def get_subject(self):
""" Return a string that describes the subject of the report. """
gid = self.__pid.get_value()
person = self.__db.get_person_from_gramps_id(gid)
return displayer.display(person)
def add_menu_options(self, menu):
self.__add_report_options(menu)
self.__add_report_display(menu)
def __add_report_options(self, menu):
##########################
category_name = _("Report Options")
##########################
self.__pid = PersonOption(_("Center person"))
self.__pid.set_help(_("The person who is used to deterine the relatives' titles"))
menu.add_option(category_name, "pid", self.__pid)
def __add_report_display(self, menu):
"""
How to display names, datyes, ...
"""
category_name = _("Display")
addopt = partial(menu.add_option, category_name)
stdoptions.add_name_format_option(menu, category_name)
locale_opt = stdoptions.add_localization_option(menu, category_name)
stdoptions.add_date_format_option(menu, category_name, locale_opt)
# stdoptions.add_gramps_id_option(menu, category_name)
# birthorder = BooleanOption(
# _('Sort all children in birth order'), False)
# birthorder.set_help(
# _('Whether to display children in birth order or in entry order?'))
# addopt("birthorder", birthorder)
# coordinates = BooleanOption(
# _('Do we display coordinates in the places list?'), False)
# coordinates.set_help(
# _('Whether to display latitude/longitude in the places list?'))
# addopt("coordinates", coordinates)
# reference_sort = BooleanOption(
# _('Sort places references either by date or by name'), False)
# reference_sort.set_help(
# _('Sort the places references by date or by name.'
# ' Not set means by date.'))
# addopt("reference_sort", reference_sort)
# self.__graphgens = NumberOption(_("Graph generations"), 4, 2, 10)
# self.__graphgens.set_help(_("The number of generations to include in "
# "the ancestor graph"))
# addopt("graphgens", self.__graphgens)
# self.__graph_changed()
# notes = BooleanOption(
# _('Include narrative notes just after name, gender'), True)
# notes.set_help(
# _('Include narrative notes just after name, gender and'
# ' age at death (default) or include them just before'
# ' attributes.'))
# addopt("notes", notes)
def make_default_style(self, default_style):
"""Make default output style for the Family Book Report."""
#Paragraph Styles
font = docgen.FontStyle()
font.set_type_face(docgen.FONT_SANS_SERIF)
font.set_size(10)
font.set_bold(0)
para = docgen.ParagraphStyle()
para.set_font(font)
para.set_description(_('The basic style used for the text display'))
default_style.add_paragraph_style('FSR-Normal', para)
font = docgen.FontStyle()
font.set_type_face(docgen.FONT_SANS_SERIF)
font.set_size(10)
font.set_bold(0)
para = docgen.ParagraphStyle()
para.set_font(font)
para.set_alignment(docgen.PARA_ALIGN_RIGHT)
para.set_description(_('The style used for the page key on the top'))
default_style.add_paragraph_style('FSR-Key', para)
font = docgen.FontStyle()
font.set_type_face(docgen.FONT_SANS_SERIF)
font.set_size(12)
font.set_bold(1)
para = docgen.ParagraphStyle()
para.set_font(font)
para.set_description(_("The style used for names"))
default_style.add_paragraph_style('FSR-Name', para)
font = docgen.FontStyle()
font.set_type_face(docgen.FONT_SANS_SERIF)
font.set_size(12)
font.set_bold(1)
para = docgen.ParagraphStyle()
para.set_font(font)
para.set_alignment(docgen.PARA_ALIGN_CENTER)
para.set_description(_("The style used for numbers"))
default_style.add_paragraph_style('FSR-Number', para)
font = docgen.FontStyle()
font.set_type_face(docgen.FONT_SANS_SERIF)
font.set_size(8)
font.set_bold(0)
para = docgen.ParagraphStyle()
para.set_font(font)
para.set_description(_(
'The style used for footnotes (notes and source references)'))
default_style.add_paragraph_style('FSR-Footnote', para)
#Table Styles
cell = docgen.TableCellStyle()
cell.set_padding(0.1)
cell.set_top_border(1)
cell.set_left_border(1)
cell.set_right_border(1)
default_style.add_cell_style('FSR-HeadCell', cell)
cell = docgen.TableCellStyle()
cell.set_padding(0.1)
cell.set_left_border(1)
default_style.add_cell_style('FSR-EmptyCell', cell)
cell = docgen.TableCellStyle()
cell.set_padding(0.1)
cell.set_top_border(1)
cell.set_left_border(1)
default_style.add_cell_style('FSR-NumberCell', cell)
cell = docgen.TableCellStyle()
cell.set_padding(0.1)
cell.set_top_border(1)
cell.set_right_border(1)
cell.set_left_border(1)
default_style.add_cell_style('FSR-DataCell', cell)
cell = docgen.TableCellStyle()
cell.set_padding(0.1)
cell.set_top_border(1)
default_style.add_cell_style('FSR-FootCell', cell)
table = docgen.TableStyle()
table.set_width(100)
table.set_columns(3)
table.set_column_width(0, 7)
table.set_column_width(1, 7)
table.set_column_width(2, 86)
default_style.add_table_style('FSR-Table', table)