agent_xmpp 0.1.0

data/lib/agent_xmpp/client/message_pipe.rb

@@ -0,0 +1,193 @@
+##############################################################################################################
+module AgentXmpp
+  
+  #####-------------------------------------------------------------------------------------------------------
+  class MessagePipe
+
+    #---------------------------------------------------------------------------------------------------------
+    attr_reader   :connection_status, :delegates, :responder_list, :connection, :stream_features, 
+                  :stream_mechanisms, :responder_list_mutex
+    #---------------------------------------------------------------------------------------------------------
+    alias_method :send_to_method, :send
+    #---------------------------------------------------------------------------------------------------------
+
+    #.........................................................................................................
+    def initialize(connection)
+      @connection = connection
+      @connection_status = :offline;
+      @delegates = [MessageDelegate]
+      @responder_list = {}
+      @responder_list_mutex = Mutex.new
+    end
+    
+    #.........................................................................................................
+    def add_delegate(delegate)
+      @delegates << delegate unless @delegates.include?(delegate)
+    end
+
+    #.........................................................................................................
+    def remove_delegate(delegate)
+      @delegates.delete(delegate)
+    end
+    
+    #.........................................................................................................
+    def delegates_respond_to?(method)
+     delegates.inject(0){|r,d| d.respond_to?(method) ? r + 1 : r} > 0
+    end
+    
+    #.........................................................................................................
+    def broadcast_to_delegates(method, *args)
+      delegates.inject([]){|r,d| d.respond_to?(method) ? r.push(d.send(method, *args)) : r}.smash
+    end
+
+    #.........................................................................................................
+    def send(data, &blk)
+      raise AgentXmppError, 'not connected'  unless connected?
+      if block_given? and data.kind_of?(Xmpp::Stanza)
+        if data.id.nil?
+          data.id = Xmpp::IdGenerator.generate_id
+        end
+        add_to_responder_list(data.id, &blk)
+      end
+      AgentXmpp.logger.info "SEND: #{data.to_s}"
+      Message.update(data)
+      @connection.send_data(data.to_s)
+    end
+
+    #.........................................................................................................
+    def send_resp(resp)
+      [resp].flatten.map {|r| r.kind_of?(AgentXmpp::Response) ? send(r.message, &r.responds_with) : r}
+    end
+
+    #.........................................................................................................
+    def connected?
+      connection and !connection.error?
+    end
+ 
+    #.........................................................................................................
+    def add_to_responder_list(stanza_id, &blk)
+      responder_list_mutex.synchronize do
+        @responder_list[stanza_id] = {:blk=>blk, :created_at=>Time.now}
+      end
+    end
+ 
+    #.........................................................................................................
+    def remove_from_responder_list(stanza_id)
+      if @responder_list[stanza_id]
+        responder_list_mutex.synchronize{@responder_list.delete(stanza_id)}
+      end
+    end
+    
+    #---------------------------------------------------------------------------------------------------------
+    # connection callbacks
+    #.........................................................................................................
+    def receive(stanza)
+      AgentXmpp.logger.info "RECV: #{stanza.to_s}"
+      result = if stanza.kind_of?(Xmpp::Stanza) and stanza.id and callback_info = responder_list[stanza.id]
+                 responder_list.delete(stanza.id)
+                 callback_info[:blk].call(stanza)
+               else
+                 process_stanza(stanza)
+               end
+      send_resp(result)          
+    end
+
+    #.........................................................................................................
+    def connection_completed
+      Boot.call_if_implemented(:call_after_connected, self)     
+      broadcast_to_delegates(:on_connect, self)
+      init_connection.collect{|m| send(m)}
+    end
+
+    #.........................................................................................................
+    def unbind
+      @connection_status = :off_line
+      broadcast_to_delegates(:on_disconnect, self)
+    end
+    
+    #.........................................................................................................
+    # private
+    #.........................................................................................................
+    def process_stanza(stanza)
+      case stanza.name
+      when 'features'
+        set_stream_features_and_mechanisms(stanza)
+        if connection_status.eql?(:offline)
+          broadcast_to_delegates(:on_preauthenticate_features, self)
+        elsif connection_status.eql?(:authenticated)
+          broadcast_to_delegates(:on_postauthenticate_features, self)
+        end
+      when 'stream'
+      when 'success'
+        if connection_status.eql?(:offline)
+          @connection.reset_parser
+          @connection_status = :authenticated
+          broadcast_to_delegates(:on_authenticate, self)
+          init_connection(false)
+        end
+      when 'failure'
+        if connection_status.eql?(:offline)
+          @connection.reset_parser
+          broadcast_to_delegates(:on_did_not_authenticate, self)
+        end
+      else
+        demux_stanza(stanza)
+      end
+    end
+  
+    #.........................................................................................................
+    def demux_stanza(stanza)
+      if stanza.respond_to?(:id) and not Message.find_by_item_id(stanza.id)
+        Message.update(stanza)
+        meth = 'on_' + if stanza.class.eql?(AgentXmpp::Xmpp::Iq)
+                         iqclass = if stanza.query
+                                     stanza.query.class
+                                   elsif stanza.command
+                                     stanza.command.class
+                                   else
+                                     nil
+                                   end
+                           if iqclass
+                                /.*::Iq(.*)/.match(iqclass.to_s).to_a.last 
+                           else
+                                'fail'
+                           end
+                       else
+                         /.*::(.*)/.match(stanza.class.to_s).to_a.last
+                       end.downcase
+        meth += '_' + stanza.type.to_s if stanza.type
+        if delegates_respond_to?(meth.to_sym) 
+          broadcast_to_delegates(meth.to_sym, self, stanza)
+        else
+          broadcast_to_delegates(:on_unsupported_message, self, stanza)
+        end
+      end
+    end
+  
+    #.........................................................................................................
+    def set_stream_features_and_mechanisms(stanza)
+      @stream_features, @stream_mechanisms = {}, []
+      stanza.elements.each do |e|
+        if e.name == 'mechanisms' and e.namespace == 'urn:ietf:params:xml:ns:xmpp-sasl'
+          e.each_element('mechanism') {|mech| @stream_mechanisms.push(mech.text)}
+        else
+          @stream_features[e.name] = e.namespace
+        end
+      end
+    end
+  
+    #.........................................................................................................
+    def init_connection(starting = true)
+      msg = []
+      msg.push(Send("<?xml version='1.0' ?>")) if starting
+      msg.push(Send("<stream:stream xmlns='jabber:client' xmlns:stream='http://etherx.jabber.org/streams' version='1.0' to='#{AgentXmpp.jid.domain}'>"))
+    end
+     
+    #.........................................................................................................
+     private :process_stanza, :demux_stanza, :set_stream_features_and_mechanisms, :init_connection
+         
+  #### MessagePipe
+  end
+
+#### AgentXmpp
+end

data/lib/agent_xmpp/client/response.rb

@@ -0,0 +1,102 @@
+##############################################################################################################
+def Send(msg, &blk)
+  AgentXmpp::Response.new(msg, &blk)
+end
+
+##############################################################################################################
+module AgentXmpp
+    
+  #####-------------------------------------------------------------------------------------------------------
+  class Response
+
+    #.........................................................................................................
+    attr_reader :text, :message, :responds_with
+
+    #.........................................................................................................
+    def initialize(msg, &blk)
+      @message = msg
+      @text = msg.to_s
+      @responds_with = blk
+    end
+
+    #.........................................................................................................
+    def to_s
+      text
+    end
+    
+    #.........................................................................................................
+    def method_missing(meth, *args, &blk)
+      text.send(meth, *args, &blk)
+    end
+
+  #### Response
+  end
+
+  #####-------------------------------------------------------------------------------------------------------
+  class Error
+
+    #.........................................................................................................
+    attr_reader :error, :args
+
+    #.........................................................................................................
+    def initialize(error, *args)
+      @error = error.to_sym
+      @args = args
+    end
+
+    #.........................................................................................................
+    def responce
+      Xmpp::ErrorResponse.send(error, *args)
+    end
+
+    #.........................................................................................................
+    def method_missing(meth, *args, &blk)
+      message.send(meth, *args, &blk)
+    end
+
+  #### Error
+  end
+
+  #####-------------------------------------------------------------------------------------------------------
+  class Delegate
+
+    #.........................................................................................................
+    attr_reader :methods
+
+    #.........................................................................................................
+    def initialize
+      @methods = []
+    end
+    
+    #.........................................................................................................
+    def add_delegate_methods(methods)
+      @methods << methods
+    end
+
+    #.........................................................................................................
+    def delegate(pipe, delegate)
+      methods.each do |meths|
+        meths.each do |(meth,blk)|
+          delegate.define_meta_class_method(meth) do |*args|
+            if res = blk.call(*args)
+              pipe.send_resp(res)             
+              pipe.remove_delegate(delegate)
+            end
+          end
+        end
+        pipe.add_delegate(delegate)
+      end
+      methods.clear
+    end
+
+    #.........................................................................................................
+    def method_missing(meth, *args, &blk)
+      methods.send(meth, *args, &blk)
+    end
+
+  #### Error
+  end
+
+
+#### AgentXmpp
+end

data/lib/agent_xmpp/config.rb

@@ -0,0 +1,48 @@
+module AgentXmpp
+
+  #.........................................................................................................
+  VERSION = "0.1.0"
+  AGENT_XMPP_NAME = 'AgentXMPP'
+  OS_VERSION = IO.popen('uname -sr').readlines.first.to_s.strip
+  SUBSCRIBE_RETRY_PERIOD = 60
+  IDENTITY = {:category => 'client', :name => AGENT_XMPP_NAME, :type => 'bot'}
+  FEATURES = ['http://jabber.org/protocol/disco#info', 
+              'http://jabber.org/protocol/disco#items',
+              'jabber:iq:version',
+              'jabber:x:data',
+              'http://jabber.org/protocol/commands',
+              'http://jabber.org/protocol/pubsub',
+              'http://jabber.org/protocol/pubsub#publish',
+              'http://jabber.org/protocol/pubsub#subscribe',
+              'http://jabber.org/protocol/pubsub#create-nodes',
+              'http://jabber.org/protocol/pubsub#delete-nodes']
+  GARBAGE_COLLECTION_INTERVAL = 86400
+  DEFAULT_PUBSUB_CONFIG = {
+    :title                    => 'event',
+    :access_model             => 'presence',
+    :max_items                => 20,
+    :deliver_notifications    => 1,
+    :deliver_payloads         => 1,
+    :persist_items            => 1,
+    :subscribe                => 1,
+    :notify_config            => 0,
+    :notify_delete            => 0,
+    :notify_retract           => 0,
+  }
+
+  #.........................................................................................................
+  @app_path = File.expand_path(File.dirname($0))
+  @log_file = STDOUT
+  
+  #.........................................................................................................
+  class << self
+    attr_accessor :config_file, :app_path, :log_file
+    def logger; @logger ||= Logger.new(STDOUT); end
+    def logger=(logger); @logger = logger; end
+  end
+  
+  #.........................................................................................................
+  class AgentXmppError < Exception; end
+  
+end
+

data/lib/agent_xmpp/main.rb

@@ -0,0 +1,175 @@
+##############################################################################################################
+OptionParser.new do |opts|
+  opts.banner = 'Usage: agent_xmpp.rb [options]'
+  opts.separator ''
+  opts.on('-a', '--app_path path', 'absolute path to application') {|a| AgentXmpp.app_path = a}
+  opts.on('-l', '--logfile file.log', 'name of logfile') {|f| AgentXmpp.log_file = f}
+  opts.on_tail('-h', '--help', 'Show this message') {
+    puts opts
+    exit
+  }
+  opts.parse!(ARGV)
+end
+
+##############################################################################################################
+module AgentXmpp
+  
+  #...........................................................................................................
+  @config = {}
+
+  #####-------------------------------------------------------------------------------------------------------
+  class << self
+
+    #.........................................................................................................
+    attr_accessor :config
+    
+    #####.....................................................................................................
+    # database
+    #.........................................................................................................
+    def in_memory_db
+      @in_memory_db ||= Sequel.sqlite
+    end
+
+    #.........................................................................................................
+    def agent_xmpp_db
+      @agent_xmpp_db ||= Sequel.sqlite("#{AgentXmpp.app_path}/agent_xmpp.db")
+    end
+
+    #.........................................................................................................
+    def version
+      @version ||= agent_xmpp_db[:version]
+    end
+
+    #.........................................................................................................
+    def publication
+      @publication ||= PublishModel.new(config['publish'])
+    end
+        
+    #####.....................................................................................................
+    # pubsub nodes
+    #.........................................................................................................
+    def pubsub_root
+      @pubsub_root ||= "/home/#{AgentXmpp.jid.domain}"  
+    end     
+    
+    #.........................................................................................................
+    def user_pubsub_root
+      @user_pubsub_root ||= "#{@pubsub_root}/#{AgentXmpp.jid.node}" 
+    end
+
+    #####.....................................................................................................
+    # client account configuration
+    #.........................................................................................................
+    def is_account_jid?(jid)
+      @jid.bare.to_s.eql?(bare_jid_to_s(jid))
+    end
+    
+    #.........................................................................................................
+    def jid
+      @jid ||= Xmpp::Jid.new("#{config['jid']}/#{resource}")
+    end
+      
+    #.........................................................................................................
+    def jid=(jid)
+      @jid = jid
+    end
+          
+    #.........................................................................................................
+    def resource
+      config['resource'] || Socket.gethostname
+    end
+         
+    #.........................................................................................................
+    def port
+      config['port'] || 5222
+    end
+
+    #.........................................................................................................
+    def password
+      config['password']
+    end
+
+    #.........................................................................................................
+    def priority
+      @priority ||= if config['priority']
+                      if config['priority'] < -127
+                        -127
+                      elsif config['priority'] > 128
+                        128
+                      else
+                        config['priority']
+                      end
+                    else; 1; end
+    end
+         
+    #.........................................................................................................
+    def bare_jid_to_s(jid)
+      case jid
+        when String then Xmpp::Jid.new(jid).bare.to_s
+        when Xmpp::Jid then jid.bare.to_s
+      else jid
+      end 
+    end  
+           
+    #.........................................................................................................
+    def full_jid_to_s(jid)
+      case jid
+        when String then jid
+        when Xmpp::Jid then jid.to_s
+      else jid
+      end 
+    end  
+            
+    #.........................................................................................................
+    def start_garbage_collection(pipe)
+      EventMachine::PeriodicTimer.new(AgentXmpp::GARBAGE_COLLECTION_INTERVAL) do
+        AgentXmpp.logger.info "GARBAGE COLLECTION IN PROGRESS ON INTERVAL: #{AgentXmpp::GARBAGE_COLLECTION_INTERVAL}"
+        AgentXmpp::BaseController.commands_list.each do |(session, command_info)|
+          AgentXmpp::BaseController.remove_command_from_list(session) if Time.now - command_info[:created_at] > AgentXmpp::GARBAGE_COLLECTION_INTERVAL
+        end
+        pipe.responder_list.each do |(stanza_id, command_info)|
+          pipe.remove_from_responder_list(stanza_id) if Time.now - command_info[:created_at] > AgentXmpp::GARBAGE_COLLECTION_INTERVAL
+        end
+      end  
+    end
+            
+  #### self
+  end
+  
+  #####-------------------------------------------------------------------------------------------------------
+  module Delegator 
+
+    #####-------------------------------------------------------------------------------------------------------
+    class << self
+
+      #.........................................................................................................
+      def delegate(del, *methods)
+        methods.each do |method_name|
+          class_eval <<-RUBY
+            def #{method_name.to_s}(*args, &blk)
+              ::#{del}.send(#{method_name.inspect}, *args, &blk)
+            end
+          RUBY
+        end
+      end
+
+    #### self
+    end
+
+    delegate AgentXmpp::BaseController, :command, :chat, :event, :before, :include_module
+    delegate AgentXmpp::Boot, :before_start, :after_connected, :restarting_client, :discovered_pubsub_node, 
+                              :discovered_command_nodes, :received_presence
+
+  #### Delegator 
+  end
+    
+#### AgentXmpp 
+end
+
+##############################################################################################################
+include AgentXmpp::Delegator
+
+##############################################################################################################
+at_exit do
+  AgentXmpp::Boot.boot
+end