synco 1.0.0

data/lib/synco/command/disk.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'
+
+require_relative '../disk'
+
+module Synco
+	module Command
+		class Mount < Samovar::Command
+			self.description = "Mount a disk with the given name."
+			
+			one :path, "The disk mount point."
+			one :name, "The symbolic name of the disk to mount, e.g. disk label."
+			
+			def invoke(parent)
+				# We may not have permission to make this directory, but we should still try:
+				FileUtils.mkpath(@path) rescue nil
+				
+				Disk.mount(@path, @name)
+			end
+		end
+		
+		class Unmount < Samovar::Command
+			self.description = "Unmount a disk with the given name."
+			
+			one :path, "The disk mount point."
+			
+			def invoke(parent)
+				Disk.unmount(@path)
+			end
+		end
+	end
+end

data/lib/synco/command/prune.rb

@@ -0,0 +1,166 @@
+# 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 'periodical/filter'
+
+# Required for strptime
+require 'date'
+
+module Synco
+	module Command
+		class Rotation
+			include Comparable
+			
+			def initialize(path, time)
+				@path = path
+				@time = time
+			end
+
+			attr :time
+			attr :path
+			
+			# Sort in reverse order by default
+			def <=> other
+				other.time <=> @time
+			end
+			
+			def eql? other
+				case other
+				when Rotation
+					@path.eql?(other.path)
+				else
+					@path.eql?(other.to_s)
+				end
+			end
+			
+			def hash
+				@path.hash
+			end
+			
+			def to_s
+				@path
+			end
+		end
+		
+		class Prune < Samovar::Command
+			self.description = "Prune old backups to reduce disk usage according to a given policy."
+			
+			options do
+				option "--hourly <count>", "Set the number of hourly backups to keep.", default: 24
+				option "--daily <count>", "Set the number of daily backups to keep.", default: 7*4
+				option "--weekly <count>", "Set the number of weekly backups to keep.", default: 52
+				option "--monthly <count>", "Set the number of monthly backups to keep.", default: 12*3
+				option "--quarterly <count>", "Set the number of quaterly backups to keep.", default: 4*10
+				option "--yearly <count>", "Set the number of yearly backups to keep.", default: 20
+				
+				option "--format <name>", "Set the name of the backup rotations, including strftime expansions.", default: BACKUP_NAME
+				option "--latest <name>", "The name of the latest backup symlink.", default: LATEST_NAME
+				
+				option "--keep <new|old>", "Keep the younger or older backups within the same period division", default: 'old'
+				
+				option "--dry", "Print out what would be done rather than doing it."
+			end
+			
+			def policy
+				policy = Periodical::Filter::Policy.new
+				
+				policy << Periodical::Filter::Hourly.new(@options[:hourly])
+				policy << Periodical::Filter::Daily.new(@options[:daily])
+				policy << Periodical::Filter::Weekly.new(@options[:weekly])
+				policy << Periodical::Filter::Monthly.new(@options[:monthly])
+				policy << Periodical::Filter::Quarterly.new(@options[:quarterly])
+				policy << Periodical::Filter::Yearly.new(@options[:yearly])
+				
+				return policy
+			end
+			
+			def current_backups
+				backups = []
+				
+				Dir['*'].each do |path|
+					next if path == @options[:latest]
+					date_string = File.basename(path)
+					
+					begin
+						backups << Rotation.new(path, DateTime.strptime(date_string, @options[:format]))
+					rescue ArgumentError
+						$stderr.puts "Skipping #{path}, error parsing #{date_string}: #{$!}"
+					end
+				end
+				
+				return backups
+			end
+			
+			def dry?
+				@options[:dry]
+			end
+			
+			def print_rotation(keep, erase)
+				puts "*** Rotating backups (DRY!) ***"
+				puts "\tKeeping:"
+				keep.sort.each { |backup| puts "\t\t#{backup.path}" }
+				puts "\tErasing:"
+				erase.sort.each { |backup| puts "\t\t#{backup.path}" }
+			end
+			
+			def perform_rotation(keep, erase)
+				puts "*** Rotating backups ***"
+				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
+			end
+			
+			def invoke(parent)
+				backups = current_backups
+				
+				retain, erase = policy.filter(backups, keep: @options[:keep].to_sym, &:time)
+				
+				# We need to retain the latest backup regardless of policy
+				if latest = @options[:latest] and File.exist?(latest)
+					latest_path = File.readlink(options[:latest])
+					latest_rotation = erase.find{|rotation| rotation.path == latest_path}
+					
+					if latest_rotation
+						puts "Retaining latest backup #{latest_rotation}"
+						erase.delete(latest_rotation)
+						retain << latest_rotation
+					end
+				end
+
+				if dry?
+					print_rotation(retain, erase)
+				else
+					perform_rotation(retain, erase)
+				end
+			end
+		end
+	end
+end

data/lib/synco/command/rotate.rb

@@ -0,0 +1,86 @@
+# 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 '../method'
+
+module Synco
+	module Command
+		class Rotate < Samovar::Command
+				self.description = "Rotate a backup snapshot into a timestamped directory."
+				
+				options do
+					option "--format <name>", "Set the name of the backup rotations, including strftime expansions.", default: BACKUP_NAME
+					option "--latest <name>", "The name of the latest backup symlink.", default: LATEST_NAME
+					option "--snapshot <name>", "The name of the in-progress backup snapshot.", default: SNAPSHOT_NAME
+					
+					# option "--timezone <name>", "The default timezone for backup timestamps.", default: BACKUP_TIMEZONE
+				end
+				
+				def backup_timestamp
+					timestamp = Time.now.utc
+					
+					#if timezone = @options[:timezone]
+					#	timestamp = timestamp.in_time_zone(timezone)
+					#end
+					
+					return timestamp
+				end
+				
+				def backup_name
+					backup_timestamp.strftime(@options[:format])
+				end
+				
+				def invoke(parent)
+					snapshot_name = @options[:snapshot]
+					unless File.exist? snapshot_name
+						$stderr.puts "Snapshot directory #{snapshot_name} does not exist!"
+						exit(10)
+					end
+					
+					rotated_name = backup_name
+					if File.exist? rotated_name
+						$stderr.puts "Destination rotation name #{rotated_name} already exists!"
+						exit(20)
+					end
+					
+					puts "Rotating #{snapshot_name} to #{rotated_name} in #{Dir.pwd}"
+					
+					# Move rotated dir
+					FileUtils.mv(snapshot_name, rotated_name)
+
+					# Recreate latest symlink
+					latest_link = @options[:latest]
+					if File.symlink?(latest_link)
+						puts "Removing old latest link..."
+						FileUtils.rm(latest_link)
+					end
+
+					puts "Creating latest symlink to #{rotated_name}"
+					FileUtils.ln_s(rotated_name, latest_link)
+				end
+		end
+	end
+end

data/lib/synco/command/spawn.rb

@@ -0,0 +1,39 @@
+# 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 Synco
+	module Command
+		class Spawn < Samovar::Command
+				self.description = "Run a command using the synco environment and root directory."
+				
+				split :argv, "Command to spawn."
+				
+				def invoke(parent)
+					Process.exec(*@argv)
+				end
+		end
+	end
+end

data/lib/synco/compact_formatter.rb

@@ -0,0 +1,115 @@
+# 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.
+
+require 'rainbow'
+require 'shellwords'
+
+module Synco
+	class CompactFormatter
+		def initialize(verbose: true)
+			@start = Time.now
+			@verbose = verbose
+		end
+		
+		def time_offset_prefix
+			offset = Time.now - @start
+			minutes = (offset/60).floor
+			seconds = (offset - (minutes*60))
+			
+			if minutes > 0
+				"#{minutes}m#{seconds.floor}s"
+			else
+				"#{seconds.round(2)}s"
+			end.rjust(6)
+		end
+		
+		def chdir_string(options)
+			if options[:chdir]
+				" in #{options[:chdir]}"
+			else
+				""
+			end
+		end
+		
+		def format_command(arguments, buffer)
+			arguments = arguments.dup
+			
+			# environment = arguments.first.is_a?(Hash) ? arguments.shift : nil
+			options = arguments.last.is_a?(Hash) ? arguments.pop : nil
+			
+			arguments = arguments.flatten.collect(&:to_s)
+			
+			buffer << Rainbow(arguments.shelljoin).bright.blue
+			
+			if options
+				buffer << chdir_string(options)
+			end
+			
+			buffer << "\n"
+			
+			# if environment
+			# 	environment.each do |key,value|
+			# 		buffer << "\texport #{key}=#{value.dump}\n"
+			# 	end
+			# end
+		end
+		
+		def format_exception(exception, buffer)
+			buffer << Rainbow("#{exception.class}: #{exception}").bright.red << "\n"
+			exception.backtrace.each do |line|
+				buffer << "\t" << Rainbow(line).red << "\n"
+			end
+		end
+		
+		def format_line(message, severity)
+			if severity == 'ERROR'
+				Rainbow(message).red
+			else
+				message
+			end
+		end
+		
+		def call(severity, datetime, progname, message)
+			buffer = []
+			prefix = ""
+			
+			if @verbose
+				prefix = time_offset_prefix
+				buffer << Rainbow(prefix).cyan + ": "
+				prefix = " " * (prefix.size) + "| " 
+			end
+			
+			if progname == 'shell' and message.kind_of? Array
+				format_command(message, buffer)
+			elsif message.kind_of? Exception
+				format_exception(message, buffer)
+			else
+				buffer << format_line(message, severity) << "\n"
+			end
+			
+			result = buffer.join
+			
+			# This fancy regex indents lines correctly depending on the prefix:
+			result.gsub!(/\n(?!$)/, "\n#{prefix}") unless prefix.empty?
+			
+			return result
+		end
+	end
+end