adhearsion 0.7.6 → 0.7.7

data/apps/default/helpers/multi_messenger.rb

@@ -7,10 +7,10 @@ require 'xmpp4r-simple'
 class MultiMessenger
   
   Format = /\A[\w\._%-]+@[\w\.-]+\.[a-zA-Z]{2,4}\z/
-  
-  def initialize username, password
+  def initialize username, password, accept_subs=false
     @username, @password = username, password
     @connection = Jabber::Simple.new username, password
+    @connection.accept_subscriptions = accept_subs
   end
   
   def connected?() @connection.connected? end
@@ -28,9 +28,26 @@ config = $HELPERS['multi_messenger']
 
 username = config['username']||''
 password = config['password']||''
+accept_subs = config['accept_subscriptions']
 
 log "MultiMessenger: Connecting to #{username}"
-jabber = MultiMessenger.new username, password
+jabber = MultiMessenger.new username, password, accept_subs
+
+jabber.connection.received_messages do |msg|
+  # Need to do something with each message? Do it here.
+end
+
+jabber.connection.presence_updates do |friend, old_presence, new_presence|
+  # Handle presence updates here, optionally
+end
+
+jabber.connection.subscription_requests do |friend, presence|
+  # When a subscription request comes in, handle it here.
+end
+
+jabber.connection.new_subscriptions do |friend, presence|
+  # Handle each subscription notification
+end
 
 InstantMessenger.use_service jabber
 $HUTDOWN.hook { jabber.connection.disconnect }

data/lib/adhearsion.rb

@@ -16,6 +16,7 @@
 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
 require 'core_extensions'
+require 'phone_number'
 
 module Asterisk
 	
@@ -41,18 +42,18 @@ module Asterisk
   # AGI. This code has been kept here in case these bugs are fixed.
 	def old_input digits=nil, user_options=Hash.new('')
     used_options = {:variable => String.random, :digits => digits}
-		used_options.default = ''
-		used_options.merge! user_options
-		args = []
-		%w(variable soundfile digits option attempts timeout).each do |x|
-			args << used_options[x.to_sym]
-		end
-		log "THESE ARE THE INPUT ARGS: " + args.inspect
-		exec :read, args
-		$OSCAR[:VARS] << args.first
-		x = get_variable(args.first).gsub(/[\(\)]/, "")
-		debug "RETURN: #{x.inspect}"
-		x.simplify
+    used_options.default = ''
+    used_options.merge! user_options
+    args = []
+    %w(variable soundfile digits option attempts timeout).each do |x|
+    	args << used_options[x.to_sym]
+    end
+    log "THESE ARE THE INPUT ARGS: " + args.inspect
+    exec :read, args
+    $OSCAR[:VARS] << args.first
+    x = get_variable(args.first).gsub(/[\(\)]/, "")
+    debug "RETURN: #{x.inspect}"
+    x.simplify
 	end
 	
 	# Input is used to receive keypad input from the user, pausing until they
@@ -66,6 +67,8 @@ module Asterisk
 	#
 	# When called without any arguments (or a first argument of -1), the user is
 	# able to enter digits ad infinitum until they press the pound (#) key.
+	#
+	# Note: input() does NOT catch "#" character! Use wait_for_digit instead.
   def input digits=nil, hash={}
     timeout, file = (hash[:timeout] || -1), (hash[:play] || hash[:file] || 'beep')
     result = rawr "GET DATA #{file} #{timeout} #{digits}"
@@ -150,7 +153,7 @@ module Asterisk
   # returns nil. If the asterisk or pound key was pressed, a String is returned of that
   # response. In all other cases, the Fixnum of the number pressed is returned.
   def wait_for_digit timeout=-1
-    digit = rawr("WAIT FOR DIGIT #{timeout < 0 ? -1 : timeout / 1000.0}").match(/=(.*)$/)[1].to_i
+    digit = rawr("WAIT FOR DIGIT #{timeout < 0 ? -1 : timeout * 1000.0}").match(/=(.*)$/)[1].to_i
     return nil if digit <= 0 # If there was an error or timeout
     return digit.chr if (32..45).include? digit
     digit - ?0
@@ -167,12 +170,34 @@ module Asterisk
     end
   end
   
+  def detach!
+    PBX.io.close
+  end
+  
 	# An abstracted remote accessor for retrieving Asterisk variables.
 	def get_variable(key, default=nil)
 		result = rawr "GET VARIABLE #{key}"
-		result[0..12] == "200 result=0" ? default : result[13..-1]
+		result[0..12] == "200 result=0" ? default : result[14..-2].strip
 	end
 
+  # Plays a tone over the call.
+  #
+  # Usage:
+  #  - tone:busy
+  #  - tone:dial
+  #  - tone:info
+  #  - tone:record
+  #  - tone "3333/33,0/15000" # Random custom tone
+  def tone type
+    exec 'PlayTones', (case type
+      when :busy   then "480+620/500,0/500"
+      when :dial   then "440+480/2000,0/4000"
+      when :info   then "!950/330,!1400/330,!1800/330,0"
+      when :record then "1400/500,0/15000"
+      else type
+    end)
+  end
+
   # == Dialing Users
   # 
   # This method will be used in most dial plans written with Adhearsion.
@@ -230,7 +255,18 @@ module Asterisk
   # last_dial_status. Note: last_dial_status returns a Symbol representing
   # the result of the last call. For more information, see its appropriate
   # documentation.
-  # 
+  #
+  # === Setting CallerID
+  #
+  # To set the callerid number, simply pass either a number or a String of the
+  # digits to dial() as a Symbol key argument.
+  #
+  #   dial :crusher, :callerid => 1_555_123_4567
+  #   dial :picard, :callerid => 12224561701
+  #   dial :laforge, :callerid => '14442223333'
+  #
+  # === Dial options
+  #
   # Additionally, you can use the :options hash key argument to specify options
   # which Asterisk's Dial() application normally takes. For example:
   # 
@@ -243,7 +279,17 @@ module Asterisk
   # http://www.voip-info.org/wiki-Asterisk+cmd+Dial
 	def dial who, hash={}
     # if who.is_a_group? TODO: Set the CDR GROUP() value if a Group is dialed.
-		exec :dial, properize(who), *[hash[:for], hash[:options]]
+    
+    # TODO Must be provided as a number until the Set(CALLERID(name)=something)
+    # stuff is figured out.
+    cid = hash.delete :callerid
+    if cid
+      cid = cid.to_s
+      cid = "1" << cid if cid.size == 10
+      rawr %(SET CALLERID "#{cid}") if cid
+    end
+    
+		exec :dial, PBX.properize(who), *[hash[:for], hash[:options]]
 	end
   
   # As you might expect, last_call_successful? returns a boolean depending on whether
@@ -258,6 +304,11 @@ module Asterisk
     !last_call_successful?
   end
 
+  # Send a DTMF tone over the line
+	def dtmf digits
+		exec "SendDTMF", digits.to_s
+	end
+  
   # The stream_file() method comes right over from the AGI protocol.
   # Its use is very similar to the Background() application from
   # Asterisk's extensions.conf language. A file is played in the
@@ -293,8 +344,29 @@ module Asterisk
   # Festival is pretty buggy (and pretty inefficient). In theory,
   # this should speak out any text supplied to it.
   def speak text
-    text.gsub!('\n').gsub!('\r').strip!
-    exec :festival, "'#{text}'"
+    text.gsub! "\n",''
+    text.gsub! "\r",''
+    text.strip!
+    exec :Festival, "#{text.inspect}"
+  end
+
+  def build_local first, second=nil
+    num = 1
+    context = nil
+    if first.kind_of? Fixnum
+      num = first
+      context = second if second
+    else
+      context = first
+      num = second if second
+    end
+    returning("Local/#{num}") do |s|
+      s << "@#{context}" if context
+    end
+  end
+
+  def external_invoke *args
+    dial build_local(*args)
   end
   
   # Since voicemail is used so frequently, extra effort has been made to
@@ -362,12 +434,40 @@ module Asterisk
   def play *files
     files.flatten!
     files.each do |f|
-      if f.simplify.is_a? Fixnum then exec :saynumber, f
+      if f.kind_of? Time
+        exec :SayUnixTime, f.to_i
+      elsif f.kind_of? Symbol then exec :playback, f
+      elsif f[0] == ?$
+        # Speak a currency. TODO: support currencies other than dollars.
+        full,dollars,decimal,cents = *f.match(/^\$(\d+)(\.(\d{1,2}).*)?$/)
+        if full
+          exec :saynumber, dollars
+          exec :playback, (dollars == '1') ? 'dollar' : 'dollars'
+          if decimal
+            exec :playback, 'and'
+            exec :saynumber, cents
+            exec :playback, (cents == '1') ? 'cent' : 'cents'
+          end
+        else exec :playback, f
+        end
+      elsif f.simplify.kind_of? Numeric then exec :saynumber, f
       else exec :playback, f
       end
     end
   end
 
+  # Compiles the provided Asterisk dialplan pattern into a Ruby regular
+  # expression. For more usage of Asterisk's pattern syntax, see
+  # http://www.voip-info.org/wiki/view/Asterisk+Dialplan+Patterns
+  def _ pattern
+    # Uncomment the following code fragment for complete compatability.
+    # The fragment handles the seldom-used hyphen number spacer with no
+    # meaning.
+  	Regexp.new '^' << pattern.#gsub(/(?!\[[\w+-]+)-(?![\w-]+\])/,'').
+  	  gsub('X', '[0-9]').gsub('Z', '[1-9]').gsub('N','[2-9]').
+  	  gsub('.','.+').gsub('!','.*') << '$'
+  end
+
   # == Dialplan Instruction Caching
   #
   # If a cynic ever says Ruby doesn't make an efficient dial plan manager,
@@ -548,37 +648,7 @@ module Asterisk
   end
 
   # Very simply sends the command over the AGI IO socket and forgets about it.
-  def putc(what) PBX.io.print "#{what}" end
-  
-  # The magical method that handles how objects passed to dial() are converted to their
-  # corresponding Asterisk-recognizable technology/extension identifier. This likely
-  # wouldn't be used much outside of dial(), but you may find it useful.
-	def properize who
-	  # These are the convention methods for Group-like objects
-		group_method = who.is_a_group?
-		
-		# If 'who' has any of the possible_methods, replace 'who' with the return value
-		# of that method
-		who = who.send group_method if group_method
-		return nil unless who
-		
-		# In case we can't perform collection algorithms on 'who', let's encapsulate it in
-		# an Array
-		who = [who] unless who.kind_of?(Enumerable) && !who.kind_of?(String)
-		
-		user_method = who.first.is_a_user?
-		# If the first thing in the Enumerable responds to a User-like convention, then 
-	  #	set 'who' equal to the extension(s) accessor of those objects. We refine the "who"
-	  # argument more and more in this way until it's finally in a way Asterisk can read.
-		who.map! { |p| p.send user_method }.compact! if user_method
-		
-		# Now replace each item in the Enumerable with its form converted to
-		# extension (assuming it's not already in that format)
-		who.map! do |ext|
-      (ext.kind_of?(String) && ext.index(?/)) ? ext : "SIP/#{ext}"
-    end
-		who * '&' # Finally, join() anything left in the Array with an '&'
-	end
+  def putc(what) PBX.io.print "#{what}" end  
 
 	# Returns the status of the last dial(). Possible dial
   # statuses include :answer, :busy, :noanswer, :cancel,
@@ -600,59 +670,119 @@ module Asterisk
 	# Direct translation of the Asterisk NoOp() application. Used primarily for
 	# viewing debug information in the Asterisk CLI.
 	def noop(*options) rawr "NOOP #{options}" end	
-end
-
-# This SIP class abstracts several SIP-related functions. In your dialplan,
-# if you should want to set a SIP header specifically, simply use the class
-# []= operator. For example, you may want to do SIP['Alert-Info'] = 'Ring-Answer'
-# which will affect the next SIP call placed. Additionally, you can use this
-# class's division operator to naturally represent "technology/channel"
-# endpoints (e.g. SIP/1550 or SIP/:tweedledum)
-class SIP
-  
-  # This will set the header value specified within the square bracked to the
-  # value given after the equals sign. Note: this can only be called if the
-  # current call's thread is handling an Asterisk call over AGI (i.e. dialplan).
-	def self.[]=(header, value)
-	  exec :SipAddHeader, "#{header}: #{value}"
-	end
 	
-	# Simple convenience method to make Adhearsion's DSL more Asterisk-like.
-	# Virtually anything can be provided after the "/", as long as its to_s()
-	# method is what you intended to represent.
-	def self./(ext) "SIP/#{ext}" end
 end
 
-class IAX
-  # Simple convenience method to make Adhearsion's DSL more Asterisk-like.
-	# Virtually anything can be provided after the "/", as long as its to_s()
-	# method is what you intended to represent.
-  def self./(arg=nil) "IAX2/#{arg}" end
+# # This Endpoint module is only used when using the
+# # forward-slash operator on the dialplan technology
+# # classes such as IAX, SIP, Zap, Local, SCCP, etc.
+# # The String's eigencalss returned from IAX/:foobar
+# # extends this module.
+# module Endpoint
+#   def /(x) to_s << "/" << x.to_s end
+# end
+# 
+# # Use like IAX/:trunk/12345
+# class IAX
+#   def self./(x) "IAX2/#{x}".extend Endpoint end
+# end
+# # Use like SIP/:trunk/12345
+# class SIP
+#   def self./(x) "SIP/#{x}".extend Endpoint end
+# end
+# # Use like SCCP/:trunk/12345
+# class SCCP
+#   def self./(x) "SCCP/#{x}".extend Endpoint end
+# end
+# # Use like Zap/:channel/12345
+# class Zap
+#   def self./(x) "ZAP/#{x}".extend Endpoint end
+# end
+# # Use like Local/'extension@context'
+# class Local
+#   def self./(x) "Local/#{x}".extend Endpoint end
+# end
+# class GTalk
+#   def self./(x) "gtalk/#{x}".extend Endpoint end
+# end
+# 
+# # Use like IAX2/:trunk/12345
+# class IAX2 < IAX;end
+# # Use like ZAP/:channel/12345
+# class ZAP < Zap;end
+
+# Contributed by Bruce Williams of Five Runs.
+module DialplanTechnologies
+  module Endpoint
+  	def /(x) to_s << "/" << x.to_s end
+  end
+  
+  class Base
+    def self./(x) "#{self}/#{x}".extend(Endpoint) end
+  end
+  
+  class << self
+    def define(&block)
+      instance_eval(&block)
+    end
+    def add(*technologies)
+      options = technologies.last.is_a?(Hash) ? technologies.pop : {}
+      technologies.each do |name|
+        eval %{class ::#{name} < Base; def self.to_s; "#{options[:as] || name}"; end; end}
+      end
+    end
+  end
+  
 end
 
-class ZAP
-  # Simple convenience method to make Adhearsion's DSL more Asterisk-like.
-	# Virtually anything can be provided after the "/", as long as its to_s()
-	# method is what you intended to represent.
-  def self./(arg=nil) "Zap/#{arg}" end
+DialplanTechnologies.define do
+  add :IAX2, :SIP, :SCCP, :ZAP, :Local
+  add :GTalk, :as => :gtalk
+  add :Zap, :as => :ZAP
+  add :IAX, :as => :IAX2
 end
 
-# For users who may try to use the (proper) IAX2 form. See IAX for more info.
-class IAX2 < IAX; end
-
-# For users who may try to use the (common) "Zap" form. See ZAP for more info.
-class Zap < ZAP; end
 
 # The PBX object is an object manifestation of the PBX with which Adhearsion will be
 # associated. Helpers often open up this class and add methods to it. Note: when doing
 # this in your own helpers, all methods will need to be class (a.k.a. static) methods
 # since no actual instance of this object is passed around.
 class PBX
-  def method_missing name
+  def self.method_missing name
     raise NameError, "Method #{name} not found! Are you sure manager_proxy is configured properly?"
   end
+
+  # The magical method that handles how objects passed to dial() are converted to their
+  # corresponding Asterisk-recognizable technology/extension identifier. This likely
+  # wouldn't be used much outside of dial(), but you may find it useful.
+	def self.properize who
+    
+    group_method = who.is_a_group?
+    
+    # If 'who' has any of the possible_methods, replace 'who' with the return value
+    # of that method
+    who = who.send group_method if group_method
+    return nil unless who
+    
+    # In case we can't perform collection algorithms on 'who', let's encapsulate it in
+    # an Array
+    who = [who] unless who.kind_of?(Enumerable) && !who.kind_of?(String)
+    
+    user_method = who.first.is_a_user?
+    # If the first thing in the Enumerable responds to a User-like convention, then 
+    #	set 'who' equal to the extension(s) accessor of those objects. We refine the "who"
+    # argument more and more in this way until it's finally in a way Asterisk can read.
+    who.map! { |p| p.send user_method }.compact! if user_method
+    
+    # Now replace each item in the Enumerable with its form converted to
+    # extension (assuming it's not already in that format)
+    who.map! do |ext|
+      (ext.kind_of?(String) && ext.index(?/)) ? ext : "SIP/#{ext}"
+    end
+    who * '&' # Finally, join() anything left in the Array with an '&'
+	end
   
-  def PBX.io() Thread.current[:io] end
+  def self.io() Thread.current[:io] end
 end
 
 # The Contexts class is a blank slate in which the extensions.rb file is evaluated.
@@ -822,4 +952,4 @@ end
 # is one of the names you're signed into AIM with. Note: this example doesn't use the :through
 # Hash-key argument because it assumes no other helpers are installed with this same format.
 # If you had a MSN or Yahoo helper installed too, you'd need to do specify :through because
-def im(sn, msg, hash={}) InstantMessenger.im(sn,msg,hash) end
+def im(sn, msg, hash={}) InstantMessenger.im(sn,msg,hash) end