cirrocumulus 0.4.6 → 0.5.2

data/VERSION

@@ -1 +1 @@
-0.4.6
+0.5.2

data/cirrocumulus.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{cirrocumulus}
-  s.version = "0.4.6"
+  s.name = "cirrocumulus"
+  s.version = "0.5.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Anton Kosyakin"]
-  s.date = %q{2011-10-27}
-  s.description = %q{Engine for building your own agents, providing you base functionality for loading ontologies, communicating with other agents and parsing FIPA-ACL messages}
-  s.email = %q{deil@mneko.net}
+  s.date = "2011-12-01"
+  s.description = "Engine for building your own agents, providing you base functionality for loading ontologies, communicating with other agents and parsing FIPA-ACL messages"
+  s.email = "deil@mneko.net"
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.rdoc"
@@ -19,7 +19,6 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
     "Gemfile",
-    "Gemfile.lock",
     "LICENSE.txt",
     "README.rdoc",
     "Rakefile",
@@ -27,26 +26,26 @@ Gem::Specification.new do |s|
     "cirrocumulus.gemspec",
     "lib/cirrocumulus.rb",
     "lib/cirrocumulus/agent.rb",
+    "lib/cirrocumulus/agent_wrapper.rb",
     "lib/cirrocumulus/engine.rb",
     "lib/cirrocumulus/kb.rb",
     "lib/cirrocumulus/logger.rb",
-    "lib/cirrocumulus/master_agent.rb",
     "lib/cirrocumulus/ontology.rb",
     "lib/cirrocumulus/rule_engine.rb",
     "lib/cirrocumulus/rule_server.rb",
+    "lib/cirrocumulus/rules/engine.rb",
+    "lib/cirrocumulus/rules/run_queue.rb",
     "lib/cirrocumulus/saga.rb",
-    "lib/test.rb",
     "test/helper.rb",
     "test/test_cirrocumulus.rb"
   ]
-  s.homepage = %q{http://github.com/deil/cirrocumulus}
+  s.homepage = "http://github.com/deil/cirrocumulus"
   s.licenses = ["GPL-2"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Agent-based infrastructure management system}
+  s.rubygems_version = "1.8.10"
+  s.summary = "Agent-based infrastructure management system"
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
@@ -54,7 +53,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<log4r>, ["~> 1.1.9"])
       s.add_runtime_dependency(%q<systemu>, [">= 0"])
       s.add_runtime_dependency(%q<xmpp4r>, ["~> 0.5"])
-      s.add_runtime_dependency(%q<xmpp4r-simple>, ["~> 0.8.8"])
+      s.add_runtime_dependency(%q<xmpp4r-simple>, [">= 0"])
       s.add_runtime_dependency(%q<eventmachine>, [">= 0"])
       s.add_runtime_dependency(%q<deil_sexpistol>, [">= 0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
@@ -65,7 +64,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<log4r>, ["~> 1.1.9"])
       s.add_dependency(%q<systemu>, [">= 0"])
       s.add_dependency(%q<xmpp4r>, ["~> 0.5"])
-      s.add_dependency(%q<xmpp4r-simple>, ["~> 0.8.8"])
+      s.add_dependency(%q<xmpp4r-simple>, [">= 0"])
       s.add_dependency(%q<eventmachine>, [">= 0"])
       s.add_dependency(%q<deil_sexpistol>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
@@ -77,7 +76,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<log4r>, ["~> 1.1.9"])
     s.add_dependency(%q<systemu>, [">= 0"])
     s.add_dependency(%q<xmpp4r>, ["~> 0.5"])
-    s.add_dependency(%q<xmpp4r-simple>, ["~> 0.8.8"])
+    s.add_dependency(%q<xmpp4r-simple>, [">= 0"])
     s.add_dependency(%q<eventmachine>, [">= 0"])
     s.add_dependency(%q<deil_sexpistol>, [">= 0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])

data/lib/cirrocumulus/agent.rb

@@ -1,4 +1,6 @@
-class Agent
+require 'thread'
+
+module Agent
   class AgentInfo
     attr_accessor :identifier
     attr_accessor :default_ontology
@@ -135,48 +137,106 @@ class Agent
     end
   end
 
-  attr_reader :default_ontology
-  attr_reader :identifier
-  attr_reader :network_map
-  
-  def initialize(cm)
-    @cm = cm
-    @identifier = cm.jid
-    @sagas = []
-    @saga_idx = 0
-    @network_map = NetworkMap.new(self)
-  end
+  class Base
+    attr_reader :identifier
+    attr_reader :network_map
 
-  def tick()
-    @network_map.tick(@cm)
+    def initialize(cm)
+      Log4r::Logger['agent'].info('Initializing new agent')
 
-    @sagas.each do |saga|
-      next if saga.is_finished?
-      saga.timeout -= 1 if saga.timeout > 0
-      saga.handle(nil) if saga.timeout == 0
+      @cm = cm
+      @identifier = cm.jid
+      @ontologies = []
+      @message_queues = {}
+      @worker_threads = {}
+      #@network_map = NetworkMap.new(self)
     end
-  end
-  
-  def restore_state()
-  end
 
-  def handles_ontology?(ontology)
-    return @default_ontology == ontology || ontology == 'cirrocumulus-map'
-  end
+    # Loads ontologies into agent
+    def load_ontologies(ontologies_list)
+      ontologies_list.each do |ontology_name|
+        ontology = eval("#{ontology_name}.new(self)")
+        @ontologies << ontology
+        @message_queues[ontology] = Queue.new
+      end
+    end
 
-  def handle_message(message, kb)
-    @network_map.handle_message(message, @cm)
+    def default_ontology
+      self.ontologies.size == 1 ? self.ontologies.first.name : nil
+    end
 
-    if message.ontology != 'cirrocumulus-map'
-      handle(message, kb)
+    # Returns true if this agents supports requested ontology
+    def handles_ontology?(ontology_name)
+      self.ontologies.any? {|ontology| ontology.name == ontology_name}
+    end
+
+    # Asks each loaded ontology to restore its state
+    def restore_state()
+      Log4r::Logger['agent'].info 'Restoring previous state..'
+
+      threads = []
+      self.ontologies.each do |ontology|
+        threads << Thread.new do
+          begin
+            ontology.restore_state()
+          rescue Exception => e
+            Log4r::Logger['agent'].warn "failed to restore state for ontology %s" % ontology.name
+            Log4r::Logger['agent'].warn "%s: %s" % [e.to_s, e.backtrace.to_s]
+          end
+        end
+      end
+
+      threads.each {|thrd| thrd.join}
+      Log4r::Logger['agent'].info 'State restored successfully!'
+    end
+
+    # Starts message processing threads
+    def start()
+      start_workers()
+    end
+
+    def send_message(message)
+      @cm.send_message(message)
+    end
+
+    def handle_message(message)
+      #@network_map.handle_message(message, @cm)
+
+      self.ontologies.each {|ontology|
+        if message.ontology == ontology.name || ontology.sagas.any? {|saga| saga.id == message.in_reply_to}
+          @message_queues[ontology] << message
+          break
+        end
+      }
+    end
+
+    protected
+
+    attr_reader :cm
+    attr_reader :ontologies
+
+    def start_workers()
+      self.ontologies.each do |ontology|
+        @worker_threads[ontology] = Thread.new do
+          Log4r::Logger['agent'].info "Starting worker for ontology %s" % [ontology.name]
+          process_ontology(ontology, @message_queues[ontology])
+        end
+      end
+    end
+
+    def process_ontology(ontology, queue)
+      while true do
+        message = queue.pop(true) rescue nil
+        begin
+          ontology.handle_incoming_message(message, nil) if message
+        rescue Exception => e
+          Log4r::Logger['agent'].warn "failed to handle incoming message for ontology %s: %s" % [ontology.name, e.to_s]
+          Log4r::Logger['agent'].warn e.backtrace.to_s
+        end
+
+        ontology.tick()
+        sleep 0.5
+      end
     end
-  end
-  
-  def self.get_node(sender)
-    sender.split('-').first
-  end
-  
-  def self.get_subsystem(sender)
-    sender.split('-').second
   end
 end

data/lib/cirrocumulus/agent_wrapper.rb

@@ -0,0 +1,68 @@
+unless Kernel.respond_to?(:require_relative)
+  module Kernel
+    def require_relative(path)
+      require File.join(File.dirname(caller[0]), path.to_str)
+    end
+  end
+end
+
+require 'yaml'
+require 'cirrocumulus'
+require 'cirrocumulus/logger'
+require 'cirrocumulus/engine'
+require 'cirrocumulus/kb'
+require 'cirrocumulus/ontology'
+require 'cirrocumulus/agent'
+
+class String
+  def underscore
+    self.gsub(/::/, '/').
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr("-", "_").
+    downcase
+  end
+end
+
+ontologies_file_name = nil
+
+ARGV.each_with_index do |arg, i|
+  if arg == '-c'
+    ontologies_file_name = ARGV[i + 1]
+  end
+end
+
+if ontologies_file_name.nil?
+  puts "Please supply config file name"
+  exit(0)
+end
+
+puts "Loading configuration.."
+agent_config = YAML.load_file(ontologies_file_name)
+ontologies = agent_config['ontologies']
+ontologies.each do |ontology_name|
+  puts "Will load ontology %s" % ontology_name
+  require File.join(AGENT_ROOT, 'ontologies', ontology_name.underscore)
+end
+
+kb_name = agent_config['kb']
+kb = if kb_name
+  puts "Will load knowledge base %s" % kb_name
+  require File.join(AGENT_ROOT, 'ontologies/xen/', kb_name.underscore) # TODO
+  eval("#{kb_name}.new()")
+else
+  Kb.new
+end
+
+cm = Cirrocumulus.new('master')
+a = Agent::Base.new(cm)
+a.load_ontologies(agent_config['ontologies'])
+begin
+  cm.run(a, kb)
+rescue Exception => e
+  puts 'Got an error:'
+  puts e
+  puts e.backtrace
+end
+
+puts "\nBye-bye."

data/lib/cirrocumulus/engine.rb

@@ -1,9 +1,11 @@
 require 'systemu'
+require 'thread'
 
 class Cirrocumulus
+  # Message. Used by agents to communicate
   class Message
     attr_accessor :sender, :act, :content
-    attr_accessor :receiver, :reply_with, :in_reply_to
+    attr_accessor :receiver, :reply_with, :in_reply_to, :conversation_id
     attr_accessor :ontology
 
     def initialize(sender, act, content)
@@ -19,22 +21,58 @@ class Cirrocumulus
     def context
       Context.new(@sender, @reply_with)
     end
+
+    def self.parse_params(content, subroutine = false)                                                                            
+      return parse_params(content.size == 1 ? content[0] : content, true)  if !subroutine                                         
+
+      return [] if content.nil?                                                                                                   
+      return content if !content.is_a?(Array)                                                                                     
+      return [] if content.size == 0                                                                                              
+      return {content[0] => []} if content.size == 1                                                                              
+      return {content[0] => parse_params(content[1], true)} if content.size == 2                                                  
+                       
+      res = {content[0] => []}                                                                                                    
+
+      if content.all? {|item| !item.is_a?(Array)}                                                                                 
+        content.each_with_index do |item,i|                                                                                       
+          if i == 0                                                                                                               
+            res[content[0]] = []                                                                                                  
+          else                                                                                                                    
+            res[content[0]] << item                                                                                               
+          end                                                                                                                     
+        end                                                                                                                       
+      else                                                                                                                        
+        content.each_with_index do |item,i|                                                                                       
+          if i == 0                                                                                                               
+            res[content[0]] = {}                                                                                                  
+          else                                                                                                                    
+            res[content[0]].merge!(parse_params(item, true))                                                                      
+          end                                                                                                        
+        end
+      end                                                                                                            
+
+      res                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  
+    end                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              
   end
 
+  # Message context. Includes sender, reply-with and conversation-id
   class Context
     attr_reader :sender
     attr_reader :reply_with
+    attr_reader :conversation_id
 
-    def initialize(sender, reply_with)
+    def initialize(sender, reply_with, conversation_id = nil)
       @sender = sender
       @reply_with = reply_with
+      @conversation_id = conversation_id
     end
   end
 
+  # Gets current platform (linux, freebsd, etc)
   def self.platform
-    if PLATFORM =~ /freebsd/
+    if RUBY_PLATFORM =~ /freebsd/
       return 'freebsd'
-    elsif PLATFORM =~ /linux/
+    elsif RUBY_PLATFORM =~ /linux/
       return 'linux'
     end
 
@@ -47,20 +85,15 @@ class Cirrocumulus
     Log4r::Logger['cirrocumulus'].info 'platform: ' + Cirrocumulus::platform
     @suffix = suffix
     @generate_jid = generate_jid
+    @send_queue = Queue.new
   end
 
-  def send(message)
-    msg = "<fipa-message ontology=\"#{message.ontology}\""
-    msg += " receiver=\"#{message.receiver}\"" if message.receiver
-    msg += " act=\"#{message.act}\""
-    msg += " reply-with=\"#{message.reply_with}\"" if message.reply_with
-    msg += " in-reply-to=\"#{message.in_reply_to}\"" if message.in_reply_to
-    message_content = message.content if message.content.is_a? String
-    message_content = Sexpistol.new.to_sexp(message.content) if message.content.is_a? Array
-    msg += "><content>#{message_content}</content></fipa-message>"
-    @im.send!("<message type=\"groupchat\" to=\"#{JABBER_CONFERENCE}\" id=\"aaefa\"><body>#{msg.gsub('&', '&amp;').gsub('<', '&lt;').gsub('>', '&gt;')}</body></message>")
+  # Sends message to other agents
+  def send_message(message)
+    @send_queue << message
   end
 
+=begin
   def inform(receiver, answer, ontology = nil)
     msg = "<fipa-message ontology=\"#{ontology || @ontology}\" receiver=\"#{receiver}\" act=\"inform\"><content>#{answer}</content></fipa-message>"
     @im.send!("<message type=\"groupchat\" to=\"#{JABBER_CONFERENCE}\" id=\"aaefa\"><body>#{msg.gsub('&', '&amp;').gsub('<', '&lt;').gsub('>', '&gt;')}</body></message>")
@@ -80,82 +113,80 @@ class Cirrocumulus
     msg = "<fipa-message ontology=\"#{ontology || @ontology}\" receiver=\"#{receiver}\" act=\"request\"><content>#{action}</content></fipa-message>"
     @im.send!("<message type=\"groupchat\" to=\"#{JABBER_CONFERENCE}\" id=\"aaefa\"><body>#{msg.gsub('&', '&amp;').gsub('<', '&lt;').gsub('>', '&gt;')}</body></message>")
   end
+=end
 
+  # Main loop. Connects to other agents and processes all incoming messages
   def run(agent, kb, sniff = false)
     connect(generate_jid(agent))
 
     Log4r::Logger['cirrocumulus'].info("entering main loop")
     agent.restore_state()
-    
+    agent.start()
+
     s = Sexpistol.new
+    should_be_running = true
 
-    loop do
+    while should_be_running do
       kb.collect_knowledge()
-      
+
       begin
-        connect(generate_jid(agent)) if @im.nil? || !@im.connected?
+        connect(generate_jid(agent)) if !connected?
       rescue Exception => e
         puts e.to_s
         sleep 5
       end
-      
-      next if @im.nil? || !@im.connected?
 
+      next if !connected?
+
+      # process incoming messages from queue
       @im.received_messages do |message|
-        next if !message.x('jabber:x:delay').nil?
-
-        begin
-          xml = Hash.from_xml(message.body)['fipa_message']
- 
-          ontology = xml['ontology']
-          sender = message.from.resource
-          receiver = xml['receiver']
-          supported_ontology = agent.handles_ontology?(ontology)
-          if (supported_ontology && (receiver == @jid || receiver.blank?)) || receiver == @jid || sniff
-              act = xml['act']
-              content_raw = xml['content']
-              content = s.parse_string(content_raw)
-              msg = Cirrocumulus::Message.new(sender, act, content)
-              msg.receiver = receiver
-              msg.reply_with = xml['reply_with']
-              msg.in_reply_to = xml['in_reply_to']
-              msg.ontology = ontology
-              flatten_message_content(msg)
-              Log4r::Logger['cirrocumulus'].debug(msg.inspect)
-              agent.handle_message(msg, kb)
-          else
-            Log4r::Logger['cirrocumulus'].debug("unhandled ontology %s" % [ontology])
-          end
-        rescue Exception => e
-          puts e.to_s
-          puts e.backtrace
-        end
+        process_incoming_message(agent, kb, message, s, sniff)
       end
 
-      agent.tick()
-      sleep 0.5
+      # send all queued messages
+      process_send_queue()
+
+      sleep 0.5 # TODO: do we need this stuff?
     end
 
     @im.disconnect
   end
-  
+
   private
-  
+
+  # Flatterns incoming message if is bounded into multiple arrays
+  def flatten_message_content(message)
+    if !message.content.is_a?(Array)
+      message.content = [message.content]
+    else
+      while message.content.is_a?(Array) && message.content.size == 1 && message.content.first.is_a?(Array)
+        message.content = message.content.first
+      end
+    end
+  end
+
+  # Generates JID for self identification
   def generate_jid(agent)
     suffix = agent.default_ontology ? agent.default_ontology.gsub('cirrocumulus-', '') : @suffix
     if @generate_jid
-      _, hostname = systemu 'hostname'
+      _, hostname = systemu('hostname')
       hostname.strip!
       "%s-%s" % [hostname, suffix]
     else
       suffix
     end
   end
-  
+
+  # Checks if agent is connected to Jabber conference
+  def connected?
+    @im && @im.connected?
+  end
+
+  # Connects to Jabber server and joins the conference
   def connect(jid)
     @jid = jid
     Log4r::Logger['cirrocumulus'].info "logging as " + @jid
-  
+
     begin
       @im.disconnect if @im && @im.connected?
       full_jid = @jid + "@" + JABBER_SERVER
@@ -163,7 +194,7 @@ class Cirrocumulus
     rescue Jabber::ClientAuthenticationFailure => ex
       Log4r::Logger['cirrocumulus'].warn ex.to_s
       Log4r::Logger['cirrocumulus'].info "registering new account with default password"
-      
+
       client = Jabber::Client.new(full_jid)
       client.connect()
       client.register(JABBER_DEFAULT_PASSWORD) #, {'username' => full_jid, 'password' => JABBER_DEFAULT_PASSWORD})
@@ -179,14 +210,62 @@ class Cirrocumulus
       @im.send!("<presence to='#{JABBER_CONFERENCE}/#{@jid}' />")
     end
   end
-  
-  def flatten_message_content(message)
-    if !message.content.is_a?(Array)
-      message.content = [message.content]
-    else
-      while message.content.is_a?(Array) && message.content.size == 1 && message.content.first.is_a?(Array)
-        message.content = message.content.first
+
+  def process_incoming_message(agent, kb, message, s, sniff)
+    return if !message.x('jabber:x:delay').nil?
+
+    begin
+      xml = Hash.from_xml(message.body)['fipa_message']
+
+      ontology = xml['ontology']
+      sender = message.from.resource
+      receiver = xml['receiver']
+      supported_ontology = agent.handles_ontology?(ontology)
+
+      if (supported_ontology && (receiver == @jid || receiver.blank?)) || receiver == @jid || sniff
+        content_raw = xml['content']
+        content = s.parse_string(content_raw)
+        msg = Cirrocumulus::Message.new(sender, xml['act'], content)
+        msg.receiver = receiver
+        msg.ontology = ontology
+        msg.reply_with = xml['reply_with']
+        msg.in_reply_to = xml['in_reply_to']
+        msg.conversation_id = xml['conversation_id']
+
+        flatten_message_content(msg)
+        Log4r::Logger['cirrocumulus'].debug(msg.inspect)
+        agent.handle_message(msg)
+      else # ignore message
+        #Log4r::Logger['cirrocumulus'].debug("unhandled ontology: %s" % [ontology])
       end
+    rescue Exception => e # exception while parsing; possibly it is not XML (humans speaking!)
+      Log4r::Logger['cirrocumulus'].error "%s\n%s" % [e.to_s, e.backtrace.to_s]
+    end
+  end
+
+  # Processes send queue and sends all pending messages
+  def process_send_queue()
+    while !@send_queue.empty? do
+      message = @send_queue.pop
+      actual_send(message)
     end
   end
+
+  # Sends message to Jabber conference
+  def actual_send(message)
+    msg = "<fipa-message ontology=\"#{message.ontology}\""
+    msg += " receiver=\"#{message.receiver}\"" if message.receiver
+    msg += " act=\"#{message.act}\""
+    msg += " reply-with=\"#{message.reply_with}\"" if message.reply_with
+    msg += " in-reply-to=\"#{message.in_reply_to}\"" if message.in_reply_to
+    msg += " conversation-id=\"#{message.conversation_id}\"" if message.conversation_id
+    message_content = message.content if message.content.is_a?(String)
+    message_content = Sexpistol.new.to_sexp(message.content) if message.content.is_a? Array
+    msg += "><content>#{message_content}</content></fipa-message>"
+    @im.send!("<message type=\"groupchat\" to=\"#{JABBER_CONFERENCE}\" id=\"aaefa\"><body>#{msg.gsub('&', '&amp;').gsub('<', '&lt;').gsub('>', '&gt;')}</body></message>")
+    true
+  rescue
+    false
+  end
+
 end