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