6e2472ac04d250412a835bd068c3e4c38c0cd843
[asterisk/asterisk.git] / channels / chan_sip.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*!
20  * \file
21  * \brief Implementation of Session Initiation Protocol
22  *
23  * \author Mark Spencer <markster@digium.com>
24  *
25  * See Also:
26  * \arg \ref AstCREDITS
27  *
28  * Implementation of RFC 3261 - without S/MIME, TCP and TLS support
29  * Configuration file \link Config_sip sip.conf \endlink
30  *
31  *
32  * \todo SIP over TCP
33  * \todo SIP over TLS
34  * \todo Better support of forking
35  * \todo VIA branch tag transaction checking
36  * \todo Transaction support
37  *
38  * \ingroup channel_drivers
39  *
40  * \par Overview of the handling of SIP sessions
41  * The SIP channel handles several types of SIP sessions, or dialogs,
42  * not all of them being "telephone calls".
43  * - Incoming calls that will be sent to the PBX core
44  * - Outgoing calls, generated by the PBX
45  * - SIP subscriptions and notifications of states and voicemail messages
46  * - SIP registrations, both inbound and outbound
47  * - SIP peer management (peerpoke, OPTIONS)
48  * - SIP text messages
49  *
50  * In the SIP channel, there's a list of active SIP dialogs, which includes
51  * all of these when they are active. "sip show channels" in the CLI will
52  * show most of these, excluding subscriptions which are shown by
53  * "sip show subscriptions"
54  *
55  * \par incoming packets
56  * Incoming packets are received in the monitoring thread, then handled by
57  * sipsock_read(). This function parses the packet and matches an existing
58  * dialog or starts a new SIP dialog.
59  * 
60  * sipsock_read sends the packet to handle_request(), that parses a bit more.
61  * if it's a response to an outbound request, it's sent to handle_response().
62  * If it is a request, handle_request sends it to one of a list of functions
63  * depending on the request type - INVITE, OPTIONS, REFER, BYE, CANCEL etc
64  * sipsock_read locks the ast_channel if it exists (an active call) and
65  * unlocks it after we have processed the SIP message.
66  *
67  * A new INVITE is sent to handle_request_invite(), that will end up
68  * starting a new channel in the PBX, the new channel after that executing
69  * in a separate channel thread. This is an incoming "call".
70  * When the call is answered, either by a bridged channel or the PBX itself
71  * the sip_answer() function is called.
72  *
73  * The actual media - Video or Audio - is mostly handled by the RTP subsystem
74  * in rtp.c 
75  * 
76  * \par Outbound calls
77  * Outbound calls are set up by the PBX through the sip_request_call()
78  * function. After that, they are activated by sip_call().
79  * 
80  * \par Hanging up
81  * The PBX issues a hangup on both incoming and outgoing calls through
82  * the sip_hangup() function
83  *
84  */
85
86
87 #include "asterisk.h"
88
89 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
90
91 #include <stdio.h>
92 #include <ctype.h>
93 #include <string.h>
94 #include <unistd.h>
95 #include <sys/socket.h>
96 #include <sys/ioctl.h>
97 #include <net/if.h>
98 #include <errno.h>
99 #include <stdlib.h>
100 #include <fcntl.h>
101 #include <netdb.h>
102 #include <signal.h>
103 #include <sys/signal.h>
104 #include <netinet/in.h>
105 #include <netinet/in_systm.h>
106 #include <arpa/inet.h>
107 #include <netinet/ip.h>
108 #include <regex.h>
109
110 #include "asterisk/lock.h"
111 #include "asterisk/channel.h"
112 #include "asterisk/config.h"
113 #include "asterisk/logger.h"
114 #include "asterisk/module.h"
115 #include "asterisk/pbx.h"
116 #include "asterisk/options.h"
117 #include "asterisk/lock.h"
118 #include "asterisk/sched.h"
119 #include "asterisk/io.h"
120 #include "asterisk/rtp.h"
121 #include "asterisk/udptl.h"
122 #include "asterisk/acl.h"
123 #include "asterisk/manager.h"
124 #include "asterisk/callerid.h"
125 #include "asterisk/cli.h"
126 #include "asterisk/app.h"
127 #include "asterisk/musiconhold.h"
128 #include "asterisk/dsp.h"
129 #include "asterisk/features.h"
130 #include "asterisk/acl.h"
131 #include "asterisk/srv.h"
132 #include "asterisk/astdb.h"
133 #include "asterisk/causes.h"
134 #include "asterisk/utils.h"
135 #include "asterisk/file.h"
136 #include "asterisk/astobj.h"
137 #include "asterisk/dnsmgr.h"
138 #include "asterisk/devicestate.h"
139 #include "asterisk/linkedlists.h"
140 #include "asterisk/stringfields.h"
141 #include "asterisk/monitor.h"
142 #include "asterisk/localtime.h"
143 #include "asterisk/abstract_jb.h"
144
145 #ifndef FALSE
146 #define FALSE    0
147 #endif
148
149 #ifndef TRUE
150 #define TRUE     1
151 #endif
152
153 #define VIDEO_CODEC_MASK        0x1fc0000 /*!< Video codecs from H.261 thru AST_FORMAT_MAX_VIDEO */
154 #ifndef IPTOS_MINCOST
155 #define IPTOS_MINCOST           0x02
156 #endif
157
158 /* #define VOCAL_DATA_HACK */
159
160 #define DEFAULT_DEFAULT_EXPIRY  120
161 #define DEFAULT_MIN_EXPIRY      60
162 #define DEFAULT_MAX_EXPIRY      3600
163 #define DEFAULT_REGISTRATION_TIMEOUT 20
164 #define DEFAULT_MAX_FORWARDS    "70"
165
166 /* guard limit must be larger than guard secs */
167 /* guard min must be < 1000, and should be >= 250 */
168 #define EXPIRY_GUARD_SECS       15                /*!< How long before expiry do we reregister */
169 #define EXPIRY_GUARD_LIMIT      30                /*!< Below here, we use EXPIRY_GUARD_PCT instead of 
170                                                    EXPIRY_GUARD_SECS */
171 #define EXPIRY_GUARD_MIN        500                /*!< This is the minimum guard time applied. If 
172                                                    GUARD_PCT turns out to be lower than this, it 
173                                                    will use this time instead.
174                                                    This is in milliseconds. */
175 #define EXPIRY_GUARD_PCT        0.20                /*!< Percentage of expires timeout to use when 
176                                                     below EXPIRY_GUARD_LIMIT */
177 #define DEFAULT_EXPIRY 900                          /*!< Expire slowly */
178
179 static int min_expiry = DEFAULT_MIN_EXPIRY;        /*!< Minimum accepted registration time */
180 static int max_expiry = DEFAULT_MAX_EXPIRY;        /*!< Maximum accepted registration time */
181 static int default_expiry = DEFAULT_DEFAULT_EXPIRY;
182 static int expiry = DEFAULT_EXPIRY;
183
184 #ifndef MAX
185 #define MAX(a,b) ((a) > (b) ? (a) : (b))
186 #endif
187
188 #define CALLERID_UNKNOWN        "Unknown"
189
190 #define DEFAULT_MAXMS                2000             /*!< Qualification: Must be faster than 2 seconds by default */
191 #define DEFAULT_FREQ_OK              60 * 1000        /*!< Qualification: How often to check for the host to be up */
192 #define DEFAULT_FREQ_NOTOK           10 * 1000        /*!< Qualification: How often to check, if the host is down... */
193
194 #define DEFAULT_RETRANS              1000             /*!< How frequently to retransmit Default: 2 * 500 ms in RFC 3261 */
195 #define MAX_RETRANS                  6                /*!< Try only 6 times for retransmissions, a total of 7 transmissions */
196 #define SIP_TRANS_TIMEOUT            32000            /*!< SIP request timeout (rfc 3261) 64*T1 
197                                                       \todo Use known T1 for timeout (peerpoke)
198                                                       */
199 #define MAX_AUTHTRIES                3                /*!< Try authentication three times, then fail */
200
201 #define SIP_MAX_HEADERS              64               /*!< Max amount of SIP headers to read */
202 #define SIP_MAX_LINES                64               /*!< Max amount of lines in SIP attachment (like SDP) */
203 #define SIP_MAX_PACKET               4096             /*!< Also from RFC 3261 (2543), should sub headers tho */
204
205 #define INITIAL_CSEQ                 101              /*!< our initial sip sequence number */
206
207 /*! \brief Global jitterbuffer configuration - by default, jb is disabled */
208 static struct ast_jb_conf default_jbconf =
209 {
210         .flags = 0,
211         .max_size = -1,
212         .resync_threshold = -1,
213         .impl = ""
214 };
215 static struct ast_jb_conf global_jbconf;
216
217 static const char tdesc[] = "Session Initiation Protocol (SIP)";
218 static const char config[] = "sip.conf";
219 static const char notify_config[] = "sip_notify.conf";
220 static int usecnt = 0;
221
222
223 #define RTP     1
224 #define NO_RTP  0
225
226 /*! \brief Authorization scheme for call transfers 
227 \note Not a bitfield flag, since there are plans for other modes,
228         like "only allow transfers for authenticated devices" */
229 enum transfermodes {
230         TRANSFER_OPENFORALL,            /*!< Allow all SIP transfers */
231         TRANSFER_CLOSED,                /*!< Allow no SIP transfers */
232 };
233
234
235 enum sip_result {
236         AST_SUCCESS = 0,
237         AST_FAILURE = -1,
238 };
239
240 /* Do _NOT_ make any changes to this enum, or the array following it;
241    if you think you are doing the right thing, you are probably
242    not doing the right thing. If you think there are changes
243    needed, get someone else to review them first _before_
244    submitting a patch. If these two lists do not match properly
245    bad things will happen.
246 */
247
248 enum xmittype {
249         XMIT_CRITICAL = 2,              /*!< Transmit critical SIP message reliably, with re-transmits.
250                                               If it fails, it's critical and will cause a teardown of the session */
251         XMIT_RELIABLE = 1,              /*!< Transmit SIP message reliably, with re-transmits */
252         XMIT_UNRELIABLE = 0,            /*!< Transmit SIP message without bothering with re-transmits */
253 };
254
255 enum parse_register_result {
256         PARSE_REGISTER_FAILED,
257         PARSE_REGISTER_UPDATE,
258         PARSE_REGISTER_QUERY,
259 };
260
261 enum subscriptiontype { 
262         NONE = 0,
263         TIMEOUT,
264         XPIDF_XML,
265         DIALOG_INFO_XML,
266         CPIM_PIDF_XML,
267         PIDF_XML,
268         MWI_NOTIFICATION
269 };
270
271 static const struct cfsubscription_types {
272         enum subscriptiontype type;
273         const char * const event;
274         const char * const mediatype;
275         const char * const text;
276 } subscription_types[] = {
277         { NONE,            "-",        "unknown",                    "unknown" },
278         /* IETF draft: draft-ietf-sipping-dialog-package-05.txt */
279         { DIALOG_INFO_XML, "dialog",   "application/dialog-info+xml", "dialog-info+xml" },
280         { CPIM_PIDF_XML,   "presence", "application/cpim-pidf+xml",   "cpim-pidf+xml" },  /* RFC 3863 */
281         { PIDF_XML,        "presence", "application/pidf+xml",        "pidf+xml" },       /* RFC 3863 */
282         { XPIDF_XML,       "presence", "application/xpidf+xml",       "xpidf+xml" },       /* Pre-RFC 3863 with MS additions */
283         { MWI_NOTIFICATION,     "message-summary", "application/simple-message-summary", "mwi" } /* RFC 3842: Mailbox notification */
284 };
285
286 /*! \brief SIP Request methods known by Asterisk */
287 enum sipmethod {
288         SIP_UNKNOWN,            /* Unknown response */
289         SIP_RESPONSE,           /* Not request, response to outbound request */
290         SIP_REGISTER,
291         SIP_OPTIONS,
292         SIP_NOTIFY,
293         SIP_INVITE,
294         SIP_ACK,
295         SIP_PRACK,              /* Not supported at all */
296         SIP_BYE,
297         SIP_REFER,
298         SIP_SUBSCRIBE,
299         SIP_MESSAGE,
300         SIP_UPDATE,             /* We can send UPDATE; but not accept it */
301         SIP_INFO,
302         SIP_CANCEL,
303         SIP_PUBLISH,            /* Not supported at all */
304 };
305
306 /*! \brief Authentication types - proxy or www authentication 
307         \note Endpoints, like Asterisk, should always use WWW authentication to
308         allow multiple authentications in the same call - to the proxy and
309         to the end point.
310 */
311 enum sip_auth_type {
312         PROXY_AUTH,
313         WWW_AUTH,
314 };
315
316 /*! \brief Authentication result from check_auth* functions */
317 enum check_auth_result {
318         AUTH_SUCCESSFUL = 0,
319         AUTH_CHALLENGE_SENT = 1,
320         AUTH_SECRET_FAILED = -1,
321         AUTH_USERNAME_MISMATCH = -2,
322         AUTH_NOT_FOUND = -3,
323         AUTH_FAKE_AUTH = -4,
324         AUTH_UNKNOWN_DOMAIN = -5,
325 };
326
327 /* States for outbound registrations (with register= lines in sip.conf */
328 enum sipregistrystate {
329         REG_STATE_UNREGISTERED = 0,     /*!< We are not registred */
330         REG_STATE_REGSENT,      /*!< Registration request sent */
331         REG_STATE_AUTHSENT,     /*!< We have tried to authenticate */
332         REG_STATE_REGISTERED,   /*!< Registred and done */
333         REG_STATE_REJECTED,     /*!< Registration rejected */
334         REG_STATE_TIMEOUT,      /*!< Registration timed out */
335         REG_STATE_NOAUTH,       /*!< We have no accepted credentials */
336         REG_STATE_FAILED,       /*!< Registration failed after several tries */
337 };
338
339
340 /*! XXX Note that sip_methods[i].id == i must hold or the code breaks */
341 static const struct  cfsip_methods { 
342         enum sipmethod id;
343         int need_rtp;           /*!< when this is the 'primary' use for a pvt structure, does it need RTP? */
344         char * const text;
345 } sip_methods[] = {
346         { SIP_UNKNOWN,   RTP,    "-UNKNOWN-" },
347         { SIP_RESPONSE,  NO_RTP, "SIP/2.0" },
348         { SIP_REGISTER,  NO_RTP, "REGISTER" },
349         { SIP_OPTIONS,   NO_RTP, "OPTIONS" },
350         { SIP_NOTIFY,    NO_RTP, "NOTIFY" },
351         { SIP_INVITE,    RTP,    "INVITE" },
352         { SIP_ACK,       NO_RTP, "ACK" },
353         { SIP_PRACK,     NO_RTP, "PRACK" },
354         { SIP_BYE,       NO_RTP, "BYE" },
355         { SIP_REFER,     NO_RTP, "REFER" },
356         { SIP_SUBSCRIBE, NO_RTP, "SUBSCRIBE" },
357         { SIP_MESSAGE,   NO_RTP, "MESSAGE" },
358         { SIP_UPDATE,    NO_RTP, "UPDATE" },
359         { SIP_INFO,      NO_RTP, "INFO" },
360         { SIP_CANCEL,    NO_RTP, "CANCEL" },
361         { SIP_PUBLISH,   NO_RTP, "PUBLISH" }
362 };
363
364 /*!  Define SIP option tags, used in Require: and Supported: headers 
365         We need to be aware of these properties in the phones to use 
366         the replace: header. We should not do that without knowing
367         that the other end supports it... 
368         This is nothing we can configure, we learn by the dialog
369         Supported: header on the REGISTER (peer) or the INVITE
370         (other devices)
371         We are not using many of these today, but will in the future.
372         This is documented in RFC 3261
373 */
374 #define SUPPORTED               1
375 #define NOT_SUPPORTED           0
376
377 #define SIP_OPT_REPLACES        (1 << 0)
378 #define SIP_OPT_100REL          (1 << 1)
379 #define SIP_OPT_TIMER           (1 << 2)
380 #define SIP_OPT_EARLY_SESSION   (1 << 3)
381 #define SIP_OPT_JOIN            (1 << 4)
382 #define SIP_OPT_PATH            (1 << 5)
383 #define SIP_OPT_PREF            (1 << 6)
384 #define SIP_OPT_PRECONDITION    (1 << 7)
385 #define SIP_OPT_PRIVACY         (1 << 8)
386 #define SIP_OPT_SDP_ANAT        (1 << 9)
387 #define SIP_OPT_SEC_AGREE       (1 << 10)
388 #define SIP_OPT_EVENTLIST       (1 << 11)
389 #define SIP_OPT_GRUU            (1 << 12)
390 #define SIP_OPT_TARGET_DIALOG   (1 << 13)
391 #define SIP_OPT_NOREFERSUB      (1 << 14)
392 #define SIP_OPT_HISTINFO        (1 << 15)
393 #define SIP_OPT_RESPRIORITY     (1 << 16)
394
395 /*! \brief List of well-known SIP options. If we get this in a require,
396    we should check the list and answer accordingly. */
397 static const struct cfsip_options {
398         int id;                 /*!< Bitmap ID */
399         int supported;          /*!< Supported by Asterisk ? */
400         char * const text;      /*!< Text id, as in standard */
401 } sip_options[] = {     /* XXX used in 3 places */
402         /* RFC3891: Replaces: header for transfer */
403         { SIP_OPT_REPLACES,     SUPPORTED,      "replaces" },   
404         /* One version of Polycom firmware has the wrong label */
405         { SIP_OPT_REPLACES,     SUPPORTED,      "replace" },    
406         /* RFC3262: PRACK 100% reliability */
407         { SIP_OPT_100REL,       NOT_SUPPORTED,  "100rel" },     
408         /* RFC4028: SIP Session Timers */
409         { SIP_OPT_TIMER,        NOT_SUPPORTED,  "timer" },
410         /* RFC3959: SIP Early session support */
411         { SIP_OPT_EARLY_SESSION, NOT_SUPPORTED, "early-session" },
412         /* RFC3911: SIP Join header support */
413         { SIP_OPT_JOIN,         NOT_SUPPORTED,  "join" },
414         /* RFC3327: Path support */
415         { SIP_OPT_PATH,         NOT_SUPPORTED,  "path" },
416         /* RFC3840: Callee preferences */
417         { SIP_OPT_PREF,         NOT_SUPPORTED,  "pref" },
418         /* RFC3312: Precondition support */
419         { SIP_OPT_PRECONDITION, NOT_SUPPORTED,  "precondition" },
420         /* RFC3323: Privacy with proxies*/
421         { SIP_OPT_PRIVACY,      NOT_SUPPORTED,  "privacy" },
422         /* RFC4092: Usage of the SDP ANAT Semantics in the SIP */
423         { SIP_OPT_SDP_ANAT,     NOT_SUPPORTED,  "sdp-anat" },
424         /* RFC3329: Security agreement mechanism */
425         { SIP_OPT_SEC_AGREE,    NOT_SUPPORTED,  "sec_agree" },
426         /* SIMPLE events:  draft-ietf-simple-event-list-07.txt */
427         { SIP_OPT_EVENTLIST,    NOT_SUPPORTED,  "eventlist" },
428         /* GRUU: Globally Routable User Agent URI's */
429         { SIP_OPT_GRUU,         NOT_SUPPORTED,  "gruu" },
430         /* Target-dialog: draft-ietf-sip-target-dialog-03.txt */
431         { SIP_OPT_TARGET_DIALOG,NOT_SUPPORTED,  "tdialog" },
432         /* Disable the REFER subscription, RFC 4488 */
433         { SIP_OPT_NOREFERSUB,   NOT_SUPPORTED,  "norefersub" },
434         /* ietf-sip-history-info-06.txt */
435         { SIP_OPT_HISTINFO,     NOT_SUPPORTED,  "histinfo" },
436         /* ietf-sip-resource-priority-10.txt */
437         { SIP_OPT_RESPRIORITY,  NOT_SUPPORTED,  "resource-priority" },
438 };
439
440
441 /*! \brief SIP Methods we support */
442 #define ALLOWED_METHODS "INVITE, ACK, CANCEL, OPTIONS, BYE, REFER, SUBSCRIBE, NOTIFY"
443
444 /*! \brief SIP Extensions we support */
445 #define SUPPORTED_EXTENSIONS "replaces" 
446
447
448 /* Default values, set and reset in reload_config before reading configuration */
449 /* These are default values in the source. There are other recommended values in the
450    sip.conf.sample for new installations. These may differ to keep backwards compatibility,
451    yet encouraging new behaviour on new installations 
452  */
453 #define DEFAULT_SIP_PORT        5060    /*!< From RFC 3261 (former 2543) */
454 #define DEFAULT_CONTEXT         "default"
455 #define DEFAULT_MUSICCLASS      "default"
456 #define DEFAULT_VMEXTEN         "asterisk"
457 #define DEFAULT_CALLERID        "asterisk"
458 #define DEFAULT_NOTIFYMIME      "application/simple-message-summary"
459 #define DEFAULT_MWITIME         10
460 #define DEFAULT_ALLOWGUEST      TRUE
461 #define DEFAULT_SRVLOOKUP       FALSE           /*!< Recommended setting is ON */
462 #define DEFAULT_COMPACTHEADERS  FALSE
463 #define DEFAULT_TOS_SIP         0               /*!< Call signalling packets should be marked as DSCP CS3, but the default is 0 to be compatible with previous versions. */
464 #define DEFAULT_TOS_AUDIO       0               /*!< Audio packets should be marked as DSCP EF (Expedited Forwarding), but the default is 0 to be compatible with previous versions. */
465 #define DEFAULT_TOS_VIDEO       0               /*!< Video packets should be marked as DSCP AF41, but the default is 0 to be compatible with previous versions. */
466 #define DEFAULT_ALLOW_EXT_DOM   TRUE
467 #define DEFAULT_REALM           "asterisk"
468 #define DEFAULT_NOTIFYRINGING   TRUE
469 #define DEFAULT_PEDANTIC        FALSE
470 #define DEFAULT_AUTOCREATEPEER  FALSE
471 #define DEFAULT_QUALIFY         FALSE
472 #define DEFAULT_T1MIN           100             /*!< 100 MS for minimal roundtrip time */
473 #define DEFAULT_MAX_CALL_BITRATE (384)          /*!< Max bitrate for video */
474 #ifndef DEFAULT_USERAGENT
475 #define DEFAULT_USERAGENT "Asterisk PBX"        /*!< Default Useragent: header unless re-defined in sip.conf */
476 #endif
477
478
479 /* Default setttings are used as a channel setting and as a default when
480    configuring devices */
481 static char default_context[AST_MAX_CONTEXT];
482 static char default_subscribecontext[AST_MAX_CONTEXT];
483 static char default_language[MAX_LANGUAGE];
484 static char default_callerid[AST_MAX_EXTENSION];
485 static char default_fromdomain[AST_MAX_EXTENSION];
486 static char default_notifymime[AST_MAX_EXTENSION];
487 static int default_qualify;             /*!< Default Qualify= setting */
488 static char default_vmexten[AST_MAX_EXTENSION];
489 static char default_musicclass[MAX_MUSICCLASS];         /*!< Global music on hold class */
490 static int default_maxcallbitrate;      /*!< Maximum bitrate for call */
491 static struct ast_codec_pref default_prefs;             /*!< Default codec prefs */
492
493 /* Global settings only apply to the channel */
494 static int global_rtautoclear;
495 static int global_notifyringing;        /*!< Send notifications on ringing */
496 static int global_alwaysauthreject;     /*!< Send 401 Unauthorized for all failing requests */
497 static int srvlookup;                   /*!< SRV Lookup on or off. Default is off, RFC behavior is on */
498 static int pedanticsipchecking;         /*!< Extra checking ?  Default off */
499 static int autocreatepeer;              /*!< Auto creation of peers at registration? Default off. */
500 static int global_relaxdtmf;                    /*!< Relax DTMF */
501 static int global_rtptimeout;           /*!< Time out call if no RTP */
502 static int global_rtpholdtimeout;
503 static int global_rtpkeepalive;         /*!< Send RTP keepalives */
504 static int global_reg_timeout;  
505 static int global_regattempts_max;      /*!< Registration attempts before giving up */
506 static int global_allowguest;           /*!< allow unauthenticated users/peers to connect? */
507 static int global_allowsubscribe;       /*!< Flag for disabling ALL subscriptions, this is FALSE only if all peers are FALSE 
508                                             the global setting is in globals_flags[1] */
509 static int global_mwitime;              /*!< Time between MWI checks for peers */
510 static int global_tos_sip;              /*!< IP type of service for SIP packets */
511 static int global_tos_audio;            /*!< IP type of service for audio RTP packets */
512 static int global_tos_video;            /*!< IP type of service for video RTP packets */
513 static int compactheaders;              /*!< send compact sip headers */
514 static int recordhistory;               /*!< Record SIP history. Off by default */
515 static int dumphistory;                 /*!< Dump history to verbose before destroying SIP dialog */
516 static char global_realm[MAXHOSTNAMELEN];               /*!< Default realm */
517 static char global_regcontext[AST_MAX_CONTEXT];         /*!< Context for auto-extensions */
518 static char global_useragent[AST_MAX_EXTENSION];        /*!< Useragent for the SIP channel */
519 static int allow_external_domains;      /*!< Accept calls to external SIP domains? */
520 static int global_callevents;           /*!< Whether we send manager events or not */
521 static int global_t1min;                /*!< T1 roundtrip time minimum */
522 static enum transfermodes global_allowtransfer; /*!< SIP Refer restriction scheme */
523
524 /*! \brief Codecs that we support by default: */
525 static int global_capability = AST_FORMAT_ULAW | AST_FORMAT_ALAW | AST_FORMAT_GSM | AST_FORMAT_H263;
526 static int noncodeccapability = AST_RTP_DTMF;
527
528 /* Object counters */
529 static int suserobjs = 0;               /*!< Static users */
530 static int ruserobjs = 0;               /*!< Realtime users */
531 static int speerobjs = 0;               /*!< Statis peers */
532 static int rpeerobjs = 0;               /*!< Realtime peers */
533 static int apeerobjs = 0;               /*!< Autocreated peer objects */
534 static int regobjs = 0;                 /*!< Registry objects */
535
536 static struct ast_flags global_flags[2] = {{0}};        /*!< global SIP_ flags */
537
538 AST_MUTEX_DEFINE_STATIC(usecnt_lock);
539
540 /*! \brief Protect the SIP dialog list (of sip_pvt's) */
541 AST_MUTEX_DEFINE_STATIC(iflock);
542
543 /*! \brief Protect the monitoring thread, so only one process can kill or start it, and not
544    when it's doing something critical. */
545 AST_MUTEX_DEFINE_STATIC(netlock);
546
547 AST_MUTEX_DEFINE_STATIC(monlock);
548
549 AST_MUTEX_DEFINE_STATIC(sip_reload_lock);
550
551 /*! \brief This is the thread for the monitor which checks for input on the channels
552    which are not currently in use.  */
553 static pthread_t monitor_thread = AST_PTHREADT_NULL;
554
555 static int sip_reloading = FALSE;                       /*!< Flag for avoiding multiple reloads at the same time */
556 static enum channelreloadreason sip_reloadreason;       /*!< Reason for last reload/load of configuration */
557
558 static struct sched_context *sched;     /*!< The scheduling context */
559 static struct io_context *io;           /*!< The IO context */
560
561 #define DEC_CALL_LIMIT  0
562 #define INC_CALL_LIMIT  1
563 #define DEC_CALL_RINGING 2
564 #define INC_CALL_RINGING 3
565
566 /*! \brief sip_request: The data grabbed from the UDP socket */
567 struct sip_request {
568         char *rlPart1;          /*!< SIP Method Name or "SIP/2.0" protocol version */
569         char *rlPart2;          /*!< The Request URI or Response Status */
570         int len;                /*!< Length */
571         int headers;            /*!< # of SIP Headers */
572         int method;             /*!< Method of this request */
573         int lines;              /*!< Body Content */
574         unsigned int flags;     /*!< SIP_PKT Flags for this packet */
575         char *header[SIP_MAX_HEADERS];
576         char *line[SIP_MAX_LINES];
577         char data[SIP_MAX_PACKET];
578         unsigned int sdp_start; /*!< the line number where the SDP begins */
579         unsigned int sdp_end;   /*!< the line number where the SDP ends */
580 };
581
582 /*
583  * A sip packet is stored into the data[] buffer, with the header followed
584  * by an empty line and the body of the message.
585  * On outgoing packets, data is accumulated in data[] with len reflecting
586  * the next available byte, headers and lines count the number of lines
587  * in both parts. There are no '\0' in data[0..len-1].
588  *
589  * On received packet, the input read from the socket is copied into data[],
590  * len is set and the string is NUL-terminated. Then a parser fills up
591  * the other fields -header[] and line[] to point to the lines of the
592  * message, rlPart1 and rlPart2 parse the first lnie as below:
593  *
594  * Requests have in the first line      METHOD URI SIP/2.0
595  *      rlPart1 = method; rlPart2 = uri;
596  * Responses have in the first line     SIP/2.0 code description
597  *      rlPart1 = SIP/2.0; rlPart2 = code + description;
598  *
599  */
600
601 /*! \brief structure used in transfers */
602 struct sip_dual {
603         struct ast_channel *chan1;      /*!< First channel involved */
604         struct ast_channel *chan2;      /*!< Second channel involved */
605         struct sip_request req;         /*!< Request that caused the transfer (REFER) */
606         int seqno;                      /*!< Sequence number */
607 };
608
609 struct sip_pkt;
610
611 /*! \brief Parameters to the transmit_invite function */
612 struct sip_invite_param {
613         const char *distinctive_ring;   /*!< Distinctive ring header */
614         int addsipheaders;              /*!< Add extra SIP headers */
615         const char *uri_options;        /*!< URI options to add to the URI */
616         const char *vxml_url;           /*!< VXML url for Cisco phones */
617         char *auth;                     /*!< Authentication */
618         char *authheader;               /*!< Auth header */
619         enum sip_auth_type auth_type;   /*!< Authentication type */
620         const char *replaces;           /*!< Replaces header for call transfers */
621         int transfer;                   /*!< Flag - is this Invite part of a SIP transfer? (invite/replaces) */
622 };
623
624 /*! \brief Structure to save routing information for a SIP session */
625 struct sip_route {
626         struct sip_route *next;
627         char hop[0];
628 };
629
630 /*! \brief Modes for SIP domain handling in the PBX */
631 enum domain_mode {
632         SIP_DOMAIN_AUTO,                /*!< This domain is auto-configured */
633         SIP_DOMAIN_CONFIG,              /*!< This domain is from configuration */
634 };
635
636 struct domain {
637         char domain[MAXHOSTNAMELEN];            /*!< SIP domain we are responsible for */
638         char context[AST_MAX_EXTENSION];        /*!< Incoming context for this domain */
639         enum domain_mode mode;                  /*!< How did we find this domain? */
640         AST_LIST_ENTRY(domain) list;            /*!< List mechanics */
641 };
642
643 static AST_LIST_HEAD_STATIC(domain_list, domain);       /*!< The SIP domain list */
644
645
646 /*! \brief sip_history: Structure for saving transactions within a SIP dialog */
647 struct sip_history {
648         AST_LIST_ENTRY(sip_history) list;
649         char event[0];  /* actually more, depending on needs */
650 };
651
652 AST_LIST_HEAD_NOLOCK(sip_history_head, sip_history); /*!< history list, entry in sip_pvt */
653
654 /*! \brief sip_auth: Creadentials for authentication to other SIP services */
655 struct sip_auth {
656         char realm[AST_MAX_EXTENSION];  /*!< Realm in which these credentials are valid */
657         char username[256];             /*!< Username */
658         char secret[256];               /*!< Secret */
659         char md5secret[256];            /*!< MD5Secret */
660         struct sip_auth *next;          /*!< Next auth structure in list */
661 };
662
663 /*--- Various flags for the flags field in the pvt structure */
664 #define SIP_ALREADYGONE         (1 << 0)        /*!< Whether or not we've already been destroyed by our peer */
665 #define SIP_NEEDDESTROY         (1 << 1)        /*!< if we need to be destroyed by the monitor thread */
666 #define SIP_NOVIDEO             (1 << 2)        /*!< Didn't get video in invite, don't offer */
667 #define SIP_RINGING             (1 << 3)        /*!< Have sent 180 ringing */
668 #define SIP_PROGRESS_SENT       (1 << 4)        /*!< Have sent 183 message progress */
669 #define SIP_NEEDREINVITE        (1 << 5)        /*!< Do we need to send another reinvite? */
670 #define SIP_PENDINGBYE          (1 << 6)        /*!< Need to send bye after we ack? */
671 #define SIP_GOTREFER            (1 << 7)        /*!< Got a refer? */
672 #define SIP_PROMISCREDIR        (1 << 8)        /*!< Promiscuous redirection */
673 #define SIP_TRUSTRPID           (1 << 9)        /*!< Trust RPID headers? */
674 #define SIP_USEREQPHONE         (1 << 10)       /*!< Add user=phone to numeric URI. Default off */
675 #define SIP_REALTIME            (1 << 11)       /*!< Flag for realtime users */
676 #define SIP_USECLIENTCODE       (1 << 12)       /*!< Trust X-ClientCode info message */
677 #define SIP_OUTGOING            (1 << 13)       /*!< Is this an outgoing call? */
678 #define SIP_CAN_BYE             (1 << 14)       /*!< Can we send BYE on this dialog? */
679 #define SIP_DEFER_BYE_ON_TRANSFER       (1 << 15)       /*!< Do not hangup at first ast_hangup */
680 #define SIP_DTMF                (3 << 16)       /*!< DTMF Support: four settings, uses two bits */
681 #define SIP_DTMF_RFC2833        (0 << 16)       /*!< DTMF Support: RTP DTMF - "rfc2833" */
682 #define SIP_DTMF_INBAND         (1 << 16)       /*!< DTMF Support: Inband audio, only for ULAW/ALAW - "inband" */
683 #define SIP_DTMF_INFO           (2 << 16)       /*!< DTMF Support: SIP Info messages - "info" */
684 #define SIP_DTMF_AUTO           (3 << 16)       /*!< DTMF Support: AUTO switch between rfc2833 and in-band DTMF */
685 /* NAT settings */
686 #define SIP_NAT                 (3 << 18)       /*!< four settings, uses two bits */
687 #define SIP_NAT_NEVER           (0 << 18)       /*!< No nat support */
688 #define SIP_NAT_RFC3581         (1 << 18)       /*!< NAT RFC3581 */
689 #define SIP_NAT_ROUTE           (2 << 18)       /*!< NAT Only ROUTE */
690 #define SIP_NAT_ALWAYS          (3 << 18)       /*!< NAT Both ROUTE and RFC3581 */
691 /* re-INVITE related settings */
692 #define SIP_REINVITE            (7 << 20)       /*!< three bits used */
693 #define SIP_CAN_REINVITE        (1 << 20)       /*!< allow peers to be reinvited to send media directly p2p */
694 #define SIP_CAN_REINVITE_NAT    (2 << 20)       /*!< allow media reinvite when new peer is behind NAT */
695 #define SIP_REINVITE_UPDATE     (4 << 20)       /*!< use UPDATE (RFC3311) when reinviting this peer */
696 /* "insecure" settings */
697 #define SIP_INSECURE_PORT       (1 << 23)       /*!< don't require matching port for incoming requests */
698 #define SIP_INSECURE_INVITE     (1 << 24)       /*!< don't require authentication for incoming INVITEs */
699 /* Sending PROGRESS in-band settings */
700 #define SIP_PROG_INBAND         (3 << 25)       /*!< three settings, uses two bits */
701 #define SIP_PROG_INBAND_NEVER   (0 << 25)
702 #define SIP_PROG_INBAND_NO      (1 << 25)
703 #define SIP_PROG_INBAND_YES     (2 << 25)
704 #define SIP_FREE_BIT            (1 << 27)       /*!< Undefined bit - not in use */
705 #define SIP_CALL_LIMIT          (1 << 28)       /*!< Call limit enforced for this call */
706 #define SIP_SENDRPID            (1 << 29)       /*!< Remote Party-ID Support */
707 #define SIP_INC_COUNT           (1 << 30)       /*!< Did this connection increment the counter of in-use calls? */
708
709 #define SIP_FLAGS_TO_COPY \
710         (SIP_PROMISCREDIR | SIP_TRUSTRPID | SIP_SENDRPID | SIP_DTMF | SIP_REINVITE | \
711          SIP_PROG_INBAND | SIP_USECLIENTCODE | SIP_NAT | \
712          SIP_USEREQPHONE | SIP_INSECURE_PORT | SIP_INSECURE_INVITE)
713
714 /* a new page of flags */
715 /* realtime flags */
716 #define SIP_PAGE2_RTCACHEFRIENDS        (1 << 0)
717 #define SIP_PAGE2_RTUPDATE              (1 << 1)
718 #define SIP_PAGE2_RTAUTOCLEAR           (1 << 2)
719 #define SIP_PAGE2_RT_FROMCONTACT        (1 << 4)
720 #define SIP_PAGE2_RTSAVE_SYSNAME        (1 << 5)
721 /* Space for addition of other realtime flags in the future */
722 #define SIP_PAGE2_IGNOREREGEXPIRE       (1 << 10)
723 #define SIP_PAGE2_DEBUG                 (3 << 11)
724 #define SIP_PAGE2_DEBUG_CONFIG          (1 << 11)
725 #define SIP_PAGE2_DEBUG_CONSOLE         (1 << 12)
726 #define SIP_PAGE2_DYNAMIC               (1 << 13)       /*!< Dynamic Peers register with Asterisk */
727 #define SIP_PAGE2_SELFDESTRUCT          (1 << 14)       /*!< Automatic peers need to destruct themselves */
728 #define SIP_PAGE2_VIDEOSUPPORT          (1 << 15)
729 #define SIP_PAGE2_ALLOWSUBSCRIBE        (1 << 16)       /*!< Allow subscriptions from this peer? */
730 #define SIP_PAGE2_ALLOWOVERLAP          (1 << 17)       /*!< Allow overlap dialing ? */
731 #define SIP_PAGE2_SUBSCRIBEMWIONLY      (1 << 18)       /*!< Only issue MWI notification if subscribed to */
732 #define SIP_PAGE2_INC_RINGING           (1 << 19)       /*!< Did this connection increment the counter of in-use calls? */
733 #define SIP_PAGE2_T38SUPPORT            (7 << 20)       /*!< T38 Fax Passthrough Support */
734 #define SIP_PAGE2_T38SUPPORT_UDPTL      (1 << 20)       /*!< 20: T38 Fax Passthrough Support */
735 #define SIP_PAGE2_T38SUPPORT_RTP        (2 << 20)       /*!< 21: T38 Fax Passthrough Support */
736 #define SIP_PAGE2_T38SUPPORT_TCP        (4 << 20)       /*!< 22: T38 Fax Passthrough Support */
737 #define SIP_PAGE2_CALL_ONHOLD           (3 << 23)       /*!< Call states */
738 #define SIP_PAGE2_CALL_ONHOLD_ONEDIR    (1 << 23)       /*!< 23: One directional hold */
739 #define SIP_PAGE2_CALL_ONHOLD_INACTIVE  (2 << 24)       /*!< 24: Inactive  */
740
741 #define SIP_PAGE2_FLAGS_TO_COPY \
742         (SIP_PAGE2_ALLOWSUBSCRIBE | SIP_PAGE2_ALLOWOVERLAP | SIP_PAGE2_VIDEOSUPPORT | SIP_PAGE2_T38SUPPORT)
743
744 /* SIP packet flags */
745 #define SIP_PKT_DEBUG           (1 << 0)        /*!< Debug this packet */
746 #define SIP_PKT_WITH_TOTAG      (1 << 1)        /*!< This packet has a to-tag */
747 #define SIP_PKT_IGNORE          (1 << 2)        /*!< This is a re-transmit, ignore it */
748 #define SIP_PKT_IGNORE_RESP     (1 << 3)        /*!< Resp ignore - ??? */
749 #define SIP_PKT_IGNORE_REQ      (1 << 4)        /*!< Req ignore - ??? */
750
751 /* T.38 set of flags */
752 #define T38FAX_FILL_BIT_REMOVAL         (1 << 0)        /*!< Default: 0 (unset)*/
753 #define T38FAX_TRANSCODING_MMR                  (1 << 1)        /*!< Default: 0 (unset)*/
754 #define T38FAX_TRANSCODING_JBIG         (1 << 2)        /*!< Default: 0 (unset)*/
755 /* Rate management */
756 #define T38FAX_RATE_MANAGEMENT_TRANSFERED_TCF   (0 << 3)
757 #define T38FAX_RATE_MANAGEMENT_LOCAL_TCF        (1 << 3)        /*!< Unset for transferredTCF (UDPTL), set for localTCF (TPKT) */
758 /* UDP Error correction */
759 #define T38FAX_UDP_EC_NONE                      (0 << 4)        /*!< two bits, if unset NO t38UDPEC field in T38 SDP*/
760 #define T38FAX_UDP_EC_FEC                       (1 << 4)        /*!< Set for t38UDPFEC */
761 #define T38FAX_UDP_EC_REDUNDANCY                (2 << 4)        /*!< Set for t38UDPRedundancy */
762 /* T38 Spec version */
763 #define T38FAX_VERSION                          (3 << 6)        /*!< two bits, 2 values so far, up to 4 values max */
764 #define T38FAX_VERSION_0                        (0 << 6)        /*!< Version 0 */
765 #define T38FAX_VERSION_1                        (1 << 6)        /*!< Version 1 */
766 /* Maximum Fax Rate */
767 #define T38FAX_RATE_2400                        (1 << 8)        /*!< 2400 bps t38FaxRate */
768 #define T38FAX_RATE_4800                        (1 << 9)        /*!< 4800 bps t38FaxRate */
769 #define T38FAX_RATE_7200                        (1 << 10)       /*!< 7200 bps t38FaxRate */
770 #define T38FAX_RATE_9600                        (1 << 11)       /*!< 9600 bps t38FaxRate */
771 #define T38FAX_RATE_12000                       (1 << 12)       /*!< 12000 bps t38FaxRate */
772 #define T38FAX_RATE_14400                       (1 << 13)       /*!< 14400 bps t38FaxRate */
773
774 /*!< This is default: NO MMR and JBIG trancoding, NO fill bit removal, transferredTCF TCF, UDP FEC, Version 0 and 9600 max fax rate */
775 static int global_t38_capability = T38FAX_VERSION_0 | T38FAX_RATE_2400 | T38FAX_RATE_4800 | T38FAX_RATE_7200 | T38FAX_RATE_9600;
776
777 #define sipdebug                ast_test_flag(&global_flags[1], SIP_PAGE2_DEBUG)
778 #define sipdebug_config         ast_test_flag(&global_flags[1], SIP_PAGE2_DEBUG_CONFIG)
779 #define sipdebug_console        ast_test_flag(&global_flags[1], SIP_PAGE2_DEBUG_CONSOLE)
780
781 /*! \brief T38 Sates for a call */
782 enum t38state {
783         T38_DISABLED = 0,               /*! Not enabled */
784         T38_LOCAL_DIRECT,               /*! Offered from local */
785         T38_LOCAL_REINVITE,             /*! Offered from local - REINVITE */
786         T38_PEER_DIRECT,                /*! Offered from peer */
787         T38_PEER_REINVITE,              /*! Offered from peer - REINVITE */
788         T38_ENABLED                     /*! Negotiated (enabled) */
789 };
790
791 /*! \brief T.38 channel settings (at some point we need to make this alloc'ed */
792 struct t38properties {
793         struct ast_flags t38support;    /*!< Flag for udptl, rtp or tcp support for this session */
794         int capability;                 /*!< Our T38 capability */
795         int peercapability;             /*!< Peers T38 capability */
796         int jointcapability;            /*!< Supported T38 capability at both ends */
797         enum t38state state;            /*!< T.38 state */
798 };
799
800 /*! \brief Parameters to know status of transfer */
801 enum referstatus {
802         REFER_IDLE,             /*!< No REFER is in progress */
803         REFER_SENT,             /*!< Sent REFER to transferee */
804         REFER_RECEIVED,         /*!< Received REFER from transferer */
805         REFER_CONFIRMED,        /*!< Refer confirmed with a 100 TRYING */
806         REFER_ACCEPTED,         /*!< Accepted by transferee */
807         REFER_RINGING,          /*!< Target Ringing */
808         REFER_200OK,            /*!< Answered by transfer target */
809         REFER_FAILED,           /*!< REFER declined - go on */
810         REFER_NOAUTH            /*!< We had no auth for REFER */
811 };
812
813 static const struct c_referstatusstring {
814         enum referstatus status;
815         char *text;
816 } referstatusstrings[] = {
817         { REFER_IDLE,           "<none>" },
818         { REFER_SENT,           "Request sent" },
819         { REFER_RECEIVED,       "Request received" },
820         { REFER_ACCEPTED,       "Accepted" },
821         { REFER_RINGING,        "Target ringing" },
822         { REFER_200OK,          "Done" },
823         { REFER_FAILED,         "Failed" },
824         { REFER_NOAUTH,         "Failed - auth failure" }
825 } ;
826
827 /*! \brief Structure to handle SIP transfers. Dynamically allocated when needed  */
828 /* OEJ: Should be moved to string fields */
829 struct sip_refer {
830         char refer_to[AST_MAX_EXTENSION];               /*!< Place to store REFER-TO extension */
831         char refer_to_domain[AST_MAX_EXTENSION];        /*!< Place to store REFER-TO domain */
832         char refer_to_urioption[AST_MAX_EXTENSION];     /*!< Place to store REFER-TO uri options */
833         char refer_to_context[AST_MAX_EXTENSION];       /*!< Place to store REFER-TO context */
834         char referred_by[AST_MAX_EXTENSION];            /*!< Place to store REFERRED-BY extension */
835         char referred_by_name[AST_MAX_EXTENSION];       /*!< Place to store REFERRED-BY extension */
836         char refer_contact[AST_MAX_EXTENSION];          /*!< Place to store Contact info from a REFER extension */
837         char replaces_callid[BUFSIZ];                   /*!< Replace info: callid */
838         char replaces_callid_totag[BUFSIZ/2];           /*!< Replace info: to-tag */
839         char replaces_callid_fromtag[BUFSIZ/2];         /*!< Replace info: from-tag */
840         struct sip_pvt *refer_call;                     /*!< Call we are referring */
841         int attendedtransfer;                           /*!< Attended or blind transfer? */
842         int localtransfer;                              /*!< Transfer to local domain? */
843         enum referstatus status;                        /*!< REFER status */
844 };
845
846 /*! \brief sip_pvt: PVT structures are used for each SIP dialog, ie. a call, a registration, a subscribe  */
847 static struct sip_pvt {
848         ast_mutex_t lock;                       /*!< Dialog private lock */
849         int method;                             /*!< SIP method that opened this dialog */
850         AST_DECLARE_STRING_FIELDS(
851                 AST_STRING_FIELD(callid);       /*!< Global CallID */
852                 AST_STRING_FIELD(randdata);     /*!< Random data */
853                 AST_STRING_FIELD(accountcode);  /*!< Account code */
854                 AST_STRING_FIELD(realm);        /*!< Authorization realm */
855                 AST_STRING_FIELD(nonce);        /*!< Authorization nonce */
856                 AST_STRING_FIELD(opaque);       /*!< Opaque nonsense */
857                 AST_STRING_FIELD(qop);          /*!< Quality of Protection, since SIP wasn't complicated enough yet. */
858                 AST_STRING_FIELD(domain);       /*!< Authorization domain */
859                 AST_STRING_FIELD(from);         /*!< The From: header */
860                 AST_STRING_FIELD(useragent);    /*!< User agent in SIP request */
861                 AST_STRING_FIELD(exten);        /*!< Extension where to start */
862                 AST_STRING_FIELD(context);      /*!< Context for this call */
863                 AST_STRING_FIELD(subscribecontext); /*!< Subscribecontext */
864                 AST_STRING_FIELD(subscribeuri); /*!< Subscribecontext */
865                 AST_STRING_FIELD(fromdomain);   /*!< Domain to show in the from field */
866                 AST_STRING_FIELD(fromuser);     /*!< User to show in the user field */
867                 AST_STRING_FIELD(fromname);     /*!< Name to show in the user field */
868                 AST_STRING_FIELD(tohost);       /*!< Host we should put in the "to" field */
869                 AST_STRING_FIELD(language);     /*!< Default language for this call */
870                 AST_STRING_FIELD(musicclass);   /*!< Music on Hold class */
871                 AST_STRING_FIELD(rdnis);        /*!< Referring DNIS */
872                 AST_STRING_FIELD(theirtag);     /*!< Their tag */
873                 AST_STRING_FIELD(username);     /*!< [user] name */
874                 AST_STRING_FIELD(peername);     /*!< [peer] name, not set if [user] */
875                 AST_STRING_FIELD(authname);     /*!< Who we use for authentication */
876                 AST_STRING_FIELD(uri);          /*!< Original requested URI */
877                 AST_STRING_FIELD(okcontacturi); /*!< URI from the 200 OK on INVITE */
878                 AST_STRING_FIELD(peersecret);   /*!< Password */
879                 AST_STRING_FIELD(peermd5secret);
880                 AST_STRING_FIELD(cid_num);      /*!< Caller*ID number */
881                 AST_STRING_FIELD(cid_name);     /*!< Caller*ID name */
882                 AST_STRING_FIELD(via);          /*!< Via: header */
883                 AST_STRING_FIELD(fullcontact);  /*!< The Contact: that the UA registers with us */
884                 AST_STRING_FIELD(our_contact);  /*!< Our contact header */
885                 AST_STRING_FIELD(rpid);         /*!< Our RPID header */
886                 AST_STRING_FIELD(rpid_from);    /*!< Our RPID From header */
887         );
888         unsigned int ocseq;                     /*!< Current outgoing seqno */
889         unsigned int icseq;                     /*!< Current incoming seqno */
890         ast_group_t callgroup;                  /*!< Call group */
891         ast_group_t pickupgroup;                /*!< Pickup group */
892         int lastinvite;                         /*!< Last Cseq of invite */
893         struct ast_flags flags[2];              /*!< SIP_ flags */
894         int timer_t1;                           /*!< SIP timer T1, ms rtt */
895         unsigned int sipoptions;                /*!< Supported SIP options on the other end */
896         struct ast_codec_pref prefs;            /*!< codec prefs */
897         int capability;                         /*!< Special capability (codec) */
898         int jointcapability;                    /*!< Supported capability at both ends (codecs ) */
899         int peercapability;                     /*!< Supported peer capability */
900         int prefcodec;                          /*!< Preferred codec (outbound only) */
901         int noncodeccapability;                 /*!< DTMF RFC2833 telephony-event */
902         int redircodecs;                        /*!< Redirect codecs */
903         int maxcallbitrate;                     /*!< Maximum Call Bitrate for Video Calls */    
904         struct t38properties t38;               /*!< T38 settings */
905         struct sockaddr_in udptlredirip;        /*!< Where our T.38 UDPTL should be going if not to us */
906         struct ast_udptl *udptl;                /*!< T.38 UDPTL session */
907         int callingpres;                        /*!< Calling presentation */
908         int authtries;                          /*!< Times we've tried to authenticate */
909         int expiry;                             /*!< How long we take to expire */
910         long branch;                            /*!< The branch identifier of this session */
911         char tag[11];                           /*!< Our tag for this session */
912         int sessionid;                          /*!< SDP Session ID */
913         int sessionversion;                     /*!< SDP Session Version */
914         struct sockaddr_in sa;                  /*!< Our peer */
915         struct sockaddr_in redirip;             /*!< Where our RTP should be going if not to us */
916         struct sockaddr_in vredirip;            /*!< Where our Video RTP should be going if not to us */
917         time_t lastrtprx;                       /*!< Last RTP received */
918         time_t lastrtptx;                       /*!< Last RTP sent */
919         int rtptimeout;                         /*!< RTP timeout time */
920         int rtpholdtimeout;                     /*!< RTP timeout when on hold */
921         int rtpkeepalive;                       /*!< Send RTP packets for keepalive */
922         struct sockaddr_in recv;                /*!< Received as */
923         struct in_addr ourip;                   /*!< Our IP */
924         struct ast_channel *owner;              /*!< Who owns us (if we have an owner) */
925         struct sip_route *route;                /*!< Head of linked list of routing steps (fm Record-Route) */
926         int route_persistant;                   /*!< Is this the "real" route? */
927         struct sip_auth *peerauth;              /*!< Realm authentication */
928         int noncecount;                         /*!< Nonce-count */
929         char lastmsg[256];                      /*!< Last Message sent/received */
930         int amaflags;                           /*!< AMA Flags */
931         int pendinginvite;                      /*!< Any pending invite ? (seqno of this) */
932         struct sip_request initreq;             /*!< Initial request that opened the SIP dialog */
933         
934         int maxtime;                            /*!< Max time for first response */
935         int initid;                             /*!< Auto-congest ID if appropriate (scheduler) */
936         int autokillid;                         /*!< Auto-kill ID (scheduler) */
937         enum transfermodes allowtransfer;       /*!< REFER: restriction scheme */
938         struct sip_refer *refer;                /*!< REFER: SIP transfer data structure */
939         enum subscriptiontype subscribed;       /*!< SUBSCRIBE: Is this dialog a subscription?  */
940         int stateid;                            /*!< SUBSCRIBE: ID for devicestate subscriptions */
941         int laststate;                          /*!< SUBSCRIBE: Last known extension state */
942         int dialogver;                          /*!< SUBSCRIBE: Version for subscription dialog-info */
943         
944         struct ast_dsp *vad;                    /*!< Voice Activation Detection dsp */
945         
946         struct sip_peer *relatedpeer;           /*!< If this dialog is related to a peer, which one 
947                                                         Used in peerpoke, mwi subscriptions */
948         struct sip_registry *registry;          /*!< If this is a REGISTER dialog, to which registry */
949         struct ast_rtp *rtp;                    /*!< RTP Session */
950         struct ast_rtp *vrtp;                   /*!< Video RTP session */
951         struct sip_pkt *packets;                /*!< Packets scheduled for re-transmission */
952         struct sip_history_head *history;       /*!< History of this SIP dialog */
953         struct ast_variable *chanvars;          /*!< Channel variables to set for inbound call */
954         struct sip_pvt *next;                   /*!< Next dialog in chain */
955         struct sip_invite_param *options;       /*!< Options for INVITE */
956 } *iflist = NULL;
957
958 #define FLAG_RESPONSE (1 << 0)
959 #define FLAG_FATAL (1 << 1)
960
961 /*! \brief sip packet - raw format for outbound packets that are sent or scheduled for transmission */
962 struct sip_pkt {
963         struct sip_pkt *next;                   /*!< Next packet in linked list */
964         int retrans;                            /*!< Retransmission number */
965         int method;                             /*!< SIP method for this packet */
966         int seqno;                              /*!< Sequence number */
967         unsigned int flags;                     /*!< non-zero if this is a response packet (e.g. 200 OK) */
968         struct sip_pvt *owner;                  /*!< Owner AST call */
969         int retransid;                          /*!< Retransmission ID */
970         int timer_a;                            /*!< SIP timer A, retransmission timer */
971         int timer_t1;                           /*!< SIP Timer T1, estimated RTT or 500 ms */
972         int packetlen;                          /*!< Length of packet */
973         char data[0];
974 };      
975
976 /*! \brief Structure for SIP user data. User's place calls to us */
977 struct sip_user {
978         /* Users who can access various contexts */
979         ASTOBJ_COMPONENTS(struct sip_user);
980         char secret[80];                /*!< Password */
981         char md5secret[80];             /*!< Password in md5 */
982         char context[AST_MAX_CONTEXT];  /*!< Default context for incoming calls */
983         char subscribecontext[AST_MAX_CONTEXT]; /* Default context for subscriptions */
984         char cid_num[80];               /*!< Caller ID num */
985         char cid_name[80];              /*!< Caller ID name */
986         char accountcode[AST_MAX_ACCOUNT_CODE]; /* Account code */
987         char language[MAX_LANGUAGE];    /*!< Default language for this user */
988         char musicclass[MAX_MUSICCLASS];/*!< Music on Hold class */
989         char useragent[256];            /*!< User agent in SIP request */
990         struct ast_codec_pref prefs;    /*!< codec prefs */
991         ast_group_t callgroup;          /*!< Call group */
992         ast_group_t pickupgroup;        /*!< Pickup Group */
993         unsigned int sipoptions;        /*!< Supported SIP options */
994         struct ast_flags flags[2];      /*!< SIP_ flags */
995         int amaflags;                   /*!< AMA flags for billing */
996         int callingpres;                /*!< Calling id presentation */
997         int capability;                 /*!< Codec capability */
998         int inUse;                      /*!< Number of calls in use */
999         int call_limit;                 /*!< Limit of concurrent calls */
1000         enum transfermodes allowtransfer;       /*! SIP Refer restriction scheme */
1001         struct ast_ha *ha;              /*!< ACL setting */
1002         struct ast_variable *chanvars;  /*!< Variables to set for channel created by user */
1003         int maxcallbitrate;             /*!< Maximum Bitrate for a video call */
1004 };
1005
1006 /*! \brief Structure for SIP peer data, we place calls to peers if registered  or fixed IP address (host) */
1007 /* XXX field 'name' must be first otherwise sip_addrcmp() will fail */
1008 struct sip_peer {
1009         ASTOBJ_COMPONENTS(struct sip_peer);     /*!< name, refcount, objflags,  object pointers */
1010                                         /*!< peer->name is the unique name of this object */
1011         char secret[80];                /*!< Password */
1012         char md5secret[80];             /*!< Password in MD5 */
1013         struct sip_auth *auth;          /*!< Realm authentication list */
1014         char context[AST_MAX_CONTEXT];  /*!< Default context for incoming calls */
1015         char subscribecontext[AST_MAX_CONTEXT]; /*!< Default context for subscriptions */
1016         char username[80];              /*!< Temporary username until registration */ 
1017         char accountcode[AST_MAX_ACCOUNT_CODE]; /*!< Account code */
1018         int amaflags;                   /*!< AMA Flags (for billing) */
1019         char tohost[MAXHOSTNAMELEN];    /*!< If not dynamic, IP address */
1020         char regexten[AST_MAX_EXTENSION]; /*!< Extension to register (if regcontext is used) */
1021         char fromuser[80];              /*!< From: user when calling this peer */
1022         char fromdomain[MAXHOSTNAMELEN];        /*!< From: domain when calling this peer */
1023         char fullcontact[256];          /*!< Contact registered with us (not in sip.conf) */
1024         char cid_num[80];               /*!< Caller ID num */
1025         char cid_name[80];              /*!< Caller ID name */
1026         int callingpres;                /*!< Calling id presentation */
1027         int inUse;                      /*!< Number of calls in use */
1028         int inRinging;                  /*!< Number of calls ringing */
1029         int call_limit;                 /*!< Limit of concurrent calls */
1030         enum transfermodes allowtransfer;       /*! SIP Refer restriction scheme */
1031         char vmexten[AST_MAX_EXTENSION]; /*!< Dialplan extension for MWI notify message*/
1032         char mailbox[AST_MAX_EXTENSION]; /*!< Mailbox setting for MWI checks */
1033         char language[MAX_LANGUAGE];    /*!<  Default language for prompts */
1034         char musicclass[MAX_MUSICCLASS];/*!<  Music on Hold class */
1035         char useragent[256];            /*!<  User agent in SIP request (saved from registration) */
1036         struct ast_codec_pref prefs;    /*!<  codec prefs */
1037         int lastmsgssent;
1038         time_t  lastmsgcheck;           /*!<  Last time we checked for MWI */
1039         unsigned int sipoptions;        /*!<  Supported SIP options */
1040         struct ast_flags flags[2];      /*!<  SIP_ flags */
1041         int expire;                     /*!<  When to expire this peer registration */
1042         int capability;                 /*!<  Codec capability */
1043         int rtptimeout;                 /*!<  RTP timeout */
1044         int rtpholdtimeout;             /*!<  RTP Hold Timeout */
1045         int rtpkeepalive;               /*!<  Send RTP packets for keepalive */
1046         ast_group_t callgroup;          /*!<  Call group */
1047         ast_group_t pickupgroup;        /*!<  Pickup group */
1048         struct ast_dnsmgr_entry *dnsmgr;/*!<  DNS refresh manager for peer */
1049         struct sockaddr_in addr;        /*!<  IP address of peer */
1050         int maxcallbitrate;             /*!< Maximum Bitrate for a video call */
1051         
1052         /* Qualification */
1053         struct sip_pvt *call;           /*!<  Call pointer */
1054         int pokeexpire;                 /*!<  When to expire poke (qualify= checking) */
1055         int lastms;                     /*!<  How long last response took (in ms), or -1 for no response */
1056         int maxms;                      /*!<  Max ms we will accept for the host to be up, 0 to not monitor */
1057         struct timeval ps;              /*!<  Ping send time */
1058         
1059         struct sockaddr_in defaddr;     /*!<  Default IP address, used until registration */
1060         struct ast_ha *ha;              /*!<  Access control list */
1061         struct ast_variable *chanvars;  /*!<  Variables to set for channel created by user */
1062         struct sip_pvt *mwipvt;         /*!<  Subscription for MWI */
1063         int lastmsg;
1064 };
1065
1066
1067
1068 /*! \brief Registrations with other SIP proxies */
1069 struct sip_registry {
1070         ASTOBJ_COMPONENTS_FULL(struct sip_registry,1,1);
1071         AST_DECLARE_STRING_FIELDS(
1072                 AST_STRING_FIELD(callid);       /*!< Global Call-ID */
1073                 AST_STRING_FIELD(realm);        /*!< Authorization realm */
1074                 AST_STRING_FIELD(nonce);        /*!< Authorization nonce */
1075                 AST_STRING_FIELD(opaque);       /*!< Opaque nonsense */
1076                 AST_STRING_FIELD(qop);          /*!< Quality of Protection, since SIP wasn't complicated enough yet. */
1077                 AST_STRING_FIELD(domain);       /*!< Authorization domain */
1078                 AST_STRING_FIELD(username);     /*!< Who we are registering as */
1079                 AST_STRING_FIELD(authuser);     /*!< Who we *authenticate* as */
1080                 AST_STRING_FIELD(hostname);     /*!< Domain or host we register to */
1081                 AST_STRING_FIELD(secret);       /*!< Password in clear text */  
1082                 AST_STRING_FIELD(md5secret);    /*!< Password in md5 */
1083                 AST_STRING_FIELD(contact);      /*!< Contact extension */
1084                 AST_STRING_FIELD(random);
1085         );
1086         int portno;                     /*!<  Optional port override */
1087         int expire;                     /*!< Sched ID of expiration */
1088         int regattempts;                /*!< Number of attempts (since the last success) */
1089         int timeout;                    /*!< sched id of sip_reg_timeout */
1090         int refresh;                    /*!< How often to refresh */
1091         struct sip_pvt *call;           /*!< create a sip_pvt structure for each outbound "registration dialog" in progress */
1092         enum sipregistrystate regstate; /*!< Registration state (see above) */
1093         time_t regtime;         /*!< Last succesful registration time */
1094         int callid_valid;               /*!< 0 means we haven't chosen callid for this registry yet. */
1095         unsigned int ocseq;             /*!< Sequence number we got to for REGISTERs for this registry */
1096         struct sockaddr_in us;          /*!< Who the server thinks we are */
1097         int noncecount;                 /*!< Nonce-count */
1098         char lastmsg[256];              /*!< Last Message sent/received */
1099 };
1100
1101 /* --- Linked lists of various objects --------*/
1102
1103 /*! \brief  The user list: Users and friends */
1104 static struct ast_user_list {
1105         ASTOBJ_CONTAINER_COMPONENTS(struct sip_user);
1106 } userl;
1107
1108 /*! \brief  The peer list: Peers and Friends */
1109 static struct ast_peer_list {
1110         ASTOBJ_CONTAINER_COMPONENTS(struct sip_peer);
1111 } peerl;
1112
1113 /*! \brief  The register list: Other SIP proxys we register with and place calls to */
1114 static struct ast_register_list {
1115         ASTOBJ_CONTAINER_COMPONENTS(struct sip_registry);
1116         int recheck;
1117 } regl;
1118
1119 /*! \todo Move the sip_auth list to AST_LIST */
1120 static struct sip_auth *authl = NULL;           /*!< Authentication list for realm authentication */
1121
1122
1123 /* --- Sockets and networking --------------*/
1124 static int sipsock  = -1;                       /*!< Main socket for SIP network communication */
1125 static struct sockaddr_in bindaddr = { 0, };    /*!< The address we bind to */
1126 static struct sockaddr_in externip;             /*!< External IP address if we are behind NAT */
1127 static char externhost[MAXHOSTNAMELEN];         /*!< External host name (possibly with dynamic DNS and DHCP */
1128 static time_t externexpire = 0;                 /*!< Expiration counter for re-resolving external host name in dynamic DNS */
1129 static int externrefresh = 10;
1130 static struct ast_ha *localaddr;                /*!< List of local networks, on the same side of NAT as this Asterisk */
1131 static struct in_addr __ourip;
1132 static struct sockaddr_in outboundproxyip;
1133 static int ourport;
1134 static struct sockaddr_in debugaddr;
1135
1136 static struct ast_config *notify_types;         /*!< The list of manual NOTIFY types we know how to send */
1137
1138 /*---------------------------- Forward declarations of functions in chan_sip.c */
1139 /*! \note This is added to help splitting up chan_sip.c into several files
1140         in coming releases */
1141
1142 /*--- PBX interface functions */
1143 static struct ast_channel *sip_request_call(const char *type, int format, void *data, int *cause);
1144 static int sip_devicestate(void *data);
1145 static int sip_sendtext(struct ast_channel *ast, const char *text);
1146 static int sip_call(struct ast_channel *ast, char *dest, int timeout);
1147 static int sip_hangup(struct ast_channel *ast);
1148 static int sip_answer(struct ast_channel *ast);
1149 static struct ast_frame *sip_read(struct ast_channel *ast);
1150 static int sip_write(struct ast_channel *ast, struct ast_frame *frame);
1151 static int sip_indicate(struct ast_channel *ast, int condition, const void *data, size_t datalen);
1152 static int sip_transfer(struct ast_channel *ast, const char *dest);
1153 static int sip_fixup(struct ast_channel *oldchan, struct ast_channel *newchan);
1154 static int sip_senddigit(struct ast_channel *ast, char digit);
1155
1156 /*--- Transmitting responses and requests */
1157 static int sipsock_read(int *id, int fd, short events, void *ignore);
1158 static int __sip_xmit(struct sip_pvt *p, char *data, int len);
1159 static int __sip_reliable_xmit(struct sip_pvt *p, int seqno, int resp, char *data, int len, int fatal, int sipmethod);
1160 static int __transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1161 static int retrans_pkt(void *data);
1162 static int transmit_sip_request(struct sip_pvt *p, struct sip_request *req);
1163 static int transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1164 static int transmit_response_reliable(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1165 static int transmit_response_with_date(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1166 static int transmit_response_with_sdp(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1167 static int transmit_response_with_unsupported(struct sip_pvt *p, const char *msg, const struct sip_request *req, const char *unsupported);
1168 static int transmit_response_with_auth(struct sip_pvt *p, const char *msg, const struct sip_request *req, const char *rand, enum xmittype reliable, const char *header, int stale);
1169 static int transmit_response_with_allow(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1170 static void transmit_fake_auth_response(struct sip_pvt *p, struct sip_request *req, int reliable);
1171 static int transmit_request(struct sip_pvt *p, int sipmethod, int inc, enum xmittype reliable, int newbranch);
1172 static int transmit_request_with_auth(struct sip_pvt *p, int sipmethod, int seqno, enum xmittype reliable, int newbranch);
1173 static int transmit_invite(struct sip_pvt *p, int sipmethod, int sdp, int init);
1174 static int transmit_reinvite_with_sdp(struct sip_pvt *p);
1175 static int transmit_info_with_digit(struct sip_pvt *p, const char digit);
1176 static int transmit_info_with_vidupdate(struct sip_pvt *p);
1177 static int transmit_message_with_text(struct sip_pvt *p, const char *text);
1178 static int transmit_refer(struct sip_pvt *p, const char *dest);
1179 static int transmit_notify_with_mwi(struct sip_pvt *p, int newmsgs, int oldmsgs, char *vmexten);
1180 static int transmit_notify_with_sipfrag(struct sip_pvt *p, int cseq, char *message, int terminate);
1181 static int transmit_state_notify(struct sip_pvt *p, int state, int full);
1182 static int transmit_register(struct sip_registry *r, int sipmethod, const char *auth, const char *authheader);
1183 static int send_response(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno);
1184 static int send_request(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno);
1185 static void copy_request(struct sip_request *dst, const struct sip_request *src);
1186 static void receive_message(struct sip_pvt *p, struct sip_request *req);
1187 static void parse_moved_contact(struct sip_pvt *p, struct sip_request *req);
1188 static int sip_send_mwi_to_peer(struct sip_peer *peer);
1189 static int does_peer_need_mwi(struct sip_peer *peer);
1190
1191 /*--- Dialog management */
1192 static struct sip_pvt *sip_alloc(ast_string_field callid, struct sockaddr_in *sin,
1193                                  int useglobal_nat, const int intended_method);
1194 static int __sip_autodestruct(void *data);
1195 static void sip_scheddestroy(struct sip_pvt *p, int ms);
1196 static void sip_cancel_destroy(struct sip_pvt *p);
1197 static void sip_destroy(struct sip_pvt *p);
1198 static void __sip_destroy(struct sip_pvt *p, int lockowner);
1199 static void __sip_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod, int reset);
1200 static void __sip_pretend_ack(struct sip_pvt *p);
1201 static int __sip_semi_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod);
1202 static int auto_congest(void *nothing);
1203 static int update_call_counter(struct sip_pvt *fup, int event);
1204 static int hangup_sip2cause(int cause);
1205 static const char *hangup_cause2sip(int cause);
1206 static struct sip_pvt *find_call(struct sip_request *req, struct sockaddr_in *sin, const int intended_method);
1207 static void free_old_route(struct sip_route *route);
1208 static void list_route(struct sip_route *route);
1209 static void build_route(struct sip_pvt *p, struct sip_request *req, int backwards);
1210 static enum check_auth_result register_verify(struct sip_pvt *p, struct sockaddr_in *sin,
1211                                               struct sip_request *req, char *uri);
1212 static struct sip_pvt *get_sip_pvt_byid_locked(const char *callid, const char *totag, const char *fromtag);
1213 static void check_pendings(struct sip_pvt *p);
1214 static void *sip_park_thread(void *stuff);
1215 static int sip_park(struct ast_channel *chan1, struct ast_channel *chan2, struct sip_request *req, int seqno);
1216 static int sip_sipredirect(struct sip_pvt *p, const char *dest);
1217
1218 /*--- Codec handling / SDP */
1219 static void try_suggested_sip_codec(struct sip_pvt *p);
1220 static const char* get_sdp_iterate(int* start, struct sip_request *req, const char *name);
1221 static const char *get_sdp(struct sip_request *req, const char *name);
1222 static int find_sdp(struct sip_request *req);
1223 static int process_sdp(struct sip_pvt *p, struct sip_request *req);
1224 static void add_codec_to_sdp(const struct sip_pvt *p, int codec, int sample_rate,
1225                              char **m_buf, size_t *m_size, char **a_buf, size_t *a_size,
1226                              int debug);
1227 static void add_noncodec_to_sdp(const struct sip_pvt *p, int format, int sample_rate,
1228                                 char **m_buf, size_t *m_size, char **a_buf, size_t *a_size,
1229                                 int debug);
1230 static int add_sdp(struct sip_request *resp, struct sip_pvt *p);
1231
1232 /*--- Authentication stuff */
1233 static int do_proxy_auth(struct sip_pvt *p, struct sip_request *req, char *header, char *respheader, int sipmethod, int init);
1234 static int reply_digest(struct sip_pvt *p, struct sip_request *req, char *header, int sipmethod, char *digest, int digest_len);
1235 static int build_reply_digest(struct sip_pvt *p, int method, char *digest, int digest_len);
1236 static int clear_realm_authentication(struct sip_auth *authlist);       /* Clear realm authentication list (at reload) */
1237 static struct sip_auth *add_realm_authentication(struct sip_auth *authlist, char *configuration, int lineno);   /* Add realm authentication in list */
1238 static struct sip_auth *find_realm_authentication(struct sip_auth *authlist, const char *realm);        /* Find authentication for a specific realm */
1239 static enum check_auth_result check_auth(struct sip_pvt *p, struct sip_request *req, const char *username,
1240                                          const char *secret, const char *md5secret, int sipmethod,
1241                                          char *uri, enum xmittype reliable, int ignore);
1242 static enum check_auth_result check_user_full(struct sip_pvt *p, struct sip_request *req,
1243                                               int sipmethod, char *uri, enum xmittype reliable,
1244                                               struct sockaddr_in *sin, struct sip_peer **authpeer);
1245 static int check_user(struct sip_pvt *p, struct sip_request *req, int sipmethod, char *uri, enum xmittype reliable, struct sockaddr_in *sin);
1246 static int do_proxy_auth(struct sip_pvt *p, struct sip_request *req, char *header, char *respheader, int sipmethod, int init);
1247 static int build_reply_digest(struct sip_pvt *p, int method, char* digest, int digest_len);
1248
1249 /*--- Domain handling */
1250 static int check_sip_domain(const char *domain, char *context, size_t len); /* Check if domain is one of our local domains */
1251 static int add_sip_domain(const char *domain, const enum domain_mode mode, const char *context);
1252 static void clear_sip_domains(void);
1253
1254 /*--- SIP realm authentication */
1255 static struct sip_auth *add_realm_authentication(struct sip_auth *authlist, char *configuration, int lineno);
1256 static int clear_realm_authentication(struct sip_auth *authlist);
1257 static struct sip_auth *find_realm_authentication(struct sip_auth *authlist, const char *realm);
1258
1259 /*--- Misc functions */
1260 static int sip_do_reload(enum channelreloadreason reason);
1261 static int reload_config(enum channelreloadreason reason);
1262 static int expire_register(void *data);
1263 static int sip_sipredirect(struct sip_pvt *p, const char *dest);
1264 static void *do_monitor(void *data);
1265 static int restart_monitor(void);
1266 static int sip_send_mwi_to_peer(struct sip_peer *peer);
1267 static void sip_destroy(struct sip_pvt *p);
1268 static int sip_addrcmp(char *name, struct sockaddr_in *sin);    /* Support for peer matching */
1269 static int sip_refer_allocate(struct sip_pvt *p);
1270 static void ast_quiet_chan(struct ast_channel *chan);
1271 static int attempt_transfer(struct sip_dual *transferer, struct sip_dual *target);
1272
1273 /*--- Device monitoring and Device/extension state handling */
1274 static int cb_extensionstate(char *context, char* exten, int state, void *data);
1275 static int sip_devicestate(void *data);
1276 static int sip_poke_noanswer(void *data);
1277 static int sip_poke_peer(struct sip_peer *peer);
1278 static void sip_poke_all_peers(void);
1279
1280
1281 /*--- Applications, functions, CLI and manager command helpers */
1282 static const char *sip_nat_mode(const struct sip_pvt *p);
1283 static int sip_show_inuse(int fd, int argc, char *argv[]);
1284 static char *transfermode2str(enum transfermodes mode);
1285 static char *nat2str(int nat);
1286 static int peer_status(struct sip_peer *peer, char *status, int statuslen);
1287 static int sip_show_users(int fd, int argc, char *argv[]);
1288 static int _sip_show_peers(int fd, int *total, struct mansession *s, struct message *m, int argc, char *argv[]);
1289 static int manager_sip_show_peers( struct mansession *s, struct message *m );
1290 static int sip_show_peers(int fd, int argc, char *argv[]);
1291 static int sip_show_objects(int fd, int argc, char *argv[]);
1292 static void  print_group(int fd, unsigned int group, int crlf);
1293 static const char *dtmfmode2str(int mode);
1294 static const char *insecure2str(int port, int invite);
1295 static void cleanup_stale_contexts(char *new, char *old);
1296 static void print_codec_to_cli(int fd, struct ast_codec_pref *pref);
1297 static const char *domain_mode_to_text(const enum domain_mode mode);
1298 static int sip_show_domains(int fd, int argc, char *argv[]);
1299 static int _sip_show_peer(int type, int fd, struct mansession *s, struct message *m, int argc, char *argv[]);
1300 static int manager_sip_show_peer( struct mansession *s, struct message *m);
1301 static int sip_show_peer(int fd, int argc, char *argv[]);
1302 static int _sip_show_peer(int type, int fd, struct mansession *s, struct message *m, int argc, char *argv[]);
1303 static int sip_show_user(int fd, int argc, char *argv[]);
1304 static int sip_show_registry(int fd, int argc, char *argv[]);
1305 static int sip_show_settings(int fd, int argc, char *argv[]);
1306 static const char *subscription_type2str(enum subscriptiontype subtype);
1307 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
1308 static int __sip_show_channels(int fd, int argc, char *argv[], int subscriptions);
1309 static int sip_show_channels(int fd, int argc, char *argv[]);
1310 static int sip_show_subscriptions(int fd, int argc, char *argv[]);
1311 static int __sip_show_channels(int fd, int argc, char *argv[], int subscriptions);
1312 static char *complete_sipch(const char *line, const char *word, int pos, int state);
1313 static char *complete_sip_peer(const char *word, int state, int flags2);
1314 static char *complete_sip_show_peer(const char *line, const char *word, int pos, int state);
1315 static char *complete_sip_debug_peer(const char *line, const char *word, int pos, int state);
1316 static char *complete_sip_user(const char *word, int state, int flags2);
1317 static char *complete_sip_show_user(const char *line, const char *word, int pos, int state);
1318 static char *complete_sipnotify(const char *line, const char *word, int pos, int state);
1319 static char *complete_sip_prune_realtime_peer(const char *line, const char *word, int pos, int state);
1320 static char *complete_sip_prune_realtime_user(const char *line, const char *word, int pos, int state);
1321 static int sip_show_channel(int fd, int argc, char *argv[]);
1322 static int sip_show_history(int fd, int argc, char *argv[]);
1323 static int sip_do_debug_ip(int fd, int argc, char *argv[]);
1324 static int sip_do_debug_peer(int fd, int argc, char *argv[]);
1325 static int sip_do_debug(int fd, int argc, char *argv[]);
1326 static int sip_no_debug(int fd, int argc, char *argv[]);
1327 static int sip_notify(int fd, int argc, char *argv[]);
1328 static int sip_do_history(int fd, int argc, char *argv[]);
1329 static int sip_no_history(int fd, int argc, char *argv[]);
1330 static int func_header_read(struct ast_channel *chan, char *function, char *data, char *buf, size_t len);
1331 static int func_check_sipdomain(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len);
1332 static int function_sippeer(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len);
1333 static int function_sipchaninfo_read(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len);
1334 static int sip_dtmfmode(struct ast_channel *chan, void *data);
1335 static int sip_addheader(struct ast_channel *chan, void *data);
1336 static int sip_do_reload(enum channelreloadreason reason);
1337 static int sip_reload(int fd, int argc, char *argv[]);
1338
1339 /*--- Debugging 
1340         Functions for enabling debug per IP or fully, or enabling history logging for
1341         a SIP dialog
1342 */
1343 static void sip_dump_history(struct sip_pvt *dialog);   /* Dump history to LOG_DEBUG at end of dialog, before destroying data */
1344 static inline int sip_debug_test_addr(const struct sockaddr_in *addr);
1345 static inline int sip_debug_test_pvt(struct sip_pvt *p);
1346 static void append_history_full(struct sip_pvt *p, const char *fmt, ...);
1347 static void sip_dump_history(struct sip_pvt *dialog);
1348
1349 /*--- Device object handling */
1350 static struct sip_peer *temp_peer(const char *name);
1351 static struct sip_peer *build_peer(const char *name, struct ast_variable *v, int realtime);
1352 static struct sip_user *build_user(const char *name, struct ast_variable *v, int realtime);
1353 static int update_call_counter(struct sip_pvt *fup, int event);
1354 static void sip_destroy_peer(struct sip_peer *peer);
1355 static void sip_destroy_user(struct sip_user *user);
1356 static int sip_poke_peer(struct sip_peer *peer);
1357 static void set_peer_defaults(struct sip_peer *peer);
1358 static struct sip_peer *temp_peer(const char *name);
1359 static void register_peer_exten(struct sip_peer *peer, int onoff);
1360 static void sip_destroy_peer(struct sip_peer *peer);
1361 static void sip_destroy_user(struct sip_user *user);
1362 static struct sip_peer *find_peer(const char *peer, struct sockaddr_in *sin, int realtime);
1363 static struct sip_user *find_user(const char *name, int realtime);
1364 static int sip_poke_peer_s(void *data);
1365 static enum parse_register_result parse_register_contact(struct sip_pvt *pvt, struct sip_peer *p, struct sip_request *req);
1366 static int expire_register(void *data);
1367 static void reg_source_db(struct sip_peer *peer);
1368 static void destroy_association(struct sip_peer *peer);
1369 static int handle_common_options(struct ast_flags *flags, struct ast_flags *mask, struct ast_variable *v);
1370
1371 /* Realtime device support */
1372 static void realtime_update_peer(const char *peername, struct sockaddr_in *sin, const char *username, const char *fullcontact, int expirey);
1373 static struct sip_user *realtime_user(const char *username);
1374 static void update_peer(struct sip_peer *p, int expiry);
1375 static struct sip_peer *realtime_peer(const char *peername, struct sockaddr_in *sin);
1376 static int sip_prune_realtime(int fd, int argc, char *argv[]);
1377
1378 /*--- Internal UA client handling (outbound registrations) */
1379 static int ast_sip_ouraddrfor(struct in_addr *them, struct in_addr *us);
1380 static void sip_registry_destroy(struct sip_registry *reg);
1381 static int sip_register(char *value, int lineno);
1382 static char *regstate2str(enum sipregistrystate regstate);
1383 static int sip_reregister(void *data);
1384 static int __sip_do_register(struct sip_registry *r);
1385 static int sip_reg_timeout(void *data);
1386 static int do_register_auth(struct sip_pvt *p, struct sip_request *req, char *header, char *respheader);
1387 static int reply_digest(struct sip_pvt *p, struct sip_request *req, char *header, int sipmethod,  char *digest, int digest_len);
1388 static void sip_send_all_registers(void);
1389
1390 /*--- Parsing SIP requests and responses */
1391 static void append_date(struct sip_request *req);       /* Append date to SIP packet */
1392 static int determine_firstline_parts(struct sip_request *req);
1393 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
1394 static const char *gettag(const struct sip_request *req, const char *header, char *tagbuf, int tagbufsize);
1395 static int find_sip_method(const char *msg);
1396 static unsigned int parse_sip_options(struct sip_pvt *pvt, const char *supported);
1397 static void parse_request(struct sip_request *req);
1398 static const char *get_header(const struct sip_request *req, const char *name);
1399 static char *referstatus2str(enum referstatus rstatus);
1400 static int method_match(enum sipmethod id, const char *name);
1401 static void parse_copy(struct sip_request *dst, const struct sip_request *src);
1402 static char *get_in_brackets(char *tmp);
1403 static const char *find_alias(const char *name, const char *_default);
1404 static const char *__get_header(const struct sip_request *req, const char *name, int *start);
1405 static const char *get_header(const struct sip_request *req, const char *name);
1406 static int lws2sws(char *msgbuf, int len);
1407 static void extract_uri(struct sip_pvt *p, struct sip_request *req);
1408 static int get_refer_info(struct sip_pvt *transferer, struct sip_request *outgoing_req);
1409 static int get_also_info(struct sip_pvt *p, struct sip_request *oreq);
1410 static int parse_ok_contact(struct sip_pvt *pvt, struct sip_request *req);
1411 static int set_address_from_contact(struct sip_pvt *pvt);
1412 static void check_via(struct sip_pvt *p, struct sip_request *req);
1413 static char *get_calleridname(const char *input, char *output, size_t outputsize);
1414 static int get_rpid_num(const char *input, char *output, int maxlen);
1415 static int get_rdnis(struct sip_pvt *p, struct sip_request *oreq);
1416 static int get_destination(struct sip_pvt *p, struct sip_request *oreq);
1417 static int get_msg_text(char *buf, int len, struct sip_request *req);
1418 static const char *gettag(const struct sip_request *req, const char *header, char *tagbuf, int tagbufsize);
1419 static void free_old_route(struct sip_route *route);
1420
1421 /*--- Constructing requests and responses */
1422 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req);
1423 static int init_req(struct sip_request *req, int sipmethod, const char *recip);
1424 static int reqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod, int seqno, int newbranch);
1425 static void initreqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod);
1426 static int init_resp(struct sip_request *resp, const char *msg);
1427 static int respprep(struct sip_request *resp, struct sip_pvt *p, const char *msg, const struct sip_request *req);
1428 static const struct sockaddr_in *sip_real_dst(const struct sip_pvt *p);
1429 static void build_via(struct sip_pvt *p);
1430 static int create_addr_from_peer(struct sip_pvt *r, struct sip_peer *peer);
1431 static int create_addr(struct sip_pvt *dialog, const char *opeer);
1432 static char *generate_random_string(char *buf, size_t size);
1433 static void build_callid_pvt(struct sip_pvt *pvt);
1434 static void build_callid_registry(struct sip_registry *reg, struct in_addr ourip, const char *fromdomain);
1435 static void make_our_tag(char *tagbuf, size_t len);
1436 static int add_header(struct sip_request *req, const char *var, const char *value);
1437 static int add_header_contentLength(struct sip_request *req, int len);
1438 static int add_line(struct sip_request *req, const char *line);
1439 static int add_text(struct sip_request *req, const char *text);
1440 static int add_digit(struct sip_request *req, char digit);
1441 static int add_vidupdate(struct sip_request *req);
1442 static void add_route(struct sip_request *req, struct sip_route *route);
1443 static int copy_header(struct sip_request *req, const struct sip_request *orig, const char *field);
1444 static int copy_all_header(struct sip_request *req, const struct sip_request *orig, const char *field);
1445 static int copy_via_headers(struct sip_pvt *p, struct sip_request *req, const struct sip_request *orig, const char *field);
1446 static void set_destination(struct sip_pvt *p, char *uri);
1447 static void append_date(struct sip_request *req);
1448 static void build_contact(struct sip_pvt *p);
1449 static void build_rpid(struct sip_pvt *p);
1450
1451 /*------Request handling functions */
1452 static int handle_request(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int *recount, int *nounlock);
1453 static int handle_request_invite(struct sip_pvt *p, struct sip_request *req, int debug, int seqno, struct sockaddr_in *sin, int *recount, char *e);
1454 static int handle_request_refer(struct sip_pvt *p, struct sip_request *req, int debug, int ignore, int seqno, int *nounlock);
1455 static int handle_request_bye(struct sip_pvt *p, struct sip_request *req);
1456 static int handle_request_register(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, char *e);
1457 static int handle_request_cancel(struct sip_pvt *p, struct sip_request *req);
1458 static int handle_request_message(struct sip_pvt *p, struct sip_request *req);
1459 static int handle_request_subscribe(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int seqno, char *e);
1460 static void handle_request_info(struct sip_pvt *p, struct sip_request *req);
1461 static int handle_request_options(struct sip_pvt *p, struct sip_request *req);
1462 static int handle_invite_replaces(struct sip_pvt *p, struct sip_request *req, int debug, int ignore, int seqno, struct sockaddr_in *sin);
1463 static int handle_request_notify(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int seqno, char *e);
1464 static int handle_invite_replaces(struct sip_pvt *p, struct sip_request *req, int debug, int ignore, int seqno, struct sockaddr_in *sin);
1465 static int local_attended_transfer(struct sip_pvt *transferer, struct sip_dual *current, struct sip_request *req, int seqno);
1466
1467 /*------Response handling functions */
1468 static void handle_response_invite(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1469 static void handle_response_refer(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1470 static int handle_response_peerpoke(struct sip_pvt *p, int resp, struct sip_request *req);
1471 static int handle_response_register(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int ignore, int seqno);
1472 static void handle_response(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int ignore, int seqno);
1473
1474 /*----- RTP interface functions */
1475 static int sip_set_rtp_peer(struct ast_channel *chan, struct ast_rtp *rtp, struct ast_rtp *vrtp, int codecs, int nat_active);
1476 static struct ast_rtp *sip_get_rtp_peer(struct ast_channel *chan);
1477 static struct ast_rtp *sip_get_vrtp_peer(struct ast_channel *chan);
1478 static int sip_get_codec(struct ast_channel *chan);
1479 static struct ast_frame *sip_rtp_read(struct ast_channel *ast, struct sip_pvt *p, int *faxdetect);
1480
1481 /*------ T38 Support --------- */
1482 static int sip_handle_t38_reinvite(struct ast_channel *chan, struct sip_pvt *pvt, int reinvite); /*!< T38 negotiation helper function */
1483 static int transmit_response_with_t38_sdp(struct sip_pvt *p, char *msg, struct sip_request *req, int retrans);
1484 static int transmit_reinvite_with_t38_sdp(struct sip_pvt *p);
1485 static struct ast_udptl *sip_get_udptl_peer(struct ast_channel *chan);
1486 static int sip_set_udptl_peer(struct ast_channel *chan, struct ast_udptl *udptl);
1487
1488 /*! \brief Definition of this channel for PBX channel registration */
1489 static const struct ast_channel_tech sip_tech = {
1490         .type = "SIP",
1491         .description = "Session Initiation Protocol (SIP)",
1492         .capabilities = ((AST_FORMAT_MAX_AUDIO << 1) - 1),
1493         .properties = AST_CHAN_TP_WANTSJITTER | AST_CHAN_TP_CREATESJITTER,
1494         .requester = sip_request_call,
1495         .devicestate = sip_devicestate,
1496         .call = sip_call,
1497         .hangup = sip_hangup,
1498         .answer = sip_answer,
1499         .read = sip_read,
1500         .write = sip_write,
1501         .write_video = sip_write,
1502         .indicate = sip_indicate,
1503         .transfer = sip_transfer,
1504         .fixup = sip_fixup,
1505         .send_digit = sip_senddigit,
1506         .bridge = ast_rtp_bridge,
1507         .send_text = sip_sendtext,
1508 };
1509
1510 /**--- some list management macros. **/
1511  
1512 #define UNLINK(element, head, prev) do {        \
1513         if (prev)                               \
1514                 (prev)->next = (element)->next; \
1515         else                                    \
1516                 (head) = (element)->next;       \
1517         } while (0)
1518
1519 /*! \brief Interface structure with callbacks used to connect to RTP module */
1520 static struct ast_rtp_protocol sip_rtp = {
1521         type: "SIP",
1522         get_rtp_info: sip_get_rtp_peer,
1523         get_vrtp_info: sip_get_vrtp_peer,
1524         set_rtp_peer: sip_set_rtp_peer,
1525         get_codec: sip_get_codec,
1526 };
1527
1528 /*! \brief Interface structure with callbacks used to connect to UDPTL module*/
1529 static struct ast_udptl_protocol sip_udptl = {
1530         type: "SIP",
1531         get_udptl_info: sip_get_udptl_peer,
1532         set_udptl_peer: sip_set_udptl_peer,
1533 };
1534
1535 /*! \brief Convert transfer status to string */
1536 static char *referstatus2str(enum referstatus rstatus)
1537 {
1538         int i = (sizeof(referstatusstrings) / sizeof(referstatusstrings[0]));
1539         int x;
1540
1541         for (x = 0; x < i; x++) {
1542                 if (referstatusstrings[x].status ==  rstatus)
1543                         return (char *) referstatusstrings[x].text;
1544         }
1545         return "";
1546 }
1547
1548 /*! \brief Initialize the initital request packet in the pvt structure.
1549         This packet is used for creating replies and future requests in
1550         a dialog */
1551 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req)
1552 {
1553         if (p->initreq.headers) {
1554                 ast_log(LOG_DEBUG, "Initializing already initialized SIP dialog %s (presumably reinvite)\n", p->callid);
1555         }
1556         /* Use this as the basis */
1557         copy_request(&p->initreq, req);
1558         parse_request(&p->initreq);
1559         if (ast_test_flag(req, SIP_PKT_DEBUG))
1560                 ast_verbose("%d headers, %d lines\n", p->initreq.headers, p->initreq.lines);
1561 }
1562
1563
1564 /*! \brief returns true if 'name' (with optional trailing whitespace)
1565  * matches the sip method 'id'.
1566  * Strictly speaking, SIP methods are case SENSITIVE, but we do
1567  * a case-insensitive comparison to be more tolerant.
1568  * following Jon Postel's rule: Be gentle in what you accept, strict with what you send
1569  */
1570 static int method_match(enum sipmethod id, const char *name)
1571 {
1572         int len = strlen(sip_methods[id].text);
1573         int l_name = name ? strlen(name) : 0;
1574         /* true if the string is long enough, and ends with whitespace, and matches */
1575         return (l_name >= len && name[len] < 33 &&
1576                 !strncasecmp(sip_methods[id].text, name, len));
1577 }
1578
1579 /*! \brief  find_sip_method: Find SIP method from header */
1580 static int find_sip_method(const char *msg)
1581 {
1582         int i, res = 0;
1583         
1584         if (ast_strlen_zero(msg))
1585                 return 0;
1586         for (i = 1; i < (sizeof(sip_methods) / sizeof(sip_methods[0])) && !res; i++) {
1587                 if (method_match(i, msg))
1588                         res = sip_methods[i].id;
1589         }
1590         return res;
1591 }
1592
1593 /*! \brief Parse supported header in incoming packet */
1594 static unsigned int parse_sip_options(struct sip_pvt *pvt, const char *supported)
1595 {
1596         char *next, *sep;
1597         char *temp = ast_strdupa(supported);
1598         unsigned int profile = 0;
1599         int i, found;
1600
1601         if (ast_strlen_zero(supported) )
1602                 return 0;
1603
1604         if (option_debug > 2 && sipdebug)
1605                 ast_log(LOG_DEBUG, "Begin: parsing SIP \"Supported: %s\"\n", supported);
1606
1607         for (next = temp; next; next = sep) {
1608                 found = FALSE;
1609                 if ( (sep = strchr(next, ',')) != NULL)
1610                         *sep++ = '\0';
1611                 next = ast_skip_blanks(next);
1612                 if (option_debug > 2 && sipdebug)
1613                         ast_log(LOG_DEBUG, "Found SIP option: -%s-\n", next);
1614                 for (i=0; i < (sizeof(sip_options) / sizeof(sip_options[0])); i++) {
1615                         if (!strcasecmp(next, sip_options[i].text)) {
1616                                 profile |= sip_options[i].id;
1617                                 found = TRUE;
1618                                 if (option_debug > 2 && sipdebug)
1619                                         ast_log(LOG_DEBUG, "Matched SIP option: %s\n", next);
1620                                 break;
1621                         }
1622                 }
1623                 if (!found && option_debug > 2 && sipdebug) {
1624                         if (!strncasecmp(next, "x-", 2))
1625                                 ast_log(LOG_DEBUG, "Found private SIP option, not supported: %s\n", next);
1626                         else
1627                                 ast_log(LOG_DEBUG, "Found no match for SIP option: %s (Please file bug report!)\n", next);
1628                 }
1629         }
1630
1631         if (pvt)
1632                 pvt->sipoptions = profile;
1633         return profile;
1634 }
1635
1636 /*! \brief See if we pass debug IP filter */
1637 static inline int sip_debug_test_addr(const struct sockaddr_in *addr) 
1638 {
1639         if (!sipdebug)
1640                 return 0;
1641         if (debugaddr.sin_addr.s_addr) {
1642                 if (((ntohs(debugaddr.sin_port) != 0)
1643                         && (debugaddr.sin_port != addr->sin_port))
1644                         || (debugaddr.sin_addr.s_addr != addr->sin_addr.s_addr))
1645                         return 0;
1646         }
1647         return 1;
1648 }
1649
1650 /*! \brief The real destination address for a write */
1651 static const struct sockaddr_in *sip_real_dst(const struct sip_pvt *p)
1652 {
1653         return ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_ROUTE ? &p->recv : &p->sa;
1654 }
1655
1656 /*! \brief Display SIP nat mode */
1657 static const char *sip_nat_mode(const struct sip_pvt *p)
1658 {
1659         return ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_ROUTE ? "NAT" : "no NAT";
1660 }
1661
1662 /*! \brief Test PVT for debugging output */
1663 static inline int sip_debug_test_pvt(struct sip_pvt *p) 
1664 {
1665         if (!sipdebug)
1666                 return 0;
1667         return sip_debug_test_addr(sip_real_dst(p));
1668 }
1669
1670 /*! \brief Transmit SIP message */
1671 static int __sip_xmit(struct sip_pvt *p, char *data, int len)
1672 {
1673         int res;
1674         char iabuf[INET_ADDRSTRLEN];
1675         const struct sockaddr_in *dst = sip_real_dst(p);
1676         res=sendto(sipsock, data, len, 0, (const struct sockaddr *)dst, sizeof(struct sockaddr_in));
1677
1678         if (res != len)
1679                 ast_log(LOG_WARNING, "sip_xmit of %p (len %d) to %s:%d returned %d: %s\n", data, len, ast_inet_ntoa(iabuf, sizeof(iabuf), dst->sin_addr), ntohs(dst->sin_port), res, strerror(errno));
1680         return res;
1681 }
1682
1683
1684 /*! \brief Build a Via header for a request */
1685 static void build_via(struct sip_pvt *p)
1686 {
1687         char iabuf[INET_ADDRSTRLEN];
1688         /* Work around buggy UNIDEN UIP200 firmware */
1689         const char *rport = ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_RFC3581 ? ";rport" : "";
1690
1691         /* z9hG4bK is a magic cookie.  See RFC 3261 section 8.1.1.7 */
1692         ast_string_field_build(p, via, "SIP/2.0/UDP %s:%d;branch=z9hG4bK%08x%s",
1693                          ast_inet_ntoa(iabuf, sizeof(iabuf), p->ourip), ourport, p->branch, rport);
1694 }
1695
1696 /*! \brief NAT fix - decide which IP address to use for ASterisk server?
1697  *
1698  * Using the localaddr structure built up with localnet statements in sip.conf
1699  * apply it to their address to see if we need to substitute our
1700  * externip or can get away with our internal bindaddr
1701  */
1702 static enum sip_result ast_sip_ouraddrfor(struct in_addr *them, struct in_addr *us)
1703 {
1704         struct sockaddr_in theirs, ours;
1705
1706         /* Get our local information */
1707         ast_ouraddrfor(them, us);
1708         theirs.sin_addr = *them;
1709         ours.sin_addr = *us;
1710
1711         if (localaddr && externip.sin_addr.s_addr &&
1712             ast_apply_ha(localaddr, &theirs) &&
1713             !ast_apply_ha(localaddr, &ours)) {
1714                 if (externexpire && time(NULL) >= externexpire) {
1715                         struct ast_hostent ahp;
1716                         struct hostent *hp;
1717
1718                         externexpire = time(NULL) + externrefresh;
1719                         if ((hp = ast_gethostbyname(externhost, &ahp))) {
1720                                 memcpy(&externip.sin_addr, hp->h_addr, sizeof(externip.sin_addr));
1721                         } else
1722                                 ast_log(LOG_NOTICE, "Warning: Re-lookup of '%s' failed!\n", externhost);
1723                 }
1724                 *us = externip.sin_addr;
1725                 if (option_debug) {
1726                         char iabuf[INET_ADDRSTRLEN];
1727                         ast_inet_ntoa(iabuf, sizeof(iabuf), *(struct in_addr *)&them->s_addr);
1728                         ast_log(LOG_DEBUG, "Target address %s is not local, substituting externip\n", iabuf);
1729                 }
1730         } else if (bindaddr.sin_addr.s_addr)
1731                 *us = bindaddr.sin_addr;
1732         return AST_SUCCESS;
1733 }
1734
1735 /*! \brief Append to SIP dialog history 
1736         \return Always returns 0 */
1737 #define append_history(p, event, fmt , args... )        append_history_full(p, "%-15s " fmt, event, ## args)
1738
1739 static void append_history_full(struct sip_pvt *p, const char *fmt, ...)
1740         __attribute__ ((format (printf, 2, 3)));
1741
1742 /*! \brief Append to SIP dialog history with arg list  */
1743 static void append_history_va(struct sip_pvt *p, const char *fmt, va_list ap)
1744 {
1745         char buf[80], *c = buf; /* max history length */
1746         struct sip_history *hist;
1747         int l;
1748
1749         vsnprintf(buf, sizeof(buf), fmt, ap);
1750         strsep(&c, "\r\n"); /* Trim up everything after \r or \n */
1751         l = strlen(buf) + 1;
1752         if (!(hist = ast_calloc(1, sizeof(*hist) + l)))
1753                 return;
1754         if (!p->history && !(p->history = ast_calloc(1, sizeof(*p->history)))) {
1755                 free(hist);
1756                 return;
1757         }
1758         memcpy(hist->event, buf, l);
1759         AST_LIST_INSERT_TAIL(p->history, hist, list);
1760 }
1761
1762 /*! \brief Append to SIP dialog history with arg list  */
1763 static void append_history_full(struct sip_pvt *p, const char *fmt, ...)
1764 {
1765         va_list ap;
1766
1767         if (!recordhistory || !p)
1768                 return;
1769         va_start(ap, fmt);
1770         append_history_va(p, fmt, ap);
1771         va_end(ap);
1772
1773         return;
1774 }
1775
1776 /*! \brief Retransmit SIP message if no answer (Called from scheduler) */
1777 static int retrans_pkt(void *data)
1778 {
1779         struct sip_pkt *pkt = data, *prev, *cur = NULL;
1780         char iabuf[INET_ADDRSTRLEN];
1781         int reschedule = DEFAULT_RETRANS;
1782
1783         /* Lock channel PVT */
1784         ast_mutex_lock(&pkt->owner->lock);
1785
1786         if (pkt->retrans < MAX_RETRANS) {
1787                 pkt->retrans++;
1788                 if (!pkt->timer_t1) {   /* Re-schedule using timer_a and timer_t1 */
1789                         if (sipdebug && option_debug > 3)
1790                                 ast_log(LOG_DEBUG, "SIP TIMER: Not rescheduling id #%d:%s (Method %d) (No timer T1)\n", pkt->retransid, sip_methods[pkt->method].text, pkt->method);
1791                 } else {
1792                         int siptimer_a;
1793
1794                         if (sipdebug && option_debug > 3)
1795                                 ast_log(LOG_DEBUG, "SIP TIMER: Rescheduling retransmission #%d (%d) %s - %d\n", pkt->retransid, pkt->retrans, sip_methods[pkt->method].text, pkt->method);
1796                         if (!pkt->timer_a)
1797                                 pkt->timer_a = 2 ;
1798                         else
1799                                 pkt->timer_a = 2 * pkt->timer_a;
1800  
1801                         /* For non-invites, a maximum of 4 secs */
1802                         siptimer_a = pkt->timer_t1 * pkt->timer_a;      /* Double each time */
1803                         if (pkt->method != SIP_INVITE && siptimer_a > 4000)
1804                                 siptimer_a = 4000;
1805                 
1806                         /* Reschedule re-transmit */
1807                         reschedule = siptimer_a;
1808                         if (option_debug > 3)
1809                                 ast_log(LOG_DEBUG, "** SIP timers: Rescheduling retransmission %d to %d ms (t1 %d ms (Retrans id #%d)) \n", pkt->retrans +1, siptimer_a, pkt->timer_t1, pkt->retransid);
1810                 } 
1811
1812                 if (sip_debug_test_pvt(pkt->owner)) {
1813                         const struct sockaddr_in *dst = sip_real_dst(pkt->owner);
1814                         ast_verbose("Retransmitting #%d (%s) to %s:%d:\n%s\n---\n",
1815                                 pkt->retrans, sip_nat_mode(pkt->owner),
1816                                 ast_inet_ntoa(iabuf, sizeof(iabuf), dst->sin_addr),
1817                                 ntohs(dst->sin_port), pkt->data);
1818                 }
1819
1820                 append_history(pkt->owner, "ReTx", "%d %s", reschedule, pkt->data);
1821                 __sip_xmit(pkt->owner, pkt->data, pkt->packetlen);
1822                 ast_mutex_unlock(&pkt->owner->lock);
1823                 return  reschedule;
1824         } 
1825         /* Too many retries */
1826         if (pkt->owner && pkt->method != SIP_OPTIONS) {
1827                 if (ast_test_flag(pkt, FLAG_FATAL) || sipdebug) /* Tell us if it's critical or if we're debugging */
1828                         ast_log(LOG_WARNING, "Maximum retries exceeded on transmission %s for seqno %d (%s %s)\n", pkt->owner->callid, pkt->seqno, (ast_test_flag(pkt, FLAG_FATAL)) ? "Critical" : "Non-critical", (ast_test_flag(pkt, FLAG_RESPONSE)) ? "Response" : "Request");
1829         } else {
1830                 if ((pkt->method == SIP_OPTIONS) && sipdebug)
1831                         ast_log(LOG_WARNING, "Cancelling retransmit of OPTIONs (call id %s) \n", pkt->owner->callid);
1832         }
1833         append_history(pkt->owner, "MaxRetries", "%s", (ast_test_flag(pkt, FLAG_FATAL)) ? "(Critical)" : "(Non-critical)");
1834                 
1835         pkt->retransid = -1;
1836
1837         if (ast_test_flag(pkt, FLAG_FATAL)) {
1838                 while(pkt->owner->owner && ast_channel_trylock(pkt->owner->owner)) {
1839                         ast_mutex_unlock(&pkt->owner->lock);    /* SIP_PVT, not channel */
1840                         usleep(1);
1841                         ast_mutex_lock(&pkt->owner->lock);
1842                 }
1843                 if (pkt->owner->owner) {
1844                         ast_set_flag(&pkt->owner->flags[0], SIP_ALREADYGONE);
1845                         ast_log(LOG_WARNING, "Hanging up call %s - no reply to our critical packet.\n", pkt->owner->callid);
1846                         ast_queue_hangup(pkt->owner->owner);
1847                         ast_channel_unlock(pkt->owner->owner);
1848                 } else {
1849                         /* If no channel owner, destroy now */
1850                         ast_set_flag(&pkt->owner->flags[0], SIP_NEEDDESTROY);   
1851                 }
1852         }
1853         /* In any case, go ahead and remove the packet */
1854         for (prev = NULL, cur = pkt->owner->packets; cur; prev = cur, cur = cur->next) {
1855                 if (cur == pkt)
1856                         break;
1857         }
1858         if (cur) {
1859                 if (prev)
1860                         prev->next = cur->next;
1861                 else
1862                         pkt->owner->packets = cur->next;
1863                 ast_mutex_unlock(&pkt->owner->lock);
1864                 free(cur);
1865                 pkt = NULL;
1866         } else
1867                 ast_log(LOG_WARNING, "Weird, couldn't find packet owner!\n");
1868         if (pkt)
1869                 ast_mutex_unlock(&pkt->owner->lock);
1870         return 0;
1871 }
1872
1873 /*! \brief Transmit packet with retransmits 
1874         \return 0 on success, -1 on failure to allocate packet 
1875 */
1876 static enum sip_result __sip_reliable_xmit(struct sip_pvt *p, int seqno, int resp, char *data, int len, int fatal, int sipmethod)
1877 {
1878         struct sip_pkt *pkt;
1879         int siptimer_a = DEFAULT_RETRANS;
1880
1881         if (!(pkt = ast_calloc(1, sizeof(*pkt) + len + 1)))
1882                 return AST_FAILURE;
1883         memcpy(pkt->data, data, len);
1884         pkt->method = sipmethod;
1885         pkt->packetlen = len;
1886         pkt->next = p->packets;
1887         pkt->owner = p;
1888         pkt->seqno = seqno;
1889         pkt->flags = resp;
1890         pkt->data[len] = '\0';
1891         pkt->timer_t1 = p->timer_t1;    /* Set SIP timer T1 */
1892         if (fatal)
1893                 ast_set_flag(pkt, FLAG_FATAL);
1894         if (pkt->timer_t1)
1895                 siptimer_a = pkt->timer_t1 * 2;
1896
1897         /* Schedule retransmission */
1898         pkt->retransid = ast_sched_add_variable(sched, siptimer_a, retrans_pkt, pkt, 1);
1899         if (option_debug > 3 && sipdebug)
1900                 ast_log(LOG_DEBUG, "*** SIP TIMER: Initalizing retransmit timer on packet: Id  #%d\n", pkt->retransid);
1901         pkt->next = p->packets;
1902         p->packets = pkt;
1903
1904         __sip_xmit(pkt->owner, pkt->data, pkt->packetlen);      /* Send packet */
1905         if (sipmethod == SIP_INVITE) {
1906                 /* Note this is a pending invite */
1907                 p->pendinginvite = seqno;
1908         }
1909         return AST_SUCCESS;
1910 }
1911
1912 /*! \brief Kill a SIP dialog (called by scheduler) */
1913 static int __sip_autodestruct(void *data)
1914 {
1915         struct sip_pvt *p = data;
1916
1917         /* If this is a subscription, tell the phone that we got a timeout */
1918         if (p->subscribed) {
1919                 p->subscribed = TIMEOUT;
1920                 transmit_state_notify(p, AST_EXTENSION_DEACTIVATED, 1); /* Send last notification */
1921                 p->subscribed = NONE;
1922                 append_history(p, "Subscribestatus", "timeout");
1923                 if (option_debug > 2)
1924                         ast_log(LOG_DEBUG, "Re-scheduled destruction of SIP subsription %s\n", p->callid ? p->callid : "<unknown>");
1925                 return 10000;   /* Reschedule this destruction so that we know that it's gone */
1926         }
1927
1928         /* Reset schedule ID */
1929         p->autokillid = -1;
1930
1931         if (option_debug)
1932                 ast_log(LOG_DEBUG, "Auto destroying call '%s'\n", p->callid);
1933         append_history(p, "AutoDestroy", "%s", p->callid);
1934         if (p->owner) {
1935                 ast_log(LOG_WARNING, "Autodestruct on dialog '%s' with owner in place (Method: %s)\n", p->callid, sip_methods[p->method].text);
1936                 ast_queue_hangup(p->owner);
1937         } else if (p->refer) {
1938                 transmit_request_with_auth(p, SIP_BYE, 0, XMIT_RELIABLE, 1);
1939         } else {
1940                 sip_destroy(p);
1941         }
1942         return 0;
1943 }
1944
1945 /*! \brief Schedule destruction of SIP call */
1946 static void sip_scheddestroy(struct sip_pvt *p, int ms)
1947 {
1948         if (sip_debug_test_pvt(p))
1949                 ast_verbose("Scheduling destruction of SIP dialog '%s' in %d ms (Method: %s)\n", p->callid, ms, sip_methods[p->method].text);
1950         if (recordhistory)
1951                 append_history(p, "SchedDestroy", "%d ms", ms);
1952
1953         if (p->autokillid > -1)
1954                 ast_sched_del(sched, p->autokillid);
1955         p->autokillid = ast_sched_add(sched, ms, __sip_autodestruct, p);
1956 }
1957
1958 /*! \brief Cancel destruction of SIP dialog */
1959 static void sip_cancel_destroy(struct sip_pvt *p)
1960 {
1961         if (p->autokillid > -1) {
1962                 ast_sched_del(sched, p->autokillid);
1963                 append_history(p, "CancelDestroy", "");
1964                 p->autokillid = -1;
1965         }
1966 }
1967
1968 /*! \brief Acknowledges receipt of a packet and stops retransmission */
1969 static void __sip_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod, int reset)
1970 {
1971         struct sip_pkt *cur, *prev = NULL;
1972
1973         /* Just in case... */
1974         char *msg;
1975         int res = FALSE;
1976
1977         msg = sip_methods[sipmethod].text;
1978
1979         ast_mutex_lock(&p->lock);
1980         for (cur = p->packets; cur; prev = cur, cur = cur->next) {
1981                 if ((cur->seqno == seqno) && ((ast_test_flag(cur, FLAG_RESPONSE)) == resp) &&
1982                         ((ast_test_flag(cur, FLAG_RESPONSE)) || 
1983                          (!strncasecmp(msg, cur->data, strlen(msg)) && (cur->data[strlen(msg)] < 33)))) {
1984                         if (!resp && (seqno == p->pendinginvite)) {
1985                                 ast_log(LOG_DEBUG, "Acked pending invite %d\n", p->pendinginvite);
1986                                 p->pendinginvite = 0;
1987                         }
1988                         /* this is our baby */
1989                         res = TRUE;
1990                         UNLINK(cur, p->packets, prev);
1991                         if (cur->retransid > -1) {
1992                                 if (sipdebug && option_debug > 3)
1993                                         ast_log(LOG_DEBUG, "** SIP TIMER: Cancelling retransmit of packet (reply received) Retransid #%d\n", cur->retransid);
1994                                 ast_sched_del(sched, cur->retransid);
1995                         }
1996                         if (!reset)
1997                                 free(cur);
1998                         break;
1999                 }
2000         }
2001         ast_mutex_unlock(&p->lock);
2002         if (option_debug)
2003                 ast_log(LOG_DEBUG, "Stopping retransmission on '%s' of %s %d: Match %s\n", p->callid, resp ? "Response" : "Request", seqno, res ? "Not Found" : "Found");
2004 }
2005
2006 /*! \brief Pretend to ack all packets
2007  * maybe the lock on p is not strictly necessary but there might be a race */
2008 static void __sip_pretend_ack(struct sip_pvt *p)
2009 {
2010         struct sip_pkt *cur = NULL;
2011
2012         while (p->packets) {
2013                 int method;
2014                 if (cur == p->packets) {
2015                         ast_log(LOG_WARNING, "Have a packet that doesn't want to give up! %s\n", sip_methods[cur->method].text);
2016                         return;
2017                 }
2018                 cur = p->packets;
2019                 method = (cur->method) ? cur->method : find_sip_method(cur->data);
2020                 __sip_ack(p, cur->seqno, ast_test_flag(cur, FLAG_RESPONSE), method, FALSE);
2021         }
2022 }
2023
2024 /*! \brief Acks receipt of packet, keep it around (used for provisional responses) */
2025 static int __sip_semi_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod)
2026 {
2027         struct sip_pkt *cur;
2028         int res = -1;
2029
2030         for (cur = p->packets; cur; cur = cur->next) {
2031                 if (cur->seqno == seqno && ast_test_flag(cur, FLAG_RESPONSE) == resp &&
2032                         (ast_test_flag(cur, FLAG_RESPONSE) || method_match(sipmethod, cur->data))) {
2033                         /* this is our baby */
2034                         if (cur->retransid > -1) {
2035                                 if (option_debug > 3 && sipdebug)
2036                                         ast_log(LOG_DEBUG, "*** SIP TIMER: Cancelling retransmission #%d - %s (got response)\n", cur->retransid, sip_methods[sipmethod].text);
2037                                 ast_sched_del(sched, cur->retransid);
2038                         }
2039                         cur->retransid = -1;
2040                         res = 0;
2041                         break;
2042                 }
2043         }
2044         if (option_debug)
2045                 ast_log(LOG_DEBUG, "(Provisional) Stopping retransmission (but retaining packet) on '%s' %s %d: %s\n", p->callid, resp ? "Response" : "Request", seqno, res ? "Not Found" : "Found");
2046         return res;
2047 }
2048
2049
2050 /*! \brief Copy SIP request, parse it */
2051 static void parse_copy(struct sip_request *dst, const struct sip_request *src)
2052 {
2053         memset(dst, 0, sizeof(*dst));
2054         memcpy(dst->data, src->data, sizeof(dst->data));
2055         dst->len = src->len;
2056         parse_request(dst);
2057 }
2058
2059 /* add a blank line if no body */
2060 static void add_blank(struct sip_request *req)
2061 {
2062         if (!req->lines) {
2063                 /* Add extra empty return. add_header() reserves 4 bytes so cannot be truncated */
2064                 snprintf(req->data + req->len, sizeof(req->data) - req->len, "\r\n");
2065                 req->len += strlen(req->data + req->len);
2066         }
2067 }
2068
2069 /*! \brief Transmit response on SIP request*/
2070 static int send_response(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno)
2071 {
2072         int res;
2073
2074         add_blank(req);
2075         if (sip_debug_test_pvt(p)) {
2076                 char iabuf[INET_ADDRSTRLEN];
2077                 const struct sockaddr_in *dst = sip_real_dst(p);
2078
2079                 ast_verbose("%sTransmitting (%s) to %s:%d:\n%s\n---\n",
2080                         reliable ? "Reliably " : "", sip_nat_mode(p),
2081                         ast_inet_ntoa(iabuf, sizeof(iabuf), dst->sin_addr),
2082                         ntohs(dst->sin_port), req->data);
2083         }
2084         if (recordhistory) {
2085                 struct sip_request tmp;
2086                 parse_copy(&tmp, req);
2087                 append_history(p, reliable ? "TxRespRel" : "TxResp", "%s / %s - %s", tmp.data, get_header(&tmp, "CSeq"), 
2088                         (tmp.method == SIP_RESPONSE || tmp.method == SIP_UNKNOWN) ? tmp.rlPart2 : sip_methods[tmp.method].text);
2089         }
2090         res = (reliable) ?
2091                 __sip_reliable_xmit(p, seqno, 1, req->data, req->len, (reliable == XMIT_CRITICAL), req->method) :
2092                 __sip_xmit(p, req->data, req->len);
2093         if (res > 0)
2094                 return 0;
2095         return res;
2096 }
2097
2098 /*! \brief Send SIP Request to the other part of the dialogue */
2099 static int send_request(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno)
2100 {
2101         int res;
2102
2103         add_blank(req);
2104         if (sip_debug_test_pvt(p)) {
2105                 char iabuf[INET_ADDRSTRLEN];
2106                 if (ast_test_flag(&p->flags[0], SIP_NAT_ROUTE))
2107                         ast_verbose("%sTransmitting (NAT) to %s:%d:\n%s\n---\n", reliable ? "Reliably " : "", ast_inet_ntoa(iabuf, sizeof(iabuf), p->recv.sin_addr), ntohs(p->recv.sin_port), req->data);
2108                 else
2109                         ast_verbose("%sTransmitting (no NAT) to %s:%d:\n%s\n---\n", reliable ? "Reliably " : "", ast_inet_ntoa(iabuf, sizeof(iabuf), p->sa.sin_addr), ntohs(p->sa.sin_port), req->data);
2110         }
2111         if (recordhistory) {
2112                 struct sip_request tmp;
2113                 parse_copy(&tmp, req);
2114                 append_history(p, reliable ? "TxReqRel" : "TxReq", "%s / %s - %s", tmp.data, get_header(&tmp, "CSeq"), sip_methods[tmp.method].text);
2115         }
2116         res = (reliable) ?
2117                 __sip_reliable_xmit(p, seqno, 0, req->data, req->len, (reliable > 1), req->method) :
2118                 __sip_xmit(p, req->data, req->len);
2119         return res;
2120 }
2121
2122 /*! \brief Pick out text in brackets from character string
2123         \return pointer to terminated stripped string
2124         \param tmp input string that will be modified */
2125 static char *get_in_brackets(char *tmp)
2126 {
2127         char *parse;
2128         char *first_quote;
2129         char *first_bracket;
2130         char *second_bracket;
2131         char last_char;
2132
2133         parse = tmp;
2134         for (;;) {
2135                 first_quote = strchr(parse, '"');
2136                 first_bracket = strchr(parse, '<');
2137                 if (first_quote && first_bracket && (first_quote < first_bracket)) {
2138                         last_char = '\0';
2139                         for (parse = first_quote + 1; *parse; parse++) {
2140                                 if ((*parse == '"') && (last_char != '\\'))
2141                                         break;
2142                                 last_char = *parse;
2143                         }
2144                         if (!*parse) {
2145                                 ast_log(LOG_WARNING, "No closing quote found in '%s'\n", tmp);
2146                                 return tmp;
2147                         }
2148                         parse++;
2149                         continue;
2150                 }
2151                 if (first_bracket) {
2152                         second_bracket = strchr(first_bracket + 1, '>');
2153                         if (second_bracket) {
2154                                 *second_bracket = '\0';
2155                                 return first_bracket + 1;
2156                         } else {
2157                                 ast_log(LOG_WARNING, "No closing bracket found in '%s'\n", tmp);
2158                                 return tmp;
2159                         }
2160                 }
2161                 return tmp;
2162         }
2163 }
2164
2165 /*! \brief Send SIP MESSAGE text within a call
2166         Called from PBX core sendtext() application */
2167 static int sip_sendtext(struct ast_channel *ast, const char *text)
2168 {
2169         struct sip_pvt *p = ast->tech_pvt;
2170         int debug = sip_debug_test_pvt(p);
2171
2172         if (debug)
2173                 ast_verbose("Sending text %s on %s\n", text, ast->name);
2174         if (!p)
2175                 return -1;
2176         if (ast_strlen_zero(text))
2177                 return 0;
2178         if (debug)
2179                 ast_verbose("Really sending text %s on %s\n", text, ast->name);
2180         transmit_message_with_text(p, text);
2181         return 0;       
2182 }
2183
2184 /*! \brief Update peer object in realtime storage 
2185         If the Asterisk system name is set in asterisk.conf, we will use
2186         that name and store that in the "regserver" field in the sippeers
2187         table to facilitate multi-server setups.
2188 */
2189 static void realtime_update_peer(const char *peername, struct sockaddr_in *sin, const char *username, const char *fullcontact, int expirey)
2190 {
2191         char port[10];
2192         char ipaddr[20];
2193         char regseconds[20];
2194
2195         char *sysname = ast_config_AST_SYSTEM_NAME;
2196         char *syslabel = NULL;
2197
2198         time_t nowtime = time(NULL) + expirey;
2199         const char *fc = fullcontact ? "fullcontact" : NULL;
2200         
2201         snprintf(regseconds, sizeof(regseconds), "%d", (int)nowtime);   /* Expiration time */
2202         ast_inet_ntoa(ipaddr, sizeof(ipaddr), sin->sin_addr);
2203         snprintf(port, sizeof(port), "%d", ntohs(sin->sin_port));
2204         
2205         if (ast_strlen_zero(sysname))   /* No system name, disable this */
2206                 sysname = NULL;
2207         else if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTSAVE_SYSNAME))
2208                 syslabel = "regserver";
2209
2210         if (fc)
2211                 ast_update_realtime("sippeers", "name", peername, "ipaddr", ipaddr,
2212                         "port", port, "regseconds", regseconds,
2213                         "username", username, fc, fullcontact, syslabel, sysname, NULL); /* note fc and syslabel _can_ be NULL */
2214         else
2215                 ast_update_realtime("sippeers", "name", peername, "ipaddr", ipaddr,
2216                         "port", port, "regseconds", regseconds,
2217                         "username", username, syslabel, sysname, NULL); /* note syslabel _can_ be NULL */
2218 }
2219
2220 /*! \brief Automatically add peer extension to dial plan */
2221 static void register_peer_exten(struct sip_peer *peer, int onoff)
2222 {
2223         char multi[256];
2224         char *stringp, *ext, *context;
2225
2226         /* XXX note that global_regcontext is both a global 'enable' flag and
2227          * the name of the global regexten context, if not specified
2228          * individually.
2229          */
2230         if (ast_strlen_zero(global_regcontext))
2231                 return;
2232
2233         ast_copy_string(multi, S_OR(peer->regexten, peer->name), sizeof(multi));
2234         stringp = multi;
2235         while ((ext = strsep(&stringp, "&"))) {
2236                 if ((context = strchr(ext, '@'))) {
2237                         *context++ = '\0';      /* split ext@context */
2238                         if (!ast_context_find(context)) {
2239                                 ast_log(LOG_WARNING, "Context %s must exist in regcontext= in sip.conf!\n", context);
2240                                 continue;
2241                         }
2242                 } else {
2243                         context = global_regcontext;
2244                 }
2245                 if (onoff)
2246                         ast_add_extension(context, 1, ext, 1, NULL, NULL, "Noop",
2247                                  ast_strdup(peer->name), free, "SIP");
2248                 else
2249                         ast_context_remove_extension(context, ext, 1, NULL);
2250         }
2251 }
2252
2253 /*! \brief Destroy peer object from memory */
2254 static void sip_destroy_peer(struct sip_peer *peer)
2255 {
2256         if (option_debug > 2)
2257                 ast_log(LOG_DEBUG, "Destroying SIP peer %s\n", peer->name);
2258
2259         /* Delete it, it needs to disappear */
2260         if (peer->call)
2261                 sip_destroy(peer->call);
2262
2263         if (peer->mwipvt)       /* We have an active subscription, delete it */
2264                 sip_destroy(peer->mwipvt);
2265
2266         if (peer->chanvars) {
2267                 ast_variables_destroy(peer->chanvars);
2268                 peer->chanvars = NULL;
2269         }
2270         if (peer->expire > -1)
2271                 ast_sched_del(sched, peer->expire);
2272         if (peer->pokeexpire > -1)
2273                 ast_sched_del(sched, peer->pokeexpire);
2274         register_peer_exten(peer, FALSE);
2275         ast_free_ha(peer->ha);
2276         if (ast_test_flag(&peer->flags[1], SIP_PAGE2_SELFDESTRUCT))
2277                 apeerobjs--;
2278         else if (ast_test_flag(&peer->flags[0], SIP_REALTIME))
2279                 rpeerobjs--;
2280         else
2281                 speerobjs--;
2282         clear_realm_authentication(peer->auth);
2283         peer->auth = NULL;
2284         if (peer->dnsmgr)
2285                 ast_dnsmgr_release(peer->dnsmgr);
2286         free(peer);
2287 }
2288
2289 /*! \brief Update peer data in database (if used) */
2290 static void update_peer(struct sip_peer *p, int expiry)
2291 {
2292         int rtcachefriends = ast_test_flag(&p->flags[1], SIP_PAGE2_RTCACHEFRIENDS);
2293         if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTUPDATE) &&
2294             (ast_test_flag(&p->flags[0], SIP_REALTIME) || rtcachefriends)) {
2295                 realtime_update_peer(p->name, &p->addr, p->username, rtcachefriends ? p->fullcontact : NULL, expiry);
2296         }
2297 }
2298
2299
2300 /*! \brief  realtime_peer: Get peer from realtime storage
2301  * Checks the "sippeers" realtime family from extconfig.conf 
2302  * \todo Consider adding check of port address when matching here to follow the same
2303  *      algorithm as for static peers. Will we break anything by adding that?
2304 */
2305 static struct sip_peer *realtime_peer(const char *newpeername, struct sockaddr_in *sin)
2306 {
2307         struct sip_peer *peer;
2308         struct ast_variable *var = NULL;
2309         struct ast_variable *tmp;
2310         char iabuf[80];
2311
2312         /* First check on peer name */
2313         if (newpeername) 
2314                 var = ast_load_realtime("sippeers", "name", newpeername, NULL);
2315         else if (sin) { /* Then check on IP address for dynamic peers */
2316                 ast_inet_ntoa(iabuf, sizeof(iabuf), sin->sin_addr);
2317                 var = ast_load_realtime("sippeers", "host", iabuf, NULL);       /* First check for fixed IP hosts */
2318                 if (!var)
2319                         var = ast_load_realtime("sippeers", "ipaddr", iabuf, NULL);     /* Then check for registred hosts */
2320         
2321         }
2322
2323         if (!var)
2324                 return NULL;
2325
2326         for (tmp = var; tmp; tmp = tmp->next) {
2327                 /* If this is type=user, then skip this object. */
2328                 if (!strcasecmp(tmp->name, "type") &&
2329                     !strcasecmp(tmp->value, "user")) {
2330                         ast_variables_destroy(var);
2331                         return NULL;
2332                 } else if (!newpeername && !strcasecmp(tmp->name, "name")) {
2333                         newpeername = tmp->value;
2334                 }
2335         }
2336         
2337         if (!newpeername) {     /* Did not find peer in realtime */
2338                 ast_log(LOG_WARNING, "Cannot Determine peer name ip=%s\n", iabuf);
2339                 ast_variables_destroy(var);
2340                 return NULL;
2341         }
2342
2343         /* Peer found in realtime, now build it in memory */
2344         peer = build_peer(newpeername, var, !ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS));
2345         if (!peer) {
2346                 ast_variables_destroy(var);
2347                 return NULL;
2348         }
2349
2350         if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS)) {
2351                 /* Cache peer */
2352                 ast_copy_flags(&peer->flags[1],&global_flags[1], SIP_PAGE2_RTAUTOCLEAR|SIP_PAGE2_RTCACHEFRIENDS);
2353                 if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTAUTOCLEAR)) {
2354                         if (peer->expire > -1) {
2355                                 ast_sched_del(sched, peer->expire);
2356                         }
2357                         peer->expire = ast_sched_add(sched, (global_rtautoclear) * 1000, expire_register, (void *)peer);
2358                 }
2359                 ASTOBJ_CONTAINER_LINK(&peerl,peer);
2360         } else {
2361                 ast_set_flag(&peer->flags[0], SIP_REALTIME);
2362         }
2363         ast_variables_destroy(var);
2364
2365         return peer;
2366 }
2367
2368 /*! \brief Support routine for find_peer */
2369 static int sip_addrcmp(char *name, struct sockaddr_in *sin)
2370 {
2371         /* We know name is the first field, so we can cast */
2372         struct sip_peer *p = (struct sip_peer *) name;
2373         return  !(!inaddrcmp(&p->addr, sin) || 
2374                                         (ast_test_flag(&p->flags[0], SIP_INSECURE_PORT) &&
2375                                         (p->addr.sin_addr.s_addr == sin->sin_addr.s_addr)));
2376 }
2377
2378 /*! \brief Locate peer by name or ip address 
2379  *      This is used on incoming SIP message to find matching peer on ip
2380         or outgoing message to find matching peer on name */
2381 static struct sip_peer *find_peer(const char *peer, struct sockaddr_in *sin, int realtime)
2382 {
2383         struct sip_peer *p = NULL;
2384
2385         if (peer)
2386                 p = ASTOBJ_CONTAINER_FIND(&peerl, peer);
2387         else
2388                 p = ASTOBJ_CONTAINER_FIND_FULL(&peerl, sin, name, sip_addr_hashfunc, 1, sip_addrcmp);
2389
2390         if (!p && realtime) {
2391                 p = realtime_peer(peer, sin);
2392         }
2393         return p;
2394 }
2395
2396 /*! \brief Remove user object from in-memory storage */
2397 static void sip_destroy_user(struct sip_user *user)
2398 {
2399         if (option_debug > 2)
2400                 ast_log(LOG_DEBUG, "Destroying user object from memory: %s\n", user->name);
2401         ast_free_ha(user->ha);
2402         if (user->chanvars) {
2403                 ast_variables_destroy(user->chanvars);
2404                 user->chanvars = NULL;
2405         }
2406         if (ast_test_flag(&user->flags[0], SIP_REALTIME))
2407                 ruserobjs--;
2408         else
2409                 suserobjs--;
2410         free(user);
2411 }
2412
2413 /*! \brief Load user from realtime storage
2414  * Loads user from "sipusers" category in realtime (extconfig.conf)
2415  * Users are matched on From: user name (the domain in skipped) */
2416 static struct sip_user *realtime_user(const char *username)
2417 {
2418         struct ast_variable *var;
2419         struct ast_variable *tmp;
2420         struct sip_user *user = NULL;
2421
2422         var = ast_load_realtime("sipusers", "name", username, NULL);
2423
2424         if (!var)
2425                 return NULL;
2426
2427         for (tmp = var; tmp; tmp = tmp->next) {
2428                 if (!strcasecmp(tmp->name, "type") &&
2429                         !strcasecmp(tmp->value, "peer")) {
2430                         ast_variables_destroy(var);
2431                         return NULL;
2432                 }
2433         }
2434
2435         user = build_user(username, var, !ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS));
2436         
2437         if (!user) {    /* No user found */
2438                 ast_variables_destroy(var);
2439                 return NULL;
2440         }
2441
2442         if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS)) {
2443                 ast_set_flag(&user->flags[1], SIP_PAGE2_RTCACHEFRIENDS);
2444                 suserobjs++;
2445                 ASTOBJ_CONTAINER_LINK(&userl,user);
2446         } else {
2447                 /* Move counter from s to r... */
2448                 suserobjs--;
2449                 ruserobjs++;
2450                 ast_set_flag(&user->flags[0], SIP_REALTIME);
2451         }
2452         ast_variables_destroy(var);
2453         return user;
2454 }
2455
2456 /*! \brief Locate user by name 
2457  * Locates user by name (From: sip uri user name part) first
2458  * from in-memory list (static configuration) then from 
2459  * realtime storage (defined in extconfig.conf) */
2460 static struct sip_user *find_user(const char *name, int realtime)
2461 {
2462         struct sip_user *u = ASTOBJ_CONTAINER_FIND(&userl, name);
2463         if (!u && realtime)
2464                 u = realtime_user(name);
2465         return u;
2466 }
2467
2468 /*! \brief Create address structure from peer reference.
2469  *  return -1 on error, 0 on success.
2470  */
2471 static int create_addr_from_peer(struct sip_pvt *r, struct sip_peer *peer)
2472 {
2473         int natflags;
2474
2475         if ((peer->addr.sin_addr.s_addr || peer->defaddr.sin_addr.s_addr) &&
2476             (!peer->maxms || ((peer->lastms >= 0)  && (peer->lastms <= peer->maxms)))) {
2477                 r->sa = (peer->addr.sin_addr.s_addr) ? peer->addr : peer->defaddr;
2478                 r->recv = r->sa;
2479         } else {
2480                 return -1;
2481         }
2482
2483         ast_copy_flags(&r->flags[0], &peer->flags[0], SIP_FLAGS_TO_COPY);
2484         ast_copy_flags(&r->flags[1], &peer->flags[1], SIP_PAGE2_FLAGS_TO_COPY);
2485         r->capability = peer->capability;
2486         if (!ast_test_flag(&r->flags[1], SIP_PAGE2_VIDEOSUPPORT) && r->vrtp) {
2487                 ast_rtp_destroy(r->vrtp);
2488                 r->vrtp = NULL;
2489         }
2490         r->prefs = peer->prefs;
2491         if (ast_test_flag(&r->flags[1], SIP_PAGE2_T38SUPPORT)) {
2492                 r->t38.capability = global_t38_capability;
2493                 if (r->udptl) {
2494                         if (ast_udptl_get_error_correction_scheme(r->udptl) == UDPTL_ERROR_CORRECTION_FEC )
2495                                 r->t38.capability |= T38FAX_UDP_EC_FEC;
2496                         else if (ast_udptl_get_error_correction_scheme(r->udptl) == UDPTL_ERROR_CORRECTION_REDUNDANCY )
2497                                 r->t38.capability |= T38FAX_UDP_EC_REDUNDANCY;
2498                         else if (ast_udptl_get_error_correction_scheme(r->udptl) == UDPTL_ERROR_CORRECTION_NONE )
2499                                 r->t38.capability |= T38FAX_UDP_EC_NONE;
2500                         r->t38.capability |= T38FAX_RATE_MANAGEMENT_TRANSFERED_TCF;
2501                         if (option_debug > 1)
2502                                 ast_log(LOG_DEBUG,"Our T38 capability (%d)\n", r->t38.capability);
2503                 }
2504                 r->t38.jointcapability = r->t38.capability;
2505         } else if (r->udptl) {
2506                 ast_udptl_destroy(r->udptl);
2507                 r->udptl = NULL;
2508         }
2509         natflags = ast_test_flag(&r->flags[0], SIP_NAT) & SIP_NAT_ROUTE;
2510         if (r->rtp) {
2511                 if (option_debug)
2512                         ast_log(LOG_DEBUG, "Setting NAT on RTP to %s\n", natflags ? "On" : "Off");
2513                 ast_rtp_setnat(r->rtp, natflags);
2514                 ast_rtp_setdtmf(r->rtp, ast_test_flag(&r->flags[0], SIP_DTMF) != SIP_DTMF_INFO);
2515         }
2516         if (r->vrtp) {
2517                 if (option_debug)
2518                         ast_log(LOG_DEBUG, "Setting NAT on VRTP to %s\n", natflags ? "On" : "Off");
2519                 ast_rtp_setnat(r->vrtp, natflags);
2520                 ast_rtp_setdtmf(r->vrtp, 0);
2521         }
2522         if (r->udptl) {
2523                 if (option_debug)
2524                         ast_log(LOG_DEBUG, "Setting NAT on UDPTL to %s\n", natflags ? "On" : "Off");
2525                 ast_udptl_setnat(r->udptl, natflags);
2526         }
2527         ast_string_field_set(r, peername, peer->username);
2528         ast_string_field_set(r, authname, peer->username);
2529         ast_string_field_set(r, username, peer->username);
2530         ast_string_field_set(r, peersecret, peer->secret);
2531         ast_string_field_set(r, peermd5secret, peer->md5secret);
2532         ast_string_field_set(r, tohost, peer->tohost);
2533         ast_string_field_set(r, fullcontact, peer->fullcontact);
2534         if (!r->initreq.headers && !ast_strlen_zero(peer->fromdomain)) {
2535                 char *tmpcall;
2536                 char *c;
2537                 tmpcall = ast_strdupa(r->callid);
2538                 c = strchr(tmpcall, '@');
2539                 if (c) {
2540                         *c = '\0';
2541                         ast_string_field_build(r, callid, "%s@%s", tmpcall, peer->fromdomain);
2542                 }
2543         }
2544         if (ast_strlen_zero(r->tohost)) {
2545                 char iabuf[INET_ADDRSTRLEN];
2546
2547                 ast_inet_ntoa(iabuf, sizeof(iabuf),  r->sa.sin_addr);
2548                 ast_string_field_set(r, tohost, iabuf);
2549         }
2550         if (!ast_strlen_zero(peer->fromdomain))
2551                 ast_string_field_set(r, fromdomain, peer->fromdomain);
2552         if (!ast_strlen_zero(peer->fromuser))
2553                 ast_string_field_set(r, fromuser, peer->fromuser);
2554         r->maxtime = peer->maxms;
2555         r->callgroup = peer->callgroup;
2556         r->pickupgroup = peer->pickupgroup;
2557         r->allowtransfer = peer->allowtransfer;
2558         /* Set timer T1 to RTT for this peer (if known by qualify=) */
2559         /* Minimum is settable or default to 100 ms */
2560         if (peer->maxms && peer->lastms)
2561                 r->timer_t1 = peer->lastms < global_t1min ? global_t1min : peer->lastms;
2562         if ((ast_test_flag(&r->flags[0], SIP_DTMF) == SIP_DTMF_RFC2833) ||
2563             (ast_test_flag(&r->flags[0], SIP_DTMF) == SIP_DTMF_AUTO))
2564                 r->noncodeccapability |= AST_RTP_DTMF;
2565         else
2566                 r->noncodeccapability &= ~AST_RTP_DTMF;
2567         ast_string_field_set(r, context, peer->context);
2568         r->rtptimeout = peer->rtptimeout;
2569         r->rtpholdtimeout = peer->rtpholdtimeout;
2570         r->rtpkeepalive = peer->rtpkeepalive;
2571         if (peer->call_limit)
2572                 ast_set_flag(&r->flags[0], SIP_CALL_LIMIT);
2573         r->maxcallbitrate = peer->maxcallbitrate;
2574         
2575         return 0;
2576 }
2577
2578 /*! \brief create address structure from peer name
2579  *      Or, if peer not found, find it in the global DNS 
2580  *      returns TRUE (-1) on failure, FALSE on success */
2581 static int create_addr(struct sip_pvt *dialog, const char *opeer)
2582 {
2583         struct hostent *hp;
2584         struct ast_hostent ahp;
2585         struct sip_peer *p;
2586         char *port;
2587         int portno;
2588         char host[MAXHOSTNAMELEN], *hostn;
2589         char peer[256];
2590
2591         ast_copy_string(peer, opeer, sizeof(peer));
2592         port = strchr(peer, ':');
2593         if (port)
2594                 *port++ = '\0';
2595         dialog->sa.sin_family = AF_INET;
2596         dialog->timer_t1 = 500; /* Default SIP retransmission timer T1 (RFC 3261) */
2597         p = find_peer(peer, NULL, 1);
2598
2599         if (p) {
2600                 int res = create_addr_from_peer(dialog, p);
2601                 ASTOBJ_UNREF(p, sip_destroy_peer);
2602                 return res;
2603         }
2604         hostn = peer;
2605         portno = port ? atoi(port) : DEFAULT_SIP_PORT;
2606         if (srvlookup) {
2607                 char service[MAXHOSTNAMELEN];
2608                 int tportno;
2609                 int ret;
2610
2611                 snprintf(service, sizeof(service), "_sip._udp.%s", peer);
2612                 ret = ast_get_srv(NULL, host, sizeof(host), &tportno, service);
2613                 if (ret > 0) {
2614                         hostn = host;
2615                         portno = tportno;
2616                 }
2617         }
2618         hp = ast_gethostbyname(hostn, &ahp);
2619         if (!hp) {
2620                 ast_log(LOG_WARNING, "No such host: %s\n", peer);
2621                 return -1;
2622         }
2623         ast_string_field_set(dialog, tohost, peer);
2624         memcpy(&dialog->sa.sin_addr, hp->h_addr, sizeof(dialog->sa.sin_addr));
2625         dialog->sa.sin_port = htons(portno);
2626         dialog->recv = dialog->sa;
2627         return 0;
2628 }
2629
2630 /*! \brief Scheduled congestion on a call */
2631 static int auto_congest(void *nothing)
2632 {
2633         struct sip_pvt *p = nothing;
2634
2635         ast_mutex_lock(&p->lock);
2636         p->initid = -1;
2637         if (p->owner) {
2638                 /* XXX fails on possible deadlock */
2639                 if (!ast_channel_trylock(p->owner)) {
2640                         ast_log(LOG_NOTICE, "Auto-congesting %s\n", p->owner->name);
2641                         append_history(p, "Cong", "Auto-congesting (timer)");
2642                         ast_queue_control(p->owner, AST_CONTROL_CONGESTION);
2643                         ast_channel_unlock(p->owner);
2644                 }
2645         }
2646         ast_mutex_unlock(&p->lock);
2647         return 0;
2648 }
2649
2650
2651 /*! \brief Initiate SIP call from PBX 
2652  *      used from the dial() application      */
2653 static int sip_call(struct ast_channel *ast, char *dest, int timeout)
2654 {
2655         int res;
2656         struct sip_pvt *p;
2657         struct varshead *headp;
2658         struct ast_var_t *current;
2659         const char *referer = NULL;   /* SIP refererer */       
2660
2661         p = ast->tech_pvt;
2662         if ((ast->_state != AST_STATE_DOWN) && (ast->_state != AST_STATE_RESERVED)) {
2663                 ast_log(LOG_WARNING, "sip_call called on %s, neither down nor reserved\n", ast->name);
2664                 return -1;
2665         }
2666
2667         /* Check whether there is vxml_url, distinctive ring variables */
2668         headp=&ast->varshead;
2669         AST_LIST_TRAVERSE(headp,current,entries) {
2670                 /* Check whether there is a VXML_URL variable */
2671                 if (!p->options->vxml_url && !strcasecmp(ast_var_name(current), "VXML_URL")) {
2672                         p->options->vxml_url = ast_var_value(current);
2673                 } else if (!p->options->uri_options && !strcasecmp(ast_var_name(current), "SIP_URI_OPTIONS")) {
2674                         p->options->uri_options = ast_var_value(current);
2675                 } else if (!p->options->distinctive_ring && !strcasecmp(ast_var_name(current), "ALERT_INFO")) {
2676                         /* Check whether there is a ALERT_INFO variable */
2677                         p->options->distinctive_ring = ast_var_value(current);
2678                 } else if (!p->options->addsipheaders && !strncasecmp(ast_var_name(current), "SIPADDHEADER", strlen("SIPADDHEADER"))) {
2679                         /* Check whether there is a variable with a name starting with SIPADDHEADER */
2680                         p->options->addsipheaders = 1;
2681                 } else if (!strcasecmp(ast_var_name(current),"SIPTRANSFER")) {
2682                         /* This is a transfered call */
2683                         p->options->transfer = 1;
2684                 } else if (!strcasecmp(ast_var_name(current),"SIPTRANSFER_REFERER")) {
2685                         /* This is the referer */
2686                         referer = ast_var_value(current);
2687                 } else if (!strcasecmp(ast_var_name(current),"SIPTRANSFER_REPLACES")) {
2688                         /* We're replacing a call. */
2689                         p->options->replaces = ast_var_value(current);
2690                 } else if (!strcasecmp(ast_var_name(current),"T38CALL")) {
2691                         p->t38.state = T38_LOCAL_DIRECT;
2692                         if (option_debug)
2693                                 ast_log(LOG_DEBUG,"T38State change to %d on channel %s\n", p->t38.state, ast->name);
2694                 }
2695
2696         }
2697         
2698         res = 0;
2699         ast_set_flag(&p->flags[0], SIP_OUTGOING);
2700
2701         if (p->options->transfer) {
2702                 char buf[BUFSIZ/2];
2703
2704                 if (referer) {
2705                         if (sipdebug && option_debug > 2)
2706                                 ast_log(LOG_DEBUG, "Call for %s transfered by %s\n", p->username, referer);
2707                         snprintf(buf, sizeof(buf)-1, "-> %s (via %s)", p->cid_name, referer);
2708                 } else {
2709                         snprintf(buf, sizeof(buf)-1, "-> %s", p->cid_name);
2710                 }
2711                 ast_string_field_set(p, cid_name, buf);
2712         } 
2713         if (option_debug)
2714                 ast_log(LOG_DEBUG, "Outgoing Call for %s\n", p->username);
2715
2716         res = update_call_counter(p, INC_CALL_RINGING);
2717         if ( res != -1 ) {
2718                 p->callingpres = ast->cid.cid_pres;
2719                 p->jointcapability = p->capability;
2720                 p->t38.jointcapability = p->t38.capability;
2721                 if (option_debug)
2722                         ast_log(LOG_DEBUG,"Our T38 capability (%d), joint T38 capability (%d)\n", p->t38.capability, p->t38.jointcapability);
2723                 transmit_invite(p, SIP_INVITE, 1, 2);
2724                 if (p->maxtime) {
2725                         /* Initialize auto-congest time */
2726                         p->initid = ast_sched_add(sched, p->maxtime * 4, auto_congest, p);
2727                 } else {
2728                         p->initid = ast_sched_add(sched, SIP_TRANS_TIMEOUT, auto_congest, p);
2729                 }
2730         }
2731         return res;
2732 }
2733
2734 /*! \brief Destroy registry object
2735         Objects created with the register= statement in static configuration */
2736 static void sip_registry_destroy(struct sip_registry *reg)
2737 {
2738         /* Really delete */
2739         if (option_debug > 2)
2740                 ast_log(LOG_DEBUG, "Destroying registry entry for %s@%s\n", reg->username, reg->hostname);
2741
2742         if (reg->call) {
2743                 /* Clear registry before destroying to ensure
2744                    we don't get reentered trying to grab the registry lock */
2745                 reg->call->registry = NULL;
2746                 if (option_debug > 2)
2747                         ast_log(LOG_DEBUG, "Destroying active SIP dialog for registry %s@%s\n", reg->username, reg->hostname);
2748                 sip_destroy(reg->call);
2749         }
2750         if (reg->expire > -1)
2751                 ast_sched_del(sched, reg->expire);
2752         if (reg->timeout > -1)
2753                 ast_sched_del(sched, reg->timeout);
2754         ast_string_field_free_all(reg);
2755         regobjs--;
2756         free(reg);
2757         
2758 }
2759
2760 /*! \brief Execute destruction of SIP dialog structure, release memory */
2761 static void __sip_destroy(struct sip_pvt *p, int lockowner)
2762 {
2763         struct sip_pvt *cur, *prev = NULL;
2764         struct sip_pkt *cp;
2765
2766         if (sip_debug_test_pvt(p) || option_debug > 2)
2767                 ast_verbose("Really destroying SIP dialog '%s' Method: %s\n", p->callid, sip_methods[p->method].text);
2768
2769         /* Remove link from peer to subscription of MWI */
2770         if (p->relatedpeer && p->relatedpeer->mwipvt)
2771                 p->relatedpeer->mwipvt = NULL;
2772
2773         if (dumphistory)
2774                 sip_dump_history(p);
2775
2776         if (p->options)
2777                 free(p->options);
2778
2779         if (p->stateid > -1)
2780                 ast_extension_state_del(p->stateid, NULL);
2781         if (p->initid > -1)
2782                 ast_sched_del(sched, p->initid);
2783         if (p->autokillid > -1)
2784                 ast_sched_del(sched, p->autokillid);
2785
2786         if (p->rtp)
2787                 ast_rtp_destroy(p->rtp);
2788         if (p->vrtp)
2789                 ast_rtp_destroy(p->vrtp);
2790         if (p->udptl)
2791                 ast_udptl_destroy(p->udptl);
2792         if (p->refer)
2793                 free(p->refer);
2794         if (p->route) {
2795                 free_old_route(p->route);
2796                 p->route = NULL;
2797         }
2798         if (p->registry) {
2799                 if (p->registry->call == p)
2800                         p->registry->call = NULL;
2801                 ASTOBJ_UNREF(p->registry, sip_registry_destroy);
2802         }
2803
2804         /* Unlink us from the owner if we have one */
2805         if (p->owner) {
2806                 if (lockowner)
2807                         ast_channel_lock(p->owner);
2808                 if (option_debug)
2809                         ast_log(LOG_DEBUG, "Detaching from %s\n", p->owner->name);
2810                 p->owner->tech_pvt = NULL;
2811                 if (lockowner)
2812                         ast_channel_unlock(p->owner);
2813         }
2814         /* Clear history */
2815         if (p->history) {
2816                 struct sip_history *hist;
2817                 while( (hist = AST_LIST_REMOVE_HEAD(p->history, list)) )
2818                         free(hist);
2819                 free(p->history);
2820                 p->history = NULL;
2821         }
2822
2823         for (prev = NULL, cur = iflist; cur; prev = cur, cur = cur->next) {
2824                 if (cur == p) {
2825                         UNLINK(cur, iflist, prev);
2826                         break;
2827                 }
2828         }
2829         if (!cur) {
2830                 ast_log(LOG_WARNING, "Trying to destroy \"%s\", not found in dialog list?!?! \n", p->callid);
2831                 return;
2832         } 
2833
2834         /* remove all current packets in this dialog */
2835         while((cp = p->packets)) {
2836                 p->packets = p->packets->next;
2837                 if (cp->retransid > -1)
2838                         ast_sched_del(sched, cp->retransid);
2839                 free(cp);
2840         }
2841         if (p->chanvars) {
2842                 ast_variables_destroy(p->chanvars);
2843                 p->chanvars = NULL;
2844         }
2845         ast_mutex_destroy(&p->lock);
2846
2847         ast_string_field_free_all(p);
2848
2849         free(p);
2850 }
2851
2852 /*! \brief  update_call_counter: Handle call_limit for SIP users 
2853  * Setting a call-limit will cause calls above the limit not to be accepted.
2854  *
2855  * Remember that for a type=friend, there's one limit for the user and
2856  * another for the peer, not a combined call limit.
2857  * This will cause unexpected behaviour in subscriptions, since a "friend"
2858  * is *two* devices in Asterisk, not one.
2859  *
2860  * Thought: For realtime, we should propably update storage with inuse counter... 
2861  *
2862  * \return 0 if call is ok (no call limit, below treshold)
2863  *      -1 on rejection of call
2864  *              
2865  */
2866 static int update_call_counter(struct sip_pvt *fup, int event)
2867 {
2868         char name[256];
2869         int *inuse, *call_limit, *inringing = NULL;
2870         int outgoing = ast_test_flag(&fup->flags[0], SIP_OUTGOING);
2871         struct sip_user *u = NULL;
2872         struct sip_peer *p = NULL;
2873
2874         if (option_debug > 2)
2875                 ast_log(LOG_DEBUG, "Updating call counter for %s call\n", outgoing ? "outgoing" : "incoming");
2876         /* Test if we need to check call limits, in order to avoid 
2877            realtime lookups if we do not need it */
2878         if (!ast_test_flag(&fup->flags[0], SIP_CALL_LIMIT))
2879                 return 0;
2880
2881         ast_copy_string(name, fup->username, sizeof(name));
2882
2883         /* Check the list of users */
2884         if (!outgoing)  /* Only check users for incoming calls */
2885                 u = find_user(name, 1);
2886
2887         if (u) {
2888                 inuse = &u->inUse;
2889                 call_limit = &u->call_limit;
2890                 p = NULL;
2891         } else {
2892                 /* Try to find peer */
2893                 if (!p)
2894                         p = find_peer(fup->peername, NULL, 1);
2895                 if (p) {
2896                         inuse = &p->inUse;
2897                         call_limit = &p->call_limit;
2898                         inringing = &p->inRinging;
2899                         ast_copy_string(name, fup->peername, sizeof(name));
2900                 } else {
2901                         if (option_debug > 1)
2902                                 ast_log(LOG_DEBUG, "%s is not a local device, no call limit\n", name);
2903                         return 0;
2904                 }
2905         }
2906         switch(event) {
2907                 /* incoming and outgoing affects the inUse counter */
2908                 case DEC_CALL_LIMIT:
2909                         if ( *inuse > 0 ) {
2910                                 if (ast_test_flag(&fup->flags[0], SIP_INC_COUNT))
2911                                         (*inuse)--;
2912                         } else {
2913                                 *inuse = 0;
2914                         }
2915                         if (inringing) {
2916                                 if (ast_test_flag(&fup->flags[1], SIP_PAGE2_INC_RINGING)) {
2917                                         if (*inringing > 0)
2918                                                 (*inringing)--;
2919                                         else
2920                                                 ast_log(LOG_WARNING, "Inringing for peer '%s' < 0?\n", fup->peername);
2921                                         ast_clear_flag(&fup->flags[1], SIP_PAGE2_INC_RINGING);
2922                                 }
2923                         }
2924                         if (option_debug > 1 || sipdebug) {
2925                                 ast_log(LOG_DEBUG, "Call %s %s '%s' removed from call limit %d\n", outgoing ? "to" : "from", u ? "user":"peer", name, *call_limit);
2926                         }
2927                         break;
2928                 case INC_CALL_RINGING:
2929                 case INC_CALL_LIMIT:
2930                         if (*call_limit > 0 ) {
2931                                 if (*inuse >= *call_limit) {
2932                                         ast_log(LOG_ERROR, "Call %s %s '%s' rejected due to usage limit of %d\n", outgoing ? "to" : "from", u ? "user":"peer", name, *call_limit);
2933                                         if (u)
2934                                                 ASTOBJ_UNREF(u, sip_destroy_user);
2935                                         else
2936                                                 ASTOBJ_UNREF(p, sip_destroy_peer);
2937                                         return -1; 
2938                                 }
2939                         }
2940                         if (inringing && (event == INC_CALL_RINGING)) {
2941                                 if (!ast_test_flag(&fup->flags[1], SIP_PAGE2_INC_RINGING)) {
2942                                         (*inringing)++;
2943                                         ast_set_flag(&fup->flags[1], SIP_PAGE2_INC_RINGING);
2944                                 }
2945                         }
2946                         /* Continue */
2947                         (*inuse)++;
2948                         ast_set_flag(&fup->flags[0], SIP_INC_COUNT);
2949                         if (option_debug > 1 || sipdebug) {
2950                                 ast_log(LOG_DEBUG, "Call %s %s '%s' is %d out of %d\n", outgoing ? "to" : "from", u ? "user":"peer", name, *inuse, *call_limit);
2951                         }
2952                         break;
2953                 case DEC_CALL_RINGING:
2954                         if (inringing) {
2955                                 if (ast_test_flag(&fup->flags[1], SIP_PAGE2_INC_RINGING)) {
2956                                         if (*inringing > 0)
2957                                                 (*inringing)--;
2958                                         else
2959                                                 ast_log(LOG_WARNING, "Inringing for peer '%s' < 0?\n", p->name);
2960                                         ast_clear_flag(&fup->flags[1], SIP_PAGE2_INC_RINGING);
2961                                 }
2962                         }
2963                         break;
2964                 default:
2965                         ast_log(LOG_ERROR, "update_call_counter(%s, %d) called with no event!\n", name, event);
2966         }
2967         if (p)
2968                 ast_device_state_changed("SIP/%s", p->name);
2969         if (u)
2970                 ASTOBJ_UNREF(u, sip_destroy_user);
2971         else
2972                 ASTOBJ_UNREF(p, sip_destroy_peer);
2973         return 0;
2974 }
2975
2976 /*! \brief Destroy SIP call structure */
2977 static void sip_destroy(struct sip_pvt *p)
2978 {
2979         ast_mutex_lock(&iflock);
2980         if (option_debug > 2)
2981                 ast_log(LOG_DEBUG, "Destroying SIP dialog %s\n", p->callid);
2982         __sip_destroy(p, 1);
2983         ast_mutex_unlock(&iflock);
2984 }
2985
2986 /*! \brief Convert SIP hangup causes to Asterisk hangup causes */
2987 static int hangup_sip2cause(int cause)
2988 {
2989         /* Possible values taken from causes.h */
2990
2991         switch(cause) {
2992                 case 401:       /* Unauthorized */
2993                         return AST_CAUSE_CALL_REJECTED;
2994                 case 403:       /* Not found */
2995                         return AST_CAUSE_CALL_REJECTED;
2996                 case 404:       /* Not found */
2997                         return AST_CAUSE_UNALLOCATED;
2998                 case 405:       /* Method not allowed */
2999                         return AST_CAUSE_INTERWORKING;
3000                 case 407:       /* Proxy authentication required */
3001                         return AST_CAUSE_CALL_REJECTED;
3002                 case 408:       /* No reaction */
3003                         return AST_CAUSE_NO_USER_RESPONSE;
3004                 case 409:       /* Conflict */
3005                         return AST_CAUSE_NORMAL_TEMPORARY_FAILURE;
3006                 case 410:       /* Gone */
3007                         return AST_CAUSE_UNALLOCATED;
3008                 case 411:       /* Length required */
3009                         return AST_CAUSE_INTERWORKING;
3010                 case 413:       /* Request entity too large */
3011                         return AST_CAUSE_INTERWORKING;
3012                 case 414:       /* Request URI too large */
3013                         return AST_CAUSE_INTERWORKING;
3014                 case 415:       /* Unsupported media type */
3015                         return AST_CAUSE_INTERWORKING;
3016                 case 420:       /* Bad extension */
3017                         return AST_CAUSE_NO_ROUTE_DESTINATION;
3018                 case 480:       /* No answer */
3019                         return AST_CAUSE_NO_ANSWER;
3020                 case 481:       /* No answer */
3021                         return AST_CAUSE_INTERWORKING;
3022                 case 482:       /* Loop detected */
3023                         return AST_CAUSE_INTERWORKING;
3024                 case 483:       /* Too many hops */
3025                         return AST_CAUSE_NO_ANSWER;
3026                 case 484:       /* Address incomplete */
3027                         return AST_CAUSE_INVALID_NUMBER_FORMAT;
3028                 case 485:       /* Ambigous */
3029                         return AST_CAUSE_UNALLOCATED;
3030                 case 486:       /* Busy everywhere */
3031                         return AST_CAUSE_BUSY;
3032                 case 487:       /* Request terminated */
3033                         return AST_CAUSE_INTERWORKING;
3034                 case 488:       /* No codecs approved */
3035                         return AST_CAUSE_BEARERCAPABILITY_NOTAVAIL;
3036                 case 491:       /* Request pending */
3037                         return AST_CAUSE_INTERWORKING;
3038                 case 493:       /* Undecipherable */
3039                         return AST_CAUSE_INTERWORKING;
3040                 case 500:       /* Server internal failure */
3041                         return AST_CAUSE_FAILURE;
3042                 case 501:       /* Call rejected */
3043                         return AST_CAUSE_FACILITY_REJECTED;
3044                 case 502:       
3045                         return AST_CAUSE_DESTINATION_OUT_OF_ORDER;
3046                 case 503:       /* Service unavailable */
3047                         return AST_CAUSE_CONGESTION;
3048                 case 504:       /* Gateway timeout */
3049                         return AST_CAUSE_RECOVERY_ON_TIMER_EXPIRE;
3050                 case 505:       /* SIP version not supported */
3051                         return AST_CAUSE_INTERWORKING;
3052                 case 600:       /* Busy everywhere */
3053                         return AST_CAUSE_USER_BUSY;
3054                 case 603:       /* Decline */
3055                         return AST_CAUSE_CALL_REJECTED;
3056                 case 604:       /* Does not exist anywhere */
3057                         return AST_CAUSE_UNALLOCATED;
3058                 case 606:       /* Not acceptable */
3059                         return AST_CAUSE_BEARERCAPABILITY_NOTAVAIL;
3060                 default:
3061                         return AST_CAUSE_NORMAL;
3062         }
3063         /* Never reached */
3064         return 0;
3065 }
3066
3067 /*! \brief Convert Asterisk hangup causes to SIP codes 
3068 \verbatim
3069  Possible values from causes.h
3070         AST_CAUSE_NOTDEFINED    AST_CAUSE_NORMAL        AST_CAUSE_BUSY
3071         AST_CAUSE_FAILURE       AST_CAUSE_CONGESTION    AST_CAUSE_UNALLOCATED
3072
3073         In addition to these, a lot of PRI codes is defined in causes.h 
3074         ...should we take care of them too ?
3075         
3076         Quote RFC 3398
3077
3078    ISUP Cause value                        SIP response
3079    ----------------                        ------------
3080    1  unallocated number                   404 Not Found
3081    2  no route to network                  404 Not found
3082    3  no route to destination              404 Not found
3083    16 normal call clearing                 --- (*)
3084    17 user busy                            486 Busy here
3085    18 no user responding                   408 Request Timeout
3086    19 no answer from the user              480 Temporarily unavailable
3087    20 subscriber absent                    480 Temporarily unavailable
3088    21 call rejected                        403 Forbidden (+)
3089    22 number changed (w/o diagnostic)      410 Gone
3090    22 number changed (w/ diagnostic)       301 Moved Permanently
3091    23 redirection to new destination       410 Gone
3092    26 non-selected user clearing           404 Not Found (=)
3093    27 destination out of order             502 Bad Gateway
3094    28 address incomplete                   484 Address incomplete
3095    29 facility rejected                    501 Not implemented
3096    31 normal unspecified                   480 Temporarily unavailable
3097 \endverbatim
3098 */
3099 static const char *hangup_cause2sip(int cause)
3100 {
3101         switch (cause) {
3102                 case AST_CAUSE_UNALLOCATED:             /* 1 */
3103                 case AST_CAUSE_NO_ROUTE_DESTINATION:    /* 3 IAX2: Can't find extension in context */
3104                 case AST_CAUSE_NO_ROUTE_TRANSIT_NET:    /* 2 */
3105                         return "404 Not Found";
3106                 case AST_CAUSE_CONGESTION:              /* 34 */
3107                 case AST_CAUSE_SWITCH_CONGESTION:       /* 42 */
3108                         return "503 Service Unavailable";
3109                 case AST_CAUSE_NO_USER_RESPONSE:        /* 18 */
3110                         return "408 Request Timeout";
3111                 case AST_CAUSE_NO_ANSWER:               /* 19 */
3112                         return "480 Temporarily unavailable";
3113                 case AST_CAUSE_CALL_REJECTED:           /* 21 */
3114                         return "403 Forbidden";
3115                 case AST_CAUSE_NUMBER_CHANGED:          /* 22 */
3116                         return "410 Gone";
3117                 case AST_CAUSE_NORMAL_UNSPECIFIED:      /* 31 */
3118                         return "480 Temporarily unavailable";
3119                 case AST_CAUSE_INVALID_NUMBER_FORMAT:
3120                         return "484 Address incomplete";
3121                 case AST_CAUSE_USER_BUSY:
3122                         return "486 Busy here";
3123                 case AST_CAUSE_FAILURE:
3124                         return "500 Server internal failure";
3125                 case AST_CAUSE_FACILITY_REJECTED:       /* 29 */
3126                         return "501 Not Implemented";
3127                 case AST_CAUSE_CHAN_NOT_IMPLEMENTED:
3128                         return "503 Service Unavailable";
3129                 /* Used in chan_iax2 */
3130                 case AST_CAUSE_DESTINATION_OUT_OF_ORDER:
3131                         return "502 Bad Gateway";
3132                 case AST_CAUSE_BEARERCAPABILITY_NOTAVAIL:       /* Can't find codec to connect to host */
3133                         return "488 Not Acceptable Here";
3134                         
3135                 case AST_CAUSE_NOTDEFINED:
3136                 default:
3137                         ast_log(LOG_DEBUG, "AST hangup cause %d (no match found in SIP)\n", cause);
3138                         return NULL;
3139         }
3140
3141         /* Never reached */
3142         return 0;
3143 }
3144
3145
3146 /*! \brief  sip_hangup: Hangup SIP call
3147  * Part of PBX interface, called from ast_hangup */
3148 static int sip_hangup(struct ast_channel *ast)
3149 {
3150         struct sip_pvt *p = ast->tech_pvt;
3151         int needcancel = FALSE;
3152         struct ast_flags locflags = {0};
3153
3154         if (!p) {
3155                 ast_log(LOG_DEBUG, "Asked to hangup channel that was not connected\n");
3156                 return 0;
3157         }
3158
3159         if (ast_test_flag(&p->flags[0], SIP_DEFER_BYE_ON_TRANSFER)) {
3160                 if (option_debug >3)
3161                         ast_log(LOG_DEBUG, "SIP Transfer: Not hanging up right now... Rescheduling hangup for %s.\n", p->callid);
3162                 if (p->autokillid > -1)
3163                         sip_cancel_destroy(p);
3164                 sip_scheddestroy(p, 32000);
3165                 ast_clear_flag(&p->flags[0], SIP_DEFER_BYE_ON_TRANSFER);        /* Really hang up next time */
3166                 ast_clear_flag(&p->flags[0], SIP_NEEDDESTROY);
3167                 p->owner->tech_pvt = NULL;
3168                 p->owner = NULL;  /* Owner will be gone after we return, so take it away */
3169                 return 0;
3170         }
3171         if (option_debug) {
3172                 if (ast_test_flag(ast, AST_FLAG_ZOMBIE) && p->refer && option_debug)
3173                         ast_log(LOG_DEBUG, "SIP Transfer: Hanging up Zombie channel %s after transfer ... Call-ID: %s\n", ast->name, p->callid);
3174                 else 
3175                         ast_log(LOG_DEBUG, "Hangup call %s, SIP callid %s)\n", ast->name, p->callid);
3176         }
3177         if (option_debug && ast_test_flag(ast, AST_FLAG_ZOMBIE)) {
3178                 ast_log(LOG_DEBUG, "Hanging up zombie call. Be scared.\n");
3179         }
3180
3181         ast_mutex_lock(&p->lock);
3182         if (option_debug && sipdebug)
3183                 ast_log(LOG_DEBUG, "update_call_counter(%s) - decrement call limit counter on hangup\n", p->username);
3184         update_call_counter(p, DEC_CALL_LIMIT);
3185
3186         /* Determine how to disconnect */
3187         if (p->owner != ast) {
3188                 ast_log(LOG_WARNING, "Huh?  We aren't the owner? Can't hangup call.\n");
3189                 ast_mutex_unlock(&p->lock);
3190                 return 0;
3191         }
3192         /* If the call is not UP, we need to send CANCEL instead of BYE */
3193         if (ast->_state != AST_STATE_UP) {
3194                 needcancel = TRUE;
3195                 if (option_debug > 3)
3196                         ast_log(LOG_DEBUG, "Hanging up channel in state %s (not UP)\n", ast_state2str(ast->_state));
3197         }
3198
3199         /* Disconnect */
3200         p = ast->tech_pvt;
3201         if (p->vad)
3202                 ast_dsp_free(p->vad);
3203
3204         p->owner = NULL;
3205         ast->tech_pvt = NULL;
3206
3207         ast_mutex_lock(&usecnt_lock);
3208         usecnt--;
3209         ast_mutex_unlock(&usecnt_lock);
3210         ast_update_use_count();
3211
3212         ast_set_flag(&locflags, SIP_NEEDDESTROY);       
3213
3214         /* Start the process if it's not already started */
3215         if (!ast_test_flag(&p->flags[0], SIP_ALREADYGONE) && !ast_strlen_zero(p->initreq.data)) {
3216                 if (needcancel) {       /* Outgoing call, not up */
3217                         if (ast_test_flag(&p->flags[0], SIP_OUTGOING)) {
3218                                 /* stop retransmitting an INVITE that has not received a response */
3219                                 __sip_pretend_ack(p);
3220
3221                                 /* if we can't send right now, mark it pending */
3222                                 if (!ast_test_flag(&p->flags[0], SIP_CAN_BYE)) {
3223                                         ast_set_flag(&p->flags[0], SIP_PENDINGBYE);
3224                                 } else {
3225                                         /* Send a new request: CANCEL */
3226                                         transmit_request_with_auth(p, SIP_CANCEL, p->ocseq, XMIT_RELIABLE, FALSE);
3227                                         /* Actually don't destroy us yet, wait for the 487 on our original 
3228                                            INVITE, but do set an autodestruct just in case we never get it. */
3229                                         ast_clear_flag(&locflags, SIP_NEEDDESTROY);
3230
3231                                         sip_scheddestroy(p, SIP_TRANS_TIMEOUT);
3232                                 }
3233                                 if ( p->initid != -1 ) {
3234                                         /* channel still up - reverse dec of inUse counter
3235                                            only if the channel is not auto-congested */
3236                                         update_call_counter(p, INC_CALL_LIMIT);
3237                                 }
3238                         } else {        /* Incoming call, not up */
3239                                 const char *res;
3240                                 if (ast->hangupcause && (res = hangup_cause2sip(ast->hangupcause)))
3241                                         transmit_response_reliable(p, res, &p->initreq);
3242                                 else 
3243                                         transmit_response_reliable(p, "603 Declined", &p->initreq);
3244                         }
3245                 } else {        /* Call is in UP state, send BYE */
3246                         if (!p->pendinginvite) {
3247                                 char *audioqos = "";
3248                                 char *videoqos = "";
3249                                 if (p->rtp)
3250                                         audioqos = ast_rtp_get_quality(p->rtp);
3251                                 if (p->vrtp)
3252                                         videoqos = ast_rtp_get_quality(p->vrtp);
3253                                 /* Send a hangup */
3254                                 transmit_request_with_auth(p, SIP_BYE, 0, XMIT_RELIABLE, 1);
3255
3256                                 /* Get RTCP quality before end of call */
3257                                 if (recordhistory) {
3258                                         if (p->rtp)
3259                                                 append_history(p, "RTCPaudio", "Quality:%s", audioqos);
3260                                         if (p->vrtp)
3261                                                 append_history(p, "RTCPvideo", "Quality:%s", videoqos);
3262                                 }
3263                                 if (p->rtp && p->owner)
3264                                         pbx_builtin_setvar_helper(p->owner, "RTPAUDIOQOS", audioqos);
3265                                 if (p->vrtp && p->owner)
3266                                         pbx_builtin_setvar_helper(p->owner, "RTPVIDEOQOS", videoqos);
3267                         } else {
3268                                 /* Note we will need a BYE when this all settles out
3269                                    but we can't send one while we have "INVITE" outstanding. */
3270                                 ast_set_flag(&p->flags[0], SIP_PENDINGBYE);     
3271                                 ast_clear_flag(&p->flags[0], SIP_NEEDREINVITE); 
3272                         }
3273                 }
3274         }
3275         ast_copy_flags(&p->flags[0], &locflags, SIP_NEEDDESTROY);       
3276         ast_mutex_unlock(&p->lock);
3277         return 0;
3278 }
3279
3280 /*! \brief Try setting codec suggested by the SIP_CODEC channel variable */
3281 static void try_suggested_sip_codec(struct sip_pvt *p)
3282 {
3283         int fmt;
3284         const char *codec;
3285
3286         codec = pbx_builtin_getvar_helper(p->owner, "SIP_CODEC");
3287         if (!codec) 
3288                 return;
3289
3290         fmt = ast_getformatbyname(codec);
3291         if (fmt) {
3292                 ast_log(LOG_NOTICE, "Changing codec to '%s' for this call because of ${SIP_CODEC} variable\n", codec);
3293                 if (p->jointcapability & fmt) {
3294                         p->jointcapability &= fmt;
3295                         p->capability &= fmt;
3296                 } else
3297                         ast_log(LOG_NOTICE, "Ignoring ${SIP_CODEC} variable because it is not shared by both ends.\n");
3298         } else
3299                 ast_log(LOG_NOTICE, "Ignoring ${SIP_CODEC} variable because of unrecognized/not configured codec (check allow/disallow in sip.conf): %s\n", codec);
3300         return; 
3301 }
3302
3303 /*! \brief  sip_answer: Answer SIP call , send 200 OK on Invite 
3304  * Part of PBX interface */
3305 static int sip_answer(struct ast_channel *ast)
3306 {
3307         int res = 0;
3308         struct sip_pvt *p = ast->tech_pvt;
3309
3310         ast_mutex_lock(&p->lock);
3311         if (ast->_state != AST_STATE_UP) {
3312                 try_suggested_sip_codec(p);     
3313
3314                 ast_setstate(ast, AST_STATE_UP);
3315                 if (option_debug)
3316                         ast_log(LOG_DEBUG, "SIP answering channel: %s\n", ast->name);
3317                 if (p->t38.state == T38_PEER_DIRECT) {
3318                         p->t38.state = T38_ENABLED;
3319                         if (option_debug > 1)
3320                                 ast_log(LOG_DEBUG,"T38State change to %d on channel %s\n", p->t38.state, ast->name);
3321                         res = transmit_response_with_t38_sdp(p, "200 OK", &p->initreq, XMIT_CRITICAL);
3322                 } else {
3323                         res = transmit_response_with_sdp(p, "200 OK", &p->initreq, XMIT_CRITICAL);
3324                 }
3325         }
3326         ast_mutex_unlock(&p->lock);
3327         return res;
3328 }
3329
3330 /*! \brief Send frame to media channel (rtp) */
3331 static int sip_write(struct ast_channel *ast, struct ast_frame *frame)
3332 {
3333         struct sip_pvt *p = ast->tech_pvt;
3334         int res = 0;
3335
3336         switch (frame->frametype) {
3337         case AST_FRAME_VOICE:
3338                 if (!(frame->subclass & ast->nativeformats)) {
3339                         ast_log(LOG_WARNING, "Asked to transmit frame type %d, while native formats is %d (read/write = %d/%d)\n",
3340                                 frame->subclass, ast->nativeformats, ast->readformat, ast->writeformat);
3341                         return 0;
3342                 }
3343                 if (p) {
3344                         ast_mutex_lock(&p->lock);
3345                         if (p->rtp) {
3346                                 /* If channel is not up, activate early media session */
3347                                 if ((ast->_state != AST_STATE_UP) &&
3348                                     !ast_test_flag(&p->flags[0], SIP_PROGRESS_SENT) &&
3349                                     !ast_test_flag(&p->flags[0], SIP_OUTGOING)) {
3350                                         transmit_response_with_sdp(p, "183 Session Progress", &p->initreq, XMIT_UNRELIABLE);
3351                                         ast_set_flag(&p->flags[0], SIP_PROGRESS_SENT);  
3352                                 }
3353                                 p->lastrtptx = time(NULL);
3354                                 res = ast_rtp_write(p->rtp, frame);
3355                         }
3356                         ast_mutex_unlock(&p->lock);
3357                 }
3358                 break;
3359         case AST_FRAME_VIDEO:
3360                 if (p) {
3361                         ast_mutex_lock(&p->lock);
3362                         if (p->vrtp) {
3363                                 /* Activate video early media */
3364                                 if ((ast->_state != AST_STATE_UP) &&
3365                                     !ast_test_flag(&p->flags[0], SIP_PROGRESS_SENT) &&
3366                                     !ast_test_flag(&p->flags[0], SIP_OUTGOING)) {
3367                                         transmit_response_with_sdp(p, "183 Session Progress", &p->initreq, XMIT_UNRELIABLE);
3368                                         ast_set_flag(&p->flags[0], SIP_PROGRESS_SENT);  
3369                                 }
3370                                 p->lastrtptx = time(NULL);
3371                                 res = ast_rtp_write(p->vrtp, frame);
3372                         }
3373                         ast_mutex_unlock(&p->lock);
3374                 }
3375                 break;
3376         case AST_FRAME_IMAGE:
3377                 return 0;
3378                 break;
3379         case AST_FRAME_MODEM:
3380                 if (p) {
3381                         ast_mutex_lock(&p->lock);
3382                         if (p->udptl) {
3383                                 if ((ast->_state != AST_STATE_UP) &&
3384                                         !ast_test_flag(&p->flags[0], SIP_PROGRESS_SENT) && 
3385                                     !ast_test_flag(&p->flags[0], SIP_OUTGOING)) {
3386                                         transmit_response_with_t38_sdp(p, "183 Session Progress", &p->initreq, XMIT_RELIABLE);
3387                                         ast_set_flag(&p->flags[0], SIP_PROGRESS_SENT);
3388                                 }
3389                                 res = ast_udptl_write(p->udptl, frame);
3390                         }
3391                         ast_mutex_unlock(&p->lock);
3392                 }
3393                 break;
3394         default: 
3395                 ast_log(LOG_WARNING, "Can't send %d type frames with SIP write\n", frame->frametype);
3396                 return 0;
3397         }
3398
3399         return res;
3400 }
3401
3402 /*! \brief  sip_fixup: Fix up a channel:  If a channel is consumed, this is called.
3403         Basically update any ->owner links */
3404 static int sip_fixup(struct ast_channel *oldchan, struct ast_channel *newchan)
3405 {
3406         int ret = -1;
3407         struct sip_pvt *p;
3408
3409         if (newchan && ast_test_flag(newchan, AST_FLAG_ZOMBIE))
3410                 ast_log(LOG_DEBUG, "New channel is zombie\n");
3411         if (oldchan && ast_test_flag(oldchan, AST_FLAG_ZOMBIE))
3412                 ast_log(LOG_DEBUG, "Old channel is zombie\n");
3413
3414         if (!newchan || !newchan->tech_pvt) {
3415                 if (!newchan)
3416                         ast_log(LOG_WARNING, "No new channel! Fixup of %s failed.\n", oldchan->name);
3417                 else
3418                         ast_log(LOG_WARNING, "No SIP tech_pvt! Fixup of %s failed.\n", oldchan->name);
3419                 return -1;
3420         }
3421         p = newchan->tech_pvt;
3422
3423         ast_mutex_lock(&p->lock);
3424         append_history(p, "Masq", "Old channel: %s\n", oldchan->name);
3425         append_history(p, "Masq (cont)", "...new owner: %s\n", newchan->name);
3426         if (p->owner != oldchan)
3427                 ast_log(LOG_WARNING, "old channel wasn't %p but was %p\n", oldchan, p->owner);
3428         else {
3429                 p->owner = newchan;
3430                 ret = 0;
3431         }
3432         if (option_debug > 2)
3433                 ast_log(LOG_DEBUG, "SIP Fixup: New owner for dialogue %s: %s (Old parent: %s)\n", p->callid, p->owner->name, oldchan->name);