lsync 2.1.0 → 2.3.1

data/lib/lsync/error.rb

@@ -1,3 +1,22 @@
+# Copyright (c) 2007, 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.
 
 module LSync
 

data/lib/lsync/event_handler.rb

@@ -1,3 +1,22 @@
+# Copyright (c) 2007, 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.
 
 module LSync
 	
@@ -12,13 +31,21 @@ module LSync
 		end
 
 		# Fire an event which calls all registered event handlers in the order they were defined.
+		# The first argument is used to #instance_eval any handlers.
 		def fire(event, *args)
 			handled = false
 			
+			scope = args.shift
+			
 			if @events && @events[event]
 				@events[event].each do |handler|
 					handled = true
-					handler.call(*args)
+
+					if scope
+						scope.instance_eval &handler
+					else
+						handler.call
+					end
 				end
 			end
 			

data/lib/lsync/event_timer.rb

@@ -1,3 +1,22 @@
+# Copyright (c) 2007, 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.
 
 require 'thread'
 

data/lib/lsync/method.rb

@@ -1,3 +1,22 @@
+# Copyright (c) 2007, 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.
 
 require 'fileutils'
 require 'pathname'
@@ -11,15 +30,12 @@ module LSync
 		include EventHandler
 		
 		def initialize(options = {})
-			@logger = options[:logger] || Logger.new(STDOUT)
 		end
 
-		attr :logger, true
-
-		def run(master_server, target_server, directory)
+		def run(controller)
 		end
 
-		def should_run?(master_server, current_server, target_server)
+		def should_run?(controller)
 		end
 	end
 	

data/lib/lsync/methods/rsync.rb

@@ -1,3 +1,22 @@
+# Copyright (c) 2007, 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.
 
 require 'lsync/method'
 
@@ -24,63 +43,64 @@ module LSync
 			
 			def initialize(direction, options = {})
 				super(options)
+
 				@direction = direction
 				@command = options[:command] || "rsync"
-				
+
 				@options = options
 				@connection = nil
 			end
 			
-			def run(master_server, target_server, directory)
+			def run(controller)
+				directory = controller.directory
 				arguments = (@options[:arguments] || ["--archive"]) + (directory.options[:arguments] || [])
 
 				local_server = nil
 				remote_server = nil
 
 				if @direction == :push
-					local_server = master_server
-					remote_server = target_server
+					local_server = controller.master
+					remote_server = controller.target
 
-					dst = remote_server.connection_string(directory)
-					src = local_server.full_path(directory)
+					destination = remote_server.connection_string(directory)
+					source = local_server.full_path(directory)
 				else
-					local_server = target_server
-					remote_server = master_server
+					local_server = controller.target
+					remote_server = controller.master
 
-					src = remote_server.connection_string(directory)
-					dst = local_server.full_path(directory)
+					source = remote_server.connection_string(directory)
+					destination = local_server.full_path(directory)
 				end
 
 				arguments += connect_arguments(local_server, remote_server)
 
 				# Create the destination backup directory
-				@connection = target_server.connect
-				@connection.send_object([:mkdir_p, target_server.full_path(directory)])
+				controller.target.exec!(["mkdir", "-p", controller.target.full_path(directory.path)])
 
-				@logger.info "In directory #{Dir.getwd}..."
+				controller.logger.info "In directory #{Dir.getwd}..."
 				Dir.chdir(local_server.root) do
-					if run_handler(src, dst, arguments) == false
-						raise BackupMethodError.new("Backup from #{src.dump} to #{dst.dump} failed.", :method => self)
+					if run_handler(controller, source, destination, arguments) == false
+						raise BackupMethodError.new("Backup from #{source} to #{destination} failed.", :method => self)
 					end
 				end
 			end
 			
-			def run_handler(src, dst, arguments)
-				run_command([@command] + arguments + [src, dst])
+			def run_handler(controller, source, destination, arguments)
+				run_command(controller, [@command] + arguments + [source, destination])
 			end
 			
-			def should_run?(master_server, current_server, target_server)
+			def should_run?(controller)
 				if @direction == :push
-					return current_server == master_server
+					return controller.current == controller.master
 				elsif @direction == :pull
-					return target_server.is_local?
+					return controller.target.local?
 				else
 					return false
 				end
 			end
 			
-			def run_command(cmd)
-				return LSync.run_command(cmd, @logger) == 0
+			def run_command(controller, command)
+				return LSync.run_command("/", command, controller.logger) == 0
 			end
 		end
 		
@@ -89,40 +109,40 @@ module LSync
 				@options[:inprogress_path] || "backup.inprogress"
 			end
 			
-			def run(master_server, target_server, directory)
+			def run(controller)
+				directory = controller.directory
 				arguments = (@options[:arguments] || []) + (directory.options[:arguments] || [])
 				
 				link_dest = Pathname.new("../" * (directory.path.depth + 1)) + "latest" + directory.path
 				arguments += ['--archive', '--link-dest', link_dest.to_s]
 
-				dst_directory = File.join(inprogress_path, directory.to_s)
+				destination_directory = File.join(inprogress_path, directory.path)
 
 				local_server = nil
 				remote_server = nil
 
 				if @direction == :push
-					local_server = master_server
-					remote_server = target_server
+					local_server = controller.master
+					remote_server = controller.target
 
-					dst = remote_server.connection_string(dst_directory)
-					src = local_server.full_path(directory)
+					destination = remote_server.connection_string(destination_directory)
+					source = local_server.full_path(directory)
 				else
-					local_server = target_server
-					remote_server = master_server
+					local_server = controller.target
+					remote_server = controller.master
 
-					dst = local_server.full_path(dst_directory)
-					src = remote_server.connection_string(directory)
+					destination = local_server.full_path(destination_directory)
+					source = remote_server.connection_string(directory)
 				end
 
 				arguments += connect_arguments(local_server, remote_server)
 
 				# Create the destination backup directory
-				@connection = target_server.connect
-				@connection.send_object([:mkdir_p, target_server.full_path(dst_directory)])
+				controller.target.exec!(["mkdir", "-p", controller.target.full_path(destination_directory)])
 
 				Dir.chdir(local_server.root) do
-					if run_handler(src, dst, arguments) == false
-						raise BackupMethodError.new("Backup from #{src.dump} to #{dst.dump} failed.", :method => self)
+					if run_handler(controller, source, destination, arguments) == false
+						raise BackupMethodError.new("Backup from #{source} to #{destination} failed.", :method => self)
 					end
 				end
 			end

data/lib/lsync/run.rb

@@ -1,35 +1,71 @@
+# Copyright (c) 2007, 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.
 
 require 'rexec/task'
 
 module LSync
 
-	# Run a specific command and output the results to the given logger.
-	def self.run_command(command, logger)
-		logger.info "Running: #{command.to_cmd} in #{Dir.getwd.dump}"
-
-		process_result = RExec::Task.open(command) do |task|
-			task.input.close
-			pipes = [task.output, task.error]
-
-			while pipes.size > 0
-				result = IO.select(pipes)
-
-				result[0].each do |pipe|
-					if pipe.closed? || pipe.eof?
-						pipes.delete(pipe)
-						next
-					end
-
-					if pipe == task.output
-						logger.info pipe.readline.chomp
-					elsif pipe == task.error
-						logger.error pipe.readline.chomp
-					end
+	def self.log_task(task, logger)
+		pipes = [task.output, task.error]
+
+		while pipes.size > 0
+			result = IO.select(pipes)
+
+			result[0].each do |pipe|
+				if pipe.closed? || pipe.eof?
+					pipes.delete(pipe)
+					next
+				end
+
+				if pipe == task.output
+					logger.info pipe.readline.chomp
+				elsif pipe == task.error
+					logger.error pipe.readline.chomp
 				end
 			end
 		end
+	end
 
-		return process_result
+	# Run a specific command and output the results to the given logger.
+	def self.run_command(root, command, logger)
+		Dir.chdir(root) do
+			logger.info "Running #{command.inspect} in #{Dir.getwd.inspect}"
+
+			process_result = RExec::Task.open(command) do |task|
+				log_task(task, logger)
+			end
+
+			return process_result
+		end
 	end
 
+	def self.run_remote_command(root, connection_command, command, logger)
+		logger.info "Running remote command #{command.inspect} in #{root}"
+		
+		process_result = RExec::Task.open(connection_command) do |connection|
+			connection.puts(["cd", root].to_cmd)
+			connection.puts((["exec"] + command).to_cmd)
+			
+			LSync::log_task(connection, logger)
+		end
+		
+		return process_result
+	end
 end

data/lib/lsync/script.rb

@@ -1,7 +1,23 @@
+# Copyright (c) 2007, 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.
 
-# A backup script coordinates "one" backup as a unit.
-
-require 'lsync/action'
 require 'lsync/method'
 require 'lsync/server'
 require 'lsync/directory'
@@ -15,11 +31,18 @@ module LSync
 		include EventHandler
 
 		def initialize(options = {}, &block)
-			@logger = options[:logger] || Logger.new($stdout)
+			if options[:logger]
+				@logger = options[:logger]
+			else
+				@logger = Logger.new($stdout)
+				@logger.formatter = LSync::MinimalLogFormat.new
+			end
+			
 			@method = nil
 
 			@servers = {}
 			@directories = []
+			@master = "localhost"
 
 			@log = nil
 
@@ -34,7 +57,7 @@ module LSync
 				return @servers[name]
 			else
 				hostname = Socket.gethostbyname(name)[0] rescue name
-				return @servers.values.find { |s| s["host"] == hostname }
+				return @servers.values.find { |s| s.host == hostname }
 			end
 		end
 
@@ -51,11 +74,11 @@ module LSync
 			server = nil
 
 			# Find out if the master server is local...
-			if master.is_local?
+			if master && master.local?
 				server = master
 			else
 				# Find a server config that specifies the local host
-				server = @servers.values.find { |s| s.is_local? }
+				server = @servers.values.find { |s| s.local? }
 			end
 
 			return server
@@ -109,7 +132,7 @@ module LSync
 		attr :log
 
 		# Run the backup process for all servers and directories specified.
-		def run!
+		def run!(options = {})
 			start_time = Time.now
 
 			# We buffer the log data so that if there is an error it is available to the notification sub-system
@@ -126,7 +149,7 @@ module LSync
 				raise ScriptError.new("Could not determine current server!", :script => self, :master => @master)
 			end
 
-			if master.is_local?
+			if master.local?
 				logger.info "We are the master server..."
 			else
 				logger.info "We are not the master server..."
@@ -137,42 +160,48 @@ module LSync
 
 			self.try do
 				method.try do
-					master.try(master_controller) do
-						logger.info "Running backups for server #{current}..."
+					logger.info "Running backups for server #{current}..."
 
-						run_backups!(master, current, logger)
-					end
+					run_backups!(master, current, logger, options)
 				end
 			end
 
 			end_time = Time.now
-			logger.info "Backup Completed (#{end_time - start_time}s)."
+			logger.info "===== Finished ====="
+			logger.info "[Time]: (#{end_time - start_time}s)."
 		end
 
 		protected
 
 		# This function runs the method for each directory and server combination specified.
-		def run_backups!(master, current, logger)
+		def run_backups!(master, current, logger, options = {})
 			@servers.each do |name, server|
 				# S is always a data destination, therefore s can't be @master
 				next if server == master
 
+				next unless server.role?(options[:role] || :any)
+
+				server_controller = CopyController.new(self, logger, master, server, current)
+
 				# Skip servers that shouldn't be processed
-				unless @method.should_run?(master, current, server)
-					logger.info "\t" + "Skipping".rjust(20) + " : #{s}"
+				unless @method.should_run?(server_controller)
+					logger.info "===== Skipping ====="
+					logger.info "[Master]: #{master}"
+					logger.info "[Target]: #{server}"
 					next
 				end
 
-				server_controller = CopyController.new(self, logger, master, server)
-
+				logger.info "===== Processing ====="
+				logger.info "[Master]: #{master}"
+				logger.info "[Target]: #{server}"
+				
 				server.try(server_controller) do
 					@directories.each do |directory|
-						directory_controller = DirectoryController.new(self, logger, master, server, directory)
+						directory_controller = DirectoryController.new(self, logger, master, server, current, directory)
 
+						logger.info "[Directory]: #{directory}"
 						directory.try(directory_controller) do
-							logger.info "\t" + ("Processing " + directory.to_s).rjust(20) + " : #{server}"
-
-							method.run(master, server, directory)
+							method.run(directory_controller)
 						end
 					end
 				end