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