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