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