rbus 0.1.0

data/lib/rbus/default.rb

@@ -0,0 +1,29 @@
+#--
+# 
+# R-Bus is a native Ruby implementation of the D-Bus protocol.
+# Copyright (C) 2007 Kristoffer Lundén (kristoffer.lunden@gmail.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA  02110-1301, USA.  A copy of the GNU General Public License is
+# also available at http://www.gnu.org/copyleft/gpl.html.
+#
+#++
+#
+base_dir = File.dirname(__FILE__)
+%w{auth bus etc message}.each do |dir|
+  Dir[File.join(base_dir, dir, '*.rb')].sort.each { |lib| require lib }
+end
+
+require File.dirname(__FILE__) + '/mainloop/thread.rb'

data/lib/rbus/etc/exception.rb

@@ -0,0 +1,44 @@
+#--
+# 
+# R-Bus is a native Ruby implementation of the D-Bus protocol.
+# Copyright (C) 2007 Kristoffer Lundén (kristoffer.lunden@gmail.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA  02110-1301, USA.  A copy of the GNU General Public License is
+# also available at http://www.gnu.org/copyleft/gpl.html.
+#
+#++
+#
+module RBus
+  
+  # Catch-all, simply do:
+  #   rescue RBus::Exception => error
+  # if in doubt. :) 
+  class Exception < RuntimeError; end
+  
+  class AuthException < Exception
+    def initialize(msg = "Failed to authenticate with any mechanism.")
+      super(msg)
+    end
+  end
+  class InvalidAddressException < Exception;end
+  class InvalidTransportException < Exception;end
+  class NotImplementedError < Exception;end
+  class TypeException < Exception;end
+  class MessageException < Exception;end
+  class IllegalEndianException < Exception;end
+  class InvalidProtocolException < Exception;end
+  class InvalidNameException < Exception;end
+end

data/lib/rbus/etc/log.rb

@@ -0,0 +1,100 @@
+#--
+# 
+# R-Bus is a native Ruby implementation of the D-Bus protocol.
+# Copyright (C) 2007 Kristoffer Lundén (kristoffer.lunden@gmail.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA  02110-1301, USA.  A copy of the GNU General Public License is
+# also available at http://www.gnu.org/copyleft/gpl.html.
+#
+#++
+#
+require 'logger'
+require 'pp'
+require 'stringio'
+module RBus
+
+  # A Logger based Log system, with levels. See Logger for more info.
+  #
+  # RBus::Log logs to STDOUT by default, it's possible to redirect this
+  # output to a file by setting a filename in the environment variable
+  # $RBUS_LOG_FILE.
+  # The default log level is ERROR, this can be adjusted by setting the
+  # environment variable $RBUS_LOG_LEVEL to FATAL, ERROR, WARN, INFO or
+  # DEBUG, or by setting RBus::Log.level=(new_level)
+  #
+  class Log
+    
+    # Set a new log level. Takes either a symbol, like :ERROR or a string,
+    # like 'FATAL'.
+    def self.level=(new_level)
+      new_level = new_level.to_s
+      log_level = case new_level
+                    when 'FATAL'
+                      Logger::FATAL
+                    when 'ERROR'
+                      Logger::ERROR
+                    when 'WARN'
+                      Logger::WARN
+                    when 'INFO'
+                      Logger::INFO
+                    when 'DEBUG'
+                      Logger::DEBUG
+                    else
+                      Logger::ERROR
+                  end
+      @@logger.level = log_level
+    end
+    
+    def self.pp(*objs)
+      sio = StringIO.new('')
+      sio.write(caller(2)[0])
+      sio.write("\n")
+      objs.each do |obj|
+        PP.pp(obj,sio)
+      end
+      sio.string
+    end
+    
+    def self.error(*objs)
+      @@logger.error(pp(objs))
+    end
+    
+    def self.warn(*objs)
+      @@logger.warn(pp(objs))
+    end
+    
+    def self.info(*objs)
+      @@logger.info(pp(objs))
+    end
+    
+    def self.debug(*objs)
+      @@logger.debug(pp(objs))
+    end
+    
+    def self.fatal(*objs)
+      @@logger.fatal(pp(objs))
+    end
+    
+    # Initialize log object
+    log_target = ENV['RBUS_LOG_FILE'] || STDOUT
+    @@logger = Logger.new(log_target)
+    self.level = ENV['RBUS_LOG_LEVEL']
+    @@logger.formatter = lambda { |severity, time, progname, msg|
+      "%s: %s\n" % [severity, msg]
+    }
+
+  end
+end

data/lib/rbus/etc/types.rb

@@ -0,0 +1,56 @@
+#--
+# 
+# R-Bus is a native Ruby implementation of the D-Bus protocol.
+# Copyright (C) 2007 Kristoffer Lundén (kristoffer.lunden@gmail.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA  02110-1301, USA.  A copy of the GNU General Public License is
+# also available at http://www.gnu.org/copyleft/gpl.html.
+#
+#++
+#
+module RBus
+
+  class ObjectPath < String
+  end
+  
+  class Variant
+    attr_reader :object_signature, :object
+    def initialize(object, signature)
+      @object_signature = signature
+      @object = object
+    end
+    
+    def method_missing(name, *args, &block)
+      @object.send(name, *args, &block)
+    end
+    
+    def ==(other)
+      other.object_signature == @object_signature && other.object == @object
+    end
+    
+    def to_s
+      @object.to_s
+    end
+    
+    def to_i
+      @object.to_i
+    end
+    
+    def to_f
+      @object.to_f
+    end
+  end
+end

data/lib/rbus/etc/version.rb

@@ -0,0 +1,34 @@
+#--
+# 
+# R-Bus is a native Ruby implementation of the D-Bus protocol.
+# Copyright (C) 2007 Kristoffer Lundén (kristoffer.lunden@gmail.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA  02110-1301, USA.  A copy of the GNU General Public License is
+# also available at http://www.gnu.org/copyleft/gpl.html.
+#
+#++
+#
+module RBus #:nodoc:
+  module VERSION #:nodoc:
+    PROTOCOL = 1
+  
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/rbus/glib.rb

@@ -0,0 +1,29 @@
+#--
+# 
+# R-Bus is a native Ruby implementation of the D-Bus protocol.
+# Copyright (C) 2007 Kristoffer Lundén (kristoffer.lunden@gmail.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA  02110-1301, USA.  A copy of the GNU General Public License is
+# also available at http://www.gnu.org/copyleft/gpl.html.
+#
+#++
+#
+base_dir = File.dirname(__FILE__)
+%w{auth bus etc message}.each do |dir|
+  Dir[File.join(base_dir, dir, '*.rb')].sort.each { |lib| require lib }
+end
+
+require File.dirname(__FILE__) + '/mainloop/glib.rb'

data/lib/rbus/mainloop/glib.rb

@@ -0,0 +1,77 @@
+#--
+# 
+# R-Bus is a native Ruby implementation of the D-Bus protocol.
+# Copyright (C) 2007 Kristoffer Lundén (kristoffer.lunden@gmail.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA  02110-1301, USA.  A copy of the GNU General Public License is
+# also available at http://www.gnu.org/copyleft/gpl.html.
+#
+#++
+#
+require File.dirname(__FILE__) + '/mainloop'
+require File.dirname(__FILE__) + '/observers'
+require 'gtk2'
+
+module RBus
+  class Mainloop
+    def setup
+      @active = true
+      @io_channel = GLib::IOChannel.new(@transport.socket.fileno)
+      @io_channel.add_watch(GLib::IOChannel::IN) do |ch, con|
+        if @active
+          message = @reader.read_message
+          handle_incoming(message)
+        end
+        true
+      end
+    end
+    
+    def send_message(message, callback = nil)
+      # TODO: if message has no_reply, use dummy observer
+      if message.member == 'AddMatch'
+        observer = SignalObserver.new(self, message.arguments[0], callback)
+        message.arguments = message.arguments[0].map{|key,value|"#{key}='#{value}'"}.join(',')
+      elsif callback
+        observer = AsyncObserver.new(self, message.serial, callback)
+      else
+        observer = nil
+      end
+      
+      handle_outgoing(message)
+
+      # Handle sync reply right here.
+      if observer.nil?
+        @active = false  
+        loop do
+          reply = @reader.read_message
+          next if reply.nil?
+          if message.serial == reply.serial
+            @active = true
+            return reply.arguments
+          else
+            handle_incoming(reply)
+            Gtk.main_iteration_do(false)
+          end
+        end
+      end
+    end  
+  end
+  
+  
+  def self.mainloop # :nodoc:
+    Gtk.main
+  end
+end

data/lib/rbus/mainloop/mainloop.rb

@@ -0,0 +1,84 @@
+#--
+# 
+# R-Bus is a native Ruby implementation of the D-Bus protocol.
+# Copyright (C) 2007 Kristoffer Lundén (kristoffer.lunden@gmail.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA  02110-1301, USA.  A copy of the GNU General Public License is
+# also available at http://www.gnu.org/copyleft/gpl.html.
+#
+#++
+#
+require 'monitor'
+require 'observer'
+
+module RBus
+
+  class Mainloop
+    include Observable
+    include MonitorMixin
+    
+    def initialize(transport)
+      super()
+      @transport = transport
+      @writer = Message::Writer.new(@transport)
+      @reader = Message::Reader.new(@transport)
+      setup
+    end    
+
+    # Mainloop implementations should override this method to setup
+    # everything they need.
+    def setup
+      raise NotImplementedError, "No mainloop implemented"
+    end
+    
+    # Mainloop implementations should call this method with
+    # any message received from the Bus. 
+    # Handles +nil+ messages for non-blocking loops.
+    def handle_incoming(message)
+      return if message.nil?
+      
+      # - empty NAMES is when Bus is connecting only
+      # - empty destination is for signals only
+      # - otherwise, NAMES must include the destination
+      return unless Bus::NAMES.empty? || message.destination.nil? || Bus::NAMES.include?(message.destination)
+      
+      # The audience is listening... broadcast the new message.
+      changed
+      notify_observers(message)
+    end
+    
+    # Mainloop implementations should call this method with
+    # any message to be sent to the Bus, and a callback, if available.
+    # Returns appropriate +observer+
+    def handle_outgoing(message)      
+      # Make sure only one message is sent at each time.  
+      synchronize do
+        @writer.send_message(message)
+      end
+    end
+    
+    # Send message, tell loop to expect an answer. Overridden by
+    # implementations.
+    def send_message(message, callback = nil)    
+      raise NotImplementedError, "No mainloop implemented"
+    end    
+  end
+
+  # Start idle mainloop, overridden by different implementations.
+  def self.mainloop
+    raise NotImplementedError, "No mainloop implemented"
+  end
+end