summaryrefslogtreecommitdiff
path: root/misc/freeswitch/scripts/event/presence_update.lua
blob: fd85f031ac6f7279c383d1bb27f01d5e3a691173 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
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
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
161
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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260

module(...,package.seeall)

function handler_class()
  return PresenceUpdate
end

ACCOUNT_RECORD_TIMEOUT = 120;

PresenceUpdate = {}

function PresenceUpdate.new(self, arg)
  require 'common.sip_account';
  require 'dialplan.presence';
  require 'common.str';
  require 'common.phone_number';
  require 'common.fapi';
  require 'common.configuration_table';

  arg = arg or {}
  object = arg.object or {}
  setmetatable(object, self);
  self.__index = self;
  self.log = arg.log;
  self.class = 'presenceupdate'
  self.database = arg.database;
  self.domain = arg.domain;
  self.presence_accounts = {}
  self.account_record = {}

  self.config = common.configuration_table.get(self.database, 'presence_update');
  self.config = self.config or {};
  self.config.trigger = self.config.trigger or {
    sip_account_presence = true,
    sip_account_register = true,
    sip_account_unregister = true,
  };
  return object;
end


function PresenceUpdate.event_handlers(self)
  return { 
    PRESENCE_PROBE = { [true] = self.presence_probe }, 
    CUSTOM = { ['sofia::register'] = self.sofia_register, ['sofia::unregister'] = self.sofia_ungerister },
    PRESENCE_IN = { [true] = self.presence_in },
  }
end


function PresenceUpdate.retrieve_sip_account(self, account, uuid)
  uuid = uuid or 'presence_update';
  
  if not self.account_record[account] or ((os.time() - self.account_record[account].created_at) > ACCOUNT_RECORD_TIMEOUT) then
    self.log:debug('[', uuid,'] PRESENCE - retrieve account data - account: ', account);
    
    local sip_account = common.sip_account.SipAccount:new{ log = self.log, database = self.database }:find_by_auth_name(account);
    if not sip_account then
      return
    end
    
    local phone_numbers = common.phone_number.PhoneNumber:new{ log = self.log, database = self.database }:list_by_owner(sip_account.id, sip_account.class);

    self.account_record[account] = { id = sip_account.id, class = sip_account.class, phone_numbers = phone_numbers, created_at = os.time() }
  end

  return self.account_record[account];
end


function PresenceUpdate.presence_probe(self, event)
  local DIALPLAN_FUNCTION_PATTERN = '^f[_%-].*';

  local event_to = event:getHeader('to');
  local event_from = event:getHeader('from');
  local probe_type = event:getHeader('probe-type');
  local account, domain = common.str.partition(event_from, '@');
  local subscription, domain = common.str.partition(event_to, '@');

  self.log:debug('[', account, '] PRESENCE_UPDATE - subscription: ', subscription,', type: ', probe_type);
  if (not self.presence_accounts[account] or not self.presence_accounts[account][subscription]) and subscription:find(DIALPLAN_FUNCTION_PATTERN) then
    if not self.presence_accounts[account] then
      self.presence_accounts[account] = {};
    end
    if not self.presence_accounts[account][subscription] then
      self.presence_accounts[account][subscription] = {};
    end
    self:update_function_presence(account, domain, subscription);
  end
end


function PresenceUpdate.sofia_register(self, event)
  local account = event:getHeader('from-user');
  local timestamp = event:getHeader('Event-Date-Timestamp');

  local sip_account = self:retrieve_sip_account(account, account);

  self.log:debug('[', account, '] PRESENCE_UPDATE - flushing account cache on register');
  self.presence_accounts[account] = nil;
end


function PresenceUpdate.sofia_ungerister(self, event)
  local account = event:getHeader('from-user');
  local timestamp = event:getHeader('Event-Date-Timestamp');

  local sip_account = self:retrieve_sip_account(account, account);

  self.log:debug('[', account, '] PRESENCE_UPDATE - flushing account cache on unregister');
  self.presence_accounts[account] = nil;
end


function PresenceUpdate.presence_in(self, event)
  local account, domain = common.str.partition(event:getHeader('from'), '@');
  local call_direction = tostring(event:getHeader('presence-call-direction') or event:getHeader('call-direction'))
  local state = event:getHeader('presence-call-info-state');
  local uuid = event:getHeader('Unique-ID');
  local caller_id =  event:getHeader('Caller-Caller-ID-Number');
  local protocol = tostring(event:getHeader('proto'));
  local timestamp = event:getHeader('Event-Date-Timestamp');
  local direction = nil;

  if call_direction == 'inbound' then
    direction = true;
  elseif call_direction == 'outbound' then
    direction = false;
  end

  if protocol == 'conf' then    
    state = event:getHeader('answer-state');
    local login = tostring(event:getHeader('proto'));
    self.log:info('[', uuid,'] PRESENCE_CONFERENCE_', call_direction:upper(), ' ', common.str.to_i(account), ' - identifier: ', account, ', state: ', state);
    self:conference(direction, account, domain, state, uuid);
  elseif protocol == 'sip' or protocol == 'any' then
    if protocol == 'sip' and common.str.blank(state) then
      self.log:debug('[', uuid,'] PRESENCE_', call_direction:upper(),' no state - protocol: ', protocol, ', account: ', account);
      return;
    end
    self.log:info('[', uuid,'] PRESENCE_', call_direction:upper(),' - protocol: ', protocol, ', account: ', account, ', state: ', state);
    self:sip_account(direction, account, domain, state, uuid, caller_id, timestamp);
  else
    self.log:info('[', uuid,'] PRESENCE_', call_direction:upper(),' unhandled protocol: ', protocol, ', account: ', account, ', state: ', state);
  end
end


function PresenceUpdate.update_function_presence(self, account, domain, subscription)
  local parameters = common.str.to_a(subscription, '_%-');
  local fid = parameters[2];
  local function_parameter = parameters[3];

  if not fid then
    self.log:error('[', account, '] PRESENCE_UPDATE - no function specified');
    return;
  end

  if fid == 'cftg' and tonumber(function_parameter) then
    self:call_forwarding(account, domain, function_parameter);
  elseif fid == 'hgmtg' then
    self:hunt_group_membership(account, domain, function_parameter);
  elseif fid == 'acdmtg' then
    self:acd_membership(account, domain, function_parameter);
  end

end


function PresenceUpdate.call_forwarding(self, account, domain, call_forwarding_id)
  require 'common.call_forwarding';

  local call_forwarding = common.call_forwarding.CallForwarding:new{ log=self.log, database=self.database, domain=domain }:find_by_id(call_forwarding_id);     
  if call_forwarding and common.str.to_b(call_forwarding.record.active) then
    local destination_type = tostring(call_forwarding.record.call_forwardable_type):lower()
    
    self.log:debug('[', account, '] PRESENCE_UPDATE - updating call forwarding presence - id: ', call_forwarding_id, ', destination: ', destination_type);
    
    if destination_type == 'voicemail' then
      call_forwarding:presence_set('early');
    else
      call_forwarding:presence_set('confirmed');
    end
  end
end


function PresenceUpdate.hunt_group_membership(self, account, domain, member_id)
  local sql_query = 'SELECT `active` FROM `hunt_group_members` WHERE `active` IS TRUE AND `id`=' .. tonumber(member_id) .. ' LIMIT 1';
  local status = self.database:query_return_value(sql_query);

  if status then
    self.log:debug('[', account, '] PRESENCE_UPDATE - updating hunt group membership presence - id: ', member_id);
    local presence_class = dialplan.presence.Presence:new{
      log = self.log,
      database = self.database,
      domain = domain,
      accounts = {'f-hgmtg-' .. member_id},
      uuid = 'hunt_group_member_' .. member_id
    }:set('confirmed');
  end
end


function PresenceUpdate.acd_membership(self, account, domain, member_id)
  local sql_query = 'SELECT `status` FROM `acd_agents` WHERE `status` = "active" AND `id`=' .. tonumber(member_id) .. ' LIMIT 1';
  local status = self.database:query_return_value(sql_query);

  if status then
    self.log:debug('[', account, '] PRESENCE_UPDATE - updating ACD membership presence - id: ', member_id);
    local presence_class = dialplan.presence.Presence:new{
      log = self.log,
      database = self.database,
      domain = domain,
      accounts = {'f-acdmtg-' .. member_id},
      uuid = 'acd_agent_' .. member_id
    }:set(status);
  end
end


function PresenceUpdate.sip_account(self, inbound, account, domain, status, uuid, caller_id, timestamp)
  local status_map = { progressing = 'early', alerting = 'confirmed', active = 'confirmed' }
  
  local sip_account = self:retrieve_sip_account(account, uuid);
  if not sip_account then
    return;
  end

  dialplan.presence.Presence:new{
    log = self.log,
    database = self.database,
    inbound = inbound,
    domain = domain,
    accounts = sip_account.phone_numbers,
    uuid = uuid
  }:set(status_map[status] or 'terminated', caller_id);

end


function PresenceUpdate.conference(self, inbound, account, domain, status, uuid)
  
  dialplan.presence.Presence:new{
    log = self.log,
    database = self.database,
    inbound = inbound,
    domain = domain,
    accounts = { account },
    uuid = uuid
  }:set(status or 'terminated');
end


function PresenceUpdate.trigger_rails(self, account, status, timestamp, uuid)
  if account.class == 'sipaccount' then
    local command = 'http_request.lua ' .. tostring(uuid) .. ' http://127.0.0.1/trigger/sip_account_update/' .. tostring(account.id) .. '?timestamp=' .. timestamp .. '&status=' .. tostring(status);
    common.fapi.FApi:new():execute('luarun', command);
  end
end