fingerprint 1.0.0

data/bin/fingerprint

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby
+# Copyright (c) 2010 Samuel Williams. Released under the GNU GPLv3.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'optparse'
+require 'fingerprint'
+
+OPTIONS = {
+	:root => "./",
+	:mode => :scan,
+	:output => nil
+}
+
+ARGV.options do |o|
+	script_name = File.basename($0)
+
+	o.banner = "Usage: #{script_name} [options]"
+	o.define_head "This script is used to calculate and compare a basic file system fingerprint."
+
+	o.on("-c", "Compare the given fingerprints. Check that the second fingerprint is a superset of the first.") do
+		 OPTIONS[:mode] = :check
+	end
+	
+	o.on("-o [output-path]", String, "Write the fingerprint output to the given file.") do |path|
+		OPTIONS[:output] = File.open(path, "w")
+	end
+
+	o.separator ""
+	o.separator "Help and Copyright information"
+
+	o.on_tail("--copy", "Display copyright information") {
+		puts "#{script_name} v#{Fingerprint::VERSION::STRING}. Copyright (c) 2010 Samuel Williams. Released under the GPLv3."
+		puts "See http://www.oriontransfer.co.nz/ for more information."
+
+		exit
+	}
+
+	o.on_tail("-h", "--help", "Show this help message.") { puts o; exit }
+end.parse!
+
+case (OPTIONS[:mode])
+	when :scan
+		Fingerprint::Scanner.scan_dirs(ARGV, OPTIONS[:output] || $stdout)
+	when :check
+		error_count = Fingerprint::Checker.check_files(ARGV[0], ARGV[1])
+		exit(error_count > 0 ? 1 : 0)
+end

data/lib/fingerprint.rb

@@ -0,0 +1,19 @@
+# Copyright (c) 2010 Samuel Williams. Released under the GNU GPLv3.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'fingerprint/version'
+require 'fingerprint/scanner'
+require 'fingerprint/checker'
+

data/lib/fingerprint/checker.rb

@@ -0,0 +1,82 @@
+# Copyright (c) 2010 Samuel Williams. Released under the GNU GPLv3.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'set'
+
+module Fingerprint
+  # Check that every file specified in fp2 exists in fp1 correctly,
+  # i.e. ensure that the fingerprint fp2 accurately is a superset of
+  # fp1
+  class Checker
+    def initialize(fp1, fp2)
+      @fp1 = fp1
+      @fp2 = fp2
+      @mismatches = []
+    end
+    
+    def check (&block)
+      @fp1.seek(0)
+      @fp2.seek(0)
+      
+      @dst = Set.new
+      @dst_paths = {}
+      @dst_hashes = {}
+      
+      # Parse original fingerprint
+      @fp2.each_line do |line|
+        if line.chomp.match(/^([a-fA-F0-9]{32}): (.*)$/)
+          @dst.add([$1, $2])
+
+          @dst_paths[$2] = $1
+          @dst_hashes[$1] ||= Set.new
+          @dst_hashes[$1].add($2)
+        end
+      end
+      
+      # For every file in the src, we check that it exists
+      # in the destination:
+      @fp1.each_line do |line|
+        if line.chomp.match(/^([a-fA-F0-9]{32}): (.*)$/)
+          yield($1, $2, self) unless dst.include?([$1, $2])
+        end
+      end
+    end
+    
+    attr :dst
+    attr :dst_paths
+    attr :dst_hashes
+    
+    def self.check_files(p1, p2)
+      puts "Comparing src: #{p1.dump} with dst: #{p2.dump}..."
+      error_count = 0 
+      checker = Checker.new(File.open(p1), File.open(p2))
+      
+      checker.check do |hash, path|
+        error_count += 1
+        
+        if !checker.dst_paths[path]
+          puts "Source file: #{path.dump} does not exist in destination!"
+        elsif checker.dst_paths[path] != hash
+          puts "Destination file: #{path.dump} is different!"
+        else
+          puts "Unknown error for path: #{path.dump}"
+        end
+      end
+      
+      return error_count
+    end
+    
+  end
+end

data/lib/fingerprint/scanner.rb

@@ -0,0 +1,86 @@
+# Copyright (c) 2010 Samuel Williams. Released under the GNU GPLv3.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'stringio'
+require 'find'
+require 'digest'
+
+module Fingerprint
+  
+  class Scanner
+    def initialize(dirs)
+      @dirs = dirs
+      @dirs << Dir.pwd if dirs.size == 0
+      
+      @excludes = [/^\._/]
+      
+      @output = StringIO.new
+    end
+
+    def output_dir(path)
+      @output.puts ""
+      @output.puts((" " * 32) + "  #{path}")
+    end
+
+    def output_file(path)
+      d = Digest::MD5.new
+
+      File.open(path) do |f|
+        while buf = f.read(1024*1024*10)
+          d << buf
+        end
+      end
+
+      @output.puts "#{d.hexdigest}: #{path}"
+    end
+    
+    def excluded?(path)
+      @excludes.each do |exclusion|
+        if exclusion.match(path)
+          return true
+        end
+      end
+      
+      return false
+    end
+
+    def process
+      for dir in @dirs
+        Dir.chdir(dir) do
+          Find.find("./") do |path|
+            if FileTest.directory?(path)
+              if excluded?(path)
+                Find.prune # Ignore this directory
+              else
+                output_dir(path)
+              end
+            else
+              output_file(path) unless excluded?(path)
+            end
+          end
+        end # Dir.chdir
+      end
+    end
+    
+    attr :output, true
+    
+    def self.scan_dirs(dirs, output = $stdout)
+      scanner = Scanner.new(dirs)
+      scanner.output = output
+      
+      scanner.process
+    end
+  end
+end

data/lib/fingerprint/version.rb

@@ -0,0 +1,24 @@
+# Copyright (c) 2010 Samuel Williams. Released under the GNU GPLv3.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module Fingerprint
+  module VERSION #:nodoc:
+    MAJOR = 1
+    MINOR = 0
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: fingerprint
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Samuel Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-20 00:00:00 +13:00
+default_executable: fingerprint
+dependencies: []
+
+description: 
+email: samuel@oriontransfer.org
+executables: 
+- fingerprint
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- bin/fingerprint
+- lib/fingerprint/checker.rb
+- lib/fingerprint/scanner.rb
+- lib/fingerprint/version.rb
+- lib/fingerprint.rb
+has_rdoc: true
+homepage: http://www.oriontransfer.co.nz/software/admin-toolbox/fingerprint
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Fingerprint is a tool for creating checksums of entire directory structures, and comparing them for inconsistencies.
+test_files: []
+