bc3 0.1.0

data/examples/test_hardcoded.rb

@@ -0,0 +1,15 @@
+$:.unshift('../lib')
+require 'bc3'
+require 'yaml'
+
+def test_hard_coded()
+  test = BC3::Snapshot.new('C:\Program Files (x86)\Beyond Compare 3')
+  test << folder = BC3::Folder.new('Helpers', Time.local(2011,1,10,14,5,37))
+  folder << folder2 = BC3::Folder.new('HtmlTidy', Time.local(2010,12,27,12,8,10))
+  folder2 << BC3::File.new(filename: 'HtmlTidy.exe', filesize: 111592, timestamp: Time.local(2007,8,16,19,0,45))
+  folder << BC3::File.new(filename: 'MediaInfo.bat', filesize: 32, timestamp: Time.local(2010,9,3,9,10,45))
+  test << BC3::File.new(filename: '7zxa.dll', filesize: 162816, timestamp: Time.local(2008,6,17,11,4,14))
+  
+  test.save('results/test_hardcoded.xxx')
+  test.save('results/test_hardcoded.bcss')
+end

data/examples/test_merge.bat

@@ -0,0 +1,5 @@
+@echo off
+ruby -I ../lib  ../bin/bc3_merge.rb -t results/test_merge.bcss -s testsnap -r 'folder*.bcss'
+REM ~ ruby -I ../lib  ../bin/bc3_merge.rb -t results/test_merge.bcss -s testsnap -b 'folder*.bcss'
+REM ~ ruby -I ../lib ../bin/bc3_merge.rb -t results/test_merge.bcss -s testsnap -i 'folder*.bcss'
+

data/examples/test_yaml.rb

@@ -0,0 +1,188 @@
+$:.unshift('../lib')
+require 'bc3'
+require 'yaml'
+
+extract = <<data
+:snapshot: C:\\Program Files (x86)\\Beyond Compare 3
+:timestamp: 2011-01-12 15:58:17 +00:00
+:content: 
+#~ - :dirname: Helpers
+  #~ :timestamp: 2011-01-10 14:05:37 +00:00
+  #~ :attributes: 16
+  #~ :content: 
+  #~ - :dirname: HtmlTidy
+    #~ :timestamp: 2010-12-27 12:08:10 +00:00
+    #~ :content: 
+    #~ - :filename: HtmlTidy.exe
+      #~ :filesize: 110592
+      #~ :crc: 
+      #~ :timestamp: 2007-08-16 19:00:00 +00:00
+  #~ - :filename: MediaInfo.bat
+    #~ :filesize: 32
+    #~ :crc: 
+    #~ :timestamp: 2010-09-03 09:10:45 +00:00
+#~ - :filename: 7zxa.dll
+  #~ :filesize: 162816
+  #~ :crc: 
+  #~ :timestamp: 2008-06-17 11:04:14 +00:00
+#~ ##### error
+- :filename: Readme.txt
+  :filesize: 1559
+  :crc: 2585723240
+  :attributes: 32
+  :timestamp: 2010-02-16 16:10:46 +01:00
+data
+
+<<rem
+Mit Readme.txt hat es Fehler --> pruefen warum.
+rem
+
+#~ test = BC3::Snapshot.newh(YAML.load(extract))
+test = BC3::Snapshot.newh(YAML.load(DATA))
+
+
+test.save('results/test_yaml.xxx')
+test.save('results/test_yaml.bcss')
+#~ test.save('results/test_yaml.bcssx')
+
+__END__
+:snapshot: C:\Program Files (x86)\Beyond Compare 3
+:timestamp: 2011-01-16 01:00:57.656250 +01:00
+:content: 
+#~ - :dirname: Helpers
+  #~ :timestamp: 2011-01-10 15:05:37 +01:00
+  #~ :attributes: 16
+  #~ :content: 
+  #~ - :dirname: HtmlTidy
+    #~ :timestamp: 2010-12-27 13:08:10 +01:00
+    #~ :attributes: 16
+    #~ :content: 
+    #~ - :filename: HtmlTidy.exe
+      #~ :filesize: 110592
+      #~ :crc: 2173815664
+      #~ :attributes: 32
+      #~ :timestamp: 2007-08-16 21:00:00 +02:00
+    #~ - :filename: XML_tidied.bat
+      #~ :filesize: 129
+      #~ :crc: 4093430901
+      #~ :attributes: 32
+      #~ :timestamp: 2009-08-19 06:41:00 +02:00
+    #~ - :filename: XML_tidied_config.txt
+      #~ :filesize: 161
+      #~ :crc: 404518302
+      #~ :attributes: 32
+      #~ :timestamp: 2009-08-19 06:32:00 +02:00
+  #~ - :filename: DOC_to_TXT.vbs
+    #~ :filesize: 1775
+    #~ :crc: 843128772
+    #~ :attributes: 32
+    #~ :timestamp: 2010-10-25 15:40:00 +02:00
+  #~ - :filename: MediaInfo.bat
+    #~ :filesize: 32
+    #~ :crc: 232131984
+    #~ :attributes: 32
+    #~ :timestamp: 2010-09-03 11:10:45 +02:00
+  #~ - :filename: MediaInfo.exe
+    #~ :filesize: 200192
+    #~ :crc: 3570952021
+    #~ :attributes: 32
+    #~ :timestamp: 2010-05-14 00:12:10 +02:00
+  #~ - :filename: PdfToText.exe
+    #~ :filesize: 663552
+    #~ :crc: 2411832728
+    #~ :attributes: 32
+    #~ :timestamp: 2009-07-09 12:01:20 +02:00
+  #~ - :filename: XLS_to_CSV_Single.vbs
+    #~ :filesize: 909
+    #~ :crc: 1591998383
+    #~ :attributes: 32
+    #~ :timestamp: 2010-11-04 11:21:10 +01:00
+#~ - :dirname: Packers
+  #~ :timestamp: 2010-10-21 14:15:31 +02:00
+  #~ :attributes: 16
+  #~ :content: 
+  #~ - :filename: cpio.wcx
+    #~ :filesize: 55296
+    #~ :crc: 2352348747
+    #~ :attributes: 32
+    #~ :timestamp: 2002-09-24 18:24:40 +02:00
+  #~ - :filename: Masks.dat
+    #~ :filesize: 26
+    #~ :crc: 592179890
+    #~ :attributes: 32
+    #~ :timestamp: 2010-10-21 14:15:27 +02:00
+  #~ - :filename: rpm.wcx
+    #~ :filesize: 56320
+    #~ :crc: 3202116200
+    #~ :attributes: 32
+    #~ :timestamp: 2002-12-02 15:09:12 +01:00
+#~ - :filename: 7zxa.dll
+  #~ :filesize: 162816
+  #~ :crc: 1142077912
+  #~ :attributes: 32
+  #~ :timestamp: 2008-06-17 13:04:14 +02:00
+#~ - :filename: BC3Key.txt
+  #~ :filesize: 375
+  #~ :crc: 1626513908
+  #~ :attributes: 32
+  #~ :timestamp: 2010-08-09 17:07:59 +02:00
+#~ - :filename: BComp.com
+  #~ :filesize: 93184
+  #~ :crc: 1452076902
+  #~ :attributes: 32
+  #~ :timestamp: 2008-11-21 13:17:02 +01:00
+#~ - :filename: BComp.exe
+  #~ :filesize: 89088
+  #~ :crc: 309807675
+  #~ :attributes: 32
+  #~ :timestamp: 2010-02-04 18:33:32 +01:00
+#~ - :filename: BCompare.chm
+  #~ :filesize: 1372366
+  #~ :crc: 2005151591
+  #~ :attributes: 32
+  #~ :timestamp: 2011-01-10 14:41:44 +01:00
+#~ - :filename: BCompare.exe
+  #~ :filesize: 9562256
+  #~ :crc: 1565394031
+  #~ :attributes: 32
+  #~ :timestamp: 2011-01-10 14:41:06 +01:00
+#~ - :filename: BCShellEx.dll
+  #~ :filesize: 132096
+  #~ :crc: 1919929414
+  #~ :attributes: 32
+  #~ :timestamp: 2010-03-01 10:54:14 +01:00
+#~ - :filename: BCShellEx64.dll
+  #~ :filesize: 390648
+  #~ :crc: 2879715418
+  #~ :attributes: 32
+  #~ :timestamp: 2010-03-01 10:54:14 +01:00
+#~ - :filename: FastMM_FullDebugMode.dll
+  #~ :filesize: 129024
+  #~ :crc: 4192386136
+  #~ :attributes: 32
+  #~ :timestamp: 2007-11-20 13:10:27 +01:00
+- :filename: License.html
+  :filesize: 8937
+  :crc: 1763902305
+  :attributes: 32
+  :timestamp: 2010-04-12 19:22:44 +02:00
+#~ - :filename: Readme.txt
+  #~ :filesize: 1559
+  #~ :crc: 2585723240
+  #~ :attributes: 32
+  #~ :timestamp: 2010-02-16 16:10:46 +01:00
+- :filename: unins000.dat
+  :filesize: 267122
+  :crc: 3852464717
+  :attributes: 32
+  :timestamp: 2011-01-10 15:05:37 +01:00
+- :filename: unins000.exe
+  :filesize: 1191984
+  :crc: 2885606081
+  :attributes: 32
+  :timestamp: 2011-01-10 15:05:29 +01:00
+- :filename: unrar.dll
+  :filesize: 178176
+  :crc: 819978712
+  :attributes: 32
+  :timestamp: 2009-07-06 16:33:30 +02:00

data/lib/bc3.rb

@@ -0,0 +1,89 @@
+=begin rdoc
+Build Snapshots for usage with Beyond compare 3
+
+Beyond compare 3 is a file and folder comparison tool.
+The folder compare allows to generate snapshots.
+
+This gem allows an alternate way to generate a snapshot.
+In opposite to BC3, this tools offers you possibilities to
+manipulate the snapshot.
+
+You may simulate changes in your folder structure, 
+merge snapshots...
+
+More about Beyond compare at http://www.scootersoftware.com
+
+This tool is a result of the following question:
+http://www.scootersoftware.com/vbulletin/showthread.php?t=7210
+
+=Examples for the usage of the gem
+==Merge snapshots from multiple CD/DVDs.
+See bin/bc3_merge.rb
+
+You can expand a _sneakernet_ on multiple storage location.
+
+Merge the snapshots of your safety copies in CD and 
+compare with your original filesystem.
+
+See http://www.scootersoftware.com/support.php?zz=kb_sneakernet
+
+==Build virtual snapshots
+Build your own snapshot.
+
+Prepare a virtual folder structure as you would like to have
+and use BC3 to convert your real structure to your wishes.
+
+==Scan for identic files.
+<em>
+The only way to find duplicate files is to flatten your folder structure so that all the files appear to be at the same level. You then can enable/show the CRC column, sort by it, then manually scan the file list for files with the same size and CRC code. I wouldn't advise it for a large number of files and folders, though. It could take a while to calculate all the CRC values, and it would be a tedious process to manually look through them all for dups.
+</em>
+http://www.scootersoftware.com/vbulletin/showpost.php?p=27736&postcount=4
+
+With this gem, you can analyse a snapshot, copy the data in a hash
+and search for duplicate CRCs
+
+
+=Warning and Restrictions
+Please don't 
+  require 'bc3'
+  include BC3
+You may get problems with rdefinition of File (See BC3::File).
+
+==Restrictions
+===File attributes
+File attributes are not supported by BC3::Snapshot.newd
+(How can I read them in ruby?)
+
+====Extended File data
+Not supported at snapshot creation.
+
+Version read at snapshot parsing, but no UTF-8 support.
+
+====Compression
+Compressed snapshot can be read, but not stored 
+(but BC3 can handle uncompressed snapshots).
+
+====File sizes
+Maximum 2GB (more is supported by BC3, but not by this gem).
+
+=end
+require 'date'
+require 'zlib'
+
+require 'log4r'
+$log = Log4r::Logger.new('BC3')
+$log.outputters = Log4r::StdoutOutputter.new('log_stdout')
+$log.level = Log4r::INFO
+
+
+require 'bc3/helper'
+require 'bc3/snapshot'
+require 'bc3/folder'
+require 'bc3/file'
+require 'bc3/time'
+
+require 'bc3/parse'
+
+module BC3
+  VERSION = '0.1.0'
+end

data/lib/bc3/file.rb

@@ -0,0 +1,120 @@
+require 'bc3/helper'
+module BC3
+=begin rdoc
+File definition for BC3 handling.
+
+If you need the original File inside BC3-module, use
+  ::File#new
+  ::File#open
+  
+=end
+  class File
+    include Helper
+    KEYS = [:filename,  :filesize ]
+    KEYS_OPTIONAL = [
+        :timestamp, :crc, :attributes,
+        :version,
+      ]
+    
+=begin rdoc
+Definition of a file in a snapshot.
+
+Arguments are given in a hash. 
+Must contain KEYS and supports KEYS_OPTIONAL
+=end
+    def initialize( args )
+      raise ArgumentError unless args.kind_of?(Hash)
+      KEYS.each{|key|
+        raise ArgumentError, "Missing Key #{key}" unless args.has_key?(key)
+      }
+      (args.keys - (KEYS + KEYS_OPTIONAL)).each{|key|
+        $log.warn("Undefined key #{key} for #{self.inspect}" )
+      }
+      @filename = args[:filename]
+      @filesize = args[:filesize]
+      @crc = args[:crc]
+      
+      @timestamp = args[:timestamp] || Time.now
+      @attributes = args[:attributes] || Attrib::Archive
+      
+      @version = args[:version]  #-> Extended File
+      
+      #Test content
+      raise ArgumentError, "timestamp is no time-object" unless @timestamp.kind_of?(Time)
+    end
+    
+=begin rdoc
+Create a folder from file system.
+
+The argument must contain:
+* dirname
+=end
+    def self.new_by_filename( filename )
+      $log.debug("Build file #{filename} from file system")
+      
+      #fixme: attrib
+      #~ p ::File.stat(filename)
+      #~ Get attributes: http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/68298
+      
+      settings = {
+        filename: filename,
+        filesize: ::File.size(filename),
+        #~ attributes: ::File.stat(filename),
+        #The timestamp must be 'local time' -> ignore local time zone for generation
+        timestamp: ::File.mtime(filename) + Time.now.gmt_offset,
+      }
+      
+      ::File.open( filename, 'r'){|f| 
+        settings[:crc]  = Helper::crc32(f.read)
+      } #fixme crc if ...
+      return File.new( settings )
+    end
+    attr_reader :filename
+
+    def to_hash()
+      { 
+        filename: @filename,
+        filesize: @filesize,
+        crc: @crc,
+        attributes: @attributes,
+        timestamp: @timestamp
+      }
+    end
+    def inspect()
+      "<BC3::File #{@filename}>"
+    end
+
+=begin rdoc
+Prepare for snapshot (bcss-file).
+
+ID_FILE (0x02)
+    Represents a file on the system.  
+
+    Name           : ShortString
+    Last Modified  : FileTime
+    DOS Attributes : UInt32
+    Size           : Int32[+Int64]
+       If Size > 2GB, store as Int32(-1) followed by Int64
+    CRC32          : UInt32
+=end
+    def bcss() 
+      bcss = "".force_encoding('BINARY')
+      bcss << 2
+      bcss << @filename.size
+      bcss << @filename
+      bcss << fixnum2int64(@timestamp.time2ad)
+      #DOS Attributes
+      bcss << @attributes  #little endian storage
+      bcss << 0
+      bcss << 0
+      bcss << 0
+      #Size
+      bcss << fixnum2int32(@filesize)
+      
+      #CRC32
+      bcss << fixnum2int32(@crc || 0)
+      #~ bcss << 255      
+      bcss
+    end
+  end #Folder
+end #BC3

data/lib/bc3/folder.rb

@@ -0,0 +1,239 @@
+$:.unshift('..') if $0 == __FILE__
+require 'bc3'
+module BC3
+=begin rdoc
+=end
+  class Folder
+    include Helper
+=begin rdoc
+=end
+    def initialize( dirname, timestamp = Time.now, attributes = nil )
+      @dirname = dirname
+      $log.debug("Create folder #{@dirname}")
+      raise ArgumentError unless @dirname.is_a?(String)
+      
+      @timestamp = timestamp || Time.now
+      raise ArgumentError, "No Timestamp for Folder" unless @timestamp.is_a?(Time)
+      
+      @attributes = attributes || Attrib::Directory
+      
+      @content = {}
+    end
+=begin rdoc
+Create a folder from a hash.
+
+The argument must contain:
+* dirname
+
+It may contain:
+* timestamp
+* content (array of folders and files)
+=end
+  def self.newh( data )
+    raise ArgumentError, "No hash given" unless data.is_a?(Hash)
+    raise ArgumentError, "dirname missing" unless data.has_key?(:dirname)
+    if data.has_key?(:content)
+      raise ArgumentError, "Content is no array" unless data[:content].is_a?(Array)
+    end
+    
+    $log.debug("Build folder #{data[:dirname]} from hash")
+    (data.keys - [:dirname, :content, :timestamp, :attributes]).each{|key|
+      $log.warn("Undefined key #{key} for #{self.inspect}" )
+    }
+    
+    folder = new( data[:dirname], data[:timestamp], data[:attributes] )
+    data[:content].each{| element |
+      if element.has_key?(:dirname)
+        folder << Folder.newh(element)
+      elsif element.has_key?(:filename)
+        folder << File.new(element)
+      else
+        raise ArgumentError, "element without dir/filename"
+      end
+    } if data[:content]
+    folder
+  end
+
+=begin rdoc
+Create a folder from file system.
+
+The argument must contain:
+* dirname
+=end
+  def self.new_by_dirname( dirname )
+#fixme: Pattern??
+#fixme: attrib
+    $log.debug("Build folder #{dirname} from file system")
+      #The timestamp must be 'local time' -> ignore local time zone for generation
+    folder = new( dirname, ::File.mtime(dirname) + Time.now.gmt_offset )
+    Dir.chdir(dirname){
+      Dir['*'].each{|f|
+        if ::File.directory?(f)
+          folder << Folder.new_by_dirname(f)
+        elsif ::File.exist?(f)
+          folder << File.new_by_filename(f)
+        else
+          raise ArgumentError, "#{f} not found in #{dirname}"
+        end
+      }
+    }
+    folder
+  end
+  #Name of the folder
+  attr_reader :dirname
+=begin rdoc
+Add content to Folder.
+The 'content' must support the bcss-method.
+
+Content may be:
+* another folder
+* a file
+=end
+    def << (content)
+      if !content.respond_to?( :bcss )
+        $log.error("Add unknown datatype as content #{content.inspect}")
+        raise ArgumentError, "Add unknown datatype as content #{content.inspect}"
+      end
+      
+      key = content.respond_to?(:dirname) ? content.dirname : content.filename
+      if @content[key]  #content already available
+        if @content[key].respond_to? :dirname and content.respond_to? :dirname
+          $log.debug("Mix into folder #{key} in folder #{self.inspect}")
+          @content[key].mixin(content) 
+        else
+          $log.warn("Overwrite #{key} in folder #{self.inspect}")
+          @content[key] = content
+        end
+      else
+        @content[key] = content
+        $log.debug("Add to folder #{self.inspect}: #{content.inspect}") if $log.debug?
+      end
+    end
+=begin rdoc
+Merge two folders.
+The content of a folder is added to the actual content.
+=end
+    def mixin( folder )
+      $log.info("Mix in content to folder #{@dirname} in folder #{self.inspect}")
+      folder.each{|key, content| self << content }
+    end
+=begin rdoc
+Loop on content of the folder and return path + object.
+
+Options may be
+* :files:  return Files
+* :folder: return Folders
+* :recursive: return also subdirectories.
+  The result is not nested, pathes are complete
+=end
+    def each(*options)
+      if options.empty?
+        extract = @content  #take all
+      else
+        extract = {}
+        @content.each{|key, content| 
+          case content
+            when File
+              extract[key] = content if options.include?(:files)
+            when Folder
+              extract[key] = content if options.include?(:folders)
+            else
+              raise "Internal error"
+            end
+            
+            if options.include?(:recursive) and content.is_a?(Folder)
+              content.each(*options).each{|subkey, subcontent|
+                extract[[key, subkey].join('/')] = subcontent
+              }
+            end
+        }
+      end
+      
+      if block_given?
+        extract.each{|key, content| yield key, content }
+      else
+        extract
+      end
+    end
+    #~ def values();@content.values;end  #fixme
+    def inspect()
+      "<BC3::Folder #{@dirname}>"
+    end
+=begin rdoc
+Return the content in a hash.
+=end
+    def to_hash()
+      #fixme: Array with needed keys?
+      { 
+        dirname: @dirname,
+        timestamp: @timestamp, 
+        attributes: @attributes,
+        content: @content.values.map{|x| x.to_hash } 
+      }
+    end
+=begin rdoc
+Prepare for snapshot (bcss-file).
+
+Each record starts with a single UByte ID value and then the data defined below.
+
+ID_DIRECTORY (0x01)
+    Represents a directory on the system, or an expanded archive file.
+
+    Name           : ShortString
+    Last Modified  : FileTime
+    DOS Attributes : UInt32
+
+
+ID_DIRECTORY_END (0xFF)
+    Represents the end of a directory listing.  No data.
+=end
+    def bcss() 
+      bcss = "".force_encoding('BINARY')
+      bcss << 1
+      bcss << @dirname.size
+      bcss << @dirname
+      bcss << fixnum2int64(@timestamp.time2ad)
+      #DOS Attributes
+      bcss << @attributes
+      bcss << 0
+      bcss << 0
+      bcss << 0
+      
+      @content.each{|key, data|
+        bcss << data.bcss
+      }
+      
+      bcss << 255
+      bcss
+    end
+  end #Folder
+end #BC3
+
+if $0 == __FILE__
+  
+    folder = BC3::Folder.new('x')
+    folder << BC3::Folder.new('x')
+    folder << BC3::File.new( filename: 'x2', filesize: 1)
+    folder << BC3::File.new( filename: 'x', filesize: 1)
+    
+    puts folder.each
+exit
+  
+  require 'YAML'
+      folder =  BC3::Folder.newh( YAML.load(%{
+          :dirname: dir
+          :content: 
+          - :dirname: subdir
+            :content:
+            - :filename: subfile
+              :filesize: 10
+          - :filename: file1
+            :filesize: 5
+          - :filename: file2
+            :filesize: 15
+      }))
+    
+    x = folder.each(:folders,:files, :recursive)
+    puts "=========="
+    puts x.keys
+    end