UPnP 1.0.0 → 1.1.0

data/.autotest

@@ -6,6 +6,7 @@ Autotest.add_hook :initialize do |at|
     ['test/test_UPnP_SSDP.rb',
      'test/test_UPnP_SSDP_notification.rb',
      'test/test_UPnP_SSDP_response.rb',
+     'test/test_UPnP_SSDP_search.rb',
     ]
   end
 
@@ -19,11 +20,19 @@ Autotest.add_hook :initialize do |at|
 
   at.extra_class_map["TestUPnPControlDevice"] =
     'test/test_UPnP_control_device.rb'
+  at.extra_class_map["TestUPnPDevice"] =
+    'test/test_UPnP_device.rb'
+  at.extra_class_map["TestUPnPService"] =
+    'test/test_UPnP_service.rb'
+  at.extra_class_map["TestUPnPRootServer"] =
+    'test/test_UPnP_root_server.rb'
   at.extra_class_map["TestUPnPSSDP"] = 'test/test_UPnP_SSDP.rb'
   at.extra_class_map["TestUPnPSSDPNotification"] =
     'test/test_UPnP_SSDP_notification.rb'
   at.extra_class_map["TestUPnPSSDPResponse"] =
     'test/test_UPnP_SSDP_response.rb'
+  at.extra_class_map["TestUPnPSSDPSearch"] =
+    'test/test_UPnP_SSDP_search.rb'
   at.extra_class_map["TestUPnPControlService"] =
     'test/test_UPnP_control_service.rb'
 end

data/History.txt

@@ -1,3 +1,11 @@
+=== 1.1.0 / 2008-07-23
+
+* 2 major enhancements
+  * Server support
+  * SSDP now supports sending advertisements
+* 1 bug fix
+  * Gem dependencies now listed
+
 === 1.0.0 / 2008-06-25
 
 * 1 major enhancement

data/Manifest.txt

@@ -7,12 +7,20 @@ bin/upnp_discover
 bin/upnp_listen
 lib/UPnP.rb
 lib/UPnP/SSDP.rb
+lib/UPnP/UUID.rb
 lib/UPnP/control.rb
 lib/UPnP/control/device.rb
 lib/UPnP/control/service.rb
+lib/UPnP/device.rb
+lib/UPnP/root_server.rb
+lib/UPnP/service.rb
 test/test_UPnP_SSDP.rb
 test/test_UPnP_SSDP_notification.rb
 test/test_UPnP_SSDP_response.rb
+test/test_UPnP_SSDP_search.rb
 test/test_UPnP_control_device.rb
 test/test_UPnP_control_service.rb
+test/test_UPnP_device.rb
+test/test_UPnP_root_server.rb
+test/test_UPnP_service.rb
 test/utilities.rb

data/README.txt

@@ -10,16 +10,27 @@ An implementation of the UPnP protocol
 
 == FEATURES/PROBLEMS:
 
-* Discovers UPnP devices and services via SSDP, see UPnP::SSDP
-* Creates a SOAP RPC driver for discovered services, see UPnP::Control::Service
-* Creates concrete UPnP device and service classes that may be extended with
-  utility methods, see UPnP::Control::Device::create,
-  UPnP::Control::Service::create and the UPnP-IGD gem.
+* Client support:
+  * Discovers UPnP devices and services via SSDP, see UPnP::SSDP
+  * Creates a SOAP RPC driver for discovered services, see
+    UPnP::Control::Service
+  * Creates concrete UPnP device and service classes that may be extended with
+    utility methods, see UPnP::Control::Device::create,
+    UPnP::Control::Service::create and the UPnP-IGD gem.
+* Server support:
+  * Easy creation of device and service skeletons from UPnP specifications
+  * Advertises UPnP devices and services via SSDP
+  * Creates a SOAP RPC server for each service
+  * Mounts services in a single WEBrick server
+  * Easy creation of executables for devices
 * Eventing not implemented
-* Servers not implemented
 
 == SYNOPSIS:
 
+See UPnP::Device for instructions on creating a UPnP device.
+
+See UPnP::Service for instructinos on creating a UPnP service.
+
 Print out information about UPnP devices nearby:
 
   upnp_discover
@@ -66,7 +77,7 @@ service, print out the external IP address for the gateway:
 
 == LICENSE:
 
-All code copyright 2008 Eric Hodel.  All rights reserved.
+Original code copyright 2008 Eric Hodel.  All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions

data/Rakefile

@@ -7,6 +7,9 @@ require './lib/upnp.rb'
 Hoe.new('UPnP', UPnP::VERSION) do |p|
   p.rubyforge_name = 'seattlerb'
   p.developer('Eric Hodel', 'drbrain@segment7.net')
+
+  p.extra_deps << 'soap4r'
+  p.extra_deps << 'builder'
 end
 
 # vim: syntax=Ruby

data/lib/UPnP.rb

@@ -23,7 +23,7 @@ module UPnP
   ##
   # The version of UPnP you are using
 
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 
   ##
   # UPnP error base class

data/lib/UPnP/SSDP.rb

@@ -94,11 +94,6 @@ class UPnP::SSDP
 
     attr_reader :name
 
-    ##
-    # Type of the advertised service or device
-
-    attr_reader :type
-
     ##
     # Server name and version of the advertised service or device
 
@@ -109,6 +104,11 @@ class UPnP::SSDP
 
     attr_reader :sub_type
 
+    ##
+    # Type of the advertised service or device
+
+    attr_reader :type
+
     ##
     # Parses a NOTIFY advertisement into its component pieces
 
@@ -270,6 +270,48 @@ class UPnP::SSDP
 
   end
 
+  ##
+  # Holds information about an M-SEARCH
+
+  class Search < Advertisement
+
+    attr_reader :date
+
+    attr_reader :target
+
+    attr_reader :wait_time
+
+    ##
+    # Creates a new Search by parsing the text in +response+
+
+    def self.parse(response)
+      response =~ /^mx:\s*(\d+)/i
+      wait_time = Integer $1
+
+      response =~ /^st:\s*(\S*)/i
+      target = $1.strip
+
+      new Time.now, target, wait_time
+    end
+
+    ##
+    # Creates a new Search
+
+    def initialize(date, target, wait_time)
+      @date = date
+      @target = target
+      @wait_time = wait_time
+    end
+
+    ##
+    # A friendlier inspect
+
+    def inspect
+      "#<#{self.class}:0x#{object_id.to_s 16} #{target}>"
+    end
+
+  end
+
   ##
   # Default broadcast address
 
@@ -301,6 +343,16 @@ class UPnP::SSDP
 
   attr_accessor :listener # :nodoc:
 
+  ##
+  # A WEBrick::Log logger for unified logging
+
+  attr_writer :log
+
+  ##
+  # Thread that periodically notifies for advertise
+
+  attr_reader :notify_thread # :nodoc:
+
   ##
   # Port to use for SSDP searching and listening
 
@@ -311,6 +363,11 @@ class UPnP::SSDP
 
   attr_accessor :queue # :nodoc:
 
+  ##
+  # Thread that handles search requests for advertise
+
+  attr_reader :search_thread # :nodoc:
+
   ##
   # Socket accessor for tests
 
@@ -336,8 +393,101 @@ class UPnP::SSDP
     @timeout = TIMEOUT
     @ttl = TTL
 
+    @log = nil
+
     @listener = nil
     @queue = Queue.new
+
+    @search_thread = nil
+    @notify_thread = nil
+  end
+
+  ##
+  # Listens for M-SEARCH requests and advertises the requested services
+
+  def advertise(root_device, port, hosts)
+    @socket ||= new_socket
+
+    @notify_thread = Thread.start do
+      loop do
+        hosts.each do |host|
+          uri = "http://#{host}:#{port}/description"
+
+          send_notify uri, 'upnp:rootdevice', root_device
+
+          root_device.devices.each do |d|
+            send_notify uri, d.name, d
+            send_notify uri, d.type_urn, d
+          end
+
+          root_device.services.each do |s|
+            send_notify uri, s.type_urn, s
+          end
+        end
+
+        sleep 60
+      end
+    end
+
+    listen
+
+    @search_thread = Thread.start do
+      loop do
+        search = @queue.pop
+
+        break if search == :shutdown
+
+        next unless Search === search
+
+        case search.target
+        when /^#{UPnP::DEVICE_SCHEMA_PREFIX}/ then
+          devices = root_device.devices.select do |d|
+            d.type_urn == search.target
+          end
+
+          devices.each do |d|
+            hosts.each do |host|
+              uri = "http://#{host}:#{port}/description"
+              send_response uri, search.target, "#{d.name}::#{search.target}", d
+            end
+          end
+        when 'upnp:rootdevice' then
+          hosts.each do |host|
+            uri = "http://#{host}:#{port}/description"
+            send_response uri, search.target, search.target, root_device
+          end
+        else
+          warn "Unhandled target #{search.target}"
+        end
+      end
+    end
+
+    sleep
+
+  ensure
+    @queue.push :shutdown
+    stop_listening
+    @notify_thread.kill
+
+    @socket.close if @socket and not @socket.closed?
+    @socket = nil
+  end
+
+  def byebye(root_device, hosts)
+    @socket ||= new_socket
+
+    hosts.each do |host|
+      send_notify_byebye 'upnp:rootdevice', root_device
+
+      root_device.devices.each do |d|
+        send_notify_byebye d.name, d
+        send_notify_byebye d.type_urn, d
+      end
+
+      root_device.services.each do |s|
+        send_notify_byebye s.type_urn, s
+      end
+    end
   end
 
   ##
@@ -348,14 +498,7 @@ class UPnP::SSDP
   # notifications received in that time.
 
   def discover
-    membership = IPAddr.new(@broadcast).hton + IPAddr.new('0.0.0.0').hton
-
-    @socket ||= UDPSocket.new
-
-    @socket.setsockopt Socket::IPPROTO_IP, Socket::IP_TTL, [@ttl].pack('i')
-    @socket.setsockopt Socket::IPPROTO_IP, Socket::IP_ADD_MEMBERSHIP, membership
-
-    @socket.bind Socket::INADDR_ANY, @port
+    @socket ||= new_socket
 
     listen
 
@@ -387,20 +530,57 @@ class UPnP::SSDP
 
     @listener = Thread.start do
       loop do
-        response = @socket.recvfrom(1024).first
+        response, (family, port, hostname, address) = @socket.recvfrom 1024
 
         begin
-          @queue << parse(response)
+          adv = parse response
+
+          info = case adv
+          when Notification then adv.type
+          when Response     then adv.target
+          when Search       then adv.target
+          else                   'unknown'
+          end
+
+          response =~ /\A(\S+)/
+          log :debug, "SSDP recv #{$1} #{hostname}:#{port} #{info}"
+
+          @queue << adv
         rescue
-          puts $!.message
-          puts $!.backtrace
+          warn $!.message
+          warn $!.backtrace
         end
       end
     end
   end
 
+  def log(level, message)
+    return unless @log
+
+    @log.send level, message
+  end
+
+  ##
+  # Sets up a UDPSocket for multicast send and receive
+
+  def new_socket
+    membership = IPAddr.new(@broadcast).hton + IPAddr.new('0.0.0.0').hton
+    ttl = [@ttl].pack 'i'
+
+    socket = UDPSocket.new
+
+    socket.setsockopt Socket::IPPROTO_IP, Socket::IP_ADD_MEMBERSHIP, membership
+    socket.setsockopt Socket::IPPROTO_IP, Socket::IP_MULTICAST_LOOP, "\000"
+    socket.setsockopt Socket::IPPROTO_IP, Socket::IP_MULTICAST_TTL, ttl
+    socket.setsockopt Socket::IPPROTO_IP, Socket::IP_TTL, ttl
+
+    socket.bind '0.0.0.0', @port
+
+    socket
+  end
+
   ##
-  # Returns a Notification or Response created from +response+.
+  # Returns a Notification, Response or Search created from +response+.
 
   def parse(response)
     case response
@@ -408,13 +588,15 @@ class UPnP::SSDP
       Notification.parse response
     when /\AHTTP/ then
       Response.parse response
+    when /\AM-SEARCH/ then
+      Search.parse response
     else
       raise Error, "Unknown response #{response[/\A.*$/]}"
     end
   end
 
   ##
-  # Broadcasts M-SEARCH requests looking for +targets+.  Waits timeout seconds
+  # Sends M-SEARCH requests looking for +targets+.  Waits timeout seconds
   # for responses then returns the collected responses.
   #
   # Supply no arguments to search for all devices and services.
@@ -432,9 +614,7 @@ class UPnP::SSDP
   # Supply <tt>"urn:..."</tt> to search for a URN.
 
   def search(*targets)
-    @socket ||= UDPSocket.new
-
-    @socket.setsockopt Socket::IPPROTO_IP, Socket::IP_TTL, [@ttl].pack('i')
+    @socket ||= new_socket
 
     if targets.empty? then
       send_search 'ssdp:all'
@@ -466,20 +646,103 @@ class UPnP::SSDP
     @socket = nil
   end
 
+  ##
+  # Builds and sends a NOTIFY message
+
+  def send_notify(uri, type, obj)
+    if type =~ /^uuid:/ then
+      name = obj.name
+    else
+      # HACK maybe this should be .device?
+      name = "#{obj.root_device.name}::#{type}"
+    end
+
+    server_info = "Ruby UPnP/#{UPnP::VERSION}"
+    device_info = "#{obj.root_device.class}/#{obj.root_device.version}"
+
+    http_notify = <<-HTTP_NOTIFY
+NOTIFY * HTTP/1.1\r
+HOST: #{@broadcast}:#{@port}\r
+CACHE-CONTROL: max-age=120\r
+LOCATION: #{uri}\r
+NT: #{type}\r
+NTS: ssdp:alive\r
+SERVER: #{server_info} UPnP/1.0 #{device_info}\r
+USN: #{name}\r
+\r
+    HTTP_NOTIFY
+
+    log :debug, "SSDP sent NOTIFY #{type}"
+
+    @socket.send http_notify, 0, @broadcast, @port
+  end
+
+  ##
+  # Builds and sends a byebye NOTIFY message
+
+  def send_notify_byebye(type, obj)
+    if type =~ /^uuid:/ then
+      name = obj.name
+    else
+      # HACK maybe this should be .device?
+      name = "#{obj.root_device.name}::#{type}"
+    end
+
+    http_notify = <<-HTTP_NOTIFY
+NOTIFY * HTTP/1.1\r
+HOST: #{@broadcast}:#{@port}\r
+NT: #{type}\r
+NTS: ssdp:byebye\r
+USN: #{name}\r
+\r
+    HTTP_NOTIFY
+
+    log :debug, "SSDP sent byebye #{type}"
+
+    @socket.send http_notify, 0, @broadcast, @port
+  end
+
+  ##
+  # Builds and sends a response to an M-SEARCH request"
+
+  def send_response(uri, type, name, device)
+    server_info = "Ruby UPnP/#{UPnP::VERSION}"
+    device_info = "#{device.root_device.class}/#{device.root_device.version}"
+
+    http_response = <<-HTTP_RESPONSE
+HTTP/1.1 200 OK\r
+CACHE-CONTROL: max-age=120\r
+EXT:\r
+LOCATION: #{uri}\r
+SERVER: #{server_info} UPnP/1.0 #{device_info}\r
+ST: #{type}\r
+NTS: ssdp:alive\r
+USN: #{name}\r
+Content-Length: 0\r
+\r
+    HTTP_RESPONSE
+
+    log :debug, "SSDP sent M-SEARCH OK #{type}"
+
+    @socket.send http_response, 0, @broadcast, @port
+  end
+
   ##
   # Builds and sends an M-SEARCH request looking for +search_target+.
 
   def send_search(search_target)
-    http_request = <<HTTP_REQUEST
+    search = <<-HTTP_REQUEST
 M-SEARCH * HTTP/1.1\r
 HOST: #{@broadcast}:#{@port}\r
 MAN: "ssdp:discover"\r
 MX: #{@timeout}\r
 ST: #{search_target}\r
 \r
-HTTP_REQUEST
+    HTTP_REQUEST
+
+    log :debug, "SSDP sent M-SEARCH #{search_target}"
 
-    @socket.send http_request, 0, @broadcast, @port
+    @socket.send search, 0, @broadcast, @port
   end
 
   ##