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