mini_exiftool 1.0.2 → 1.1.0

data/Changelog

@@ -1,6 +1,10 @@
+Version 1.1.0
+- Escaping filenames in shell commands
+  Thanks to Michael Hoy for the hint and implementing a patch which was
+  the base for this fix.
 Version 1.0.2
 - Fixing warings
-  thanks to Peter-Hinrich Krogmann for the hint.
+  Thanks to Peter-Hinrich Krogmann for the hint.
 Version 1.0.1
 - Fixing bug [#22726]
   Making MiniExiftool::Error public.

data/lib/mini_exiftool.rb

@@ -16,6 +16,7 @@ require 'fileutils'
 require 'tempfile'
 require 'pstore'
 require 'set'
+require 'shellwords'
 
 # Simple OO access to the Exiftool command-line application.
 class MiniExiftool
@@ -29,7 +30,7 @@ class MiniExiftool
   attr_reader :filename
   attr_accessor :numerical, :composite, :convert_encoding, :errors, :timestamps
 
-  VERSION = '1.0.2'
+  VERSION = '1.1.0'
 
   # +opts+ support at the moment
   # * <code>:numerical</code> for numerical values, default is +false+
@@ -80,7 +81,7 @@ class MiniExiftool
     opt_params << (@numerical ? '-n ' : '')
     opt_params << (@composite ? '' : '-e ')
     opt_params << (@convert_encoding ? '-L ' : '')
-    cmd = %Q(#@@cmd -q -q -s -t #{opt_params} #{@@sep_op} "#{filename}")
+    cmd = %Q(#@@cmd -q -q -s -t #{opt_params} #{@@sep_op} #{Shellwords.escape(filename)})
     if run(cmd)
       parse_output
     else
@@ -156,7 +157,7 @@ class MiniExiftool
       opt_params = ''
       opt_params << (arr_val.detect {|x| x.kind_of?(Numeric)} ? '-n ' : '')
       opt_params << (@convert_encoding ? '-L ' : '')
-      cmd = %Q(#@@cmd -q -P -overwrite_original #{opt_params} #{tag_params} "#{temp_filename}")
+      cmd = %Q(#@@cmd -q -P -overwrite_original #{opt_params} #{tag_params} #{temp_filename})
       result = run(cmd)
       unless result
         all_ok = false

data/test/test_class_methods.rb

@@ -27,14 +27,6 @@ class TestClassMethods < TestCase
     rescue MiniExiftool::Error => e
       assert_match /File 'not_existing_file' does not exist/, e.message
     end
-    assert_raises MiniExiftool::Error do
-      MiniExiftool.new __FILE__ # file type wich Exiftool can not handle
-    end
-    begin
-      MiniExiftool.new __FILE__ # file type wich Exiftool can not handle
-    rescue MiniExiftool::Error => e
-      assert_match /Error: Unknown (?:image|file) type/, e.message
-    end
   end
 
   def test_command

data/test/test_dumping.rb

@@ -76,14 +76,4 @@ class TestDumping < TestCase
     assert_equal true, MiniExiftool.from_yaml(numerical.to_yaml).numerical
   end
 
-  def test_heuristics_for_restoring_timestamps
-    standard = @mini_exiftool.to_hash
-    timestamps = MiniExiftool.new(@filename_test, :timestamps => DateTime).to_hash
-    assert_equal Time, MiniExiftool.from_hash(standard).timestamps
-    assert_equal DateTime, MiniExiftool.from_hash(timestamps).timestamps
-    # Doesn't work yet.
-    # assert_equal Time, MiniExiftool.from_yaml(standard.to_yaml).timestamps
-    # assert_equal DateTime, MiniExiftool.from_yaml(timestamps.to_yaml).timestamps
-  end
-
 end

data/test/test_escape_filename.rb

@@ -0,0 +1,25 @@
+require 'helpers_for_test'
+
+class TestEscapeFilename < TestCase
+
+  def setup
+    @temp_file = Tempfile.new('test')
+    @temp_file.close
+    @temp_filename = @temp_file.path
+    @org_filename = File.dirname(__FILE__) + '/data/test 36"Bench.jpg'
+    FileUtils.cp(@org_filename, @temp_filename)
+    @mini_exiftool = MiniExiftool.new @temp_filename
+  end
+
+  def test_access
+    assert_equal '36" Bench', @mini_exiftool['description']
+  end
+
+  def test_save
+    desc = 'another bench'
+    @mini_exiftool.description = desc
+    assert @mini_exiftool.save
+    assert_equal desc, @mini_exiftool.description
+  end
+
+end

data/test/test_read.rb

@@ -25,7 +25,7 @@ class TestRead < TestCase
     assert_kind_of Float, @mini_exiftool['MaxApertureValue']
     assert_kind_of String, @mini_exiftool.flash
     assert_kind_of Fixnum, @mini_exiftool['ExposureCompensation']
-    assert_kind_of String, @mini_exiftool['SubjectLocation']
+    assert_kind_of String, (@mini_exiftool['SubjectLocation'] || @mini_exiftool['SubjectArea'])
     assert_kind_of Array, @mini_exiftool['Keywords']
     assert_kind_of String, @mini_exiftool['SupplementalCategories']
     assert_kind_of Array, @mini_exiftool['SupplementalCategories'].to_a

data/test/test_read_numerical.rb

@@ -22,7 +22,7 @@ class TestReadNumerical < TestCase
     assert_kind_of Fixnum, @mini_exiftool_num.flash
     assert_kind_of String, @mini_exiftool_num.exif_version
     assert_kind_of Fixnum, @mini_exiftool_num['ExposureCompensation']
-    assert_kind_of String, @mini_exiftool_num['SubjectLocation']
+    assert_kind_of String, (@mini_exiftool_num['SubjectLocation'] || @mini_exiftool_num['SubjectArea'])
     assert_kind_of Array, @mini_exiftool_num['Keywords']
     assert_kind_of String, @mini_exiftool_num['SupplementalCategories']
     assert_kind_of Array, @mini_exiftool_num['SupplementalCategories'].to_a

data/test/test_save.rb

@@ -32,7 +32,7 @@ class TestSave < TestCase
     result = @mini_exiftool.save
     assert_equal false, result
     assert_equal 1, @mini_exiftool.errors.size
-    assert_equal("Can't convert IFD0:Orientation (not in PrintConv)",
+    assert_match(/Can't convert IFD0:Orientation \(not in PrintConv\)/,
                  @mini_exiftool.errors['Orientation'])
     assert @mini_exiftool.changed?
     assert @mini_exiftool.changed_tags.include?('Orientation')

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 2
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors: 
 - Jan Friedrich
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-30 00:00:00 +01:00
+date: 2011-02-10 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -32,25 +32,25 @@ files:
 - examples/external_photo.rb
 - examples/print_portraits.rb
 - examples/shift_time.rb
-- lib/mini_exiftool.new.rb
 - lib/mini_exiftool.rb
 - setup.rb
 - test/helpers_for_test.rb
 - test/test_class_methods.rb
 - test/test_composite.rb
 - test/test_dumping.rb
+- test/test_escape_filename.rb
 - test/test_read.rb
 - test/test_read_numerical.rb
 - test/test_save.rb
 - test/test_special.rb
 - test/test_special_dates.rb
 - test/test_write.rb
-- x.rb
 - Rakefile
 - COPYING
 - Changelog
 - test/data/Canon.jpg
 - test/data/INFORMATION
+- test/data/test 36"Bench.jpg
 - test/data/test.jpg
 - test/data/test_special_dates.jpg
 - README
@@ -96,6 +96,7 @@ test_files:
 - test/test_class_methods.rb
 - test/test_composite.rb
 - test/test_dumping.rb
+- test/test_escape_filename.rb
 - test/test_read.rb
 - test/test_read_numerical.rb
 - test/test_save.rb

data/lib/mini_exiftool.new.rb

@@ -1,445 +0,0 @@
-#
-# MiniExiftool
-#
-# This library is wrapper for the Exiftool command-line
-# application (http://www.sno.phy.queensu.ca/~phil/exiftool/)
-# written by Phil Harvey.
-# Read and write access is done in a clean OO manner.
-#
-# Author: Jan Friedrich
-# Copyright (c) 2007, 2008 by Jan Friedrich
-# Licensed under the GNU LESSER GENERAL PUBLIC LICENSE,
-# Version 2.1, February 1999
-#
-
-require 'fileutils'
-require 'tempfile'
-require 'pstore'
-require 'set'
-
-# Simple OO access to the Exiftool command-line application.
-class MiniExiftool
-
-  # Name of the Exiftool command-line application
-  @@cmd = 'exiftool'
-
-  # Hash of the standard options used when call MiniExiftool.new
-  @@opts = { :numerical => false, :composite => true, :convert_encoding => false, :timestamps => Time }
-
-  attr_reader :filename
-  attr_accessor :numerical, :composite, :convert_encoding, :errors, :timestamps
-
-  VERSION = '1.0.1'
-
-  # +opts+ support at the moment
-  # * <code>:numerical</code> for numerical values, default is +false+
-  # * <code>:composite</code> for including composite tags while loading,
-  #   default is +true+
-  # * <code>:convert_encoding</code> convert encoding (See -L-option of
-  #   the exiftool command-line application, default is +false+
-  # * <code>:timestamps</code> generating DateTime objects instead of
-  #   Time objects if set to <code>DateTime</code>, default is +Time+
-  #
-  #   <b>ATTENTION:</b> Time objects are created using <code>Time.local</code>
-  #   therefore they use <em>your local timezone</em>, DateTime objects instead
-  #   are created <em>without timezone</em>!
-  def initialize filename=nil, opts={}
-    opts = @@opts.merge opts
-    @numerical = opts[:numerical]
-    @composite = opts[:composite]
-    @convert_encoding = opts[:convert_encoding]
-    @timestamps = opts[:timestamps]
-    @values = TagHash.new
-    @tag_names = TagHash.new
-    @changed_values = TagHash.new
-    @errors = TagHash.new
-    load filename unless filename.nil?
-  end
-
-  def initialize_from_hash hash # :nodoc:
-    hash.each_pair do |tag,value|
-      set_value tag, value
-    end
-    set_attributes_by_heuristic
-    self
-  end
-
-  # Load the tags of filename.
-  def load filename
-    unless filename && File.exist?(filename)
-      raise MiniExiftool::Error.new("File '#{filename}' does not exist.")
-    end
-    if File.directory?(filename)
-      raise MiniExiftool::Error.new("'#{filename}' is a directory.")
-    end
-    @filename = filename
-    @values.clear
-    @tag_names.clear
-    @changed_values.clear
-    opt_params = ''
-    opt_params << (@numerical ? '-n ' : '')
-    opt_params << (@composite ? '' : '-e ')
-    opt_params << (@convert_encoding ? '-L ' : '')
-    cmd = %Q(#@@cmd -q -q -s -t #{opt_params} #{@@sep_op} "#{filename}")
-    if run(cmd)
-      parse_output
-    else
-      raise MiniExiftool::Error.new(@error_text)
-    end
-    self
-  end
-
-  # Reload the tags of an already readed file.
-  def reload
-    load @filename
-  end
-
-  # Returns the value of a tag.
-  def [] tag
-    @changed_values[tag] || @values[tag]
-  end
-
-  # Set the value of a tag.
-  def []=(tag, val)
-    @changed_values[tag] = val
-  end
-
-  # Returns true if any tag value is changed or if the value of a
-  # given tag is changed.
-  def changed? tag=false
-    if tag
-      @changed_values.include? tag
-    else
-      !@changed_values.empty?
-    end
-  end
-
-  # Revert all changes or the change of a given tag.
-  def revert tag=nil
-    if tag
-      val = @changed_values.delete(tag)
-      res = val != nil
-    else
-      res = @changed_values.size > 0
-      @changed_values.clear
-    end
-    res
-  end
-
-  # Returns an array of the tags (original tag names) of the readed file.
-  def tags
-    @values.keys.map { |key| @tag_names[key] }
-  end
-
-  # Returns an array of all changed tags.
-  def changed_tags
-    @changed_values.keys.map { |key| MiniExiftool.original_tag(key) }
-  end
-
-  # Save the changes to the file.
-  def save
-    return false if @changed_values.empty?
-    @errors.clear
-    temp_file = Tempfile.new('mini_exiftool')
-    temp_file.close
-    temp_filename = temp_file.path
-    FileUtils.cp filename, temp_filename
-    all_ok = true
-    @changed_values.each do |tag, val|
-      original_tag = MiniExiftool.original_tag(tag)
-      arr_val = val.kind_of?(Array) ? val : [val]
-      arr_val.map! {|e| convert e}
-      tag_params = ''
-      arr_val.each do |v|
-        tag_params << %Q(-#{original_tag}="#{v}" )
-      end
-      opt_params = ''
-      opt_params << (arr_val.detect {|x| x.kind_of?(Numeric)} ? '-n ' : '')
-      opt_params << (@convert_encoding ? '-L ' : '')
-      cmd = %Q(#@@cmd -q -P -overwrite_original #{opt_params} #{tag_params} "#{temp_filename}")
-      result = run(cmd)
-      unless result
-        all_ok = false
-        @errors[tag] = @error_text.gsub(/Nothing to do.\n\z/, '').chomp
-      end
-    end
-    if all_ok
-      FileUtils.cp temp_filename, filename
-      reload
-    end
-    temp_file.delete
-    all_ok
-  end
-
-  # Returns a hash of the original loaded values of the MiniExiftool
-  # instance.
-  def to_hash
-    result = {}
-    @values.each do |k,v|
-      result[@tag_names[k]] = v
-    end
-    result
-  end
-
-  # Returns a YAML representation of the original loaded values of the
-  # MiniExiftool instance.
-  def to_yaml
-    to_hash.to_yaml
-  end
-
-  # Create a MiniExiftool instance from a hash
-  def self.from_hash hash
-    instance = MiniExiftool.new
-    instance.initialize_from_hash hash
-    instance
-  end
-
-  # Create a MiniExiftool instance from YAML data created with
-  # MiniExiftool#to_yaml
-  def self.from_yaml yaml
-    MiniExiftool.from_hash YAML.load(yaml)
-  end
-
-  # Returns the command name of the called Exiftool application.
-  def self.command
-    @@cmd
-  end
-
-  # Setting the command name of the called Exiftool application.
-  def self.command= cmd
-    @@cmd = cmd
-  end
-
-  # Returns the options hash.
-  def self.opts
-    @@opts
-  end
-
-  # Returns a set of all known tags of Exiftool.
-  def self.all_tags
-    unless defined? @@all_tags
-      @@all_tags = pstore_get :all_tags
-    end
-    @@all_tags
-  end
-
-  # Returns a set of all possible writable tags of Exiftool.
-  def self.writable_tags
-    unless defined? @@writable_tags
-      @@writable_tags = pstore_get :writable_tags
-    end
-    @@writable_tags
-  end
-
-  # Returns the original Exiftool name of the given tag
-  def self.original_tag tag
-    unless defined? @@all_tags_map
-      @@all_tags_map = pstore_get :all_tags_map
-    end
-    @@all_tags_map[tag]
-  end
-
-  # Returns the version of the Exiftool command-line application.
-  def self.exiftool_version
-    output = `#{MiniExiftool.command} -ver 2>&1`
-    unless $?.exitstatus == 0
-      raise MiniExiftool::Error.new("Command '#{MiniExiftool.command}' not found")
-    end
-    output.chomp!
-  end
-
-  def self.unify tag
-    tag.gsub(/[-_]/,'').downcase
-  end
-
-  # Exception class
-  class MiniExiftool::Error < StandardError; end
-
-  ############################################################################
-  private
-  ############################################################################
-
-  @@error_file = Tempfile.new 'errors'
-  @@error_file.close
-
-  if Float(exiftool_version) < 7.41
-    @@separator = ', '
-    @@sep_op = ''
-  else
-    @@separator = '@@'
-    @@sep_op = '-sep @@'
-  end
-
-  def run cmd
-    if $DEBUG
-      $stderr.puts cmd
-    end
-    @output = `#{cmd} 2>#{@@error_file.path}`
-    @status = $?
-    unless @status.exitstatus == 0
-      @error_text = File.readlines(@@error_file.path).join
-      return false
-    else
-      @error_text = ''
-      return true
-    end
-  end
-
-  def convert val
-    case val
-    when Time
-      val = val.strftime('%Y:%m:%d %H:%M:%S')
-    end
-    val
-  end
-
-  def method_missing symbol, *args
-    tag_name = symbol.id2name
-    if tag_name.sub!(/=$/, '')
-      self[tag_name] = args.first
-    else
-      self[tag_name]
-    end
-  end
-
-  def parse_output
-    @output.each_line do |line|
-      tag, value = parse_line line
-      set_value tag, value
-    end
-  end
-
-  def parse_line line
-    if line =~ /^([^\t]+)\t(.*)$/
-      tag, value = $1, $2
-      case value
-      when /^\d{4}:\d\d:\d\d \d\d:\d\d:\d\d$/
-        arr = value.split(/[: ]/)                 #Fixed by kro44 - add parentheses
-        arr.map! {|elem| elem.to_i}
-        begin
-          if @timestamps == Time
-            value = Time.local(*arr)              #Fixed by kro44 - add parentheses
-          elsif @timestamps == DateTime
-            value = DateTime.strptime(value,'%Y:%m:%d %H:%M:%S')
-          else
-            raise MiniExiftool::Error.new("Value #@timestamps not allowed for option timestamps.")
-          end
-        rescue ArgumentError
-          value = false
-        end
-      when /^\d+\.\d+$/
-        value = value.to_f
-      when /^0+[1-9]+$/
-        # nothing => String
-      when /^-?\d+$/
-        value = value.to_i
-      when /^[\d ]+$/
-        # nothing => String
-      when /#{@@separator}/
-        value = value.split @@separator
-      end
-    else
-      raise MiniExiftool::Error.new("Malformed line #{line.inspect} of exiftool output.")
-    end
-    unless value.respond_to?('to_a')
-      class << value
-        def to_a
-          [self]
-        end
-      end
-    end
-    return [tag, value]
-  end
-
-  def set_value tag, value
-    @tag_names[tag] = tag
-    @values[tag] = value
-  end
-
-  def set_attributes_by_heuristic
-    self.composite = tags.include?('ImageSize') ? true : false
-    self.numerical = self.file_size.kind_of?(Integer) ? true : false
-    # TODO: Is there a heuristic to determine @convert_encoding?
-    self.timestamps = self.FileModifyDate.kind_of?(DateTime) ? DateTime : Time
-  end
-
-  def temp_filename
-    unless @temp_filename
-      temp_file = Tempfile.new('mini-exiftool')
-      temp_file.close
-      FileUtils.cp(@filename, temp_file.path)
-      @temp_filename = temp_file.path
-    end
-    @temp_filename
-  end
-
-  def self.pstore_get attribute
-    load_or_create_pstore unless defined? @@pstore
-    result = nil
-    @@pstore.transaction(true) do |ps|
-      result = ps[attribute]
-    end
-    result
-  end
-
-  def self.load_or_create_pstore
-    # This will hopefully work on *NIX and Windows systems
-    home = ENV['HOME'] || ENV['HOMEDRIVE'] + ENV['HOMEPATH'] || ENV['USERPROFILE']
-    subdir = RUBY_PLATFORM =~ /win/i ? '_mini_exiftool' : '.mini_exiftool'
-    FileUtils.mkdir_p(File.join(home, subdir))
-    filename = File.join(home, subdir, 'exiftool_tags_' << exiftool_version.gsub('.', '_') << '.pstore')
-    @@pstore = PStore.new filename
-    if !File.exist?(filename) || File.size(filename) == 0
-      @@pstore.transaction do |ps|
-        ps[:all_tags] = all_tags = determine_tags('list')
-        ps[:writable_tags] = determine_tags('listw')
-        map = {}
-        all_tags.each { |k| map[unify(k)] = k }
-        ps[:all_tags_map] = map
-      end
-    end
-  end
-
-  def self.determine_tags arg
-    output = `#{@@cmd} -#{arg}`
-    lines = output.split(/\n/)                    #Fixed by kro44 - add parentheses
-    tags = Set.new
-    lines.each do |line|
-      next unless line =~ /^\s/
-      tags |= line.chomp.split
-    end
-    tags
-  end
-
-
-  # Hash with indifferent access:
-  # DateTimeOriginal == datetimeoriginal == date_time_original
-  class TagHash < Hash # :nodoc:
-    def[] k
-      super(unify(k))
-    end
-    def []= k, v
-      super(unify(k), v)
-    end
-    def delete k
-      super(unify(k))
-    end
-
-    def unify tag
-      MiniExiftool.unify tag
-    end
-  end
-
-end
-
-# Add to_a to Numerical if it's not yet defined
-unless Numeric.instance_methods.include? 'to_a'
-  class Numeric
-    def to_a
-      [self]
-    end
-  end
-end
-
-# Test if we can run the Exiftool command
-MiniExiftool.exiftool_version

data/x.rb

@@ -1,3 +0,0 @@
-require 'mini_exiftool'
-
-puts MiniExiftool.exiftool_version