backup 3.6.0 → 3.7.0

data/lib/backup/notifier/http_post.rb

@@ -0,0 +1,122 @@
+# encoding: utf-8
+require 'uri'
+
+module Backup
+  module Notifier
+    class HttpPost < Base
+
+      ##
+      # URI to post notification to.
+      #
+      # URI scheme may be `http` or `https`.
+      #
+      # If Basic Authentication is needed, supply the `user:password` in the URI.
+      # e.g. 'https://user:pass@www.example.com/path'
+      #
+      # Port may also be supplied.
+      # e.g. 'http://www.example.com:8080/path'
+      attr_accessor :uri
+
+      ##
+      # Hash of additional HTTP headers to send.
+      #
+      # This notifier sets the following headers:
+      # { 'User-Agent'   => "Backup/#{ Backup::VERSION }",
+      #   'Content-Type' => 'x-www-form-urlencoded' }
+      #
+      # 'Content-Type' may not be changed.
+      # 'User-Agent' may be overridden or omitted by setting it to +nil+.
+      # e.g. { 'Authorization' => 'my_auth_info', 'User-Agent' => nil }
+      attr_accessor :headers
+
+      ##
+      # Hash of additional POST parameters to send.
+      #
+      # This notifier will set two parameters:
+      # { 'status'  => 'success|warning|failure',
+      #   'message' => '[Backup::(Success|Warning|Failure)] label (trigger)' }
+      #
+      # 'status' may not be changed.
+      # 'message' may be overridden or omitted by setting a +nil+ value.
+      # e.g. { 'auth_token' => 'my_token', 'message' => nil }
+      attr_accessor :params
+
+      ##
+      # Successful HTTP Status Code(s) that should be returned.
+      #
+      # This may be a single code or an Array of acceptable codes.
+      # e.g. [200, 201, 204]
+      #
+      # If any other response code is returned, the request will be retried
+      # using `max_retries` and `retry_waitsec`.
+      #
+      # Default: 200
+      attr_accessor :success_codes
+
+      ##
+      # Verify the server's certificate when using SSL.
+      #
+      # This will default to +true+ for most systems.
+      # It may be forced by setting to +true+, or disabled by setting to +false+.
+      attr_accessor :ssl_verify_peer
+
+      ##
+      # Path to a +cacert.pem+ file to use for +ssl_verify_peer+.
+      #
+      # This is provided (via Excon), but may be specified if needed.
+      attr_accessor :ssl_ca_file
+
+      def initialize(model, &block)
+        super
+        instance_eval(&block) if block_given?
+
+        @headers ||= {}
+        @params  ||= {}
+        @success_codes ||= 200
+      end
+
+      private
+
+      ##
+      # Notify the user of the backup operation results.
+      #
+      # `status` indicates one of the following:
+      #
+      # `:success`
+      # : The backup completed successfully.
+      # : Notification will be sent if `on_success` is `true`.
+      #
+      # `:warning`
+      # : The backup completed successfully, but warnings were logged.
+      # : Notification will be sent if `on_warning` or `on_success` is `true`.
+      #
+      # `:failure`
+      # : The backup operation failed.
+      # : 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 })"
+
+        opts = {
+          :headers => { 'User-Agent' => "Backup/#{ VERSION }" }.
+              merge(headers).reject {|k,v| v.nil? }.
+              merge('Content-Type' => 'application/x-www-form-urlencoded'),
+          :body => encode_www_form({ 'message' => message }.
+              merge(params).reject {|k,v| v.nil? }.
+              merge('status' => status.to_s)),
+          :expects => success_codes # raise error if unsuccessful
+        }
+        opts.merge!(:ssl_verify_peer => ssl_verify_peer) unless ssl_verify_peer.nil?
+        opts.merge!(:ssl_ca_file => ssl_ca_file) if ssl_ca_file
+
+        Excon.post(uri, opts)
+      end
+
+    end
+  end
+end

data/lib/backup/notifier/mail.rb

@@ -240,3 +240,41 @@ module Backup
     end
   end
 end
+
+# Patch mail v2.5.4 Exim delivery method
+# https://github.com/meskyanichi/backup/issues/446
+# https://github.com/mikel/mail/pull/546
+module Mail
+  class Exim
+    def self.call(path, arguments, destinations, encoded_message)
+      popen "#{path} #{arguments}" do |io|
+        io.puts encoded_message.to_lf
+        io.flush
+      end
+    end
+  end
+end
+
+# Patch mail v2.5.4 for ruby-1.8.7
+# https://github.com/mikel/mail/issues/548
+# https://github.com/mikel/mail/commit/c7318a6c03c1ecb3f574ccd2e3f06778687d1d15
+if RUBY_VERSION < '1.9'
+  module Mail
+    class SMTP
+      private
+      def ssl_context
+        openssl_verify_mode = settings[:openssl_verify_mode]
+
+        if openssl_verify_mode.kind_of?(String)
+          openssl_verify_mode = "OpenSSL::SSL::VERIFY_#{openssl_verify_mode.upcase}".constantize
+        end
+
+        context = Net::SMTP.default_ssl_context
+        context.verify_mode = openssl_verify_mode
+        context.ca_path = settings[:ca_path] if settings[:ca_path]
+        context.ca_file = settings[:ca_file] if settings[:ca_file]
+        context
+      end
+    end
+  end
+end

data/lib/backup/notifier/nagios.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+
+module Backup
+  module Notifier
+    class Nagios < Base
+
+      ##
+      # Host of Nagios server to notify on backup completion.
+      attr_accessor :nagios_host
+
+      ##
+      # Port of Nagios server to notify on backup completion.
+      attr_accessor :nagios_port
+
+      ##
+      # Name of the Nagios service for the backup check.
+      attr_accessor :service_name
+
+      ##
+      # Host name in Nagios for the backup check.
+      attr_accessor :service_host
+
+      def initialize(model, &block)
+        super
+        instance_eval(&block) if block_given?
+
+        @nagios_host  ||= Config.hostname
+        @nagios_port  ||= 5667
+        @service_name ||= "Backup #{ model.trigger }"
+        @service_host ||= Config.hostname
+      end
+
+      private
+
+      ##
+      # Notify the user of the backup operation results.
+      #
+      # `status` indicates one of the following:
+      #
+      # `:success`
+      # : The backup completed successfully.
+      # : Notification will be sent if `on_success` is `true`.
+      #
+      # `:warning`
+      # : The backup completed successfully, but warnings were logged.
+      # : Notification will be sent if `on_warning` or `on_success` is `true`.
+      #
+      # `:failure`
+      # : The backup operation failed.
+      # : 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 }")
+      end
+
+      def send_message(message)
+        cmd = "#{ utility(:send_nsca) } -H '#{ nagios_host }' -p '#{ nagios_port }'"
+        msg = [service_host, service_name, model.exit_status, message].join("\t")
+        run("echo '#{ msg }' | #{ cmd }")
+      end
+
+    end
+  end
+end

data/lib/backup/notifier/prowl.rb

@@ -1,5 +1,4 @@
 # encoding: utf-8
-require 'excon'
 require 'uri'
 
 module Backup

data/lib/backup/notifier/pushover.rb

@@ -1,5 +1,4 @@
 # encoding: utf-8
-require 'excon'
 require 'uri'
 
 module Backup

data/lib/backup/package.rb

@@ -19,6 +19,10 @@ module Backup
     # Set by the Splitter if the final archive was "chunked"
     attr_accessor :chunk_suffixes
 
+    ##
+    # If true, the Cycler will not attempt to remove the package when Cycling.
+    attr_accessor :no_cycle
+
     ##
     # The version of Backup used to create the package
     attr_reader :version
@@ -27,6 +31,7 @@ module Backup
       @trigger = model.trigger
       @extension = 'tar'
       @chunk_suffixes = Array.new
+      @no_cycle = false
       @version = VERSION
     end
 

data/lib/backup/packager.rb

@@ -2,6 +2,8 @@
 
 module Backup
   module Packager
+    class Error < Backup::Error; end
+
     class << self
       include Backup::Utilities::Helpers
 
@@ -19,8 +21,7 @@ module Backup
         if @pipeline.success?
           Logger.info "Packaging Complete!"
         else
-          raise Errors::Packager::PipelineError,
-              "Failed to Create Backup Package\n" +
+          raise Error, "Failed to Create Backup Package\n" +
               @pipeline.error_messages
         end
       end

data/lib/backup/pipeline.rb

@@ -2,6 +2,8 @@
 
 module Backup
   class Pipeline
+    class Error < Backup::Error; end
+
     include Backup::Utilities::Helpers
 
     attr_reader :stderr, :errors
@@ -63,8 +65,8 @@ module Backup
         @stderr = stderr.read.strip
       end
       Logger.warn(stderr_messages) if success? && stderr_messages
-    rescue Exception => e
-      raise Errors::Pipeline::ExecutionError.wrap(e)
+    rescue Exception => err
+      raise Error.wrap(err, 'Pipeline failed to execute')
     end
 
     def success?

data/lib/backup/storage/base.rb

@@ -21,12 +21,13 @@ module Backup
       # multiple storages of the same type. If multiple storages of the same
       # type are added to a single backup model, this identifier must be set.
       # This will be appended to the YAML storage file used for cycling backups.
-      def initialize(model, storage_id = nil)
+      def initialize(model, storage_id = nil, &block)
         @model = model
         @package = model.package
         @storage_id = storage_id.to_s.gsub(/\W/, '_') if storage_id
 
         load_defaults!
+        instance_eval(&block) if block_given?
       end
 
       def perform!

data/lib/backup/storage/cloud_files.rb

@@ -0,0 +1,151 @@
+# encoding: utf-8
+require 'backup/cloud_io/cloud_files'
+
+module Backup
+  module Storage
+    class CloudFiles < Base
+      class Error < Backup::Error; end
+
+      ##
+      # Rackspace CloudFiles Credentials
+      attr_accessor :username, :api_key
+
+      ##
+      # Rackspace Auth URL (optional)
+      attr_accessor :auth_url
+
+      ##
+      # Rackspace Service Net
+      # (LAN-based transfers to avoid charges and improve performance)
+      attr_accessor :servicenet
+
+      ##
+      # Rackspace Region (optional)
+      attr_accessor :region
+
+      ##
+      # Rackspace Container Name
+      attr_accessor :container
+
+      ##
+      # Rackspace Container Name for SLO Segments
+      # Required if #segment_size is set. Must be different from #container.
+      attr_accessor :segments_container
+
+      ##
+      # SLO Segment size, specified in MiB.
+      #
+      # Each package file larger than +segment_size+
+      # will be uploaded as a Static Large Objects (SLO).
+      #
+      # Defaults to 0 for backward compatibility (pre v.3.7.0),
+      # since #segments_container would be required.
+      #
+      # Minimum: 1 (0 disables SLO support)
+      # Maximum: 5120 (5 GiB)
+      attr_accessor :segment_size
+
+      ##
+      # If set, all backup package files (including SLO segments) will be
+      # scheduled for automatic removal by the server.
+      #
+      # The `keep` option should not be used if this is set,
+      # unless you're transitioning from the `keep` option.
+      attr_accessor :days_to_keep
+
+      ##
+      # Number of times to retry failed operations.
+      #
+      # Default: 10
+      attr_accessor :max_retries
+
+      ##
+      # Time in seconds to pause before each retry.
+      #
+      # Default: 30
+      attr_accessor :retry_waitsec
+
+      def initialize(model, storage_id = nil)
+        super
+
+        @servicenet         ||= false
+        @segment_size       ||= 0
+        @max_retries        ||= 10
+        @retry_waitsec      ||= 30
+
+        @path ||= 'backups'
+        path.sub!(/^\//, '')
+
+        check_configuration
+      end
+
+      private
+
+      def cloud_io
+        @cloud_io ||= CloudIO::CloudFiles.new(
+          :username           => username,
+          :api_key            => api_key,
+          :auth_url           => auth_url,
+          :region             => region,
+          :servicenet         => servicenet,
+          :container          => container,
+          :segments_container => segments_container,
+          :segment_size       => segment_size,
+          :days_to_keep       => days_to_keep,
+          :max_retries        => max_retries,
+          :retry_waitsec      => retry_waitsec
+        )
+      end
+
+      def transfer!
+        package.filenames.each do |filename|
+          src = File.join(Config.tmp_path, filename)
+          dest = File.join(remote_path, filename)
+          Logger.info "Storing '#{ container }/#{ dest }'..."
+          cloud_io.upload(src, dest)
+        end
+
+        package.no_cycle = true if days_to_keep
+      end
+
+      # Called by the Cycler.
+      # Any error raised will be logged as a warning.
+      def remove!(package)
+        Logger.info "Removing backup package dated #{ package.time }..."
+
+        remote_path = remote_path_for(package)
+        objects = cloud_io.objects(remote_path)
+
+        raise Error, "Package at '#{ remote_path }' not found" if objects.empty?
+
+        slo_objects, objects = objects.partition(&:slo?)
+        cloud_io.delete_slo(slo_objects)
+        cloud_io.delete(objects)
+      end
+
+      def check_configuration
+        required = %w{ username api_key container }
+        raise Error, <<-EOS if required.map {|name| send(name) }.any?(&:nil?)
+          Configuration Error
+          #{ required.map {|name| "##{ name }"}.join(', ') } are all required
+        EOS
+
+        raise Error, <<-EOS if segment_size > 0 && segments_container.to_s.empty?
+          Configuration Error
+          #segments_container is required if #segment_size is > 0
+        EOS
+
+        raise Error, <<-EOS if container == segments_container
+          Configuration Error
+          #container and #segments_container must not be the same container.
+        EOS
+
+        raise Error, <<-EOS if segment_size > 5120
+          Configuration Error
+          #segment_size is too large (max 5120)
+        EOS
+      end
+
+    end
+  end
+end