jeeves-pvr 0.2.0

data/lib/jeeves/parser/listings.rb

@@ -0,0 +1,41 @@
+#
+#
+# = Jeeves CLI
+#
+# == Listings related actions
+#
+# Author:: Robert Sharp
+# Copyright:: Copyright (c) 2014 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 'optplus/nested'
+
+class ListingCLI < Optplus::NestedParser
+  
+  usage "listings [update|clean]"
+  
+  description "manage TV listings in Jeeves PVR"
+  
+  def before_actions
+    @jeeves_config = @_parent.jeeves_config
+  end
+  
+  describe :update, 'update TV listings'
+  help :update, 'download TV listings data and load into Jeeves'
+  
+  def update
+    @jeeves_config[:jeeves_uri_timeout] = get_option(:timeout) if option?(:timeout)
+    @jeeves_config[:update_listings] = get_option(:update_listings) if option?(:update_listings)
+    Jeeves.update_listings(@jeeves_config)
+  rescue Jeeves::ListingError => e
+    exit_on_error "Error while updating listings #{e}"
+  end
+  
+end

data/lib/jeeves/parser/store.rb

@@ -0,0 +1,167 @@
+#
+#
+# = Jeeves Store CLI
+#
+# == Jeeves
+#
+# Author:: Robert Sharp
+# Copyright:: Copyright (c) 2014 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 'optplus/nested'
+
+class StoreCLI < Optplus::NestedParser
+  
+  include Jeni::IO
+  
+  usage "store command"
+  
+  description "manage Jeeves file stores"
+  
+  def before_actions
+    @jeeves_config = @_parent.jeeves_config
+    @logger = @_parent.logger
+  end
+  
+  describe :status, 'show status of Jeeves file stores'
+  help :status, 'display basic information about the file stores',
+    'currently available for Jeeves.'
+  
+  def status
+    parts = Array.new
+    devices = Array.new
+    @jeeves_config[:add_partition].each_pair do |path, params|
+      part = Jeeves::Partition.new(path, params)
+      if part.ready? then
+        if devices.include?(part.device) then
+          part.duplicate = true
+        else
+          devices << part.device
+        end
+        
+      end
+      parts << part.to_a
+    end
+    Jeeves.tabulate(%w{* 4c 4c 4c 8r 8r},
+        %w{Path Mnt Rdy Dup Total Free},
+        parts
+      )
+  end
+  
+  describe :list, 'list pre-allocated files in the Jeeves store'
+  help :list, 'list all of the pre-allocated files',
+    'that Jeeves currently knows about. These may',
+    'include files that were not released and those',
+    'that have not been recorded yet.'
+  
+  def list
+    jestore = Jeeves::Store.new(@logger, @jeeves_config)
+    if jestore.files <= 0 then
+      puts "There are no files to show"
+    else
+      entries = Array.new
+      colours = Array.new
+      compare_time = Time.now
+      jestore.each_file do |path, params|
+        entries << [path, Jeeves.human_size(params[:space]), params[:date].strftime("%Y-%b-%d %H:%M")]
+        if params[:date] < compare_time then
+          if FileTest.exists?(path) then
+            colours << :yellow
+          else
+            colours << :red
+          end
+        else
+          colours << :green
+        end
+      end
+      Jeeves.tabulate(%w{* *r *c},
+        %w{Path Space Date},
+        entries, colours)
+    end    
+  end
+  
+  
+  describe :clean, 'clean old records from the list of files'
+  help :clean, 'deletes any records in the Jeeves file store',
+    'for files whose allocation date has now expired'
+    
+  def clean
+    jestore = Jeeves::Store.new(@logger, @jeeves_config)
+    if get_option :delete then
+      # going to get rid of all file lists
+      if ask('Delete all file lists?', :no, 'yn') == :yes then
+        
+        jestore.each_partition do |part|
+          if FileTest.exists?(part.file_list) then
+            puts "Deleting #{part.file_list}"
+            FileUtils.rm_f(part.file_list)
+          end
+        end
+        
+      else
+        
+        puts "OK, no files have been deleted"
+        
+      end
+      return
+    end
+    
+    # jeeves store clear
+    if jestore.files == 0 then
+      puts "The file list is empty, nothing to clean".yellow
+      return
+    end
+    if get_option :clean_all then
+      if ask('Clean all files from the list?', :no, 'yn') != :no then
+        jestore.clean(true)
+        puts "The file list is now empty".green
+      end
+    else
+      if jestore.stale_files == 0 then
+        puts "There are no files to clean!".yellow
+        return
+      end
+      if ask('Clean files from the list?', :no, 'yn') != :no then
+        jestore.clean
+        puts "Cleaned file list".green
+      end
+    end    
+    
+  end
+  
+  describe :init, 'initialise a partition for use by Jeeves'
+  help :init, 'This will set up a partition to be used by Jeeves'
+  
+  def init
+    new_store = next_argument_or_error("need to provide a path to initialise")
+    
+    unless FileTest.exists?(new_store)
+      exit_on_error "path #{new_store} does not exist"
+    end
+
+    part = Jeeves::Partition.new(new_store)
+
+    if get_option :delete then
+      part.delete_key
+      return
+    end
+    
+    force = get_option :force_init
+    puts "Forcing a new key!".red.bold if force
+    key = part.create_key(force)
+    puts ""
+    puts "# add this line to your config file"
+    puts "add_store :path=>'#{part.path}', :key=>'#{key}'"    
+  rescue Jeeves::InvalidPartitionKey => err
+    exit_on_error err
+  end
+  
+end

data/lib/jeeves/parser/videos.rb

@@ -0,0 +1,136 @@
+#
+#
+# = Jeeves
+#
+# == Video CLI
+#
+# Author:: Robert Sharp
+# Copyright:: Copyright (c) 2014 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 'optplus/nested'
+
+class VideosCLI < Optplus::NestedParser
+  
+  include Jeni::IO
+
+  usage "videos <command> [<options>]"
+  
+  description "Do things with videos, such as load them into Jeeves."
+  
+  def before_actions
+    @jeeves_config = @_parent.jeeves_config
+    @logger = @_parent.logger
+  end
+  
+  
+  describe :show, 'show information about a Jeeves-ready video'
+  
+  def show
+    file = next_argument_or_error "Need to provide a file to show"
+
+    unless FileTest.exists?(file)
+      exit_on_error "File does not exist: #{file}"
+    end
+    
+    vid = Jeeves::Video.new(file, @logger, @jeeves_config)
+    tags = vid.get_tags
+    strs = Array.new
+    
+    %w{programme subtitle category}.each do |key|
+      strs << [key.capitalize, tags.delete(key)] if tags.has_tag?(key)
+    end
+    
+    unless tags.has_tag?('description')
+      exit_on_error "This file has not been tagged for Jeeves"
+    end
+    
+    width = 80
+    descs = [tags.delete('description')]
+    if descs[0].length > width then
+      descs = descs[0].scan(/\S.{0,#{width}}\S(?=\s|$)|\S+/)
+    end
+    
+    first = true
+    descs.each do |desc|
+      strs << [first ? 'Description' : '', desc]
+      first = false
+    end
+    
+    strs << ['','']
+    
+    strs << ['Start', Time.at(tags.delete('start').to_i).strftime('%a %-d %b %y, %H:%M')]
+    strs << ['Duration', Jeeves.hrs_mins(tags.delete('duration').to_i)]
+    
+    tags.each_tag do |key, value|
+      strs << [key, value]
+    end    
+    
+    Jeeves.tabulate(%w{* 80}, %w{Key Contents}, strs)
+  end
+  
+  
+  describe :load, 'load an existing video into Jeeves'
+  help :load, 'Use load for a file that already has the tags relevant to Jeeves',
+    'and just needs to be added to the database.'
+  
+  def load
+    file = next_argument_or_error "Need to provide a file to load"
+
+    unless FileTest.exists?(file)
+      exit_on_error "File does not exist: #{file}"
+    end
+    vid = Jeeves::Video.new(file, @logger, @jeeves_config)
+    
+    response = vid.upload_to_jeeves
+    vid.clean_up
+    if response.to_i == 0 then
+      puts "Jeeves OK".green
+      
+    else
+      exit_on_error "Jeeves returned unexpected response: #{response}"
+    end
+  rescue Jeeves::JeevesError => e
+    exit_on_error "Error while loading video: #{e}"
+  end
+  
+  describe :wrangle, 'tag and load a video into Jeeves'
+  help :load, 'Obtain metadata from Jeeves and tag a video with it',
+    'before loading into Jeeves.'
+    
+  def wrangle
+    
+    file = next_argument_or_error "Need to provide a file to wrangle"
+    unless FileTest.exists?(file)
+      exit_on_error "File does not exist: #{file}"
+    end
+    pid = next_argument_or_error "Need to provide a programme id to wrangle"
+    vid = Jeeves::Video.new(file, @logger, @jeeves_config)
+    vid.tag_from_prog_id(pid)
+    response = vid.upload_to_jeeves
+    vid.clean_up
+    if response.to_i == 0 then
+      puts "Jeeves OK"
+      
+    else
+      exit_on_error "Jeeves returned unexpected response: #{response}"
+    end
+  rescue Jeeves::JeevesError => e
+    exit_on_error "Error while wrangling video: #{e}"    
+  end
+  
+  describe :orphans, 'find files that have no entry in Jeeves'
+  
+  def orphans
+    
+  end
+  
+end

data/lib/jeeves/partition.rb

@@ -0,0 +1,174 @@
+#
+#
+# = Jeeves Disk
+#
+# == a single area to store files and part of a set of disks making up a store
+#
+# 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 'jeeves/errors'
+require 'jeeves/utils'
+
+module Jeeves
+  
+  # a unit of storage that can be added into a store
+  class Partition
+    
+    #include Jeeves::Utils
+    
+    # create a partition, regardless of what state it is in
+    def initialize(path, options={})
+      @path = File.expand_path(path)
+      @key = options[:key]
+      @key_file = File.join(@path, '.jeeves.key')
+      @file_list = File.join(@path, '.jeeves_store.rb')
+      @mount_point = options[:mount_point] || @path
+      
+      # assume the disk is not ready
+      @mounted = false
+      @ready = false
+      # check status
+      if FileTest.writable?(@path) then
+        # seems to be there, but is it correct?
+        if FileTest.exists?(@key_file) then
+          # there is a key file so assume it is mounted
+          @mounted = true
+          @ready = key_ok?
+        end
+      else
+        unless @path == @mount_point then
+          # check if mount_point is mounted
+          if FileTest.writable?(@mount_point) then
+            @mounted = true
+          end
+        end
+      end #if
+            
+      @total_space = 0
+      @free_space = 0
+      @device = ''
+      update_space
+      
+    end
+    
+    # path to the partition
+    attr_reader :path
+    
+    # boolean flag to indicate if the partition is mounted
+    # @deprecated use {#mounted?} instead
+    attr_reader :mounted
+    
+    # test if the partition is mounted
+    def mounted?
+      return @mounted
+    end
+    
+    attr_reader :ready
+    
+    # test if the partition is ready to use
+    def ready?
+      return @ready
+    end
+    
+    # return the device on which the partition resides (e.g. /dev/sda1)
+    attr_reader :device
+    
+    # return the total space in the partition (in 1K blocks)
+    attr_reader :total_space
+    
+    # return the free space in the partitions (in 1K blocks)
+    attr_reader :free_space
+    
+    # return tha path to where the file list would be or is
+    attr_reader :file_list
+    
+    # flag the partition as a duplicate
+    attr_accessor :duplicate
+    
+    # return the date of the file_list if it exists or nil otherwise
+    # The returned value is the modification time of the file
+    def file_list_date
+      return nil if @file_list.nil?
+      return File.mtime(@file_list)
+    end
+    
+    # test if the file list exists
+    def file_list?
+      return FileTest.exists?(@file_list)
+    end
+    
+    # test that the key given at init is the same as the key
+    # on the disk
+    def key_ok?
+      # get the key in the keyfile
+      return false if @key.nil?
+      return false unless File.exists?(@key_file)
+      file_key = File.readlines(@key_file).first.chomp
+      return file_key == @key
+    end
+    
+    # return the free space in 1K blocks on the given path
+    def update_space
+      return unless @ready
+      # use df to get the free space for path
+      df_lines = `/bin/df -Pk #{@path}`.split("\n")
+      df_fields = df_lines[1].split
+      @device = df_fields[0]
+      @total_space = df_fields[1].to_i
+      @free_space = df_fields[3].to_i
+    end
+    
+    def display(cols)
+      return @path.ljust(cols.shift) + 
+        (@mounted ? 'OK' : 'No').ljust(cols.shift) +
+        (@ready ? 'OK': 'No').ljust(cols.shift) +
+        (@duplicate ? '*': '').ljust(cols.shift) +
+        Jeeves.human_size(@total_space).rjust(cols.shift) +
+        Jeeves.human_size(@free_space).rjust(cols.shift)
+    end
+    
+    def to_a
+      return [@path,
+        (@mounted ? 'OK' : 'No'),
+        (@ready ? 'OK': 'No'),
+        (@duplicate ? '*': ''),
+        Jeeves.human_size(@total_space),
+        Jeeves.human_size(@free_space)]
+    end
+    
+    # create a key and save it to the disk
+    #
+    # This will raise an exception if the key file already exists or cannot be written
+    # but it can be forced to create the key anyway
+    #
+    # @param [Boolean] force the key file to be created if one already exists
+    def create_key(force=false)
+      # check that path is writable
+      unless FileTest.writable?(@path)
+        raise Jeeves::InvalidPartition, "Cannot write to #{path}"
+      end
+      
+      if FileTest.exists?(@key_file) &&  !force then
+        raise Jeeves::InvalidPartitionKey, "Keyfile already exists at #{path}"
+      end
+      
+      @key = Digest::SHA1.hexdigest(Time.now.to_s + rand(12341234).to_s)
+
+      File.open(@key_file, 'w') do |kfile|
+        kfile.puts @key
+      end
+      return @key
+      
+    end
+  end
+  
+end