foreman_bootdisk 17.1.0 → 19.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca80bb43629c291c9d6b27bb8c94ebd10fcc2e6e267378e4852ab42bdcee0088
-  data.tar.gz: 743d4a31beef4d80d6ab5b025cf6261bbbb11cb62eb82b65d8f7c5aaed58c9fb
+  metadata.gz: c39668300d2a5a68390be2bda58d3559441a09d1b25e1b7d061bde4231ee7e9c
+  data.tar.gz: 4068117bc381e9014aaa52d0b7ebb773d356c3307b2a08ec66a633b5455b22e1
 SHA512:
-  metadata.gz: 1915d2f7f01f58ec795f343707fe7a6d24f49af0ce6fb6ee9577f3279749e74f5cfb74b7ee707f3eea0e972b92344bc7d10a30f7be9556bffe8be2a39315526d
-  data.tar.gz: b21943b356b209d60ad7cd1bc655a81c042ef93534fb94f719c271688f64f42a2f2ea3ba21a10280b388861fd061d1e08df498de216dc233f27a92e10065c942
+  metadata.gz: a1b23054266e36961e187c1013a4d0efa63adb4a66b93cdfc23cb93796c41fe3cccc5f77cad15ede3023a26a7d99c28c2ab14c144ea661be0b4d800a8df82ebc
+  data.tar.gz: 5a55ed870b9c65bf6019695e1562fc28bf50672ef523d87170979374d5baed59d47c3be55e29fb177c88a44bfab5a7978f79f2482985c4f8fcd7e197c0b2060b

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/foreman_bootdisk/api/v2/disks_controller.rb

@@ -37,8 +37,13 @@ module ForemanBootdisk
           host = @disk
           if params[:full]
             return unless bootdisk_type_allowed?('full_host')
-            ForemanBootdisk::ISOGenerator.generate_full_host(host) do |iso|
-              send_file(iso, filename: "#{host.name}#{ForemanBootdisk::ISOGenerator.token_expiry(host)}.iso")
+            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?

data/app/controllers/foreman_bootdisk/disks_controller.rb

@@ -5,9 +5,13 @@ require 'uri'
 module ForemanBootdisk
   class DisksController < ::ApplicationController
     include AllowedActions
+    include PrettyError
 
-    before_action :bootdisk_type_allowed?, except: :help
-    before_action :find_resource, only: %w[host full_host subnet]
+    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
@@ -39,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
@@ -46,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")
-      end
-    end
 
-    def subnet
-      host = @disk
+      prolong_token(host)
       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)
+        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: '/')
-        return
-      end
-
-      ForemanBootdisk::ISOGenerator.generate(ipxe: tmpl_bios, grub: tmpl_efi) do |iso|
-        send_file(iso, filename: "bootdisk_subnet_#{subnet.name}.iso")
       end
     end
 
     def help; end
 
+    def bootdisk_options
+      host = @disk
+
+      return not_found unless host
+
+      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
+
     private
 
     def resource_scope(_controller = controller_name)
@@ -84,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,16 +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' },
-              host_action_buttons(host)
-            )
-          )
-        )
+        bootdisk_title_action_buttons(host_action_buttons(host))
       else
         bootdisk_button_disabled(host)
       end
@@ -69,55 +64,48 @@ module ForemanBootdisk
 
       host_image_link = display_bootdisk_link_if_authorized(
                           _("Host '%s' image") % host.name.split('.')[0],
-                          {
-                              controller: 'foreman_bootdisk/disks',
-                              action: 'host',
-                              id: host
+                        {
+                            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
+                             {
+                                 controller: 'foreman_bootdisk/disks',
+                                 action: 'full_host',
+                                 id: host
                                },
                                class: 'la'
                              )
 
-      generic_image_link = display_bootdisk_link_if_authorized(
-                             _('Generic image'),
-                             {
-                                 controller: 'foreman_bootdisk/disks',
-                                 action: 'generic'
-                             },
-                             class: 'la'
-                           )
-
-      help_link = display_bootdisk_link_if_authorized(
-                    _('Help'),
-                    {
-                    controller: 'foreman_bootdisk/disks',
-                    action: 'help'
-                    },
-                    class: 'la'
-                  )
-
-      divider = tag(:li, '', class: 'divider')
+      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')
-      actions << full_host_image_link if allowed_actions.include?('full_host')
+      if allowed_actions.include?('full_host')
+        if host.build?
+          actions << full_host_image_link
+        else
+          actions << full_host_blind_link
+        end
+      end
 
-      subnet_link = display_bootdisk_for_subnet(host)
-      actions << divider if allowed_actions.include?('generic') || (allowed_actions.include?('subnet') && subnet_link.present?)
 
-      actions << generic_image_link if allowed_actions.include?('generic')
-      actions << subnet_link if allowed_actions.include?('subnet')
+      actions << divider if (host_image_link.present? && allowed_actions.include?('host')) || (full_host_image_link.present? && allowed_actions.include?('full_host'))
 
-      actions << divider
-      actions << help_link
+      actions << bootdisk_help_link
 
       actions
     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/views/foreman_bootdisk/disks/help.html.erb

@@ -9,7 +9,12 @@
     <%= _('All images are usable as either ISOs or as disk images, including being written to a USB disk with `dd`.') %>
   </p>
 
-  <h2><%= _('Host image') %></h2>
+  <h2><%= _('Host images') %></h2>
+  <p>
+    <%= _('These images are used for host. You can find them at host detail page.') %>
+  </p>
+
+  <h3><%= _('Host image') %><%= mark_disabled_bootdisk_type('host') %></h3>
   <p>
     <%= _("Per-host images contain data about a particular host registered in Foreman and set up fully static networking, avoiding the requirement for DHCP.  After networking is configured, they chainload from Foreman, picking up the current OS configuration and build state from the server.") %>
   </p>
@@ -17,12 +22,17 @@
     <%= _("Once chainloaded, the OS bootloader and installer are downloaded directly from the installation media configured in Foreman, and the provisioning script (kickstart/preseed) is downloaded from Foreman.") %>
   </p>
 
-  <h2><%= _('Full host image') %></h2>
+  <h3><%= _('Full host image') %><%= mark_disabled_bootdisk_type('full_host') %></h3>
   <p>
     <%= _('A variant of the per-host image which contains the OS bootloader embedded inside the disk.  This may be useful if chainloading fails on certain hardware, but has the downside that the image must be regenerated for any change in the OS, bootloader or PXELinux templates.') %>
   </p>
 
-  <h2><%= _('Generic image') %></h2>
+  <h2><%= _('Generic images') %></h2>
+  <p>
+    <%= _('These images are more generic than previous images. You can find them at subnet index page.') %>
+  </p>
+
+  <h3><%= _('Generic image') %><%= mark_disabled_bootdisk_type('generic') %></h3>
   <p>
     <%= _('Generic images are a reusable disk image that works for any host registered in Foreman.  It requires a basic DHCP and DNS service to function and contact the server, but does not require DHCP reservations or static IP addresses.') %>
   </p>
@@ -30,11 +40,13 @@
     <%= _('The OS install continues using the installation media configured in Foreman, and it will typically configure static networking, depending on how the OS iPXE template is configured.') %>
   </p>
 
-  <h2><%= _('Subnet image') %></h2>
+  <h3><%= _('Subnet image') %><%= mark_disabled_bootdisk_type('subnet') %></h3>
   <p>
     <%= _('Subnet images are similar to generic images, but chain-loading is done via the TFTP Smart Proxy assigned to the Subnet of the host. The smart proxy must have the "Templates" module enabled and configured.') %>
   </p>
   <p>
     <%= _('This image is generic for all hosts with a provisioning NIC on that subnet.') %>
   </p>
+
+  <p><%= _('* - These bootdisk types were disabled, you can enable them in Administer - Settings.') %></p>
 </div>

data/app/views/subnets/_bootdisk_action_buttons.erb

@@ -0,0 +1 @@
+<%= display_bootdisk_for_subnet(subject) %>

data/app/views/subnets/_bootdisk_title_buttons.erb

@@ -0,0 +1 @@
+<%= display_bootdisk_title_buttons %>

data/config/routes.rb

@@ -7,7 +7,8 @@ ForemanBootdisk::Engine.routes.draw do
     constraints(id: %r{[^/]+}) do
       get 'hosts/:id', on: :collection, to: 'disks#host'
       get 'full_hosts/:id', on: :collection, to: 'disks#full_host'
-      get 'subnet/:id', on: :collection, to: 'disks#subnet'
+      get 'subnet/:id', on: :collection, to: 'subnet_disks#subnet'
+      get 'bootdisk_options/:id', on: :collection, to: 'disks#bootdisk_options'
     end
   end
 

data/db/migrate/20140522185700_change_templatekind_to_bootdisk.rb

@@ -2,10 +2,10 @@
 
 class ChangeTemplatekindToBootdisk < ActiveRecord::Migration[4.2]
   class FakeConfigTemplate < ApplicationRecord
-    self.table_name = if ActiveRecord::Base.connection.migration_context.get_all_versions.include?(20_150_514_072_626)
-                        'templates'
-                      else
+    self.table_name = if defined? ConfigTemplate
                         'config_templates'
+                      else
+                        'templates'
                       end
   end
 

data/lib/foreman_bootdisk/engine.rb

@@ -38,10 +38,13 @@ module ForemanBootdisk
 
     initializer 'foreman_bootdisk.register_plugin', before: :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_bootdisk do
-        requires_foreman '>= 2.1'
+        requires_foreman '>= 3.1'
+        # Add Global files for extending foreman-core components and routes
+        register_global_js_file 'global'
 
         security_block :bootdisk do |_map|
-          permission :download_bootdisk, 'foreman_bootdisk/disks': %i[generic host full_host subnet help],
+          permission :download_bootdisk, 'foreman_bootdisk/disks': %i[generic host full_host help bootdisk_options],
+                                         'foreman_bootdisk/subnet_disks': [:subnet],
                                          'foreman_bootdisk/api/v2/disks': %i[generic host],
                                          'foreman_bootdisk/api/v2/subnet_disks': [:subnet]
         end
@@ -57,6 +60,11 @@ module ForemanBootdisk
         provision_method 'bootdisk', N_('Boot disk based')
         template_labels 'Bootdisk' => N_('Boot disk embedded template')
         allowed_template_helpers :bootdisk_chain_url, :bootdisk_raise
+
+        extend_page "subnets/index" do |cx|
+          cx.add_pagelet :subnet_index_action_buttons, name: 'Bootdisk', partial: 'subnets/bootdisk_action_buttons'
+          cx.add_pagelet :subnet_index_title_buttons, name: 'Bootdisk', partial: 'subnets/bootdisk_title_buttons'
+        end
       end
     end
 
@@ -71,6 +79,7 @@ module ForemanBootdisk
         Host::Managed.prepend ForemanBootdisk::HostExt
         Host::Managed.include ForemanBootdisk::Orchestration::Compute if SETTINGS[:unattended]
         HostsHelper.prepend ForemanBootdisk::HostsHelperExt
+        SubnetsHelper.prepend ForemanBootdisk::SubnetsHelperExt
         Foreman::Model::Vmware.prepend ForemanBootdisk::ComputeResources::Vmware if Foreman::Model::Vmware.available?
       rescue StandardError => e
         Rails.logger.warn "#{ForemanBootdisk::ENGINE_NAME}: skipping engine hook (#{e})"

data/lib/foreman_bootdisk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ForemanBootdisk
-  VERSION = '17.1.0'
+  VERSION = '19.0.1'
 end

data/locale/action_names.rb

@@ -1,7 +1,5 @@
-# frozen_string_literal: true
-
 # Autogenerated!
 _("Remote action:")
-_("Import facts")
 _("Import Puppet classes")
-_("Action with sub plans")
+_("Import facts")
+_("Action with sub plans")