d-installer 0.4.2

data/lib/dinstaller/dbus/interfaces/service_status.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+# Copyright (c) [2022] SUSE LLC
+#
+# All Rights Reserved.
+#
+# This program is free software; you can redistribute it and/or modify it
+# under the terms of version 2 of the GNU General Public License as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+# more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, contact SUSE LLC.
+#
+# To contact SUSE LLC about this file by physical or electronic mail, you may
+# find current contact information at www.suse.com.
+
+require "dbus"
+
+module DInstaller
+  module DBus
+    module Interfaces
+      # Mixin to define the ServiceStatus D-Bus interface
+      #
+      # @note This mixin is expected to be included in a class inherited from {::DBus::Object} and
+      #   it requires a #service_status method that returns a {DInstaller::DBus::ServiceStatus}
+      #   object.
+      #
+      # @example
+      #   class Demo < ::DBus::Object
+      #     include DInstaller::DBus::Interfaces::ServiceStatus
+      #
+      #     def initialize
+      #       super("org.test.Demo")
+      #       register_service_status_callbacks
+      #     end
+      #
+      #     def service_status
+      #       @service_status ||= DInstaller::DBus::ServiceStatus.new
+      #   end
+      module ServiceStatus
+        SERVICE_STATUS_INTERFACE = "org.opensuse.DInstaller.ServiceStatus1"
+
+        SERVICE_STATUS_IDLE = 0
+        SERVICE_STATUS_BUSY = 1
+
+        # Description of all possible service status values
+        #
+        # @return [Array<Hash>]
+        def service_status_all
+          [
+            { "id" => SERVICE_STATUS_IDLE, "label" => "idle" },
+            { "id" => SERVICE_STATUS_BUSY, "label" => "busy" }
+          ]
+        end
+
+        # Current value of the service status
+        #
+        # @return [Integer]
+        def service_status_current
+          service_status.busy? ? SERVICE_STATUS_BUSY : SERVICE_STATUS_IDLE
+        end
+
+        # Registers callbacks to be called when the value of the service status changes
+        #
+        # @note This method is expected to be called in the constructor.
+        def register_service_status_callbacks
+          service_status.on_change do
+            dbus_properties_changed(SERVICE_STATUS_INTERFACE,
+              { "Current" => service_status_current }, [])
+          end
+        end
+
+        def self.included(base)
+          base.class_eval do
+            dbus_interface SERVICE_STATUS_INTERFACE do
+              dbus_reader :service_status_all, "aa{sv}", dbus_name: "All"
+              dbus_reader :service_status_current, "u", dbus_name: "Current"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dinstaller/dbus/language.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+# Copyright (c) [2022] SUSE LLC
+#
+# All Rights Reserved.
+#
+# This program is free software; you can redistribute it and/or modify it
+# under the terms of version 2 of the GNU General Public License as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+# more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, contact SUSE LLC.
+#
+# To contact SUSE LLC about this file by physical or electronic mail, you may
+# find current contact information at www.suse.com.
+
+require "dbus"
+require "dinstaller/language"
+require "dinstaller/errors"
+
+module DInstaller
+  module DBus
+    # YaST D-Bus object (/org/opensuse/DInstaller/Language1)
+    #
+    # @see https://rubygems.org/gems/ruby-dbus
+    class Language < ::DBus::Object
+      PATH = "/org/opensuse/DInstaller/Language1"
+      private_constant :PATH
+
+      LANGUAGE_INTERFACE = "org.opensuse.DInstaller.Language1"
+      private_constant :LANGUAGE_INTERFACE
+
+      # @param backend [DInstaller::Language]
+      # @param logger [Logger]
+      def initialize(backend, logger)
+        @backend = backend
+        @logger = logger
+
+        super(PATH)
+      end
+
+      dbus_interface LANGUAGE_INTERFACE do
+        attr_accessor :available_languages
+
+        dbus_reader :available_languages, "a(ssa{sv})"
+
+        dbus_reader :marked_for_install, "as"
+
+        dbus_method :ToInstall, "in LangIDs:as" do |lang_ids|
+          logger.info "ToInstall #{lang_ids.inspect}"
+          result = select_to_install(lang_ids)
+
+          dbus_properties_changed(LANGUAGE_INTERFACE, { "MarkedForInstall" => lang_ids }, [])
+          result ? 0 : 1
+        end
+
+        dbus_method(:Finish) { finish }
+      end
+
+      def available_languages
+        @available_languages ||= backend.languages.map { |k, v| [k, v.first, {}] }
+      end
+
+      def marked_for_install
+        # TODO: change when installer support multiple target languages
+        result = [backend.language]
+        logger.info "MarkedForInstall #{result}"
+        result
+      end
+
+      def select_to_install(lang_ids)
+        backend.language = lang_ids.first
+        true
+      rescue Errors::InvalidValue
+        false
+      end
+
+      def finish
+        backend.finish
+      end
+
+    private
+
+      attr_reader :logger
+      attr_reader :backend
+    end
+  end
+end

data/lib/dinstaller/dbus/language_service.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+# Copyright (c) [2022] SUSE LLC
+#
+# All Rights Reserved.
+#
+# This program is free software; you can redistribute it and/or modify it
+# under the terms of version 2 of the GNU General Public License as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+# more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, contact SUSE LLC.
+#
+# To contact SUSE LLC about this file by physical or electronic mail, you may
+# find current contact information at www.suse.com.
+
+require "dbus"
+require "dinstaller/dbus/language"
+require "dinstaller/language"
+
+module DInstaller
+  module DBus
+    # D-Bus service (org.opensuse.DInstaller.Language)
+    #
+    # It connects to the system D-Bus and answers requests on objects below
+    # `/org/opensuse/DInstaller/Language1`.
+    class LanguageService
+      # Service name
+      #
+      # @return [String]
+      SERVICE_NAME = "org.opensuse.DInstaller.Language"
+      private_constant :SERVICE_NAME
+
+      # System D-Bus
+      #
+      # @return [::DBus::Connection]
+      attr_reader :bus
+
+      # @param config [Config] Configuration object
+      # @param logger [Logger]
+      def initialize(_config, logger = nil)
+        @logger = logger || Logger.new($stdout)
+        @bus = ::DBus::SystemBus.instance
+      end
+
+      # Exports the installer object through the D-Bus service
+      def export
+        dbus_objects.each { |o| service.export(o) }
+
+        paths = dbus_objects.map(&:path).join(", ")
+        logger.info "Exported #{paths} objects"
+      end
+
+      # Call this from some main loop to dispatch the D-Bus messages
+      def dispatch
+        bus.dispatch_message_queue
+      end
+
+    private
+
+      # @return [Logger]
+      attr_reader :logger
+
+      # @return [::DBus::Service]
+      def service
+        @service ||= bus.request_service(SERVICE_NAME)
+      end
+
+      # @return [Array<::DBus::Object>]
+      def dbus_objects
+        @dbus_objects ||= [
+          language_dbus
+        ]
+      end
+
+      # @return [DInstaller::DBus::Language]
+      def language_dbus
+        @language_dbus ||= DInstaller::DBus::Language.new(language_backend(logger), logger)
+      end
+
+      # @return [DInstaller::Language]
+      def language_backend(logger)
+        @language_backend ||= DInstaller::Language.new(logger).tap(&:probe)
+      end
+    end
+  end
+end

data/lib/dinstaller/dbus/manager.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+# Copyright (c) [2021] SUSE LLC
+#
+# All Rights Reserved.
+#
+# This program is free software; you can redistribute it and/or modify it
+# under the terms of version 2 of the GNU General Public License as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+# more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, contact SUSE LLC.
+#
+# To contact SUSE LLC about this file by physical or electronic mail, you may
+# find current contact information at www.suse.com.
+
+require "dbus"
+require "dinstaller/manager"
+require "dinstaller/dbus/base_object"
+require "dinstaller/dbus/with_service_status"
+require "dinstaller/dbus/interfaces/progress"
+require "dinstaller/dbus/interfaces/service_status"
+
+module DInstaller
+  module DBus
+    # D-Bus object to manage the installation process
+    class Manager < BaseObject
+      include WithServiceStatus
+      include Interfaces::Progress
+      include Interfaces::ServiceStatus
+
+      PATH = "/org/opensuse/DInstaller/Manager1"
+      private_constant :PATH
+
+      # Constructor
+      #
+      # @param backend [DInstaller::Manager]
+      # @param logger [Logger]
+      def initialize(backend, logger)
+        super(PATH, logger: logger)
+        @backend = backend
+        register_callbacks
+        register_progress_callbacks
+        register_service_status_callbacks
+      end
+
+      MANAGER_INTERFACE = "org.opensuse.DInstaller.Manager1"
+      private_constant :MANAGER_INTERFACE
+
+      STARTUP_PHASE = 0
+      CONFIG_PHASE = 1
+      INSTALL_PHASE = 2
+
+      dbus_interface MANAGER_INTERFACE do
+        dbus_method(:Probe, "") { config_phase }
+        dbus_method(:Commit, "") { install_phase }
+        dbus_reader :installation_phases, "aa{sv}"
+        dbus_reader :current_installation_phase, "u"
+        dbus_reader :busy_services, "as"
+      end
+
+      # Runs the config phase
+      def config_phase
+        safe_run do
+          busy_while { backend.config_phase }
+        end
+      end
+
+      # Runs the install phase
+      def install_phase
+        safe_run do
+          busy_while { backend.install_phase }
+        end
+      end
+
+      # Description of all possible installation phase values
+      #
+      # @return [Array<Hash>]
+      def installation_phases
+        [
+          { "id" => STARTUP_PHASE, "label" => "startup" },
+          { "id" => CONFIG_PHASE,  "label" => "config" },
+          { "id" => INSTALL_PHASE, "label" => "install" }
+        ]
+      end
+
+      # Current value of the installation phase
+      #
+      # @return [Integer]
+      def current_installation_phase
+        return STARTUP_PHASE if backend.installation_phase.startup?
+        return CONFIG_PHASE if backend.installation_phase.config?
+        return INSTALL_PHASE if backend.installation_phase.install?
+      end
+
+      # Name of the services that are currently busy
+      #
+      # @return [Array<String>]
+      def busy_services
+        backend.busy_services
+      end
+
+    private
+
+      # @return [DInstaller::Manager]
+      attr_reader :backend
+
+      # Executes the given block only if the service is idle
+      #
+      # @note The service still dispatches messages while waiting for a D-Bus answer.
+      #
+      # @param block [Proc]
+      def safe_run(&block)
+        raise busy_error if service_status.busy?
+
+        block.call
+      end
+
+      def busy_error
+        ::DBus.error("org.opensuse.DInstaller.Error.Busy")
+      end
+
+      # Registers callback to be called
+      def register_callbacks
+        backend.installation_phase.on_change do
+          dbus_properties_changed(MANAGER_INTERFACE,
+            { "CurrentInstallationPhase" => current_installation_phase }, [])
+        end
+
+        backend.on_services_status_change do
+          dbus_properties_changed(MANAGER_INTERFACE, { "BusyServices" => busy_services }, [])
+        end
+
+        backend.software.on_product_selected do |product|
+          safe_run do
+            busy_while { backend.select_product(product) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dinstaller/dbus/manager_service.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+# Copyright (c) [2022] SUSE LLC
+#
+# All Rights Reserved.
+#
+# This program is free software; you can redistribute it and/or modify it
+# under the terms of version 2 of the GNU General Public License as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+# more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, contact SUSE LLC.
+#
+# To contact SUSE LLC about this file by physical or electronic mail, you may
+# find current contact information at www.suse.com.
+
+require "dbus"
+require "dinstaller/manager"
+require "dinstaller/cockpit_manager"
+require "dinstaller/dbus/manager"
+require "dinstaller/dbus/language"
+require "dinstaller/dbus/storage/proposal"
+require "dinstaller/dbus/questions"
+
+module DInstaller
+  module DBus
+    # D-Bus service (org.opensuse.DInstaller)
+    #
+    # It connects to the system D-Bus and answers requests on objects below
+    # `/org/opensuse/DInstaller`.
+    class ManagerService
+      # Service name
+      #
+      # @return [String]
+      SERVICE_NAME = "org.opensuse.DInstaller"
+      private_constant :SERVICE_NAME
+
+      # System D-Bus
+      #
+      # @return [::DBus::Connection]
+      attr_reader :bus
+
+      # Installation manager
+      #
+      # @return [DInstaller::Manager]
+      attr_reader :manager
+
+      # @param config [Config] Configuration
+      # @param logger [Logger]
+      def initialize(config, logger = nil)
+        @config = config
+        @manager = DInstaller::Manager.new(config, logger)
+        @logger = logger || Logger.new($stdout)
+        @bus = ::DBus::SystemBus.instance
+      end
+
+      # Initializes and exports the D-Bus API
+      #
+      # @note The service runs its startup phase
+      def start
+        setup_cockpit
+        export
+        manager.on_progress_change { dispatch } # make single thread more responsive
+        manager.startup_phase
+      end
+
+      # Exports the installer object through the D-Bus service
+      def export
+        dbus_objects.each { |o| service.export(o) }
+
+        paths = dbus_objects.map(&:path).join(", ")
+        logger.info "Exported #{paths} objects"
+      end
+
+      # Call this from some main loop to dispatch the D-Bus messages
+      def dispatch
+        bus.dispatch_message_queue
+      end
+
+    private
+
+      # @return [Logger]
+      attr_reader :logger
+
+      # @return [Config]
+      attr_reader :config
+
+      def setup_cockpit
+        cockpit = CockpitManager.new(logger)
+        cockpit.setup(config.data["web"])
+      end
+
+      # @return [::DBus::Service]
+      def service
+        @service ||= bus.request_service(SERVICE_NAME)
+      end
+
+      # @return [Array<::DBus::Object>]
+      def dbus_objects
+        @dbus_objects ||= [
+          manager_dbus,
+          language_dbus,
+          storage_proposal_dbus,
+          questions_dbus
+        ]
+      end
+
+      def manager_dbus
+        @manager_dbus ||= DInstaller::DBus::Manager.new(manager, logger)
+      end
+
+      def language_dbus
+        @language_dbus ||= DInstaller::DBus::Language.new(manager.language, logger)
+      end
+
+      def storage_proposal_dbus
+        @storage_proposal_dbus ||= DInstaller::DBus::Storage::Proposal.new(
+          manager.storage.proposal, logger
+        )
+      end
+
+      def questions_dbus
+        @questions_dbus ||= DInstaller::DBus::Questions.new(manager.questions_manager, logger)
+      end
+    end
+  end
+end