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