ruby-dbus 0.20.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d52907f5f6be32813466ae280cb99ff605d4195ca84396e97a90a7568fb579ec
-  data.tar.gz: 01bf87805f19878641a424f5c9ba21fcff637dcb6d4bbcdc230dda3713df8c80
+  metadata.gz: 6fb99aaae181360df50b490a74425d252d5d78d6c2cbfb72d6b1fad72a35defd
+  data.tar.gz: 7443efcea3624c95617b8375c7e71986f6746c3b9a81f658f0b26c427e0b424d
 SHA512:
-  metadata.gz: 8009bcca0c66ddb5d5e9ca76a2fbc06b0408437ac3f5135d1378362f58520cbcb20c6d625d242e7c19ca1f679b4ab7b4e584e5f9d6c376eea90f57372f7f27aa
-  data.tar.gz: 0d8388654ae2ad5aeca7cf0eb6cec2fb3eb463ac43b85eb7a83bfbd32a011d65749b1a1195fcc4ae0f8c6a5591e49c0176a09c442c67a166ce2432bb30d704f7
+  metadata.gz: cc10425266793eb1f7e712aabc0a685b76f3467212a72346df3f382186cd5a05f0cc4124f1056e7c2cc5b64a54d376b5b038812063347a870ab86e72275f67c7
+  data.tar.gz: 2e7eedd8c235788121ab59412b5a9dec2841b1b8e738790b2405ebd69c3b284df9261f06545b0bab93990b6daed3188d7872afbfb219dc867ff8fc0119481e68

data/NEWS.md

@@ -2,6 +2,34 @@
 
 ## Unreleased
 
+## Ruby D-Bus 0.22.0 - 2023-05-08
+
+Features:
+ * Enable using nokogiri without rexml (by Dominik Andreas Schorpp, [#132][])
+
+Bug fixes:
+ * Respect DBUS_SYSTEM_BUS_ADDRESS environment variable.
+
+Other:
+ * For NameRequestError, mention who is the other owner.
+ * Session bus autolaunch still does not work, but: don't try launchd except
+   on macOS, and improve the error message.
+ * examples/gdbus split off to its own repository,
+   https://github.com/mvidner/dbus-gui-gtk
+
+[#132]: https://github.com/mvidner/ruby-dbus/pull/132
+
+## Ruby D-Bus 0.21.0 - 2023-04-08
+
+Features:
+ * Respect env RUBY_DBUS_ENDIANNESS=B (or =l) for outgoing messages.
+
+Bug fixes:
+ * Reduce socket buffer allocations ([#129][]).
+ * Message#marshall speedup: don't marshall the body twice.
+
+[#129]: https://github.com/mvidner/ruby-dbus/pull/129
+
 ## Ruby D-Bus 0.20.0 - 2023-03-21
 
 Features:
@@ -82,7 +110,7 @@ API:
    when declaring properties ([#117][]).
 
 [#115]: https://github.com/mvidner/ruby-dbus/issues/115
-[#117]: https://github.com/mvidner/ruby-dbus/pulls/117
+[#117]: https://github.com/mvidner/ruby-dbus/pull/117
 
 ## Ruby D-Bus 0.18.0.beta7 - 2022-05-29
 
@@ -450,7 +478,7 @@ Bug fixes:
  * Handle more ways which tell us that a bus connection has died.
 
 [#3]: https://github.com/mvidner/ruby-dbus/issue/3
-[bsc#617350]: https://bugzilla.novell.com/show_bug.cgi?id=617350
+[bsc#617350]: https://bugzilla.suse.com/show_bug.cgi?id=617350
 
 ## Ruby D-Bus 0.3.0 - 2010-03-28
 
@@ -518,8 +546,8 @@ Bug fixes:
  * Fixed an endless sleep in DBus::Main.run ([bsc#537401][]).
  * Added details to PacketMarshaller exceptions ([bsc#538050][]).
 
-[bsc#537401]: https://bugzilla.novell.com/show_bug.cgi?id=537401
-[bsc#538050]: https://bugzilla.novell.com/show_bug.cgi?id=538050
+[bsc#537401]: https://bugzilla.suse.com/show_bug.cgi?id=537401
+[bsc#538050]: https://bugzilla.suse.com/show_bug.cgi?id=538050
 
 ## Ruby D-Bus "I'm not dead" 0.2.9 - 2009-08-26
 

data/VERSION

@@ -1 +1 @@
-0.20.0
+0.22.0

data/lib/dbus/auth.rb

@@ -8,8 +8,6 @@
 # License, version 2.1 as published by the Free Software Foundation.
 # See the file "COPYING" for the exact licensing terms.
 
-require "rbconfig"
-
 module DBus
   # Exception raised when authentication fails somehow.
   class AuthenticationFailed < StandardError
@@ -183,7 +181,7 @@ module DBus
       # that may carry credentials.
       # @return [void]
       def send_nul_byte
-        if RbConfig::CONFIG["target_os"] =~ /freebsd/
+        if Platform.freebsd?
           @socket.sendmsg(0.chr, 0, nil, [:SOCKET, :SCM_CREDS, ""])
         else
           @socket.write(0.chr)

data/lib/dbus/bus.rb

@@ -318,10 +318,13 @@ module DBus
 <node>
   <interface name="org.freedesktop.DBus.Introspectable">
     <method name="Introspect">
-      <arg name="data" direction="out" type="s"/>
+      <arg direction="out" type="s"/>
     </method>
   </interface>
   <interface name="org.freedesktop.DBus">
+    <method name="Hello">
+      <arg direction="out" type="s"/>
+    </method>
     <method name="RequestName">
       <arg direction="in" type="s"/>
       <arg direction="in" type="u"/>
@@ -336,8 +339,8 @@ module DBus
       <arg direction="in" type="u"/>
       <arg direction="out" type="u"/>
     </method>
-    <method name="Hello">
-      <arg direction="out" type="s"/>
+    <method name="UpdateActivationEnvironment">
+      <arg direction="in" type="a{ss}"/>
     </method>
     <method name="NameHasOwner">
       <arg direction="in" type="s"/>
@@ -371,12 +374,29 @@ module DBus
       <arg direction="in" type="s"/>
       <arg direction="out" type="u"/>
     </method>
+    <method name="GetAdtAuditSessionData">
+      <arg direction="in" type="s"/>
+      <arg direction="out" type="ay"/>
+    </method>
     <method name="GetConnectionSELinuxSecurityContext">
       <arg direction="in" type="s"/>
       <arg direction="out" type="ay"/>
     </method>
     <method name="ReloadConfig">
     </method>
+    <method name="GetId">
+      <arg direction="out" type="s"/>
+    </method>
+    <method name="GetConnectionCredentials">
+      <arg direction="in" type="s"/>
+      <arg direction="out" type="a{sv}"/>
+    </method>
+    <property name="Features" type="as" access="read">
+      <annotation name="org.freedesktop.DBus.Property.EmitsChangedSignal" value="const"/>
+    </property>
+    <property name="Interfaces" type="as" access="read">
+      <annotation name="org.freedesktop.DBus.Property.EmitsChangedSignal" value="const"/>
+    </property>
     <signal name="NameOwnerChanged">
       <arg type="s"/>
       <arg type="s"/>
@@ -480,7 +500,15 @@ module DBus
       proxy.RequestName(name, NAME_FLAG_REPLACE_EXISTING) do |rmsg, r|
         # check and report errors first
         raise rmsg if rmsg.is_a?(Error)
-        raise NameRequestError unless r == REQUEST_NAME_REPLY_PRIMARY_OWNER
+
+        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
       end
       @service = Service.new(name, self)
       @service
@@ -702,7 +730,8 @@ module DBus
     def self.session_bus_address
       ENV["DBUS_SESSION_BUS_ADDRESS"] ||
         address_from_file ||
-        "launchd:env=DBUS_LAUNCHD_SESSION_BUS_SOCKET"
+        ("launchd:env=DBUS_LAUNCHD_SESSION_BUS_SOCKET" if Platform.macos?) ||
+        (raise NotImplementedError, "Cannot find session bus; sorry, haven't figured out autolaunch yet")
     end
 
     def self.address_from_file
@@ -732,6 +761,9 @@ module DBus
     include Singleton
   end
 
+  # Default socket name for the system bus.
+  SYSTEM_BUS_ADDRESS = "unix:path=/var/run/dbus/system_bus_socket"
+
   # = D-Bus system bus class
   #
   # The system bus is a system-wide bus mostly used for global or
@@ -742,9 +774,13 @@ module DBus
   class ASystemBus < Connection
     # Get the default system bus.
     def initialize
-      super(SYSTEM_BUS_ADDRESS)
+      super(self.class.system_bus_address)
       send_hello
     end
+
+    def self.system_bus_address
+      ENV["DBUS_SYSTEM_BUS_ADDRESS"] || SYSTEM_BUS_ADDRESS
+    end
   end
 
   # = D-Bus remote (TCP) bus class

data/lib/dbus/message.rb

@@ -10,6 +10,8 @@
 # License, version 2.1 as published by the Free Software Foundation.
 # See the file "COPYING" for the exact licensing terms.
 
+require_relative "raw_message"
+
 # = D-Bus main module
 #
 # Module containing all the D-Bus modules and classes.
@@ -144,6 +146,10 @@ module DBus
       @params << [type, val]
     end
 
+    # "l" or "B"
+    ENDIANNESS_CHAR = ENV.fetch("RUBY_DBUS_ENDIANNESS", HOST_END)
+    ENDIANNESS = RawMessage.endianness(ENDIANNESS_CHAR)
+
     # FIXME: what are these? a message element constant enumeration?
     # See method below, in a message, you have and array of optional parameters
     # that come with an index, to determine their meaning. The values are in
@@ -165,14 +171,14 @@ module DBus
         raise InvalidDestinationName
       end
 
-      params = PacketMarshaller.new
-      @params.each do |param|
-        params.append(param[0], param[1])
+      params_marshaller = PacketMarshaller.new(endianness: ENDIANNESS)
+      @params.each do |type, value|
+        params_marshaller.append(type, value)
       end
-      @body_length = params.packet.bytesize
+      @body_length = params_marshaller.packet.bytesize
 
-      marshaller = PacketMarshaller.new
-      marshaller.append(Type::BYTE, HOST_END.ord)
+      marshaller = PacketMarshaller.new(endianness: ENDIANNESS)
+      marshaller.append(Type::BYTE, ENDIANNESS_CHAR.ord)
       marshaller.append(Type::BYTE, @message_type)
       marshaller.append(Type::BYTE, @flags)
       marshaller.append(Type::BYTE, @protocol)
@@ -191,10 +197,8 @@ module DBus
       marshaller.append("a(yv)", headers)
 
       marshaller.align(8)
-      @params.each do |param|
-        marshaller.append(param[0], param[1])
-      end
-      marshaller.packet
+
+      marshaller.packet + params_marshaller.packet
     end
 
     # Unmarshall a packet contained in the buffer _buf_ and set the

data/lib/dbus/message_queue.rb

@@ -18,10 +18,15 @@ module DBus
     # The socket that is used to connect with the bus.
     attr_reader :socket
 
+    # The buffer size for messages.
+    MSG_BUF_SIZE = 4096
+
     def initialize(address)
       DBus.logger.debug "MessageQueue: #{address}"
       @address = address
       @buffer = ""
+      # Reduce allocations by using a single buffer for our socket
+      @read_buffer = String.new(capacity: MSG_BUF_SIZE)
       @is_tcp = false
       @mutex = Mutex.new
       connect
@@ -157,15 +162,12 @@ module DBus
       ret
     end
 
-    # The buffer size for messages.
-    MSG_BUF_SIZE = 4096
-
     # Fill (append) the buffer from data that might be available on the
     # socket.
     # @return [void]
     # @raise EOFError
     def buffer_from_socket_nonblock
-      @buffer += @socket.read_nonblock(MSG_BUF_SIZE)
+      @buffer += @socket.read_nonblock(MSG_BUF_SIZE, @read_buffer)
     rescue EOFError
       raise # the caller expects it
     rescue Errno::EAGAIN

data/lib/dbus/platform.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# This file is part of the ruby-dbus project
+# 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.
+
+require "rbconfig"
+
+module DBus
+  # Platform detection
+  module Platform
+    module_function
+
+    def freebsd?
+      RbConfig::CONFIG["target_os"] =~ /freebsd/
+    end
+
+    def macos?
+      RbConfig::CONFIG["target_os"] =~ /darwin/
+    end
+  end
+end

data/lib/dbus/proxy_object.rb

@@ -126,8 +126,9 @@ module DBus
     # It uses _default_iface_ which must have been set.
     # @return [void]
     def on_signal(name, &block)
-      # TODO: improve
-      raise NoMethodError unless @default_iface && has_iface?(@default_iface)
+      unless @default_iface && has_iface?(@default_iface)
+        raise NoMethodError, "undefined signal `#{name}' for DBus interface `#{@default_iface}' on object `#{@path}'"
+      end
 
       @interfaces[@default_iface].on_signal(name, &block)
     end

data/lib/dbus/xml.rb

@@ -11,11 +11,17 @@
 # License, version 2.1 as published by the Free Software Foundation.
 # See the file "COPYING" for the exact licensing terms.
 
-# TODO: check if it is slow, make replaceable
-require "rexml/document"
+# Our gemspec says rexml is needed and nokogiri is optional
+# but in fact either will do
+
 begin
   require "nokogiri"
 rescue LoadError
+  begin
+    require "rexml/document"
+  rescue LoadError
+    raise LoadError, "cannot load nokogiri OR rexml/document"
+  end
 end
 
 module DBus

data/lib/dbus.rb

@@ -10,6 +10,21 @@
 # License, version 2.1 as published by the Free Software Foundation.
 # See the file "COPYING" for the exact licensing terms.
 
+module DBus
+  # Byte signifying big endianness.
+  BIG_END = "B"
+  # Byte signifying little endianness.
+  LIL_END = "l"
+
+  # Byte signifying the host's endianness.
+  HOST_END = if [0x01020304].pack("L").unpack1("V") == 0x01020304
+               LIL_END
+             else
+               BIG_END
+             end
+end
+# ^ That's because dbus/message needs HOST_END early
+
 require_relative "dbus/api_options"
 require_relative "dbus/auth"
 require_relative "dbus/bus"
@@ -26,6 +41,7 @@ require_relative "dbus/message_queue"
 require_relative "dbus/object"
 require_relative "dbus/object_manager"
 require_relative "dbus/object_path"
+require_relative "dbus/platform"
 require_relative "dbus/proxy_object"
 require_relative "dbus/proxy_object_factory"
 require_relative "dbus/proxy_object_interface"
@@ -38,21 +54,6 @@ require "socket"
 #
 # Module containing all the D-Bus modules and classes.
 module DBus
-  # Default socket name for the system bus.
-  SYSTEM_BUS_ADDRESS = "unix:path=/var/run/dbus/system_bus_socket"
-
-  # Byte signifying big endianness.
-  BIG_END = "B"
-  # Byte signifying little endianness.
-  LIL_END = "l"
-
-  # Byte signifying the host's endianness.
-  HOST_END = if [0x01020304].pack("L").unpack1("V") == 0x01020304
-               LIL_END
-             else
-               BIG_END
-             end
-
   # Comparing symbols is faster than strings
   # @return [:little,:big]
   HOST_ENDIANNESS = RawMessage.endianness(HOST_END)

data/ruby-dbus.gemspec

@@ -22,9 +22,10 @@ GEMSPEC = Gem::Specification.new do |s|
 
   s.required_ruby_version = ">= 2.4.0"
 
-  s.add_dependency "rexml"
-
-  # This is optional
+  # Either of rexml and nokogiri is required
+  # but AFAIK gemspec cannot express that.
+  # Nokogiri is recommended as rexml is dead slow.
+  s.add_runtime_dependency "rexml"
   # s.add_runtime_dependency "nokogiri"
 
   s.add_development_dependency "packaging_rake_tasks"

data/spec/bus_and_xml_backend_spec.rb

@@ -5,7 +5,9 @@
 require_relative "spec_helper"
 
 require "rubygems"
-require "nokogiri"
+# If we have nokogiri, rexml is normally omitted
+# but here we include it for test coverage
+require "rexml"
 require "dbus"
 
 describe "BusAndXmlBackendTest" do

data/spec/platform_spec.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env rspec
+# frozen_string_literal: true
+
+require_relative "spec_helper"
+require "dbus"
+
+describe DBus::Platform do
+  describe ".macos?" do
+    # code coverage chasing, as other tests mock it out
+    it "doesn't crash" do
+      expect { described_class.macos? }.to_not raise_error
+    end
+  end
+end

data/spec/raw_message_spec.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env rspec
+# frozen_string_literal: true
+
+require_relative "spec_helper"
+require "dbus"
+
+# Pedantic full coverage test.
+# The happy paths are covered via calling classes
+describe DBus::RawMessage do
+  describe ".endianness" do
+    it "returns :little for 'l'" do
+      expect(described_class.endianness("l")).to eq :little
+    end
+
+    it "returns :big for 'B'" do
+      expect(described_class.endianness("B")).to eq :big
+    end
+
+    it "raises for other strings" do
+      expect { described_class.endianness("m") }
+        .to raise_error(DBus::InvalidPacketException, /Incorrect endianness/)
+    end
+  end
+
+  describe "#align" do
+    it "raises for values other than 1 2 4 8" do
+      subject = described_class.new("l")
+      expect { subject.align(3) }.to raise_error(ArgumentError)
+      expect { subject.align(16) }.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/session_bus_spec.rb

@@ -4,6 +4,23 @@
 require_relative "spec_helper"
 require "dbus"
 
+describe DBus::ASystemBus do
+  describe "#initialize" do
+    it "will use DBUS_SYSTEM_BUS_ADDRESS or the well known address" do
+      expect(ENV)
+        .to receive(:[])
+        .with("DBUS_SYSTEM_BUS_ADDRESS")
+        .and_return(nil)
+      expect(DBus::MessageQueue)
+        .to receive(:new)
+        .with("unix:path=/var/run/dbus/system_bus_socket")
+      expect_any_instance_of(described_class).to receive(:send_hello)
+
+      described_class.new
+    end
+  end
+end
+
 describe DBus::ASessionBus do
   subject(:dbus_session_bus_address) { "unix:abstract=/tmp/dbus-foo,guid=123" }
 
@@ -18,6 +35,22 @@ describe DBus::ASessionBus do
       ENV["DBUS_SESSION_BUS_ADDRESS"] = dbus_session_bus_address
       expect(DBus::ASessionBus.session_bus_address).to eq(dbus_session_bus_address)
     end
+
+    it "uses launchd on macOS when ENV and file fail" do
+      ENV["DBUS_SESSION_BUS_ADDRESS"] = nil
+      expect(described_class).to receive(:address_from_file).and_return(nil)
+      expect(DBus::Platform).to receive(:macos?).and_return(true)
+
+      expect(described_class.session_bus_address).to start_with "launchd:"
+    end
+
+    it "raises a readable exception when all addresses fail" do
+      ENV["DBUS_SESSION_BUS_ADDRESS"] = nil
+      expect(described_class).to receive(:address_from_file).and_return(nil)
+      expect(DBus::Platform).to receive(:macos?).and_return(false)
+
+      expect { described_class.session_bus_address }.to raise_error(NotImplementedError, /Cannot find session bus/)
+    end
   end
 
   describe "#address_from_file" do

data/spec/signal_spec.rb

@@ -103,4 +103,14 @@ describe "SignalHandlerTest" do
   it "tests removing a nonexistent rule" do
     @obj.on_signal "DoesNotExist"
   end
+
+  describe DBus::ProxyObject do
+    describe "#on_signal" do
+      it "raises a descriptive error when the default_iface is wrong" do
+        @obj.default_iface = "org.ruby.NoSuchInterface"
+        expect { @obj.on_signal("Foo") {} }
+          .to raise_error(NoMethodError, /undefined signal.*interface `org.ruby.NoSuchInterface'/)
+      end
+    end
+  end
 end

data/spec/tools/dbus-launch-simple

@@ -16,9 +16,9 @@ my_dbus_launch () {
     # wait for the daemon to print the info
     TRIES=0
     while [ ! -s $AF -o ! -s $PF ]; do
-	sleep 0.1
-	TRIES=`expr $TRIES + 1`
-	if [ $TRIES -gt 100 ]; then echo "dbus-daemon failed?"; exit 1; fi
+        sleep 0.1
+        TRIES=`expr $TRIES + 1`
+        if [ $TRIES -gt 100 ]; then echo "dbus-daemon failed?"; exit 1; fi
     done
     DBUS_SESSION_BUS_PID=$(cat $PF)
     export DBUS_SESSION_BUS_ADDRESS=$(cat $AF)
@@ -26,10 +26,10 @@ my_dbus_launch () {
 #    dbus-monitor &
 }
 
-my_dbus_launch
-
 # Clean up at exit.
 trap "kill \$KILLS; rm -rf \$RM_FILES" EXIT TERM INT
 
+my_dbus_launch
+
 # run the payload; the return value is passed on
 "$@"

data/spec/tools/dbus-limited-session.conf

@@ -21,7 +21,14 @@
   <allow_anonymous/>
   -->
 
+  <!-- Give clients a variety of addresses to connect to -->
   <listen>unix:tmpdir=/tmp</listen>
+  <listen>unix:dir=/tmp</listen>
+  <!-- runtime will happily steal the actual session bus! -->
+  <!--
+  <listen>unix:runtime=yes</listen>
+  -->
+  <listen>tcp:host=%3a%3a1,family=ipv6</listen>
   <listen>tcp:host=127.0.0.1</listen>
 
   <standard_session_servicedirs />

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-dbus
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.22.0
 platform: ruby
 authors:
 - Ruby DBus Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-21 00:00:00.000000000 Z
+date: 2023-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rexml
@@ -124,9 +124,6 @@ files:
 - doc/Tutorial.md
 - examples/doc/README.md
 - examples/doc/_extract_examples
-- examples/gdbus/gdbus
-- examples/gdbus/gdbus.glade
-- examples/gdbus/launch.sh
 - examples/no-introspect/nm-test.rb
 - examples/no-introspect/tracker-test.rb
 - examples/rhythmbox/playpause.rb
@@ -157,6 +154,7 @@ files:
 - lib/dbus/object.rb
 - lib/dbus/object_manager.rb
 - lib/dbus/object_path.rb
+- lib/dbus/platform.rb
 - lib/dbus/proxy_object.rb
 - lib/dbus/proxy_object_factory.rb
 - lib/dbus/proxy_object_interface.rb
@@ -186,9 +184,11 @@ files:
 - spec/object_spec.rb
 - spec/packet_marshaller_spec.rb
 - spec/packet_unmarshaller_spec.rb
+- spec/platform_spec.rb
 - spec/property_spec.rb
 - spec/proxy_object_interface_spec.rb
 - spec/proxy_object_spec.rb
+- spec/raw_message_spec.rb
 - spec/server_robustness_spec.rb
 - spec/server_spec.rb
 - spec/service_newapi.rb
@@ -225,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.0.dev
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Ruby module for interaction with D-Bus

data/examples/gdbus/gdbus

@@ -1,264 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-#
-# This is a quite complex example using internal lower level API.
-# Not a good starting point, but might be usefull if you want to do tricky
-# stuff.
-# -- Arnaud
-
-require "dbus"
-require "gtk2"
-
-ENABLE_SYSTEM = false
-
-class MethodCallWindow
-  def initialize(pwindow, intf, meth)
-    @intf = intf
-    @meth = meth
-    @entries = []
-    @dialog = Gtk::Dialog.new(meth.name, pwindow,
-                              Gtk::Dialog::MODAL | Gtk::Dialog::NO_SEPARATOR,
-                              [Gtk::Stock::OK, Gtk::Dialog::RESPONSE_OK],
-                              [Gtk::Stock::CANCEL, Gtk::Dialog::RESPONSE_CANCEL])
-
-    @meth.params.each do |param|
-      shbox = Gtk::HBox.new(true, 0)
-      label = Gtk::Label.new("#{param[0]} (#{param[1]})")
-      input = Gtk::Entry.new
-      @entries << input
-      shbox.pack_start(label, true, true, 0)
-      shbox.pack_start(input, true, true, 0)
-      @dialog.vbox.pack_start(shbox, true, true, 0)
-      @dialog.vbox.show_all
-    end
-  end
-
-  def run
-    on_ok if @dialog.run == Gtk::Dialog::RESPONSE_OK
-    @dialog.destroy
-  end
-
-  def on_ok
-    bus = @intf.object.bus
-    m = DBus::Message.new(DBus::Message::METHOD_CALL)
-    m.path = @intf.object.path
-    m.interface = @intf.name
-    m.destination = @intf.object.destination
-    m.member = @meth.name
-    m.sender = bus.unique_name
-    @meth.params.each_with_index do |param, idx|
-      entry = @entries[idx]
-      data = nil
-      case param[1]
-      when "u", "i"
-        data = entry.text.to_i
-      when "s"
-        data = entry.text
-      when /^a/
-        begin
-          data = eval(entry.text)
-        rescue
-          puts "Incorrect data: #{data}"
-        end
-      end
-      m.add_param(param[1], data)
-    end
-    bus.send_sync_or_async(m) do |retm|
-      if retm.is_a?(DBus::Error)
-        puts "Error: #{retm.inspect}"
-      else
-        puts "Method #{m.member} returns: #{retm.params.inspect}"
-      end
-    end
-  end
-end
-
-class DBusUI
-  def initialize
-    @glade = Gtk::Builder.new
-    @glade << "gdbus.glade"
-
-    @sessiontreeview = @glade.get_object("sessiontreeview")
-    setup_treeview_renderer(@sessiontreeview, "D-Bus Objects")
-    @sessiontreeview.selection.signal_connect("changed") do |selection|
-      on_treeview_selection_changed(selection)
-    end
-
-    @systemtreeview = @glade.get_object("systemtreeview")
-    setup_treeview_renderer(@systemtreeview, "D-Bus Objects")
-    @systemtreeview.selection.signal_connect("changed") do |selection|
-      on_treeview_selection_changed(selection)
-    end
-
-    @methsigtreeview = @glade.get_object("methsigtreeview")
-    # ierk
-    setup_methodview_renderer(@methsigtreeview)
-    @methsigtreeview.signal_connect("row-activated") do |view, path, column|
-      on_method_activated(view, path, column)
-    end
-
-    @window = @glade.get_object("window1")
-    @window.show_all
-    start_buses
-  end
-
-  def beautify_method(meth)
-    # Damn, this need to be rewritten :p
-    s = "#{meth.name}("
-    case meth
-    when DBus::Method
-      s += (meth.params.collect { |a| "in #{a[0]}:#{a[1]}" } +
-            meth.rets.collect { |a| "out #{a[0]}:#{a[1]}" }).join(", ")
-    when DBus::Signal
-      s += (meth.params.collect { |a| "in #{a[0]}:#{a[1]}" }).join(", ")
-    end
-    s += ")"
-    s
-  end
-
-  def on_treeview_selection_changed(selection)
-    selected = selection.selected
-    model = Gtk::ListStore.new(String, String, DBus::Method,
-                               DBus::ProxyObjectInterface)
-    @methsigtreeview.model = model
-    return unless selected
-
-    intf = selected[1]
-    return unless intf
-
-    intf.methods.keys.sort.each do |mi|
-      m = intf.methods[mi]
-      subiter = model.append
-      subiter[0] = beautify_method(m)
-      subiter[1] = "M"
-      subiter[2] = m
-      subiter[3] = intf
-    end
-    intf.signals.keys.sort.each do |mi|
-      m = intf.signals[mi]
-      subiter = model.append
-      subiter[0] = beautify_method(m)
-      subiter[1] = "S"
-      subiter[2] = m
-      subiter[3] = intf
-    end
-  end
-
-  def on_method_activated(view, path, _column)
-    name = view.model.get_iter(path)[0]
-    puts "Clicked on: #{name.inspect}"
-    type = view.model.get_iter(path)[1]
-    case type
-    when "M"
-      method = view.model.get_iter(path)[2]
-      intf = view.model.get_iter(path)[3]
-      MethodCallWindow.new(@window, intf, method).run
-    when "S"
-      signal = view.model.get_iter(path)[2]
-      intf = view.model.get_iter(path)[3]
-      mr = DBus::MatchRule.new.from_signal(intf, signal)
-      puts "*** Registering matchrule: #{mr} ***"
-      intf.object.bus.add_match(mr) do |sig|
-        puts "Got #{sig.member}(#{sig.params.join(",")})"
-      end
-    end
-  end
-
-  def on_sessiontreeview_row_activated(view, path, _column)
-    name = view.model.get_iter(path)[0]
-    puts "Clicked on: #{name.inspect}"
-  end
-
-  def on_window_delete_event(_window, _event)
-    Gtk.main_quit
-  end
-
-  def setup_methodview_renderer(treeview)
-    renderer = Gtk::CellRendererText.new
-    _col_offset = treeview.insert_column(-1, "T", renderer, "text" => 1)
-    col_offset = treeview.insert_column(-1, "Name", renderer, "text" => 0)
-    column = treeview.get_column(col_offset - 1)
-    column.clickable = true
-  end
-
-  def setup_treeview_renderer(treeview, str)
-    renderer = Gtk::CellRendererText.new
-    col_offset = treeview.insert_column(-1, str, renderer, "text" => 0)
-    column = treeview.get_column(col_offset - 1)
-    column.clickable = true
-  end
-
-  def process_input(bus)
-    # THIS is the bad ass loop
-    # we should return to the glib main loop from time to time. Anyone with a
-    # proper way to handle it ?
-    bus.update_buffer
-    bus.messages.each do |msg|
-      bus.process(msg)
-    end
-  end
-
-  def start_buses
-    # call glibize to get dbus messages from the glib mainloop
-    DBus::SessionBus.instance.glibize
-    DBus::SystemBus.instance.glibize if ENABLE_SYSTEM
-
-    DBus::SessionBus.instance.proxy.ListNames do |_msg, names|
-      fill_treeview(DBus::SessionBus.instance, @sessiontreeview, names)
-    end
-
-    return unless ENABLE_SYSTEM
-
-    DBus::SystemBus.instance.proxy.ListNames do |_msg, names|
-      fill_treeview(DBus::SystemBus.instance, @systemtreeview, names)
-    end
-  end
-
-  def walk_node(model, iter, node)
-    node.each_pair do |key, val|
-      subiter = model.append(iter)
-      subiter[0] = key
-      walk_node(model, subiter, val)
-    end
-
-    return if node.object.nil?
-
-    node.object.interfaces.sort.each do |ifname|
-      subiter = model.append(iter)
-      subiter[0] = ifname
-      subiter[1] = node.object[ifname]
-    end
-  end
-
-  def introspect_services(model, bus)
-    el = @introspect_array.shift
-    if el !~ /^:/
-      iter = model.append(nil)
-      iter[0] = el
-      puts "introspecting: #{el}"
-      begin
-        service = bus.service(el).introspect
-        walk_node(model, iter, service.root)
-      rescue Exception => e
-        puts "DBus Error:"
-        puts e.backtrace.join("\n")
-      end
-    end
-
-    !@introspect_array.empty?
-  end
-
-  def fill_treeview(bus, treeview, array)
-    model = Gtk::TreeStore.new(String, DBus::ProxyObjectInterface)
-    treeview.model = model
-    @introspect_array = array.sort
-    Gtk.idle_add { introspect_services(model, bus) }
-  end
-
-  def main
-    Gtk.main
-  end
-end
-
-DBusUI.new.main

data/examples/gdbus/gdbus.glade

@@ -1,98 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<interface>
-  <!-- interface-requires gtk+ 2.6 -->
-  <!-- interface-naming-policy toplevel-contextual -->
-  <object class="GtkWindow" id="window1">
-    <property name="visible">True</property>
-    <property name="can_focus">False</property>
-    <property name="title" translatable="yes">GD-Bus</property>
-    <property name="default_width">500</property>
-    <property name="default_height">400</property>
-    <signal name="delete-event" handler="on_window_delete_event" swapped="no"/>
-    <child>
-      <object class="GtkHPaned" id="hpaned1">
-        <property name="visible">True</property>
-        <property name="can_focus">True</property>
-        <child>
-          <object class="GtkNotebook" id="notebook1">
-            <property name="visible">True</property>
-            <property name="can_focus">True</property>
-            <child>
-              <object class="GtkScrolledWindow" id="scrolledwindow3">
-                <property name="visible">True</property>
-                <property name="can_focus">True</property>
-                <property name="shadow_type">in</property>
-                <child>
-                  <object class="GtkTreeView" id="sessiontreeview">
-                    <property name="visible">True</property>
-                    <property name="can_focus">True</property>
-                    <signal name="row-activated" handler="on_sessiontreeview_row_activated" swapped="no"/>
-                  </object>
-                </child>
-              </object>
-            </child>
-            <child type="tab">
-              <object class="GtkLabel" id="label1">
-                <property name="visible">True</property>
-                <property name="can_focus">False</property>
-                <property name="label" translatable="yes">Session</property>
-              </object>
-              <packing>
-                <property name="tab_fill">False</property>
-              </packing>
-            </child>
-            <child>
-              <object class="GtkScrolledWindow" id="scrolledwindow5">
-                <property name="visible">True</property>
-                <property name="can_focus">True</property>
-                <property name="shadow_type">in</property>
-                <child>
-                  <object class="GtkTreeView" id="systemtreeview">
-                    <property name="visible">True</property>
-                    <property name="can_focus">True</property>
-                  </object>
-                </child>
-              </object>
-              <packing>
-                <property name="position">1</property>
-              </packing>
-            </child>
-            <child type="tab">
-              <object class="GtkLabel" id="label2">
-                <property name="visible">True</property>
-                <property name="can_focus">False</property>
-                <property name="label" translatable="yes">System</property>
-              </object>
-              <packing>
-                <property name="position">1</property>
-                <property name="tab_fill">False</property>
-              </packing>
-            </child>
-          </object>
-          <packing>
-            <property name="resize">False</property>
-            <property name="shrink">True</property>
-          </packing>
-        </child>
-        <child>
-          <object class="GtkScrolledWindow" id="scrolledwindow4">
-            <property name="visible">True</property>
-            <property name="can_focus">True</property>
-            <property name="shadow_type">in</property>
-            <child>
-              <object class="GtkTreeView" id="methsigtreeview">
-                <property name="visible">True</property>
-                <property name="can_focus">True</property>
-                <signal name="row-activated" handler="on_method_activated" swapped="no"/>
-              </object>
-            </child>
-          </object>
-          <packing>
-            <property name="resize">False</property>
-            <property name="shrink">True</property>
-          </packing>
-        </child>
-      </object>
-    </child>
-  </object>
-</interface>

data/examples/gdbus/launch.sh

@@ -1,4 +0,0 @@
-#!/bin/sh
-set -e
-# for the lazy typer
-ruby -w -I ../../lib gdbus