Module: OverSIP::SIP::Core

Included in:
Request
Defined in:
lib/oversip/sip/core.rb

Overview

This module is included by OverSIP::SIP::Request class.

Instance Method Summary collapse

Instance Method Details

#check_max_forwards(max_forwards) ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/oversip/sip/core.rb', line 25

def check_max_forwards max_forwards
  if @max_forwards
    unless @max_forwards.zero?
      @new_max_forwards = ( @max_forwards > max_forwards ? max_forwards : @max_forwards - 1 )
      return true
    else
      log_system_notice "Max-Forwards is 0 => 483"
      reply 483
      return false
    end
  else
    @new_max_forwards = max_forwards
    return true
  end
end

#connection_outbound_flow_token ⇒ Object 



192
193
194
195
196
197
198
199
200
201
 
# File 'lib/oversip/sip/core.rb', line 192

def connection_outbound_flow_token
  @connection_outbound_flow_token ||= if @transport == :udp
    # NOTE: Add "_" so later we can figure that this is for UDP.
    # NOTE: Replace "=" with "-" so it can be added as a SIP URI param (needed i.e.
    # for the OutboundMangling module).
    "_" << ::Base64.strict_encode64("#{@source_ip}_#{@source_port}").gsub(/=/,"-")
  else
    @connection.outbound_flow_token
  end
end

#create_transaction ⇒ Object

Create a server transaction for the incoming request.



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/oversip/sip/core.rb', line 7

def create_transaction
  return false  if @server_transaction

  case @sip_method
  when :INVITE
    ::OverSIP::SIP::InviteServerTransaction.new self
    return true
  when :ACK
    return nil
  when :CANCEL
    return nil
  else
    ::OverSIP::SIP::NonInviteServerTransaction.new self
    return true
  end
end

#destination_myself? ⇒ Boolean

Checks whether the RURI points to a local domain or address. Typically, prior to using this method the user has verified the return value of loose_route() in case it’s an initial request (if it’s true then the request has pre-loaded Route).

Returns:

  • (Boolean) 


140
141
142
143
144
145
146
147
148
149
 
# File 'lib/oversip/sip/core.rb', line 140

def destination_myself?
  return true if @destination_myself
  return false if @destination_myself == false

  if local_uri? @ruri
    return @destination_myself = true
  else
    return @destination_myself = false
  end
end

#fix_nat ⇒ Object 



152
153
154
155
156
157
158
159
160
 
# File 'lib/oversip/sip/core.rb', line 152

def fix_nat
  # Force rport usage for UDP clients.
  @via_rport = @source_port

  # Force outgoing Outbound.
  if initial? and @num_vias == 1 and outbound_aware?
    @force_outgoing_outbound = true
  end
end

#incoming_outbound_requested? ⇒ Boolean

Returns:

  • (Boolean) 


189
 
# File 'lib/oversip/sip/core.rb', line 189

def incoming_outbound_requested?       ; @incoming_outbound_requested  end

#loose_route ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/oversip/sip/core.rb', line 42

def loose_route
  num_removes = 0
  has_preloaded_route_with_ob_param = false

  # Remove all the Route's pointing to the proxy until a Route not pointing to us is found.
  if @routes
    @routes.each do |route|
      if ::OverSIP::SIP::Tags.check_value_for_route_ovid(route.ovid_param)
        num_removes += 1
      else
        if local_uri? route
          has_preloaded_route_with_ob_param = true  if route.ob_param?
          num_removes += 1
        else
          break
        end
      end
    end
  end

  ### Outbound stuf. RFC 5626 section 5.3.

  # Outgoing initial request asking for Outbound. Just valid when:
  # - It's an initial request.
  # - The request comes via UDP or comes via TCP/TLS/WS/WSS but through a connection
  #   opened by the peer (and not by OverSIP).
  # - Single Via (so there is no a proxy in front of us).
  # - It's an INVITE, REGISTER, SUBSCRIBE or REFER request.
  # - Has a preloaded top Route with ;ob param pointing to us, or has Contact with ;ob, or
  #   it's a REGISTER with ;+sip.instance..
  #
  if (
        initial? and
        @connection.class.outbound_listener? and (
          @force_outgoing_outbound or (
            @num_vias == 1 and
            outbound_aware? and (
              ( has_preloaded_route_with_ob_param or (@contact and @contact.ob_param?) ) or
              ( @sip_method == :REGISTER and contact_reg_id? )
            )
          )
        )
      )
    @outgoing_outbound_requested = true
    log_system_debug "applying outgoing Outbound support"  if $oversip_debug
  else
    @outgoing_outbound_requested = false
  end

  # Incoming initial request or in-dialog incoming/outgoing request. Must only perform
  # Outbound for the incoming case and just when:
  # - All the Route headers point to us.
  # - There are 1 or 2 Route headers.
  # - The latest Route has a flow token and a valid ;ovid param (so has been generated
  #   previously by us).
  #     NOTE: But don't check its value so it still would work in case of server reboot.
  # - It's an incoming Outbound request (so flow token in the Route does not match the
  #   flow token of the incoming connection).
  if (
        (num_removes == 1 or num_removes == 2) and
        @routes.size == num_removes and
        (outbound_route = @routes.last) and
        outbound_route.ovid_param and
        (@route_outbound_flow_token = outbound_route.user) and
        @route_outbound_flow_token != @connection_outbound_flow_token
      )
    @incoming_outbound_requested = true
    log_system_debug "destination is an incoming Outbound connection"  if $oversip_debug
  end

  # If there are not Route headers return false.
  return false  unless @routes

  # Remove the Route values pointintg to us.
  unless num_removes == 0
    @headers["Route"].shift num_removes
    @routes.shift num_removes
  end
  @routes.empty? and @routes = nil

  # Return true if it is an in-dialog request and the top Route pointed to us.
  # False otherwise as we shouldn't receive an in-dialog request with a top Route non
  # pointing to us.
  if in_dialog?
    return ( num_removes > 0 ? true : false )
  # Return true if it was an initial request and more Route headers remain after inspection.
  elsif @routes
    return true
  # Return false if it was an initial request and all its Route headers pointed to the proxy.
  else
    return false
  end
end

#outgoing_outbound_requested? ⇒ Boolean

Returns:

  • (Boolean) 


163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/oversip/sip/core.rb', line 163

def outgoing_outbound_requested?
  return true   if @outgoing_outbound_requested
  return false  if @outgoing_outbound_requested == false
  
  # It could be an initial request so we must provide Outbound support if
  # forced via request.fix_nat() or if the request properly indicates it, even
  # when route.loose_route() is not called.
  if (
        initial? and
        @connection.class.outbound_listener? and (
          @force_outgoing_outbound or (
            @num_vias == 1 and
            outbound_aware? and (
              ( @contact and @contact.ob_param? ) or
              ( @sip_method == :REGISTER and contact_reg_id? )
            )
          )
        )
      )
    log_system_debug "applying outgoing Outbound support"  if $oversip_debug
    @outgoing_outbound_requested = true
  else
    @outgoing_outbound_requested = false
  end
end