jeeves-pvr 0.2.0

data/bin/jeeves.wrapper

@@ -0,0 +1,26 @@
+#!/usr/bin/ruby18
+#
+# This file was generated by RubyGems.
+#
+# The application 'jeeves-pvr' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'rubygems'
+
+version = ">= 0"
+
+if ARGV.first
+  str = ARGV.first
+  str = str.dup.force_encoding("BINARY") if str.respond_to? :force_encoding
+  if str =~ /\A_(.*)_\z/
+    version = $1
+    ARGV.shift
+  end
+end
+
+#gem 'jeeves-pvr', version
+#require 'jeeves'
+executable = Gem.bin_path('jeeves-pvr', 'jeeves', version)
+puts executable
+load executable

data/etc/jerbil/jeeves.rb

@@ -0,0 +1,46 @@
+#
+# Configuration Options for: Jeeves::Config
+#
+
+# Add a file partition for Jeeves. Must have the following parameters:
+#   :path - valid file path to the partition to be added (not a device path),
+#   :key - the key given to the partition when it was initialised,
+#   :mountable - true if the partition should be mounted directly,
+#   :mounted_on - path of mount point if the partition is not one itself
+#  
+# Use :mountable=>true to enable the partition to be mounted - needs to be an entry in /etc/fstab
+# If the partition is not directly mountable but is on a mountable device partition that you also want
+# mounted then use :mounted_on=>/path/to/partition instead
+#add_partition 
+add_partition :path=>'/home/jeeves', :key=>'d1520a02b294db739bddb2324482310116f39d07'
+add_partition :path=>'/home/jeeves_2', :key=>'9227567edca1bb8018d2c7bda592dbb69a89af35'
+
+# Specify what to do if a specified partition cannot be added, e.g. because it has not been mounted
+# Can be one of the following:
+#   :ignore - log an info message and carry on
+#   :warn - let the user know but carry on
+#   :fatal - do not continue without the partition
+# 
+# The default is to warn but carry on. Jeeves should still be able to allocate a file even if there are
+# missing partitions in the store
+store_errors :warn
+
+# Specify the environment within which Jeeves services (Jetuner etc) are expected
+# to be operating. Should be one of :dev, :test or :prod
+#environment :dev
+
+# URL to the Jeeves listing/TV application that has info on programme listings
+jeeves_tv_url 'http://tv.jeeves.osburn-sharp.ath.cx'
+
+# Set the base rate for estimating data storage in kbytes per second. Note
+# for some tuners this may need to be scaled, which can be done at the time
+# of allocation.
+#base_data_rate 416
+
+# Specify a directory where jeeves can put working files etc. If you are working
+# across a network then this directory needs to be shared across the network too.
+working_dir '/home/jeeves/.jeeves'
+
+# URL to the Jeeves video application to which recorded videos are referred etc
+jeeves_url 'http://jeeves.osburn-sharp.ath.cx'
+

data/lib/jeeves.rb

@@ -0,0 +1,68 @@
+#
+# Author:: R.J.Sharp
+# Email:: robert(a)osburn-sharp.ath.cx
+# Copyright:: Copyright (c) 2011 
+# License:: Open Software Licence v3.0
+#
+# This software is licensed for use under the Open Software Licence v. 3.0
+# The terms of this licence can be found at http://www.opensource.org/licenses/osl-3.0.php
+# and in the file LICENCE. Under the terms of this licence, all derivative works
+# must themselves be licensed under the Open Software Licence v. 3.0
+#
+# 
+require 'jerbil/jerbil_service/base'
+require 'jerbil/jerbil_service/support'
+require 'jerbil/support'
+require 'jerbil/config'
+
+# pull in things to do with jeeves
+
+require 'jeeves/listings'
+require 'jeeves/store'
+require 'jeeves/tags'
+require 'jeeves/config'
+require 'jeeves/errors'
+
+#
+# == Jeeves Service
+#
+# Synopsis of the whole service
+#
+module Jeeves
+
+  # add generic class methods
+  extend JerbilService::Support
+
+  # === Jeeves Service class
+  #
+  # Description of how the service class works
+  #
+  # class Service < JerbilService::Base
+  # 
+  #   # Document the constructor as required.
+  #   #
+  #   # pkey:: string - private key that must be used for
+  #   #        supervision calls (e.g. stop_callback)
+  #   # options:: hash of options, preferably as created by Jeckyl. See documentation
+  #   #           on JerbilService::Base for assumed options re logging etc
+  #   #
+  #   def initialize(pkey, options)
+  # 
+  #     # do things that cannot be done when $SAFE > 0
+  # 
+  #     # the symbol should be the app name and must correspond to a service in /etc/services
+  #     super(:jeeves, pkey, options)
+  # 
+  #     # DRb is now working, this process may have daemonized and $SAFE = 1
+  # 
+  #   end
+  # 
+  #   #
+  #   # define additional class methods to make things happen
+  #   #
+  # 
+  #   # do not redefine the superclass methods unless you are absolutely sure you know
+  #   # what you are doing.
+  # 
+  # end
+end

data/lib/jeeves/config.rb

@@ -0,0 +1,141 @@
+#
+#
+# = Configuration settings for Jeeves Applications etc
+#
+# == Jeckyl config
+#
+# Author:: Robert Sharp
+# Copyright:: Copyright (c) 2013 Robert Sharp
+# License:: Open Software Licence v3.0
+#
+# This software is licensed for use under the Open Software Licence v. 3.0
+# The terms of this licence can be found at http://www.opensource.org/licenses/osl-3.0.php
+# and in the file copyright.txt. Under the terms of this licence, all derivative works
+# must themselves be licensed under the Open Software Licence v. 3.0
+#
+# 
+#
+require 'jeckyl'
+
+module Jeeves
+  
+  # define all of the configuration settings for Jeeves. Derived from
+  # Jellog to provide logging options for store operations
+  #
+  class Config < Jeckyl::Config
+    
+    def configure_add_partition(params={})
+      comment "Add a file partition for Jeeves. Must have the following parameters:",
+        "  :path - valid file path to the partition to be added (not a device path),",
+        "  :key - the key given to the partition when it was initialised,",
+        "  :mountable - true if the partition should be mounted directly,",
+        "  :mounted_on - path of mount point if the partition is not one itself",
+        " ",
+        "Use :mountable=>true to enable the partition to be mounted - needs to be an entry in /etc/fstab",
+        "If the partition is not directly mountable but is on a mountable device partition that you also want",
+        "mounted then use :mounted_on=>/path/to/partition instead"
+        
+      # ignore calls to get a default, which will not have the right params
+      return unless params.kind_of?(Hash)
+        
+      @stores ||= Hash.new
+      
+      if @stores.has_key?(params[:path]) then
+        # should not have defined the store already...
+        raise Jeckyl::ConfigError, "Duplicate store: #{params[:path]}"
+      end
+      
+      # make sure this is a writable directory
+      # but if its not mounted it may not be!
+      #a_writable_dir(params[:path])
+      
+      # if Jeeves.store_key(params[:path]) != params[:key] then
+      #   # store has not been initialised with this key
+      #   raise Jeckyl::ConfigError, "Incorrect/missing key for store: #{params[:path]}"
+      # end
+      
+      @stores[params[:path]] = {:key=>params[:key]}
+      
+      # check that both mount options have not been provided
+      if params[:mountable] then
+        if params.has_key?(:mounted_on) then
+          raise Jeckyl::ConfigError, "Please provide :mountable or :mounted_on but not both"
+        end
+        @stores[params[:path]][:mount_point] = params[:path]
+      end
+      
+      if params.has_key?(:mounted_on) then
+        a_readable_file(params[:mounted_on]) # the directory may not be writable!
+        @stores[params[:path]][:mount_point] = params[:mounted_on]
+      end
+      
+      return @stores
+      
+    end
+    
+    def configure_base_data_rate(kbpm)
+      default 25000 / 60 # reasonable rate for dvb
+      comment "Set the base rate for estimating data storage in kbytes per second. Note",
+        "for some tuners this may need to be scaled, which can be done at the time",
+        "of allocation."
+        
+      a_type_of(kbpm, Integer) && in_range(kbpm, 100, 10000)
+      
+    end
+    
+    def configure_jeeves_url(url)
+      comment "URL to the Jeeves video application to which recorded videos are referred etc"
+      
+      a_matching_string(url, /https?:\/\/[\S]+/)
+    end
+    
+    def configure_jeeves_tv_url(url)
+      comment "URL to the Jeeves listing/TV application that has info on programme listings"
+      
+      a_matching_string(url, /https?:\/\/[\S]+/)
+    end
+    
+    def configure_jeeves_uri_timeout(timeout)
+      default 2 * 60 # 2 minutes
+      comment "Set the timeout on updating Jeeves TV with the listings data. This can",
+        "take a long time so usually it exceeds the default. Needs to be in seconds.",
+        "To set an infinite timeout, use 0"
+        
+      a_type_of(timeout, Integer) && in_range(timeout, 0, 10000) # some very high upper limit
+      
+    end
+    
+    def configure_store_errors(symb)
+      default :warn
+      comment "Specify what to do if a specified partition cannot be added, e.g. because it has not been mounted",
+        "Can be one of the following:",
+        "  :ignore - log an info message and carry on",
+        "  :warn - let the user know but carry on",
+        "  :fatal - do not continue without the partition",
+        "",
+        "The default is to warn but carry on. Jeeves should still be able to allocate a file even if there are",
+        "missing partitions in the store"
+        
+        a_member_of(symb, [:ignore, :warn, :fatal])
+        
+    end
+    
+    def configure_working_dir(dir)
+      default '/tmp'
+      comment "Specify a directory where jeeves can put working files etc. If you are working",
+        "across a network then this directory needs to be shared across the network too."
+      
+      a_writable_dir(dir)
+      
+    end
+    
+    def configure_environment(env)
+      default :dev
+      comment "Specify the environment within which Jeeves services (Jetuner etc) are expected",
+        "to be operating. Should be one of :dev, :test or :prod"
+      a_member_of(env, [:dev, :test, :prod])
+    end
+    
+  end
+  
+end

data/lib/jeeves/errors.rb

@@ -0,0 +1,70 @@
+#
+# Author:: R.J.Sharp
+# Email:: robert(a)osburn-sharp.ath.cx
+# Copyright:: Copyright (c) 2011 
+# License:: Open Software Licence v3.0
+#
+# This software is licensed for use under the Open Software Licence v. 3.0
+# The terms of this licence can be found at http://www.opensource.org/licenses/osl-3.0.php
+# and in the file LICENCE. Under the terms of this licence, all derivative works
+# must themselves be licensed under the Open Software Licence v. 3.0
+#
+# 
+# This file groups together all the errors for jeeves.
+# Preceed each class with a description of the error
+
+module Jeeves
+
+  # A general class for all errors created by this project. All specific exceptions
+  # should be children of this class
+  class JeevesError < RuntimeError; end
+  
+  class VersionError < JeevesError; end
+  
+  # errors raised by the scheduler
+  class JscheduleError < JeevesError; end
+  
+  #the tuner type for a scheduler is not valid
+  class InvalidTuner < JscheduleError; end
+  
+  # the tuner does not have the given mode
+  class InvalidMode < JscheduleError; end
+  
+  # a schedule request is missing a required parameter
+  class MissingParam < JscheduleError; end
+  
+  # the tuner is busy
+  class TunerBusy < JscheduleError; end
+  
+  # store related errors
+  class StoreError < JeevesError; end
+  
+  class InvalidPartition < StoreError; end
+  
+  class InvalidPartitionKey < StoreError; end
+  
+  class DiskError < JeevesError; end
+  
+  # listings related errors
+  class ListingError < JeevesError; end
+  class VideoError < JeevesError; end
+  
+  
+  class TaggerError < JeevesError; end
+  
+  # A Jeckyl option that is needed has not been provided
+  class MissingOption < TaggerError; end
+  
+  # the file provided cannot be read
+  class FileError < TaggerError; end
+  
+  # the url does not work
+  class UrlError < TaggerError; end
+  
+  # there was an error with the XML tags
+  class XMLError < TaggerError; end
+  
+  # error creating matroska file
+  class MkvError < TaggerError; end
+
+end

data/lib/jeeves/listings.rb

@@ -0,0 +1,116 @@
+#
+#
+# = Xmltv
+#
+# == methods for interfacing xmltv with jeeves
+#
+# Author:: Robert Sharp
+# Copyright:: Copyright (c) 2013 Robert Sharp
+# License:: Open Software Licence v3.0
+#
+# This software is licensed for use under the Open Software Licence v. 3.0
+# The terms of this licence can be found at http://www.opensource.org/licenses/osl-3.0.php
+# and in the file copyright.txt. Under the terms of this licence, all derivative works
+# must themselves be licensed under the Open Software Licence v. 3.0
+#
+# 
+#
+require 'jeckyl/errors'
+require 'jeeves/errors'
+
+module Jeeves
+  
+  # load the latest listings data into Jeeves
+  # 
+  # jeeves will use existing listings data if it was downloaded
+  # less than 6 hours ago. This can be overriden with the :force option
+  #
+  # If the :reset option is set to true then the listings data will replace
+  # all existing data and not just append to it.
+  #
+  # @param [Hash] params to control the loading
+  # @option [String] :working_dir, see config
+  # @option [String] :jeeves_tv_url, see config
+  # @option [Boolean] :force - set to true to force new listings data
+  # @option [Boolean] :reset - set to true to reset all listings data
+  def Jeeves.update_listings(params={})
+    
+    working_dir = params[:working_dir]
+    unless File.directory?(working_dir) && File.writable?(working_dir)
+      # if config file is used this should not be possible
+      raise Jeckyl::ConfigError, "Cannot write to #{working_dir}"
+    end
+    
+    chan_txt_file = File.join(working_dir, 'channels.txt')
+    listings_file = File.join(working_dir, 'listings.xml')
+    
+    age = 0
+    # see how old it is
+    age = Time.now - File.mtime(listings_file) if FileTest.exists?(listings_file)
+    
+    age = 0 if params[:update_listings] == true
+    
+    jeeves_tv_url = params[:jeeves_tv_url]
+
+    # check how old the listings file is
+    unless age > 0 && age < (60*60*6) then
+      # its more than 6 hours old, so renew it
+      # or you forced renewal!
+    
+      # make sure it does not already exist
+      FileUtils.rm_f(chan_txt_file)
+      FileUtils.rm_f(listings_file)
+      
+      
+      # get the channels info from jeeves_tv
+      cmd = "/usr/bin/wget #{jeeves_tv_url}/bchannels.txt -O #{chan_txt_file}"
+      
+      
+      unless system(cmd)
+        raise ListingError, "#{cmd}\n failed with error #{$?}"
+      end
+      
+      unless File.exists?(chan_txt_file)
+        raise ListingError, "Failed to create file: #{chan_txt_file}"
+      end
+      
+      # now copy this file to where xmltv expects to find it.
+      # cheat with shell cos of ~
+      cmd = "cp #{chan_txt_file} ~/.xmltv/tv_grab_uk_rt.conf"
+      unless system(cmd)
+        raise ListingError, "Failed to copy file: #{cmd}"
+      end
+      
+      cmd = "/usr/bin/tv_grab_uk_rt >#{listings_file}"
+      unless system(cmd)
+        raise ListingError, "Failed to grab listings: #{$?}\n #{cmd}"
+      end
+    end
+    
+    listings_url = URI.encode(listings_file) # ensure it is OK as url
+    
+    # and now poke jeeves-tv to let it know there is something to process
+    #cmd = "/usr/bin/wget #{jeeves_tv_url}/load?file=#{listings_url}"
+    url = "#{jeeves_tv_url}/load?file=#{listings_url}"
+    url << "&reset=true" if params[:reset_listings]
+    
+    # unless system(cmd)
+    #   raise ListingError, "Failed to load programme info: #{$?}\n#{cmd}"
+    # end
+    
+    rto = params[:jeeves_uri_timeout]
+    rto = nil if rto == 0 # makes it infinite
+    
+    response = Array.new
+    open(url, read_timeout:rto) do |resp|
+      resp.each_line do |line|
+        response << line
+      end
+    end
+    
+    # test that the response was OK
+    
+    return true
+  end
+  
+end