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