dnssd 1.2 → 1.3

data/lib/dnssd.rb

@@ -1,6 +1,3 @@
-require 'dnssd/dnssd'
-require 'socket'
-
 ##
 # DNSSD is a wrapper for the DNS Service Discovery library.
 #
@@ -16,7 +13,7 @@ module DNSSD
   ##
   # The version of DNSSD you're using.
 
-  VERSION = '1.2'
+  VERSION = '1.3'
 
   ##
   # Registers +socket+ with DNSSD as +name+.  If +service+ is omitted it is
@@ -120,9 +117,14 @@ module DNSSD
                     interface = DNSSD::InterfaceAny, &block)
     service = DNSSD::Service.new
 
-    Thread.start do
-      run(service, :register, name, type, domain, port, nil, text_record,
-          flags, interface, &block)
+    if block_given? then
+      Thread.start do
+        run(service, :register, name, type, domain, port, nil, text_record,
+            flags, interface, &block)
+      end
+    else
+      service.register name, type, domain, port, nil, text_record, flags,
+                       interface
     end
 
     service
@@ -135,8 +137,15 @@ module DNSSD
                      interface = DNSSD::InterfaceAny, &block)
     service = DNSSD::Service.new
 
-    run(service, :register, name, type, domain, port, nil, text_record, flags,
-        interface, &block)
+    if block_given? then
+      run(service, :register, name, type, domain, port, nil, text_record, flags,
+          interface, &block)
+    else
+      service.register name, type, domain, port, nil, text_record, flags,
+                       interface
+    end
+
+    service
   end
 
   ##
@@ -175,8 +184,34 @@ module DNSSD
 
 end
 
-require 'dnssd/flags'
+require 'socket'
+
 require 'dnssd/reply'
-require 'dnssd/service'
+require 'dnssd/reply/addr_info'
+require 'dnssd/reply/browse'
+require 'dnssd/reply/domain'
+require 'dnssd/reply/query_record'
+require 'dnssd/reply/register'
+require 'dnssd/reply/resolve'
 require 'dnssd/text_record'
 
+# Suppress avahi compatibilty warning
+# http://0pointer.de/avahi-compat?s=libdns_sd&e=ruby
+ENV['AVAHI_COMPAT_NOWARN'] = '1'
+
+# The C extension uses above-defined classes
+require 'dnssd/dnssd'
+
+module DNSSD
+  # :stopdoc:
+  class ServiceNotRunningError < UnknownError; end unless
+    const_defined? :ServiceNotRunningError
+
+  InterfaceUnicast = 4294967294 unless const_defined? :InterfaceUnicast # -2
+  # :startdoc:
+end
+
+require 'dnssd/flags'
+require 'dnssd/service'
+require 'dnssd/record'
+

data/lib/dnssd/record.rb

@@ -0,0 +1,97 @@
+require 'ipaddr'
+
+##
+# Created when adding a DNS record using DNSSD::Service#add_record.  Provides
+# convenience methods for creating the DNS record.
+#
+# See also {RFC 1035}[http://www.rfc-editor.org/rfc/rfc1035.txt]
+
+class DNSSD::Record
+
+  value_to_name = constants.map do |name|
+    next if name.intern == :IN
+    [const_get(name), name.to_s]
+  end.compact.flatten
+
+  ##
+  # Maps record constant values to the constant name
+
+  VALUE_TO_NAME = Hash[*value_to_name]
+
+  ##
+  # Turns +string+ into an RFC-1035 character-string
+
+  def self.string_to_character_string(string)
+    length = string.length
+    raise ArgumentError, "#{string.inspect} is too long (255 bytes max)" if
+      length > 255
+    "#{length.chr}#{string}"
+  end
+
+  ##
+  # Turns +string+ into an RFC-1035 domain-name
+
+  def self.string_to_domain_name(string)
+    string.split('.').map do |part|
+      string_to_character_string part
+    end.join('') << "\0"
+  end
+
+  ##
+  # Encodes resource +args+ into +type+.  Handles:
+  #
+  # A AAAA CNAME MX NS PTR SOA SRV TXT
+
+  def self.to_data(type, *args)
+    raise ArgumentError, "unknown type #{type}" unless VALUE_TO_NAME.key? type
+
+    data = case type
+           when A then
+             addr = args.shift
+             addr = IPAddr.new addr unless IPAddr === addr
+             raise ArgumentError, "#{addr} is not IPv4" unless addr.ipv4?
+             addr.hton
+           when AAAA then
+             addr = args.shift
+             addr = IPAddr.new addr unless IPAddr === addr
+             raise ArgumentError, "#{addr} is not IPv6" unless addr.ipv6?
+             addr.hton
+           when CNAME, NS, PTR then
+             string_to_domain_name args.shift
+           when MX then
+             [args.shift, string_to_domain_name(args.shift)].pack 'na*'
+           when SOA then
+             [
+               string_to_domain_name(args.shift),
+               string_to_domain_name(args.shift),
+               args.shift, args.shift, args.shift, args.shift, args.shift
+             ].pack 'a*a*NNNNN'
+           when SRV then
+             [
+               args.shift, args.shift, args.shift,
+               string_to_domain_name(args.shift)
+             ].pack 'nnna*'
+           when TXT then
+             data = args.map do |string|
+               string_to_character_string string
+             end.join ''
+
+             raise ArgumentError,
+                   "TXT record too long (#{data.length} bytes)" if
+               data.length > 65535
+
+             args.clear
+
+             data
+           else
+             raise ArgumentError, "unhandled record type #{VALUE_TO_NAME[type]}"
+           end
+
+    raise ArgumentError, "Too many arguments for #{VALUE_TO_NAME[type]}" unless
+      args.empty?
+
+    data
+  end
+
+end
+

data/lib/dnssd/reply.rb

@@ -4,131 +4,78 @@
 class DNSSD::Reply
 
   ##
-  # The service domain
-
-  attr_reader :domain
-
-  ##
-  # Flags describing the reply, see DNSSD::Flags
+  # Flags for this reply, see DNSSD::Flags
 
   attr_reader :flags
 
   ##
-  # The interface on which the service is available
+  # The interface name for this reply
 
   attr_reader :interface
 
   ##
-  # The service name
-
-  attr_reader :name
-
-  ##
-  # The port for this service
-
-  attr_reader :port
-
-  ##
-  # The DNSSD::Service associated with the reply
+  # The DNSSD::Service that created this reply
 
   attr_reader :service
 
   ##
-  # The hostname of the host provide the service
-
-  attr_reader :target
-
-  ##
-  # The service's primary text record
-
-  attr_reader :text_record
-
-  ##
-  # The service type
-
-  attr_reader :type
-
-  ##
-  # Creates a DNSSD::Reply from +service+ and +flags+
+  # Creates a new reply attached to +service+ with +flags+ on interface index
+  # +interface+
 
-  def self.from_service(service, flags)
-    reply = new
-    reply.instance_variable_set :@service, service
-    reply.instance_variable_set :@flags, DNSSD::Flags.new(flags)
-    reply
-  end
-
-  ##
-  # Connects to this Reply.  If +target+ and +port+ are missing, DNSSD.resolve
-  # is automatically called.  +family+ can be used to select a particular
-  # address family.
-
-  def connect(family = Socket::AF_UNSPEC)
-    unless target and port then
-      value = nil
-
-      DNSSD.resolve! self do |reply|
-        value = reply
-        break
-      end
-
-      return value.connect
-    end
-
-    socktype = case protocol
-               when 'tcp' then Socket::SOCK_STREAM
-               when 'udp' then Socket::SOCK_DGRAM
-               else raise ArgumentError, "invalid protocol #{protocol}"
-               end
-
-    addresses = Socket.getaddrinfo target, port, family, socktype
-
-    socket = nil
-
-    addresses.each do |address|
-      begin
-        case protocol
-        when 'tcp' then
-          socket = TCPSocket.new address[3], port
-        when 'udp' then
-          socket = UDPSocket.new
-          socket.connect address[3], port rescue next
-        end
-
-        return socket
-      rescue
-        next
-      end
-    end
-
-    raise DNSSD::Error, "unable to connect to #{target}:#{port}" unless socket
+  def initialize(service, flags, interface)
+    @service = service
+    @flags = DNSSD::Flags.new flags
+    @interface = if interface then
+                   interface > 0 ? DNSSD.interface_name(interface) : interface
+                 end
   end
 
   ##
   # The full service domain name, see DNSS::Service#fullname
 
   def fullname
-    DNSSD::Service.fullname @name.gsub("\032", ' '), @type, @domain
+    fullname = DNSSD::Service.fullname @name.gsub("\032", ' '), @type, @domain
+    fullname << '.' unless fullname =~ /\.$/
+    fullname
   end
 
   def inspect # :nodoc:
-    "#<%s:0x%x %p type: %s domain: %s interface: %s flags: %s>" % [
-      self.class, object_id, @name, @type, @domain, @interface, @flags
+    "#<%s:0x%x interface: %s flags: %p>" % [
+      self.class, object_id, interface_name, @flags
     ]
   end
 
+  ##
+  # Expands the name of the interface including constants
+
+  def interface_name
+    case @interface
+    when nil                       then 'nil'
+    when DNSSD::InterfaceAny       then 'any'
+    when DNSSD::InterfaceLocalOnly then 'local'
+    when DNSSD::InterfaceUnicast   then 'unicast'
+    else @interface
+    end
+  end
+
   ##
   # Protocol of this service
 
   def protocol
-    type.split('.').last.sub '_', ''
+    raise TypeError, 'no type on this reply' unless
+      instance_variable_defined? :@type
+
+    @type.split('.').last.sub '_', ''
   end
 
   ##
   # Service name as in Socket.getservbyname
 
   def service_name
-    type.split('.').first.sub '_', ''
+    raise TypeError, 'no type on this reply' unless
+      instance_variable_defined? :@type
+
+    @type.split('.').first.sub '_', ''
   end
 
   ##
@@ -141,8 +88,8 @@ class DNSSD::Reply
     end
 
     @name   = fullname[0]
-    @type   = fullname[1,   2].join '.'
-    @domain = fullname.last + '.'
+    @type   = fullname[1, 2].join '.'
+    @domain = fullname[3..-1].map { |part| part.sub '.', '\\.' }.join('.') + '.'
   end
 
   ##

data/lib/dnssd/reply/addr_info.rb

@@ -0,0 +1,47 @@
+##
+# Created by DNSSD::Service#getaddrinfo
+
+class DNSSD::Reply::AddrInfo < DNSSD::Reply
+
+  ##
+  # IP address of host
+
+  attr_reader :address
+
+  ##
+  # Host name
+
+  attr_reader :hostname
+
+  ##
+  # Port name
+
+  attr_reader :port
+
+  ##
+  # Time to live see #expired?
+
+  attr_reader :ttl
+
+  ##
+  # Creates a new AddrInfo, called internally by DNSSD::Service#getaddrinfo
+
+  def initialize(service, flags, interface, hostname, sockaddr, ttl)
+    super service, flags, interface
+
+    @hostname = hostname
+    @port, @address = Socket.unpack_sockaddr_in sockaddr
+
+    @created = Time.now
+    @ttl = ttl
+  end
+
+  ##
+  # Has this AddrInfo passed its TTL?
+
+  def expired?
+    Time.now > @created + ttl
+  end
+
+end
+

data/lib/dnssd/reply/browse.rb

@@ -0,0 +1,52 @@
+##
+# Returned by DNSSD::Service#browse
+
+class DNSSD::Reply::Browse < DNSSD::Reply
+
+  ##
+  # A domain for registration or browsing
+
+  attr_reader :domain
+
+  ##
+  # The service name
+
+  attr_reader :name
+
+  ##
+  # The service type
+
+  attr_reader :type
+
+  ##
+  # Creates a new Browse, called internally by DNSSD::Service#browse
+
+  def initialize(service, flags, interface, name, type, domain)
+    super service, flags, interface
+
+    set_names name, type, domain
+  end
+
+  ##
+  # Resolves this service's target using DNSSD::Reply::Resolve#connect which
+  # connects, returning a TCP or UDP socket.
+
+  def connect(family = Socket::AF_UNSPEC, addrinfo_flags = 0)
+    value = nil
+
+    DNSSD.resolve! self do |reply|
+      value = reply
+      break
+    end
+
+    value.connect family, addrinfo_flags
+  end
+
+  def inspect # :nodoc:
+    "#<%s:0x%x %p interface: %s flags: %p>" % [
+      self.class, object_id, fullname, interface_name, @flags
+    ]
+  end
+
+end
+