Removing registrar_expire from basic-pbx config
[asterisk/asterisk.git] / res / res_pjsip_diversion.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * Kevin Harwell <kharwell@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 /*** MODULEINFO
20         <depend>pjproject</depend>
21         <depend>res_pjsip</depend>
22         <support_level>core</support_level>
23  ***/
24
25 #include "asterisk.h"
26
27 #include <pjsip.h>
28 #include <pjsip_ua.h>
29
30 #include "asterisk/res_pjsip.h"
31 #include "asterisk/res_pjsip_session.h"
32 #include "asterisk/callerid.h"
33 #include "asterisk/channel.h"
34 #include "asterisk/module.h"
35 #include "asterisk/strings.h"
36
37 static const pj_str_t diversion_name = { "Diversion", 9 };
38
39 /*!
40  * \internal
41  * \brief Determine if the given string is a SIP token.
42  * \since 13.8.0
43  *
44  * \param str String to determine if is a SIP token.
45  *
46  * \note A token is defined by RFC3261 Section 25.1
47  *
48  * \return Non-zero if the string is a SIP token.
49  */
50 static int sip_is_token(const char *str)
51 {
52         int is_token;
53
54         if (ast_strlen_zero(str)) {
55                 /* An empty string is not a token. */
56                 return 0;
57         }
58
59         is_token = 1;
60         do {
61                 if (!isalnum(*str)
62                         && !strchr("-.!%*_+`'~", *str)) {
63                         /* The character is not allowed in a token. */
64                         is_token = 0;
65                         break;
66                 }
67         } while (*++str);
68
69         return is_token;
70 }
71
72 /*! \brief Diversion header reasons
73  *
74  * The core defines a bunch of constants used to define
75  * redirecting reasons. This provides a translation table
76  * between those and the strings which may be present in
77  * a SIP Diversion header
78  */
79 static const struct reasons {
80         enum AST_REDIRECTING_REASON code;
81         const char *text;
82 } reason_table[] = {
83         { AST_REDIRECTING_REASON_UNKNOWN, "unknown" },
84         { AST_REDIRECTING_REASON_USER_BUSY, "user-busy" },
85         { AST_REDIRECTING_REASON_NO_ANSWER, "no-answer" },
86         { AST_REDIRECTING_REASON_UNAVAILABLE, "unavailable" },
87         { AST_REDIRECTING_REASON_UNCONDITIONAL, "unconditional" },
88         { AST_REDIRECTING_REASON_TIME_OF_DAY, "time-of-day" },
89         { AST_REDIRECTING_REASON_DO_NOT_DISTURB, "do-not-disturb" },
90         { AST_REDIRECTING_REASON_DEFLECTION, "deflection" },
91         { AST_REDIRECTING_REASON_FOLLOW_ME, "follow-me" },
92         { AST_REDIRECTING_REASON_OUT_OF_ORDER, "out-of-service" },
93         { AST_REDIRECTING_REASON_AWAY, "away" },
94         { AST_REDIRECTING_REASON_CALL_FWD_DTE, "cf_dte" },              /* Non-standard */
95         { AST_REDIRECTING_REASON_SEND_TO_VM, "send_to_vm" },    /* Non-standard */
96 };
97
98 static const char *reason_code_to_str(const struct ast_party_redirecting_reason *reason)
99 {
100         int idx;
101         int code;
102
103         /* use specific string if given */
104         if (!ast_strlen_zero(reason->str)) {
105                 return reason->str;
106         }
107
108         code = reason->code;
109         for (idx = 0; idx < ARRAY_LEN(reason_table); ++idx) {
110                 if (code == reason_table[idx].code) {
111                         return reason_table[idx].text;
112                 }
113         }
114
115         return "unknown";
116 }
117
118 static pjsip_fromto_hdr *get_diversion_header(pjsip_rx_data *rdata)
119 {
120         static const pj_str_t from_name = { "From", 4 };
121
122         pjsip_generic_string_hdr *hdr;
123         pj_str_t value;
124         int size;
125
126         if (!(hdr = pjsip_msg_find_hdr_by_name(rdata->msg_info.msg, &diversion_name, NULL))) {
127                 return NULL;
128         }
129
130         pj_strdup_with_null(rdata->tp_info.pool, &value, &hdr->hvalue);
131
132         /* parse as a fromto header */
133         return pjsip_parse_hdr(rdata->tp_info.pool, &from_name, value.ptr,
134                                pj_strlen(&value), &size);
135 }
136
137 static void set_redirecting_value(char **dst, const pj_str_t *src)
138 {
139         ast_free(*dst);
140         *dst = ast_malloc(pj_strlen(src) + 1);
141         if (*dst) {
142                 ast_copy_pj_str(*dst, src, pj_strlen(src) + 1);
143         }
144 }
145
146 static void set_redirecting_id(pjsip_name_addr *name_addr, struct ast_party_id *data,
147                                struct ast_set_party_id *update)
148 {
149         pjsip_sip_uri *uri = pjsip_uri_get_uri(name_addr->uri);
150         char *semi;
151         pj_str_t uri_user;
152
153         uri_user = uri->user;
154
155         /* Always truncate redirecting number at a semicolon. */
156         semi = pj_strchr(&uri_user, ';');
157         if (semi) {
158                 /*
159                  * We need to be able to handle URI's looking like
160                  * "sip:1235557890;phone-context=national@x.x.x.x;user=phone"
161                  *
162                  * Where the uri->user field will result in:
163                  * "1235557890;phone-context=national"
164                  *
165                  * People don't care about anything after the semicolon
166                  * showing up on their displays even though the RFC
167                  * allows the semicolon.
168                  */
169                 pj_strset(&uri_user, (char *) pj_strbuf(&uri_user), semi - pj_strbuf(&uri_user));
170         }
171
172         if (pj_strlen(&uri_user)) {
173                 update->number = 1;
174                 data->number.valid = 1;
175                 set_redirecting_value(&data->number.str, &uri_user);
176         }
177
178         if (pj_strlen(&name_addr->display)) {
179                 update->name = 1;
180                 data->name.valid = 1;
181                 set_redirecting_value(&data->name.str, &name_addr->display);
182         }
183 }
184
185 static void copy_redirecting_id(struct ast_party_id *dst, const struct ast_party_id *src,
186                                 struct ast_set_party_id *update)
187 {
188         ast_party_id_copy(dst, src);
189
190         if (dst->number.valid) {
191                 update->number = 1;
192         }
193
194         if (dst->name.valid) {
195                 update->name = 1;
196         }
197 }
198
199 static void set_redirecting_reason(pjsip_fromto_hdr *hdr,
200                                    struct ast_party_redirecting_reason *data)
201 {
202         static const pj_str_t reason_name = { "reason", 6 };
203         pjsip_param *reason = pjsip_param_find(&hdr->other_param, &reason_name);
204         char *reason_str;
205
206         if (!reason) {
207                 return;
208         }
209
210         set_redirecting_value(&data->str, &reason->value);
211         if (!data->str) {
212                 /* Oops, allocation failure */
213                 return;
214         }
215         reason_str = ast_strdupa(data->str);
216
217         /* Remove any enclosing double-quotes */
218         if (*reason_str == '"') {
219                 reason_str = ast_strip_quoted(reason_str, "\"", "\"");
220         }
221
222         data->code = ast_redirecting_reason_parse(reason_str);
223         if (data->code < 0) {
224                 data->code = AST_REDIRECTING_REASON_UNKNOWN;
225         } else {
226                 ast_free(data->str);
227                 data->str = ast_strdup("");
228         }
229 }
230
231 static void set_redirecting(struct ast_sip_session *session,
232                             pjsip_fromto_hdr *from_info,
233                             pjsip_name_addr *to_info)
234 {
235         struct ast_party_redirecting data;
236         struct ast_set_party_redirecting update;
237
238         if (!session->channel) {
239                 return;
240         }
241
242         ast_party_redirecting_init(&data);
243         memset(&update, 0, sizeof(update));
244
245         if (from_info) {
246                 set_redirecting_id((pjsip_name_addr*)from_info->uri,
247                         &data.from, &update.from);
248                 set_redirecting_reason(from_info, &data.reason);
249         } else {
250                 copy_redirecting_id(&data.from, &session->id, &update.from);
251         }
252
253         set_redirecting_id(to_info, &data.to, &update.to);
254
255         ast_set_party_id_all(&update.priv_orig);
256         ast_set_party_id_all(&update.priv_from);
257         ast_set_party_id_all(&update.priv_to);
258         ++data.count;
259
260         ast_channel_set_redirecting(session->channel, &data, &update);
261         ast_party_redirecting_free(&data);
262 }
263
264 static int diversion_incoming_request(struct ast_sip_session *session, pjsip_rx_data *rdata)
265 {
266         pjsip_fromto_hdr *hdr = get_diversion_header(rdata);
267
268         if (hdr) {
269                 set_redirecting(session, hdr, (pjsip_name_addr*)
270                                 PJSIP_MSG_TO_HDR(rdata->msg_info.msg)->uri);
271         }
272
273         return 0;
274 }
275
276 static void diversion_incoming_response(struct ast_sip_session *session, pjsip_rx_data *rdata)
277 {
278         static const pj_str_t contact_name = { "Contact", 7 };
279         static const pj_str_t contact_name_s = { "m", 1 };
280
281         pjsip_status_line status = rdata->msg_info.msg->line.status;
282         pjsip_fromto_hdr *div_hdr;
283         pjsip_contact_hdr *contact_hdr;
284
285         if ((status.code != 302) && (status.code != 181)) {
286                 return;
287         }
288
289         /* use the diversion header info if there is one. if not one then use the
290            session caller id info. if that doesn't exist use info from the To hdr*/
291         if (!(div_hdr = get_diversion_header(rdata)) && !session->id.number.valid) {
292                 div_hdr = PJSIP_MSG_TO_HDR(rdata->msg_info.msg);
293         }
294
295         contact_hdr = pjsip_msg_find_hdr_by_names(rdata->msg_info.msg, &contact_name, &contact_name_s, NULL);
296
297         set_redirecting(session, div_hdr, contact_hdr ? (pjsip_name_addr*)contact_hdr->uri :
298                         (pjsip_name_addr*)PJSIP_MSG_FROM_HDR(rdata->msg_info.msg)->uri);
299 }
300
301 /*!
302  * \internal
303  * \brief Adds diversion header information to an outbound SIP message
304  *
305  * \param tdata The outbound message
306  * \param data The redirecting data used to fill parts of the diversion header
307  */
308 static void add_diversion_header(pjsip_tx_data *tdata, struct ast_party_redirecting *data)
309 {
310         pjsip_fromto_hdr *hdr;
311         pjsip_name_addr *name_addr;
312         pjsip_sip_uri *uri;
313         pjsip_param *param;
314         pjsip_fromto_hdr *old_hdr;
315         const char *reason_str;
316         const char *quote_str;
317         char *reason_buf;
318
319         struct ast_party_id *id = &data->from;
320         pjsip_uri *base = PJSIP_MSG_FROM_HDR(tdata->msg)->uri;
321
322         if (!id->number.valid || ast_strlen_zero(id->number.str)) {
323                 return;
324         }
325
326         hdr = pjsip_from_hdr_create(tdata->pool);
327         hdr->type = PJSIP_H_OTHER;
328         pj_strdup(tdata->pool, &hdr->name, &diversion_name);
329         hdr->sname = hdr->name;
330
331         name_addr = pjsip_uri_clone(tdata->pool, base);
332         uri = pjsip_uri_get_uri(name_addr->uri);
333
334         pj_strdup2(tdata->pool, &name_addr->display, id->name.str);
335         pj_strdup2(tdata->pool, &uri->user, id->number.str);
336
337         param = PJ_POOL_ALLOC_T(tdata->pool, pjsip_param);
338         param->name = pj_str("reason");
339
340         reason_str = reason_code_to_str(&data->reason);
341
342         /* Reason is either already quoted or it is a token to not need quotes added. */
343         quote_str = *reason_str == '\"' || sip_is_token(reason_str) ? "" : "\"";
344
345         reason_buf = pj_pool_alloc(tdata->pool, strlen(reason_str) + 3);
346         sprintf(reason_buf, "%s%s%s", quote_str, reason_str, quote_str);/* Safe */
347
348         param->value = pj_str(reason_buf);
349
350         pj_list_insert_before(&hdr->other_param, param);
351
352         hdr->uri = (pjsip_uri *) name_addr;
353         old_hdr = pjsip_msg_find_hdr_by_name(tdata->msg, &diversion_name, NULL);
354         if (old_hdr) {
355                 pj_list_erase(old_hdr);
356         }
357         pjsip_msg_add_hdr(tdata->msg, (pjsip_hdr *)hdr);
358 }
359
360 static void get_redirecting_add_diversion(struct ast_sip_session *session, pjsip_tx_data *tdata)
361 {
362         struct ast_party_redirecting *data;
363
364         if (session->channel && session->endpoint->id.send_diversion &&
365             (data = ast_channel_redirecting(session->channel))->count) {
366                 add_diversion_header(tdata, data);
367         }
368 }
369
370 /*!
371  * \internal
372  * \brief Adds a diversion header to an outgoing INVITE request if
373  *  redirecting information is available.
374  *
375  * \param session The session on which the INVITE request is to be sent
376  * \param tdata The outbound INVITE request
377  */
378 static void diversion_outgoing_request(struct ast_sip_session *session, pjsip_tx_data *tdata)
379 {
380         get_redirecting_add_diversion(session, tdata);
381 }
382
383 /*!
384  * \internal
385  * \brief Adds a diversion header to an outgoing 3XX response
386  *
387  * \param session The session on which the INVITE response is to be sent
388  * \param tdata The outbound INVITE response
389  */
390 static void diversion_outgoing_response(struct ast_sip_session *session, pjsip_tx_data *tdata)
391 {
392         struct pjsip_status_line status = tdata->msg->line.status;
393
394         /* add to 302 and 181 */
395         if (PJSIP_IS_STATUS_IN_CLASS(status.code, 300) || (status.code == 181)) {
396                 get_redirecting_add_diversion(session, tdata);
397         }
398 }
399
400 static struct ast_sip_session_supplement diversion_supplement = {
401         .method = "INVITE",
402         /* this supplement needs to be called after caller id
403            and after the channel has been created */
404         .priority = AST_SIP_SUPPLEMENT_PRIORITY_CHANNEL + 100,
405         .incoming_request = diversion_incoming_request,
406         .incoming_response = diversion_incoming_response,
407         .outgoing_request = diversion_outgoing_request,
408         .outgoing_response = diversion_outgoing_response,
409         .response_priority = AST_SIP_SESSION_BEFORE_REDIRECTING,
410 };
411
412 static int load_module(void)
413 {
414         ast_sip_session_register_supplement(&diversion_supplement);
415         return AST_MODULE_LOAD_SUCCESS;
416 }
417
418 static int unload_module(void)
419 {
420         ast_sip_session_unregister_supplement(&diversion_supplement);
421         return 0;
422 }
423
424 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "PJSIP Add Diversion Header Support",
425         .support_level = AST_MODULE_SUPPORT_CORE,
426         .load = load_module,
427         .unload = unload_module,
428         .load_pri = AST_MODPRI_APP_DEPEND,
429         .requires = "res_pjsip,res_pjsip_session",
430 );