ruby-dbus 0.22.1 → 0.23.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9faf3489c1ee5baf70dbb2204b777c577d6237554f072fa44bfdbee49c34e06d
-  data.tar.gz: '08c81cc0acde47f38e19b107222692253fe1b512c7f1bb5698e074c63601b85b'
+  metadata.gz: bfebbc3384d221039f465d964817aad4c42ccc147ed6351b23728665c200a9b8
+  data.tar.gz: 63e5542cd3f7a76dc0d7fc0d852e7fae9c0f506fdbc06f7b2d1f644267cead46
 SHA512:
-  metadata.gz: bf539a91b1420631d7614b83636502f4c41e4ff7f137fb2c54eff88bc6b2810bb53efa14cadd8a5bb28b71864abbb0cd35451202c60f83a78b3e58816aa6fb67
-  data.tar.gz: aa1e225fe3177c63761d8e487b70a688b45330e4f115aa52753fc08f4f194949a206da8e1d102c3f55f49d169a2688bed67d5497639e3da9652f887f3bad5768
+  metadata.gz: 5dea8b83e62b698162f53d18fbc29b60fb594962a449f5d7b8cf82aa10e47fee3633186f894b6d95a42b1d02bc6f5ef172809405e93f57c2b04b450f1fb85732
+  data.tar.gz: 3f0de7019ee46470c4e4afc2f37b4badeab5a1387c6d14c1df2b42b271c7bec9656dad656227e71efdf84d678c88b3394904f2e3c810270aaf0bafdb673fe5c3

data/NEWS.md

@@ -2,6 +2,19 @@
 
 ## Unreleased
 
+## Ruby D-Bus 0.23.0.beta1 - 2023-06-05
+
+Bug fixes:
+* A service can now have more than one name ([#69][]).
+  Connection#request_service is deprecated in favor of Connection#object_server
+  and BusConnection#request_name
+
+[#69]: https://github.com/mvidner/ruby-dbus/issues/69
+
+API:
+ * Remove Service, splitting it into ProxyService and ObjectServer
+ * Split off BusConnection from Connection
+
 ## Ruby D-Bus 0.22.1 - 2023-05-17
 
 Bug fixes:

data/VERSION

@@ -1 +1 @@
-0.22.1
+0.23.0.beta1

data/doc/Reference.md

@@ -24,7 +24,7 @@ is simply "dbus"
 
 1. {DBus.session_bus Connect to the session bus};
 2. {DBus::Connection#[] get the screensaver service}
-3. {DBus::Service#[] and its screensaver object}.
+3. {DBus::ProxyService#[] and its screensaver object}.
 4. Call one of its methods in a loop, solving [xkcd#196](http://xkcd.com/196).
 
  
@@ -58,7 +58,7 @@ a method proxy always returned an array of values. This was to
 accomodate the rare cases of a DBus method specifying more than one
 *out* parameter. For compatibility, the behavior is preserved if you
 construct a {DBus::ProxyObject} with {DBus::ApiOptions::A0},
-which is what {DBus::Service#object} does.
+which is what {DBus::ProxyService#object} does.
 
 For nearly all methods you used `Method[0]` or
 `Method.first`
@@ -340,8 +340,8 @@ for overriding this.
     obj = Note.new("/net/vidner/Example/Properties")
 
     bus = DBus::SessionBus.instance
-    service = bus.request_service("net.vidner.Example")
-    service.export(obj)
+    bus.object_server.export(obj)
+    bus.request_name("net.vidner.Example")
 
     main = DBus::Main.new
     main << bus

data/examples/service/complex-property.rb

@@ -16,6 +16,6 @@ class Test < DBus::Object
 end
 
 bus = DBus::SessionBus.instance
-svc = bus.request_service("net.vidner.Scratch")
-svc.export(Test.new("/net/vidner/Scratch"))
+bus.object_server.export(Test.new("/net/vidner/Scratch"))
+bus.request_name("net.vidner.Scratch")
 DBus::Main.new.tap { |m| m << bus }.run

data/examples/service/service_newapi.rb

@@ -31,9 +31,9 @@ class Test < DBus::Object
 end
 
 bus = DBus::SessionBus.instance
-service = bus.request_service("org.ruby.service")
 myobj = Test.new("/org/ruby/MyInstance")
-service.export(myobj)
+bus.object_server.export(myobj)
+bus.request_name("org.ruby.service")
 
 Thread.new do
   i = 0

data/lib/dbus/bus.rb

@@ -5,7 +5,7 @@
 # This file is part of the ruby-dbus project
 # Copyright (C) 2007 Arnaud Cornet and Paul van Tilburg
 #
-# This library is free software; you caan redistribute it and/or
+# This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
 # License, version 2.1 as published by the Free Software Foundation.
 # See the file "COPYING" for the exact licensing terms.
@@ -17,233 +17,6 @@ require "singleton"
 #
 # Module containing all the D-Bus modules and classes.
 module DBus
-  # This represents a remote service. It should not be instantiated directly
-  # Use {Connection#service}
-  class Service
-    # The service name.
-    attr_reader :name
-    # The bus the service is running on.
-    attr_reader :bus
-    # The service root (FIXME).
-    attr_reader :root
-
-    # Create a new service with a given _name_ on a given _bus_.
-    def initialize(name, bus)
-      @name = BusName.new(name)
-      @bus = bus
-      @root = Node.new("/")
-    end
-
-    # Determine whether the service name already exists.
-    def exists?
-      bus.proxy.ListNames[0].member?(@name)
-    end
-
-    # Perform an introspection on all the objects on the service
-    # (starting recursively from the root).
-    def introspect
-      raise NotImplementedError if block_given?
-
-      rec_introspect(@root, "/")
-      self
-    end
-
-    # Retrieves an object at the given _path_.
-    # @param path [ObjectPath]
-    # @return [ProxyObject]
-    def [](path)
-      object(path, api: ApiOptions::A1)
-    end
-
-    # Retrieves an object at the given _path_
-    # whose methods always return an array.
-    # @param path [ObjectPath]
-    # @param api [ApiOptions]
-    # @return [ProxyObject]
-    def object(path, api: ApiOptions::A0)
-      node = get_node(path, create: true)
-      if node.object.nil? || node.object.api != api
-        node.object = ProxyObject.new(
-          @bus, @name, path,
-          api: api
-        )
-      end
-      node.object
-    end
-
-    # Export an object
-    # @param obj [DBus::Object]
-    def export(obj)
-      obj.service = self
-      get_node(obj.path, create: true).object = obj
-      object_manager_for(obj)&.object_added(obj)
-    end
-
-    # Undo exporting an object _obj_.
-    # Raises ArgumentError if it is not a DBus::Object.
-    # Returns the object, or false if _obj_ was not exported.
-    # @param obj [DBus::Object]
-    def unexport(obj)
-      raise ArgumentError, "DBus::Service#unexport() expects a DBus::Object argument" unless obj.is_a?(DBus::Object)
-      return false unless obj.path
-
-      last_path_separator_idx = obj.path.rindex("/")
-      parent_path = obj.path[1..last_path_separator_idx - 1]
-      node_name = obj.path[last_path_separator_idx + 1..-1]
-
-      parent_node = get_node(parent_path, create: false)
-      return false unless parent_node
-
-      object_manager_for(obj)&.object_removed(obj)
-      obj.service = nil
-      parent_node.delete(node_name).object
-    end
-
-    # Get the object node corresponding to the given *path*.
-    # @param path [ObjectPath]
-    # @param create [Boolean] if true, the the {Node}s in the path are created
-    #   if they do not already exist.
-    # @return [Node,nil]
-    def get_node(path, create: false)
-      n = @root
-      path.sub(%r{^/}, "").split("/").each do |elem|
-        if !(n[elem])
-          return nil if !create
-
-          n[elem] = Node.new(elem)
-        end
-        n = n[elem]
-      end
-      n
-    end
-
-    # Find the (closest) parent of *object*
-    # implementing the ObjectManager interface, or nil
-    # @return [DBus::Object,nil]
-    def object_manager_for(object)
-      path = object.path
-      node_chain = get_node_chain(path)
-      om_node = node_chain.reverse_each.find do |node|
-        node.object&.is_a? DBus::ObjectManager
-      end
-      om_node&.object
-    end
-
-    # All objects (not paths) under this path (except itself).
-    # @param path [ObjectPath]
-    # @return [Array<DBus::Object>]
-    # @raise ArgumentError if the *path* does not exist
-    def descendants_for(path)
-      node = get_node(path, create: false)
-      raise ArgumentError, "Object path #{path} doesn't exist" if node.nil?
-
-      node.descendant_objects
-    end
-
-    #########
-
-    private
-
-    #########
-
-    # @raise ArgumentError if the *path* does not exist
-    def get_node_chain(path)
-      n = @root
-      result = [n]
-      path.sub(%r{^/}, "").split("/").each do |elem|
-        n = n[elem]
-        raise ArgumentError, "Object path #{path} doesn't exist" if n.nil?
-
-        result.push(n)
-      end
-      result
-    end
-
-    # Perform a recursive retrospection on the given current _node_
-    # on the given _path_.
-    def rec_introspect(node, path)
-      xml = bus.introspect_data(@name, path)
-      intfs, subnodes = IntrospectXMLParser.new(xml).parse
-      subnodes.each do |nodename|
-        subnode = node[nodename] = Node.new(nodename)
-        subpath = if path == "/"
-                    "/#{nodename}"
-                  else
-                    "#{path}/#{nodename}"
-                  end
-        rec_introspect(subnode, subpath)
-      end
-      return if intfs.empty?
-
-      node.object = ProxyObjectFactory.new(xml, @bus, @name, path).build
-    end
-  end
-
-  # = Object path node class
-  #
-  # Class representing a node on an object path.
-  class Node < Hash
-    # @return [DBus::Object,DBus::ProxyObject,nil]
-    #   The D-Bus object contained by the node.
-    attr_accessor :object
-
-    # The name of the node.
-    # @return [String] the last component of its object path, or "/"
-    attr_reader :name
-
-    # Create a new node with a given _name_.
-    def initialize(name)
-      super()
-      @name = name
-      @object = nil
-    end
-
-    # Return an XML string representation of the node.
-    # It is shallow, not recursing into subnodes
-    # @param node_opath [String]
-    def to_xml(node_opath)
-      xml = '<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
-"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
-'
-      xml += "<node name=\"#{node_opath}\">\n"
-      each_key do |k|
-        xml += "  <node name=\"#{k}\" />\n"
-      end
-      @object&.intfs&.each_value do |v|
-        xml += v.to_xml
-      end
-      xml += "</node>"
-      xml
-    end
-
-    # Return inspect information of the node.
-    def inspect
-      # Need something here
-      "<DBus::Node #{sub_inspect}>"
-    end
-
-    # Return instance inspect information, used by Node#inspect.
-    def sub_inspect
-      s = ""
-      if !@object.nil?
-        s += format("%x ", @object.object_id)
-      end
-      contents_sub_inspect = keys
-                             .map { |k| "#{k} => #{self[k].sub_inspect}" }
-                             .join(",")
-      "#{s}{#{contents_sub_inspect}}"
-    end
-
-    # All objects (not paths) under this path (except itself).
-    # @return [Array<DBus::Object>]
-    def descendant_objects
-      children_objects = values.map(&:object).compact
-      descendants = values.map(&:descendant_objects)
-      flat_descendants = descendants.reduce([], &:+)
-      children_objects + flat_descendants
-    end
-  end
-
   # FIXME: rename Connection to Bus?
 
   # D-Bus main connection class
@@ -279,6 +52,10 @@ module DBus
       @proxy = nil
     end
 
+    def object_server
+      @object_server ||= ObjectServer.new(self)
+    end
+
     # Dispatch all messages that are available in the queue,
     # but do not block on the queue.
     # Called by a main loop when something is available in the queue
@@ -487,11 +264,23 @@ module DBus
     class NameRequestError < Exception
     end
 
+    def handle_return_of_request_name(ret, name)
+      details = if ret == REQUEST_NAME_REPLY_IN_QUEUE
+                  other = proxy.GetNameOwner(name).first
+                  other_creds = proxy.GetConnectionCredentials(other).first
+                  "already owned by #{other}, #{other_creds.inspect}"
+                else
+                  "error code #{ret}"
+                end
+      raise NameRequestError, "Could not request #{name}, #{details}" unless ret == REQUEST_NAME_REPLY_PRIMARY_OWNER
+
+      ret
+    end
+
     # Attempt to request a service _name_.
-    #
-    # FIXME, NameRequestError cannot really be rescued as it will be raised
-    # when dispatching a later call. Rework the API to better match the spec.
-    # @return [Service]
+    # @raise NameRequestError which cannot really be rescued as it will be raised when dispatching a later call.
+    # @return [ObjectServer]
+    # @deprecated Use {BusConnection#request_name}.
     def request_service(name)
       # Use RequestName, but asynchronously!
       # A synchronous call would not work with service activation, where
@@ -501,17 +290,9 @@ module DBus
         # check and report errors first
         raise rmsg if rmsg.is_a?(Error)
 
-        details = if r == REQUEST_NAME_REPLY_IN_QUEUE
-                    other = proxy.GetNameOwner(name).first
-                    other_creds = proxy.GetConnectionCredentials(other).first
-                    "already owned by #{other}, #{other_creds.inspect}"
-                  else
-                    "error code #{r}"
-                  end
-        raise NameRequestError, "Could not request #{name}, #{details}" unless r == REQUEST_NAME_REPLY_PRIMARY_OWNER
+        handle_return_of_request_name(r, name)
       end
-      @service = Service.new(name, self)
-      @service
+      object_server
     end
 
     # Set up a ProxyObject for the bus itself, since the bus is introspectable.
@@ -631,7 +412,7 @@ module DBus
         if msg.path == "/org/freedesktop/DBus"
           DBus.logger.debug "Got method call on /org/freedesktop/DBus"
         end
-        node = @service.get_node(msg.path, create: false)
+        node = object_server.get_node(msg.path, create: false)
         # introspect a known path even if there is no object on it
         if node &&
            msg.interface == "org.freedesktop.DBus.Introspectable" &&
@@ -670,24 +451,23 @@ module DBus
     def service(name)
       # The service might not exist at this time so we cannot really check
       # anything
-      Service.new(name, self)
+      ProxyService.new(name, self)
     end
     alias [] service
 
     # @api private
     # Emit a signal event for the given _service_, object _obj_, interface
     # _intf_ and signal _sig_ with arguments _args_.
-    # @param service [Service]
+    # @param _service unused
     # @param obj [DBus::Object]
     # @param intf [Interface]
     # @param sig [Signal]
     # @param args arguments for the signal
-    def emit(service, obj, intf, sig, *args)
+    def emit(_service, obj, intf, sig, *args)
       m = Message.new(DBus::Message::SIGNAL)
       m.path = obj.path
       m.interface = intf.name
       m.member = sig.name
-      m.sender = service.name
       i = 0
       sig.params.each do |par|
         m.add_param(par.type, args[i])
@@ -710,7 +490,25 @@ module DBus
         @unique_name = rmsg.destination
         DBus.logger.debug "Got hello reply. Our unique_name is #{@unique_name}"
       end
-      @service = Service.new(@unique_name, self)
+    end
+  end
+
+  # A regular Bus {Connection}.
+  # As opposed to a peer connection to a single counterparty with no daemon in between.
+  # FIXME: move the remaining relevant methods from Connection here, but alias the constants
+  class BusConnection < Connection
+    # @param name [BusName] the requested name
+    # @param flags [Integer] TODO: explain and add a better non-numeric API for this
+    # @raise NameRequestError if we could not get the name
+    # @example Usage
+    #   bus = DBus.session_bus
+    #   bus.object_server.export(DBus::Object.new("/org/example/Test"))
+    #   bus.request_name("org.example.Test")
+    # @see https://dbus.freedesktop.org/doc/dbus-specification.html#bus-messages-request-name
+    def request_name(name, flags: 0)
+      name = BusName.new(name)
+      r = proxy.RequestName(name, flags).first
+      handle_return_of_request_name(r, name)
     end
   end
 
@@ -720,7 +518,7 @@ module DBus
   #
   # Use SessionBus, the non-singleton ASessionBus is
   # for the test suite.
-  class ASessionBus < Connection
+  class ASessionBus < BusConnection
     # Get the the default session bus.
     def initialize
       super(self.class.session_bus_address)
@@ -771,7 +569,7 @@ module DBus
   #
   # Use SystemBus, the non-singleton ASystemBus is
   # for the test suite.
-  class ASystemBus < Connection
+  class ASystemBus < BusConnection
     # Get the default system bus.
     def initialize
       super(self.class.system_bus_address)
@@ -794,7 +592,8 @@ module DBus
   #
   # you'll need to take care about authentification then, more info here:
   # https://gitlab.com/pangdudu/ruby-dbus/-/blob/master/README.rdoc
-  class RemoteBus < Connection
+  # TODO: keep the name but update the docs
+  class RemoteBus < BusConnection
     # Get the remote bus.
     def initialize(socket_name)
       super(socket_name)
@@ -818,55 +617,4 @@ module DBus
   def self.session_bus
     SessionBus.instance
   end
-
-  # = Main event loop class.
-  #
-  # Class that takes care of handling message and signal events
-  # asynchronously.  *Note:* This is a native implement and therefore does
-  # not integrate with a graphical widget set main loop.
-  class Main
-    # Create a new main event loop.
-    def initialize
-      @buses = {}
-      @quitting = false
-    end
-
-    # Add a _bus_ to the list of buses to watch for events.
-    def <<(bus)
-      @buses[bus.message_queue.socket] = bus
-    end
-
-    # Quit a running main loop, to be used eg. from a signal handler
-    def quit
-      @quitting = true
-    end
-
-    # Run the main loop. This is a blocking call!
-    def run
-      # before blocking, empty the buffers
-      # https://bugzilla.novell.com/show_bug.cgi?id=537401
-      @buses.each_value do |b|
-        while (m = b.message_queue.message_from_buffer_nonblock)
-          b.process(m)
-        end
-      end
-      while !@quitting && !@buses.empty?
-        ready = IO.select(@buses.keys, [], [], 5) # timeout 5 seconds
-        next unless ready # timeout exceeds so continue unless quitting
-
-        ready.first.each do |socket|
-          b = @buses[socket]
-          begin
-            b.message_queue.buffer_from_socket_nonblock
-          rescue EOFError, SystemCallError
-            @buses.delete socket # this bus died
-            next
-          end
-          while (m = b.message_queue.message_from_buffer_nonblock)
-            b.process(m)
-          end
-        end
-      end
-    end
-  end
 end

data/lib/dbus/logger.rb

@@ -17,9 +17,10 @@ module DBus
   # The default one logs to STDERR,
   # with DEBUG if $DEBUG is set, otherwise INFO.
   def logger
-    unless defined? @logger
+    if @logger.nil?
+      debug = $DEBUG || ENV["RUBY_DBUS_DEBUG"]
       @logger = Logger.new($stderr)
-      @logger.level = $DEBUG ? Logger::DEBUG : Logger::INFO
+      @logger.level = debug ? Logger::DEBUG : Logger::INFO
     end
     @logger
   end

data/lib/dbus/main.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# This file is part of the ruby-dbus project
+# Copyright (C) 2007 Arnaud Cornet and Paul van Tilburg
+# Copyright (C) 2023 Martin Vidner
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License, version 2.1 as published by the Free Software Foundation.
+# See the file "COPYING" for the exact licensing terms.
+
+module DBus
+  # = Main event loop class.
+  #
+  # Class that takes care of handling message and signal events
+  # asynchronously.  *Note:* This is a native implement and therefore does
+  # not integrate with a graphical widget set main loop.
+  class Main
+    # Create a new main event loop.
+    def initialize
+      @buses = {}
+      @quitting = false
+    end
+
+    # Add a _bus_ to the list of buses to watch for events.
+    def <<(bus)
+      @buses[bus.message_queue.socket] = bus
+    end
+
+    # Quit a running main loop, to be used eg. from a signal handler
+    def quit
+      @quitting = true
+    end
+
+    # Run the main loop. This is a blocking call!
+    def run
+      # before blocking, empty the buffers
+      # https://bugzilla.novell.com/show_bug.cgi?id=537401
+      @buses.each_value do |b|
+        while (m = b.message_queue.message_from_buffer_nonblock)
+          b.process(m)
+        end
+      end
+      while !@quitting && !@buses.empty?
+        ready = IO.select(@buses.keys, [], [], 5) # timeout 5 seconds
+        next unless ready # timeout exceeds so continue unless quitting
+
+        ready.first.each do |socket|
+          b = @buses[socket]
+          begin
+            b.message_queue.buffer_from_socket_nonblock
+          rescue EOFError, SystemCallError => e
+            DBus.logger.debug "Got #{e.inspect} from #{socket.inspect}"
+            @buses.delete socket # this bus died
+            next
+          end
+          while (m = b.message_queue.message_from_buffer_nonblock)
+            b.process(m)
+          end
+        end
+      end
+      DBus.logger.debug "Main loop quit" if @quitting
+      DBus.logger.debug "Main loop quit, no connections left" if @buses.empty?
+    end
+  end
+end

data/lib/dbus/message.rb

@@ -16,12 +16,6 @@ require_relative "raw_message"
 #
 # Module containing all the D-Bus modules and classes.
 module DBus
-  # = InvalidDestinationName class
-  # Thrown when you try to send a message to /org/freedesktop/DBus/Local, that
-  # is reserved.
-  class InvalidDestinationName < Exception
-  end
-
   # = D-Bus message class
   #
   # Class that holds any type of message that travels over the bus.
@@ -164,11 +158,15 @@ module DBus
     SENDER = 7
     SIGNATURE = 8
 
+    RESERVED_PATH = "/org/freedesktop/DBus/Local"
+
     # Marshall the message with its current set parameters and return
     # it in a packet form.
+    # @return [String]
     def marshall
-      if @path == "/org/freedesktop/DBus/Local"
-        raise InvalidDestinationName
+      if @path == RESERVED_PATH
+        # the bus would disconnect us, better explain why
+        raise "Cannot send a message with the reserved path #{RESERVED_PATH}: #{inspect}"
       end
 
       params_marshaller = PacketMarshaller.new(endianness: ENDIANNESS)