res_pjsip: Fix prune_on_boot to remove only contacts for the host.
[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 struct ast_sip_contact *ast_sip_location_create_contact(struct ast_sip_aor *aor,
360         const char *uri, struct timeval expiration_time, const char *path_info,
361         const char *user_agent, const char *via_addr, int via_port, const char *call_id,
362         int prune_on_boot, struct ast_sip_endpoint *endpoint)
363 {
364         struct ast_sip_contact *contact;
365         char name[MAX_OBJECT_FIELD * 2 + 3];
366         char hash[33];
367
368         ast_md5_hash(hash, uri);
369         snprintf(name, sizeof(name), "%s;@%s", ast_sorcery_object_get_id(aor), hash);
370
371         contact = ast_sorcery_alloc(ast_sip_get_sorcery(), "contact", name);
372         if (!contact) {
373                 return NULL;
374         }
375
376         ast_string_field_set(contact, uri, uri);
377         contact->expiration_time = expiration_time;
378         contact->qualify_frequency = aor->qualify_frequency;
379         contact->qualify_timeout = aor->qualify_timeout;
380         contact->authenticate_qualify = aor->authenticate_qualify;
381         if (path_info && aor->support_path) {
382                 ast_string_field_set(contact, path, path_info);
383         }
384
385         if (!ast_strlen_zero(aor->outbound_proxy)) {
386                 ast_string_field_set(contact, outbound_proxy, aor->outbound_proxy);
387         }
388
389         if (!ast_strlen_zero(user_agent)) {
390                 ast_string_field_set(contact, user_agent, user_agent);
391         }
392
393         if (!ast_strlen_zero(ast_config_AST_SYSTEM_NAME)) {
394                 ast_string_field_set(contact, reg_server, ast_config_AST_SYSTEM_NAME);
395         }
396
397         if (!ast_strlen_zero(via_addr)) {
398                 ast_string_field_set(contact, via_addr, via_addr);
399         }
400         contact->via_port = via_port;
401
402         if (!ast_strlen_zero(call_id)) {
403                 ast_string_field_set(contact, call_id, call_id);
404         }
405
406         contact->endpoint = ao2_bump(endpoint);
407         if (endpoint) {
408                 ast_string_field_set(contact, endpoint_name, ast_sorcery_object_get_id(endpoint));
409         }
410
411         contact->prune_on_boot = prune_on_boot;
412
413         if (ast_sorcery_create(ast_sip_get_sorcery(), contact)) {
414                 ao2_ref(contact, -1);
415                 return NULL;
416         }
417         return contact;
418 }
419
420 int ast_sip_location_add_contact_nolock(struct ast_sip_aor *aor, const char *uri,
421                 struct timeval expiration_time, const char *path_info, const char *user_agent,
422                 const char *via_addr, int via_port, const char *call_id,
423                 struct ast_sip_endpoint *endpoint)
424 {
425         struct ast_sip_contact *contact;
426
427         contact = ast_sip_location_create_contact(aor, uri, expiration_time, path_info,
428                 user_agent, via_addr, via_port, call_id, 0, endpoint);
429         ao2_cleanup(contact);
430         return contact ? 0 : -1;
431 }
432
433 int ast_sip_location_add_contact(struct ast_sip_aor *aor, const char *uri,
434                 struct timeval expiration_time, const char *path_info, const char *user_agent,
435                 const char *via_addr, int via_port, const char *call_id,
436                 struct ast_sip_endpoint *endpoint)
437 {
438         int res;
439
440         ao2_lock(aor);
441         res = ast_sip_location_add_contact_nolock(aor, uri, expiration_time, path_info, user_agent,
442                 via_addr, via_port, call_id,
443                 endpoint);
444         ao2_unlock(aor);
445
446         return res;
447 }
448
449 int ast_sip_location_update_contact(struct ast_sip_contact *contact)
450 {
451         return ast_sorcery_update(ast_sip_get_sorcery(), contact);
452 }
453
454 int ast_sip_location_delete_contact(struct ast_sip_contact *contact)
455 {
456         return ast_sorcery_delete(ast_sip_get_sorcery(), contact);
457 }
458
459 static int prune_boot_contacts_cb(void *obj, void *arg, int flags)
460 {
461         struct ast_sip_contact *contact = obj;
462
463         if (contact->prune_on_boot
464                 && !strcmp(contact->reg_server, ast_config_AST_SYSTEM_NAME ?: "")) {
465                 ast_verb(3, "Removed contact '%s' from AOR '%s' due to system boot\n",
466                         contact->uri, contact->aor);
467                 ast_sip_location_delete_contact(contact);
468         }
469
470         return 0;
471 }
472
473 void ast_sip_location_prune_boot_contacts(void)
474 {
475         struct ao2_container *contacts;
476
477         contacts = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), "contact",
478                 AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);
479         if (contacts) {
480                 ao2_callback(contacts, 0, prune_boot_contacts_cb, NULL);
481                 ao2_ref(contacts, -1);
482         }
483 }
484
485 /*! \brief Custom handler for translating from a string timeval to actual structure */
486 static int expiration_str2struct(const struct aco_option *opt, struct ast_variable *var, void *obj)
487 {
488         struct ast_sip_contact *contact = obj;
489         return ast_get_timeval(var->value, &contact->expiration_time, ast_tv(0, 0), NULL);
490 }
491
492 /*! \brief Custom handler for translating from an actual structure timeval to string */
493 static int expiration_struct2str(const void *obj, const intptr_t *args, char **buf)
494 {
495         const struct ast_sip_contact *contact = obj;
496         return (ast_asprintf(buf, "%ld", contact->expiration_time.tv_sec) < 0) ? -1 : 0;
497 }
498
499 static int permanent_uri_sort_fn(const void *obj_left, const void *obj_right, int flags)
500 {
501         const struct ast_sip_contact *object_left = obj_left;
502         const struct ast_sip_contact *object_right = obj_right;
503         const char *right_key = obj_right;
504         int cmp;
505
506         switch (flags & OBJ_SEARCH_MASK) {
507         case OBJ_SEARCH_OBJECT:
508                 right_key = ast_sorcery_object_get_id(object_right);
509                 /* Fall through */
510         case OBJ_SEARCH_KEY:
511                 cmp = strcmp(ast_sorcery_object_get_id(object_left), right_key);
512                 break;
513         case OBJ_SEARCH_PARTIAL_KEY:
514                 /*
515                  * We could also use a partial key struct containing a length
516                  * so strlen() does not get called for every comparison instead.
517                  */
518                 cmp = strncmp(ast_sorcery_object_get_id(object_left), right_key, strlen(right_key));
519                 break;
520         default:
521                 /* Sort can only work on something with a full or partial key. */
522                 ast_assert(0);
523                 cmp = 0;
524                 break;
525         }
526         return cmp;
527 }
528
529 int ast_sip_validate_uri_length(const char *contact_uri)
530 {
531         int max_length = pj_max_hostname - 1;
532         char *contact = ast_strdupa(contact_uri);
533         char *host;
534         char *at;
535         int theres_a_port = 0;
536
537         if (strlen(contact_uri) > pjsip_max_url_size - 1) {
538                 return -1;
539         }
540
541         contact = ast_strip_quoted(contact, "<", ">");
542
543         if (!strncasecmp(contact, "sip:", 4)) {
544                 host = contact + 4;
545         } else if (!strncasecmp(contact, "sips:", 5)) {
546                 host = contact + 5;
547         } else {
548                 /* Not a SIP URI */
549                 return -1;
550         }
551
552         at = strchr(contact, '@');
553         if (at) {
554                 /* sip[s]:user@host */
555                 host = at + 1;
556         }
557
558         if (host[0] == '[') {
559                 /* Host is an IPv6 address. Just get up to the matching bracket */
560                 char *close_bracket;
561
562                 close_bracket = strchr(host, ']');
563                 if (!close_bracket) {
564                         return -1;
565                 }
566                 close_bracket++;
567                 if (*close_bracket == ':') {
568                         theres_a_port = 1;
569                 }
570                 *close_bracket = '\0';
571         } else {
572                 /* uri parameters could contain ';' so trim them off first */
573                 host = strsep(&host, ";?");
574                 /* Host is FQDN or IPv4 address. Need to find closing delimiter */
575                 if (strchr(host, ':')) {
576                         theres_a_port = 1;
577                         host = strsep(&host, ":");
578                 }
579         }
580
581         if (!theres_a_port) {
582                 max_length -= strlen("_sips.tcp.");
583         }
584
585         if (strlen(host) > max_length) {
586                 return -1;
587         }
588
589         return 0;
590 }
591
592 /*! \brief Custom handler for permanent URIs */
593 static int permanent_uri_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
594 {
595         struct ast_sip_aor *aor = obj;
596         const char *aor_id = ast_sorcery_object_get_id(aor);
597         char *contacts;
598         char *contact_uri;
599
600         if (ast_strlen_zero(var->value)) {
601                 return 0;
602         }
603
604         contacts = ast_strdupa(var->value);
605         while ((contact_uri = ast_strip(strsep(&contacts, ",")))) {
606                 struct ast_sip_contact *contact;
607                 struct ast_sip_contact_status *status;
608                 char hash[33];
609                 char contact_id[strlen(aor_id) + sizeof(hash) + 2];
610
611                 if (ast_strlen_zero(contact_uri)) {
612                         continue;
613                 }
614
615                 if (ast_sip_validate_uri_length(contact_uri)) {
616                         ast_log(LOG_ERROR, "Contact uri or hostname length exceeds pjproject limit: %s\n", contact_uri);
617                         return -1;
618                 }
619
620                 if (!aor->permanent_contacts) {
621                         aor->permanent_contacts = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK,
622                                 AO2_CONTAINER_ALLOC_OPT_DUPS_REJECT, permanent_uri_sort_fn, NULL);
623                         if (!aor->permanent_contacts) {
624                                 return -1;
625                         }
626                 }
627
628                 ast_md5_hash(hash, contact_uri);
629                 snprintf(contact_id, sizeof(contact_id), "%s@@%s", aor_id, hash);
630                 contact = ast_sorcery_alloc(ast_sip_get_sorcery(), "contact", contact_id);
631                 if (!contact) {
632                         return -1;
633                 }
634
635                 ast_string_field_set(contact, uri, contact_uri);
636
637                 status = ast_res_pjsip_find_or_create_contact_status(contact);
638                 if (!status) {
639                         ao2_ref(contact, -1);
640                         return -1;
641                 }
642                 ao2_ref(status, -1);
643
644                 ao2_link(aor->permanent_contacts, contact);
645                 ao2_ref(contact, -1);
646         }
647
648         return 0;
649 }
650
651 static int contact_to_var_list(void *object, void *arg, int flags)
652 {
653         struct ast_sip_contact_wrapper *wrapper = object;
654         struct ast_variable **var = arg;
655
656         ast_variable_list_append(&*var, ast_variable_new("contact", wrapper->contact->uri, ""));
657
658         return 0;
659 }
660
661 static int contacts_to_var_list(const void *obj, struct ast_variable **fields)
662 {
663         const struct ast_sip_aor *aor = obj;
664
665         ast_sip_for_each_contact(aor, contact_to_var_list, fields);
666
667         return 0;
668 }
669
670 static int voicemail_extension_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
671 {
672         struct ast_sip_aor *aor = obj;
673
674         aor->voicemail_extension = ast_strdup(var->value);
675
676         return aor->voicemail_extension ? 0 : -1;
677 }
678
679 static int voicemail_extension_to_str(const void *obj, const intptr_t *args, char **buf)
680 {
681         const struct ast_sip_aor *aor = obj;
682
683         *buf = ast_strdup(aor->voicemail_extension);
684
685         return 0;
686 }
687
688 int ast_sip_for_each_aor(const char *aors, ao2_callback_fn on_aor, void *arg)
689 {
690         char *copy;
691         char *name;
692         int res;
693
694         if (!on_aor || ast_strlen_zero(aors)) {
695                 return 0;
696         }
697
698         copy = ast_strdupa(aors);
699         while ((name = ast_strip(strsep(&copy, ",")))) {
700                 struct ast_sip_aor *aor;
701
702                 aor = ast_sip_location_retrieve_aor(name);
703                 if (aor) {
704                         res = on_aor(aor, arg, 0);
705                         ao2_ref(aor, -1);
706                         if (res) {
707                                 return -1;
708                         }
709                 }
710         }
711         return 0;
712 }
713
714 static void contact_wrapper_destroy(void *obj)
715 {
716         struct ast_sip_contact_wrapper *wrapper = obj;
717
718         ast_free(wrapper->aor_id);
719         ast_free(wrapper->contact_id);
720         ao2_cleanup(wrapper->contact);
721 }
722
723 int ast_sip_for_each_contact(const struct ast_sip_aor *aor,
724                 ao2_callback_fn on_contact, void *arg)
725 {
726         struct ao2_container *contacts;
727         struct ao2_iterator i;
728         int res = 0;
729         void *object = NULL;
730
731         if (!on_contact ||
732             !(contacts = ast_sip_location_retrieve_aor_contacts(aor))) {
733                 return 0;
734         }
735
736         i = ao2_iterator_init(contacts, 0);
737         while ((object = ao2_iterator_next(&i))) {
738                 RAII_VAR(struct ast_sip_contact *, contact, object, ao2_cleanup);
739                 RAII_VAR(struct ast_sip_contact_wrapper *, wrapper, NULL, ao2_cleanup);
740                 const char *aor_id = ast_sorcery_object_get_id(aor);
741
742                 wrapper = ao2_alloc_options(sizeof(struct ast_sip_contact_wrapper),
743                         contact_wrapper_destroy, AO2_ALLOC_OPT_LOCK_NOLOCK);
744                 if (!wrapper) {
745                         res = -1;
746                         break;
747                 }
748                 wrapper->contact_id = ast_malloc(strlen(aor_id) + strlen(contact->uri) + 2);
749                 if (!wrapper->contact_id) {
750                         res = -1;
751                         break;
752                 }
753                 sprintf(wrapper->contact_id, "%s/%s", aor_id, contact->uri);
754                 wrapper->aor_id = ast_strdup(aor_id);
755                 if (!wrapper->aor_id) {
756                         res = -1;
757                         break;
758                 }
759                 wrapper->contact = contact;
760                 ao2_bump(wrapper->contact);
761
762                 if ((res = on_contact(wrapper, arg, 0))) {
763                         break;
764                 }
765         }
766         ao2_iterator_destroy(&i);
767         ao2_ref(contacts, -1);
768         return res;
769 }
770
771 int ast_sip_contact_to_str(void *object, void *arg, int flags)
772 {
773         struct ast_sip_contact_wrapper *wrapper = object;
774         struct ast_str **buf = arg;
775
776         ast_str_append(buf, 0, "%s,", wrapper->contact_id);
777
778         return 0;
779 }
780
781 static int sip_aor_to_ami(const struct ast_sip_aor *aor, struct ast_str **buf)
782 {
783         struct ast_variable *objset;
784         struct ast_variable *i;
785
786         objset = ast_sorcery_objectset_create2(ast_sip_get_sorcery(), aor,
787                 AST_HANDLER_ONLY_STRING);
788         if (!objset) {
789                 return -1;
790         }
791
792         ast_str_append(buf, 0, "ObjectType: %s\r\n",
793                        ast_sorcery_object_get_type(aor));
794         ast_str_append(buf, 0, "ObjectName: %s\r\n",
795                        ast_sorcery_object_get_id(aor));
796
797         for (i = objset; i; i = i->next) {
798                 char *camel = ast_to_camel_case(i->name);
799
800                 if (strcmp(camel, "Contact") == 0) {
801                         ast_free(camel);
802                         camel = NULL;
803                 }
804                 ast_str_append(buf, 0, "%s: %s\r\n", S_OR(camel, "Contacts"), i->value);
805                 ast_free(camel);
806         }
807
808         ast_variables_destroy(objset);
809         return 0;
810 }
811
812 static int contacts_to_str(const void *obj, const intptr_t *args, char **buf)
813 {
814         const struct ast_sip_aor *aor = obj;
815         struct ast_str *str;
816
817         str = ast_str_create(MAX_OBJECT_FIELD);
818         if (!str) {
819                 *buf = NULL;
820                 return -1;
821         }
822
823         ast_sip_for_each_contact(aor, ast_sip_contact_to_str, &str);
824         ast_str_truncate(str, -1);
825
826         *buf = ast_strdup(ast_str_buffer(str));
827         ast_free(str);
828
829         return *buf ? 0 : -1;
830 }
831
832 static int format_ami_aor_handler(void *obj, void *arg, int flags)
833 {
834         struct ast_sip_aor *aor = obj;
835         struct ast_sip_ami *ami = arg;
836         const struct ast_sip_endpoint *endpoint = ami->arg;
837         struct ast_str *buf;
838         struct ao2_container *contacts;
839         int total_contacts;
840         int num_permanent;
841
842         buf = ast_sip_create_ami_event("AorDetail", ami);
843         if (!buf) {
844                 return -1;
845         }
846         contacts = ast_sip_location_retrieve_aor_contacts(aor);
847         if (!contacts) {
848                 ast_free(buf);
849                 return -1;
850         }
851
852         sip_aor_to_ami(aor, &buf);
853         total_contacts = ao2_container_count(contacts);
854         num_permanent = aor->permanent_contacts ?
855                 ao2_container_count(aor->permanent_contacts) : 0;
856
857         ast_str_append(&buf, 0, "TotalContacts: %d\r\n", total_contacts);
858         ast_str_append(&buf, 0, "ContactsRegistered: %d\r\n",
859                        total_contacts - num_permanent);
860         ast_str_append(&buf, 0, "EndpointName: %s\r\n",
861                        ast_sorcery_object_get_id(endpoint));
862
863         astman_append(ami->s, "%s\r\n", ast_str_buffer(buf));
864         ami->count++;
865
866         ast_free(buf);
867         ao2_ref(contacts, -1);
868         return 0;
869 }
870
871 static int format_ami_endpoint_aor(const struct ast_sip_endpoint *endpoint,
872                                    struct ast_sip_ami *ami)
873 {
874         ami->arg = (void *)endpoint;
875         return ast_sip_for_each_aor(endpoint->aors,
876                                     format_ami_aor_handler, ami);
877 }
878
879 struct ast_sip_endpoint_formatter endpoint_aor_formatter = {
880         .format_ami = format_ami_endpoint_aor
881 };
882
883 static struct ao2_container *cli_aor_get_container(const char *regex)
884 {
885         struct ao2_container *container;
886         struct ao2_container *s_container;
887
888         container = ast_sorcery_retrieve_by_regex(ast_sip_get_sorcery(), "aor", regex);
889         if (!container) {
890                 return NULL;
891         }
892
893         /* Create a sorted container of aors. */
894         s_container = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK, 0,
895                 ast_sorcery_object_id_sort, ast_sorcery_object_id_compare);
896         if (s_container
897                 && ao2_container_dup(s_container, container, 0)) {
898                 ao2_ref(s_container, -1);
899                 s_container = NULL;
900         }
901         ao2_ref(container, -1);
902
903         return s_container;
904 }
905
906 static int cli_contact_populate_container(void *obj, void *arg, int flags)
907 {
908         ao2_link(arg, obj);
909
910         return 0;
911 }
912
913 static int cli_aor_gather_contacts(void *obj, void *arg, int flags)
914 {
915         struct ast_sip_aor *aor = obj;
916
917         return ast_sip_for_each_contact(aor, cli_contact_populate_container, arg);
918 }
919
920 static const char *cli_contact_get_id(const void *obj)
921 {
922         const struct ast_sip_contact_wrapper *wrapper = obj;
923         return wrapper->contact_id;
924 }
925
926 static int cli_contact_sort(const void *obj, const void *arg, int flags)
927 {
928         const struct ast_sip_contact_wrapper *left_wrapper = obj;
929         const struct ast_sip_contact_wrapper *right_wrapper = arg;
930         const char *right_key = arg;
931         int cmp = 0;
932
933         switch (flags & OBJ_SEARCH_MASK) {
934         case OBJ_SEARCH_OBJECT:
935                 right_key = right_wrapper->contact_id;
936                 /* Fall through */
937         case OBJ_SEARCH_KEY:
938                 cmp = strcmp(left_wrapper->contact_id, right_key);
939                 break;
940         case OBJ_SEARCH_PARTIAL_KEY:
941                 cmp = strncmp(left_wrapper->contact_id, right_key, strlen(right_key));
942                 break;
943         default:
944                 cmp = 0;
945                 break;
946         }
947
948         return cmp;
949 }
950
951 static int cli_contact_compare(void *obj, void *arg, int flags)
952 {
953         const struct ast_sip_contact_wrapper *left_wrapper = obj;
954         const struct ast_sip_contact_wrapper *right_wrapper = arg;
955         const char *right_key = arg;
956         int cmp = 0;
957
958         switch (flags & OBJ_SEARCH_MASK) {
959         case OBJ_SEARCH_OBJECT:
960                 right_key = right_wrapper->contact_id;
961                 /* Fall through */
962         case OBJ_SEARCH_KEY:
963                 if (strcmp(left_wrapper->contact_id, right_key) == 0) {;
964                         cmp = CMP_MATCH | CMP_STOP;
965                 }
966                 break;
967         case OBJ_SEARCH_PARTIAL_KEY:
968                 if (strncmp(left_wrapper->contact_id, right_key, strlen(right_key)) == 0) {
969                         cmp = CMP_MATCH;
970                 }
971                 break;
972         default:
973                 cmp = 0;
974                 break;
975         }
976
977         return cmp;
978 }
979
980 static int cli_contact_iterate(void *container, ao2_callback_fn callback, void *args)
981 {
982         return ast_sip_for_each_contact(container, callback, args);
983 }
984
985 static int cli_filter_contacts(void *obj, void *arg, int flags)
986 {
987         struct ast_sip_contact_wrapper *wrapper = obj;
988         regex_t *regexbuf = arg;
989
990         if (!regexec(regexbuf, wrapper->contact_id, 0, NULL, 0)) {
991                 return 0;
992         }
993
994         return CMP_MATCH;
995 }
996
997 static struct ao2_container *cli_contact_get_container(const char *regex)
998 {
999         RAII_VAR(struct ao2_container *, parent_container, NULL, ao2_cleanup);
1000         struct ao2_container *child_container;
1001         regex_t regexbuf;
1002
1003         parent_container = cli_aor_get_container("");
1004         if (!parent_container) {
1005                 return NULL;
1006         }
1007
1008         child_container = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK, 0,
1009                 cli_contact_sort, cli_contact_compare);
1010         if (!child_container) {
1011                 return NULL;
1012         }
1013
1014         ao2_callback(parent_container, OBJ_NODATA, cli_aor_gather_contacts, child_container);
1015
1016         if (!ast_strlen_zero(regex)) {
1017                 if (regcomp(&regexbuf, regex, REG_EXTENDED | REG_NOSUB)) {
1018                         ao2_ref(child_container, -1);
1019                         return NULL;
1020                 }
1021                 ao2_callback(child_container, OBJ_UNLINK | OBJ_MULTIPLE | OBJ_NODATA, cli_filter_contacts, &regexbuf);
1022                 regfree(&regexbuf);
1023         }
1024
1025         return child_container;
1026 }
1027
1028 static void *cli_contact_retrieve_by_id(const char *id)
1029 {
1030         struct ao2_container *container;
1031         void *obj;
1032
1033         container = cli_contact_get_container("");
1034         if (!container) {
1035                 return NULL;
1036         }
1037
1038         obj = ao2_find(container, id, OBJ_SEARCH_KEY);
1039         ao2_ref(container, -1);
1040         return obj;
1041 }
1042
1043 static int cli_contact_print_header(void *obj, void *arg, int flags)
1044 {
1045         struct ast_sip_cli_context *context = arg;
1046         int indent = CLI_INDENT_TO_SPACES(context->indent_level);
1047         int filler = CLI_LAST_TABSTOP - indent - 23;
1048
1049         ast_assert(context->output_buffer != NULL);
1050
1051         ast_str_append(&context->output_buffer, 0,
1052                 "%*s:  <Aor/ContactUri%*.*s> <Hash....> <Status> <RTT(ms)..>\n",
1053                 indent, "Contact", filler, filler, CLI_HEADER_FILLER);
1054
1055         return 0;
1056 }
1057
1058 static int cli_contact_print_body(void *obj, void *arg, int flags)
1059 {
1060         struct ast_sip_contact_wrapper *wrapper = obj;
1061         struct ast_sip_contact *contact = wrapper->contact;
1062         struct ast_sip_cli_context *context = arg;
1063         int indent;
1064         int flexwidth;
1065         const char *contact_id = ast_sorcery_object_get_id(contact);
1066         const char *hash_start = contact_id + strlen(contact->aor) + 2;
1067         struct ast_sip_contact_status *status;
1068
1069         ast_assert(contact->uri != NULL);
1070         ast_assert(context->output_buffer != NULL);
1071
1072         status = ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), CONTACT_STATUS, contact_id);
1073
1074         indent = CLI_INDENT_TO_SPACES(context->indent_level);
1075         flexwidth = CLI_LAST_TABSTOP - indent - 9 - strlen(contact->aor) + 1;
1076
1077         ast_str_append(&context->output_buffer, 0, "%*s:  %s/%-*.*s %-10.10s %-7.7s %11.3f\n",
1078                 indent,
1079                 "Contact",
1080                 contact->aor,
1081                 flexwidth, flexwidth,
1082                 contact->uri,
1083                 hash_start,
1084                 ast_sip_get_contact_short_status_label(status ? status->status : UNKNOWN),
1085                 (status && (status->status != UNKNOWN) ? ((long long) status->rtt) / 1000.0 : NAN));
1086
1087         ao2_cleanup(status);
1088         return 0;
1089 }
1090
1091 static int cli_aor_iterate(void *container, ao2_callback_fn callback, void *args)
1092 {
1093         const char *aor_list = container;
1094
1095         return ast_sip_for_each_aor(aor_list, callback, args);
1096 }
1097
1098 static void *cli_aor_retrieve_by_id(const char *id)
1099 {
1100         return ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "aor", id);
1101 }
1102
1103 static const char *cli_aor_get_id(const void *obj)
1104 {
1105         return ast_sorcery_object_get_id(obj);
1106 }
1107
1108 static int cli_aor_print_header(void *obj, void *arg, int flags)
1109 {
1110         struct ast_sip_cli_context *context = arg;
1111         int indent = CLI_INDENT_TO_SPACES(context->indent_level);
1112         int filler = CLI_LAST_TABSTOP - indent - 7;
1113
1114         ast_assert(context->output_buffer != NULL);
1115
1116         ast_str_append(&context->output_buffer, 0,
1117                 "%*s:  <Aor%*.*s>  <MaxContact>\n",
1118                 indent, "Aor", filler, filler, CLI_HEADER_FILLER);
1119
1120         if (context->recurse) {
1121                 struct ast_sip_cli_formatter_entry *formatter_entry;
1122
1123                 context->indent_level++;
1124                 formatter_entry = ast_sip_lookup_cli_formatter("contact");
1125                 if (formatter_entry) {
1126                         formatter_entry->print_header(NULL, context, 0);
1127                         ao2_ref(formatter_entry, -1);
1128                 }
1129                 context->indent_level--;
1130         }
1131
1132         return 0;
1133 }
1134
1135 static int cli_aor_print_body(void *obj, void *arg, int flags)
1136 {
1137         struct ast_sip_aor *aor = obj;
1138         struct ast_sip_cli_context *context = arg;
1139         int indent;
1140         int flexwidth;
1141
1142         ast_assert(context->output_buffer != NULL);
1143
1144 //      context->current_aor = aor;
1145
1146         indent = CLI_INDENT_TO_SPACES(context->indent_level);
1147         flexwidth = CLI_LAST_TABSTOP - indent - 12;
1148
1149         ast_str_append(&context->output_buffer, 0, "%*s:  %-*.*s %12u\n",
1150                 indent,
1151                 "Aor",
1152                 flexwidth, flexwidth,
1153                 ast_sorcery_object_get_id(aor), aor->max_contacts);
1154
1155         if (context->recurse) {
1156                 struct ast_sip_cli_formatter_entry *formatter_entry;
1157
1158                 context->indent_level++;
1159
1160                 formatter_entry = ast_sip_lookup_cli_formatter("contact");
1161                 if (formatter_entry) {
1162                         formatter_entry->iterate(aor, formatter_entry->print_body, context);
1163                         ao2_ref(formatter_entry, -1);
1164                 }
1165
1166                 context->indent_level--;
1167
1168                 if (context->indent_level == 0) {
1169                         ast_str_append(&context->output_buffer, 0, "\n");
1170                 }
1171         }
1172
1173         if (context->show_details || (context->show_details_only_level_0 && context->indent_level == 0)) {
1174                 ast_str_append(&context->output_buffer, 0, "\n");
1175                 ast_sip_cli_print_sorcery_objectset(aor, context, 0);
1176         }
1177
1178         return 0;
1179 }
1180
1181 static struct ast_cli_entry cli_commands[] = {
1182         AST_CLI_DEFINE(ast_sip_cli_traverse_objects, "List PJSIP Aors",
1183                 .command = "pjsip list aors",
1184                 .usage = "Usage: pjsip list aors [ like <pattern> ]\n"
1185                                 "       List the configured PJSIP Aors\n"
1186                                 "       Optional regular expression pattern is used to filter the list.\n"),
1187         AST_CLI_DEFINE(ast_sip_cli_traverse_objects, "Show PJSIP Aors",
1188                 .command = "pjsip show aors",
1189                 .usage = "Usage: pjsip show aors [ like <pattern> ]\n"
1190                                 "       Show the configured PJSIP Aors\n"
1191                                 "       Optional regular expression pattern is used to filter the list.\n"),
1192         AST_CLI_DEFINE(ast_sip_cli_traverse_objects, "Show PJSIP Aor",
1193                 .command = "pjsip show aor",
1194                 .usage = "Usage: pjsip show aor <id>\n"
1195                                  "       Show the configured PJSIP Aor\n"),
1196
1197         AST_CLI_DEFINE(ast_sip_cli_traverse_objects, "List PJSIP Contacts",
1198                 .command = "pjsip list contacts",
1199                 .usage = "Usage: pjsip list contacts [ like <pattern> ]\n"
1200                                 "       List the configured PJSIP contacts\n"
1201                                 "       Optional regular expression pattern is used to filter the list.\n"),
1202         AST_CLI_DEFINE(ast_sip_cli_traverse_objects, "Show PJSIP Contacts",
1203                 .command = "pjsip show contacts",
1204                 .usage = "Usage: pjsip show contacts [ like <pattern> ]\n"
1205                                 "       Show the configured PJSIP contacts\n"
1206                                 "       Optional regular expression pattern is used to filter the list.\n"),
1207         AST_CLI_DEFINE(ast_sip_cli_traverse_objects, "Show PJSIP Contact",
1208                 .command = "pjsip show contact",
1209                 .usage = "Usage: pjsip show contact\n"
1210                                  "       Show the configured PJSIP contact\n"),
1211 };
1212
1213 struct ast_sip_cli_formatter_entry *contact_formatter;
1214 struct ast_sip_cli_formatter_entry *aor_formatter;
1215
1216 /*! \brief Always create a contact_status for each contact */
1217 static int contact_apply_handler(const struct ast_sorcery *sorcery, void *object)
1218 {
1219         struct ast_sip_contact_status *status;
1220         struct ast_sip_contact *contact = object;
1221
1222         status = ast_res_pjsip_find_or_create_contact_status(contact);
1223         ao2_cleanup(status);
1224
1225         return status ? 0 : -1;
1226 }
1227
1228 /*! \brief Initialize sorcery with location support */
1229 int ast_sip_initialize_sorcery_location(void)
1230 {
1231         struct ast_sorcery *sorcery = ast_sip_get_sorcery();
1232         int i;
1233
1234         ast_pjproject_get_buildopt("PJ_MAX_HOSTNAME", "%d", &pj_max_hostname);
1235         /* As of pjproject 2.4.5, PJSIP_MAX_URL_SIZE isn't exposed yet but we try anyway. */
1236         ast_pjproject_get_buildopt("PJSIP_MAX_URL_SIZE", "%d", &pjsip_max_url_size);
1237
1238         ast_sorcery_apply_default(sorcery, "contact", "astdb", "registrar");
1239         ast_sorcery_object_set_congestion_levels(sorcery, "contact", -1,
1240                 3 * AST_TASKPROCESSOR_HIGH_WATER_LEVEL);
1241         ast_sorcery_apply_default(sorcery, "aor", "config", "pjsip.conf,criteria=type=aor");
1242
1243         if (ast_sorcery_object_register(sorcery, "contact", contact_alloc, NULL, contact_apply_handler) ||
1244                 ast_sorcery_object_register(sorcery, "aor", aor_alloc, NULL, NULL)) {
1245                 return -1;
1246         }
1247
1248         ast_sorcery_observer_add(sorcery, "aor", &aor_observer);
1249
1250         ast_sorcery_object_field_register(sorcery, "contact", "type", "", OPT_NOOP_T, 0, 0);
1251         ast_sorcery_object_field_register(sorcery, "contact", "uri", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, uri));
1252         ast_sorcery_object_field_register(sorcery, "contact", "path", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, path));
1253         ast_sorcery_object_field_register_custom(sorcery, "contact", "expiration_time", "", expiration_str2struct, expiration_struct2str, NULL, 0, 0);
1254         ast_sorcery_object_field_register(sorcery, "contact", "qualify_frequency", 0, OPT_UINT_T,
1255                 PARSE_IN_RANGE, FLDSET(struct ast_sip_contact, qualify_frequency), 0, 86400);
1256         ast_sorcery_object_field_register(sorcery, "contact", "qualify_timeout", "3.0", OPT_DOUBLE_T, 0, FLDSET(struct ast_sip_contact, qualify_timeout));
1257         ast_sorcery_object_field_register(sorcery, "contact", "authenticate_qualify", "no", OPT_YESNO_T, 1, FLDSET(struct ast_sip_contact, authenticate_qualify));
1258         ast_sorcery_object_field_register(sorcery, "contact", "outbound_proxy", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, outbound_proxy));
1259         ast_sorcery_object_field_register(sorcery, "contact", "user_agent", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, user_agent));
1260         ast_sorcery_object_field_register(sorcery, "contact", "endpoint", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, endpoint_name));
1261         ast_sorcery_object_field_register(sorcery, "contact", "reg_server", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, reg_server));
1262         ast_sorcery_object_field_register(sorcery, "contact", "via_addr", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, via_addr));
1263         ast_sorcery_object_field_register(sorcery, "contact", "via_port", "0", OPT_UINT_T, 0, FLDSET(struct ast_sip_contact, via_port));
1264         ast_sorcery_object_field_register(sorcery, "contact", "call_id", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, call_id));
1265         ast_sorcery_object_field_register(sorcery, "contact", "prune_on_boot", "no", OPT_YESNO_T, 1, FLDSET(struct ast_sip_contact, prune_on_boot));
1266
1267         ast_sorcery_object_field_register(sorcery, "aor", "type", "", OPT_NOOP_T, 0, 0);
1268         ast_sorcery_object_field_register(sorcery, "aor", "minimum_expiration", "60", OPT_UINT_T, 0, FLDSET(struct ast_sip_aor, minimum_expiration));
1269         ast_sorcery_object_field_register(sorcery, "aor", "maximum_expiration", "7200", OPT_UINT_T, 0, FLDSET(struct ast_sip_aor, maximum_expiration));
1270         ast_sorcery_object_field_register(sorcery, "aor", "default_expiration", "3600", OPT_UINT_T, 0, FLDSET(struct ast_sip_aor, default_expiration));
1271         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);
1272         ast_sorcery_object_field_register(sorcery, "aor", "qualify_timeout", "3.0", OPT_DOUBLE_T, 0, FLDSET(struct ast_sip_aor, qualify_timeout));
1273         ast_sorcery_object_field_register(sorcery, "aor", "authenticate_qualify", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_aor, authenticate_qualify));
1274         ast_sorcery_object_field_register(sorcery, "aor", "max_contacts", "0", OPT_UINT_T, 0, FLDSET(struct ast_sip_aor, max_contacts));
1275         ast_sorcery_object_field_register(sorcery, "aor", "remove_existing", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_aor, remove_existing));
1276         ast_sorcery_object_field_register_custom(sorcery, "aor", "contact", "", permanent_uri_handler, contacts_to_str, contacts_to_var_list, 0, 0);
1277         ast_sorcery_object_field_register(sorcery, "aor", "mailboxes", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_aor, mailboxes));
1278         ast_sorcery_object_field_register_custom(sorcery, "aor", "voicemail_extension", "", voicemail_extension_handler, voicemail_extension_to_str, NULL, 0, 0);
1279         ast_sorcery_object_field_register(sorcery, "aor", "outbound_proxy", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_aor, outbound_proxy));
1280         ast_sorcery_object_field_register(sorcery, "aor", "support_path", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_aor, support_path));
1281
1282         internal_sip_register_endpoint_formatter(&endpoint_aor_formatter);
1283
1284         contact_formatter = ao2_alloc(sizeof(struct ast_sip_cli_formatter_entry), NULL);
1285         if (!contact_formatter) {
1286                 ast_log(LOG_ERROR, "Unable to allocate memory for contact_formatter\n");
1287                 return -1;
1288         }
1289         contact_formatter->name = "contact";
1290         contact_formatter->print_header = cli_contact_print_header;
1291         contact_formatter->print_body = cli_contact_print_body;
1292         contact_formatter->get_container = cli_contact_get_container;
1293         contact_formatter->iterate = cli_contact_iterate;
1294         contact_formatter->get_id = cli_contact_get_id;
1295         contact_formatter->retrieve_by_id = cli_contact_retrieve_by_id;
1296
1297         aor_formatter = ao2_alloc(sizeof(struct ast_sip_cli_formatter_entry), NULL);
1298         if (!aor_formatter) {
1299                 ast_log(LOG_ERROR, "Unable to allocate memory for aor_formatter\n");
1300                 return -1;
1301         }
1302         aor_formatter->name = "aor";
1303         aor_formatter->print_header = cli_aor_print_header;
1304         aor_formatter->print_body = cli_aor_print_body;
1305         aor_formatter->get_container = cli_aor_get_container;
1306         aor_formatter->iterate = cli_aor_iterate;
1307         aor_formatter->get_id = cli_aor_get_id;
1308         aor_formatter->retrieve_by_id = cli_aor_retrieve_by_id;
1309
1310         ast_sip_register_cli_formatter(contact_formatter);
1311         ast_sip_register_cli_formatter(aor_formatter);
1312         ast_cli_register_multiple(cli_commands, ARRAY_LEN(cli_commands));
1313
1314         /*
1315          * Reset StatsD gauges in case we didn't shut down cleanly.
1316          * Note that this must done here, as contacts will create the contact_status
1317          * object before PJSIP options handling is initialized.
1318          */
1319         for (i = 0; i <= REMOVED; i++) {
1320                 ast_statsd_log_full_va("PJSIP.contacts.states.%s", AST_STATSD_GAUGE, 0, 1.0, ast_sip_get_contact_status_label(i));
1321         }
1322
1323         return 0;
1324 }
1325
1326 int ast_sip_destroy_sorcery_location(void)
1327 {
1328         ast_sorcery_observer_remove(ast_sip_get_sorcery(), "aor", &aor_observer);
1329         ast_cli_unregister_multiple(cli_commands, ARRAY_LEN(cli_commands));
1330         ast_sip_unregister_cli_formatter(contact_formatter);
1331         ast_sip_unregister_cli_formatter(aor_formatter);
1332
1333         internal_sip_unregister_endpoint_formatter(&endpoint_aor_formatter);
1334
1335         return 0;
1336 }
1337