dreamback 0.0.4 → 0.0.5

data/lib/dreamback/backup.rb

@@ -39,20 +39,24 @@ module Dreamback
           end
         end
 
-        # Get the newest folder for linking
+        # Get yesterday's folder to link against
         backup_to_link = backup_folders.first[0]
+        # If this would link us to the same folder, don't do that. Try yesterday's instead.
+        if backup_to_link.eql? "dreamback." + Date.today.strftime("%Y%m%d")
+          backup_to_link = "dreamback." + (Date.today - 1).strftime("%Y%m%d")
+        end
 
         # Delete any folders older than our limit
-        # Subtract one to account for the folder we're about to create
-        # Normally we remove a folder so that our count is one less than the "days to keep"
-        # However, if today's folder already exists then there's no need
-        offset = backup_folders.include?("dreamback.#{Time.now.strftime("%Y%m%d")}") ? 0 : 1
-        if backup_folders.length >= Dreamback.settings[:days_to_keep] - offset
-          folders_to_delete = backup_folders.slice(Dreamback.settings[:days_to_keep] - offset, backup_folders.length)
-          folders_to_delete.map! {|f| f[0]}
-          rsync_delete(folders_to_delete)
+        if Dreamback.settings[:days_to_keep]
+          folders_to_delete = rotate_daily(backup_folders)
+        elsif Dreamback.settings[:keep_time_machine]
+          folders_to_delete = rotate_time_machine(backup_folders)[:delete]
+        else
+          folders_to_delete = nil
         end
+        rsync_delete(folders_to_delete)
       end
+
       backup_to_link
     end
 
@@ -60,6 +64,7 @@ module Dreamback
     # We do this because sftp has no recursive delete method
     # @params [Array[String]] list of backup directories
     def self.rsync_delete(directories)
+      return if directories.nil? || directories.empty?
       empty_dir_path = File.expand_path("../.dreamback_empty_dir", __FILE__)
       empty_dir = Dir.mkdir(empty_dir_path) unless File.exists?(empty_dir_path)
       begin
@@ -78,6 +83,8 @@ module Dreamback
     # @param [String] name of the most recent backup folder prior to starting this run to link against
     def self.rsync_backup(link_dir)
       tmp_dir_path = "~/.dreamback_tmp"
+      tmp_dir = File.expand_path(tmp_dir_path)
+      Dir.mkdir(tmp_dir) unless File.exists?(tmp_dir)
       user_exclusions_path = File.expand_path("~/.dreamback_exclusions")
       default_exclusions_path = File.expand_path("../exclusions.txt", __FILE__)
       exclusions_path = File.exists?(user_exclusions_path) ? user_exclusions_path : default_exclusions_path
@@ -90,17 +97,84 @@ module Dreamback
           user = dreamhost[:user]
           server = dreamhost[:server]
           # rsync won't do remote<->remote syncing, so we stage everything here first
-          tmp_dir = File.expand_path(tmp_dir_path)
-          Dir.mkdir(tmp_dir) unless File.exists?(tmp_dir)
           `rsync -e ssh -av --keep-dirlinks --exclude-from #{exclusions_path} --copy-links #{user}@#{server}:~/ #{tmp_dir}/#{user}@#{server}`
-          # Now we can sync local to remote. Only use link-dest if a previous folder to link to exists.
-          link_dest = link_dir.nil? ? "" : "--link-dest=~#{BACKUP_FOLDER.gsub(".", "")}/#{link_dir}"
-          `rsync -e ssh -av --delete --copy-links --keep-dirlinks #{link_dest} #{tmp_dir}/ #{backup_server_user}@#{backup_server}:#{BACKUP_FOLDER}/dreamback.#{today}`
         end
+        # Now we can sync local to remote. Only use link-dest if a previous folder to link to exists.
+        link_dest = link_dir.nil? ? "" : "--link-dest=~#{BACKUP_FOLDER.gsub(".", "")}/#{link_dir}"
+        `rsync -e ssh -av --delete --copy-links --keep-dirlinks #{link_dest} #{tmp_dir}/ #{backup_server_user}@#{backup_server}:#{BACKUP_FOLDER}/dreamback.#{today}`
       ensure
         # Remove the staging directory
         `rm -rf #{File.expand_path(tmp_dir_path)}`
       end
     end
+
+    # Rotate folders based on the number of days to keep
+    # @param [Array] folders to rotate in Dreamback format (dreamback.20120521)
+    # @return [Array] list of folders to delete
+    def self.rotate_daily(backup_folders)
+      # Subtract one to account for the folder we're about to create
+      # Normally we remove a folder so that our count is one less than the "days to keep"
+      # However, if today's folder already exists then there's no need
+      offset = backup_folders.include?("dreamback.#{Time.now.strftime("%Y%m%d")}") ? 0 : 1
+      if backup_folders.length >= Dreamback.settings[:days_to_keep] - offset
+        folders_to_delete = backup_folders.slice(Dreamback.settings[:days_to_keep] - offset, backup_folders.length)
+        folders_to_delete.map! {|f| f[0]}
+      end
+      folders_to_delete ||= nil
+    end
+
+    # Use a time machine-like algorithm to rotate backups. This will keep daily backups for seven days, weeklies for three months, and monthlies forever
+    # @param [Date] the day to count as "today", where the rotation will start
+    # @param [Array] folders to rotate in Dreamback format (dreamback.20120521)
+    # @return [Hash] :keep => list of folders to retain, :delete => folders marked for deletion
+    def self.rotate_time_machine(folders, today = nil)
+      today ||= Date.today
+      ymd = "%Y%m%d"
+
+      folder_data = {}
+      folders.each do |f|
+        folder_data[f] = {
+          :date => Date.strptime(f[1].to_s, ymd)
+        }
+      end
+
+      keep = []
+      one_week_ago = today - 7
+      three_months_ago = today << 3
+
+      week_hash = {}
+      month_hash = {}
+      folder_data.each do |k, v|
+        if v[:date] >= one_week_ago
+          keep << k
+        elsif v[:date] >= three_months_ago
+          week_hash[v[:date].cweek] = [] if week_hash[v[:date].cweek].nil?
+          week_hash[v[:date].cweek] << [k, v]
+        else
+          ym = v[:date].strftime("%Y%m").to_i
+          month_hash[ym] = [] if month_hash[ym].nil?
+          month_hash[ym] << [k, v]
+        end
+      end
+
+      week_hash.each do |week, dates|
+        dates.sort! {|a, b| a[1][:date] <=> b[1][:date]}
+      end
+
+      week_hash.each do |week, dates|
+        keep << dates.shift[0] unless dates.empty?
+      end
+
+      month_hash.each do |month, dates|
+        dates.sort! {|a, b| a[1][:date] <=> b[1][:date]}
+      end
+
+      month_hash.each do |month, dates|
+        keep << dates.shift[0] unless dates.empty?
+      end
+
+      keep.sort!.compact!
+      { :keep => keep, :delete => folders - keep}
+    end
   end
 end

data/lib/dreamback/exclusions.txt

@@ -10,4 +10,5 @@ lib
 logs
 mail
 Maildir
-tmp
+tmp
+src

data/lib/dreamback/initializer.rb

@@ -1,6 +1,7 @@
 require 'json'
 require 'net/sftp'
 require 'cronedit'
+require 'highline/import'
 
 module Dreamback
   @settings
@@ -35,7 +36,20 @@ module Dreamback
         save_settings(SETTINGS_LOCATION)
       else
         if direct
-          say(bold("You have already setup Dreamback. Please run \"dreamback backup\" to start a backup."))
+          say(bold("You have already setup Dreamback."))
+
+          choose("From here you can:  \n") do |menu|
+            menu.prompt = "Select an option:  "
+
+            menu.choice("Run setup again") {
+              create_new_settings
+              save_settings(SETTINGS_LOCATION)
+            }
+
+            menu.choice("Run a backup right now") {
+              Dreamback::Backup.start
+            }
+          end
         end
       end
 
@@ -125,6 +139,7 @@ module Dreamback
     def self.create_new_settings
       settings = {}
       say("#{bold("Server Where We Should Store Your Backup")}\nYour dreamhost backup-specific account will work best, but any POSIX server with rsync should work\n<%= color('Note:', BOLD)%> dreamhost does not allow you to store non-webhosted data except your BACKUP-SPECIFIC account")
+      say("You can configure your Dreamhost backup user here: https://panel.dreamhost.com/index.cgi?tree=users.backup")
       settings[:backup_server] = ask("Server name: ")
       settings[:backup_server_user] = ask(bold("Username for the backup server: "))
       settings[:dreamhost_users] = []
@@ -136,7 +151,25 @@ module Dreamback
         settings[:dreamhost_users] << dreamhost
         another_user = agree(bold("Add another dreamhost account? [y/n]"))
       end
-      settings[:days_to_keep] = ask(bold("How many days of backups do you want to keep [1-30]? "), Integer) {|q| q.in = 1..30}
+
+      choose("What method should we use to keep backups?  \n") do |menu|
+        menu.prompt = "Select an option  "
+
+        menu.choice("Number of days") {
+          settings[:days_to_keep] = ask(bold("How many days of backups do you want to keep [1-9999]? "), Integer) {|q| q.in = 1..9999}
+          say("#{bold("We will keep #{settings[:days_to_keep]} days of backups")}")
+        }
+
+        menu.choice("Time machine-inspired\n   (daily backups for seven days, weekly backups for three months, monthly backups forever)") {
+          settings[:keep_time_machine] = true
+          say("#{bold("We will keep backups based on a time machine-inspired method")}")
+        }
+
+        menu.choice("Keep everything") {
+          say("#{bold("We will keep everything. This may take a lot of space.")}")
+        }
+      end
+
       @settings = settings
     end
 

data/lib/dreamback/version.rb

@@ -1,3 +1,3 @@
 module Dreamback
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/test/dreamback_test.rb

@@ -1,7 +1,8 @@
 require "rubygems"
+require "json"
 require "test/unit"
 require File.expand_path('../../lib/dreamback/initializer', __FILE__)
-require "json"
+require File.expand_path('../../lib/dreamback/backup', __FILE__)
 
 # Used for testing private methods
 class Class
@@ -55,4 +56,76 @@ class DreambackTest < Test::Unit::TestCase
     assert_equal settings_file, JSON.parse(settings_test, :symbolize_names => true)
   end
 
+  def test_time_machine_rotate
+    folders = [
+      "dreamback.20120514",
+      "dreamback.20120513",
+      "dreamback.20120512",
+      "dreamback.20120511",
+      "dreamback.20120510",
+      "dreamback.20120509",
+      "dreamback.20120508",
+      "dreamback.20120501",
+      "dreamback.20120424",
+      "dreamback.20120413",
+      "dreamback.20120417",
+      "dreamback.20120411",
+      "dreamback.20120410",
+      "dreamback.20120403",
+      "dreamback.20120327",
+      "dreamback.20120325",
+      "dreamback.20120320",
+      "dreamback.20120321",
+      "dreamback.20120313",
+      "dreamback.20120312",
+      "dreamback.20120309",
+      "dreamback.20120308",
+      "dreamback.20120301",
+      "dreamback.20120227",
+      "dreamback.20120215",
+      "dreamback.20120207",
+      "dreamback.20120208"
+    ]
+
+    folders_sorted = {
+      :keep=>
+        [
+          "dreamback.20120207",
+          "dreamback.20120215",
+          "dreamback.20120227",
+          "dreamback.20120308",
+          "dreamback.20120312",
+          "dreamback.20120320",
+          "dreamback.20120327",
+          "dreamback.20120403",
+          "dreamback.20120410",
+          "dreamback.20120417",
+          "dreamback.20120424",
+          "dreamback.20120501",
+          "dreamback.20120508",
+          "dreamback.20120509",
+          "dreamback.20120510",
+          "dreamback.20120511",
+          "dreamback.20120512",
+          "dreamback.20120513",
+          "dreamback.20120514"
+        ],
+     :delete=>
+      [
+        "dreamback.20120413",
+        "dreamback.20120411",
+        "dreamback.20120325",
+        "dreamback.20120321",
+        "dreamback.20120313",
+        "dreamback.20120309",
+        "dreamback.20120301",
+        "dreamback.20120208"
+      ]
+    }
+
+    today = Date.strptime("20120514", "%Y%m%d")
+
+    assert folders_sorted == Dreamback::Backup.rotate_time_machine(today, folders)
+  end
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: dreamback
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Paul R Alexander
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-30 00:00:00 -07:00
+date: 2012-06-25 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency