Project

General

Profile

Download (9.42 KB) Statistics
| Branch: | Tag: | Revision:

root/lib/cyborghood/cyborg/conversation.rb @ 45333094

b7f7d214 Marc Dequènes (Duck)
#--
# CyborgHood, a distributed system management software.
# Copyright (c) 2009-2010 Marc Dequènes (Duck) <Duck@DuckCorp.org>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#++

cdd6154d Marc Dequènes (Duck)
require 'yaml'
b7f7d214 Marc Dequènes (Duck)
require 'cyborghood/cyborg/session'
7e9520c0 Marc Dequènes (Duck)
require 'cyborghood/cyborg/protocol'
b7f7d214 Marc Dequènes (Duck)

module CyborgHood
e26c015f Marc Dequènes (Duck)
class ConversationThread
attr_reader :conversation, :name, :id, :session

3d653143 Marc Dequènes (Duck)
def initialize(conversation, id, name)
e26c015f Marc Dequènes (Duck)
@conversation = conversation
@name = name
688a21d7 Marc Dequènes (Duck)
@id = id
e26c015f Marc Dequènes (Duck)
@session = Session.new
@next_action_id = 0
end

def new_message(action_code, parameters = nil, action_id = nil)
45333094 Marc Dequènes (Duck)
Message.new(self, action_code, parameters, action_id)
e26c015f Marc Dequènes (Duck)
end

def next_action_id
id = @next_action_id
@next_action_id +=1
id
end

def close
@session.clear
end
end

class Message
45333094 Marc Dequènes (Duck)
attr_reader :conv_thread, :action_code, :action_parameters, :action_id, :reply_to_action_id
e26c015f Marc Dequènes (Duck)
3d653143 Marc Dequènes (Duck)
def initialize(conv_thread, action_code, action_parameters = nil, action_id = nil)
e26c015f Marc Dequènes (Duck)
@conv_thread = conv_thread
@action_code = action_code
@action_parameters = action_parameters
45333094 Marc Dequènes (Duck)
@reply_to_action_id = action_id

@action_id = nil
e26c015f Marc Dequènes (Duck)
end

def new?
45333094 Marc Dequènes (Duck)
@reply_to_action_id.nil?
end

def sent?
e26c015f Marc Dequènes (Duck)
@action_id.nil?
end

def send
45333094 Marc Dequènes (Duck)
raise CyberError.new(:unrecoverable, "bot/conversation", "Not sending twice the same message") unless self.sent?
e26c015f Marc Dequènes (Duck)
@action_id = @conv_thread.next_action_id
688a21d7 Marc Dequènes (Duck)
@conv_thread.conversation.send_message(self)
e26c015f Marc Dequènes (Duck)
end

45333094 Marc Dequènes (Duck)
def create_reply(action_code, parameters = nil)
e26c015f Marc Dequènes (Duck)
raise CyberError.new(:unrecoverable, "bot/conversation", "Cannot reply to a newly created message") if self.new?
45333094 Marc Dequènes (Duck)
self.class.new(@conv_thread, action_code, parameters, @action_id)
cdd6154d Marc Dequènes (Duck)
end
end

b7f7d214 Marc Dequènes (Duck)
class Conversation < EventMachine::Protocols::LineAndTextProtocol
# don't rely on EventMachine's default, it may change one day
MaxLineLength = 16*1024

EOD = "\033[0J"
45333094 Marc Dequènes (Duck)
BOT_NAME_PATTERN = "[A-Z][a-zA-Z0-9]+"
e26c015f Marc Dequènes (Duck)
ACTION_WORD_PATTERN = "[a-zA-Z0-9]+"
45333094 Marc Dequènes (Duck)
ACTION_PATTERN = "^(#{BOT_NAME_PATTERN})-([0-9]{4})-([0-9]{4})([+]?) (#{ACTION_WORD_PATTERN}( #{ACTION_WORD_PATTERN})*)$"
cc684758 Marc Dequènes (Duck)
MAXIMUM_ERROR_COUNT = 3
cdd6154d Marc Dequènes (Duck)
MAXIMUM_LINES = 1024

45333094 Marc Dequènes (Duck)
attr_reader :bot, :peer_name, :peer_capabilities
b7f7d214 Marc Dequènes (Duck)
45333094 Marc Dequènes (Duck)
def initialize(bot, block = nil)
3d653143 Marc Dequènes (Duck)
@bot = bot
d57fd602 Marc Dequènes (Duck)
@comm_logic_block = block
b7f7d214 Marc Dequènes (Duck)
super

@config = Config.instance
e26c015f Marc Dequènes (Duck)
45333094 Marc Dequènes (Duck)
@error_count = 0
b7f7d214 Marc Dequènes (Duck)
@split_data_mode = false
e26c015f Marc Dequènes (Duck)
@split_data_message = nil
b7f7d214 Marc Dequènes (Duck)
@split_data = []
e26c015f Marc Dequènes (Duck)
# associated conversation threads
@conv_threads = {}
45333094 Marc Dequènes (Duck)
@conv_threads_index = {}
e26c015f Marc Dequènes (Duck)
# thread 0 is reserved
688a21d7 Marc Dequènes (Duck)
@next_thread_id = 0
e26c015f Marc Dequènes (Duck)
@system_thread = self.thread('system')

# post-negociation peer info
45333094 Marc Dequènes (Duck)
@peer_name = nil
cdd6154d Marc Dequènes (Duck)
@peer_capabilities = []
688a21d7 Marc Dequènes (Duck)
45333094 Marc Dequènes (Duck)
@comm_stop = false

688a21d7 Marc Dequènes (Duck)
@protocol = BotProtocol.new(self)
e26c015f Marc Dequènes (Duck)
end
cdd6154d Marc Dequènes (Duck)
b7f7d214 Marc Dequènes (Duck)
def post_init
45333094 Marc Dequènes (Duck)
logger.info "New conversation with #{identifier}"
@protocol.send_announce_helo unless @comm_logic_block.nil?
rescue
logger.error "Conversation post_init: " + $!
connection_close
b7f7d214 Marc Dequènes (Duck)
end

def receive_line(data)
45333094 Marc Dequènes (Duck)
return if @comm_stop or data.empty?
b7f7d214 Marc Dequènes (Duck)
e26c015f Marc Dequènes (Duck)
clear_receive_info
cdd6154d Marc Dequènes (Duck)
b7f7d214 Marc Dequènes (Duck)
if data == EOD
logger.debug "Received EOD [#{identifier}]"
exit_split_mode
else
if @split_data_mode
logger.debug "Received data (split mode) [#{identifier}]: #{data}"

cdd6154d Marc Dequènes (Duck)
if @split_data.size > MAXIMUM_LINES
reply_fatal_error "overflow"
else
@split_data << data
end
b7f7d214 Marc Dequènes (Duck)
else
logger.debug "Received data [#{identifier}]: #{data}"

cdd6154d Marc Dequènes (Duck)
if data =~ Regexp.new(ACTION_PATTERN)
45333094 Marc Dequènes (Duck)
# TODO: pass peer_name into Message and use it in Protocol to check replies match
peer_name = $1
conv_thread_id = $2.to_i
action_id = $3.to_i
flags = $4 || ""
action_code = $5
cc684758 Marc Dequènes (Duck)
e26c015f Marc Dequènes (Duck)
conv_thread = self.thread_by_id(conv_thread_id)
message = conv_thread.new_message(action_code, nil, action_id)

if flags.index '+'
enter_split_mode(message)
cc684758 Marc Dequènes (Duck)
else
e26c015f Marc Dequènes (Duck)
receive_message(message)
cc684758 Marc Dequènes (Duck)
end
e26c015f Marc Dequènes (Duck)
else
reply_syntax_error "bad action format"
b7f7d214 Marc Dequènes (Duck)
end
end
end
cdd6154d Marc Dequènes (Duck)
fccfdfb9 Marc Dequènes (Duck)
check_errors
end

e26c015f Marc Dequènes (Duck)
def receive_message(message)
45333094 Marc Dequènes (Duck)
logger.debug "Received message '#{message.action_code}' [#{identifier}]"
cdd6154d Marc Dequènes (Duck)
688a21d7 Marc Dequènes (Duck)
@protocol.process_received_message(message)
b7f7d214 Marc Dequènes (Duck)
end

def receive_error(msg)
logger.error "Error [#{identifier}]: #{msg}"
fccfdfb9 Marc Dequènes (Duck)
@error_count += 1
b7f7d214 Marc Dequènes (Duck)
end

def unbind
45333094 Marc Dequènes (Duck)
logger.info "Conversation finished with #{identifier} (#{@peer_name})"
@bot.unregister_communication @peer_name unless @peer_name.nil?
@conv_threads.each_value {|s| s.close }
@comm_logic_block.call false unless @comm_logic_block.nil? or @protocol.negociation_ok?
cdd6154d Marc Dequènes (Duck)
end

3d653143 Marc Dequènes (Duck)
def bye
45333094 Marc Dequènes (Duck)
@protocol.send_quit_leaving
3d653143 Marc Dequènes (Duck)
end

45333094 Marc Dequènes (Duck)
def set_peer_info(name, capabilities)
@peer_name = name
cdd6154d Marc Dequènes (Duck)
@peer_capabilities = capabilities || []
45333094 Marc Dequènes (Duck)
logger.info "Peer name for #{identifier}: #{@peer_name}"
logger.info "Peer capabilities for #{identifier}: #{@peer_capabilities.join(", ")}"
@bot.register_communication @peer_name, self
cdd6154d Marc Dequènes (Duck)
end

d57fd602 Marc Dequènes (Duck)
def set_comm_ready
45333094 Marc Dequènes (Duck)
logger.info "Protocol negociation with '#{@peer_name}' on #{identifier} succeeded"
@comm_logic_block.call self unless @comm_logic_block.nil?
end

def set_comm_stop
@comm_stop = true
yield if block_given?
close_connection_after_writing
d57fd602 Marc Dequènes (Duck)
end

e26c015f Marc Dequènes (Duck)
def set_error_status(fatal = false)
# fatal status is conservative, it cannot be canceled
@reveive_fatal_error = @reveive_fatal_error || fatal
@receive_error = true
end

def thread(name = 'default')
688a21d7 Marc Dequènes (Duck)
@conv_threads[name] || new_thread(name)
cdd6154d Marc Dequènes (Duck)
end

e26c015f Marc Dequènes (Duck)
def thread_by_id(id)
name = @conv_threads_index[id]
688a21d7 Marc Dequènes (Duck)
name.nil? ? new_thread("noname/#{id}", id) : @conv_threads[name]
cdd6154d Marc Dequènes (Duck)
end

e26c015f Marc Dequènes (Duck)
def send_message(message)
raise CyberError.new(:unrecoverable, "bot/conversation", "Cannot send message without action id") if message.action_id.nil?

45333094 Marc Dequènes (Duck)
flags = ""
flags += "+" unless message.action_parameters.nil?

send_line sprintf("%s-%04d-%04d%s %s", @bot.name, message.conv_thread.id, message.action_id, flags, message.action_code)
e26c015f Marc Dequènes (Duck)
unless message.action_parameters.nil?
45333094 Marc Dequènes (Duck)
message.action_parameters.to_yaml.each_line {|l| send_line l }
e26c015f Marc Dequènes (Duck)
send_line EOD
end
b7f7d214 Marc Dequènes (Duck)
end

protected

69a12fdb Marc Dequènes (Duck)
def clear_receive_info
@receive_error = false
@receive_fatal_error = false
end

def send_line(msg)
d57fd602 Marc Dequènes (Duck)
return if error?

69a12fdb Marc Dequènes (Duck)
logger.debug "Sending data [#{identifier}]: #{msg}"
send_data "#{msg}\n"
end

def check_errors
@error_count += 1 if @receive_error

msg_quit = nil
if @error_count >= MAXIMUM_ERROR_COUNT
msg_quit = "too much errors, terminating"
elsif @fatal_error
msg_quit = "previous fatal error"
end

45333094 Marc Dequènes (Duck)
@protocol.send_quit_decline msg_quit unless msg_quit.nil?
69a12fdb Marc Dequènes (Duck)
end

688a21d7 Marc Dequènes (Duck)
def new_thread(name, id = nil)
id ||= @next_thread_id
th = ConversationThread.new(self, id, name)
@next_thread_id = [@next_thread_id, id + 1].max

@conv_threads[th.name] = th
# allow searching by id too
@conv_threads_index[th.id] = name
th
end

cdd6154d Marc Dequènes (Duck)
def reply_syntax_error(msg = nil)
e26c015f Marc Dequènes (Duck)
logger.error "Protocol error [#{identifier}]: syntax error (#{msg})"

cdd6154d Marc Dequènes (Duck)
msg = "syntax error" + (msg ? ": " + msg : "")
@protocol.send_error_protocol(msg)
end

def reply_fatal_error(msg = nil)
e26c015f Marc Dequènes (Duck)
logger.error "Protocol error [#{identifier}]: fatal error (#{msg})"

cdd6154d Marc Dequènes (Duck)
msg = "fatal error" + (msg ? ": " + msg : "")
fccfdfb9 Marc Dequènes (Duck)
@protocol.send_error_protocol(msg, true)
cdd6154d Marc Dequènes (Duck)
end

e26c015f Marc Dequènes (Duck)
def enter_split_mode(message)
b7f7d214 Marc Dequènes (Duck)
if @split_data_mode
e26c015f Marc Dequènes (Duck)
reply_fatal_error "already in split mode"
b7f7d214 Marc Dequènes (Duck)
@split_data_mode = false
e26c015f Marc Dequènes (Duck)
@split_data_message = nil
b7f7d214 Marc Dequènes (Duck)
else
e26c015f Marc Dequènes (Duck)
logger.debug "Protocol info [#{identifier}]: entered split mode for action '#{message.action_id}'"
b7f7d214 Marc Dequènes (Duck)
@split_data_mode = true
e26c015f Marc Dequènes (Duck)
@split_data_message = message
b7f7d214 Marc Dequènes (Duck)
end
@split_data = []
end

def exit_split_mode
if @split_data_mode
e26c015f Marc Dequènes (Duck)
logger.debug "Protocol info [#{identifier}]: quit split mode for action '#{@split_data_message.action_id}'"

45333094 Marc Dequènes (Duck)
parameters = YAML.load(@split_data.join("\n"))
e26c015f Marc Dequènes (Duck)
reply_syntax_error("bad parameters format") if parameters.nil?

45333094 Marc Dequènes (Duck)
message = @split_data_message.conv_thread.new_message(@split_data_message.action_code, parameters, @split_data_message.reply_to_action_id)
e26c015f Marc Dequènes (Duck)
receive_message(message)
b7f7d214 Marc Dequènes (Duck)
else
e26c015f Marc Dequènes (Duck)
reply_fatal_error "not in split mode"
b7f7d214 Marc Dequènes (Duck)
end
@split_data_mode = false
e26c015f Marc Dequènes (Duck)
@split_data_message = nil
b7f7d214 Marc Dequènes (Duck)
@split_data = []
end

def identifier
bc642412 Marc Dequènes (Duck)
"#{@bot.identifier_prefix}/#{@signature}"
69a12fdb Marc Dequènes (Duck)
end
b7f7d214 Marc Dequènes (Duck)
end
end