dnssd 1.2 → 1.3

data/.autotest

@@ -1,10 +1,24 @@
+require 'autotest/restart'
 begin
   require 'autotest/fsevent'
 rescue LoadError
 end
 
+Autotest.add_hook :initialize do |at|
+  at.testlib = 'minitest/unit'
+
+  def at.path_to_classname(s)
+    sep = File::SEPARATOR
+    f = s.sub(/^test#{sep}/, '').sub(/\.rb$/, '').split(sep)
+    f = f.map { |path| path.split(/_|(\d+)/).map { |seg| seg.capitalize }.join }
+    f = f.map { |path| path =~ /^Test/ ? path : "Test#{path}"  }
+    f.join('::').sub 'Dnssd', 'DNSSD'
+  end
+end
+
 Autotest.add_hook :run_command do |at|
   at.unit_diff = 'cat'
+
   if ENV['ONENINE']
     system "rake1.9 compile"
   else

data/History.txt

@@ -1,12 +1,31 @@
-=== 1.2.0 / 2009-08-11
+=== 1.3 / 2009-08-18
 
-* 3 major enhancements
+* 4 major enhancements
+  * Added DNSSD::Service.get_property
+  * Added DNSSD::Service#getaddrinfo
+  * Added DNSSD::Service#add_record
+  * Added DNSSD::Service#query_record
+
+* 5 minor enhancements
+  * DNSSD::Reply#connect now uses DNSSD::Service#getaddrinfo (faster)
+  * DNSSD::Service#register behaves properly when blockless
+  * Broke up DNSSD::Reply into specific subclasses
+  * Added sample/query_record.rb
+  * sample/*.rb work with each other now for clarity of implementation
+
+* 2 bug fixes
+  * Fix hierarchical domains like <tt>\.mac\.name.members.mac.com.</tt>
+  * Fix compilation against avahi 0.6.25
+
+=== 1.2 / 2009-08-11
+
+* 4 major enhancements
   * DNSSD::Service is now directly instantiable
   * DNSSD.announce which registers a server socket you've created
   * DNSSD::Reply.connect which connects to a browsed service
   * Fix asynchronous service shutdown crash
 
-* 3 minor enhancements
+* 8 minor enhancements
   * DNSSD.resolve now optionally accepts a DNSSD::Reply from DNSSD.browse
   * Use rb_thread_wait_fd instead of custom rb_thread_select code
   * DNSSD::Reply#protocol and DNSSD::Reply#service_name

data/Manifest.txt

@@ -8,15 +8,25 @@ ext/dnssd/dnssd.h
 ext/dnssd/errors.c
 ext/dnssd/extconf.rb
 ext/dnssd/flags.c
+ext/dnssd/record.c
 ext/dnssd/service.c
 lib/dnssd.rb
 lib/dnssd/flags.rb
+lib/dnssd/record.rb
 lib/dnssd/reply.rb
+lib/dnssd/reply/addr_info.rb
+lib/dnssd/reply/browse.rb
+lib/dnssd/reply/domain.rb
+lib/dnssd/reply/query_record.rb
+lib/dnssd/reply/register.rb
+lib/dnssd/reply/resolve.rb
 lib/dnssd/service.rb
 lib/dnssd/text_record.rb
 sample/browse.rb
 sample/enumerate_domains.rb
+sample/getaddrinfo.rb
 sample/growl.rb
+sample/query_record.rb
 sample/register.rb
 sample/resolve.rb
 sample/resolve_ichat.rb
@@ -24,5 +34,10 @@ sample/server.rb
 sample/socket.rb
 test/test_dnssd.rb
 test/test_dnssd_flags.rb
+test/test_dnssd_record.rb
 test/test_dnssd_reply.rb
+test/test_dnssd_reply_browse.rb
+test/test_dnssd_reply_query_record.rb
+test/test_dnssd_reply_resolve.rb
+test/test_dnssd_service.rb
 test/test_dnssd_text_record.rb

data/README.txt

@@ -2,11 +2,13 @@
 
 * http://rubyforge.org/projects/dnssd
 * http://github.com/tenderlove/dnssd
+* http://developer.apple.com/documentation/Networking/Conceptual/dns_discovery_api/Introduction.html
 
 == DESCRIPTION:
 
 DNS Service Discovery (aka Bonjour, MDNS) API for Ruby.  Implements browsing,
-resolving, registration and domain enumeration.
+resolving, registration and domain enumeration.  Supports avahi's DNSSD
+compatibility layer for avahi 0.6.25 or newer.
 
 == FEATURES/PROBLEMS:
 
@@ -16,7 +18,7 @@ resolving, registration and domain enumeration.
 
 == SYNOPSIS:
 
-See the sample directory (Hint: gem contents --prefix dnssd)
+See the sample directory (Hint: <tt>gem contents --prefix dnssd</tt>)
 
 Registering a service:
 
@@ -35,15 +37,37 @@ Browsing services:
 == REQUIREMENTS:
 
 * OS X
-* The dns-sd library on other operating systems (or dns-sd shim)
+* The dns-sd library on other operating systems
+* avahi 0.6.25+
 
 == INSTALL:
 
   sudo gem install dnssd
 
+If you have dnssd installed in a non-standard location you can use the build
+options --with-dnssd-dir and --with-dnssd-lib:
+
+  sudo gem install dnssd -- \
+    --with-dnssd-dir=/path/to/dnssd \
+    --with-dnssd-lib=/path/to/lib/dnssd
+
+Using the default Bonjour SDK install for Windows, the command to build
+the Ruby dnssd extension will look like this:
+
+  # Windows 2000 or Windows XP
+  sudo gem install dnssd -- \
+     --with-dnssd-dir=c:/progra~1/bonjou~1 \
+     --with-dnssd-lib=c:/progra~1/bonjou~1/lib/win32
+  
+  # Windows Vista and later
+  sudo gem install dnssd -- \
+     --with-dnssd-dir=c:/progra~2/bonjou~1 \
+     --with-dnssd-lib=c:/progra~2/bonjou~1/lib/win32
+
 == LICENSE:
 
 Copyright (c) 2004 Chad Fowler, Charles Mills, Rich Kilmer
+
 Copyright (c) 2009 Phil Hagelberg, Aaron Patterson, Eric Hodel
 
 Licensed under the ruby license

data/Rakefile

@@ -10,12 +10,12 @@ Hoe.plugin :git
 HOE = Hoe.spec 'dnssd' do
   self.rubyforge_name = 'dnssd'
 
+  developer 'Eric Hodel',      'drbrain@segment.net'
+  developer 'Aaron Patterson', 'aaronp@rubyforge.org'
+  developer 'Phil Hagelberg',  'phil@hagelb.org'
   developer 'Chad Fowler',     'chad@chadfowler.com'
   developer 'Charles Mills',   ''
   developer 'Rich Kilmer',     ''
-  developer 'Phil Hagelberg',  'phil@hagelb.org'
-  developer 'Aaron Patterson', 'aaronp@rubyforge.org'
-  developer 'Eric Hodel',      'drbrain@segment.net'
 
   spec_extras[:extensions] = 'ext/dnssd/extconf.rb'
 
@@ -23,13 +23,14 @@ HOE = Hoe.spec 'dnssd' do
 
   extra_dev_deps << ['hoe-seattlerb', '~> 1.2']
   extra_dev_deps << ['minitest', '~> 1.4']
-  extra_dev_deps << ['rake-complier', '~> 0.6']
+  extra_dev_deps << ['rake-compiler', '~> 0.6']
 end
 
 require 'rake/extensiontask'
 
 Rake::ExtensionTask.new 'dnssd', HOE.spec do |ext|
   ext.lib_dir = File.join 'lib', 'dnssd'
+  ext.config_options << '--with-warnings'
 end
 
 task :test => :compile

data/ext/dnssd/dnssd.c

@@ -2,6 +2,7 @@
 
 void Init_DNSSD_Errors(void);
 void Init_DNSSD_Flags(void);
+void Init_DNSSD_Record(void);
 void Init_DNSSD_Service(void);
 
 /*
@@ -82,9 +83,11 @@ Init_dnssd(void) {
   rb_define_const(mDNSSD, "InterfaceLocalOnly",
       ULONG2NUM(kDNSServiceInterfaceIndexLocalOnly));
 
+#ifdef kDNSServiceInterfaceIndexUnicast
   /* Unicast interfaces */
   rb_define_const(mDNSSD, "InterfaceUnicast",
       ULONG2NUM(kDNSServiceInterfaceIndexUnicast));
+#endif
 
   rb_define_singleton_method(mDNSSD, "getservbyport", dnssd_getservbyport, -1);
 
@@ -93,6 +96,7 @@ Init_dnssd(void) {
 
   Init_DNSSD_Errors();
   Init_DNSSD_Flags();
+  Init_DNSSD_Record();
   Init_DNSSD_Service();
 }
 

data/ext/dnssd/dnssd.h

@@ -4,27 +4,22 @@
 #include <ruby.h>
 #include <dns_sd.h>
 
-/* for if_indextoname() and other unix networking functions */
-#ifdef HAVE_UNISTD_H
-#include <unistd.h>
-#endif
-#ifdef HAVE_SYS_TYPES_H
+#include <arpa/inet.h>  /* htons ntohs */
+#include <sys/socket.h> /* struct sockaddr_in */
+#include <netdb.h>      /* getservbyport */
+
+/* if_indextoname and if_nametoindex */
+#ifdef HAVE_IPHLPAPI_H
+#include <iphlpapi.h> /* Vista and newer */
+#else
 #include <sys/types.h>
-#endif
-#ifdef HAVE_SYS_SOCKET_H
-#include <sys/socket.h>
-#endif
-#ifdef HAVE_SYS_PARAM_H
-#include <sys/param.h>
-#endif
-#ifdef HAVE_NET_IF_H
 #include <net/if.h>
 #endif
-#ifdef HAVE_SYS_IF_H
-#include <sys/if.h>
-#endif
-#ifdef HAVE_NETDB_H
-#include <netdb.h>
+
+#ifdef HAVE_ST_SIN_LEN
+#define SIN_LEN(si) (si)->sin_len
+#else
+#define SIN_LEN(si) sizeof(struct sockaddr_in)
 #endif
 
 extern VALUE eDNSSDError;

data/ext/dnssd/errors.c

@@ -1,5 +1,4 @@
 #include "dnssd.h"
-#include <assert.h>
 
 VALUE eDNSSDError;
 static VALUE eDNSSDUnknownError;
@@ -11,8 +10,13 @@ static VALUE dnssd_errors[DNSSD_ERROR_END - DNSSD_ERROR_START];
 
 static void
 dnssd_errors_store(VALUE error, DNSServiceErrorType err) {
-  assert(DNSSD_ERROR_START <= err && err <= DNSSD_ERROR_END);
-  dnssd_errors[err - DNSSD_ERROR_START] = error;
+  if (DNSSD_ERROR_START <= err && err <= DNSSD_ERROR_END) {
+    dnssd_errors[err - DNSSD_ERROR_START] = error;
+  } else {
+    rb_raise(eDNSSDError,
+        "invalid error number %d (expected between %d and %d)",
+        err, DNSSD_ERROR_START, DNSSD_ERROR_END);
+  }
 }
 
 void
@@ -107,6 +111,7 @@ Init_DNSSD_Errors(void) {
   error_class = rb_define_class_under(mDNSSD, "BadTimeError", eDNSSDError);
   dnssd_errors_store(error_class, kDNSServiceErr_BadTime);
 
+#ifdef HAVE_KDNSSERVICEERR_BADSIG
   error_class = rb_define_class_under(mDNSSD, "BadSigError", eDNSSDError);
   dnssd_errors_store(error_class, kDNSServiceErr_BadSig);
 
@@ -124,4 +129,5 @@ Init_DNSSD_Errors(void) {
 
   error_class = rb_define_class_under(mDNSSD, "NATPortMappingDisabled", eDNSSDError);
   dnssd_errors_store(error_class, kDNSServiceErr_NATPortMappingDisabled);
+#endif
 }

data/ext/dnssd/extconf.rb

@@ -1,59 +1,66 @@
-#!/usr/bin/env ruby
-# :stopdoc:
-#
-# Extension configuration script for DNS_SD C Extension.
+require 'mkmf'
 
-def check_for_funcs(*funcs)
-  funcs.flatten!
-  funcs.each do |f|
-    abort("need function #{f}") unless have_func(f)
-  end
-end
+$CFLAGS << ' -Wall' if with_config 'warnings'
 
-require "mkmf"
+dir_config 'dnssd'
 
-$CFLAGS << " -Wall"
-$CFLAGS << " -DDEBUG" if $DEBUG
+abort 'unable to find dnssd header' unless have_header 'dns_sd.h'
 
-libraries = {
-  'mdns'   => 'DNSServiceRefSockFD',
-  'dns_sd' => 'DNSServiceRefSockFD',
-  'System' => 'DNSServiceRefSockFD'
-}.sort
+have_library('dnssd')  ||
+have_library('dns_sd') ||
+have_library('mdns')   ||
+have_library('System') ||
+abort('unable to find dnssd library')
 
-dnssd_found = libraries.any? do |library, function|
-  have_library library, function
-end
+have_macro('htons', 'arpa/inet.h') ||
+have_func('htons', 'arpa/inet.h')  ||
+abort("couldn't find htons")
 
-unless dnssd_found then
-  abort "Couldn't find DNSSD in libraries #{libraries.keys.join ', '}"
-end
+have_macro('ntohs', 'arpa/inet.h') ||
+have_func('ntohs', 'arpa/inet.h')  ||
+abort("couldn't find ntohs")
 
-have_header "dns_sd.h" or abort "can't find the rendezvous client headers"
+# These functions live in netioapi.h on Windows, not net/if.h. The MSDN
+# documentation says to include iphlpapi.h, not netioapi.h directly.
+#
+# Note, however, that these functions only exist on Vista/Server 2008 or later.
+# On Windows XP and earlier you will have to define a custom version of each
+# function using native functions, such as ConvertInterfaceIndexToLuid() and
+# ConvertInterfaceLuidToNameA().
+#
+if have_header 'iphlpapi.h' then
+  have_func('if_indextoname', %w[iphlpapi.h netioapi.h]) &&
+  have_func('if_nametoindex', %w[iphlpapi.h netioapi.h]) ||
+  abort('unable to find if_indextoname or if_nametoindex')
+else
+  have_func('if_indextoname', %w[sys/types.h sys/socket.h net/if.h]) &&
+  have_func('if_nametoindex', %w[sys/types.h sys/socket.h net/if.h]) ||
+  abort('unable to find if_indextoname or if_nametoindex')
+end
 
-have_header "unistd.h"
-have_header "sys/types.h"
-have_header "sys/socket.h"
-have_header "sys/param.h"
-have_header "sys/if.h"
-have_header "net/if.h"
-have_header "arpa/inet.h"
-have_header "netdb.h"
+have_func('getservbyport', 'netdb.h') ||
+abort('unable to find getservbyport')
 
-abort "need function #{f}" unless have_macro("htons") || have_func("htons")
-abort "need function #{f}" unless have_macro("ntohs") || have_func("ntohs")
+have_type('struct sockaddr_in', 'netinet/in.h') ||
+abort('unable to find struct sockaddr_in')
 
-check_for_funcs "if_indextoname", "if_nametoindex"
-have_func "gethostname"
+have_struct_member 'struct sockaddr_in', 'sin_len', 'netinet/in.h'
+# otherwise, use sizeof()
 
-s1 = check_sizeof "void*"
-s2 = check_sizeof("DNSServiceFlags", "dns_sd.h") or
-  abort("can't determine sizeof(DNSServiceFlags)")
+puts
+puts 'checking for missing avahi features'
+# avahi 0.6.25 is missing these functions
+have_func 'DNSServiceGetProperty', 'dns_sd.h'
+have_func 'DNSServiceGetAddrInfo', 'dns_sd.h'
 
-# need to make sure storing unsigned integer in void * is OK.
-s1 >= s2 or abort("sizeof(void*) < sizeof(DNSServiceFlags) please contact the authors!")
+# avahi 0.6.25 is missing these flags
+have_func 'kDNSServiceFlagsForce', 'dns_sd.h'
+have_func 'kDNSServiceFlagsNonBrowsable', 'dns_sd.h'
+have_func 'kDNSServiceFlagsReturnIntermediates', 'dns_sd.h'
+have_func 'kDNSServiceFlagsShareConnection', 'dns_sd.h'
 
-create_makefile "dnssd"
+# avahi 0.6.25 is missing errors after BadTime
+have_func 'kDNSServiceErr_BadSig', 'dns_sd.h'
 
-# :startdoc:
+create_makefile 'dnssd'
 

data/ext/dnssd/flags.c

@@ -1,31 +1,43 @@
 #include "dnssd.h"
 
 /* dnssd flags, flag IDs, flag names */
-#define DNSSD_MAX_FLAGS 13
+#define DNSSD_MAX_FLAGS 15
 
 static const DNSServiceFlags dnssd_flag[DNSSD_MAX_FLAGS] = {
   kDNSServiceFlagsMoreComing,
-
   kDNSServiceFlagsAdd,
   kDNSServiceFlagsDefault,
-
   kDNSServiceFlagsNoAutoRename,
-
   kDNSServiceFlagsShared,
   kDNSServiceFlagsUnique,
-
   kDNSServiceFlagsBrowseDomains,
   kDNSServiceFlagsRegistrationDomains,
-
   kDNSServiceFlagsLongLivedQuery,
-
   kDNSServiceFlagsAllowRemoteQuery,
+  kDNSServiceFlagsForceMulticast
+#ifdef HAVE_KDNSSERVICEFLAGSFORCE
+, kDNSServiceFlagsForce
+#else
+, (DNSServiceFlags)NULL
+#endif
 
-  kDNSServiceFlagsForceMulticast,
+#ifdef HAVE_KDNSSERVICEFLAGSRETURNINTERMEDIATES
+, kDNSServiceFlagsReturnIntermediates
+#else
+, (DNSServiceFlags)NULL
+#endif
 
-  kDNSServiceFlagsForce,
+#ifdef HAVE_KDNSSERVICEFLAGSNONBROWSABLE
+, kDNSServiceFlagsNonBrowsable
+#else
+, (DNSServiceFlags)NULL
+#endif
 
-  kDNSServiceFlagsReturnIntermediates
+#ifdef HAVE_KDNSSERVICEFLAGSSHARECONNECTION
+, kDNSServiceFlagsShareConnection
+#else
+, (DNSServiceFlags)NULL
+#endif
 };
 
 static const char *dnssd_flag_name[DNSSD_MAX_FLAGS] = {
@@ -41,7 +53,9 @@ static const char *dnssd_flag_name[DNSSD_MAX_FLAGS] = {
   "allow_remote_query",
   "force_multicast",
   "force",
-  "return_intermediates"
+  "return_intermediates",
+  "non_browsable",
+  "share_connection"
 };
 
 void
@@ -54,7 +68,7 @@ Init_DNSSD_Flags(void) {
   cDNSSDFlags = rb_define_class_under(mDNSSD, "Flags", rb_cObject);
 
   /* flag constants */
-#if DNSSD_MAX_FLAGS != 13
+#if DNSSD_MAX_FLAGS != 15
 #error The code below needs to be updated.
 #endif
 
@@ -96,6 +110,24 @@ Init_DNSSD_Flags(void) {
   rb_define_const(cDNSSDFlags, "NoAutoRename",
       ULONG2NUM(kDNSServiceFlagsNoAutoRename));
 
+#ifdef kDNSServiceFlagsShareConnection
+  /* For efficiency, clients that perform many concurrent operations may want
+   * to use a single Unix Domain Socket connection with the background daemon,
+   * instead of having a separate connection for each independent operation. To
+   * use this mode, clients first call DNSServiceCreateConnection(&MainRef) to
+   * initialize the main DNSServiceRef.  For each subsequent operation that is
+   * to share that same connection, the client copies the MainRef, and then
+   * passes the address of that copy, setting the ShareConnection flag to tell
+   * the library that this DNSServiceRef is not a typical uninitialized
+   * DNSServiceRef; it's a copy of an existing DNSServiceRef whose connection
+   * information should be reused.
+   *
+   * NOTE: Not currently supported
+   */
+  rb_define_const(cDNSSDFlags, "ShareConnection",
+      ULONG2NUM(kDNSServiceFlagsShareConnection));
+#endif
+
   /* Flag for registering individual records on a connected DNSSD::Service.
    *
    * DNSSD::Flags::Shared indicates that there may be multiple records with
@@ -148,6 +180,7 @@ Init_DNSSD_Flags(void) {
   rb_define_const(cDNSSDFlags, "ForceMulticast",
       ULONG2NUM(kDNSServiceFlagsForceMulticast));
 
+#ifdef HAVE_KDNSSERVICEFLAGSFORCE
   /* Flag for signifying a "stronger" variant of an operation. Currently
    * defined only for DNSSD.reconfirm_record, where it forces a record to
    * be removed from the cache immediately, instead of querying for a few
@@ -158,7 +191,21 @@ Init_DNSSD_Flags(void) {
    * instance will disappear, and then re-appear moments later.
    */
   rb_define_const(cDNSSDFlags, "Force", ULONG2NUM(kDNSServiceFlagsForce));
+#endif
+
+#ifdef HAVE_KDNSSERVICEFLAGSNONBROWSABLE
+  /* A service registered with the NonBrowsable flag set can be resolved using
+   * DNSServiceResolve(), but will not be discoverable using
+   * DNSServiceBrowse().  This is for cases where the name is actually a GUID;
+   * it is found by other means; there is no end-user benefit to browsing to
+   * find a long list of opaque GUIDs.  Using the NonBrowsable flag creates
+   * SRV+TXT without the cost of also advertising an associated PTR record.
+   */
+  rb_define_const(cDNSSDFlags, "NonBrowsable",
+      ULONG2NUM(kDNSServiceFlagsNonBrowsable));
+#endif
 
+#ifdef HAVE_KDNSSERVICEFLAGSRETURNINTERMEDIATES
   /* Flag for returning intermediate results. For example, if a query results
    * in an authoritative NXDomain (name does not exist) then that result is
    * returned to the client. However the query is not implicitly cancelled --
@@ -172,12 +219,19 @@ Init_DNSSD_Flags(void) {
    */
   rb_define_const(cDNSSDFlags, "ReturnIntermediates",
       ULONG2NUM(kDNSServiceFlagsReturnIntermediates));
+#endif
+
+#ifdef HAVE_KDNSSERVICEFLAGSSHARECONNECTION
+  rb_define_const(cDNSSDFlags, "ShareConnection",
+      ULONG2NUM(kDNSServiceFlagsShareConnection));
+#endif
 
   flags_hash = rb_hash_new();
 
   for (i = 0; i < DNSSD_MAX_FLAGS; i++) {
-    rb_hash_aset(flags_hash, rb_str_new2(dnssd_flag_name[i]),
-        ULONG2NUM(dnssd_flag[i]));
+    if (dnssd_flag[i])
+      rb_hash_aset(flags_hash, rb_str_new2(dnssd_flag_name[i]),
+          ULONG2NUM(dnssd_flag[i]));
   }
 
   /* Hash of flags => flag_name */