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