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