phtools 0.8.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dbc8c46f63d80e6beda76258cf6da8f1311bd836
-  data.tar.gz: 58ea09d9d25e550e87483747279171ce8b20e587
+  metadata.gz: 11a9513d5b974ef96b53c7d9f7b4a30299fecb37
+  data.tar.gz: d5156efe4cb97fd0c352168c9a8be41db697eb85
 SHA512:
-  metadata.gz: e04354409ef45c612b47cf1b25dd9edf25fcba3948eb8e25e74349350831892885c44ce4b64d795e742c1fc263879b4e3cd5135ff7291e53a9074cb83f4aee08
-  data.tar.gz: 62e00150f730d9905ede7f0c78c7ef6a46c2bbbdbfefbe3300e0b35c6083946760e4ffd4596a44c1553f187c7c75b7c5da7b4ccd0c21b8366811b5d13bc4a671
+  metadata.gz: 95b747d7110174f61b325c8cdd58ff6b79d21ca3ae494ea96c9bc0bdc1c6c43ba8621d9d81f0d297ee5b67a74d9486d38ea5405f5df4c1723bc5c2b26b14948b
+  data.tar.gz: 15c18ab1c5cc87c2e98f8008b0768452efc2db051daae2054ed01fcfc3d91785055c89a58643b7cd82de89bb07eb30abf0043b991a29d7fc278e7d0801db3f00

data/TODO.md

@@ -23,14 +23,15 @@
 - [ ] phrename: make new usage mode: `phrename -t TAG`. Useful if user wants to re-set date-time using TAG keeping author-nickname unchanged
 
 ### phgettags
-- [ ] create phgettags (based on ftmtags)
+- [x] create phgettags (based on ftmtags)
 
 ### phfixfmd
 - [x] create phfixfmd - fix FileModifyDate to get equal to date-time-in-the-name
 
 ### phfixdto
-- [ ] create phfixdto - fix MWG:DateTimeOriginal = date-time-in-name
-- [ ] phfixdto: make -N --no_run option = no running exiftool script, only preparation
+- [x] create phfixdto - fix MWG:DateTimeOriginal (DTO) := date-time-in-name
+- [x] phfixdto: make -N --no_run option = no running exiftool script, only preparation
+- [ ] phfixdto: smartly check if CreateDate set (including MWG subfields). If any - then update CreateDate
 
 ### phevent
 - [ ] create phevent  (based on ftevent)

data/exe/phfixdto

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# (c) ANB Andrew Bizyaev
+
+module PhTools
+  tool_name = File.basename(__FILE__)
+  require "#{tool_name}"
+
+  file_type = FILE_TYPE_IMAGE + FILE_TYPE_VIDEO + FILE_TYPE_AUDIO
+  usage = <<DOCOPT
+***************************************************
+phtools - *Keep Your Photos In Order* (c) ANB
+***************************************************
+  #{tool_name} updates the input file's DateTimeOriginal (CreateDate) tags with
+the date-time encoded in the filename (date-time-in-the-name). The file should
+be renamed to phtools Standard Name before using this command (use phrename for
+this).
+  This program uses external utility ExifTool created by Phil Harvey
+(http://www.sno.phy.queensu.ca/~phil/exiftool/).
+  #{tool_name} acts as a 'sink' program meaning it expects the input files
+to be passed to STDIN, does its job on the files and produces no useful
+(for other pipe-optimized programs) output.
+In other words this command is intended to be used with other programs
+connected via input pipes as a last command in the pipe chain, e.g.:
+  phls | phrename - a anb | #{tool_name}
+
+Usage:
+  #{tool_name} [-N] [-D]
+  #{tool_name} -h | --help
+  #{tool_name} -v | --version
+
+Options:
+  -N --no_run   Dry-run mode means no run exiftool command, only generate script
+                file 'exif_tagger_dto.txt'. User can check the script and
+                manually run the command: `exiftool -@ exif_tagger_dto.txt`
+  -D --debug    Turn on debugging (verbose) mode
+  -h --help     Show this screen.
+  -v --version  Show version.
+DOCOPT
+
+  PhTools.const_get(tool_name.capitalize).new(usage, file_type).run!
+end

data/exe/phfixfmd

@@ -11,7 +11,7 @@ module PhTools
 ***************************************************
 phtools - *Keep Your Photos In Order* (c) ANB
 ***************************************************
-  #{tool_name} changes an input file modify-date according to the date encoded
+  #{tool_name} changes an input file's modify-date according to the date encoded
 in the filename (date-time-in-the-name). Therefore the file should be renamed
 to phtools Standard Name before using this command (use phrename for this).
   #{tool_name} acts as a 'filter' program meaning it expects the input files

data/exe/phgettags

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# (c) ANB Andrew Bizyaev
+
+module PhTools
+  tool_name = File.basename(__FILE__)
+  require "#{tool_name}"
+
+  file_type = FILE_TYPE_IMAGE + FILE_TYPE_VIDEO + FILE_TYPE_AUDIO
+  usage = <<DOCOPT
+***************************************************
+phtools - *Keep Your Photos In Order* (c) ANB
+***************************************************
+  #{tool_name} extracts the list of tags stored inside the given file.
+
+  #{tool_name} acts as a 'sink' program meaning it expects the input files
+to be passed to STDIN, does its job on the input files and produces no useful
+(for other pipe-optimized programs) output.
+In other words this command is intended to be used with other programs
+connected via input pipes as a last command in the pipe chain, e.g.:
+  phls | #{tool_name}
+
+This program uses external utility ExifTool created by Phil Harvey
+(http://www.sno.phy.queensu.ca/~phil/exiftool/).
+
+Usage:
+  #{tool_name} [-f] [-D]
+  #{tool_name} -h | --help
+  #{tool_name} -v | --version
+
+Options:
+  -f --full_dump  Print all tags
+  -D --debug      Turn on debugging (verbose) mode
+  -h --help       Show this screen.
+  -v --version    Show version.
+DOCOPT
+
+  PhTools.const_get(tool_name.capitalize).new(usage, file_type).run!
+end

data/exe/phls

@@ -11,16 +11,20 @@ module PhTools
 ***************************************************
 phtools - *Keep Your Photos In Order* (c) ANB
 ***************************************************
-#{tool_name} scans given directories and generates list of files to standard output.
-In short it acts like a smart 'ls' command (or 'dir' in Windows).
+  #{tool_name} scans given directories and generates list of files to standard
+output. In short it acts like a smart 'ls' command (or 'dir' in Windows).
 Set DIRs to be scanned as a parameters. If no DIRs are set - current dir (.)
 will be scanned. Set FILEMASKs as a parameters - and only files matching the
-masks will be processed. If no FILEMASK is set *.* will be used by-default.
+masks will be processed. If no FILEMASK is set '*.*' will be used by-default.
 To avoid unnessesary mask extraction by OS - put it in ''.
 Note, #{tool_name} works only with phtools-friendly file types: #{file_type * ','}
-#{tool_name} is a starting point for all other phtools to be connected via pipes.
 
-Example: #{tool_name} abc '*aaa*' | phrename -a anb => scans 'abc' folder and
+  #{tool_name} acts as a 'source' program meaning it does not require any input
+from STDIN, it generates list of files based on input parameters and send it
+to STDOUT.
+  In other words this command is intended to be used with other programs
+connected via pipes as a 1st command in the pipe chain, e.g.:
+  #{tool_name} abc '*aaa*' | phrename -a anb => scans 'abc' folder and
 sends all found phtools friendly files filtered with *aaa* to phrename command.
 
 Usage:

data/exe/phrename

@@ -54,7 +54,7 @@ Options:
   -t TAG --tag_date=TAG  Force program to use TAG as a Date-Time creation
                          info instead of standard phtools tags.
                          You can retreive all existing tags using command:
-                         `phls filename|phmtags -f` OR
+                         `phls filename|phgettags -f` OR
                          `exiftool -s filename`
 
   -s DELTA --shift_time=DELTA  DELTA (in seconds) will be added to Date-Time value

data/lib/phfixdto.rb

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# (c) ANB Andrew Bizyaev
+
+require 'mini_exiftool'
+require 'phtools/runner'
+require 'phtools/exif_tagger'
+
+module PhTools
+  # phfixdto logic
+  class Phfixdto < Runner
+    def self.about
+      'fixes DateTimeOriginal tag to be equal to date-time-in-the-name'
+    end
+
+    private
+
+    def process_before
+      @writer = ExifTagger::TagWriter.new(
+        script_name: 'exif_tagger_dto.txt',
+        memo: "#{DateTime.now}: Script generated by #{@tool_name} version #{PhTools::VERSION})",
+        output: STDERR)
+    end
+
+    def process_file(phfile)
+      fail PhTools::Error, 'wrong date-time-in-the-name' unless phfile.date_time_ok?
+
+      STDERR.puts %(  ...#{phfile}...)
+      begin
+        @tags_original = MiniExiftool.new(phfile.filename,
+                                          replace_invalid_chars: true,
+                                          composite: true,
+                                          timestamps: DateTime)
+      rescue
+        raise PhTools::Error, "EXIF tags reading - #{e.message}"
+      end
+
+      @tags_to_write = ExifTagger::TagCollection.new
+
+      @tags_to_write[:date_time_original] = phfile.date_time_to_time
+      @tags_to_write.item(:date_time_original).force_write = true
+
+      unless @tags_original[:create_date].nil?
+        @tags_to_write[:create_date] = phfile.date_time_to_time
+        @tags_to_write.item(:create_date).force_write = true
+      end
+      @tags_to_write.check_for_warnings(original_values: @tags_original)
+      fail PhTools::Error, @tags_to_write.error_message unless @tags_to_write.valid?
+
+      @writer.add_to_script(phfile: phfile, tags: @tags_to_write)
+
+      return ''
+
+    rescue => e
+      raise PhTools::Error, e.message
+    end
+
+    def process_after
+      @writer.run! unless @options_cli['--no_run']
+    end
+  end
+end

data/lib/phfixfmd.rb

@@ -14,8 +14,7 @@ module PhTools
     private
 
     def process_file(phfile)
-      fail PhTools::Error, 'wrong date-time in the name' unless
-        phfile.date_time_ok?
+      fail PhTools::Error, 'wrong date-time-in-the-name' unless phfile.date_time_ok?
       begin
         File.utime(Time.now, phfile.date_time_to_time, phfile.filename)
       rescue

data/lib/phgettags.rb

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# (c) ANB Andrew Bizyaev
+
+require 'phtools/runner'
+require 'mini_exiftool'
+require 'phtools/exif_tagger'
+
+module PhTools
+  class Phgettags < Runner
+
+    def self.about
+      "extracts the tags stored inside the file"
+    end
+
+    private
+
+    def process_file(phfile)
+      begin
+        tags = MiniExiftool.new(phfile.filename,
+                                numerical: false,
+                                coord_format: '%d %d %.4f',
+                                replace_invalid_chars: true,
+                                composite: true,
+                                timestamps: DateTime)
+      rescue
+        raise PhTools::Error, "EXIF tags reading - #{e.message}"
+      end
+
+      puts "******** FILE #{phfile} ********"
+
+      if not @options_cli['--full_dump']
+        puts format('%-29s %s', "FileModifyDate", "#{tags.FileModifyDate}")
+        ExifTagger::TAGS_SUPPORTED.each do |tag|
+          puts "#{tag.to_s.camelize}"
+          ExifTagger::Tag.const_get(tag.to_s.camelize).const_get('EXIFTOOL_TAGS').each do |t|
+            v = tags[t]
+            v = 'EMPTY' if v.respond_to?(:empty?) && v.empty?
+            if v.nil?
+              puts format('  %-27s %s', t, 'NIL')
+            else
+              puts format('  %-27s %-10s %s', t, "(#{v.class})", v)
+            end
+          end
+        end
+      else #full_dump
+        tags.to_hash.each do |t,v|
+          puts format('%-29s %-10s %s', t, "(#{v.class})", v)
+        end
+      end
+
+      return ''
+
+    rescue => e
+      raise PhTools::Error, "exif tags operating: #{e.message}"
+    end
+  end
+end

data/lib/phtools/exif_tagger/error.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# (c) ANB Andrew Bizyaev
+
+module ExifTagger
+  class Error < StandardError; end
+  class UnknownTag < Error; end
+  class WriteTag < Error; end
+  class CreatorsDirectory < Error; end
+  class PlacesDirectory < Error; end
+end

data/lib/phtools/exif_tagger/tag_collection.rb

@@ -0,0 +1,103 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# (c) ANB Andrew Bizyaev
+
+module ExifTagger
+  # EXIF tags collection
+  class TagCollection
+    include Enumerable
+
+    def initialize(init_values = nil)
+      @collection = []
+      return if init_values.nil?
+      case
+      when init_values.is_a?(Hash)
+        init_values.each do |k, v|
+          self[k] = v
+        end
+      when init_values.is_a?(ExifTagger::TagCollection)
+        init_values.each do |item|
+          self[item.tag_id] = item.value
+        end
+      end
+    end
+
+    def each(&block)
+      @collection.each(&block)
+    end
+
+    def to_s
+      str = ''
+      @collection.each { |i| str << i.to_s }
+      str
+    end
+
+    def []=(tag, value)
+      return if value.nil?
+      delete(tag)
+      @collection << produce_tag(tag, value.dup)
+    end
+
+    def [](tag)
+      ind = @collection.find_index(tag)
+      ind.nil? ? nil : @collection[ind].value
+    end
+
+    def item(tag)
+      ind = @collection.find_index(tag)
+      ind.nil? ? nil : @collection[ind]
+    end
+
+    def delete(tag)
+      @collection.delete(tag)
+    end
+
+    def valid?
+      ok = true
+      @collection.each { |i| ok &&= i.valid? }
+      ok
+    end
+
+    def with_warnings?
+      warn = false
+      @collection.each { |i| warn ||= i.warnings.empty? }
+      warn
+    end
+
+    def check_for_warnings(original_values: {})
+      @collection.each do |i|
+        i.check_for_warnings(original_values: original_values)
+      end
+    end
+
+    def error_message
+      str = ''
+      unless valid?
+        str = "Tags are NOT VALID:\n"
+        @collection.each do |item|
+          item.errors.each { |e| str << '    ' + e + "\n" }
+        end
+      end
+      str
+    end
+
+    def warning_message
+      str = ''
+      if with_warnings?
+        @collection.each do |item|
+          item.warnings.each { |e| str << '    WARNING: ' + e + "\n" }
+        end
+      end
+      str
+    end
+
+    private
+
+    def produce_tag(tag, value)
+      tag_class = ExifTagger::Tag.const_get(tag.to_s.camelize)
+      tag_class.new(value)
+    rescue => e
+      raise ExifTagger::UnknownTag, "Tag #{tag} - #{e.message}"
+    end
+  end
+end

data/lib/phtools/exif_tagger/tag_writer.rb

@@ -0,0 +1,79 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# (c) ANB Andrew Bizyaev
+
+require 'date'
+
+# Exif tagger
+module ExifTagger
+  # batch EXIF tags setter
+  class TagWriter
+    DEFAULT_OPTIONS = %w(-v0 -FileModifyDate<DateTimeOriginal -overwrite_original -ignoreMinorErrors)
+    attr_reader :script_name, :added_files_count
+
+    def initialize(script_name: 'exif_tagger.txt',
+                   memo: 'Generated by phtools',
+                   output: STDOUT, err: STDERR)
+      @script_name = script_name
+      create_script(memo)
+      @added_files_count = 0
+      @output = output
+      @err = err
+      @output.puts "*** Preparing exiftool script '#{@script_name}' ..."
+    end
+
+    def add_to_script(phfile: '', tags: {}, options: DEFAULT_OPTIONS)
+      @script.puts "# **(#{@added_files_count + 1})** Processing file: #{phfile} *****"
+      # tags
+      tags.each do |k|
+        @script.puts tags.item(k).to_write_script
+      end
+      # file to be altered
+      @script.puts %Q{#{phfile}}
+      # General options
+      options.each { |o| @script.puts "#{o}" }
+      @script.puts %Q{-execute}
+      @script.puts
+      @added_files_count += 1
+
+    rescue => e
+      raise WriteTag, "adding item to exiftool script - #{e.message}"
+    end
+
+    def close_script
+      @script.close
+      @output.puts "*** Finished preparation of the script '#{script_name}'"
+    rescue => e
+      raise WriteTag, "closing exiftool script - #{e.message}"
+    end
+
+    def command
+      "exiftool -@ #{@script_name}"
+    end
+
+    def run!
+      close_script
+      if @added_files_count > 0
+        @output.puts "*** Running #{command} ..."
+        ok = system(command, out: @output, err: @err)
+        fail if ok.nil?
+        @output.puts "*** Finished #{command}"
+      else
+        @output.puts "*** Nothing to update, skip running #{command} ..."
+      end
+    rescue
+      raise WriteTag, "running #{command}"
+    end
+
+    private
+
+    def create_script(memo)
+      @script = File.open(@script_name, 'w+:utf-8')
+      @script.puts '# exiftool script for batch tag operations'
+      @script.puts "# #{memo}"
+      @script.puts "# usage: exiftool -@ #{@script_name}"
+    rescue => e
+      raise ExifTagger::WriteTag, "creating exiftool script - #{e.message}"
+    end
+  end
+end

data/lib/phtools/exif_tagger/tags/_tag.rb

@@ -0,0 +1,111 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# (c) ANB Andrew Bizyaev
+
+require 'active_support/core_ext'
+
+module ExifTagger
+  module Tag
+    # Parent class for all tags
+    class Tag
+      include Comparable
+
+      EXIFTOOL_TAGS = []
+      attr_reader :errors, :value, :value_invalid, :warnings, :write_script_lines
+      attr_accessor :info, :force_write
+
+      def initialize(value_norm = '')
+        @value = value_norm
+        @errors = []
+        @value_invalid = []
+        @warnings = []
+        @write_script_lines = []
+        @info = ''
+        @force_write = false
+        validate
+        @value.freeze
+        @errors.freeze
+        @value_invalid.freeze
+        @warnings.freeze
+      end
+
+      def tag_id
+        self.class.to_s.demodulize.underscore.to_sym
+      end
+
+      def tag_name
+        self.class.to_s.demodulize
+      end
+
+      def <=>(other)
+        if other.respond_to? :tag_id
+          tag_id <=> other.tag_id
+        else
+          tag_id <=> other.to_s.to_sym
+        end
+      end
+
+      def to_s
+        "#{tag_id} = #{@value}"
+      end
+
+      def valid?
+        @errors.empty?
+      end
+
+      def check_for_warnings(original_values: {})
+        @warnings = []
+        self.class::EXIFTOOL_TAGS.each do |tag|
+          v = original_values[tag]
+          unless v.nil?
+            case
+            when v.kind_of?(String)
+              @warnings << "#{tag_name} has original value: #{tag}='#{v}'" unless v.empty?
+            when v.kind_of?(Array)
+              @warnings << "#{tag_name} has original value: #{tag}=#{v}" unless v.join.empty?
+            else
+              @warnings << "#{tag_name} has original value: #{tag}=#{v}"
+            end
+          end
+        end
+        @warnings.freeze
+      end
+
+      def to_write_script
+        str = ''
+        generate_write_script_lines
+        unless @write_script_lines.empty?
+          str << print_info
+          str << print_warnings
+          str << print_lines
+        end
+        str
+      end
+
+      private
+
+      def print_info
+        @info.empty? ? '' : "# INFO: #{@info}\n"
+      end
+
+      def print_warnings
+        str = ''
+        @warnings.each do |w|
+          str << "# WARNING: #{w}\n"
+        end
+        str
+      end
+
+      def print_lines
+        str = ''
+        @write_script_lines.each do |l|
+          unless @warnings.empty?
+            str << '# ' unless @force_write
+          end
+          str << "#{l}\n"
+        end
+        str
+      end
+    end
+  end
+end

data/lib/phtools/exif_tagger/tags/_tag_date.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# (c) ANB Andrew Bizyaev
+
+require_relative '_tag'
+require 'date'
+
+module ExifTagger
+  module Tag
+    class TagDate < Tag
+      MAX_BYTESIZE = 32 # no limit set in EXIF spec for Date
+
+      private
+
+      def validate
+        case
+        when @value.kind_of?(String)
+          bsize = @value.bytesize
+          if bsize > MAX_BYTESIZE
+            @errors << %(#{tag_name}: '#{@value}' ) +
+              %(is #{bsize - MAX_BYTESIZE} bytes longer than allowed #{MAX_BYTESIZE})
+            @value_invalid << @value
+            @value = ''
+          end
+        when @value.kind_of?(DateTime)
+          if @value == DateTime.new(0)
+            @errors << %(#{tag_name}: '#{@value}' zero Date)
+            @value_invalid << @value
+            @value = ''
+          end
+        when @value.kind_of?(Time)
+          if @value == Time.new(0)
+            @errors << %(#{tag_name}: '#{@value}' zero Date)
+            @value_invalid << @value
+            @value = ''
+          end
+        else
+          @errors << %(#{tag_name}: '#{@value}' is of wrong type (#{@value.class}))
+          @value_invalid << @value
+          @value = ''
+        end
+      end
+    end
+  end
+end

data/lib/phtools/exif_tagger/tags/city.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# (c) ANB Andrew Bizyaev
+
+require_relative '_tag'
+
+module ExifTagger
+  module Tag
+    # MWG:City, String[0,32]
+    #   = IPTC:City XMP-photoshop:City XMP-iptcExt:LocationShownCity
+    class City < Tag
+      MAX_BYTESIZE = 32
+      EXIFTOOL_TAGS = %w(City LocationShownCity)
+
+      def initialize(value_raw = '')
+        super(value_raw.to_s)
+      end
+
+      private
+
+      def validate
+        bsize = @value.bytesize
+        if bsize > MAX_BYTESIZE
+          @errors << %(#{tag_name}: '#{@value}' ) +
+                     %(is #{bsize - MAX_BYTESIZE} bytes longer than allowed #{MAX_BYTESIZE})
+          @value_invalid << @value
+          @value = ''
+        end
+      end
+
+      def generate_write_script_lines
+        @write_script_lines = []
+        unless @value.empty?
+          @write_script_lines << %Q(-MWG:City=#{@value})
+        end
+      end
+    end
+  end
+end