oversip 1.2.1 → 1.3.0.dev1

data/lib/oversip/sip/proxy.rb

@@ -1,62 +1,19 @@
 module OverSIP::SIP
 
-  class Proxy
-
-    include ::OverSIP::Logger
-
-    def initialize proxy_profile=:default_proxy
-      unless (@proxy_conf = ::OverSIP.proxies[proxy_profile.to_sym])
-        raise ::OverSIP::RuntimeError, "proxy '#{proxy_profile}' is not defined in Proxies Configuration file"
-      end
-    end
-
-
-    def on_provisional_response &block
-      @on_provisional_response_block = block
-    end
-
-    def on_success_response &block
-      @on_success_response_block = block
-    end
-
-    def on_failure_response &block
-      @on_failure_response_block = block
-    end
-
-    def on_canceled &block
-      @on_canceled_block = block
-    end
-
-    def on_invite_timeout &block
-      @on_invite_timeout_block = block
-    end
-
-    def on_error &block
-      @on_error_block = block
-    end
-
-    def on_target &block
-      @on_target_block = block
-    end
+  class Proxy < Client
 
     # If called, current response within the called callback won't be forwarded.
     def drop_response
       @drop_response = true
     end
 
-    # It must only be called within the on_target() callback. By calling this method,
-    # the request routing is aborted, no more DNS targets are tryed, a local 403 response
-    # is generated and on_error() callback is called with status 403.
-    def abort_routing
-      @aborted = true
-    end
 
     def route request, dst_host=nil, dst_port=nil, dst_transport=nil
       unless (@request = request).is_a? ::OverSIP::SIP::Request
         raise ::OverSIP::RuntimeError, "request must be a OverSIP::SIP::Request instance"
       end
 
-      @log_id = "Proxy #{@proxy_conf[:name]} #{@request.via_branch_id}"
+      @log_id = "Proxy #{@conf[:name]} #{@request.via_branch_id}"
 
       # Create the server transaction if it doesn't exist yet.
       @server_transaction = @request.server_transaction or case @request.sip_method
@@ -79,7 +36,7 @@ module OverSIP::SIP
       # set then don't honor the Outbound connection).
 
       if @request.incoming_outbound_requested? and not dst_host
-        @client_transaction = (::OverSIP::SIP::ClientTransaction.get_class @request).new self, @request, @proxy_conf, @request.route_outbound_flow_token
+        @client_transaction = (::OverSIP::SIP::ClientTransaction.get_class @request).new self, @request, @conf, @request.route_outbound_flow_token
 
         if @client_transaction.connection
           add_routing_headers
@@ -88,7 +45,7 @@ module OverSIP::SIP
           unless @request.sip_method == :ACK
             log_system_debug "flow failed"  if $oversip_debug
 
-            @on_error_block && @on_error_block.call(430, "Flow Failed")
+            @on_error_block && @on_error_block.call(430, "Flow Failed", :flow_failed)
             unless @drop_response
               @request.reply 430, "Flow Failed"
             else
@@ -139,56 +96,14 @@ module OverSIP::SIP
       end
 
       # Loockup in the DNS cache of this proxy.
-      if dst_host_type == :domain and @proxy_conf[:use_dns_cache]
-        dns_cache_entry = "#{dst_host}|#{dst_port}|#{dst_transport}|#{dst_scheme}"
-        if (result = @proxy_conf[:dns_cache][dns_cache_entry])
-          log_system_debug "destination found in the DNS cache"  if $oversip_debug
-          if result.is_a? ::Symbol
-            rfc3263_failed result
-          else
-            rfc3263_succeeded result
-          end
-          return
-        end
-      else
-        dns_cache_entry = nil
-      end
+      result = check_dns_cache dst_scheme, dst_host, dst_host_type, dst_port, dst_transport
 
-      # Perform RFC 3261 procedures.
-      dns_query = ::OverSIP::SIP::RFC3263::Query.new @proxy_conf, @request.via_branch_id, dst_scheme, dst_host, dst_host_type, dst_port, dst_transport
-      case result = dns_query.resolve
-
-      # Async result so DNS took place.
-      when nil
-        # Async success.
-        dns_query.callback do |result|
-          # Store the result in the DNS cache.
-          if dns_cache_entry
-            @proxy_conf[:dns_cache][dns_cache_entry] = result
-            ::EM.add_timer(@proxy_conf[:dns_cache_time]) { @proxy_conf[:dns_cache].delete dns_cache_entry }
-          end
-          rfc3263_succeeded result
-        end
-        # Async error.
-        dns_query.errback do |result|
-          # Store the result in the DNS cache.
-          if dns_cache_entry
-            @proxy_conf[:dns_cache][dns_cache_entry] = result
-            ::EM.add_timer(@proxy_conf[:dns_cache_time]) { @proxy_conf[:dns_cache].delete dns_cache_entry }
-          end
-          rfc3263_failed result
-        end
-      # Instant error.
-      when ::Symbol
-        # Store the result in the DNS cache.
-        if dns_cache_entry
-          @proxy_conf[:dns_cache][dns_cache_entry] = result
-          ::EM.add_timer(@proxy_conf[:dns_cache_time]) { @proxy_conf[:dns_cache].delete dns_cache_entry }
-        end
-        rfc3263_failed result
-      # Instant success so it's not a domain (no DNS performed).
-      else
-        rfc3263_succeeded result
+      case result
+      when true
+        return
+      else  # It can be String or nil, so use it as dns_cache_key param.
+        # Perform RFC 3263 procedures.
+        do_dns result, @request.via_branch_id, dst_scheme, dst_host, dst_host_type, dst_port, dst_transport
       end
 
     end  # def route
@@ -206,7 +121,7 @@ module OverSIP::SIP
           @on_success_response_block && @on_success_response_block.call(response)
         elsif response.status_code >= 300 && ! @canceled
           if response.status_code == 503
-            if @proxy_conf[:dns_failover_on_503]
+            if @conf[:dns_failover_on_503]
               try_next_target nil, nil, response
               return
             else
@@ -239,22 +154,7 @@ module OverSIP::SIP
     end
 
 
-    def client_timeout
-      try_next_target 408, "Client Timeout"
-    end
-
-
-    def connection_failed
-      try_next_target 500, "Connection Error"
-    end
-
-
-    def tls_validation_failed
-      try_next_target 500, "TLS Validation Failed"
-    end
-
-
-    # Timer C for INVITE.
+    # Timer C for INVITE (method called by the client transaction).
     def invite_timeout
       @on_invite_timeout_block && @on_invite_timeout_block.call
 
@@ -265,6 +165,7 @@ module OverSIP::SIP
     end
 
 
+
     private
 
 
@@ -278,7 +179,7 @@ module OverSIP::SIP
 
       # NOTE: As per RFC 6665 the proxy MUST add Record-Route to in-dialog NOTIFY's.
       if (@request.initial? and @request.record_routing_aware?) or @request.sip_method == :NOTIFY
-        do_record_routing = @proxy_conf[:do_record_routing]
+        do_record_routing = @conf[:do_record_routing]
 
         # Request has no previous RR/Path and current proxy performs record-routing.
         # So add RR/Path.
@@ -329,7 +230,13 @@ module OverSIP::SIP
             @request.insert_header "Path", @request.connection.class.record_route
           else
             @request.in_rr = :path
-            @request.insert_header "Path", @request.connection.class.record_route
+            # The request comes via UDP or via a connection made by the client.
+            if @request.connection.class.outbound_listener?
+              @request.insert_header "Path", @request.connection.class.record_route
+            # The request comes via a TCP/TLS connection made by OverSIP.
+            else
+              @request.insert_header "Path", @request.connection.record_route
+            end
           end
 
         # Record-Route for INVITE, SUBSCRIBE, REFER and in-dialog NOTIFY.
@@ -346,7 +253,13 @@ module OverSIP::SIP
             @request.insert_header "Record-Route", @request.connection.class.record_route
           else
             @request.in_rr = :rr
-            @request.insert_header "Record-Route", @request.connection.class.record_route
+            # The request comes via UDP or via a connection made by the client.
+            if @request.connection.class.outbound_listener?
+              @request.insert_header "Record-Route", @request.connection.class.record_route
+            # The request comes via a TCP/TLS connection made by OverSIP.
+            else
+              @request.insert_header "Record-Route", @request.connection.record_route
+            end
           end
 
         end
@@ -355,129 +268,42 @@ module OverSIP::SIP
     end  # add_routing_headers
 
 
-    def rfc3263_succeeded result
-      # After RFC 3263 (DNS) resolution we get N targets.
-      @num_target = 0  # First target is 0 (rather than 1).
-
-      case result
-
-      when RFC3263::Target
-        @target = result  # Single Target.
-
-      when RFC3263::SrvTargets
-        log_system_debug "result is srv targets => randomizing:"  if $oversip_debug
-        @targets = result.randomize  # Array of Targets.
-
-      # This can contain Target and SrvTargets entries.
-      when RFC3263::MultiTargets
-        log_system_debug "result is MultiTargets => flatting:"  if $oversip_debug
-        @targets = result.flatten  # Array of Targets.
-
-      end
-
-      try_next_target
-    end  # rfc3263_succeeded
-
-
-    def try_next_target status=nil, reason=nil, full_response=nil
-      # Single target.
-      if @target and @num_target == 0
-        log_system_debug "using single target: #{@target}"  if $oversip_debug
-        use_target @target
-        @num_target = 1
-
-      # Multiple targets (so @targets is set).
-      elsif @targets and @num_target < @targets.size
-        log_system_debug "using target #{@num_target+1} of #{@targets.size}: #{@targets[@num_target]}"  if $oversip_debug
-        use_target @targets[@num_target]
-        @num_target += 1
+    def no_more_targets status, reason, full_response, code
+      # If we have received a [3456]XX response from downstream then run @on_failure_block.
+      if full_response
+        @on_failure_response_block && @on_failure_response_block.call(full_response)
+        unless @drop_response
+          # If the response is 503 convert it into 500 (RFC 3261 16.7).
+          full_response.status_code = 500  if full_response.status_code == 503
+          @request.reply_full full_response
+        else
+          @drop_response = false
+        end
 
-      # No more targets.
+      # If not, generate the response according to the given status and reason.
       else
-        # If we have received a [3456]XX response from downstream then run @on_failure_block.
-        if full_response
-          @on_failure_response_block && @on_failure_response_block.call(full_response)
-          unless @drop_response
-            # If the response is 503 convert it into 500 (RFC 3261 16.7).
-            full_response.status_code = 500  if full_response.status_code == 503
-            @request.reply_full full_response
-          else
-            @drop_response = false
-          end
-
-        # If not, generate the response according to the given status and reason.
+        @on_error_block && @on_error_block.call(status, reason, code)
+        unless @drop_response
+          @request.reply status, reason
         else
-          @on_error_block && @on_error_block.call(status, reason)
-          unless @drop_response
-            @request.reply status, reason
-          else
-            @drop_response = false
-          end
-
+          @drop_response = false
         end
+
       end
-    end  # try_next_target
+    end  # no_more_targets
 
 
-    def use_target target
-      # Call the on_target() callback if set by the user.
-      @on_target_block && @on_target_block.call(target.ip_type, target.ip, target.port, target.transport)
+    def do_dns_fail status, reason, code
+      @on_error_block && @on_error_block.call(status, reason, code)
 
-      # If the user has called to proxy.abort_routing() then stop next targets
-      # and call to on_error() callback.
-      if @aborted
-        log_system_notice "routing aborted for target #{target}"
-        @aborted = @target = @targets = nil
-        try_next_target 403, "Destination Not Allowed"
-        return
+      unless @drop_response
+        @request.reply status, reason  unless @request.sip_method == :ACK
+      else
+        @drop_response = false
       end
-
-      @client_transaction = (::OverSIP::SIP::ClientTransaction.get_class @request).new self, @request, @proxy_conf, target.transport, target.ip, target.ip_type, target.port
-      add_routing_headers
-      @client_transaction.send_request
     end
 
 
-    def rfc3263_failed error
-      case error
-        when :rfc3263_domain_not_found
-          log_system_debug "no resolution"  if $oversip_debug
-          status = 404
-          reason = "No DNS Resolution"
-        when :rfc3263_unsupported_scheme
-          log_system_debug "unsupported URI scheme"  if $oversip_debug
-          status = 416
-          reason = "Unsupported URI scheme"
-        when :rfc3263_unsupported_transport
-          log_system_debug "unsupported transport"  if $oversip_debug
-          status = 478
-          reason = "Unsupported Transport"
-        when :rfc3263_wrong_transport
-          log_system_debug "wrong URI transport"  if $oversip_debug
-          status = 478
-          reason = "Wrong URI Transport"
-        when :rfc3263_no_ipv4
-          log_system_debug "destination requires unsupported IPv4"  if $oversip_debug
-          status = 478
-          reason = "Destination Requires Unsupported IPv4"
-        when :rfc3263_no_ipv6
-          log_system_debug "destination requires unsupported IPv6"  if $oversip_debug
-          status = 478
-          reason = "Destination Requires Unsupported IPv6"
-        when :rfc3263_no_dns
-          log_system_debug "destination requires unsupported DNS query"  if $oversip_debug
-          status = 478
-          reason = "Destination Requires Unsupported DNS Query"
-        end
-
-        @on_error_block && @on_error_block.call(status, reason)
-        unless @drop_response
-          @request.reply status, reason  unless @request.sip_method == :ACK
-        else
-          @drop_response = false
-        end
-    end  # def rfc3263_failed
-
   end  # class Proxy
 
 end

data/lib/oversip/sip/request.rb

@@ -38,36 +38,40 @@ module OverSIP::SIP
 
 
     def reply status_code, reason_phrase=nil, extra_headers=[], body=nil
+      if @sip_method == :ACK
+        log_system_error "attemtp to reply to an ACK aborted"
+        return false
+      end
       return false  unless @server_transaction.receive_response(status_code)  if @server_transaction
 
       reason_phrase ||= REASON_PHARSE[status_code] || REASON_PHARSE_NOT_SET
 
       if status_code > 100
-        @internal_to_tag ||= @to_tag || ( @server_transaction ? SecureRandom.hex(6) : OverSIP::SIP::Tags.totag_for_sl_reply )
+        @internal_to_tag ||= @to_tag || ( @server_transaction ? ::SecureRandom.hex(6) : ::OverSIP::SIP::Tags.totag_for_sl_reply )
       end
 
       response = "SIP/2.0 #{status_code} #{reason_phrase}\r\n"
 
       @hdr_via.each do |hdr|
-        response << "Via: " << hdr << "\r\n"
+        response << "Via: " << hdr << CRLF
       end
 
-      response << "From: " << @hdr_from << "\r\n"
+      response << "From: " << @hdr_from << CRLF
 
       response << "To: " << @hdr_to
       response << ";tag=#{@internal_to_tag}"  if @internal_to_tag
-      response << "\r\n"
+      response << CRLF
 
-      response << "Call-ID: " << @call_id << "\r\n"
-      response << "CSeq: " << @cseq.to_s << " " << @sip_method.to_s << "\r\n"
+      response << "Call-ID: " << @call_id << CRLF
+      response << "CSeq: " << @cseq.to_s << " " << @sip_method.to_s << CRLF
       response << "Content-Length: #{body ? body.bytesize : "0"}\r\n"
 
       extra_headers.each do |header|
-        response << header.to_s << "\r\n"
+        response << header.to_s << CRLF
       end  if extra_headers
 
-      response << HDR_SERVER << "\r\n"
-      response << "\r\n"
+      response << HDR_SERVER << CRLF
+      response << CRLF
 
       response << body  if body
 
@@ -129,9 +133,9 @@ module OverSIP::SIP
         @headers["Contact"] = [ @contact.to_s << (@contact_params ? @contact_params : "") ]
       end
 
-      @headers.each do |key, values|
+      @headers.each do |name, values|
         values.each do |value|
-          msg << key << ": #{value}\r\n"
+          msg << name << ": #{value}\r\n"
         end
       end
 

data/lib/oversip/sip/response.rb

@@ -18,12 +18,12 @@ module OverSIP::SIP
       @headers["From"] = [ request.hdr_from ]  if request.from_was_modified
       if request.to_was_modified
         hdr_to = @to_tag ? "#{request.hdr_to};tag=#{@to_tag}" : request.hdr_to
-        @headers["To"] = [ hdr_to ]  if request.to_was_modified
+        @headers["To"] = [ hdr_to ]
       end
 
-      @headers.each do |key, values|
+      @headers.each do |name, values|
         values.each do |value|
-          msg << key << ": #{value}\r\n"
+          msg << name << ": #{value}\r\n"
         end
       end
 

data/lib/oversip/sip/rfc3263.rb

@@ -216,7 +216,7 @@ module OverSIP::SIP
               dns_transport = :udp
             # "sips" is not possible in UDP.
             else
-              return :rfc3263_wrong_transport
+              return :rfc3263_unsupported_transport
             end
           when :tcp
             case (dns_transport = ( @uri_scheme == :sips ? :tls : :tcp ))
@@ -271,7 +271,6 @@ module OverSIP::SIP
           elsif @uri_transport
             if @use_srv
               if (targets = resolve_SRV(@uri_host, @uri_scheme, dns_transport))
-                ### TODO: Esto es nuevo para mejora. Antes devolvía siempre el segundo caso.
                 if targets.size == 1
                   @on_success_block && @on_success_block.call(targets[0])
                 else
@@ -415,7 +414,7 @@ module OverSIP::SIP
 
           end
 
-        end
+        end  # @@fiber_pool.spawn
 
         nil
       end

data/lib/oversip/sip/tags.rb

@@ -31,7 +31,7 @@ module OverSIP::SIP
 
     def self.create_antiloop_id request
       # It produces a 32 chars string.
-      ::Digest::MD5.hexdigest "#{ANTILOOP_CONST}#{request.ruri.uri}#{request.call_id}#{request.routes[0].uri if request.routes}"
+      ::Digest::MD5.hexdigest "#{ANTILOOP_CONST}#{request.ruri.to_s}#{request.call_id}#{request.routes[0].uri if request.routes}"
     end
 
   end

data/lib/oversip/sip/transport_manager.rb

@@ -9,7 +9,7 @@ module OverSIP::SIP
 
 
     # Get an existing connection or create a new one (TCP/TLS).
-    # For UDP it always return the single UDP reactor instance.
+    # For UDP it always returns the single UDP reactor instance.
     # client_transaction is passed when creating a new clien transaction. In case the
     # outgoing connection is a TCP/TLS client connection and it's not connected yet,
     # the client transaction is stored in the @pending_client_transactions of the client
@@ -62,9 +62,10 @@ module OverSIP::SIP
 
       # NOTE: Should never happen.
       unless conn
-        log_system_error "no connection (nil) retrieved from TransportManager.get_connection(), FIXME, it should never occur!!!"
-        raise "no connection (nil) retrieved from TransportManager.get_connection(), FIXME, it should never occur!!!"
+        ::OverSIP::Launcher.fatal "no connection retrieved from TransportManager.get_connection(), FIXME, it should never occur!!!"
       end
+
+      # Return the created/retrieved connection instance.
       conn
     end
 
@@ -92,7 +93,7 @@ module OverSIP::SIP
       if flow_token.getbyte(0) == 95
         # NOTE: Doing Base64.decode64 automatically removes the leading "_".
         # NOTE: Previously when the Outbound flow token was generated, "=" was replaced with "-" so it becomes
-        # valid for a SIP URI param (in case of using Contact mangling if the registrar does not support Path).
+        # valid for a SIP URI param (needed i.e. for the OutboundMangling module).
         ip_type, ip, port = ::OverSIP::Utils.parse_outbound_udp_flow_token(::Base64.decode64 flow_token.gsub(/-/,"="))
 
         case ip_type
@@ -105,7 +106,7 @@ module OverSIP::SIP
             return false
           end
 
-      # It not, the flow token has been generated for a TCP/TLS/WS/WSS connection so let's lookup
+      # If not, the flow token has been generated for a TCP/TLS/WS/WSS connection so let's lookup
       # it into the Outbound connection collection and return nil for IP and port.
       else
         @outbound_connections[flow_token]

data/lib/oversip/sip/uac.rb

@@ -0,0 +1,93 @@
+module OverSIP::SIP
+
+  class Uac < Client
+
+
+    def route request, dst_host=nil, dst_port=nil, dst_transport=nil
+      unless (@request = request).is_a? ::OverSIP::SIP::UacRequest or @request.is_a? ::OverSIP::SIP::Request
+        raise ::OverSIP::RuntimeError, "request must be a OverSIP::SIP::UacRequest or OverSIP::SIP::Request instance"
+      end
+
+      # The destination of the request is taken from:
+      # - dst_xxx fields if given.
+      # - The request.ruri if it is an OverSIP::SIP::Uri or OverSIP::SIP::NameAddr.
+      # Otherwise raise an exception.
+      unless dst_host or request.ruri.is_a?(::OverSIP::SIP::Uri) or request.ruri.is_a?(::OverSIP::SIP::NameAddr)
+        raise ::OverSIP::RuntimeError, "if dst_host is not given then request.ruri must be an OverSIP::SIP::Uri or OverSIP::SIP::NameAddr instance"
+      end
+
+      @log_id = "UAC (proxy #{@conf[:name]})"
+
+      # Force the destination.
+      if dst_host
+        dst_scheme = :sip
+        dst_host_type = ::OverSIP::Utils.ip_type(dst_host) || :domain
+
+      # Or use the Request URI.
+      else
+        dst_scheme = request.ruri.scheme
+        dst_host = request.ruri.host
+        dst_host_type = request.ruri.host_type
+        dst_port = request.ruri.port
+        dst_transport = request.ruri.transport_param
+      end
+
+      # If the destination uri_host is an IPv6 reference, convert it to real IPv6.
+      if dst_host_type == :ipv6_reference
+        dst_host = ::OverSIP::Utils.normalize_ipv6(dst_host, true)
+        dst_host_type = :ipv6
+      end
+
+      # Loockup in the DNS cache of this proxy.
+      result = check_dns_cache dst_scheme, dst_host, dst_host_type, dst_port, dst_transport
+
+      case result
+      when true
+        return
+      else  # It can be String or nil, so use it as dns_cache_key param.
+        # Perform RFC 3263 procedures.
+        do_dns result, @request.via_branch_id, dst_scheme, dst_host, dst_host_type, dst_port, dst_transport
+      end
+
+    end  # def send
+
+
+    def receive_response response
+      log_system_debug "received response #{response.status_code}"  if $oversip_debug
+
+      if response.status_code < 200
+        @on_provisional_response_block && @on_provisional_response_block.call(response)
+      elsif response.status_code >= 200 && response.status_code <= 299
+        @on_success_response_block && @on_success_response_block.call(response)
+      elsif response.status_code >= 300
+        if response.status_code == 503
+          if @conf[:dns_failover_on_503]
+            try_next_target nil, nil, response
+            return
+          else
+            @on_failure_response_block && @on_failure_response_block.call(response)
+          end
+        else
+          @on_failure_response_block && @on_failure_response_block.call(response)
+        end
+      end
+    end
+
+
+
+    private
+
+
+    def no_more_targets status, reason, full_response, code
+      # If we have received a [3456]XX response from downstream then run @on_failure_block.
+      if full_response
+        @on_failure_response_block && @on_failure_response_block.call(full_response)
+      # If not, generate the response according to the given status and reason.
+      else
+        @on_error_block && @on_error_block.call(status, reason, code)
+      end
+    end
+
+  end  # class Uac
+
+end