Ticket #465: find-photos.rb

#! /opt/local/bin/ruby
# Encoding: UTF-8
#
# Author::      Ollivier Robert
# Copyright::   © 2007-2008 by Ollivier Robert
# Description:: Identify in which format an image exist
#
# Long description:
#
# From a given tree root, find all images in DNG/PEF/JPG formats,
# displays partial path from the root and sizes for all.
#
# BUGS
#
# XXX highly specific to my own setup (the -new hack) and Pentax-specific
#
# An ImagePool is made of ImageBuckets.
# An ImageBucket is made of potentially several formats and several versions
# per format

# VCS ID
MYNAME = File.basename($0)
ID = "$Id: find-photos.rb,v 17656f563b53 2008/10/03 14:04:50 roberto $"

# Standard packages
#
require "optparse"

$verbose = false

# === message
#
def message(msg)
  if $verbose then
    puts(msg)
  end
end # -- message

# == class Image
#
# Contain partial path (below the root of the ImagePool) path
# different types may be in different directories so store all partial
# paths
#
class ImageBucket
  include Enumerable
  attr_reader :base_name, :raw, :dng, :jpg, :pef, :nef, :cr2, :crw
  attr_reader :types
  
  # === initialize
  #
  def initialize(base_name)
    @base_name = base_name
    @types = Hash.new
    @dng = 0
    @jpg = 0
    @pef = 0
    @raw = 0
    @nef = 0
    @cr2 = 0
    @crw = 0
  end # -- initialize

  # === add
  #
  def add(base_dir, type)
    tmp = @types[type] || Array.new
    tmp << "#{base_dir}/#{@base_name}.#{type}"
    @types[type] = tmp
    case type
    when /DNG/
      @dng += 1
      @raw += 1
    when /dng/
      @dng += 1
      @raw += 1
    when /PEF/i
      @pef += 1
      @raw += 1
    when /NEF/i
      @nef += 1
      @raw += 1
    when /CR2/i
      @nef += 1
      @raw += 1
    when /CRW/i
      @nef += 1
      @raw += 1
    when /JPEG/i
      @jpg += 1
    when /JPG/i
      @jpg += 1
    end
    message("Adding #{type} to #{base_name}")
  end # -- add

  # === each
  #
  def each
    @types.each do |type, base_path|
      yield(type, base_path)
    end
  end # -- each

end # -- ImageBucket

# == class ImagePool
#
class ImagePool
  include Enumerable
  attr_reader :root, :size, :pool, :total, :stats

  # === initialize
  #
  def initialize(root, now = true, type = nil)
    @root = root
    @pool = Hash.new
    @size = 0
    @total = 0
    @stats = Hash.new(0)
    if now then
      read(type)
    end
  end # -- initialize

  # === read
  #
  # General format: base_dir/base_name.base_type
  #
  # For every base_name, base_dir/base_type can change
  #
  def read(type = nil)
    Dir.chdir(@root) do
      Dir.glob("**/*.{JPG,jpg,DNG,dng,PEF,pef,NEF,CR2,CRW}").each do |full_name|

        fname = File.basename(full_name)
        fname =~%r{(.*)\.(\w+)$}
        base_name = $1
        base_type = $2
        base_dir = File.dirname(full_name)

        message("(#{base_dir})(#{base_name}).(#{base_type})")

        if @pool[base_name].nil? then
          img = ImageBucket.new(base_name)
          img.add(base_dir, base_type)
          @pool[base_name] = img
          @size += 1
        else
          @pool[base_name].add(base_dir, base_type)
        end
        @total += 1
        @stats[base_type] += 1
      end # -- Dir.glob
    end # -- Dir.chdir
  end # -- read

  # === add
  #
  def add(img)
    @pool[img.base_name].add(img)
  end # -- add

  # === <<
  #
  def <<(img)
    self.add(img)
  end # -- <<

  # === each
  #
  def each
    @pool.each do |base_name, img|
      yield(base_name, img)
    end
  end # -- each

  # === keys
  #
  def keys
    return @pool.keys
  end # -- keys

  # === []
  #
  def [](base_name)
    return @pool[base_name]
  end # -- []

end # -- ImagePool

# == main
#
def main(argv)
  usage = <<-"EOTEXT"
Usage: #{MYNAME} [-hv] DIR 
  EOTEXT
  
  banner = <<-"EOTEXT"
#{MYNAME}
Revision #{ID}

#{usage}
  EOTEXT

  # Process options
  #
  argv.options do |opts|
    opts.banner = banner
    opts.on("-v", "--verbose", "Be more verbose.") do
      $verbose = true
    end
    opts.on("-h", "--help", "Display this.") do
      puts banner
      return 255
    end
    opts.parse!
  end

  argv.options = nil
  root_dir = argv.shift

  if root_dir.nil? then
    $stderr.puts("You must specify a directory to look into!")
    return 1
  end

  # Down to work
  #
  ts = Time.new
  list = ImagePool.new(root_dir)
  te = Time.new - ts
  puts "Root is #{root_dir}"
  puts "#{list.size} photos with #{list.total} variants found in #{te}s"
  list.keys.sort.each do |base_name|
    puts "#{base_name}"
    img = list[base_name]
    img.each do |type, partial_path|
      partial_path.each do |path|
        full_path = "#{list.root}/#{path}"
        size = File.size(full_path)
        puts "  #{type}: #{path} (#{size})"
      end
    end
  end
  
  # Some stats
  #
  list.stats.each do |type, nb|
    puts "#{nb} #{type} photos"
  end
  return 0
end # -- main

if $0 == __FILE__ then
  exit(main(ARGV) || 1)
end