-
Notifications
You must be signed in to change notification settings - Fork 909
/
dialog.c
3746 lines (3323 loc) · 95.1 KB
/
dialog.c
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
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* dialog module - basic support for dialog tracking
*
* Copyright (C) 2006 Voice Sistem SRL
* Copyright (C) 2011 Carsten Bock, carsten@ng-voice.com
*
* This file is part of Kamailio, a free SIP server.
*
* Kamailio is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version
*
* Kamailio is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
*/
/*!
* \file
* \brief Module interface
* \ingroup dialog
* Module: \ref dialog
*/
/**
* @defgroup dialog dialog :: Kamailio dialog module
* @brief Kamailio dialog module
*
* The dialog module provides dialog awareness to the Kamailio proxy. Its
* functionality is to keep track of the current dialogs, to offer
* information about them (like how many dialogs are active) or to manage
* them. The module exports several functions that could be used directly
* from scripts.
* The module, via an internal API, also provide the foundation to build
* on top of it more complex dialog-based functionalities via other
* Kamailio modules.
*/
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <sys/time.h>
#include "../../core/sr_module.h"
#include "../../lib/srdb1/db.h"
#include "../../core/dprint.h"
#include "../../core/error.h"
#include "../../core/ut.h"
#include "../../core/pvar.h"
#include "../../core/mod_fix.h"
#include "../../core/script_cb.h"
#include "../../core/kemi.h"
#include "../../core/fmsg.h"
#include "../../core/hashes.h"
#include "../../core/counters.h"
#include "../../core/mem/mem.h"
#include "../../core/timer_proc.h"
#include "../../core/lvalue.h"
#include "../../core/globals.h"
#include "../../core/parser/parse_to.h"
#include "../../modules/tm/tm_load.h"
#include "../../core/rpc_lookup.h"
#include "../../core/srapi.h"
#include "../rr/api.h"
#include "dlg_hash.h"
#include "dlg_timer.h"
#include "dlg_handlers.h"
#include "dlg_load.h"
#include "dlg_cb.h"
#include "dlg_db_handler.h"
#include "dlg_req_within.h"
#include "dlg_profile.h"
#include "dlg_var.h"
#include "dlg_transfer.h"
#include "dlg_cseq.h"
#include "dlg_dmq.h"
MODULE_VERSION
#define RPC_DATE_BUF_LEN 21
static int mod_init(void);
static int child_init(int rank);
static void mod_destroy(void);
/* module parameter */
static int dlg_hash_size = 4096;
static char *rr_param = "did";
static int dlg_flag = -1;
static str timeout_spec = {NULL, 0};
static int default_timeout = 60 * 60 * 12; /* 12 hours */
static int seq_match_mode = SEQ_MATCH_STRICT_ID;
static char *profiles_wv_s = NULL;
static char *profiles_nv_s = NULL;
str dlg_extra_hdrs = {NULL, 0};
static int db_fetch_rows = 200;
static int db_skip_load = 0;
static int dlg_keep_proxy_rr = 0;
int dlg_filter_mode = 0;
int initial_cbs_inscript = 1;
int dlg_wait_ack = 1;
static int dlg_timer_procs = 0;
static int _dlg_track_cseq_updates = 0;
int dlg_ka_failed_limit = 1;
int dlg_early_timeout = 300;
int dlg_noack_timeout = 60;
int dlg_end_timeout = 300;
int dlg_enable_dmq = 0;
int dlg_event_rt[DLG_EVENTRT_MAX];
str dlg_event_callback = STR_NULL;
str dlg_bridge_controller = str_init("sip:controller@kamailio.org");
str dlg_bridge_contact = str_init("sip:controller@kamailio.org:5060");
int bye_early_code = 480;
str bye_early_reason = str_init("Temporarily Unavailable");
str ruri_pvar_param = str_init("$ru");
pv_elem_t *ruri_param_model = NULL;
str empty_str = STR_NULL;
int dlg_h_id_start = 0;
int dlg_h_id_step = 1;
/* statistic variables */
int dlg_enable_stats = 1;
int detect_spirals = 1;
int dlg_send_bye = 0;
int dlg_timeout_noreset = 0;
stat_var *active_dlgs = 0;
stat_var *processed_dlgs = 0;
stat_var *expired_dlgs = 0;
stat_var *failed_dlgs = 0;
stat_var *early_dlgs = 0;
int debug_variables_list = 0;
struct tm_binds d_tmb;
struct rr_binds d_rrb;
pv_spec_t timeout_avp;
int dlg_db_mode_param = DB_MODE_NONE;
str dlg_xavp_cfg = {0};
int dlg_ka_timer = 0;
int dlg_ka_interval = 0;
int dlg_clean_timer = 90;
int dlg_ctxiuid_mode = 0;
str dlg_lreq_callee_headers = {0};
/* db stuff */
static str db_url = str_init(DEFAULT_DB_URL);
static unsigned int db_update_period = DB_DEFAULT_UPDATE_PERIOD;
static int pv_get_dlg_count(
struct sip_msg *msg, pv_param_t *param, pv_value_t *res);
void dlg_ka_timer_exec(unsigned int ticks, void *param);
void dlg_clean_timer_exec(unsigned int ticks, void *param);
/* commands wrappers and fixups */
static int fixup_profile(void **param, int param_no);
static int fixup_get_profile2(void **param, int param_no);
static int fixup_get_profile3(void **param, int param_no);
static int w_set_dlg_profile(struct sip_msg *, char *, char *);
static int w_unset_dlg_profile(struct sip_msg *, char *, char *);
static int w_is_in_profile(struct sip_msg *, char *, char *);
static int w_get_profile_size2(struct sip_msg *, char *, char *);
static int w_get_profile_size3(struct sip_msg *, char *, char *, char *);
static int w_dlg_isflagset(struct sip_msg *msg, char *flag, str *s2);
static int w_dlg_resetflag(struct sip_msg *msg, char *flag, str *s2);
static int w_dlg_setflag(struct sip_msg *msg, char *flag, char *s2);
static int w_dlg_set_property(struct sip_msg *msg, char *prop, char *s2);
static int w_dlg_reset_property(struct sip_msg *msg, char *prop, char *s2);
static int w_dlg_manage(struct sip_msg *, char *, char *);
static int w_dlg_bye(struct sip_msg *, char *, char *);
static int w_dlg_refer(struct sip_msg *, char *, char *);
static int w_dlg_bridge(struct sip_msg *, char *, char *, char *);
static int w_dlg_set_timeout(struct sip_msg *, char *, char *, char *);
static int w_dlg_set_timeout_by_profile2(struct sip_msg *, char *, char *);
static int w_dlg_set_timeout_by_profile3(
struct sip_msg *, char *, char *, char *);
static int fixup_dlg_bye(void **param, int param_no);
static int fixup_dlg_refer(void **param, int param_no);
static int fixup_dlg_bridge(void **param, int param_no);
static int w_dlg_get(struct sip_msg *, char *, char *, char *);
static int w_is_known_dlg(struct sip_msg *);
static int w_dlg_set_ruri(sip_msg_t *, char *, char *);
static int w_dlg_db_load_callid(sip_msg_t *msg, char *ci, char *p2);
static int w_dlg_db_load_extra(sip_msg_t *msg, char *p1, char *p2);
static int fixup_dlg_get_var(void **param, int param_no);
static int fixup_dlg_get_var_free(void **param, int param_no);
static int w_dlg_get_var(
struct sip_msg *, char *, char *, char *, char *, char *);
static int fixup_dlg_set_var(void **param, int param_no);
static int fixup_dlg_set_var_free(void **param, int param_no);
static int w_dlg_set_var(
struct sip_msg *, char *, char *, char *, char *, char *);
static int w_dlg_remote_profile(sip_msg_t *msg, char *cmd, char *pname,
char *pval, char *puid, char *expires);
static int fixup_dlg_remote_profile(void **param, int param_no);
static int w_dlg_req_with_headers_and_content(
struct sip_msg *, char *, char *, char *, char *, char *);
static int w_dlg_req_with_content(
struct sip_msg *, char *, char *, char *, char *);
static int w_dlg_req_with_headers(struct sip_msg *, char *, char *, char *);
static int w_dlg_req_within(struct sip_msg *, char *, char *);
static int fixup_dlg_dlg_req_within(void **, int);
static int fixup_dlg_req_with_headers(void **, int);
static int fixup_dlg_req_with_content(void **, int);
static int fixup_dlg_req_with_headers_and_content(void **, int);
static cmd_export_t cmds[] = {
{"dlg_manage", (cmd_function)w_dlg_manage, 0, 0, 0, REQUEST_ROUTE},
{"set_dlg_profile", (cmd_function)w_set_dlg_profile, 1, fixup_profile,
0, ANY_ROUTE},
{"set_dlg_profile", (cmd_function)w_set_dlg_profile, 2, fixup_profile,
0, ANY_ROUTE},
{"unset_dlg_profile", (cmd_function)w_unset_dlg_profile, 1,
fixup_profile, 0,
REQUEST_ROUTE | FAILURE_ROUTE | ONREPLY_ROUTE | BRANCH_ROUTE},
{"unset_dlg_profile", (cmd_function)w_unset_dlg_profile, 2,
fixup_profile, 0,
REQUEST_ROUTE | FAILURE_ROUTE | ONREPLY_ROUTE | BRANCH_ROUTE},
{"is_in_profile", (cmd_function)w_is_in_profile, 1, fixup_profile, 0,
ANY_ROUTE},
{"is_in_profile", (cmd_function)w_is_in_profile, 2, fixup_profile, 0,
ANY_ROUTE},
{"get_profile_size", (cmd_function)w_get_profile_size2, 2,
fixup_get_profile2, 0, ANY_ROUTE},
{"get_profile_size", (cmd_function)w_get_profile_size3, 3,
fixup_get_profile3, 0, ANY_ROUTE},
{"dlg_setflag", (cmd_function)w_dlg_setflag, 1, fixup_igp_null, 0,
ANY_ROUTE},
{"dlg_resetflag", (cmd_function)w_dlg_resetflag, 1, fixup_igp_null, 0,
ANY_ROUTE},
{"dlg_isflagset", (cmd_function)w_dlg_isflagset, 1, fixup_igp_null, 0,
ANY_ROUTE},
{"dlg_bye", (cmd_function)w_dlg_bye, 1, fixup_dlg_bye, 0, ANY_ROUTE},
{"dlg_refer", (cmd_function)w_dlg_refer, 2, fixup_dlg_refer, 0,
ANY_ROUTE},
{"dlg_bridge", (cmd_function)w_dlg_bridge, 3, fixup_dlg_bridge, 0,
ANY_ROUTE},
{"dlg_get", (cmd_function)w_dlg_get, 3, fixup_dlg_bridge, 0, ANY_ROUTE},
{"is_known_dlg", (cmd_function)w_is_known_dlg, 0, NULL, 0, ANY_ROUTE},
{"dlg_set_timeout", (cmd_function)w_dlg_set_timeout, 1, fixup_igp_null,
0, ANY_ROUTE},
{"dlg_set_timeout", (cmd_function)w_dlg_set_timeout, 3, fixup_igp_all,
0, ANY_ROUTE},
{"dlg_set_timeout_by_profile",
(cmd_function)w_dlg_set_timeout_by_profile2, 2, fixup_profile,
0, ANY_ROUTE},
{"dlg_set_timeout_by_profile",
(cmd_function)w_dlg_set_timeout_by_profile3, 3, fixup_profile,
0, ANY_ROUTE},
{"dlg_set_property", (cmd_function)w_dlg_set_property, 1,
fixup_spve_null, 0, ANY_ROUTE},
{"dlg_reset_property", (cmd_function)w_dlg_reset_property, 1,
fixup_spve_null, 0, ANY_ROUTE},
{"dlg_remote_profile", (cmd_function)w_dlg_remote_profile, 5,
fixup_dlg_remote_profile, 0, ANY_ROUTE},
{"dlg_set_ruri", (cmd_function)w_dlg_set_ruri, 0, NULL, 0, ANY_ROUTE},
{"dlg_db_load_callid", (cmd_function)w_dlg_db_load_callid, 1,
fixup_spve_null, 0, ANY_ROUTE},
{"dlg_db_load_extra", (cmd_function)w_dlg_db_load_extra, 0, 0, 0,
ANY_ROUTE},
{"dlg_get_var", (cmd_function)w_dlg_get_var, 5, fixup_dlg_get_var,
fixup_dlg_get_var_free, ANY_ROUTE},
{"dlg_set_var", (cmd_function)w_dlg_set_var, 5, fixup_dlg_set_var,
fixup_dlg_set_var_free, ANY_ROUTE},
{"dlg_req_within", (cmd_function)w_dlg_req_within, 2,
fixup_dlg_dlg_req_within, 0, ANY_ROUTE},
{"dlg_req_within", (cmd_function)w_dlg_req_with_headers, 3,
fixup_dlg_req_with_headers, 0, ANY_ROUTE},
{"dlg_req_within", (cmd_function)w_dlg_req_with_content, 4,
fixup_dlg_req_with_content, 0, ANY_ROUTE},
{"dlg_req_within", (cmd_function)w_dlg_req_with_headers_and_content, 5,
fixup_dlg_req_with_headers_and_content, 0, ANY_ROUTE},
{"load_dlg", (cmd_function)load_dlg, 0, 0, 0, 0}, {0, 0, 0, 0, 0, 0}};
static param_export_t mod_params[] = {
{"enable_stats", INT_PARAM, &dlg_enable_stats},
{"hash_size", INT_PARAM, &dlg_hash_size},
{"rr_param", PARAM_STRING, &rr_param},
{"dlg_flag", INT_PARAM, &dlg_flag},
{"timeout_avp", PARAM_STR, &timeout_spec},
{"default_timeout", INT_PARAM, &default_timeout},
{"dlg_extra_hdrs", PARAM_STR, &dlg_extra_hdrs},
{"dlg_match_mode", INT_PARAM, &seq_match_mode},
{
"detect_spirals",
INT_PARAM,
&detect_spirals,
},
{"db_url", PARAM_STR, &db_url},
{"db_mode", INT_PARAM, &dlg_db_mode_param},
{"table_name", PARAM_STR, &dialog_table_name},
{"call_id_column", PARAM_STR, &call_id_column},
{"from_uri_column", PARAM_STR, &from_uri_column},
{"from_tag_column", PARAM_STR, &from_tag_column},
{"to_uri_column", PARAM_STR, &to_uri_column},
{"to_tag_column", PARAM_STR, &to_tag_column},
{"h_id_column", PARAM_STR, &h_id_column},
{"h_entry_column", PARAM_STR, &h_entry_column},
{"state_column", PARAM_STR, &state_column},
{"start_time_column", PARAM_STR, &start_time_column},
{"timeout_column", PARAM_STR, &timeout_column},
{"to_cseq_column", PARAM_STR, &to_cseq_column},
{"from_cseq_column", PARAM_STR, &from_cseq_column},
{"to_route_column", PARAM_STR, &to_route_column},
{"from_route_column", PARAM_STR, &from_route_column},
{"to_contact_column", PARAM_STR, &to_contact_column},
{"from_contact_column", PARAM_STR, &from_contact_column},
{"to_sock_column", PARAM_STR, &to_sock_column},
{"from_sock_column", PARAM_STR, &from_sock_column},
{"sflags_column", PARAM_STR, &sflags_column},
{"toroute_name_column", PARAM_STR, &toroute_name_column},
{"vars_table_name", PARAM_STR, &dialog_vars_table_name},
{"vars_h_id_column", PARAM_STR, &vars_h_id_column},
{"vars_h_entry_column", PARAM_STR, &vars_h_entry_column},
{"vars_key_column", PARAM_STR, &vars_key_column},
{"vars_value_column", PARAM_STR, &vars_value_column},
{"db_update_period", INT_PARAM, &db_update_period},
{"db_fetch_rows", INT_PARAM, &db_fetch_rows},
{"profiles_with_value", PARAM_STRING, &profiles_wv_s},
{"profiles_no_value", PARAM_STRING, &profiles_nv_s},
{"bridge_controller", PARAM_STR, &dlg_bridge_controller},
{"bridge_contact", PARAM_STR, &dlg_bridge_contact},
{"ruri_pvar", PARAM_STR, &ruri_pvar_param},
{"initial_cbs_inscript", INT_PARAM, &initial_cbs_inscript},
{"send_bye", INT_PARAM, &dlg_send_bye},
{"wait_ack", INT_PARAM, &dlg_wait_ack},
{"xavp_cfg", PARAM_STR, &dlg_xavp_cfg},
{"ka_timer", INT_PARAM, &dlg_ka_timer},
{"ka_interval", INT_PARAM, &dlg_ka_interval},
{"timeout_noreset", INT_PARAM, &dlg_timeout_noreset},
{"timer_procs", PARAM_INT, &dlg_timer_procs},
{"track_cseq_updates", PARAM_INT, &_dlg_track_cseq_updates},
{"lreq_callee_headers", PARAM_STR, &dlg_lreq_callee_headers},
{"db_skip_load", INT_PARAM, &db_skip_load},
{"ka_failed_limit", INT_PARAM, &dlg_ka_failed_limit},
{"enable_dmq", INT_PARAM, &dlg_enable_dmq},
{"event_callback", PARAM_STR, &dlg_event_callback},
{"early_timeout", PARAM_INT, &dlg_early_timeout},
{"noack_timeout", PARAM_INT, &dlg_noack_timeout},
{"end_timeout", PARAM_INT, &dlg_end_timeout},
{"h_id_start", PARAM_INT, &dlg_h_id_start},
{"h_id_step", PARAM_INT, &dlg_h_id_step},
{"keep_proxy_rr", INT_PARAM, &dlg_keep_proxy_rr},
{"dlg_filter_mode", INT_PARAM, &dlg_filter_mode},
{"bye_early_code", PARAM_INT, &bye_early_code},
{"bye_early_reason", PARAM_STR, &bye_early_reason},
{"dlg_ctxiuid_mode", PARAM_INT, &dlg_ctxiuid_mode},
{"debug_variables", PARAM_INT, &debug_variables_list},
{0, 0, 0}};
static stat_export_t mod_stats[] = {
{"active_dialogs", STAT_NO_RESET, &active_dlgs},
{"early_dialogs", STAT_NO_RESET, &early_dlgs},
{"processed_dialogs", 0, &processed_dlgs},
{"expired_dialogs", 0, &expired_dlgs},
{"failed_dialogs", 0, &failed_dlgs}, {0, 0, 0}};
static rpc_export_t rpc_methods[];
static pv_export_t mod_items[] = {
{{"DLG_count", sizeof("DLG_count") - 1}, PVT_OTHER, pv_get_dlg_count, 0,
0, 0, 0, 0},
{{"DLG_lifetime", sizeof("DLG_lifetime") - 1}, PVT_OTHER,
pv_get_dlg_lifetime, 0, 0, 0, 0, 0},
{{"DLG_status", sizeof("DLG_status") - 1}, PVT_OTHER, pv_get_dlg_status,
0, 0, 0, 0, 0},
{{"dlg_ctx", sizeof("dlg_ctx") - 1}, PVT_OTHER, pv_get_dlg_ctx,
pv_set_dlg_ctx, pv_parse_dlg_ctx_name, 0, 0, 0},
{{"dlg", sizeof("dlg") - 1}, PVT_OTHER, pv_get_dlg, 0,
pv_parse_dlg_name, 0, 0, 0},
{{"dlg_var", sizeof("dlg_var") - 1}, PVT_OTHER, pv_get_dlg_variable,
pv_set_dlg_variable, pv_parse_dialog_var_name, 0, 0, 0},
{{0, 0}, 0, 0, 0, 0, 0, 0, 0}};
struct module_exports exports = {"dialog", /* module's name */
DEFAULT_DLFLAGS, /* dlopen flags */
cmds, /* exported functions */
mod_params, /* param exports */
0, /* exported RPC methods */
mod_items, /* exported pseudo-variables */
0, /* reply processing function */
mod_init, /* module initialization function */
child_init, /* per-child init function */
mod_destroy};
static int fixup_profile(void **param, int param_no)
{
struct dlg_profile_table *profile;
pv_elem_t *model = NULL;
str s;
s.s = (char *)(*param);
s.len = strlen(s.s);
if(s.len == 0) {
LM_ERR("param %d is empty string!\n", param_no);
return E_CFG;
}
if(param_no == 1) {
profile = search_dlg_profile(&s);
if(profile == NULL) {
LM_CRIT("profile <%s> not defined\n", s.s);
return E_CFG;
}
pkg_free(*param);
*param = (void *)profile;
return 0;
} else if(param_no == 2) {
if(pv_parse_format(&s, &model) || model == NULL) {
LM_ERR("wrong format [%s] for value param!\n", s.s);
return E_CFG;
}
*param = (void *)model;
}
return 0;
}
static int fixup_get_profile2(void **param, int param_no)
{
pv_spec_t *sp;
int ret;
if(param_no == 1) {
return fixup_profile(param, 1);
} else if(param_no == 2) {
ret = fixup_pvar_null(param, 1);
if(ret < 0)
return ret;
sp = (pv_spec_t *)(*param);
if(sp->type != PVT_AVP && sp->type != PVT_SCRIPTVAR) {
LM_ERR("return must be an AVP or SCRIPT VAR!\n");
return E_SCRIPT;
}
}
return 0;
}
static int fixup_get_profile3(void **param, int param_no)
{
if(param_no == 1) {
return fixup_profile(param, 1);
} else if(param_no == 2) {
return fixup_profile(param, 2);
} else if(param_no == 3) {
return fixup_get_profile2(param, 2);
}
return 0;
}
int load_dlg(struct dlg_binds *dlgb)
{
dlgb->register_dlgcb = register_dlgcb;
dlgb->terminate_dlg = dlg_bye_all;
dlgb->set_dlg_var = set_dlg_variable;
dlgb->get_dlg_varref = get_dlg_varref;
dlgb->get_dlg_varval = get_dlg_varval;
dlgb->get_dlg_vardup = get_dlg_vardup;
dlgb->get_dlg_varstatus = get_dlg_varstatus;
dlgb->get_dlg = dlg_get_msg_dialog;
dlgb->release_dlg = dlg_release;
return 1;
}
static int pv_get_dlg_count(
struct sip_msg *msg, pv_param_t *param, pv_value_t *res)
{
int n;
int l;
char *ch;
if(msg == NULL || res == NULL)
return -1;
n = active_dlgs ? get_stat_val(active_dlgs) : 0;
l = 0;
ch = int2str(n, &l);
res->rs.s = ch;
res->rs.len = l;
res->ri = n;
res->flags = PV_VAL_STR | PV_VAL_INT | PV_TYPE_INT;
return 0;
}
static int mod_init(void)
{
unsigned int n;
sr_cfgenv_t *cenv = NULL;
if(dlg_h_id_start == -1) {
dlg_h_id_start = server_id;
} else if(dlg_h_id_start < 0) {
dlg_h_id_start = 0;
}
if(dlg_h_id_step < 1) {
dlg_h_id_step = 1;
}
if(dlg_ka_interval != 0 && dlg_ka_interval < 30) {
LM_ERR("ka interval too low (%d), has to be at least 30\n",
dlg_ka_interval);
return -1;
}
dlg_event_rt[DLG_EVENTRT_START] = route_lookup(&event_rt, "dialog:start");
dlg_event_rt[DLG_EVENTRT_END] = route_lookup(&event_rt, "dialog:end");
dlg_event_rt[DLG_EVENTRT_FAILED] = route_lookup(&event_rt, "dialog:failed");
#ifdef STATISTICS
/* register statistics */
if(dlg_enable_stats
&& (register_module_stats(exports.name, mod_stats) != 0)) {
LM_ERR("failed to register %s statistics\n", exports.name);
return -1;
}
#endif
if(rpc_register_array(rpc_methods) != 0) {
LM_ERR("failed to register RPC commands\n");
return -1;
}
if(faked_msg_init() < 0)
return -1;
if(dlg_bridge_init_hdrs() < 0)
return -1;
/* param checkings */
if(dlg_flag != -1 && dlg_flag > MAX_FLAG) {
LM_ERR("invalid dlg flag %d!!\n", dlg_flag);
return -1;
}
if(rr_param == 0 || rr_param[0] == 0) {
LM_ERR("empty rr_param!!\n");
return -1;
} else if(strlen(rr_param) > MAX_DLG_RR_PARAM_NAME) {
LM_ERR("rr_param too long (max=%d)!!\n", MAX_DLG_RR_PARAM_NAME);
return -1;
}
if(dlg_keep_proxy_rr < 0 || dlg_keep_proxy_rr > 3) {
LM_ERR("invalid value for keep_proxy_rr\n");
return -1;
}
if(timeout_spec.s) {
if(pv_parse_spec(&timeout_spec, &timeout_avp) == 0
&& (timeout_avp.type != PVT_AVP)) {
LM_ERR("malformed or non AVP timeout "
"AVP definition in '%.*s'\n",
timeout_spec.len, timeout_spec.s);
return -1;
}
}
if(default_timeout <= 0) {
LM_ERR("0 default_timeout not accepted!!\n");
return -1;
}
if(ruri_pvar_param.s == NULL || ruri_pvar_param.len <= 0) {
LM_ERR("invalid r-uri PV string\n");
return -1;
}
if(pv_parse_format(&ruri_pvar_param, &ruri_param_model) < 0
|| ruri_param_model == NULL) {
LM_ERR("malformed r-uri PV string: %s\n", ruri_pvar_param.s);
return -1;
}
if(initial_cbs_inscript != 0 && initial_cbs_inscript != 1) {
LM_ERR("invalid parameter for running initial callbacks in-script"
" (must be either 0 or 1)\n");
return -1;
}
if(seq_match_mode != SEQ_MATCH_NO_ID && seq_match_mode != SEQ_MATCH_FALLBACK
&& seq_match_mode != SEQ_MATCH_STRICT_ID) {
LM_ERR("invalid value %d for seq_match_mode param!!\n", seq_match_mode);
return -1;
}
if(detect_spirals != 0 && detect_spirals != 1) {
LM_ERR("invalid value %d for detect_spirals param!!\n", detect_spirals);
return -1;
}
if(dlg_timeout_noreset != 0 && dlg_timeout_noreset != 1) {
LM_ERR("invalid value %d for timeout_noreset param!!\n",
dlg_timeout_noreset);
return -1;
}
/* create profile hashes */
if(add_profile_definitions(profiles_nv_s, 0) != 0) {
LM_ERR("failed to add profiles without value\n");
return -1;
}
if(add_profile_definitions(profiles_wv_s, 1) != 0) {
LM_ERR("failed to add profiles with value\n");
return -1;
}
/* load the TM API */
if(load_tm_api(&d_tmb) != 0) {
LM_ERR("can't load TM API\n");
return -1;
}
/* load RR API also */
if(load_rr_api(&d_rrb) != 0) {
LM_ERR("can't load RR API\n");
return -1;
}
/* register callbacks*/
/* listen for all incoming requests */
if(d_tmb.register_tmcb(0, 0, TMCB_REQUEST_IN, dlg_onreq, 0, 0) <= 0) {
LM_ERR("cannot register TMCB_REQUEST_IN callback\n");
return -1;
}
/* listen for all routed requests */
if(d_rrb.register_rrcb(dlg_onroute, 0) < 0) {
LM_ERR("cannot register RR callback\n");
return -1;
}
if(register_script_cb(profile_cleanup, POST_SCRIPT_CB | REQUEST_CB, 0)
< 0) {
LM_ERR("cannot register script callback");
return -1;
}
if(register_script_cb(dlg_cfg_cb, PRE_SCRIPT_CB | REQUEST_CB, 0) < 0) {
LM_ERR("cannot register pre-script ctx callback\n");
return -1;
}
if(register_script_cb(dlg_cfg_cb, POST_SCRIPT_CB | REQUEST_CB, 0) < 0) {
LM_ERR("cannot register post-script ctx callback\n");
return -1;
}
if(register_script_cb(spiral_detect_reset, POST_SCRIPT_CB | REQUEST_CB, 0)
< 0) {
LM_ERR("cannot register req pre-script spiral detection reset "
"callback\n");
return -1;
}
if(register_script_cb(cb_dlg_locals_reset, POST_SCRIPT_CB | ONREPLY_CB, 0)
< 0) {
LM_ERR("cannot register reply post-script dlg locals reset callback\n");
return -1;
}
if(register_script_cb(cb_dlg_locals_reset, POST_SCRIPT_CB | FAILURE_CB, 0)
< 0) {
LM_ERR("cannot register failure post-script dlg locals reset "
"callback\n");
return -1;
}
if(dlg_timer_procs <= 0) {
if(register_timer(dlg_timer_routine, 0, 1) < 0) {
LM_ERR("failed to register timer \n");
return -1;
}
} else {
register_sync_timers(1);
}
/* init handlers */
init_dlg_handlers(rr_param, dlg_flag, timeout_spec.s ? &timeout_avp : 0,
default_timeout, seq_match_mode, dlg_keep_proxy_rr);
/* init timer */
if(init_dlg_timer(dlg_ontimeout) != 0) {
LM_ERR("cannot init timer list\n");
return -1;
}
/* sanitize dlg_hash_zie */
if(dlg_hash_size < 1) {
LM_WARN("hash_size is smaller "
"then 1 -> rounding from %d to 1\n",
dlg_hash_size);
dlg_hash_size = 1;
}
/* initialized the hash table */
for(n = 0; n < (8 * sizeof(n)); n++) {
if(dlg_hash_size == (1 << n))
break;
if(n && dlg_hash_size < (1 << n)) {
LM_WARN("hash_size is not a power "
"of 2 as it should be -> rounding from %d to %d\n",
dlg_hash_size, 1 << (n - 1));
dlg_hash_size = 1 << (n - 1);
}
}
if(init_dlg_table(dlg_hash_size) < 0) {
LM_ERR("failed to create hash table\n");
return -1;
}
/* if a database should be used to store the dialogs' information */
dlg_db_mode = dlg_db_mode_param;
if(dlg_db_mode == DB_MODE_NONE) {
db_url.s = 0;
db_url.len = 0;
} else {
if(dlg_db_mode != DB_MODE_REALTIME && dlg_db_mode != DB_MODE_DELAYED
&& dlg_db_mode != DB_MODE_SHUTDOWN) {
LM_ERR("unsupported db_mode %d\n", dlg_db_mode);
return -1;
}
if(!db_url.s || db_url.len == 0) {
LM_ERR("db_url not configured for db_mode %d\n", dlg_db_mode);
return -1;
}
if(init_dlg_db(&db_url, dlg_hash_size, db_update_period, db_fetch_rows,
db_skip_load)
!= 0) {
LM_ERR("failed to initialize the DB support\n");
return -1;
}
}
/* timer process to send keep alive requests */
if(dlg_ka_timer > 0 && dlg_ka_interval > 0)
register_sync_timers(1);
/* timer process to clean old unconfirmed dialogs */
register_sync_timers(1);
if(_dlg_track_cseq_updates != 0) {
cenv = sr_cfgenv_get();
cenv->cb_cseq_update = dlg_cseq_update;
dlg_register_cseq_callbacks();
}
if(dlg_enable_dmq > 0 && dlg_dmq_initialize() != 0) {
LM_ERR("failed to initialize dmq integration\n");
return -1;
}
if(dlg_db_mode == DB_MODE_SHUTDOWN) {
ksr_module_set_flag(KSRMOD_FLAG_POSTCHILDINIT);
}
return 0;
}
static int child_init(int rank)
{
dlg_db_mode = dlg_db_mode_param;
if(rank == PROC_INIT) {
if(dlg_db_mode != DB_MODE_NONE) {
run_load_callbacks();
}
}
if(rank == PROC_MAIN) {
if(dlg_timer_procs > 0) {
if(fork_sync_timer(PROC_TIMER, "Dialog Main Timer",
1 /*socks flag*/, dlg_timer_routine, NULL,
1 /*every sec*/)
< 0) {
LM_ERR("failed to start main timer routine as process\n");
return -1; /* error */
}
}
if(dlg_ka_timer > 0 && dlg_ka_interval > 0) {
if(fork_sync_timer(PROC_TIMER, "Dialog KA Timer", 1 /*socks flag*/,
dlg_ka_timer_exec, NULL, dlg_ka_timer /*sec*/)
< 0) {
LM_ERR("failed to start ka timer routine as process\n");
return -1; /* error */
}
}
if(fork_sync_timer(PROC_TIMER, "Dialog Clean Timer", 1 /*socks flag*/,
dlg_clean_timer_exec, NULL, dlg_clean_timer /*sec*/)
< 0) {
LM_ERR("failed to start clean timer routine as process\n");
return -1; /* error */
}
}
if(((dlg_db_mode == DB_MODE_REALTIME || dlg_db_mode == DB_MODE_DELAYED)
&& (rank > 0 || rank == PROC_TIMER || rank == PROC_RPC))
|| (dlg_db_mode == DB_MODE_SHUTDOWN
&& (rank == PROC_POSTCHILDINIT))) {
if(dlg_connect_db(&db_url)) {
LM_ERR("failed to connect to database (rank=%d)\n", rank);
return -1;
}
}
/* in DB_MODE_SHUTDOWN only PROC_MAIN will do a DB dump at the end, so
* for the rest of the processes will be the same as DB_MODE_NONE */
if(dlg_db_mode == DB_MODE_SHUTDOWN && rank != PROC_POSTCHILDINIT)
dlg_db_mode = DB_MODE_NONE;
/* in DB_MODE_REALTIME and DB_MODE_DELAYED the PROC_MAIN have no DB handle */
if((dlg_db_mode == DB_MODE_REALTIME || dlg_db_mode == DB_MODE_DELAYED)
&& rank == PROC_MAIN)
dlg_db_mode = DB_MODE_NONE;
return 0;
}
static void mod_destroy(void)
{
if(dlg_db_mode == DB_MODE_DELAYED || dlg_db_mode == DB_MODE_SHUTDOWN) {
dialog_update_db(0, 0);
destroy_dlg_db();
}
dlg_bridge_destroy_hdrs();
/* no DB interaction from now on */
dlg_db_mode = DB_MODE_NONE;
destroy_dlg_table();
destroy_dlg_timer();
destroy_dlg_callbacks(DLGCB_CREATED | DLGCB_LOADED);
destroy_dlg_handlers();
destroy_dlg_profiles();
}
static int w_set_dlg_profile_helper(
sip_msg_t *msg, struct dlg_profile_table *profile, str *value)
{
if(profile->has_value) {
if(value == NULL || value->len <= 0) {
LM_ERR("invalid value parameter\n");
return -1;
}
if(set_dlg_profile(msg, value, profile) < 0) {
LM_ERR("failed to set profile with key\n");
return -1;
}
} else {
if(set_dlg_profile(msg, NULL, profile) < 0) {
LM_ERR("failed to set profile\n");
return -1;
}
}
return 1;
}
static int w_set_dlg_profile(struct sip_msg *msg, char *profile, char *value)
{
pv_elem_t *pve = NULL;
str val_s = STR_NULL;
pve = (pv_elem_t *)value;
if(pve != NULL) {
if(pv_printf_s(msg, pve, &val_s) != 0 || val_s.len <= 0
|| val_s.s == NULL) {
LM_WARN("cannot get string for value\n");
return -1;
}
}
return w_set_dlg_profile_helper(
msg, (struct dlg_profile_table *)profile, &val_s);
}
static int w_unset_dlg_profile_helper(
sip_msg_t *msg, struct dlg_profile_table *profile, str *value)
{
if(profile->has_value) {
if(value == NULL || value->len <= 0) {
LM_ERR("invalid value parameter\n");
return -1;
}
if(unset_dlg_profile(msg, value, profile) < 0) {
LM_ERR("failed to unset profile with key\n");
return -1;
}
} else {
if(unset_dlg_profile(msg, NULL, profile) < 0) {
LM_ERR("failed to unset profile\n");
return -1;
}
}
return 1;
}
static int w_unset_dlg_profile(struct sip_msg *msg, char *profile, char *value)
{
pv_elem_t *pve = NULL;
str val_s = STR_NULL;
pve = (pv_elem_t *)value;
if(pve != NULL) {
if(pv_printf_s(msg, pve, &val_s) != 0 || val_s.len <= 0
|| val_s.s == NULL) {
LM_WARN("cannot get string for value\n");
return -1;
}
}
return w_unset_dlg_profile_helper(
msg, (struct dlg_profile_table *)profile, &val_s);
}
static int w_is_in_profile_helper(
sip_msg_t *msg, struct dlg_profile_table *profile, str *value)
{
if(profile->has_value) {
if(value == NULL || value->len <= 0) {
LM_ERR("invalid value parameter\n");
return -1;
}
return is_dlg_in_profile(msg, profile, value);
} else {
return is_dlg_in_profile(msg, profile, NULL);
}
}
static int w_is_in_profile(struct sip_msg *msg, char *profile, char *value)
{
pv_elem_t *pve = NULL;
str val_s = STR_NULL;
pve = (pv_elem_t *)value;
if(pve != NULL) {
if(pv_printf_s(msg, pve, &val_s) != 0 || val_s.len <= 0
|| val_s.s == NULL) {
LM_WARN("cannot get string for value\n");
return -1;
}
}
return w_is_in_profile_helper(
msg, (struct dlg_profile_table *)profile, &val_s);
}
/**
* get dynamic name profile size
*/
static int w_get_profile_size_helper(sip_msg_t *msg,
struct dlg_profile_table *profile, str *value, pv_spec_t *spd)
{
unsigned int size;
pv_value_t val;
if(profile->has_value) {
if(value == NULL || value->s == NULL || value->len <= 0) {
LM_ERR("invalid value parameter\n");
return -1;
}
size = get_profile_size(profile, value);
} else {
size = get_profile_size(profile, NULL);
}
memset(&val, 0, sizeof(pv_value_t));