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