Merge "res_pjsip: Use hash for contact object identity instead of Contact URI."
[asterisk/asterisk.git] / res / res_pjsip / location.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * Joshua Colp <jcolp@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 #include "asterisk.h"
20 #include "pjsip.h"
21 #include "pjlib.h"
22
23 #include "asterisk/res_pjsip.h"
24 #include "asterisk/logger.h"
25 #include "asterisk/astobj2.h"
26 #include "asterisk/sorcery.h"
27 #include "include/res_pjsip_private.h"
28 #include "asterisk/res_pjsip_cli.h"
29
30 /*! \brief Destructor for AOR */
31 static void aor_destroy(void *obj)
32 {
33         struct ast_sip_aor *aor = obj;
34
35         ao2_cleanup(aor->permanent_contacts);
36         ast_string_field_free_memory(aor);
37 }
38
39 /*! \brief Allocator for AOR */
40 static void *aor_alloc(const char *name)
41 {
42         struct ast_sip_aor *aor = ast_sorcery_generic_alloc(sizeof(struct ast_sip_aor), aor_destroy);
43         if (!aor) {
44                 return NULL;
45         }
46         ast_string_field_init(aor, 128);
47         return aor;
48 }
49
50 /*! \brief Internal callback function which destroys the specified contact */
51 static int destroy_contact(void *obj, void *arg, int flags)
52 {
53         struct ast_sip_contact *contact = obj;
54
55         ast_sip_location_delete_contact(contact);
56
57         return CMP_MATCH;
58 }
59
60 static void aor_deleted_observer(const void *object)
61 {
62         const char *aor_id = ast_sorcery_object_get_id(object);
63         /* Give enough space for ^ at the beginning and ;@ at the end, since that is our object naming scheme */
64         char regex[strlen(aor_id) + 4];
65         struct ao2_container *contacts;
66
67         snprintf(regex, sizeof(regex), "^%s;@", aor_id);
68
69         if (!(contacts = ast_sorcery_retrieve_by_regex(ast_sip_get_sorcery(), "contact", regex))) {
70                 return;
71         }
72
73         /* Destroy any contacts that may still exist that were made for this AoR */
74         ao2_callback(contacts, OBJ_NODATA | OBJ_MULTIPLE | OBJ_UNLINK, destroy_contact, NULL);
75
76         ao2_ref(contacts, -1);
77 }
78
79 /*! \brief Observer for contacts so state can be updated on respective endpoints */
80 static const struct ast_sorcery_observer aor_observer = {
81         .deleted = aor_deleted_observer,
82 };
83
84
85 /*! \brief Destructor for contact */
86 static void contact_destroy(void *obj)
87 {
88         struct ast_sip_contact *contact = obj;
89
90         ast_string_field_free_memory(contact);
91         ao2_cleanup(contact->endpoint);
92 }
93
94 /*! \brief Allocator for contact */
95 static void *contact_alloc(const char *name)
96 {
97         struct ast_sip_contact *contact = ast_sorcery_generic_alloc(sizeof(*contact), contact_destroy);
98
99         if (!contact) {
100                 return NULL;
101         }
102
103         if (ast_string_field_init(contact, 256)) {
104                 ao2_cleanup(contact);
105                 return NULL;
106         }
107
108         return contact;
109 }
110
111 struct ast_sip_aor *ast_sip_location_retrieve_aor(const char *aor_name)
112 {
113         return ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "aor", aor_name);
114 }
115
116 /*! \brief Internal callback function which deletes and unlinks any expired contacts */
117 static int contact_expire(void *obj, void *arg, int flags)
118 {
119         struct ast_sip_contact *contact = obj;
120
121         /* If the contact has not yet expired it is valid */
122         if (ast_tvdiff_ms(contact->expiration_time, ast_tvnow()) > 0) {
123                 return 0;
124         }
125
126         ast_sip_location_delete_contact(contact);
127
128         return CMP_MATCH;
129 }
130
131 /*! \brief Internal callback function which links static contacts into another container */
132 static int contact_link_static(void *obj, void *arg, int flags)
133 {
134         struct ao2_container *dest = arg;
135
136         ao2_link(dest, obj);
137         return 0;
138 }
139
140 /*! \brief Simple callback function which returns immediately, used to grab the first contact of an AOR */
141 static int contact_find_first(void *obj, void *arg, int flags)
142 {
143         return CMP_MATCH | CMP_STOP;
144 }
145
146 struct ast_sip_contact *ast_sip_location_retrieve_first_aor_contact(const struct ast_sip_aor *aor)
147 {
148         RAII_VAR(struct ao2_container *, contacts, NULL, ao2_cleanup);
149         struct ast_sip_contact *contact;
150
151         contacts = ast_sip_location_retrieve_aor_contacts(aor);
152         if (!contacts || (ao2_container_count(contacts) == 0)) {
153                 return NULL;
154         }
155
156         contact = ao2_callback(contacts, 0, contact_find_first, NULL);
157         return contact;
158 }
159
160 struct ao2_container *ast_sip_location_retrieve_aor_contacts(const struct ast_sip_aor *aor)
161 {
162         /* Give enough space for ^ at the beginning and ;@ at the end, since that is our object naming scheme */
163         char regex[strlen(ast_sorcery_object_get_id(aor)) + 4];
164         struct ao2_container *contacts;
165
166         snprintf(regex, sizeof(regex), "^%s;@", ast_sorcery_object_get_id(aor));
167
168         if (!(contacts = ast_sorcery_retrieve_by_regex(ast_sip_get_sorcery(), "contact", regex))) {
169                 return NULL;
170         }
171
172         /* Prune any expired contacts and delete them, we do this first because static contacts can never expire */
173         ao2_callback(contacts, OBJ_NODATA | OBJ_MULTIPLE | OBJ_UNLINK, contact_expire, NULL);
174
175         /* Add any permanent contacts from the AOR */
176         if (aor->permanent_contacts) {
177                 ao2_callback(aor->permanent_contacts, OBJ_NODATA, contact_link_static, contacts);
178         }
179
180         return contacts;
181 }
182
183 void ast_sip_location_retrieve_contact_and_aor_from_list(const char *aor_list, struct ast_sip_aor **aor,
184         struct ast_sip_contact **contact)
185 {
186         char *aor_name;
187         char *rest;
188
189         /* If the location is still empty we have nowhere to go */
190         if (ast_strlen_zero(aor_list) || !(rest = ast_strdupa(aor_list))) {
191                 ast_log(LOG_WARNING, "Unable to determine contacts from empty aor list\n");
192                 return;
193         }
194
195         *aor = NULL;
196         *contact = NULL;
197
198         while ((aor_name = strsep(&rest, ","))) {
199                 *aor = ast_sip_location_retrieve_aor(aor_name);
200
201                 if (!(*aor)) {
202                         continue;
203                 }
204                 *contact = ast_sip_location_retrieve_first_aor_contact(*aor);
205                 /* If a valid contact is available use its URI for dialing */
206                 if (*contact) {
207                         break;
208                 }
209
210                 ao2_ref(*aor, -1);
211                 *aor = NULL;
212         }
213 }
214
215 struct ast_sip_contact *ast_sip_location_retrieve_contact_from_aor_list(const char *aor_list)
216 {
217         struct ast_sip_aor *aor;
218         struct ast_sip_contact *contact;
219
220         ast_sip_location_retrieve_contact_and_aor_from_list(aor_list, &aor, &contact);
221
222         ao2_cleanup(aor);
223
224         return contact;
225 }
226
227 static int permanent_uri_sort_fn(const void *obj_left, const void *obj_right, int flags);
228 static int cli_contact_populate_container(void *obj, void *arg, int flags);
229
230 static int gather_contacts_for_aor(void *obj, void *arg, int flags)
231 {
232         struct ao2_container *aor_contacts;
233         struct ast_sip_aor *aor = obj;
234         struct ao2_container *container = arg;
235
236         aor_contacts = ast_sip_location_retrieve_aor_contacts(aor);
237         if (!aor_contacts) {
238                 return 0;
239         }
240         ao2_callback(aor_contacts, OBJ_MULTIPLE | OBJ_NODATA, cli_contact_populate_container,
241                 container);
242         ao2_ref(aor_contacts, -1);
243         return CMP_MATCH;
244 }
245
246 struct ao2_container *ast_sip_location_retrieve_contacts_from_aor_list(const char *aor_list)
247 {
248         struct ao2_container *contacts;
249
250         contacts = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK,
251                 AO2_CONTAINER_ALLOC_OPT_DUPS_REJECT, permanent_uri_sort_fn, NULL);
252         if (!contacts) {
253                 return NULL;
254         }
255
256         ast_sip_for_each_aor(aor_list, gather_contacts_for_aor, contacts);
257
258         return contacts;
259 }
260
261 struct ast_sip_contact *ast_sip_location_retrieve_contact(const char *contact_name)
262 {
263         return ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "contact", contact_name);
264 }
265
266 int ast_sip_location_add_contact(struct ast_sip_aor *aor, const char *uri,
267                 struct timeval expiration_time, const char *path_info, const char *user_agent,
268                 struct ast_sip_endpoint *endpoint)
269 {
270         char name[MAX_OBJECT_FIELD * 2 + 3];
271         RAII_VAR(struct ast_sip_contact *, contact, NULL, ao2_cleanup);
272         char hash[33];
273
274         ast_md5_hash(hash, uri);
275         snprintf(name, sizeof(name), "%s;@%s", ast_sorcery_object_get_id(aor), hash);
276
277         if (!(contact = ast_sorcery_alloc(ast_sip_get_sorcery(), "contact", name))) {
278                 return -1;
279         }
280
281         ast_string_field_set(contact, uri, uri);
282         contact->expiration_time = expiration_time;
283         contact->qualify_frequency = aor->qualify_frequency;
284         contact->qualify_timeout = aor->qualify_timeout;
285         contact->authenticate_qualify = aor->authenticate_qualify;
286         if (path_info && aor->support_path) {
287                 ast_string_field_set(contact, path, path_info);
288         }
289
290         if (!ast_strlen_zero(aor->outbound_proxy)) {
291                 ast_string_field_set(contact, outbound_proxy, aor->outbound_proxy);
292         }
293
294         if (!ast_strlen_zero(user_agent)) {
295                 ast_string_field_set(contact, user_agent, user_agent);
296         }
297
298         contact->endpoint = ao2_bump(endpoint);
299
300         return ast_sorcery_create(ast_sip_get_sorcery(), contact);
301 }
302
303 int ast_sip_location_update_contact(struct ast_sip_contact *contact)
304 {
305         return ast_sorcery_update(ast_sip_get_sorcery(), contact);
306 }
307
308 int ast_sip_location_delete_contact(struct ast_sip_contact *contact)
309 {
310         return ast_sorcery_delete(ast_sip_get_sorcery(), contact);
311 }
312
313 /*! \brief Custom handler for translating from a string timeval to actual structure */
314 static int expiration_str2struct(const struct aco_option *opt, struct ast_variable *var, void *obj)
315 {
316         struct ast_sip_contact *contact = obj;
317         return ast_get_timeval(var->value, &contact->expiration_time, ast_tv(0, 0), NULL);
318 }
319
320 /*! \brief Custom handler for translating from an actual structure timeval to string */
321 static int expiration_struct2str(const void *obj, const intptr_t *args, char **buf)
322 {
323         const struct ast_sip_contact *contact = obj;
324         return (ast_asprintf(buf, "%ld", contact->expiration_time.tv_sec) < 0) ? -1 : 0;
325 }
326
327 /*! \brief Helper function which validates a permanent contact */
328 static int permanent_contact_validate(void *data)
329 {
330         const char *value = data;
331         pj_pool_t *pool;
332         pj_str_t contact_uri;
333         static const pj_str_t HCONTACT = { "Contact", 7 };
334         pjsip_contact_hdr *contact_hdr;
335         int rc = 0;
336
337         pool = pjsip_endpt_create_pool(ast_sip_get_pjsip_endpoint(), "Permanent Contact Validation", 256, 256);
338         if (!pool) {
339                 return -1;
340         }
341
342         pj_strdup2_with_null(pool, &contact_uri, value);
343         if (!(contact_hdr = pjsip_parse_hdr(pool, &HCONTACT, contact_uri.ptr, contact_uri.slen, NULL))
344                 || !(PJSIP_URI_SCHEME_IS_SIP(contact_hdr->uri)
345                         || PJSIP_URI_SCHEME_IS_SIPS(contact_hdr->uri))) {
346                 rc = -1;
347         }
348
349         pjsip_endpt_release_pool(ast_sip_get_pjsip_endpoint(), pool);
350         return rc;
351 }
352
353 static int permanent_uri_sort_fn(const void *obj_left, const void *obj_right, int flags)
354 {
355         const struct ast_sip_contact *object_left = obj_left;
356         const struct ast_sip_contact *object_right = obj_right;
357         const char *right_key = obj_right;
358         int cmp;
359
360         switch (flags & OBJ_SEARCH_MASK) {
361         case OBJ_SEARCH_OBJECT:
362                 right_key = ast_sorcery_object_get_id(object_right);
363                 /* Fall through */
364         case OBJ_SEARCH_KEY:
365                 cmp = strcmp(ast_sorcery_object_get_id(object_left), right_key);
366                 break;
367         case OBJ_SEARCH_PARTIAL_KEY:
368                 /*
369                  * We could also use a partial key struct containing a length
370                  * so strlen() does not get called for every comparison instead.
371                  */
372                 cmp = strncmp(ast_sorcery_object_get_id(object_left), right_key, strlen(right_key));
373                 break;
374         default:
375                 /* Sort can only work on something with a full or partial key. */
376                 ast_assert(0);
377                 cmp = 0;
378                 break;
379         }
380         return cmp;
381 }
382
383 /*! \brief Custom handler for permanent URIs */
384 static int permanent_uri_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
385 {
386         struct ast_sip_aor *aor = obj;
387         const char *aor_id = ast_sorcery_object_get_id(aor);
388         char *contacts;
389         char *contact_uri;
390
391         if (ast_strlen_zero(var->value)) {
392                 return 0;
393         }
394
395         contacts = ast_strdupa(var->value);
396         while ((contact_uri = strsep(&contacts, ","))) {
397                 struct ast_sip_contact *contact;
398                 struct ast_sip_contact_status *status;
399                 char contact_id[strlen(aor_id) + strlen(contact_uri) + 2 + 1];
400
401                 if (ast_sip_push_task_synchronous(NULL, permanent_contact_validate, contact_uri)) {
402                         ast_log(LOG_ERROR, "Permanent URI on aor '%s' with contact '%s' failed to parse\n",
403                                 ast_sorcery_object_get_id(aor), contact_uri);
404                         return -1;
405                 }
406
407                 if (!aor->permanent_contacts) {
408                         aor->permanent_contacts = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK,
409                                 AO2_CONTAINER_ALLOC_OPT_DUPS_REJECT, permanent_uri_sort_fn, NULL);
410                         if (!aor->permanent_contacts) {
411                                 return -1;
412                         }
413                 }
414
415                 snprintf(contact_id, sizeof(contact_id), "%s@@%s", aor_id, contact_uri);
416                 contact = ast_sorcery_alloc(ast_sip_get_sorcery(), "contact", contact_id);
417                 if (!contact) {
418                         return -1;
419                 }
420
421                 status = ast_res_pjsip_find_or_create_contact_status(contact);
422                 if (!status) {
423                         ao2_ref(contact, -1);
424                         return -1;
425                 }
426                 ao2_ref(status, -1);
427
428                 ast_string_field_set(contact, uri, contact_uri);
429                 ao2_link(aor->permanent_contacts, contact);
430                 ao2_ref(contact, -1);
431         }
432
433         return 0;
434 }
435
436 static int contact_to_var_list(void *object, void *arg, int flags)
437 {
438         struct ast_sip_contact_wrapper *wrapper = object;
439         struct ast_variable **var = arg;
440
441         ast_variable_list_append(&*var, ast_variable_new("contact", wrapper->contact->uri, ""));
442
443         return 0;
444 }
445
446 static int contacts_to_var_list(const void *obj, struct ast_variable **fields)
447 {
448         const struct ast_sip_aor *aor = obj;
449
450         ast_sip_for_each_contact(aor, contact_to_var_list, fields);
451
452         return 0;
453 }
454
455 int ast_sip_for_each_aor(const char *aors, ao2_callback_fn on_aor, void *arg)
456 {
457         char *copy, *name;
458
459         if (!on_aor || ast_strlen_zero(aors)) {
460                 return 0;
461         }
462
463         copy = ast_strdupa(aors);
464         while ((name = strsep(&copy, ","))) {
465                 RAII_VAR(struct ast_sip_aor *, aor,
466                          ast_sip_location_retrieve_aor(name), ao2_cleanup);
467
468                 if (!aor) {
469                         continue;
470                 }
471
472                 if (on_aor(aor, arg, 0)) {
473                         return -1;
474                 }
475         }
476         ast_free(copy);
477         return 0;
478 }
479
480 static void contact_wrapper_destroy(void *obj)
481 {
482         struct ast_sip_contact_wrapper *wrapper = obj;
483         ast_free(wrapper->aor_id);
484         ast_free(wrapper->contact_id);
485         ao2_ref(wrapper->contact, -1);
486 }
487
488 int ast_sip_for_each_contact(const struct ast_sip_aor *aor,
489                 ao2_callback_fn on_contact, void *arg)
490 {
491         RAII_VAR(struct ao2_container *, contacts, NULL, ao2_cleanup);
492         struct ao2_iterator i;
493         int res = 0;
494         void *object = NULL;
495
496         if (!on_contact ||
497             !(contacts = ast_sip_location_retrieve_aor_contacts(aor))) {
498                 return 0;
499         }
500
501         i = ao2_iterator_init(contacts, 0);
502         while ((object = ao2_iterator_next(&i))) {
503                 RAII_VAR(struct ast_sip_contact *, contact, object, ao2_cleanup);
504                 RAII_VAR(struct ast_sip_contact_wrapper *, wrapper, NULL, ao2_cleanup);
505                 const char *aor_id = ast_sorcery_object_get_id(aor);
506
507                 wrapper = ao2_alloc(sizeof(struct ast_sip_contact_wrapper), contact_wrapper_destroy);
508                 if (!wrapper) {
509                         res = -1;
510                         break;
511                 }
512                 wrapper->contact_id = ast_malloc(strlen(aor_id) + strlen(contact->uri) + 2);
513                 if (!wrapper->contact_id) {
514                         res = -1;
515                         break;
516                 }
517                 sprintf(wrapper->contact_id, "%s/%s", aor_id, contact->uri);
518                 wrapper->aor_id = ast_strdup(aor_id);
519                 if (!wrapper->aor_id) {
520                         res = -1;
521                         break;
522                 }
523                 wrapper->contact = contact;
524                 ao2_bump(wrapper->contact);
525
526                 if ((res = on_contact(wrapper, arg, 0))) {
527                         break;
528                 }
529         }
530         ao2_iterator_destroy(&i);
531         return res;
532 }
533
534 int ast_sip_contact_to_str(void *object, void *arg, int flags)
535 {
536         struct ast_sip_contact_wrapper *wrapper = object;
537         struct ast_str **buf = arg;
538
539         ast_str_append(buf, 0, "%s,", wrapper->contact_id);
540
541         return 0;
542 }
543
544 static int sip_aor_to_ami(const struct ast_sip_aor *aor, struct ast_str **buf)
545 {
546         RAII_VAR(struct ast_variable *, objset, ast_sorcery_objectset_create2(
547                          ast_sip_get_sorcery(), aor, AST_HANDLER_ONLY_STRING), ast_variables_destroy);
548         struct ast_variable *i;
549
550         if (!objset) {
551                 return -1;
552         }
553
554         ast_str_append(buf, 0, "ObjectType: %s\r\n",
555                        ast_sorcery_object_get_type(aor));
556         ast_str_append(buf, 0, "ObjectName: %s\r\n",
557                        ast_sorcery_object_get_id(aor));
558
559         for (i = objset; i; i = i->next) {
560                 char *camel = ast_to_camel_case(i->name);
561                 if (strcmp(camel, "Contact") == 0) {
562                         ast_free(camel);
563                         camel = NULL;
564                 }
565                 ast_str_append(buf, 0, "%s: %s\r\n", S_OR(camel, "Contacts"), i->value);
566                 ast_free(camel);
567         }
568
569         return 0;
570 }
571
572 static int contacts_to_str(const void *obj, const intptr_t *args, char **buf)
573 {
574         const struct ast_sip_aor *aor = obj;
575         RAII_VAR(struct ast_str *, str, ast_str_create(MAX_OBJECT_FIELD), ast_free);
576
577         ast_sip_for_each_contact(aor, ast_sip_contact_to_str, &str);
578         ast_str_truncate(str, -1);
579
580         *buf = ast_strdup(ast_str_buffer(str));
581         if (!*buf) {
582                 return -1;
583         }
584
585         return 0;
586 }
587
588 static int format_ami_aor_handler(void *obj, void *arg, int flags)
589 {
590         struct ast_sip_aor *aor = obj;
591         struct ast_sip_ami *ami = arg;
592         const struct ast_sip_endpoint *endpoint = ami->arg;
593         RAII_VAR(struct ast_str *, buf,
594                  ast_sip_create_ami_event("AorDetail", ami), ast_free);
595
596         int total_contacts;
597         int num_permanent;
598         RAII_VAR(struct ao2_container *, contacts,
599                  ast_sip_location_retrieve_aor_contacts(aor), ao2_cleanup);
600
601         if (!buf) {
602                 return -1;
603         }
604
605         sip_aor_to_ami(aor, &buf);
606         total_contacts = ao2_container_count(contacts);
607         num_permanent = aor->permanent_contacts ?
608                 ao2_container_count(aor->permanent_contacts) : 0;
609
610         ast_str_append(&buf, 0, "TotalContacts: %d\r\n", total_contacts);
611         ast_str_append(&buf, 0, "ContactsRegistered: %d\r\n",
612                        total_contacts - num_permanent);
613         ast_str_append(&buf, 0, "EndpointName: %s\r\n",
614                        ast_sorcery_object_get_id(endpoint));
615
616         astman_append(ami->s, "%s\r\n", ast_str_buffer(buf));
617         ami->count++;
618
619         return 0;
620 }
621
622 static int format_ami_endpoint_aor(const struct ast_sip_endpoint *endpoint,
623                                    struct ast_sip_ami *ami)
624 {
625         ami->arg = (void *)endpoint;
626         return ast_sip_for_each_aor(endpoint->aors,
627                                     format_ami_aor_handler, ami);
628 }
629
630 struct ast_sip_endpoint_formatter endpoint_aor_formatter = {
631         .format_ami = format_ami_endpoint_aor
632 };
633
634 static struct ao2_container *cli_aor_get_container(void)
635 {
636         RAII_VAR(struct ao2_container *, container, NULL, ao2_cleanup);
637         struct ao2_container *s_container;
638
639         container = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), "aor",
640                 AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);
641         if (!container) {
642                 return NULL;
643         }
644
645         s_container = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK, 0,
646                 ast_sorcery_object_id_sort, ast_sorcery_object_id_compare);
647         if (!s_container) {
648                 return NULL;
649         }
650
651         if (ao2_container_dup(s_container, container, 0)) {
652                 ao2_ref(s_container, -1);
653                 return NULL;
654         }
655
656         return s_container;
657 }
658
659 static int cli_contact_populate_container(void *obj, void *arg, int flags)
660 {
661         ao2_link(arg, obj);
662
663         return 0;
664 }
665
666 static int cli_aor_gather_contacts(void *obj, void *arg, int flags)
667 {
668         struct ast_sip_aor *aor = obj;
669
670         return ast_sip_for_each_contact(aor, cli_contact_populate_container, arg);
671 }
672
673 static const char *cli_contact_get_id(const void *obj)
674 {
675         const struct ast_sip_contact_wrapper *wrapper = obj;
676         return wrapper->contact_id;
677 }
678
679 static int cli_contact_sort(const void *obj, const void *arg, int flags)
680 {
681         const struct ast_sip_contact_wrapper *left_wrapper = obj;
682         const struct ast_sip_contact_wrapper *right_wrapper = arg;
683         const char *right_key = arg;
684         int cmp = 0;
685
686         switch (flags & OBJ_SEARCH_MASK) {
687         case OBJ_SEARCH_OBJECT:
688                 right_key = right_wrapper->contact_id;
689                 /* Fall through */
690         case OBJ_SEARCH_KEY:
691                 cmp = strcmp(left_wrapper->contact_id, right_key);
692                 break;
693         case OBJ_SEARCH_PARTIAL_KEY:
694                 cmp = strncmp(left_wrapper->contact_id, right_key, strlen(right_key));
695                 break;
696         default:
697                 cmp = 0;
698                 break;
699         }
700
701         return cmp;
702 }
703
704 static int cli_contact_compare(void *obj, void *arg, int flags)
705 {
706         const struct ast_sip_contact_wrapper *left_wrapper = obj;
707         const struct ast_sip_contact_wrapper *right_wrapper = arg;
708         const char *right_key = arg;
709         int cmp = 0;
710
711         switch (flags & OBJ_SEARCH_MASK) {
712         case OBJ_SEARCH_OBJECT:
713                 right_key = right_wrapper->contact_id;
714                 /* Fall through */
715         case OBJ_SEARCH_KEY:
716                 if (strcmp(left_wrapper->contact_id, right_key) == 0) {;
717                         cmp = CMP_MATCH | CMP_STOP;
718                 }
719                 break;
720         case OBJ_SEARCH_PARTIAL_KEY:
721                 if (strncmp(left_wrapper->contact_id, right_key, strlen(right_key)) == 0) {
722                         cmp = CMP_MATCH;
723                 }
724                 break;
725         default:
726                 cmp = 0;
727                 break;
728         }
729
730         return cmp;
731 }
732
733 static int cli_contact_iterate(void *container, ao2_callback_fn callback, void *args)
734 {
735         return ast_sip_for_each_contact(container, callback, args);
736 }
737
738 static struct ao2_container *cli_contact_get_container(void)
739 {
740         RAII_VAR(struct ao2_container *, parent_container, NULL, ao2_cleanup);
741         struct ao2_container *child_container;
742
743         parent_container =  cli_aor_get_container();
744         if (!parent_container) {
745                 return NULL;
746         }
747
748         child_container = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK, 0,
749                 cli_contact_sort, cli_contact_compare);
750         if (!child_container) {
751                 return NULL;
752         }
753
754         ao2_callback(parent_container, OBJ_NODATA, cli_aor_gather_contacts, child_container);
755
756         return child_container;
757 }
758
759 static void *cli_contact_retrieve_by_id(const char *id)
760 {
761         return ao2_find(cli_contact_get_container(), id, OBJ_KEY | OBJ_NOLOCK);
762 }
763
764 static int cli_contact_print_header(void *obj, void *arg, int flags)
765 {
766         struct ast_sip_cli_context *context = arg;
767         int indent = CLI_INDENT_TO_SPACES(context->indent_level);
768         int filler = CLI_LAST_TABSTOP - indent - 18;
769
770         ast_assert(context->output_buffer != NULL);
771
772         ast_str_append(&context->output_buffer, 0,
773                 "%*s:  <Aor/ContactUri%*.*s>  <Status....>  <RTT(ms)..>\n",
774                 indent, "Contact", filler, filler, CLI_HEADER_FILLER);
775
776         return 0;
777 }
778
779 static int cli_contact_print_body(void *obj, void *arg, int flags)
780 {
781         struct ast_sip_contact_wrapper *wrapper = obj;
782         struct ast_sip_contact *contact = wrapper->contact;
783         struct ast_sip_cli_context *context = arg;
784         int indent;
785         int flexwidth;
786
787         RAII_VAR(struct ast_sip_contact_status *, status,
788                 ast_sorcery_retrieve_by_id( ast_sip_get_sorcery(), CONTACT_STATUS, ast_sorcery_object_get_id(contact)),
789                 ao2_cleanup);
790
791         ast_assert(contact->uri != NULL);
792         ast_assert(context->output_buffer != NULL);
793
794         indent = CLI_INDENT_TO_SPACES(context->indent_level);
795         flexwidth = CLI_LAST_TABSTOP - indent - 2;
796
797         ast_str_append(&context->output_buffer, 0, "%*s:  %-*.*s  %-12.12s  %11.3f\n",
798                 indent,
799                 "Contact",
800                 flexwidth, flexwidth,
801                 wrapper->contact_id,
802                 ast_sip_get_contact_short_status_label(status ? status->status : UNKNOWN),
803                 (status && (status->status != UNKNOWN) ? ((long long) status->rtt) / 1000.0 : NAN));
804
805         return 0;
806 }
807
808 static int cli_aor_iterate(void *container, ao2_callback_fn callback, void *args)
809 {
810         const char *aor_list = container;
811
812         return ast_sip_for_each_aor(aor_list, callback, args);
813 }
814
815 static void *cli_aor_retrieve_by_id(const char *id)
816 {
817         return ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "aor", id);
818 }
819
820 static const char *cli_aor_get_id(const void *obj)
821 {
822         return ast_sorcery_object_get_id(obj);
823 }
824
825 static int cli_aor_print_header(void *obj, void *arg, int flags)
826 {
827         struct ast_sip_cli_context *context = arg;
828         RAII_VAR(struct ast_sip_cli_formatter_entry *, formatter_entry, NULL, ao2_cleanup);
829
830         int indent = CLI_INDENT_TO_SPACES(context->indent_level);
831         int filler = CLI_LAST_TABSTOP - indent - 7;
832
833         ast_assert(context->output_buffer != NULL);
834
835         ast_str_append(&context->output_buffer, 0,
836                 "%*s:  <Aor%*.*s>  <MaxContact>\n",
837                 indent, "Aor", filler, filler, CLI_HEADER_FILLER);
838
839         if (context->recurse) {
840                 context->indent_level++;
841                 formatter_entry = ast_sip_lookup_cli_formatter("contact");
842                 if (formatter_entry) {
843                         formatter_entry->print_header(NULL, context, 0);
844                 }
845                 context->indent_level--;
846         }
847
848         return 0;
849 }
850
851 static int cli_aor_print_body(void *obj, void *arg, int flags)
852 {
853         struct ast_sip_aor *aor = obj;
854         struct ast_sip_cli_context *context = arg;
855         RAII_VAR(struct ast_sip_cli_formatter_entry *, formatter_entry, NULL, ao2_cleanup);
856         int indent;
857         int flexwidth;
858
859         ast_assert(context->output_buffer != NULL);
860
861 //      context->current_aor = aor;
862
863         indent = CLI_INDENT_TO_SPACES(context->indent_level);
864         flexwidth = CLI_LAST_TABSTOP - indent - 12;
865
866         ast_str_append(&context->output_buffer, 0, "%*s:  %-*.*s %12u\n",
867                 indent,
868                 "Aor",
869                 flexwidth, flexwidth,
870                 ast_sorcery_object_get_id(aor), aor->max_contacts);
871
872         if (context->recurse) {
873                 context->indent_level++;
874
875                 formatter_entry = ast_sip_lookup_cli_formatter("contact");
876                 if (formatter_entry) {
877                         formatter_entry->iterate(aor, formatter_entry->print_body, context);
878                 }
879
880                 context->indent_level--;
881
882                 if (context->indent_level == 0) {
883                         ast_str_append(&context->output_buffer, 0, "\n");
884                 }
885         }
886
887         if (context->show_details || (context->show_details_only_level_0 && context->indent_level == 0)) {
888                 ast_str_append(&context->output_buffer, 0, "\n");
889                 ast_sip_cli_print_sorcery_objectset(aor, context, 0);
890         }
891
892         return 0;
893 }
894
895 static struct ast_cli_entry cli_commands[] = {
896         AST_CLI_DEFINE(ast_sip_cli_traverse_objects, "List PJSIP Aors",
897                 .command = "pjsip list aors",
898                 .usage = "Usage: pjsip list aors\n"
899                                  "       List the configured PJSIP Aors\n"),
900         AST_CLI_DEFINE(ast_sip_cli_traverse_objects, "Show PJSIP Aors",
901                 .command = "pjsip show aors",
902                 .usage = "Usage: pjsip show aors\n"
903                                  "       Show the configured PJSIP Aors\n"),
904         AST_CLI_DEFINE(ast_sip_cli_traverse_objects, "Show PJSIP Aor",
905                 .command = "pjsip show aor",
906                 .usage = "Usage: pjsip show aor <id>\n"
907                                  "       Show the configured PJSIP Aor\n"),
908
909         AST_CLI_DEFINE(ast_sip_cli_traverse_objects, "List PJSIP Contacts",
910                 .command = "pjsip list contacts",
911                 .usage = "Usage: pjsip list contacts\n"
912                                  "       List the configured PJSIP contacts\n"),
913         AST_CLI_DEFINE(ast_sip_cli_traverse_objects, "Show PJSIP Contacts",
914                 .command = "pjsip show contacts",
915                 .usage = "Usage: pjsip show contacts\n"
916                                  "       Show the configured PJSIP contacts\n"),
917         AST_CLI_DEFINE(ast_sip_cli_traverse_objects, "Show PJSIP Contact",
918                 .command = "pjsip show contact",
919                 .usage = "Usage: pjsip show contact\n"
920                                  "       Show the configured PJSIP contact\n"),
921 };
922
923 struct ast_sip_cli_formatter_entry *contact_formatter;
924 struct ast_sip_cli_formatter_entry *aor_formatter;
925
926 /*! \brief Always create a contact_status for each contact */
927 static int contact_apply_handler(const struct ast_sorcery *sorcery, void *object)
928 {
929         struct ast_sip_contact_status *status;
930         struct ast_sip_contact *contact = object;
931
932         status = ast_res_pjsip_find_or_create_contact_status(contact);
933         ao2_cleanup(status);
934
935         return status ? 0 : -1;
936 }
937
938 /*! \brief Initialize sorcery with location support */
939 int ast_sip_initialize_sorcery_location(void)
940 {
941         struct ast_sorcery *sorcery = ast_sip_get_sorcery();
942         ast_sorcery_apply_default(sorcery, "contact", "astdb", "registrar");
943         ast_sorcery_apply_default(sorcery, "aor", "config", "pjsip.conf,criteria=type=aor");
944
945         if (ast_sorcery_object_register(sorcery, "contact", contact_alloc, NULL, contact_apply_handler) ||
946                 ast_sorcery_object_register(sorcery, "aor", aor_alloc, NULL, NULL)) {
947                 return -1;
948         }
949
950         ast_sorcery_observer_add(sorcery, "aor", &aor_observer);
951
952         ast_sorcery_object_field_register(sorcery, "contact", "type", "", OPT_NOOP_T, 0, 0);
953         ast_sorcery_object_field_register(sorcery, "contact", "uri", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, uri));
954         ast_sorcery_object_field_register(sorcery, "contact", "path", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, path));
955         ast_sorcery_object_field_register_custom(sorcery, "contact", "expiration_time", "", expiration_str2struct, expiration_struct2str, NULL, 0, 0);
956         ast_sorcery_object_field_register(sorcery, "contact", "qualify_frequency", 0, OPT_UINT_T,
957                 PARSE_IN_RANGE, FLDSET(struct ast_sip_contact, qualify_frequency), 0, 86400);
958         ast_sorcery_object_field_register(sorcery, "contact", "qualify_timeout", "3.0", OPT_DOUBLE_T, 0, FLDSET(struct ast_sip_contact, qualify_timeout));
959         ast_sorcery_object_field_register(sorcery, "contact", "outbound_proxy", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, outbound_proxy));
960         ast_sorcery_object_field_register(sorcery, "contact", "user_agent", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, user_agent));
961
962         ast_sorcery_object_field_register(sorcery, "aor", "type", "", OPT_NOOP_T, 0, 0);
963         ast_sorcery_object_field_register(sorcery, "aor", "minimum_expiration", "60", OPT_UINT_T, 0, FLDSET(struct ast_sip_aor, minimum_expiration));
964         ast_sorcery_object_field_register(sorcery, "aor", "maximum_expiration", "7200", OPT_UINT_T, 0, FLDSET(struct ast_sip_aor, maximum_expiration));
965         ast_sorcery_object_field_register(sorcery, "aor", "default_expiration", "3600", OPT_UINT_T, 0, FLDSET(struct ast_sip_aor, default_expiration));
966         ast_sorcery_object_field_register(sorcery, "aor", "qualify_frequency", 0, OPT_UINT_T, PARSE_IN_RANGE, FLDSET(struct ast_sip_aor, qualify_frequency), 0, 86400);
967         ast_sorcery_object_field_register(sorcery, "aor", "qualify_timeout", "3.0", OPT_DOUBLE_T, 0, FLDSET(struct ast_sip_aor, qualify_timeout));
968         ast_sorcery_object_field_register(sorcery, "aor", "authenticate_qualify", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_aor, authenticate_qualify));
969         ast_sorcery_object_field_register(sorcery, "aor", "max_contacts", "0", OPT_UINT_T, 0, FLDSET(struct ast_sip_aor, max_contacts));
970         ast_sorcery_object_field_register(sorcery, "aor", "remove_existing", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_aor, remove_existing));
971         ast_sorcery_object_field_register_custom(sorcery, "aor", "contact", "", permanent_uri_handler, contacts_to_str, contacts_to_var_list, 0, 0);
972         ast_sorcery_object_field_register(sorcery, "aor", "mailboxes", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_aor, mailboxes));
973         ast_sorcery_object_field_register(sorcery, "aor", "outbound_proxy", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_aor, outbound_proxy));
974         ast_sorcery_object_field_register(sorcery, "aor", "support_path", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_aor, support_path));
975
976         internal_sip_register_endpoint_formatter(&endpoint_aor_formatter);
977
978         contact_formatter = ao2_alloc(sizeof(struct ast_sip_cli_formatter_entry), NULL);
979         if (!contact_formatter) {
980                 ast_log(LOG_ERROR, "Unable to allocate memory for contact_formatter\n");
981                 return -1;
982         }
983         contact_formatter->name = "contact";
984         contact_formatter->print_header = cli_contact_print_header;
985         contact_formatter->print_body = cli_contact_print_body;
986         contact_formatter->get_container = cli_contact_get_container;
987         contact_formatter->iterate = cli_contact_iterate;
988         contact_formatter->get_id = cli_contact_get_id;
989         contact_formatter->retrieve_by_id = cli_contact_retrieve_by_id;
990
991         aor_formatter = ao2_alloc(sizeof(struct ast_sip_cli_formatter_entry), NULL);
992         if (!aor_formatter) {
993                 ast_log(LOG_ERROR, "Unable to allocate memory for aor_formatter\n");
994                 return -1;
995         }
996         aor_formatter->name = "aor";
997         aor_formatter->print_header = cli_aor_print_header;
998         aor_formatter->print_body = cli_aor_print_body;
999         aor_formatter->get_container = cli_aor_get_container;
1000         aor_formatter->iterate = cli_aor_iterate;
1001         aor_formatter->get_id = cli_aor_get_id;
1002         aor_formatter->retrieve_by_id = cli_aor_retrieve_by_id;
1003
1004         ast_sip_register_cli_formatter(contact_formatter);
1005         ast_sip_register_cli_formatter(aor_formatter);
1006         ast_cli_register_multiple(cli_commands, ARRAY_LEN(cli_commands));
1007
1008         return 0;
1009 }
1010
1011 int ast_sip_destroy_sorcery_location(void)
1012 {
1013         ast_sorcery_observer_remove(ast_sip_get_sorcery(), "aor", &aor_observer);
1014         ast_cli_unregister_multiple(cli_commands, ARRAY_LEN(cli_commands));
1015         ast_sip_unregister_cli_formatter(contact_formatter);
1016         ast_sip_unregister_cli_formatter(aor_formatter);
1017
1018         internal_sip_unregister_endpoint_formatter(&endpoint_aor_formatter);
1019
1020         return 0;
1021 }
1022