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