foreman_expire_hosts 3.0.0 → 4.0.0

data/app/services/foreman_expire_hosts/action/delete_expired_hosts.rb

@@ -0,0 +1,23 @@
+module ForemanExpireHosts
+  module Action
+    class DeleteExpiredHosts < Base
+      private
+
+      def selector
+        Host.expired_past_grace_period
+      end
+
+      def action(host)
+        SafeDestroy.new(host).destroy!
+      end
+
+      def success_notification
+        ForemanExpireHosts::Notification::DeletedHosts
+      end
+
+      def failure_notification
+        ForemanExpireHosts::Notification::FailedDeletedHosts
+      end
+    end
+  end
+end

data/app/services/foreman_expire_hosts/action/stop_expired_hosts.rb

@@ -0,0 +1,37 @@
+module ForemanExpireHosts
+  module Action
+    class StopExpiredHosts < Base
+      private
+
+      def selector
+        Host.expired
+      end
+
+      def action(host)
+        return true unless host.supports_power_and_running?
+        logger.info "Powering down expired host in grace period #{host}"
+        host.power.stop
+      rescue StandardError
+        false
+      end
+
+      def success_notification
+        ForemanExpireHosts::Notification::StoppedHosts
+      end
+
+      def failure_notification
+        ForemanExpireHosts::Notification::FailedStoppedHosts
+      end
+
+      def success_notification_options
+        super.merge(
+          :delete_date => (Date.today + days_to_delete_after_expired)
+        )
+      end
+
+      def days_to_delete_after_expired
+        Setting[:days_to_delete_after_host_expiration].to_i
+      end
+    end
+  end
+end

data/app/services/foreman_expire_hosts/expiry_edit_authorizer.rb

@@ -0,0 +1,21 @@
+module ForemanExpireHosts
+  class ExpiryEditAuthorizer
+    attr_accessor :user, :hosts
+
+    def initialize(opts = {})
+      self.user = opts.fetch(:user)
+      self.hosts = opts.fetch(:hosts)
+    end
+
+    def authorized?
+      hosts.each do |host|
+        next unless user.can?(:edit_hosts, host)
+        return true if user.can?(:edit_host_expiry, host)
+        return true if Setting[:can_owner_modify_host_expiry_date] &&
+                       ((host.owner_type == 'User' && host.owner == user) ||
+                        (host.owner_type == 'Usergroup' && host.owner.all_users.include?(user)))
+      end
+      false
+    end
+  end
+end

data/app/services/foreman_expire_hosts/notification/base.rb

@@ -0,0 +1,71 @@
+module ForemanExpireHosts
+  module Notification
+    class Base
+      attr_accessor :all_hosts, :global_recipients
+
+      def initialize(opts)
+        @all_hosts = opts.fetch(:hosts)
+        @global_recipients = [opts[:to]].flatten.compact
+      end
+
+      def deliver
+        deliver_mail_notifications if respond_to?(:build_mail_notification, true)
+        deliver_ui_notifications if respond_to?(:build_ui_notification, true)
+      end
+
+      private
+
+      def deliver_mail_notifications
+        hosts_by_recipient(all_hosts).each do |recipient, hosts|
+          deliver_mail_notification(recipient, hosts)
+        end
+        deliver_mail_notification(additional_recipients, all_hosts) if additional_recipients.present?
+        true
+      end
+
+      def deliver_mail_notification(recipient, hosts)
+        build_mail_notification(recipient, hosts).deliver_now
+      rescue SocketError, Net::SMTPError => error
+        message = _('Failed to deliver %{notification_name} for Hosts %{hosts}') % {
+          :notification_name => humanized_name,
+          :hosts => hosts.map(&:name).to_sentence
+        }
+        Foreman::Logging.exception(message, error)
+      end
+
+      def deliver_ui_notifications
+        all_hosts.each do |host|
+          build_ui_notification(host).deliver!
+        end
+      end
+
+      delegate :logger, :to => :Rails
+
+      def humanized_name
+        _('Notification')
+      end
+
+      def hosts_by_recipient(hosts)
+        hosts.each_with_object({}) do |host, hash|
+          recipients = recipients_for_host(host)
+          recipients.each do |recipient|
+            hash[recipient] ||= []
+            hash[recipient] << host
+          end
+        end
+      end
+
+      def recipients_for_host(host)
+        return global_recipients if global_recipients.present?
+        return [User.anonymous_admin] if host.owner.blank?
+        return [host.owner] if host.owner_type == 'User'
+        host.owner.all_users
+      end
+
+      def additional_recipients
+        return [] if Setting[:host_expiry_email_recipients].nil?
+        Setting[:host_expiry_email_recipients].split(',').compact.map(&:strip)
+      end
+    end
+  end
+end

data/app/services/foreman_expire_hosts/notification/deleted_hosts.rb

@@ -0,0 +1,15 @@
+module ForemanExpireHosts
+  module Notification
+    class DeletedHosts < Base
+      private
+
+      def humanized_name
+        _('Deleted Hosts Notification')
+      end
+
+      def build_mail_notification(recipient, hosts)
+        ExpireHostsMailer.deleted_hosts_notification(recipient, hosts)
+      end
+    end
+  end
+end

data/app/services/foreman_expire_hosts/notification/expiry_warning.rb

@@ -0,0 +1,26 @@
+module ForemanExpireHosts
+  module Notification
+    class ExpiryWarning < Base
+      attr_accessor :expiry_date
+
+      def initialize(opts)
+        super
+        @expiry_date = opts.fetch(:expiry_date)
+      end
+
+      private
+
+      def humanized_name
+        _('Host Expiry Warning Notification')
+      end
+
+      def build_ui_notification(host)
+        ForemanExpireHosts::UINotifications::Hosts::ExpiryWarning.new(host)
+      end
+
+      def build_mail_notification(recipient, hosts)
+        ExpireHostsMailer.expiry_warning_notification(recipient, expiry_date, hosts)
+      end
+    end
+  end
+end

data/app/services/foreman_expire_hosts/notification/failed_deleted_hosts.rb

@@ -0,0 +1,15 @@
+module ForemanExpireHosts
+  module Notification
+    class FailedDeletedHosts < Base
+      private
+
+      def humanized_name
+        _('Failed Deleted Hosts Notification')
+      end
+
+      def build_mail_notification(recipient, hosts)
+        ExpireHostsMailer.failed_to_delete_hosts_notification(recipient, hosts)
+      end
+    end
+  end
+end

data/app/services/foreman_expire_hosts/notification/failed_stopped_hosts.rb

@@ -0,0 +1,15 @@
+module ForemanExpireHosts
+  module Notification
+    class FailedStoppedHosts < Base
+      private
+
+      def humanized_name
+        _('Failed Stopped Hosts Notification')
+      end
+
+      def build_mail_notification(recipient, hosts)
+        ExpireHostsMailer.failed_to_stop_hosts_notification(recipient, hosts)
+      end
+    end
+  end
+end

data/app/services/foreman_expire_hosts/notification/stopped_hosts.rb

@@ -0,0 +1,26 @@
+module ForemanExpireHosts
+  module Notification
+    class StoppedHosts < Base
+      attr_accessor :delete_date
+
+      def initialize(opts)
+        super
+        @delete_date = opts.fetch(:delete_date)
+      end
+
+      private
+
+      def humanized_name
+        _('Stopped Hosts Notification')
+      end
+
+      def build_ui_notification(host)
+        ForemanExpireHosts::UINotifications::Hosts::StoppedHost.new(host)
+      end
+
+      def build_mail_notification(recipient, hosts)
+        ExpireHostsMailer.stopped_hosts_notification(recipient, delete_date, hosts)
+      end
+    end
+  end
+end

data/app/services/foreman_expire_hosts/safe_destroy.rb

@@ -0,0 +1,23 @@
+module ForemanExpireHosts
+  class SafeDestroy
+    # See http://projects.theforeman.org/issues/14702 for reasoning.
+    attr_accessor :subject
+
+    def initialize(subject)
+      self.subject = subject
+    end
+
+    def destroy!
+      subject.destroy!
+    rescue ActiveRecord::RecordNotDestroyed => invalid
+      message = _('Failed to delete %{class_name} %{subject}: %{message} - Errors: %{errors}') % {
+        :class_name => subject.class.name,
+        :subject => subject,
+        :message => invalid.message,
+        :errors => invalid.record.errors.full_messages.to_sentence
+      }
+      Foreman::Logging.exception(message, invalid)
+      false
+    end
+  end
+end

data/app/services/foreman_expire_hosts/ui_notifications/hosts/base.rb

@@ -0,0 +1,68 @@
+module ForemanExpireHosts
+  module UINotifications
+    module Hosts
+      class Base < ::UINotifications::Hosts::Base
+        private
+
+        def create
+          return add_notification unless find_notification
+          redeliver! if redeliver?
+          find_notification
+        end
+
+        def add_notification
+          ::Notification.create!(
+            initiator: initiator,
+            subject: subject,
+            message: parsed_message,
+            audience: audience,
+            notification_blueprint: blueprint
+          )
+        end
+
+        def message
+          blueprint.message
+        end
+
+        def parsed_message
+          ::UINotifications::StringParser.new(
+            message,
+            message_variables
+          ).to_s
+        end
+
+        def message_variables
+          {
+            subject: subject,
+            initator: initiator
+          }
+        end
+
+        def update_notification
+          find_notification
+            .update_attributes(expired_at: blueprint.expired_at, :message => parsed_message)
+        end
+
+        def redeliver!
+          recipients = find_notification.notification_recipients
+          recipients.update_all(seen: false) # rubocop:disable Rails/SkipsModelValidations
+          recipients.pluck(:user_id).each do |user_id|
+            ::UINotifications::CacheHandler.new(user_id).clear
+          end
+        end
+
+        def redeliver?
+          false
+        end
+
+        def find_notification
+          blueprint.notifications.find_by(subject: subject)
+        end
+
+        def blueprint
+          @blueprint ||= NotificationBlueprint.find_by(name: blueprint_name)
+        end
+      end
+    end
+  end
+end

data/app/services/foreman_expire_hosts/ui_notifications/hosts/expiry_warning.rb

@@ -0,0 +1,28 @@
+module ForemanExpireHosts
+  module UINotifications
+    module Hosts
+      class ExpiryWarning < Base
+        include ActionView::Helpers::DateHelper
+
+        def blueprint_name
+          'expire_hosts_expiry_warning'
+        end
+
+        private
+
+        # Nag the user about expiring hosts
+        def redeliver?
+          true
+        end
+
+        def message
+          N_('%{subject} will expire in %{relative_expiry_time}.')
+        end
+
+        def message_variables
+          super.merge(:relative_expiry_time => time_ago_in_words(subject.expired_on))
+        end
+      end
+    end
+  end
+end

data/app/services/foreman_expire_hosts/ui_notifications/hosts/stopped_host.rb

@@ -0,0 +1,11 @@
+module ForemanExpireHosts
+  module UINotifications
+    module Hosts
+      class StoppedHost < Base
+        def blueprint_name
+          'expire_hosts_stopped_host'
+        end
+      end
+    end
+  end
+end

data/app/views/expire_hosts_mailer/expiry_warning_notification.html.erb

@@ -1,4 +1,7 @@
-<%= _('The following hosts will be expired on %s. Please change expiry date if you want to keep these hosts alive.') % @expiry_date %>
+<%= _('The following hosts will be expired on %s.') % @expiry_date %>
+<% if @authorized_for_expiry_date_change %>
+<%= _('Please change their expiry date if you want to keep these hosts alive.') %>
+<% end %>
 <br/><br/>
 
 <%= render 'hosts_table', :hosts => @hosts, :link_to_hosts => true %>

data/app/views/expire_hosts_mailer/stopped_hosts_notification.html.erb

@@ -1,4 +1,7 @@
-<%= _('The following hosts have been expired in Foreman and will be stopped for now. These hosts will be destroyed on %s. Please change their expiry date and power them on if you want to keep the hosts.') % l(@delete_date) %>
+<%= _('The following hosts have been expired in Foreman and will be stopped for now. These hosts will be destroyed on %s.') % l(@delete_date) %>
+<% if @authorized_for_expiry_date_change %>
+<%= _('Please change their expiry date and power them on if you want to keep the hosts.') %>
+<% end %>
 <br/><br/>
 
 <%= render 'hosts_table', :hosts => @hosts, :link_to_hosts => true %>

data/db/seeds.d/80_expire_hosts_ui_notification.rb

@@ -0,0 +1,30 @@
+[
+  {
+    group: _('Hosts'),
+    name: 'expire_hosts_expiry_warning',
+    message: _('%{subject} will expire soon.'),
+    level: 'info',
+    actions:
+    {
+      links:
+      [
+        path_method: :host_path,
+        title: _('Details')
+      ]
+    }
+  },
+  {
+    group: _('Hosts'),
+    name: 'expire_hosts_stopped_host',
+    message: _('%{subject} was stopped because it expired.'),
+    level: 'info',
+    actions:
+    {
+      links:
+      [
+        path_method: :host_path,
+        title: _('Details')
+      ]
+    }
+  }
+].each { |blueprint| UINotifications::Seed.new(blueprint).configure }