tivohmo 0.1.0

data/lib/tivohmo/beacon.rb

@@ -0,0 +1,69 @@
+require 'socket'
+
+module TivoHMO
+
+  # Provides a mechanism for broadcasting the presence of a
+  # TivoHMO::Server to Tivo dvrs on the local network
+  class Beacon
+    include GemLogger::LoggerSupport
+
+    def initialize(service_port, limit: -1, interval: 60)
+      @interval = interval
+      @limit = limit
+      @uid = SecureRandom.uuid
+      @socket = UDPSocket.new(Socket::AF_INET)
+      @socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_BROADCAST, true)
+      @services = ['TiVoMediaServer:%s/http' % service_port]
+      @running = false
+    end
+
+    def start
+      if ! @running
+        logger.info "Starting beacon(limit=#@limit, interval=#@interval) for #{@services.inspect}"
+        @running = true
+        @broadcast_thread = Thread.new do
+          while @running
+            broadcast
+            sleep(@interval)
+            @limit = @limit - 1
+            break if @limit == 0
+          end
+          @running = false
+          logger.info "Beacon thread exiting"
+        end
+      end
+    end
+
+    def stop
+      logger.info "Stopping beacon"
+      @running = false
+    end
+
+    def join
+      @broadcast_thread.join
+    end
+
+    def beacon_data(method)
+      payload = {
+          tivoconnect: 1,
+          method: method,
+          identity: "{#{@uid}}",
+          machine: Socket.gethostname,
+          platform: 'pc/tivohmo',
+          services: @services.join(';'),
+          swversion: TivoHMO::VERSION
+      }
+      data = payload.collect {|k,v| "#{k}=#{v}" }.join("\n") << "\n"
+      data
+    end
+
+    def broadcast
+      bcast_ip = '<broadcast>' #'255.255.255.255'
+      bcast_port = 2190
+      packet = beacon_data('broadcast')
+      logger.debug "Sending beacon packet: #{packet}"
+      @socket.send(packet, 0, bcast_ip, bcast_port)
+    end
+
+  end
+end

data/lib/tivohmo/cli.rb

@@ -0,0 +1,182 @@
+require 'clamp'
+require 'yaml'
+require 'active_support/core_ext/string'
+require 'sigdump/setup'
+require 'tivohmo'
+require 'open-uri'
+
+module TivoHMO
+
+  # The command line interface to tivohmo
+  class CLI < Clamp::Command
+    include GemLogger::LoggerSupport
+
+    def self.description
+      desc = <<-DESC
+        Runs a HMO server.  Specify one or more applications to show up as top level
+        shares in the TiVo Now Playing view.  The application, identifier,
+        transcoder, metadata options can be given in groups to apply the transcoder
+        and metadata to each application - uses the application's default if not given
+
+        e.g.
+
+        tivohmo -a TivoHMO::Adapters::Filesystem::Application -i ~/Video/Movies \\
+                -a TivoHMO::Adapters::Filesystem::Application -i ~/Video/TV
+
+        to run two top level filesystem video serving apps for different dirs,
+        or
+
+        tivohmo -a TivoHMO::Adapters::Filesystem::Application -t Vids -i ~/Video
+
+        to run the single filesystem app with a custom title
+      DESC
+      desc.split("\n").collect(&:strip).join("\n")
+    end
+
+    option ["-d", "--debug"],
+           :flag, "debug output\n",
+           default: false
+
+    option ["-r", "--preload"],
+           :flag, "Preloads all lazy container listings\n",
+           default: false
+
+    option ["-l", "--logfile"],
+           "FILE", "log to given file\n"
+
+    option ["-p", "--port"],
+           "PORT", "run server using PORT\n",
+           default: 9032 do |s|
+      Integer(s)
+    end
+
+    option ["-f", "--configuration"],
+           "FILE", "load configuration from given filename\n"
+
+    option ["-a", "--application"],
+           "CLASSNAME", "use the given application class\n",
+           multivalued: true
+
+    option ["-i", "--identifier"],
+           "IDENTIFIER", "use the given application identifier\n" +
+           "a string that has meaning to the application\n",
+           multivalued: true
+
+    option ["-t", "--title"],
+           "TITLE", "use the given title for the application\n",
+           multivalued: true
+
+    option ["-T", "--transcoder"],
+           "CLASSNAME", "override the application's transcoder class\n",
+           multivalued: true
+
+    option ["-M", "--metadata"],
+           "CLASSNAME", "override the application's metadata class\n",
+           multivalued: true
+
+    option ["-b", "--beacon"],
+           "LIMIT:INTERVAL", "configure beacon limit and/or interval\n"
+
+    def execute
+      setup_logging
+
+      if configuration
+        config = YAML.load_file(configuration)
+
+        # allow cli option to override config file
+        set_if_default(:port, config['port'].to_i)
+      end
+
+      signal_usage_error "at least one application is required" unless application_list.present?
+      signal_usage_error "an initializer is needed for each application" unless
+          application_list.size == identifier_list.size
+
+      (application_list + transcoder_list + metadata_list).each do |c|
+        if c && c.starts_with?('TivoHMO::Adapters::')
+          path = c.downcase.split('::')[0..-2].join('/')
+          require path
+        end
+      end
+
+      server = TivoHMO::API::Server.new
+
+      apps_with_config = application_list.zip(identifier_list,
+                                              title_list,
+                                              transcoder_list,
+                                              metadata_list)
+
+      apps_with_config.each do |app_classname, identifier, title, transcoder, metadata|
+        app_class = app_classname.constantize
+        app = app_class.new(identifier)
+
+        if title
+          app.title = title
+        else
+          app.title = "#{app.title} on #{server.title}"
+        end
+
+        app.transcoder_class = transcoder.constantize if transcoder
+        app.metadata_class = metadata.constantize if metadata
+        server.add_child(app)
+      end
+
+      preload_containers(server) if preload?
+
+      opts = {}
+      if beacon.present?
+        limit, interval = beacon.split(":")
+        opts[:limit] = limit.to_i if limit.present?
+        opts[:interval] = interval.to_i if interval.present?
+      end
+      notifier = TivoHMO::Beacon.new(port, **opts)
+
+      TivoHMO::Server.start(server, port) do |s|
+        wait_for_server { notifier.start }
+      end
+    end
+
+    private
+
+    def setup_logging
+      Logging.logger.root.level = :debug if debug?
+
+      if logfile.present?
+        Logging.logger.root.appenders = Logging.appenders.file(
+            logfile,
+            layout: Logging.layouts.pattern(
+                pattern: Logging.appenders.stdout.layout.pattern
+            )
+        )
+      end
+    end
+
+    def set_if_default(attr, new_value)
+      self.send("#{attr}=", new_value) if self.send(attr) == self.send("default_#{attr}")
+    end
+
+    def preload_containers(server)
+      logger.info "Preloading lazily cached containers"
+      queue = server.children.dup
+      queue.each do |i|
+        logger.debug("Loading children for #{i.title_path}")
+        queue.concat(i.children)
+      end
+      logger.info "Preload complete"
+    end
+
+    def wait_for_server
+      Thread.new do
+        while true
+          begin
+            open("http://localhost:#{port}/TiVoConnect?Command=QueryServer") {}
+            yield
+            break
+          rescue Exception => e
+          end
+        end
+      end
+    end
+
+  end
+
+end

data/lib/tivohmo/logging.rb

@@ -0,0 +1,50 @@
+require 'gem_logger'
+require 'logging'
+require 'active_support/concern'
+
+Logging.format_as :inspect
+Logging.backtrace true
+
+Logging.color_scheme(
+    'bright',
+    levels: {
+        info: :green,
+        warn: :yellow,
+        error: :red,
+        fatal: [:white, :on_red]
+    },
+    date: :blue,
+    logger: :cyan,
+    message: :magenta
+)
+
+Logging.appenders.stdout(
+    'stdout',
+    layout: Logging.layouts.pattern(
+        pattern: '[%d] %-5l %c{2} %m\n',
+        color_scheme: 'bright'
+    )
+)
+
+Logging.logger.root.appenders = Logging.appenders.stdout
+Logging.logger.root.level = :info
+
+module TivoHMO
+  module LoggingConcern
+    extend ActiveSupport::Concern
+
+    def logger
+      Logging.logger[self.class]
+    end
+
+    module ClassMethods
+      def logger
+        Logging.logger[self]
+      end
+    end
+
+  end
+end
+
+GemLogger.default_logger = Logging.logger.root
+GemLogger.logger_concern = TivoHMO::LoggingConcern

data/lib/tivohmo/server/views/_container.builder

@@ -0,0 +1,19 @@
+xml.Item do
+
+  xml.Details do
+    xml.Title container.title
+    xml.ContentType container.content_type
+    xml.SourceFormat container.source_format
+    xml.UniqueId format_uuid(container.uuid)
+    xml.TotalItems container.children.size
+    xml.LastCaptureDate format_date(container.created_at) if container.created_at
+  end
+
+  xml.Links do
+    xml.Content do
+      xml.Url container_url(container)
+      xml.ContentType "x-tivo-container/folder"
+    end
+  end
+
+end

data/lib/tivohmo/server/views/_item.builder

@@ -0,0 +1,57 @@
+xml.Item do
+
+  md = item.metadata
+
+  xml.Details do
+    xml.Title item.title
+    xml.ContentType item.content_type
+    xml.SourceFormat item.source_format
+
+    if md
+      xml.SourceSize md.source_size if md.source_size
+      xml.Duration md.duration.to_i if md.duration
+      xml.Description md.description if md.description
+
+      xml.SourceChannel md.channel[:major_number] if md.channel
+      xml.SourceStation md.channel[:callsign] if md.channel
+
+      xml.SeriesId md.series_id
+      xml.ShowingBits md.showing_bits if md.showing_bits
+      # xml.CopyProtected 'Yes' if md.valid?
+
+      xml.EpisodeTitle md.episode_title if md.is_episode && md.episode_title
+      xml.EpisodeNumber md.episode_number if md.episode_number
+
+      xml.ProgramId md.program_id if md.program_id
+
+      xml.TvRating md.tv_rating[:name] if md.tv_rating
+      xml.MpaaRating md.mpaa_rating[:name] if md.mpaa_rating
+    end
+
+    xml.CaptureDate format_date(item.created_at) if item.created_at
+
+  end
+
+  xml.Links do
+    xml.Content do
+      xml.ContentType item.content_type
+      xml.Url item_url(item)
+    end
+
+    xml.CustomIcon do
+      xml.ContentType "image/*"
+      xml.AcceptsParams "No"
+      xml.Url "urn:tivo:image:save-until-i-delete-recording"
+    end
+
+    if md
+      xml.TiVoVideoDetails do
+        xml.ContentType "text/xml"
+        xml.AcceptsParams "No"
+        xml.Url item_detail_url(item)
+      end
+    end
+
+  end
+
+end

data/lib/tivohmo/server/views/container.builder

@@ -0,0 +1,26 @@
+xml.TiVoContainer do
+
+  paginated_children = children[item_start, item_count]
+
+  xml.ItemStart item_start
+  xml.ItemCount paginated_children.size
+
+  xml.Details do
+    xml.Title container.title_path
+    xml.ContentType "x-tivo-container/folder"
+    xml.SourceFormat "x-tivo-container/folder"
+    xml.TotalItems children.size
+    xml.UniqueId format_uuid(container.uuid)
+  end
+
+  paginated_children.each do |child|
+    if child.is_a?(TivoHMO::API::Container)
+      builder :_container, layout: false, locals: { xml: xml, container: child }
+    elsif child.is_a?(TivoHMO::API::Item)
+      builder :_item, layout: false, locals: { xml: xml, item: child }
+    else
+      raise "Invalid child, needs to be item or container"
+    end
+  end
+
+end

data/lib/tivohmo/server/views/item_details.builder

@@ -0,0 +1,153 @@
+xml.TvBusMarshalledStruct :TvBusEnvelope,
+    'xmlns:xs' => "http://www.w3.org/2001/XMLSchema-instance",
+    'xmlns:TvBusMarshalledStruct' => "http://tivo.com/developer/xml/idl/TvBusMarshalledStruct",
+    'xmlns:TvPgdRecording' => "http://tivo.com/developer/xml/idl/TvPgdRecording",
+    'xmlns:TvBusDuration' => "http://tivo.com/developer/xml/idl/TvBusDuration",
+    'xmlns:TvPgdShowing' => "http://tivo.com/developer/xml/idl/TvPgdShowing",
+    'xmlns:TvDbShowingBit' => "http://tivo.com/developer/xml/idl/TvDbShowingBit",
+    'xmlns:TvBusDateTime' => "http://tivo.com/developer/xml/idl/TvBusDateTime",
+    'xmlns:TvPgdProgram' => "http://tivo.com/developer/xml/idl/TvPgdProgram",
+    'xmlns:TvDbColorCode' => "http://tivo.com/developer/xml/idl/TvDbColorCode",
+    'xmlns:TvPgdSeries' => "http://tivo.com/developer/xml/idl/TvPgdSeries",
+    'xmlns:TvDbShowType' => "http://tivo.com/developer/xml/idl/TvDbShowType",
+    'xmlns:TvPgdChannel' => "http://tivo.com/developer/xml/idl/TvPgdChannel",
+    'xmlns:TvDbTvRating' => "http://tivo.com/developer/xml/idl/TvDbTvRating",
+    'xmlns:TvDbRecordQuality' => "http://tivo.com/developer/xml/idl/TvDbRecordQuality",
+    'xmlns:TvDbBitstreamFormat' => "http://tivo.com/developer/xml/idl/TvDbBitstreamFormat",
+    'xs:schemaLocation' => "http://tivo.com/developer/xml/idl/TvBusMarshalledStruct TvBusMarshalledStruct.xsd http://tivo.com/developer/xml/idl/TvPgdRecording TvPgdRecording.xsd http://tivo.com/developer/xml/idl/TvBusDuration TvBusDuration.xsd http://tivo.com/developer/xml/idl/TvPgdShowing TvPgdShowing.xsd http://tivo.com/developer/xml/idl/TvDbShowingBit TvDbShowingBit.xsd http://tivo.com/developer/xml/idl/TvBusDateTime TvBusDateTime.xsd http://tivo.com/developer/xml/idl/TvPgdProgram TvPgdProgram.xsd http://tivo.com/developer/xml/idl/TvDbColorCode TvDbColorCode.xsd http://tivo.com/developer/xml/idl/TvPgdSeries TvPgdSeries.xsd http://tivo.com/developer/xml/idl/TvDbShowType TvDbShowType.xsd http://tivo.com/developer/xml/idl/TvPgdChannel TvPgdChannel.xsd http://tivo.com/developer/xml/idl/TvDbTvRating TvDbTvRating.xsd http://tivo.com/developer/xml/idl/TvDbRecordQuality TvDbRecordQuality.xsd http://tivo.com/developer/xml/idl/TvDbBitstreamFormat TvDbBitstreamFormat.xsd",
+     'xs:type' => "TvPgdRecording:TvPgdRecording" do
+
+  md = item.metadata
+
+  xml.recordedDuration format_iso_duration(md.duration)
+  xml.vActualShowing md.actual_showing
+  xml.vBookmark md.bookmark
+  xml.recordingQuality md.recording_quality[:name], :value => md.recording_quality[:value]
+
+  xml.showing do
+
+    xml.showingBits :value => md.showing_bits
+    xml.time format_iso_date(md.time)
+    xml.duration format_iso_duration(md.duration)
+    if md.part_count and md.part_index
+      xml.partCount md.part_count
+      xml.partIndex md.part_index
+    end
+
+    xml.program do
+
+      xml.vActor do
+        Array(md.actors).each do |actor|
+          xml.element actor
+        end
+      end
+
+      xml.vAdvisory md.advisory
+
+      xml.vChoreographer do
+        Array(md.choreographers).each do |choreographer|
+          xml.element choreographer
+        end
+      end
+
+      xml.colorCode md.color_code.try(:[], :name),
+                    :value => md.color_code.try(:[], :value)
+      xml.description md.description
+
+      xml.vDirector do
+        Array(md.directors).each do |director|
+          xml.element director
+        end
+      end
+
+      xml.episodeNumber md.episode_number if md.episode_number
+      xml.episodeTitle md.episode_title if md.is_episode && md.episode_title
+
+      xml.vExecProducer do
+        Array(md.executive_producers).each do |executive_producer|
+          xml.element executive_producer
+        end
+      end
+
+      xml.vProgramGenre do
+        Array(md.program_genres).each do |program_genre|
+          xml.element program_genre
+        end
+      end
+
+      xml.vGuestStar do
+        Array(md.guest_stars).each do |guest_star|
+          xml.element guest_star
+        end
+      end
+
+      xml.vHost do
+        Array(md.hosts).each do |host|
+          xml.element host
+        end
+      end
+
+      xml.isEpisode md.is_episode
+
+      if md.movie_year
+        xml.movieYear md.movie_year
+      else
+        xml.originalAirDate format_iso_date(md.original_air_date || md.time)
+      end
+
+      if md.mpaa_rating
+        xml.mpaaRating md.mpaa_rating[:name], :value => md.mpaa_rating[:value]
+      end
+
+      xml.vProducer do
+        Array(md.producers).each do |producer|
+          xml.element producer
+        end
+      end
+
+      xml.series do
+        xml.isEpisodic md.is_episode
+        xml.vSeriesGenre do
+          Array(md.series_genres).each do |series_genre|
+            xml.element series_genre
+          end
+        end
+        xml.seriesTitle md.series_title
+        xml.uniqueId md.series_id if md.series_id
+      end
+
+      xml.showType md.show_type.try(:[], :name),
+                    :value => md.show_type.try(:[], :value)
+
+      if md.star_rating
+        xml.starRating md.star_rating[:name], :value => md.star_rating[:value]
+      end
+
+      xml.title md.series_title ? md.series_title : (md.title || item.title)
+
+      xml.vWriter do
+        Array(md.writers).each do |writer|
+          xml.element writer
+        end
+      end
+
+      xml.uniqueId md.program_id if md.program_id
+
+    end
+
+    xml.channel do
+      xml.displayMajorNumber md.channel.try(:[], :major_number)
+      xml.displayMinorNumber md.channel.try(:[], :minor_number)
+      xml.callsign md.channel.try(:[], :callsign)
+    end
+
+    if md.tv_rating
+      xml.tvRating md.tv_rating[:name], :value => md.tv_rating[:value]
+    end
+
+  end
+
+  xml.startTime format_iso_date(md.start_time)
+  xml.stopTime format_iso_date(md.stop_time)
+
+end

data/lib/tivohmo/server/views/layout.builder

@@ -0,0 +1,2 @@
+xml.instruct! :xml, :version => '1.0'
+xml << yield

data/lib/tivohmo/server/views/layout.erb

@@ -0,0 +1,10 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+  <head>
+    <title>TivoHMO</title>
+    <link rel="stylesheet" type="text/css" href="/main.css">
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/lib/tivohmo/server/views/server.builder

@@ -0,0 +1,18 @@
+xml.TiVoContainer do
+
+  xml.Details do
+    xml.Title container.title
+    xml.ContentType container.content_type
+    xml.SourceFormat container.source_format
+    xml.TotalItems children.size
+  end
+
+  paginated_children = children[item_start, item_count]
+  paginated_children.each do |child|
+    builder :_container, layout: false, locals: { xml: xml, container: child }
+  end
+
+  xml.ItemStart item_start
+  xml.ItemCount paginated_children.size
+
+end

data/lib/tivohmo/server/views/server_info.builder

@@ -0,0 +1,7 @@
+xml.TiVoServer do
+  xml.Version "1.6"
+  xml.InternalName "TivoHMO"
+  xml.InternalVersion TivoHMO::VERSION
+  xml.Organization "TivoHMO Developers"
+  xml.Comment "https://github.com/wr0ngway/tivohmo"
+end

data/lib/tivohmo/server/views/unsupported.erb

@@ -0,0 +1,7 @@
+<h3>Unsupported Command</h3>
+<p>Query:</p>
+<ul>
+  <% params.each do |key, value| %>
+    <li><%= key %>: <%= value %></li>
+  <% end %>
+</ul>

data/lib/tivohmo/server/views/video_formats.builder

@@ -0,0 +1,10 @@
+#GET /TiVoConnect?Command=QueryFormats&SourceFormat=video%2Fx-tivo-mpeg HTTP/1.1.
+
+xml.TiVoFormats do
+  formats.each do |format|
+    xml.Format do
+      xml.ContentType format
+      xml.Description ""
+    end
+  end
+end