-
Notifications
You must be signed in to change notification settings - Fork 191
/
Copy pathnua_session.c
4789 lines (4087 loc) · 143 KB
/
nua_session.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
/*
* This file is part of the Sofia-SIP package
*
* Copyright (C) 2006 Nokia Corporation.
*
* Contact: Pekka Pessi <pekka.pessi@nokia.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA
*
*/
/**@CFILE nua_session.c
* @brief SIP session handling
*
* @author Pekka Pessi <Pekka.Pessi@nokia.com>
*
* @date Created: Wed Mar 8 16:17:27 EET 2006 ppessi
*/
#include "config.h"
#include <stddef.h>
#include <stdlib.h>
#include <string.h>
#include <limits.h>
#include <assert.h>
#include <sofia-sip/su_string.h>
#include <sofia-sip/sip_protos.h>
#include <sofia-sip/sip_status.h>
#include <sofia-sip/sip_util.h>
#include <sofia-sip/su_uniqueid.h>
#include <sofia-sip/msg_mime_protos.h>
#define NTA_INCOMING_MAGIC_T struct nua_server_request
#define NTA_OUTGOING_MAGIC_T struct nua_client_request
#define NTA_RELIABLE_MAGIC_T struct nua_server_request
#include "nua_stack.h"
#include <sofia-sip/soa.h>
#ifndef SDP_H
typedef struct sdp_session_s sdp_session_t;
#endif
/* ---------------------------------------------------------------------- */
/** @enum nua_callstate
The states for SIP session established with INVITE.
Initially the call states follow the state of the INVITE transaction. If the
initial INVITE transaction fails, the call is terminated. The status codes
401 and 407 are an exception: if the client (on the left side in the diagram
below) receives them, it enters in #nua_callstate_authenticating state.
If a re-INVITE transaction fails, the result depends on the status code in
failure. The call can return to the ready state, be terminated immediately,
or be terminated gracefully. The proper action to take is determined with
sip_response_terminates_dialog().
@sa @ref nua_call_model, #nua_i_state, nua_invite(), #nua_i_invite
@par Session State Diagram
@code
+----------+
| |---------------------+
| Init | |
| |----------+ |
+----------+ | |
| | | |
--/INVITE| |INVITE/100 | |
V V | |
+----------+ +----------+ | |
+--------| | | | | |
| 18X +-| Calling | | Received | |INVITE/ |
| /- | | | | | | /18X |
| V +----------+ +----------+ V |
| +----------+ | | | +----------+ |
|---| | |2XX -/ | -/ | | | |
| | Proceed- | | /- 2XX| 18X| | Early | |INVITE/
| | ing | | | +->| | | /200
| +----------+ V V +----------+ |
| | +----------+ +----------+ | -/ |
| 2XX| | | | |<--+ 2XX |
| /-| | Complet- | | Complete |<-----------+
| +->| ing | | |------+
| +----------+ +----------+ |
| | | | |
|401,407/ -/ACK| |ACK/- |timeout/ |
| /ACK V V | /BYE |
| +----------+ | |
| | | | |
| +--| Ready | | |
| | | | | |
| | +----------+ | |
| | | | |
| BYE/ | |-/BYE | |BYE/
V /200 | V | |/200
+----------+ | +----------+ | |
| | | | | | |
|Authentic-| | | Terminat-|<----+ |
| ating | | | ing | |
+----------+ | +----------+ |
| | |
| |[23456]XX/- |
| V |
| +----------+ |
| | | |
+->|Terminated|<--------------+
| |
+----------+
|
V
+----------+
| |
| Init |
| |
+----------+
@endcode
*/
/* ---------------------------------------------------------------------- */
/* Session event usage */
/** @internal @brief Session-related state. */
typedef struct nua_session_usage
{
enum nua_callstate ss_state; /**< Session status (enum nua_callstate) */
unsigned ss_100rel:1; /**< Use 100rel, send 183 */
unsigned ss_alerting:1; /**< 180 is sent/received */
unsigned ss_update_needed:2; /**< Send an UPDATE (do O/A if > 1) */
unsigned ss_precondition:1; /**< Precondition required */
unsigned ss_reporting:1; /**< True if reporting state */
unsigned : 0;
struct session_timer {
unsigned interval; /**< Negotiated expiration time */
enum nua_session_refresher refresher; /**< Our Negotiated role */
struct {
unsigned expires, defaults; /**< Value of Session-Expires (delta) */
unsigned min_se; /**< Minimum session expires */
/** none, local or remote */
enum nua_session_refresher refresher;
unsigned supported:1, require:1, :0;
} local, remote;
unsigned timer_set:1; /**< We have active session timer. */
} ss_timer[1];
char const *ss_reason; /**< Reason for termination. */
/* Offer-Answer status */
char const *ss_oa_recv, *ss_oa_sent;
/**< Version of user SDP from latest successful O/A */
int ss_sdp_version;
} nua_session_usage_t;
static char const Offer[] = "offer", Answer[] = "answer";
static char const *nua_session_usage_name(nua_dialog_usage_t const *du);
static int nua_session_usage_add(nua_handle_t *nh,
nua_dialog_state_t *ds,
nua_dialog_usage_t *du);
static void nua_session_usage_remove(nua_handle_t *nh,
nua_dialog_state_t *ds,
nua_dialog_usage_t *du,
nua_client_request_t *cr,
nua_server_request_t *sr);
static void nua_session_usage_refresh(nua_owner_t *,
nua_dialog_state_t *,
nua_dialog_usage_t *,
sip_time_t now);
static int nua_session_usage_shutdown(nua_owner_t *,
nua_dialog_state_t *,
nua_dialog_usage_t *);
static void signal_call_state_change(nua_handle_t *nh,
nua_session_usage_t *ss,
int status, char const *phrase,
enum nua_callstate next_state);
static int nua_invite_client_should_ack(nua_client_request_t const *cr);
static int nua_invite_client_ack(nua_client_request_t *cr, tagi_t const *tags);
static int nua_invite_client_complete(nua_client_request_t *cr);
static nua_usage_class const nua_session_usage[1] = {
{
sizeof (nua_session_usage_t),
sizeof nua_session_usage,
nua_session_usage_add,
nua_session_usage_remove,
nua_session_usage_name,
nua_base_usage_update_params,
NULL,
nua_session_usage_refresh,
nua_session_usage_shutdown
}};
static char const *nua_session_usage_name(nua_dialog_usage_t const *du)
{
return "session";
}
static
int nua_session_usage_add(nua_handle_t *nh,
nua_dialog_state_t *ds,
nua_dialog_usage_t *du)
{
nua_session_usage_t *ss = NUA_DIALOG_USAGE_PRIVATE(du);
if (ds->ds_has_session)
return -1;
ds->ds_has_session = 1;
ds->ds_got_session = 1;
ss->ss_timer->local.refresher = nua_any_refresher;
ss->ss_timer->remote.refresher = nua_any_refresher;
return 0;
}
static
void nua_session_usage_remove(nua_handle_t *nh,
nua_dialog_state_t *ds,
nua_dialog_usage_t *du,
nua_client_request_t *cr0,
nua_server_request_t *sr0)
{
nua_session_usage_t *ss = NUA_DIALOG_USAGE_PRIVATE(du);
nua_client_request_t *cr, *cr_next;
nua_server_request_t *sr;
/* Destroy queued INVITE transactions */
for (cr = ds->ds_cr; cr; cr = cr_next) {
cr_next = cr->cr_next;
if (cr->cr_method != sip_method_invite)
continue;
if (cr == cr0)
continue;
nua_client_request_ref(cr);
if (nua_invite_client_should_ack(cr)) {
ss->ss_reporting = 1;
nua_invite_client_ack(cr, NULL);
ss->ss_reporting = 0;
}
if (cr == du->du_cr && cr->cr_orq) {
nua_client_request_unref(cr);
continue;
}
if (cr->cr_status < 200) {
nua_stack_event(nh->nh_nua, nh,
NULL,
(enum nua_event_e)cr->cr_event,
SIP_481_NO_TRANSACTION,
NULL);
}
nua_client_request_remove(cr);
nua_client_request_unref(cr);
cr_next = ds->ds_cr;
}
if (ss->ss_state != nua_callstate_terminated &&
ss->ss_state != nua_callstate_init &&
!ss->ss_reporting) {
int status = 0; char const *phrase = "Terminated";
if (cr0)
status = cr0->cr_status, phrase = cr0->cr_phrase ? cr0->cr_phrase : phrase;
else if (sr0)
status = sr0->sr_status, phrase = sr0->sr_phrase;
signal_call_state_change(nh, ss, status, phrase, nua_callstate_terminated);
}
/* Application can respond to BYE after the session usage has terminated */
for (sr = ds->ds_sr; sr; sr = sr->sr_next) {
if (sr->sr_usage == du && sr->sr_method == sip_method_bye)
sr->sr_usage = NULL;
}
ds->ds_has_session = 0;
nh->nh_has_invite = 0;
nh->nh_active_call = 0;
nh->nh_hold_remote = 0;
if (nh->nh_soa)
soa_destroy(nh->nh_soa), nh->nh_soa = NULL;
}
static
nua_dialog_usage_t *nua_dialog_usage_for_session(nua_dialog_state_t const *ds)
{
if (ds == ((nua_handle_t *)NULL)->nh_ds)
return NULL;
return nua_dialog_usage_get(ds, nua_session_usage, NULL);
}
static
nua_session_usage_t *nua_session_usage_for_dialog(nua_dialog_state_t const *ds)
{
nua_dialog_usage_t *du;
if (ds == ((nua_handle_t *)NULL)->nh_ds)
return NULL;
du = nua_dialog_usage_get(ds, nua_session_usage, NULL);
return (nua_session_usage_t *)nua_dialog_usage_private(du);
}
/** Zap the session associated with the handle */
static
void nua_session_usage_destroy(nua_handle_t *nh,
nua_session_usage_t *ss)
{
/* Remove usage */
nua_dialog_usage_remove(nh, nh->nh_ds, nua_dialog_usage_public(ss), NULL, NULL);
SU_DEBUG_5(("nua: terminated session %p\n", (void *)nh));
}
/* ======================================================================== */
/* INVITE and call (session) processing */
static int session_timer_is_supported(struct session_timer const *t);
static void session_timer_preferences(struct session_timer *t,
sip_t const *sip,
sip_supported_t const *supported,
unsigned expires, int isset,
enum nua_session_refresher refresher,
unsigned min_se);
static void session_timer_store(struct session_timer *t,
sip_t const *sip);
static int session_timer_check_min_se(msg_t *msg, sip_t *sip,
sip_t const *request,
unsigned long min_se);
static int session_timer_add_headers(struct session_timer *t,
int initial,
msg_t *msg, sip_t *sip,
nua_handle_t *nh);
static void session_timer_negotiate(struct session_timer *t, int uas);
static void session_timer_set(nua_session_usage_t *ss, int uas);
static int session_timer_check_restart(nua_client_request_t *cr,
int status, char const *phrase,
sip_t const *sip);
static int nh_referral_check(nua_handle_t *nh, tagi_t const *tags);
static void nh_referral_respond(nua_handle_t *,
int status, char const *phrase);
static
int session_get_description(sip_t const *sip,
char const **return_sdp,
size_t *return_len);
static
int session_include_description(soa_session_t *soa,
int session,
msg_t *msg,
sip_t *sip);
static
int session_make_description(su_home_t *home,
soa_session_t *soa,
int session,
sip_content_disposition_t **return_cd,
sip_content_type_t **return_ct,
sip_payload_t **return_pl);
static
int nua_server_retry_after(nua_server_request_t *sr,
int status, char const *phrase,
int min, int max);
/**@fn void nua_invite(nua_handle_t *nh, tag_type_t tag, tag_value_t value, ...);
*
* Place a call using SIP @b INVITE method.
*
* The INVITE method is used to initiate a call between two parties. The
* call is also known as <i>SIP session</i>.
*
* At SIP level the session is represented as @e Dialog, which is a
* peer-to-peer association between two SIP User-Agents. The dialog is
* established by a successful 2XX response to the INVITE. The dialog is
* terminated by BYE transaction, which application can initiate with
* nua_bye() call.
*
* An @e early @e dialog is established by an preliminary response
* (101..199), such as <i>180 Ringing</i>. An early dialog is terminated
* with an error response with response code in range 300...699.
*
* The media session belonging to the SIP session is usually represented by
* SDP, Session Description Protocol. The media session it is usually
* established during the call set-up with procedure known as SDP
* Offer/Answer exchange, defined by @RFC3264. See <b>Media Session
* Handling</b> below for details.
*
* @param nh Pointer to operation handle
* @param tag, value, ... List of tagged parameters
*
* @return
* nothing
*
* @par Events:
* #nua_r_invite \n
* #nua_i_state (#nua_i_active, #nua_i_terminated) \n
* #nua_i_media_error \n
* #nua_i_fork \n
*
* @par Tags:
* NUTAG_AUTH_CACHE() \n
* NUTAG_AUTOACK() \n
* NUTAG_AUTOANSWER() \n
* NUTAG_EARLY_MEDIA() \n
* NUTAG_ENABLEINVITE() \n
* NUTAG_INITIAL_ROUTE(), NUTAG_INITIAL_ROUTE_STR() \n
* NUTAG_INVITE_TIMER() \n
* NUTAG_MEDIA_ENABLE() \n
* NUTAG_MEDIA_FEATURES() \n
* NUTAG_MIN_SE() \n
* NUTAG_RETRY_COUNT() \n
* NUTAG_SERVICE_ROUTE_ENABLE() \n
* NUTAG_SESSION_REFRESHER() \n
* NUTAG_SESSION_TIMER() \n
* NUTAG_SOA_NAME() \n
* NUTAG_UPDATE_REFRESH() \n
*
* @par Populating SIP Request Message with Tagged Arguments
* The tagged arguments can be used to pass values for any SIP headers to
* the stack. When the INVITE message (or any other SIP message) is created,
* the tagged values saved with nua_handle() are used first, next the tagged
* values given with the operation (nua_invite()) are added.
*
* @par
* When multiple tags for the same header are specified, the behaviour
* depends on the header type. If only a single header field can be included
* in a SIP message, the latest non-NULL value is used, e.g., @Subject.
* However, if the SIP header can consist of multiple lines or header fields
* separated by comma, e.g., @Accept, all the tagged
* values are concatenated.
*
* @par
* However, if a tag value is #SIP_NONE (-1 casted as a void pointer), the
* values from previous tags are ignored.
*
* @par
* Next, values previously set with nua_set_params() or nua_set_hparams()
* are used: @Allow, @Supported, @Organization, and @UserAgent headers are
* added to the request if they are not already set.
*
* @par
* Now, the target URI for the request needs to be determined.
*
* @par
* For initial INVITE requests, values from tags are used. If NUTAG_URL() is
* given, it is used as target URI. Otherwise, if SIPTAG_TO() is given, it
* is used as target URI. If neither is given, the complete request line
* already specified using SIPTAG_REQUEST() or SIPTAG_REQUEST_STR() is used.
* If none of the tags above are given, an internal error is returned to the
* application. At this point, the target URI is stored in the request line,
* together with method name ("INVITE") and protocol version ("SIP/2.0").
* The initial dialog information is also created: @CallID, @CSeq headers
* are generated, if they do not exist, and an unique tag is added to @From
* header.
*
* @par
* For the initial INVITE requests, the @Route headers specified by
* SIPTAG_ROUTE()/SIPTAG_ROUTER_STR() tags in nua_handle() and nua_invite()
* calls are inserted to the request. Next the initial route set specified
* by NUTAG_INITIAL_ROUTE()/NUTAG_INITIAL_ROUTE_STR() tags is prepended to
* the route. Finally (unless NUTAG_SERVICE_ROUTE_ENABLE(0) is used) the
* @ServiceRoute set received from the registrar is also appended to the
* route set of the initial request message.
*
* @par
* Next, the stack generates a @Contact header for the request (Unless the
* application already gave a @Contact header or it does not want to use
* @Contact and indicates that by including SIPTAG_CONTACT(NULL) or
* SIPTAG_CONTACT(SIP_NONE) in the tagged parameters.) If the application
* has a registration active, the @Contact header used with registration is
* used. Otherwise, the @Contact header is generated from the local IP
* address and port number, taking also the values from NUTAG_M_DISPLAY(),
* NUTAG_M_FEATURES(), NUTAG_M_PARAMS(), and NUTAG_M_USERNAME().
*
* @par
* For in-dialog INVITE (re-INVITE), the request URI is taken from the
* @Contact header received from the remote party during the dialog
* establishment. Also, the @CallID and @CSeq headers and @From and @To tags
* are generated based on the dialog information and added to the request.
* If the dialog has a route (set by @RecordRoute headers), it is added to
* the request, too.
*
* @par
* @MaxForwards header (with default value set by NTATAG_MAX_FORWARDS()) is
* also added now, if it does not exist.
*
* @par
* The INVITE request message created by nua_invite() operation is saved as
* a template for automatic re-INVITE requests sent by the session timer
* ("timer") feature (see NUTAG_SESSION_TIMER() for more details). Please
* note that the template message is not used when ACK, PRACK, UPDATE or
* INFO requests are created (however, these requests will include
* dialog-specific headers like @To, @From, and @CallID as well as
* preference headers @Allow, @Supported, @UserAgent, @Organization).
*
* @par Tags Related to SIP Headers and Request-URI
* NUTAG_URL(), SIPTAG_REQUEST(), SIPTAG_REQUEST_STR() \n
* NUTAG_INITIAL_ROUTE(), NUTAG_INITIAL_ROUTE_STR(),
* SIPTAG_ROUTE(), SIPTAG_ROUTE_STR(),
* NUTAG_SERVICE_ROUTE_ENABLE() \n
* SIPTAG_MAX_FORWARDS(), SIPTAG_MAX_FORWARDS_STR() \n
* SIPTAG_PROXY_REQUIRE(), SIPTAG_PROXY_REQUIRE_STR() \n
* SIPTAG_FROM(), SIPTAG_FROM_STR() \n
* SIPTAG_TO(), SIPTAG_TO_STR() \n
* SIPTAG_CALL_ID(), SIPTAG_CALL_ID_STR() \n
* SIPTAG_CSEQ(), SIPTAG_CSEQ_STR()
* (note that @CSeq value is incremented if request gets retried)\n
* SIPTAG_CONTACT(), SIPTAG_CONTACT_STR() \n
* SIPTAG_REQUEST_DISPOSITION(), SIPTAG_REQUEST_DISPOSITION_STR() \n
* SIPTAG_ACCEPT_CONTACT(), SIPTAG_ACCEPT_CONTACT_STR() \n
* SIPTAG_REJECT_CONTACT(), SIPTAG_REJECT_CONTACT_STR() \n
* SIPTAG_EXPIRES(), SIPTAG_EXPIRES_STR() \n
* SIPTAG_DATE(), SIPTAG_DATE_STR() \n
* SIPTAG_TIMESTAMP(), SIPTAG_TIMESTAMP_STR() \n
* SIPTAG_SUBJECT(), SIPTAG_SUBJECT_STR() \n
* SIPTAG_PRIORITY(), SIPTAG_PRIORITY_STR() \n
* SIPTAG_CALL_INFO(), SIPTAG_CALL_INFO_STR() \n
* SIPTAG_ORGANIZATION(), SIPTAG_ORGANIZATION_STR() \n
* NUTAG_USER_AGENT(), SIPTAG_USER_AGENT() and SIPTAG_USER_AGENT_STR() \n
* SIPTAG_IN_REPLY_TO(), SIPTAG_IN_REPLY_TO_STR() \n
* SIPTAG_ACCEPT(), SIPTAG_ACCEPT_STR() \n
* SIPTAG_ACCEPT_ENCODING(), SIPTAG_ACCEPT_ENCODING_STR() \n
* SIPTAG_ACCEPT_LANGUAGE(), SIPTAG_ACCEPT_LANGUAGE_STR() \n
* NUTAG_ALLOW(), SIPTAG_ALLOW(), and SIPTAG_ALLOW_STR() \n
* NUTAG_EARLY_MEDIA(), SIPTAG_REQUIRE(), and SIPTAG_REQUIRE_STR() \n
* NUTAG_SUPPORTED(), SIPTAG_SUPPORTED(), and SIPTAG_SUPPORTED_STR() \n
* SIPTAG_ALLOW_EVENTS(), SIPTAG_ALLOW_EVENTS_STR() \n
* SIPTAG_PROXY_AUTHORIZATION(), SIPTAG_PROXY_AUTHORIZATION_STR() \n
* SIPTAG_AUTHORIZATION(), SIPTAG_AUTHORIZATION_STR() \n
* SIPTAG_REFERRED_BY(), SIPTAG_REFERRED_BY_STR() \n
* SIPTAG_REPLACES(), SIPTAG_REPLACES_STR() \n
* NUTAG_SESSION_TIMER(), NUTAG_SESSION_REFRESHER(),
* SIPTAG_SESSION_EXPIRES(), SIPTAG_SESSION_EXPIRES_STR() \n
* NUTAG_MIN_SE(), SIPTAG_MIN_SE(), SIPTAG_MIN_SE_STR() \n
* SIPTAG_SECURITY_CLIENT(), SIPTAG_SECURITY_CLIENT_STR() \n
* SIPTAG_SECURITY_VERIFY(), SIPTAG_SECURITY_VERIFY_STR() \n
* SIPTAG_PRIVACY(), SIPTAG_PRIVACY_STR() \n
* SIPTAG_MIME_VERSION(), SIPTAG_MIME_VERSION_STR() \n
* SIPTAG_CONTENT_TYPE(), SIPTAG_CONTENT_TYPE_STR() \n
* SIPTAG_CONTENT_ENCODING(), SIPTAG_CONTENT_ENCODING_STR() \n
* SIPTAG_CONTENT_LANGUAGE(), SIPTAG_CONTENT_LANGUAGE_STR() \n
* SIPTAG_CONTENT_DISPOSITION(), SIPTAG_CONTENT_DISPOSITION_STR() \n
* SIPTAG_HEADER(), SIPTAG_HEADER_STR() \n
* SIPTAG_PAYLOAD(), SIPTAG_PAYLOAD_STR() \n
*
* @par SDP Handling
* By default the nua_invite() uses an @ref soa_session_t "SOA media
* session" object to take care of the Offer/Answer exchange. The SOA can
* be disabled with tag NUTAG_MEDIA_ENABLE(0).
*
* @par
* The SDP description of the
* @ref soa_session_t "soa media session" is included in the INVITE request
* as a message body.
* The SDP in the message body of the 1XX or 2XX response message is
* interpreted as an answer, given to the @ref soa_session_t "soa media
* session" object for processing.
*
* @bug If the INVITE request already contains a message body, SDP is not
* added. Also, if the response contains a multipart body, it is not parsed.
*
* @par Tags Related to SDP Management and Offer/Answer Model:
* NUTAG_MEDIA_ENABLE(), \n
* NUTAG_INCLUDE_EXTRA_SDP(), \n
* SOATAG_HOLD(), SOATAG_AF(), SOATAG_ADDRESS(),
* SOATAG_ORDERED_USER(), SOATAG_REUSE_REJECTED(),
* SOATAG_RTP_SELECT(), SOATAG_RTP_SORT(), SOATAG_RTP_MISMATCH(),
* SOATAG_AUDIO_AUX(), \n
* SOATAG_USER_SDP() or SOATAG_USER_SDP_STR() \n
*
* @par Alternative Call Models
* In addition to the basic SIP call model described in @RFC3261 and
* @RFC3264, the early media model described in @RFC3262 is available. The
* use of 100rel and early media can be use can be forced with
* NUTAG_EARLY_MEDIA(1).
*
* Also, the "precondition" call model described in @RFC3312 is supported at
* SIP level, that is, the SIP PRACK and UPDATE requests are sent if
* "precondition" is added to the @Require header in the INVITE request.
*
* Optionally
* - uses early media if NUTAG_EARLY_MEDIA() tag is used with non zero-value
* - media parameters can be set by SOA tags
* - nua_invite() can be used to change status of an existing call:
* - #SOATAG_HOLD tag can be used to list the media that will be put on hold,
* the value "*" sets all the media beloginging to the session on hold
*
* @par Authentication
* The INVITE request may need authentication. Each proxy or server
* requiring authentication can respond with 401 or 407 response. The
* nua_authenticate() operation stores authentication information (username
* and password) to the handle, and stack tries to authenticate all the rest
* of the requests (e.g., PRACK, ACK, UPDATE, re-INVITE, BYE) using the
* stored username and password.
*
* @sa @ref nua_call_model, #nua_r_invite, #nua_i_state, \n
* nua_handle_has_active_call() \n
* nua_handle_has_call_on_hold()\n
* nua_handle_has_invite() \n
* nua_authenticate() \n
* nua_prack() \n
* nua_update() \n
* nua_info() \n
* nua_cancel() \n
* nua_bye() \n
* #nua_i_invite, nua_respond()
*/
/* Tags not implemented
* NUTAG_REFER_PAUSE() \n
*/
static int nua_invite_client_init(nua_client_request_t *cr,
msg_t *msg, sip_t *sip,
tagi_t const *tags);
static int nua_invite_client_request(nua_client_request_t *cr,
msg_t *msg, sip_t *sip,
tagi_t const *tags);
static int nua_invite_client_preliminary(nua_client_request_t *cr,
int status, char const *phrase,
sip_t const *sip);
static int nua_invite_client_response(nua_client_request_t *cr,
int status, char const *phrase,
sip_t const *sip);
static int nua_session_client_response(nua_client_request_t *cr,
int status, char const *phrase,
sip_t const *sip);
static int nua_invite_client_report(nua_client_request_t *cr,
int status, char const *phrase,
sip_t const *sip,
nta_outgoing_t *orq,
tagi_t const *tags);
nua_client_methods_t const nua_invite_client_methods = {
SIP_METHOD_INVITE, /* crm_method, crm_method_name */
0, /* crm_extra */
{ /* crm_flags */
/* create_dialog */ 1,
/* in_dialog */ 1,
/* target refresh */ 1
},
NULL, /* crm_template */
nua_invite_client_init, /* crm_init */
nua_invite_client_request, /* crm_send */
session_timer_check_restart, /* crm_check_restart */
nua_invite_client_response, /* crm_recv */
nua_invite_client_preliminary, /* crm_preliminary */
nua_invite_client_report, /* crm_report */
nua_invite_client_complete, /* crm_complete */
};
extern nua_client_methods_t const nua_bye_client_methods;
extern nua_client_methods_t const nua_cancel_client_methods;
extern nua_client_methods_t const nua_update_client_methods;
extern nua_client_methods_t const nua_prack_client_methods;
int nua_stack_invite(nua_t *nua, nua_handle_t *nh, nua_event_t e,
tagi_t const *tags)
{
return nua_client_create(nh, e, &nua_invite_client_methods, tags);
}
static int nua_invite_client_init(nua_client_request_t *cr,
msg_t *msg, sip_t *sip,
tagi_t const *tags)
{
nua_handle_t *nh = cr->cr_owner;
nua_dialog_usage_t *du;
nua_session_usage_t *ss;
cr->cr_usage = du = nua_dialog_usage_for_session(nh->nh_ds);
/* Errors returned by nua_invite_client_init()
do not change the session state */
cr->cr_neutral = 1;
if (nh_is_special(nh) ||
nua_stack_set_handle_special(nh, nh_has_invite, nua_i_error))
return nua_client_return(cr, 900, "Invalid handle for INVITE", msg);
else if (nh_referral_check(nh, tags) < 0)
return nua_client_return(cr, 900, "Invalid referral", msg);
if (du) {
nua_server_request_t *sr;
for (sr = nh->nh_ds->ds_sr; sr; sr = sr->sr_next)
/* INVITE in progress? */
if (sr->sr_usage == du && sr->sr_method == sip_method_invite &&
nua_server_request_is_pending(sr))
return nua_client_return(cr, SIP_491_REQUEST_PENDING, msg);
cr->cr_initial = 0;
}
else {
du = nua_dialog_usage_add(nh, nh->nh_ds, nua_session_usage, NULL);
cr->cr_initial = 1;
}
if (!du)
return -1;
ss = nua_dialog_usage_private(du);
if (ss->ss_state >= nua_callstate_terminating)
return nua_client_return(cr, 900, "Session is terminating", msg);
if (nua_client_bind(cr, du) < 0)
return nua_client_return(cr, 900, "INVITE already in progress", msg);
cr->cr_neutral = 0;
session_timer_preferences(ss->ss_timer,
sip,
NH_PGET(nh, supported),
NH_PGET(nh, session_timer),
NUA_PISSET(nh->nh_nua, nh, session_timer),
NH_PGET(nh, refresher),
NH_PGET(nh, min_se));
return 0;
}
static int nua_invite_client_request(nua_client_request_t *cr,
msg_t *msg, sip_t *sip,
tagi_t const *tags)
{
nua_handle_t *nh = cr->cr_owner;
nua_dialog_usage_t *du = cr->cr_usage;
nua_session_usage_t *ss;
int offer_sent = 0, retval;
if (du == NULL) /* Call terminated */
return nua_client_return(cr, SIP_481_NO_TRANSACTION, msg);
ss = NUA_DIALOG_USAGE_PRIVATE(du);
if (ss->ss_state >= nua_callstate_terminating)
return nua_client_return(cr, 900, "Session is terminating", msg);
nua_dialog_usage_reset_refresh(du);
/* Add session timer headers */
if (session_timer_is_supported(ss->ss_timer))
session_timer_add_headers(ss->ss_timer, ss->ss_state == nua_callstate_init,
msg, sip, nh);
ss->ss_100rel = NH_PGET(nh, early_media);
ss->ss_precondition = sip_has_feature(sip->sip_require, "precondition");
if (ss->ss_precondition)
ss->ss_update_needed = ss->ss_100rel = 1;
if (nh->nh_soa) {
soa_init_offer_answer(nh->nh_soa);
if (sip->sip_payload)
offer_sent = 0; /* XXX - kludge */
else if (soa_generate_offer(nh->nh_soa, 0, NULL) < 0)
return -1;
else
offer_sent = 1;
if (offer_sent > 0 &&
session_include_description(nh->nh_soa, 1, msg, sip) < 0)
return nua_client_return(cr, 900, "Internal media error", msg);
if (NH_PGET(nh, media_features) &&
!nua_dialog_is_established(nh->nh_ds) &&
!sip->sip_accept_contact && !sip->sip_reject_contact) {
sip_accept_contact_t ac[1];
sip_accept_contact_init(ac);
ac->cp_params = (msg_param_t *)
soa_media_features(nh->nh_soa, 1, msg_home(msg));
if (ac->cp_params) {
msg_header_replace_param(msg_home(msg), ac->cp_common, "explicit");
sip_add_dup(msg, sip, (sip_header_t *)ac);
}
}
}
else {
offer_sent = session_get_description(sip, NULL, NULL);
}
retval = nua_base_client_trequest(cr, msg, sip,
NTATAG_REL100(ss->ss_100rel),
TAG_NEXT(tags));
if (retval == 0) {
if ((cr->cr_offer_sent = offer_sent))
ss->ss_oa_sent = Offer;
if (!cr->cr_restarting) /* Restart logic calls nua_invite_client_report */
signal_call_state_change(nh, ss, 0, "INVITE sent",
nua_callstate_calling);
}
return retval;
}
static int nua_invite_client_response(nua_client_request_t *cr,
int status, char const *phrase,
sip_t const *sip)
{
nua_dialog_usage_t *du = cr->cr_usage;
nua_session_usage_t *ss = nua_dialog_usage_private(du);
if (ss == NULL || sip == NULL) {
/* Xyzzy */
}
else if (status < 300) {
du->du_ready = 1;
if (session_timer_is_supported(ss->ss_timer))
session_timer_store(ss->ss_timer, sip);
session_timer_set(ss, 0);
}
return nua_session_client_response(cr, status, phrase, sip);
}
static int nua_invite_client_preliminary(nua_client_request_t *cr,
int status, char const *phrase,
sip_t const *sip)
{
nua_handle_t *nh = cr->cr_owner;
nua_dialog_usage_t *du = cr->cr_usage;
nua_session_usage_t *ss = nua_dialog_usage_private(du);
assert(sip);
if (ss && sip && sip->sip_rseq) {
/* Handle 100rel responses */
sip_rseq_t *rseq = sip->sip_rseq;
/* Establish early dialog - we should fork here */
if (!nua_dialog_is_established(nh->nh_ds)) {
nta_outgoing_t *tagged;
nua_dialog_uac_route(nh, nh->nh_ds, sip, 1, 1);
nua_dialog_store_peer_info(nh, nh->nh_ds, sip);
/* Tag the INVITE request */
tagged = nta_outgoing_tagged(cr->cr_orq,
nua_client_orq_response, cr,
sip->sip_to->a_tag, sip->sip_rseq);
if (tagged) {
nta_outgoing_destroy(cr->cr_orq), cr->cr_orq = tagged;
}
else {
cr->cr_graceful = 1;
ss->ss_reason = "SIP;cause=500;text=\"Cannot Create Early Dialog\"";
}
}
if (!rseq) {
SU_DEBUG_5(("nua(%p): 100rel missing RSeq\n", (void *)nh));
}
else if (nta_outgoing_rseq(cr->cr_orq) > rseq->rs_response) {
SU_DEBUG_5(("nua(%p): 100rel bad RSeq %u (got %u)\n", (void *)nh,
(unsigned)rseq->rs_response,
nta_outgoing_rseq(cr->cr_orq)));
return 1; /* Do not send event */
}
else if (nta_outgoing_setrseq(cr->cr_orq, rseq->rs_response) < 0) {
SU_DEBUG_1(("nua(%p): cannot set RSeq %u\n", (void *)nh,
(unsigned)rseq->rs_response));
cr->cr_graceful = 1;
ss->ss_reason = "SIP;cause=400;text=\"Bad RSeq\"";
}
}
return nua_session_client_response(cr, status, phrase, sip);
}
/** Process response to a session request (INVITE, PRACK, UPDATE) */
static int nua_session_client_response(nua_client_request_t *cr,
int status, char const *phrase,
sip_t const *sip)
{
nua_handle_t *nh = cr->cr_owner;
nua_dialog_usage_t *du = cr->cr_usage;
nua_session_usage_t *ss = nua_dialog_usage_private(du);
char const *sdp = NULL;
size_t len;
char const *received = NULL;
#define LOG3(m) \
SU_DEBUG_3(("nua(%p): %s: %s %s in %u %s (%u)\n", \
(void *)nh, cr->cr_method_name, (m), \
received ? received : "SDP", status, phrase, cr->cr_answer_recv))
#define LOG5(m) \
SU_DEBUG_5(("nua(%p): %s: %s %s in %u %s (%u)\n", \
(void *)nh, cr->cr_method_name, (m), received, status, phrase, cr->cr_answer_recv))
retry:
if (!ss || !sip || 300 <= status)
/* Xyzzy */;
else if (!session_get_description(sip, &sdp, &len))
/* No SDP */;
else if (cr->cr_answer_recv) {
if (status < 200 && cr->cr_answer_recv >= 200) {
LOG3("call already answered, ignoring provisional response");
sdp = NULL;
return 0;
} else {
// we need to make sure its *actually* a dup, so we can't assume for now.
LOG3("multiple answers received, processing");
cr->cr_answer_recv = 0;
goto retry;
}
}
else if (cr->cr_offer_sent) {
/* case 1: answer to our offer */
cr->cr_answer_recv = status;
received = Answer;
if (nh->nh_soa == NULL)
LOG5("got SDP");
else if (soa_set_remote_sdp(nh->nh_soa, NULL, sdp, len) < 0) {
LOG3("error parsing SDP");
sdp = NULL;
cr->cr_graceful = 1;
ss->ss_reason = "SIP;cause=400;text=\"Malformed Session Description\"";
}
else if (soa_process_answer(nh->nh_soa, NULL) < 0) {
LOG5("error processing SDP");
/* XXX */
sdp = NULL;
}
else if (soa_activate(nh->nh_soa, NULL) < 0) {
/* XXX - what about errors? */
LOG3("error activating media after");
}
else {
ss->ss_sdp_version = soa_get_user_version(nh->nh_soa);
LOG5("processed SDP");
}
}
else if (cr->cr_method != sip_method_invite) {
/* If non-invite request did not have offer, ignore SDP in response */
LOG3("ignoring extra");
sdp = NULL;
}
else {
/* case 2: new offer */
cr->cr_offer_recv = 1, cr->cr_answer_sent = 0;
received = Offer;
if (nh->nh_soa && soa_set_remote_sdp(nh->nh_soa, NULL, sdp, len) < 0) {
LOG3("error parsing SDP");
sdp = NULL;