build: Update config.guess and config.sub
[asterisk/asterisk.git] / res / res_pjsip_caller_id.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * Mark Michelson <mmichelson@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/channel.h"
33 #include "asterisk/module.h"
34 #include "asterisk/callerid.h"
35
36 /*!
37  * \internal
38  * \brief Set an ast_party_id name and number based on an identity header.
39  * \param hdr From, P-Asserted-Identity, or Remote-Party-ID header on incoming message
40  * \param[out] id The ID to set data on
41  */
42 static void set_id_from_hdr(pjsip_fromto_hdr *hdr, struct ast_party_id *id)
43 {
44         char cid_name[AST_CHANNEL_NAME];
45         char cid_num[AST_CHANNEL_NAME];
46         pjsip_sip_uri *uri;
47         pjsip_name_addr *id_name_addr = (pjsip_name_addr *) hdr->uri;
48         char *semi;
49
50         uri = pjsip_uri_get_uri(id_name_addr);
51         ast_copy_pj_str(cid_name, &id_name_addr->display, sizeof(cid_name));
52         ast_copy_pj_str(cid_num, &uri->user, sizeof(cid_num));
53
54         /* Always truncate caller-id number at a semicolon. */
55         semi = strchr(cid_num, ';');
56         if (semi) {
57                 /*
58                  * We need to be able to handle URI's looking like
59                  * "sip:1235557890;phone-context=national@x.x.x.x;user=phone"
60                  *
61                  * Where the uri->user field will result in:
62                  * "1235557890;phone-context=national"
63                  *
64                  * People don't care about anything after the semicolon
65                  * showing up on their displays even though the RFC
66                  * allows the semicolon.
67                  */
68                 *semi = '\0';
69         }
70
71         ast_free(id->name.str);
72         id->name.str = ast_strdup(cid_name);
73         if (!ast_strlen_zero(cid_name)) {
74                 id->name.valid = 1;
75         }
76         ast_free(id->number.str);
77         id->number.str = ast_strdup(cid_num);
78         if (!ast_strlen_zero(cid_num)) {
79                 id->number.valid = 1;
80         }
81 }
82
83 /*!
84  * \internal
85  * \brief Get a P-Asserted-Identity or Remote-Party-ID header from an incoming message
86  *
87  * This function will parse the header as if it were a From header. This allows for us
88  * to easily manipulate the URI, as well as add, modify, or remove parameters from the
89  * header
90  *
91  * \param rdata The incoming message
92  * \param header_name The name of the ID header to find
93  * \retval NULL No ID header present or unable to parse ID header
94  * \retval non-NULL The parsed ID header
95  */
96 static pjsip_fromto_hdr *get_id_header(pjsip_rx_data *rdata, const pj_str_t *header_name)
97 {
98         static const pj_str_t from = { "From", 4 };
99         pj_str_t header_content;
100         pjsip_fromto_hdr *parsed_hdr;
101         pjsip_generic_string_hdr *ident = pjsip_msg_find_hdr_by_name(rdata->msg_info.msg,
102                         header_name, NULL);
103         int parsed_len;
104
105         if (!ident) {
106                 return NULL;
107         }
108
109         pj_strdup_with_null(rdata->tp_info.pool, &header_content, &ident->hvalue);
110
111         parsed_hdr = pjsip_parse_hdr(rdata->tp_info.pool, &from, header_content.ptr,
112                         pj_strlen(&header_content), &parsed_len);
113
114         if (!parsed_hdr) {
115                 return NULL;
116         }
117
118         return parsed_hdr;
119 }
120
121 /*!
122  * \internal
123  * \brief Set an ast_party_id structure based on data in a P-Asserted-Identity header
124  *
125  * This makes use of \ref set_id_from_hdr for setting name and number. It uses
126  * the contents of a Privacy header in order to set presentation information.
127  *
128  * \param rdata The incoming message
129  * \param[out] id The ID to set
130  * \retval 0 Successfully set the party ID
131  * \retval non-zero Could not set the party ID
132  */
133 static int set_id_from_pai(pjsip_rx_data *rdata, struct ast_party_id *id)
134 {
135         static const pj_str_t pai_str = { "P-Asserted-Identity", 19 };
136         static const pj_str_t privacy_str = { "Privacy", 7 };
137         pjsip_fromto_hdr *pai_hdr = get_id_header(rdata, &pai_str);
138         pjsip_generic_string_hdr *privacy;
139
140         if (!pai_hdr) {
141                 return -1;
142         }
143
144         set_id_from_hdr(pai_hdr, id);
145
146         if (!id->number.valid) {
147                 return -1;
148         }
149
150         privacy = pjsip_msg_find_hdr_by_name(rdata->msg_info.msg, &privacy_str, NULL);
151         if (!privacy || !pj_stricmp2(&privacy->hvalue, "none")) {
152                 id->number.presentation = AST_PRES_ALLOWED_USER_NUMBER_NOT_SCREENED;
153                 id->name.presentation = AST_PRES_ALLOWED_USER_NUMBER_NOT_SCREENED;
154         } else {
155                 id->number.presentation = AST_PRES_PROHIB_USER_NUMBER_NOT_SCREENED;
156                 id->name.presentation = AST_PRES_PROHIB_USER_NUMBER_NOT_SCREENED;
157         }
158
159         return 0;
160 }
161
162 /*!
163  * \internal
164  * \brief Set an ast_party_id structure based on data in a Remote-Party-ID header
165  *
166  * This makes use of \ref set_id_from_hdr for setting name and number. It uses
167  * the privacy and screen parameters in order to set presentation information.
168  *
169  * \param rdata The incoming message
170  * \param[out] id The ID to set
171  * \retval 0 Succesfully set the party ID
172  * \retval non-zero Could not set the party ID
173  */
174 static int set_id_from_rpid(pjsip_rx_data *rdata, struct ast_party_id *id)
175 {
176         static const pj_str_t rpid_str = { "Remote-Party-ID", 15 };
177         static const pj_str_t privacy_str = { "privacy", 7 };
178         static const pj_str_t screen_str = { "screen", 6 };
179         pjsip_fromto_hdr *rpid_hdr = get_id_header(rdata, &rpid_str);
180         pjsip_param *screen;
181         pjsip_param *privacy;
182
183         if (!rpid_hdr) {
184                 return -1;
185         }
186
187         set_id_from_hdr(rpid_hdr, id);
188
189         if (!id->number.valid) {
190                 return -1;
191         }
192
193         privacy = pjsip_param_find(&rpid_hdr->other_param, &privacy_str);
194         screen = pjsip_param_find(&rpid_hdr->other_param, &screen_str);
195         if (privacy && !pj_stricmp2(&privacy->value, "full")) {
196                 id->number.presentation = AST_PRES_RESTRICTED;
197                 id->name.presentation = AST_PRES_RESTRICTED;
198         } else {
199                 id->number.presentation = AST_PRES_ALLOWED;
200                 id->name.presentation = AST_PRES_ALLOWED;
201         }
202         if (screen && !pj_stricmp2(&screen->value, "yes")) {
203                 id->number.presentation |= AST_PRES_USER_NUMBER_PASSED_SCREEN;
204                 id->name.presentation |= AST_PRES_USER_NUMBER_PASSED_SCREEN;
205         } else {
206                 id->number.presentation |= AST_PRES_USER_NUMBER_UNSCREENED;
207                 id->name.presentation |= AST_PRES_USER_NUMBER_UNSCREENED;
208         }
209
210         return 0;
211 }
212
213 /*!
214  * \internal
215  * \brief Set an ast_party_id structure based on data in a From
216  *
217  * This makes use of \ref set_id_from_hdr for setting name and number. It uses
218  * no information from the message in order to set privacy. It relies on endpoint
219  * configuration for privacy information.
220  *
221  * \param rdata The incoming message
222  * \param[out] id The ID to set
223  * \retval 0 Succesfully set the party ID
224  * \retval non-zero Could not set the party ID
225  */
226 static int set_id_from_from(struct pjsip_rx_data *rdata, struct ast_party_id *id)
227 {
228         pjsip_fromto_hdr *from = pjsip_msg_find_hdr(rdata->msg_info.msg,
229                         PJSIP_H_FROM, rdata->msg_info.msg->hdr.next);
230
231         if (!from) {
232                 /* This had better not happen */
233                 return -1;
234         }
235
236         set_id_from_hdr(from, id);
237
238         if (!id->number.valid) {
239                 return -1;
240         }
241
242         return 0;
243 }
244
245 /*!
246  * \internal
247  * \brief Determine if a connected line update should be queued
248  *
249  * This uses information about the session and the ID that would be queued
250  * in the connected line update in order to determine if we should queue
251  * a connected line update.
252  *
253  * \param session The session whose channel we wish to queue the connected line update on
254  * \param id The identification information that would be queued on the connected line update
255  * \retval 0 We should not queue a connected line update
256  * \retval non-zero We should queue a connected line update
257  */
258 static int should_queue_connected_line_update(const struct ast_sip_session *session, const struct ast_party_id *id)
259 {
260         /* Invalid number means no update */
261         if (!id->number.valid) {
262                 return 0;
263         }
264
265         /* If the session has never communicated an update or if the
266          * new ID has a different number than the session, then we
267          * should queue an update
268          */
269         if (ast_strlen_zero(session->id.number.str) ||
270                         strcmp(session->id.number.str, id->number.str)) {
271                 return 1;
272         }
273
274         /* By making it to this point, it means the number is not enough
275          * to determine if an update should be sent. Now we look at
276          * the name
277          */
278
279         /* If the number couldn't warrant an update and the name is
280          * invalid, then no update
281          */
282         if (!id->name.valid) {
283                 return 0;
284         }
285
286         /* If the name has changed or we don't have a name set for the
287          * session, then we should send an update
288          */
289         if (ast_strlen_zero(session->id.name.str) ||
290                         strcmp(session->id.name.str, id->name.str)) {
291                 return 1;
292         }
293
294         /* Neither the name nor the number have changed. No update */
295         return 0;
296 }
297
298 /*!
299  * \internal
300  * \brief Queue a connected line update on a session's channel.
301  * \param session The session whose channel should have the connected line update queued upon.
302  * \param id The identification information to place in the connected line update
303  */
304 static void queue_connected_line_update(struct ast_sip_session *session, const struct ast_party_id *id)
305 {
306         struct ast_party_connected_line connected;
307         struct ast_party_caller caller;
308
309         /* Fill connected line information */
310         ast_party_connected_line_init(&connected);
311         connected.id = *id;
312         connected.id.tag = session->endpoint->id.self.tag;
313         connected.source = AST_CONNECTED_LINE_UPDATE_SOURCE_ANSWER;
314
315         /* Save to channel driver copy */
316         ast_party_id_copy(&session->id, &connected.id);
317
318         /* Update our channel CALLERID() */
319         ast_party_caller_init(&caller);
320         caller.id = connected.id;
321         caller.ani = connected.id;
322         caller.ani2 = ast_channel_caller(session->channel)->ani2;
323         ast_channel_set_caller_event(session->channel, &caller, NULL);
324
325         /* Tell peer about the new connected line information. */
326         ast_channel_queue_connected_line_update(session->channel, &connected, NULL);
327 }
328
329 /*!
330  * \internal
331  * \brief Make updates to connected line information based on an incoming request.
332  *
333  * This will get identity information from an incoming request. Once the identification is
334  * retrieved, we will check if the new information warrants a connected line update and queue
335  * a connected line update if so.
336  *
337  * \param session The session on which we received an incoming request
338  * \param rdata The incoming request
339  */
340 static void update_incoming_connected_line(struct ast_sip_session *session, pjsip_rx_data *rdata)
341 {
342         struct ast_party_id id;
343
344         if (!session->endpoint->id.trust_connected_line
345                 || !session->endpoint->id.trust_inbound) {
346                 return;
347         }
348
349         ast_party_id_init(&id);
350         if (!set_id_from_pai(rdata, &id) || !set_id_from_rpid(rdata, &id)) {
351                 if (should_queue_connected_line_update(session, &id)) {
352                         queue_connected_line_update(session, &id);
353                 }
354         }
355         ast_party_id_free(&id);
356 }
357
358 /*!
359  * \internal
360  * \brief Session supplement callback on an incoming INVITE request
361  *
362  * If we are receiving an initial INVITE, then we will set the session's identity
363  * based on the INVITE or configured endpoint values. If we are receiving a reinvite,
364  * then we will potentially queue a connected line update via the \ref update_incoming_connected_line
365  * function
366  *
367  * \param session The session that has received an INVITE
368  * \param rdata The incoming INVITE
369  */
370 static int caller_id_incoming_request(struct ast_sip_session *session, pjsip_rx_data *rdata)
371 {
372         if (!session->channel) {
373                 /*
374                  * Since we have no channel this must be the initial inbound
375                  * INVITE.  Set the session ID directly because the channel
376                  * has not been created yet.
377                  */
378                 if (session->endpoint->id.trust_inbound
379                         && (!set_id_from_pai(rdata, &session->id)
380                                 || !set_id_from_rpid(rdata, &session->id))) {
381                         ast_free(session->id.tag);
382                         session->id.tag = ast_strdup(session->endpoint->id.self.tag);
383                         return 0;
384                 }
385                 ast_party_id_copy(&session->id, &session->endpoint->id.self);
386                 if (!session->endpoint->id.self.number.valid) {
387                         set_id_from_from(rdata, &session->id);
388                 }
389         } else {
390                 /*
391                  * ReINVITE or UPDATE.  Check for changes to the ID and queue
392                  * a connected line update if necessary.
393                  */
394                 update_incoming_connected_line(session, rdata);
395         }
396         return 0;
397 }
398
399 /*!
400  * \internal
401  * \brief Session supplement callback on INVITE response
402  *
403  * INVITE responses could result in queuing connected line updates.
404  *
405  * \param session The session on which communication is happening
406  * \param rdata The incoming INVITE response
407  */
408 static void caller_id_incoming_response(struct ast_sip_session *session, pjsip_rx_data *rdata)
409 {
410         if (!session->channel) {
411                 return;
412         }
413
414         update_incoming_connected_line(session, rdata);
415 }
416
417 /*!
418  * \internal
419  * \brief Create an identity header for an outgoing message
420  * \param hdr_name The name of the header to create
421  * \param tdata The message to place the header on
422  * \param id The identification information for the new header
423  * \return newly-created header
424  */
425 static pjsip_fromto_hdr *create_new_id_hdr(const pj_str_t *hdr_name, pjsip_fromto_hdr *base, pjsip_tx_data *tdata, const struct ast_party_id *id)
426 {
427         pjsip_fromto_hdr *id_hdr;
428         pjsip_name_addr *id_name_addr;
429         pjsip_sip_uri *id_uri;
430
431         id_hdr = pjsip_from_hdr_create(tdata->pool);
432         id_hdr->type = PJSIP_H_OTHER;
433         id_hdr->sname = id_hdr->name = *hdr_name;
434
435         id_name_addr = pjsip_uri_clone(tdata->pool, base->uri);
436         id_uri = pjsip_uri_get_uri(id_name_addr->uri);
437
438         if (id->name.valid && !ast_strlen_zero(id->name.str)) {
439                 int name_buf_len = strlen(id->name.str) * 2 + 1;
440                 char *name_buf = ast_alloca(name_buf_len);
441
442                 ast_escape_quoted(id->name.str, name_buf, name_buf_len);
443                 pj_strdup2(tdata->pool, &id_name_addr->display, name_buf);
444         } else {
445                 /*
446                  * We need to clear the remnants of the clone or it'll be left set.
447                  * pj_strdup2 is safe to call with a NULL src and it resets both slen and ptr.
448                  */
449                 pj_strdup2(tdata->pool, &id_name_addr->display, NULL);
450         }
451
452         if (id->number.valid) {
453                 pj_strdup2(tdata->pool, &id_uri->user, id->number.str);
454         } else {
455                 /* Similar to name, make sure the number is also cleared when invalid */
456                 pj_strdup2(tdata->pool, &id_uri->user, NULL);
457         }
458
459         id_hdr->uri = (pjsip_uri *) id_name_addr;
460         return id_hdr;
461 }
462
463 /*!
464  * \internal
465  * \brief Add a Privacy header to an outbound message
466  *
467  * When sending a P-Asserted-Identity header, if privacy is requested, then we
468  * will need to indicate such by adding a Privacy header. Similarly, if no
469  * privacy is requested, and a Privacy header already exists on the message,
470  * then the old Privacy header should be removed.
471  *
472  * \param tdata The outbound message to add the Privacy header to
473  * \param id The id information used to determine privacy
474  */
475 static void add_privacy_header(pjsip_tx_data *tdata, const struct ast_party_id *id)
476 {
477         static const pj_str_t pj_privacy_name = { "Privacy", 7 };
478         static const pj_str_t pj_privacy_value = { "id", 2 };
479         pjsip_hdr *old_privacy;
480
481         old_privacy = pjsip_msg_find_hdr_by_name(tdata->msg, &pj_privacy_name, NULL);
482
483         if ((ast_party_id_presentation(id) & AST_PRES_RESTRICTION) == AST_PRES_ALLOWED) {
484                 if (old_privacy) {
485                         pj_list_erase(old_privacy);
486                 }
487         } else if (!old_privacy) {
488                 pjsip_generic_string_hdr *privacy_hdr = pjsip_generic_string_hdr_create(
489                                 tdata->pool, &pj_privacy_name, &pj_privacy_value);
490                 pjsip_msg_add_hdr(tdata->msg, (pjsip_hdr *)privacy_hdr);
491         }
492 }
493
494 /*!
495  * \internal
496  * \brief Add a P-Asserted-Identity header to an outbound message
497  * \param tdata The message to add the header to
498  * \param id The identification information used to populate the header
499  */
500 static void add_pai_header(const struct ast_sip_session *session, pjsip_tx_data *tdata, const struct ast_party_id *id)
501 {
502         static const pj_str_t pj_pai_name = { "P-Asserted-Identity", 19 };
503         pjsip_fromto_hdr *base;
504         pjsip_fromto_hdr *pai_hdr;
505         pjsip_fromto_hdr *old_pai;
506
507         /* Since inv_session reuses responses, we have to make sure there's not already
508          * a P-Asserted-Identity present. If there is, we just modify the old one.
509          */
510         old_pai = pjsip_msg_find_hdr_by_name(tdata->msg, &pj_pai_name, NULL);
511         if (old_pai) {
512                 /* If type is OTHER, then the existing header was most likely
513                  * added by the PJSIP_HEADER dial plan function as a simple
514                  * name/value pair.  We can't pass this to modify_id_header because
515                  * there are no virtual functions to get the uri.  We could parse
516                  * it into a pjsip_fromto_hdr but it isn't worth it since
517                  * modify_id_header is just going to overwrite the name and number
518                  * anyway.  We'll just remove it from the header list instead
519                  * and create a new one.
520                  */
521                 if (old_pai->type == PJSIP_H_OTHER) {
522                         pj_list_erase(old_pai);
523                 } else {
524                         ast_sip_modify_id_header(tdata->pool, old_pai, id);
525                         add_privacy_header(tdata, id);
526                         return;
527                 }
528         }
529
530         if (tdata->msg->type == PJSIP_REQUEST_MSG) {
531                 base = session->saved_from_hdr ? session->saved_from_hdr : PJSIP_MSG_FROM_HDR(tdata->msg);
532         } else {
533                 base = PJSIP_MSG_TO_HDR(tdata->msg);
534         }
535
536         pai_hdr = create_new_id_hdr(&pj_pai_name, base, tdata, id);
537         if (!pai_hdr) {
538                 return;
539         }
540         add_privacy_header(tdata, id);
541
542         pjsip_msg_add_hdr(tdata->msg, (pjsip_hdr *)pai_hdr);
543 }
544
545 /*!
546  * \internal
547  * \brief Add party parameter to a Remote-Party-ID header.
548  *
549  * \param tdata The message where the Remote-Party-ID header is
550  * \param hdr The header on which the parameters are being added
551  * \param session The session involved
552  */
553 static void add_party_param(pjsip_tx_data *tdata, pjsip_fromto_hdr *hdr, const struct ast_sip_session *session)
554 {
555         static const pj_str_t party_str = { "party", 5 };
556         static const pj_str_t calling_str = { "calling", 7 };
557         static const pj_str_t called_str = { "called", 6 };
558         pjsip_param *party;
559
560         /* The party value can't change throughout the lifetime, so it is set only once */
561         party = pjsip_param_find(&hdr->other_param, &party_str);
562         if (party) {
563                 return;
564         }
565
566         party = PJ_POOL_ALLOC_T(tdata->pool, pjsip_param);
567         party->name = party_str;
568         party->value = (session->inv_session->role == PJSIP_ROLE_UAC) ? calling_str : called_str;
569         pj_list_insert_before(&hdr->other_param, party);
570 }
571
572 /*!
573  * \internal
574  * \brief Add privacy and screen parameters to a Remote-Party-ID header.
575  *
576  * If privacy is requested, then the privacy and screen parameters need to
577  * reflect this. Similarly, if no privacy or screening is to be communicated,
578  * we need to make sure that any previously set values are updated.
579  *
580  * \param tdata The message where the Remote-Party-ID header is
581  * \param hdr The header on which the parameters are being added
582  * \param id The identification information used to determine privacy
583  */
584 static void add_privacy_params(pjsip_tx_data *tdata, pjsip_fromto_hdr *hdr, const struct ast_party_id *id)
585 {
586         static const pj_str_t privacy_str = { "privacy", 7 };
587         static const pj_str_t screen_str = { "screen", 6 };
588         static const pj_str_t privacy_full_str = { "full", 4 };
589         static const pj_str_t privacy_off_str = { "off", 3 };
590         static const pj_str_t screen_yes_str = { "yes", 3 };
591         static const pj_str_t screen_no_str = { "no", 2 };
592         pjsip_param *old_privacy;
593         pjsip_param *old_screen;
594         pjsip_param *privacy;
595         pjsip_param *screen;
596         int presentation;
597
598         old_privacy = pjsip_param_find(&hdr->other_param, &privacy_str);
599         old_screen = pjsip_param_find(&hdr->other_param, &screen_str);
600
601         if (!old_privacy) {
602                 privacy = PJ_POOL_ALLOC_T(tdata->pool, pjsip_param);
603                 privacy->name = privacy_str;
604                 pj_list_insert_before(&hdr->other_param, privacy);
605         } else {
606                 privacy = old_privacy;
607         }
608
609         if (!old_screen) {
610                 screen = PJ_POOL_ALLOC_T(tdata->pool, pjsip_param);
611                 screen->name = screen_str;
612                 pj_list_insert_before(&hdr->other_param, screen);
613         } else {
614                 screen = old_screen;
615         }
616
617         presentation = ast_party_id_presentation(id);
618         if ((presentation & AST_PRES_RESTRICTION) == AST_PRES_ALLOWED) {
619                 privacy->value = privacy_off_str;
620         } else {
621                 privacy->value = privacy_full_str;
622         }
623         if ((presentation & AST_PRES_NUMBER_TYPE) == AST_PRES_USER_NUMBER_PASSED_SCREEN) {
624                 screen->value = screen_yes_str;
625         } else {
626                 screen->value = screen_no_str;
627         }
628 }
629
630 /*!
631  * \internal
632  * \brief Add a Remote-Party-ID header to an outbound message
633  * \param tdata The message to add the header to
634  * \param id The identification information used to populate the header
635  */
636 static void add_rpid_header(const struct ast_sip_session *session, pjsip_tx_data *tdata, const struct ast_party_id *id)
637 {
638         static const pj_str_t pj_rpid_name = { "Remote-Party-ID", 15 };
639         pjsip_fromto_hdr *base;
640         pjsip_fromto_hdr *rpid_hdr;
641         pjsip_fromto_hdr *old_rpid;
642
643         /* Since inv_session reuses responses, we have to make sure there's not already
644          * a P-Asserted-Identity present. If there is, we just modify the old one.
645          */
646         old_rpid = pjsip_msg_find_hdr_by_name(tdata->msg, &pj_rpid_name, NULL);
647         if (old_rpid) {
648                 /* If type is OTHER, then the existing header was most likely
649                  * added by the PJSIP_HEADER dial plan function as a simple
650                  * name/value pair.  We can't pass this to modify_id_header because
651                  * there are no virtual functions to get the uri.  We could parse
652                  * it into a pjsip_fromto_hdr but it isn't worth it since
653                  * modify_id_header is just going to overwrite the name and number
654                  * anyway.  We'll just remove it from the header list instead
655                  * and create a new one.
656                  */
657                 if (old_rpid->type == PJSIP_H_OTHER) {
658                         pj_list_erase(old_rpid);
659                 } else {
660                         ast_sip_modify_id_header(tdata->pool, old_rpid, id);
661                         add_party_param(tdata, old_rpid, session);
662                         add_privacy_params(tdata, old_rpid, id);
663                         return;
664                 }
665         }
666
667         if (tdata->msg->type == PJSIP_REQUEST_MSG) {
668                 base = session->saved_from_hdr ? session->saved_from_hdr : PJSIP_MSG_FROM_HDR(tdata->msg);
669         } else {
670                 base = PJSIP_MSG_TO_HDR(tdata->msg);
671         }
672
673         rpid_hdr = create_new_id_hdr(&pj_rpid_name, base, tdata, id);
674         if (!rpid_hdr) {
675                 return;
676         }
677         add_party_param(tdata, rpid_hdr, session);
678         add_privacy_params(tdata, rpid_hdr, id);
679         pjsip_msg_add_hdr(tdata->msg, (pjsip_hdr *)rpid_hdr);
680 }
681
682 /*!
683  * \internal
684  * \brief Add any appropriate identification headers to an outbound SIP message
685  *
686  * This will determine if an outbound message should have identification headers and
687  * will add the appropriately configured headers
688  *
689  * \param session The session on which we will be sending the message
690  * \param tdata The outbound message
691  * \param The identity information to place on the message
692  */
693 static void add_id_headers(const struct ast_sip_session *session, pjsip_tx_data *tdata, const struct ast_party_id *id)
694 {
695         if (!id->number.valid
696                 || (!session->endpoint->id.trust_outbound
697                         && (ast_party_id_presentation(id) & AST_PRES_RESTRICTION) != AST_PRES_ALLOWED)) {
698                 return;
699         }
700         if (session->endpoint->id.send_pai) {
701                 add_pai_header(session, tdata, id);
702         }
703         if (session->endpoint->id.send_rpid) {
704                 add_rpid_header(session, tdata, id);
705         }
706 }
707
708 /*!
709  * \internal
710  * \brief Session supplement callback for outgoing INVITE requests
711  *
712  * On all INVITEs (initial and reinvite) we may add other identity headers
713  * such as P-Asserted-Identity and Remote-Party-ID based on configuration
714  * and privacy settings
715  *
716  * \param session The session on which the INVITE will be sent
717  * \param tdata The outbound INVITE request
718  */
719 static void caller_id_outgoing_request(struct ast_sip_session *session, pjsip_tx_data *tdata)
720 {
721         struct ast_party_id effective_id;
722         struct ast_party_id connected_id;
723
724         if (!session->channel) {
725                 return;
726         }
727
728         ast_party_id_init(&connected_id);
729         ast_channel_lock(session->channel);
730         effective_id = ast_channel_connected_effective_id(session->channel);
731         ast_party_id_copy(&connected_id, &effective_id);
732         ast_channel_unlock(session->channel);
733
734         add_id_headers(session, tdata, &connected_id);
735         ast_party_id_free(&connected_id);
736 }
737
738 /*!
739  * \internal
740  * \brief Session supplement for outgoing INVITE response
741  *
742  * This will add P-Asserted-Identity and Remote-Party-ID headers if necessary
743  *
744  * \param session The session on which the INVITE response is to be sent
745  * \param tdata The outbound INVITE response
746  */
747 static void caller_id_outgoing_response(struct ast_sip_session *session, pjsip_tx_data *tdata)
748 {
749         struct ast_party_id effective_id;
750         struct ast_party_id connected_id;
751
752         if (!session->channel
753                 || (!session->endpoint->id.send_connected_line
754                         && session->inv_session
755                         && session->inv_session->state >= PJSIP_INV_STATE_EARLY)) {
756                 return;
757         }
758
759         /* Must do a deep copy unless we hold the channel lock the entire time. */
760         ast_party_id_init(&connected_id);
761         ast_channel_lock(session->channel);
762         effective_id = ast_channel_connected_effective_id(session->channel);
763         ast_party_id_copy(&connected_id, &effective_id);
764         ast_channel_unlock(session->channel);
765
766         add_id_headers(session, tdata, &connected_id);
767         ast_party_id_free(&connected_id);
768 }
769
770 static struct ast_sip_session_supplement caller_id_supplement = {
771         .method = "INVITE,UPDATE",
772         .priority = AST_SIP_SUPPLEMENT_PRIORITY_CHANNEL - 1000,
773         .incoming_request = caller_id_incoming_request,
774         .incoming_response = caller_id_incoming_response,
775         .outgoing_request = caller_id_outgoing_request,
776         .outgoing_response = caller_id_outgoing_response,
777 };
778
779 static int load_module(void)
780 {
781         ast_module_shutdown_ref(AST_MODULE_SELF);
782         ast_sip_session_register_supplement(&caller_id_supplement);
783         return AST_MODULE_LOAD_SUCCESS;
784 }
785
786 static int unload_module(void)
787 {
788         ast_sip_session_unregister_supplement(&caller_id_supplement);
789         return 0;
790 }
791
792 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "PJSIP Caller ID Support",
793         .support_level = AST_MODULE_SUPPORT_CORE,
794         .load = load_module,
795         .unload = unload_module,
796         .load_pri = AST_MODPRI_APP_DEPEND,
797         .requires = "res_pjsip",
798 );