lsync 1.2.5 → 2.0.2

data/README.md

@@ -0,0 +1,51 @@
+LSync
+=====
+
+* Author: Samuel G. D. Williams (<http://www.oriontransfer.co.nz>)
+* Copyright (C) 2009, 2011 Samuel G. D. Williams.
+* Released under the MIT license.
+
+LSync is a tool for scripted synchronization and backups. It provides a custom Ruby
+DSL for describing complex backup and synchronization tasks. It is designed to give
+maximum flexibility while reducing the complexity of describing complex multi-server
+setups.
+
+* Single and multi-server data synchronization.
+* Incremental backups both locally and remotely.
+* Backup staging and coordination.
+* Backup verification using `Fingerprint`.
+* Data backup redundancy controlled via DNS.
+
+For examples please see the main [project page][1].
+
+[1]: http://www.oriontransfer.co.nz/gems/lsync
+
+Overview
+--------
+
+LSync imposes a particular structure regarding the organisation of backup scripts:
+Backup scripts involve a set of servers and directories. A server is a logical unit 
+where files are available or stored. Directories are specific places within servers.
+
+License
+-------
+
+Copyright (c) 2009, 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+
+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.

data/lib/lsync.rb

@@ -15,21 +15,13 @@
 
 require 'rubygems'
 
-gem 'termios'
-gem 'net-ssh'
-gem 'ruleby'
-
 require 'yaml'
 require 'socket'
 require 'set'
 require 'logger'
 
 require 'lsync/version'
-require 'lsync/extensions'
-
 require 'lsync/script'
-require 'lsync/plan'
-
 require 'lsync/tee_logger'
 
 require 'fileutils'
@@ -38,19 +30,4 @@ require 'optparse'
 require 'open-uri'
 
 module LSync
-	class InvalidConfigurationPath < StandardError
-	end
-	
-	def self.load_from_file(path)
-		path = Pathname.new(path)
-		
-		case path.extname
-		when ".lsync-script"
-			return Script.load_from_file(path)
-		when ".lsync-plan"
-			return Plan.load_from_file(path)
-		else
-			raise InvalidConfigurationPath.new(path)
-		end
-	end
 end

data/lib/lsync/action.rb

@@ -4,97 +4,102 @@ require 'lsync/run'
 require 'lsync/error'
 
 module LSync
-  
-  class AbortBackupException < Exception
-    
-  end
-  
-  class Action
-    def initialize(function)
-      @function = function
-      
-      if @function.match(/^\%([a-z]+)(\s+.*)?$/)
-        @script_name = $1
-        @arguments = $2
-      else
-        @script_name = nil
-      end
-    end
-    
-    def to_s
-      @function
-    end
-    
-    def run_on_server(server, logger)
-      logger.info "Running #{@function} on #{server}"
-      
-      if server.is_local?
-        run_locally(server, logger)
-      else
-        run_remotely(server, logger)
-      end
-    end
-    
-  private
-    def run_locally(server, logger)
-      command = nil
-      
-      if @script_name
-        uname = `uname`.chomp.downcase
-        
-        local_path = Action.script_path(uname, @script_name)
-        command = local_path.to_cmd + @arguments
-      else
-        command = @function
-      end
-      
-      ret = nil
-      Dir.chdir(server.root_path) do
-        ret = LSync.run_command(command, logger)
-      end
-      
-      case(ret)
-      when 0
-        return
-      when 1
-        raise AbortBackupException
-      else
-        raise BackupActionError
-      end
-    end
-    
-    def run_remotely(server, logger)
-      conn = server.connect
-      conn.send_object([:set_working_dir, server.root_path])
-      
-      if @script_name
-        uname = `uname`.chomp.downcase
-
-        local_path = Action.script_path(uname, @script_name)
-        
-        logger.info("Sending run_script #{@script_name}...")
-        conn.send_object([:run_script, @script_name, Pathname.new(local_path).read, @arguments])
-      else
-        logger.info("Sending run_command #{@function}...")
-        conn.send_object([:run_command, @function])
-      end
-      
-      conn.run do |message|
-        break if message == :done
-        
-        logger.send(*message)
-      end
-    end
-    
-    def self.script_path(platform, name)
-      exact_script_path(platform, name) || exact_script_path("generic", name)
-    end
-    
-    private
-    def self.exact_script_path(platform, name)
-      path = (Pathname.new(__FILE__).dirname + "actions" + platform + name).expand_path
-      path.exist? ? path : nil
-    end
-  end
+
+	class AbortBackupException < StandardError
+	end
+	
+	# A runnable action, such as a shell command or action script.
+	#
+	# If the first argument is a symbol, then this will map to one of the standard
+	# actions in the `lsync/actions` subdirectory. These actions are sometimes implemented
+	# on a per-platform basis.
+	class Action
+		def initialize(function)
+			@function = function
+			
+			case @function[0]
+			when Symbol
+				@script_name = @function[0].to_s
+				@arguments = @function[1,@function.size]
+			else
+				@script_name = nil
+			end
+		end
+
+		# Return a string representation of the action for logging.
+		def to_s
+			@function.to_cmd
+		end
+
+		# Run the action on the given server, typically in the root directory specified.
+		def run_on_server(server, logger)
+			# logger.info "Running #{@function.to_cmd} on #{server}"
+
+			if server.is_local?
+				run_locally(server, logger)
+			else
+				run_remotely(server, logger)
+			end
+		end
+
+		private
+		# Run the script locally by invoking it directly.
+		def run_locally(server, logger)
+			command = nil
+
+			if @script_name
+				uname = `uname`.chomp.downcase
+
+				local_path = Action.script_path(uname, @script_name)
+				command = [local_path] + @arguments
+			else
+				command = @function
+			end
+
+			result = nil
+			Dir.chdir(server.root) do
+				result = LSync.run_command(command, logger)
+			end
+
+			if result != 0
+				raise ShellScriptError.new(command, result)
+			end
+		end
+
+		# Run the script remotely by sending the data across the network and executing it.
+		def run_remotely(server, logger)
+			conn = server.connect
+			conn.send_object([:set_working_dir, server.root])
+
+			if @script_name
+				uname = `uname`.chomp.downcase
+
+				local_path = Action.script_path(uname, @script_name)
+
+				logger.info("Sending run_script #{@script_name}...")
+				conn.send_object([:run_script, @script_name, Pathname.new(local_path).read, @arguments])
+			else
+				logger.info("Sending run_command #{@function}...")
+				conn.send_object([:run_command, @function])
+			end
+
+			conn.run do |message|
+				break if message == :done
+
+				logger.send(*message)
+			end
+		end
+
+		# Figure out the path of the script, which may depend on the given platform.
+		def self.script_path(platform, name)
+			exact_script_path(platform, name) || exact_script_path("generic", name)
+		end
+
+		# Return the exact path of a builtin action script.
+		def self.exact_script_path(platform, name)
+			path = (Pathname.new(__FILE__).dirname + "actions" + platform + name).expand_path
+			path.exist? ? path : nil
+		end
+	end
 
 end

data/lib/lsync/actions/darwin/disk

@@ -5,15 +5,15 @@ action = ARGV[0]
 disk_name = ARGV[1]
 
 def get_disk_id(name)
-  begin
-	  `diskutil list`.match(/#{name}\s*\*?[0-9]+\.[0-9]+ .B\s+(disk[0-9]s[0-9])$/)[1]
+	begin
+		`diskutil list`.match(/#{name}\s*\*?[0-9]+\.[0-9]+ .B\s+(disk[0-9]s[0-9])$/)[1]
 	rescue
-	  exit 5
-  end
+		exit 5
+	end
 end
 
 if (action == 'mountpoint')
 	puts File.join('', 'Volumes', disk_name, ARGV[2..-1])
 else
-  system DISKUTIL, action, get_disk_id(disk_name)
+	system DISKUTIL, action, get_disk_id(disk_name)
 end

data/lib/lsync/actions/generic/prune

@@ -26,6 +26,23 @@ class Rotation
 	def <=> other
 		return other.time <=> @time
 	end
+	
+	def eql? other
+		case other
+		when Rotation
+			@path.eql?(other.path) # && @time.eql?(other.time)
+		else
+			@path.eql?(other.to_s)
+		end
+	end
+	
+	def hash
+		@path.hash
+	end
+	
+	def to_s
+		@path
+	end
 end
 
 class Period
@@ -160,7 +177,7 @@ ARGV.options do |o|
 	o.on("--dry-run", "Print out what would be deleted, but don't actually delete anything.") do
 		OPTIONS[:Wet] = false
 	end
-	
+
 	o.on("-l latest", String, "Specify the symlink name that points to the latest backup, so it won't be deleted.")
 
 	o.separator ""
@@ -225,7 +242,7 @@ end.parse!
 
 backups = []
 
-Dir.chdir(OPTIONS[:Destination]) do 
+Dir.chdir(OPTIONS[:Destination]) do
 	Dir["*"].each do |path|
 		next if path.match(OPTIONS[:Latest])
 		date_string = File.basename(path)
@@ -240,12 +257,17 @@ Dir.chdir(OPTIONS[:Destination]) do
 	keep, erase = OPTIONS[:Policy].filter(backups)
 
 	# We need to retain the latest backup regardless of policy
-	if OPTIONS[:Latest]
-		latest_backup = Pathname.new(OPTIONS[:Latest]).realpath.basename.to_s
-		puts "Retaining latest backup #{latest_backup}"
-		erase.delete(latest_backup)
+	if OPTIONS[:Latest] && File.exist?(OPTIONS[:Latest])
+		path = Pathname.new(OPTIONS[:Latest]).realpath.basename.to_s
+		latest_rotation = erase.find { |rotation| rotation.path == path }
+
+		if latest_rotation
+			puts "Retaining latest backup #{latest_rotation}"
+			erase.delete(latest_rotation)
+			keep << latest_rotation
+		end
 	end
-	
+
 	if OPTIONS[:Wet]
 		erase.sort.each do |backup|
 			puts "Erasing #{backup.path}..."

data/lib/lsync/actions/generic/rotate

@@ -9,66 +9,78 @@ require 'fileutils'
 require 'optparse'
 
 OPTIONS = {
-  :Format => "%Y.%m.%d-%H.%M.%S",
-  :Latest => "latest",
-  :UseGMT => true,
-  :Destination => nil
+	:Format => "%Y.%m.%d-%H.%M.%S",
+	:Latest => "latest",
+	:UseGMT => true,
+	:Destination => nil
 }
 
 ARGV.options do |o|
-  script_name = File.basename($0)
-
-  o.set_summary_indent('  ')
-  o.banner = "Usage: #{script_name} [options] [directory]"
-  o.define_head "This script is used to rotate directories."
-
-  o.separator ""
-  o.separator "Help and Copyright information"
-
-  o.on("-f format", String, "Set the format of the rotated directory names. See Time$strftime") do |format| 
-    OPTIONS[:Format] = format
-  end
-  
-  o.on("-l latest", String, "Set the name for the latest rotation symlink.") do |latest|
-    OPTIONS[:Latest] = latest
-  end
-
-  o.on("-d destination", String, "Set the directory to move rotated backups.") do |destination|
-    OPTIONS[:Destination] = destination
-  end
-
-  o.on_tail("--copy", "Display copyright information") do
-    puts "#{script_name}. Copyright (c) 2008-2009 Samuel Williams. Released under the GPLv3."
-    puts "See http://www.oriontransfer.co.nz/ for more information."
-
-    exit
-  end
-
-  o.on_tail("-h", "--help", "Show this help message.") do
-    puts o
-    exit
-  end
+	script_name = File.basename($0)
+
+	o.set_summary_indent('  ')
+	o.banner = "Usage: #{script_name} [options] [directory]"
+	o.define_head "This script is used to rotate directories."
+
+	o.separator ""
+	o.separator "Help and Copyright information"
+
+	o.on("-f format", String, "Set the format of the rotated directory names. See Time$strftime") do |format| 
+		OPTIONS[:Format] = format
+	end
+
+	o.on("-l latest", String, "Set the name for the latest rotation symlink.") do |latest|
+		OPTIONS[:Latest] = latest
+	end
+
+	o.on("-d destination", String, "Set the directory to move rotated backups.") do |destination|
+		OPTIONS[:Destination] = destination
+	end
+
+	o.on_tail("--copy", "Display copyright information") do
+		puts "#{script_name}. Copyright (c) 2008-2009 Samuel Williams. Released under the GPLv3."
+		puts "See http://www.oriontransfer.co.nz/ for more information."
+
+		exit
+	end
+
+	o.on_tail("-h", "--help", "Show this help message.") do
+		puts o
+		exit
+	end
 end.parse!
 
 time = Time.now
 
 if OPTIONS[:UseUTC]
-  time = time.utc
+	time = time.utc
 end
 
-dir = Pathname.new(ARGV[0] || ".inprogress")
+dir = Pathname.new(ARGV[0] || "backup.inprogress")
 rotation_dir = Pathname.new(OPTIONS[:Destination] ? OPTIONS[:Destination] : dir.dirname)
 rotated_name = time.strftime(OPTIONS[:Format])
 rotated_dir = rotation_dir + rotated_name
 latest_link = rotation_dir + OPTIONS[:Latest]
 
+unless File.exist? dir
+	$stderr.puts "Can not find source directory to rotate: #{dir} in #{Dir.getwd}!"
+	exit(10)
+end
+
+if File.exist? rotated_dir
+	$stderr.puts "Destination rotation name #{rotated_dir} already exists in #{Dir.getwd}!"
+	exit(20)
+end
+
+puts "Rotating #{dir} to #{rotated_dir}..."
+
 # Move rotated dir
 FileUtils.mv(dir, rotated_dir)
 
 # Recreate latest symlink
 if File.symlink?(latest_link)
-  puts "Removing old latest link..."
-  FileUtils.rm(latest_link)
+	puts "Removing old latest link..."
+	FileUtils.rm(latest_link)
 end
 
 puts "Creating latest symlink to #{rotated_name}"