backup-ssh 4.1.10 → 4.4.0

data/lib/backup/notifier/http_post.rb

@@ -95,18 +95,13 @@ module Backup
       # : Notification will be sent if `on_warning` or `on_success` is `true`.
       #
       def notify!(status)
-        tag = case status
-              when :success then '[Backup::Success]'
-              when :failure then '[Backup::Failure]'
-              when :warning then '[Backup::Warning]'
-              end
-        message = "#{ tag } #{ model.label } (#{ model.trigger })"
+        msg = message.call(model, :status => status_data_for(status))
 
         opts = {
           :headers => { 'User-Agent' => "Backup/#{ VERSION }" }.
               merge(headers).reject {|k,v| v.nil? }.
               merge('Content-Type' => 'application/x-www-form-urlencoded'),
-          :body => URI.encode_www_form({ 'message' => message }.
+          :body => URI.encode_www_form({ 'message' => msg }.
               merge(params).reject {|k,v| v.nil? }.
               merge('status' => status.to_s)),
           :expects => success_codes # raise error if unsuccessful

data/lib/backup/notifier/mail.rb

@@ -37,6 +37,18 @@ module Backup
       # Receiver Email Address
       attr_accessor :to
 
+      ##
+      # CC receiver Email Address
+      attr_accessor :cc
+
+      ##
+      # BCC receiver Email Address
+      attr_accessor :bcc
+
+      ##
+      # Set reply to email address
+      attr_accessor :reply_to
+
       ##
       # SMTP Server Address
       attr_accessor :address
@@ -148,14 +160,8 @@ module Backup
       # : backup log, if `on_failure` is `true`.
       #
       def notify!(status)
-        tag = case status
-              when :success then '[Backup::Success]'
-              when :warning then '[Backup::Warning]'
-              when :failure then '[Backup::Failure]'
-              end
-
         email = new_email
-        email.subject = "#{ tag } #{ model.label } (#{ model.trigger })"
+        email.subject = message.call(model, :status => status_data_for(status))
 
         send_log = send_log_on.include?(status)
         template = Backup::Template.new({ :model => model, :send_log => send_log })
@@ -182,9 +188,9 @@ module Backup
         options =
             case method
             when 'smtp'
-              { :address              => @address,
+              opts = {
+                :address              => @address,
                 :port                 => @port,
-                :domain               => @domain,
                 :user_name            => @user_name,
                 :password             => @password,
                 :authentication       => @authentication,
@@ -193,6 +199,11 @@ module Backup
                 :ssl                  => @encryption == :ssl,
                 :tls                  => @encryption == :tls
               }
+
+              # Don't override default domain setting if domain not applicable.
+              # ref https://github.com/mikel/mail/blob/2.6.3/lib/mail/network/delivery_methods/smtp.rb#L82
+              opts[:domain] = @domain if @domain
+              opts
             when 'sendmail'
               opts = {}
               opts.merge!(:location  => utility(:sendmail))
@@ -209,13 +220,13 @@ module Backup
             when 'test' then {}
             end
 
-        ::Mail.defaults do
-          delivery_method method.to_sym, options
-        end
-
         email = ::Mail.new
-        email.to   = @to
-        email.from = @from
+        email.delivery_method method.to_sym, options
+        email.to       = to
+        email.from     = from
+        email.cc       = cc
+        email.bcc      = bcc
+        email.reply_to = reply_to
         email
       end
 

data/lib/backup/notifier/nagios.rb

@@ -14,8 +14,8 @@ module Backup
 
       ##
       # Nagios nrpe configuration file.
-      attr_accessor :send_nsca_cfg     
- 
+      attr_accessor :send_nsca_cfg
+
       ##
       # Name of the Nagios service for the backup check.
       attr_accessor :service_name
@@ -55,12 +55,7 @@ module Backup
       # : Notification will be sent if `on_warning` or `on_success` is `true`.
       #
       def notify!(status)
-        message = case status
-              when :success then 'Completed Successfully'
-              when :warning then 'Completed Successfully (with Warnings)'
-              when :failure then 'Failed'
-              end
-        send_message("#{ message } in #{ model.duration }")
+        send_message(message.call(model, :status => status_data_for(status)))
       end
 
       def send_message(message)

data/lib/backup/notifier/prowl.rb

@@ -16,6 +16,9 @@ module Backup
       attr_accessor :api_key
 
       def initialize(model, &block)
+        @message = lambda do |model, data|
+          "#{ model.label } (#{ model.trigger })"
+        end
         super
         instance_eval(&block) if block_given?
       end
@@ -40,21 +43,17 @@ module Backup
       # : Notification will be sent if `on_warning` or `on_success` is `true`.
       #
       def notify!(status)
-        tag = case status
-              when :success then '[Backup::Success]'
-              when :warning then '[Backup::Warning]'
-              when :failure then '[Backup::Failure]'
-              end
-        send_message(tag)
+        send_message(status)
       end
 
-      def send_message(message)
+      def send_message(status)
         uri = 'https://api.prowlapp.com/publicapi/add'
+        status_data = status_data_for(status)
         data = {
           :application  => application,
           :apikey       => api_key,
-          :event        => message,
-          :description  => "#{ model.label } (#{ model.trigger })"
+          :event        => status_data[:message],
+          :description  => message.call(model, :status => status_data)
         }
         options = {
           :headers  => { 'Content-Type' => 'application/x-www-form-urlencoded' },

data/lib/backup/notifier/pushover.rb

@@ -51,13 +51,7 @@ module Backup
       # : Notification will be sent if `on_warning` or `on_success` is `true`.
       #
       def notify!(status)
-        tag = case status
-              when :success then '[Backup::Success]'
-              when :failure then '[Backup::Failure]'
-              when :warning then '[Backup::Warning]'
-              end
-        message = "#{ tag } #{ model.label } (#{ model.trigger })"
-        send_message(message)
+        send_message(message.call(model, :status => status_data_for(status)))
       end
 
       def send_message(message)

data/lib/backup/notifier/ses.rb

@@ -21,6 +21,18 @@ module Backup
       # Receiver Email Address
       attr_accessor :to
 
+      ##
+      # CC receiver Email Address
+      attr_accessor :cc
+
+      ##
+      # BCC receiver Email Address
+      attr_accessor :bcc
+
+      ##
+      # Set reply to email address
+      attr_accessor :reply_to
+
       def initialize(model, &block)
         super
         instance_eval(&block) if block_given?
@@ -66,14 +78,13 @@ module Backup
       # : backup log, if `on_failure` is `true`.
       #
       def notify!(status)
-        tag = case status
-                when :success then '[Backup::Success]'
-                when :warning then '[Backup::Warning]'
-                when :failure then '[Backup::Failure]'
-              end
-
-        email = ::Mail.new(:to => to, :from => from)
-        email.subject = "#{ tag } #{ model.label } (#{ model.trigger })"
+        email = ::Mail.new
+        email.to       = to
+        email.from     = from
+        email.cc       = cc
+        email.bcc      = bcc
+        email.reply_to = reply_to
+        email.subject  = message.call(model, :status => status_data_for(status))
 
         send_log = send_log_on.include?(status)
         template = Backup::Template.new({ :model => model, :send_log => send_log })

data/lib/backup/notifier/slack.rb

@@ -61,21 +61,15 @@ module Backup
       # : Notification will be sent if `on_warning` or `on_success` is `true`.
       #
       def notify!(status)
-        tag = case status
-              when :success then '[Backup::Success]'
-              when :failure then '[Backup::Failure]'
-              when :warning then '[Backup::Warning]'
-              end
-        message = "#{ tag } #{ model.label } (#{ model.trigger })"
-
-        data = { :text => message }
+        data = {
+          :text => message.call(model, :status => status_data_for(status)),
+          :attachments => [attachment(status)]
+        }
         [:channel, :username, :icon_emoji].each do |param|
           val = send(param)
           data.merge!(param => val) if val
         end
 
-        data.merge!(:attachments => [attachment(status)])
-
         options = {
           :headers  => { 'Content-Type' => 'application/x-www-form-urlencoded' },
           :body     => URI.encode_www_form(:payload => JSON.dump(data))

data/lib/backup/notifier/twitter.rb

@@ -38,13 +38,7 @@ module Backup
       # : Notification will be sent if `on_warning` or `on_success` is `true`.
       #
       def notify!(status)
-        tag = case status
-              when :success then '[Backup::Success]'
-              when :warning then '[Backup::Warning]'
-              when :failure then '[Backup::Failure]'
-              end
-        message = "#{ tag } #{ model.label } (#{ model.trigger }) (@ #{ model.time })"
-        send_message(message)
+        send_message(message.call(model, :status => status_data_for(status)))
       end
 
       # Twitter::Client will raise an error if unsuccessful.

data/lib/backup/notifier/zabbix.rb

@@ -45,12 +45,7 @@ module Backup
       # : Notification will be sent if `on_warning` or `on_success` is `true`.
       #
       def notify!(status)
-        message = case status
-              when :success then 'Completed Successfully'
-              when :warning then 'Completed Successfully (with Warnings)'
-              when :failure then 'Failed'
-              end
-        send_message("#{ message } in #{ model.duration }")
+        send_message(message.call(model, :status => status_data_for(status)))
       end
 
       def send_message(message)

data/lib/backup/package.rb

@@ -47,5 +47,9 @@ module Backup
       "#{ trigger }.#{ extension }"
     end
 
+    def time_as_object
+      Time.strptime(time, '%Y.%m.%d.%H.%M.%S')
+    end
+
   end
 end

data/lib/backup/packager.rb

@@ -42,8 +42,11 @@ module Backup
         # The command's output will then be either piped to the Encryptor
         # or the Splitter (if no Encryptor), or through `cat` into the final
         # output file if neither are configured.
-        @pipeline << "#{ utility(:tar) } -cf - " +
-            "-C '#{ Config.tmp_path }' '#{ @package.trigger }'"
+        @pipeline.add(
+          "#{ utility(:tar) } -cf - " +
+          "-C '#{ Config.tmp_path }' '#{ @package.trigger }'",
+          tar_success_codes
+        )
 
         ##
         # If an Encryptor was configured, it will be called first
@@ -96,6 +99,9 @@ module Backup
         stack.shift
       end
 
+      def tar_success_codes
+        gnu_tar? ? [0, 1] : [0]
+      end
     end
   end
 end

data/lib/backup/storage/base.rb

@@ -10,8 +10,18 @@ module Backup
       attr_accessor :path
 
       ##
-      # Sets the limit to how many backups to keep in the remote location.
-      # If exceeded, the oldest will be removed to make room for the newest
+      # Number of backups to keep or time until which to keep.
+      #
+      # If an Integer is given it sets the limit to how many backups to keep in
+      # the remote location. If exceeded, the oldest will be removed to make
+      # room for the newest.
+      #
+      # If a Time object is given it will remove backups _older_ than the given
+      # date.
+      #
+      # @!attribute [rw] keep
+      #   @param [Integer|Time]
+      #   @return [Integer|Time]
       attr_accessor :keep
 
       attr_reader :model, :package, :storage_id
@@ -33,7 +43,9 @@ module Backup
       def perform!
         Logger.info "#{ storage_name } Started..."
         transfer!
-        cycle! if respond_to?(:cycle!, true) && keep.to_i > 0
+        if respond_to?(:cycle!, true) && (keep.to_i > 0 || keep.is_a?(Time))
+          cycle!
+        end
         Logger.info "#{ storage_name } Finished!"
       end
 

data/lib/backup/storage/cycler.rb

@@ -14,24 +14,34 @@ module Backup
         Logger.info 'Cycling Started...'
 
         packages = yaml_load.unshift(package)
-        excess = packages.count - keep.to_i
+        cycled_packages = []
 
-        if excess > 0
-          packages.pop(excess).each do |pkg|
-            begin
-              remove!(pkg) unless pkg.no_cycle
-            rescue => err
-              Logger.warn Error.wrap(err, <<-EOS)
-                There was a problem removing the following package:
-                Trigger: #{pkg.trigger} :: Dated: #{pkg.time}
-                Package included the following #{ pkg.filenames.count } file(s):
-                #{ pkg.filenames.join("\n") }
-              EOS
-            end
+        if keep.is_a?(Date) || keep.is_a?(Time)
+          cycled_packages = packages.select do |p|
+            p.time_as_object < keep.to_time
           end
+        else
+          excess = packages.count - keep.to_i
+          cycled_packages = packages.last(excess) if excess > 0
         end
 
-        yaml_save(packages)
+        saved_packages = packages - cycled_packages
+        cycled_packages.each { |package| delete_package package }
+
+        yaml_save(saved_packages)
+      end
+
+      def delete_package(package)
+        begin
+          remove!(package) unless package.no_cycle
+        rescue => err
+          Logger.warn Error.wrap(err, <<-EOS)
+            There was a problem removing the following package:
+            Trigger: #{package.trigger} :: Dated: #{package.time}
+            Package included the following #{ package.filenames.count } file(s):
+            #{ package.filenames.join("\n") }
+          EOS
+        end
       end
 
       # Returns path to the YAML data file.

data/lib/backup/storage/dropbox.rb

@@ -210,27 +210,3 @@ module Backup
     end
   end
 end
-
-# Patch for dropbox-ruby-sdk-1.5.1
-class DropboxClient
-  class ChunkedUploader
-    def upload(chunk_size = 1024**2 * 4)
-      while @offset < @total_size
-        @file_obj.seek(@offset) unless @file_obj.pos == @offset
-        data = @file_obj.read(chunk_size)
-
-        begin
-          resp = @client.parse_response(
-            @client.partial_chunked_upload(data, @upload_id, @offset)
-          )
-        rescue DropboxError => err
-          resp = JSON.parse(err.http_response.body) rescue {}
-          raise err unless resp['offset']
-        end
-
-        @offset = resp['offset']
-        @upload_id ||= resp['upload_id']
-      end
-    end
-  end
-end

data/lib/backup/storage/ftp.rb

@@ -15,15 +15,25 @@ module Backup
       attr_accessor :ip, :port
 
       ##
-      # use passive mode?
+      # Use passive mode?
       attr_accessor :passive_mode
 
+      ##
+      # Configure connection open and read timeouts.
+      # Net::FTP's open_timeout and read_timeout will both be configured using
+      # this setting.
+      # @!attribute [rw] timeout
+      #   @param [Integer|Float]
+      #   @return [Integer|Float]
+      attr_accessor :timeout
+
       def initialize(model, storage_id = nil)
         super
 
         @port         ||= 21
         @path         ||= 'backups'
         @passive_mode ||= false
+        @timeout      ||= nil
         path.sub!(/^~\//, '')
       end
 
@@ -42,6 +52,10 @@ module Backup
         end; Net::FTP.send(:const_set, :FTP_PORT, port)
 
         Net::FTP.open(ip, username, password) do |ftp|
+          if timeout
+            ftp.open_timeout = timeout
+            ftp.read_timeout = timeout
+          end
           ftp.passive = true if passive_mode
           yield ftp
         end