RubyGems - bandshell - Versions diffs - 0.9 → 1.0 - Mend

bandshell 0.9 → 1.0

Files changed (12) hide show

checksums.yaml +4 -4
data/lib/bandshell/application/app.rb +52 -143
data/lib/bandshell/application/public/favicon.ico +0 -0
data/lib/bandshell/application/public/javascripts/authenticate.js +39 -6
data/lib/bandshell/application/public/javascripts/jquery-1.7.2.js +9404 -0
data/lib/bandshell/application/views/authenticate.erb +41 -8
data/lib/bandshell/application/views/main.erb +2 -2
data/lib/bandshell/application/views/player_status.erb +16 -2
data/lib/bandshell/hardware_api.rb +54 -9
data/lib/bandshell/player_info.rb +112 -0
data/lib/bandshell/screen_control.rb +159 -0
metadata +6 -2

data/lib/bandshell/application/views/authenticate.erb CHANGED Viewed

@@ -3,13 +3,46 @@
 <div id="no-js">
   It looks like Javascript is disabled. The Concerto Display will not work.
 </div>
-<% unless @display_temp_token.nil? %>
-  <div id="instructions">
-    Please enter the following token when setting up the screen in the
-    Concerto Panel:
-    <%= @display_temp_token %>
-  </div>
-<% end %>
 <div id="status">
   Waiting for first update...
-</div>
+</div>
+<div id="error" style="display:none">
+  <div class="alert alert-block">
+    <h2><span id="error_text">Error text here.</span></h2>
+    <p><span id="error_res_text">Error resolution info here.</span></p>
+  </div>
+</div>
+<div id="instructions" style="display:none">
+  <div class="alert alert-block">
+    <p class="center">
+    To configure this screen, you will need the following code:
+    </p>
+    <p class="center" style="font-size: 4em; font-family: Courier New, monospace; line-height: 1em;">
+      <%# The following span will be filled in by javascript. %>
+      <strong><span id="screen_temp_token">xxxxxx</span></strong>
+    </p>
+  </div>
+  <div style="margin: 20px auto; max-width: 850px;">
+    <br />
+    <h2><b>Step One.</b><br />
+      On your PC or mobile device, log into the
+Concerto Panel and visit the Screens page.
+    </h2>
+    <br />
+    <h2><b>Step Two.</b><br />If this is a completely new screen, click
+&quot;New Screen&quot; and fill out the relevant details.</h2>
+    The screen should not be public. Use the code
+given above as the authorization code. If this
+machine is being reconfigured or is replacing an
+existing screen, simply click on that screen, click
+edit, ensure that the screen is not public, and enter
+the authorization code.
+    <br />
+    <h2><b>Step Three.</b><br />Finally, take a look back at this screen. After a moment,
+your template should appear.</h2>
+    <p>You can add some content to the screen by editing the
+subscriptions in each field in the Concerto Panel.</p>
+    <br />
+    <h1 class="center">Happy Advertising!</h1>
+  </div>
+</div>

data/lib/bandshell/application/views/main.erb CHANGED Viewed

@@ -6,7 +6,7 @@
   <meta name="application-name" content="Concerto Player Network Configuration"/>
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   <link rel="stylesheet" type="text/css" href="/stylesheets/concerto-styles.css">
-  <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.js"></script>
+  <script src="javascripts/jquery-1.7.2.js"></script>
 </head>
 <body>
   <%#= render :partial => "elements/topmenu_contents" %>
@@ -52,4 +52,4 @@
   </div>
 </body>
-</html>
+</html>

data/lib/bandshell/application/views/player_status.erb CHANGED Viewed

@@ -15,6 +15,20 @@
   <%= JSON.pretty_generate(@on_off_rules) %>
 </pre>
 <p>
-  Screen status: Scheduled
-  <%= screen_scheduled_on? ? "On" : "Off" %>
+  Screen scheduled state:
+  <%= player_info.screen_scheduled_on? ? "On" : "Off" %>
+</p>
+<p>
+  Screen control availability:
+  <% avail, msg = Bandshell::ScreenControl.control_availability %>
+  <% if avail %>
+    Available
+  <% else %>
+    Not available:<br/>
+    <%= msg %>
+  <% end %>
+</p>
+<p>
+  Screen actual state:
+  <%= Bandshell::ScreenControl.screen_is_on? ? "On" : "Off" %>
 </p>

data/lib/bandshell/hardware_api.rb CHANGED Viewed

@@ -14,7 +14,9 @@ module Bandshell
     end
     def concerto_url
-      Bandshell::ConfigStore.read_config('concerto_url', '')
+      # Trailing slash required for proper URI Join behavior.
+      # Double slashes not harmful.
+      Bandshell::ConfigStore.read_config('concerto_url', '')+"/"
     end
     def frontend_uri
@@ -35,13 +37,20 @@ module Bandshell
     attr_reader :screen_id, :screen_url
+    # Can return:
+    #   :stat_badauth
+    #   :stat_err
+    #   :stat_serverr on connection or sever failure
+    #   :stat_badauth on an invalid permanent token
+    #   :stat_success when screen data retrieved.
     def attempt_to_get_screen_data!
       unless have_temp_token? or have_auth_token?
         request_temp_token!
       end
       unless have_auth_token?
-        check_temp_token!
+        tt_status = check_temp_token!
+        return tt_status unless tt_status == :stat_success
       end
       if have_auth_token?
@@ -50,6 +59,8 @@ module Bandshell
           ConfigStore.write_config('auth_token','')
           request_temp_token!
         end
+      elsif have_temp_token?
+        status = :stat_temponly
       else
         status = :stat_err
       end
@@ -66,6 +77,11 @@ module Bandshell
     # Get array of data about the screen from the server
     # This can only succeed once we have obtained a valid auth token.
+    # Returns:
+    #   :stat_serverr on connection or sever failure
+    #   :stat_badauth on an invalid permanent token
+    #   :stat_success when screen data retrieved.
+    # TODO: save screen data in configs???
     def fetch_screen_data
       return nil if auth_token.empty?
@@ -104,15 +120,25 @@ module Bandshell
         res = Net::HTTP.start(uri.hostname, uri.port) { |http|
           http.request(req)
         }
-      rescue Errno::ECONNREFUSED
+      rescue StandardError => ex
+        puts "get_with_auth: Failed to access concerto server:\n"+
+             "   "+ex.message.chomp
         res = nil
       end
       res
     end
     def request_temp_token!
-      response = Net::HTTP.get_response(frontend_api_uri)
+      begin
+        response = Net::HTTP.get_response(frontend_api_uri)
+      rescue StandardError => ex
+        puts "request_temp_token: Failed to access concerto server:\n"+
+             "   "+ex.message.chomp
+        return false
+      end
       if response.code != "200"
+        puts "request_temp_token: Unsuccessful request, HTTP "+response.code+"."
         return false
       end
@@ -129,22 +155,41 @@ module Bandshell
       return false
     end
+    # If the temp token has been accepted, convert it into an auth token,
+    # which is saved in the config store.
+    # Returns success of the action of checking:
+    #   stat_err on generic or unknown errors
+    #   stat_serverr if the server is inaccessible or erroring
+    #   stat_success if the acceptedness was reliably determined
     def check_temp_token!
-      return false if temp_token.empty?
+      return :stat_err if temp_token.empty? #should not happen
       query = URI.join(frontend_api_uri,"?screen_temp_token="+temp_token)
-      response = Net::HTTP.get_response(query)
+      begin
+        response = Net::HTTP.get_response(query)
+      rescue StandardError => ex
+        puts "check_temp_token: Failed to access concerto server:\n"+
+             "   "+ex.message.chomp
+        return :stat_serverr
+      end
       if response.code != "200"
-        return false
+        puts "check_temp_token: Unsuccessful request, HTTP "+response.code+"."
+        return :stat_serverr
       end
       data=JSON.parse(response.body)
       if data.has_key? 'screen_auth_token'
         ConfigStore.write_config('auth_token',data['screen_auth_token'])
         ConfigStore.write_config('auth_temp_token','')
-        return true
+        return :stat_success
+      elsif data.has_key? 'screen_temp_token'
+        # Indicates the API was accessed successfuly but the temp token
+        # has not been entered yet.
+        return :stat_success
       end
-      return false
+      return :stat_err
     end
     public

data/lib/bandshell/player_info.rb ADDED Viewed

@@ -0,0 +1,112 @@
+require 'bandshell/config_store'
+require 'net/http'
+require 'json'
+# This class can be thought of as a singleton model which retrieves,
+# manipulates, and stores information about the Player received from
+# the Concerto server's concerto-hardware plugin. For example, it
+# keeps track of screen on/off times.
+module Bandshell
+  class PlayerInfo
+    attr_accessor :last_update
+    attr_accessor :on_off_rules
+    attr_accessor :shelf_life
+    def initialize
+      @last_update  = Time.new(0)
+      @shelf_life   = 60
+      @on_off_rules = [{"action"=>"on"}] # default to always-on
+    end
+    # Returns false on failure.
+    def update_if_stale
+      if (@last_update < Time.now - @shelf_life)
+        update
+      else
+        true
+      end
+    end #update
+    # Fetches the latest player settings from Concerto
+    # TODO: Store settings in BandshellConfig (and update whenever they have
+    # changed) so that configs are immediately available at boot.
+    # Returns true on success, false on failure.
+    def update
+      data = Bandshell::HardwareApi::get_player_info
+      if data.nil?
+        puts "update_player_info: Recieved null data from get_player_info!"
+      elsif data == :stat_serverr
+        puts "update_player_info: Server error while retrieving player info."
+      elsif data == :stat_badauth
+        puts "update_player_info: Auth error while retrieving player info."
+      else
+        new_rules = data['screen_on_off']
+        if new_rules.nil? or !new_rules.is_a? Array
+          puts "update_player_info: Invalid screen on/off rules received."
+        else
+          @on_off_rules = new_rules
+          @last_update = Time.now
+          return true
+        end
+      end
+      return false
+    end #update
+    # Returns true if the screen should be turned on right now,
+    # according to the latest data recieved from concerto-hardware.
+    # Assumes on_off_rules is either nil or a valid ruleset.
+    # TODO: Evaluate effects of timezones
+    def screen_scheduled_on?
+      return true if on_off_rules.nil?
+      results = []
+      t = Time.now
+      on_off_rules.each do |rule|
+        rule_active = true
+        rule.each do |key, value|
+          case key
+          when "wkday"
+            rule_active = false unless value.include? t.wday.to_s
+          when "time_after"
+            rule_secs = seconds_since_midnight(Time.parse(value))
+            curr_secs = seconds_since_midnight(t)
+            rule_active = false unless curr_secs > rule_secs
+          when "time_before"
+            rule_secs = seconds_since_midnight(Time.parse(value))
+            curr_secs = seconds_since_midnight(t)
+            rule_active = false unless curr_secs < rule_secs
+          when "date"
+            day = Time.parse(value)
+            rule_active = false unless t.year==day.year and t.yday==day.yday
+          when "action"
+            # Do nothing.
+          else
+            # Do nothing.
+            # Err on the side of being on too long.
+          end # case key
+        end
+        if rule_active and rule.has_key? "action"
+          results << rule["action"]
+        end
+      end # each rule
+      if results.include? "force_on"
+        return true
+      elsif results.include? "off"
+        return false
+      elsif results.include? "on"
+        return true
+      else # All rules failed
+        return false
+      end
+    end #screen_scheduled_on?
+    # For a given time object, gives a numeric representation of the
+    # time of day on the day it represents.
+    def seconds_since_midnight(time)
+      time.sec + (time.min * 60) + (time.hour * 3600)
+    end
+  end #class
+end #module

data/lib/bandshell/screen_control.rb ADDED Viewed

@@ -0,0 +1,159 @@
+# This is a stateless class which provides a collection of methods
+# for controlling the display. Currently supported control interfaces
+# include:
+#   * DPMS
+module Bandshell
+  class ScreenControl
+  class << self
+    # Only used if no display is set already.
+    def default_display
+      ":0"
+    end
+    # Ensures that the display is in the specified state by enforcing
+    # each of a number of parameters, passed as the "state" hash.
+    # Valid keys:
+    #   :on => (boolean value: true for on, false for off)
+    def enforce_screen_state(state)
+      if !state.is_a? Hash
+        raise "enforce_screen_state: did not receive a hash!"
+      end
+      if state.has_key? :on
+        if state[:on] == true
+          force_screen_on unless screen_is_on? == true
+        elsif state[:on] == false
+          force_screen_off unless screen_is_on? == false
+        else
+          raise "enforce_screen_state: Invalid value for :on!"
+        end
+      end
+    end
+    def force_screen_on
+      dpms_force_screen_on
+    end
+    def force_screen_off
+      dpms_force_screen_off
+    end
+    # true, false, or unknown
+    def screen_is_on?
+      dpms_screen_is_on?
+    end
+    # Returns a boolean and an explanatory string indicating
+    # whether the screen can be controlled by DPMS.
+    def control_availability
+      dpms_availability
+    end
+    private
+    #
+    # DPMS Implementation
+    #
+    # Note: this code relies on backtick system calls. These are dangerous,
+    # security-wise, so we need to ensure that no webserver-provided strings
+    # are interploated.
+    #
+    # We make no attempt to enable or disable DPMS. I'm not sure how the
+    # default is determined at a system level, but that may be an option
+    # if folks run into it being off.
+    # true, false, or :unknown
+    def dpms_screen_is_on?
+      if ENV['DISPLAY'].nil? or ENV['DISPLAY'].empty?
+        ENV['DISPLAY'] = default_display
+      end
+      begin
+        result = `xset -q 2>&1`
+      rescue Errno::ENOENT
+        return :unknown
+      end
+      if ($?.exitstatus != 0)
+        return :unknown
+      end
+      if result.include? "Monitor is On"
+        return true
+      elsif result.include? "Monitor is Off"
+        return false
+      else
+        return :unknown
+      end
+    end
+    # true on success, false on failure.
+    def dpms_force_screen_on
+      if ENV['DISPLAY'].nil? or ENV['DISPLAY'].empty?
+        ENV['DISPLAY'] = default_display
+      end
+      begin
+        `xset dpms force on`
+      rescue Errno::ENOENT
+        return false
+      end
+      if $?.exitstatus != 0
+        return false
+      end
+      # Required if the screen was turned off with DPMS and the
+      # screensaver has not been disabled:
+      begin
+        `xset s reset`
+      rescue Errno::ENOENT #unlikely, but still...
+        return false
+      end
+      if $?.exitstatus != 0
+        return false
+      end
+    end
+    # true on success, false on failure.
+    def dpms_force_screen_off
+      if ENV['DISPLAY'].nil? or ENV['DISPLAY'].empty?
+        ENV['DISPLAY'] = default_display
+      end
+      begin
+        `xset dpms force off`
+      rescue Errno::ENOENT
+        return false
+      end
+      if $?.exitstatus == 0
+        return true
+      else
+        return false
+      end
+    end
+    def dpms_availability
+      if ENV['DISPLAY'].nil? or ENV['DISPLAY'].empty?
+        ENV['DISPLAY'] = default_display
+      end
+      begin
+        result = `xset -q 2>&1`
+      rescue Errno::ENOENT
+        return [false, "Can't access the xset command to control DPMS."]
+      end
+      if ($?.exitstatus == 127)
+        return [false, "Can't access the xset command to control DPMS."]
+      elsif ($?.exitstatus != 0)
+        # xset returns 1 and a message if the display is not specified or
+        # invalid.
+        return [false, "Problem running xset: "+result.chomp]
+      end
+      if result.include? "DPMS is Disabled"
+        return [false, "DPMS is disabled."]
+      elsif result.include? "DPMS is Enabled"
+        return [true, ""]
+      else
+        return [false, "Error parsing xset output."]
+      end
+    end
+  end # self
+  end # ScreenControl
+end