concerto_client 0.0.1 → 0.0.3

data/lib/concerto_client/application/app.rb

@@ -1,5 +1,5 @@
 require 'rubygems'
-require 'sinatra'
+require 'sinatra/base'
 require 'haml'
 require 'json'
 require 'net/http'
@@ -7,10 +7,6 @@ require 'ipaddress'
 require 'concerto_client/netconfig'
 
 class ConcertoConfigServer < Sinatra::Base
-	# Some files we will use. None of these need to exist right away.
-	PASSWORD_FILE='/tmp/concerto_password'
-	URL_FILE='/tmp/concerto_url'
-
 	# push these over to netconfig.rb?
 	# Our list of available physical-layer connection methods...
 	CONNECTION_METHODS = [ 
@@ -29,14 +25,7 @@ class ConcertoConfigServer < Sinatra::Base
 		IPAddress.parse("::1") 
 	]
 
-	# Load our (constant) password from file.
-	begin
-		PASSWORD = File.open(PASSWORD_FILE) do |f|
-			f.readline.chomp
-		end
-	rescue Errno::ENOENT
-		PASSWORD = 'default'
-	end
+	set :haml, { :format => :html5, :layout => :main }
 
 	helpers do
 		# Get the return value of the method on obj if obj supports the method.
@@ -51,40 +40,39 @@ class ConcertoConfigServer < Sinatra::Base
 		end
 
 		# Enforce authentication on actions.
-		# Calling from within an action will check authentication and return 401
-		# if unauthorized.
+		# Calling from within an action will check authentication and return 
+		# 401 if unauthorized.
 		def protected!
 			unless authorized?
-				response['WWW-Authenticate'] = %(Basic realm="Concerto Configuration")
+				response['WWW-Authenticate'] = \
+					%(Basic realm="Concerto Configuration")
 				throw(:halt, [401, "Not authorized\n"])
 			end
 		end
 
 		# Check authorization credentials.
-		# Currently configured to check if the REMOTE_ADDR is localhost and allow
+		# Currently configured to check if the REMOTE_ADDR is local and allow
 		# everything if so. This permits someone at local console to configure
-		# without the need for a password. Others must have the correct password
-		# to be considered authorized.
+		# without the need for a password. Others must have the correct 
+		# password to be considered authorized.
 		def authorized?
 			ip = IPAddress.parse(request.env['REMOTE_ADDR'])
+			password = ConcertoConfig::ConfigStore.read_config(
+				'password', 'default'
+			)
 			if LOCALHOSTS.include? ip
 				# allow all requests from localhost no questions asked
 				true
 			else
 				@auth ||= Rack::Auth::Basic::Request.new(request.env)
-				@auth.provided? && @auth.basic? && @auth.credentials && @auth.credentials == ['root', PASSWORD]
+				@auth.provided? && @auth.basic? && @auth.credentials && \
+					@auth.credentials == ['root', password]
 			end
 		end
 
 		# Get our base URL from wherever it may be stored.
 		def concerto_url
-			begin
-				File.open(URL_FILE) do |f|
-					f.readline.chomp
-				end
-			rescue
-				""
-			end
+			ConcertoConfig::ConfigStore.read_config('concerto_url', '')
 		end
 
 		# Try to figure out what our current IPv4 address is
@@ -116,7 +104,8 @@ class ConcertoConfigServer < Sinatra::Base
 		# Check if we can retrieve a URL and get a 200 status code.
 		def validate_url(url)
 			begin
-				# this will fail with Errno::something if server can't be reached
+				# this will fail with Errno::something if server 
+				# can't be reached
 				response = Net::HTTP.get_response(URI(url))
 				if response.code != "200"
 					# also bomb out if we don't get an OK response
@@ -159,7 +148,7 @@ class ConcertoConfigServer < Sinatra::Base
 		if network_ok
 			# Everything's up and running, we just don't know what 
 			# our URL should be.
-			haml :setup, :layout => :main
+			haml :setup
 		else
 			# The network settings are not sane, we don't have an IP.
 			# Redirect the user to the network configuration page to 
@@ -173,10 +162,9 @@ class ConcertoConfigServer < Sinatra::Base
 		protected!
 		url = params[:url]
 		if validate_url(url)
-			File.open(URL_FILE, 'w') do |f|
-				f.write url
-			end
-			
+			# save to the configuration store
+			ConcertoConfig::ConfigStore.write_config('concerto_url', url)
+
 			# root will now redirect to the proper concerto_url
 			redirect '/screen'
 		else
@@ -189,7 +177,7 @@ class ConcertoConfigServer < Sinatra::Base
 	# render a page indicating that the concerto_url is no good.
 	# this page redirects to / every 5 seconds
 	get '/problem' do
-		haml :problem, :layout => :main
+		haml :problem
 	end
 
 	get '/netconfig' do
@@ -201,7 +189,7 @@ class ConcertoConfigServer < Sinatra::Base
 		# is not implemented. This is also how we get away with just having
 		# one instance each of the config classes that are currently selected.
 		begin
-			cm, am = ConcertoConfig.read_config
+			cm, am = ConcertoConfig.read_network_config
 		rescue Errno::ENOENT
 			cm = nil
 			am = nil
@@ -212,8 +200,7 @@ class ConcertoConfigServer < Sinatra::Base
 		haml :netsettings, :locals => { 
 				:connection_method => cm, 
 				:addressing_method => am 
-			},
-			:format => :html5, :layout => :main
+			}
 	end
 
 	# Given the name of a class, pick a class out of a list of allowed classes.
@@ -276,23 +263,8 @@ class ConcertoConfigServer < Sinatra::Base
 		do_assign(cmargs, cm)
 		do_assign(amargs, am)
 
-		# Check that everything is consistent. If not, we currently throw
-		# an exception, which probably is not the best long term solution.
-		cm.validate
-		am.validate
-
-		# Serialize our instances as JSON data to be written to the config file.
-		json_data = {
-			'connection_method' => cmclass.basename,
-			'connection_method_args' => cm.args,
-			'addressing_method' => amclass.basename,
-			'addressing_method_args' => am.args
-		}
-
-		# Write the config file to disk.
-		File.open(ConcertoConfig::CONFIG_FILE, 'w') do |f|
-			f.write json_data.to_json
-		end
+		# Save the configuration file.
+		ConcertoConfig.write_network_config(cm, am)
 
 		# Reload network configuration.
 		STDERR.puts "Trying to bring down the interface"
@@ -300,13 +272,30 @@ class ConcertoConfigServer < Sinatra::Base
 			ConcertoConfig.configured_interface.ifdown
 		end
 		STDERR.puts "Rewriting configuration files"
-		ConcertoConfig::configure_system
+		ConcertoConfig::configure_system_network
 		STDERR.puts "Bringing interface back up"
 		ConcertoConfig.configured_interface.ifup
 
 		# Back to the network form.
 		redirect '/netconfig' # as a get request
 	end
+
+	get '/password' do
+		protected!
+		haml :password
+	end
+
+	post '/password' do
+		protected!
+		
+		if params[:newpass] != params[:newpass_confirm]
+			# something something error handling something
+			redirect '/password'
+		end
+		
+		ConcertoConfig::ConfigStore.write_config('password', params[:newpass])
+		redirect '/setup'
+	end
 end
 
 ConcertoConfigServer.run!

data/lib/concerto_client/application/views/password.haml

@@ -0,0 +1,9 @@
+%form{:method=>'post'}
+	%p
+		%label{:for=>'newpass'} New Password
+		%input{:type=>'password', :name=>'newpass'}
+	%p
+		%label{:for=>'newpass_confirm'} Confirm Password
+		%input{:type=>'password', :name=>'newpass_confirm'}
+	%p
+		%input{:type=>'submit', :value=>'Change Password'}

data/lib/concerto_client/application/views/setup.haml

@@ -1,18 +1,25 @@
 %h1 Welcome to Concerto Player
 %p 
-    You're seeing this because your Concerto player has not yet been configured.
-    We need the URL of your Concerto instance before we can get up and running.
+	You're seeing this because your Concerto player has not yet been configured.
+	We need the URL of your Concerto instance before we can get up and running.
 
 %form{:method=>'post'}
-    %p
-        %label{:for=>'url'} URL
-        %input{:type=>'text', :name=>'url'}
-        %input{:type=>'submit', :value=>'Here it is!'}
+	%p
+		%label{:for=>'url'} URL
+		%input{:type=>'text', :name=>'url'}
+		%input{:type=>'submit', :value=>'Here it is!'}
 
 %p
-    The IPv4 address of this screen appears to be:
-    =my_ip
+	The IPv4 address of this screen appears to be:
+	=my_ip
 %p
-    ==This page can be accessed remotely via http://#{my_ip}/setup
+	==This page can be accessed remotely via http://#{my_ip}/setup
 %p
-    Username is root, default password is 'default'.
+	Username is root, default password is 'default'.
+%p 
+	Also, you may want to
+	%a{:href=>'/netconfig'} change network settings
+	or
+	%a{:href=>'/password'} change the configuration password.
+	
+	

data/lib/concerto_client/config_store.rb

@@ -0,0 +1,48 @@
+require 'concerto_client/live_image'
+require 'fileutils'
+
+# A key/value store for strings.
+# Right now implemented as disk files.
+module ConcertoConfig
+	module ConfigStore
+		@@path = nil
+
+		def self.read_config(name, default='')
+			initialize_path if not @@path			
+			file = File.join(@@path, name)
+			rofile = File.join(@@ropath, name)
+
+			# Check the read/write config location first. If nothing there,
+			# check the read-only location. If nothing is there, return default.
+			# This way writes can be made at runtime on read-only media while
+			# still allowing some settings to be "baked into" the media.
+			if File.exist?(file)
+				IO.read(file)
+			elsif File.exist?(rofile)
+				IO.read(rofile)
+			else
+				default
+			end
+		end
+
+		# Write a config to the read/write configuration location.
+		def self.write_config(name, value)
+			initialize_path if not @@path
+			file = File.join(@@path, name)
+
+			File.open(file, 'w') do |f|
+				f.write value
+			end
+		end
+
+		def self.initialize_path
+			@@ropath = File.join(LiveImage.mountpoint, 'concerto', 'config')
+			if LiveImage.readonly?
+				@@path = '/tmp/concerto/config'
+			else
+				@@path = @@ropath
+			end
+			FileUtils.mkdir_p @@path
+		end
+	end
+end

data/lib/concerto_client/live_image.rb

@@ -0,0 +1,25 @@
+# Functions for dealing with the live image
+# (where it's mounted, if it's read-only, etc)
+module ConcertoConfig
+	module LiveImage
+		def self.mountpoint
+			'/live/image'
+		end
+
+		def self.readonly?
+			# on a readonly file system this will fail
+			if not File.exist? self.mountpoint
+				true
+			else
+				begin
+					f = Tempfile.new('test', self.mountpoint)
+					f.close!
+					false
+				rescue 
+					# if the tempfile creation bombs we assume readonly
+					true
+				end
+			end
+		end
+	end
+end

data/lib/concerto_client/netconfig.rb

@@ -3,6 +3,7 @@
 require 'rubygems'
 require 'json'
 require 'ipaddress'
+require 'concerto_client/config_store'
 
 # The big idea here is that we have connection methods (layer 2)
 # and addressing methods (layer 3) and by combining that configuration
@@ -19,21 +20,17 @@ require 'ipaddress'
 # files such as wpa_supplicant.conf, resolv.conf etc.
 
 class Module
+	# Get the name of a class/module and strip off any leading modules.
+	# This is useful in determining arguments for Module#const_get.
     def basename
         name.gsub(/^.*::/, '')
     end
 end
 
 module ConcertoConfig
-    # Where we store the name of the interface we are going to configure.
-    INTERFACE_FILE='/tmp/concerto_configured_interface'
-
     # The Debian interfaces configuration file we are going to write out.
     INTERFACES_FILE='/etc/network/interfaces'
 
-    # The configuration file we will read from.
-    CONFIG_FILE='/live/image/netconfig.json'
-
     # Some useful interface operations.
     class Interface
         # Wrap an interface name (eth0, wlan0 etc) with some useful operations.
@@ -440,17 +437,20 @@ module ConcertoConfig
         end
     end
 
-    # Read a JSON formatted network configuration from an input stream.
+    # Read a JSON formatted network configuration from the config store.
     # This instantiates the connection and addressing method classes
-    # and returns the instances
-    # i.e.
-    # cm, am = read_config(STDIN)
-    def self.read_config
+    # and returns the instances i.e. cm, am = read_network_config
+	# 
+	# If no configuration is saved or it is corrupt this returns
+	# a default configuration that is somewhat likely to work.
+    def self.read_network_config
+		input = ConfigStore.read_config('network_config', '')
+
 		begin
-			input = IO.read(CONFIG_FILE)
 			args = JSON.parse(input)
-		rescue Errno::ENOENT
-			# set up some sane defaults if the config file doesn't exist
+		rescue
+			# set up some sane defaults if we have no configuration
+			# or it can't be parsed
 			args = {
 				'connection_method' => 'WiredConnection',
 				'addressing_method' => 'DHCPAddressing',
@@ -473,19 +473,38 @@ module ConcertoConfig
         return [connection_method, addressing_method]    
     end
 
+	# Save the network configuration to the configuration store.
+	# Arguments are instances of connection method and addressing 
+	# method classes. Throws exception if either one is not valid.
+	def self.write_network_config(cm, am)
+		# Check that everything is consistent. If not, we currently throw
+		# an exception, which probably is not the best long term solution.
+		cm.validate
+		am.validate
+
+		# Serialize our instances as JSON data to be written to the config file.
+		json_data = {
+			'connection_method' => cm.class.basename,
+			'connection_method_args' => cm.args,
+			'addressing_method' => am.class.basename,
+			'addressing_method_args' => am.args
+		}.to_json
+		
+		# Save the serialized configuration.
+		ConfigStore.write_config('network_config', json_data)
+	end
+
     # This reads a JSON configuration file on STDIN and writes the interfaces
     # file. Also the classes instantiated will have a chance to write
     # out any auxiliary files needed.
-    def self.configure_system
-        connection_method, addressing_method = read_config
+    def self.configure_system_network
+        connection_method, addressing_method = read_network_config
 
         ifname = connection_method.config_interface_name
 
         # squirrel away the name of the interface we are configuring
         # This will be useful later for getting network status information.
-        File.open(INTERFACE_FILE, 'w') do |f|
-            f.write ifname
-        end
+		ConfigStore.write_config('network_interface', ifname)
         
         # Write the /etc/network/interfaces file.
         File.open(INTERFACES_FILE, 'w') do |f|
@@ -510,13 +529,11 @@ module ConcertoConfig
 
     # Get the name of the interface we configured
     def self.configured_interface
-        begin
-            ifname = File.open(INTERFACE_FILE) do |f|
-                f.readline.chomp
-            end
-            Interface.new(ifname)
-        rescue
-            nil
-        end
+		ifname = ConfigStore.read_config('network_interface', '')
+		if ifname != ''
+			Interface.new(ifname)
+		else
+			nil
+		end
     end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: concerto_client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-12 00:00:00.000000000Z
+date: 2012-06-12 00:00:00.000000000 Z
 dependencies: []
 description: Client-side tools for Concerto digital signage
 email: andrew@asquaredlabs.com
@@ -19,6 +19,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/concerto_client/config_store.rb
+- lib/concerto_client/live_image.rb
 - lib/concerto_client/netconfig.rb
 - lib/concerto_client/application/app.rb
 - lib/concerto_client/application/public/network.js
@@ -27,6 +29,7 @@ files:
 - lib/concerto_client/application/public/trollface.png
 - lib/concerto_client/application/views/main.haml
 - lib/concerto_client/application/views/setup.haml
+- lib/concerto_client/application/views/password.haml
 - lib/concerto_client/application/views/netsettings.haml
 - lib/concerto_client/application/views/problem.haml
 - bin/concerto_configserver
@@ -51,7 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Concerto Client Tools