budik 1.0.0

data/lib/budik/config.rb

@@ -0,0 +1,149 @@
+# = config.rb
+# This file contains methods for configuring the application.
+#
+# == Contact
+#
+# Author::  Petr Schmied (mailto:jblack@paworld.eu)
+# Website:: http://www.paworld.eu
+# Date::    September 20, 2015
+
+module Budik
+  # 'Config' class loads and manages app configuration.
+  class Config
+    include Singleton
+
+    # Installs the application if not installed.
+    # Loads options, sources and language.
+    def initialize
+      @templates_dir = File.dirname(__FILE__) + '/../../config/templates/'
+      install unless installed?
+
+      @options = YAML.load_file(Dir.home + '/.budik/options.yml')
+      @sources = YAML.load_file(File.expand_path(@options['sources']['path']))
+      @lang = init_lang
+    end
+
+    # Sets application's language.
+    #
+    # - *Returns*:
+    #   - R18n::Translation object.
+    #
+    def init_lang
+      R18n.default_places = Dir.home + '/.budik/lang/'
+      R18n.set(@options['lang'])
+      R18n.t
+    end
+
+    # Language strings, options and sources.
+    attr_accessor :lang, :options, :sources
+
+    # Opens options file for editing.
+    def edit
+      options_path = File.expand_path('~/.budik/options.yml')
+      open_file(options_path)
+    end
+
+    # Installs the application.
+    def install
+      dir = Dir.home + '/.budik/'
+      FileUtils.mkdir_p([dir, dir + 'lang/', dir + 'downloads/'])
+
+      install_options(dir)
+      install_sources(dir)
+      install_lang(dir)
+    end
+
+    # Creates options file from template.
+    #
+    # - *Args*:
+    #   - +dir+ -> Directory containing app's configuration (String).
+    #
+    def install_options(dir)
+      options = @templates_dir + 'options/' + platform?.to_s + '.yml'
+      FileUtils.cp options, dir + 'options.yml'
+    end
+
+    # Creates sources file from template.
+    #
+    # - *Args*:
+    #   - +dir+ -> Directory containing app's configuration (String).
+    #
+    def install_sources(dir)
+      sources = @templates_dir + 'sources/sources.yml'
+      FileUtils.cp sources, dir unless File.file? dir + sources
+    end
+
+    # Creates default language file from template.
+    #
+    # - *Args*:
+    #   - +dir+ -> Directory containing app's configuration (String).
+    #
+    def install_lang(dir)
+      lang = @templates_dir + 'lang/en.yml'
+      FileUtils.cp lang, dir + 'lang/'
+    end
+
+    # Checks if the application is already installed.
+    def installed?
+      File.file?(Dir.home + '/.budik/options.yml')
+    end
+
+    # Opens file in default editor depending on platform.
+    #
+    # - *Args*:
+    #   - +file+ -> File to open (String).
+    #
+    def open_file(file)
+      if @options['os'] == 'windows'
+        system('@powershell -Command "' + file + '"')
+      else
+        editor = ENV['EDITOR'] ? ENV['EDITOR'] : 'vi'
+        system(editor + ' "' + file + '"')
+      end
+    end
+
+    # Returns current platform application's running on.
+    #
+    # - *Returns*:
+    #   - :windows, :linux or :rpi
+    #
+    def platform?
+      os = Sys::Platform.linux? ? :linux : :windows
+      rpi?(os) ? :rpi : os
+    end
+
+    # Resets app's configuration.
+    def reset
+      options = @templates_dir + 'options/' + platform?.to_s + '.yml'
+      FileUtils.cp(options, Dir.home + '/.budik/options.yml')
+    end
+
+    # Checks if application is running on Raspberry Pi.
+    #
+    # - *Args*:
+    #   - +os+ -> Operating system (:windows or :linux)
+    # - *Returns*:
+    #   - true or false
+    #
+    def rpi?(os)
+      return false unless os == :linux
+      cpuinfo = File.read('/proc/cpuinfo')
+      hardware = cpuinfo.scan(/[hH]ardware\s*:\s*(\w+)/).first.first
+      hardware =~ /BCM270[89]/
+    rescue
+      false
+    end
+
+    # Creates and/or opens language file for translation.
+    #
+    # - *Args*:
+    #   - +lang+ -> Language code (String)
+    #
+    def translate(lang)
+      template = @templates_dir + 'lang/en.yml'
+      new_lang = Dir.home + '/.budik/lang/' + lang + '.yml'
+      FileUtils.cp template, new_lang
+      open_file(new_lang)
+    end
+  end
+end

data/lib/budik/devices.rb

@@ -0,0 +1,146 @@
+# = devices.rb
+# This file contains methods for managing devices (storage and TV).
+#
+# == Contact
+#
+# Author::  Petr Schmied (mailto:jblack@paworld.eu)
+# Website:: http://www.paworld.eu
+# Date::    September 20, 2015
+
+module Budik
+  # 'Devices' class manages display and storage devices.
+  class Devices
+    include Singleton
+
+    # Loads TV and storage settings.
+    def initialize
+      options = Config.instance.options
+      @tv = {}
+      @storage = { mounted: nil, awake: nil, unmount: false }
+
+      tv_load(options['tv'])
+      storage_load(options['sources']['download'])
+    end
+
+    # Returns TV and storage settings.
+    attr_accessor :storage, :tv
+
+    # Loads storage settings.
+    #
+    # - *Args*:
+    #   - +options+ -> Storage options (Hash).
+    #
+    def storage_load(options)
+      @storage[:device] = options['device']
+      @storage[:partition] = options['partition']
+      @storage[:dir] = options['dir']
+
+      part_sub = { '$partition': @storage[:partition] }
+      dev_sub = { '$device': @storage[:device] }
+
+      storage_parse_cmd('mount', options['mount'], part_sub, mounted: false)
+      storage_parse_cmd('unmount', options['unmount'], part_sub, unmount: true)
+      storage_parse_cmd('sleep', options['sleep'], dev_sub, awake: false)
+    end
+
+    # Substitutes device and partition in (un)mount and sleep commands.
+    #
+    # == Example
+    #
+    # cmd = 'sleep'
+    # template = 'sudo hdparm -y $device'
+    # subst = { '$device': '/dev/sda' }
+    # state_mods = { awake: false }
+    #
+    # Parsed command: 'sudo hdparm -y /dev/sda'
+    # State 'awake' set to false
+    #
+    # - *Args*:
+    #   - +cmd+ -> Command ('mount', 'unmount' or 'sleep').
+    #   - +template+ -> Command template (String).
+    #   - +subst+ -> Variable to substitute (Hash, variable: value).
+    #   - +state_mods+ -> State modifiers (Hash).
+    #
+    def storage_parse_cmd(cmd, template, subst, state_mods = {})
+      return if template.empty?
+
+      cmd = (cmd + '_command').to_sym
+      var, val = subst.first
+      @storage[cmd] = template.gsub(var.to_s, val)
+      state_mods.each { |state, setting| @storage[state] = setting }
+    end
+
+    # Mounts partition if needed and if not already mounted
+    # If applicable, sets 'mounted' and 'awake' states to true
+    def storage_mount
+      unless @storage[:mounted].nil? || @storage[:mounted] == true
+        system(@storage[:mount_command])
+      end
+
+      @storage[:mounted] = true unless @storage[:mounted].nil?
+      @storage[:awake] = true unless @storage[:awake].nil?
+    end
+
+    # Unmounts partition if needed and if mounted
+    # If applicable, sets 'mounted' state to false
+    def storage_unmount
+      unmount = !@storage[:unmount]
+      unless unmount || @storage[:mounted].nil? || @storage[:mounted] == false
+        system(@storage[:unmount_command])
+      end
+
+      @storage[:mounted] = false unless @storage[:mounted].nil?
+    end
+
+    # Spins device down if needed and if awake
+    # If applicable, sets 'awake' state to false
+    def storage_sleep
+      sleep_check = @storage[:awake].nil? || @storage[:awake] == false
+
+      unless sleep_check || @storage[:mounted] == true
+        system(@storage[:sleep_command])
+      end
+
+      @storage[:awake] = false unless @storage[:awake].nil?
+    end
+
+    # Loads TV settings if TV is available.
+    #
+    # - *Args*:
+    #   - +options+ -> TV options (Hash).
+    #
+    def tv_load(options)
+      if options['available']
+        @tv[:use_if_no_video] = options['use_if_no_video']
+        @tv[:wait_secs_after_on] = options['wait_secs_after_on']
+        @tv[:on] = false
+      else
+        @tv[:on] = nil
+      end
+    end
+
+    # Turns on TV if needed and if not already on
+    # Gives TV time to turn on, then sets active HDMI as active source
+    # If applicable, sets 'on' state to true
+    def tv_on
+      unless @tv[:on].nil? || @tv[:on] == true
+        system('echo "on 0" | cec-client -s >/dev/null')
+        sleep(@tv[:wait_secs_after_on]) unless @tv[:wait_secs_after_on].nil?
+        system('echo "as" | cec-client -s >/dev/null')
+      end
+
+      @tv[:on] = true unless @tv[:on].nil?
+    end
+
+    # Turns off TV if needed and if on
+    # If applicable, sets 'on' state to false
+    # Doesn't work on my TV
+    def tv_off
+      unless @tv[:on].nil? || @tv[:on] == false
+        system('echo "standby 0" | cec-client -s >/dev/null')
+      end
+
+      @tv[:on] = false unless @tv[:on].nil?
+    end
+  end
+end

data/lib/budik/io.rb

@@ -0,0 +1,58 @@
+# = io.rb
+# This file contains methods for managing application's input and output.
+#
+# == Contact
+#
+# Author::  Petr Schmied (mailto:jblack@paworld.eu)
+# Website:: http://www.paworld.eu
+# Date::    September 20, 2015
+
+module Budik
+  # 'Output' class provides information to the user via console.
+  class IO
+    include Singleton
+
+    # Loads output strings in currently set language.
+    def initialize
+      @strings = Config.instance.lang.output
+    end
+
+    # Outputs table formatted information about selected source
+    # to the console.
+    #
+    # - *Args*:
+    #   - +source+ -> Selected source (Hash).
+    #   - +number+ -> Number of selected source (Fixnum).
+    #
+    def run_info_table(source, number)
+      title = 'Budik - ' + DateTime.now.strftime('%d/%m/%Y %H:%M')
+
+      rows = []
+      rows << [@strings.alarm, source[:name]]
+      rows << [@strings.category, source[:category].to_s]
+      rows << [@strings.number, number.to_s]
+
+      Terminal::Table.new title: title, rows: rows
+    end
+
+    # Outputs formatted list of sources to the console.
+    #
+    # - *Args*:
+    #   - +sources+ -> Parsed sources (Array of Hashes).
+    #
+    def sources_print(sources)
+      sources.each_with_index do |source, index|
+        puts '[' + index.to_s.light_white + '] ' + source[:name].yellow
+      end
+    end
+
+    # Outputs information about source being downloaded.
+    #
+    # - *Args*:
+    #   - +source+ -> Source being downloaded (Hash).
+    #
+    def storage_download_info(source)
+      puts @strings.downloading + source[:name]
+    end
+  end
+end

data/lib/budik/player.rb

@@ -0,0 +1,174 @@
+# = player.rb
+# This file contains methods for managing media players.
+#
+# == Contact
+#
+# Author::  Petr Schmied (mailto:jblack@paworld.eu)
+# Website:: http://www.paworld.eu
+# Date::    September 20, 2015
+
+module Budik
+  # 'Player' class handles communication between app and media players.
+  class Player
+    include Singleton
+
+    # Sets player and loads its options.
+    def initialize
+      player_options = Config.instance.options['player']
+      @player = player_options['player']
+
+      if @player == 'omxplayer'
+        @player_options = player_options['omxplayer']
+      else
+        @player_options = player_options['vlc']
+      end
+    end
+
+    # Gets current player and its options.
+    attr_accessor :player, :player_options
+
+    # Plays a source using currently set player.
+    #
+    # - *Args*:
+    #   - +source+ -> Source to play (Hash).
+    #
+    def play(source)
+      if @player == 'omxplayer'
+        omxplayer(source)
+      else
+        vlc(source)
+      end
+    end
+
+    # Plays a source using omxplayer.
+    #
+    # - *Args*:
+    #   - +source+ -> Source to play (Hash).
+    #
+    def omxplayer(source)
+      source[:path].each_with_index do |item, index|
+        Open3.popen3(omx_build_command(item)) do |i, _o, _e, _t|
+          omx_volume_control(i) if index == 0
+        end
+      end
+    end
+
+    # Builds omxplayer's command with required parameters.
+    #
+    # - *Args*:
+    #   - +item+ -> Item to play (path, String).
+    #
+    def omx_build_command(item)
+      command = @player_options['path']
+      args = '--vol ' + @player_options['default_volume'].to_s
+      command + ' ' + args + ' "' + Storage.instance.locate_item(item) + '"'
+    end
+
+    # Fades in volume using omxplayer's volup command.
+    #
+    # - *Args*:
+    #   - +i+ -> Stdin object.
+    #
+    def omx_volume_control(i)
+      7.times do
+        sleep(@player_options['volume_step_secs'])
+        i.print '+'
+      end
+      i.close
+    end
+
+    # Plays a source using vlc.
+    #
+    # - *Args*:
+    #   - +source+ -> Source to play (Hash).
+    #
+    def vlc(source)
+      vlc_pid = spawn(vlc_build_command(source))
+      sleep(@player_options['wait_secs_after_run'])
+      vlc_volume_control(vlc_rc_connect)
+
+      Process.wait(vlc_pid)
+    end
+
+    # Builds VLC's command with required parameters.
+    #
+    # - *Args*:
+    #   - +source+ -> Source to play (Hash).
+    #
+    def vlc_build_command(source)
+      vlc_path = Marshal.load(Marshal.dump(@player_options['path']))
+      vlc_path.gsub!(/(^|$)/, '"') if vlc_path =~ /\s/
+
+      args = vlc_build_args
+      files = vlc_cmd_add_items(source)
+
+      vlc_path + args[:rc] + args[:volume] + args[:fullscreen] + files
+    end
+
+    # Builds list of options/arguments fo VLC command
+    def vlc_build_args
+      rc_host = @player_options['rc_host']
+      rc_port = @player_options['rc_port']
+      rc = ' --extraintf rc --rc-host ' + rc_host + ':' + rc_port.to_s
+
+      volume = ' --volume-step ' + @player_options['volume_step'].to_s
+      fullscreen = @player_options['fullscreen'] ? ' --fullscreen ' : ' '
+
+      { rc: rc, volume: volume, fullscreen: fullscreen }
+    end
+
+    # Parses source and adds its items to the VLC command.
+    # Adds 'vlc://quit' to automatically quit VLC after play is over.
+    #
+    # - *Args*:
+    #   - +source+ -> Source to play (Hash).
+    #
+    def vlc_cmd_add_items(source)
+      files = ''
+      source[:path].each do |item|
+        item_path = Storage.instance.locate_item(item).gsub(%r{^/}, '')
+        files += (vlc_cmd_item_prefix(item_path) + item_path + '" ')
+      end
+      files += 'vlc://quit'
+    end
+
+    # Adds 'file:///' prefix to local file paths so VLC plays them
+    # correctly.
+    #
+    # - *Args*:
+    #   - +item_path+ -> Path to item.
+    #
+    def vlc_cmd_item_prefix(item_path)
+      is_url = (item_path =~ /\A#{URI.regexp(%w(http https))}\z/)
+      is_url ? '"' : '"file:///'
+    end
+
+    # Makes a connection to VLC's remote control interface.
+    # FIXME: Possible infinite loop
+    def vlc_rc_connect
+      rc_host = @player_options['rc_host']
+      rc_port = @player_options['rc_port']
+      loop do
+        begin
+          rc = TCPSocket.open(rc_host, rc_port)
+          return rc
+        rescue
+          next
+        end
+      end
+    end
+
+    # Fades in volume using VLC's remote control interface.
+    #
+    # - *Args*:
+    #   - +rc+ -> IO object (returned by TCPSocket.open).
+    #
+    def vlc_volume_control(rc)
+      rc.puts 'volume ' + @player_options['default_volume'].to_s
+      128.times do
+        sleep(@player_options['volume_fadein_secs'])
+        rc.puts 'volup ' + @player_options['volume_step'].to_s
+      end
+    end
+  end
+end