summaryrefslogtreecommitdiff
path: root/misc/freeswitch/scripts/dialplan/functions.lua
blob: 0d15b86c3855044da91ac604b4f98654e7c9e328 (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
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
-- DialplanModule: Functions
--
module(...,package.seeall)

Functions = {}

-- Create Functions object
function Functions.new(self, arg)
  arg = arg or {}
  object = arg.object or {}
  setmetatable(object, self)
  self.__index = self
  self.log = arg.log
  self.database = arg.database
  self.domain = arg.domain
  return object
end

function Functions.ensure_caller_sip_account(self, caller)
  if caller.account and  caller.account.class == 'sipaccount' then
    return caller.account;
  end
end

function Functions.dialplan_function(self, caller, dialed_number)
  require 'common.str'
  local parameters = common.str.to_a(dialed_number, '%-');
  if not parameters[2] then
    return { continue = false, code = 484, phrase = 'Malformed function parameters', no_cdr = true };
  end
  local fid = tostring(parameters[2]);
  local result = { continue = false, code = 404, phrase = 'Function not found', no_cdr = true };

  self.log:debug('DIALPLAN_FUNCTION - execute: ', dialed_number);

  if fid == "ta" then
    result = self:transfer_all(caller, parameters[3]);
  elseif fid == "ia" then
    result = self:intercept_any_number(caller, parameters[3]);
  elseif fid == "ig" then
    result = self:group_pickup(caller, parameters[3]);
  elseif fid == "anc" then
    result = self:account_node_change(caller);
  elseif fid == "li" then
    result = self:user_login(caller, parameters[3], parameters[4]);
  elseif fid == "lo" then
    result = self:user_logout(caller);
  elseif fid == "lir" then
    result = self:user_login_redirect(caller, parameters[3], parameters[4]);
  elseif fid == "loaon" then
    result = self:user_auto_logout(caller, true);
  elseif fid == "loaoff" then
    result = self:user_auto_logout(caller, false);
  elseif fid == "redial" then
    result = self:redial(caller);
  elseif fid == "dcliroff" then
    result = self:dial_clir_off(caller, parameters[3]);
  elseif fid == "dcliron" then
    result = self:dial_clir_on(caller, parameters[3]);
  elseif fid == "cliron" then
    result = self:clir_on(caller);
  elseif fid == "cliroff" then
    result = self:clir_off(caller);
  elseif fid == "clipon" then
    result = self:clip_on(caller);
  elseif fid == "clipoff" then
    result = self:clip_off(caller);
  elseif fid == "cwaoff" then
    result = self:callwaiting_off(caller);
  elseif fid == "cwaon" then
    result = self:callwaiting_on(caller);
  elseif fid == "cfoff" then
    result = self:call_forwarding_off(caller);
  elseif fid == "cfdel" then
    result = self:call_forwarding_off(caller, nil, true);
  elseif fid == "cfu" then
    result = self:call_forwarding_on(caller, 'always', parameters[3], 'PhoneNumber');
  elseif fid == "cfuoff" then
    result = self:call_forwarding_off(caller, 'always');
  elseif fid == "cfudel" then
    result = self:call_forwarding_off(caller, 'always', true);
  elseif fid == "cfutg" then
    result = self:call_forwarding_toggle(caller, 'always', parameters[3]);
  elseif fid == "cfn" then
    result = self:call_forwarding_on(caller, 'noanswer', parameters[3], 'PhoneNumber', parameters[4]);
  elseif fid == "cfnoff" then
    result = self:call_forwarding_off(caller, 'noanswer');
  elseif fid == "cfndel" then
    result = self:call_forwarding_off(caller, 'noanswer', true); 
  elseif fid == "cfo" then
    result = self:call_forwarding_on(caller, 'offline', parameters[3], 'PhoneNumber');
  elseif fid == "cfooff" then
    result = self:call_forwarding_off(caller, 'offline');
  elseif fid == "cfodel" then
    result = self:call_forwarding_off(caller, 'offline', true);
  elseif fid == "cfb" then
    result = self:call_forwarding_on(caller, 'busy', parameters[3], 'PhoneNumber');
  elseif fid == "cfboff" then
    result = self:call_forwarding_off(caller, 'busy');
  elseif fid == "cfbdel" then
    result = self:call_forwarding_off(caller, 'busy', true);
  elseif fid == "vmleave" then
    result = self:voicemail_message_leave(caller, parameters[3]);
  elseif fid == "vmcheck" then
    result = self:voicemail_check(caller, parameters[3]);
  elseif fid == "vmtg" then
    result = self:call_forwarding_toggle(caller, nil, parameters[3]);
  elseif fid == "acdmtg" then
    result = self:acd_membership_toggle(caller, parameters[3], parameters[4]);
  elseif fid == "e164" then
    result = "+" .. tostring(parameters[3]);
  elseif fid == "hangup" then
    result = self:hangup(caller, parameters[3], parameters[4]);
  elseif fid == "cpa" then
    result = self:call_parking_inout(caller, parameters[3], parameters[4]);
  elseif fid == "cpai" then
    result = self:call_parking_inout_index(caller, parameters[3]);
  end

  return result or { continue = false, code = 505, phrase = 'Error executing function', no_cdr = true };
end

-- Transfer all calls to a conference
function Functions.transfer_all(self, caller, destination_number)
  self.log:info('TRANSFER_ALL - caller: ', caller.account_type, '/', caller.account_uuid, ' number: ', destination_number);
  
  local caller_sip_account = self:ensure_caller_sip_account(caller);
  if not caller_sip_account then
    self.log:error('TRANSFER_ALL - incompatible caller');
    return { continue = false, code = 403, phrase = 'Incompatible caller' }
  end

  -- Query call and channel table for channel IDs
  local sql_query = 'SELECT  `b`.`name` AS `caller_chan_name`, `a`.`caller_uuid`, `a`.`callee_uuid` \
    FROM `calls` `a` JOIN `channels` `b` ON `a`.`caller_uuid` = `b`.`uuid` JOIN `channels` `c` \
    ON `a`.`callee_uuid` = `c`.`uuid` WHERE `b`.`name` LIKE ("%' .. caller_sip_account.record.auth_name .. '@%") \
    OR `c`.`name` LIKE ("%' .. caller_sip_account.record.auth_name .. '@%") LIMIT 100';

  self.database:query(sql_query, function(call_entry)
    local uid = nil
    if call_entry.caller_chan_name:find(caller_sip_account.record.auth_name .. "@") then
      uid = call_entry.callee_uuid;
      self.log:debug("Transfering callee channel with uid: " .. uid);
    else
      uid = call_entry.caller_uuid;
      self.log:debug("Transfering caller channel with uid: " .. uid);
    end
    freeswitch.API():execute("uuid_transfer", uid .. " " .. destination_number);
  end)

  return destination_number;
end


function Functions.intercept_any_number(self, caller, destination_number)
  require 'common.phone_number'
  local phone_number = common.phone_number.PhoneNumber:new{ log = self.log, database = self.database }:find_by_number(destination_number);

  if not phone_number or not phone_number.record then
    self.log:notice('FUNCTION_INTERCEPT_ANY_NUMBER - number not found: ', destination_number);
    return { continue = false, code = 404, phrase = 'Number not found', no_cdr = true };
  end

  if not phone_number.record.phone_numberable_type:lower() == 'sipaccount' or not tonumber(phone_number.record.phone_numberable_id) then
    self.log:notice('FUNCTION_INTERCEPT_ANY_NUMBER - destination: ',  phone_number.record.phone_numberable_type:lower(), '=', phone_number.record.phone_numberable_id, ', number: ', destination_number);
    return { continue = false, code = 505, phrase = 'Incompatible destination', no_cdr = true };
  end

  self.log:info('FUNCTION_INTERCEPT_ANY_NUMBER intercepting call - to: ', phone_number.record.phone_numberable_type:lower(), '=', phone_number.record.phone_numberable_id, ', number: ', destination_number);

  caller:set_variable('gs_pickup_group_pick', 's' .. phone_number.record.phone_numberable_id);
  caller:execute('pickup', 's' .. phone_number.record.phone_numberable_id);

  return { continue = false, code = 200, phrase = 'OK', no_cdr = true }
end


function Functions.group_pickup(self, caller, group_id)
  if not tonumber(group_id) then
    return { continue = false, code = 505, phrase = 'Incompatible destination', no_cdr = true };
  end
  
  caller:set_variable('gs_pickup_group_pick', 'g' .. group_id);
  caller:execute('pickup', 'g' .. group_id);

  return { continue = false, code = 200, phrase = 'OK', no_cdr = true }
end


function Functions.account_node_change(self, caller)
  self.log:info('NODE_CHANGE - caller: ', caller.account_type, '/', caller.account_uuid, ', caller_id: ', caller.caller_id_number);

  -- find caller's sip account
  local caller_sip_account = caller.account;
  if not caller_sip_account or not caller_sip_account.class == 'sipaccount' then
    self.log:notice('LOGIN - caller sip_account not found');
    return { continue = false, code = 404, phrase = 'Account not found', no_cdr = true }
  end

  require 'phones.phone'
  local phone_class = phones.phone.Phone:new{log = self.log, database = self.database}

  -- logout caller phones if caller account is hot-deskable
  local caller_phones = phone_class:find_all_hot_deskable_by_account(caller_sip_account.record.id);
  for index, phone_caller in ipairs(caller_phones) do
    phone_caller:logout(caller_sip_account.record.id);
  end

  self:update_node_change(caller_sip_account, caller.local_node_id);
  caller:answer();
  caller:send_display('Change successful');
  caller.session:sayPhrase('logged_in');

  -- resync caller phones
  for index, phone_caller in ipairs(caller_phones) do
    local result = phone_caller:resync{ auth_name = caller_sip_account.record.auth_name, domain = caller_sip_account.record.host };
    self.log:info('NODE_CHANGE - resync phone - mac: ', phone_caller.record.mac_address, ', ip_address: ', phone_caller.record.ip_address, ', result: ', result);
  end

  return { continue = false, code = 200, phrase = 'OK', no_cdr = true }
end


function Functions.user_login(self, caller, number, pin)
  require 'common.str'

  local PHONE_NUMBER_LEN_MIN = 4;
  local PHONE_NUMBER_LEN_MAX = 12;
  local PIN_LEN_MIN = 4;
  local PIN_LEN_MAX = 12;

  caller:set_variable('destination_number', 'f-li-' .. common.str.to_s(number) .. '-PIN');
  self.log:info('LOGIN - caller: ', caller.account_type, '/', caller.account_uuid, ', caller_id: ', caller.caller_id_number, ', number: ', number);

  if common.str.blank(number) then
    number = caller.session:read(PHONE_NUMBER_LEN_MIN, PHONE_NUMBER_LEN_MAX, 'ivr/ivr-please_enter_extension_followed_by_pound.wav', 3000, '#');
  end

   -- find caller's sip account
  local caller_sip_account = caller.account;
  if not caller_sip_account or not caller_sip_account.class == 'sipaccount' then
    self.log:notice('LOGIN - caller sip_account not found');
    return { continue = false, code = 404, phrase = 'Caller not found', no_cdr = true }
  end

  require 'phones.phone'
  local phone_class = phones.phone.Phone:new{log = self.log, database = self.database}
  
  local caller_phones = phone_class:find_all_hot_deskable_by_account(caller_sip_account.id);
  local caller_phone  = caller_phones[1];

  if not caller_phone then
    self.log:notice('LOGIN - caller phone not found or not hot-deskable');
    local result = phone_class:resync{ auth_name = caller_sip_account.record.auth_name, domain = caller_sip_account.record.host };
    return { continue = false, code = 403, phrase = 'Phone not hot-deskable', no_cdr = true }
  end

  require 'common.phone_number'
  local phone_number = common.phone_number.PhoneNumber:new{log = self.log, database = self.database}:find_by_number(number, {"SipAccount"});

  if not phone_number then
    self.log:notice('LOGIN - number not found or not linked to a sip account - number: ', number);
    return { continue = false, code = 404, phrase = 'Account not found', no_cdr = true }
  end

  require 'common.sip_account'
  local destination_sip_account = common.sip_account.SipAccount:new{ log = self.log, database = self.database }:find_by_id(phone_number.record.phone_numberable_id);

  if not destination_sip_account then
    self.log:notice('LOGIN - account not found - ', phone_number.record.phone_numberable_type, '=', phone_number.record.phone_numberable_id, ', number: ', number);
    return { continue = false, code = 404, phrase = 'Account not found', no_cdr = true }
  end

  self.log:info('LOGIN - destination: ', phone_number.record.phone_numberable_type, '=', destination_sip_account.record.id, 
    ', caller_name: ', destination_sip_account.record.caller_name, ', hotdeskable: ', destination_sip_account.record.hotdeskable);

  if not common.str.to_b(destination_sip_account.record.hotdeskable) then
    self.log:notice('LOGIN - destination sip_account not hot-deskable');
    return { continue = false, code = 404, phrase = 'Destination not hot-deskable', no_cdr = true }
  end

  require 'dialplan.user'
  local user = dialplan.user.User:new{ log = self.log, database = self.database }:find_by_id(destination_sip_account.record.sip_accountable_id);

  if common.str.blank(pin) then
    pin = caller.session:read(PIN_LEN_MIN, PIN_LEN_MAX, 'ivr/ivr-please_enter_pin_followed_by_pound.wav', 3000, '#');
  end

  if not user then
    self.log:notice('LOGIN - user not found - ',  destination_sip_account.record.sip_accountable_type, '=',destination_sip_account.record.sip_accountable_id);
    return { continue = false, code = 403, phrase = 'Authentication failed', no_cdr = true }
  end

  if not user:check_pin(pin) then
    self.log:notice('LOGIN - authentication failed');
    return { continue = false, code = 403, phrase = 'Authentication failed', no_cdr = true }
  end

  -- logout caller phones if caller account is hot-deskable
  if common.str.to_b(caller_sip_account.record.hotdeskable) then
    for index, phone_caller in ipairs(caller_phones) do
      phone_caller:logout(caller_sip_account.record.id);
    end
  end

  local destination_phones = phone_class:find_all_hot_deskable_by_account(destination_sip_account.record.id);
  -- logout destination phones
  for index, phone_destination in ipairs(destination_phones) do
    phone_destination:logout(destination_sip_account.record.id);
  end

  local result = caller_phone:login(destination_sip_account.record.id, destination_sip_account.record.sip_accountable_id, destination_sip_account.record.sip_accountable_type);
  self.log:info('LOGIN - account login - mac: ', caller_phone.record.mac_address, ', ip_address: ', caller_phone.record.ip_address, ', result: ', result);

  if not result then
    return { continue = false, code = 403, phrase = 'Login failed', no_cdr = true }
  end

  caller:answer();
  caller:send_display('Login successful');

  self:update_node_change(destination_sip_account, caller.local_node_id);
  caller:sleep(1000);

  -- resync destination phones
  for index, phone_destination in ipairs(destination_phones) do
    local result = phone_destination:resync{ auth_name = destination_sip_account.record.auth_name, domain = destination_sip_account.record.host };
    self.log:info('LOGIN - resync destination phone - mac: ', phone_destination.record.mac_address, ', ip_address: ', phone_destination.record.ip_address, ', result: ', result);
  end

  -- resync caller phones
  for index, phone_caller in ipairs(caller_phones) do
    local result = phone_caller:resync{ auth_name = caller_sip_account.record.auth_name, domain = caller_sip_account.record.host };
    self.log:info('LOGIN - resync caller phone - mac: ', phone_caller.record.mac_address, ', ip_address: ', phone_caller.record.ip_address, ', result: ', result);
  end

  return { continue = false, code = 200, phrase = 'OK', no_cdr = true }
end


function Functions.user_logout(self, caller)
  require 'common.str'
  self.log:info('LOGOUT - caller: ', caller.account_type, '/', caller.account_uuid, ', caller_id: ', caller.caller_id_number);

  -- find caller's sip account
  local caller_sip_account = caller.account;
  if not caller_sip_account or not caller_sip_account.class == 'sipaccount' then
    self.log:notice('LOGOUT - caller sip_account not found');
    return { continue = false, code = 404, phrase = 'Caller not found', no_cdr = true }
  end

  if not common.str.to_b(caller_sip_account.record.hotdeskable) then
    self.log:notice('LOGOUT - caller sip_account not hot-deskable');
    return { continue = false, code = 404, phrase = 'Caller not hot-deskable', no_cdr = true }
  end

  require 'phones.phone'
  local phone_class = phones.phone.Phone:new{log = self.log, database = self.database}
  
  local caller_phones = phone_class:find_all_hot_deskable_by_account(caller_sip_account.id);
  
  if #caller_phones == 0 then
    self.log:notice('LOGOUT - caller phones not found or not hot-deskable');
    local result = phone_class:resync{ auth_name = caller_sip_account.record.auth_name, domain = caller_sip_account.record.host };
    return { continue = false, code = 403, phrase = 'Phone not hot-deskable', no_cdr = true }
  end

  local result = false;
  for index, phone_caller in ipairs(caller_phones) do
    result = phone_caller:logout(caller_sip_account.record.id);
    self.log:info('LOGOUT - account logout - mac: ', phone_caller.record.mac_address, ', ip_address: ', phone_caller.record.ip_address, ', result: ', result);
  end

  caller:answer();
  caller:send_display('Logout successful');
  caller:sleep(1000);

  -- resync caller phones
  for index, phone_caller in ipairs(caller_phones) do
    local result = phone_caller:resync{ auth_name = caller_sip_account.record.auth_name, domain = caller_sip_account.record.host };
    self.log:info('LOGIN - resync caller phone - mac: ', phone_caller.record.mac_address, ', ip_address: ', phone_caller.record.ip_address, ', result: ', result);
  end

  return { continue = false, code = 200, phrase = 'OK', no_cdr = true }
end


function Functions.update_node_change(self, sip_account, node_id)
  require 'common.sync_log'
  local sync_log_class = common.sync_log.SyncLog:new{ log = self.log, database = self.database, homebase_ip_address = sip_account.record.host }
  
  if tostring(sip_account.record.gs_node_id) ~= tostring(node_id) then
    self.log:info('UPDATE_NODE - from: ', sip_account.record.gs_node_id, ', to: ', node_id, ', sipaccount=', sip_account.record.id, '/', sip_account.record.uuid, '@', node_id, ', caller_name: ', sip_account.record.caller_name);
    sql_query = 'UPDATE `sip_accounts` SET `updated_at` = NOW(), `gs_node_id` = ' .. tonumber(node_id) .. ' WHERE id = ' .. tonumber(sip_account.record.id);
    if self.database:query(sql_query) then
      sync_log_class:insert('SipAccount', { uuid = sip_account.record.uuid, gs_node_id = tonumber(node_id), updated_at = os.date('!%Y-%m-%d %H:%M:%S %Z') }, 'update', { 'gs_node_id', 'updated_at' });
    end
  end

  require 'common.phone_number'
  local phone_numbers = common.phone_number.PhoneNumber:new{log = self.log, database = self.database}:find_all_by_owner(sip_account.record.id, 'SipAccount');
  for number_id, phone_number in pairs(phone_numbers) do
    if tostring(phone_number.record.gs_node_id) ~= tostring(node_id) then
      self.log:info('UPDATE_NODE - from: ', phone_number.record.gs_node_id, ', to: ', node_id, ', phonenumber=', phone_number.record.id, '/', phone_number.record.uuid, '@', node_id, ', number: ', phone_number.record.number);
      sql_query = 'UPDATE `phone_numbers` SET `updated_at` = NOW(), `gs_node_id` = ' .. tonumber(node_id) .. ' WHERE id = ' .. tonumber(number_id);
      
      if self.database:query(sql_query) then
        sync_log_class:insert('PhoneNumber', { uuid = phone_number.record.uuid, gs_node_id = tonumber(node_id), updated_at = os.date('!%Y-%m-%d %H:%M:%S %Z') }, 'update', { 'gs_node_id', 'updated_at' });
      end
    end
  end
end


function Functions.user_login_redirect(self, caller, phone_number, pin)
  -- Remove PIN from destination_number
  caller.session:setVariable("destination_number", "f-li-" .. tostring(phone_number) .. "-PIN");

  -- Redirect to f-li function
  caller.session:execute("redirect", "sip:f-li-" .. tostring(phone_number) .. "-" .. tostring(pin) .. "@" .. caller.domain);
end

-- Set nightly_reboot flag
function Functions.user_auto_logout(self, caller, auto_logout)
  local nightly_reboot = 'FALSE';
  if auto_logout then
    nightly_reboot = 'TRUE';
  end

  -- Ensure a valid sip account
  local caller_sip_account = caller.account;
  if not caller_sip_account or not caller_sip_account.class == 'sipaccount' then
    return { continue = false, code = 403, phrase = 'Incompatible caller', no_cdr = true }
  end

  require "phones.phone"
  local phone_class = phones.phone.Phone:new{log = self.log, database = self.database}
  
  -- Get caller phone
  local caller_phone = phone_class:find_hot_deskable_by_account(caller_sip_account.id);
  if not caller_phone then
    self.log:notice("Caller phone not found or not hot-deskable");
    return { continue = false, code = 401, phrase = 'Phone not hot-deskable', no_cdr = true }
  end

  log:debug("Hot-desking auto log off - caller phone: " .. caller_phone.record.id .. ", mac: " .. caller_phone.record.mac_address);

  sql_query = 'UPDATE `phones` SET `nightly_reboot` = ' .. nightly_reboot .. ' WHERE `id` = ' .. tonumber(caller_phone.record.id);
  
  if not self.database:query(sql_query) then
    self.log:error('Hot-desking auto log off status could not be changed from ' .. tostring(caller_phone.record.nightly_reboot) .. ' to ' .. nightly_reboot);
    return { continue = false, code = 401, phrase = 'Value could not be changed', no_cdr = true }
    
  end

  self.log:debug('Hot-desking auto log off changed from ' .. tostring(caller_phone.record.nightly_reboot) .. ' to ' .. nightly_reboot);

  caller:answer();
  caller:send_display('Logout successful');
  caller:sleep(1000);
end

function Functions.redial(self, caller)
  -- Ensure a valid sip account
  local caller_sip_account = self:ensure_caller_sip_account(caller);
  if not caller_sip_account then
    return { continue = false, code = 403, phrase = 'Incompatible caller', no_cdr = true }
  end

  local sql_query = 'SELECT `destination_number` \
    FROM `call_histories` \
    WHERE `entry_type` = "dialed" \
    AND `call_historyable_type` = "SipAccount" \
    AND `call_historyable_id` = ' .. caller_sip_account.record.id .. ' \
    ORDER BY `start_stamp` DESC LIMIT 1';

  local phone_number = self.database:query_return_value(sql_query);

  common_str = require 'common.str';
  if common_str.blank(phone_number) then
    return { continue = false, code = 404, phrase = 'No phone number saved', no_cdr = true }
  end

  return { continue = true, number = phone_number }
end

function Functions.dial_clir_off(self, caller, phone_number)
  -- Ensure a valid sip account
  local caller_sip_account = self:ensure_caller_sip_account(caller);
  if not caller_sip_account then
    return { continue = false, code = 403, phrase = 'Incompatible caller', no_cdr = true }
  end

  caller.clir = false;
  return { continue = true, number = phone_number }
end

function Functions.dial_clir_on(self, caller, phone_number)
  -- Ensure a valid sip account
  local caller_sip_account = self:ensure_caller_sip_account(caller);
  if not caller_sip_account then
    return { continue = false, code = 403, phrase = 'Incompatible caller', no_cdr = true }
  end

  caller.clir = true;
  return { continue = true, number = phone_number }
end

function Functions.callwaiting_on(self, caller)
  -- Find caller's SipAccount
  local caller_sip_account = self:ensure_caller_sip_account(caller);
  if not caller_sip_account then
    return { continue = false, code = 403, phrase = 'Incompatible caller', no_cdr = true }
  end

  local sql_query = 'UPDATE `sip_accounts` SET `call_waiting` = TRUE WHERE `id` = ' .. caller_sip_account.record.id;
  
  if not self.database:query(sql_query) then
    self.log:notice("Call Waiting could not be set");
    return { continue = false, code = 500, phrase = 'Call Waiting could not be set', no_cdr = true }
  end

  caller:answer();
  caller:send_display('Call waiting on');
  caller:sleep(1000);
  return { continue = false, code = 200, phrase = 'OK', no_cdr = true }
end

function Functions.callwaiting_off(self, caller)
  -- Find caller's SipAccount
  local caller_sip_account = self:ensure_caller_sip_account(caller);
  if not caller_sip_account then
    return { continue = false, code = 403, phrase = 'Incompatible caller', no_cdr = true }
  end

  local sql_query = 'UPDATE `sip_accounts` SET `call_waiting` = FALSE WHERE `id` = ' .. caller_sip_account.record.id;
  
  if not self.database:query(sql_query) then
    self.log:notice("Call Waiting could not be set");
    return { continue = false, code = 500, phrase = 'Call Waiting could not be set', no_cdr = true }
  end

  caller:answer();
  caller:send_display('Call waiting off');
  caller:sleep(1000);
  return { continue = false, code = 200, phrase = 'OK', no_cdr = true }
end

function Functions.clir_on(self, caller)
  -- Find caller's SipAccount
  local caller_sip_account = self:ensure_caller_sip_account(caller);
  if not caller_sip_account then
    return { continue = false, code = 403, phrase = 'Incompatible caller', no_cdr = true }
  end

  local sql_query = 'UPDATE `sip_accounts` SET `clir` = TRUE WHERE `id` = ' .. caller_sip_account.record.id;
  
  if not self.database:query(sql_query) then
    self.log:notice("CLIR could not be set");
    return { continue = false, code = 500, phrase = 'CLIR could not be set', no_cdr = true }
    
  end

  caller:answer();
  caller:send_display('CLIR on');
  caller:sleep(1000);
  return { continue = false, code = 200, phrase = 'OK', no_cdr = true }
end

function Functions.clir_off(self, caller)
  -- Find caller's SipAccount
  local caller_sip_account = self:ensure_caller_sip_account(caller);
  if not caller_sip_account then
    return { continue = false, code = 403, phrase = 'Incompatible caller', no_cdr = true }
  end

  local sql_query = 'UPDATE `sip_accounts` SET `clir` = FALSE WHERE `id` = ' .. caller_sip_account.record.id;
  
  if not self.database:query(sql_query) then
    self.log:notice("CLIR could not be set");
    return { continue = false, code = 500, phrase = 'CLIR could not be set', no_cdr = true }
    
  end

  caller:answer();
  caller:send_display('CLIR off');
  caller:sleep(1000);
  return { continue = false, code = 200, phrase = 'OK', no_cdr = true }
end

function Functions.clip_on(self, caller)
  -- Find caller's SipAccount
  local caller_sip_account = self:ensure_caller_sip_account(caller);
  if not caller_sip_account then
    return { continue = false, code = 403, phrase = 'Incompatible caller', no_cdr = true }
  end

  local sql_query = 'UPDATE `sip_accounts` SET `clip` = TRUE WHERE `id` = ' .. caller_sip_account.record.id;
  
  if not self.database:query(sql_query) then
    self.log:notice("CLIP could not be set");
    return { continue = false, code = 500, phrase = 'CLIP could not be set', no_cdr = true }
    
  end

  caller:answer();
  caller:send_display('CLIP on');
  caller:sleep(1000);
  return { continue = false, code = 200, phrase = 'OK', no_cdr = true }
end


function Functions.clip_off(self, caller)
  -- Find caller's SipAccount
  local caller_sip_account = self:ensure_caller_sip_account(caller);
  if not caller_sip_account then
    return { continue = false, code = 403, phrase = 'Incompatible caller', no_cdr = true }
  end

  local sql_query = 'UPDATE `sip_accounts` SET `clip` = FALSE WHERE `id` = ' .. caller_sip_account.record.id;
  
  if not self.database:query(sql_query) then
    self.log:notice("CLIP could not be set");
    return { continue = false, code = 500, phrase = 'CLIP could not be set', no_cdr = true }
    
  end

  caller:answer();
  caller:send_display('CLIP off');
  caller:sleep(1000);
  return { continue = false, code = 200, phrase = 'OK', no_cdr = true }
end

function Functions.call_forwarding_off(self, caller, call_forwarding_service, delete)
  -- Find caller's SipAccount
  local caller_sip_account = self:ensure_caller_sip_account(caller);
  if not caller_sip_account then
    return { continue = false, code = 403, phrase = 'Incompatible caller', no_cdr = true }
  end

  caller_sip_account.domain = caller_sip_account.domain or caller.domain;

  if not caller_sip_account:call_forwarding_off(call_forwarding_service, nil, delete) then
    self.log:notice('FUNCTION_CALL_FORWARDING_OFF - call forwarding could not be deactivated');
    return { continue = false, code = 500, phrase = 'Call Forwarding could not be deactivated', no_cdr = true }
  end

  caller:answer();
  caller:send_display('Call forwarding off');
  caller:sleep(1000);
  return { continue = false, code = 200, phrase = 'OK', no_cdr = true }
end


function Functions.call_forwarding_on(self, caller, call_forwarding_service, destination, destination_type, timeout)
  if not call_forwarding_service then
    self.log:notice('FUNCTION_CALL_FORWARDING_ON - no call forwarding service specified');
  end

  -- Find caller's SipAccount
  local caller_sip_account = self:ensure_caller_sip_account(caller);
  if not caller_sip_account then
    return { continue = false, code = 403, phrase = 'Incompatible caller', no_cdr = true }
  end

  caller_sip_account.domain = caller_sip_account.domain or caller.domain;

  if not caller_sip_account:call_forwarding_on(call_forwarding_service, destination, destination_type, timeout) then
    self.log:notice('FUNCTION_CALL_FORWARDING_ON - call forwarding could not be activated');
    return { continue = false, code = 500, phrase = 'Call Forwarding could not be activated', no_cdr = true }
  end

  caller:answer();
  caller:send_display('Call forwarding on');
  caller:sleep(1000);
  return { continue = false, code = 200, phrase = 'OK', no_cdr = true }
end


function Functions.call_forwarding_toggle(self, caller, call_forwarding_service, phone_number_id)
  local defaults = {log = self.log, database = self.database, domain = caller.domain}

  -- Find caller's SipAccount
  local caller_sip_account = self:ensure_caller_sip_account(caller);
  if not caller_sip_account then
    return { continue = false, code = 403, phrase = 'Incompatible caller', no_cdr = true }
  end

  require "common.phone_number"
  local phone_number_class = common.phone_number.PhoneNumber:new{ log = self.log, database = self.database, domain = caller.domain };
  local phone_numbers = phone_number_class:list_by_owner(caller_sip_account.record.id, 'SipAccount');

  local result = nil;
  for index, phone_number in pairs(phone_numbers) do
    phone_number_object = phone_number_class:find_by_number(phone_number);
    if phone_number_object then
      if not result then
        result = phone_number_object:call_forwarding_toggle(call_forwarding_service);
      elseif result.active then
        phone_number_object:call_forwarding_on(call_forwarding_service, result.destination, result.destination_type, result.timeout);
      else
        phone_number_object:call_forwarding_off(call_forwarding_service);
      end      
    end
  end

  if not result then
    self.log:notice("call forwarding could not be toggled");
    return { continue = false, code = 500, phrase = 'Call Forwarding could not be toggled', no_cdr = true }
    
  end

  caller:answer();
  caller:send_display('Call forwarding toggled');
  caller:sleep(1000);
  return { continue = false, code = 200, phrase = 'OK', no_cdr = true }
end


function Functions.voicemail_message_leave(self, caller, phone_number)
  require 'dialplan.voicemail'
  local voicemail_account = dialplan.voicemail.Voicemail:new{ log = self.log, database = self.database }:find_by_number(phone_number);

  if not voicemail_account then
    return { continue = false, code = 404, phrase = 'Mailbox not found', no_cdr = true }
  end

  voicemail_account:leave(caller, phone_number);

  if caller:to_s("voicemail_message_len") ~= '' then
    voicemail_account:send_notify(caller);
  else
    self.log:debug("voicemail - no message saved");
  end

  return { continue = false, code = 200, phrase = 'OK' }
end


function Functions.voicemail_check(self, caller, phone_number)
  local voicemail_account = nil;
  local voicemail_authorized = false;

  require 'dialplan.voicemail'

  if phone_number then
    voicemail_account = dialplan.voicemail.Voicemail:new{ log = self.log, database = self.database }:find_by_number(phone_number);
  else
    if caller.auth_account_type == 'SipAccount' then
      voicemail_account = dialplan.voicemail.Voicemail:new{ log = self.log, database = self.database }:find_by_sip_account_id(caller.auth_account.id);
      voicemail_authorized = true;
    end
  end

  if not voicemail_account then
    return { continue = false, code = 404, phrase = 'Mailbox not found', no_cdr = true }
  end

  voicemail_account:menu(caller, voicemail_authorized);

  return { continue = false, code = 200, phrase = 'OK', no_cdr = true }
end


function Functions.acd_membership_toggle(self, caller, agent_id, phone_number)
  -- Find caller's SipAccount
  local caller_sip_account = self:ensure_caller_sip_account(caller);
  if not caller_sip_account then
    return { continue = false, code = 403, phrase = 'Incompatible caller', no_cdr = true }
  end

  require 'dialplan.acd'
  local acd_class = dialplan.acd.AutomaticCallDistributor:new{ log = self.log, database = self.database, domain = self.domain };

  self.log:info('ACD_MEMBERSHIP_TOGGLE - sipaccount=', caller_sip_account.id, '/', caller_sip_account.uuid, ', agent=', agent_id, ', ACD phone number: ', phone_number);

  if not tonumber(agent_id) or tonumber(agent_id) == 0 then

    if not phone_number then
      self.log:notice('ACD_MEMBERSHIP_TOGGLE - neither agent_id nor phone_number specified');
      return { continue = false, code = 404, phrase = 'Agent not found', no_cdr = true }
    end

    require "common.phone_number"
    local phone_number_object = common.phone_number.PhoneNumber:new{ log = self.log, database = self.database, domain = caller.domain }:find_by_number(phone_number, {'AutomaticCallDistributor'});

    if not phone_number_object or not tonumber(phone_number_object.record.phone_numberable_id) then
      self.log:notice('ACD_MEMBERSHIP_TOGGLE - ACD not found');
      return { continue = false, code = 404, phrase = 'ACD not found', no_cdr = true }
    end

    local agent = acd_class:agent_find_by_acd_and_destination(phone_number_object.record.phone_numberable_id, caller_sip_account.class, caller_sip_account.id);

    if not agent or not tonumber(agent.id) then
      self.log:notice('ACD_MEMBERSHIP_TOGGLE - agent not found');
      return { continue = false, code = 404, phrase = 'Agent not found', no_cdr = true }
    end

    agent_id = agent.id;
  end

  local status = acd_class:agent_status_toggle(agent_id, 'sipaccount', caller_sip_account.id);

  if not status then
    self.log:error('ACD_MEMBERSHIP_TOGGLE - error toggling ACD membership');
    return { continue = false, code = 500, phrase = 'Error toggling ACD membership', no_cdr = true }
  end

  self.log:info('ACD_MEMBERSHIP_TOGGLE - sipaccount=', caller_sip_account.id, '/', caller_sip_account.uuid, ', agent=', agent_id, ', status: ', status);

  caller:answer();
  caller:send_display('ACD membership toggled: ' .. status);
  caller:sleep(500);
  caller.session:sayPhrase('acd_agent_status', tostring(status));
  return { continue = false, code = 200, phrase = 'OK', no_cdr = true }
end


function Functions.hangup(self, caller, code, phrase)
  require 'common.str'

  if not tonumber(code) then
    code = 403;
    phrase = 'Forbidden';
  end

  if common.str.blank(phrase) then
    phrase = 'Hangup here';
  end

  self.log:info("FUNCTION_HANGUP code: ", code, ', phrase: ', phrase);
  return { continue = false, code = code, phrase = phrase:gsub('_', ' '), no_cdr = true }
end


function Functions.call_parking_inout(self, caller, stall_name, lot_name)
  require 'dialplan.call_parking';
  local parking_stall = dialplan.call_parking.CallParking:new{ log = self.log, database = self.database, caller = caller }:find_by_name(stall_name);
  
  if not parking_stall then
    return { continue = false, code = 404, phrase = 'Parking stall not found', no_cdr = true }
  end

  if lot_name and parking_stall.lot ~= lot_name then
    return { continue = false, code = 404, phrase = 'Parking lot not found', no_cdr = true }
  end

  parking_stall:park_retrieve();

  return { continue = false, code = 200, phrase = 'OK', no_cdr = true }
end


function Functions.call_parking_inout_index(self, caller, stall_index)
  if not tonumber(stall_index) then
    self.log:notice('FUNCTION_CALL_PARKING_INOUT_INDEX - malformed index: ', stall_index);
    return { continue = false, code = 404, phrase = 'No parkings stall specified', no_cdr = true }
  end

  require 'common.str';
  local owner = common.str.try(caller, 'auth_account.owner');
  
  if not owner then
    self.log:notice('FUNCTION_CALL_PARKING_INOUT_INDEX - stall owner not specified');
    return { continue = false, code = 404, phrase = 'No parkings stalls owner' , no_cdr = true }
  end

  require 'dialplan.call_parking';
  local parking_stalls = dialplan.call_parking.CallParking:new{ log = self.log, database = self.database, caller = caller }:find_by_owner(owner.id, owner.class);

  if not parking_stalls or #parking_stalls < 1 then
    self.log:notice('FUNCTION_CALL_PARKING_INOUT_INDEX - no parkings stalls found');
    return { continue = false, code = 404, phrase = 'No parkings stalls', no_cdr = true }
  end

  local parking_stall = parking_stalls[tonumber(stall_index)];

  if not parking_stall then
    self.log:notice('FUNCTION_CALL_PARKING_INOUT_INDEX - no parkings stall found with index: ', stall_index);
    return { continue = false, code = 404, phrase = 'Parking stall not found', no_cdr = true }
  end

  self.log:info('FUNCTION_CALL_PARKING_INOUT_INDEX parking/retrieving call - parkingstall=', parking_stall.id, '/', parking_stall.name, ', index: ', stall_index);
  parking_stall:park_retrieve();

  return { continue = false, code = 200, phrase = 'OK', no_cdr = true }
end