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