foreman_bootdisk 17.0.2 → 19.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc43113465fd89f890f9606fb04af3e948b96ac1bd6c1943211a452e38c4cb2a
-  data.tar.gz: 9db1069085f706df776576fc0df25f49a7d09ae71555ea15397d57656ddd0da5
+  metadata.gz: d21663a31369d139b9bac432999214fbcdb8d0cab69e3fba545c8dde84534fab
+  data.tar.gz: 7ab0ae10f8f2b2bf3826185251c6b7abaf6588c2a076ed0263b218a6a2780313
 SHA512:
-  metadata.gz: 115bddba362f7c53b78d06ca78a1f120babae76cc2f922447cd0e05b1f322f189e30b186e6cb0718b7d9a24bfca67bf2287283fd9495eba4193a9b6bb560ec29
-  data.tar.gz: 1cd764fdc0a939d45934070d6b34e2619870c8c206afd4915cae93f68f7553cfcc9b18d3c04770aba9f4b6f45d62bbd779563798b7175595ee8c2b991f03b660
+  metadata.gz: ad56a6d4126ecd913dc9b1938b1995427ce26d67377457281301ec73b4deab28e5241dbfffb5b6f2233c768cd3eb465c12ab990129c430de85350962a37ec309
+  data.tar.gz: a8da031331b090a898f6b9fde9e37bcb4b8bfed1a5b6e5e1f876b8595f872aa0ec64278cbc7d799ee09466f81c2236e94f126b9347f6c0d925a5ea7501ca821a

data/README.md

@@ -228,7 +228,7 @@ The installation can continue on either the DHCP or static IP depending on how
 the OS iPXE template is configured, and could configure the assigned IP
 address statically for the installed system via the kickstart file.
 
-To generate the image from the web interface, view a host page, click the
+To generate the image from the web interface, view a subnet page, click the
 "Boot disk" button and select "Generic image".
 
 To generate using the Hammer CLI, install the [hammer_cli_foreman_bootdisk](https://github.com/theforeman/hammer_cli_foreman_bootdisk)
@@ -269,8 +269,7 @@ the "Templates" module enabled and configured.
 
 This image is generic for all hosts with a provisioning NIC on that subnet.
 
-To generate the image from the web interface, view a host page, click the
-"Boot disk" button and select "Subnet image".
+To generate the image from the web interface, view a subnet page and select "Subnet image" from subnet action buttons.
 
 To generate using the Hammer CLI, install the [hammer_cli_foreman_bootdisk](https://github.com/theforeman/hammer_cli_foreman_bootdisk)
 plugin and run:

data/app/controllers/concerns/allowed_actions.rb

@@ -0,0 +1,16 @@
+module AllowedActions
+  extend ActiveSupport::Concern
+
+  def bootdisk_type_allowed?(action = params[:action])
+    return true if Setting::Bootdisk.allowed_types&.include?(action)
+
+    message = _('This type of bootdisk is not allowed. Please contact administrator.')
+    if api_request?
+      render_error :custom_error, status: :unprocessable_entity, locals: { message: message}
+    else
+      error(message)
+      redirect_back(fallback_location: '/')
+    end
+    false
+  end
+end

data/app/controllers/foreman_bootdisk/api/v2/disks_controller.rb

@@ -7,11 +7,13 @@ module ForemanBootdisk
     module V2
       class DisksController < ::Api::V2::BaseController
         include ::Api::Version2
+        include AllowedActions
 
         resource_description do
           api_base_url '/bootdisk/api'
         end
 
+        before_action :bootdisk_type_allowed?, only: :generic
         before_action :find_resource, only: :host
         skip_after_action :log_response_body
 
@@ -34,10 +36,17 @@ module ForemanBootdisk
         def host
           host = @disk
           if params[:full]
-            ForemanBootdisk::ISOGenerator.generate_full_host(host) do |iso|
-              send_file(iso, filename: "#{host.name}#{ForemanBootdisk::ISOGenerator.token_expiry(host)}.iso")
+            return unless bootdisk_type_allowed?('full_host')
+            begin
+              ForemanBootdisk::ISOGenerator.generate_full_host(host) do |iso|
+                send_file(iso, filename: "#{host.name}#{ForemanBootdisk::ISOGenerator.token_expiry(host)}.iso")
+              end
+            rescue ::Foreman::Exception => e
+              raise e unless e.code == 'ERF42-2893'
+              render_error json: { error: _('Host is not in build mode')}, status: :method_not_allowed
             end
           else
+            return unless bootdisk_type_allowed?
             # EFI not supported for iPXE host bootdisk
             tmpl = host.bootdisk_template_render
             ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl) do |iso|

data/app/controllers/foreman_bootdisk/api/v2/subnet_disks_controller.rb

@@ -7,11 +7,14 @@ module ForemanBootdisk
     module V2
       class SubnetDisksController < ::Api::V2::BaseController
         include ::Api::Version2
+        include AllowedActions
 
         resource_description do
           api_base_url '/bootdisk/api'
         end
 
+        rescue_from ActiveRecord::RecordNotFound, :with => :subnet_not_found
+        before_action :bootdisk_type_allowed?, only: :subnet
         before_action :find_resource, only: :subnet
 
         skip_after_action :log_response_body
@@ -42,6 +45,10 @@ module ForemanBootdisk
         def resource_scope
           Subnet.authorized('view_subnets')
         end
+
+        def subnet_not_found
+          not_found ("Subnet not found by id '%s'") % params[:id]
+        end
       end
     end
   end

data/app/controllers/foreman_bootdisk/disks_controller.rb

@@ -4,7 +4,14 @@ require 'uri'
 
 module ForemanBootdisk
   class DisksController < ::ApplicationController
-    before_action :find_resource, only: %w[host full_host subnet]
+    include AllowedActions
+    include PrettyError
+
+    helper DiskHelper
+
+    before_action :bootdisk_type_allowed?, except: %i[help bootdisk_options]
+
+    before_action :find_resource, only: %w[host full_host bootdisk_options]
 
     # as this engine is isolated, we need to include url helpers from core explicitly
     # to render help page layout
@@ -36,6 +43,8 @@ module ForemanBootdisk
         return
       end
 
+      prolong_token(host)
+
       ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl) do |iso|
         send_file(iso, filename: "#{host.name}.iso")
       end
@@ -43,33 +52,39 @@ module ForemanBootdisk
 
     def full_host
       host = @disk
-      ForemanBootdisk::ISOGenerator.generate_full_host(host) do |iso|
-        send_file(iso, filename: "#{host.name}#{ForemanBootdisk::ISOGenerator.token_expiry(host)}.iso")
+
+      prolong_token(host)
+      begin
+        ForemanBootdisk::ISOGenerator.generate_full_host(host) do |iso|
+          send_file(iso, filename: "#{host.name}#{ForemanBootdisk::ISOGenerator.token_expiry(host)}.iso")
+        end
+      rescue ::Foreman::Exception => e
+        raise e unless e.code == 'ERF42-2893'
+        error _('Host is not in build mode.')
+        redirect_back(fallback_location: '/')
       end
     end
 
-    def subnet
+    def help; end
+
+    def bootdisk_options
       host = @disk
-      begin
-        subnet = host.try(:subnet) || raise(::Foreman::Exception.new(N_('Subnet is not assigned to the host %s'), host.name))
-        subnet.tftp || raise(::Foreman::Exception.new(N_('TFTP feature not enabled for subnet %s'), subnet.name))
-        subnet.httpboot || ForemanBootdisk.logger.warn('HTTPBOOT feature is not enabled for subnet %s, UEFI may not be available for bootdisk' % subnet.name)
 
-        tmpl_bios = ForemanBootdisk::Renderer.new.generic_template_render(subnet)
-        tmpl_efi = ForemanBootdisk::Renderer.new.generic_efi_template_render(subnet)
-      rescue StandardError => e
-        error_rendering(e)
-        redirect_back(fallback_location: '/')
-        return
-      end
+      return not_found unless host
 
-      ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl_bios, grub: tmpl_efi) do |iso|
-        send_file(iso, filename: "bootdisk_subnet_#{subnet.name}.iso")
+      respond_to do |format|
+        format.json do
+          render json: {
+            bootdiskOptions: {
+              bootdiskDownloadable: !!host.bootdisk_downloadable?,
+              architectureName: host.architecture.name,
+              actions: bootdisk_allowed_actions(host),
+            },
+          }, status: :ok
+        end
       end
     end
 
-    def help; end
-
     private
 
     def resource_scope(_controller = controller_name)
@@ -81,5 +96,42 @@ module ForemanBootdisk
       error("#{msg}: #{exception.message}")
       ::Foreman::Logging.exception(msg, exception)
     end
+
+    def prolong_token(host)
+      return if Setting[:token_duration] == 0 || host.token.nil?
+
+      # update build token
+      token = host.token
+      token.update(expires: Time.zone.now + Setting[:token_duration].minutes)
+    end
+
+    def bootdisk_allowed_actions(host)
+      return [] unless host.bootdisk_downloadable?
+
+      allowed = %w[host full_host].each_with_object([]) do |action, actions|
+        opts = {
+          controller: 'foreman_bootdisk/disks',
+          action: action,
+          id: host
+        }
+        next unless User.current.allowed_to?(opts) && Setting::Bootdisk.allowed_types.include?(action)
+
+        hostname = host.name.split('.')[0]
+        title = action == 'host' ? _("Host '%s' image") % hostname : _("Full host '%s' image") % hostname
+        disable_full_host = action == 'full_host' && !host.build?
+        actions << {
+          title: title,
+          link: "/bootdisk/disks/#{action}s/#{host.id}",
+          disabled:  disable_full_host ? true : false,
+          description: disable_full_host ? _('Host is not in build mode') : nil
+        }
+      end
+      return allowed unless User.current.allowed_to?({controller: 'foreman_bootdisk/disks', action: 'help'})
+
+      allowed.push({
+        title: _('Boot disk help'),
+        link: '/bootdisk/disks/help'
+      })
+    end
   end
 end

data/app/controllers/foreman_bootdisk/subnet_disks_controller.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module ForemanBootdisk
+  class SubnetDisksController < ::ApplicationController
+    include PrettyError
+
+    before_action :find_resource, only: :subnet
+
+    # as this engine is isolated, we need to include url helpers from core explicitly
+    # to render help page layout
+    include Rails.application.routes.url_helpers
+
+    def subnet
+      begin
+        @subnet.tftp || raise(::Foreman::Exception.new(N_('TFTP feature not enabled for subnet %s'), @subnet.name))
+        @subnet.httpboot || ForemanBootdisk.logger.warn('HTTPBOOT feature is not enabled for subnet %s, UEFI may not be available for bootdisk' % @subnet.name)
+
+        tmpl_bios = ForemanBootdisk::Renderer.new.generic_template_render(@subnet)
+        tmpl_efi = ForemanBootdisk::Renderer.new.generic_efi_template_render(@subnet)
+      rescue StandardError => e
+        error_rendering(e)
+        redirect_back(fallback_location: '/')
+        return
+      end
+
+      ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl_bios, grub: tmpl_efi) do |iso|
+        send_file(iso, filename: "bootdisk_subnet_#{@subnet.name}.iso")
+      end
+    end
+
+    private
+
+    def resource_scope(_controller = controller_name)
+      Subnet.authorized(:view_subnets)
+    end
+
+    def find_resource
+      @subnet = Subnet.find(params[:id])
+    end
+  end
+end

data/app/helpers/bootdisk_links_helper.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module BootdiskLinksHelper
+  # Core Foreman helpers can't look up a URL against a mounted engine
+  def display_bootdisk_link_if_authorized(name, options = {}, html_options = {})
+    if bootdisk_authorized_for(options)
+      link_to(name, bootdisk_url(options), html_options)
+    else
+      ''
+    end
+  end
+
+  def bootdisk_url(options)
+    ForemanBootdisk::Engine.routes.url_for(options.merge(only_path: true, script_name: foreman_bootdisk_path))
+  end
+
+  def bootdisk_authorized_for(options)
+    User.current.allowed_to?(options)
+  end
+
+  def divider
+    tag(:li, class: 'divider')
+  end
+
+  def bootdisk_help_link
+    display_bootdisk_link_if_authorized(
+      _('Boot disk Help'),
+    {
+        controller: 'foreman_bootdisk/disks',
+        action: 'help'
+      },
+      class: 'la'
+    )
+  end
+
+  def bootdisk_title_action_buttons(actions)
+    title_actions(
+      button_group(
+        select_action_button(
+          _('Boot disk'), { class: 'btn btn-group' },
+          actions
+        )
+      )
+    )
+  end
+end

data/app/helpers/concerns/foreman_bootdisk/hosts_helper_ext.rb

@@ -2,51 +2,11 @@
 
 module ForemanBootdisk
   module HostsHelperExt
+    include BootdiskLinksHelper
+
     def host_title_actions(host)
       if host.bootdisk_downloadable?
-        title_actions(
-          button_group(
-            select_action_button(
-              _('Boot disk'), { class: 'btn btn-group' },
-              display_bootdisk_link_if_authorized(
-                _("Host '%s' image") % host.name.split('.')[0],
-                {
-                  controller: 'foreman_bootdisk/disks',
-                  action: 'host',
-                  id: host
-                },
-                class: 'la'
-              ),
-              display_bootdisk_link_if_authorized(
-                _("Full host '%s' image") % host.name.split('.')[0],
-                {
-                  controller: 'foreman_bootdisk/disks',
-                  action: 'full_host',
-                  id: host
-                },
-                class: 'la'
-              ),
-              content_tag(:li, '', class: 'divider'),
-              display_bootdisk_link_if_authorized(
-                _('Generic image'),
-                {
-                  controller: 'foreman_bootdisk/disks',
-                  action: 'generic'
-                },
-                class: 'la'
-              ),
-              display_bootdisk_for_subnet(host),
-              content_tag(:li, '', class: 'divider'),
-              display_bootdisk_link_if_authorized(
-                _('Help'), {
-                  controller: 'foreman_bootdisk/disks',
-                  action: 'help'
-                },
-                class: 'la'
-              )
-            )
-          )
-        )
+        bootdisk_title_action_buttons(host_action_buttons(host))
       else
         bootdisk_button_disabled(host)
       end
@@ -95,5 +55,59 @@ module ForemanBootdisk
     def bootdisk_authorized_for(options)
       User.current.allowed_to?(options)
     end
+
+    def host_action_buttons(host)
+      actions = []
+
+      allowed_actions = Setting::Bootdisk.allowed_types
+      return '' unless allowed_actions
+
+      host_image_link = display_bootdisk_link_if_authorized(
+                          _("Host '%s' image") % host.name.split('.')[0],
+                        {
+                            controller: 'foreman_bootdisk/disks',
+                            action: 'host',
+                            id: host
+                          },
+                          class: 'la'
+                        )
+
+      full_host_image_link = display_bootdisk_link_if_authorized(
+                               _("Full host '%s' image") % host.name.split('.')[0],
+                             {
+                                 controller: 'foreman_bootdisk/disks',
+                                 action: 'full_host',
+                                 id: host
+                               },
+                               class: 'la'
+                             )
+
+      full_host_blind_link = if bootdisk_authorized_for({controller: 'foreman_bootdisk/disks', action: 'full_host', id: host})
+                               link_to(_("Full host '%s' image") % host.name.split('.')[0],
+                                       '#',
+                                       class: 'la btn btn-info',
+                                       disabled: true,
+                                       title: _('Host is not in build mode')
+                               )
+                             else
+                               ''
+                             end
+
+      actions << host_image_link if allowed_actions.include?('host')
+      if allowed_actions.include?('full_host')
+        if host.build?
+          actions << full_host_image_link
+        else
+          actions << full_host_blind_link
+        end
+      end
+
+
+      actions << divider if (host_image_link.present? && allowed_actions.include?('host')) || (full_host_image_link.present? && allowed_actions.include?('full_host'))
+
+      actions << bootdisk_help_link
+
+      actions
+    end
   end
 end

data/app/helpers/concerns/foreman_bootdisk/pretty_error.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ForemanBootdisk
+  module PrettyError
+    extend ActiveSupport::Concern
+
+    def error_rendering(exception)
+      msg = _('Failed to render boot disk template')
+      error("#{msg}: #{exception.message}")
+      ::Foreman::Logging.exception(msg, exception)
+    end
+  end
+end

data/app/helpers/concerns/foreman_bootdisk/subnets_helper_ext.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module ForemanBootdisk
+  module SubnetsHelperExt
+    include BootdiskLinksHelper
+
+    def display_bootdisk_for_subnet(subnet)
+      if (proxy = subnet.tftp || subnet.httpboot) && proxy.has_feature?('Templates') && Setting::Bootdisk.allowed_types.include?('subnet')
+        display_bootdisk_link_if_authorized(
+            _("Subnet generic image"), {
+            controller: 'foreman_bootdisk/subnet_disks',
+            action: 'subnet',
+            id: subnet.id
+        },
+            class: 'la'
+        )
+      else
+        ''
+      end
+    end
+
+    def display_bootdisk_title_buttons
+
+      actions = []
+
+      generic_image_link = display_bootdisk_link_if_authorized(
+                             _('Generic image'),
+                           {
+                               controller: 'foreman_bootdisk/disks',
+                               action: 'generic'
+                             },
+                             class: 'la'
+                           )
+
+      if Setting::Bootdisk.allowed_types&.include?('generic')
+        actions << generic_image_link
+        actions << divider
+      end
+
+      actions << bootdisk_help_link
+
+      bootdisk_title_action_buttons(actions)
+    end
+  end
+end

data/app/helpers/disk_helper.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module DiskHelper
+  def mark_disabled_bootdisk_type(type)
+    return '' if Setting::Bootdisk.allowed_types&.include?(type)
+    '*'
+  end
+end

data/app/lib/foreman_bootdisk/scope/bootdisk.rb

@@ -3,6 +3,20 @@
 module ForemanBootdisk
   module Scope
     class Bootdisk < ::Foreman::Renderer::Scope::Provisioning
+      extend ApipieDSL::Class
+
+      apipie :class, 'Macros related to provisioning via boot disk' do
+        name 'Bootdisk'
+        sections only: %w[all provisioning]
+      end
+
+      apipie :method, 'Generates URL for boot chain' do
+        optional :mac, String, 'MAC address of the host', default: 'MAC address of the current host'
+        optional :action, String, 'Bootloader to use', default: 'iPXE'
+        returns String, desc: 'URL for boot chain'
+        example 'bootdisk_chain_url #=> "http://foreman.some.host.fqdn/unattended/iPXE?mac=00%3A11%3A22%3A33%3A44%3A55"'
+        example 'bootdisk_chain_url("00:11:22:33:44:55") #=> "http://foreman.some.host.fqdn/unattended/iPXE?mac=00%3A11%3A22%3A33%3A44%3A55"'
+      end
       def bootdisk_chain_url(mac = host.try(:mac), action = 'iPXE')
         url = foreman_url(action)
         u = URI.parse(url)
@@ -14,6 +28,16 @@ module ForemanBootdisk
         u.to_s
       end
 
+      apipie :method, 'Always raises an error with a description provided as an argument' do
+        desc 'This method is useful for aborting script execution if some of the conditions are not met'
+        list :args, desc: 'Description for the error'
+        raises error: ::Foreman::Exception, desc: 'The error is always being raised'
+        returns nil, desc: "Doesn't return anything"
+        example "<%
+  interface = @host.provision_interface #=> interface = nil
+  bootdisk_raise(N_('Host has no provisioning interface defined')) unless interface #=> Foreman::Exception is raised and the execution of the script is aborted
+%>"
+      end
       def bootdisk_raise(*args)
         raise ::Foreman::Exception.new(*args)
       end

data/app/models/concerns/foreman_bootdisk/host_ext.rb

@@ -4,6 +4,8 @@ require 'uri'
 
 module ForemanBootdisk
   module HostExt
+    extend ApipieDSL::Extension
+
     def bootdisk_template
       template = ProvisioningTemplate.unscoped.find_by(name: Setting[:bootdisk_host_template])
       unless template
@@ -36,6 +38,10 @@ module ForemanBootdisk
     def can_be_built?
       super || (managed? && SETTINGS[:unattended] && bootdisk_build? && !build?)
     end
+
+    apipie_update :class do
+      property :bootdisk_build?, one_of: [true, false], desc: 'Returns true if provision method for this host is bootdisk, false otherwise'
+    end
   end
 end
 

data/app/models/concerns/foreman_bootdisk/orchestration/compute.rb

@@ -42,8 +42,16 @@ module ForemanBootdisk
       end
 
       def bootdisk_generate_iso_image
-        ForemanBootdisk::ISOGenerator.generate(ipxe: bootdisk_template_render, dir: Dir.tmpdir) do |image|
-          FileUtils.mv image, bootdisk_isofile
+        if self.build? && self.provisioning_template(kind: :PXELinux) && self.provisioning_template(kind: :PXEGrub2)
+          logger.info format('Generating FULL HOST ISO image for %s', name)
+          ForemanBootdisk::ISOGenerator.generate_full_host(self, dir: Dir.tmpdir) do |image|
+            FileUtils.mv image, bootdisk_isofile
+          end
+        else
+          logger.info format('Generating HOST ISO image for %s', name)
+          ForemanBootdisk::ISOGenerator.generate(ipxe: bootdisk_template_render, dir: Dir.tmpdir) do |image|
+            FileUtils.mv image, bootdisk_isofile
+          end
         end
       end
 
@@ -60,7 +68,6 @@ module ForemanBootdisk
       end
 
       def setGenerateIsoImage
-        logger.info format('Generating ISO image for %s', name)
         bootdisk_generate_iso_image
       rescue StandardError => e
         failure format(_('Failed to generate ISO image for instance %{name}: %{message}'), name: name, message: e.message), e

data/app/models/setting/bootdisk.rb

@@ -21,12 +21,21 @@ class Setting
         set('bootdisk_generic_efi_host_template', N_('Grub2 template to use for generic EFI host boot disks'),
             'Boot disk Grub2 EFI - generic host', N_('Generic Grub2 EFI image template'), nil, collection: templates),
         set('bootdisk_mkiso_command', N_('Command to generate ISO image, use genisoimage or mkisofs'), 'genisoimage', N_('ISO generation command')),
-        set('bootdisk_cache_media', N_('Installation media files will be cached for full host images'), true, N_('Installation media caching'))
+        set('bootdisk_cache_media', N_('Installation media files will be cached for full host images'), true, N_('Installation media caching')),
+        set('bootdisk_allowed_types', N_('List of allowed bootdisk types, remove type to disable it'), Setting::Bootdisk.bootdisk_types, N_('Allowed bootdisk types'))
       ]
     end
 
     def self.humanized_category
       N_('Boot disk')
     end
+
+    def self.bootdisk_types
+      %w(generic host full_host subnet)
+    end
+
+    def self.allowed_types
+      Setting['bootdisk_allowed_types']
+    end
   end
 end