lsync 1.2.1 → 1.2.5

data/bin/lsync

@@ -7,7 +7,6 @@ require 'optparse'
 
 OPTIONS = {
   :ConfigFiles => [],
-  :Plan => nil,
   :LogPath => "/var/log/lsync/backup.log"
 }
 
@@ -16,16 +15,17 @@ ARGV.options do |o|
 
   o.set_summary_indent('  ')
   o.banner = "Usage: #{script_name} [options] [directory | config]"
-  o.define_head "This script is used to run backups. If you specify a directory, files ending in .conf will all be processed."
+  o.define_head "This script is used to run lsync scripts and plans. If you specify a directory, files ending in .lsync-script and .lsync-plan will all be processed."
 
   o.separator ""
   o.separator "Help and Copyright information"
-
-  o.on("-p plan", String, "Run the specified backup plan") { |plan| OPTIONS[:Plan] = plan }
-  o.on("-l log_path", String, "Set the directory for backup logs") { |log_path| OPTIONS[:LogPath] = log_path }
+	
+  o.on("-l log_path", String, "Set the directory for backup logs") do |log_path|
+		OPTIONS[:LogPath] = log_path
+	end
 
   o.on_tail("--copy", "Display copyright information") do
-    puts "#{script_name} v#{LSync::VERSION::STRING}. Copyright (c) 2008-2009 Samuel Williams. Released under the GPLv3."
+    puts "#{script_name} v#{LSync::VERSION::STRING}. Copyright (c) 2008-2010 Samuel Williams. Released under the GPLv3."
     puts "See http://www.oriontransfer.co.nz/ for more information."
 
     exit
@@ -90,32 +90,23 @@ def process_config_files
     end
   
     if File.directory? p
-      OPTIONS[:ConfigFiles] += Dir[File.join(p, "*.conf")]
+      OPTIONS[:ConfigFiles] += Dir[File.join(p, "*.{lsync-script,lsync-plan}")]
     else
       OPTIONS[:ConfigFiles] << p
     end
   end
 end
 
-def validate_options
-  if OPTIONS[:Plan] && OPTIONS[:ConfigFiles].size > 0
-    $logger.error "Please specify either a backup plan or a set of backup scripts, but not both in one run."
-    exit(27)
-  end
-end
-
-def run_backups
-  OPTIONS[:ConfigFiles].each do |c|
-    config = LSync::BackupScript.load_from_file(c)
-    config.logger = $logger
-    config.run_backup
-  end
-
-  if OPTIONS[:Plan]
-    config = LSync::BackupPlan.load_from_file(OPTIONS[:Plan])
-    config.logger = $logger
-    config.run_backup
-  end
+def run_backups(config_files)
+	if config_files.size == 0
+		$logger.warn "No configuration files specified!"
+	else
+		config_files.each do |c|
+			config = LSync::load_from_file(c)
+			config.logger = $logger
+			config.run_backup
+		end
+	end
 end
 
 def dump_exception_backtrace ex
@@ -124,17 +115,16 @@ def dump_exception_backtrace ex
   end
 end
 
+# Main Script Execution
 setup_logging
 
 process_config_files
 
-validate_options
-
 $logger.info "  Backup beginning at #{Time.now.to_s}  ".center(96, "=")
 
 begin
-  run_backups
-rescue LSync::BackupError
+  run_backups(OPTIONS[:ConfigFiles])
+rescue LSync::Error
   $logger.error "#{$!.class.name}: #{$!.to_s}. Dumping backtrace:"
   dump_exception_backtrace($!)
   exit(230)

data/lib/lsync.rb

@@ -26,8 +26,10 @@ require 'logger'
 
 require 'lsync/version'
 require 'lsync/extensions'
-require 'lsync/backup_script'
-require 'lsync/backup_plan'
+
+require 'lsync/script'
+require 'lsync/plan'
+
 require 'lsync/tee_logger'
 
 require 'fileutils'
@@ -36,5 +38,19 @@ require 'optparse'
 require 'open-uri'
 
 module LSync
-
-end
+	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

@@ -1,7 +1,7 @@
 
 require 'pathname'
 require 'lsync/run'
-require 'lsync/backup_error'
+require 'lsync/error'
 
 module LSync
   

data/lib/lsync/actions/generic/prune

@@ -6,7 +6,6 @@
 # was.
 
 require 'pathname'
-require 'fileutils'
 require 'optparse'
 
 require 'set'
@@ -125,7 +124,7 @@ class Policy
 			filtered_values += period.filter(values, options)
 		end
 
-		return filtered_values.to_a, (Set.new(values) - filtered_values).to_a
+		return filtered_values, (Set.new(values) - filtered_values)
 	end
 
 	attr :periods
@@ -133,10 +132,11 @@ end
 
 OPTIONS = {
 	:Format => "%Y.%m.%d-%H.%M.%S",
-	:Destination => "./*",
+	:Destination => "./",
 	:Policy => Policy.new,
 	:PolicyOptions => {},
-	:Wet => true
+	:Wet => true,
+	:Latest => "latest"
 }
 
 ARGV.options do |o|
@@ -160,6 +160,8 @@ 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 ""
 
@@ -198,11 +200,11 @@ ARGV.options do |o|
 		OPTIONS[:Policy] << Monthly.new(count)
 	end
 
-	o.on("--quaterly count", Integer, "Set the number of monthly backups to keep.") do |count|
+	o.on("--quaterly count", Integer, "Set the number of quaterly backups to keep.") do |count|
 		OPTIONS[:Policy] << Quarterly.new(count)
 	end
 
-	o.on("--yearly count", Integer, "Set the number of monthly backups to keep.") do |count|
+	o.on("--yearly count", Integer, "Set the number of yearly backups to keep.") do |count|
 		OPTIONS[:Policy] << Yearly.new(count)
 	end
 
@@ -223,29 +225,41 @@ end.parse!
 
 backups = []
 
-Dir[OPTIONS[:Destination]].each do |path|
-	next if path.match("latest")
-	date_string = File.basename(path)
+Dir.chdir(OPTIONS[:Destination]) do 
+	Dir["*"].each do |path|
+		next if path.match(OPTIONS[:Latest])
+		date_string = File.basename(path)
 
-	begin
-		backups << Rotation.new(path, DateTime.strptime(date_string, OPTIONS[:Format]))
-	rescue ArgumentError
-		puts "Skipping #{path}, error parsing #{date_string}: #{$!}"
+		begin
+			backups << Rotation.new(path, DateTime.strptime(date_string, OPTIONS[:Format]))
+		rescue ArgumentError
+			puts "Skipping #{path}, error parsing #{date_string}: #{$!}"
+		end
 	end
-end
 
-keep, erase = OPTIONS[:Policy].filter(backups)
+	keep, erase = OPTIONS[:Policy].filter(backups)
 
-if OPTIONS[:Wet]
-	erase.sort.each do |backup|
-		puts "Erasing #{backup.path}..."
-		$stdout.flush
-		FileUtils.rm_rf(backup.path)
+	# 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)
 	end
-else
-	puts "*** Dry Run ***"
-	puts "\tKeeping:"
-	keep.sort.each { |backup| puts "\t\t#{backup.path}" }
-	puts "\tErasing:"
-	erase.sort.each { |backup| puts "\t\t#{backup.path}" }
-end
+	
+	if OPTIONS[:Wet]
+		erase.sort.each do |backup|
+			puts "Erasing #{backup.path}..."
+			$stdout.flush
+
+			# Ensure that we can remove the backup
+			system("chmod", "-R", "ug+rwX", backup.path)
+			system("rm", "-rf", backup.path)
+		end
+	else
+		puts "*** Dry Run ***"
+		puts "\tKeeping:"
+		keep.sort.each { |backup| puts "\t\t#{backup.path}" }
+		puts "\tErasing:"
+		erase.sort.each { |backup| puts "\t\t#{backup.path}" }
+	end
+end

data/lib/lsync/directory.rb

@@ -13,6 +13,22 @@ class Pathname
       return self.class.new(to_s + "/")
     end
   end
+
+	# Returns the number of path components
+	# We need to work with a cleanpath to get an accurate depth
+	# "", "/" => 0
+	# "bob" => 1
+	# "bob/dole" => 2
+	# "/bob/dole" => 2
+	#
+	def depth
+		bits = cleanpath.to_s.split(SEPARATOR_PAT)
+		
+		bits.delete("")
+		bits.delete(".")
+		
+		return bits.size
+	end
 end
 
 module LSync
@@ -29,11 +45,6 @@ module LSync
     def to_s
       @path.to_s
     end
-    
-    # Special exception for root path
-    def depth
-      return @path.to_s.scan("/").size - 1
-    end
   end
   
 end

data/lib/lsync/{backup_error.rb → error.rb}

@@ -1,7 +1,7 @@
 
 module LSync
   
-  class BackupError < StandardError
+  class Error < StandardError
     def initialize(reason, components = {})
       @reason = reason
       @components = components
@@ -15,16 +15,16 @@ module LSync
     attr :components
   end
   
-  class BackupScriptError < BackupError
+  class ScriptError < Error
   end
   
-  class BackupMethodError < BackupError
+  class BackupMethodError < Error
   end
   
-  class ConfigurationError < BackupError
+  class ConfigurationError < Error
   end
   
-  class BackupActionError < BackupError
+  class BackupActionError < Error
     def initialize(server, action, exception)
       super("Backup action failed: #{action} (#{exception.to_s})", :action => action, :exception => exception)
     end

data/lib/lsync/method.rb

@@ -91,6 +91,7 @@ module LSync
         
         @logger = logger
         
+				@logger.info "In directory #{Dir.getwd}"
         Dir.chdir(local_server.root_path) do
           if run_handler(src, dst, options) == false
             raise BackupMethodError.new("Backup from #{src.dump} to #{dst.dump} failed.", :method => self)
@@ -127,7 +128,7 @@ module LSync
     class RSyncSnapshot < RSync
       def run(master_server, target_server, directory, options, logger)
         options ||= ""
-        link_dest = Pathname.new("../" * (directory.depth + 1)) + "latest" + directory.path
+        link_dest = Pathname.new("../" * (directory.path.depth + 1)) + "latest" + directory.path
         options += " --archive --link-dest #{link_dest.to_s.dump}"
         
         inprogress_path = ".inprogress"

data/lib/lsync/{backup_plan.rb → plan.rb}

@@ -68,7 +68,7 @@ module LSync
     end
   end
 
-  class BackupPlanRulebook < Ruleby::Rulebook
+  class PlanRulebook < Ruleby::Rulebook
     include Facts
 
     def rules
@@ -203,7 +203,7 @@ module LSync
     attr :rules
   end
 
-  class BackupPlan
+  class Plan
     def initialize(config, logger = nil)
       @logger = logger || Logger.new(STDOUT)
       
@@ -220,7 +220,7 @@ module LSync
 
         puts " Loading Rules ".center(80, "=")
 
-        BackupPlanRulebook.new(e).rules
+        PlanRulebook.new(e).rules
 
         @stages.each do |k,s|
           StageRulebook.new(e, s).rules

data/lib/lsync/{backup_script.rb → script.rb}

@@ -8,7 +8,7 @@ require 'lsync/directory'
 
 module LSync
 
-  class BackupScript
+  class Script
     private
     # Given a name, find out which server config matches it
     def find_named_server name
@@ -76,7 +76,7 @@ module LSync
 
       # At this point we must know the current server or we can't continue
       if current == nil
-        raise BackupScriptError.new("Could not determine current server!", :script => self, :master => @master)
+        raise ScriptError.new("Could not determine current server!", :script => self, :master => @master)
       end
 
       if @master.is_local?

data/lib/lsync/version.rb

@@ -17,7 +17,7 @@ module LSync
   module VERSION #:nodoc:
     MAJOR = 1
     MINOR = 2
-    TINY  = 1
+    TINY  = 5
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: lsync
 version: !ruby/object:Gem::Version 
+  hash: 21
   prerelease: false
   segments: 
   - 1
   - 2
-  - 1
-  version: 1.2.1
+  - 5
+  version: 1.2.5
 platform: ruby
 authors: 
 - Samuel Williams
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-18 00:00:00 +13:00
+date: 2010-09-09 00:00:00 +12:00
 default_executable: lsync
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: termios
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -33,9 +36,11 @@ dependencies:
   name: net-ssh
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -45,9 +50,11 @@ dependencies:
   name: ruleby
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -57,9 +64,11 @@ dependencies:
   name: rexec
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -82,15 +91,15 @@ files:
 - lib/lsync/actions/generic/rotate
 - lib/lsync/actions/linux/disk
 - lib/lsync/actions/linux/terminal
-- lib/lsync/backup_error.rb
-- lib/lsync/backup_plan.rb
-- lib/lsync/backup_script.rb
 - lib/lsync/directory.rb
+- lib/lsync/error.rb
 - lib/lsync/extensions.rb
 - lib/lsync/lb.py
 - lib/lsync/method.rb
 - lib/lsync/password.rb
+- lib/lsync/plan.rb
 - lib/lsync/run.rb
+- lib/lsync/script.rb
 - lib/lsync/server.rb
 - lib/lsync/shell.rb
 - lib/lsync/shell_client.rb
@@ -98,7 +107,7 @@ files:
 - lib/lsync/version.rb
 - lib/lsync.rb
 has_rdoc: true
-homepage: http://wiki.oriontransfer.org/?lsync
+homepage: http://www.oriontransfer.co.nz/software/lsync
 licenses: []
 
 post_install_message: 
@@ -107,25 +116,29 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: LSync is a tool for scripted synchronization and backups.
 test_files: []