oversip 0.9.0

data/lib/oversip/sip/grammar/uri.rb

@@ -0,0 +1,116 @@
+module OverSIP::SIP
+
+  class Uri
+    attr_reader :scheme, :user, :host, :host_type, :port, :params, :transport_param, :ovid_param, :phone_context_param, :headers
+    attr_accessor :uri_modified
+
+    def scheme= value
+      return nil  if unknown_scheme?
+      @scheme = value
+      @uri_modified = true
+    end
+
+    def unknown_scheme?
+      not @scheme.is_a? Symbol
+    end
+
+    def user= value
+      return nil  if unknown_scheme?
+      @user = value
+      @uri_modified = true
+    end
+    alias :number :user
+    alias :number= :user=
+
+    def host= value
+      return nil  if unknown_scheme?
+      @host = value
+      @host_type = ::OverSIP::Utils.ip_type(value) || :domain
+      @uri_modified = true
+    end
+    alias :domain :host
+    alias :domain= :host=
+
+    def host_type= value
+      return nil  if unknown_scheme?
+      @host_type = value
+    end
+
+    def port= value
+      return nil  if unknown_scheme?
+      @port = value
+      @uri_modified = true
+    end
+
+    def params
+      @params ||= {}
+    end
+
+    def set_param k, v
+      return nil  if unknown_scheme?
+      @params ||= {}
+      @params[k.downcase] = v
+      @uri_modified = true
+    end
+
+    def del_param k
+      return nil  if unknown_scheme?
+      return false  unless @params
+      if @params.include?(k=k.downcase)
+        @uri_modified = true
+        return @params.delete(k)
+      end
+      false
+    end
+
+    def lr_param?
+      @lr_param ? true : false
+    end
+
+    def ob_param?
+      @ob_param ? true : false
+    end
+
+    def headers= value
+      return nil  if unknown_scheme?
+      @headers = value
+      @uri_modified = true
+    end
+
+    def uri
+      return @uri  unless @uri_modified
+
+      case @scheme
+        when :sip, :sips
+          @uri = @scheme.to_s << ":"
+          ( @uri << ::EscapeUtils.escape_uri(@user) << "@" )  if @user
+          @uri << @host
+          ( @uri << ":" << @port.to_s )  if @port
+
+          @params.each do |k,v|
+            @uri << ";" << k
+            ( @uri << "=" << v.to_s )  if v
+          end  if @params
+
+          @uri << @headers  if @headers
+
+        when :tel
+          @uri = "tel:"
+          @uri << @user
+
+          @params.each do |k,v|
+            @uri << ";" << k
+            ( @uri << "=" << v.to_s )  if v
+          end  if @params
+
+        end
+
+      @uri_modified = false
+      @uri
+    end
+    alias :to_s :uri
+    alias :inspect :uri
+
+  end  # class Uri
+
+end

data/lib/oversip/sip/launcher.rb

@@ -0,0 +1,180 @@
+module OverSIP::SIP
+
+  module Launcher
+
+    extend ::OverSIP::Logger
+
+    IP_TYPE = {
+      :ipv4 => "IPv4",
+      :ipv6 => "IPv6"
+    }
+
+
+    def self.log_id
+      @log_id ||= "SIP launcher"
+    end
+
+
+    def self.run enabled, ip_type, ip, port, transport, virtual_ip=nil, virtual_port=nil
+      uri_ip = case ip_type
+        when :ipv4 ; ip
+        when :ipv6 ; "[#{ip}]"
+        end
+
+      if virtual_ip
+        uri_virtual_ip = case ip_type
+          when :ipv4 ; virtual_ip
+          when :ipv6 ; "[#{virtual_ip}]"
+          end
+      end
+
+      klass = case transport
+        when :udp
+          case ip_type
+            when :ipv4 ; OverSIP::SIP::IPv4UdpServer
+            when :ipv6 ; OverSIP::SIP::IPv6UdpServer
+            end
+        when :tcp
+          case ip_type
+            when :ipv4 ; OverSIP::SIP::IPv4TcpServer
+            when :ipv6 ; OverSIP::SIP::IPv6TcpServer
+            end
+        when :tls
+          case ip_type
+            when :ipv4 ; OverSIP::SIP::IPv4TlsServer
+            when :ipv6 ; OverSIP::SIP::IPv6TlsServer
+            end
+        when :tls_tunnel
+          case ip_type
+            when :ipv4 ; OverSIP::SIP::IPv4TlsTunnelServer
+            when :ipv6 ; OverSIP::SIP::IPv6TlsTunnelServer
+            end
+        end
+
+      klass.ip = virtual_ip || ip
+      klass.port = virtual_port || port
+
+      case
+
+        when klass == OverSIP::SIP::IPv4UdpServer
+          klass.via_core = "SIP/2.0/UDP #{uri_ip}:#{port}"
+          klass.record_route = "<sip:#{uri_ip}:#{port};transport=udp;lr;ovid=#{OverSIP::SIP::Tags.value_for_route_ovid}>"
+          klass.outbound_record_route_fragment = "@#{uri_ip}:#{port};transport=udp;lr;ovid=#{OverSIP::SIP::Tags.value_for_route_ovid}>"
+          klass.outbound_path_fragment = "@#{uri_ip}:#{port};transport=udp;lr;ovid=#{OverSIP::SIP::Tags.value_for_route_ovid};ob>"
+
+          if enabled
+            EM::open_datagram_socket(ip, port, klass) do |conn|
+              klass.connections = conn
+            end
+          end
+
+        when klass == OverSIP::SIP::IPv6UdpServer
+          klass.via_core = "SIP/2.0/UDP #{uri_ip}:#{port}"
+          klass.record_route = "<sip:#{uri_ip}:#{port};transport=udp;lr;ovid=#{OverSIP::SIP::Tags.value_for_route_ovid}>"
+          klass.outbound_record_route_fragment = "@#{uri_ip}:#{port};transport=udp;lr;ovid=#{OverSIP::SIP::Tags.value_for_route_ovid}>"
+          klass.outbound_path_fragment = "@#{uri_ip}:#{port};transport=udp;lr;ovid=#{OverSIP::SIP::Tags.value_for_route_ovid};ob>"
+
+          if enabled
+            EM::open_datagram_socket(ip, port, klass) do |conn|
+              klass.connections = conn
+            end
+          end
+
+        when klass == OverSIP::SIP::IPv4TcpServer
+          klass.via_core = "SIP/2.0/TCP #{uri_ip}:#{port}"
+          klass.record_route = "<sip:#{uri_ip}:#{port};transport=tcp;lr;ovid=#{OverSIP::SIP::Tags.value_for_route_ovid}>"
+          klass.outbound_record_route_fragment = "@#{uri_ip}:#{port};transport=tcp;lr;ovid=#{OverSIP::SIP::Tags.value_for_route_ovid}>"
+          klass.outbound_path_fragment = "@#{uri_ip}:#{port};transport=tcp;lr;ovid=#{OverSIP::SIP::Tags.value_for_route_ovid};ob>"
+
+          if enabled
+            EM.start_server(ip, port, klass) do |conn|
+              conn.post_connection
+              conn.set_comm_inactivity_timeout 3600  # TODO
+            end
+          end
+
+        when klass == OverSIP::SIP::IPv6TcpServer
+          klass.via_core = "SIP/2.0/TCP #{uri_ip}:#{port}"
+          klass.record_route = "<sip:#{uri_ip}:#{port};transport=tcp;lr;ovid=#{OverSIP::SIP::Tags.value_for_route_ovid}>"
+          klass.outbound_record_route_fragment = "@#{uri_ip}:#{port};transport=tcp;lr;ovid=#{OverSIP::SIP::Tags.value_for_route_ovid}>"
+          klass.outbound_path_fragment = "@#{uri_ip}:#{port};transport=tcp;lr;ovid=#{OverSIP::SIP::Tags.value_for_route_ovid};ob>"
+
+          if enabled
+            EM.start_server(ip, port, klass) do |conn|
+              conn.post_connection
+              conn.set_comm_inactivity_timeout 3600 # TODO
+            end
+          end
+
+        when klass == OverSIP::SIP::IPv4TlsServer
+          klass.via_core = "SIP/2.0/TLS #{uri_ip}:#{port}"
+          rr_host = ::OverSIP.configuration[:sip][:record_route_hostname_tls_ipv4] || uri_ip
+          klass.record_route = "<sip:#{rr_host}:#{port};transport=tls;lr;ovid=#{OverSIP::SIP::Tags.value_for_route_ovid}>"
+          klass.outbound_record_route_fragment = "@#{rr_host}:#{port};transport=tls;lr;ovid=#{OverSIP::SIP::Tags.value_for_route_ovid}>"
+          klass.outbound_path_fragment = "@#{rr_host}:#{port};transport=tls;lr;ovid=#{OverSIP::SIP::Tags.value_for_route_ovid};ob>"
+
+          if enabled
+            EM.start_server(ip, port, klass) do |conn|
+              conn.post_connection
+              conn.set_comm_inactivity_timeout 3600  # TODO
+            end
+          end
+
+        when klass == OverSIP::SIP::IPv6TlsServer
+          klass.via_core = "SIP/2.0/TLS #{uri_ip}:#{port}"
+          rr_host = ::OverSIP.configuration[:sip][:record_route_hostname_tls_ipv6] || uri_ip
+          klass.record_route = "<sip:#{rr_host}:#{port};transport=tls;lr;ovid=#{OverSIP::SIP::Tags.value_for_route_ovid}>"
+          klass.outbound_record_route_fragment = "@#{rr_host}:#{port};transport=tls;lr;ovid=#{OverSIP::SIP::Tags.value_for_route_ovid}>"
+          klass.outbound_path_fragment = "@#{rr_host}:#{port};transport=tls;lr;ovid=#{OverSIP::SIP::Tags.value_for_route_ovid};ob>"
+
+          if enabled
+            EM.start_server(ip, port, klass) do |conn|
+              conn.post_connection
+              conn.set_comm_inactivity_timeout 3600  # TODO
+            end
+          end
+
+        when klass == OverSIP::SIP::IPv4TlsTunnelServer
+          klass.via_core = "SIP/2.0/TLS #{uri_virtual_ip}:#{virtual_port}"
+          rr_host = ::OverSIP.configuration[:sip][:record_route_hostname_tls_ipv4] || uri_virtual_ip
+          klass.record_route = "<sip:#{rr_host}:#{virtual_port};transport=tls;lr;ovid=#{OverSIP::SIP::Tags.value_for_route_ovid}>"
+          klass.outbound_record_route_fragment = "@#{rr_host}:#{virtual_port};transport=tls;lr;ovid=#{OverSIP::SIP::Tags.value_for_route_ovid}>"
+          klass.outbound_path_fragment = "@#{rr_host}:#{virtual_port};transport=tls;lr;ovid=#{OverSIP::SIP::Tags.value_for_route_ovid};ob>"
+
+          if enabled
+            EM.start_server(ip, port, klass) do |conn|
+              conn.post_connection
+              conn.set_comm_inactivity_timeout 3600  # TODO
+            end
+          end
+
+        when klass == OverSIP::SIP::IPv6TlsTunnelServer
+          klass.via_core = "SIP/2.0/TLS #{uri_virtual_ip}:#{virtual_port}"
+          rr_host = ::OverSIP.configuration[:sip][:record_route_hostname_tls_ipv6] || uri_virtual_ip
+          klass.record_route = "<sip:#{rr_host}:#{virtual_port};transport=tls;lr;ovid=#{OverSIP::SIP::Tags.value_for_route_ovid}>"
+          klass.outbound_record_route_fragment = "@#{rr_host}:#{virtual_port};transport=tls;lr;ovid=#{OverSIP::SIP::Tags.value_for_route_ovid}>"
+          klass.outbound_path_fragment = "@#{rr_host}:#{virtual_port};transport=tls;lr;ovid=#{OverSIP::SIP::Tags.value_for_route_ovid};ob>"
+
+          if enabled
+            EM.start_server(ip, port, klass) do |conn|
+              conn.post_connection
+              conn.set_comm_inactivity_timeout 3600  # TODO
+            end
+          end
+
+        end  # case
+
+      transport_str = case transport
+        when :tls_tunnel ; "TLS-Tunnel"
+        else             ; transport.to_s.upcase
+        end
+
+      if enabled
+        log_system_info "SIP #{transport_str} server listening on #{IP_TYPE[ip_type]} #{uri_ip}:#{port}"
+      end
+
+    end  # def self.run
+
+  end
+
+end

data/lib/oversip/sip/listeners/ipv4_tcp_client.rb

@@ -0,0 +1,21 @@
+module OverSIP::SIP
+
+  class IPv4TcpClient < TcpClient
+
+    @ip_type = :ipv4
+    @transport = :tcp
+    @server_class = ::OverSIP::SIP::IPv4TcpServer
+    @connections = @server_class.connections
+    @invite_server_transactions = @server_class.invite_server_transactions
+    @non_invite_server_transactions = @server_class.non_invite_server_transactions
+    @invite_client_transactions = @server_class.invite_client_transactions
+    @non_invite_client_transactions = @server_class.non_invite_client_transactions
+
+    LOG_ID = "SIP TCP IPv4 client"
+    def log_id
+      LOG_ID
+    end
+
+  end
+
+end

data/lib/oversip/sip/listeners/ipv4_tcp_server.rb

@@ -0,0 +1,21 @@
+module OverSIP::SIP
+
+  class IPv4TcpServer < TcpServer
+
+    @ip_type = :ipv4
+    @transport = :tcp
+    @connections = {}
+    @invite_server_transactions = {}
+    @non_invite_server_transactions = {}
+    @invite_client_transactions = {}
+    @non_invite_client_transactions = {}
+    @is_reliable_transport_listener = true
+
+    LOG_ID = "SIP TCP IPv4 server"
+    def log_id
+      LOG_ID
+    end
+
+  end
+
+end

data/lib/oversip/sip/listeners/ipv4_tls_client.rb

@@ -0,0 +1,21 @@
+module OverSIP::SIP
+
+  class IPv4TlsClient < TlsClient
+
+    @ip_type = :ipv4
+    @transport = :tls
+    @server_class = ::OverSIP::SIP::IPv4TlsServer
+    @connections = @server_class.connections
+    @invite_server_transactions = @server_class.invite_server_transactions
+    @non_invite_server_transactions = @server_class.non_invite_server_transactions
+    @invite_client_transactions = @server_class.invite_client_transactions
+    @non_invite_client_transactions = @server_class.non_invite_client_transactions
+
+    LOG_ID = "SIP TLS IPv4 client"
+    def log_id
+      LOG_ID
+    end
+
+  end
+
+end

data/lib/oversip/sip/listeners/ipv4_tls_server.rb

@@ -0,0 +1,21 @@
+module OverSIP::SIP
+
+  class IPv4TlsServer < TlsServer
+
+    @ip_type = :ipv4
+    @transport = :tls
+    @connections = {}
+    @invite_server_transactions = {}
+    @non_invite_server_transactions = {}
+    @invite_client_transactions = {}
+    @non_invite_client_transactions = {}
+    @is_reliable_transport_listener = true
+
+    LOG_ID = "SIP TLS IPv4 server"
+    def log_id
+      LOG_ID
+    end
+
+  end
+
+end

data/lib/oversip/sip/listeners/ipv4_tls_tunnel_server.rb

@@ -0,0 +1,21 @@
+module OverSIP::SIP
+
+  class IPv4TlsTunnelServer < TlsTunnelServer
+
+    @ip_type = :ipv4
+    @transport = :tls
+    @connections = {}
+    @invite_server_transactions = {}
+    @non_invite_server_transactions = {}
+    @invite_client_transactions = {}
+    @non_invite_client_transactions = {}
+    @is_reliable_transport_listener = true
+
+    LOG_ID = "SIP TLS-Tunnel IPv4 server"
+    def log_id
+      LOG_ID
+    end
+
+  end
+
+end

data/lib/oversip/sip/listeners/ipv4_udp_server.rb

@@ -0,0 +1,20 @@
+module OverSIP::SIP
+
+  class IPv4UdpServer < UdpReactor
+
+    @ip_type = :ipv4
+    @transport = :udp
+    @connections = nil  # To be set after creating the unique server instance.
+    @invite_server_transactions = {}
+    @non_invite_server_transactions = {}
+    @invite_client_transactions = {}
+    @non_invite_client_transactions = {}
+
+    LOG_ID = "SIP UDP IPv4 server"
+    def log_id
+      LOG_ID
+    end
+
+  end
+
+end

data/lib/oversip/sip/listeners/ipv6_tcp_client.rb

@@ -0,0 +1,21 @@
+module OverSIP::SIP
+
+  class IPv6TcpClient < TcpClient
+
+    @ip_type = :ipv6
+    @transport = :tcp
+    @server_class = ::OverSIP::SIP::IPv6TcpServer
+    @connections = @server_class.connections
+    @invite_server_transactions = @server_class.invite_server_transactions
+    @non_invite_server_transactions = @server_class.non_invite_server_transactions
+    @invite_client_transactions = @server_class.invite_client_transactions
+    @non_invite_client_transactions = @server_class.non_invite_client_transactions
+
+    LOG_ID = "SIP TCP IPv6 client"
+    def log_id
+      LOG_ID
+    end
+
+  end
+
+end

data/lib/oversip/sip/listeners/ipv6_tcp_server.rb

@@ -0,0 +1,21 @@
+module OverSIP::SIP
+
+  class IPv6TcpServer < TcpServer
+
+    @ip_type = :ipv6
+    @transport = :tcp
+    @connections = {}
+    @invite_server_transactions = {}
+    @non_invite_server_transactions = {}
+    @invite_client_transactions = {}
+    @non_invite_client_transactions = {}
+    @is_reliable_transport_listener = true
+
+    LOG_ID = "SIP TCP IPv6 server"
+    def log_id
+      LOG_ID
+    end
+
+  end
+
+end

data/lib/oversip/sip/listeners/ipv6_tls_client.rb

@@ -0,0 +1,21 @@
+module OverSIP::SIP
+
+  class IPv6TlsClient < TlsClient
+
+    @ip_type = :ipv6
+    @transport = :tls
+    @server_class = ::OverSIP::SIP::IPv6TlsServer
+    @connections = @server_class.connections
+    @invite_server_transactions = @server_class.invite_server_transactions
+    @non_invite_server_transactions = @server_class.non_invite_server_transactions
+    @invite_client_transactions = @server_class.invite_client_transactions
+    @non_invite_client_transactions = @server_class.non_invite_client_transactions
+
+    LOG_ID = "SIP TLS IPv6 client"
+    def log_id
+      LOG_ID
+    end
+
+  end
+
+end

data/lib/oversip/sip/listeners/ipv6_tls_server.rb

@@ -0,0 +1,21 @@
+module OverSIP::SIP
+
+  class IPv6TlsServer < TlsServer
+
+    @ip_type = :ipv6
+    @transport = :tls
+    @connections = {}
+    @invite_server_transactions = {}
+    @non_invite_server_transactions = {}
+    @invite_client_transactions = {}
+    @non_invite_client_transactions = {}
+    @is_reliable_transport_listener = true
+
+    LOG_ID = "SIP TLS IPv6 server"
+    def log_id
+      LOG_ID
+    end
+
+  end
+
+end

data/lib/oversip/sip/listeners/ipv6_tls_tunnel_server.rb

@@ -0,0 +1,21 @@
+module OverSIP::SIP
+
+  class IPv6TlsTunnelServer < TlsTunnelServer
+
+    @ip_type = :ipv6
+    @transport = :tls
+    @connections = {}
+    @invite_server_transactions = {}
+    @non_invite_server_transactions = {}
+    @invite_client_transactions = {}
+    @non_invite_client_transactions = {}
+    @is_reliable_transport_listener = true
+
+    LOG_ID = "SIP TLS-Tunnel IPv6 server"
+    def log_id
+      LOG_ID
+    end
+
+  end
+
+end

data/lib/oversip/sip/listeners/ipv6_udp_server.rb

@@ -0,0 +1,20 @@
+module OverSIP::SIP
+
+  class IPv6UdpServer < UdpReactor
+
+    @ip_type = :ipv6
+    @transport = :udp
+    @connections = nil  # To be set after creating the unique server instance.
+    @invite_server_transactions = {}
+    @non_invite_server_transactions = {}
+    @invite_client_transactions = {}
+    @non_invite_client_transactions = {}
+
+    LOG_ID = "SIP UDP IPv6 server"
+    def log_id
+      LOG_ID
+    end
+
+  end
+
+end

data/lib/oversip/sip/listeners/reactor.rb

@@ -0,0 +1,39 @@
+module OverSIP::SIP
+
+  class Reactor < ::EM::Connection
+
+    include ::OverSIP::Logger
+    include ::OverSIP::SIP::MessageProcessor
+
+    class << self
+      attr_accessor :ip_type, :ip, :port, :transport,
+                    :via_core,
+                    :record_route,
+                    :outbound_record_route_fragment, :outbound_path_fragment,
+                    :connections,
+                    :invite_server_transactions, :non_invite_server_transactions,
+                    :invite_client_transactions, :non_invite_client_transactions
+
+      def reliable_transport_listener?
+        @is_reliable_transport_listener
+      end
+    end
+
+    def initialize
+      @parser = ::OverSIP::SIP::MessageParser.new
+      @buffer = ::IO::Buffer.new
+      @state = :init
+
+      # Set the socket sending error handling to report the error:
+      # :ERRORHANDLING_KILL, :ERRORHANDLING_IGNORE, :ERRORHANDLING_REPORT
+      self.send_error_handling = :ERRORHANDLING_REPORT
+    end
+
+    def receive_senderror error, data
+      log_system_error "Socket sending error: #{error.inspect}, #{data.inspect}"
+    end
+
+  end  # class Reactor
+
+end
+

data/lib/oversip/sip/listeners/tcp_client.rb

@@ -0,0 +1,73 @@
+module OverSIP::SIP
+
+  class TcpClient < TcpReactor
+
+    attr_accessor :server_class  ## TODO: sirve??
+    attr_reader :connected
+    attr_reader :pending_client_transactions
+
+    def initialize ip, port
+      # NOTE: The parent class implementing "initialize" method is Reactor, and allows no arguments.
+      # If we call just "super" from here it will fail since "ip" and "port" will be passed as
+      # arguments. So we must use "super()" and we are done (no arguments are passed to parent).
+      super()
+
+      @remote_ip = ip
+      @remote_port = port
+      @connection_id = ::OverSIP::SIP::TransportManager.add_connection self, self.class, self.class.ip_type, @remote_ip, @remote_port
+      @connected = false
+      @pending_client_transactions = []
+
+      ### TODO: make it configurable.
+      set_pending_connect_timeout 2.0
+
+    end
+
+
+    def connection_completed
+      log_system_info "TCP connection opened to " << remote_desc
+
+      @connected = true
+      @pending_client_transactions.clear
+    end
+
+
+    def remote_desc
+      @remote_desc ||= case self.class.ip_type
+        when :ipv4  ; "#{@remote_ip}:#{@remote_port.to_s}"
+        when :ipv6  ; "[#{@remote_ip}]:#{@remote_port.to_s}"
+        end
+    end
+
+
+    def unbind cause=nil
+      @state = :ignore
+
+      # Remove the connection.
+      self.class.connections.delete @connection_id
+
+      @local_closed = true  if cause == ::Errno::ETIMEDOUT
+
+      if @connected
+        log_msg = "connection to #{remote_desc} "
+        log_msg << ( @local_closed ? "locally closed" : "remotely closed" )
+        log_msg << " (cause: #{cause.inspect})"  if cause
+        log_system_debug log_msg  if $oversip_debug
+
+      # If the TCP client connection has failed (remote server rejected the connection) then
+      # inform to all the pending client transactions.
+      else
+        log_system_notice "connection to #{remote_desc} failed"  if $oversip_debug
+
+        @pending_client_transactions.each do |client_transaction|
+          client_transaction.connection_failed
+        end
+        @pending_client_transactions.clear
+      end
+
+      @connected = false
+    end
+
+  end
+
+end