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