backup_zh 4.0.3.1

data/lib/backup/notifier/mail.rb

@@ -0,0 +1,238 @@
+# encoding: utf-8
+require 'mail'
+
+module Backup
+  module Notifier
+    class Mail < Base
+
+      ##
+      # Mail delivery method to be used by the Mail gem.
+      #
+      # Supported methods:
+      #
+      # [:smtp - ::Mail::SMTP (default)]
+      #   Settings used by this method:
+      #   {#address}, {#port}, {#domain}, {#user_name}, {#password},
+      #   {#authentication}, {#encryption}, {#openssl_verify_mode}
+      #
+      # [:sendmail - ::Mail::Sendmail]
+      #   Settings used by this method:
+      #   {#sendmail_args}
+      #
+      # [:exim - ::Mail::Exim]
+      #   Settings used by this method:
+      #   {#exim_args}
+      #
+      # [:file - ::Mail::FileDelivery]
+      #   Settings used by this method:
+      #   {#mail_folder}
+      #
+      attr_accessor :delivery_method
+
+      ##
+      # Sender Email Address
+      attr_accessor :from
+
+      ##
+      # Receiver Email Address
+      attr_accessor :to
+
+      ##
+      # SMTP Server Address
+      attr_accessor :address
+
+      ##
+      # SMTP Server Port
+      attr_accessor :port
+
+      ##
+      # Your domain (if applicable)
+      attr_accessor :domain
+
+      ##
+      # SMTP Server Username (sender email's credentials)
+      attr_accessor :user_name
+
+      ##
+      # SMTP Server Password (sender email's credentials)
+      attr_accessor :password
+
+      ##
+      # Authentication type
+      #
+      # Acceptable values: +:plain+, +:login+, +:cram_md5+
+      attr_accessor :authentication
+
+      ##
+      # Set the method of encryption to be used for the +SMTP+ connection.
+      #
+      # [:starttls (default)]
+      #   Use +STARTTLS+ to upgrade the connection to a +SSL/TLS+ connection.
+      #
+      # [:tls or :ssl]
+      #   Use a +SSL/TLS+ connection.
+      #
+      # [:none]
+      #   No encryption will be used.
+      attr_accessor :encryption
+
+      ##
+      # OpenSSL Verify Mode
+      #
+      # Valid modes: +:none+, +:peer+, +:client_once+, +:fail_if_no_peer_cert+
+      # See +OpenSSL::SSL+ for details.
+      #
+      # Use +:none+ for a self-signed and/or wildcard certificate
+      attr_accessor :openssl_verify_mode
+
+      ##
+      # Optional arguments to pass to `sendmail`
+      #
+      # Note that this will override the defaults set by the Mail gem
+      # (currently: '-i'). So, if set here, be sure to set all the arguments
+      # you require.
+      #
+      # Example: '-i -X/tmp/traffic.log'
+      attr_accessor :sendmail_args
+
+      ##
+      # Optional arguments to pass to `exim`
+      #
+      # Note that this will override the defaults set by the Mail gem
+      # (currently: '-i -t') So, if set here, be sure to set all the arguments
+      # you require.
+      #
+      # Example: '-i -t -X/tmp/traffic.log'
+      attr_accessor :exim_args
+
+      ##
+      # Folder where mail will be kept when using the `:file` `delivery_method`.
+      #
+      # Default location is '$HOME/Backup/emails'
+      attr_accessor :mail_folder
+
+      ##
+      # Array of statuses for which the log file should be attached.
+      #
+      # Available statuses are: `:success`, `:warning` and `:failure`.
+      # Default: [:warning, :failure]
+      attr_accessor :send_log_on
+
+      def initialize(model, &block)
+        super
+        instance_eval(&block) if block_given?
+
+        @send_log_on ||= [:warning, :failure]
+        @encryption  ||= :starttls
+      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, including a copy of the current
+      # : backup log, if `on_warning` or `on_success` is `true`.
+      #
+      # `:failure`
+      # : The backup operation failed.
+      # : Notification will be sent, including a copy of the current
+      # : 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 })"
+
+        send_log = send_log_on.include?(status)
+        template = Backup::Template.new({ :model => model, :send_log => send_log })
+        email.body = template.result('notifier/mail/%s.erb' % status.to_s)
+
+        if send_log
+          email.convert_to_multipart
+          email.attachments["#{ model.time }.#{ model.trigger }.log"] = {
+            :mime_type => 'text/plain;',
+            :content   => Logger.messages.map(&:formatted_lines).flatten.join("\n")
+          }
+        end
+
+        email.deliver! # raise error if unsuccessful
+      end
+
+      ##
+      # Configures the Mail gem by setting the defaults.
+      # Creates and returns a new email, based on the @delivery_method used.
+      def new_email
+        method = %w{ smtp sendmail exim file test }.
+            index(@delivery_method.to_s) ? @delivery_method.to_s : 'smtp'
+
+        options =
+            case method
+            when 'smtp'
+              { :address              => @address,
+                :port                 => @port,
+                :domain               => @domain,
+                :user_name            => @user_name,
+                :password             => @password,
+                :authentication       => @authentication,
+                :enable_starttls_auto => @encryption == :starttls,
+                :openssl_verify_mode  => @openssl_verify_mode,
+                :ssl                  => @encryption == :ssl,
+                :tls                  => @encryption == :tls
+              }
+            when 'sendmail'
+              opts = {}
+              opts.merge!(:location  => utility(:sendmail))
+              opts.merge!(:arguments => @sendmail_args) if @sendmail_args
+              opts
+            when 'exim'
+              opts = {}
+              opts.merge!(:location  => utility(:exim))
+              opts.merge!(:arguments => @exim_args) if @exim_args
+              opts
+            when 'file'
+              @mail_folder ||= File.join(Config.root_path, 'emails')
+              { :location => File.expand_path(@mail_folder) }
+            when 'test' then {}
+            end
+
+        ::Mail.defaults do
+          delivery_method method.to_sym, options
+        end
+
+        email = ::Mail.new
+        email.to   = @to
+        email.from = @from
+        email
+      end
+
+    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

data/lib/backup/notifier/nagios.rb

@@ -0,0 +1,74 @@
+# 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
+
+      ##
+      # Nagios nrpe configuration file.
+      attr_accessor :send_nsca_cfg     
+ 
+      ##
+      # 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
+        @send_nsca_cfg||= "/etc/nagios/send_nsca.cfg"
+        @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 }' -c '#{ send_nsca_cfg }'"
+        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

@@ -0,0 +1,69 @@
+# encoding: utf-8
+require 'uri'
+
+module Backup
+  module Notifier
+    class Prowl < Base
+
+      ##
+      # Application name
+      # Tell something like your server name. Example: "Server1 Backup"
+      attr_accessor :application
+
+      ##
+      # API-Key
+      # Create a Prowl account and request an API key on prowlapp.com.
+      attr_accessor :api_key
+
+      def initialize(model, &block)
+        super
+        instance_eval(&block) if block_given?
+      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 :warning then '[Backup::Warning]'
+              when :failure then '[Backup::Failure]'
+              end
+        send_message(tag)
+      end
+
+      def send_message(message)
+        uri = 'https://api.prowlapp.com/publicapi/add'
+        data = {
+          :application  => application,
+          :apikey       => api_key,
+          :event        => message,
+          :description  => "#{ model.label } (#{ model.trigger })"
+        }
+        options = {
+          :headers  => { 'Content-Type' => 'application/x-www-form-urlencoded' },
+          :body     => URI.encode_www_form(data)
+        }
+        options.merge!(:expects => 200) # raise error if unsuccessful
+        Excon.post(uri, options)
+      end
+
+    end
+  end
+end

data/lib/backup/notifier/pushover.rb

@@ -0,0 +1,80 @@
+# encoding: utf-8
+require 'uri'
+
+module Backup
+  module Notifier
+    class Pushover < Base
+
+      ##
+      # The API User Token
+      attr_accessor :user
+
+      ##
+      # The API Application Token
+      attr_accessor :token
+
+      ##
+      # The user's device identifier to sent the message directly to,
+      # rather than all of the user's devices
+      attr_accessor :device
+
+      ##
+      # The message title
+      attr_accessor :title
+
+      ##
+      # The priority of the notification
+      attr_accessor :priority
+
+      def initialize(model, &block)
+        super
+        instance_eval(&block) if block_given?
+      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 })"
+        send_message(message)
+      end
+
+      def send_message(message)
+        uri = 'https://api.pushover.net/1/messages.json'
+        data = { :user => user, :token => token, :message => message }
+        [:device, :title, :priority].each do |param|
+          val = send(param)
+          data.merge!(param => val) if val
+        end
+        options = {
+          :headers  => { 'Content-Type' => 'application/x-www-form-urlencoded' },
+          :body     => URI.encode_www_form(data)
+        }
+        options.merge!(:expects => 200) # raise error if unsuccessful
+        Excon.post(uri, options)
+      end
+
+    end
+  end
+end