Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MediaReport]: New image DPI option #285

Draft
wants to merge 3 commits into
base: maintenance/gramps51
Choose a base branch
from
Draft

[MediaReport]: New image DPI option #285

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a86ca7c
MediaReport: new image DPI option
Mattkmmr Jan 25, 2020
3174d11
[media_report] try fixing dialog issue for CLI
Mattkmmr Sep 6, 2021
70ed99a
Merge branch 'maintenance/gramps51' into update-media-report
Mattkmmr Feb 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion MediaReport/media_report.gpr.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
name = _("Media Report"),
description = _("Generates report including images, image data"
" and notes."),
version = '1.1.7',
version = '1.2.0',
gramps_target_version = "5.1",
status = STABLE,
fname = "media_report.py",
Expand Down
94 changes: 55 additions & 39 deletions MediaReport/media_report.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#
# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2019 Matthias Kemmer
# Copyright (C) 2019 Matthias Kemmer
#
# 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
Expand All @@ -17,7 +17,7 @@
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#

"""A text report for media containing images, image data and notes."""

# ----------------------------------------------------------------------------
#
Expand All @@ -29,7 +29,7 @@

# ----------------------------------------------------------------------------
#
# Gramps module
# Gramps modules
#
# ----------------------------------------------------------------------------
from gramps.gui.dialog import OkDialog
Expand All @@ -41,10 +41,12 @@
from gramps.gen.plug.docgen import (ParagraphStyle, FontStyle, TableStyle,
TableCellStyle, PARA_ALIGN_CENTER,
PARA_ALIGN_LEFT)

# Old:
#from gramps.gen.const import GRAMPS_LOCALE as glocale
#_ = glocale.translation.gettext
from gramps.gen.const import GRAMPS_LOCALE as glocale
try:
_trans = glocale.get_addon_translator(__file__)
except ValueError:
_trans = glocale.translation
_ = _trans.gettext

# New:
#------------------------------------------------------------------------
Expand All @@ -66,6 +68,7 @@
# ----------------------------------------------------------------------------
class MediaReport(Report):
"""Create a Media Report containing images, image data and notes."""

def __init__(self, database, options, user):
Report.__init__(self, database, options, user)

Expand All @@ -74,12 +77,13 @@ def __init__(self, database, options, user):
self._db = self.database
self._opt = self.get_opt_dict()
self.user = user
self.window = self.user.uistate.window
self.window = self.user.uistate.window if self.user.uistate else None
self.filename = None

def get_opt_dict(self):
"""
Get the values of the menu options
Get the values of the menu options.

:return: dictionary e.g. {opt_name:value}
"""
dct = dict()
Expand All @@ -100,39 +104,40 @@ def __valid_options(self):
dct = self._opt
mid = dct["mid"]
is_img = self.__media_is_img(mid)
msg1 = _("You have to select an image to generate this report.")
msg2 = _("You have to select a custom note or uncheck the option "
"'include custom note' to generate this report.")
msg3 = _("This report only supports PDF as output file format.")

# no media file selected
if not mid or mid == "":
OkDialog(_("INFO"), _("You have to select an image to generate "
"this report."), parent=self.window)
if self.window:
OkDialog(_("INFO"), msg1, parent=self.window)
return False

# 'include custom note' checked, but no custom note selected
if dct["incl_note"] and dct["note"] == "":
OkDialog(_("INFO"), _("You have to select a custom note or uncheck"
" the option 'include custom note' to "
"generate this report."), parent=self.window)
if self.window:
OkDialog(_("INFO"), msg2, parent=self.window)
return False

# incorrect media file, not an image
if not is_img:
OkDialog(_("INFO"), _("You have to select an image to "
"generate this report."), parent=self.window)
if self.window:
OkDialog(_("INFO"), msg1, parent=self.window)
return False

# other file output than PDF (PDF is only one supported right now)
if self.options.get_output()[-3:] != "pdf":
OkDialog(_("INFO"), _("This report only supports PDF as output "
"file format."), parent=self.window)
if self.window:
OkDialog(_("INFO"), msg3, parent=self.window)
return False

# if everything is valid
return True

def write_report(self):
"""
Inherited method; called by Report() in _ReportDialog.py
"""
"""Inherited method; called by Report() in '_ReportDialog.py'."""
# check if an image is selected and a note, if include note is checked
# stop report generation if one is missing
if not self.__valid_options():
Expand Down Expand Up @@ -260,7 +265,8 @@ def __write_general_data(self, media):
self.doc.end_row()
self.doc.end_table()

def __get_ref_list(self, media):
@staticmethod
def __get_ref_list(media):
dct = dict()
for category in media.get_referenced_handles():
name, handle = category
Expand Down Expand Up @@ -318,14 +324,14 @@ def pers_ref_lst(self, media_handle):
return lst

def write_heading(self, txt, heading="Heading"):
"""Write a report heading"""
"""Write a report heading."""
self.doc.start_paragraph(heading)
self.doc.write_text(txt)
self.doc.end_paragraph()

def write_media(self, path):
"""
Add the image to the report
Add the image to the report.

:param path: gramps media path
:type path: string
Expand All @@ -337,7 +343,8 @@ def write_media(self, path):
height = floor(self.doc.get_usable_height() *
self._opt["media_h"] * 0.009)
# height is capped to 90% to save some space for report heading
self.doc.add_media(self.filename, 'center', width, height)
dpi = self._opt['dpi']
self.doc.add_media(self.filename, 'center', width, height, dpi)
else:
no_file = _('File does not exist')
self.user.warn(_("Could not add photo to page"),
Expand All @@ -346,11 +353,12 @@ def write_media(self, path):

def write_person_reference(self, media):
"""
Add a table that list all referenced people in the image
Add a table that list all referenced people in the image.

:param media: the media object used in this report
:type media: :class Media: object
"""
dpi = self._opt['dpi']
# Add some space by adding empty heading
self.write_heading(" ")
# Add person references
Expand All @@ -365,7 +373,8 @@ def write_person_reference(self, media):

self.doc.start_row()
self.doc.start_cell('cell')
self.doc.add_media(self.filename, 'center', 2.0, 2.0, crop=ref1[1])
self.doc.add_media(self.filename, 'center', 2.0, 2.0, dpi,
crop=ref1[1])
self.doc.end_cell()

self.doc.start_cell('cell')
Expand All @@ -375,7 +384,8 @@ def write_person_reference(self, media):
self.doc.end_cell()

self.doc.start_cell('cell')
self.doc.add_media(self.filename, 'center', 2.0, 2.0, crop=ref2[1])
self.doc.add_media(self.filename, 'center', 2.0, 2.0, dpi,
crop=ref2[1])
self.doc.end_cell()

self.doc.start_cell('cell')
Expand All @@ -388,7 +398,7 @@ def write_person_reference(self, media):
pers_name = name_displayer.display(ref_lst[-1][0])
self.doc.start_row()
self.doc.start_cell('cell')
self.doc.add_media(self.filename, 'center', 2.0, 2.0,
self.doc.add_media(self.filename, 'center', 2.0, 2.0, dpi,
crop=ref_lst[-1][1])
self.doc.end_cell()

Expand Down Expand Up @@ -417,17 +427,18 @@ def write_note(self):
#
# ----------------------------------------------------------------------------
class ReportOptions(MenuReportOptions):
"""Report options for Media Report"""
"""Report options for Media Report."""

def __init__(self, name, dbase):
MenuReportOptions.__init__(self, name, dbase)

def add_menu_options(self, menu):
"""Add the options to the report option menu"""
"""Add the options to the report option menu."""
head = StringOption(_("Heading"), "")
menu.add_option(_("Report Options"), "head", head)

media = MediaOption(_("Media"))
media.set_help(_("Select a media file for this report"))
media = MediaOption(_("Image"))
media.set_help(_("Select an image file for this report"))
menu.add_option(_("Report Options"), "mid", media)

self.note = NoteOption(_("Custom note"))
Expand All @@ -443,26 +454,31 @@ def add_menu_options(self, menu):
incl_pers.set_help(_("Referenced people will be included"))
menu.add_option(_("Report Options"), "incl_pers", incl_pers)

incl_data = BooleanOption(_("Include media data"), False)
incl_data = BooleanOption(_("Include image data"), False)
incl_data.set_help(_("Tags, notes and attributes will be included"))
menu.add_option(_("Report Options"), "incl_data", incl_data)

media_w = NumberOption(_("Media width"), 100, 10, 100, 10)
media_w.set_help(_("Maximum media width in % of available "
media_w = NumberOption(_("Image width"), 100, 10, 100, 10)
media_w.set_help(_("Maximum image width in % of available "
"page width."))
menu.add_option(_("Report Options"), "media_w", media_w)

media_h = NumberOption(_("Media height"), 100, 10, 100, 10)
media_h.set_help(_("Maximum media height in % of available page "
media_h = NumberOption(_("Image height"), 100, 10, 100, 10)
media_h.set_help(_("Maximum image height in % of available page "
"height."))
menu.add_option(_("Report Options"), "media_h", media_h)

media_dpi = NumberOption(_("Image DPI"), 72, 1, 1000)
media_dpi.set_help(_("Set the DPI value for the images."))
menu.add_option(_("Report Options"), "dpi", media_dpi)

def __update_custom_note_opt(self):
self.note.set_available(False)
if self.incl_note.get_value():
self.note.set_available(True)

def make_default_style(self, default_style):
@staticmethod
def make_default_style(default_style):
"""Define the default styling."""
para = ParagraphStyle()
default_style.add_paragraph_style("Default", para)
Expand Down