adhearsion 0.8.4 → 0.8.5

data/lib/adhearsion/voip/asterisk/manager_interface.rb

@@ -29,7 +29,9 @@ module Adhearsion
         #
         class ManagerInterface
 
-          CAUSAL_EVENT_NAMES = ["queuestatus", "sippeers", "parkedcalls", "status", "dahdishowchannels"] unless defined? CAUSAL_EVENT_NAMES
+          CAUSAL_EVENT_NAMES = %w[queuestatus sippeers iaxpeers parkedcalls
+                                  dahdishowchannels coreshowchannels dbget
+                                  status konferencelist] unless defined? CAUSAL_EVENT_NAMES
 
           class << self
 
@@ -41,13 +43,7 @@ module Adhearsion
 
             def replies_with_action_id?(name, headers={})
               name = name.to_s.downcase
-              # TODO: Expand this case statement
-              case name
-                when "queues", "iaxpeers"
-                  false
-                else
-                  true
-              end
+              !UnsupportedActionName::UNSUPPORTED_ACTION_NAMES.include? name
             end
 
             ##
@@ -76,21 +72,27 @@ module Adhearsion
               return nil unless has_causal_events?(action_name)
               action_name = action_name.to_s.downcase
                case action_name
-                 when "queuestatus", 'parkedcalls', "status"
+                 when "sippeers", "iaxpeers"
+                 "peerlistcomplete"
+               when "dbget"
+                 "dbgetresponse"
+               when "konferencelist"
+                 "conferencelistcomplete"
+               else
                    action_name + "complete"
-                 when "sippeers"
-                   "peerlistcomplete"
                end
             end
 
           end
 
           DEFAULT_SETTINGS = {
-            :host     => "localhost",
-            :port     => 5038,
-            :username => "admin",
-            :password => "secret",
-            :events   => true
+            :host           => "localhost",
+            :port           => 5038,
+            :username       => "admin",
+            :password       => "secret",
+            :events         => true,
+            :auto_reconnect => true,
+            :event_callback => proc { |event| Events.trigger(%w[asterisk manager_interface], event) }
           }.freeze unless defined? DEFAULT_SETTINGS
 
           attr_reader *DEFAULT_SETTINGS.keys
@@ -106,11 +108,13 @@ module Adhearsion
           def initialize(options={})
             options = parse_options options
 
-            @host = options[:host]
-            @username = options[:username]
-            @password = options[:password]
-            @port     = options[:port]
-            @events   = options[:events]
+            @host           = options[:host]
+            @username       = options[:username]
+            @password       = options[:password]
+            @port           = options[:port]
+            @events         = options[:events]
+            @auto_reconnect = options[:auto_reconnect]
+            @event_callback = options[:event_callback]
 
             @sent_messages = {}
             @sent_messages_lock = Mutex.new
@@ -136,21 +140,29 @@ module Adhearsion
 
               if corresponding_action
 
+                # The "DBGet" command is causal, meaning it has an separate
+                # event that contains the data for command's response.  However,
+                # unlike other causal commands, AMI does not send a
+                # "DBGetComplete" action indicating the causal event is
+                # finished.  This is fixed starting in Asterisk 1.8.
+                if message.name.downcase == "dbgetresponse"
+                  event_collection << message
+                end
+
                 # If this is the meta-event which signals no more events will follow and the response is complete.
                 if message.name.downcase == corresponding_action.causal_event_terminator_name
-
-                  # Result found! Wake up any Threads waiting
+                  # Wake up the waiting Thread
                   corresponding_action.future_resource.resource = event_collection.freeze
 
+                  # Clear the stored action and event collection
                   @current_action_with_causal_events   = nil
                   @event_collection_for_current_action = nil
-
                 else
                   event_collection << message
                   # We have more causal events coming.
                 end
               else
-                ahn_log.ami.error "Got an unexpected event on actions socket! This may be a bug! #{message.inspect}"
+                ahn_log.ami.error "Got an unexpected event on actions socket! This AMI command may have a multi-message response. Try making Adhearsion treat it as CAUSAL_EVENT #{message.inspect}"
               end
 
             elsif message["ActionID"].nil?
@@ -195,7 +207,7 @@ module Adhearsion
           def event_message_received(event)
             return if event.kind_of?(ManagerInterfaceResponse) && event["Message"] == "Authentication accepted"
             # TODO: convert the event name to a certain namespace.
-            Events.trigger %w[asterisk manager_interface], event
+            @event_callback.call(event)
           end
 
           def event_error_received(message)
@@ -226,13 +238,14 @@ module Adhearsion
 
           def actions_connection_established
             @actions_state = :connected
-            @actions_writer_thread = Thread.new(&method(:write_loop))
+            start_actions_writer_loop
           end
 
           def actions_connection_disconnected
             @actions_state = :disconnected
             ahn_log.ami.error "AMI connection for ACTION disconnected !!!"
-            establish_actions_connection
+            clear_actions_connection
+            establish_actions_connection if @auto_reconnect
           end
 
           def events_connection_established
@@ -242,14 +255,23 @@ module Adhearsion
           def events_connection_disconnected
             @events_state = :disconnected
             ahn_log.ami.error "AMI connection for EVENT disconnected !!!"
-            establish_events_connection
+            clear_events_connection
+            establish_events_connection if @auto_reconnect
+          end
+
+          def clear_actions_connection
+            stop_actions_writer_loop
+            clear_actions_connection_resources
+            disconnect_actions_connection
+          end
+
+          def clear_events_connection
+            disconnect_events_connection
           end
 
           def disconnect!
-            # PSEUDO CODE
-            # TODO: Go through all the waiting condition variables and raise an exception
-            #@write_queue << :STOP!
-            #raise NotImplementedError
+            clear_actions_connection
+            clear_events_connection
           end
 
           def dynamic
@@ -390,7 +412,7 @@ module Adhearsion
             args[:exten] = options[:extension] if options[:extension]
             args[:caller_id] = options[:caller_id] if options[:caller_id]
             if options[:variables] && options[:variables].kind_of?(Hash)
-              args[:variable] = options[:variables].map {|pair| pair.join('=')}.join(AHN_CONFIG.asterisk.argument_delimiter)
+              args[:variable] = options[:variables].map {|pair| pair.join('=')}.join(@coreSettings["ArgumentDelimiter"])
             end
             originate args
           end
@@ -410,8 +432,25 @@ module Adhearsion
           class UnsupportedActionName < ArgumentError
             UNSUPPORTED_ACTION_NAMES = %w[
               queues
-              iaxpeers
             ] unless defined? UNSUPPORTED_ACTION_NAMES
+
+            # Blacklist some actions depends on the Asterisk version
+            def self.preinitialize(version)
+              if version < 1.8
+                %w[iaxpeers muteaudio mixmonitormute aocmessage].each do |action|
+                  UNSUPPORTED_ACTION_NAMES << action
+                end
+              end
+
+              if version < 1.6
+                %w[skinnydevices skinnyshowdevice skinnylines skinnyshowline coreshowchannels
+                   sipshowregistry getconfigjson bridge listallvoicemailusers dbdel dbdeltree
+                   insert jitterbufstats atxfer iaxregistry queuereload queuereset].each do |action|
+                  UNSUPPORTED_ACTION_NAMES << action
+                end
+              end
+            end
+
             def initialize(name)
               super "At the moment this AMI library doesn't support the #{name.inspect} action because it causes a protocol anomaly. Support for it will be coming shortly."
             end
@@ -424,19 +463,33 @@ module Adhearsion
             true
           end
 
-          def write_loop
+          def start_actions_writer_loop
+            @actions_writer_thread = Thread.new(&method(:actions_writer_loop))
+          end
+
+          def stop_actions_writer_loop
+            if @actions_writer_thread
+              @write_queue << :STOP!
+              @actions_writer_thread.join
+              @actions_writer_thread = nil
+            end
+          end
+
+          def actions_writer_loop
             loop do
-              next_action = @write_queue.shift
-              return :stopped if next_action.equal? :STOP!
-              register_action_with_metadata next_action
-
-              ahn_log.ami.debug "Sending AMI action: #{"\n>>> " + next_action.to_s.gsub(/(\r\n)+/, "\n>>> ")}"
-              @actions_connection.send_data next_action.to_s
-              # If it's "causal event" action, we must wait here until it's fully responded
-              next_action.response if next_action.has_causal_events?
+              begin
+                next_action = @write_queue.shift
+                return :stopped if next_action.equal? :STOP!
+                register_action_with_metadata next_action
+
+                ahn_log.ami.debug "Sending AMI action: #{"\n>>> " + next_action.to_s.gsub(/(\r\n)+/, "\n>>> ")}"
+                @actions_connection.send_data next_action.to_s
+                # If it's "causal event" action, we must wait here until it's fully responded
+                next_action.response if next_action.has_causal_events?
+              rescue Object => e
+                ahn_log.ami.debug "Error in AMI writer loop: #{e.class}: #{e.message}\n\t#{e.backtrace.join("\n\t")}"
+              end
             end
-          rescue => e
-            p e
           end
 
           ##
@@ -462,6 +515,22 @@ module Adhearsion
             end
           end
 
+          # Give an error response to any outstanding messages -- they
+          # won't be completed now
+          def clear_actions_connection_resources
+            # Fail all outstanding messages and reset the message list
+            @sent_messages_lock.synchronize do
+              @sent_messages.each do |action_id, action|
+                error         = ManagerInterfaceError.new
+                error.message = "Connection terminated to AMI server"
+
+                action.future_resource.resource = error
+              end
+
+              @sent_messages = {}
+            end
+          end
+
           ##
           # Instantiates a new ManagerInterfaceActionsConnection and assigns it to @actions_connection.
           #
@@ -469,13 +538,22 @@ module Adhearsion
           #
           def establish_actions_connection
             @actions_connection = EventSocket.connect(@host, @port) do |handler|
-              handler.receive_data { |data| @actions_lexer << data  }
+              handler.receive_data { |data| @actions_lexer << data   }
               handler.connected    { actions_connection_established  }
               handler.disconnected { actions_connection_disconnected }
             end
             login_actions
           end
 
+          def disconnect_actions_connection
+            # Clean up the EventSocket we may have
+            if @actions_connection
+              @actions_connection.disconnect!
+              @actions_connection.join
+              @actions_connection = nil
+            end
+          end
+
           ##
           # Instantiates a new ManagerInterfaceEventsConnection and assigns it to @events_connection.
           #
@@ -485,7 +563,7 @@ module Adhearsion
 
             # Note: the @events_connection instance variable is set in login()
             @events_connection = EventSocket.connect(@host, @port) do |handler|
-              handler.receive_data { |data| @events_lexer << data  }
+              handler.receive_data { |data| @events_lexer << data   }
               handler.connected    { events_connection_established  }
               handler.disconnected { events_connection_disconnected }
             end
@@ -500,10 +578,29 @@ module Adhearsion
               raise AuthenticationFailedException, "Incorrect username and password! #{response.message}"
             else
               ahn_log.ami "Successful AMI actions-only connection into #{@username}@#{@host}"
+              if @actions_lexer.ami_version < 1.1
+                @coreSettings = Hash.new
+                @coreSettings["AsteriskVersion"] = "1.4.0"
+                @coreSettings["AMIversion"] = "1.0"
+                @coreSettings["ArgumentDelimiter"] = "|"
+              else
+                @coreSettings = send_action_synchronously("CoreSettings").headers
+                @coreSettings["ArgumentDelimiter"] = ","
+              end
+              UnsupportedActionName::preinitialize(@coreSettings["AsteriskVersion"].to_f)
               response
             end
           end
 
+          def disconnect_events_connection
+            # Clean up the EventSocket we may have
+            if @events_connection
+              @events_connection.disconnect!
+              @events_connection.join
+              @events_connection = nil
+            end
+          end
+
           ##
           # Since this method is always called after the login_actions method, an AuthenticationFailedException would have already
           # been raised if the username/password were off. Because this is the only action we ever need to send on this socket,
@@ -525,9 +622,9 @@ module Adhearsion
           ##
           # Raised when calling ManagerInterface#connect!() and the server responds with an error after logging in.
           #
-          class AuthenticationFailedException < Exception; end
+          class AuthenticationFailedException < StandardError; end
 
-          class NotConnectedError < Exception; end
+          class NotConnectedError < StandardError; end
 
           ##
           # Each time ManagerInterface#send_action is invoked, a new ManagerInterfaceAction is instantiated.

data/lib/adhearsion/voip/asterisk/manager_interface/ami_lexer.rb

@@ -1533,7 +1533,7 @@ end
           end
 
           def init_error
-            @current_message = ManagerInterfaceError.new()
+            @current_message = ManagerInterfaceError.new
           end
 
           def version_starts

data/lib/adhearsion/voip/asterisk/manager_interface/ami_messages.rb

@@ -46,7 +46,7 @@ module Adhearsion
 
         end
 
-        class ManagerInterfaceError < Exception
+        class ManagerInterfaceError < StandardError
 
           attr_accessor :message
           def initialize

data/lib/adhearsion/voip/call.rb

@@ -1,4 +1,5 @@
 require 'uri'
+require 'thread'
 #TODO Some of this is asterisk-specific
 module Adhearsion
   class << self
@@ -16,7 +17,7 @@ module Adhearsion
     end
   end
 
-  class Hangup < Exception
+  class Hangup < StandardError
     # At the moment, we'll just use this to end a call-handling Thread.
   end
 
@@ -52,7 +53,8 @@ module Adhearsion
       end
     end
 
-    # Searches all active calls by their unique_identifier. See Call#unique_identifier.
+    # Searches all active calls by their unique_identifier. See Call#unique_identifier. 
+    # Is this actually by channel?
     def find(id)
       atomically do
         return calls[id]
@@ -86,9 +88,9 @@ module Adhearsion
 
   end
 
-  class UselessCallException < Exception; end
+  class UselessCallException < StandardError; end
 
-  class MetaAgiCallException < Exception
+  class MetaAgiCallException < StandardError
     attr_reader :call
     def initialize(call)
       super()
@@ -113,7 +115,7 @@ module Adhearsion
     # instance variable.
     class CallMessageQueue < Queue
 
-      class InboxClosedException < Exception
+      class InboxClosedException < StandardError
         # this gets raised when the :cancel message is delivered to the queue and with_next_message (or similar auto-message-iteration)
         # features are called.
       end
@@ -200,10 +202,15 @@ module Adhearsion
       end
     end
 
-    def tag(symbol)
-      raise ArgumentError, "tag must be a Symbol" unless symbol.is_a? Symbol
+    # This may still be a symbol, but no longer requires the tag to be a symbol although beware
+    # that using a symbol would create a memory leak if used improperly
+    # @param [String, Symbol] label String or Symbol with which to tag this call
+    def tag(label)
+      if ![String, Symbol].include?(label.class)
+        raise ArgumentError, "Tag must be a String or Symbol"
+      end
       @tag_mutex.synchronize do
-        @tags << symbol
+        @tags << label
       end
     end
 

data/lib/adhearsion/voip/dial_plan.rb

@@ -1,6 +1,23 @@
 # Hardcoding require for now since for some reason it's not being loaded
 require 'adhearsion/voip/dsl/dialplan/control_passing_exception'
 
+require 'adhearsion/version'
+# JRuby contains a bug that breaks some of the menu functionality
+# See: https://adhearsion.lighthouseapp.com/projects/5871/tickets/92-menu-method-under-jruby-does-not-appear-to-work
+begin
+  curver = Adhearsion::PkgVersion.new(JRUBY_VERSION)
+  minver = Adhearsion::PkgVersion.new("1.6.0")
+  if curver < minver
+    puts "****************************************************************************"
+    puts "Versions of JRuby prior to 1.6.0 contain a bug that limits the prevents"
+    puts "using the \"+\" operator to jump from one context to another."
+    puts "Adhearsion has detected JRuby version #{JRUBY_VERSION}. For more information see:"
+    puts "https://adhearsion.lighthouseapp.com/projects/5871/tickets/92-menu-method-under-jruby-does-not-appear-to-work"
+    puts "****************************************************************************"
+  end
+rescue NameError # In case JRUBY_VERSION is not defined.
+end
+
 module Adhearsion
   class DialPlan
     attr_accessor :loader, :entry_points
@@ -76,7 +93,7 @@ module Adhearsion
 
     class Manager
 
-      class NoContextError < Exception; end
+      class NoContextError < StandardError; end
 
       class << self
         def handle(call)
@@ -110,10 +127,10 @@ module Adhearsion
       # Find the dialplan by the context name from the call or from the
       # first path entry in the AGI URL
       def entry_point_for(call)
-        if entry_point = dial_plan.lookup(call.context.to_sym)
-          entry_point
-        elsif call.respond_to?(:request) && m = call.request.path.match(%r{/([^/]+)})
+        if call.respond_to?(:request) && m = call.request.path.match(%r{/([^/]+)})
           dial_plan.lookup(m[1].to_sym)
+        elsif entry_point = dial_plan.lookup(call.context.to_sym)
+          entry_point
         end
       end