sfpagent 0.1.6 → 0.1.9

data/lib/sfpagent/agent.rb

@@ -7,45 +7,42 @@ require 'uri'
 require 'net/http'
 require 'logger'
 require 'json'
+require 'digest/md5'
 
 module Sfp
 	module Agent
 		NetHelper = Object.new.extend(Nuri::Net::Helper)
 
-		if Process.euid == 0
-			CachedDir = '/var/sfpagent'
-		else
-			CachedDir = File.expand_path('~/.sfpagent')
-		end
+		CachedDir = (Process.euid == 0 ? '/var/sfpagent' : File.expand_path('~/.sfpagent'))
 		Dir.mkdir(CachedDir, 0700) if not File.exist?(CachedDir)
 
 		DefaultPort = 1314
+
 		PIDFile = "#{CachedDir}/sfpagent.pid"
 		LogFile = "#{CachedDir}/sfpagent.log"
 		ModelFile = "#{CachedDir}/sfpagent.model"
 		AgentsDataFile = "#{CachedDir}/sfpagent.agents"
 
+		BSigFile = "#{CachedDir}/bsig.model"
+		BSigPIDFile = "#{CachedDir}/bsig.pid"
+
 		@@logger = WEBrick::Log.new(LogFile, WEBrick::BasicLog::INFO ||
 		                                     WEBrick::BasicLog::ERROR ||
 		                                     WEBrick::BasicLog::FATAL ||
 		                                     WEBrick::BasicLog::WARN)
 
-		@@model_lock = Mutex.new
+		@@current_model_hash = nil
+
+		@@bsig = nil
+		@@bsig_modified_time = nil
+		@@bsig_engine = Sfp::BSig.new # create BSig engine instance
+
 		@@runtime_lock = Mutex.new
 
 		def self.logger
 			@@logger
 		end
 
-		def self.check_config(p={})
-			# check modules directory, and create it if it's not exist
-			p[:modules_dir] = "#{CachedDir}/modules" if p[:modules_dir].to_s.strip == ''
-			p[:modules_dir] = File.expand_path(p[:modules_dir].to_s)
-			p[:modules_dir].chop! if p[:modules_dir][-1,1] == '/'
-			Dir.mkdir(p[:modules_dir], 0700) if not File.exists?(p[:modules_dir])
-			p
-		end
-
 		# Start the agent.
 		#
 		# options:
@@ -56,14 +53,29 @@ module Sfp
 		#	:keyfile
 		#
 		def self.start(p={})
+			Process.daemon
+
 			begin
-				@@config = p = check_config(p)
-	
+				# check modules directory, and create it if it's not exist
+				p[:modules_dir] = File.expand_path(p[:modules_dir].to_s.strip != '' ? p[:modules_dir].to_s : "#{CachedDir}/modules")
+				Dir.mkdir(p[:modules_dir], 0700) if not File.exist?(p[:modules_dir])
+				@@config = p
+Sfp::Agent.logger.info "modules dir: " + p[:modules_dir]
+
+				# load modules from cached directory
+				load_modules(p)
+
+				# reload model
+				build_model({:complete => true})
+
+				# create web server
 				server_type = (p[:daemon] ? WEBrick::Daemon : WEBrick::SimpleServer)
 				port = (p[:port] ? p[:port] : DefaultPort)
-	
-				config = {:Host => '0.0.0.0', :Port => port, :ServerType => server_type,
-				          :Logger => @@logger}
+				config = { :Host => '0.0.0.0',
+				           :Port => port,
+				           :ServerType => server_type,
+				           :pid => '/tmp/webrick.pid',
+				           :Logger => Sfp::Agent.logger }
 				if p[:ssl]
 					config[:SSLEnable] = true
 					config[:SSLVerifyClient] = OpenSSL::SSL::VERIFY_NONE
@@ -71,36 +83,44 @@ module Sfp
 					config[:SSLPrivateKey] = OpenSSL::PKey::RSA.new(File.open(p[:keyfile]).read)
 					config[:SSLCertName] = [["CN", WEBrick::Utils::getservername]]
 				end
-
-				load_modules(p)
-				reload_model
-
 				server = WEBrick::HTTPServer.new(config)
-				server.mount("/", Sfp::Agent::Handler, @@logger)
+				server.mount("/", Sfp::Agent::Handler, Sfp::Agent.logger)
+
+				# trap signal
+				['INT', 'KILL', 'HUP'].each { |signal|
+					trap(signal) {
+						Sfp::Agent.logger.info "Shutting down web server"
+						server.shutdown
+					}
+				}
 
+				# send request to local web server to save its PID
 				fork {
-					begin
-						# send request to save PID
-						sleep 2
-						url = URI.parse("http://127.0.0.1:#{config[:Port]}/pid")
-						http = Net::HTTP.new(url.host, url.port)
-						if p[:ssl]
-							http.use_ssl = p[:ssl]
-							http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+					sleep 0.5
+					1.upto(5) do |i|
+						begin
+							NetHelper.get_data('127.0.0.1', config[:Port], '/pid')
+							break if File.exist?(PIDFile)
+						rescue
+							sleep (i*i)
 						end
-						req = Net::HTTP::Get.new(url.path)
-						http.request(req)
-						puts "\nSFP Agent is running with PID #{File.read(PIDFile)}" if File.exist?(PIDFile)
-					rescue Exception => e
-						Sfp::Agent.logger.warn "Cannot request /pid #{e}"
 					end
+					puts "SFP Agent is running with PID #{File.read(PIDFile)}" if File.exist?(PIDFile)
 				}
 
-				trap('INT') { server.shutdown }
+				# start BSig's main thread in a separate process
+				fork {
+					bsig_engine.enable({:mode => :main})
+				}
+
+				# enable BSig's satisfier
+				bsig_engine.enable({:mode => :satisfier})
 
+				# start web server
 				server.start
+
 			rescue Exception => e
-				@@logger.error "Starting the agent [Failed] #{e}"
+				Sfp::Agent.logger.error "Starting the agent [Failed] #{e}\n#{e.backtrace.join("\n")}"
 				raise e
 			end
 		end
@@ -108,25 +128,36 @@ module Sfp
 		# Stop the agent's daemon.
 		#
 		def self.stop
+			# stopping web server (main thread)
 			pid = (File.exist?(PIDFile) ? File.read(PIDFile).to_i : nil)
 			if not pid.nil? and `ps h #{pid}`.strip =~ /.*sfpagent.*/
-				print "Stopping SFP Agent with PID #{pid} "
-				Process.kill('KILL', pid)
-				puts "[OK]"
-				@@logger.info "SFP Agent daemon has been stopped."
+				Process.kill('HUP', pid)
+				puts "Stopping SFP Agent with PID #{pid}"
+				File.delete(PIDFile) if File.exist?(PIDFile)
 			else
 				puts "SFP Agent is not running."
 			end
-			File.delete(PIDFile) if File.exist?(PIDFile)
+
+			# stopping BSig engine
+			pid_bsig = (File.exist?(BSigPIDFile) ? File.read(BSigPIDFile).to_i : nil)
+			if not pid_bsig.nil? and `ps h #{pid_bsig}`.strip =~ /.*sfpagent.*/
+				Process.kill('HUP', pid_bsig)
+				puts "Stopping BSig engine with PID #{pid_bsig}"
+				File.delete(BSigPIDFile) if File.exist?(BSigPIDFile)
+			else
+				puts "BSig engine is not running."
+			end
+
+			Sfp::Agent.logger.info "SFP Agent daemon has been stopped."
 		end
 
 		# Print the status of the agent.
 		#
 		def self.status
-			pid = (File.exist?(PIDFile) ? File.read(PIDFile).to_i : nil)
-			if pid.nil?
+			if not File.exist?(PIDFile)
 				puts "SFP Agent is not running."
 			else
+				pid = File.read(PIDFile).to_i
 				if `ps hf #{pid}`.strip =~ /.*sfpagent.*/
 					puts "SFP Agent is running with PID #{pid}"
 				else
@@ -134,56 +165,118 @@ module Sfp
 					puts "SFP Agent is not running."
 				end
 			end
+
+			if not File.exist?(BSigPIDFile)
+				puts "BSig engine is not running."
+			else
+				pid = File.read(BSigPIDFile).to_i
+				if `ps hf #{pid}`.strip =~ /.*sfpagent.*/
+					puts "BSig engine is running with PID #{pid}"
+				else
+					File.delete(BSigPIDFile)
+					puts "BSig engine is not running."
+				end
+			end
 		end
 
 		# Save given model to cached file, and then reload the model.
 		#
 		def self.set_model(model)
 			begin
-				@@model_lock.synchronize {
-					@@logger.info "Setting the model [Wait]"
-					File.open(ModelFile, 'w', 0600) { |f|
-						f.write(JSON.generate(model))
+				# generate MD5 hash for the new model
+				data = JSON.generate(model)
+				new_model_hash = Digest::MD5.hexdigest(data)
+
+				# save the new model if it's not same with the existing one
+				if Digest::MD5.hexdigest(data) != @@current_model_hash
+					Sfp::Agent.logger.info "Setting new model [Wait]"
+					File.open(ModelFile, File::RDWR|File::CREAT, 0600) { |f|
+						f.flock(File::LOCK_EX)
+						f.rewind
+						f.write(data)
 						f.flush
+						f.truncate(f.pos)
 					}
-				}
-				reload_model
-				@@logger.info "Setting the model [OK]"
+					build_model
+					Sfp::Agent.logger.info "Setting the model [OK]"
+				else
+					#Sfp::Agent.logger.info "The model is not changed."
+				end
 				return true
 			rescue Exception => e
-				@@logger.error "Setting the model [Failed] #{e}"
+				Sfp::Agent.logger.error "Setting the model [Failed] #{e}\n#{e.backtrace.join("\n")}"
 			end
 			false
 		end
 
-		# Return the model which is read from cached file.
+		# Reload the model from cached file.
+		#
+		def self.build_model(p={})
+			if not File.exist?(ModelFile)
+				Sfp::Agent.logger.info "There is no model in cache."
+			else
+				begin
+					@@runtime_lock.synchronize {
+						data = File.read(ModelFile)
+						@@current_model_hash = Digest::MD5.hexdigest(data)
+						if !defined?(@@runtime) or @@runtime.nil? or p[:complete]
+							@@runtime = Sfp::Runtime.new(JSON[data])
+						else
+							@@runtime.set_model(JSON[data])
+						end
+					}
+					Sfp::Agent.logger.info "Reloading the model in cache [OK]"
+				rescue Exception => e
+					Sfp::Agent.logger.error "Reloading the model in cache [Failed] #{e}\n#{e.backtrace.join("\n")}"
+				end
+			end
+		end
+
+		# Setting a new BSig model: set @@bsig variable, and save in cached file
 		#
-		def self.get_model
-			return nil if not File.exist?(ModelFile)
+		def self.set_bsig(bsig)
 			begin
-				@@model_lock.synchronize {
-					return JSON[File.read(ModelFile)]
+				File.open(BSigFile, File::RDWR|File::CREAT, 0600) { |f|
+					f.flock(File::LOCK_EX)
+					Sfp::Agent.logger.info "Setting the BSig model [Wait]"
+					f.rewind
+					data = (bsig.nil? ? '' : JSON.generate(bsig))
+					f.write(data)
+					f.flush
+					f.truncate(f.pos)
 				}
+				Sfp::Agent.logger.info "Setting the BSig model [OK]"
+				return true
 			rescue Exception => e
-				@@logger.error "Get the model [Failed] #{e}\n#{e.backtrace}"
+				Sfp::Agent.logger.error "Setting the BSig model [Failed] #{e}\n#{e.backtrace.join("\n")}"
 			end
 			false
 		end
 
-		# Reload the model from cached file.
+		# Return a BSig model from cached file
 		#
-		def self.reload_model
-			model = get_model
-			if model.nil?
-				@@logger.info "There is no model in cache."
-			else
-				begin
-					@@runtime_lock.synchronize { @@runtime = Sfp::Runtime.new(model) }
-					@@logger.info "Reloading the model in cache [OK]"
-				rescue Exception => e
-					@@logger.error "Reloading the model in cache [Failed] #{e}"
-				end
+		def self.get_bsig
+			return nil if not File.exist?(BSigFile)
+			return @@bsig if File.mtime(BSigFile) == @@bsig_modified_time
+
+			begin
+				data = File.read(BSigFile)
+				@@bsig = (data.length > 0 ? JSON[data] : nil)
+				@@bsig_modified_time = File.mtime(BSigFile)
+				return @@bsig
+			rescue Exception => e
+				Sfp::Agent.logger.error "Get the BSig model [Failed] #{e}\n#{e.backtrace.join("\n")}"
 			end
+			false
+		end
+
+		def self.bsig_engine
+			@@bsig_engine
+		end
+
+		def self.whoami?
+			return nil if !defined?(@@runtime) or @@runtime.nil?
+			@@runtime.whoami?
 		end
 
 		# Return the current state of the model.
@@ -192,33 +285,31 @@ module Sfp
 			@@runtime_lock.synchronize {
 				return nil if !defined?(@@runtime) or @@runtime.nil?
 				begin
-					@@runtime.get_state if @@runtime.modules.nil?
 					return @@runtime.get_state(as_sfp)
 				rescue Exception => e
-					@@logger.error "Get state [Failed] #{e}\n#{e.backtrace.join("\n")}"
+					Sfp::Agent.logger.error "Get state [Failed] #{e}\n#{e.backtrace.join("\n")}"
 				end
 			}
 			false
 		end
 
 		def self.resolve(path, as_sfp=true)
+			return Sfp::Undefined.new if !defined?(@@runtime) or @@runtime.nil? or @@runtime.root.nil?
 			begin
-				#@@runtime_lock.synchronize {
-					return Sfp::Undefined.new if !defined?(@@runtime) or @@runtime.nil? or @@runtime.modules.nil?
-					path = path.simplify
-					_, node, _ = path.split('.', 3)
-					if @@runtime.modules.has_key?(node)
-						# local resolve
-						parent, attribute = path.pop_ref
-						mod = @@runtime.modules.at?(parent)
-						if mod.is_a?(Hash)
-							mod[:_self].update_state
-							state = mod[:_self].state
-							return state[attribute] if state.has_key?(attribute)
-						end
-						return Sfp::Undefined.new
+				path = path.simplify
+				_, node, _ = path.split('.', 3)
+				if @@runtime.root.has_key?(node)
+					# local resolve
+					parent, attribute = path.pop_ref
+					mod = @@runtime.root.at?(parent)
+					if mod.is_a?(Hash)
+						mod[:_self].update_state
+						state = mod[:_self].state
+						return state[attribute] if state.has_key?(attribute)
 					end
-				#}
+					return Sfp::Undefined.new
+				end
+
 				agents = get_agents
 				if agents[node].is_a?(Hash)
 					# remote resolve
@@ -232,7 +323,7 @@ module Sfp
 					end
 				end
 			rescue Exception => e
-				@@logger.error "Resolve #{path} [Failed] #{e}\n#{e.backtrace.join("\n")}"
+				Sfp::Agent.logger.error "Resolve #{path} [Failed] #{e}\n#{e.backtrace.join("\n")}"
 			end
 			Sfp::Undefined.new
 		end
@@ -242,15 +333,14 @@ module Sfp
 		# @param action contains the action's schema.
 		#
 		def self.execute_action(action)
-			logger = (@@config[:daemon] ? @@logger : Logger.new(STDOUT))
+			logger = (@@config[:daemon] ? Sfp::Agent.logger : Logger.new(STDOUT))
 			action_string = "#{action['name']} #{JSON.generate(action['parameters'])}"
 			begin
 				result = @@runtime.execute_action(action)
 				logger.info "Executing #{action_string} " + (result ? "[OK]" : "[Failed]")
 				return result
 			rescue Exception => e
-				logger.info "Executing #{action_string} [Failed] #{e}\n#{e.backtrace.join("\n")}"
-				logger.error "#{e}\n#{e.bracktrace.join("\n")}"
+				logger.error "Executing #{action_string} [Failed] #{e}\n#{e.backtrace.join("\n")}"
 			end
 			false
 		end
@@ -266,22 +356,22 @@ module Sfp
 			@@modules = []
 			counter = 0
 			if dir != '' and File.exist?(dir)
-				@@logger.info "Modules directory: #{dir}"
+				Sfp::Agent.logger.info "Modules directory: #{dir}"
 				Dir.entries(dir).each { |name|
 					next if name == '.' or name == '..' or File.file?("#{dir}/#{name}")
 					module_file = "#{dir}/#{name}/#{name}.rb"
 					next if not File.exist?(module_file)
 					begin
 						load module_file #require module_file
-						@@logger.info "Loading module #{dir}/#{name} [OK]"
+						Sfp::Agent.logger.info "Loading module #{dir}/#{name} [OK]"
 						counter += 1
 						@@modules << name
 					rescue Exception => e
-						@@logger.warn "Loading module #{dir}/#{name} [Failed]\n#{e}"
+						Sfp::Agent.logger.warn "Loading module #{dir}/#{name} [Failed]\n#{e}"
 					end
 				}
 			end
-			@@logger.info "Successfully loading #{counter} modules."
+			Sfp::Agent.logger.info "Successfully loading #{counter} modules."
 		end
 
 		def self.get_schemata(module_name)
@@ -312,17 +402,16 @@ module Sfp
 			data = {}
 			@@modules.each { |m| data[m] = get_module_hash(m) }
 			data
-			#(defined?(@@modules) and @@modules.is_a?(Array) ? @@modules : [])
 		end
 
 		def self.uninstall_all_modules(p={})
 			return true if @@config[:modules_dir] == ''
 			if system("rm -rf #{@@config[:modules_dir]}/*")
 				load_modules(@@config)
-				@@logger.info "Deleting all modules [OK]"
+				Sfp::Agent.logger.info "Deleting all modules [OK]"
 				return true
 			end
-			@@logger.info "Deleting all modules [Failed]"
+			Sfp::Agent.logger.info "Deleting all modules [Failed]"
 			false
 		end
 
@@ -336,7 +425,7 @@ module Sfp
 				result = true
 			end
 			load_modules(@@config)
-			@@logger.info "Deleting module #{name} " + (result ? "[OK]" : "[Failed]")
+			Sfp::Agent.logger.info "Deleting module #{name} " + (result ? "[OK]" : "[Failed]")
 			result
 		end
 
@@ -366,7 +455,11 @@ module Sfp
 				system("cd #{module_dir}; rm data.tgz")
 			}
 			load_modules(@@config)
-			@@logger.info "Installing module #{name} [OK]"
+			
+			# rebuild the model
+			build_model({:complete => true})
+
+			Sfp::Agent.logger.info "Installing module #{name} [OK]"
 
 			true
 		end
@@ -399,9 +492,12 @@ module Sfp
 			true
 		end
 
+		@@agents_data = nil
+		@@agents_data_modified_time = nil
 		def self.get_agents
 			return {} if not File.exist?(AgentsDataFile)
-			JSON[File.read(AgentsDataFile)]
+			return @@agents_data if File.mtime(AgentsDataFile) == @@agents_data_modified_time
+			@@agents_data = JSON[File.read(AgentsDataFile)]
 		end
 
 		# A class that handles each request.
@@ -445,6 +541,9 @@ module Sfp
 					elsif path == '/model'
 						status, content_type, body = get_model
 
+					elsif path == '/bsig'
+						status, content_Type, body = get_bsig
+
 					elsif path =~ /^\/schemata\/.+/
 						status, content_type, body = get_schemata({:module => path[10, path.length-10]})
 
@@ -469,8 +568,6 @@ module Sfp
 			#
 			# uri:
 			#	/execute => receive an action's schema and execute it
-			#	/migrate => SFP object migration
-			#	/duplicate => SFP object duplication
 			#
 			def do_POST(request, response)
 				status = 400
@@ -481,14 +578,6 @@ module Sfp
 					path = (request.path[-1,1] == '/' ? ryyequest.path.chop : request.path)
 					if path == '/execute'
 						status, content_type, body = self.execute({:query => request.query})
-
-					elsif path =~ /\/migrate\/.+/
-						status, content_type, body = self.migrate({:src => path[8, path.length-8],
-						                                           :dest => request.query['destination']})
-
-					elsif path =~ /\/duplicate\/.+/
-						# TODO
-
 					end
 				end
 
@@ -524,6 +613,12 @@ module Sfp
 					elsif path == '/agents'
 						status, content_type, body = self.manage_agents({:query => request.query})
 
+					elsif path == '/bsig'
+						status, content_type, body = self.set_bsig({:query => request.query})
+
+					elsif path == '/bsig/satisfier'
+						status, content_type, body = self.satisfy_bsig_request({:query => request.query})
+
 					end
 				end
 
@@ -532,35 +627,6 @@ module Sfp
 				response.body = body
 			end
 
-			def migrate(p={})
-				# migrate: source path, destination path
-				#@logger.info "migrate #{p[:src]} => #{p[:dest]}"
-				return [400, 'plain/text', 'Destination path should begin with "/"'] if p[:dest].to_s[0,1] != '/'
-				begin
-					# reformat the source and destination paths to SFP reference
-					p[:src] = '$' + p[:src].gsub(/\//, '.')
-					p[:dest] = '$' + p[:dest].gsub(/\//, '.')
-
-					# find the target in agents' database
-					agents = Sfp::Agent.get_agents
-					data = agents.at?(p[:dest])
-					return [404, 'plain/text', 'Unrecognized destination!'] if !data.is_a?(Hash)
-
-					# send the sub-model to destination
-					model = Sfp::Agent.get_model
-					return [404, '', ''] if model.nil?
-					submodel = model.at?(p[:src])
-
-					# TODO
-					# 1. send the configuration to destination
-
-					return [200, 'plain/text', "#{p[:src]} #{p[:dest]}:#{data.inspect}"]
-				rescue Exception => e
-					@logger.error "Migration failed #{e}\n#{e.backtrace.join("\n")}"
-				end
-				return [500, 'plain/text', e.to_s]
-			end
-
 			def manage_agents(p={})
 				begin
 					if p[:query].has_key?('agents')
@@ -614,11 +680,11 @@ module Sfp
 			end
 
 			def set_model(p={})
-				if p[:query].has_key?('model')
-					# Setting the model was success, and then return '200' status.
+				if p[:query] and p[:query].has_key?('model')
+					# If setting the model was success, then return '200' status.
 					return [200, '', ''] if Sfp::Agent.set_model(JSON[p[:query]['model']])
 				else
-					# Remove the existing model by setting an empty model
+					# Removing the existing model by setting an empty model, if it's success then return '200' status.
 					return [200, '', ''] if Sfp::Agent.set_model({})
 				end
 
@@ -632,7 +698,7 @@ module Sfp
 				# The model is not exist.
 				return [404, '', ''] if model.nil?
 
-				# The model is exist, and then send the model in JSON.
+				# The model is exist, and then send it in JSON.
 				return [200, 'application/json', JSON.generate(model)] if !!model
 
 				# There is an error when retrieving the model!
@@ -657,15 +723,48 @@ module Sfp
 				[500, '', '']
 			end
 
+			def set_bsig(p={})
+				if p[:query] and p[:query].has_key?('bsig')
+					# If setting the BSig model was success, then return '200' status
+					return [200, '', ''] if Sfp::Agent.set_bsig(JSON[p[:query]['bsig']])
+				else
+					# Deleting the existing BSig model by setting with Nil, if it's success then return '200' status.
+					return [200, '', ''] if Sfp::Agent.set_bsig(nil)
+				end
+
+				# There is an error on setting/deleting the BSig model
+				[500, '', '']
+			end
+
+			def get_bsig(p={})
+				bsig = Sfp::Agent.get_bsig
+
+				# The BSig model is not exist
+				return [404, '', ''] if bsig.nil?
+
+				# The BSig model is exist, and then send it in JSON
+				return [200, 'application/json', JSON.generate(bsig)] if !!bsig
+
+				[500, '', '']
+			end
+
+			def satisfy_bsig_request(p={})
+				return [400, '', ''] if not p[:query]
+
+Sfp::Agent.logger.info Sfp::Agent.bsig_engine.to_s
+
+				return [500, '', ''] if Sfp::Agent.bsig_engine.nil?
+
+				req = p[:query]
+				return [200, '', ''] if Sfp::Agent.bsig_engine.receive_goal_from_agent(req['id'].to_i, JSON[req['goal']], req['pi'].to_i)
+
+				[500, '', '']
+			end
+
 			def trusted(address)
 				true
 			end
-		end
-	end
 
-	def self.require(gem, pack=nil)
-		::Kernel.require gem
-	rescue LoadError => e
-		::Kernel.require gem if system("gem install #{pack||gem} --no-ri --no-rdoc")
+		end
 	end
 end