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