Allow for multiple contacts to be configured in a single contact= line.
[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         char *contacts = ast_strdupa(var->value);
294         char *contact_uri;
295
296         while ((contact_uri = strsep(&contacts, ","))) {
297                 struct ast_sip_contact *contact;
298                 char contact_id[strlen(aor_id) + strlen(contact_uri) + 2 + 1];
299
300                 if (ast_sip_push_task_synchronous(NULL, permanent_contact_validate, contact_uri)) {
301                         ast_log(LOG_ERROR, "Permanent URI on aor '%s' with contact '%s' failed to parse\n",
302                                 ast_sorcery_object_get_id(aor), contact_uri);
303                         return -1;
304                 }
305
306                 if (!aor->permanent_contacts) {
307                         aor->permanent_contacts = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK,
308                                 AO2_CONTAINER_ALLOC_OPT_DUPS_REJECT, permanent_uri_sort_fn, NULL);
309                         if (!aor->permanent_contacts) {
310                                 return -1;
311                         }
312                 }
313
314                 snprintf(contact_id, sizeof(contact_id), "%s@@%s", aor_id, contact_uri);
315                 contact = ast_sorcery_alloc(ast_sip_get_sorcery(), "contact", contact_id);
316                 if (!contact) {
317                         return -1;
318                 }
319
320                 ast_string_field_set(contact, uri, contact_uri);
321                 ao2_link(aor->permanent_contacts, contact);
322                 ao2_ref(contact, -1);
323         }
324
325         return 0;
326 }
327
328 static int contact_to_var_list(void *object, void *arg, int flags)
329 {
330         struct ast_sip_contact_wrapper *wrapper = object;
331         struct ast_variable **var = arg;
332
333         ast_variable_list_append(&*var, ast_variable_new("contact", wrapper->contact->uri, ""));
334
335         return 0;
336 }
337
338 static int contacts_to_var_list(const void *obj, struct ast_variable **fields)
339 {
340         const struct ast_sip_aor *aor = obj;
341
342         ast_sip_for_each_contact(aor, contact_to_var_list, fields);
343
344         return 0;
345 }
346
347 int ast_sip_for_each_aor(const char *aors, ao2_callback_fn on_aor, void *arg)
348 {
349         char *copy, *name;
350
351         if (!on_aor || ast_strlen_zero(aors)) {
352                 return 0;
353         }
354
355         copy = ast_strdupa(aors);
356         while ((name = strsep(&copy, ","))) {
357                 RAII_VAR(struct ast_sip_aor *, aor,
358                          ast_sip_location_retrieve_aor(name), ao2_cleanup);
359
360                 if (!aor) {
361                         continue;
362                 }
363
364                 if (on_aor(aor, arg, 0)) {
365                         return -1;
366                 }
367         }
368         ast_free(copy);
369         return 0;
370 }
371
372 static void contact_wrapper_destroy(void *obj)
373 {
374         struct ast_sip_contact_wrapper *wrapper = obj;
375         ast_free(wrapper->aor_id);
376         ast_free(wrapper->contact_id);
377         ao2_ref(wrapper->contact, -1);
378 }
379
380 int ast_sip_for_each_contact(const struct ast_sip_aor *aor,
381                 ao2_callback_fn on_contact, void *arg)
382 {
383         RAII_VAR(struct ao2_container *, contacts, NULL, ao2_cleanup);
384         struct ao2_iterator i;
385         int res = 0;
386         void *object = NULL;
387
388         if (!on_contact ||
389             !(contacts = ast_sip_location_retrieve_aor_contacts(aor))) {
390                 return 0;
391         }
392
393         i = ao2_iterator_init(contacts, 0);
394         while ((object = ao2_iterator_next(&i))) {
395                 RAII_VAR(struct ast_sip_contact *, contact, object, ao2_cleanup);
396                 RAII_VAR(struct ast_sip_contact_wrapper *, wrapper, NULL, ao2_cleanup);
397                 const char *aor_id = ast_sorcery_object_get_id(aor);
398
399                 wrapper = ao2_alloc(sizeof(struct ast_sip_contact_wrapper), contact_wrapper_destroy);
400                 if (!wrapper) {
401                         res = -1;
402                         break;
403                 }
404                 wrapper->contact_id = ast_malloc(strlen(aor_id) + strlen(contact->uri) + 2);
405                 if (!wrapper->contact_id) {
406                         res = -1;
407                         break;
408                 }
409                 sprintf(wrapper->contact_id, "%s/%s", aor_id, contact->uri);
410                 wrapper->aor_id = ast_strdup(aor_id);
411                 if (!wrapper->aor_id) {
412                         res = -1;
413                         break;
414                 }
415                 wrapper->contact = contact;
416                 ao2_bump(wrapper->contact);
417
418                 if ((res = on_contact(wrapper, arg, 0))) {
419                         break;
420                 }
421         }
422         ao2_iterator_destroy(&i);
423         return res;
424 }
425
426 int ast_sip_contact_to_str(void *object, void *arg, int flags)
427 {
428         struct ast_sip_contact_wrapper *wrapper = object;
429         struct ast_str **buf = arg;
430
431         ast_str_append(buf, 0, "%s,", wrapper->contact_id);
432
433         return 0;
434 }
435
436 static int sip_aor_to_ami(const struct ast_sip_aor *aor, struct ast_str **buf)
437 {
438         RAII_VAR(struct ast_variable *, objset, ast_sorcery_objectset_create2(
439                          ast_sip_get_sorcery(), aor, AST_HANDLER_ONLY_STRING), ast_variables_destroy);
440         struct ast_variable *i;
441
442         if (!objset) {
443                 return -1;
444         }
445
446         ast_str_append(buf, 0, "ObjectType: %s\r\n",
447                        ast_sorcery_object_get_type(aor));
448         ast_str_append(buf, 0, "ObjectName: %s\r\n",
449                        ast_sorcery_object_get_id(aor));
450
451         for (i = objset; i; i = i->next) {
452                 char *camel = ast_to_camel_case(i->name);
453                 if (strcmp(camel, "Contact") == 0) {
454                         ast_free(camel);
455                         camel = NULL;
456                 }
457                 ast_str_append(buf, 0, "%s: %s\r\n", S_OR(camel, "Contacts"), i->value);
458                 ast_free(camel);
459         }
460
461         return 0;
462 }
463
464 static int contacts_to_str(const void *obj, const intptr_t *args, char **buf)
465 {
466         const struct ast_sip_aor *aor = obj;
467         RAII_VAR(struct ast_str *, str, ast_str_create(MAX_OBJECT_FIELD), ast_free);
468
469         ast_sip_for_each_contact(aor, ast_sip_contact_to_str, &str);
470         ast_str_truncate(str, -1);
471
472         *buf = ast_strdup(ast_str_buffer(str));
473         if (!*buf) {
474                 return -1;
475         }
476
477         return 0;
478 }
479
480 static int format_ami_aor_handler(void *obj, void *arg, int flags)
481 {
482         struct ast_sip_aor *aor = obj;
483         struct ast_sip_ami *ami = arg;
484         const struct ast_sip_endpoint *endpoint = ami->arg;
485         RAII_VAR(struct ast_str *, buf,
486                  ast_sip_create_ami_event("AorDetail", ami), ast_free);
487
488         int total_contacts;
489         int num_permanent;
490         RAII_VAR(struct ao2_container *, contacts,
491                  ast_sip_location_retrieve_aor_contacts(aor), ao2_cleanup);
492
493         if (!buf) {
494                 return -1;
495         }
496
497         sip_aor_to_ami(aor, &buf);
498         total_contacts = ao2_container_count(contacts);
499         num_permanent = aor->permanent_contacts ?
500                 ao2_container_count(aor->permanent_contacts) : 0;
501
502         ast_str_append(&buf, 0, "TotalContacts: %d\r\n", total_contacts);
503         ast_str_append(&buf, 0, "ContactsRegistered: %d\r\n",
504                        total_contacts - num_permanent);
505         ast_str_append(&buf, 0, "EndpointName: %s\r\n",
506                        ast_sorcery_object_get_id(endpoint));
507
508         astman_append(ami->s, "%s\r\n", ast_str_buffer(buf));
509         return 0;
510 }
511
512 static int format_ami_endpoint_aor(const struct ast_sip_endpoint *endpoint,
513                                    struct ast_sip_ami *ami)
514 {
515         ami->arg = (void *)endpoint;
516         return ast_sip_for_each_aor(endpoint->aors,
517                                     format_ami_aor_handler, ami);
518 }
519
520 struct ast_sip_endpoint_formatter endpoint_aor_formatter = {
521         .format_ami = format_ami_endpoint_aor
522 };
523
524 static struct ao2_container *cli_aor_get_container(void)
525 {
526         RAII_VAR(struct ao2_container *, container, NULL, ao2_cleanup);
527         struct ao2_container *s_container;
528
529         container = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), "aor",
530                 AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);
531         if (!container) {
532                 return NULL;
533         }
534
535         s_container = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK, 0,
536                 ast_sorcery_object_id_sort, ast_sorcery_object_id_compare);
537         if (!s_container) {
538                 return NULL;
539         }
540
541         if (ao2_container_dup(s_container, container, 0)) {
542                 ao2_ref(s_container, -1);
543                 return NULL;
544         }
545
546         return s_container;
547 }
548
549 static int cli_contact_populate_container(void *obj, void *arg, int flags)
550 {
551         ao2_link(arg, obj);
552
553         return 0;
554 }
555
556 static int cli_aor_gather_contacts(void *obj, void *arg, int flags)
557 {
558         struct ast_sip_aor *aor = obj;
559
560         return ast_sip_for_each_contact(aor, cli_contact_populate_container, arg);
561 }
562
563 static const char *cli_contact_get_id(const void *obj)
564 {
565         const struct ast_sip_contact_wrapper *wrapper = obj;
566         return wrapper->contact_id;
567 }
568
569 static int cli_contact_sort(const void *obj, const void *arg, int flags)
570 {
571         const struct ast_sip_contact_wrapper *left_wrapper = obj;
572         const struct ast_sip_contact_wrapper *right_wrapper = arg;
573         const char *right_key = arg;
574         int cmp = 0;
575
576         switch (flags & OBJ_SEARCH_MASK) {
577         case OBJ_SEARCH_OBJECT:
578                 right_key = right_wrapper->contact_id;
579                 /* Fall through */
580         case OBJ_SEARCH_KEY:
581                 cmp = strcmp(left_wrapper->contact_id, right_key);
582                 break;
583         case OBJ_SEARCH_PARTIAL_KEY:
584                 cmp = strncmp(left_wrapper->contact_id, right_key, strlen(right_key));
585                 break;
586         default:
587                 cmp = 0;
588                 break;
589         }
590
591         return cmp;
592 }
593
594 static int cli_contact_compare(void *obj, void *arg, int flags)
595 {
596         const struct ast_sip_contact_wrapper *left_wrapper = obj;
597         const struct ast_sip_contact_wrapper *right_wrapper = arg;
598         const char *right_key = arg;
599         int cmp = 0;
600
601         switch (flags & OBJ_SEARCH_MASK) {
602         case OBJ_SEARCH_OBJECT:
603                 right_key = right_wrapper->contact_id;
604                 /* Fall through */
605         case OBJ_SEARCH_KEY:
606                 if (strcmp(left_wrapper->contact_id, right_key) == 0) {;
607                         cmp = CMP_MATCH | CMP_STOP;
608                 }
609                 break;
610         case OBJ_SEARCH_PARTIAL_KEY:
611                 if (strncmp(left_wrapper->contact_id, right_key, strlen(right_key)) == 0) {
612                         cmp = CMP_MATCH;
613                 }
614                 break;
615         default:
616                 cmp = 0;
617                 break;
618         }
619
620         return cmp;
621 }
622
623 static int cli_contact_hash(const void *obj, int flags)
624 {
625         const struct ast_sip_contact_wrapper *wrapper = obj;
626         if (flags & OBJ_SEARCH_OBJECT) {
627                 return ast_str_hash(wrapper->contact_id);
628         } else if (flags & OBJ_SEARCH_KEY) {
629                 return ast_str_hash(obj);
630         }
631
632         return -1;
633 }
634
635 static int cli_contact_iterate(void *container, ao2_callback_fn callback, void *args)
636 {
637         return ast_sip_for_each_contact(container, callback, args);
638 }
639
640 static struct ao2_container *cli_contact_get_container(void)
641 {
642         RAII_VAR(struct ao2_container *, parent_container, NULL, ao2_cleanup);
643         struct ao2_container *child_container;
644
645         parent_container =  cli_aor_get_container();
646         if (!parent_container) {
647                 return NULL;
648         }
649
650         child_container = ao2_container_alloc_hash(AO2_ALLOC_OPT_LOCK_NOLOCK, 0, 17,
651                 cli_contact_hash, cli_contact_sort, cli_contact_compare);
652         if (!child_container) {
653                 return NULL;
654         }
655
656         ao2_callback(parent_container, OBJ_NODATA, cli_aor_gather_contacts, child_container);
657
658         return child_container;
659 }
660
661 static void *cli_contact_retrieve_by_id(const char *id)
662 {
663         return ao2_find(cli_contact_get_container(), id, OBJ_KEY | OBJ_NOLOCK);
664 }
665
666 static int cli_contact_print_header(void *obj, void *arg, int flags)
667 {
668         struct ast_sip_cli_context *context = arg;
669         int indent = CLI_INDENT_TO_SPACES(context->indent_level);
670         int filler = CLI_LAST_TABSTOP - indent - 18;
671
672         ast_assert(context->output_buffer != NULL);
673
674         ast_str_append(&context->output_buffer, 0,
675                 "%*s:  <Aor/ContactUri%*.*s>  <Status....>  <RTT(ms)..>\n",
676                 indent, "Contact", filler, filler, CLI_HEADER_FILLER);
677
678         return 0;
679 }
680
681 static int cli_contact_print_body(void *obj, void *arg, int flags)
682 {
683         struct ast_sip_contact_wrapper *wrapper = obj;
684         struct ast_sip_contact *contact = wrapper->contact;
685         struct ast_sip_cli_context *context = arg;
686         int indent;
687         int flexwidth;
688
689         RAII_VAR(struct ast_sip_contact_status *, status,
690                 ast_sorcery_retrieve_by_id( ast_sip_get_sorcery(), CONTACT_STATUS, ast_sorcery_object_get_id(contact)),
691                 ao2_cleanup);
692
693         ast_assert(contact->uri != NULL);
694         ast_assert(context->output_buffer != NULL);
695
696         indent = CLI_INDENT_TO_SPACES(context->indent_level);
697         flexwidth = CLI_LAST_TABSTOP - indent - 2;
698
699         ast_str_append(&context->output_buffer, 0, "%*s:  %-*.*s  %-12.12s  %11.3f\n",
700                 indent,
701                 "Contact",
702                 flexwidth, flexwidth,
703                 wrapper->contact_id,
704                 (status ? (status->status == AVAILABLE ? "Avail" : "Unavail") : "Unknown"),
705                 (status ? ((long long) status->rtt) / 1000.0 : NAN));
706
707         return 0;
708 }
709
710 static int cli_aor_iterate(void *container, ao2_callback_fn callback, void *args)
711 {
712         const char *aor_list = container;
713
714         return ast_sip_for_each_aor(aor_list, callback, args);
715 }
716
717 static void *cli_aor_retrieve_by_id(const char *id)
718 {
719         return ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "aor", id);
720 }
721
722 static const char *cli_aor_get_id(const void *obj)
723 {
724         return ast_sorcery_object_get_id(obj);
725 }
726
727 static int cli_aor_print_header(void *obj, void *arg, int flags)
728 {
729         struct ast_sip_cli_context *context = arg;
730         RAII_VAR(struct ast_sip_cli_formatter_entry *, formatter_entry, NULL, ao2_cleanup);
731
732         int indent = CLI_INDENT_TO_SPACES(context->indent_level);
733         int filler = CLI_LAST_TABSTOP - indent - 7;
734
735         ast_assert(context->output_buffer != NULL);
736
737         ast_str_append(&context->output_buffer, 0,
738                 "%*s:  <Aor%*.*s>  <MaxContact>\n",
739                 indent, "Aor", filler, filler, CLI_HEADER_FILLER);
740
741         if (context->recurse) {
742                 context->indent_level++;
743                 formatter_entry = ast_sip_lookup_cli_formatter("contact");
744                 if (formatter_entry) {
745                         formatter_entry->print_header(NULL, context, 0);
746                 }
747                 context->indent_level--;
748         }
749
750         return 0;
751 }
752
753 static int cli_aor_print_body(void *obj, void *arg, int flags)
754 {
755         struct ast_sip_aor *aor = obj;
756         struct ast_sip_cli_context *context = arg;
757         RAII_VAR(struct ast_sip_cli_formatter_entry *, formatter_entry, NULL, ao2_cleanup);
758         int indent;
759         int flexwidth;
760
761         ast_assert(context->output_buffer != NULL);
762
763 //      context->current_aor = aor;
764
765         indent = CLI_INDENT_TO_SPACES(context->indent_level);
766         flexwidth = CLI_LAST_TABSTOP - indent - 12;
767
768         ast_str_append(&context->output_buffer, 0, "%*s:  %-*.*s %12d\n",
769                 indent,
770                 "Aor",
771                 flexwidth, flexwidth,
772                 ast_sorcery_object_get_id(aor), aor->max_contacts);
773
774         if (context->recurse) {
775                 context->indent_level++;
776
777                 formatter_entry = ast_sip_lookup_cli_formatter("contact");
778                 if (formatter_entry) {
779                         formatter_entry->iterate(aor, formatter_entry->print_body, context);
780                 }
781
782                 context->indent_level--;
783
784                 if (context->indent_level == 0) {
785                         ast_str_append(&context->output_buffer, 0, "\n");
786                 }
787         }
788
789         if (context->show_details || (context->show_details_only_level_0 && context->indent_level == 0)) {
790                 ast_str_append(&context->output_buffer, 0, "\n");
791                 ast_sip_cli_print_sorcery_objectset(aor, context, 0);
792         }
793
794         return 0;
795 }
796
797 static struct ast_cli_entry cli_commands[] = {
798         AST_CLI_DEFINE(ast_sip_cli_traverse_objects, "List PJSIP Aors",
799                 .command = "pjsip list aors",
800                 .usage = "Usage: pjsip list aors\n"
801                                  "       List the configured PJSIP Aors\n"),
802         AST_CLI_DEFINE(ast_sip_cli_traverse_objects, "Show PJSIP Aors",
803                 .command = "pjsip show aors",
804                 .usage = "Usage: pjsip show aors\n"
805                                  "       Show the configured PJSIP Aors\n"),
806         AST_CLI_DEFINE(ast_sip_cli_traverse_objects, "Show PJSIP Aor",
807                 .command = "pjsip show aor",
808                 .usage = "Usage: pjsip show aor <id>\n"
809                                  "       Show the configured PJSIP Aor\n"),
810
811         AST_CLI_DEFINE(ast_sip_cli_traverse_objects, "List PJSIP Contacts",
812                 .command = "pjsip list contacts",
813                 .usage = "Usage: pjsip list contacts\n"
814                                  "       List the configured PJSIP contacts\n"),
815         AST_CLI_DEFINE(ast_sip_cli_traverse_objects, "Show PJSIP Contacts",
816                 .command = "pjsip show contacts",
817                 .usage = "Usage: pjsip show contacts\n"
818                                  "       Show the configured PJSIP contacts\n"),
819         AST_CLI_DEFINE(ast_sip_cli_traverse_objects, "Show PJSIP Contact",
820                 .command = "pjsip show contact",
821                 .usage = "Usage: pjsip show contact\n"
822                                  "       Show the configured PJSIP contact\n"),
823 };
824
825 struct ast_sip_cli_formatter_entry *contact_formatter;
826 struct ast_sip_cli_formatter_entry *aor_formatter;
827
828 /*! \brief Initialize sorcery with location support */
829 int ast_sip_initialize_sorcery_location(void)
830 {
831         struct ast_sorcery *sorcery = ast_sip_get_sorcery();
832         ast_sorcery_apply_default(sorcery, "contact", "astdb", "registrar");
833         ast_sorcery_apply_default(sorcery, "aor", "config", "pjsip.conf,criteria=type=aor");
834
835         if (ast_sorcery_object_register(sorcery, "contact", contact_alloc, NULL, NULL) ||
836                 ast_sorcery_object_register(sorcery, "aor", aor_alloc, NULL, NULL)) {
837                 return -1;
838         }
839
840         ast_sorcery_object_field_register(sorcery, "contact", "type", "", OPT_NOOP_T, 0, 0);
841         ast_sorcery_object_field_register(sorcery, "contact", "uri", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, uri));
842         ast_sorcery_object_field_register(sorcery, "contact", "path", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, path));
843         ast_sorcery_object_field_register_custom(sorcery, "contact", "expiration_time", "", expiration_str2struct, expiration_struct2str, NULL, 0, 0);
844         ast_sorcery_object_field_register(sorcery, "contact", "qualify_frequency", 0, OPT_UINT_T,
845                                           PARSE_IN_RANGE, FLDSET(struct ast_sip_contact, qualify_frequency), 0, 86400);
846         ast_sorcery_object_field_register(sorcery, "contact", "outbound_proxy", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, outbound_proxy));
847         ast_sorcery_object_field_register(sorcery, "contact", "user_agent", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, user_agent));
848
849         ast_sorcery_object_field_register(sorcery, "aor", "type", "", OPT_NOOP_T, 0, 0);
850         ast_sorcery_object_field_register(sorcery, "aor", "minimum_expiration", "60", OPT_UINT_T, 0, FLDSET(struct ast_sip_aor, minimum_expiration));
851         ast_sorcery_object_field_register(sorcery, "aor", "maximum_expiration", "7200", OPT_UINT_T, 0, FLDSET(struct ast_sip_aor, maximum_expiration));
852         ast_sorcery_object_field_register(sorcery, "aor", "default_expiration", "3600", OPT_UINT_T, 0, FLDSET(struct ast_sip_aor, default_expiration));
853         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);
854         ast_sorcery_object_field_register(sorcery, "aor", "authenticate_qualify", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_aor, authenticate_qualify));
855         ast_sorcery_object_field_register(sorcery, "aor", "max_contacts", "0", OPT_UINT_T, 0, FLDSET(struct ast_sip_aor, max_contacts));
856         ast_sorcery_object_field_register(sorcery, "aor", "remove_existing", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_aor, remove_existing));
857         ast_sorcery_object_field_register_custom(sorcery, "aor", "contact", "", permanent_uri_handler, contacts_to_str, contacts_to_var_list, 0, 0);
858         ast_sorcery_object_field_register(sorcery, "aor", "mailboxes", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_aor, mailboxes));
859         ast_sorcery_object_field_register(sorcery, "aor", "outbound_proxy", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_aor, outbound_proxy));
860         ast_sorcery_object_field_register(sorcery, "aor", "support_path", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_aor, support_path));
861
862         ast_sip_register_endpoint_formatter(&endpoint_aor_formatter);
863
864         contact_formatter = ao2_alloc(sizeof(struct ast_sip_cli_formatter_entry), NULL);
865         if (!contact_formatter) {
866                 ast_log(LOG_ERROR, "Unable to allocate memory for contact_formatter\n");
867                 return -1;
868         }
869         contact_formatter->name = "contact";
870         contact_formatter->print_header = cli_contact_print_header;
871         contact_formatter->print_body = cli_contact_print_body;
872         contact_formatter->get_container = cli_contact_get_container;
873         contact_formatter->iterate = cli_contact_iterate;
874         contact_formatter->get_id = cli_contact_get_id;
875         contact_formatter->retrieve_by_id = cli_contact_retrieve_by_id;
876
877         aor_formatter = ao2_alloc(sizeof(struct ast_sip_cli_formatter_entry), NULL);
878         if (!aor_formatter) {
879                 ast_log(LOG_ERROR, "Unable to allocate memory for aor_formatter\n");
880                 return -1;
881         }
882         aor_formatter->name = "aor";
883         aor_formatter->print_header = cli_aor_print_header;
884         aor_formatter->print_body = cli_aor_print_body;
885         aor_formatter->get_container = cli_aor_get_container;
886         aor_formatter->iterate = cli_aor_iterate;
887         aor_formatter->get_id = cli_aor_get_id;
888         aor_formatter->retrieve_by_id = cli_aor_retrieve_by_id;
889
890         ast_sip_register_cli_formatter(contact_formatter);
891         ast_sip_register_cli_formatter(aor_formatter);
892         ast_cli_register_multiple(cli_commands, ARRAY_LEN(cli_commands));
893
894         return 0;
895 }
896
897 int ast_sip_destroy_sorcery_location(void)
898 {
899         ast_cli_unregister_multiple(cli_commands, ARRAY_LEN(cli_commands));
900         ast_sip_unregister_cli_formatter(contact_formatter);
901         ast_sip_unregister_cli_formatter(aor_formatter);
902
903         return 0;
904 }
905