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