adhearsion 1.0.3 → 1.1.0

data/CHANGELOG

@@ -1,3 +1,11 @@
+1.1.0
+ - Added interactive call control console: ahn start console <path>
+ - Added centralized exception handler through eventing system
+ - Support for using ahn_hoptoad to send Adhearsion exceptions to Hoptoad
+ - Adhearsion.active_calls can now use hash syntax to find calls by ID
+ - Added Adhearsion::Calls#to_h
+ - Add a Monitor to synchronize access to an AGI connection
+
 1.0.3
  - Fix the play() command regression when passing an array of strings. This was breaking the SimonGame
  - Deprecate ManagerInterface#send_action_asynchronously

data/adhearsion.gemspec

@@ -21,7 +21,6 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  s.has_rdoc      = true
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
@@ -38,6 +37,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency("i18n")
       s.add_runtime_dependency("rubigen", [">= 1.5.6"])
       s.add_runtime_dependency("rake")
+      s.add_runtime_dependency("pry")
 
       # Development dependencies
       s.add_development_dependency('rubigen', [">= 1.5.6"])

data/app_generators/ahn/templates/events.rb

@@ -20,6 +20,7 @@
 ##
 # Here is a list of the events included by default:
 #
+# - events.exception
 # - events.asterisk.manager_interface
 # - events.after_initialized
 # - events.shutdown
@@ -30,3 +31,9 @@
 #
 # Note: events are mostly for components to register and expose to you.
 ##
+
+events.exception.each do |e|
+  ahn_log.error "#{e.class}: #{e.message}"
+  ahn_log.error e.backtrace.join("\n\t")
+end
+

data/lib/adhearsion/cli.rb

@@ -6,7 +6,7 @@ module Adhearsion
       USAGE = <<USAGE
 Usage:
    ahn create /path/to/directory
-   ahn start [daemon] [/path/to/directory]
+   ahn start [console|daemon] [/path/to/directory]
    ahn version|-v|--v|-version|--version
    ahn help|-h|--h|--help|-help
 
@@ -39,23 +39,27 @@ USAGE
           when 'start'
             pid_file_regexp = /^--pid-file=(.+)$/
             if args.size > 3
-              fail_and_print_usage "Too many arguments supplied!" if args.size > 3
+              raise CommandHandler::CLIException, "Too many arguments supplied!" if args.size > 3
             elsif args.size == 3
-              fail_and_print_usage "Unrecognized final argument #{args.last}" unless args.last =~ pid_file_regexp
+              raise CommandHandler::CLIException, "Unrecognized final argument #{args.last}" unless args.last =~ pid_file_regexp
               pid_file = args.pop[pid_file_regexp, 1]
             else
               pid_file = nil
             end
 
-            if args.first == 'daemon' && args.size == 2
+            if args.size == 2
               path   = args.last
-              daemon = true
+              if args.first =~ /daemon|console/
+                mode = args.first.to_sym
+              else
+                raise CommandHandler::CLIException, "Invalid start mode requested: #{args.first}"
+              end
             elsif args.size == 1
-              path, daemon = args.first, false
+              path, mode = args.first, :foreground
             else
-              fail_and_print_usage "Invalid format for the start CLI command!"
+              raise CommandHandler::CLIException, "Invalid format for the start CLI command!"
             end
-            [:start, path, daemon, pid_file]
+            [:start, path, mode, pid_file]
           when '-'
             [:start, Dir.pwd]
           when "enable", "disable"
@@ -192,9 +196,9 @@ component_name.upcase = ComponentTester.new("#{component_name}", File.dirname(__
             end
           end
 
-          def start(path, daemon=false, pid_file=nil)
+          def start(path, mode=:foreground, pid_file=nil)
             raise PathInvalid, path unless File.exists? path + "/.ahnrc"
-            Adhearsion::Initializer.start path, :daemon => daemon, :pid_file => pid_file
+            Adhearsion::Initializer.start path, :mode => mode, :pid_file => pid_file
           end
 
           def version

data/lib/adhearsion/component_manager.rb

@@ -134,6 +134,13 @@ module Adhearsion
           end
         end
         container
+      rescue StandardError => e
+        # Non-fatal errors
+        Events.trigger(['exception'], e)
+      rescue Exception => e
+        # Fatal errors.  Log them and keep passing them upward
+        Events.trigger(['exception'], e)
+        raise e
       end
 
       class ComponentDefinitionContainer < Module

data/lib/adhearsion/console.rb

@@ -0,0 +1,49 @@
+require 'pry'
+
+module Adhearsion
+  module Console
+    include Adhearsion
+
+    class << self
+      ##
+      # Start the Adhearsion console
+      #
+      def run
+        Pry.prompt = [ proc {|obj, nest_level| "AHN#{'  ' * nest_level}> " },
+                       proc {|obj, nest_level| "AHN#{'  ' * nest_level}? " } ]
+        pry
+      end
+
+      def logger
+        Adhearsion::Logging
+      end
+
+      def calls
+        Adhearsion.active_calls
+      end
+
+      def use(call)
+        unless call.is_a? Adhearsion::Call
+          raise ArgumentError unless Adhearsion.active_calls[call]
+          call = Adhearsion.active_calls[call]
+        end
+        Pry.prompt = [ proc { "AHN<#{call.channel}> "},
+                       proc { "AHN<#{call.channel}? "}  ]
+
+        # Pause execution of the thread currently controlling the call
+        call.with_command_lock do
+          CallWrapper.new(call).pry
+        end
+      end
+    end
+
+    class CallWrapper
+      attr_accessor :call
+
+      def initialize(call)
+        @call = call
+        extend Adhearsion::VoIP::Commands.for('asterisk')
+      end
+    end
+  end
+end

data/lib/adhearsion/events_support.rb

@@ -26,6 +26,7 @@ module Adhearsion
     DEFAULT_FRAMEWORK_EVENT_NAMESPACES = %w[
       /after_initialized
       /shutdown
+      /exception
       /asterisk/manager_interface
       /asterisk/before_call
       /asterisk/after_call

data/lib/adhearsion/initializer.rb

@@ -125,7 +125,7 @@ module Adhearsion
     def initialize(path=nil, options={})
       @@started = true
       @path     = path
-      @daemon   = options[:daemon] || ENV['DAEMON']
+      @mode     = options[:mode]
       @pid_file = options[:pid_file].nil? ? ENV['PID_FILE'] : options[:pid_file]
       @loaded_init_files  = options[:loaded_init_files]
       self.class.ahn_root = path
@@ -137,6 +137,7 @@ module Adhearsion
       resolve_pid_file_path
       resolve_log_file_path
       daemonize! if should_daemonize?
+      launch_console if need_console?
       switch_to_root_directory
       catch_termination_signal
       create_pid_file if pid_file
@@ -168,7 +169,7 @@ module Adhearsion
       elsif pid_file then pid_file
       elsif pid_file.equal?(false) then nil
       # FIXME @pid_file = @daemon? Assignment or equality? I'm assuming equality.
-      else @pid_file = @daemon ? default_pid_path : nil
+      else @pid_file = (@mode == :daemon) ? default_pid_path : nil
       end
     end
 
@@ -315,7 +316,11 @@ Adhearsion will abort until you fix this. Sorry for the incovenience.
     end
 
     def should_daemonize?
-      @daemon
+      @mode == :daemon
+    end
+
+    def need_console?
+      @mode == :console
     end
 
     def daemonize!
@@ -324,6 +329,20 @@ Adhearsion will abort until you fix this. Sorry for the incovenience.
       daemonize log_file
     end
 
+    def launch_console
+      require 'adhearsion/console'
+      Thread.new do
+        begin
+          puts "Starting console"
+          Adhearsion::Console.run
+          Adhearsion.shutdown!
+        rescue Exception => e
+          puts e.message
+          puts e.backtrace.join("\n")
+        end
+      end
+    end
+
     def initialize_log_file
       Dir.mkdir(ahn_app_log_directory) unless File.directory? ahn_app_log_directory
       file_logger = Log4r::FileOutputter.new("Main Adhearsion log file", :filename => log_file, :trunc => false)
@@ -382,7 +401,7 @@ Adhearsion will abort until you fix this. Sorry for the incovenience.
         begin
           IMPORTANT_THREADS[index].join
         rescue => e
-          ahn_log.error "Error after join()ing Thread #{thread.inspect}. #{e.message}"
+          ahn_log.error "Error after join()ing Thread #{Thread.inspect}. #{e.message}"
         ensure
           index = index + 1
         end

data/lib/adhearsion/logging.rb

@@ -24,12 +24,15 @@ module Adhearsion
           end
         end
       end
+      alias :level= :logging_level=
 
-      def logging_level
+      def logging_level(level = nil)
+        return self.logging_level= level unless level.nil?
         @@logging_level_lock.synchronize do
           return @@logging_level ||= Log4r::INFO
         end
       end
+      alias :level :logging_level
     end
 
     class AdhearsionLogger < Log4r::Logger

data/lib/adhearsion/version.rb

@@ -1,8 +1,8 @@
 module Adhearsion #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 1 unless defined? MAJOR
-    MINOR = 0 unless defined? MINOR
-    TINY  = 3 unless defined? TINY
+    MINOR = 1 unless defined? MINOR
+    TINY  = 0 unless defined? TINY
 
     STRING = [MAJOR, MINOR, TINY].join('.') unless defined? STRING
   end
@@ -13,13 +13,16 @@ module Adhearsion #:nodoc:
     attr_reader :major, :minor, :revision
 
     def initialize(version="")
-      @major, @minor, @revision = version.split(".").map(&:to_i)
+      version = "" if version.nil?
+      @major, @minor, @revision, @patchlevel = version.split(".", 4).map(&:to_i)
+      @major = 0 unless @major
     end
 
     def <=>(other)
       return @major <=> other.major if ((@major <=> other.major) != 0)
       return @minor <=> other.minor if ((@minor <=> other.minor) != 0)
       return @revision <=> other.revision if ((@revision <=> other.revision) != 0)
+      return 0
     end
 
     def self.sort

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

@@ -59,9 +59,8 @@ module Adhearsion
               ahn_log.agi "Ignoring meta-AGI request"
               call.hangup!
         	  # TBD: (may have more hooks than what Jay has defined in hooks.rb)
-            rescue => e
-              ahn_log.agi.error "#{e.class}: #{e.message}"
-              ahn_log.agi.error e.backtrace.join("\n\t")
+            rescue SyntaxError, StandardError => e
+              Events.trigger(['exception'], e)
             ensure
               Adhearsion.remove_inactive_call call rescue nil
             end

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

@@ -94,10 +94,12 @@ module Adhearsion
         #
         # @see http://www.voip-info.org/wiki/view/Asterisk+FastAGI More information about FAGI
         def raw_response(message = nil)
-          raise ArgumentError.new("illegal NUL in message #{message.inspect}") if message =~ /\0/
-          ahn_log.agi.debug ">>> #{message}"
-          write message if message
-          read
+          @call.with_command_lock do
+            raise ArgumentError.new("illegal NUL in message #{message.inspect}") if message =~ /\0/
+            ahn_log.agi.debug ">>> #{message}"
+            write message if message
+            read
+          end
         end
 
         def response(command, *arguments)

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

@@ -39,8 +39,10 @@ module Adhearsion
         private
 
         def read_configuration
-          normalized_file = self.class.normalize_configuration execute(read_command)
-          normalized_file.split(/^\[([-_\w]+)\]$/)[1..-1].each_slice(2).map do |(name,properties)|
+          normalized_file = self.class.normalize_configuration File.open(@filename, 'r'){|f| f.read}
+          sections = normalized_file.split(/^\[([-_\w]+)\]$/)[1..-1]
+          return [] if sections.nil?
+          sections.each_slice(2).map do |(name,properties)|
             [name, hash_from_properties(properties)]
           end
         end
@@ -53,15 +55,6 @@ module Adhearsion
             property_hash
           end
         end
-
-        def execute(command)
-          %x[command]
-        end
-
-        def read_command
-          "cat #{filename}"
-        end
-
       end
     end
   end

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

@@ -458,7 +458,13 @@ WARN
           end
 
           def start_actions_writer_loop
-            @actions_writer_thread = Thread.new(&method(:actions_writer_loop))
+            @actions_writer_thread = Thread.new do
+              begin
+                actions_writer_loop
+              rescue => e
+                Events.trigger(['exception'], e)
+              end
+            end
           end
 
           def stop_actions_writer_loop

data/lib/adhearsion/voip/call.rb

@@ -24,6 +24,8 @@ module Adhearsion
   ##
   # This manages the list of calls the Adhearsion service receives
   class Calls
+    attr_reader :semaphore, :calls
+
     def initialize
       @semaphore = Monitor.new
       @calls     = {}
@@ -60,6 +62,7 @@ module Adhearsion
         return calls[id]
       end
     end
+    alias :[] :find
 
     def clear!
       atomically do
@@ -75,16 +78,23 @@ module Adhearsion
       end
     end
 
+    def each
+      calls.each_pair{|id, call| yield id, call }
+    end
+
     def to_a
       calls.values
     end
 
+    def to_h
+      calls
+    end
+
     private
-      attr_reader :semaphore, :calls
 
-      def atomically(&block)
-        semaphore.synchronize(&block)
-      end
+    def atomically(&block)
+      semaphore.synchronize(&block)
+    end
 
   end
 
@@ -259,6 +269,15 @@ module Adhearsion
       @hungup_call
     end
 
+    # Lock the socket for a command.  Can be used to allow the console to take
+    # control of the thread in between AGI commands coming from the dialplan.
+    def with_command_lock
+      @command_monitor ||= Monitor.new
+      @command_monitor.synchronize do
+        yield
+      end
+    end
+
     # Adhearsion indexes calls by this identifier so they may later be found and manipulated. For calls from Asterisk, this
     # method uses the following properties for uniqueness, falling back to the next if one is for some reason unavailable:
     #

data/lib/theatre.rb

@@ -130,19 +130,14 @@ module Theatre
 
     protected
 
-    # This will use the Adhearsion logger eventually.
-    def warn(exception)
-      # STDERR.puts exception.message, *exception.backtrace
-    end
-
     def thread_loop
       loop do
         begin
           next_invocation = @master_queue.pop
           return :stopped if next_invocation.equal? :THEATRE_SHUTDOWN!
           next_invocation.start
-        rescue => error
-          warn error
+        rescue Exception => error
+          Adhearsion::Events.trigger(['exception'], error)
         end
       end
     end