First part of Media Metadata Gramplet for the MediaView bottom bar! The only reason that I am committing this now is because I am confused and baffled at the results that I am getting from this gramplet. Please see email to the development list for more information. It is working, but it looks weird...
svn: r16752
This commit is contained in:
Rob G. Healey
parent
f9179e8186
commit
ba2302030b
@ -24,6 +24,7 @@ pkgdata_PYTHON = \
|
||||
Notes.py \
|
||||
PedigreeGramplet.py \
|
||||
PersonDetails.py \
|
||||
MediaMetadata.py \
|
||||
PersonResidence.py \
|
||||
PlaceDetails.py \
|
||||
PluginManagerGramplet.py\
|
||||
|
||||
397
src/plugins/gramplet/MediaMetadata.py
Normal file
397
src/plugins/gramplet/MediaMetadata.py
Normal file
@ -0,0 +1,397 @@
|
||||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Gramps - a GTK+/GNOME based genealogy program
|
||||
#
|
||||
# Copyright (C) 2011 Rob G. Healey <robhealey1 [AT] gmail [DOT] com>
|
||||
#
|
||||
# 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
#
|
||||
# $Id: AttributesGramplet.py 16035 2010-10-24 14:43:47Z bmcage $
|
||||
#
|
||||
|
||||
# *****************************************************************************
|
||||
# Python Modules
|
||||
# *****************************************************************************
|
||||
import os, sys
|
||||
from datetime import datetime, date
|
||||
import time
|
||||
|
||||
# abilty to escape certain characters from html output...
|
||||
from xml.sax.saxutils import escape as _html_escape
|
||||
|
||||
#------------------------------------------------
|
||||
# Gtk/ Gramps modules
|
||||
#------------------------------------------------
|
||||
|
||||
from gen.plug import Gramplet
|
||||
from gen.ggettext import gettext as _
|
||||
|
||||
import gen.mime
|
||||
|
||||
# import the pyexiv2 library classes for this addon
|
||||
_DOWNLOAD_LINK = "http://tilloy.net/dev/pyexiv2/"
|
||||
pyexiv2_required = True
|
||||
try:
|
||||
import pyexiv2
|
||||
REQ_pyexiv2_VERSION = (0, 2, 0)
|
||||
if pyexiv2.version_info < REQ_pyexiv2_VERSION:
|
||||
pyexiv2_required = False
|
||||
|
||||
except ImportError:
|
||||
raise Exception(_("The, pyexiv2, python binding library, to exiv2 is not "
|
||||
"installed on this computer.\n It can be downloaded from here: %s\n"
|
||||
"You will need to download at least pyexiv2-%d.%d.%d .") % (
|
||||
REQ_pyexiv2_VERSION, _DOWNLOAD_LINK))
|
||||
|
||||
except AttributeError:
|
||||
pyexiv2_required = False
|
||||
|
||||
if not pyexiv2_required:
|
||||
raise Exception(_("The minimum required version for pyexiv2 must be pyexiv2-%d.%d.%d\n"
|
||||
"or greater. You may download it from here: %s\n\n") % (
|
||||
REQ_pyexiv2_VERSION, _DOWNLOAD_LINK))
|
||||
|
||||
# import the required classes for use in this gramplet
|
||||
from pyexiv2 import ExifTag, ImageMetadata, IptcTag, Rational
|
||||
|
||||
from gen.plug import Gramplet
|
||||
from DateHandler import displayer as _dd
|
||||
|
||||
import gen.lib
|
||||
import Utils
|
||||
|
||||
#------------------------------------------------
|
||||
# Support functions
|
||||
#------------------------------------------------
|
||||
def _return_month(month):
|
||||
"""
|
||||
returns either an integer of the month number or the abbreviated month name
|
||||
|
||||
@param: rmonth -- can be one of:
|
||||
10, "10", or ( "Oct" or "October" )
|
||||
"""
|
||||
|
||||
if isinstance(month, str):
|
||||
for s, l, i in _allmonths:
|
||||
found = any(month == value for value in [s, l])
|
||||
if found:
|
||||
month = int(i)
|
||||
break
|
||||
else:
|
||||
for s, l, i in _allmonths:
|
||||
if str(month) == i:
|
||||
month = l
|
||||
break
|
||||
return month
|
||||
|
||||
def _split_values(text):
|
||||
"""
|
||||
splits a variable into its pieces
|
||||
"""
|
||||
|
||||
if "-" in text:
|
||||
separator = "-"
|
||||
elif "." in text:
|
||||
separator = "."
|
||||
elif ":" in text:
|
||||
separator = ":"
|
||||
else:
|
||||
separator = " "
|
||||
return [value for value in text.split(separator)]
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# Constants
|
||||
# -----------------------------------------------------------------------------
|
||||
# available image types for exiv2
|
||||
_valid_types = ["jpeg", "exv", "tiff", "dng", "nef", "pef", "pgf", "png", "psd", "jp2", "jpg"]
|
||||
|
||||
# set up Exif keys for Image.exif_keys
|
||||
ImageArtist = "Exif.Image.Artist"
|
||||
ImageCopyright = "Exif.Image.Copyright"
|
||||
ImageDateTime = "Exif.Image.DateTime"
|
||||
ImageLatitude = "Exif.GPSInfo.GPSLatitude"
|
||||
ImageLatitudeRef = "Exif.GPSInfo.GPSLatitudeRef"
|
||||
ImageLongitude = "Exif.GPSInfo.GPSLongitude"
|
||||
ImageLongitudeRef = "Exif.GPSInfo.GPSLongitudeRef"
|
||||
ImageDescription = "Exif.Image.ImageDescription"
|
||||
|
||||
# set up keys for Image IPTC keys
|
||||
IptcKeywords = "Iptc.Application2.Keywords"
|
||||
|
||||
_DATAMAP = [ImageArtist, ImageCopyright, ImageDateTime,
|
||||
ImageLatitude, ImageLatitudeRef, ImageLongitude, ImageLongitudeRef,
|
||||
ImageDescription]
|
||||
|
||||
_allmonths = list( [_dd.short_months[i], _dd.long_months[i], i] for i in range(1, 13) )
|
||||
|
||||
class MediaMetadata(Gramplet):
|
||||
"""
|
||||
Displays the Media Metadata if present ?
|
||||
"""
|
||||
def init(self):
|
||||
|
||||
# set all dirty variables to False to begin this gramplet
|
||||
_dirty_image = False
|
||||
|
||||
plugin_image = False
|
||||
mtype = False
|
||||
|
||||
self.set_text(_("No Family Tree loaded."))
|
||||
self.set_use_markup(True)
|
||||
|
||||
def post_init(self):
|
||||
self.connect_signal("Media", self.update)
|
||||
|
||||
def db_changed(self):
|
||||
self.dbstate.db.connect('media-update', self.update)
|
||||
self.update()
|
||||
|
||||
def active_changed(self, handle):
|
||||
self.update()
|
||||
|
||||
def main(self): # return false finishes
|
||||
|
||||
self.set_text("")
|
||||
active_handle = self.get_active('Media')
|
||||
active_media = self.dbstate.db.get_object_from_handle(active_handle)
|
||||
if not active_media:
|
||||
return
|
||||
|
||||
# get mime type and make sure it is an image
|
||||
mime_type = active_media.get_mime_type()
|
||||
mtype = gen.mime.get_description(mime_type)
|
||||
if mime_type and mime_type.startswith("image"):
|
||||
value, filetype = mime_type.split("/")
|
||||
|
||||
# make sure it is within the allowable media types?
|
||||
found = any(_type == filetype for _type in _valid_types)
|
||||
if not found:
|
||||
return
|
||||
|
||||
# make sure media is on the computer?
|
||||
image_path = Utils.media_path_full(self.dbstate.db, active_media.get_path() )
|
||||
if not os.path.exists(image_path):
|
||||
return
|
||||
|
||||
# make sure the file permissions allow reading?
|
||||
readable = os.access(image_path, os.R_OK)
|
||||
if not readable:
|
||||
return
|
||||
|
||||
# define plugin media
|
||||
plugin_image = ImageMetadata(image_path)
|
||||
|
||||
# read media metadata
|
||||
plugin_image.read()
|
||||
|
||||
# display media description
|
||||
title = active_media.get_description()
|
||||
self.render_text(_("Active media") + ": <b>%s</b>" % title)
|
||||
self.append_text("\n")
|
||||
|
||||
# display Media mime type
|
||||
self.append_text(_("Mime type") + ": " + mtype)
|
||||
self.append_text("\n\n")
|
||||
|
||||
# set up image metadata keys for use in this gramplet
|
||||
dataKeyTags = [KeyTag for KeyTag in plugin_image.exif_keys if KeyTag in _DATAMAP ]
|
||||
|
||||
for KeyTag in dataKeyTags:
|
||||
|
||||
# Media image Artist
|
||||
if KeyTag == ImageArtist:
|
||||
self.append_text(_("Artist") + ": " + _get_value(KeyTag, plugin_image))
|
||||
self.append_text("\n")
|
||||
|
||||
# media image Copyright
|
||||
elif KeyTag == ImageCopyright:
|
||||
self.append_text(_("Copyright") + ": " + _get_value(KeyTag, plugin_image))
|
||||
self.append_text("\n\n")
|
||||
|
||||
# media image DateTime
|
||||
elif KeyTag == ImageDateTime:
|
||||
|
||||
# date1 may come from the image metadata
|
||||
# date2 may come from the Gramps database
|
||||
date1 = _get_value( KeyTag, plugin_image )
|
||||
date2 = active_media.get_date_object()
|
||||
|
||||
use_date = date1 or date2
|
||||
if use_date:
|
||||
rdate, rtime = self.process_date(use_date)
|
||||
|
||||
self.append_text(_("Date") + ": " + rdate)
|
||||
self.append_text("\n")
|
||||
|
||||
self.append_text(_("Time") + ": " + rtime)
|
||||
self.append_text("\n\n")
|
||||
|
||||
# Latitude and Latitude Reference
|
||||
elif KeyTag == ImageLatitude:
|
||||
|
||||
latitude = _get_value(ImageLatitude, plugin_image)
|
||||
longitude = _get_value(ImageLongitude, plugin_image)
|
||||
|
||||
# if latitude and longitude exist, display them...
|
||||
if (latitude and longitude):
|
||||
|
||||
# split latitude metadata into (degrees, minutes, and seconds) from Rational
|
||||
deg, min, sec = rational_to_dms(latitude)
|
||||
|
||||
# Latitude Direction Reference
|
||||
LatitudeRef = _get_value(ImageLatitudeRef, plugin_image)
|
||||
|
||||
self.append_text(_("Latitude") + ": " + """%s° %s′ %s″ %s""" % (
|
||||
deg, min, sec, LatitudeRef)
|
||||
)
|
||||
self.append_text("\n")
|
||||
|
||||
# split longitude metadata into degrees, minutes, and seconds
|
||||
deg, min, sec = rational_to_dms(longitude)
|
||||
|
||||
# Longitude Direction Reference
|
||||
LongitudeRef = _get_value(ImageLongitudeRef, plugin_image)
|
||||
|
||||
self.append_text(_("Longitude") + ": " + """%s° %s′ %s″ %s""" % (
|
||||
deg, min, sec, LongitudeRef)
|
||||
)
|
||||
self.append_text("\n\n")
|
||||
|
||||
# Image Description Field
|
||||
elif KeyTag == ImageDescription:
|
||||
self.append_text(_("Description") + ": " + _get_value(ImageDescription, plugin_image))
|
||||
self.append_text("\n")
|
||||
|
||||
# image Keywords
|
||||
words = ""
|
||||
keyWords = _get_value(IptcKeywords, plugin_image)
|
||||
if keyWords:
|
||||
index = 1
|
||||
for word in keyWords:
|
||||
words += word
|
||||
if index is not len(keyWords):
|
||||
words += ","
|
||||
index += 1
|
||||
self.append_text(_("Keywords") + ": " + words)
|
||||
self.append_text("\n")
|
||||
|
||||
self.append_text("\n", scroll_to="begin")
|
||||
|
||||
def process_date(self, tmpDate):
|
||||
"""
|
||||
Process the date for read and write processes
|
||||
year, month, day, hour, minutes, seconds
|
||||
|
||||
@param: tmpDate = variable to be processed
|
||||
"""
|
||||
|
||||
year, month, day = False, False, False
|
||||
now = time.localtime()
|
||||
datetype = tmpDate.__class__
|
||||
|
||||
# get local time for when if it is not available?
|
||||
hour, minutes, seconds = now[3:6]
|
||||
|
||||
found = any(datetype == _type for _type in [datetime, date, gen.lib.date.Date])
|
||||
if found:
|
||||
|
||||
#ImageDateTime is in datetime.datetime format
|
||||
if datetype == datetime:
|
||||
year, month, day = tmpDate.year, tmpDate.month, tmpDate.day
|
||||
hour, minutes, seconds = tmpDate.hour, tmpDate.minute, tmpDate.second
|
||||
|
||||
# ImageDateTime is in datetime.date format
|
||||
elif datetype == date:
|
||||
year, month, day = tmpDate.year, tmpDate.month, tmpDate.day
|
||||
|
||||
# ImageDateTime is in gen.lib.date.Date format
|
||||
elif datetype == gen.lib.date.Date:
|
||||
year, month, day = tmpDate.get_year(), tmpDate.get_month(), tmpDate.get_day()
|
||||
|
||||
# ImageDateTime is in string format
|
||||
elif datetype == str:
|
||||
|
||||
# separate date and time from the string
|
||||
if "/" in tmpDate:
|
||||
rdate, rtime = tmpDate.split("/")
|
||||
elif tmpDate.count(" ") == 1:
|
||||
rdate, rtime = tmpDate.split(" ")
|
||||
else:
|
||||
rdate = tmpDate
|
||||
rtime = False
|
||||
|
||||
# split date elements
|
||||
year, month, day = _split_values(rdate)
|
||||
|
||||
# split time elements if not False
|
||||
if rtime is not False:
|
||||
hour, minutes, seconds = _split_values(rtime)
|
||||
hour, minutes, seconds = int(hour), int(minutes), int(seconds)
|
||||
|
||||
found = any(value == False for value in [year, month, day] )
|
||||
if not found:
|
||||
|
||||
# convert values to integers
|
||||
year, day = int(year), int(day)
|
||||
month = _return_month(month)
|
||||
|
||||
if isinstance(month, int):
|
||||
rdate = "%04d-%s-%02d" % (year, _dd.long_months[month], day)
|
||||
elif isinstance(month, str):
|
||||
rdate = "%04d-%s-%02d" % (year, month, day)
|
||||
rtime = "%02d:%02d:%02d" % (hour, minutes, seconds)
|
||||
|
||||
return rdate, rtime
|
||||
|
||||
#------------------------------------------------
|
||||
# Retrieve metadata from image
|
||||
#------------------------------------------------
|
||||
|
||||
def _get_value(KeyTag, image):
|
||||
"""
|
||||
gets the value from the Exif Key, and returns it...
|
||||
|
||||
@param: KeyTag -- image metadata key
|
||||
@param: image -- pyexiv2 ImageMetadata instance
|
||||
"""
|
||||
|
||||
# Exif KeyValue Family?
|
||||
if "Exif" in KeyTag:
|
||||
try:
|
||||
KeyValue = image[KeyTag].raw_value
|
||||
except KeyError:
|
||||
KeyValue = image[KeyTag].value
|
||||
|
||||
# Iptc KeyValue family?
|
||||
else:
|
||||
try:
|
||||
KeyValue = image[KeyTag].value
|
||||
except KeyError:
|
||||
KeyValue = ""
|
||||
|
||||
return KeyValue
|
||||
|
||||
def rational_to_dms(rational_coords):
|
||||
"""
|
||||
will return a rational set of coordinates to degrees, minutes, seconds
|
||||
"""
|
||||
|
||||
rd, rm, rs = rational_coords.split(" ")
|
||||
rd, rest = rd.split("/")
|
||||
rm, rest = rm.split("/")
|
||||
rs, rest = rs.split("/")
|
||||
|
||||
return rd, rm, rs
|
||||
@ -77,6 +77,19 @@ register(GRAMPLET,
|
||||
gramplet_title=_("Preview"),
|
||||
)
|
||||
|
||||
register(GRAMPLET,
|
||||
id="Media Metadata Gramplet",
|
||||
name=_("Media Metadata Gramplet"),
|
||||
description = _("Gramplet showing metadata of a media object"),
|
||||
version="1.0.0",
|
||||
gramps_target_version="3.3",
|
||||
status = STABLE,
|
||||
fname="MediaMetadata.py",
|
||||
height=200,
|
||||
gramplet = 'MediaMetadata',
|
||||
gramplet_title=_("Metadata"),
|
||||
)
|
||||
|
||||
register(GRAMPLET,
|
||||
id="Person Residence Gramplet",
|
||||
name=_("Person Residence Gramplet"),
|
||||
|
||||
@ -436,6 +436,7 @@ class MediaView(ListView):
|
||||
"""
|
||||
return (("Media Filter Gramplet",),
|
||||
("Media Preview Gramplet",
|
||||
"Media Metadata Gramplet",
|
||||
"Media Sources Gramplet",
|
||||
"Media Notes Gramplet",
|
||||
"Media Attributes Gramplet"))
|
||||
|
||||
Loading…
Reference in New Issue
Block a user