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