Class: AutomateEm::Communicator

Inherits:
Object
  • Object
show all
Defined in:
lib/automate-em/core/communicator.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(system) ⇒ Communicator

Returns a new instance of Communicator.



11
12
13
14
15
16
17
18
19
20
21
 
# File 'lib/automate-em/core/communicator.rb', line 11

def initialize(system)
	@system = system
	
	@command_lock = Mutex.new
	@status_lock = Mutex.new
	
	@status_register = {}
	@connected_interfaces = {}
	
	@shutdown = true
end

Class Method Details

.select(user, interface, system) ⇒ Object

Set the system to communicate with Up to interfaces to maintain stability here (They should deal with errors)



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/automate-em/core/communicator.rb', line 72

def self.select(user, interface, system)
	System.logger.debug "-- Interface #{interface.class} attempting to select system #{system}"
	if system == 0
		return nil unless user[:system_admin]
		System.communicator.attach(interface)
	else
		sys = nil
		
		if user.class == User
			sys = user.control_systems.select('control_systems.name').where('control_systems.id = ? AND control_systems.active = ?', system.to_i, true).first
			
		elsif user.class == TrustedDevice && user.control_system_id == system.to_i
			sys = User.find(user.user_id).control_systems.select('control_systems.name, control_systems.active').where('control_systems.id = ?', system.to_i).first
			if sys.nil?
				#
				# Kill comms, this key is not valid
				#	Invalidate key
				#
				user.expires = Time.now
				user.save
				interface.shutdown
				return nil
			elsif sys.active == false
				#
				# System offline... Disconnect
				#
				return false
			end
		end
		
		system = sys.nil? ? nil : sys.name.to_sym
		if System[system].nil?
			interface.shutdown	#kill comms
			return nil
		end
		
		System.logger.debug "-- Interface #{interface.class} selected system #{system}"
		return System[system].communicator.attach(interface)
	end
end

.system_list(user) ⇒ Object

Systems avaliable to this user



54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/automate-em/core/communicator.rb', line 54

def self.system_list(user)
	response = {:ids => [], :names => []}
	
	if user.class == User
		user.control_systems.select('control_systems.id, control_systems.name').each do |controller|
			if !!System[controller.name.to_sym]
				response[:ids] << controller.id
				response[:names] << controller.name
			end
		end 	# We ignore token requests here as they should know the system they can connect to
	end
	return response
end

Instance Method Details

#attach(interface) ⇒ Object 



302
303
304
305
306
307
308
 
# File 'lib/automate-em/core/communicator.rb', line 302

def attach(interface)
	@status_lock.synchronize {
		return nil if @shutdown || interface.nil?
		@connected_interfaces[interface] = [] unless @connected_interfaces.include?(interface)
	}
	return self
end

#disconnected(interface) ⇒ Object

Keep track of connected systems



119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/automate-em/core/communicator.rb', line 119

def disconnected(interface)
	@status_lock.synchronize {
		status_array = @connected_interfaces.delete(interface)
		status_array.each do |status_hash|
			status_hash.delete(interface)
		end
		#
		# TODO::Refactor required
		#	This still isn't perfect as we could be observing modules we are not using...
		#
	}
	logger.debug "-- Interface #{interface.class} disconnected" unless logger.nil?
end

#logger ⇒ Object 



24
25
26
 
# File 'lib/automate-em/core/communicator.rb', line 24

def logger
	@system.logger
end

#register(interface, mod, status, &block) ⇒ Object

Keep track of status events



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/automate-em/core/communicator.rb', line 137

def register(interface, mod, status, &block)
	mod_sym = mod.class == String ? mod.to_sym : mod	# remember the symbol used by the interface to reference this module
	status = status.to_sym if status.class == String
	
	if @system.modules[mod_sym].present?
		mod = @system.modules[mod_sym].instance	# most efficient

		theVal = nil
		@status_lock.synchronize {
			@status_register[mod] ||= {}
			@status_register[mod][status] ||= {}
			@status_register[mod][status][interface] = mod_sym
			@connected_interfaces[interface] << @status_register[mod][status] unless @connected_interfaces[interface].nil?
			theVal = mod[status]
		}
		
		mod.add_observer(self)
		logger.debug "-- Interface #{interface.class} registered #{mod_sym}:#{status}"
		
		#
		# Send the status to this requestor!
		#	This is the same as in update
		#
		if !theVal.nil?
			begin
				function = "#{mod_sym.to_s.downcase}_#{status}_changed".to_sym
				
				if interface.respond_to?(function)
					interface.__send__(function, theVal)
				else
					interface.notify(mod_sym, status, theVal)
				end
			rescue => e
				AutomateEm.print_error(logger, e, {
					:message => "in communicator.rb, register : bad interface or user module code",
					:level => Logger::ERROR
				})
			end
		end
	else
		logger.warn "in communicator.rb, register : #{interface.class} called register on a bad module name"
		block.call() unless block.nil?	# Block will inform of any errors
	end
rescue => e
	begin
		AutomateEm.print_error(logger, e, {
			:message => "in communicator.rb, register : #{interface.class} failed to register #{mod.inspect}.#{status.inspect}",
			:level => Logger::ERROR
		})
		block.call() unless block.nil?	# Block will inform of any errors
	rescue => x
		AutomateEm.print_error(logger, x, {
			:message => "in communicator.rb, register : #{interface.class} provided a bad block",
			:level => Logger::WARN
		})
	end
ensure
	ActiveRecord::Base.clear_active_connections!
end

#send_command(mod, command, *args, &block) ⇒ Object

Pass commands to the selected system



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/automate-em/core/communicator.rb', line 271

def send_command(mod, command, *args, &block)
	#
	# Accept String, argument array
	#	String
	#
	mod = mod.to_sym if mod.class == String
	logger.debug "-- Command requested #{mod}.#{command}(#{args})"
	
	begin
		@command_lock.synchronize {
			@system.modules[mod].instance.public_send(command, *args)	# Not send string however call function command
		}
	rescue => e
		AutomateEm.print_error(logger, e, {
			:message => "module #{mod} in communicator.rb, send_command : command unavaliable or bad module code",
			:level => Logger::WARN
		})
		begin
			block.call() unless block.nil?	# Block will inform of any errors
		rescue => x
			AutomateEm.print_error(logger, x, {
				:message => "in communicator.rb, send_command : interface provided bad block",
				:level => Logger::ERROR
			})
		end
	ensure
		ActiveRecord::Base.clear_active_connections!
	end
end

#shutdown ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/automate-em/core/communicator.rb', line 29

def shutdown
	@status_lock.synchronize {
		@shutdown = true
		@system.modules.each_value do |mod|
			mod.instance.delete_observer(self)
		end
		@status_register = {}			
		@connected_interfaces.each_key do |soc|
			soc.shutdown
		end
	}
	logger.debug "-- Communicator shutdown"
end

#start(nolog = false) ⇒ Object

Logging isn’t active for the very first of these



43
44
45
46
47
48
 
# File 'lib/automate-em/core/communicator.rb', line 43

def start(nolog = false)			# Logging isn't active for the very first of these
	@status_lock.synchronize {
		@shutdown = false
	}
	logger.debug "-- Communicator started" unless nolog
end

#unregister(interface, mod, status, &block) ⇒ Object 



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/automate-em/core/communicator.rb', line 197

def unregister(interface, mod, status, &block)
	mod_sym = mod.to_sym if mod.class == String
	status = status.to_sym if status.class == String
	
	mod = @system.modules[mod_sym].instance
	logger.debug "Interface #{interface.class} unregistered #{mod_sym}:#{status}"

	@status_lock.synchronize {
		@status_register[mod] ||= {}
		@status_register[mod][status] ||= {}
		@status_register[mod][status].delete(interface)
		@connected_interfaces[interface].delete(@status_register[mod][status]) unless @connected_interfaces[interface].nil?

		#
		# TODO:: deleteing the observer will delete all status updates
		#	This needs to be more selective.
		#	We only delete the observer if all the mod[status]'s are empty
		#
		#if @status_register[mod][status].empty?
		#	mod.delete_observer(self)
		#end
	}
rescue => e
	logger.warn "in communicator.rb, unregister : #{interface.class} called unregister when it was not needed"
	#logger.warn e.message
	#logger.warn e.backtrace
	begin
		block.call() if !block.nil?	# Block will inform of any errors
	rescue => x
		AutomateEm.print_error(logger, x, {
			:message => "in communicator.rb, unregister : #{interface.class} provided a bad block",
			:level => Logger::WARN
		})
	end
end

#update(mod, status, data) ⇒ Object 



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/automate-em/core/communicator.rb', line 233

def update(mod, status, data)
	@status_lock.synchronize {
		return if @status_register[mod].nil? || @status_register[mod][status].nil?
	
		#
		# Interfaces should implement the notify function
		#	Or a function for that particular event
		#
		@status_register[mod][status].each_pair do |interface, mod|
			EM.defer do	# to avoid deadlock
				begin
					function = "#{mod.to_s.downcase}_#{status}_changed".to_sym
					if interface.respond_to?(function)				# Can provide a function to deal with status updates
						interface.__send__(function, data)
					else
						interface.notify(mod, status, data)
					end
				rescue => e
					AutomateEm.print_error(logger, e, {
						:message => "in communicator.rb, update : bad interface or user module code",
						:level => Logger::ERROR
					})
				ensure
					ActiveRecord::Base.clear_active_connections!
				end
			end
		end
	}
rescue => e
	AutomateEm.print_error(logger, e, {
		:message => "in communicator.rb, update : This should never happen",
		:level => Logger::ERROR
	})
end