sdague-ruby-dbus 0.2.1

data/lib/dbus/bus.rb

@@ -0,0 +1,690 @@
+# dbus.rb - Module containing the low-level D-Bus implementation
+#
+# This file is part of the ruby-dbus project
+# Copyright (C) 2007 Arnaud Cornet and Paul van Tilburg
+#
+# 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 'socket'
+require 'thread'
+require 'singleton'
+
+# = D-Bus main module
+#
+# Module containing all the D-Bus modules and classes.
+module DBus
+  # This represents a remote service. It should not be instancied directly
+  # Use Bus::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, @bus = name, bus
+      @root = Node.new("/")
+    end
+
+    # Determine whether the serice name already exists.
+    def exists?
+      bus.proxy.ListName.member?(@name)
+    end
+
+    # Perform an introspection on all the objects on the service
+    # (starting recursively from the root).
+    def introspect
+      if block_given?
+        raise NotImplementedError
+      else
+        rec_introspect(@root, "/")
+      end
+      self
+    end
+
+    # Retrieves an object at the given _path_.
+    def object(path)
+      node = get_node(path, true)
+      if node.object.nil?
+        node.object = ProxyObject.new(@bus, @name, path)
+      end
+      node.object
+    end
+
+    # Export an object _obj_ (an DBus::Object subclass instance).
+    def export(obj)
+      obj.service = self
+      get_node(obj.path, true).object = obj
+    end
+
+    # Get the object node corresponding to the given _path_. if _create_ is
+    # true, the the nodes in the path are created if they do not already exist.
+    def get_node(path, create = false)
+      n = @root
+      path.sub(/^\//, "").split("/").each do |elem|
+        if not n[elem]
+          if not create
+            return nil
+          else
+            n[elem] = Node.new(elem)
+          end
+        end
+        n = n[elem]
+      end
+      if n.nil?
+        puts "Warning, unknown object #{path}" if $DEBUG
+      end
+      n
+    end
+
+    #########
+    private
+    #########
+
+    # 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)
+        if path == "/"
+          subpath = "/" + nodename
+        else
+          subpath = path + "/" + nodename
+        end
+        rec_introspect(subnode, subpath)
+      end
+      if intfs.size > 0
+        node.object = ProxyObjectFactory.new(xml, @bus, @name, path).build
+      end
+    end
+  end
+
+  # = Object path node class
+  #
+  # Class representing a node on an object path.
+  class Node < Hash
+    # The D-Bus object contained by the node.
+    attr_accessor :object
+    # The name of the node.
+    attr_reader :name
+
+    # Create a new node with a given _name_.
+    def initialize(name)
+      @name = name
+      @object = nil
+    end
+
+    # Return an XML string representation of the node.
+    def to_xml
+      xml = '<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
+"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
+<node>
+'
+      self.each_pair do |k, v|
+        xml += "<node name=\"#{k}\" />"
+      end
+      if @object
+        @object.intfs.each_pair do |k, v|
+          xml += %{<interface name="#{v.name}">\n}
+          v.methods.each_value { |m| xml += m.to_xml }
+          v.signals.each_value { |m| xml += m.to_xml }
+          xml +="</interface>\n"
+        end
+      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 not @object.nil?
+        s += "%x " % @object.object_id
+      end
+      s + "{" + keys.collect { |k| "#{k} => #{self[k].sub_inspect}" }.join(",") + "}"
+    end
+  end # class Inspect
+
+  # FIXME: rename Connection to Bus?
+
+  # D-Bus main connection class
+  #
+  # Main class that maintains a connection to a bus and can handle incoming
+  # and outgoing messages.
+  class Connection
+    # The unique name (by specification) of the message.
+    attr_reader :unique_name
+    # The socket that is used to connect with the bus.
+    attr_reader :socket
+
+    # Create a new connection to the bus for a given connect _path_. _path_
+    # format is described in the D-Bus specification:
+    # http://dbus.freedesktop.org/doc/dbus-specification.html#addresses
+    # and is something like:
+    # "transport1:key1=value1,key2=value2;transport2:key1=value1,key2=value2"
+    # e.g. "unix:path=/tmp/dbus-test"
+    #
+    # Current implementation of ruby-dbus supports only a single server
+    # address and only "unix:path=...,guid=..." and
+    # "unix:abstract=...,guid=..." forms
+    def initialize(path)
+      @path = path
+      @unique_name = nil
+      @buffer = ""
+      @method_call_replies = Hash.new
+      @method_call_msgs = Hash.new
+      @signal_matchrules = Array.new
+      @proxy = nil
+      # FIXME: can be TCP or any stream
+      @socket = Socket.new(Socket::Constants::PF_UNIX,
+                           Socket::Constants::SOCK_STREAM, 0)
+      @object_root = Node.new("/")
+    end
+
+    # Connect to the bus and initialize the connection.
+    def connect
+      parse_session_string
+      if @transport == "unix" and @type == "abstract"
+        if HOST_END == LIL_END
+          sockaddr = "\1\0\0#{@unix_abstract}"
+        else
+          sockaddr = "\0\1\0#{@unix_abstract}"
+        end
+      elsif @transport == "unix" and @type == "path"
+        sockaddr = Socket.pack_sockaddr_un(@unix)
+      end
+      @socket.connect(sockaddr)
+      init_connection
+    end
+
+    # Send the buffer _buf_ to the bus using Connection#writel.
+    def send(buf)
+      @socket.write(buf)
+    end
+
+    # Tell a bus to register itself on the glib main loop
+    def glibize
+      require 'glib2'
+      # Circumvent a ruby-glib bug
+      @channels ||= Array.new
+
+      gio = GLib::IOChannel.new(@socket.fileno)
+      @channels << gio
+      gio.add_watch(GLib::IOChannel::IN) do |c, ch|
+        update_buffer
+        messages.each do |msg|
+          process(msg)
+        end
+        true
+      end
+    end
+
+    # FIXME: describe the following names, flags and constants.
+    # See DBus spec for definition
+    NAME_FLAG_ALLOW_REPLACEMENT = 0x1
+    NAME_FLAG_REPLACE_EXISTING = 0x2
+    NAME_FLAG_DO_NOT_QUEUE = 0x4
+
+    REQUEST_NAME_REPLY_PRIMARY_OWNER = 0x1
+    REQUEST_NAME_REPLY_IN_QUEUE = 0x2
+    REQUEST_NAME_REPLY_EXISTS = 0x3
+    REQUEST_NAME_REPLY_ALREADY_OWNER = 0x4
+
+    DBUSXMLINTRO = '<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
+"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
+<node>
+  <interface name="org.freedesktop.DBus.Introspectable">
+    <method name="Introspect">
+      <arg name="data" direction="out" type="s"/>
+    </method>
+  </interface>
+  <interface name="org.freedesktop.DBus">
+    <method name="RequestName">
+      <arg direction="in" type="s"/>
+      <arg direction="in" type="u"/>
+      <arg direction="out" type="u"/>
+    </method>
+    <method name="ReleaseName">
+      <arg direction="in" type="s"/>
+      <arg direction="out" type="u"/>
+    </method>
+    <method name="StartServiceByName">
+      <arg direction="in" type="s"/>
+      <arg direction="in" type="u"/>
+      <arg direction="out" type="u"/>
+    </method>
+    <method name="Hello">
+      <arg direction="out" type="s"/>
+    </method>
+    <method name="NameHasOwner">
+      <arg direction="in" type="s"/>
+      <arg direction="out" type="b"/>
+    </method>
+    <method name="ListNames">
+      <arg direction="out" type="as"/>
+    </method>
+    <method name="ListActivatableNames">
+      <arg direction="out" type="as"/>
+    </method>
+    <method name="AddMatch">
+      <arg direction="in" type="s"/>
+    </method>
+    <method name="RemoveMatch">
+      <arg direction="in" type="s"/>
+    </method>
+    <method name="GetNameOwner">
+      <arg direction="in" type="s"/>
+      <arg direction="out" type="s"/>
+    </method>
+    <method name="ListQueuedOwners">
+      <arg direction="in" type="s"/>
+      <arg direction="out" type="as"/>
+    </method>
+    <method name="GetConnectionUnixUser">
+      <arg direction="in" type="s"/>
+      <arg direction="out" type="u"/>
+    </method>
+    <method name="GetConnectionUnixProcessID">
+      <arg direction="in" type="s"/>
+      <arg direction="out" type="u"/>
+    </method>
+    <method name="GetConnectionSELinuxSecurityContext">
+      <arg direction="in" type="s"/>
+      <arg direction="out" type="ay"/>
+    </method>
+    <method name="ReloadConfig">
+    </method>
+    <signal name="NameOwnerChanged">
+      <arg type="s"/>
+      <arg type="s"/>
+      <arg type="s"/>
+    </signal>
+    <signal name="NameLost">
+      <arg type="s"/>
+    </signal>
+    <signal name="NameAcquired">
+      <arg type="s"/>
+    </signal>
+  </interface>
+</node>
+'
+
+    def introspect_data(dest, path)
+      m = DBus::Message.new(DBus::Message::METHOD_CALL)
+      m.path = path
+      m.interface = "org.freedesktop.DBus.Introspectable"
+      m.destination = dest
+      m.member = "Introspect"
+      m.sender = unique_name
+      if not block_given?
+        # introspect in synchronous !
+        send_sync(m) do |rmsg|
+          if rmsg.is_a?(Error)
+            raise rmsg
+          else
+            return rmsg.params[0]
+          end
+        end
+      else
+        send(m.marshall)
+        on_return(m) do |rmsg|
+          if rmsg.is_a?(Error)
+            yield rmsg
+          else
+            yield rmsg.params[0]
+          end
+        end
+      end
+      nil
+    end
+
+    # Issues a call to the org.freedesktop.DBus.Introspectable.Introspect method
+    # _dest_ is the service and _path_ the object path you want to introspect
+    # If a code block is given, the introspect call in asynchronous. If not
+    # data is returned
+    #
+    # FIXME: link to ProxyObject data definition
+    # The returned object is a ProxyObject that has methods you can call to
+    # issue somme METHOD_CALL messages, and to setup to receive METHOD_RETURN
+    def introspect(dest, path)
+      if not block_given?
+        # introspect in synchronous !
+        data = introspect_data(dest, path)
+        pof = DBus::ProxyObjectFactory.new(data, self, dest, path)
+        return pof.build
+      else
+        introspect_data(dest, path) do |data|
+          yield(DBus::ProxyObjectFactory.new(data, self, dest, path).build)
+        end
+      end
+    end
+
+    # Exception raised when a service name is requested that is not available.
+    class NameRequestError < Exception
+    end
+
+    # Attempt to request a service _name_.
+    def request_service(name)
+      r = proxy.RequestName(name, NAME_FLAG_REPLACE_EXISTING)
+      raise NameRequestError if r[0] != REQUEST_NAME_REPLY_PRIMARY_OWNER
+      @service = Service.new(name, self)
+      @service
+    end
+
+    # Set up a ProxyObject for the bus itself, since the bus is introspectable.
+    # Returns the object.
+    def proxy
+      if @proxy == nil
+        path = "/org/freedesktop/DBus"
+        dest = "org.freedesktop.DBus"
+        pof = DBus::ProxyObjectFactory.new(DBUSXMLINTRO, self, dest, path)
+        @proxy = pof.build["org.freedesktop.DBus"]
+      end
+      @proxy
+    end
+
+    # Fill (append) the buffer from data that might be available on the
+    # socket.
+    def update_buffer
+      @buffer += @socket.read_nonblock(MSG_BUF_SIZE)
+    end
+
+    # Get one message from the bus and remove it from the buffer.
+    # Return the message.
+    def pop_message
+      ret = nil
+      begin
+        ret, size = Message.new.unmarshall_buffer(@buffer)
+        @buffer.slice!(0, size)
+      rescue IncompleteBufferException => e
+        # fall through, let ret be null
+      end
+      ret
+    end
+
+    # Retrieve all the messages that are currently in the buffer.
+    def messages
+      ret = Array.new
+      while msg = pop_message
+        ret << msg
+      end
+      ret
+    end
+
+    # The buffer size for messages.
+    MSG_BUF_SIZE = 4096
+
+    # Update the buffer and retrieve all messages using Connection#messages.
+    # Return the messages.
+    def poll_messages
+      ret = nil
+      r, d, d = IO.select([@socket], nil, nil, 0)
+      if r and r.size > 0
+        update_buffer
+      end
+      messages
+    end
+
+    # Wait for a message to arrive. Return it once it is available.
+    def wait_for_message
+      ret = pop_message
+      while ret == nil
+        r, d, d = IO.select([@socket])
+        if r and r[0] == @socket
+          update_buffer
+          ret = pop_message
+        end
+      end
+      ret
+    end
+
+    # Send a message _m_ on to the bus. This is done synchronously, thus
+    # the call will block until a reply message arrives.
+    def send_sync(m, &retc) # :yields: reply/return message
+      send(m.marshall)
+      @method_call_msgs[m.serial] = m
+      @method_call_replies[m.serial] = retc
+
+      retm = wait_for_message
+      process(retm)
+      until [DBus::Message::ERROR,
+          DBus::Message::METHOD_RETURN].include?(retm.message_type) and
+          retm.reply_serial == m.serial
+        retm = wait_for_message
+        process(retm)
+      end
+    end
+
+    # Specify a code block that has to be executed when a reply for
+    # message _m_ is received.
+    def on_return(m, &retc)
+      # Have a better exception here
+      if m.message_type != Message::METHOD_CALL
+        raise "on_return should only get method_calls"
+      end
+      @method_call_msgs[m.serial] = m
+      @method_call_replies[m.serial] = retc
+    end
+
+    # Asks bus to send us messages matching mr, and execute slot when
+    # received
+    def add_match(mr, &slot)
+      # check this is a signal.
+      @signal_matchrules << [mr, slot]
+      self.proxy.AddMatch(mr.to_s)
+    end
+
+    # Process a message _m_ based on its type.
+    # method call:: FIXME...
+    # method call return value:: FIXME...
+    # signal:: FIXME...
+    # error:: FIXME...
+    def process(m)
+      case m.message_type
+      when Message::ERROR, Message::METHOD_RETURN
+        raise InvalidPacketException if m.reply_serial == nil
+        mcs = @method_call_replies[m.reply_serial]
+        if not mcs
+          puts "no return code for #{mcs.inspect} (#{m.inspect})" if $DEBUG
+        else
+          if m.message_type == Message::ERROR
+            mcs.call(Error.new(m))
+          else
+            mcs.call(m)
+          end
+          @method_call_replies.delete(m.reply_serial)
+          @method_call_msgs.delete(m.reply_serial)
+        end
+      when DBus::Message::METHOD_CALL
+        if m.path == "/org/freedesktop/DBus"
+          puts "Got method call on /org/freedesktop/DBus" if $DEBUG
+        end
+        # handle introspectable as an exception:
+        if m.interface == "org.freedesktop.DBus.Introspectable" and
+            m.member == "Introspect"
+          reply = Message.new(Message::METHOD_RETURN).reply_to(m)
+          reply.sender = @unique_name
+          node = @service.get_node(m.path)
+          raise NotImplementedError if not node
+          reply.sender = @unique_name
+          reply.add_param(Type::STRING, @service.get_node(m.path).to_xml)
+          send(reply.marshall)
+        else
+          node = @service.get_node(m.path)
+          return if node.nil?
+          obj = node.object
+          return if obj.nil?
+          obj.dispatch(m) if obj
+        end
+      when DBus::Message::SIGNAL
+        @signal_matchrules.each do |elem|
+          mr, slot = elem
+          if mr.match(m)
+            slot.call(m)
+            return
+          end
+        end
+      else
+        puts "Unknown message type: #{m.message_type}" if $DEBUG
+      end
+    end
+
+    # Retrieves the service with the given _name_.
+    def service(name)
+      # The service might not exist at this time so we cannot really check
+      # anything
+      Service.new(name, self)
+    end
+    alias :[] :service
+
+    # Emit a signal event for the given _service_, object _obj_, interface
+    # _intf_ and signal _sig_ with arguments _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[1], args[i])
+        i += 1
+      end
+      send(m.marshall)
+    end
+
+    ###########################################################################
+    private
+
+    # Send a hello messages to the bus to let it know we are here.
+    def send_hello
+      m = Message.new(DBus::Message::METHOD_CALL)
+      m.path = "/org/freedesktop/DBus"
+      m.destination = "org.freedesktop.DBus"
+      m.interface = "org.freedesktop.DBus"
+      m.member = "Hello"
+      send_sync(m) do |rmsg|
+        @unique_name = rmsg.destination
+        puts "Got hello reply. Our unique_name is #{@unique_name}" if $DEBUG
+      end
+    end
+
+    # Parse the session string (socket address).
+    def parse_session_string
+      path_parsed = /^([^:]*):([^;]*)$/.match(@path)
+      @transport = path_parsed[1]
+      adr = path_parsed[2]
+      if @transport == "unix"
+        adr.split(",").each do |eqstr|
+          idx, val = eqstr.split("=")
+          case idx
+          when "path"
+            @type = idx
+            @unix = val
+          when "abstract"
+            @type = idx
+            @unix_abstract = val
+          when "guid"
+            @guid = val
+          end
+        end
+      end
+    end
+
+    # Initialize the connection to the bus.
+    def init_connection
+      @client = Client.new(@socket)
+      @client.authenticate
+      # TODO: code some real stuff here
+      #writel("AUTH EXTERNAL 31303030")
+      #s = readl
+      # parse OK ?
+      #writel("BEGIN")
+    end
+  end # class Connection
+
+  # = D-Bus session bus class
+  #
+  # The session bus is a session specific bus (mostly for desktop use).
+  # This is a singleton class.
+  class SessionBus < Connection
+    include Singleton
+
+    # Get the the default session bus.
+    def initialize
+      super(ENV["DBUS_SESSION_BUS_ADDRESS"])
+      connect
+      send_hello
+    end
+  end
+
+  # = D-Bus system bus class
+  #
+  # The system bus is a system-wide bus mostly used for global or
+  # system usages.  This is a singleton class.
+  class SystemBus < Connection
+    include Singleton
+
+    # Get the default system bus.
+    def initialize
+      super(SystemSocketName)
+      connect
+      send_hello
+    end
+  end
+
+  # FIXME: we should get rid of these
+
+  def DBus.system_bus
+    SystemBus.instance
+  end
+
+  def DBus.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 = Hash.new
+    end
+
+    # Add a _bus_ to the list of buses to watch for events.
+    def <<(bus)
+      @buses[bus.socket] = bus
+    end
+
+    # Run the main loop. This is a blocking call!
+    def run
+      loop do
+        ready, dum, dum = IO.select(@buses.keys)
+        ready.each do |socket|
+          b = @buses[socket]
+          b.update_buffer
+          while m = b.pop_message
+            b.process(m)
+          end
+        end
+      end
+    end
+  end # class Main
+end # module DBus