#
# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2000-2007 Donald N. Allingham
# Copyright (C) 2007-2009 Brian G. Matherly
# Copyright (C) 2008 James Friedmann <jfriedmannj@gmail.com>
# Copyright (C) 2010 Jakim Friant
# Copyright (C) 2015-2016 Paul Franklin
#
# 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.
#
"""
A collection of utilities to aid in the generation of reports.
"""
#-------------------------------------------------------------------------
#
# Standard Python modules
#
#-------------------------------------------------------------------------
import os
#------------------------------------------------------------------------
#
# Gramps modules
#
#------------------------------------------------------------------------
from ...const import GRAMPS_LOCALE as glocale
_ = glocale.translation.gettext
from ...datehandler import get_date
from ...display.place import displayer as _pd
from ...utils.file import media_path_full
from ..docgen import IndexMark, INDEX_TYPE_ALP
# _T_ is a gramps-defined keyword -- see po/update_po.py and po/genpot.sh
def _T_(value):
""" enable deferred translations (see Python docs 22.1.3.4) """
return value
#-------------------------------------------------------------------------
#
# Convert points to cm and back
#
#-------------------------------------------------------------------------
[docs]
def pt2cm(pt_):
"""
Convert points to centimeters. Fonts are typically specified in points,
but the :class:`.BaseDoc` classes use centimeters.
:param pt_: points
:type pt_: float or int
:returns: equivalent units in centimeters
:rtype: float
"""
return pt_ / 28.3465
[docs]
def cm2pt(cm_):
"""
Convert centimeters to points. Fonts are typically specified in points,
but the :class:`.BaseDoc` classes use centimeters.
:param cm_: centimeters
:type cm_: float or int
:returns: equivalent units in points
:rtype: float
"""
return cm_ * 28.3465
[docs]
def rgb_color(color):
"""
Convert color value from 0-255 integer range into 0-1 float range.
:param color: list or tuple of integer values for red, green, and blue
:type color: int
:returns: (red, green, blue) tuple of floating point color values
:rtype: 3-tuple
"""
red = float(color[0]) / 255.0
green = float(color[1]) / 255.0
blue = float(color[2]) / 255.0
return (red, green, blue)
#-------------------------------------------------------------------------
#
# Roman numbers
#
#-------------------------------------------------------------------------
[docs]
def roman(num):
""" Integer to Roman numeral converter for 0 < num < 4000 """
if not isinstance(num, int):
return "?"
if not 0 < num < 4000:
return "?"
vals = (1000, 900, 500, 400, 100, 90, 50, 40, 10, 9, 5, 4, 1)
nums = ('M', 'CM', 'D', 'CD', 'C', 'XC', 'L',
'XL', 'X', 'IX', 'V', 'IV', 'I')
retval = ""
for i in range(len(vals)):
amount = int(num / vals[i])
retval += nums[i] * amount
num -= vals[i] * amount
return retval
#-------------------------------------------------------------------------
#
#
#
#-------------------------------------------------------------------------
[docs]
def place_name(dbase, place_handle):
""" returns a place string given a handle """
if place_handle:
place = dbase.get_place_from_handle(place_handle)
name = _pd.display(dbase, place)
else:
name = ""
return str(name)
#-------------------------------------------------------------------------
#
# Functions commonly used in reports
#
#-------------------------------------------------------------------------
[docs]
def insert_image(database, doc, photo, user,
w_cm=4.0, h_cm=4.0, alt="", style_name=None, align='right'):
"""
Insert pictures of a person into the document.
:type photo: :class:`~.mediaref.MediaRef`
:type user: :class:`.gen.user.User`
:param alt: an alternative text to use. Useful for eg html reports
:param style_name: style to use for the "alternative text" or captions
:param align: image alignment: 'left', 'right', 'center', or 'single'
"""
object_handle = photo.get_reference_handle()
media = database.get_media_from_handle(object_handle)
mime_type = media.get_mime_type()
if mime_type and mime_type.startswith("image"):
filename = media_path_full(database, media.get_path())
if os.path.exists(filename):
doc.add_media(filename, align, w_cm, h_cm,
alt=alt, style_name=style_name,
crop=photo.get_rectangle())
else:
no_file = _('File does not exist')
user.warn(_("Could not add photo to page"),
_("%(str1)s: %(str2)s") % {'str1': filename,
'str2': no_file})
#-------------------------------------------------------------------------
#
# find_spouse
#
#-------------------------------------------------------------------------
[docs]
def find_spouse(person, family):
""" find the spouse of a person """
spouse_handle = None
if family:
if person.get_handle() == family.get_father_handle():
spouse_handle = family.get_mother_handle()
else:
spouse_handle = family.get_father_handle()
return spouse_handle
#-------------------------------------------------------------------------
#
# find_marriage
#
#-------------------------------------------------------------------------
[docs]
def find_marriage(database, family):
""" find the marriage of a family """
for event_ref in family.get_event_ref_list():
event = database.get_event_from_handle(event_ref.ref)
if (event
and event.type.is_marriage()
and event_ref.role.is_family()):
return event
return None
#-------------------------------------------------------------------------
#
# Indexing function
#
#-------------------------------------------------------------------------
[docs]
def get_person_mark(dbase, person):
"""
Return a IndexMark that can be used to index a person in a report
:param dbase: the Gramps database instance
:param person: the key is for
"""
if not person:
return None
name = person.get_primary_name().get_name()
birth = " "
death = " "
key = ""
birth_ref = person.get_birth_ref()
if birth_ref:
birth_event = dbase.get_event_from_handle(birth_ref.ref)
birth = get_date(birth_event)
death_ref = person.get_death_ref()
if death_ref:
death_event = dbase.get_event_from_handle(death_ref.ref)
death = get_date(death_event)
if birth == death == " ":
key = name
else:
key = "%s (%s - %s)" % (name, birth, death)
return IndexMark(key, INDEX_TYPE_ALP)
#-------------------------------------------------------------------------
#
# Address String
#
#-------------------------------------------------------------------------
[docs]
def get_address_str(addr):
"""
Return a string that combines the elements of an address
:param addr: the Gramps address instance
"""
addr_str = ""
elems = [addr.get_street(),
addr.get_locality(),
addr.get_city(),
addr.get_county(),
addr.get_state(),
addr.get_country(),
addr.get_postal_code(),
addr.get_phone()]
for info in elems:
if info:
if addr_str == "":
addr_str = info
else:
# translators: needed for Arabic, ignore otherwise
addr_str = _("%(str1)s, %(str2)s"
) % {'str1' : addr_str, 'str2' : info}
return addr_str
#-------------------------------------------------------------------------
#
# People Filters
#
#-------------------------------------------------------------------------
[docs]
def get_person_filters(person, include_single=True, name_format=None):
"""
Return a list of filters that are relevant for the given person
:param person: the person the filters should apply to.
:type person: :class:`~.person.Person`
:param include_single: include a filter to include the single person
:type include_single: boolean
:param name_format: optional format to control display of person's name
:type name_format: None or int
"""
from ...filters import GenericFilter, rules, CustomFilters, DeferredFilter
from ...display.name import displayer as name_displayer
if person:
real_format = name_displayer.get_default_format()
if name_format is not None:
name_displayer.set_default_format(name_format)
name = name_displayer.display(person)
name_displayer.set_default_format(real_format)
gramps_id = person.get_gramps_id()
else:
# Do this in case of command line options query (show=filter)
name = _("PERSON")
gramps_id = ''
if include_single:
filt_id = GenericFilter()
filt_id.set_name(name)
filt_id.add_rule(rules.person.HasIdOf([gramps_id]))
all_people = DeferredFilter(_T_("Entire Database"), None)
all_people.add_rule(rules.person.Everyone([]))
# feature request 2356: avoid genitive form
des = DeferredFilter(_T_("Descendants of %s"), name)
des.add_rule(rules.person.IsDescendantOf([gramps_id, 1]))
# feature request 2356: avoid genitive form
d_fams = DeferredFilter(_T_("Descendant Families of %s"), name)
d_fams.add_rule(rules.person.IsDescendantFamilyOf([gramps_id, 1]))
# feature request 2356: avoid genitive form
ans = DeferredFilter(_T_("Ancestors of %s"), name)
ans.add_rule(rules.person.IsAncestorOf([gramps_id, 1]))
com = DeferredFilter(_T_("People with common ancestor with %s"), name)
com.add_rule(rules.person.HasCommonAncestorWith([gramps_id]))
if include_single:
the_filters = [filt_id, all_people, des, d_fams, ans, com]
else:
the_filters = [all_people, des, d_fams, ans, com]
the_filters.extend(CustomFilters.get_filters('Person'))
return the_filters
#-------------------------------------------------------------------------
#
# Family Filters
#
#-------------------------------------------------------------------------
[docs]
def get_family_filters(database, family,
include_single=True, name_format=None):
"""
Return a list of filters that are relevant for the given family
:param database: The database that the family is in.
:type database: DbBase
:param family: the family the filters should apply to.
:type family: :class:`~.family.Family`
:param include_single: include a filter to include the single family
:type include_single: boolean
:param name_format: optional format to control display of person's name
:type name_format: None or int
"""
from ...filters import (GenericFilterFactory, rules, CustomFilters,
DeferredFamilyFilter)
from ...display.name import displayer as name_displayer
if family:
real_format = name_displayer.get_default_format()
if name_format is not None:
name_displayer.set_default_format(name_format)
fhandle = family.get_father_handle()
if fhandle:
father = database.get_person_from_handle(fhandle)
father_name = name_displayer.display(father)
else:
father_name = _("unknown father")
mhandle = family.get_mother_handle()
if mhandle:
mother = database.get_person_from_handle(mhandle)
mother_name = name_displayer.display(mother)
else:
mother_name = _("unknown mother")
gramps_id = family.get_gramps_id()
name = _("%(father_name)s and %(mother_name)s (%(family_id)s)"
) % {'father_name' : father_name,
'mother_name' : mother_name,
'family_id' : gramps_id}
name_displayer.set_default_format(real_format)
else:
# Do this in case of command line options query (show=filter)
name = _("FAMILY")
gramps_id = ''
if include_single:
FilterClass = GenericFilterFactory('Family')
filt_id = FilterClass()
filt_id.set_name(name)
filt_id.add_rule(rules.family.HasIdOf([gramps_id]))
all_families = DeferredFamilyFilter(_T_("Every family"), None)
all_families.add_rule(rules.family.AllFamilies([]))
# feature request 2356: avoid genitive form
d_fams = DeferredFamilyFilter(_T_("Descendant Families of %s"), name)
d_fams.add_rule(rules.family.IsDescendantOf([gramps_id, 1]))
# feature request 2356: avoid genitive form
ans = DeferredFamilyFilter(_T_("Ancestor Families of %s"), name)
ans.add_rule(rules.family.IsAncestorOf([gramps_id, 1]))
if include_single:
the_filters = [filt_id, all_families, d_fams, ans]
else:
the_filters = [all_families, d_fams, ans]
the_filters.extend(CustomFilters.get_filters('Family'))
return the_filters