res_pjsip: Updates and adds more PJSIP CLI commands.
[asterisk/asterisk.git] / res / res_pjsip / location.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * Joshua Colp <jcolp@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 #include "asterisk.h"
20 #include "pjsip.h"
21 #include "pjlib.h"
22
23 #include "asterisk/res_pjsip.h"
24 #include "asterisk/logger.h"
25 #include "asterisk/astobj2.h"
26 #include "asterisk/sorcery.h"
27 #include "include/res_pjsip_private.h"
28 #include "asterisk/res_pjsip_cli.h"
29
30 /*! \brief Destructor for AOR */
31 static void aor_destroy(void *obj)
32 {
33         struct ast_sip_aor *aor = obj;
34
35         ao2_cleanup(aor->permanent_contacts);
36         ast_string_field_free_memory(aor);
37 }
38
39 /*! \brief Allocator for AOR */
40 static void *aor_alloc(const char *name)
41 {
42         struct ast_sip_aor *aor = ast_sorcery_generic_alloc(sizeof(struct ast_sip_aor), aor_destroy);
43         if (!aor) {
44                 return NULL;
45         }
46         ast_string_field_init(aor, 128);
47         return aor;
48 }
49
50 /*! \brief Destructor for contact */
51 static void contact_destroy(void *obj)
52 {
53         struct ast_sip_contact *contact = obj;
54
55         ast_string_field_free_memory(contact);
56 }
57
58 /*! \brief Allocator for contact */
59 static void *contact_alloc(const char *name)
60 {
61         struct ast_sip_contact *contact = ast_sorcery_generic_alloc(sizeof(*contact), contact_destroy);
62
63         if (!contact) {
64                 return NULL;
65         }
66
67         if (ast_string_field_init(contact, 256)) {
68                 ao2_cleanup(contact);
69                 return NULL;
70         }
71
72         return contact;
73 }
74
75 struct ast_sip_aor *ast_sip_location_retrieve_aor(const char *aor_name)
76 {
77         return ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "aor", aor_name);
78 }
79
80 /*! \brief Internal callback function which deletes and unlinks any expired contacts */
81 static int contact_expire(void *obj, void *arg, int flags)
82 {
83         struct ast_sip_contact *contact = obj;
84
85         /* If the contact has not yet expired it is valid */
86         if (ast_tvdiff_ms(contact->expiration_time, ast_tvnow()) > 0) {
87                 return 0;
88         }
89
90         ast_sip_location_delete_contact(contact);
91
92         return CMP_MATCH;
93 }
94
95 /*! \brief Internal callback function which links static contacts into another container */
96 static int contact_link_static(void *obj, void *arg, int flags)
97 {
98         struct ao2_container *dest = arg;
99
100         ao2_link(dest, obj);
101         return 0;
102 }
103
104 /*! \brief Simple callback function which returns immediately, used to grab the first contact of an AOR */
105 static int contact_find_first(void *obj, void *arg, int flags)
106 {
107         return CMP_MATCH | CMP_STOP;
108 }
109
110 struct ast_sip_contact *ast_sip_location_retrieve_first_aor_contact(const struct ast_sip_aor *aor)
111 {
112         RAII_VAR(struct ao2_container *, contacts, NULL, ao2_cleanup);
113         struct ast_sip_contact *contact;
114
115         contacts = ast_sip_location_retrieve_aor_contacts(aor);
116         if (!contacts || (ao2_container_count(contacts) == 0)) {
117                 return NULL;
118         }
119
120         contact = ao2_callback(contacts, 0, contact_find_first, NULL);
121         return contact;
122 }
123
124 struct ao2_container *ast_sip_location_retrieve_aor_contacts(const struct ast_sip_aor *aor)
125 {
126         /* Give enough space for ^ at the beginning and ;@ at the end, since that is our object naming scheme */
127         char regex[strlen(ast_sorcery_object_get_id(aor)) + 4];
128         struct ao2_container *contacts;
129
130         snprintf(regex, sizeof(regex), "^%s;@", ast_sorcery_object_get_id(aor));
131
132         if (!(contacts = ast_sorcery_retrieve_by_regex(ast_sip_get_sorcery(), "contact", regex))) {
133                 return NULL;
134         }
135
136         /* Prune any expired contacts and delete them, we do this first because static contacts can never expire */
137         ao2_callback(contacts, OBJ_NODATA | OBJ_MULTIPLE | OBJ_UNLINK, contact_expire, NULL);
138
139         /* Add any permanent contacts from the AOR */
140         if (aor->permanent_contacts) {
141                 ao2_callback(aor->permanent_contacts, OBJ_NODATA, contact_link_static, contacts);
142         }
143
144         return contacts;
145 }
146
147 struct ast_sip_contact *ast_sip_location_retrieve_contact_from_aor_list(const char *aor_list)
148 {
149         char *aor_name;
150         char *rest;
151         struct ast_sip_contact *contact = NULL;
152
153         /* If the location is still empty we have nowhere to go */
154         if (ast_strlen_zero(aor_list) || !(rest = ast_strdupa(aor_list))) {
155                 ast_log(LOG_WARNING, "Unable to determine contacts from empty aor list\n");
156                 return NULL;
157         }
158
159         while ((aor_name = strsep(&rest, ","))) {
160                 RAII_VAR(struct ast_sip_aor *, aor, ast_sip_location_retrieve_aor(aor_name), ao2_cleanup);
161                 RAII_VAR(struct ao2_container *, contacts, NULL, ao2_cleanup);
162
163                 if (!aor) {
164                         continue;
165                 }
166                 contact = ast_sip_location_retrieve_first_aor_contact(aor);
167                 /* If a valid contact is available use its URI for dialing */
168                 if (contact) {
169                         break;
170                 }
171         }
172
173         return contact;
174 }
175
176 struct ast_sip_contact *ast_sip_location_retrieve_contact(const char *contact_name)
177 {
178         return ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "contact", contact_name);
179 }
180
181 int ast_sip_location_add_contact(struct ast_sip_aor *aor, const char *uri, struct timeval expiration_time, const char *path_info)
182 {
183         char name[AST_UUID_STR_LEN];
184         RAII_VAR(struct ast_sip_contact *, contact, NULL, ao2_cleanup);
185
186         snprintf(name, sizeof(name), "%s;@%s", ast_sorcery_object_get_id(aor), uri);
187
188         if (!(contact = ast_sorcery_alloc(ast_sip_get_sorcery(), "contact", name))) {
189                 return -1;
190         }
191
192         ast_string_field_set(contact, uri, uri);
193         contact->expiration_time = expiration_time;
194         contact->qualify_frequency = aor->qualify_frequency;
195         contact->authenticate_qualify = aor->authenticate_qualify;
196         if (path_info && aor->support_path) {
197                 ast_string_field_set(contact, path, path_info);
198         }
199
200         if (!ast_strlen_zero(aor->outbound_proxy)) {
201                 ast_string_field_set(contact, outbound_proxy, aor->outbound_proxy);
202         }
203
204         return ast_sorcery_create(ast_sip_get_sorcery(), contact);
205 }
206
207 int ast_sip_location_update_contact(struct ast_sip_contact *contact)
208 {
209         return ast_sorcery_update(ast_sip_get_sorcery(), contact);
210 }
211
212 int ast_sip_location_delete_contact(struct ast_sip_contact *contact)
213 {
214         return ast_sorcery_delete(ast_sip_get_sorcery(), contact);
215 }
216
217 /*! \brief Custom handler for translating from a string timeval to actual structure */
218 static int expiration_str2struct(const struct aco_option *opt, struct ast_variable *var, void *obj)
219 {
220         struct ast_sip_contact *contact = obj;
221         return ast_get_timeval(var->value, &contact->expiration_time, ast_tv(0, 0), NULL);
222 }
223
224 /*! \brief Custom handler for translating from an actual structure timeval to string */
225 static int expiration_struct2str(const void *obj, const intptr_t *args, char **buf)
226 {
227         const struct ast_sip_contact *contact = obj;
228         return (ast_asprintf(buf, "%lu", contact->expiration_time.tv_sec) < 0) ? -1 : 0;
229 }
230
231 /*! \brief Helper function which validates a permanent contact */
232 static int permanent_contact_validate(void *data)
233 {
234         const char *value = data;
235         pj_pool_t *pool;
236         pj_str_t contact_uri;
237         static const pj_str_t HCONTACT = { "Contact", 7 };
238
239         pool = pjsip_endpt_create_pool(ast_sip_get_pjsip_endpoint(), "Permanent Contact Validation", 256, 256);
240         if (!pool) {
241                 return -1;
242         }
243
244         pj_strdup2_with_null(pool, &contact_uri, value);
245         if (!pjsip_parse_hdr(pool, &HCONTACT, contact_uri.ptr, contact_uri.slen, NULL)) {
246                 pjsip_endpt_release_pool(ast_sip_get_pjsip_endpoint(), pool);
247                 return -1;
248         }
249
250         pjsip_endpt_release_pool(ast_sip_get_pjsip_endpoint(), pool);
251         return 0;
252 }
253
254 /*! \brief Custom handler for permanent URIs */
255 static int permanent_uri_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
256 {
257         struct ast_sip_aor *aor = obj;
258         RAII_VAR(struct ast_sip_contact *, contact, NULL, ao2_cleanup);
259
260         if (ast_sip_push_task_synchronous(NULL, permanent_contact_validate, (char*)var->value)) {
261                 ast_log(LOG_ERROR, "Permanent URI on aor '%s' with contact '%s' failed to parse\n",
262                         ast_sorcery_object_get_id(aor), var->value);
263                 return -1;
264         }
265
266         if ((!aor->permanent_contacts && !(aor->permanent_contacts = ao2_container_alloc_options(AO2_ALLOC_OPT_LOCK_NOLOCK, 1, NULL, NULL))) ||
267                 !(contact = ast_sorcery_alloc(ast_sip_get_sorcery(), "contact", NULL))) {
268                 return -1;
269         }
270
271         ast_string_field_set(contact, uri, var->value);
272         ao2_link(aor->permanent_contacts, contact);
273
274         return 0;
275 }
276
277 int ast_sip_for_each_aor(const char *aors, ao2_callback_fn on_aor, void *arg)
278 {
279         char *copy, *name;
280
281         if (!on_aor || ast_strlen_zero(aors)) {
282                 return 0;
283         }
284
285         copy = ast_strdupa(aors);
286         while ((name = strsep(&copy, ","))) {
287                 RAII_VAR(struct ast_sip_aor *, aor,
288                          ast_sip_location_retrieve_aor(name), ao2_cleanup);
289
290                 if (!aor) {
291                         continue;
292                 }
293
294                 if (on_aor(aor, arg, 0)) {
295                         return -1;
296                 }
297         }
298         ast_free(copy);
299         return 0;
300 }
301
302 int ast_sip_for_each_contact(const struct ast_sip_aor *aor,
303                 ao2_callback_fn on_contact, void *arg)
304 {
305         RAII_VAR(struct ao2_container *, contacts, NULL, ao2_cleanup);
306         struct ast_sip_contact *contact;
307         struct ao2_iterator i;
308
309         if (!on_contact ||
310             !(contacts = ast_sip_location_retrieve_aor_contacts(aor))) {
311                 return 0;
312         }
313
314         i = ao2_iterator_init(contacts, 0);
315         while ((contact = ao2_iterator_next(&i))) {
316                 int res;
317
318                 ast_sorcery_object_set_extended(contact, "@aor_id", ast_sorcery_object_get_id(aor));
319                 if ((res = on_contact(contact, arg, 0))) {
320                         ao2_iterator_destroy(&i);
321                         return -1;
322                 }
323         }
324         ao2_iterator_destroy(&i);
325         return 0;
326 }
327
328 int ast_sip_contact_to_str(void *object, void *arg, int flags)
329 {
330         struct ast_sip_contact *contact = object;
331         struct ast_str **buf = arg;
332
333         ast_str_append(buf, 0, "%s/%s,",
334                 ast_sorcery_object_get_extended(contact, "aor_id"), contact->uri);
335
336         return 0;
337 }
338
339 static int sip_aor_to_ami(const struct ast_sip_aor *aor, struct ast_str **buf)
340 {
341         return ast_sip_sorcery_object_to_ami(aor, buf);
342 }
343
344 static int format_ami_aor_handler(void *obj, void *arg, int flags)
345 {
346         struct ast_sip_aor *aor = obj;
347         struct ast_sip_ami *ami = arg;
348         const struct ast_sip_endpoint *endpoint = ami->arg;
349         RAII_VAR(struct ast_str *, buf,
350                  ast_sip_create_ami_event("AorDetail", ami), ast_free);
351
352         int num;
353         RAII_VAR(struct ao2_container *, contacts,
354                  ast_sip_location_retrieve_aor_contacts(aor), ao2_cleanup);
355
356         if (!buf) {
357                 return -1;
358         }
359
360         sip_aor_to_ami(aor, &buf);
361         ast_str_append(&buf, 0, "Contacts: ");
362         ast_sip_for_each_contact(aor, ast_sip_contact_to_str, &buf);
363         ast_str_truncate(buf, -1);
364         ast_str_append(&buf, 0, "\r\n");
365
366         num = ao2_container_count(contacts);
367         ast_str_append(&buf, 0, "TotalContacts: %d\r\n", num);
368         ast_str_append(&buf, 0, "ContactsRegistered: %d\r\n",
369                        num - ao2_container_count(aor->permanent_contacts));
370         ast_str_append(&buf, 0, "EndpointName: %s\r\n",
371                        ast_sorcery_object_get_id(endpoint));
372
373         astman_append(ami->s, "%s\r\n", ast_str_buffer(buf));
374         return 0;
375 }
376
377 static int format_ami_endpoint_aor(const struct ast_sip_endpoint *endpoint,
378                                    struct ast_sip_ami *ami)
379 {
380         ami->arg = (void *)endpoint;
381         return ast_sip_for_each_aor(endpoint->aors,
382                                     format_ami_aor_handler, ami);
383 }
384
385 struct ast_sip_endpoint_formatter endpoint_aor_formatter = {
386         .format_ami = format_ami_endpoint_aor
387 };
388
389 static struct ao2_container *cli_get_aor_container(void)
390 {
391         RAII_VAR(struct ao2_container *, container, NULL, ao2_cleanup);
392         RAII_VAR(struct ao2_container *, s_container, NULL, ao2_cleanup);
393
394         container = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), "aor",
395                 AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);
396         if (!container) {
397                 return NULL;
398         }
399
400         s_container = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK, 0,
401                 ast_sorcery_object_id_compare, NULL);
402         if (!s_container) {
403                 return NULL;
404         }
405
406         if (ao2_container_dup(s_container, container, 0)) {
407                 return NULL;
408         }
409         ao2_ref(s_container, +1);
410         return s_container;
411 }
412
413 static int populate_contact_container(void *obj, void *arg, int flags)
414 {
415         struct ast_sip_contact *contact = obj;
416         struct ao2_container *container = arg;
417
418         ao2_link(container, contact);
419         return 0;
420 }
421
422 static int gather_aor_contacts(void *obj, void *arg, int flags)
423 {
424         struct ast_sip_aor *aor = obj;
425         struct ao2_container *container = arg;
426         ast_sip_for_each_contact(aor, populate_contact_container, container);
427         return 0;
428 }
429
430 static int cli_contact_compare(const void *left, const void *right, int flags)
431 {
432         const struct ast_sip_contact *left_contact = left;
433         const struct ast_sip_contact *right_contact = right;
434         int rc;
435
436         if (!left_contact || !right_contact) {
437                 return 0;
438         }
439         rc = strcmp(ast_sorcery_object_get_extended(left_contact, "aor_id"),
440                 ast_sorcery_object_get_extended(right_contact, "aor_id"));
441         if (rc) {
442                 return rc;
443         }
444         return strcmp(left_contact->uri, right_contact->uri);
445 }
446
447 static struct ao2_container *cli_get_contact_container(void)
448 {
449         RAII_VAR(struct ao2_container *, parent_container, NULL, ao2_cleanup);
450         struct ao2_container *child_container;
451
452         parent_container =  cli_get_aor_container();
453         if (!parent_container) {
454                 return NULL;
455         }
456
457         child_container = ao2_container_alloc_list(AO2_ALLOC_OPT_LOCK_NOLOCK, 0,
458                 cli_contact_compare, NULL);
459         if (!child_container) {
460                 return NULL;
461         }
462
463         ao2_ref(child_container, +1);
464         ao2_callback(parent_container, OBJ_NODATA, gather_aor_contacts, child_container);
465
466         return child_container;
467 }
468
469 static int cli_contact_iterator(const void *container, ao2_callback_fn callback, void *args)
470 {
471         const struct ast_sip_aor *array = container;
472
473         return ast_sip_for_each_contact(array, callback, args);
474 }
475
476 static int cli_print_contact_header(void *obj, void *arg, int flags)
477 {
478         struct ast_sip_cli_context *context = arg;
479         int indent = CLI_INDENT_TO_SPACES(context->indent_level);
480         int filler = CLI_LAST_TABSTOP - indent - 18;
481
482         if (!context->output_buffer) {
483                 return -1;
484         }
485         ast_str_append(&context->output_buffer, 0,
486                 "%*s:  <Aor/ContactUri%*.*s>  <Status....>  <RTT(ms)..>\n",
487                 indent, "Contact", filler, filler, CLI_HEADER_FILLER);
488
489         return 0;
490 }
491
492 static int cli_print_contact_body(void *obj, void *arg, int flags)
493 {
494         struct ast_sip_contact *contact = obj;
495         struct ast_sip_cli_context *context = arg;
496         char *print_name = NULL;
497         int print_name_len;
498         int indent;
499         int flexwidth;
500         const char *aor_id = ast_sorcery_object_get_extended(contact, "aor_id");
501
502         RAII_VAR(struct ast_sip_contact_status *, status,
503                 ast_sorcery_retrieve_by_id( ast_sip_get_sorcery(), CONTACT_STATUS, ast_sorcery_object_get_id(contact)),
504                 ao2_cleanup);
505
506         if (!context->output_buffer) {
507                 return -1;
508         }
509
510         print_name_len = strlen(aor_id) + strlen(contact->uri) + 2;
511         print_name = ast_alloca(print_name_len);
512         snprintf(print_name, print_name_len, "%s/%s", aor_id, contact->uri);
513
514         indent = CLI_INDENT_TO_SPACES(context->indent_level);
515         flexwidth = CLI_LAST_TABSTOP - indent - 2;
516
517         ast_str_append(&context->output_buffer, 0, "%*s:  %-*.*s  %-12.12s  %11.3f\n",
518                 indent,
519                 "Contact",
520                 flexwidth, flexwidth,
521                 print_name,
522                 (status ? (status->status == AVAILABLE ? "Avail" : "Unavail") : "Unknown"),
523                 (status ? ((long long) status->rtt) / 1000.0 : NAN));
524
525         return 0;
526 }
527
528 static int cli_aor_iterator(const void *container, ao2_callback_fn callback, void *args)
529 {
530         const char *aor_list = container;
531
532         return ast_sip_for_each_aor(aor_list, callback, args);
533 }
534
535 static int cli_print_aor_header(void *obj, void *arg, int flags)
536 {
537         struct ast_sip_cli_context *context = arg;
538         struct ast_sip_cli_formatter_entry *formatter_entry;
539
540         int indent = CLI_INDENT_TO_SPACES(context->indent_level);
541         int filler = CLI_LAST_TABSTOP - indent - 7;
542
543         if (!context->output_buffer) {
544                 return -1;
545         }
546         ast_str_append(&context->output_buffer, 0,
547                 "%*s:  <Aor%*.*s>  <MaxContact>\n",
548                 indent, "Aor", filler, filler, CLI_HEADER_FILLER);
549
550         if (context->recurse) {
551                 context->indent_level++;
552                 formatter_entry = ast_sip_lookup_cli_formatter("contact");
553                 if (formatter_entry && formatter_entry->print_header) {
554                         formatter_entry->print_header(NULL, context, 0);
555                 }
556                 context->indent_level--;
557         }
558         return 0;
559 }
560
561 static int cli_print_aor_body(void *obj, void *arg, int flags)
562 {
563         struct ast_sip_aor *aor = obj;
564         struct ast_sip_cli_context *context = arg;
565         struct ast_sip_cli_formatter_entry *formatter_entry;
566         int indent;
567         int flexwidth;
568
569         if (!context->output_buffer) {
570                 return -1;
571         }
572
573         context->current_aor = aor;
574
575         indent = CLI_INDENT_TO_SPACES(context->indent_level);
576         flexwidth = CLI_LAST_TABSTOP - indent - 12;
577
578         ast_str_append(&context->output_buffer, 0, "%*s:  %-*.*s %12d\n",
579                 indent,
580                 "Aor",
581                 flexwidth, flexwidth,
582                 ast_sorcery_object_get_id(aor), aor->max_contacts);
583
584         if (context->recurse) {
585                 context->indent_level++;
586
587                 formatter_entry = ast_sip_lookup_cli_formatter("contact");
588                 if (formatter_entry && formatter_entry->print_body && formatter_entry->iterator) {
589                         formatter_entry->iterator(aor, formatter_entry->print_body, context);
590                 }
591
592                 context->indent_level--;
593
594                 if (context->indent_level == 0) {
595                         ast_str_append(&context->output_buffer, 0, "\n");
596                 }
597         }
598
599         if (context->show_details || (context->show_details_only_level_0 && context->indent_level == 0)) {
600                 ast_str_append(&context->output_buffer, 0, "\n");
601                 ast_sip_cli_print_sorcery_objectset(aor, context, 0);
602         }
603
604         return 0;
605 }
606
607 static struct ast_sip_cli_formatter_entry cli_contact_formatter = {
608         .name = "contact",
609         .print_header = cli_print_contact_header,
610         .print_body = cli_print_contact_body,
611         .get_container = cli_get_contact_container,
612         .iterator = cli_contact_iterator,
613         .comparator = cli_contact_compare,
614 };
615
616 static struct ast_sip_cli_formatter_entry cli_aor_formatter = {
617         .name = "aor",
618         .print_header = cli_print_aor_header,
619         .print_body = cli_print_aor_body,
620         .get_container = cli_get_aor_container,
621         .iterator = cli_aor_iterator,
622         .comparator = ast_sorcery_object_id_compare,
623 };
624
625 static struct ast_cli_entry cli_commands[] = {
626         AST_CLI_DEFINE(ast_sip_cli_traverse_objects, "List PJSIP Aors",
627                 .command = "pjsip list aors",
628                 .usage = "Usage: pjsip list aors\n"
629                                  "       List the configured PJSIP Aors\n"),
630         AST_CLI_DEFINE(ast_sip_cli_traverse_objects, "Show PJSIP Aors",
631                 .command = "pjsip show aors",
632                 .usage = "Usage: pjsip show aors\n"
633                                  "       Show the configured PJSIP Aors\n"),
634         AST_CLI_DEFINE(ast_sip_cli_traverse_objects, "Show PJSIP Aor",
635                 .command = "pjsip show aor",
636                 .usage = "Usage: pjsip show aor <id>\n"
637                                  "       Show the configured PJSIP Aor\n"),
638
639         AST_CLI_DEFINE(ast_sip_cli_traverse_objects, "List PJSIP Contacts",
640                 .command = "pjsip list contacts",
641                 .usage = "Usage: pjsip list contacts\n"
642                                  "       List the configured PJSIP contacts\n"),
643 };
644
645 /*! \brief Initialize sorcery with location support */
646 int ast_sip_initialize_sorcery_location(void)
647 {
648         struct ast_sorcery *sorcery = ast_sip_get_sorcery();
649         ast_sorcery_apply_default(sorcery, "contact", "astdb", "registrar");
650         ast_sorcery_apply_default(sorcery, "aor", "config", "pjsip.conf,criteria=type=aor");
651
652         if (ast_sorcery_object_register(sorcery, "contact", contact_alloc, NULL, NULL) ||
653                 ast_sorcery_object_register(sorcery, "aor", aor_alloc, NULL, NULL)) {
654                 return -1;
655         }
656
657         ast_sorcery_object_field_register(sorcery, "contact", "type", "", OPT_NOOP_T, 0, 0);
658         ast_sorcery_object_field_register(sorcery, "contact", "uri", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, uri));
659         ast_sorcery_object_field_register(sorcery, "contact", "path", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, path));
660         ast_sorcery_object_field_register_custom(sorcery, "contact", "expiration_time", "", expiration_str2struct, expiration_struct2str, 0, 0);
661         ast_sorcery_object_field_register(sorcery, "contact", "qualify_frequency", 0, OPT_UINT_T,
662                                           PARSE_IN_RANGE, FLDSET(struct ast_sip_contact, qualify_frequency), 0, 86400);
663         ast_sorcery_object_field_register(sorcery, "contact", "outbound_proxy", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_contact, outbound_proxy));
664
665         ast_sorcery_object_field_register(sorcery, "aor", "type", "", OPT_NOOP_T, 0, 0);
666         ast_sorcery_object_field_register(sorcery, "aor", "minimum_expiration", "60", OPT_UINT_T, 0, FLDSET(struct ast_sip_aor, minimum_expiration));
667         ast_sorcery_object_field_register(sorcery, "aor", "maximum_expiration", "7200", OPT_UINT_T, 0, FLDSET(struct ast_sip_aor, maximum_expiration));
668         ast_sorcery_object_field_register(sorcery, "aor", "default_expiration", "3600", OPT_UINT_T, 0, FLDSET(struct ast_sip_aor, default_expiration));
669         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);
670         ast_sorcery_object_field_register(sorcery, "aor", "authenticate_qualify", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_aor, authenticate_qualify));
671         ast_sorcery_object_field_register(sorcery, "aor", "max_contacts", "0", OPT_UINT_T, 0, FLDSET(struct ast_sip_aor, max_contacts));
672         ast_sorcery_object_field_register(sorcery, "aor", "remove_existing", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_aor, remove_existing));
673         ast_sorcery_object_field_register_custom(sorcery, "aor", "contact", "", permanent_uri_handler, NULL, 0, 0);
674         ast_sorcery_object_field_register(sorcery, "aor", "mailboxes", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_aor, mailboxes));
675         ast_sorcery_object_field_register(sorcery, "aor", "outbound_proxy", "", OPT_STRINGFIELD_T, 0, STRFLDSET(struct ast_sip_aor, outbound_proxy));
676         ast_sorcery_object_field_register(sorcery, "aor", "support_path", "no", OPT_BOOL_T, 1, FLDSET(struct ast_sip_aor, support_path));
677
678         ast_sip_register_endpoint_formatter(&endpoint_aor_formatter);
679         ast_sip_register_cli_formatter(&cli_contact_formatter);
680         ast_sip_register_cli_formatter(&cli_aor_formatter);
681         ast_cli_register_multiple(cli_commands, ARRAY_LEN(cli_commands));
682         return 0;
683 }
684
685 int ast_sip_destroy_sorcery_location(void)
686 {
687         ast_cli_unregister_multiple(cli_commands, ARRAY_LEN(cli_commands));
688         ast_sip_unregister_cli_formatter(&cli_contact_formatter);
689         ast_sip_unregister_cli_formatter(&cli_aor_formatter);
690         return 0;
691 }
692