phusion-backup 1.0.0

data/LICENSE.TXT

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Phusion
+
+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/bin/phusion-backup

@@ -0,0 +1,277 @@
+#!/usr/bin/env ruby
+# encoding: binary
+require 'etc'
+require 'optparse'
+
+module PhusionBackup
+
+module TUI
+protected
+	DEFAULT_TERMINAL_COLORS = "\e[0m\e[37m\e[40m"
+	
+	def stdout
+		@stdout || STDOUT
+	end
+	
+	def print(text)
+		stdout.write(substitute_color_tags(text))
+		stdout.flush
+	end
+
+	def puts(text = nil)
+		if text
+			stdout.puts(substitute_color_tags(text))
+		else
+			stdout.puts
+		end
+		stdout.flush
+	end
+
+	def puts_error(text)
+		STDERR.puts(substitute_color_tags("<red>#{text}</red>"))
+		STDERR.flush
+	end
+	
+	def substitute_color_tags(data)
+		data = data.to_s
+		data = data.gsub(%r{<b>(.*?)</b>}m, "\e[1m\\1#{DEFAULT_TERMINAL_COLORS}")
+		data.gsub!(%r{<red>(.*?)</red>}m, "\e[1m\e[31m\\1#{DEFAULT_TERMINAL_COLORS}")
+		data.gsub!(%r{<green>(.*?)</green>}m, "\e[1m\e[32m\\1#{DEFAULT_TERMINAL_COLORS}")
+		data.gsub!(%r{<yellow>(.*?)</yellow>}m, "\e[1m\e[33m\\1#{DEFAULT_TERMINAL_COLORS}")
+		data.gsub!(%r{<banner>(.*?)</banner>}m, "\e[33m\e[44m\e[1m\\1#{DEFAULT_TERMINAL_COLORS}")
+		return data
+	end
+end
+
+class Server < Struct.new(:hostname, :dir)
+end
+
+class Core
+	ROOT = File.expand_path(File.dirname(__FILE__) + "/..")
+	
+	include TUI
+	
+	def initialize(backupdirs)
+		@backupdirs = backupdirs
+	end
+	
+	def servers
+		results = []
+		@backupdirs.each do |dir|
+			next if !File.exist?(dir)
+			Dir.foreach(dir) do |hostname|
+				next if hostname =~ /^\./
+				fullname = "#{dir}/#{hostname}"
+				if File.directory?(fullname)
+					results << Server.new(hostname, fullname)
+				end
+			end
+		end
+		return results
+	end
+	
+	def find_server(hostname_or_dir)
+		return servers.find { |s| s.hostname == hostname_or_dir || s.dir == hostname_or_dir }
+	end
+	
+	def generate(dir)
+		copy_file_no_overwrite("#{ROOT}/resources/default-files.txt", "#{dir}/files.txt")
+		copy_file_no_overwrite("#{ROOT}/resources/default-install-script.txt", "#{dir}/install-script.txt")
+	end
+	
+	def run_backup(server)
+		if !File.exist?("#{server.dir}/files.txt")
+			puts "<red>No `files.txt` found in this backup directory.</red>"
+			puts
+			puts "Each backup directory must have such a file, in which you " +
+				"specify which files must be backed up. You can create " +
+				"a default one with:"
+			puts
+			puts "  <b>phusion-backup --generate #{server.dir}</b>"
+			exit 1
+		end
+		
+		filename = create_globbing_filelist(server)
+		begin
+			sh!('rdiff-backup',
+				'-v6',
+				'--exclude-sockets',
+				'--include-globbing-filelist', filename,
+				"root@#{server.hostname}::/",
+				"#{server.dir}/data")
+		ensure
+			File.unlink(filename)
+		end
+	end
+
+private
+	class CommandError < StandardError
+	end
+	
+	def sh(*args)
+		puts "# #{args.join(' ')}"
+		result = system(*args)
+		if result
+			return true
+		elsif $?.signaled? && $?.termsig == Signal.list["INT"]
+			raise Interrupt
+		else
+			return false
+		end
+	end
+
+	def sh!(*args)
+		if !sh(*args)
+			puts_error "*** Command failed: #{args.join(' ')}"
+			raise CommandError
+		end
+	end
+	
+	def copy_file_no_overwrite(source, target)
+		if File.exist?(target)
+			puts " [CREATE] #{target}"
+			puts "          <yellow>File already exists. Not overwritten.</yellow>"
+		else
+			dir = File.dirname(target)
+			if !File.exist?(dir)
+				puts " [MKDIR]  #{dir}"
+				Dir.mkdir(dir)
+			end
+			puts " [CREATE] #{target}"
+			File.open(target, "w") do |f|
+				f.write(File.read(source))
+			end
+		end
+	end
+	
+	def create_globbing_filelist(server)
+		filename = "/tmp/phusion-backup-#{Process.pid}.txt"
+		File.open(filename, 'a') do |target|
+			File.open("#{server.dir}/files.txt", 'r') do |source|
+				while !source.eof?
+					line = source.readline.sub(/^#.*/, '')
+					target.puts(line)
+				end
+			end
+			target.puts "- **"
+		end
+		return filename
+	end
+end
+
+class App
+	include TUI
+	
+	def initialize(argv)
+		@argv = argv.dup
+		@stdout = STDOUT
+	end
+	
+	def run
+		options = {}
+		parser = OptionParser.new do |opts|
+			nl = "\n" << (" " * 37)
+			opts.banner = "General usage: phusion-backup <options...>"
+			opts.separator ""
+			
+			opts.separator "Backup one or more servers:"
+			opts.separator "   phusion-backup hostname1 [hostname2 ...]"
+			opts.separator ""
+			opts.separator "   `hostnameX' is either a host name or directory name."
+			opts.separator ""
+			
+			opts.separator "Display all servers that phusion-backup knows about:"
+			opts.separator "   phusion-backup --list"
+			opts.separator ""
+			
+			opts.separator "Please read the README for tutorial!"
+			opts.separator ""
+			opts.separator "Available options:"
+			opts.on("--list",
+			        "Show all servers that phusion-backup knows#{nl}" +
+			        "about.") do
+				options[:list] = true
+			end
+			opts.on("--generate DIR", String,
+			        "Generate default files (like files.txt)#{nl}" +
+			        "in the given directory.") do |dir|
+				options[:generate] = dir
+			end
+			opts.on("-h", "--help", "Show this help message.") do
+				options[:help] = true
+			end
+		end
+		begin
+			parser.parse!(@argv)
+		rescue OptionParser::ParseError => e
+			puts e
+			puts
+			puts "Please see '--help' for valid options."
+			exit 1
+		end
+
+		if options[:help]
+			puts parser
+			return 0
+		end
+		
+		core = Core.new(["#{Core::ROOT}/backups", "#{home_dir}/Backups"])
+		
+		if options[:list]
+			core.servers.each do |server|
+				printf "%-35s %s\n", server.hostname, server.dir
+			end
+			return 0
+		elsif options[:generate]
+			core.generate(options[:generate])
+			return 0
+		end
+		
+		if @argv.empty?
+			if core.servers.empty?
+				puts_error "You must create a backup specification first. Please read README for tutorial."
+			else
+				puts_error "Please specify the server you want to backup:"
+				puts
+				core.servers.each do |server|
+					puts "  phusion-backup #{server.hostname}"
+				end
+				puts
+				puts "For full usage please see `phusion-backup --help` and the README."
+			end
+			return 1
+		end
+		
+		servers = []
+		@argv.each do |name|
+			server = core.find_server(name)
+			if !server
+				puts_error "This program doesn't know anything about the server '#{name}'."
+				puts "If you've misspelled the name, please correct it."
+				puts "If you want to see a list of available servers that this programs knows about, run <b>phusion-backup --list</b>."
+				puts "For general, please refer to the README."
+				exit 1
+			end
+			servers << server
+		end
+		
+		servers.each do |server|
+			puts "<banner>Backing up #{server.hostname} - #{server.dir}</banner>"
+			core.run_backup(server)
+			puts
+		end
+		
+		return 0
+	rescue Core::CommandError
+		return 1
+	end
+
+private
+	def home_dir
+		return Etc.getpwuid(Process.uid).dir
+	end
+end
+
+end
+
+exit(PhusionBackup::App.new(ARGV).run)

data/phusion-backup.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+	s.name = "phusion-backup"
+	s.version = "1.0.0"
+	s.authors = ["Hongli Lai"]
+	s.date = "2011-03-30"
+	s.description = "Simple backup tool utilizing rdiff-backup."
+	s.summary = "Simple backup tool utilizing rdiff-backup."
+	s.email = "hongli@phusion.nl"
+	s.files = Dir[
+		"LICENSE.TXT",
+		"phusion-backup.gemspec",
+		"bin/*",
+		"resources/*"
+	]
+	s.homepage = "https://github.com/FooBarWidget/crash-watch"
+	s.rdoc_options = ["--charset=UTF-8"]
+	s.executables = ["phusion-backup"]
+	s.require_paths = ["lib"]
+end
+

data/resources/default-files.txt

@@ -0,0 +1,33 @@
+# Standard system stuff.
+/etc/skel
+/etc/profile
+/etc/bash.bashrc
+/etc/hostname
+/etc/nanorc
+/etc/screenrc
+/etc/mailname
+/etc/rc.local
+/var/spool/cron
+
+# Daemon tools.
+- /etc/service/*/supervise
+/etc/service
+
+# Backup all home directories, excluding non-critical things like caches.
+/root
+- /home/*/.gem
+- /home/*/.bundle
+- /home/*/.*/bundle
+/home
+
+# Backup all Capistrano-deployed web applications, excluding non-critical things like caches.
+- /u/*/*/shared/cached-copy
+- /u/*/*/shared/bundle
+- /u/*/*/releases/*/.git
+- /u/*/*/releases/*/vendor/bundle
+- /u/*/**/*.log
+/u
+
+# Phusion stuff.
+/etc/init.d/firewall
+/opt/production/nginx/conf

data/resources/default-install-script.txt

@@ -0,0 +1,5 @@
+# Standard, essential tools
+apt-get install bash-completion screen
+
+# Compiler toolchain
+apt-get install build-essential gdb

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: phusion-backup
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Hongli Lai
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-30 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Simple backup tool utilizing rdiff-backup.
+email: hongli@phusion.nl
+executables: 
+- phusion-backup
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE.TXT
+- phusion-backup.gemspec
+- bin/phusion-backup
+- resources/default-files.txt
+- resources/default-install-script.txt
+has_rdoc: true
+homepage: https://github.com/FooBarWidget/crash-watch
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.5.2
+signing_key: 
+specification_version: 3
+summary: Simple backup tool utilizing rdiff-backup.
+test_files: []
+