fingerprint 1.4.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2c6867e9566430e12dc2d913a013c469e3b2bc47
-  data.tar.gz: 58d9a1812dcd041743816328ac3e71fc79496014
+SHA256:
+  metadata.gz: 29779cfa264198432f16e421ed412e812a464332c4499d65e6a8039d0c08522f
+  data.tar.gz: 97dc135381bfa725ab41d34fbaf58ff56a16c89bb2bb8749b1539c90abe30cd1
 SHA512:
-  metadata.gz: ac0bfcca4b51a31797849aa039c795626f78d7a5d0b5278aadbb9872b635d7ca3cd369b3cd08de77c48545ca58af4aad83ede79e99749b56e896a03b8e238e5e
-  data.tar.gz: 76f51cf43136114a35cafb99958da8e7099c98ee68a931efa7a1b853e76dc9025a2bedd6df697ebf69b7c7f47004f3616865514beea9c980d8a9e4798f7eec58
+  metadata.gz: a8f9fdb7259e57057bc10f9e412b0444393ab2bcd90d11b7091fffa40800759f2a52f7fcc25a2f8edafe8cebbc199ae6a81eb95401e2e2204f2bb28d1ab611d0
+  data.tar.gz: 418347660a6002e3e1cc5092a0e50c6d4462a034a6ccb1afe5e74f2912d2bb1d9dc3eda892fe4342a2db151d2952410461cbdde5f954fa6e881dc59e2df6d251

checksums.yaml.gz.sig

@@ -0,0 +1,4 @@
+.P�v�������m���\Q=G �ivO,����/�.>e��'\����0H���$ѭ5X�����,D���J!�����Ҝ�+*��T04mPkTR�:>F	-^��i`�/��G�w�ܺ�ź����F1A<>�J
+�?&'�.�PvqsL���W���G�Q��p[��@�M�����P�,H�q�����S	e>��u�_��K��r�� A��?�)g/�׍=��/�#����=-�R2�������a���^�,�=����> Y�����
�7;K�tA��;���D��;�	O��_�����B4�Y��ߕ�y%8sb�ͦ��x�
+�C�S��xG�
+[I�c/�[r+W>�&��Ӈ�~H E�R�K�Y"��l>:

data/bin/fingerprint

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-# Copyright (c) 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# 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
@@ -20,201 +20,10 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'optparse'
-require 'pathname'
-require 'fingerprint'
-require 'fileutils'
+# This script takes a given path, and renames it with the given format. 
+# It then ensures that there is a symlink called "latest" that points 
+# to the renamed directory.
 
-OPTIONS = {
-	:root => "./",
-	:mode => :scan,
-	:output => $stdout,
-	:verbose => false,
-	:force => false,
-	:name => "index.fingerprint",
-	:extended => false,
-	:checksums => Fingerprint::DEFAULT_CHECKSUMS,
-	:additions => false,
-	:failures => :ignore,
-}
+require_relative '../lib/fingerprint/command'
 
-ARGV.options do |o|
-	script_name = File.basename($0)
-
-	o.banner = "Usage: #{script_name} [options] [path]"
-	o.define_head "This script is used to create and compare file system fingerprints."
-
-	o.separator ""
-	o.separator "Directory analysis and verification:"
-	
-	o.on("-a", "--analyze [path]", String, "Generage a fingerprint of the given path and save it for later verification.") do |path|
-		OPTIONS[:mode] = :analyze
-		OPTIONS[:root] = path if path
-	end
-	
-	o.on("-v", "--verify [path]", String, "Verify a given path based on a previously saved fingerprint.") do |path|
-		OPTIONS[:mode] = :verify
-		OPTIONS[:root] = path if path
-	end
-	
-	o.on("-n name", String, "Specify the name of the fingerprint file.", "Default: #{OPTIONS[:name]}") do |name|
-		OPTIONS[:name] = name
-	end
-	
-	o.on("-f", "Force any operation to complete despite warnings.") do
-		OPTIONS[:force] = true
-	end
-	
-	o.separator ""
-	
-	o.on("-x", "Include additional extended information about files and directories.") do
-		OPTIONS[:extended] = true
-	end
-	
-	o.on("-s [checksum1,checksum2]", "Provide a list of the checksum algorithms to use.", "Available: #{Fingerprint::CHECKSUMS.keys.join(', ')}; Default: #{OPTIONS[:checksums].join(', ')}") do |checksums|
-		OPTIONS[:checksums] = checksums.split(/[\s,]+/)
-	end
-	
-	o.separator ""
-	o.separator "Compare fingerprints:"
-
-	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("-A", "Report files that have been added to the second fingerprint.") do
-		OPTIONS[:additions] = true
-	end
-	
-	o.separator ""
-	o.separator "Output manipulation:"
-	
-	o.on("-o [output-path]", String, "Write the fingerprint output to the given file.") do |path|
-		OPTIONS[:output] = File.open(path, "w")
-	end
-	
-	o.on("--verbose", "Verbose output, include additional details in the file transcript.") do
-		OPTIONS[:verbose] = true
-	end
-	
-	o.on("--progress", "Print percentage progress to standard error.") do
-		OPTIONS[:progress] = true
-	end
-	
-	o.on("--die", "Give a non-zero exit code if errors are detected by check or verify.") do
-		OPTIONS[:failures] = :die
-	end
-	
-	o.separator ""
-	o.separator "Help and Copyright information:"
-
-	o.on_tail("--copy", "Display copyright and warranty information") do
-		$stderr.puts "#{script_name} v#{Fingerprint::VERSION}. Copyright (c) 2011 Samuel Williams."
-		$stderr.puts "This software is released under the MIT license and comes with ABSOLUTELY NO WARRANTY."
-		$stderr.puts "See http://www.oriontransfer.co.nz/ for more information."
-		exit
-	end
-
-	o.on_tail("-h", "--help", "Show this help message.") do
-		$stderr.puts o
-		exit
-	end
-end.parse!
-
-unless File.directory? OPTIONS[:root]
-	$stderr.puts "Path #{OPTIONS[:root]} doesn't exist!"
-	exit(255)
-end
-
-if OPTIONS[:checksums].size == 0
-	OPTIONS[:checksums] = ['MD5', 'SHA2.256']
-end
-
-def finish_check(error_count)
-	if error_count == 0
-		$stderr.puts "Data verified, 0 errors found."
-		exit(0)
-	else
-		$stderr.puts "Data inconsistent, #{error_count} errors found!"
-		exit(OPTIONS[:failures] == :die ? 1 : 0)
-	end
-end
-
-case (OPTIONS[:mode])
-when :analyze
-	output_file = Pathname.new(OPTIONS[:root]) + OPTIONS[:name]
-
-	if output_file.exist? && !OPTIONS[:force]
-		$stderr.puts "Output file #{output_file} already exists. Aborting."
-		exit(2)
-	end
-
-	options = OPTIONS.dup
-	options[:excludes] = [OPTIONS[:name]]
-
-	finished = false
-	begin
-		File.open(output_file, "w") do |io|
-			options[:output] = io
-
-			Fingerprint::Scanner.scan_paths([OPTIONS[:root]], options)
-		end
-		finished = true
-	ensure
-		FileUtils.rm(output_file) unless finished
-	end		
-when :verify
-	error_count = 0
-
-	input_file = Pathname.new(OPTIONS[:root]) + OPTIONS[:name]
-
-	unless File.exist? input_file
-		$stderr.puts "Can't find index #{input_file}. Aborting."
-		exit(3)
-	end
-
-	options = OPTIONS.dup
-
-	master = Fingerprint::RecordSet.new
-
-	File.open(input_file, "r") do |io|
-		master.parse(io)
-	end
-
-	if master.configuration
-		options.merge!(master.configuration.options)
-	end
-
-	scanner = Fingerprint::Scanner.new([OPTIONS[:root]], options)
-	copy = Fingerprint::SparseRecordSet.new(scanner)
-
-	error_count += Fingerprint::Checker::verify(master, copy, options)
-
-	finish_check(error_count)
-when :scan
-	roots = ARGV
-	roots << Dir.pwd if roots.size == 0
-
-	# Check that all supplied paths exist
-	roots.delete_if do |root|
-		if File.exist? root
-			false
-		else
-			$stderr.puts "Path #{root} doesn't exist, skipping!"
-			true
-		end
-	end
-
-	options = OPTIONS.dup
-
-	# Discard output once it has been written to disk:
-	options[:recordset] = nil
-
-	Fingerprint::Scanner.scan_paths(roots, options)
-when :check
-	options = OPTIONS.dup
-
-	error_count = Fingerprint::Checker.check_files(ARGV[0], ARGV[1], options)
-
-	finish_check(error_count)
-end
+Fingerprint::Command.call

data/lib/fingerprint/checker.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
@@ -18,7 +18,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'fingerprint/record'
+require_relative 'record'
 
 module Fingerprint
 	# Given two fingerprints (master and copy) ensures that the copy has at least everything contained
@@ -31,7 +31,7 @@ module Fingerprint
 	#
 	# Master and copy are +IO+ objects corresponding to the output produced by +Fingerprint::Scanner+.
 	class Checker
-		def initialize(master, copy, options = {})
+		def initialize(master, copy, **options)
 			@master = master
 			@copy = copy
 			
@@ -42,7 +42,7 @@ module Fingerprint
 		attr :copy
 
 		# Run the checking process.
-		def check (&block)
+		def check(&block)
 			# For every file in the src, we check that it exists
 			# in the destination:
 			total_count = @master.records.count
@@ -77,7 +77,7 @@ module Fingerprint
 				end
 				
 				if @options[:progress]
-					$stderr.puts "# Progress: File #{processed_count} / #{total_count}; Byte #{processed_size} / #{total_size} = #{sprintf('%0.2f%', processed_size.to_f / total_size.to_f * 100.0)}"
+					$stderr.puts "# Progress: File #{processed_count} / #{total_count}; Byte #{processed_size} / #{total_size} = #{sprintf('%0.2f%%', processed_size.to_f / total_size.to_f * 100.0)}"
 
 					processed_size += (record['file.size'] || 0).to_i
 				end
@@ -95,7 +95,7 @@ module Fingerprint
 		# A list of files which either did not exist in the copy, or had the wrong checksum.
 		attr :failures
 
-		def self.check_files(master, copy, options = {}, &block)
+		def self.check_files(master, copy, **options, &block)
 			# New API that takes two RecordSets...
 			
 			File.open(master) do |master_file|
@@ -106,13 +106,13 @@ module Fingerprint
 					copy_recordset = RecordSet.new
 					copy_recordset.parse(copy_file)
 
-					verify(master_recordset, copy_recordset, options, &block)
+					verify(master_recordset, copy_recordset, **options, &block)
 				end
 			end
 		end
 
 		# Helper function to check two fingerprint files.
-		def self.verify(master, copy, options = {}, &block)
+		def self.verify(master, copy, **options, &block)
 			error_count = 0 
 
 			errors = options.delete(:recordset) || RecordSet.new
@@ -120,7 +120,7 @@ module Fingerprint
 				errors = RecordSetPrinter.new(errors, options[:output])
 			end
 
-			checker = Checker.new(master, copy, options)
+			checker = Checker.new(master, copy, **options)
 
 			checker.check do |record, result, message|
 				error_count += 1

data/lib/fingerprint/checksums.rb

@@ -0,0 +1,33 @@
+# 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.
+
+# This script takes a given path, and renames it with the given format. 
+# It then ensures that there is a symlink called "latest" that points 
+# to the renamed directory.
+
+require 'samovar'
+
+module Fingerprint
+	module Checksums
+		def self.call(result)
+			result.split(/\s*,\s*/)
+		end
+	end
+end

data/lib/fingerprint/command/analyze.rb

@@ -0,0 +1,74 @@
+# 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.
+
+# This script takes a given path, and renames it with the given format. 
+# It then ensures that there is a symlink called "latest" that points 
+# to the renamed directory.
+
+require 'samovar'
+require 'fileutils'
+
+require_relative '../checksums'
+require_relative '../scanner'
+require_relative '../record'
+
+module Fingerprint
+	module Command
+		class Analyze < Samovar::Command
+			self.description = "Generates a fingerprint for the specified paths and saves it."
+			
+			options do
+				option "-n/--name <name>", "The fingerprint file name.", default: INDEX_FINGERPRINT
+				
+				option "-f/--force", "Force all operations to complete despite warnings."
+				option "-x/--extended", "Include extended information about files and directories."
+				option "-s/--checksums <SHA2.256>", "Specify what checksum algorithms to use: #{CHECKSUMS.keys.join(', ')}.", default: DEFAULT_CHECKSUMS, type: Checksums
+				
+				option "--progress", "Print structured progress to standard error."
+				option "--verbose", "Verbose fingerprint output, e.g. excluded paths."
+			end
+			
+			many :paths, "Paths relative to the root to use for verification, or pwd if not specified.", default: ["./"]
+			
+			def call
+				output_file = @options[:name]
+
+				if File.exist?(output_file) and !@options[:force]
+					abort "Output file #{output_file} already exists. Aborting."
+				end
+
+				options = @options.dup
+				options[:excludes] = [File.expand_path(options[:name], Dir.pwd)]
+
+				finished = false
+				begin
+					File.open(output_file, "w") do |io|
+						options[:output] = io
+
+						Scanner.scan_paths(@paths, **options)
+					end
+					finished = true
+				ensure
+					FileUtils.rm(output_file) unless finished
+				end	
+			end
+		end
+	end
+end

data/lib/fingerprint/command/compare.rb

@@ -0,0 +1,55 @@
+# 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.
+
+# This script takes a given path, and renames it with the given format. 
+# It then ensures that there is a symlink called "latest" that points 
+# to the renamed directory.
+
+require 'samovar'
+
+module Fingerprint
+	module Command
+		class Compare < Samovar::Command
+			self.description = "Compare two fingerprints and report additions, removals and changes."
+			
+			options do
+				option "-x/--extended", "Include extended information about files and directories."
+				option "-a/--additions", "Report files that have been added to the copy."
+				option "--fail-on-errors", "Exit with non-zero status if errors are encountered."
+				
+				option "--progress", "Print structured progress to standard error."
+			end
+			
+			one :master, "The fingerprint which represents the original data."
+			one :copy,  "The fingerprint which represents a copy of the data."
+			
+			def call
+				options = @options.dup
+				options[:output] = @parent.output
+				
+				error_count = Checker.check_files(@master, @copy, **options)
+
+				if @options[:fail_on_errors]
+					abort "Data inconsistent, #{error_count} error(s) found!" if error_count != 0
+				end
+			end
+		end
+	end
+end

data/lib/fingerprint/command/duplicates.rb

@@ -0,0 +1,98 @@
+# 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.
+
+# This script takes a given path, and renames it with the given format. 
+# It then ensures that there is a symlink called "latest" that points 
+# to the renamed directory.
+
+require 'samovar'
+
+module Fingerprint
+	module Command
+		class Duplicates < Samovar::Command
+			self.description = "Efficiently find duplicates in a given fingerprint."
+			
+			options do
+				option "-i/--inverse", "Invert the output, i.e. show files which are not duplicates."
+				option "-x/--extended", "Include extended information about files and directories."
+				
+				option "--verbose", "Verbose output, e.g. what is happening."
+			end
+			
+			one :master, "The source fingerprint which represents the primarily file list."
+			many :copies, "Zero or more fingerprints which might contain duplicates.", default: []
+			
+			attr :duplicates_recordset
+			
+			def call
+				@options[:output] = @parent.output
+				
+				@duplicates_recordset = RecordSet.new
+				results = RecordSetPrinter.new(duplicates_recordset, @options[:output])
+				
+				master_file_path = @master
+				File.open(master_file_path) do |master_file|
+					master_recordset = RecordSet.new
+					master_recordset.parse(master_file)
+					
+					ignore_similar = false
+					
+					copy_file_paths = @copies
+					
+					if copy_file_paths.size == 0
+						copy_file_paths = [master_file_path]
+						ignore_similar = true
+					end
+					
+					copy_file_paths.each do |copy_file_path|
+						File.open(copy_file_path) do |copy_file|
+							copy_recordset = RecordSet.new
+							copy_recordset.parse(copy_file)
+							
+							copy_recordset.records.each do |record|
+								record.metadata['fingerprint'] = copy_file_path
+								# We need to see if the record exists in the master
+								
+								if @options[:verbose]
+									$stderr.puts "Checking #{record.inspect}"
+								end
+								
+								main_record = master_recordset.find_by_key(record)
+								
+								# If we are scanning the same index, don't print out every file, just those that are duplicates within the single file.
+								if ignore_similar && main_record && (main_record.path == record.path)
+									main_record = nil
+								end
+								
+								if main_record
+									record.metadata['original.path'] = main_record.path
+									record.metadata['original.fingerprint'] = master_file_path
+									results << record if !@options[:inverse]
+								else
+									results << record if @options[:inverse]
+								end
+							end
+						end
+					end
+				end
+			end
+		end
+	end
+end

data/lib/fingerprint/command/scan.rb

@@ -0,0 +1,61 @@
+# 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.
+
+# This script takes a given path, and renames it with the given format. 
+# It then ensures that there is a symlink called "latest" that points 
+# to the renamed directory.
+
+require 'samovar'
+
+require_relative '../checksums'
+require_relative '../scanner'
+require_relative '../record'
+
+module Fingerprint
+	module Command
+		class Scan < Samovar::Command
+			self.description = "Generate a fingerprint from the given paths."
+			
+			options do
+				option "-p/--path <path>", "Analyze the given path relative to root.", default: "./"
+				
+				option "-x/--extended", "Include extended information about files and directories."
+				option "-s/--checksums <SHA2.256>", "Specify what checksum algorithms to use: #{CHECKSUMS.keys.join(', ')}.", default: DEFAULT_CHECKSUMS, type: Checksums
+				
+				option "--progress", "Print structured progress to standard error."
+				option "--verbose", "Verbose fingerprint output, e.g. excluded paths."
+			end
+			
+			many :paths, "Paths to scan."
+			
+			def call
+				@paths = [Dir.pwd] unless @paths
+				
+				options = @options.dup
+				
+				# This configuration ensures that the output is printed to $stdout.
+				options[:output] = @parent.output
+				options[:recordset] = nil
+				
+				Scanner.scan_paths(@paths, **options)
+			end
+		end
+	end
+end