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