lsync 2.1.0 → 2.3.1

data/bin/lsync-mount

@@ -0,0 +1,88 @@
+#!/usr/bin/env ruby
+
+# 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 Linux
+	Commands = {
+		"mount" => "mount",
+		"unmount" => "umount"
+	}
+
+	DevicePaths = [
+		"/dev/disk/by-label",
+		"/dev/disk/by-uuid",
+		"/dev"
+	]
+	
+	def self.run(action, disk_name)
+		action = ARGV[0]
+		disk_name = ARGV[1]
+
+		mountpoint = File.join('', 'mnt', disk_name)
+
+		if (action == 'mountpoint')
+			puts File.join(mountpoint, ARGV[2..-1])
+		else
+			puts "#{action.capitalize}ing #{mountpoint}..."
+			system Commands[action], mountpoint
+
+			if $?.exitstatus != 0 or $?.exitstatus != 3383
+				exit 5
+			end
+		end
+	end
+end
+
+module Darwin
+	DISKUTIL = "diskutil"
+
+	def self.get_disk_id(name)
+		begin
+			`diskutil list`.match(/#{name}\s*\*?[0-9]+\.[0-9]+ .B\s+(disk[0-9]s[0-9])$/)[1]
+		rescue
+			exit 5
+		end
+	end
+
+	def self.run
+		action = ARGV[0]
+		disk_name = ARGV[1]
+		
+		if (action == 'mountpoint')
+			puts File.join('', 'Volumes', disk_name, ARGV[2..-1])
+		else
+			system DISKUTIL, action, get_disk_id(disk_name)
+		end
+	end
+end
+
+class UnsupportedPlatformError < StandardError
+end
+
+platform = `uname`.chomp.downcase
+case platform
+when "darwin"
+	Darwin.run
+when "linux"
+	Linux.run
+else
+	raise UnsupportedPlatformError.new("Platform #{platform} not supported.")
+end

data/{lib/lsync/actions/generic/prune → bin/lsync-prune}

@@ -1,5 +1,25 @@
 #!/usr/bin/env ruby
 
+# 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.
+
 # This script takes a specified directory, and removes any directories that
 # don't match the supplied policy. Thanks to Scott Lu and his "snapfilter"
 # command which made me realise how complicated my first attempt at doing this

data/{lib/lsync/actions/generic/rotate → bin/lsync-rotate}

@@ -1,5 +1,25 @@
 #!/usr/bin/env ruby
 
+# 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.
+
 # 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.
@@ -11,7 +31,7 @@ require 'optparse'
 OPTIONS = {
 	:Format => "%Y.%m.%d-%H.%M.%S",
 	:Latest => "latest",
-	:UseGMT => true,
+	:UseUTC => false,
 	:Destination => nil
 }
 
@@ -25,7 +45,7 @@ ARGV.options do |o|
 	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| 
+	o.on("-f format", String, "Set the format of the rotated directory names. See Time\#strftime") do |format| 
 		OPTIONS[:Format] = format
 	end
 
@@ -36,9 +56,13 @@ ARGV.options do |o|
 	o.on("-d destination", String, "Set the directory to move rotated backups.") do |destination|
 		OPTIONS[:Destination] = destination
 	end
+	
+	o.on("-u", "Use UTC time for directory names.") do
+		OPTIONS[:UseUTC] = true
+	end
 
 	o.on_tail("--copy", "Display copyright information") do
-		puts "#{script_name}. Copyright (c) 2008-2009 Samuel Williams. Released under the GPLv3."
+		puts "#{script_name}. Copyright (c) 2007-2011 Samuel Williams. Released under the MIT license."
 		puts "See http://www.oriontransfer.co.nz/ for more information."
 
 		exit

data/lib/lsync.rb

@@ -1,17 +1,22 @@
-# Copyright (c) 2007 Samuel Williams. Released under the GNU GPLv2.
-#
-# 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.
+# Copyright (c) 2007, 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
 # 
-# 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.
+# 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:
 # 
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# 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 'rubygems'
 

data/lib/lsync/client.rb

@@ -0,0 +1,56 @@
+# 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 'pathname'
+require 'fileutils'
+
+$connection.run do |object|
+	case(object[0])
+	when :chdir
+		# [:chdir, :path]
+		Dir.chdir(object[1])
+	when :script
+		# [:script, :command, :data]
+		
+		command = object[1]
+		script_name = File.basename(command[0])
+		
+		local_path = `mktemp -t #{script_name.gsub(/[^a-z]/i, '')}.XXXX`.chomp
+		
+		File.open(local_path, 'w') { |fp| fp.write(object[2]) }
+		system('chmod', '+x', local_path)
+		
+		pid = fork do
+			command[0] = local_path
+			exec *command
+		end
+		
+		# Clean up the script after execution:
+		pid, result = Process.wait2(pid)
+		# system('rm', '-f', local_path)
+		
+		exit!(result.exitstatus)
+	when :exec
+		# [:exec, :command]
+		command = object[1]
+		
+		exec *command
+	end
+end

data/lib/lsync/controller.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
 	class BasicController
@@ -12,32 +31,118 @@ module LSync
 		# The output logger.
 		attr :logger
 	end
-
+	
 	# The server controller provides event handlers with a unified interface
 	# for dealing with servers and associated actions.
 	class ServerController < BasicController
 		def initialize(script, logger, server)
 			super(script, logger)
-			
+
 			@server = server
+
+			@connection = nil
+			@platform = nil
 		end
 
 		# The current server.
 		attr :server
 
-		# Run a given shell script on the server.
-		def run!(*function)
-			action = Action.new(function)
-			action.run_on_server(@server, @logger)
+		def run(command, options = {})
+			task = nil
+			
+			root ||= options[:root] || @server.root
+			
+			if String === command
+				command = [command]
+			end
+			
+			begin
+				connection, task = @server.shell.connect(@server)
+				connection.send_object([:chdir, root])
+				
+				if options[:script]
+					data = command[0]
+					
+					command = command.dup
+					
+					# Descriptive name can be provided by options[:script].
+					case options[:script]
+					when String
+						command[0] = options[:script]
+					else
+						command[0] = "script"
+					end
+					
+					@logger.info "Running script #{command.inspect} on #{@server}"
+					
+					connection.send_object([:script, command, data])
+				elsif options[:remote]
+					@logger.info "Running script #{command.inspect} on #{@server}"
+					
+					data = File.read(command[0])
+					connection.send_object([:script, command, data])
+				else
+					@logger.info "Running command #{command.inspect} on #{@server}"
+					connection.send_object([:exec, command])
+				end
+				
+				if block_given?
+					yield task
+				else
+					LSync::log_task(task, @logger)
+				end
+			ensure
+				if task
+					task.stop
+					task.wait
+				end
+			end
+		end
+
+		# Run a command on the given server using this shell.
+		def exec(command, options = {}, &block)
+			unless @server.local?
+				command = @server.shell.connection_command(@server) + ["--"] + command
+			end
+
+			@logger.debug "Executing #{command.inspect} on #{@server}"
+			RExec::Task.open(command, options, &block)
+		end
+
+		def exec!(command, options = {})
+			exec(command, options) do |task|
+				task.input.close
+
+				result = task.wait
+
+				unless result.exitstatus == 0
+					raise ShellScriptError.new("Command #{command.inspect} failed: #{result.exitstatus}", result.exitstatus)
+				end
+
+				return task.output.read
+			end
+		end
+
+		def ==(other)
+			@server == other.server
+		end
+		
+		def respond_to?(name)
+			@server.respond_to?(name) || super(name)
+		end
+		
+		def method_missing(name, *args, &block)
+			@server.send(name, *args, &block)
 		end
 	end
 	
 	class CopyController < BasicController
-		def initialize(script, logger, master, target)
+		def initialize(script, logger, master, target, current)
 			super(script, logger)
 			
 			@master = ServerController.new(script, logger, master)
 			@target = ServerController.new(script, logger, target)
+			@current = ServerController.new(script, logger, current)
 		end
 		
 		# The master server controller (where the data is being copied from).
@@ -45,13 +150,16 @@ module LSync
 		
 		# The target server controller (where the data is being copied to).
 		attr :target
+		
+		# The current server controller (the controller for the local machine).
+		attr :current
 	end
 	
 	# The directory controller provides event handlers with a unified interface
 	# for dealing with a particular backup in a particular directory.
 	class DirectoryController < CopyController
-		def initialize(script, logger, master, target, directory)
-			super(script, logger, master, target)
+		def initialize(script, logger, master, target, current, directory)
+			super(script, logger, master, target, current)
 
 			@directory = directory
 		end

data/lib/lsync/directory.rb

@@ -1,4 +1,24 @@
+# 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/error'
 require 'lsync/event_handler'
 require 'pathname'
 
@@ -35,7 +55,10 @@ class Pathname
 end
 
 module LSync
-
+	
+	class AbsolutePathError < Error
+	end
+	
 	# A specific directory which is relative to the root of a given server. Specific configuration details
 	# such as excludes and other options may be specified.
 	class Directory
@@ -44,6 +67,10 @@ module LSync
 		def initialize(path)
 			@path = Pathname.new(path).cleanpath.normalize_trailing_slash
 			@options = {:arguments => []}
+			
+			if @path.absolute?
+				raise AbsolutePathError.new("Path #{path} may not be absolute!", :path => path)
+			end
 		end
 
 		attr :path