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