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