d-installer 0.4.2

data/lib/dinstaller/dbus/question.rb

@@ -0,0 +1,176 @@
+# 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/question"
+require "dinstaller/luks_activation_question"
+require "dinstaller/dbus/base_object"
+
+module DInstaller
+  module DBus
+    # Class to represent a question on D-Bus
+    #
+    # Questions are dynamically exported on D-Bus. All questions are exported as children of
+    # {DBus::Questions} object.
+    #
+    # Clients should provide an answer for each question.
+    class Question < BaseObject
+      # This module contains the D-Bus interfaces that question D-Bus object can implement. The
+      # interfaces that a question implements are dynamically determined while creating a new
+      # D-Bus question.
+      module Interfaces
+        # Generic interface for a question
+        module Question
+          QUESTION_INTERFACE = "org.opensuse.DInstaller.Question1"
+          private_constant :QUESTION_INTERFACE
+
+          # @!method backend
+          #   @note Classes including this mixin must define a #backend method
+          #   @return [DInstaller::Question]
+
+          # Unique id of the question
+          #
+          # @return [Integer]
+          def id
+            backend.id
+          end
+
+          # Text of the question
+          #
+          # @return [String]
+          def text
+            backend.text
+          end
+
+          # Options the question admits as answer
+          #
+          # @note Clients are responsible of generating the proper label for each option.
+          #
+          # @return [Array<String>]
+          def options
+            backend.options.map(&:to_s)
+          end
+
+          # Default option a client should offer as answer
+          #
+          # @return [String]
+          def default_option
+            backend.default_option.to_s
+          end
+
+          # Answer selected for a client
+          #
+          # @return [String]
+          def answer
+            backend.answer.to_s
+          end
+
+          # Selects an option as answer
+          #
+          # @param option [String]
+          def answer=(option)
+            backend.answer = option.to_sym
+          end
+
+          def self.included(base)
+            base.class_eval do
+              dbus_interface QUESTION_INTERFACE do
+                dbus_reader :id, "u"
+                dbus_reader :text, "s"
+                dbus_reader :options, "as"
+                dbus_reader :default_option, "s"
+                dbus_accessor :answer, "s"
+              end
+            end
+          end
+        end
+
+        # Interface to provide information when activating a LUKS device
+        module LuksActivation
+          LUKS_ACTIVATION_INTERFACE = "org.opensuse.DInstaller.Question.LuksActivation1"
+          private_constant :LUKS_ACTIVATION_INTERFACE
+
+          # @!method backend
+          #   @note Classes including this mixin must define a #backend method
+          #   @return [DInstaller::Question]
+
+          # Given password
+          #
+          # @return [String]
+          def luks_password
+            backend.password || ""
+          end
+
+          # Sets a password
+          #
+          # @param value [String]
+          def luks_password=(value)
+            backend.password = value
+          end
+
+          # Current attempt for activating the device
+          #
+          # @return [Integer]
+          def activation_attempt
+            backend.attempt
+          end
+
+          def self.included(base)
+            base.class_eval do
+              dbus_interface LUKS_ACTIVATION_INTERFACE do
+                dbus_accessor :luks_password, "s", dbus_name: "Password"
+                dbus_reader :activation_attempt, "u", dbus_name: "Attempt"
+              end
+            end
+          end
+        end
+      end
+
+      # Defines the interfaces to implement according to the backend type
+      INTERFACES_TO_INCLUDE = {
+        DInstaller::Question               => [Interfaces::Question],
+        DInstaller::LuksActivationQuestion => [Interfaces::Question, Interfaces::LuksActivation]
+      }.freeze
+      private_constant :INTERFACES_TO_INCLUDE
+
+      # Constructor
+      #
+      # @param path [::DBus::ObjectPath]
+      # @param backend [DInstaller::Question]
+      # @param logger [Logger]
+      def initialize(path, backend, logger)
+        super(path, logger: logger)
+        @backend = backend
+        add_interfaces
+      end
+
+    private
+
+      # @return [DInstaller::Question]
+      attr_reader :backend
+
+      # Adds interfaces to the question
+      def add_interfaces
+        INTERFACES_TO_INCLUDE[backend.class].each { |i| singleton_class.include(i) }
+      end
+    end
+  end
+end

data/lib/dinstaller/dbus/questions.rb

@@ -0,0 +1,124 @@
+# 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 "pathname"
+require "dinstaller/dbus/question"
+
+module DInstaller
+  module DBus
+    # This class represents a D-Bus object implementing ObjectManager interface for questions
+    #
+    # {DBus::Questions} uses a {QuestionsManager} as backend and exports a {DBus::Question} object
+    # when a {DInstaller::Question} is added to the questions manager. A {DBus::Question} is
+    # unexported when a {DInstaller::Question} is deleted from the questions manager.
+    #
+    # Callbacks of {QuestionsManager} are used to ensure that the proper D-Bus actions are performed
+    # when adding, deleting or waiting for answers.
+    class Questions < ::DBus::Object
+      PATH = "/org/opensuse/DInstaller/Questions1"
+      private_constant :PATH
+
+      OBJECT_MANAGER_INTERFACE = "org.freedesktop.DBus.ObjectManager"
+      private_constant :OBJECT_MANAGER_INTERFACE
+
+      # Constructor
+      #
+      # The callbacks of the backend are configured to perform the proper D-Bus actions, see
+      # {#register_callbacks}.
+      #
+      # @param backend [DInstaller::QuestionsManager]
+      # @param logger [Logger]
+      def initialize(backend, logger)
+        @backend = backend
+        @logger = logger
+        @exported_questions = []
+
+        register_callbacks
+
+        super(PATH)
+      end
+
+      # Information provided by ObjectManger for each exported object
+      #
+      # Returns a hash containing paths of exported objects as keys. Each value is the information
+      # of interfaces and properties for that object, see {BaseObject#interfaces_and_properties}.
+      #
+      # @return [Hash]
+      def managed_objects
+        exported_questions.each_with_object({}) { |q, h| h[q.path] = q.interfaces_and_properties }
+      end
+
+      dbus_interface OBJECT_MANAGER_INTERFACE do
+        dbus_method(:GetManagedObjects, "out res:a{oa{sa{sv}}}") { [managed_objects] }
+        dbus_signal(:InterfacesAdded, "object:o, interfaces_and_properties:a{sa{sv}}")
+        dbus_signal(:InterfacesRemoved, "object:o, interfaces:as")
+      end
+
+    private
+
+      # @return [DInstaller::QuestionsManager]
+      attr_reader :backend
+
+      # @return [Logger]
+      attr_reader :logger
+
+      # Currently exported questions
+      #
+      # @return [Array<DBus::Question>]
+      attr_reader :exported_questions
+
+      # Builds the question path (e.g., org.opensuse.DInstaller/Questions1/1)
+      #
+      # @param question [DInstaller::Question]
+      # @return [::DBus::ObjectPath]
+      def path_for(question)
+        path = Pathname.new(PATH).join(question.id.to_s)
+
+        ::DBus::ObjectPath.new(path.to_s)
+      end
+
+      # Callbacks with actions to do when adding, deleting or waiting for questions
+      def register_callbacks
+        # When adding a question, a new question is exported on D-Bus.
+        backend.on_add do |question|
+          dbus_object = DBus::Question.new(path_for(question), question, logger)
+          @service.export(dbus_object)
+          exported_questions << dbus_object
+          InterfacesAdded(dbus_object.path, dbus_object.interfaces_and_properties)
+        end
+
+        # When removing a question, the question is unexported from D-Bus.
+        backend.on_delete do |question|
+          dbus_object = exported_questions.find { |q| q.id == question.id }
+          if dbus_object
+            @service.unexport(dbus_object)
+            exported_questions.delete(dbus_object)
+            InterfacesRemoved(dbus_object.path, dbus_object.intfs.keys)
+          end
+        end
+
+        # Bus dispatches messages while waiting for questions to be answered
+        backend.on_wait { @service.bus.dispatch_message_queue }
+      end
+    end
+  end
+end

data/lib/dinstaller/dbus/service_runner.rb

@@ -0,0 +1,97 @@
+# 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 "eventmachine"
+require "logger"
+
+module DInstaller
+  module DBus
+    # Set up and run a given D-Bus service
+    #
+    # @example Run the manager service
+    #   runner = ServiceRunner.new(:manager)
+    #   runner.run
+    #
+    # @example Run the users service
+    #   runner = ServiceRunner.new(:users)
+    #   runner.run
+    class ServiceRunner
+      # @param name [Symbol,String] Service name (:manager, :users, etc.)
+      # @param logger [Logger] Service logger
+      def initialize(name, logger: Logger.new($stdout))
+        @name = name || :manager
+        @logger = logger
+      end
+
+      # Run the Service
+      #
+      # This method listens for D-Bus calls.
+      def run
+        initialize_yast
+        service = build_service(name, logger)
+        # TODO: implement a #start method in all services,
+        # which is equivalent to #export in most cases.
+        service.respond_to?(:start) ? service.start : service.export
+        EventMachine.run do
+          EventMachine::PeriodicTimer.new(0.1) { service.dispatch }
+        end
+      end
+
+    private
+
+      attr_reader :name, :logger
+
+      # Configuration
+      def config
+        # TODO: do not require "yast" until it is needed
+        require "dinstaller/config"
+        Config.load(logger) unless Config.current
+        Config.current
+      end
+
+      # Set up a service
+      #
+      # @param name [Symbol] Service name (ie, :users)
+      # @param logger [Logger] Service logger
+      # @return [#export,#dispatch] Class that implements #export and #dispatch methods.
+      def build_service(name, logger)
+        require "dinstaller/dbus/#{name}_service"
+        klass = DInstaller::DBus.const_get("#{name.capitalize}Service")
+        klass.new(config, logger)
+      rescue LoadError, NameError
+        raise "Service '#{name}' not found"
+      end
+
+      # Initializes YaST
+      def initialize_yast
+        require "yast"
+        Yast.import "Mode"
+        Yast.import "Stage"
+
+        Yast::Mode.SetUI("commandline")
+        Yast::Mode.SetMode("installation")
+        # Set stage to initial, so it will act as installer for some cases like
+        # proposing installer instead of reading current one
+        Yast::Stage.Set("initial")
+      end
+    end
+  end
+end

data/lib/dinstaller/dbus/service_status.rb

@@ -0,0 +1,87 @@
+# 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.
+
+module DInstaller
+  module DBus
+    # Represents the status of a D-Installer service and allows to configure callbacks to be called
+    # when the status value changes
+    class ServiceStatus
+      # Possible values of the service status
+      IDLE = "idle"
+      BUSY = "busy"
+
+      # Constructor
+      #
+      # The service status is initialized as idle.
+      def initialize
+        @value = IDLE
+        @on_change_callbacks = []
+      end
+
+      # Whether the current service status value is busy
+      #
+      # @return [Boolean]
+      def busy?
+        value == BUSY
+      end
+
+      # Changes the service status value to idle
+      #
+      # @note Callbacks are called.
+      #
+      # @return [self]
+      def idle
+        change_to(IDLE)
+        self
+      end
+
+      # Changes the service status value to busy
+      #
+      # @note Callbacks are called.
+      #
+      # @return [self]
+      def busy
+        change_to(BUSY)
+        self
+      end
+
+      # Registers a callback to be called when the service status changes
+      #
+      # @param block [Proc]
+      def on_change(&block)
+        @on_change_callbacks << block
+      end
+
+    private
+
+      # @return [IDLE, BUSY]
+      attr_reader :value
+
+      # Changes the current service status value and runs the callbacks
+      #
+      # @param value [IDLE, BUSY]
+      def change_to(value)
+        @value = value
+        @on_change_callbacks.each(&:call)
+      end
+    end
+  end
+end

data/lib/dinstaller/dbus/software/manager.rb

@@ -0,0 +1,131 @@
+# 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/base_object"
+require "dinstaller/dbus/with_service_status"
+require "dinstaller/dbus/clients/language"
+require "dinstaller/dbus/interfaces/progress"
+require "dinstaller/dbus/interfaces/service_status"
+
+module DInstaller
+  module DBus
+    module Software
+      # D-Bus object to manage software installation
+      class Manager < BaseObject
+        include WithServiceStatus
+        include Interfaces::Progress
+        include Interfaces::ServiceStatus
+
+        PATH = "/org/opensuse/DInstaller/Software1"
+        private_constant :PATH
+
+        # Constructor
+        #
+        # @param backend [DInstaller::Software]
+        # @param logger [Logger]
+        def initialize(backend, logger)
+          super(PATH, logger: logger)
+          @backend = backend
+          register_callbacks
+          register_progress_callbacks
+          register_service_status_callbacks
+        end
+
+        SOFTWARE_INTERFACE = "org.opensuse.DInstaller.Software1"
+        private_constant :SOFTWARE_INTERFACE
+
+        dbus_interface SOFTWARE_INTERFACE do
+          dbus_reader :available_base_products, "a(ssa{sv})"
+
+          dbus_reader :selected_base_product, "s"
+
+          dbus_method :SelectProduct, "in ProductID:s" do |product_id|
+            logger.info "SelectProduct #{product_id}"
+
+            select_product(product_id)
+            dbus_properties_changed(SOFTWARE_INTERFACE, { "SelectedBaseProduct" => product_id }, [])
+          end
+
+          # TODO: just for performance comparison (see `perf.rb`)
+          dbus_method :ProvisionSelected, "in Provision:s, out Result:b" do |provision|
+            backend.provision_selected?(provision)
+          end
+
+          dbus_method :ProvisionsSelected, "in Provisions:as, out Result:ab" do |provisions|
+            [provisions.map { |p| backend.provision_selected?(p) }]
+          end
+
+          dbus_method(:Probe) { probe }
+          dbus_method(:Propose) { propose }
+          dbus_method(:Install) { install }
+          dbus_method(:Finish) { finish }
+        end
+
+        def available_base_products
+          backend.products.map do |id, data|
+            [id, data["name"], { "description" => data["description"] }].freeze
+          end
+        end
+
+        # Returns the selected base product
+        #
+        # @return [String] Product ID or an empty string if no product is selected
+        def selected_base_product
+          backend.product || ""
+        end
+
+        def select_product(product_id)
+          backend.select_product(product_id)
+        end
+
+        def probe
+          busy_while { backend.probe }
+        end
+
+        def propose
+          busy_while { backend.propose }
+        end
+
+        def install
+          busy_while { backend.install }
+        end
+
+        def finish
+          busy_while { backend.finish }
+        end
+
+      private
+
+        # @return [DInstaller::Software]
+        attr_reader :backend
+
+        # Registers callback to be called
+        def register_callbacks
+          client = DInstaller::DBus::Clients::Language.new
+          client.on_language_selected do |language_ids|
+            backend.languages = language_ids
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dinstaller/dbus/software/proposal.rb

@@ -0,0 +1,82 @@
+# 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 "yast"
+require "dbus"
+Yast.import "PackagesProposal"
+
+module DInstaller
+  module DBus
+    module Software
+      # Software proposal D-Bus representation
+      #
+      # This class allows to change software proposal settings through D-Bus.
+      #
+      # @see Yast::PackagesProposal
+      class Proposal < ::DBus::Object
+        PATH = "/org/opensuse/DInstaller/Software/Proposal1"
+        private_constant :PATH
+
+        INTERFACE = "org.opensuse.DInstaller.Software.Proposal1"
+        private_constant :INTERFACE
+
+        TYPES = [:package, :pattern].freeze
+        private_constant :TYPES
+
+        # Constructor
+        #
+        # @param logger [Logger]
+        def initialize(logger)
+          @logger = logger
+
+          super(PATH)
+        end
+
+        dbus_interface INTERFACE do
+          dbus_method :AddResolvables,
+            "in Id:s, in Type:y, in Resolvables:as, in Optional:b" do |id, type, resolvables, opt|
+            Yast::PackagesProposal.AddResolvables(id, TYPES[type], resolvables, optional: opt)
+          end
+
+          dbus_method :GetResolvables,
+            "in Id:s, in Type:y, in Optional:b, out Resolvables:as" do |id, type, opt|
+            [Yast::PackagesProposal.GetResolvables(id, TYPES[type], optional: opt)]
+          end
+
+          dbus_method :SetResolvables,
+            "in Id:s, in Type:y, in Resolvables:as, in Optional:b" do |id, type, resolvables, opt|
+            Yast::PackagesProposal.SetResolvables(id, TYPES[type], resolvables, optional: opt)
+          end
+
+          dbus_method :RemoveResolvables,
+            "in Id:s, in Type:y, in Resolvables:as, in Optional:b" do |id, type, resolvables, opt|
+            Yast::PackagesProposal.RemoveResolvables(id, TYPES[type], resolvables, optional: opt)
+          end
+        end
+
+      private
+
+        # @return [Logger]
+        attr_reader :logger
+      end
+    end
+  end
+end