- Documentation update
[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;       /*!< SUBSCRIBE: Is this dialog a subscription?  */
805         int stateid;                            /*!< SUBSCRIBE: ID for devicestate subscriptions */
806         int laststate;                          /*!< SUBSCRIBE: Last known extension state */
807         int dialogver;                          /*!< SUBSCRIBE: Version for subscription dialog-info */
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 inbound 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 - raw format for outbound packets that are sent or scheduled for transmission */
827 struct sip_pkt {
828         struct sip_pkt *next;                   /*!< Next packet in linked list */
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
1082 /*------Response handling functions */
1083 static void handle_response_invite(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1084 static void handle_response_refer(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1085
1086 /*----- RTP interface functions */
1087 static int sip_set_rtp_peer(struct ast_channel *chan, struct ast_rtp *rtp, struct ast_rtp *vrtp, int codecs, int nat_active);
1088 static struct ast_rtp *sip_get_rtp_peer(struct ast_channel *chan);
1089 static struct ast_rtp *sip_get_vrtp_peer(struct ast_channel *chan);
1090 static int sip_get_codec(struct ast_channel *chan);
1091
1092 /*! \brief Definition of this channel for PBX channel registration */
1093 static const struct ast_channel_tech sip_tech = {
1094         .type = "SIP",
1095         .description = "Session Initiation Protocol (SIP)",
1096         .capabilities = ((AST_FORMAT_MAX_AUDIO << 1) - 1),
1097         .properties = AST_CHAN_TP_WANTSJITTER,
1098         .requester = sip_request_call,
1099         .devicestate = sip_devicestate,
1100         .call = sip_call,
1101         .hangup = sip_hangup,
1102         .answer = sip_answer,
1103         .read = sip_read,
1104         .write = sip_write,
1105         .write_video = sip_write,
1106         .indicate = sip_indicate,
1107         .transfer = sip_transfer,
1108         .fixup = sip_fixup,
1109         .send_digit = sip_senddigit,
1110         .bridge = ast_rtp_bridge,
1111         .send_text = sip_sendtext,
1112 };
1113
1114 /*! \brief Interface structure with callbacks used to connect to RTP module */
1115 static struct ast_rtp_protocol sip_rtp = {
1116         type: "SIP",
1117         get_rtp_info: sip_get_rtp_peer,
1118         get_vrtp_info: sip_get_vrtp_peer,
1119         set_rtp_peer: sip_set_rtp_peer,
1120         get_codec: sip_get_codec,
1121 };
1122
1123 /*! \brief Convert transfer status to string */
1124 static char *referstatus2str(enum referstatus rstatus)
1125 {
1126         int i = (sizeof(referstatusstrings) / sizeof(referstatusstrings[0]));
1127         int x;
1128
1129         for (x = 0; x < i; x++) {
1130                 if (referstatusstrings[x].status ==  rstatus)
1131                         return (char *) referstatusstrings[x].text;
1132         }
1133         return "";
1134 }
1135
1136 /*! \brief Initialize the initital request packet in the pvt structure.
1137         This packet is used for creating replies and future requests in
1138         a dialog */
1139 void initialize_initreq(struct sip_pvt *p, struct sip_request *req)
1140 {
1141         if (p->initreq.headers) {
1142                 ast_log(LOG_WARNING, "Initializing already initialized SIP dialog??? %s\n", p->callid);
1143                 return;
1144         }
1145         /* Use this as the basis */
1146         copy_request(&p->initreq, req);
1147         parse_request(&p->initreq);
1148         if (ast_test_flag(req, SIP_PKT_DEBUG))
1149                 ast_verbose("%d headers, %d lines\n", p->initreq.headers, p->initreq.lines);
1150 }
1151
1152
1153 /*! \brief returns true if 'name' (with optional trailing whitespace)
1154  * matches the sip method 'id'.
1155  * Strictly speaking, SIP methods are case SENSITIVE, but we do
1156  * a case-insensitive comparison to be more tolerant.
1157  * following Jon Postel's rule: Be gentle in what you accept, strict with what you send 
1158  */
1159 static int method_match(enum sipmethod id, const char *name)
1160 {
1161         int len = strlen(sip_methods[id].text);
1162         int l_name = name ? strlen(name) : 0;
1163         /* true if the string is long enough, and ends with whitespace, and matches */
1164         return (l_name >= len && name[len] < 33 &&
1165                 !strncasecmp(sip_methods[id].text, name, len));
1166 }
1167
1168 /*! \brief  find_sip_method: Find SIP method from header */
1169 static int find_sip_method(const char *msg)
1170 {
1171         int i, res = 0;
1172         
1173         if (ast_strlen_zero(msg))
1174                 return 0;
1175         for (i = 1; i < (sizeof(sip_methods) / sizeof(sip_methods[0])) && !res; i++) {
1176                 if (method_match(i, msg))
1177                         res = sip_methods[i].id;
1178         }
1179         return res;
1180 }
1181
1182 /*! \brief Parse supported header in incoming packet */
1183 static unsigned int parse_sip_options(struct sip_pvt *pvt, const char *supported)
1184 {
1185         char *next, *sep;
1186         char *temp = ast_strdupa(supported);
1187         unsigned int profile = 0;
1188         int i, found;
1189
1190         if (!pvt || ast_strlen_zero(supported) )
1191                 return 0;
1192
1193         if (option_debug > 2 && sipdebug)
1194                 ast_log(LOG_DEBUG, "Begin: parsing SIP \"Supported: %s\"\n", supported);
1195
1196         for (next = temp; next; next = sep) {
1197                 found = FALSE;
1198                 if ( (sep = strchr(next, ',')) != NULL)
1199                         *sep++ = '\0';
1200                 next = ast_skip_blanks(next);
1201                 if (option_debug > 2 && sipdebug)
1202                         ast_log(LOG_DEBUG, "Found SIP option: -%s-\n", next);
1203                 for (i=0; i < (sizeof(sip_options) / sizeof(sip_options[0])); i++) {
1204                         if (!strcasecmp(next, sip_options[i].text)) {
1205                                 profile |= sip_options[i].id;
1206                                 found = TRUE;
1207                                 if (option_debug > 2 && sipdebug)
1208                                         ast_log(LOG_DEBUG, "Matched SIP option: %s\n", next);
1209                                 break;
1210                         }
1211                 }
1212                 if (!found && option_debug > 2 && sipdebug)
1213                         ast_log(LOG_DEBUG, "Found no match for SIP option: %s (Please file bug report!)\n", next);
1214         }
1215
1216         pvt->sipoptions = profile;
1217         return profile;
1218 }
1219
1220 /*! \brief See if we pass debug IP filter */
1221 static inline int sip_debug_test_addr(const struct sockaddr_in *addr) 
1222 {
1223         if (!sipdebug)
1224                 return 0;
1225         if (debugaddr.sin_addr.s_addr) {
1226                 if (((ntohs(debugaddr.sin_port) != 0)
1227                         && (debugaddr.sin_port != addr->sin_port))
1228                         || (debugaddr.sin_addr.s_addr != addr->sin_addr.s_addr))
1229                         return 0;
1230         }
1231         return 1;
1232 }
1233
1234 /* The real destination address for a write */
1235 static const struct sockaddr_in *sip_real_dst(const struct sip_pvt *p)
1236 {
1237         return ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_ROUTE ? &p->recv : &p->sa;
1238 }
1239
1240 static const char *sip_nat_mode(const struct sip_pvt *p)
1241 {
1242         return ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_ROUTE ? "NAT" : "no NAT";
1243 }
1244
1245 /*! \brief Test PVT for debugging output */
1246 static inline int sip_debug_test_pvt(struct sip_pvt *p) 
1247 {
1248         if (!sipdebug)
1249                 return 0;
1250         return sip_debug_test_addr(sip_real_dst(p));
1251 }
1252
1253 /*! \brief Transmit SIP message */
1254 static int __sip_xmit(struct sip_pvt *p, char *data, int len)
1255 {
1256         int res;
1257         char iabuf[INET_ADDRSTRLEN];
1258         const struct sockaddr_in *dst = sip_real_dst(p);
1259         res=sendto(sipsock, data, len, 0, (const struct sockaddr *)dst, sizeof(struct sockaddr_in));
1260
1261         if (res != len)
1262                 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));
1263         return res;
1264 }
1265
1266
1267 /*! \brief Build a Via header for a request */
1268 static void build_via(struct sip_pvt *p)
1269 {
1270         char iabuf[INET_ADDRSTRLEN];
1271         /* Work around buggy UNIDEN UIP200 firmware */
1272         const char *rport = ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_RFC3581 ? ";rport" : "";
1273
1274         /* z9hG4bK is a magic cookie.  See RFC 3261 section 8.1.1.7 */
1275         ast_string_field_build(p, via, "SIP/2.0/UDP %s:%d;branch=z9hG4bK%08x%s",
1276                          ast_inet_ntoa(iabuf, sizeof(iabuf), p->ourip), ourport, p->branch, rport);
1277 }
1278
1279 /*! \brief NAT fix - decide which IP address to use for ASterisk server?
1280  * Only used for outbound registrations */
1281 static int ast_sip_ouraddrfor(struct in_addr *them, struct in_addr *us)
1282 {
1283         /*
1284          * Using the localaddr structure built up with localnet statements
1285          * apply it to their address to see if we need to substitute our
1286          * externip or can get away with our internal bindaddr
1287          */
1288         struct sockaddr_in theirs;
1289         theirs.sin_addr = *them;
1290
1291         if (localaddr && externip.sin_addr.s_addr &&
1292            ast_apply_ha(localaddr, &theirs)) {
1293                 if (externexpire && time(NULL) >= externexpire) {
1294                         struct ast_hostent ahp;
1295                         struct hostent *hp;
1296
1297                         time(&externexpire);
1298                         externexpire += externrefresh;
1299                         if ((hp = ast_gethostbyname(externhost, &ahp))) {
1300                                 memcpy(&externip.sin_addr, hp->h_addr, sizeof(externip.sin_addr));
1301                         } else
1302                                 ast_log(LOG_NOTICE, "Warning: Re-lookup of '%s' failed!\n", externhost);
1303                 }
1304                 *us = externip.sin_addr;
1305                 if (option_debug) {
1306                         char iabuf[INET_ADDRSTRLEN];
1307                         ast_inet_ntoa(iabuf, sizeof(iabuf), *(struct in_addr *)&them->s_addr);
1308                 
1309                         ast_log(LOG_DEBUG, "Target address %s is not local, substituting externip\n", iabuf);
1310                 }
1311         } else if (bindaddr.sin_addr.s_addr)
1312                 *us = bindaddr.sin_addr;
1313         else
1314                 return ast_ouraddrfor(them, us);
1315         return 0;
1316 }
1317
1318 /*! \brief Append to SIP dialog history 
1319         \return Always returns 0 */
1320 #define append_history(p, event, fmt , args... )        append_history_full(p, "%-15s " fmt, event, ## args)
1321
1322 static int append_history_full(struct sip_pvt *p, const char *fmt, ...)
1323         __attribute__ ((format (printf, 2, 3)));
1324
1325 /*! \brief Append to SIP dialog history with arg list  */
1326 static void append_history_va(struct sip_pvt *p, const char *fmt, va_list ap)
1327 {
1328         char buf[80], *c = buf; /* max history length */
1329         struct sip_history *hist;
1330         int l;
1331
1332         vsnprintf(buf, sizeof(buf), fmt, ap);
1333         strsep(&c, "\r\n"); /* Trim up everything after \r or \n */
1334         l = strlen(buf) + 1;
1335         if (!(hist = ast_calloc(1, sizeof(*hist) + l)))
1336                 return;
1337         if (!p->history && !(p->history = ast_calloc(1, sizeof(*p->history)))) {
1338                 free(hist);
1339                 return;
1340         }
1341         memcpy(hist->event, buf, l);
1342         AST_LIST_INSERT_TAIL(p->history, hist, list);
1343 }
1344
1345 /*! \brief Append to SIP dialog history with arg list  */
1346 static int append_history_full(struct sip_pvt *p, const char *fmt, ...)
1347 {
1348         va_list ap;
1349
1350         if (!recordhistory || !p)
1351                 return 0;
1352         va_start(ap, fmt);
1353         append_history_va(p, fmt, ap);
1354         va_end(ap);
1355
1356         return 0;
1357 }
1358
1359 /*! \brief Retransmit SIP message if no answer */
1360 static int retrans_pkt(void *data)
1361 {
1362         struct sip_pkt *pkt = data, *prev, *cur = NULL;
1363         char iabuf[INET_ADDRSTRLEN];
1364         int reschedule = DEFAULT_RETRANS;
1365
1366         /* Lock channel PVT */
1367         ast_mutex_lock(&pkt->owner->lock);
1368
1369         if (pkt->retrans < MAX_RETRANS) {
1370                 pkt->retrans++;
1371                 if (!pkt->timer_t1) {   /* Re-schedule using timer_a and timer_t1 */
1372                         if (sipdebug && option_debug > 3)
1373                                 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);
1374                 } else {
1375                         int siptimer_a;
1376
1377                         if (sipdebug && option_debug > 3)
1378                                 ast_log(LOG_DEBUG, "SIP TIMER: Rescheduling retransmission #%d (%d) %s - %d\n", pkt->retransid, pkt->retrans, sip_methods[pkt->method].text, pkt->method);
1379                         if (!pkt->timer_a)
1380                                 pkt->timer_a = 2 ;
1381                         else
1382                                 pkt->timer_a = 2 * pkt->timer_a;
1383  
1384                         /* For non-invites, a maximum of 4 secs */
1385                         siptimer_a = pkt->timer_t1 * pkt->timer_a;      /* Double each time */
1386                         if (pkt->method != SIP_INVITE && siptimer_a > 4000)
1387                                 siptimer_a = 4000;
1388                 
1389                         /* Reschedule re-transmit */
1390                         reschedule = siptimer_a;
1391                         if (option_debug > 3)
1392                                 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);
1393                 } 
1394
1395                 if (pkt->owner && sip_debug_test_pvt(pkt->owner)) {
1396                         if (ast_test_flag(&pkt->owner->flags[0], SIP_NAT_ROUTE))
1397                                 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);
1398                         else
1399                                 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);
1400                 }
1401
1402                 append_history(pkt->owner, "ReTx", "%d %s", reschedule, pkt->data);
1403                 __sip_xmit(pkt->owner, pkt->data, pkt->packetlen);
1404                 ast_mutex_unlock(&pkt->owner->lock);
1405                 return  reschedule;
1406         } 
1407         /* Too many retries */
1408         if (pkt->owner && pkt->method != SIP_OPTIONS) {
1409                 if (ast_test_flag(pkt, FLAG_FATAL) || sipdebug) /* Tell us if it's critical or if we're debugging */
1410                         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");
1411         } else {
1412                 if ((pkt->method == SIP_OPTIONS) && sipdebug)
1413                         ast_log(LOG_WARNING, "Cancelling retransmit of OPTIONs (call id %s) \n", pkt->owner->callid);
1414         }
1415         append_history(pkt->owner, "MaxRetries", "%s", (ast_test_flag(pkt, FLAG_FATAL)) ? "(Critical)" : "(Non-critical)");
1416                 
1417         pkt->retransid = -1;
1418
1419         if (ast_test_flag(pkt, FLAG_FATAL)) {
1420                 while(pkt->owner->owner && ast_mutex_trylock(&pkt->owner->owner->lock)) {
1421                         ast_mutex_unlock(&pkt->owner->lock);
1422                         usleep(1);
1423                         ast_mutex_lock(&pkt->owner->lock);
1424                 }
1425                 if (pkt->owner->owner) {
1426                         ast_set_flag(&pkt->owner->flags[0], SIP_ALREADYGONE);
1427                         ast_log(LOG_WARNING, "Hanging up call %s - no reply to our critical packet.\n", pkt->owner->callid);
1428                         ast_queue_hangup(pkt->owner->owner);
1429                         ast_channel_unlock(pkt->owner->owner);
1430                 } else {
1431                         /* If no channel owner, destroy now */
1432                         ast_set_flag(&pkt->owner->flags[0], SIP_NEEDDESTROY);   
1433                 }
1434         }
1435         /* In any case, go ahead and remove the packet */
1436         for (prev = NULL, cur = pkt->owner->packets; cur; prev = cur, cur = cur->next) {
1437                 if (cur == pkt)
1438                         break;
1439         }
1440         if (cur) {
1441                 if (prev)
1442                         prev->next = cur->next;
1443                 else
1444                         pkt->owner->packets = cur->next;
1445                 ast_mutex_unlock(&pkt->owner->lock);
1446                 free(cur);
1447                 pkt = NULL;
1448         } else
1449                 ast_log(LOG_WARNING, "Weird, couldn't find packet owner!\n");
1450         if (pkt)
1451                 ast_mutex_unlock(&pkt->owner->lock);
1452         return 0;
1453 }
1454
1455 /*! \brief Transmit packet with retransmits 
1456         \return 0 on success, -1 on failure to allocate packet 
1457 */
1458 static int __sip_reliable_xmit(struct sip_pvt *p, int seqno, int resp, char *data, int len, int fatal, int sipmethod)
1459 {
1460         struct sip_pkt *pkt;
1461         int siptimer_a = DEFAULT_RETRANS;
1462
1463         if (!(pkt = ast_calloc(1, sizeof(*pkt) + len + 1)))
1464                 return -1;
1465         memcpy(pkt->data, data, len);
1466         pkt->method = sipmethod;
1467         pkt->packetlen = len;
1468         pkt->next = p->packets;
1469         pkt->owner = p;
1470         pkt->seqno = seqno;
1471         pkt->flags = resp;
1472         pkt->data[len] = '\0';
1473         pkt->timer_t1 = p->timer_t1;    /* Set SIP timer T1 */
1474         if (fatal)
1475                 ast_set_flag(pkt, FLAG_FATAL);
1476         if (pkt->timer_t1)
1477                 siptimer_a = pkt->timer_t1 * 2;
1478
1479         /* Schedule retransmission */
1480         pkt->retransid = ast_sched_add_variable(sched, siptimer_a, retrans_pkt, pkt, 1);
1481         if (option_debug > 3 && sipdebug)
1482                 ast_log(LOG_DEBUG, "*** SIP TIMER: Initalizing retransmit timer on packet: Id  #%d\n", pkt->retransid);
1483         pkt->next = p->packets;
1484         p->packets = pkt;
1485
1486         __sip_xmit(pkt->owner, pkt->data, pkt->packetlen);      /* Send packet */
1487         if (sipmethod == SIP_INVITE) {
1488                 /* Note this is a pending invite */
1489                 p->pendinginvite = seqno;
1490         }
1491         return 0;
1492 }
1493
1494 /*! \brief Kill a SIP dialog (called by scheduler) */
1495 static int __sip_autodestruct(void *data)
1496 {
1497         struct sip_pvt *p = data;
1498
1499         /* If this is a subscription, tell the phone that we got a timeout */
1500         if (p->subscribed) {
1501                 p->subscribed = TIMEOUT;
1502                 transmit_state_notify(p, AST_EXTENSION_DEACTIVATED, 1); /* Send last notification */
1503                 p->subscribed = NONE;
1504                 append_history(p, "Subscribestatus", "timeout");
1505                 if (option_debug > 2)
1506                         ast_log(LOG_DEBUG, "Re-scheduled destruction of SIP subsription %s\n", p->callid ? p->callid : "<unknown>");
1507                 return 10000;   /* Reschedule this destruction so that we know that it's gone */
1508         }
1509
1510         /* Reset schedule ID */
1511         p->autokillid = -1;
1512
1513         if (option_debug)
1514                 ast_log(LOG_DEBUG, "Auto destroying call '%s'\n", p->callid);
1515         append_history(p, "AutoDestroy", "");
1516         if (p->owner) {
1517                 ast_log(LOG_WARNING, "Autodestruct on dialog '%s' with owner in place (Method: %s)\n", p->callid, sip_methods[p->method].text);
1518                 ast_queue_hangup(p->owner);
1519         } else {
1520                 sip_destroy(p);
1521         }
1522         return 0;
1523 }
1524
1525 /*! \brief Schedule destruction of SIP call */
1526 static int sip_scheddestroy(struct sip_pvt *p, int ms)
1527 {
1528         if (sip_debug_test_pvt(p))
1529                 ast_verbose("Scheduling destruction of SIP dialog '%s' in %d ms (Method: %s)\n", p->callid, ms, sip_methods[p->method].text);
1530         if (recordhistory)
1531                 append_history(p, "SchedDestroy", "%d ms", ms);
1532
1533         if (p->autokillid > -1)
1534                 ast_sched_del(sched, p->autokillid);
1535         p->autokillid = ast_sched_add(sched, ms, __sip_autodestruct, p);
1536         return 0;
1537 }
1538
1539 /*! \brief Cancel destruction of SIP dialog */
1540 static int sip_cancel_destroy(struct sip_pvt *p)
1541 {
1542         if (p->autokillid > -1) {
1543                 ast_sched_del(sched, p->autokillid);
1544                 append_history(p, "CancelDestroy", "");
1545                 p->autokillid = -1;
1546         }
1547         return 0;
1548 }
1549
1550 /*! \brief Acknowledges receipt of a packet and stops retransmission */
1551 static int __sip_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod, int reset)
1552 {
1553         struct sip_pkt *cur, *prev = NULL;
1554         int res = -1;
1555
1556         /* Just in case... */
1557         char *msg;
1558
1559         msg = sip_methods[sipmethod].text;
1560
1561         ast_mutex_lock(&p->lock);
1562         for (cur = p->packets; cur; prev = cur, cur = cur->next) {
1563                 if ((cur->seqno == seqno) && ((ast_test_flag(cur, FLAG_RESPONSE)) == resp) &&
1564                         ((ast_test_flag(cur, FLAG_RESPONSE)) || 
1565                          (!strncasecmp(msg, cur->data, strlen(msg)) && (cur->data[strlen(msg)] < 33)))) {
1566                         if (!resp && (seqno == p->pendinginvite)) {
1567                                 ast_log(LOG_DEBUG, "Acked pending invite %d\n", p->pendinginvite);
1568                                 p->pendinginvite = 0;
1569                         }
1570                         /* this is our baby */
1571                         if (prev)
1572                                 prev->next = cur->next;
1573                         else
1574                                 p->packets = cur->next;
1575                         if (cur->retransid > -1) {
1576                                 if (sipdebug && option_debug > 3)
1577                                         ast_log(LOG_DEBUG, "** SIP TIMER: Cancelling retransmit of packet (reply received) Retransid #%d\n", cur->retransid);
1578                                 ast_sched_del(sched, cur->retransid);
1579                         }
1580                         if (!reset)
1581                                 free(cur);
1582                         res = 0;
1583                         break;
1584                 }
1585         }
1586         ast_mutex_unlock(&p->lock);
1587         if (option_debug)
1588                 ast_log(LOG_DEBUG, "Stopping retransmission on '%s' of %s %d: Match %s\n", p->callid, resp ? "Response" : "Request", seqno, res ? "Not Found" : "Found");
1589         return res;
1590 }
1591
1592 /*! \brief Pretend to ack all packets */
1593 static int __sip_pretend_ack(struct sip_pvt *p)
1594 {
1595         struct sip_pkt *cur = NULL;
1596
1597         while (p->packets) {
1598                 if (cur == p->packets) {
1599                         ast_log(LOG_WARNING, "Have a packet that doesn't want to give up! %s\n", sip_methods[cur->method].text);
1600                         return -1;
1601                 }
1602                 cur = p->packets;
1603                 if (cur->method)
1604                         __sip_ack(p, p->packets->seqno, (ast_test_flag(p->packets, FLAG_RESPONSE)), cur->method, FALSE);
1605                 else {  /* Unknown packet type */
1606                         char *c;
1607                         char method[128];
1608
1609                         ast_copy_string(method, p->packets->data, sizeof(method));
1610                         c = ast_skip_blanks(method); /* XXX what ? */
1611                         *c = '\0';
1612                         __sip_ack(p, p->packets->seqno, (ast_test_flag(p->packets, FLAG_RESPONSE)), find_sip_method(method), FALSE);
1613                 }
1614         }
1615         return 0;
1616 }
1617
1618 /*! \brief Acks receipt of packet, keep it around (used for provisional responses) */
1619 static int __sip_semi_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod)
1620 {
1621         struct sip_pkt *cur;
1622         int res = -1;
1623
1624         for (cur = p->packets; cur; cur = cur->next) {
1625                 if (cur->seqno == seqno && ast_test_flag(cur, FLAG_RESPONSE) == resp &&
1626                         (ast_test_flag(cur, FLAG_RESPONSE) || method_match(sipmethod, cur->data))) {
1627                         /* this is our baby */
1628                         if (cur->retransid > -1) {
1629                                 if (option_debug > 3 && sipdebug)
1630                                         ast_log(LOG_DEBUG, "*** SIP TIMER: Cancelling retransmission #%d - %s (got response)\n", cur->retransid, sip_methods[sipmethod].text);
1631                                 ast_sched_del(sched, cur->retransid);
1632                         }
1633                         cur->retransid = -1;
1634                         res = 0;
1635                         break;
1636                 }
1637         }
1638         if (option_debug)
1639                 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");
1640         return res;
1641 }
1642
1643
1644 /*! \brief Copy SIP request, parse it */
1645 static void parse_copy(struct sip_request *dst, struct sip_request *src)
1646 {
1647         memset(dst, 0, sizeof(*dst));
1648         memcpy(dst->data, src->data, sizeof(dst->data));
1649         dst->len = src->len;
1650         parse_request(dst);
1651 }
1652
1653 /*! \brief Transmit response on SIP request*/
1654 static int send_response(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno)
1655 {
1656         int res;
1657
1658         if (sip_debug_test_pvt(p)) {
1659                 char iabuf[INET_ADDRSTRLEN];
1660                 if (ast_test_flag(&p->flags[0], SIP_NAT_ROUTE))
1661                         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);
1662                 else
1663                         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);
1664         }
1665         if (recordhistory) {
1666                 struct sip_request tmp;
1667                 parse_copy(&tmp, req);
1668                 append_history(p, reliable ? "TxRespRel" : "TxResp", "%s / %s - %s", tmp.data, get_header(&tmp, "CSeq"), 
1669                         tmp.method == SIP_RESPONSE ? tmp.rlPart2 : sip_methods[tmp.method].text);
1670         }
1671         res = (reliable) ?
1672                 __sip_reliable_xmit(p, seqno, 1, req->data, req->len, (reliable == XMIT_CRITICAL), req->method) :
1673                 __sip_xmit(p, req->data, req->len);
1674         if (res > 0)
1675                 return 0;
1676         return res;
1677 }
1678
1679 /*! \brief Send SIP Request to the other part of the dialogue */
1680 static int send_request(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno)
1681 {
1682         int res;
1683
1684         if (sip_debug_test_pvt(p)) {
1685                 char iabuf[INET_ADDRSTRLEN];
1686                 if (ast_test_flag(&p->flags[0], SIP_NAT_ROUTE))
1687                         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);
1688                 else
1689                         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);
1690         }
1691         if (recordhistory) {
1692                 struct sip_request tmp;
1693                 parse_copy(&tmp, req);
1694                 append_history(p, reliable ? "TxReqRel" : "TxReq", "%s / %s - %s", tmp.data, get_header(&tmp, "CSeq"), sip_methods[tmp.method].text);
1695         }
1696         res = (reliable) ?
1697                 __sip_reliable_xmit(p, seqno, 0, req->data, req->len, (reliable > 1), req->method) :
1698                 __sip_xmit(p, req->data, req->len);
1699         return res;
1700 }
1701
1702 /*! \brief Pick out text in brackets from character string
1703         \return pointer to terminated stripped string
1704         \param tmp input string that will be modified */
1705 static char *get_in_brackets(char *tmp)
1706 {
1707         char *parse;
1708         char *first_quote;
1709         char *first_bracket;
1710         char *second_bracket;
1711         char last_char;
1712
1713         parse = tmp;
1714         for (;;) {
1715                 first_quote = strchr(parse, '"');
1716                 first_bracket = strchr(parse, '<');
1717                 if (first_quote && first_bracket && (first_quote < first_bracket)) {
1718                         last_char = '\0';
1719                         for (parse = first_quote + 1; *parse; parse++) {
1720                                 if ((*parse == '"') && (last_char != '\\'))
1721                                         break;
1722                                 last_char = *parse;
1723                         }
1724                         if (!*parse) {
1725                                 ast_log(LOG_WARNING, "No closing quote found in '%s'\n", tmp);
1726                                 return tmp;
1727                         }
1728                         parse++;
1729                         continue;
1730                 }
1731                 if (first_bracket) {
1732                         second_bracket = strchr(first_bracket + 1, '>');
1733                         if (second_bracket) {
1734                                 *second_bracket = '\0';
1735                                 return first_bracket + 1;
1736                         } else {
1737                                 ast_log(LOG_WARNING, "No closing bracket found in '%s'\n", tmp);
1738                                 return tmp;
1739                         }
1740                 }
1741                 return tmp;
1742         }
1743 }
1744
1745 /*! \brief Send SIP MESSAGE text within a call
1746         Called from PBX core sendtext() application */
1747 static int sip_sendtext(struct ast_channel *ast, const char *text)
1748 {
1749         struct sip_pvt *p = ast->tech_pvt;
1750         int debug = sip_debug_test_pvt(p);
1751
1752         if (debug)
1753                 ast_verbose("Sending text %s on %s\n", text, ast->name);
1754         if (!p)
1755                 return -1;
1756         if (ast_strlen_zero(text))
1757                 return 0;
1758         if (debug)
1759                 ast_verbose("Really sending text %s on %s\n", text, ast->name);
1760         transmit_message_with_text(p, text);
1761         return 0;       
1762 }
1763
1764 /*! \brief Update peer object in realtime storage */
1765 static void realtime_update_peer(const char *peername, struct sockaddr_in *sin, const char *username, const char *fullcontact, int expirey)
1766 {
1767         char port[10];
1768         char ipaddr[20];
1769         char regseconds[20];
1770         time_t nowtime;
1771         const char *fc = fullcontact ? "fullcontact" : NULL;
1772         
1773         time(&nowtime);
1774         nowtime += expirey;
1775         snprintf(regseconds, sizeof(regseconds), "%d", (int)nowtime);   /* Expiration time */
1776         ast_inet_ntoa(ipaddr, sizeof(ipaddr), sin->sin_addr);
1777         snprintf(port, sizeof(port), "%d", ntohs(sin->sin_port));
1778         
1779         ast_update_realtime("sippeers", "name", peername, "ipaddr", ipaddr,
1780                 "port", port, "regseconds", regseconds,
1781                 "username", username, fc, fullcontact, NULL); /* note fc _can_ be NULL */
1782 }
1783
1784 /*! \brief Automatically add peer extension to dial plan */
1785 static void register_peer_exten(struct sip_peer *peer, int onoff)
1786 {
1787         char multi[256];
1788         char *stringp, *ext;
1789         if (!ast_strlen_zero(global_regcontext)) {
1790
1791                 ast_copy_string(multi, S_OR(peer->regexten, peer->name), sizeof(multi));
1792                 stringp = multi;
1793                 while((ext = strsep(&stringp, "&"))) {
1794                         if (onoff)
1795                                 ast_add_extension(global_regcontext, 1, ext, 1, NULL, NULL, "Noop",
1796                                                   ast_strdup(peer->name), free, "SIP");
1797                         else
1798                                 ast_context_remove_extension(global_regcontext, ext, 1, NULL);
1799                 }
1800         }
1801 }
1802
1803 /*! \brief Destroy peer object from memory */
1804 static void sip_destroy_peer(struct sip_peer *peer)
1805 {
1806         if (option_debug > 2)
1807                 ast_log(LOG_DEBUG, "Destroying SIP peer %s\n", peer->name);
1808
1809         /* Delete it, it needs to disappear */
1810         if (peer->call)
1811                 sip_destroy(peer->call);
1812
1813         if (peer->mwipvt) {     /* We have an active subscription, delete it */
1814                 sip_destroy(peer->mwipvt);
1815         }
1816
1817         if (peer->chanvars) {
1818                 ast_variables_destroy(peer->chanvars);
1819                 peer->chanvars = NULL;
1820         }
1821         if (peer->expire > -1)
1822                 ast_sched_del(sched, peer->expire);
1823         if (peer->pokeexpire > -1)
1824                 ast_sched_del(sched, peer->pokeexpire);
1825         register_peer_exten(peer, FALSE);
1826         ast_free_ha(peer->ha);
1827         if (ast_test_flag(&peer->flags[1], SIP_PAGE2_SELFDESTRUCT))
1828                 apeerobjs--;
1829         else if (ast_test_flag(&peer->flags[0], SIP_REALTIME))
1830                 rpeerobjs--;
1831         else
1832                 speerobjs--;
1833         clear_realm_authentication(peer->auth);
1834         peer->auth = NULL;
1835         if (peer->dnsmgr)
1836                 ast_dnsmgr_release(peer->dnsmgr);
1837         free(peer);
1838 }
1839
1840 /*! \brief Update peer data in database (if used) */
1841 static void update_peer(struct sip_peer *p, int expiry)
1842 {
1843         int rtcachefriends = ast_test_flag(&p->flags[1], SIP_PAGE2_RTCACHEFRIENDS);
1844         if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTUPDATE) &&
1845             (ast_test_flag(&p->flags[0], SIP_REALTIME) || rtcachefriends)) {
1846                 realtime_update_peer(p->name, &p->addr, p->username, rtcachefriends ? p->fullcontact : NULL, expiry);
1847         }
1848 }
1849
1850
1851 /*! \brief  realtime_peer: Get peer from realtime storage
1852  * Checks the "sippeers" realtime family from extconfig.conf 
1853  * \todo Consider adding check of port address when matching here to follow the same
1854  *      algorithm as for static peers. Will we break anything by adding that?
1855 */
1856 static struct sip_peer *realtime_peer(const char *peername, struct sockaddr_in *sin)
1857 {
1858         struct sip_peer *peer = NULL;
1859         struct ast_variable *var;
1860         struct ast_variable *tmp;
1861         char *newpeername = (char *) peername;
1862         char iabuf[80];
1863
1864         /* First check on peer name */
1865         if (newpeername) 
1866                 var = ast_load_realtime("sippeers", "name", peername, NULL);
1867         else if (sin) { /* Then check on IP address for dynamic peers */
1868                 ast_inet_ntoa(iabuf, sizeof(iabuf), sin->sin_addr);
1869                 var = ast_load_realtime("sippeers", "host", iabuf, NULL);       /* First check for fixed IP hosts */
1870                 if (!var)
1871                         var = ast_load_realtime("sippeers", "ipaddr", iabuf, NULL);     /* Then check for registred hosts */
1872         
1873         } else
1874                 return NULL;
1875
1876         if (!var)
1877                 return NULL;
1878
1879         for (tmp = var; tmp; tmp = tmp->next) {
1880                 /* If this is type=user, then skip this object. */
1881                 if (!strcasecmp(tmp->name, "type") &&
1882                     !strcasecmp(tmp->value, "user")) {
1883                         ast_variables_destroy(var);
1884                         return NULL;
1885                 } else if (!newpeername && !strcasecmp(tmp->name, "name")) {
1886                         newpeername = tmp->value;
1887                 }
1888         }
1889         
1890         if (!newpeername) {     /* Did not find peer in realtime */
1891                 ast_log(LOG_WARNING, "Cannot Determine peer name ip=%s\n", iabuf);
1892                 ast_variables_destroy(var);
1893                 return NULL;
1894         }
1895
1896         /* Peer found in realtime, now build it in memory */
1897         peer = build_peer(newpeername, var, !ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS));
1898         if (!peer) {
1899                 ast_variables_destroy(var);
1900                 return NULL;
1901         }
1902
1903         if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS)) {
1904                 /* Cache peer */
1905                 ast_copy_flags(&peer->flags[1],&global_flags[1], SIP_PAGE2_RTAUTOCLEAR|SIP_PAGE2_RTCACHEFRIENDS);
1906                 if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTAUTOCLEAR)) {
1907                         if (peer->expire > -1) {
1908                                 ast_sched_del(sched, peer->expire);
1909                         }
1910                         peer->expire = ast_sched_add(sched, (global_rtautoclear) * 1000, expire_register, (void *)peer);
1911                 }
1912                 ASTOBJ_CONTAINER_LINK(&peerl,peer);
1913         } else {
1914                 ast_set_flag(&peer->flags[0], SIP_REALTIME);
1915         }
1916         ast_variables_destroy(var);
1917
1918         return peer;
1919 }
1920
1921 /*! \brief Support routine for find_peer */
1922 static int sip_addrcmp(char *name, struct sockaddr_in *sin)
1923 {
1924         /* We know name is the first field, so we can cast */
1925         struct sip_peer *p = (struct sip_peer *) name;
1926         return  !(!inaddrcmp(&p->addr, sin) || 
1927                                         (ast_test_flag(&p->flags[0], SIP_INSECURE_PORT) &&
1928                                         (p->addr.sin_addr.s_addr == sin->sin_addr.s_addr)));
1929 }
1930
1931 /*! \brief Locate peer by name or ip address 
1932  *      This is used on incoming SIP message to find matching peer on ip
1933         or outgoing message to find matching peer on name */
1934 static struct sip_peer *find_peer(const char *peer, struct sockaddr_in *sin, int realtime)
1935 {
1936         struct sip_peer *p = NULL;
1937
1938         if (peer)
1939                 p = ASTOBJ_CONTAINER_FIND(&peerl, peer);
1940         else
1941                 p = ASTOBJ_CONTAINER_FIND_FULL(&peerl, sin, name, sip_addr_hashfunc, 1, sip_addrcmp);
1942
1943         if (!p && realtime) {
1944                 p = realtime_peer(peer, sin);
1945         }
1946         return p;
1947 }
1948
1949 /*! \brief Remove user object from in-memory storage */
1950 static void sip_destroy_user(struct sip_user *user)
1951 {
1952         if (option_debug > 2)
1953                 ast_log(LOG_DEBUG, "Destroying user object from memory: %s\n", user->name);
1954         ast_free_ha(user->ha);
1955         if (user->chanvars) {
1956                 ast_variables_destroy(user->chanvars);
1957                 user->chanvars = NULL;
1958         }
1959         if (ast_test_flag(&user->flags[0], SIP_REALTIME))
1960                 ruserobjs--;
1961         else
1962                 suserobjs--;
1963         free(user);
1964 }
1965
1966 /*! \brief Load user from realtime storage
1967  * Loads user from "sipusers" category in realtime (extconfig.conf)
1968  * Users are matched on From: user name (the domain in skipped) */
1969 static struct sip_user *realtime_user(const char *username)
1970 {
1971         struct ast_variable *var;
1972         struct ast_variable *tmp;
1973         struct sip_user *user = NULL;
1974
1975         var = ast_load_realtime("sipusers", "name", username, NULL);
1976
1977         if (!var)
1978                 return NULL;
1979
1980         for (tmp = var; tmp; tmp = tmp->next) {
1981                 if (!strcasecmp(tmp->name, "type") &&
1982                         !strcasecmp(tmp->value, "peer")) {
1983                         ast_variables_destroy(var);
1984                         return NULL;
1985                 }
1986         }
1987
1988         user = build_user(username, var, !ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS));
1989         
1990         if (!user) {    /* No user found */
1991                 ast_variables_destroy(var);
1992                 return NULL;
1993         }
1994
1995         if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS)) {
1996                 ast_set_flag(&user->flags[1], SIP_PAGE2_RTCACHEFRIENDS);
1997                 suserobjs++;
1998                 ASTOBJ_CONTAINER_LINK(&userl,user);
1999         } else {
2000                 /* Move counter from s to r... */
2001                 suserobjs--;
2002                 ruserobjs++;
2003                 ast_set_flag(&user->flags[0], SIP_REALTIME);
2004         }
2005         ast_variables_destroy(var);
2006         return user;
2007 }
2008
2009 /*! \brief Locate user by name 
2010  * Locates user by name (From: sip uri user name part) first
2011  * from in-memory list (static configuration) then from 
2012  * realtime storage (defined in extconfig.conf) */
2013 static struct sip_user *find_user(const char *name, int realtime)
2014 {
2015         struct sip_user *u = ASTOBJ_CONTAINER_FIND(&userl, name);
2016         if (!u && realtime)
2017                 u = realtime_user(name);
2018         return u;
2019 }
2020
2021 /*! \brief Create address structure from peer reference */
2022 static int create_addr_from_peer(struct sip_pvt *r, struct sip_peer *peer)
2023 {
2024         int natflags;
2025
2026         if ((peer->addr.sin_addr.s_addr || peer->defaddr.sin_addr.s_addr) &&
2027             (!peer->maxms || ((peer->lastms >= 0)  && (peer->lastms <= peer->maxms)))) {
2028                 r->sa = (peer->addr.sin_addr.s_addr) ? peer->addr : peer->defaddr;
2029                 r->recv = r->sa;
2030         } else {
2031                 return -1;
2032         }
2033
2034         ast_copy_flags(&r->flags[0], &peer->flags[0], SIP_FLAGS_TO_COPY);
2035         ast_copy_flags(&r->flags[1], &peer->flags[1], SIP_PAGE2_FLAGS_TO_COPY);
2036         r->capability = peer->capability;
2037         if (!ast_test_flag(&r->flags[1], SIP_PAGE2_VIDEOSUPPORT) && r->vrtp) {
2038                 ast_rtp_destroy(r->vrtp);
2039                 r->vrtp = NULL;
2040         }
2041         r->prefs = peer->prefs;
2042         natflags = ast_test_flag(&r->flags[0], SIP_NAT) & SIP_NAT_ROUTE;
2043         if (r->rtp) {
2044                 if (option_debug)
2045                         ast_log(LOG_DEBUG, "Setting NAT on RTP to %d\n", natflags);
2046                 ast_rtp_setnat(r->rtp, natflags);
2047         }
2048         if (r->vrtp) {
2049                 if (option_debug)
2050                         ast_log(LOG_DEBUG, "Setting NAT on VRTP to %d\n", natflags);
2051                 ast_rtp_setnat(r->vrtp, natflags);
2052         }
2053         ast_string_field_set(r, peername, peer->username);
2054         ast_string_field_set(r, authname, peer->username);
2055         ast_string_field_set(r, username, peer->username);
2056         ast_string_field_set(r, peersecret, peer->secret);
2057         ast_string_field_set(r, peermd5secret, peer->md5secret);
2058         ast_string_field_set(r, tohost, peer->tohost);
2059         ast_string_field_set(r, fullcontact, peer->fullcontact);
2060         if (!r->initreq.headers && !ast_strlen_zero(peer->fromdomain)) {
2061                 char *tmpcall;
2062                 char *c;
2063                 tmpcall = ast_strdupa(r->callid);
2064                 if (tmpcall) {
2065                         c = strchr(tmpcall, '@');
2066                         if (c) {
2067                                 *c = '\0';
2068                                 ast_string_field_build(r, callid, "%s@%s", tmpcall, peer->fromdomain);
2069                         }
2070                 }
2071         }
2072         if (ast_strlen_zero(r->tohost)) {
2073                 char iabuf[INET_ADDRSTRLEN];
2074
2075                 ast_inet_ntoa(iabuf, sizeof(iabuf),  r->sa.sin_addr);
2076                 ast_string_field_set(r, tohost, iabuf);
2077         }
2078         if (!ast_strlen_zero(peer->fromdomain))
2079                 ast_string_field_set(r, fromdomain, peer->fromdomain);
2080         if (!ast_strlen_zero(peer->fromuser))
2081                 ast_string_field_set(r, fromuser, peer->fromuser);
2082         r->maxtime = peer->maxms;
2083         r->callgroup = peer->callgroup;
2084         r->pickupgroup = peer->pickupgroup;
2085         r->allowtransfer = peer->allowtransfer;
2086         /* Set timer T1 to RTT for this peer (if known by qualify=) */
2087         /* Minimum is settable or default to 100 ms */
2088         if (peer->maxms && peer->lastms)
2089                 r->timer_t1 = peer->lastms < global_t1min ? global_t1min : peer->lastms;
2090         if ((ast_test_flag(&r->flags[0], SIP_DTMF) == SIP_DTMF_RFC2833) ||
2091             (ast_test_flag(&r->flags[0], SIP_DTMF) == SIP_DTMF_AUTO))
2092                 r->noncodeccapability |= AST_RTP_DTMF;
2093         else
2094                 r->noncodeccapability &= ~AST_RTP_DTMF;
2095         ast_string_field_set(r, context, peer->context);
2096         r->rtptimeout = peer->rtptimeout;
2097         r->rtpholdtimeout = peer->rtpholdtimeout;
2098         r->rtpkeepalive = peer->rtpkeepalive;
2099         if (peer->call_limit)
2100                 ast_set_flag(&r->flags[0], SIP_CALL_LIMIT);
2101         r->maxcallbitrate = peer->maxcallbitrate;
2102         
2103         return 0;
2104 }
2105
2106 /*! \brief create address structure from peer name
2107  *      Or, if peer not found, find it in the global DNS 
2108  *      returns TRUE (-1) on failure, FALSE on success */
2109 static int create_addr(struct sip_pvt *dialog, const char *opeer)
2110 {
2111         struct hostent *hp;
2112         struct ast_hostent ahp;
2113         struct sip_peer *p;
2114         int found=0;
2115         char *port;
2116         int portno;
2117         char host[MAXHOSTNAMELEN], *hostn;
2118         char peer[256];
2119
2120         ast_copy_string(peer, opeer, sizeof(peer));
2121         port = strchr(peer, ':');
2122         if (port)
2123                 *port++ = '\0';
2124         dialog->sa.sin_family = AF_INET;
2125         dialog->timer_t1 = 500; /* Default SIP retransmission timer T1 (RFC 3261) */
2126         p = find_peer(peer, NULL, 1);
2127
2128         if (p) {
2129                 found++;
2130                 if (create_addr_from_peer(dialog, p))
2131                         ASTOBJ_UNREF(p, sip_destroy_peer);
2132         }
2133         if (!p) {
2134                 if (found)
2135                         return -1;
2136
2137                 hostn = peer;
2138                 portno = port ? atoi(port) : DEFAULT_SIP_PORT;
2139                 if (srvlookup) {
2140                         char service[MAXHOSTNAMELEN];
2141                         int tportno;
2142                         int ret;
2143                         snprintf(service, sizeof(service), "_sip._udp.%s", peer);
2144                         ret = ast_get_srv(NULL, host, sizeof(host), &tportno, service);
2145                         if (ret > 0) {
2146                                 hostn = host;
2147                                 portno = tportno;
2148                         }
2149                 }
2150                 hp = ast_gethostbyname(hostn, &ahp);
2151                 if (hp) {
2152                         ast_string_field_set(dialog, tohost, peer);
2153                         memcpy(&dialog->sa.sin_addr, hp->h_addr, sizeof(dialog->sa.sin_addr));
2154                         dialog->sa.sin_port = htons(portno);
2155                         dialog->recv = dialog->sa;
2156                         return 0;
2157                 } else {
2158                         ast_log(LOG_WARNING, "No such host: %s\n", peer);
2159                         return -1;
2160                 }
2161         } else {
2162                 ASTOBJ_UNREF(p, sip_destroy_peer);
2163                 return 0;
2164         }
2165 }
2166
2167 /*! \brief Scheduled congestion on a call */
2168 static int auto_congest(void *nothing)
2169 {
2170         struct sip_pvt *p = nothing;
2171
2172         ast_mutex_lock(&p->lock);
2173         p->initid = -1;
2174         if (p->owner) {
2175                 /* XXX fails on possible deadlock */
2176                 if (!ast_channel_trylock(p->owner)) {
2177                         ast_log(LOG_NOTICE, "Auto-congesting %s\n", p->owner->name);
2178                         ast_queue_control(p->owner, AST_CONTROL_CONGESTION);
2179                         ast_channel_unlock(p->owner);
2180                 }
2181         }
2182         ast_mutex_unlock(&p->lock);
2183         return 0;
2184 }
2185
2186
2187
2188
2189 /*! \brief Initiate SIP call from PBX 
2190  *      used from the dial() application      */
2191 static int sip_call(struct ast_channel *ast, char *dest, int timeout)
2192 {
2193         int res;
2194         struct sip_pvt *p;
2195         struct varshead *headp;
2196         struct ast_var_t *current;
2197         
2198         p = ast->tech_pvt;
2199         if ((ast->_state != AST_STATE_DOWN) && (ast->_state != AST_STATE_RESERVED)) {
2200                 ast_log(LOG_WARNING, "sip_call called on %s, neither down nor reserved\n", ast->name);
2201                 return -1;
2202         }
2203
2204         /* Check whether there is vxml_url, distinctive ring variables */
2205         headp=&ast->varshead;
2206         AST_LIST_TRAVERSE(headp,current,entries) {
2207                 /* Check whether there is a VXML_URL variable */
2208                 if (!p->options->vxml_url && !strcasecmp(ast_var_name(current), "VXML_URL")) {
2209                         p->options->vxml_url = ast_var_value(current);
2210                 } else if (!p->options->uri_options && !strcasecmp(ast_var_name(current), "SIP_URI_OPTIONS")) {
2211                         p->options->uri_options = ast_var_value(current);
2212                 } else if (!p->options->distinctive_ring && !strcasecmp(ast_var_name(current), "ALERT_INFO")) {
2213                         /* Check whether there is a ALERT_INFO variable */
2214                         p->options->distinctive_ring = ast_var_value(current);
2215                 } else if (!p->options->addsipheaders && !strncasecmp(ast_var_name(current), "SIPADDHEADER", strlen("SIPADDHEADER"))) {
2216                         /* Check whether there is a variable with a name starting with SIPADDHEADER */
2217                         p->options->addsipheaders = 1;
2218                 }
2219         }
2220         
2221         res = 0;
2222         ast_set_flag(&p->flags[0], SIP_OUTGOING);
2223         if (option_debug)
2224                 ast_log(LOG_DEBUG, "Outgoing Call for %s\n", p->username);
2225         res = update_call_counter(p, INC_CALL_LIMIT);
2226         if ( res != -1 ) {
2227                 p->callingpres = ast->cid.cid_pres;
2228                 p->jointcapability = p->capability;
2229                 transmit_invite(p, SIP_INVITE, 1, 2);
2230                 if (p->maxtime) {
2231                         /* Initialize auto-congest time */
2232                         p->initid = ast_sched_add(sched, p->maxtime * 4, auto_congest, p);
2233                 }
2234         }
2235         return res;
2236 }
2237
2238 /*! \brief Destroy registry object
2239         Objects created with the register= statement in static configuration */
2240 static void sip_registry_destroy(struct sip_registry *reg)
2241 {
2242         /* Really delete */
2243         if (option_debug > 2)
2244                 ast_log(LOG_DEBUG, "Destroying registry entry for %s@%s\n", reg->username, reg->hostname);
2245
2246         if (reg->call) {
2247                 /* Clear registry before destroying to ensure
2248                    we don't get reentered trying to grab the registry lock */
2249                 reg->call->registry = NULL;
2250                 if (option_debug > 2)
2251                         ast_log(LOG_DEBUG, "Destroying active SIP dialog for registry %s@%s\n", reg->username, reg->hostname);
2252                 sip_destroy(reg->call);
2253         }
2254         if (reg->expire > -1)
2255                 ast_sched_del(sched, reg->expire);
2256         if (reg->timeout > -1)
2257                 ast_sched_del(sched, reg->timeout);
2258         ast_string_field_free_all(reg);
2259         regobjs--;
2260         free(reg);
2261         
2262 }
2263
2264 /*! \brief Execute destrucion of SIP dialog structure, release memory */
2265 static void __sip_destroy(struct sip_pvt *p, int lockowner)
2266 {
2267         struct sip_pvt *cur, *prev = NULL;
2268         struct sip_pkt *cp;
2269
2270         if (sip_debug_test_pvt(p) || option_debug > 2)
2271                 ast_verbose("Really destroying SIP dialog '%s' Method: %s\n", p->callid, sip_methods[p->method].text);
2272
2273         /* Remove link from peer to subscription of MWI */
2274         if (p->relatedpeer && p->relatedpeer->mwipvt)
2275                 p->relatedpeer->mwipvt = NULL;
2276
2277         if (dumphistory)
2278                 sip_dump_history(p);
2279
2280         if (p->options)
2281                 free(p->options);
2282
2283         if (p->stateid > -1)
2284                 ast_extension_state_del(p->stateid, NULL);
2285         if (p->initid > -1)
2286                 ast_sched_del(sched, p->initid);
2287         if (p->autokillid > -1)
2288                 ast_sched_del(sched, p->autokillid);
2289
2290         if (p->rtp)
2291                 ast_rtp_destroy(p->rtp);
2292         if (p->vrtp)
2293                 ast_rtp_destroy(p->vrtp);
2294         if (p->route) {
2295                 free_old_route(p->route);
2296                 p->route = NULL;
2297         }
2298         if (p->registry) {
2299                 if (p->registry->call == p)
2300                         p->registry->call = NULL;
2301                 ASTOBJ_UNREF(p->registry, sip_registry_destroy);
2302         }
2303
2304         /* Unlink us from the owner if we have one */
2305         if (p->owner) {
2306                 if (lockowner)
2307                         ast_channel_lock(p->owner);
2308                 if (option_debug)
2309                         ast_log(LOG_DEBUG, "Detaching from %s\n", p->owner->name);
2310                 p->owner->tech_pvt = NULL;
2311                 if (lockowner)
2312                         ast_channel_unlock(p->owner);
2313         }
2314         /* Clear history */
2315         if (p->history) {
2316                 struct sip_history *hist;
2317                 while( (hist = AST_LIST_REMOVE_HEAD(p->history, list)) )
2318                         free(hist);
2319                 free(p->history);
2320                 p->history = NULL;
2321         }
2322
2323         for (prev = NULL, cur = iflist; cur; prev = cur, cur = cur->next) {
2324                 if (cur == p) {
2325                         if (prev)
2326                                 prev->next = cur->next;
2327                         else
2328                                 iflist = cur->next;
2329                         break;
2330                 }
2331         }
2332         if (!cur) {
2333                 ast_log(LOG_WARNING, "Trying to destroy \"%s\", not found in dialog list?!?! \n", p->callid);
2334                 return;
2335         } 
2336         if (p->initid > -1)
2337                 ast_sched_del(sched, p->initid);
2338
2339         /* remove all current packets in this dialog */
2340         while((cp = p->packets)) {
2341                 p->packets = p->packets->next;
2342                 if (cp->retransid > -1)
2343                         ast_sched_del(sched, cp->retransid);
2344                 free(cp);
2345         }
2346         if (p->chanvars) {
2347                 ast_variables_destroy(p->chanvars);
2348                 p->chanvars = NULL;
2349         }
2350         ast_mutex_destroy(&p->lock);
2351
2352         ast_string_field_free_all(p);
2353
2354         free(p);
2355 }
2356
2357 /*! \brief  update_call_counter: Handle call_limit for SIP users 
2358  * Setting a call-limit will cause calls above the limit not to be accepted.
2359  *
2360  * Remember that for a type=friend, there's one limit for the user and
2361  * another for the peer, not a combined call limit.
2362  * This will cause unexpected behaviour in subscriptions, since a "friend"
2363  * is *two* devices in Asterisk, not one.
2364  *
2365  * Thought: For realtime, we should propably update storage with inuse counter... 
2366  *
2367  * \return 0 if call is ok (no call limit, below treshold)
2368  *      -1 on rejection of call
2369  *              
2370  */
2371 static int update_call_counter(struct sip_pvt *fup, int event)
2372 {
2373         char name[256];
2374         int *inuse, *call_limit;
2375         int outgoing = ast_test_flag(&fup->flags[0], SIP_OUTGOING);
2376         struct sip_user *u = NULL;
2377         struct sip_peer *p = NULL;
2378
2379         if (option_debug > 2)
2380                 ast_log(LOG_DEBUG, "Updating call counter for %s call\n", outgoing ? "outgoing" : "incoming");
2381         /* Test if we need to check call limits, in order to avoid 
2382            realtime lookups if we do not need it */
2383         if (!ast_test_flag(&fup->flags[0], SIP_CALL_LIMIT))
2384                 return 0;
2385
2386         ast_copy_string(name, fup->username, sizeof(name));
2387
2388         /* Check the list of users */
2389         if (!outgoing)  /* Only check users for incoming calls */
2390                 u = find_user(name, 1);
2391
2392         if (u) {
2393                 inuse = &u->inUse;
2394                 call_limit = &u->call_limit;
2395                 p = NULL;
2396         } else {
2397                 /* Try to find peer */
2398                 if (!p)
2399                         p = find_peer(fup->peername, NULL, 1);
2400                 if (p) {
2401                         inuse = &p->inUse;
2402                         call_limit = &p->call_limit;
2403                         ast_copy_string(name, fup->peername, sizeof(name));
2404                 } else {
2405                         if (option_debug > 1)
2406                                 ast_log(LOG_DEBUG, "%s is not a local user, no call limit\n", name);
2407                         return 0;
2408                 }
2409         }
2410         switch(event) {
2411                 /* incoming and outgoing affects the inUse counter */
2412                 case DEC_CALL_LIMIT:
2413                         if ( *inuse > 0 ) {
2414                                 if (ast_test_flag(&fup->flags[0], SIP_INC_COUNT))
2415                                         (*inuse)--;
2416                         } else {
2417                                 *inuse = 0;
2418                         }
2419                         if (option_debug > 1 || sipdebug) {
2420                                 ast_log(LOG_DEBUG, "Call %s %s '%s' removed from call limit %d\n", outgoing ? "to" : "from", u ? "user":"peer", name, *call_limit);
2421                         }
2422                         break;
2423                 case INC_CALL_LIMIT:
2424                         if (*call_limit > 0 ) {
2425                                 if (*inuse >= *call_limit) {
2426                                         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);
2427                                         if (u)
2428                                                 ASTOBJ_UNREF(u, sip_destroy_user);
2429                                         else
2430                                                 ASTOBJ_UNREF(p, sip_destroy_peer);
2431                                         return -1; 
2432                                 }
2433                         }
2434                         (*inuse)++;
2435                         ast_set_flag(&fup->flags[0], SIP_INC_COUNT);
2436                         if (option_debug > 1 || sipdebug) {
2437                                 ast_log(LOG_DEBUG, "Call %s %s '%s' is %d out of %d\n", outgoing ? "to" : "from", u ? "user":"peer", name, *inuse, *call_limit);
2438                         }
2439                         break;
2440                 default:
2441                         ast_log(LOG_ERROR, "update_call_counter(%s, %d) called with no event!\n", name, event);
2442         }
2443         if (u)
2444                 ASTOBJ_UNREF(u, sip_destroy_user);
2445         else
2446                 ASTOBJ_UNREF(p, sip_destroy_peer);
2447         return 0;
2448 }
2449
2450 /*! \brief Destroy SIP call structure */
2451 static void sip_destroy(struct sip_pvt *p)
2452 {
2453         ast_mutex_lock(&iflock);
2454         if (option_debug > 2)
2455                 ast_log(LOG_DEBUG, "Destroying SIP dialog %s\n", p->callid);
2456         __sip_destroy(p, 1);
2457         ast_mutex_unlock(&iflock);
2458 }
2459
2460 /*! \brief Convert SIP hangup causes to Asterisk hangup causes */
2461 static int hangup_sip2cause(int cause)
2462 {
2463         /* Possible values taken from causes.h */
2464
2465         switch(cause) {
2466                 case 401:       /* Unauthorized */
2467                         return AST_CAUSE_CALL_REJECTED;
2468                 case 403:       /* Not found */
2469                         return AST_CAUSE_CALL_REJECTED;
2470                 case 404:       /* Not found */
2471                         return AST_CAUSE_UNALLOCATED;
2472                 case 405:       /* Method not allowed */
2473                         return AST_CAUSE_INTERWORKING;
2474                 case 407:       /* Proxy authentication required */
2475                         return AST_CAUSE_CALL_REJECTED;
2476                 case 408:       /* No reaction */
2477                         return AST_CAUSE_NO_USER_RESPONSE;
2478                 case 409:       /* Conflict */
2479                         return AST_CAUSE_NORMAL_TEMPORARY_FAILURE;
2480                 case 410:       /* Gone */
2481                         return AST_CAUSE_UNALLOCATED;
2482                 case 411:       /* Length required */
2483                         return AST_CAUSE_INTERWORKING;
2484                 case 413:       /* Request entity too large */
2485                         return AST_CAUSE_INTERWORKING;
2486                 case 414:       /* Request URI too large */
2487                         return AST_CAUSE_INTERWORKING;
2488                 case 415:       /* Unsupported media type */
2489                         return AST_CAUSE_INTERWORKING;
2490                 case 420:       /* Bad extension */
2491                         return AST_CAUSE_NO_ROUTE_DESTINATION;
2492                 case 480:       /* No answer */
2493                         return AST_CAUSE_FAILURE;
2494                 case 481:       /* No answer */
2495                         return AST_CAUSE_INTERWORKING;
2496                 case 482:       /* Loop detected */
2497                         return AST_CAUSE_INTERWORKING;
2498                 case 483:       /* Too many hops */
2499                         return AST_CAUSE_NO_ANSWER;
2500                 case 484:       /* Address incomplete */
2501                         return AST_CAUSE_INVALID_NUMBER_FORMAT;
2502                 case 485:       /* Ambigous */
2503                         return AST_CAUSE_UNALLOCATED;
2504                 case 486:       /* Busy everywhere */
2505                         return AST_CAUSE_BUSY;
2506                 case 487:       /* Request terminated */
2507                         return AST_CAUSE_INTERWORKING;
2508                 case 488:       /* No codecs approved */
2509                         return AST_CAUSE_BEARERCAPABILITY_NOTAVAIL;
2510                 case 491:       /* Request pending */
2511                         return AST_CAUSE_INTERWORKING;
2512                 case 493:       /* Undecipherable */
2513                         return AST_CAUSE_INTERWORKING;
2514                 case 500:       /* Server internal failure */
2515                         return AST_CAUSE_FAILURE;
2516                 case 501:       /* Call rejected */
2517                         return AST_CAUSE_FACILITY_REJECTED;
2518                 case 502:       
2519                         return AST_CAUSE_DESTINATION_OUT_OF_ORDER;
2520                 case 503:       /* Service unavailable */
2521                         return AST_CAUSE_CONGESTION;
2522                 case 504:       /* Gateway timeout */
2523                         return AST_CAUSE_RECOVERY_ON_TIMER_EXPIRE;
2524                 case 505:       /* SIP version not supported */
2525                         return AST_CAUSE_INTERWORKING;
2526                 case 600:       /* Busy everywhere */
2527                         return AST_CAUSE_USER_BUSY;
2528                 case 603:       /* Decline */
2529                         return AST_CAUSE_CALL_REJECTED;
2530                 case 604:       /* Does not exist anywhere */
2531                         return AST_CAUSE_UNALLOCATED;
2532                 case 606:       /* Not acceptable */
2533                         return AST_CAUSE_BEARERCAPABILITY_NOTAVAIL;
2534                 default:
2535                         return AST_CAUSE_NORMAL;
2536         }
2537         /* Never reached */
2538         return 0;
2539 }
2540
2541 /*! \brief Convert Asterisk hangup causes to SIP codes 
2542 \verbatim
2543  Possible values from causes.h
2544         AST_CAUSE_NOTDEFINED    AST_CAUSE_NORMAL        AST_CAUSE_BUSY
2545         AST_CAUSE_FAILURE       AST_CAUSE_CONGESTION    AST_CAUSE_UNALLOCATED
2546
2547         In addition to these, a lot of PRI codes is defined in causes.h 
2548         ...should we take care of them too ?
2549         
2550         Quote RFC 3398
2551
2552    ISUP Cause value                        SIP response
2553    ----------------                        ------------
2554    1  unallocated number                   404 Not Found
2555    2  no route to network                  404 Not found
2556    3  no route to destination              404 Not found
2557    16 normal call clearing                 --- (*)
2558    17 user busy                            486 Busy here
2559    18 no user responding                   408 Request Timeout
2560    19 no answer from the user              480 Temporarily unavailable
2561    20 subscriber absent                    480 Temporarily unavailable
2562    21 call rejected                        403 Forbidden (+)
2563    22 number changed (w/o diagnostic)      410 Gone
2564    22 number changed (w/ diagnostic)       301 Moved Permanently
2565    23 redirection to new destination       410 Gone
2566    26 non-selected user clearing           404 Not Found (=)
2567    27 destination out of order             502 Bad Gateway
2568    28 address incomplete                   484 Address incomplete
2569    29 facility rejected                    501 Not implemented
2570    31 normal unspecified                   480 Temporarily unavailable
2571 \endverbatim
2572 */
2573 static const char *hangup_cause2sip(int cause)
2574 {
2575         switch (cause) {
2576                 case AST_CAUSE_UNALLOCATED:             /* 1 */
2577                 case AST_CAUSE_NO_ROUTE_DESTINATION:    /* 3 IAX2: Can't find extension in context */
2578                 case AST_CAUSE_NO_ROUTE_TRANSIT_NET:    /* 2 */
2579                         return "404 Not Found";
2580                 case AST_CAUSE_CONGESTION:              /* 34 */
2581                 case AST_CAUSE_SWITCH_CONGESTION:       /* 42 */
2582                         return "503 Service Unavailable";
2583                 case AST_CAUSE_NO_USER_RESPONSE:        /* 18 */
2584                         return "408 Request Timeout";
2585                 case AST_CAUSE_NO_ANSWER:               /* 19 */
2586                         return "480 Temporarily unavailable";
2587                 case AST_CAUSE_CALL_REJECTED:           /* 21 */
2588                         return "403 Forbidden";
2589                 case AST_CAUSE_NUMBER_CHANGED:          /* 22 */
2590                         return "410 Gone";
2591                 case AST_CAUSE_NORMAL_UNSPECIFIED:      /* 31 */
2592                         return "480 Temporarily unavailable";
2593                 case AST_CAUSE_INVALID_NUMBER_FORMAT:
2594                         return "484 Address incomplete";
2595                 case AST_CAUSE_USER_BUSY:
2596                         return "486 Busy here";
2597                 case AST_CAUSE_FAILURE:
2598                         return "500 Server internal failure";
2599                 case AST_CAUSE_FACILITY_REJECTED:       /* 29 */
2600                         return "501 Not Implemented";
2601                 case AST_CAUSE_CHAN_NOT_IMPLEMENTED:
2602                         return "503 Service Unavailable";
2603                 /* Used in chan_iax2 */
2604                 case AST_CAUSE_DESTINATION_OUT_OF_ORDER:
2605                         return "502 Bad Gateway";
2606                 case AST_CAUSE_BEARERCAPABILITY_NOTAVAIL:       /* Can't find codec to connect to host */
2607                         return "488 Not Acceptable Here";
2608                         
2609                 case AST_CAUSE_NOTDEFINED:
2610                 default:
2611                         ast_log(LOG_DEBUG, "AST hangup cause %d (no match found in SIP)\n", cause);
2612                         return NULL;
2613         }
2614
2615         /* Never reached */
2616         return 0;
2617 }
2618
2619
2620 /*! \brief  sip_hangup: Hangup SIP call
2621  * Part of PBX interface, called from ast_hangup */
2622 static int sip_hangup(struct ast_channel *ast)
2623 {
2624         struct sip_pvt *p = ast->tech_pvt;
2625         int needcancel = FALSE;
2626         struct ast_flags locflags = {0};
2627
2628         if (!p) {
2629                 ast_log(LOG_DEBUG, "Asked to hangup channel that was not connected\n");
2630                 return 0;
2631         }
2632         if (option_debug && sipdebug)
2633                 ast_log(LOG_DEBUG, "Hangup call %s, SIP callid %s)\n", ast->name, p->callid);
2634
2635         ast_mutex_lock(&p->lock);
2636         if (option_debug && sipdebug)
2637                 ast_log(LOG_DEBUG, "update_call_counter(%s) - decrement call limit counter on hangup\n", p->username);
2638         update_call_counter(p, DEC_CALL_LIMIT);
2639         /* Determine how to disconnect */
2640         if (p->owner != ast) {
2641                 ast_log(LOG_WARNING, "Huh?  We aren't the owner? Can't hangup call.\n");
2642                 ast_mutex_unlock(&p->lock);
2643                 return 0;
2644         }
2645         /* If the call is not UP, we need to send CANCEL instead of BYE */
2646         if (ast->_state != AST_STATE_UP)
2647                 needcancel = TRUE;
2648
2649         /* Disconnect */
2650         p = ast->tech_pvt;
2651         if (p->vad)
2652                 ast_dsp_free(p->vad);
2653
2654         p->owner = NULL;
2655         ast->tech_pvt = NULL;
2656
2657         ast_mutex_lock(&usecnt_lock);
2658         usecnt--;
2659         ast_mutex_unlock(&usecnt_lock);
2660         ast_update_use_count();
2661
2662         ast_set_flag(&locflags, SIP_NEEDDESTROY);       
2663
2664         /* Start the process if it's not already started */
2665         if (!ast_test_flag(&p->flags[0], SIP_ALREADYGONE) && !ast_strlen_zero(p->initreq.data)) {
2666                 if (needcancel) {       /* Outgoing call, not up */
2667                         if (ast_test_flag(&p->flags[0], SIP_OUTGOING)) {
2668                                 /* stop retransmitting an INVITE that has not received a response */
2669                                 __sip_pretend_ack(p);
2670
2671                                 /* Send a new request: CANCEL */
2672                                 transmit_request_with_auth(p, SIP_CANCEL, p->ocseq, XMIT_RELIABLE, 0);
2673                                 /* Actually don't destroy us yet, wait for the 487 on our original 
2674                                    INVITE, but do set an autodestruct just in case we never get it. */
2675                                 ast_clear_flag(&locflags, SIP_NEEDDESTROY);
2676
2677                                 sip_scheddestroy(p, 32000);
2678                                 if ( p->initid != -1 ) {
2679                                         /* channel still up - reverse dec of inUse counter
2680                                            only if the channel is not auto-congested */
2681                                         update_call_counter(p, INC_CALL_LIMIT);
2682                                 }
2683                         } else {        /* Incoming call, not up */
2684                                 const char *res;
2685                                 if (ast->hangupcause && (res = hangup_cause2sip(ast->hangupcause)))
2686                                         transmit_response_reliable(p, res, &p->initreq);
2687                                 else 
2688                                         transmit_response_reliable(p, "603 Declined", &p->initreq);
2689                         }
2690                 } else {        /* Call is in UP state, send BYE */
2691                         if (!p->pendinginvite) {
2692                                 /* Send a hangup */
2693                                 transmit_request_with_auth(p, SIP_BYE, 0, XMIT_RELIABLE, 1);
2694                         } else {
2695                                 /* Note we will need a BYE when this all settles out
2696                                    but we can't send one while we have "INVITE" outstanding. */
2697                                 ast_set_flag(&p->flags[0], SIP_PENDINGBYE);     
2698                                 ast_clear_flag(&p->flags[0], SIP_NEEDREINVITE); 
2699                         }
2700                 }
2701         }
2702         ast_copy_flags(&p->flags[0], &locflags, SIP_NEEDDESTROY);       
2703         ast_mutex_unlock(&p->lock);
2704         return 0;
2705 }
2706
2707 /*! \brief Try setting codec suggested by the SIP_CODEC channel variable */
2708 static void try_suggested_sip_codec(struct sip_pvt *p)
2709 {
2710         int fmt;
2711         const char *codec;
2712
2713         codec = pbx_builtin_getvar_helper(p->owner, "SIP_CODEC");
2714         if (!codec) 
2715                 return;
2716
2717         fmt = ast_getformatbyname(codec);
2718         if (fmt) {
2719                 ast_log(LOG_NOTICE, "Changing codec to '%s' for this call because of ${SIP_CODEC) variable\n", codec);
2720                 if (p->jointcapability & fmt) {
2721                         p->jointcapability &= fmt;
2722                         p->capability &= fmt;
2723                 } else
2724                         ast_log(LOG_NOTICE, "Ignoring ${SIP_CODEC} variable because it is not shared by both ends.\n");
2725         } else
2726                 ast_log(LOG_NOTICE, "Ignoring ${SIP_CODEC} variable because of unrecognized/not configured codec (check allow/disallow in sip.conf): %s\n", codec);
2727         return; 
2728 }
2729
2730 /*! \brief  sip_answer: Answer SIP call , send 200 OK on Invite 
2731  * Part of PBX interface */
2732 static int sip_answer(struct ast_channel *ast)
2733 {
2734         int res = 0;
2735         struct sip_pvt *p = ast->tech_pvt;
2736
2737         ast_mutex_lock(&p->lock);
2738         if (ast->_state != AST_STATE_UP) {
2739                 try_suggested_sip_codec(p);     
2740
2741                 ast_setstate(ast, AST_STATE_UP);
2742                 if (option_debug)
2743                         ast_log(LOG_DEBUG, "SIP answering channel: %s\n", ast->name);
2744                 res = transmit_response_with_sdp(p, "200 OK", &p->initreq, XMIT_RELIABLE);
2745         }
2746         ast_mutex_unlock(&p->lock);
2747         return res;
2748 }
2749
2750 /*! \brief Send frame to media channel (rtp) */
2751 static int sip_write(struct ast_channel *ast, struct ast_frame *frame)
2752 {
2753         struct sip_pvt *p = ast->tech_pvt;
2754         int res = 0;
2755
2756         switch (frame->frametype) {
2757         case AST_FRAME_VOICE:
2758                 if (!(frame->subclass & ast->nativeformats)) {
2759                         ast_log(LOG_WARNING, "Asked to transmit frame type %d, while native formats is %d (read/write = %d/%d)\n",
2760                                 frame->subclass, ast->nativeformats, ast->readformat, ast->writeformat);
2761                         return 0;
2762                 }
2763                 if (p) {
2764                         ast_mutex_lock(&p->lock);
2765                         if (p->rtp) {
2766                                 /* If channel is not up, activate early media session */
2767                                 if ((ast->_state != AST_STATE_UP) &&
2768                                     !ast_test_flag(&p->flags[0], SIP_PROGRESS_SENT) &&
2769                                     !ast_test_flag(&p->flags[0], SIP_OUTGOING)) {
2770                                         transmit_response_with_sdp(p, "183 Session Progress", &p->initreq, XMIT_UNRELIABLE);
2771                                         ast_set_flag(&p->flags[0], SIP_PROGRESS_SENT);  
2772                                 }
2773                                 time(&p->lastrtptx);
2774                                 res =  ast_rtp_write(p->rtp, frame);
2775                         }
2776                         ast_mutex_unlock(&p->lock);
2777                 }
2778                 break;
2779         case AST_FRAME_VIDEO:
2780                 if (p) {
2781                         ast_mutex_lock(&p->lock);
2782                         if (p->vrtp) {
2783                                 /* Activate video early media */
2784                                 if ((ast->_state != AST_STATE_UP) &&
2785                                     !ast_test_flag(&p->flags[0], SIP_PROGRESS_SENT) &&
2786                                     !ast_test_flag(&p->flags[0], SIP_OUTGOING)) {
2787                                         transmit_response_with_sdp(p, "183 Session Progress", &p->initreq, XMIT_UNRELIABLE);
2788                                         ast_set_flag(&p->flags[0], SIP_PROGRESS_SENT);  
2789                                 }
2790                                 time(&p->lastrtptx);
2791                                 res =  ast_rtp_write(p->vrtp, frame);
2792                         }
2793                         ast_mutex_unlock(&p->lock);
2794                 }
2795                 break;
2796         case AST_FRAME_IMAGE:
2797                 return 0;
2798                 break;
2799         default: 
2800                 ast_log(LOG_WARNING, "Can't send %d type frames with SIP write\n", frame->frametype);
2801                 return 0;
2802         }
2803
2804         return res;
2805 }
2806
2807 /*! \brief  sip_fixup: Fix up a channel:  If a channel is consumed, this is called.
2808         Basically update any ->owner links */
2809 static int sip_fixup(struct ast_channel *oldchan, struct ast_channel *newchan)
2810 {
2811         int ret = -1;
2812         struct sip_pvt *p;
2813
2814         if (!newchan || !newchan->tech_pvt) {
2815                 ast_log(LOG_WARNING, "No SIP tech_pvt! Fixup of %s failed.\n", oldchan->name);
2816                 return -1;
2817         }
2818         p = newchan->tech_pvt;
2819
2820         ast_mutex_lock(&p->lock);
2821         if (p->owner != oldchan)
2822                 ast_log(LOG_WARNING, "old channel wasn't %p but was %p\n", oldchan, p->owner);
2823         else {
2824                 p->owner = newchan;
2825                 append_history(p, "Masq", "Old channel: %s\n", oldchan->name);
2826                 ret = 0;
2827         }
2828         ast_mutex_unlock(&p->lock);
2829         return ret;
2830 }
2831
2832 /*! \brief Send DTMF character on SIP channel
2833         within one call, we're able to transmit in many methods simultaneously */
2834 static int sip_senddigit(struct ast_channel *ast, char digit)
2835 {
2836         struct sip_pvt *p = ast->tech_pvt;
2837         int res = 0;
2838
2839         ast_mutex_lock(&p->lock);
2840         switch (ast_test_flag(&p->flags[0], SIP_DTMF)) {
2841         case SIP_DTMF_INFO:
2842                 transmit_info_with_digit(p, digit);
2843                 break;
2844         case SIP_DTMF_RFC2833:
2845                 if (p->rtp)
2846                         ast_rtp_senddigit(p->rtp, digit);
2847                 break;
2848         case SIP_DTMF_INBAND:
2849                 res = -1;
2850                 break;
2851         }
2852         ast_mutex_unlock(&p->lock);
2853         return res;
2854 }
2855
2856 /*! \brief Transfer SIP call */
2857 static int sip_transfer(struct ast_channel *ast, const char *dest)
2858 {
2859         struct sip_pvt *p = ast->tech_pvt;
2860         int res;
2861
2862         ast_mutex_lock(&p->lock);
2863         if (ast->_state == AST_STATE_RING)
2864                 res = sip_sipredirect(p, dest);
2865         else
2866                 res = transmit_refer(p, dest);
2867         ast_mutex_unlock(&p->lock);
2868         return res;
2869 }
2870
2871 /*! \brief Play indication to user 
2872  * With SIP a lot of indications is sent as messages, letting the device play
2873    the indication - busy signal, congestion etc 
2874    \return -1 to force ast_indicate to send indication in audio, 0 if SIP can handle the indication by sending a message
2875 */
2876 static int sip_indicate(struct ast_channel *ast, int condition)
2877 {
2878         struct sip_pvt *p = ast->tech_pvt;
2879         int res = 0;
2880
2881         ast_mutex_lock(&p->lock);
2882         switch(condition) {
2883         case AST_CONTROL_RINGING:
2884                 if (ast->_state == AST_STATE_RING) {
2885                         if (!ast_test_flag(&p->flags[0], SIP_PROGRESS_SENT) ||
2886                             (ast_test_flag(&p->flags[0], SIP_PROG_INBAND) == SIP_PROG_INBAND_NEVER)) {                          
2887                                 /* Send 180 ringing if out-of-band seems reasonable */
2888                                 transmit_response(p, "180 Ringing", &p->initreq);
2889                                 ast_set_flag(&p->flags[0], SIP_RINGING);
2890                                 if (ast_test_flag(&p->flags[0], SIP_PROG_INBAND) != SIP_PROG_INBAND_YES)
2891                                         break;
2892                         } else {
2893                                 /* Well, if it's not reasonable, just send in-band */
2894                         }
2895                 }
2896                 res = -1;
2897                 break;
2898         case AST_CONTROL_BUSY:
2899                 if (ast->_state != AST_STATE_UP) {
2900                         transmit_response(p, "486 Busy Here", &p->initreq);
2901                         ast_set_flag(&p->flags[0], SIP_ALREADYGONE);    
2902                         ast_softhangup_nolock(ast, AST_SOFTHANGUP_DEV);
2903                         break;
2904                 }
2905                 res = -1;
2906                 break;
2907         case AST_CONTROL_CONGESTION:
2908                 if (ast->_state != AST_STATE_UP) {
2909                         transmit_response(p, "503 Service Unavailable", &p->initreq);
2910                         ast_set_flag(&p->flags[0], SIP_ALREADYGONE);    
2911                         ast_softhangup_nolock(ast, AST_SOFTHANGUP_DEV);
2912                         break;
2913                 }
2914                 res = -1;
2915                 break;
2916         case AST_CONTROL_PROCEEDING:
2917                 if ((ast->_state != AST_STATE_UP) &&
2918                     !ast_test_flag(&p->flags[0], SIP_PROGRESS_SENT) &&
2919                     !ast_test_flag(&p->flags[0], SIP_OUTGOING)) {
2920                         transmit_response(p, "100 Trying", &p->initreq);
2921                         break;
2922                 }
2923                 res = -1;
2924                 break;
2925         case AST_CONTROL_PROGRESS:
2926                 if ((ast->_state != AST_STATE_UP) &&
2927                     !ast_test_flag(&p->flags[0], SIP_PROGRESS_SENT) &&
2928                     !ast_test_flag(&p->flags[0], SIP_OUTGOING)) {
2929                         transmit_response_with_sdp(p, "183 Session Progress", &p->initreq, XMIT_UNRELIABLE);
2930                         ast_set_flag(&p->flags[0], SIP_PROGRESS_SENT);  
2931                         break;
2932                 }
2933                 res = -1;
2934                 break;
2935         case AST_CONTROL_HOLD:  /* The other part of the bridge are put on hold */
2936                 if (sipdebug)
2937                         ast_log(LOG_DEBUG, "Bridged channel now on hold - %s\n", p->callid);
2938                 res = -1;
2939                 break;
2940         case AST_CONTROL_UNHOLD:        /* The other part of the bridge are back from hold */
2941                 if (sipdebug)
2942                         ast_log(LOG_DEBUG, "Bridged channel is back from hold, let's talk! : %s\n", p->callid);
2943                 res = -1;
2944                 break;
2945         case AST_CONTROL_VIDUPDATE:     /* Request a video frame update */
2946                 if (p->vrtp && !ast_test_flag(&p->flags[0], SIP_NOVIDEO)) {
2947                         transmit_info_with_vidupdate(p);
2948                         /* ast_rtcp_send_h261fur(p->vrtp); */
2949                         res = 0;
2950                 } else
2951                         res = -1;
2952                 break;
2953         case -1:
2954                 res = -1;
2955                 break;
2956         default:
2957                 ast_log(LOG_WARNING, "Don't know how to indicate condition %d\n", condition);
2958                 res = -1;
2959                 break;
2960         }
2961         ast_mutex_unlock(&p->lock);
2962         return res;
2963 }
2964
2965
2966
2967 /*! \brief Initiate a call in the SIP channel
2968         called from sip_request_call (calls from the pbx ) */
2969 static struct ast_channel *sip_new(struct sip_pvt *i, int state, const char *title)
2970 {
2971         struct ast_channel *tmp;
2972         struct ast_variable *v = NULL;
2973         int fmt;
2974         int what;
2975         
2976         ast_mutex_unlock(&i->lock);
2977         /* Don't hold a sip pvt lock while we allocate a channel */
2978         tmp = ast_channel_alloc(1);
2979         ast_mutex_lock(&i->lock);
2980         if (!tmp) {
2981                 ast_log(LOG_WARNING, "Unable to allocate SIP channel structure\n");
2982                 return NULL;
2983         }
2984         tmp->tech = &sip_tech;
2985         /* Select our native format based on codec preference until we receive
2986            something from another device to the contrary. */
2987         if (i->jointcapability)
2988                 what = i->jointcapability;
2989         else if (i->capability)
2990                 what = i->capability;
2991         else
2992                 what = global_capability;
2993         tmp->nativeformats = ast_codec_choose(&i->prefs, what, 1) | (i->jointcapability & AST_FORMAT_VIDEO_MASK);
2994         fmt = ast_best_codec(tmp->nativeformats);
2995
2996         if (title)
2997                 ast_string_field_build(tmp, name, "SIP/%s-%04lx", title, ast_random() & 0xffff);
2998         else if (strchr(i->fromdomain,':'))
2999                 ast_string_field_build(tmp, name, "SIP/%s-%08x", strchr(i->fromdomain,':')+1, (int)(long)(i));
3000         else
3001                 ast_string_field_build(tmp, name, "SIP/%s-%08x", i->fromdomain, (int)(long)(i));
3002
3003         if (ast_test_flag(&i->flags[0], SIP_DTMF) ==  SIP_DTMF_INBAND) {
3004                 i->vad = ast_dsp_new();
3005                 ast_dsp_set_features(i->vad, DSP_FEATURE_DTMF_DETECT);
3006                 if (global_relaxdtmf)
3007                         ast_dsp_digitmode(i->vad, DSP_DIGITMODE_DTMF | DSP_DIGITMODE_RELAXDTMF);
3008         }
3009         if (i->rtp) {
3010                 tmp->fds[0] = ast_rtp_fd(i->rtp);
3011                 tmp->fds[1] = ast_rtcp_fd(i->rtp);
3012         }
3013         if (i->vrtp) {
3014                 tmp->fds[2] = ast_rtp_fd(i->vrtp);
3015                 tmp->fds[3] = ast_rtcp_fd(i->vrtp);
3016         }
3017         if (state == AST_STATE_RING)
3018                 tmp->rings = 1;
3019         tmp->adsicpe = AST_ADSI_UNAVAILABLE;
3020         tmp->writeformat = fmt;
3021         tmp->rawwriteformat = fmt;
3022         tmp->readformat = fmt;
3023         tmp->rawreadformat = fmt;
3024         tmp->tech_pvt = i;
3025
3026         tmp->callgroup = i->callgroup;
3027         tmp->pickupgroup = i->