Changeset 9074

Timestamp:

04/07/08 16:46:43 (5 years ago)

Author:

ihag

Message:

lang/ruby/mdmaildir/mdmerge.rb:

• add -f COMMAND_FILE option for make cmdfile mode.
  
• add -c -f COMMAND_FILE option for commit from cmdfile mode.
  
• Introduced CMDProcessor class for abstracting the behavior of command.
  

lang/ruby/mdmaildir/mdd.rb: add comments.
lang/ruby/mdmaildir/README: fix typo.

Location:

lang/ruby/mdmaildir

Files:

• README (modified) (1 diff)
• mdd.rb (modified) (8 diffs)
• mdmerge.rb (modified) (4 diffs)

lang/ruby/mdmaildir/README

@@ -1 @@
-Maildir manupiration scripts for migration and maintenance.
+Maildir manipuration scripts for migration and maintenance.
 
 - mdmerge.rb: Merge different two Maildir into one Maildir.

lang/ruby/mdmaildir/mdd.rb

@@ -1 +1 @@
 #!/usr/local/bin/ruby
 # $Id$
-require 'gdbm'
-require 'digest/sha1'
-require 'pp'
 
+#
+# = Manipulates message-digest file for whole of messages in the Maildir.
+#
+# Authors::  $Author: genta $
+# Revision:: $Revision: 77 $
+#
+class MDDigest
+  require 'gdbm'
+  require 'digest/sha1'
+  require 'pp'
 
-# Maildir digest file class
-class MDDigest
   attr_reader :path, :basedir, :db
+
+  # Create MDDigest instance.  MDDigest opens a message-digest file in
+  # the specified Maildir.  The message-digest file is stored into the
+  # top-level directory as filename like "_maildir_/mddigest".
+  #
+  # _maildir_:: Path of Maildir.
+  # returns::   An instance of MDDigest class
   def initialize(maildir)
     @basedir = maildir.dup
@@ -16 +28 @@
 
   def open;  @db = GDBM.open(@path); end
-  def close; @db.reorganize.close;   end
-  def clear; @db.clear;              end
+  private :open
 
+  # Close the backend DBM. Call this method at the end of your program.
+  def close;
+    @db.reorganize.close
+  end
+
+  # Truncate message-digest file.
+  def clear
+    @db.clear
+  end
+
+  # Caliculates a message-digest for specified message, and records it
+  # into message-digest file. 
+  #
+  # _path_::  Relative path of a message from Maildir directory.
+  # returns:: void
   def add(path)
     apath = abspath(path)
@@ -33 +59 @@
   end
 
+  # Check specified key and file are already records in message-digest
+  # file, or not.
+  #
+  # _key_::   Key of file-hash. It typically message-digest + size of
+  #           message.
+  # _file_::  Relative path of a message from Maildir directory.
+  # returns:: *true* if it already exists.
+  #           *false* for not exists.
   def has_file?(key, file)
     return false if @db[key].nil?
@@ -41 +75 @@
   end
 
+  # Wrapper of GDBM#each. It is for traversal all of messages in Maildir
+  # by using a message-digest file.
   def each(&block)
     @db.each(&block)
@@ -46 +82 @@
 
 
+  private
+
+  # Caliculates a Message digest for specified message.
+  #
+  # _file_::  Path for a message.
+  # returns:: Instance of Digest::SHA1.
   def hash(file)
     md = Digest::SHA1.new
@@ -57 +99 @@
   end
 
-  def abspath(file)
-    File.expand_path(file, @basedir)
-  end
-
+  # _key_::
+  # _dest_::
   def merge(key, dest)
     dfolder = folder(abspath(dest))
@@ -77 +117 @@
   end
 
+  # Determines a folder name for a specified message.
+  #
+  # _path_::  Relative path of a message from Maildir directory
+  # returns:: A folder name in Maildir for a message that directed by path.
   def folder(path)
     f, = path.split('/')
@@ -82 +126 @@
     return f
   end
+
+  # Convert relative path to the absolute path. The root of absolute path is
+  # Maildir directory.
+  #
+  # _file_::  Relative path from Maildir directory.
+  # returns:: Absolute path that converted from _file_.
+  def abspath(file)
+    File.expand_path(file, @basedir)
+  end
 end

lang/ruby/mdmaildir/mdmerge.rb

@@ -5 +5 @@
 $LOAD_PATH << File.dirname($0)
 require 'mdd'  # MDDigest class
+require 'optparse'
 require 'pp'
 
+# store command-line configuration params.
+$config = Hash.new
+
 
 
 class CMD
-  attr_reader :fileq, :dirq, :skipdir, :basedir, :fromdir, :config
-  def initialize(basedir, fromdir, config = {})
-    @fileq, @dirq = [], []
-    @skipdir = []
+  require 'tempfile'
+
+  attr_reader :basedir, :fromdir
+  def initialize(basedir, fromdir, config = Hash.new)
+    @config = config.dup
     @basedir = basedir.dup
     @fromdir = fromdir.dup
-    @config = config.dup
+    @logger = nil
+    @tempfile = Tempfile.new(File.basename($0))
+  end
+
+  def openlog(file)
+    @logger = open(file, 'w')
+  end
+
+  def closelog
+    @logger.close
+    @logger = nil
+  end
+
+  def logging?
+    @logger.nil? ? false : true
+  end
+
+  def fd
+    logging? ? @logger : @tempfile
+  end
+  protected :fd
+
+  def rewind
+    return self if logging?
+    @tempfile.rewind
+  end
+  protected :rewind
+
+  def load(file)
+    @tempfile = open(file)
   end
 
   def add(file)
-    mkdir(file)
-    cpfile(file)
-  end
-
-  def cpfile(rpath)
-    return if @fileq.include?(rpath)
-    @fileq << rpath
-  end
-
-  def mkdir(rpath)
-    rdir = File.dirname(rpath)
-    path = rdir.split(File::SEPARATOR)
-    path.pop if path[-1] =~ /^(cur|new|tmp)$/
-    rdir = File.join(path)
-    adir = abspath(rdir)
-
-    return if @dirq.include?(rdir) or @skipdir.include?(rdir)
-    if test(?d, adir) then
-      puts "mkdir: already exists: #{adir}"
-      @skipdir << rdir
-      return
-    end
-    @dirq << rdir
-  end
-
-  def commit_check
-    @dirq.each do |dir|
-      puts "mkdir: #{dir}"
-    end
-
-    @fileq.each do |file|
-      puts "cp: #{file}"
-    end
+    fd.puts(file)
+    return self
   end
 
   def commit
-    return if immediate?
-    do_mkdir
-    do_cpfile
-  end
-
-
-  def do_mkdir
-    @dirq.each do |rpath|
-      folder = rpath.split(File::SEPARATOR)[0].sub(/^\./, '')
-      #puts "maildirmake: #{folder} (from: #{rpath}, basedir: #{@basedir})"
-      system('maildirmake', '-f',  folder, @basedir) or
-        raise "maildirmake: #{$?}"
-    end
-  end
-
-  def do_cpfile
-    @fileq.each do |rpath|
-      tofile = File.expand_path(rpath, @basedir)
+    rewind
+    dircache = Hash.new(false)
+    while rpath = fd.gets
+      rpath.chomp!
+      folder = rpath_to_folder(rpath)
+      if dircache[folder] == false then
+        do_maildirmake(folder)
+        dircache[folder] = true
+      end
+
+      to_rpath = rpath.dup
+      unless imap_prefix.empty? then
+        if to_rpath =~ /^\./ then
+          to_rpath = '.' + imap_prefix + to_rpath
+        else
+          unless to_rpath =~ /^(cur|tmp|new)/ then
+            raise "Internal Error: rpath contains illegal path: #{to_rpath}"
+          end
+          to_rpath = '.' + imap_prefix + '/' + to_rpath
+        end
+      end
+      tofile = File.expand_path(to_rpath, @basedir)
       frfile = File.expand_path(rpath, @fromdir)
-
-      system('cp', '-p', frfile, tofile) or raise "cp: #{$?}"
-    end
+      do_cpfile(frfile, tofile)
+    end
+  end
+
+
+  private
+
+  def do_maildirmake(folder)
+    path = folder.split('.')
+    path.unshift(imap_prefix) unless imap_prefix.empty?
+    path.size.times do |i|
+      folder = path[0..i].join('.')
+      next if test(?e, abspath('.' + folder))
+      
+      args = ['maildirmake', '-f', folder, @basedir]
+      args.unshift('echo') if dry_run?
+      system(*args) or
+        raise("maildirmake: returned in status #{$?} for " +
+              "'maildirmake -f #{folder} #{@basedir}'")
+    end
+    return self
+  end
+
+  def do_cpfile(src, dest)
+    args = link? ? ['ln', '-f', src, dest] : ['cp', '-p', src, dest]
+    args.unshift('echo') if dry_run?
+    system(*args) or
+      raise("#{args[0]}: returned in status #{$?} for " + args.join(' '))
+    return self
+  end
+
+  def rpath_to_folder(msg_rpath)
+    folder, = File.dirname(msg_rpath).split(File::SEPARATOR)
+    return '' unless folder.sub!(/^\./, '')
+    return folder
   end
 
@@ -84 +123 @@
   end
 
-  def immediate?
-    @config.key?(:immediate)
-  end
-end
+  def dry_run?;    @config[:dry_run]; end
+  def link?;       @config[:link];    end
+  def imap_prefix; @config.key?(:prefix) ? @config[:prefix] : ''; end
+end
+
+
+class CMDProcessor
+  require 'forwardable'
+  extend Forwardable
+  def_delegators(:@cmd, :openlog, :closelog, :load, :commit)
+  protected :openlog, :closelog, :load, :commit
+
+  def initialize(updating_maildir, mergefrom_maildir, config)
+    @config = config
+    @mode = @config[:mode]
+    @cmdfile = @config[:cmdfile]
+
+    @updating = MDDigest.new(updating_maildir)
+    @mergefrom = MDDigest.new(mergefrom_maildir)
+
+    @cmd = CMD.new(@updating.basedir, @mergefrom.basedir, @config)
+  end
+
+  def process
+    raise "Please inhelit this class"
+  end
+
+  def close
+    $stderr.print 'Closing DBMs...'
+    @updating.close
+    @mergefrom.close
+    $stderr.puts ' done.'
+    return nil
+  end
+
+  protected
+  def check_maildir
+    @mergefrom.each do |key, file|
+      # 'files' are mail. that have a same hash digest.
+      files = file.split('\0')
+      files.each do |file|
+        @cmd.add(file) unless @updating.has_file?(key, file)
+      end
+    end
+    return self
+  end
+end
+
+class OnTheFly < CMDProcessor
+  def process
+    $stderr.puts 'Processing in on-the-fly mode.'
+
+    $stderr.print "Checking maildir... "
+    check_maildir
+    $stderr.puts "done."
+
+    $stderr.print "Commit... "
+    commit
+    $stderr.puts "done."
+
+    return self
+  end
+end
+
+class MakeCMDFile < CMDProcessor
+  def process
+    $stderr.puts 'Processing in make-cmdfile mode.'
+
+    openlog(@cmdfile)
+    $stderr.print "Checking maildir... "
+    check_maildir
+    $stderr.puts "done."
+    closelog
+
+    return self
+  end
+end
+
+class CommitFromFile < CMDProcessor
+  def process
+    $stderr.puts 'Processing in commit-from-file mode.'
+    self.load(@cmdfile)
+
+    $stderr.print "Commit... "
+    commit
+    $stderr.puts "done."
+
+    return self
+  end
+end
+
 
 def usage
   puts <<-_EOD_
-#{File.basename($0)} [base-maildir] [merge-from-maildir]
+#{File.basename($0)} [options]... [base-maildir] [merge-from-maildir]
 Note: base-maildir will be overwritten.  Please backup first.
+
+Options:
+  -f COMMAND_FILE             実際に処理を行わず，COMMAND_FILEに処理の
+                              内容を書き出します．
+  -c -f COMMAND_FILE          COMMAND_FILEから処理の内容を読み込み，実
+                              行します．
+  -p IMAP_FOLDER_PREFIX       base-maildirにコピーする際，指定されたフ
+                              ォルダ以下にコピーを行います．
+  --link                      base-maildirにコピーする際，cp(1) の代わ
+                              りにln(1)を用います．
+  -n                          For debug.
+  -h                          Show usage.
   _EOD_
 end
@@ -98 +236 @@
 def getargs
   $home = ENV['HOME'] or raise "HOME environment undefined"
+  
+  commit_from_file = false
+  OptionParser.new do |opt|
+    opt.on('-f MANDATORY') {|val| $config[:cmdfile] = val }
+    opt.on('-n') {|v| $config[:dry_run] = true }
+    opt.on('-c') {|v| commit_from_file = true }
+    opt.on('-p MANDATORY') {|val| $config[:prefix] = val }
+    opt.on('--link') {|v| $config[:link] = true }
+    opt.on('-h') {|v| usage(); exit }
+    opt.parse!(ARGV)
+  end
+
   if ARGV.size != 2 then
     usage()
@@ -103 +253 @@
   end
   $src, $dest = ARGV[0..1]
-end
-
+
+  # sanity check for options
+  $config[:mode] = :on_the_fly
+  if $config.key?(:cmdfile) then
+    $config[:mode] = :make_cmdfile
+  end
+  if (commit_from_file == true) then
+    $config[:mode] = :commit_from_file
+    unless test(?e, $config[:cmdfile]) then
+      raise "#{$config[:cmdfile]}: Not exists"
+    end
+  end
+end
 
 
 getargs()
-smd = MDDigest.new($src)
-dmd = MDDigest.new($dest)
-cmd = CMD.new(smd.basedir, dmd.basedir, {:immediate => true})
-
-dmd.each do |key, file|
-  files = file.split('\0')  # 'files' are mail. that have a same hash digest.
-  files.each do |file|
-    cmd.add(file) unless smd.has_file?(key, file)
-  end
-end
-cmd.commit
-
-smd.close
-dmd.close
+{ :on_the_fly => OnTheFly, 
+  :make_cmdfile => MakeCMDFile,
+  :commit_from_file => CommitFromFile }[$config[:mode]].
+  new($src, $dest, $config).process.close
 __END__