D-Bus API for registration

service/lib/agama/dbus/clients/software.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) [2022] SUSE LLC
+# Copyright (c) [2022-2023] SUSE LLC
 #
 # All Rights Reserved.
 #
@@ -20,18 +20,18 @@
 # find current contact information at www.suse.com.
 
 require "agama/dbus/clients/base"
-require "agama/dbus/clients/with_service_status"
+require "agama/dbus/clients/with_issues"
 require "agama/dbus/clients/with_progress"
-require "agama/dbus/clients/with_validation"
+require "agama/dbus/clients/with_service_status"
 
 module Agama
   module DBus
     module Clients
       # D-Bus client for software configuration
       class Software < Base
-        include WithServiceStatus
+        include WithIssues
         include WithProgress
-        include WithValidation
+        include WithServiceStatus
 
         TYPES = [:package, :pattern].freeze
         private_constant :TYPES
@@ -55,7 +55,7 @@ def service_name
         #
         # @return [Array<Array<String, String>>] name and display name of each product
         def available_products
-          dbus_object["org.opensuse.Agama.Software1"]["AvailableBaseProducts"].map do |l|
+          dbus_object["org.opensuse.Agama.Software1"]["AvailableProducts"].map do |l|
             l[0..1]
           end
         end
@@ -64,7 +64,7 @@ def available_products
         #
         # @return [String, nil] name of the product
         def selected_product
-          product = dbus_object["org.opensuse.Agama.Software1"]["SelectedBaseProduct"]
+          product = dbus_object["org.opensuse.Agama.Software1"]["SelectedProduct"]
           return nil if product.empty?
 
           product
@@ -170,8 +170,8 @@ def remove_resolvables(unique_id, type, resolvables, optional: false)
         # @param block [Proc] Callback to run when a product is selected
         def on_product_selected(&block)
           on_properties_change(dbus_object) do |_, changes, _|
-            base_product = changes["SelectedBaseProduct"]
-            block.call(base_product) unless base_product.nil?
+            product = changes["SelectedProduct"]
+            block.call(product) unless product.nil?
           end
         end
 

service/lib/agama/dbus/software/manager.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) [2022] SUSE LLC
+# Copyright (c) [2022-2023] SUSE LLC
 #
 # All Rights Reserved.
 #
@@ -21,12 +21,12 @@
 
 require "dbus"
 require "agama/dbus/base_object"
-require "agama/dbus/with_service_status"
 require "agama/dbus/clients/locale"
 require "agama/dbus/clients/network"
+require "agama/dbus/interfaces/issues"
 require "agama/dbus/interfaces/progress"
 require "agama/dbus/interfaces/service_status"
-require "agama/dbus/interfaces/validation"
+require "agama/dbus/with_service_status"
 
 module Agama
   module DBus
@@ -36,7 +36,7 @@ class Manager < BaseObject
         include WithServiceStatus
         include Interfaces::Progress
         include Interfaces::ServiceStatus
-        include Interfaces::Validation
+        include Interfaces::Issues
 
         PATH = "/org/opensuse/Agama/Software1"
         private_constant :PATH
@@ -54,20 +54,20 @@ def initialize(backend, logger)
           @selected_patterns = {}
         end
 
+        # List of issues, see {DBus::Interfaces::Issues}
+        #
+        # @return [Array<Agama::Issue>]
+        def issues
+          backend.issues
+        end
+
         SOFTWARE_INTERFACE = "org.opensuse.Agama.Software1"
         private_constant :SOFTWARE_INTERFACE
 
         dbus_interface SOFTWARE_INTERFACE do
-          dbus_reader :available_base_products, "a(ssa{sv})"
-
-          dbus_reader :selected_base_product, "s"
-
-          # documented way to be able to write to patterns and trigger signal
-          attr_writer :selected_patterns
+          dbus_reader :available_products, "a(ssa{sv})"
 
-          # selected patterns is hash with pattern name as id and 0 for user selected and
-          # 1 for auto selected. Can be extended in future e.g. for mandatory patterns
-          dbus_attr_reader :selected_patterns, "a{sy}"
+          dbus_reader :selected_product, "s"
 
           dbus_method :SelectProduct, "in ProductID:s" do |product_id|
             old_product_id = backend.product
@@ -80,7 +80,6 @@ def initialize(backend, logger)
             logger.info "Selecting product #{product_id}"
             select_product(product_id)
             dbus_properties_changed(SOFTWARE_INTERFACE, { "SelectedBaseProduct" => product_id }, [])
-            update_validation # as different product means different software selection
           end
 
           # value of result hash is category, description, icon, summary and order
@@ -101,6 +100,13 @@ def initialize(backend, logger)
             ]
           end
 
+          # documented way to be able to write to patterns and trigger signal
+          attr_writer :selected_patterns
+
+          # selected patterns is hash with pattern name as id and 0 for user selected and
+          # 1 for auto selected. Can be extended in future e.g. for mandatory patterns
+          dbus_attr_reader :selected_patterns, "a{sy}"
+
           dbus_method(:AddPattern, "in id:s") { |p| backend.add_pattern(p) }
           dbus_method(:RemovePattern, "in id:s") { |p| backend.remove_pattern(p) }
           dbus_method(:SetUserPatterns, "in ids:as") { |ids| backend.user_patterns = ids }
@@ -121,7 +127,7 @@ def initialize(backend, logger)
           dbus_method(:Finish) { finish }
         end
 
-        def available_base_products
+        def available_products
           backend.products.map do |id, data|
             [id, data["name"], { "description" => data["description"] }].freeze
           end
@@ -130,7 +136,7 @@ def available_base_products
         # Returns the selected base product
         #
         # @return [String] Product ID or an empty string if no product is selected
-        def selected_base_product
+        def selected_product
           backend.product || ""
         end
 
@@ -140,13 +146,10 @@ def select_product(product_id)
 
         def probe
           busy_while { backend.probe }
-
-          update_validation # probe do force proposal
         end
 
         def propose
           busy_while { backend.propose }
-          update_validation
 
           nil # explicit nil as return value
         end
@@ -159,6 +162,45 @@ def finish
           busy_while { backend.finish }
         end
 
+        REGISTRATION_INTERFACE = "org.opensuse.Agama1.Registration"
+        private_constant :REGISTRATION_INTERFACE
+
+        dbus_interface REGISTRATION_INTERFACE do
+          dbus_reader :reg_code, "s"
+
+          dbus_reader :email, "s"
+
+          dbus_reader :state, "u"
+
+          dbus_method :Register, "in reg_code:s, in options:a{sv}, out result:u" do
+            |reg_code, options|
+            backend.registration.register(reg_code, email: options["Email"])
+            # map errors to exit codes?
+            0
+          end
+
+          dbus_method :Deregister, "out result:u" do
+            backend.registration.deregister
+            # map errors to exit codes?
+            0
+          end
+        end
+
+        def reg_code
+          backend.registration.reg_code || ""
+        end
+
+        def email
+          backend.registration.email || ""
+        end
+
+        # Replace #State by #IsDisabled and #isOptional ?
+        def state
+          return 0 if backend.registration.disabled?
+          return 1 if backend.registration.optional?
+          return 2 unless backend.registration.optional?
+        end
+
       private
 
         # @return [Agama::Software]
@@ -179,6 +221,8 @@ def register_callbacks
           backend.on_selected_patterns_change do
             self.selected_patterns = compute_patterns
           end
+
+          backend.on_issues_change { issues_properties_changed }
         end
 
         USER_SELECTED_PATTERN = 0

service/lib/agama/manager.rb

@@ -200,7 +200,7 @@ def on_services_status_change(&block)
     #
     # @return [Boolean]
     def valid?
-      [users, software].all?(&:valid?) && !storage.errors?
+      users.valid? && !software.errors? && !storage.errors?
     end
 
     # Collects the logs and stores them into an archive

service/lib/agama/registration.rb

@@ -0,0 +1,43 @@
+# Copyright (c) [2024] 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 Agama
+  # Handles everything related to registration of system to SCC, RMT or similar
+  class Registration
+    attr_reader :reg_code
+    attr_reader :email
+
+    # initializes registration with instance of software manager for query about products
+    def initialize(software_manager)
+      @software = software_manager
+    end
+
+    def register(code, email: nil)
+    end
+
+    def deregister
+    end
+
+    def disabled?
+    end
+
+    def optional?
+    end
+  end
+end