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