backup 3.0.19 → 3.0.20

data/lib/backup/storage/ftp.rb

@@ -24,44 +24,42 @@ module Backup
       # use passive mode?
       attr_accessor :passive_mode
 
-      ##
-      # Creates a new instance of the FTP storage object
-      # First it sets the defaults (if any exist) and then evaluates
-      # the configuration block which may overwrite these defaults
-      def initialize(&block)
-        load_defaults!
-
-        @port         ||= 21
-        @path         ||= 'backups'
-        @passive_mode ||= false
-
-        instance_eval(&block) if block_given?
-
-        @time = TIME
-        @path = path.sub(/^\~\//, '')
-      end
-
       ##
       # This is the remote path to where the backup files will be stored
       def remote_path
-        File.join(path, TRIGGER)
+        File.join(path, TRIGGER, @time)
       end
 
       ##
       # Performs the backup transfer
       def perform!
+        super
         transfer!
         cycle!
       end
 
     private
 
+      ##
+      # Set configuration defaults before evaluating configuration block,
+      # after setting defaults from Storage::Base
+      def pre_configure
+        super
+        @port         ||= 21
+        @path         ||= 'backups'
+        @passive_mode ||= false
+      end
+
+      ##
+      # Adjust configuration after evaluating configuration block,
+      # after adjustments from Storage::Base
+      def post_configure
+        super
+        @path = path.sub(/^\~\//, '')
+      end
+
       ##
       # Establishes a connection to the remote server and returns the Net::FTP object.
-      # Not doing any instance variable caching because this object gets persisted in YAML
-      # format to a file and will issues. This, however has no impact on performance since it only
-      # gets invoked once per object for a #transfer! and once for a remove! Backups run in the
-      # background anyway so even if it were a bit slower it shouldn't matter.
       #
       # Note *
       # Since the FTP port is defined as a constant in the Net::FTP class, and might be required
@@ -71,31 +69,41 @@ module Backup
           Net::FTP.send(:remove_const, :FTP_PORT)
         end; Net::FTP.send(:const_set, :FTP_PORT, port)
 
-        ftp = Net::FTP.new(ip, username, password)
-        ftp.passive = true if passive_mode
-        ftp
+        Net::FTP.open(ip, username, password) do |ftp|
+          ftp.passive = true if passive_mode
+          yield ftp
+        end
       end
 
       ##
       # Transfers the archived file to the specified remote server
       def transfer!
-        Logger.message("#{ self.class } started transferring \"#{ remote_file }\".")
-        create_remote_directories!
-        connection.put(
-          File.join(local_path, local_file),
-          File.join(remote_path, remote_file)
-        )
+        connection do |ftp|
+          create_remote_directories(ftp)
+
+          files_to_transfer do |local_file, remote_file|
+            Logger.message "#{storage_name} started transferring " +
+                "'#{ local_file }' to '#{ ip }'."
+            ftp.put(
+              File.join(local_path, local_file),
+              File.join(remote_path, remote_file)
+            )
+          end
+        end
       end
 
       ##
       # Removes the transferred archive file from the server
       def remove!
-        begin
-          connection.delete(
-            File.join(remote_path, remote_file)
-          )
-        rescue Net::FTPPermError
-          Logger.warn "Could not remove file \"#{ File.join(remote_path, remote_file) }\"."
+        connection do |ftp|
+          transferred_files do |local_file, remote_file|
+            Logger.message "#{storage_name} started removing " +
+                "'#{ local_file }' from '#{ ip }'."
+
+            ftp.delete(File.join(remote_path, remote_file))
+          end
+
+          ftp.rmdir(remote_path)
         end
       end
 
@@ -105,13 +113,13 @@ module Backup
       # paths to directories that don't yet exist when creating new directories.
       # Instead, we split the parts up in to an array (for each '/') and loop through
       # that to create the directories one by one. Net::FTP raises an exception when
-      # the directory it's trying ot create already exists, so we have rescue it
-      def create_remote_directories!
+      # the directory it's trying to create already exists, so we have rescue it
+      def create_remote_directories(ftp)
         path_parts = Array.new
         remote_path.split('/').each do |path_part|
           path_parts << path_part
           begin
-            connection.mkdir(path_parts.join('/'))
+            ftp.mkdir(path_parts.join('/'))
           rescue Net::FTPPermError; end
         end
       end

data/lib/backup/storage/local.rb

@@ -12,53 +12,64 @@ module Backup
       # Path to store backups to
       attr_accessor :path
 
-      ##
-      # Creates a new instance of the Local storage object
-      # First it sets the defaults (if any exist) and then evaluates
-      # the configuration block which may overwrite these defaults
-      def initialize(&block)
-        load_defaults!
-
-        @path ||= "#{ENV['HOME']}/backups"
-
-        instance_eval(&block) if block_given?
-
-        @time = TIME
-        fix_path!
-      end
-
       ##
       # This is the remote path to where the backup files will be stored.
       # Eventhough it says "remote", it's actually the "local" path, but
       # the naming is necessary for compatibility reasons
       def remote_path
-        File.join(path, TRIGGER)
+        File.join(path, TRIGGER, @time)
       end
 
       ##
       # Performs the backup transfer
       def perform!
+        super
         transfer!
         cycle!
       end
 
     private
 
+      ##
+      # Set configuration defaults before evaluating configuration block,
+      # after setting defaults from Storage::Base
+      def pre_configure
+        super
+        @path ||= "#{ENV['HOME']}/backups"
+      end
+
+      ##
+      # Adjust configuration after evaluating configuration block,
+      # after adjustments from Storage::Base
+      def post_configure
+        super
+        @path = File.expand_path(path)
+      end
+
       ##
       # Transfers the archived file to the specified local path
       def transfer!
-        Logger.message("#{ self.class } started transferring \"#{ remote_file }\".")
         create_local_directories!
-        FileUtils.cp(
-          File.join(local_path, local_file),
-          File.join(remote_path, remote_file)
-        )
+
+        files_to_transfer do |local_file, remote_file|
+          Logger.message "#{storage_name} started transferring '#{ local_file }'."
+          FileUtils.cp(
+            File.join(local_path, local_file),
+            File.join(remote_path, remote_file)
+          )
+        end
       end
 
       ##
       # Removes the transferred archive file from the local path
       def remove!
-        FileUtils.rm(File.join(remote_path, remote_file))
+        messages = []
+        transferred_files do |local_file, remote_file|
+          messages << "#{storage_name} started removing '#{ local_file }'."
+        end
+        Logger.message messages.join("\n")
+
+        FileUtils.rm_r(remote_path)
       end
 
       ##
@@ -67,12 +78,6 @@ module Backup
         FileUtils.mkdir_p(remote_path)
       end
 
-      ##
-      # Replaces ~/ with the full path to the users $HOME directory
-      def fix_path!
-        @path = path.sub(/^\~\//, "#{ENV['HOME']}/")
-      end
-
     end
   end
 end

data/lib/backup/storage/ninefold.rb

@@ -16,25 +16,10 @@ module Backup
       # Ninefold directory path
       attr_accessor :path
 
-      ##
-      # Creates a new instance of the Ninefold storage object
-      # First it sets the defaults (if any exist) and then evaluates
-      # the configuration block which may overwrite these defaults
-      #
-      def initialize(&block)
-        load_defaults!
-
-        @path ||= 'backups'
-
-        instance_eval(&block) if block_given?
-
-        @time = TIME
-      end
-
       ##
       # This is the remote path to where the backup files will be stored
       def remote_path
-        File.join(path, TRIGGER).sub(/^\//, '')
+        File.join(path, TRIGGER, @time).sub(/^\//, '')
       end
 
       ##
@@ -46,12 +31,28 @@ module Backup
       ##
       # Performs the backup transfer
       def perform!
+        super
         transfer!
         cycle!
       end
 
     private
 
+      ##
+      # Set configuration defaults before evaluating configuration block,
+      # after setting defaults from Storage::Base
+      def pre_configure
+        super
+        @path ||= 'backups'
+      end
+
+      ##
+      # Adjust configuration after evaluating configuration block,
+      # after adjustments from Storage::Base
+      def post_configure
+        super
+      end
+
       ##
       # Establishes a connection to Amazon S3 and returns the Fog object.
       # Not doing any instance variable caching because this object gets persisted in YAML
@@ -59,7 +60,7 @@ module Backup
       # gets invoked once per object for a #transfer! and once for a remove! Backups run in the
       # background anyway so even if it were a bit slower it shouldn't matter.
       def connection
-        Fog::Storage.new(
+        @connection ||= Fog::Storage.new(
           :provider                => provider,
           :ninefold_storage_token  => storage_token,
           :ninefold_storage_secret => storage_secret
@@ -69,26 +70,39 @@ module Backup
       ##
       # Transfers the archived file to the specified directory
       def transfer!
-        begin
-          Logger.message("#{ self.class } started transferring \"#{ remote_file }\".")
-          directory   = connection.directories.get remote_path
+        files_to_transfer do |local_file, remote_file|
+          Logger.message "#{storage_name} started transferring '#{ local_file }'."
+          directory   = connection.directories.get(remote_path)
           directory ||= connection.directories.create(:key => remote_path)
           directory.files.create(
             :key  => remote_file,
             :body => File.open(File.join(local_path, local_file))
           )
-        rescue Excon::Errors::NotFound
-          raise "An error occurred while trying to transfer the file."
         end
       end
 
       ##
       # Removes the transferred archive file from the Amazon S3 bucket
       def remove!
-        begin
-          directory = connection.directories.get remote_path
-          directory.files.get(remote_file).destroy
-        rescue Excon::Errors::SocketError; end
+        if directory = connection.directories.get(remote_path)
+          transferred_files do |local_file, remote_file|
+            Logger.message "#{storage_name} started removing " +
+                "'#{ local_file }' from Ninefold.'"
+
+            if file = directory.files.get(remote_file)
+              file.destroy
+            else
+              # Note: Fog-0.11.0 will return nil if remote_file is not found
+              raise Errors::Storage::Ninefold::NotFoundError,
+                  "'#{remote_file}' not found in '#{remote_path}'", caller(1)
+            end
+          end
+          directory.destroy
+        else
+          # Note: Fog-0.11.0 will return nil if remote_path is not found
+          raise Errors::Storage::Ninefold::NotFoundError,
+              "Directory at '#{remote_path}' not found", caller(1)
+        end
       end
 
     end

data/lib/backup/storage/object.rb

@@ -11,8 +11,10 @@ module Backup
       ##
       # Instantiates a new Backup::Storage::Object and stores the
       # full path to the storage file (yaml) in the @storage_file attribute
-      def initialize(type)
-        @storage_file = File.join(DATA_PATH, TRIGGER, "#{type}.yml")
+      def initialize(type, storage_id)
+        suffix = storage_id.to_s.strip.gsub(/[\W\s]/, '_')
+        filename = suffix.empty? ? type : "#{type}-#{suffix}"
+        @storage_file = File.join(DATA_PATH, TRIGGER, "#{filename}.yml")
       end
 
       ##
@@ -24,11 +26,11 @@ module Backup
       # descending. The newest backup storage object comes in Backup::Storage::Object.load[0]
       # and the oldest in Backup::Storage::Object.load[-1]
       def load
-        if File.exist?(storage_file)
-          YAML.load_file(storage_file).sort { |a,b| b.time <=> a.time }
-        else
-          []
+        objects = []
+        if File.exist?(storage_file) and not File.zero?(storage_file)
+          objects = YAML.load_file(storage_file).sort { |a,b| b.time <=> a.time }
         end
+        objects
       end
 
       ##

data/lib/backup/storage/rsync.rb

@@ -11,7 +11,7 @@ Backup::Dependency.load('net-ssh')
 module Backup
   module Storage
     class RSync < Base
-      include Backup::CLI
+      include Backup::CLI::Helpers
 
       ##
       # Server credentials
@@ -29,24 +29,6 @@ module Backup
       # Flag to use local backups
       attr_accessor :local
 
-      ##
-      # Creates a new instance of the RSync storage object
-      # First it sets the defaults (if any exist) and then evaluates
-      # the configuration block which may overwrite these defaults
-      def initialize(&block)
-        load_defaults!
-
-        @port   ||= 22
-        @path   ||= 'backups'
-        @local  ||= false
-
-        instance_eval(&block) if block_given?
-        write_password_file!
-
-        @time = TIME
-        @path = path.sub(/^\~\//, '')
-      end
-
       ##
       # This is the remote path to where the backup files will be stored
       def remote_path
@@ -56,60 +38,67 @@ module Backup
       ##
       # Performs the backup transfer
       def perform!
+        super
+        write_password_file!
         transfer!
+      ensure
         remove_password_file!
       end
 
-      ##
-      # Returns Rsync syntax for defining a port to connect to
-      def port
-        "-e 'ssh -p #{@port}'"
-      end
+    private
 
       ##
-      # Returns Rsync syntax for using a password file
-      def password
-        "--password-file='#{@password_file.path}'" unless @password.nil?
+      # Set configuration defaults before evaluating configuration block,
+      # after setting defaults from Storage::Base
+      def pre_configure
+        super
+        @port   ||= 22
+        @path   ||= 'backups'
+        @local  ||= false
       end
 
       ##
-      # RSync options
-      # -z = Compresses the bytes that will be transferred to reduce bandwidth usage
-      def options
-        "-z"
+      # Adjust configuration after evaluating configuration block,
+      # after adjustments from Storage::Base
+      def post_configure
+        super
+        @path = path.sub(/^\~\//, '')
       end
 
-    private
-
       ##
       # Establishes a connection to the remote server and returns the Net::SSH object.
-      # Not doing any instance variable caching because this object gets persisted in YAML
-      # format to a file and will issues. This, however has no impact on performance since it only
-      # gets invoked once per object for a #transfer! and once for a remove! Backups run in the
-      # background anyway so even if it were a bit slower it shouldn't matter.
       def connection
-        Net::SSH.start(ip, username, :password => @password, :port => @port)
+        Net::SSH.start(ip, username, :password => password, :port => port) do |ssh|
+          yield ssh
+        end
       end
 
       ##
       # Transfers the archived file to the specified remote server
       def transfer!
-        Logger.message("#{ self.class } started transferring \"#{ remote_file }\".")
         create_remote_directories!
-        if @local
-          run("#{ utility(:rsync) } '#{ File.join(local_path, local_file) }' '#{ File.join(remote_path, TIME+'.'+remote_file[20..-1]) }'")
+
+        Logger.message "#{storage_name} started transferring " +
+            "'#{ filename }' to '#{ ip }'."
+
+        if local
+          run(
+            "#{ utility(:rsync) } '#{ File.join(local_path, filename) }' " +
+            "'#{ File.join(remote_path, filename[20..-1]) }'"
+          )
         else
-          run("#{ utility(:rsync) } #{ options } #{ port } #{ password } '#{ File.join(local_path, local_file) }' '#{ username }@#{ ip }:#{ File.join(remote_path, remote_file[20..-1]) }'")
+          run(
+            "#{ utility(:rsync) } #{ rsync_options } #{ rsync_port } " +
+            "#{ rsync_password_file } '#{ File.join(local_path, filename) }' " +
+            "'#{ username }@#{ ip }:#{ File.join(remote_path, filename[20..-1]) }'"
+          )
         end
       end
 
       ##
-      # Removes the transferred archive file from the server
+      # Note: RSync::Storage doesn't cycle
       def remove!
-        response = connection.exec!("rm #{ File.join(remote_path, remote_file) }")
-        if response =~ /No such file or directory/
-          Logger.warn "Could not remove file \"#{ File.join(remote_path, remote_file) }\"."
-        end
+        nil
       end
 
       ##
@@ -119,7 +108,9 @@ module Backup
         if @local
           mkdir(remote_path)
         else
-          connection.exec!("mkdir -p '#{ remote_path }'")
+          connection do |ssh|
+            ssh.exec!("mkdir -p '#{ remote_path }'")
+          end
         end
       end
 
@@ -127,9 +118,9 @@ module Backup
       # Writes the provided password to a temporary file so that
       # the rsync utility can read the password from this file
       def write_password_file!
-        unless @password.nil?
+        unless password.nil?
           @password_file = Tempfile.new('backup-rsync-password')
-          @password_file.write(@password)
+          @password_file.write(password)
           @password_file.close
         end
       end
@@ -138,7 +129,26 @@ module Backup
       # Removes the previously created @password_file
       # (temporary file containing the password)
       def remove_password_file!
-        @password_file.unlink unless @password.nil?
+        @password_file.delete if @password_file
+      end
+
+      ##
+      # Returns Rsync syntax for using a password file
+      def rsync_password_file
+        "--password-file='#{@password_file.path}'" if @password_file
+      end
+
+      ##
+      # Returns Rsync syntax for defining a port to connect to
+      def rsync_port
+        "-e 'ssh -p #{port}'"
+      end
+
+      ##
+      # RSync options
+      # -z = Compresses the bytes that will be transferred to reduce bandwidth usage
+      def rsync_options
+        "-z"
       end
 
     end