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