eric-adhearsion 0.7.999 → 0.8.0

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

@@ -0,0 +1,19 @@
+module Adhearsion
+  module VoIP
+    module Asterisk
+      module Manager
+        
+        ##
+        # Higher level abstraction of the Asterisk Manager Interface.
+        #
+        class SuperManager
+          
+          def initialize
+            raise NotImplementedError
+          end
+          
+        end
+      end
+    end
+  end
+end

data/lib/adhearsion/voip/call.rb

@@ -61,6 +61,18 @@ module Adhearsion
       end
     end
     
+    def with_tag(tag)
+      atomically do
+        calls.inject(Array.new) do |calls_with_tag,(key,call)|
+          call.tagged_with?(tag) ? calls_with_tag << call : calls_with_tag
+        end
+      end
+    end
+    
+    def to_a
+      calls.values
+    end
+    
     private
       attr_reader :semaphore, :calls
       
@@ -80,7 +92,6 @@ module Adhearsion
     end
   end
   
-  
   class FailedExtensionCallException < MetaAgiCallException; end
   
   class HungupExtensionCallException < MetaAgiCallException; end
@@ -142,6 +153,33 @@ module Adhearsion
       check_if_valid_call
       define_variable_accessors
       set_originating_voip_platform!
+      @tag_mutex = Mutex.new
+      @tags = []
+    end
+
+    def tags
+      @tag_mutex.synchronize do
+        return @tags.clone
+      end
+    end
+
+    def tag(symbol)
+      raise ArgumentError, "tag must be a Symbol" unless symbol.is_a? Symbol
+      @tag_mutex.synchronize do
+        @tags << symbol
+      end
+    end
+    
+    def remove_tag(symbol)
+      @tag_mutex.synchronize do
+        @tags.reject! { |tag| tag == symbol }
+      end
+    end
+    
+    def tagged_with?(symbol)
+      @tag_mutex.synchronize do
+        @tags.include? symbol
+      end
     end
 
     def deliver_message(message)
@@ -237,6 +275,7 @@ module Adhearsion
           replace_yes_no_answers_with_booleans
           coerce_request_into_uri_object
           decompose_uri_query_into_hash
+          override_variables_with_query_params
           remove_dashes_from_context_name
           coerce_type_of_number_into_symbol
         }
@@ -315,7 +354,7 @@ module Adhearsion
             returning variables do
               if variables[:request].query
                 variables[:query] = variables[:request].query.split('&').inject({}) do |query_string_parameters, key_value_pair|
-                  parameter_name, parameter_value = *key_value_pair.match(/(.+)=(.+)/).captures
+                  parameter_name, parameter_value = *key_value_pair.match(/(.+)=(.*)/).captures
                   query_string_parameters[parameter_name] = parameter_value
                   query_string_parameters
                 end
@@ -325,6 +364,16 @@ module Adhearsion
             end
           end
           
+          def override_variables_with_query_params(variables)
+            returning variables do
+              if variables[:query]
+                variables[:query].each do |key, value|
+                  variables[key.to_sym] = value
+                end
+              end
+            end
+          end
+          
           def remove_dashes_from_context_name(variables)
             returning variables do
               variables[:context].gsub!('-', '_')

data/lib/adhearsion/voip/dial_plan.rb

@@ -1,6 +1,4 @@
 # Hardcoding require for now since for some reason it's not being loaded
-require 'adhearsion/blank_slate'
-require 'adhearsion/component_manager'
 require 'adhearsion/voip/dsl/dialplan/control_passing_exception'
 
 module Adhearsion
@@ -8,25 +6,40 @@ module Adhearsion
     attr_accessor :loader, :entry_points
     def initialize(loader = Loader)
       @loader       = loader
-      @entry_points = @loader.load_dial_plan.contexts
+      @entry_points = @loader.load_dialplans.contexts
     end
     
     ##
     # Lookup and return an entry point by context name
+    #
     def lookup(context_name)
       entry_points[context_name]
     end
     
     ##
-    # Executable environment for a dial plan in the scope of a call
+    # Executable environment for a dial plan in the scope of a call. This class has all the dialplan methods mixed into it.
+    #
     class ExecutionEnvironment
       
+      class << self
+        def create(*args)
+          returning(new(*args)) { |instance| instance.stage! }
+        end
+      end
+      
       attr_reader :call
-      def initialize(call, entry_point=nil)
+      def initialize(call, entry_point)
         @call, @entry_point = call, entry_point
+      end
+      
+      ##
+      # Adds the methods to this ExecutionEnvironment which make it useful. e.g. dialplan-related methods, call variables,
+      # and component methods.
+      #
+      def stage!
         extend_with_voip_commands!
         extend_with_call_variables!
-        extend_with_components_with_call_context!
+        extend_with_dialplan_component_methods!
       end
       
       def run
@@ -41,27 +54,22 @@ module Adhearsion
         end
       end
       
-      private
-        attr_reader :entry_point
-        
-        def extend_with_voip_commands!
-          extend(Adhearsion::VoIP::Conveniences)
-          extend(Adhearsion::VoIP::Commands.for(call.originating_voip_platform))
-        end
-        
-        def extend_with_call_variables!
-          call.define_variable_accessors self
-        end
-        
-        def extend_with_components_with_call_context!
-          ComponentManager.components_with_call_context.keys.each do |component_name|
-            eval <<-COMPONENT_BUILDER
-              def self.new_#{component_name.underscore}(*args, &block)
-                ComponentManager.components_with_call_context['#{component_name}'].instantiate_with_call_context(self, *args, &block)
-              end
-            COMPONENT_BUILDER
-          end
-        end
+      protected
+
+      attr_reader :entry_point
+      def extend_with_voip_commands!
+        extend Adhearsion::VoIP::Conveniences
+        extend Adhearsion::VoIP::Commands.for(call.originating_voip_platform)
+      end
+      
+      def extend_with_call_variables!
+        call.define_variable_accessors self
+      end
+      
+      def extend_with_dialplan_component_methods!        
+        Components.component_manager.extend_object_with(self, :dialplan) if Components.component_manager
+      end
+      
     end
     
     class Manager
@@ -81,20 +89,19 @@ module Adhearsion
       
       def handle(call)
         if call.failed_call?
-          environment = ExecutionEnvironment.new(call)
-          call.extract_failed_reason_from(environment)
+          environment = ExecutionEnvironment.create(call, nil)
+          call.extract_failed_reason_from environment
           raise FailedExtensionCallException.new(environment)
         end
         
         if call.hungup_call?
-          raise HungupExtensionCallException.new(ExecutionEnvironment.new(call))
+          raise HungupExtensionCallException.new(ExecutionEnvironment.new(call, nil))
         end
         
         starting_entry_point = entry_point_for call
         raise NoContextError, "No dialplan entry point for call context '#{call.context}' -- Ignoring call!" unless starting_entry_point
-      
-        @context = ExecutionEnvironment.new(call, starting_entry_point)
-        inject_context_names_into_environment(@context)
+        @context = ExecutionEnvironment.create(call, starting_entry_point)
+        inject_context_names_into_environment @context
         @context.run
       end
       
@@ -103,7 +110,7 @@ module Adhearsion
       def entry_point_for(call)
         if entry_point = dial_plan.lookup(call.context.to_sym)
           entry_point
-        elsif m = call.request.path.match(%r{/([^/]+)})
+        elsif call.respond_to?(:request) && m = call.request.path.match(%r{/([^/]+)})
           dial_plan.lookup(m[1].to_sym)
         end
       end
@@ -124,50 +131,55 @@ module Adhearsion
         attr_accessor :default_dial_plan_file_name
         
         def load(dial_plan_as_string)
-          returning new do |loader|
-            inject_dial_plan_component_classes_into dial_plan_as_string
-            loader.load(dial_plan_as_string)
+          string_io = StringIO.new dial_plan_as_string
+          def string_io.path
+            "(eval)"
           end
+          load_dialplans string_io
         end
         
-        def load_dial_plan(file_name = default_dial_plan_file_name)
-          load read_dialplan_file(AHN_ROOT.dial_plan_named(file_name))
-        end
-        
-        private
-          def inject_dial_plan_component_classes_into(dial_plan_as_string)
-            dial_plan_as_string[0, 0] = ComponentManager.components_with_call_context.keys.map do |component| 
-              "#{component} = ::Adhearsion::ComponentManager.components_with_call_context['#{component}'] unless defined? #{component}\n"
-            end.join
+        def load_dialplans(*files)
+          files = Adhearsion::AHN_CONFIG.files_from_setting("paths", "dialplan") if files.empty?
+          files = Array files
+          files.map! do |file|
+            case file
+              when File, StringIO
+                file
+              when String
+                File.new file
+              else
+                raise ArgumentError, "Unrecognized type of file #{file.inspect}"
+            end
           end
-          
-          def read_dialplan_file(filename)
-            File.read filename
+          returning new do |loader|
+            files.each do |file|
+              loader.load file
+            end
           end
-          
+        end
+        
       end
       
       self.default_dial_plan_file_name ||= 'dialplan.rb'
 
-      attr_reader :contexts
       def initialize
-        @contexts = {}
+        @context_collector = ContextNameCollector.new
       end
       
-      def load(dial_plan_as_string)
-        contexts.update(ContextNameCollector.build(dial_plan_as_string))
+      def contexts
+        @context_collector.contexts
+      end
+      
+      def load(dialplan_file)
+        dialplan_code = dialplan_file.read
+        @context_collector.instance_eval(dialplan_code, dialplan_file.path)
+        nil
       end
       
       class ContextNameCollector# < ::BlankSlate
         
         class << self
-          
-          def build(dial_plan_as_string)
-            builder = new
-            builder.instance_eval(dial_plan_as_string)
-            builder.contexts
-          end
-          
+
           def const_missing(name)
             super
           rescue ArgumentError
@@ -185,6 +197,7 @@ module Adhearsion
           super if !block_given? || args.any?
           contexts[name] = DialplanContextProc.new(name, &block)
         end
+        
       end
     end
     class DialplanContextProc < Proc

data/lib/adhearsion/voip/dsl/dialing_dsl.rb

@@ -15,7 +15,7 @@
 # License along with this library; if not, write to the Free Software
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
-require 'adhearsion/core_extensions/metaprogramming'
+require 'adhearsion/foundation/metaprogramming'
 require 'adhearsion/voip/conveniences'
 require 'adhearsion/voip/constants'
 require 'adhearsion/voip/dsl/dialing_dsl/dialing_dsl_monkey_patches'

data/lib/adhearsion/voip/dsl/dialplan/parser.rb

@@ -14,14 +14,10 @@ module Adhearsion
           
           #TODO: separate into smaller pieces
           def self.get_contexts
-            unless Adhearsion::Paths.manager_for?("dialplans")
-              raise "No dialplan files found in .ahnrc!" 
-            end
-            
             envelope = ContextsEnvelope.new
             
-            dialplans = all_dialplans
-            warn "No dialplan files were found!" if dialplans.empty?
+            dialplans = AHN_CONFIG.files_from_setting "paths", "dialplan"
+            ahn_log.dialplan.warn "No dialplan files were found!" if dialplans.empty?
             
             returning({}) do |contexts|
               dialplans.each do |file|

data/lib/adhearsion/voip/dsl/numerical_string.rb

@@ -52,10 +52,10 @@ module Adhearsion
 
         # Checks against a pattern identifying US local numbers (i.e numbers
         # without an area code seven digits long)
-        def local_number?() to_s =~ Adhearsion::VoIP::Constants::US_LOCAL_NUMBER end
+        def us_local_number?() to_s =~ Adhearsion::VoIP::Constants::US_LOCAL_NUMBER end
 
         # Checks against a pattern identifying US domestic numbers.
-        def national_number?() to_s =~ Adhearsion::VoIP::Constants::US_NATIONAL_NUMBER end
+        def us_national_number?() to_s =~ Adhearsion::VoIP::Constants::US_NATIONAL_NUMBER end
 
         # Checks against a pattern identifying an ISN number. See http://freenum.org
         # for more info.

data/lib/adhearsion/voip/freeswitch/oes_server.rb

@@ -52,7 +52,7 @@ module Adhearsion
           # If the target context does not exist, warn and don't handle the call
           unless first_context
             log "No context '#{first_context_name}' found in " +
-                "#{all_dialplans.to_sentence(:connector => "or")}. Ignoring request!"
+                "#{AHN_CONFIG.files_from_setting("paths", "").to_sentence(:connector => "or")}. Ignoring request!"
             return
           end
           
@@ -91,7 +91,7 @@ module Adhearsion
         # time.
         def should_reload_contexts?
           !@abstract_contexts || !@abstract_dispatcher ||
-            all_dialplans.map { |x| File.mtime(x) }.max < Time.now
+            AHN_CONFIG.files_from_setting("paths", "dialplan").map { |x| File.mtime(x) }.max < Time.now
         end
         
         def rubyize_keys_for(hash)

data/lib/theatre.rb

@@ -0,0 +1,151 @@
+require 'thread'
+require 'rubygems'
+
+$: << File.expand_path(File.dirname(__FILE__))
+
+require 'theatre/version'
+require 'theatre/namespace_manager'
+require 'theatre/invocation'
+require 'theatre/callback_definition_loader'
+
+module Theatre
+  
+  class Theatre
+    
+    attr_reader :namespace_manager
+    
+    ##
+    # Creates a new stopped Theatre. You must call start!() after you instantiate this for it to begin processing events.
+    #
+    # @param [Fixnum] thread_count Number of Threads to spawn when started.
+    #
+    def initialize(thread_count=6)
+      @thread_count      = thread_count
+      @started           = false
+      @namespace_manager = ActorNamespaceManager.new
+      @thread_group      = ThreadGroup.new
+      @master_queue      = Queue.new
+      @loader_mixins     = []
+    end
+    
+    ##
+    # Send a message to this Theatre for asynchronous processing.
+    #
+    # @param [String] namespace The namespace to which the payload should be sent
+    # @param [Object] payload The actual content to be sent to the callback. Optional.
+    # @return [Array<Theatre::Invocation>] An Array of Invocation objects
+    # @raise Theatre::NamespaceNotFound Raised when told to enqueue an unrecognized namespace
+    #
+    def trigger(namespace, payload=:argument_undefined)
+      @namespace_manager.callbacks_for_namespaces(namespace).map do |callback|
+        invocation = if payload.equal?(:argument_undefined)
+          Invocation.new(namespace, callback)
+        else
+          Invocation.new(namespace, callback, payload)
+        end
+        invocation.queued
+        @master_queue << invocation
+        invocation
+      end
+    end
+    
+    ##
+    # Send a message to this Theatre for synchronous processing. The execution of this will not go through this Theatre's
+    # Thread pool. If an error occurred in any of callbacks, the Exception object will be placed in the returned Array 
+    # instead for you to act upon.
+    #
+    # @param [String] namespace The namespace to which the payload should be sent
+    # @param [Object] payload The actual content to be sent to the callback. Optional.
+    # @return [Array] An Array containing each callback's return value (or Exception raised, if any) when given the payload
+    # @raise Theatre::NamespaceNotFound Raised when told to enqueue an unrecognized namespace
+    #
+    def trigger_immediately(namespace, payload=:argument_undefined)
+      @namespace_manager.callbacks_for_namespaces(namespace).map do |callback|
+        begin
+          invocation = if payload.equal?(:argument_undefined)
+            callback.call
+          else
+            callback.call payload
+          end
+        rescue => captured_error_to_be_returned
+          captured_error_to_be_returned
+        end
+      end
+    end
+    
+    def load_events_code(code, *args)
+      loader = CallbackDefinitionLoader.new(self, *args)
+      loader.load_events_code code
+    end
+    
+    def load_events_file(file, *args)
+      loader = CallbackDefinitionLoader.new(self, *args)
+      loader.load_events_file file
+    end
+    
+    def register_namespace_name(*args)
+      @namespace_manager.register_namespace_name(*args)
+    end
+    
+    def register_callback_at_namespace(*args)
+      @namespace_manager.register_callback_at_namespace(*args)
+    end
+    
+    def register_loader_mixin(mod)
+      @loader_mixins << mod
+    end
+    
+    def join
+      @thread_group.list.each do |thread|
+        begin
+          thread.join
+        rescue
+          # Ignore any exceptions
+        end
+      end
+    end
+    
+    ##
+    # Starts this Theatre.
+    #
+    # When this method is called, the Threads are spawned and begin pulling messages off this Theatre's master queue.
+    #
+    def start!
+      return false if @thread_group.list.any? # Already started
+      @started_time = Time.now
+      @thread_count.times do
+        @thread_group.add Thread.new(&method(:thread_loop))
+      end
+    end
+    
+    ##
+    # Notifies all Threads for this Theatre to stop by sending them special messages. Any messages which were queued and
+    # untriggered when this method is received will still be processed. Note: you may start this Theatre again later once it
+    # has been stopped.
+    #
+    def graceful_stop!
+      @thread_count.times { @master_queue << :THEATRE_SHUTDOWN! }
+      @started_time = nil
+    end
+    
+    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
+        end
+      end
+    end
+    
+  end
+end