pangdudu-ruby-dbus 0.2.2 → 0.2.3

data/README

@@ -38,6 +38,7 @@ Ruby D-Bus currently supports the following features:
  * Rubyish D-Bus object and interface syntax support that automatically
    allows for introspection.
  * Emitting signals on exported objects.
+ * Connection to a local or remote bus over TCP/IP
 
 == Usage
 

data/lib/dbus/auth.rb

@@ -33,8 +33,62 @@ module DBus
       return Process.uid.to_s.split(//).collect { |a| "%x" % a[0] }.join
     end
   end
+  
+  # = Authentication class using SHA1 crypto algorithm 
+  #
+  # Class for 'CookieSHA1' type authentication.
+  # Implements the AUTH DBUS_COOKIE_SHA1 mechanism.
+  class DBusCookieSHA1 < Authenticator
+    
+    #the autenticate method (called in stage one of authentification)    
+    def authenticate
+      require 'etc'
+      return "#{hex_encode(Etc.getlogin)}" #server expects it to be binary
+    end
 
-  # Note: this following stuff is tested with External authenticator only!
+    #returns the modules name
+    def name
+      return 'DBUS_COOKIE_SHA1'
+    end
+    
+    #handles the interesting crypto stuff, check the rbus-project for more info: http://rbus.rubyforge.org/
+    def data(hexdata)
+      require 'digest/sha1'
+      data = hex_decode(hexdata)
+      # name of cookie file, id of cookie in file, servers random challenge  
+      context, id, s_challenge = data.split(' ')
+      # Random client challenge        
+      c_challenge = Array.new(s_challenge.length/2).map{|obj|obj=rand(255).to_s}.join
+      # Search cookie file for id
+      path = File.join(ENV['HOME'], '.dbus-keyrings', context)
+      File.foreach(path) do |line|
+        if line.index(id) == 0
+          # Right line of file, read cookie
+          cookie = line.split(' ')[2].chomp
+          # Concatenate and encrypt
+          to_encrypt = [s_challenge, c_challenge, cookie].join(':')
+          sha = Digest::SHA1.hexdigest(to_encrypt)
+          #the almighty tcp server wants everything hex encoded
+          hex_response = hex_encode("#{c_challenge} #{sha}")
+          # Return response
+          response = [:AuthOk, hex_response]
+          return response
+        end
+      end
+      raise AuthException, 'Unable to locate cookie'
+    end  
+    
+    # encode plain to hex
+    def hex_encode(plain)
+      return nil if plain.nil?
+      plain.to_s.unpack('H*')[0]
+    end
+    
+    # decode hex to plain
+    def hex_decode(encoded)
+      encoded.scan(/[[:xdigit:]]{2}/).map{|h|h.hex.chr}.join
+    end  
+  end #DBusCookieSHA1 class ends here
 
   # = Authentication client class.
   #
@@ -44,7 +98,7 @@ module DBus
     def initialize(socket)
       @socket = socket
       @state = nil
-      @auth_list = [External]
+      @auth_list = [External,DBusCookieSHA1]
     end
 
     # Start the authentication process.
@@ -81,7 +135,18 @@ module DBus
     # Read data (a buffer) from the bus until CR LF is encountered.
     # Return the buffer without the CR LF characters.
     def next_msg
-      @socket.readline.chomp.split(" ")
+      data,crlf = "","\r\n"
+      left = 1024 #1024 byte, no idea if it's ever getting bigger
+      while left > 0
+        buf = @socket.read( left > 1 ? 1 : left )
+        break if buf.nil?
+        left -= buf.size
+        data += buf
+        break if data.include? crlf
+      end
+      readline = data.chomp.split(" ")
+      return readline
+      #return @socket.readline.chomp.split(" ")
     end
 
     # Try to reach the next state based on the current state.
@@ -89,10 +154,12 @@ module DBus
       msg = next_msg
       if @state == :Starting
         case msg[0]
+        when "OK"
+          @state = :WaitingForOk    
         when "CONTINUE"
           @state = :WaitingForData
-        when "OK"
-          @state = :WaitingForOk
+        when "REJECTED" #needed by tcp, unix-path/abstract don't get here
+          @state = :WaitingForData
         end
       end
       case @state
@@ -152,5 +219,5 @@ module DBus
       end
       return true
     end # def next_state
-  end # class Client
+  end # class Client 
 end # module D-Bus

data/lib/dbus/bus.rb

@@ -11,53 +11,11 @@
 require 'socket'
 require 'thread'
 require 'singleton'
-require 'connection' #outsourced connection module
 
 # = D-Bus main module
 #
 # Module containing all the D-Bus modules and classes.
 module DBus
-
-  # = 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
-
   # This represents a remote service. It should not be instancied directly
   # Use Bus::service()
   class Service
@@ -201,6 +159,524 @@ module DBus
     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
+      @object_root = Node.new("/")
+    end
+
+    # Connect to the bus and initialize the connection.
+    def connect
+      connect_to_tcp if @path.include? "tcp:" #testing
+      connect_to_unix_abstract if @path.include? "unix:" #supposed stable
+    end
+
+    # Connect to a bus over tcp and initialize the connection.
+    def connect_to_tcp
+      #check if the path is sufficient
+      if @path.include? "host=" and @path.include? "port="
+        host,port,family = "","",""
+        #get the parameters
+        @path.split(",").each do |para|
+          host = para.sub("tcp:","").sub("host=","") if para.include? "host="
+          port = para.sub("port=","").to_i if para.include? "port="
+          family = para.sub("family=","") if para.include? "family="
+        end
+        #puts "host,port,family : #{host},#{port},#{family}"      
+        #initialize the tcp socket
+        @socket = TCPSocket.new(host,port)
+        init_connection
+      else
+        #Danger, Will Robinson: the specified "path" is not usable
+        puts "ERROR:dbus/bus.rb/Connection.connect_to_tcp: supplied path: #{@path}, unasable! sry" if $DEBUG
+      end
+    end
+
+    # Connect to an abstract unix bus and initialize the connection.
+    def connect_to_unix_abstract
+      @socket = Socket.new(Socket::Constants::PF_UNIX,Socket::Constants::SOCK_STREAM, 0)
+      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
+    
+    # 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
+
+    # 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
+
+    # Initialize the connection to the bus.
+    def init_connection
+      @client = Client.new(@socket)
+      @client.authenticate
+    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 socket_name=SessionSocketName
+      super(socket_name)
+      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 socket_name=SystemSocketName
+      super(socket_name)
+      connect
+      send_hello
+    end
+  end
+
+  # FIXME: we should get rid of these singeltons
+
+  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

data/lib/dbus/connection.rb

@@ -1,3 +1,10 @@
+ require 'dbus/bus'
+ require 'dbus/auth'
+
+# = D-Bus main module
+#
+# Module containing all the D-Bus modules and classes.
+module DBus 
   # D-Bus main connection class
   #
   # Main class that maintains a connection to a bus and can handle incoming
@@ -26,14 +33,18 @@
       @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)
+      # FIXME: can be TCP or any stream, let's do it.
+      @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
+      connect_to_unix_abstract
+    end
+
+    # Connect to the bus and initialize the connection.
+    def connect_to_unix_abstract
       parse_session_string
       if @transport == "unix" and @type == "abstract"
         if HOST_END == LIL_END
@@ -454,4 +465,4 @@
       #writel("BEGIN")
     end
   end # class Connection
-
+end # module DBus

data/lib/dbus.rb

@@ -16,7 +16,6 @@ require 'dbus/marshall'
 require 'dbus/message'
 require 'dbus/matchrule'
 require 'dbus/auth'
-
 require 'socket'
 require 'thread'
 
@@ -27,6 +26,9 @@ module DBus
   # Default socket name for the system bus.
   SystemSocketName = "unix:path=/var/run/dbus/system_bus_socket"
 
+  # Socket name for the session bus.
+  SessionSocketName = ENV["DBUS_SESSION_BUS_ADDRESS"]
+
   # Byte signifying big endianness.
   BIG_END = ?B
   # Byte signifying little endianness.
@@ -80,3 +82,5 @@ module DBus
   class InvalidIntrospectionData < Exception
   end
 end # module DBus
+#just for my info
+puts "pangdudus ruby-dbus fork."

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
 name: pangdudu-ruby-dbus
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors: 
-- Ruby DBUS Team
+- Ruby DBUS Team, pangdudu
 autorequire: dbus
 bindir: bin
 cert_chain: []