fingerprint 1.3.1 → 3.1.0

data/lib/fingerprint/find.rb

@@ -0,0 +1,40 @@
+# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'find'
+require 'build/files/path'
+require 'build/files/system'
+
+module Fingerprint
+	module Find
+		def self.find(root)
+			# Ensure root is a directory:
+			root += File::SEPARATOR unless root.end_with?(File::SEPARATOR)
+			
+			::Find.find(root) do |path|
+				yield Build::Files::Path.new(path, root)
+			end
+		end
+		
+		def self.prune
+			::Find.prune
+		end
+	end
+end

data/lib/fingerprint/record.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# Copyright, 2011, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -25,6 +25,7 @@ module Fingerprint
 	MODES = {
 		:configuration => 'C',
 		:file => 'F',
+		:link => 'L',
 		:directory => 'D',
 		:summary => 'S',
 		:warning => 'W',
@@ -67,7 +68,7 @@ module Fingerprint
 			options = {}
 			
 			options[:extended] = true if @metadata['options.extended'] == 'true'
-			options[:checksum] = @metadata['options.checksums'].split(/[\s,]+/) if @metadata['options.checksums']
+			options[:checksums] = @metadata['options.checksums'].split(/[\s,]+/) if @metadata['options.checksums']
 			
 			return options
 		end
@@ -83,12 +84,22 @@ module Fingerprint
 		end
 	end
 	
-	class Recordset
+	class RecordSet
+		def self.load_file(path)
+			File.open(path, "r") do |io|
+				self.load(io)
+			end
+		end
+		
+		def self.load(io)
+			self.new.tap{|record_set| record_set.parse(io)}
+		end
+		
 		def initialize
 			@records = []
 			@paths = {}
 			@keys = {}
-
+			
 			@configuration = nil
 
 			@callback = nil
@@ -107,22 +118,30 @@ module Fingerprint
 				@configuration = record
 			else
 				@paths[record.path] = record
-				record.keys.each do |key, value|
-					@keys[key] = value
+				record.keys.each do |key|
+					@keys[key] ||= {}
+					
+					@keys[key][record[key]] = record
 				end
 			end
 		end
 
+		def include?(path)
+			@paths.include?(path)
+		end
+		
+		def empty?
+			@paths.empty?
+		end
+
 		def lookup(path)
 			return @paths[path]
 		end
 
-		def find(record)
-			result = lookup(record.path)
-
-			return result if result
-
-			@record.keys.each do |key, value|
+		def find_by_key(record)
+			record.keys.each do |key|
+				value = record[key]
+				
 				result = @keys[key][value]
 
 				return result if result
@@ -131,6 +150,14 @@ module Fingerprint
 			return nil
 		end
 
+		def find(record)
+			result = lookup(record.path)
+
+			return result if result
+
+			return find_by_key(record)
+		end
+
 		def compare(other)
 			main = lookup(other.path)
 
@@ -218,7 +245,7 @@ module Fingerprint
 	end
 	
 	# This record set dynamically computes data from the disk as required.
-	class SparseRecordset < Recordset
+	class SparseRecordSet < RecordSet
 		def initialize(scanner)
 			super()
 			
@@ -234,7 +261,7 @@ module Fingerprint
 		end
 	end
 	
-	class RecordsetWrapper
+	class RecordSetWrapper
 		def initialize(recordset)
 			@recordset = recordset
 		end
@@ -248,7 +275,7 @@ module Fingerprint
 		end
 	end
 	
-	class RecordsetPrinter < RecordsetWrapper
+	class RecordSetPrinter < RecordSetWrapper
 		def initialize(recordset, output)
 			super(recordset)
 			@output = output
@@ -256,7 +283,7 @@ module Fingerprint
 
 		def <<(record)
 			record.write(@output)
-			@recordset << record
+			@recordset << record if @recordset
 		end
 	end
 end

data/lib/fingerprint/scanner.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# Copyright, 2011, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -19,28 +19,33 @@
 # THE SOFTWARE.
 
 require 'stringio'
-require 'find'
 require 'etc'
 require 'digest/sha2'
 
-module Fingerprint
+require_relative 'find'
+require_relative 'record'
+require_relative 'version'
 
+module Fingerprint
+	INDEX_FINGERPRINT = "index.fingerprint"
+	
 	CHECKSUMS = {
 		'MD5' => lambda { Digest::MD5.new },
 		'SHA1' => lambda { Digest::SHA1.new },
 		'SHA2.256' => lambda { Digest::SHA2.new(256) },
+		'SHA2.384' => lambda { Digest::SHA2.new(384) },
 		'SHA2.512' => lambda { Digest::SHA2.new(512) },
 	}
 
-	DEFAULT_CHECKSUMS = ['MD5', 'SHA2.256']
+	DEFAULT_CHECKSUMS = ['SHA2.256']
 
 	# The scanner class can scan a set of directories and produce an index.
 	class Scanner
 		# Initialize the scanner to scan a given set of directories in order.
 		# [+options[:excludes]+]  An array of regular expressions of files to avoid indexing.
 		# [+options[:output]+]    An +IO+ where the results will be written.
-		def initialize(roots, options = {})
-			@roots = roots
+		def initialize(roots, pwd: Dir.pwd, **options)
+			@roots = roots.collect{|root| File.expand_path(root, pwd)}
 
 			@excludes = options[:excludes] || []
 			@options = options
@@ -71,7 +76,7 @@ module Fingerprint
 				'options.extended' => @options[:extended] == true,
 				'options.checksums' => @options[:checksums].join(', '),
 				'summary.time.start' => Time.now,
-				'fingerprint.version' => Fingerprint::VERSION::STRING
+				'fingerprint.version' => Fingerprint::VERSION
 			})
 		end
 
@@ -84,14 +89,14 @@ module Fingerprint
 			end
 
 			File.open(path, "rb") do |file|
-				buf = ""
-				while file.read(1024 * 1024 * 10, buf)
-					total += buf.size
+				buffer = ""
+				while file.read(1024 * 1024 * 10, buffer)
+					total += buffer.bytesize
 					
 					@progress.call(total) if @progress
 					
 					@digests.each do |key, digest|
-						digest << buf
+						digest << buffer
 					end
 				end
 			end
@@ -106,35 +111,61 @@ module Fingerprint
 		end
 
 		def metadata_for(type, path)
-			stat = File.stat(path)
 			metadata = {}
+			
+			if type == :link
+				metadata['file.symlink'] = File.readlink(path)
+			else
+				stat = File.stat(path)
+
+				if type == :file
+					metadata['file.size'] = stat.size
+					digests = digests_for(path)
+					metadata.merge!(digests)
+				elsif type == :blockdev or type == :chardev
+					metadata['file.dev_major'] = stat.dev_major
+					metadata['file.dev_minor'] = stat.dev_minor
+				end
 
-			if type == :file
-				metadata['file.size'] = stat.size
-				digests = digests_for(path)
-				metadata.merge!(digests)
-			end
-
-			# Extended information
-			if @options[:extended]
-				metadata['posix.time.modified'] = File.mtime(path)
+				# Extended information
+				if @options[:extended]
+					metadata['posix.time.modified'] = File.mtime(path)
 
-				metadata['posix.mode'] = stat.mode.to_s(8)
+					metadata['posix.mode'] = stat.mode.to_s(8)
 
-				metadata['posix.permissions.user.id'] = stat.uid
-				metadata['posix.permissions.user.name'] = Etc.getpwuid(stat.uid).name
-				metadata['posix.permissions.group.id'] = stat.gid
-				metadata['posix.permissions.group.name'] = Etc.getgrgid(stat.gid).name
+					metadata['posix.permissions.user.id'] = stat.uid
+					metadata['posix.permissions.user.name'] = Etc.getpwuid(stat.uid).name
+					metadata['posix.permissions.group.id'] = stat.gid
+					metadata['posix.permissions.group.name'] = Etc.getgrgid(stat.gid).name
+				end
 			end
-
+			
 			return metadata
 		end
 		
 		# Output a directory header.
 		def directory_record_for(path)
-			Record.new(:directory, path, metadata_for(:directory, path))
+			Record.new(:directory, path.relative_path, metadata_for(:directory, path))
 		end
 
+		def link_record_for(path)
+			metadata = metadata_for(:link, path)
+			
+			Record.new(:link, path.relative_path, metadata)
+		end
+		
+		def blockdev_record_for(path)
+			metadata = metadata_for(:blockdev, path)
+			
+			Record.new(:blockdev, path.relative_path, metadata)
+		end
+		
+		def chardev_record_for(path)
+			metadata = metadata_for(:chardev, path)
+			
+			Record.new(:chardev, path.relative_path, metadata)
+		end
+		
 		# Output a file and associated metadata.
 		def file_record_for(path)
 			metadata = metadata_for(:file, path)
@@ -142,12 +173,30 @@ module Fingerprint
 			# Should this be here or in metadata_for?
 			# metadata.merge!(digests_for(path))
 			
-			Record.new(:file, path, metadata)
+			Record.new(:file, path.relative_path, metadata)
 		end
 
 		# Add information about excluded paths.
 		def excluded_record_for(path)
-			Record.new(:excluded, path)
+			Record.new(:excluded, path.relative_path)
+		end
+
+		def record_for(path)
+			stat = File.stat(path)
+			
+			if stat.symlink?
+				return link_record_for(path)
+			elsif stat.blockdev?
+				return blockdev_record_for(path)
+			elsif stat.chardev?
+				return chardev_record_for(path)
+			elsif stat.socket?
+				return socket_record_for(path)
+			elsif stat.file?
+				return file_record_for(path)
+			end
+		rescue Errno::ENOENT
+			return nil
 		end
 
 		public
@@ -163,17 +212,13 @@ module Fingerprint
 			return false
 		end
 
-		def valid_file?(path)
-			!(excluded?(path) || File.symlink?(path) || !File.file?(path) || !File.readable?(path))
-		end
-
 		def scan_path(path)
+			return nil if excluded?(path)
+			
 			@roots.each do |root|
-				Dir.chdir(root) do
-					if valid_file?(path)
-						return file_record_for(path)
-					end
-				end
+				full_path = Build::Files::Path.join(root, path)
+				
+				return record_for(full_path)
 			end
 			
 			return nil
@@ -192,23 +237,21 @@ module Fingerprint
 			# Estimate the number of files and amount of data to process..
 			if @options[:progress]
 				@roots.each do |root|
-					Dir.chdir(root) do
-						Find.find("./") do |path|
-							if @options[:progress]
-								$stderr.puts "# Scanning: #{path}"
-							end
-							
-							if File.directory?(path)
-								if excluded?(path)
-									Find.prune # Ignore this directory
-								end
-							else
-								# Skip anything that isn't a valid file (e.g. pipes, sockets, symlinks).
-								if valid_file?(path)
-									total_count += 1
-									total_size += File.size(path)
-								end
-							end
+					Find.find(root) do |path|
+						# Some special files fail here, and this was the simplest fix.
+						Find.prune unless File.exist?(path)
+						
+						if @options[:progress]
+							$stderr.puts "# Scanning: #{path}"
+						end
+						
+						if excluded?(path)
+							Find.prune if path.directory?
+						elsif path.symlink?
+							total_count += 1
+						elsif path.file?
+							total_count += 1
+							total_size += File.size(path)
 						end
 					end
 				end
@@ -221,52 +264,54 @@ module Fingerprint
 			end
 			
 			@roots.each do |root|
-				Dir.chdir(root) do
-					recordset << header_for(root)
+				recordset << header_for(root)
+				
+				Find.find(root) do |path|
+					# Some special files fail here, and this was the simplest fix.
+					Find.prune unless File.exist?(path)
 					
-					Find.find("./") do |path|
-						if @options[:progress]
-							$stderr.puts "# Path: #{path}"
-						end
+					if @options[:progress]
+						$stderr.puts "# Path: #{path.relative_path}"
+					end
+					
+					if excluded?(path)
+						excluded_count += 1
 						
-						if File.directory?(path)
-							if excluded?(path)
-								excluded_count += 1
-								
-								if @options[:verbose]
-									recordset << excluded_record_for(path)
-								end
-								
-								Find.prune # Ignore this directory
-							else
-								directory_count += 1
-								
-								recordset << directory_record_for(path)
-							end
-						else
-							# Skip anything that isn't a valid file (e.g. pipes, sockets, symlinks).
-							if valid_file?(path)
-								recordset << file_record_for(path)
-
-								processed_count += 1
-								processed_size += File.size(path)
-							else
-								excluded_count += 1
-								
-								if @options[:verbose]
-									recordset << excluded_record_for(path)
-								end
-							end
+						if @options[:verbose]
+							recordset << excluded_record_for(path)
 						end
 						
-						# Print out a progress summary if requested
-						@progress.call(0) if @progress
+						Find.prune if path.directory?
+					elsif path.directory?
+						directory_count += 1
+						
+						recordset << directory_record_for(path)
+					elsif path.symlink?
+						recordset << link_record_for(path)
+						
+						processed_count += 1
+					elsif path.file?
+						recordset << file_record_for(path)
+
+						processed_count += 1
+						processed_size += File.size(path)
+					else
+						excluded_count += 1
+						
+						if @options[:verbose]
+							recordset << excluded_record_for(path)
+						end
 					end
+					
+					# Print out a progress summary if requested
+					@progress.call(0) if @progress
 				end
 			end
+			
+			summary_message = "#{processed_count} files processed."
 
 			# Output summary
-			recordset << Record.new(:summary, nil, {
+			recordset << Record.new(:summary, summary_message, {
 				'summary.directories' => directory_count,
 				'summary.files' => processed_count,
 				'summary.size' => processed_size,
@@ -278,12 +323,18 @@ module Fingerprint
 		end
 
 		# A helper function to scan a set of directories.
-		def self.scan_paths(paths, options = {})
+		def self.scan_paths(paths, **options)
 			if options[:output]
-				options[:recordset] = RecordsetPrinter.new(Recordset.new, options[:output])
+				if options.key? :recordset
+					recordset = options[:recordset]
+				else
+					recordset = RecordSet.new
+				end
+				
+				options[:recordset] = RecordSetPrinter.new(recordset, options[:output])
 			end
 
-			scanner = Scanner.new(paths, options)
+			scanner = Scanner.new(paths, **options)
 
 			scanner.scan(options[:recordset])