Class: Punchblock::Translator::Asterisk::Call

Inherits:
Object
  • Object
show all
Extended by:
ActorHasGuardedHandlers
Includes:
Celluloid, HasGuardedHandlers, DeadActorSafety
Defined in:
lib/punchblock/translator/asterisk/call.rb

Constant Summary collapse

HANGUP_CAUSE_TO_END_REASON = 
Hash.new { :error }

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from ActorHasGuardedHandlers

execute_guarded_handlers_on_receiver

Methods included from DeadActorSafety

#safe_from_dead_actors

Constructor Details

#initialize(channel, translator, ami_client, connection, agi_env = nil) ⇒ Call

Returns a new instance of Call.



28
29
30
31
32
33
34
35
36
37
 
# File 'lib/punchblock/translator/asterisk/call.rb', line 28

def initialize(channel, translator, ami_client, connection, agi_env = nil)
  @channel, @translator, @ami_client, @connection = channel, translator, ami_client, connection
  @agi_env = agi_env || {}
  @id, @components = Punchblock.new_uuid, {}
  @answered = false
  @pending_joins = {}
  @progress_sent = false
  @block_commands = false
  @channel_variables = {}
end

Instance Attribute Details

#agi_env ⇒ Object (readonly)

Returns the value of attribute agi_env.



14
15
16
 
# File 'lib/punchblock/translator/asterisk/call.rb', line 14

def agi_env
  @agi_env
end

#channel ⇒ Object

Returns the value of attribute channel.



14
15
16
 
# File 'lib/punchblock/translator/asterisk/call.rb', line 14

def channel
  @channel
end

#direction ⇒ Object (readonly)

Returns the value of attribute direction.



14
15
16
 
# File 'lib/punchblock/translator/asterisk/call.rb', line 14

def direction
  @direction
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



14
15
16
 
# File 'lib/punchblock/translator/asterisk/call.rb', line 14

def id
  @id
end

#translator ⇒ Object (readonly)

Returns the value of attribute translator.



14
15
16
 
# File 'lib/punchblock/translator/asterisk/call.rb', line 14

def translator
  @translator
end

Instance Method Details

#actor_died(actor, reason) ⇒ Object 



276
277
278
279
280
281
282
283
 
# File 'lib/punchblock/translator/asterisk/call.rb', line 276

def actor_died(actor, reason)
  return unless reason
  if id = @components.key(actor)
    @components.delete id
    complete_event = Punchblock::Event::Complete.new :component_id => id, :reason => Punchblock::Event::Complete::Error.new
    send_pb_event complete_event
  end
end

#answered? ⇒ Boolean

Returns:

  • (Boolean) 


93
94
95
 
# File 'lib/punchblock/translator/asterisk/call.rb', line 93

def answered?
  @answered
end

#channel_var(variable) ⇒ Object 



56
57
58
 
# File 'lib/punchblock/translator/asterisk/call.rb', line 56

def channel_var(variable)
  @channel_variables[variable] || fetch_channel_var(variable)
end

#component_with_id(component_id) ⇒ Object 



43
44
45
 
# File 'lib/punchblock/translator/asterisk/call.rb', line 43

def component_with_id(component_id)
  @components[component_id]
end

#dial(dial_command) ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/punchblock/translator/asterisk/call.rb', line 65

def dial(dial_command)
  @direction = :outbound
  channel = dial_command.to || ''
  channel.match(/.* <(?<channel>.*)>/) { |m| channel = m[:channel] }
  params = { :async       => true,
             :application => 'AGI',
             :data        => 'agi:async',
             :channel     => channel,
             :callerid    => dial_command.from
           }
  params[:variable] = variable_for_headers dial_command.headers
  params[:timeout] = dial_command.timeout unless dial_command.timeout.nil?

  originate_action = Punchblock::Component::Asterisk::AMI::Action.new :name => 'Originate',
                                                                      :params => params
  originate_action.request!
  translator.async.execute_global_command originate_action
  dial_command.response = Ref.new :id => id
end

#execute_agi_command(command, *params) ⇒ Object 



232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/punchblock/translator/asterisk/call.rb', line 232

def execute_agi_command(command, *params)
  agi = AGICommand.new Punchblock.new_uuid, channel, command, *params
  condition = Celluloid::Condition.new
  register_tmp_handler :ami, name: 'AsyncAGI', [:[], 'SubEvent'] => 'Exec', [:[], 'CommandID'] => agi.id do |event|
    condition.signal event
  end
  agi.execute @ami_client
  event = condition.wait
  return unless event
  agi.parse_result event
rescue RubyAMI::Error => e
  abort e
end

#execute_command(command) ⇒ Object 



162
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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/punchblock/translator/asterisk/call.rb', line 162

def execute_command(command)
  if @block_commands
    command.response = ProtocolError.new.setup :item_not_found, "Could not find a call with ID #{id}", id
    return
  end
  if command.component_id
    if component = component_with_id(command.component_id)
      component.execute_command command
    else
      command.response = ProtocolError.new.setup :item_not_found, "Could not find a component with ID #{command.component_id} for call #{id}", id, command.component_id
    end
  end
  case command
  when Command::Accept
    if outbound?
      command.response = true
    else
      execute_agi_command 'EXEC RINGING'
      command.response = true
    end
  when Command::Answer
    execute_agi_command 'ANSWER'
    @answered = true
    command.response = true
  when Command::Hangup
    send_ami_action 'Hangup', 'Channel' => channel, 'Cause' => 16
    command.response = true
  when Command::Join
    other_call = translator.call_with_id command.call_id
    @pending_joins[other_call.channel] = command
    execute_agi_command 'EXEC Bridge', other_call.channel
  when Command::Unjoin
    other_call = translator.call_with_id command.call_id
    redirect_back other_call
    command.response = true
  when Command::Reject
    rejection = case command.reason
    when :busy
      'EXEC Busy'
    when :decline
      'EXEC Busy'
    when :error
      'EXEC Congestion'
    else
      'EXEC Congestion'
    end
    execute_agi_command rejection
    command.response = true
  when Punchblock::Component::Asterisk::AGI::Command
    execute_component Component::Asterisk::AGICommand, command
  when Punchblock::Component::Output
    execute_component Component::Output, command
  when Punchblock::Component::Input
    execute_component Component::Input, command
  when Punchblock::Component::Record
    execute_component Component::Record, command
  else
    command.response = ProtocolError.new.setup 'command-not-acceptable', "Did not understand command for call #{id}", id
  end
rescue RubyAMI::Error => e
  command.response = case e.message
  when 'No such channel'
    ProtocolError.new.setup :item_not_found, "Could not find a call with ID #{id}", id
  else
    ProtocolError.new.setup 'error', e.message, id
  end
rescue Celluloid::DeadActorError
  command.response = ProtocolError.new.setup :item_not_found, "Could not find a component with ID #{command.component_id} for call #{id}", id, command.component_id
end

#handle_hangup_event(reason = :hangup) ⇒ Object 



266
267
268
269
270
271
272
273
274
 
# File 'lib/punchblock/translator/asterisk/call.rb', line 266

def handle_hangup_event(reason = :hangup)
  @block_commands = true
  @components.dup.each_pair do |id, component|
    safe_from_dead_actors do
      component.call_ended if component.alive?
    end
  end
  send_end_event reason
end

#inbound? ⇒ Boolean

Returns:

  • (Boolean) 


89
90
91
 
# File 'lib/punchblock/translator/asterisk/call.rb', line 89

def inbound?
  direction == :inbound
end

#logger_id ⇒ Object 



246
247
248
 
# File 'lib/punchblock/translator/asterisk/call.rb', line 246

def logger_id
  "#{self.class}: #{id}"
end

#outbound? ⇒ Boolean

Returns:

  • (Boolean) 


85
86
87
 
# File 'lib/punchblock/translator/asterisk/call.rb', line 85

def outbound?
  direction == :outbound
end

#process_ami_event(ami_event) ⇒ Object 



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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/punchblock/translator/asterisk/call.rb', line 107

def process_ami_event(ami_event)
  send_pb_event Event::Asterisk::AMI::Event.new(:name => ami_event.name, :attributes => ami_event.headers)

  case ami_event.name
  when 'Hangup'
    handle_hangup_event HANGUP_CAUSE_TO_END_REASON[ami_event['Cause'].to_i]
  when 'AsyncAGI'
    if component = component_with_id(ami_event['CommandID'])
      component.handle_ami_event ami_event
    end
  when 'Newstate'
    case ami_event['ChannelState']
    when '5'
      send_pb_event Event::Ringing.new
    when '6'
      @answered = true
      send_pb_event Event::Answered.new
    end
  when 'OriginateResponse'
    if ami_event['Response'] == 'Failure' && ami_event['Uniqueid'] == '<null>'
      send_end_event :error
    end
  when 'BridgeExec'
    join_command   = @pending_joins.delete ami_event['Channel1']
    join_command ||= @pending_joins.delete ami_event['Channel2']
    join_command.response = true if join_command
  when 'Bridge'
    other_call_channel = ([ami_event['Channel1'], ami_event['Channel2']] - [channel]).first
    if other_call = translator.call_for_channel(other_call_channel)
      event = case ami_event['Bridgestate']
      when 'Link'
        Event::Joined.new.tap do |e|
          e.call_id = other_call.id
        end
      when 'Unlink'
        Event::Unjoined.new.tap do |e|
          e.call_id = other_call.id
        end
      end
      send_pb_event event
    end
  when 'Unlink'
    other_call_channel = ([ami_event['Channel1'], ami_event['Channel2']] - [channel]).first
    if other_call = translator.call_for_channel(other_call_channel)
      event = Event::Unjoined.new.tap do |e|
        e.call_id = other_call.id
      end
      send_pb_event event
    end
  when 'VarSet'
    @channel_variables[ami_event['Variable']] = ami_event['Value']
  end
  trigger_handler :ami, ami_event
end

#redirect_back(other_call = nil) ⇒ Object 



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/punchblock/translator/asterisk/call.rb', line 250

def redirect_back(other_call = nil)
  redirect_options = {
    'Channel'   => channel,
    'Exten'     => Asterisk::REDIRECT_EXTENSION,
    'Priority'  => Asterisk::REDIRECT_PRIORITY,
    'Context'   => Asterisk::REDIRECT_CONTEXT
  }
  redirect_options.merge!({
    'ExtraChannel' => other_call.channel,
    'ExtraExten'     => Asterisk::REDIRECT_EXTENSION,
    'ExtraPriority'  => Asterisk::REDIRECT_PRIORITY,
    'ExtraContext'   => Asterisk::REDIRECT_CONTEXT
  }) if other_call
  send_ami_action 'Redirect', redirect_options
end

#register_component(component) ⇒ Object 



39
40
41
 
# File 'lib/punchblock/translator/asterisk/call.rb', line 39

def register_component(component)
  @components[component.id] ||= component
end

#send_offer ⇒ Object 



47
48
49
50
 
# File 'lib/punchblock/translator/asterisk/call.rb', line 47

def send_offer
  @direction = :inbound
  send_pb_event offer_event
end

#send_progress ⇒ Object 



97
98
99
100
101
 
# File 'lib/punchblock/translator/asterisk/call.rb', line 97

def send_progress
  return if answered? || outbound? || @progress_sent
  @progress_sent = true
  execute_agi_command "EXEC Progress"
end

#shutdown ⇒ Object 



52
53
54
 
# File 'lib/punchblock/translator/asterisk/call.rb', line 52

def shutdown
  terminate
end

#to_s ⇒ Object Also known as: inspect 



60
61
62
 
# File 'lib/punchblock/translator/asterisk/call.rb', line 60

def to_s
  "#<#{self.class}:#{id} Channel: #{channel.inspect}>"
end