84f73c742bf4a107bbae88ea4fda4fddd4f728ef
[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/paths.h"
27 #include "asterisk/sorcery.h"
28 #include "asterisk/taskprocessor.h"
29 #include "include/res_pjsip_private.h"
30 #include "asterisk/res_pjsip_cli.h"
31 #include "asterisk/statsd.h"
32 #include "asterisk/named_locks.h"
33
34 #include "asterisk/res_pjproject.h"
35
36 static int pj_max_hostname = PJ_MAX_HOSTNAME;
37 static int pjsip_max_url_size = PJSIP_MAX_URL_SIZE;
38
39 /*! \brief Destructor for AOR */
40 static void aor_destroy(void *obj)
41 {
42         struct ast_sip_aor *aor = obj;
43
44         ao2_cleanup(aor->permanent_contacts);
45         ast_string_field_free_memory(aor);
46         ast_free(aor->voicemail_extension);
47 }
48
49 /*! \brief Allocator for AOR */
50 static void *aor_alloc(const char *name)
51 {
52         void *lock;
53         struct ast_sip_aor *aor;
54
55         lock = ast_named_lock_get(AST_NAMED_LOCK_TYPE_MUTEX, "aor", name);
56         if (!lock) {
57                 return NULL;
58         }
59
60         aor = ast_sorcery_lockable_alloc(sizeof(struct ast_sip_aor), aor_destroy, lock);
61         ao2_ref(lock, -1);
62
63         if (!aor) {
64                 return NULL;
65         }
66         ast_string_field_init(aor, 128);
67
68         return aor;
69 }
70
71 /*! \brief Internal callback function which destroys the specified contact */
72 static int destroy_contact(void *obj, void *arg, int flags)
73 {
74         struct ast_sip_contact *contact = obj;
75
76         ast_sip_location_delete_contact(contact);
77
78         return CMP_MATCH;
79 }
80
81 static void aor_deleted_observer(const void *object)
82 {
83         const struct ast_sip_aor *aor = object;
84         const char *aor_id = ast_sorcery_object_get_id(object);
85         /* Give enough space for ;@ at the end, since that is our object naming scheme */
86         size_t prefix_len = strlen(aor_id) + sizeof(";@") - 1;
87         char prefix[prefix_len + 1];
88         struct ao2_container *contacts;
89
90         if (aor->permanent_contacts) {
91                 ao2_callback(aor->permanent_contacts, OBJ_NODATA | OBJ_MULTIPLE | OBJ_UNLINK, destroy_contact, NULL);
92         }
93
94         sprintf(prefix, "%s;@", aor_id); /* Safe */
95         if (!(contacts = ast_sorcery_retrieve_by_prefix(ast_sip_get_sorcery(), "contact", prefix, prefix_len))) {
96                 return;
97         }
98         /* Destroy any contacts that may still exist that were made for this AoR */
99         ao2_callback(contacts, OBJ_NODATA | OBJ_MULTIPLE | OBJ_UNLINK, destroy_contact, NULL);
100
101         ao2_ref(contacts, -1);
102 }
103
104 /*! \brief Observer for contacts so state can be updated on respective endpoints */
105 static const struct ast_sorcery_observer aor_observer = {
106         .deleted = aor_deleted_observer,
107 };
108
109
110 /*! \brief Destructor for contact */
111 static void contact_destroy(void *obj)
112 {
113         struct ast_sip_contact *contact = obj;
114
115         ast_string_field_free_memory(contact);
116         ao2_cleanup(contact->endpoint);
117 }
118
119 /*! \brief Allocator for contact */
120 static void *contact_alloc(const char *name)
121 {
122         struct ast_sip_contact *contact = ast_sorcery_generic_alloc(sizeof(*contact), contact_destroy);
123         char *id = ast_strdupa(name);
124         char *aor = id;
125         char *aor_separator = NULL;
126
127         if (!contact) {
128                 return NULL;
129         }
130
131         if (ast_string_field_init(contact, 256)) {
132                 ao2_cleanup(contact);
133                 return NULL;
134         }
135
136         ast_string_field_init_extended(contact, endpoint_name);
137         ast_string_field_init_extended(contact, reg_server);
138         ast_string_field_init_extended(contact, via_addr);
139         ast_string_field_init_extended(contact, call_id);
140
141         /* Dynamic contacts are delimited with ";@" and static ones with "@@" */
142         if ((aor_separator = strstr(id, ";@")) || (aor_separator = strstr(id, "@@"))) {
143                 *aor_separator = '\0';
144         }
145         ast_assert(aor_separator != NULL);
146
147         ast_string_field_set(contact, aor, aor);
148
149         return contact;
150 }
151
152 struct ast_sip_aor *ast_sip_location_retrieve_aor(const char *aor_name)
153 {
154         return ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "aor", aor_name);
155 }
156
157 /*! \brief Internal callback function which deletes and unlinks any expired contacts */
158 static int contact_expire(void *obj, void *arg, int flags)
159 {
160         struct ast_sip_contact *contact = obj;
161
162         /* If the contact has not yet expired it is valid */
163         if (ast_tvdiff_ms(contact->expiration_time, ast_tvnow()) > 0) {
164                 return 0;
165         }
166
167         ast_sip_location_delete_contact(contact);
168
169         return CMP_MATCH;
170 }
171
172 /*! \brief Internal callback function which links static contacts into another container */
173 static int contact_link_static(void *obj, void *arg, int flags)
174 {
175         struct ao2_container *dest = arg;
176
177         ao2_link(dest, obj);
178         return 0;
179 }
180
181 /*! \brief Internal callback function which removes any contact which is unreachable */
182 static int contact_remove_unreachable(void *obj, void *arg, int flags)
183 {
184         struct ast_sip_contact *contact = obj;
185         struct ast_sip_contact_status *status;
186         int unreachable;
187
188         status = ast_res_pjsip_find_or_create_contact_status(contact);
189         if (!status) {
190                 return 0;
191         }
192
193         unreachable = (status->status == UNAVAILABLE);
194         ao2_ref(status, -1);
195
196         return unreachable ? CMP_MATCH : 0;
197 }
198
199 struct ast_sip_contact *ast_sip_location_retrieve_first_aor_contact(const struct ast_sip_aor *aor)
200 {
201         return ast_sip_location_retrieve_first_aor_contact_filtered(aor, AST_SIP_CONTACT_FILTER_DEFAULT);
202 }
203
204 struct ast_sip_contact *ast_sip_location_retrieve_first_aor_contact_filtered(const struct ast_sip_aor *aor,
205         unsigned int flags)
206 {
207         struct ao2_container *contacts;
208         struct ast_sip_contact *contact = NULL;
209
210         contacts = ast_sip_location_retrieve_aor_contacts_filtered(aor, flags);
211         if (contacts && ao2_container_count(contacts)) {
212                 /* Get the first AOR contact in the container. */
213                 contact = ao2_callback(contacts, 0, NULL, NULL);
214         }
215         ao2_cleanup(contacts);
216         return contact;
217 }
218
219 struct ao2_container *ast_sip_location_retrieve_aor_contacts_nolock(const struct ast_sip_aor *aor)
220 {
221         return ast_sip_location_retrieve_aor_contacts_nolock_filtered(aor, AST_SIP_CONTACT_FILTER_DEFAULT);
222 }
223
224 struct ao2_container *ast_sip_location_retrieve_aor_contacts_nolock_filtered(const struct ast_sip_aor *aor,
225         unsigned int flags)
226 {
227         /* Give enough space for ;@ at the end, since that is our object naming scheme */
228         size_t prefix_len = strlen(ast_sorcery_object_get_id(aor)) + sizeof(";@") - 1;
229         char prefix[prefix_len + 1];
230         struct ao2_container *contacts;
231
232         sprintf(prefix, "%s;@", ast_sorcery_object_get_id(aor)); /* Safe */
233         if (!(contacts = ast_sorcery_retrieve_by_prefix(ast_sip_get_sorcery(), "contact", prefix, prefix_len))) {
234                 return NULL;
235         }
236
237         /* Prune any expired contacts and delete them, we do this first because static contacts can never expire */
238         ao2_callback(contacts, OBJ_NODATA | OBJ_MULTIPLE | OBJ_UNLINK, contact_expire, NULL);
239
240         /* Add any permanent contacts from the AOR */
241         if (aor->permanent_contacts) {
242                 ao2_callback(aor->permanent_contacts, OBJ_NODATA, contact_link_static, contacts);
243         }
244
245         if (flags & AST_SIP_CONTACT_FILTER_REACHABLE) {
246                 ao2_callback(contacts, OBJ_NODATA | OBJ_MULTIPLE | OBJ_UNLINK, contact_remove_unreachable, NULL);
247         }
248
249         return contacts;
250 }
251
252 struct ao2_container *ast_sip_location_retrieve_aor_contacts(const struct ast_sip_aor *aor)
253 {
254         return ast_sip_location_retrieve_aor_contacts_filtered(aor, AST_SIP_CONTACT_FILTER_DEFAULT);
255 }
256
257 struct ao2_container *ast_sip_location_retrieve_aor_contacts_filtered(const struct ast_sip_aor *aor,
258         unsigned int flags)
259 {
260         struct ao2_container *contacts;
261
262         /* ao2_lock / ao2_unlock do not actually write aor since it has an ao2 lockobj. */
263         ao2_lock((void*)aor);
264         contacts = ast_sip_location_retrieve_aor_contacts_nolock_filtered(aor, flags);
265         ao2_unlock((void*)aor);
266
267         return contacts;
268 }
269
270
271 void ast_sip_location_retrieve_contact_and_aor_from_list(const char *aor_list, struct ast_sip_aor **aor,
272         struct ast_sip_contact **contact)
273 {
274         ast_sip_location_retrieve_contact_and_aor_from_list_filtered(aor_list, AST_SIP_CONTACT_FILTER_DEFAULT, aor, contact);
275 }
276
277 void ast_sip_location_retrieve_contact_and_aor_from_list_filtered(const char *aor_list, unsigned int flags,
278         struct ast_sip_aor **aor, struct ast_sip_contact **contact)
279 {
280         char *aor_name;
281         char *rest;
282
283         /* If the location is still empty we have nowhere to go */
284         if (ast_strlen_zero(aor_list) || !(rest = ast_strdupa(aor_list))) {
285                 ast_log(LOG_WARNING, "Unable to determine contacts from empty aor list\n");
286                 return;
287         }
288
289         *aor = NULL;
290         *contact = NULL;
291
292         while ((aor_name = ast_strip(strsep(&rest, ",")))) {
293                 *aor = ast_sip_location_retrieve_aor(aor_name);
294
295                 if (!(*aor)) {
296                         continue;
297                 }
298                 *contact = ast_sip_location_retrieve_first_aor_contact_filtered(*aor, flags);
299                 /* If a valid contact is available use its URI for dialing */
300                 if (*contact) {
301                         break;
302                 }
303
304                 ao2_ref(*aor, -1);
305                 *aor = NULL;
306         }
307 }
308
309 struct ast_sip_contact *ast_sip_location_retrieve_contact_from_aor_list(const char *aor_list)
310 {
311         struct ast_sip_aor *aor;
312         struct ast_sip_contact *contact;
313
314         ast_sip_location_retrieve_contact_and_aor_from_list(aor_list, &aor, &contact);
315
316         ao2_cleanup(aor);
317
318         return contact;
319 }
320
321 static int permanent_uri_sort_fn(const void *obj_left, const void *obj_right, int flags);
322 static int cli_contact_populate_container(void *obj, void *arg, int flags);
323
324 static int gather_contacts_for_aor(void *obj, void *arg, int flags)
325 {
326         struct ao2_container *aor_contacts;
327         struct ast_sip_aor *aor = obj;
328         struct ao2_container *container = arg;
329
330         aor_contacts = ast_sip_location_retrieve_aor_contacts(aor);
331         if (!aor_contacts) {
332                 return 0;
333         }
334         ao2_callback(aor_contacts, OBJ_MULTIPLE | OBJ_NODATA, cli_contact_populate_container,
335                 container);
336         ao2_ref(aor_contacts, -1);
337         return CMP_MATCH;
338 }
339
340 struct ao2_container *ast_sip_location_retrieve_contacts_from_aor_list(const char *aor_list)
341 {
342         struct ao2_container *contacts;
343
344         contacts = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK,
345                 AO2_CONTAINER_ALLOC_OPT_DUPS_REJECT, permanent_uri_sort_fn, NULL);
346         if (!contacts) {
347                 return NULL;
348         }
349
350         ast_sip_for_each_aor(aor_list, gather_contacts_for_aor, contacts);
351
352         return contacts;
353 }
354
355 struct ast_sip_contact *ast_sip_location_retrieve_contact(const char *contact_name)
356 {
357         return ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "contact", contact_name);
358 }
359
360 struct ast_sip_contact *ast_sip_location_create_contact(struct ast_sip_aor *aor,
361         const char *uri, struct timeval expiration_time, const char *path_info,
362         const char *user_agent, const char *via_addr, int via_port, const char *call_id,
363         int prune_on_boot, struct ast_sip_endpoint *endpoint)
364 {
365         struct ast_sip_contact *contact;
366         char name[MAX_OBJECT_FIELD * 2 + 3];
367         char hash[33];
368
369         ast_md5_hash(hash, uri);
370         snprintf(name, sizeof(name), "%s;@%s", ast_sorcery_object_get_id(aor), hash);
371
372         contact = ast_sorcery_alloc(ast_sip_get_sorcery(), "contact", name);
373         if (!contact) {
374                 return NULL;
375         }
376
377         ast_string_field_set(contact, uri, uri);
378         contact->expiration_time = expiration_time;
379         contact->qualify_frequency = aor->qualify_frequency;
380         contact->qualify_timeout = aor->qualify_timeout;
381         contact->authenticate_qualify = aor->authenticate_qualify;
382         if (path_info && aor->support_path) {
383                 ast_string_field_set(contact, path, path_info);
384         }
385
386         if (!ast_strlen_zero(aor->outbound_proxy)) {
387                 ast_string_field_set(contact, outbound_proxy, aor->outbound_proxy);
388         }
389
390         if (!ast_strlen_zero(user_agent)) {
391                 ast_string_field_set(contact, user_agent, user_agent);
392         }
393
394         if (!ast_strlen_zero(ast_config_AST_SYSTEM_NAME)) {
395                 ast_string_field_set(contact, reg_server, ast_config_AST_SYSTEM_NAME);
396         }
397
398         if (!ast_strlen_zero(via_addr)) {
399                 ast_string_field_set(contact, via_addr, via_addr);
400         }
401         contact->via_port = via_port;
402
403         if (!ast_strlen_zero(call_id)) {
404                 ast_string_field_set(contact, call_id, call_id);
405         }
406
407         contact->endpoint = ao2_bump(endpoint);
408         if (endpoint) {
409                 ast_string_field_set(contact, endpoint_name, ast_sorcery_object_get_id(endpoint));
410         }
411
412         contact->prune_on_boot = prune_on_boot;
413
414         if (ast_sorcery_create(ast_sip_get_sorcery(), contact)) {
415                 ao2_ref(contact, -1);
416                 return NULL;
417         }
418         return contact;
419 }
420
421 int ast_sip_location_add_contact_nolock(struct ast_sip_aor *aor, const char *uri,
422                 struct timeval expiration_time, const char *path_info, const char *user_agent,
423                 const char *via_addr, int via_port, const char *call_id,
424                 struct ast_sip_endpoint *endpoint)
425 {
426         struct ast_sip_contact *contact;
427
428         contact = ast_sip_location_create_contact(aor, uri, expiration_time, path_info,
429                 user_agent, via_addr, via_port, call_id, 0, endpoint);
430         ao2_cleanup(contact);
431         return contact ? 0 : -1;
432 }
433
434 int ast_sip_location_add_contact(struct ast_sip_aor *aor, const char *uri,
435                 struct timeval expiration_time, const char *path_info, const char *user_agent,
436                 const char *via_addr, int via_port, const char *call_id,
437                 struct ast_sip_endpoint *endpoint)
438 {
439         int res;
440
441         ao2_lock(aor);
442         res = ast_sip_location_add_contact_nolock(aor, uri, expiration_time, path_info, user_agent,
443                 via_addr, via_port, call_id,
444                 endpoint);
445         ao2_unlock(aor);
446
447         return res;
448 }
449
450 int ast_sip_location_update_contact(struct ast_sip_contact *contact)
451 {
452         return ast_sorcery_update(ast_sip_get_sorcery(), contact);
453 }
454
455 int ast_sip_location_delete_contact(struct ast_sip_contact *contact)
456 {
457         return ast_sorcery_delete(ast_sip_get_sorcery(), contact);
458 }
459
460 static int prune_boot_contacts_cb(void *obj, void *arg, int flags)
461 {
462         struct ast_sip_contact *contact = obj;
463
464         if (contact->prune_on_boot
465                 && !strcmp(contact->reg_server, ast_config_AST_SYSTEM_NAME ?: "")) {
466                 ast_verb(3, "Removed contact '%s' from AOR '%s' due to system boot\n",
467                         contact->uri, contact->aor);
468                 ast_sip_location_delete_contact(contact);
469         }
470
471         return 0;
472 }
473
474 void ast_sip_location_prune_boot_contacts(void)
475 {
476         struct ao2_container *contacts;
477
478         contacts = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), "contact",
479                 AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);
480         if (contacts) {
481                 ao2_callback(contacts, 0, prune_boot_contacts_cb, NULL);
482                 ao2_ref(contacts, -1);
483         }
484 }
485
486 /*! \brief Custom handler for translating from a string timeval to actual structure */
487 static int expiration_str2struct(const struct aco_option *opt, struct ast_variable *var, void *obj)
488 {
489         struct ast_sip_contact *contact = obj;
490         return ast_get_timeval(var->value, &contact->expiration_time, ast_tv(0, 0), NULL);
491 }
492
493 /*! \brief Custom handler for translating from an actual structure timeval to string */
494 static int expiration_struct2str(const void *obj, const intptr_t *args, char **buf)
495 {
496         const struct ast_sip_contact *contact = obj;
497         return (ast_asprintf(buf, "%ld", contact->expiration_time.tv_sec) < 0) ? -1 : 0;
498 }
499
500 static int permanent_uri_sort_fn(const void *obj_left, const void *obj_right, int flags)
501 {
502         const struct ast_sip_contact *object_left = obj_left;
503         const struct ast_sip_contact *object_right = obj_right;
504         const char *right_key = obj_right;
505         int cmp;
506
507         switch (flags & OBJ_SEARCH_MASK) {
508         case OBJ_SEARCH_OBJECT:
509                 right_key = ast_sorcery_object_get_id(object_right);
510                 /* Fall through */
511         case OBJ_SEARCH_KEY:
512                 cmp = strcmp(ast_sorcery_object_get_id(object_left), right_key);
513                 break;
514         case OBJ_SEARCH_PARTIAL_KEY:
515                 /*
516                  * We could also use a partial key struct containing a length
517                  * so strlen() does not get called for every comparison instead.
518                  */
519                 cmp = strncmp(ast_sorcery_object_get_id(object_left), right_key, strlen(right_key));
520                 break;
521         default:
522                 /* Sort can only work on something with a full or partial key. */
523                 ast_assert(0);
524                 cmp = 0;
525                 break;
526         }
527         return cmp;
528 }
529
530 int ast_sip_validate_uri_length(const char *contact_uri)
531 {
532         int max_length = pj_max_hostname - 1;
533         char *contact = ast_strdupa(contact_uri);
534         char *host;
535         char *at;
536         int theres_a_port = 0;
537
538         if (strlen(contact_uri) > pjsip_max_url_size - 1) {
539                 return -1;
540         }
541
542         contact = ast_strip_quoted(contact, "<", ">");
543
544         if (!strncasecmp(contact, "sip:", 4)) {
545                 host = contact + 4;
546         } else if (!strncasecmp(contact, "sips:", 5)) {
547                 host = contact + 5;
548         } else {
549                 /* Not a SIP URI */
550                 return -1;
551         }
552
553         at = strchr(contact, '@');
554         if (at) {
555                 /* sip[s]:user@host */
556                 host = at + 1;
557         }
558
559         if (host[0] == '[') {
560                 /* Host is an IPv6 address. Just get up to the matching bracket */
561                 char *close_bracket;
562
563                 close_bracket = strchr(host, ']');
564                 if (!close_bracket) {
565                         return -1;
566                 }
567                 close_bracket++;
568                 if (*close_bracket == ':') {
569                         theres_a_port = 1;
570                 }
571                 *close_bracket = '\0';
572         } else {
573                 /* uri parameters could contain ';' so trim them off first */
574                 host = strsep(&host, ";?");
575                 /* Host is FQDN or IPv4 address. Need to find closing delimiter */
576                 if (strchr(host, ':')) {
577                         theres_a_port = 1;
578                         host = strsep(&host, ":");
579                 }
580         }
581
582         if (!theres_a_port) {
583                 max_length -= strlen("_sips.tcp.");
584         }
585
586         if (strlen(host) > max_length) {
587                 return -1;
588         }
589
590         return 0;
591 }
592
593 /*! \brief Custom handler for permanent URIs */
594 static int permanent_uri_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
595 {
596         struct ast_sip_aor *aor = obj;
597         const char *aor_id = ast_sorcery_object_get_id(aor);
598         char *contacts;
599         char *contact_uri;
600
601         if (ast_strlen_zero(var->value)) {
602                 return 0;
603         }
604
605         contacts = ast_strdupa(var->value);
606         while ((contact_uri = ast_strip(strsep(&contacts, ",")))) {
607                 struct ast_sip_contact *contact;
608                 struct ast_sip_contact_status *status;
609                 char hash[33];
610                 char contact_id[strlen(aor_id) + sizeof(hash) + 2];
611
612                 if (ast_strlen_zero(contact_uri)) {
613                         continue;
614                 }
615
616                 if (ast_sip_validate_uri_length(contact_uri)) {
617                         ast_log(LOG_ERROR, "Contact uri or hostname length exceeds pjproject limit or is not a sip(s) uri: %s\n", contact_uri);
618                         return -1;
619                 }
620
621                 if (!aor->permanent_contacts) {
622                         aor->permanent_contacts = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK,
623                                 AO2_CONTAINER_ALLOC_OPT_DUPS_REJECT, permanent_uri_sort_fn, NULL);
624                         if (!aor->permanent_contacts) {
625                                 return -1;
626                         }
627                 }
628
629                 ast_md5_hash(hash, contact_uri);
630                 snprintf(contact_id, sizeof(contact_id), "%s@@%s", aor_id, hash);
631                 contact = ast_sorcery_alloc(ast_sip_get_sorcery(), "contact", contact_id);
632                 if (!contact) {
633                         return -1;
634                 }
635
636                 ast_string_field_set(contact, uri, contact_uri);
637
638                 status = ast_res_pjsip_find_or_create_contact_status(contact);
639                 if (!status) {
640                         ao2_ref(contact, -1);
641                         return -1;
642                 }
643                 ao2_ref(status, -1);
644
645                 ao2_link(aor->permanent_contacts, contact);
646                 ao2_ref(contact, -1);
647         }
648
649         return 0;
650 }
651
652 static int contact_to_var_list(void *object, void *arg, int flags)
653 {
654         struct ast_sip_contact_wrapper *wrapper = object;
655         struct ast_variable **var = arg;
656
657         ast_variable_list_append(&*var, ast_variable_new("contact", wrapper->contact->uri, ""));
658
659         return 0;
660 }
661
662 static int contacts_to_var_list(const void *obj, struct ast_variable **fields)
663 {
664         const struct ast_sip_aor *aor = obj;
665
666         ast_sip_for_each_contact(aor, contact_to_var_list, fields);
667
668         return 0;
669 }
670
671 static int voicemail_extension_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
672 {
673         struct ast_sip_aor *aor = obj;
674
675         aor->voicemail_extension = ast_strdup(var->value);
676
677         return aor->voicemail_extension ? 0 : -1;
678 }
679
680 static int voicemail_extension_to_str(const void *obj, const intptr_t *args, char **buf)
681 {
682         const struct ast_sip_aor *aor = obj;
683
684         *buf = ast_strdup(aor->voicemail_extension);
685
686         return 0;
687 }
688
689 int ast_sip_for_each_aor(const char *aors, ao2_callback_fn on_aor, void *arg)
690 {
691         char *copy;
692         char *name;
693         int res;
694
695         if (!on_aor || ast_strlen_zero(aors)) {
696                 return 0;
697         }
698
699         copy = ast_strdupa(aors);
700         while ((name = ast_strip(strsep(&copy, ",")))) {
701                 struct ast_sip_aor *aor;
702
703                 aor = ast_sip_location_retrieve_aor(name);
704                 if (aor) {
705                         res = on_aor(aor, arg, 0);
706                         ao2_ref(aor, -1);
707                         if (res) {
708                                 return -1;
709                         }
710                 }
711         }
712         return 0;
713 }
714
715 static void contact_wrapper_destroy(void *obj)
716 {
717         struct ast_sip_contact_wrapper *wrapper = obj;
718
719         ast_free(wrapper->aor_id);
720         ast_free(wrapper->contact_id);
721         ao2_cleanup(wrapper->contact);
722 }
723
724 int ast_sip_for_each_contact(const struct ast_sip_aor *aor,
725                 ao2_callback_fn on_contact, void *arg)
726 {
727         struct ao2_container *contacts;
728         struct ao2_iterator i;
729         int res = 0;
730         void *object = NULL;
731
732         if (!on_contact ||
733             !(contacts = ast_sip_location_retrieve_aor_contacts(aor))) {
734                 return 0;
735         }
736
737         i = ao2_iterator_init(contacts, 0);
738         while ((object = ao2_iterator_next(&i))) {
739                 RAII_VAR(struct ast_sip_contact *, contact, object, ao2_cleanup);
740                 RAII_VAR(struct ast_sip_contact_wrapper *, wrapper, NULL, ao2_cleanup);
741                 const char *aor_id = ast_sorcery_object_get_id(aor);
742
743                 wrapper = ao2_alloc_options(sizeof(struct ast_sip_contact_wrapper),
744                         contact_wrapper_destroy, AO2_ALLOC_OPT_LOCK_NOLOCK);
745                 if (!wrapper) {
746                         res = -1;
747                         break;
748                 }
749                 wrapper->contact_id = ast_malloc(strlen(aor_id) + strlen(contact->uri) + 2);
750                 if (!wrapper->contact_id) {
751                         res = -1;
752                         break;
753                 }
754                 sprintf(wrapper->contact_id, "%s/%s", aor_id, contact->uri);
755                 wrapper->aor_id = ast_strdup(aor_id);
756                 if (!wrapper->aor_id) {
757                         res = -1;
758                         break;
759                 }
760                 wrapper->contact = contact;
761                 ao2_bump(wrapper->contact);
762
763                 if ((res = on_contact(wrapper, arg, 0))) {
764                         break;
765                 }
766         }
767         ao2_iterator_destroy(&i);
768         ao2_ref(contacts, -1);
769         return res;
770 }
771
772 int ast_sip_contact_to_str(void *object, void *arg, int flags)
773 {
774         struct ast_sip_contact_wrapper *wrapper = object;
775         struct ast_str **buf = arg;
776
777         ast_str_append(buf, 0, "%s,", wrapper->contact_id);
778
779         return 0;
780 }
781
782 static int sip_aor_to_ami(const struct ast_sip_aor *aor, struct ast_str **buf)
783 {
784         struct ast_variable *objset;
785         struct ast_variable *i;
786
787         objset = ast_sorcery_objectset_create2(ast_sip_get_sorcery(), aor,
788                 AST_HANDLER_ONLY_STRING);
789         if (!objset) {
790                 return -1;
791         }
792
793         ast_str_append(buf, 0, "ObjectType: %s\r\n",
794                        ast_sorcery_object_get_type(aor));
795         ast_str_append(buf, 0, "ObjectName: %s\r\n",
796                        ast_sorcery_object_get_id(aor));
797
798         for (i = objset; i; i = i->next) {
799                 char *camel = ast_to_camel_case(i->name);
800
801                 if (strcmp(camel, "Contact") == 0) {
802                         ast_free(camel);
803                         camel = NULL;
804                 }
805                 ast_str_append(buf, 0, "%s: %s\r\n", S_OR(camel, "Contacts"), i->value);
806                 ast_free(camel);
807         }
808
809         ast_variables_destroy(objset);
810         return 0;
811 }
812
813 static int contacts_to_str(const void *obj, const intptr_t *args, char **buf)
814 {
815         const struct ast_sip_aor *aor = obj;
816         struct ast_str *str;
817
818         str = ast_str_create(MAX_OBJECT_FIELD);
819         if (!str) {
820                 *buf = NULL;
821                 return -1;
822         }
823
824         ast_sip_for_each_contact(aor, ast_sip_contact_to_str, &str);
825         ast_str_truncate(str, -1);
826
827         *buf = ast_strdup(ast_str_buffer(str));
828         ast_free(str);
829
830         return *buf ? 0 : -1;
831 }
832
833 static int format_ami_aor_handler(void *obj, void *arg, int flags)
834 {
835         struct ast_sip_aor *aor = obj;
836         struct ast_sip_ami *ami = arg;
837         const struct ast_sip_endpoint *endpoint = ami->arg;
838         struct ast_str *buf;
839         struct ao2_container *contacts;
840         int total_contacts;
841         int num_permanent;
842
843         buf = ast_sip_create_ami_event("AorDetail", ami);
844         if (!buf) {
845                 return -1;
846         }
847         contacts = ast_sip_location_retrieve_aor_contacts(aor);
848         if (!contacts) {
849                 ast_free(buf);
850                 return -1;
851         }
852
853         sip_aor_to_ami(aor, &buf);
854         total_contacts = ao2_container_count(contacts);
855         num_permanent = aor->permanent_contacts ?
856                 ao2_container_count(aor->permanent_contacts) : 0;
857
858         ast_str_append(&buf, 0, "TotalContacts: %d\r\n", total_contacts);
859         ast_str_append(&buf, 0, "ContactsRegistered: %d\r\n",
860                        total_contacts - num_permanent);
861         ast_str_append(&buf, 0, "EndpointName: %s\r\n",
862                        ast_sorcery_object_get_id(endpoint));
863
864         astman_append(ami->s, "%s\r\n", ast_str_buffer(buf));
865         ami->count++;
866
867         ast_free(buf);
868         ao2_ref(contacts, -1);
869         return 0;
870 }
871
872 static int format_ami_endpoint_aor(const struct ast_sip_endpoint *endpoint,
873                                    struct ast_sip_ami *ami)
874 {
875         ami->arg = (void *)endpoint;
876         return ast_sip_for_each_aor(endpoint->aors,
877                                     format_ami_aor_handler, ami);
878 }
879
880 struct ast_sip_endpoint_formatter endpoint_aor_formatter = {
881         .format_ami = format_ami_endpoint_aor
882 };
883
884 static struct ao2_container *cli_aor_get_container(const char *regex)
885 {
886         struct ao2_container *container;
887         struct ao2_container *s_container;
888
889         container = ast_sorcery_retrieve_by_regex(ast_sip_get_sorcery(), "aor", regex);
890         if (!container) {
891                 return NULL;
892         }
893
894         /* Create a sorted container of aors. */
895         s_container = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK, 0,
896                 ast_sorcery_object_id_sort, ast_sorcery_object_id_compare);
897         if (s_container
898                 && ao2_container_dup(s_container, container, 0)) {
899                 ao2_ref(s_container, -1);
900                 s_container = NULL;
901         }
902         ao2_ref(container, -1);
903
904         return s_container;
905 }
906
907 static int cli_contact_populate_container(void *obj, void *arg, int flags)
908 {
909         ao2_link(arg, obj);
910
911         return 0;
912 }
913
914 static int cli_aor_gather_contacts(void *obj, void *arg, int flags)
915 {
916         struct ast_sip_aor *aor = obj;
917
918         return ast_sip_for_each_contact(aor, cli_contact_populate_container, arg);
919 }
920
921 static const char *cli_contact_get_id(const void *obj)
922 {
923         const struct ast_sip_contact_wrapper *wrapper = obj;
924         return wrapper->contact_id;
925 }
926
927 static int cli_contact_sort(const void *obj, const void *arg, int flags)
928 {
929         const struct ast_sip_contact_wrapper *left_wrapper = obj;
930         const struct ast_sip_contact_wrapper *right_wrapper = arg;
931         const char *right_key = arg;
932         int cmp = 0;
933
934         switch (flags & OBJ_SEARCH_MASK) {
935         case OBJ_SEARCH_OBJECT:
936                 right_key = right_wrapper->contact_id;
937                 /* Fall through */
938         case OBJ_SEARCH_KEY:
939                 cmp = strcmp(left_wrapper->contact_id, right_key);
940                 break;
941         case OBJ_SEARCH_PARTIAL_KEY:
942                 cmp = strncmp(left_wrapper->contact_id, right_key, strlen(right_key));
943                 break;
944         default:
945                 cmp = 0;
946                 break;
947         }
948
949         return cmp;
950 }
951
952 static int cli_contact_compare(void *obj, void *arg, int flags)
953 {
954         const struct ast_sip_contact_wrapper *left_wrapper = obj;
955         const struct ast_sip_contact_wrapper *right_wrapper = arg;
956         const char *right_key = arg;
957         int cmp = 0;
958
959         switch (flags & OBJ_SEARCH_MASK) {
960         case OBJ_SEARCH_OBJECT:
961                 right_key = right_wrapper->contact_id;
962                 /* Fall through */
963         case OBJ_SEARCH_KEY:
964                 if (strcmp(left_wrapper->contact_id, right_key) == 0) {;
965                         cmp = CMP_MATCH | CMP_STOP;
966                 }
967                 break;
968         case OBJ_SEARCH_PARTIAL_KEY:
969                 if (strncmp(left_wrapper->contact_id, right_key, strlen(right_key)) == 0) {
970                         cmp = CMP_MATCH;
971                 }
972                 break;
973         default:
974                 cmp = 0;
975                 break;
976         }
977
978         return cmp;
979 }
980
981 static int cli_contact_iterate(void *container, ao2_callback_fn callback, void *args)
982 {
983         return ast_sip_for_each_contact(container, callback, args);
984 }
985
986 static int cli_filter_contacts(void *obj, void *arg, int flags)
987 {
988         struct ast_sip_contact_wrapper *wrapper = obj;
989         regex_t *regexbuf = arg;
990
991         if (!regexec(regexbuf, wrapper->contact_id, 0, NULL, 0)) {
992                 return 0;
993         }
994
995         return CMP_MATCH;
996 }
997
998 static struct ao2_container *cli_contact_get_container(const char *regex)
999 {
1000         RAII_VAR(struct ao2_container *, parent_container, NULL, ao2_cleanup);
1001         struct ao2_container *child_container;
1002         regex_t regexbuf;
1003
1004         parent_container = cli_aor_get_container("");
1005         if (!parent_container) {
1006                 return NULL;
1007         }
1008
1009         child_container = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK, 0,
1010                 cli_contact_sort, cli_contact_compare);
1011         if (!child_container) {
1012                 return NULL;
1013         }
1014
1015         ao2_callback(parent_container, OBJ_NODATA, cli_aor_gather_contacts, child_container);
1016
1017         if (!ast_strlen_zero(regex)) {
1018                 if (regcomp(&regexbuf, regex, REG_EXTENDED | REG_NOSUB)) {
1019                         ao2_ref(child_container, -1);
1020                         return NULL;
1021                 }
1022                 ao2_callback(child_container, OBJ_UNLINK | OBJ_MULTIPLE | OBJ_NODATA, cli_filter_contacts, &regexbuf);
1023                 regfree(&regexbuf);
1024         }
1025
1026         return child_container;
1027 }
1028
1029 static void *cli_contact_retrieve_by_id(const char *id)
1030 {
1031         struct ao2_container *container;
1032         void *obj;
1033
1034         container = cli_contact_get_container("");
1035         if (!container) {
1036                 return NULL;
1037         }
1038
1039         obj = ao2_find(container, id, OBJ_SEARCH_KEY);
1040         ao2_ref(container, -1);
1041         return obj;
1042 }
1043
1044 static int cli_contact_print_header(void *obj, void *arg, int flags)
1045 {
1046         struct ast_sip_cli_context *context = arg;
1047         int indent = CLI_INDENT_TO_SPACES(context->indent_level);
1048         int filler = CLI_LAST_TABSTOP - indent - 23;
1049
1050         ast_assert(context->output_buffer != NULL);
1051
1052         ast_str_append(&context->output_buffer, 0,
1053                 "%*s:  <Aor/ContactUri%*.*s> <Hash....> <Status> <RTT(ms)..>\n",
1054                 indent, "Contact", filler, filler, CLI_HEADER_FILLER);
1055
1056         return 0;
1057 }
1058
1059 static int cli_contact_print_body(void *obj, void *arg, int flags)
1060 {
1061         struct ast_sip_contact_wrapper *wrapper = obj;
1062         struct ast_sip_contact *contact = wrapper->contact;
1063         struct ast_sip_cli_context *context = arg;
1064         int indent;
1065         int flexwidth;
1066         const char *contact_id = ast_sorcery_object_get_id(contact);
1067         const char *hash_start = contact_id + strlen(contact->aor) + 2;
1068         struct ast_sip_contact_status *status;
1069
1070         ast_assert(contact->uri != NULL);
1071         ast_assert(context->output_buffer != NULL);
1072
1073         status = ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), CONTACT_STATUS, contact_id);
1074
1075         indent = CLI_INDENT_TO_SPACES(context->indent_level);
1076         flexwidth = CLI_LAST_TABSTOP - indent - 9 - strlen(contact->aor) + 1;
1077
1078         ast_str_append(&context->output_buffer, 0, "%*s:  %s/%-*.*s %-10.10s %-7.7s %11.3f\n",
1079                 indent,
1080                 "Contact",
1081                 contact->aor,
1082                 flexwidth, flexwidth,
1083                 contact->uri,
1084                 hash_start,
1085                 ast_sip_get_contact_short_status_label(status ? status->status : UNKNOWN),
1086                 (status && (status->status != UNKNOWN) ? ((long long) status->rtt) / 1000.0 : NAN));
1087
1088         ao2_cleanup(status);
1089         return 0;
1090 }
1091
1092 static int cli_aor_iterate(void *container, ao2_callback_fn callback, void *args)
1093 {
1094         const char *aor_list = container;
1095
1096         return ast_sip_for_each_aor(aor_list, callback, args);
1097 }
1098
1099 static void *cli_aor_retrieve_by_id(const char *id)
1100 {
1101         return ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "aor", id);
1102 }
1103
1104 static const char *cli_aor_get_id(const void *obj)
1105 {
1106         return ast_sorcery_object_get_id(obj);
1107 }
1108
1109 static int cli_aor_print_header(void *obj, void *arg, int flags)
1110 {
1111         struct ast_sip_cli_context *context = arg;
1112         int indent = CLI_INDENT_TO_SPACES(context->indent_level);
1113         int filler = CLI_LAST_TABSTOP - indent - 7;
1114
1115         ast_assert(context->output_buffer != NULL);
1116
1117         ast_str_append(&context->output_buffer, 0,
1118                 "%*s:  <Aor%*.*s>  <MaxContact>\n",
1119                 indent, "Aor", filler, filler, CLI_HEADER_FILLER);
1120
1121         if (context->recurse) {
1122                 struct ast_sip_cli_formatter_entry *formatter_entry;
1123
1124                 context->indent_level++;
1125                 formatter_entry = ast_sip_lookup_cli_formatter("contact");
1126                 if (formatter_entry) {
1127                         formatter_entry->print_header(NULL, context, 0);
1128                         ao2_ref(formatter_entry, -1);
1129                 }
1130                 context->indent_level--;
1131         }
1132
1133         return 0;
1134 }
1135
1136 static int cli_aor_print_body(void *obj, void *arg, int flags)
1137 {
1138         struct ast_sip_aor *aor = obj;
1139         struct ast_sip_cli_context *context = arg;
1140         int indent;
1141         int flexwidth;
1142
1143         ast_assert(context->output_buffer != NULL);
1144
1145 //      context->current_aor = aor;
1146
1147         indent = CLI_INDENT_TO_SPACES(context->indent_level);
1148         flexwidth = CLI_LAST_TABSTOP - indent - 12;
1149
1150         ast_str_append(&context->output_buffer, 0, "%*s:  %-*.*s %12u\n",
1151                 indent,
1152                 "Aor",
1153                 flexwidth, flexwidth,
1154                 ast_sorcery_object_get_id(aor), aor->max_contacts);
1155
1156         if (context->recurse) {
1157                 struct ast_sip_cli_formatter_entry *formatter_entry;
1158
1159                 context->indent_level++;
1160
1161                 formatter_entry = ast_sip_lookup_cli_formatter("contact");
1162                 if (formatter_entry) {
1163                         formatter_entry->iterate(aor, formatter_entry->print_body, context);
1164                         ao2_ref(formatter_entry, -1);
1165                 }
1166
1167                 context->indent_level--;
1168
1169                 if (context->indent_level == 0) {
1170                         ast_str_append(&context->output_buffer, 0, "\n");
1171                 }
1172         }
1173
1174         if (context->show_details || (context->show_details_only_level_0 && context->indent_level == 0)) {
1175                 ast_str_append(&context->output_buffer, 0, "\n");
1176                 ast_sip_cli_print_sorcery_objectset(aor, context, 0);
1177         }
1178
1179         return 0;
1180 }
1181
1182 static struct ao2_container *cli_get_aors(void)
1183 {
1184         struct ao2_container *aors;
1185
1186         aors = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), "aor",
1187                         AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);
1188
1189         return aors;
1190 }
1191
1192 static int format_ami_aorlist_handler(void *obj, void *arg, int flags)
1193 {
1194         struct ast_sip_aor *aor = obj;
1195         struct ast_sip_ami *ami = arg;
1196         struct ast_str *buf;
1197
1198         buf = ast_sip_create_ami_event("AorList", ami);
1199         if (!buf) {
1200                 return -1;
1201         }
1202
1203         sip_aor_to_ami(aor, &buf);
1204
1205         astman_append(ami->s, "%s\r\n", ast_str_buffer(buf));
1206         ami->count++;
1207
1208         ast_free(buf);
1209
1210         return 0;
1211 }
1212
1213 static int ami_show_aors(struct mansession *s, const struct message *m)
1214 {
1215         struct ast_sip_ami ami = { .s = s, .m = m, .action_id = astman_get_header(m, "ActionID"), };
1216         struct ao2_container *aors;
1217
1218         aors = cli_get_aors();
1219         if (!aors) {
1220                 astman_send_error(s, m, "Could not get AORs\n");
1221                 return 0;
1222         }
1223
1224         if (!ao2_container_count(aors)) {
1225                 astman_send_error(s, m, "No AORs found\n");
1226                 ao2_ref(aors, -1);
1227                 return 0;
1228         }
1229
1230         astman_send_listack(s, m, "A listing of AORs follows, presented as AorList events",
1231                         "start");
1232
1233         ao2_callback(aors, OBJ_NODATA, format_ami_aorlist_handler, &ami);
1234
1235         astman_send_list_complete_start(s, m, "AorListComplete", ami.count);
1236         astman_send_list_complete_end(s);
1237
1238         ao2_ref(aors, -1);
1239
1240         return 0;
1241 }
1242
1243 static struct ast_cli_entry cli_commands[] = {
1244         AST_CLI_DEFINE(ast_sip_cli_traverse_objects, "List PJSIP Aors",
1245                 .command = "pjsip list aors",
1246                 .usage = "Usage: pjsip list aors [ like <pattern> ]\n"
1247                                 "       List the configured PJSIP Aors\n"
1248                                 "       Optional regular expression pattern is used to filter the list.\n"),
1249         AST_CLI_DEFINE(ast_sip_cli_traverse_objects, "Show PJSIP Aors",
1250                 .command = "pjsip show aors",
1251                 .usage = "Usage: pjsip show aors [ like <pattern> ]\n"
1252                                 "       Show the configured PJSIP Aors\n"
1253                                 "       Optional regular expression pattern is used to filter the list.\n"),
1254         AST_CLI_DEFINE(ast_sip_cli_traverse_objects, "Show PJSIP Aor",
1255                 .command = "pjsip show aor",
1256                 .usage = "Usage: pjsip show aor <id>\n"
1257                                  "       Show the configured PJSIP Aor\n"),
1258
1259         AST_CLI_DEFINE(ast_sip_cli_traverse_objects, "List PJSIP Contacts",
1260                 .command = "pjsip list contacts",
1261                 .usage = "Usage: pjsip list contacts [ like <pattern> ]\n"
1262                                 "       List the configured PJSIP contacts\n"
1263                                 "       Optional regular expression pattern is used to filter the list.\n"),
1264         AST_CLI_DEFINE(ast_sip_cli_traverse_objects, "Show PJSIP Contacts",
1265                 .command = "pjsip show contacts",
1266                 .usage = "Usage: pjsip show contacts [ like <pattern> ]\n"
1267                                 "       Show the configured PJSIP contacts\n"
1268                                 "       Optional regular expression pattern is used to filter the list.\n"),
1269         AST_CLI_DEFINE(ast_sip_cli_traverse_objects, "Show PJSIP Contact",
1270                 .command = "pjsip show contact",
1271                 .usage = "Usage: pjsip show contact\n"
1272                                  "       Show the configured PJSIP contact\n"),
1273 };
1274
1275 struct ast_sip_cli_formatter_entry *contact_formatter;
1276 struct ast_sip_cli_formatter_entry *aor_formatter;
1277
1278 /*! \brief Always create a contact_status for each contact */
1279 static int contact_apply_handler(const struct ast_sorcery *sorcery, void *object)
1280 {
1281         struct ast_sip_contact_status *status;
1282         struct ast_sip_contact *contact = object;
1283
1284         if (ast_strlen_zero(contact->uri)) {
1285                 ast_log(LOG_ERROR, "A URI on dynamic contact '%s' is empty\n",
1286                         ast_sorcery_object_get_id(contact));
1287                 return -1;
1288         }
1289         status = ast_res_pjsip_find_or_create_contact_status(contact);
1290         ao2_cleanup(status);
1291
1292         return status ? 0 : -1;
1293 }
1294
1295 /*! \brief Initialize sorcery with location support */
1296 int ast_sip_initialize_sorcery_location(void)
1297 {
1298         struct ast_sorcery *sorcery = ast_sip_get_sorcery();
1299         int i;
1300
1301         ast_pjproject_get_buildopt("PJ_MAX_HOSTNAME", "%d", &pj_max_hostname);
1302         /* As of pjproject 2.4.5, PJSIP_MAX_URL_SIZE isn't exposed yet but we try anyway. */
1303         ast_pjproject_get_buildopt("PJSIP_MAX_URL_SIZE", "%d", &pjsip_max_url_size);
1304
1305         ast_sorcery_apply_default(sorcery, "contact", "astdb", "registrar");
1306         ast_sorcery_object_set_congestion_levels(sorcery, "contact", -1,
1307                 3 * AST_TASKPROCESSOR_HIGH_WATER_LEVEL);
1308         ast_sorcery_apply_default(sorcery, "aor", "config", "pjsip.conf,criteria=type=aor");
1309
1310         if (ast_sorcery_object_register(sorcery, "contact", contact_alloc, NULL, contact_apply_handler) ||
1311                 ast_sorcery_object_register(sorcery, "aor", aor_alloc, NULL, NULL)) {
1312                 return -1;
1313         }
1314
1315         ast_sorcery_observer_add(sorcery, "aor", &aor_observer);
1316
1317         ast_sorcery_object_field_register(sorcery, "contact", "type", "", OPT_NOOP_T, 0, 0);
1318         ast_sorcery_object_field_register(sorcery, "contact", "uri", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, uri));
1319         ast_sorcery_object_field_register(sorcery, "contact", "path", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, path));
1320         ast_sorcery_object_field_register_custom(sorcery, "contact", "expiration_time", "", expiration_str2struct, expiration_struct2str, NULL, 0, 0);
1321         ast_sorcery_object_field_register(sorcery, "contact", "qualify_frequency", 0, OPT_UINT_T,
1322                 PARSE_IN_RANGE, FLDSET(struct ast_sip_contact, qualify_frequency), 0, 86400);
1323         ast_sorcery_object_field_register(sorcery, "contact", "qualify_timeout", "3.0", OPT_DOUBLE_T, 0, FLDSET(struct ast_sip_contact, qualify_timeout));
1324         ast_sorcery_object_field_register(sorcery, "contact", "authenticate_qualify", "no", OPT_YESNO_T, 1, FLDSET(struct ast_sip_contact, authenticate_qualify));
1325         ast_sorcery_object_field_register(sorcery, "contact", "outbound_proxy", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, outbound_proxy));
1326         ast_sorcery_object_field_register(sorcery, "contact", "user_agent", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, user_agent));
1327         ast_sorcery_object_field_register(sorcery, "contact", "endpoint", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, endpoint_name));
1328         ast_sorcery_object_field_register(sorcery, "contact", "reg_server", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, reg_server));
1329         ast_sorcery_object_field_register(sorcery, "contact", "via_addr", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, via_addr));
1330         ast_sorcery_object_field_register(sorcery, "contact", "via_port", "0", OPT_UINT_T, 0, FLDSET(struct ast_sip_contact, via_port));
1331         ast_sorcery_object_field_register(sorcery, "contact", "call_id", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, call_id));
1332         ast_sorcery_object_field_register(sorcery, "contact", "prune_on_boot", "no", OPT_YESNO_T, 1, FLDSET(struct ast_sip_contact, prune_on_boot));
1333
1334         ast_sorcery_object_field_register(sorcery, "aor", "type", "", OPT_NOOP_T, 0, 0);
1335         ast_sorcery_object_field_register(sorcery, "aor", "minimum_expiration", "60", OPT_UINT_T, 0, FLDSET(struct ast_sip_aor, minimum_expiration));
1336         ast_sorcery_object_field_register(sorcery, "aor", "maximum_expiration", "7200", OPT_UINT_T, 0, FLDSET(struct ast_sip_aor, maximum_expiration));
1337         ast_sorcery_object_field_register(sorcery, "aor", "default_expiration", "3600", OPT_UINT_T, 0, FLDSET(struct ast_sip_aor, default_expiration));
1338         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);
1339         ast_sorcery_object_field_register(sorcery, "aor", "qualify_timeout", "3.0", OPT_DOUBLE_T, 0, FLDSET(struct ast_sip_aor, qualify_timeout));
1340         ast_sorcery_object_field_register(sorcery, "aor", "authenticate_qualify", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_aor, authenticate_qualify));
1341         ast_sorcery_object_field_register(sorcery, "aor", "max_contacts", "0", OPT_UINT_T, 0, FLDSET(struct ast_sip_aor, max_contacts));
1342         ast_sorcery_object_field_register(sorcery, "aor", "remove_existing", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_aor, remove_existing));
1343         ast_sorcery_object_field_register_custom(sorcery, "aor", "contact", "", permanent_uri_handler, contacts_to_str, contacts_to_var_list, 0, 0);
1344         ast_sorcery_object_field_register(sorcery, "aor", "mailboxes", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_aor, mailboxes));
1345         ast_sorcery_object_field_register_custom(sorcery, "aor", "voicemail_extension", "", voicemail_extension_handler, voicemail_extension_to_str, NULL, 0, 0);
1346         ast_sorcery_object_field_register(sorcery, "aor", "outbound_proxy", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_aor, outbound_proxy));
1347         ast_sorcery_object_field_register(sorcery, "aor", "support_path", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_aor, support_path));
1348
1349         ast_sip_register_endpoint_formatter(&endpoint_aor_formatter);
1350
1351         contact_formatter = ao2_alloc(sizeof(struct ast_sip_cli_formatter_entry), NULL);
1352         if (!contact_formatter) {
1353                 ast_log(LOG_ERROR, "Unable to allocate memory for contact_formatter\n");
1354                 return -1;
1355         }
1356         contact_formatter->name = "contact";
1357         contact_formatter->print_header = cli_contact_print_header;
1358         contact_formatter->print_body = cli_contact_print_body;
1359         contact_formatter->get_container = cli_contact_get_container;
1360         contact_formatter->iterate = cli_contact_iterate;
1361         contact_formatter->get_id = cli_contact_get_id;
1362         contact_formatter->retrieve_by_id = cli_contact_retrieve_by_id;
1363
1364         aor_formatter = ao2_alloc(sizeof(struct ast_sip_cli_formatter_entry), NULL);
1365         if (!aor_formatter) {
1366                 ast_log(LOG_ERROR, "Unable to allocate memory for aor_formatter\n");
1367                 return -1;
1368         }
1369         aor_formatter->name = "aor";
1370         aor_formatter->print_header = cli_aor_print_header;
1371         aor_formatter->print_body = cli_aor_print_body;
1372         aor_formatter->get_container = cli_aor_get_container;
1373         aor_formatter->iterate = cli_aor_iterate;
1374         aor_formatter->get_id = cli_aor_get_id;
1375         aor_formatter->retrieve_by_id = cli_aor_retrieve_by_id;
1376
1377         ast_sip_register_cli_formatter(contact_formatter);
1378         ast_sip_register_cli_formatter(aor_formatter);
1379         ast_cli_register_multiple(cli_commands, ARRAY_LEN(cli_commands));
1380
1381         if (ast_manager_register_xml("PJSIPShowAors", EVENT_FLAG_SYSTEM, ami_show_aors)) {
1382                 return -1;
1383         }
1384
1385         /*
1386          * Reset StatsD gauges in case we didn't shut down cleanly.
1387          * Note that this must done here, as contacts will create the contact_status
1388          * object before PJSIP options handling is initialized.
1389          */
1390         for (i = 0; i <= REMOVED; i++) {
1391                 ast_statsd_log_full_va("PJSIP.contacts.states.%s", AST_STATSD_GAUGE, 0, 1.0, ast_sip_get_contact_status_label(i));
1392         }
1393
1394         return 0;
1395 }
1396
1397 int ast_sip_destroy_sorcery_location(void)
1398 {
1399         ast_sorcery_observer_remove(ast_sip_get_sorcery(), "aor", &aor_observer);
1400         ast_cli_unregister_multiple(cli_commands, ARRAY_LEN(cli_commands));
1401         ast_sip_unregister_cli_formatter(contact_formatter);
1402         ast_sip_unregister_cli_formatter(aor_formatter);
1403         ast_manager_unregister("PJSIPShowAors");
1404
1405         ast_sip_unregister_endpoint_formatter(&endpoint_aor_formatter);
1406
1407         return 0;
1408 }