The pre-commit-annex hook script that automatically extracts metadata has been updated to also use exiftool. Thanks, Klaus Ethgen.

4 files changed, 124 insertions, 45 deletions

diff --git a/debian/changelog b/debian/changelog
index 7c97d97bf..0fb7025dc 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -19,6 +19,9 @@ git-annex (6.20160218) UNRELEASED; urgency=medium
     to match ranges of numeric values.
   * Similarly, support preferred content expressions like
     metadata=field<number and metadata=field>number
+  * The pre-commit-annex hook script that automatically extracts
+    metadata has been updated to also use exiftool.
+    Thanks, Klaus Ethgen.
 
  -- Joey Hess <id@joeyh.name>  Thu, 18 Feb 2016 13:09:21 -0400
 
diff --git a/debian/copyright b/debian/copyright
index 5f80d4050..501e5b179 100644
--- a/debian/copyright
+++ b/debian/copyright
@@ -44,6 +44,11 @@ Copyright: 2001 Ian Lynagh
            2010-2015 Joey Hess <id@joeyh.name>
 License: GPL-3+
 
+Files: doc/tips/automatically_adding_metadata/pre-commit-annex 
+Copyright: 2014 Joey Hess <id@joeyh.name>
+           2016 Klaus Ethgen <Klaus@Ethgen.ch>
+License: GPL-3+
+
 Files: Utility/libmounts.c
 Copyright: 1980, 1989, 1993, 1994 The Regents of the University of California
            2001 David Rufino <daverufino@btinternet.com>
diff --git a/doc/tips/automatically_adding_metadata.mdwn b/doc/tips/automatically_adding_metadata.mdwn
index e6d02defa..b3118a75e 100644
--- a/doc/tips/automatically_adding_metadata.mdwn
+++ b/doc/tips/automatically_adding_metadata.mdwn
@@ -2,23 +2,48 @@ git-annex's [[metadata]] works best when files have a lot of useful
 metadata attached to them.
 
 To make git-annex automatically set the year and month when adding files,
-run `git config annex.genmetadata true`.
+run: `git config annex.genmetadata true`
+
+## git commit hook
 
 A git commit hook can be set up to extract lots of metadata from files
-like photos, mp3s, etc.
+like photos, mp3s, etc. Whenever annexed files are committed, their
+metadata will be extracted and stored.
+
+Download [[pre-commit-annex]] and install it in your git-annex repository
+as `.git/hooks/pre-commit-annex`  
+Remember to make the script executable! `chmod +x .git/hooks/pre-commit-annex`
+
+### using extract
 
-1. Install the `extract` utility, from <http://www.gnu.org/software/libextractor/>  
-   `apt-get install extract`
-2. Download [[pre-commit-annex]] and install it in your git-annex repository
-   as `.git/hooks/pre-commit-annex`.  
-   Remember to make the script executable!
-3. Run: `git config metadata.extract "artist album title camera_make video_dimensions"`
+The git commit hook can use extract to get metadata.
 
-Now any fields you list in metadata.extract to will be extracted and
-stored when files are committed.
+Install it from <http://www.gnu.org/software/libextractor/>  
+`apt-get install extract`
+
+Configure which metadata fields to ask extract for: `git config metadata.extract "artist album title camera_make video_dimensions"`
 
 To get a list of all possible fields, run: `extract -L | sed 's/ /_/g'`
 
+### using exiftool
+
+The git commit hook can also use exiftool to get metadata.
+
+Install it from <http://owl.phy.queensu.ca/~phil/exiftool/>  
+`apt-get install libimage-exiftool-perl`
+
+Configure which metadata fields to ask exiftool for: `git config metadata.exiftool "Model ImageSize FocusRange GPSAltitude GPSCoordinates"`
+
+To get a list of all possible fields, run: `exiftool -list`
+
+### using both extract and exiftool
+
+If you want some metadata that extract knows about, and other metadata
+that exiftool knows about, just install them both, and set both
+`metadata.extract` and `metadata.exiftool`.
+
+### overwriting existing metadata
+
 By default, if a git-annex already has a metadata field for a file,
 its value will not be overwritten with metadata taken from files.
 To allow overwriting, run: `git config metadata.overwrite true`
diff --git a/doc/tips/automatically_adding_metadata/pre-commit-annex b/doc/tips/automatically_adding_metadata/pre-commit-annex
index 873284d2c..61717c8a5 100755
--- a/doc/tips/automatically_adding_metadata/pre-commit-annex
+++ b/doc/tips/automatically_adding_metadata/pre-commit-annex
@@ -1,4 +1,20 @@
-#!/bin/sh
+#! /bin/sh
+#
+# Copyright (C) 2014 Joey Hess <id@joeyh.name>
+# Copyright (C) 2016 Klaus Ethgen <Klaus@Ethgen.ch>
+#
+# 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 3 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, see <http://www.gnu.org/licenses/>.
 #
 # This script can be used to add git-annex metadata to files when they're
 # committed. It is typically installed as .git/hooks/pre-commit-annex
@@ -6,67 +22,97 @@
 # You can also run this script by hand, passing it the names of files
 # already checked into git-annex, and it will extract/refresh the git-annex
 # metadata from the files.
-#
-# Copyright 2014 Joey Hess <id@joeyh.name>
-# License: GPL-3+
 
-extract="$(git config metadata.extract || true)" 
-want="$(perl -e 'print (join("|", map {s/_/ /g; "^$_ - "} (split " ", shift())))' "$extract")"
+tool="$(git config metadata.tool || :)"
+if [ -z "$tool" ]; then
+	tool=extract
+fi
+case "$tool" in
+	exiftool)
+		tool_exec="exiftool -unknown -zip -veryShort -ignoreMinorErrors -use MWG -dateFormat '%Y-%m-%dT%H:%M:%S'"
+	;;
+	*)
+		tool_exec="$tool"
+	;;
+esac
 
-if [ -z "$want" ]; then
+extract_fields="$(git config metadata.extract || :)"
+if [ -n "$extract_fields" ]; then
+	tools=extract
+	extract_want="^($(echo "$extract_fields" | sed -e 's/ /|/g' -e 's/_/ /g'))"
+fi
+exiftool_fields="$(git config metadata.exiftool || :)"
+if [ -n "$exiftool_fields" ]; then
+	tools="exiftool $tools"
+	exiftool_want="^($(echo "$exiftool_fields" | sed -e 's/ /|/g' -e 's/_/ /g'))"
+fi
+if [ -z "$tools" ]; then
 	exit 0
 fi
 
-case "$(git config --bool metadata.overwrite || true)" in
+case "$(git config --bool metadata.overwrite || :)" in
 	true)
-		overwrite=1
+		equal="="
 	;;
 	*)
-		overwrite=""
+		equal="?="
 	;;
 esac
 
-addmeta () {
-	file="$1"
-	field="$2"
-	value="$3"
-	afield="$(echo "$field" | tr ' ' _)"
-	if [ "$overwrite" ]; then
-		p="$afield=$value"
-
-	else
-		p="$afield?=$value"
-	fi
-	git -c annex.alwayscommit=false annex metadata "$file" -s "$p" --quiet
-}
-
 if git rev-parse --verify HEAD >/dev/null 2>&1; then
-	against=HEAD
+	against="HEAD"
 else
 	# Initial commit: diff against an empty tree object
-	against=4b825dc642cb6eb9a060e54bf8d69288fbee4904
+	against="4b825dc642cb6eb9a060e54bf8d69288fbee4904"
 fi
 
-IFS="
-"
+addmeta() {
+	file="$1"
+	field="$2"
+	value="$3"
+	afield="$(echo "$field" | tr ' ' '_' | tr 'A-Z' 'a-z')"
+	git -c annex.alwayscommit=false annex metadata \
+		--set "$afield$equal$value" --quiet -- "$file"
+}
 
-process () {
+process() {
 	if [ -e "$f" ]; then
 		echo "adding metadata for $f"
-		for l in $(extract "$f" | egrep "$want"); do
-			field="${l%% - *}"
-			value="${l#* - }"
-			addmeta "$f" "$field" "$value"
+		for tool in $tools; do
+			case "$tool" in
+				exiftool)
+					tool_exec="exiftool -unknown -zip -veryShort -ignoreMinorErrors -use MWG -dateFormat '%Y-%m-%dT%H:%M:%S'"
+				;;
+				*)
+					tool_exec="$tool"
+				;;
+			esac
+			LC_ALL=C $tool_exec "./$f" | eval egrep --text -i \""\$${tool}_want"\" | while read line; do
+				case "$tool" in
+					extract)
+						field="${line%% - *}"
+						value="${line#* - }"
+					;;
+					exiftool)
+						field="${line%%: *}"
+						value="${line#*: }"
+					;;
+				esac
+				
+				if [ -n "$value" ]; then
+					addmeta "$f" "$field" "$value"
+				fi
+			done
 		done
 	fi
 }
 
 if [ -n "$*" ]; then
-	for f in $@; do
+	for f in "$@"; do
 		process "$f"
 	done
 else
-	for f in $(git diff-index --name-only --cached $against); do
+	for f in "$(git diff-index --name-only --cached $against)"; do
 		process "$f"
 	done
 fi