UPnP-ContentDirectory 1.0

data.tar.gz.sig

@@ -0,0 +1,4 @@
+�D>�5������~�T�S�|�D�'��)�����B�f��b�ʕ�~�bt�������9B�x#d��-�{#9�T�~�3�C���r�"Dϔ��*��
+MŰld�Y�q)��g�L��
+�~1����ʒ=B�Ca&O���V^,'����!�3���h'�}�j��\��0�;���M±��>���!!����s0Lۚ���j�ۤ�D��!٥-)@�zor��7��g��_F�w�x�B�t��
+�w�oJ�Fl�*N

data/History.txt

@@ -0,0 +1,5 @@
+=== 1.0.0 / 2008-07-23
+
+* 1 major enhancement
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,5 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/UPnP/service/content_directory.rb

data/README.txt

@@ -0,0 +1,83 @@
+= UPnP-ContentDirectory
+
+* http://seattlerb.org/UPnP-ContentDirectory
+* http://upnp.org
+* Bugs: http://rubyforge.org/tracker/?func=add&group_id=1513&atid=5921
+
+== DESCRIPTION:
+
+A UPnP ContentDirectory service with some DLNA extensions.  Currently this is
+a work in progress, and is only adequate for viewing images on a PlayStation
+3.
+
+== FEATURES/PROBLEMS:
+
+* Only direct filesystem representations currently supported
+* Largely undocumented
+* Only tested on PlayStation 3
+* Only images known to work
+* Partially implemented:
+  * Browse
+  * GetSystemUpdateID
+* Not implemented:
+  * CreateObject
+  * CreateReference
+  * DeleteResource
+  * DestroyObject
+  * ExportResource
+  * GetSearchCapabilities
+  * GetSortCapabilities
+  * GetTransferProgress
+  * ImportResource
+  * Search
+  * StopTransferResource
+  * UpdateObject
+
+== SYNOPSIS:
+
+In a UPnP::Device::create block:
+
+  your_device.add_service 'ContentDirectory' do |cd|
+    cd.add_directory Dir.pwd
+  end
+
+See UPnP::Device::MediaServer for an example of usage.
+
+== REQUIREMENTS:
+
+* A filesystem with files on it
+* A UPnP control point
+
+== INSTALL:
+
+  sudo gem install UPnP-ContentDirectory
+
+== LICENSE:
+
+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
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+3. Neither the names of the authors nor the names of their contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
+OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/Rakefile

@@ -0,0 +1,14 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/UPnP/service/content_directory'
+
+Hoe.new 'UPnP-ContentDirectory', UPnP::Service::ContentDirectory::VERSION do |p|
+  p.rubyforge_name = 'seattlerb'
+  p.developer 'Eric Hodel', 'drbrain@segment7.net'
+
+  p.extra_deps << ['UPnP', '>= 1.1.0']
+end
+
+# vim: syntax=Ruby

data/lib/UPnP/service/content_directory.rb

@@ -0,0 +1,401 @@
+require 'open3'
+require 'uri'
+
+require 'rubygems'
+require 'UPnP/service'
+
+##
+# A UPnP ContentDirectory service.  See upnp.org for specifications.
+
+class UPnP::Service::ContentDirectory < UPnP::Service
+
+  VERSION = '1.0'
+
+  ##
+  # Returns the searching capabilities supported by the device
+
+  add_action 'GetSearchCapabilities',
+    [OUT, 'SearchCaps', 'SearchCapabilities']
+
+  ##
+  # Returns the CSV list of metadata tags that can be used in sortCriteria
+
+  add_action 'GetSortCapabilities',
+    [OUT, 'SortCaps', 'SortCapabilities']
+
+  add_action 'GetSystemUpdateID',
+    [OUT, 'Id', 'SystemUpdateID']
+
+  add_action 'Browse',
+    [IN, 'ObjectID',       'A_ARG_TYPE_ObjectID'],
+    [IN, 'BrowseFlag',     'A_ARG_TYPE_BrowseFlag'],
+    [IN, 'Filter',         'A_ARG_TYPE_Filter'],
+    [IN, 'StartingIndex',  'A_ARG_TYPE_Index'],
+    [IN, 'RequestedCount', 'A_ARG_TYPE_Count'],
+    [IN, 'SortCriteria',   'A_ARG_TYPE_SortCriteria'],
+
+    [OUT, 'Result',         'A_ARG_TYPE_Result'],
+    [OUT, 'NumberReturned', 'A_ARG_TYPE_Count'],
+    [OUT, 'TotalMatches',   'A_ARG_TYPE_Count'],
+    [OUT, 'UpdateID',       'A_ARG_TYPE_UpdateID']
+
+  # optional actions
+
+  add_action 'Search',
+    [IN, 'ContainerID', 'A_ARG_TYPE_ObjectID'],
+    [IN, 'SearchCriteria', 'A_ARG_TYPE_SearchCriteria'],
+    [IN, 'Filter', 'A_ARG_TYPE_Filter'],
+    [IN, 'StartingIndex', 'A_ARG_TYPE_Index'],
+    [IN, 'RequestedCount', 'A_ARG_TYPE_Count'],
+    [IN, 'SortCriteria', 'A_ARG_TYPE_SortCriteria'],
+
+    [OUT, 'Result', 'A_ARG_TYPE_Result'],
+    [OUT, 'NumberReturned', 'A_ARG_TYPE_Count'],
+    [OUT, 'TotalMatches', 'A_ARG_TYPE_Count'],
+    [OUT, 'UpdateID', 'A_ARG_TYPE_UpdateID']
+
+  add_action 'CreateObject',
+    [IN, 'ContainerID', 'A_ARG_TYPE_ObjectID'],
+    [IN, 'Elements', 'A_ARG_TYPE_Result'],
+
+    [OUT, 'ObjectID', 'A_ARG_TYPE_ObjectID'],
+    [OUT, 'Result', 'A_ARG_TYPE_Result']
+
+  add_action 'DestroyObject',
+    [IN, 'ObjectID', 'A_ARG_TYPE_ObjectID']
+
+  add_action 'UpdateObject',
+    [IN, 'ObjectID', 'A_ARG_TYPE_ObjectID'],
+    [IN, 'CurrentTagValue', 'A_ARG_TYPE_TagValueList'],
+    [IN, 'NewTagValue', 'A_ARG_TYPE_TagValueList']
+
+  add_action 'ImportResource',
+    [IN, 'SourceURI', 'A_ARG_TYPE_URI'],
+    [IN, 'DestinationURI', 'A_ARG_TYPE_URI'],
+
+    [OUT, 'TransferID', 'A_ARG_TYPE_TransferID']
+
+  add_action 'ExportResource',
+    [IN, 'SourceURI', 'A_ARG_TYPE_URI'],
+    [IN, 'DestinationURI', 'A_ARG_TYPE_URI'],
+
+    [OUT, 'TransferID', 'A_ARG_TYPE_TransferID']
+
+  add_action 'StopTransferResource',
+    [IN, 'TransferID', 'A_ARG_TYPE_TransferID']
+
+  add_action 'GetTransferProgress',
+    [IN, 'TransferID', 'A_ARG_TYPE_TransferID'],
+
+    [OUT, 'TransferStatus', 'A_ARG_TYPE_TransferStatus'],
+    [OUT, 'TransferLength', 'A_ARG_TYPE_TransferLength'],
+    [OUT, 'TransferTotal', 'A_ARG_TYPE_TransferTotal']
+
+  add_action 'DeleteResource',
+    [IN, 'ResourceURI', 'A_ARG_TYPE_URI']
+
+  add_action 'CreateReference',
+    [IN, 'ContainerID', 'A_ARG_TYPE_ObjectID'],
+    [IN, 'ObjectID', 'A_ARG_TYPE_ObjectID'],
+    [OUT, 'NewID', 'A_ARG_TYPE_ObjectID']
+
+  add_variable 'TransferIDs',               'string', nil, nil, true
+  add_variable 'A_ARG_TYPE_ObjectID',       'string'
+  add_variable 'A_ARG_TYPE_Result',         'string' # 2.5.4 - DIDL-Lite
+  add_variable 'A_ARG_TYPE_SearchCriteria', 'string' # 2.5.5
+  add_variable 'A_ARG_TYPE_BrowseFlag',     'string',
+               %w[BrowseMetadata BrowseDirectChildren]
+  add_variable 'A_ARG_TYPE_Filter',         'string' # 2.5.7
+  add_variable 'A_ARG_TYPE_SortCriteria',   'string' # 2.5.8
+  add_variable 'A_ARG_TYPE_Index',          'ui4'    # 2.5.9
+  add_variable 'A_ARG_TYPE_Count',          'ui4'    # 2.5.10
+  add_variable 'A_ARG_TYPE_UpdateID',       'ui4'    # 2.5.11
+  add_variable 'A_ARG_Type_TransferID',     'ui4'    # 2.5.12
+  add_variable 'A_ARG_Type_TransferStatus', 'string' # 2.5.13
+  add_variable 'A_ARG_Type_TransferLength', 'string' # 2.5.14
+  add_variable 'A_ARG_Type_TransferTotal',  'string' # 2.5.15
+  add_variable 'A_ARG_TYPE_TagValueList',   'string' # 2.5.16
+  add_variable 'A_ARG_TYPE_URI',            'uri'    # 2.5.17
+  add_variable 'SearchCapabilities',        'string' # 2.5.18
+  add_variable 'SortCapabilities',          'string' # 2.5.19
+  add_variable 'SystemUpdateID',            'ui4',    nil, nil, true # 2.5.20
+  add_variable 'ContainerUpdateIDs',        'string', nil, nil, true # 2.5.21
+
+  def initialize(*args)
+    @directories = []
+
+    super
+  end
+
+  def on_init
+    @SystemUpdateID = 0
+
+    @object_count = 0
+    @objects = {}
+    @parents = {}
+
+    add_object 'root', -1
+    WEBrick::HTTPUtils::DefaultMimeTypes['mp3'] = 'audio/mpeg'
+  end
+
+  # :section: ContentServer implementation
+
+  ##
+  # Allows the caller to incrementally browse the hierarchy of the content
+  # directory, including information listing the classes of objects available
+  # in any container.
+
+  def Browse(object_id, browse_flag, filter, starting_index, requested_count,
+             sort_criteria)
+    filter = filter.split ','
+    object_id = object_id.to_i
+    update_id = 0
+
+    case browse_flag
+    when 'BrowseMetadata' then
+      number_returned = 1
+      total_matches = 1
+
+      result = metadata_result object_id
+    when 'BrowseDirectChildren' then
+      number_returned, total_matches, result = children_result object_id
+    else
+      raise "unknown BrowseFlag #{browse_flag}"
+    end
+
+    [nil, result, number_returned, total_matches, update_id]
+  end
+
+  ##
+  # Returns the current value of the SystemUpdateID state variable.  For use
+  # by clients that want to poll for any changes in the content directory
+  # instead of subscribing to events.
+
+  def GetSystemUpdateID
+    [nil, @SystemUpdateID]
+  end
+
+  # :section: Support implementation
+
+  ##
+  # Adds object +name+ to the directory tree under +parent+
+
+  def add_object(name, parent)
+    object_id = @object_count
+    @object_count += 1
+
+    @objects[object_id] = name
+    @objects[name] = object_id
+
+    @parents[object_id] = parent
+
+    object_id
+  end
+
+  ##
+  # Adds +directory+ as a path searched by the content server
+
+  def add_directory(directory)
+    return self if @directories.include? directory
+
+    add_object directory, 0
+    @directories << directory
+
+    self
+  end
+
+  def children_result(object_id)
+    object = get_object object_id
+
+    children = if object_id == 0 then
+                 @directories
+               else
+                 Dir[File.join(object, '*')]
+               end
+
+    result = make_result do |xml|
+      children.each do |child|
+        child_id = get_object child, object_id
+
+        result_object xml, child, child_id, File.basename(child)
+      end
+    end
+
+    [children.length, children.length, result]
+  end
+
+  def get_object(name, parent_id = nil)
+    if @objects.key? name then
+      @objects[name]
+    elsif parent_id.nil? then
+      raise Error, "object #{name} does not exist"
+    else
+      add_object name, parent_id
+    end
+  end
+
+  def get_parent(object_id)
+    if @parents.key? object_id then
+      @parents[object_id]
+    else
+      raise Error, "invalid object id #{object_id}"
+    end
+  end
+
+  def item_class(mime_type)
+    case mime_type
+    when /^image/ then
+      'object.item.imageItem'
+    when /^audio/ then
+      'object.item.audioItem'
+    else
+      puts "unhandled mime type #{mime_type}"
+      'object.item'
+    end
+  end
+
+  def make_result
+    result = []
+
+    xml = Builder::XmlMarkup.new :indent => 2, :target => result
+    xml.tag! 'DIDL-Lite',
+             'xmlns' => 'urn:schemas-upnp-org:metadata-1-0/DIDL-Lite/',
+             'xmlns:dc' => 'http://purl.org/dc/elements/1.1/',
+             'xmlns:upnp' => 'urn:schemas-upnp-org:metadata-1-0/upnp/' do
+      yield xml
+    end
+
+    result.join
+  end
+
+  def metadata_result(object_id)
+    object = get_object object_id
+    parent = get_parent object_id
+
+    title = File.basename object
+
+    make_result do |xml|
+      result_object xml, object, object_id, title
+    end
+  end
+
+  def mount_extra(http_server)
+    super
+
+    @directories.each do |root|
+      root_id = get_object root
+      path = File.join service_path, root_id.to_s
+
+      http_server.mount path, WEBrick::HTTPServlet::FileHandler, root
+    end
+  end
+
+  def resource(xml, object, mime_type, stat)
+    info = nil
+    url = nil
+
+    case mime_type
+    when /^audio\/(.*)/ then
+      pn = case $1
+           when 'mpeg' then
+             'MP3'
+           end
+
+      pn = "DLNA.ORG_PN=#{pn}"
+
+      additional = [pn, 'DLNA.ORG_OP=01', 'DLNA.ORG_CI=0'].compact.join ';'
+
+      info = ['http-get', '*', mime_type, additional]
+    when /^image\/(.*)/ then
+      pn = case $1
+           when 'jpeg' then
+             'JPEG_LRG'
+           end
+
+      pn = "DLNA.ORG_PN=#{pn}"
+
+      additional = [pn, 'DLNA.ORG_OP=01', 'DLNA.ORG_CI=0'].compact.join ';'
+
+      info = ['http-get', '*', mime_type, additional]
+    end
+
+    if info then
+      url = resource_url object
+
+      attributes = {
+        :protocolInfo => info.join(':'),
+        :size => stat.size,
+      }
+
+      xml.res attributes, URI.escape(url)
+    end
+  end
+
+  ##
+  # A URL to this object on this server.  Correctly handles multi-homed
+  # servers.
+
+  def resource_url(object)
+    _, port, host, addr = Thread.current[:WEBrickSocket].addr
+
+    root = root_for object
+    root_id = get_object root
+
+    object = object.sub root, ''
+
+    File.join "http://#{addr}:#{port}", service_path, root_id.to_s, object
+  end
+
+  def result_object(xml, object, object_id, title)
+    if object_id == 0 then
+      result_container xml, object, object_id, @directories.length, title
+    elsif File.directory? object then
+      children = Dir[File.join(object, '*/')].length
+
+      result_container xml, object, object_id, children, title
+    else
+      result_item xml, object, object_id, title
+    end
+  end
+
+  def result_container(xml, object, object_id, children, title)
+    xml.tag! 'container', :id => object_id, :parentID => get_parent(object_id),
+                   :restricted => true, :childCount => children do
+      xml.dc :title, title
+      xml.upnp :class, 'object.container'
+    end
+  end
+
+  def result_item(xml, object, object_id, title)
+    inn, out, = Open3.popen3('file', '-bI', object)
+    inn.close
+
+    mime_type = out.read.strip
+
+    stat = File.stat object
+
+    xml.tag! 'item', :id => object_id, :parentID => get_parent(object_id),
+             :restricted => true, :childCount => 0 do
+      xml.dc :title, title
+      xml.dc :date, stat.ctime.iso8601
+      xml.upnp :class, item_class(mime_type)
+
+      resource xml, object, mime_type, stat
+    end
+  end
+
+  ##
+  # Returns the root for +object_id+
+
+  def root_for(object_id)
+    object_id = get_object object_id unless Integer === object_id
+
+    while (parent_id = get_parent(object_id)) != 0 do
+      object_id = parent_id
+    end
+
+    get_object object_id
+  end
+
+end
+

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: UPnP-ContentDirectory
+version: !ruby/object:Gem::Version 
+  version: "1.0"
+platform: ruby
+authors: 
+- Eric Hodel
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDNjCCAh6gAwIBAgIBADANBgkqhkiG9w0BAQUFADBBMRAwDgYDVQQDDAdkcmJy
+  YWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZFgNu
+  ZXQwHhcNMDcxMjIxMDIwNDE0WhcNMDgxMjIwMDIwNDE0WjBBMRAwDgYDVQQDDAdk
+  cmJyYWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZ
+  FgNuZXQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCbbgLrGLGIDE76
+  LV/cvxdEzCuYuS3oG9PrSZnuDweySUfdp/so0cDq+j8bqy6OzZSw07gdjwFMSd6J
+  U5ddZCVywn5nnAQ+Ui7jMW54CYt5/H6f2US6U0hQOjJR6cpfiymgxGdfyTiVcvTm
+  Gj/okWrQl0NjYOYBpDi+9PPmaH2RmLJu0dB/NylsDnW5j6yN1BEI8MfJRR+HRKZY
+  mUtgzBwF1V4KIZQ8EuL6I/nHVu07i6IkrpAgxpXUfdJQJi0oZAqXurAV3yTxkFwd
+  g62YrrW26mDe+pZBzR6bpLE+PmXCzz7UxUq3AE0gPHbiMXie3EFE0oxnsU3lIduh
+  sCANiQ8BAgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
+  BBS5k4Z75VSpdM0AclG2UvzFA/VW5DANBgkqhkiG9w0BAQUFAAOCAQEAHagT4lfX
+  kP/hDaiwGct7XPuVGbrOsKRVD59FF5kETBxEc9UQ1clKWngf8JoVuEoKD774dW19
+  bU0GOVWO+J6FMmT/Cp7nuFJ79egMf/gy4gfUfQMuvfcr6DvZUPIs9P/TlK59iMYF
+  DIOQ3DxdF3rMzztNUCizN4taVscEsjCcgW6WkUJnGdqlu3OHWpQxZBJkBTjPCoc6
+  UW6on70SFPmAy/5Cq0OJNGEWBfgD9q7rrs/X8GGwUWqXb85RXnUVi/P8Up75E0ag
+  14jEc90kN+C7oI/AGCBN0j6JnEtYIEJZibjjDJTSMWlUKKkj30kq7hlUC2CepJ4v
+  x52qPcexcYZR7w==
+  -----END CERTIFICATE-----
+
+date: 2008-07-23 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: UPnP
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.0
+    version: 
+description: A UPnP ContentDirectory service with some DLNA extensions.  Currently this is a work in progress, and is only adequate for viewing images on a PlayStation 3.
+email: 
+- drbrain@segment7.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/UPnP/service/content_directory.rb
+has_rdoc: true
+homepage: http://seattlerb.org/UPnP-ContentDirectory
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: seattlerb
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A UPnP ContentDirectory service with some DLNA extensions
+test_files: []
+

metadata.gz.sig

@@ -0,0 +1,4 @@
+Κ�����h.�H?ؠ+�Q�3�x��!��he�.�рNY@@3��~ؑ�ł����d"6̈�*o�
+��j��+��@G�4�a4"���K�ŽVц�yQ�N�PC�Ľ*�i,w��.~�mѡȡ�4��@*�����a�Z$�y̱�����x��ʼn5c�;�����;X����&�E��V�~T����6^u����{֢�����
+
+淅w:N��q��w��X|b�}���3ya�n�K�N�AH��L�kN�d