res_pjsip: Add ignore_uri_user_options option.
[asterisk/asterisk.git] / res / res_pjsip / pjsip_options.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * Matt Jordan <mjordan@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
21 #include <pjsip.h>
22 #include <pjsip_ua.h>
23 #include <pjlib.h>
24
25 #include "asterisk/res_pjsip.h"
26 #include "asterisk/channel.h"
27 #include "asterisk/pbx.h"
28 #include "asterisk/astobj2.h"
29 #include "asterisk/cli.h"
30 #include "asterisk/time.h"
31 #include "asterisk/test.h"
32 #include "asterisk/statsd.h"
33 #include "include/res_pjsip_private.h"
34 #include "asterisk/taskprocessor.h"
35
36 #define DEFAULT_LANGUAGE "en"
37 #define DEFAULT_ENCODING "text/plain"
38 #define QUALIFIED_BUCKETS 211
39
40 static const char *status_map [] = {
41         [UNAVAILABLE] = "Unreachable",
42         [AVAILABLE] = "Reachable",
43         [UNKNOWN] = "Unknown",
44         [CREATED] = "Created",
45         [REMOVED] = "Removed",
46 };
47
48 static const char *short_status_map [] = {
49         [UNAVAILABLE] = "Unavail",
50         [AVAILABLE] = "Avail",
51         [UNKNOWN] = "Unknown",
52         [CREATED] = "Created",
53         [REMOVED] = "Removed",
54 };
55
56 static void contact_deleted(const void *obj);
57 static void qualify_and_schedule(struct ast_sip_contact *contact);
58
59 const char *ast_sip_get_contact_status_label(const enum ast_sip_contact_status_type status)
60 {
61         return status_map[status];
62 }
63
64 const char *ast_sip_get_contact_short_status_label(const enum ast_sip_contact_status_type status)
65 {
66         return short_status_map[status];
67 }
68
69 /*!
70  * \internal
71  * \brief Destroy a ast_sip_contact_status object.
72  */
73 static void contact_status_destroy(void * obj)
74 {
75         struct ast_sip_contact_status *status = obj;
76
77         ast_string_field_free_memory(status);
78 }
79
80 /*!
81  * \internal
82  * \brief Create a ast_sip_contact_status object.
83  */
84 static void *contact_status_alloc(const char *name)
85 {
86         struct ast_sip_contact_status *status = ast_sorcery_generic_alloc(sizeof(*status), contact_status_destroy);
87         char *id = ast_strdupa(name);
88         char *aor = id;
89         char *aor_separator = NULL;
90
91         if (!status) {
92                 ast_log(LOG_ERROR, "Unable to allocate ast_sip_contact_status\n");
93                 return NULL;
94         }
95
96         if (ast_string_field_init(status, 256)) {
97                 ast_log(LOG_ERROR, "Unable to allocate ast_sip_contact_status stringfields\n");
98                 ao2_cleanup(status);
99                 return NULL;
100         }
101
102         /* Dynamic contacts are delimited with ";@" and static ones with "@@" */
103         if ((aor_separator = strstr(id, ";@")) || (aor_separator = strstr(id, "@@"))) {
104                 *aor_separator = '\0';
105         }
106         ast_assert(aor_separator != NULL);
107
108         ast_string_field_set(status, aor, aor);
109         status->status = CREATED;
110
111         return status;
112 }
113
114 static int qualify_and_schedule_aor_contact(void *obj)
115 {
116         struct ast_sip_contact *contact = obj;
117         struct ast_sip_aor *aor;
118
119         if (!contact || ast_strlen_zero(contact->aor) ||
120                 !(aor = ast_sip_location_retrieve_aor(contact->aor))) {
121                 ao2_ref(contact, -1);
122                 return -1;
123         }
124
125         contact->qualify_frequency = aor->qualify_frequency;
126         contact->qualify_timeout = aor->qualify_timeout;
127         contact->authenticate_qualify = aor->authenticate_qualify;
128
129         ao2_ref(aor, -1);
130
131         qualify_and_schedule(contact);
132         ao2_ref(contact, -1);
133
134         return 0;
135 }
136
137 AST_MUTEX_DEFINE_STATIC(creation_lock);
138
139 /*!
140  * \brief Retrieve a ast_sip_contact_status object from sorcery creating
141  *        one if not found.
142  */
143 struct ast_sip_contact_status *ast_res_pjsip_find_or_create_contact_status(const struct ast_sip_contact *contact)
144 {
145         struct ast_sip_contact_status *status;
146         SCOPED_MUTEX(lock, &creation_lock);
147
148         status = ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), CONTACT_STATUS,
149                 ast_sorcery_object_get_id(contact));
150         if (status) {
151                 return status;
152         }
153
154         status = ast_sorcery_alloc(ast_sip_get_sorcery(), CONTACT_STATUS,
155                 ast_sorcery_object_get_id(contact));
156         if (!status) {
157                 ast_log(LOG_ERROR, "Unable to create ast_sip_contact_status for contact %s/%s\n",
158                         contact->aor, contact->uri);
159                 return NULL;
160         }
161
162         ast_string_field_set(status, uri, contact->uri);
163         status->rtt_start = ast_tv(0, 0);
164         status->rtt = 0;
165
166         if (ast_sorcery_create(ast_sip_get_sorcery(), status)) {
167                 ast_log(LOG_ERROR, "Unable to persist ast_sip_contact_status for contact %s\n",
168                         contact->uri);
169                 ao2_ref(status, -1);
170                 return NULL;
171         }
172
173         /* The permanent contact added after asterisk start should be qualified. */
174         if (ast_test_flag(&ast_options, AST_OPT_FLAG_FULLY_BOOTED) && ast_tvzero(contact->expiration_time)) {
175                 /*
176                  * The FULLY_BOOTED to filter out contacts that already existed when asterisk started.
177                  * The zero expiration_time to select only permanent contacts.
178                  */
179                 ao2_ref((struct ast_sip_contact *) contact, +1);
180                 if (ast_sip_push_task(NULL, qualify_and_schedule_aor_contact, (struct ast_sip_contact *) contact)) {
181                         ao2_ref((struct ast_sip_contact *) contact, -1);
182                 }
183         }
184
185         ast_statsd_log_string_va("PJSIP.contacts.states.%s", AST_STATSD_GAUGE,
186                 "+1", 1.0, ast_sip_get_contact_status_label(status->status));
187
188         return status;
189 }
190
191 /*!
192  * \internal
193  * \brief Update an ast_sip_contact_status's elements.
194  */
195 static void update_contact_status(const struct ast_sip_contact *contact,
196         enum ast_sip_contact_status_type value, int is_contact_refresh)
197 {
198         RAII_VAR(struct ast_sip_contact_status *, status, NULL, ao2_cleanup);
199         RAII_VAR(struct ast_sip_contact_status *, update, NULL, ao2_cleanup);
200
201         status = ast_res_pjsip_find_or_create_contact_status(contact);
202         if (!status) {
203                 ast_log(LOG_ERROR, "Unable to find ast_sip_contact_status for contact %s\n",
204                         contact->uri);
205                 return;
206         }
207
208         if (is_contact_refresh
209                 && status->status == CREATED) {
210                 /*
211                  * The contact status hasn't been updated since creation
212                  * and we don't want to re-send a created status.
213                  */
214                 if (contact->qualify_frequency
215                         || status->rtt_start.tv_sec > 0) {
216                         /* Ignore, the status will change soon. */
217                         return;
218                 }
219
220                 /*
221                  * Convert to a regular contact status update
222                  * because the status may never change.
223                  */
224                 is_contact_refresh = 0;
225                 value = UNKNOWN;
226         }
227
228         update = ast_sorcery_alloc(ast_sip_get_sorcery(), CONTACT_STATUS,
229                 ast_sorcery_object_get_id(status));
230         if (!update) {
231                 ast_log(LOG_ERROR, "Unable to allocate ast_sip_contact_status for contact %s\n",
232                         contact->uri);
233                 return;
234         }
235
236         ast_string_field_set(update, uri, contact->uri);
237
238         if (is_contact_refresh) {
239                 /* Copy everything just to set the refresh flag. */
240                 update->status = status->status;
241                 update->last_status = status->last_status;
242                 update->rtt = status->rtt;
243                 update->rtt_start = status->rtt_start;
244                 update->refresh = 1;
245         } else {
246                 update->last_status = status->status;
247                 update->status = value;
248
249                 /*
250                  * if the contact is available calculate the rtt as
251                  * the diff between the last start time and "now"
252                  */
253                 update->rtt = update->status == AVAILABLE && status->rtt_start.tv_sec > 0
254                         ? ast_tvdiff_us(ast_tvnow(), status->rtt_start)
255                         : 0;
256                 update->rtt_start = ast_tv(0, 0);
257
258                 ast_test_suite_event_notify("AOR_CONTACT_QUALIFY_RESULT",
259                         "Contact: %s\r\n"
260                         "Status: %s\r\n"
261                         "RTT: %" PRId64,
262                         ast_sorcery_object_get_id(update),
263                         ast_sip_get_contact_status_label(update->status),
264                         update->rtt);
265         }
266
267         if (ast_sorcery_update(ast_sip_get_sorcery(), update)) {
268                 ast_log(LOG_ERROR, "Unable to update ast_sip_contact_status for contact %s\n",
269                         contact->uri);
270         }
271 }
272
273 /*!
274  * \internal
275  * \brief Initialize the start time on a contact status so the round
276  *        trip time can be calculated upon a valid response.
277  */
278 static void init_start_time(const struct ast_sip_contact *contact)
279 {
280         RAII_VAR(struct ast_sip_contact_status *, status, NULL, ao2_cleanup);
281         RAII_VAR(struct ast_sip_contact_status *, update, NULL, ao2_cleanup);
282
283         status = ast_res_pjsip_find_or_create_contact_status(contact);
284         if (!status) {
285                 ast_log(LOG_ERROR, "Unable to find ast_sip_contact_status for contact %s\n",
286                         contact->uri);
287                 return;
288         }
289
290         update = ast_sorcery_alloc(ast_sip_get_sorcery(), CONTACT_STATUS,
291                 ast_sorcery_object_get_id(status));
292         if (!update) {
293                 ast_log(LOG_ERROR, "Unable to copy ast_sip_contact_status for contact %s\n",
294                         contact->uri);
295                 return;
296         }
297
298         ast_string_field_set(status, uri, contact->uri);
299         update->status = status->status;
300         update->last_status = status->last_status;
301         update->rtt = status->rtt;
302         update->rtt_start = ast_tvnow();
303
304         if (ast_sorcery_update(ast_sip_get_sorcery(), update)) {
305                 ast_log(LOG_ERROR, "Unable to update ast_sip_contact_status for contact %s\n",
306                         contact->uri);
307         }
308 }
309
310 /*!
311  * \internal
312  * \brief For an endpoint try to match the given contact->aor.
313  */
314 static int on_endpoint(void *obj, void *arg, int flags)
315 {
316         struct ast_sip_endpoint *endpoint = obj;
317         char *contact_aor = arg;
318         char *aor_name;
319         char *aors;
320
321         if (!arg || ast_strlen_zero(endpoint->aors)) {
322                 return 0;
323         }
324
325         aors = ast_strdupa(endpoint->aors);
326         while ((aor_name = ast_strip(strsep(&aors, ",")))) {
327                 if (!strcmp(contact_aor, aor_name)) {
328                         return CMP_MATCH;
329                 }
330         }
331
332         return 0;
333 }
334
335 /*!
336  * \internal
337  * \brief Find an endpoint associated with the given contact.
338  */
339 static struct ast_sip_endpoint *find_an_endpoint(struct ast_sip_contact *contact)
340 {
341         struct ao2_container *endpoints;
342         struct ast_sip_endpoint *endpoint;
343         struct ast_variable *var;
344         char *aor = ast_alloca(strlen(contact->aor) + 3);
345
346         sprintf(aor, "%%%s%%", contact->aor);
347         var = ast_variable_new("aors LIKE", aor, "");
348         endpoints = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(),
349                 "endpoint", AST_RETRIEVE_FLAG_MULTIPLE, var);
350
351         ast_variables_destroy(var);
352
353         /*
354          * Because aors are a string list, we have to use a pattern match but since a simple
355          * pattern match could return an endpoint that has an aor of "aaabccc" when searching
356          * for "abc", we still have to iterate over them to find an exact aor match.
357          */
358         endpoint = ao2_callback(endpoints, 0, on_endpoint, (char *)contact->aor);
359         ao2_ref(endpoints, -1);
360
361         return endpoint;
362 }
363
364 /*!
365  * \internal
366  * \brief Receive a response to the qualify contact request.
367  */
368 static void qualify_contact_cb(void *token, pjsip_event *e)
369 {
370         struct ast_sip_contact *contact = token;
371
372         switch(e->body.tsx_state.type) {
373         default:
374                 ast_log(LOG_ERROR, "Unexpected PJSIP event %u\n", e->body.tsx_state.type);
375                 /* Fall through */
376         case PJSIP_EVENT_TRANSPORT_ERROR:
377         case PJSIP_EVENT_TIMER:
378                 update_contact_status(contact, UNAVAILABLE, 0);
379                 break;
380         case PJSIP_EVENT_RX_MSG:
381                 update_contact_status(contact, AVAILABLE, 0);
382                 break;
383         }
384         ao2_cleanup(contact);
385 }
386
387 /*!
388  * \internal
389  * \brief Attempt to qualify the contact
390  *
391  * \details Sends a SIP OPTIONS request to the given contact in order to make
392  *         sure that contact is available.
393  */
394 static int qualify_contact(struct ast_sip_endpoint *endpoint, struct ast_sip_contact *contact)
395 {
396         pjsip_tx_data *tdata;
397         RAII_VAR(struct ast_sip_endpoint *, endpoint_local, NULL, ao2_cleanup);
398
399         if (endpoint) {
400                 endpoint_local = ao2_bump(endpoint);
401         } else {
402                 if (!ast_strlen_zero(contact->endpoint_name)) {
403                         endpoint_local = ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "endpoint", contact->endpoint_name);
404                 }
405                 if (!endpoint_local) {
406                         endpoint_local = find_an_endpoint(contact);
407                 }
408                 if (!endpoint_local) {
409                         ast_log(LOG_WARNING, "Unable to find an endpoint to qualify contact %s. Deleting this contact\n",
410                                 contact->uri);
411                         contact_deleted(contact);
412                         return -1;
413                 }
414         }
415
416         if (ast_sip_create_request("OPTIONS", NULL, endpoint_local, NULL, contact, &tdata)) {
417                 ast_log(LOG_ERROR, "Unable to create request to qualify contact %s\n",
418                         contact->uri);
419                 return -1;
420         }
421
422         /* If an outbound proxy is specified set it on this request */
423         if (!ast_strlen_zero(contact->outbound_proxy) &&
424                 ast_sip_set_outbound_proxy(tdata, contact->outbound_proxy)) {
425                 pjsip_tx_data_dec_ref(tdata);
426                 ast_log(LOG_ERROR, "Unable to apply outbound proxy on request to qualify contact %s\n",
427                         contact->uri);
428                 return -1;
429         }
430
431         init_start_time(contact);
432
433         ao2_ref(contact, +1);
434         if (ast_sip_send_out_of_dialog_request(tdata, endpoint_local, (int)(contact->qualify_timeout * 1000), contact, qualify_contact_cb)
435                 != PJ_SUCCESS) {
436                 ast_log(LOG_ERROR, "Unable to send request to qualify contact %s\n",
437                         contact->uri);
438                 update_contact_status(contact, UNAVAILABLE, 0);
439                 ao2_ref(contact, -1);
440                 return -1;
441         }
442
443         return 0;
444 }
445
446 /*!
447  * \internal
448  * \brief Scheduling context for sending QUALIFY request at specified intervals.
449  */
450 static struct ast_sched_context *sched;
451
452 /*!
453  * \internal
454  * \brief Container to hold all actively scheduled qualifies.
455  */
456 static struct ao2_container *sched_qualifies;
457
458 /*!
459  * \internal
460  * \brief Structure to hold qualify contact scheduling information.
461  */
462 struct sched_data {
463         /*! The scheduling id */
464         int id;
465         /*! The the contact being checked */
466         struct ast_sip_contact *contact;
467 };
468
469 /*!
470  * \internal
471  * \brief Destroy the scheduled data and remove from scheduler.
472  */
473 static void sched_data_destructor(void *obj)
474 {
475         struct sched_data *data = obj;
476
477         ao2_cleanup(data->contact);
478 }
479 /*!
480  * \internal
481  * \brief Create the scheduling data object.
482  */
483 static struct sched_data *sched_data_create(struct ast_sip_contact *contact)
484 {
485         struct sched_data *data;
486
487         data = ao2_t_alloc(sizeof(*data), sched_data_destructor, contact->uri);
488         if (!data) {
489                 ast_log(LOG_ERROR, "Unable to create schedule qualify data for contact %s\n",
490                         contact->uri);
491                 return NULL;
492         }
493
494         data->contact = contact;
495         ao2_ref(data->contact, +1);
496
497         return data;
498 }
499
500 /*!
501  * \internal
502  * \brief Send a qualify contact request within a threaded task.
503  */
504 static int qualify_contact_task(void *obj)
505 {
506         struct ast_sip_contact *contact = obj;
507         int res;
508
509         res = qualify_contact(NULL, contact);
510         ao2_ref(contact, -1);
511         return res;
512 }
513
514 /*!
515  * \internal
516  * \brief Send a scheduled qualify contact request.
517  */
518 static int qualify_contact_sched(const void *obj)
519 {
520         struct sched_data *data = (struct sched_data *) obj;
521
522         ao2_ref(data->contact, +1);
523         if (ast_sip_push_task(NULL, qualify_contact_task, data->contact)) {
524                 ao2_ref(data->contact, -1);
525         }
526
527         /*
528          * Always reschedule rather than have a potential race cleaning
529          * up the data object ref between self deletion and an external
530          * deletion.
531          */
532         return data->contact->qualify_frequency * 1000;
533 }
534
535 /*!
536  * \internal
537  * \brief Set up a scheduled qualify contact check.
538  */
539 static void schedule_qualify(struct ast_sip_contact *contact, int initial_interval)
540 {
541         struct sched_data *data;
542
543         data = sched_data_create(contact);
544         if (!data) {
545                 return;
546         }
547
548         ast_assert(contact->qualify_frequency != 0);
549
550         ao2_t_ref(data, +1, "Ref for qualify_contact_sched() scheduler entry");
551         data->id = ast_sched_add_variable(sched, initial_interval,
552                 qualify_contact_sched, data, 1);
553         if (data->id < 0) {
554                 ao2_t_ref(data, -1, "Cleanup failed scheduler add");
555                 ast_log(LOG_ERROR, "Unable to schedule qualify for contact %s\n",
556                         contact->uri);
557         } else if (!ao2_link(sched_qualifies, data)) {
558                 AST_SCHED_DEL_UNREF(sched, data->id,
559                         ao2_t_ref(data, -1, "Cleanup scheduler for failed ao2_link"));
560         }
561         ao2_t_ref(data, -1, "Done setting up scheduler entry");
562 }
563
564 /*!
565  * \internal
566  * \brief Remove the contact from the scheduler.
567  */
568 static void unschedule_qualify(struct ast_sip_contact *contact)
569 {
570         struct sched_data *data;
571
572         data = ao2_find(sched_qualifies, contact, OBJ_UNLINK | OBJ_SEARCH_KEY);
573         if (!data) {
574                 return;
575         }
576
577         AST_SCHED_DEL_UNREF(sched, data->id,
578                 ao2_t_ref(data, -1, "Delete scheduler entry ref"));
579         ao2_t_ref(data, -1, "Done with ao2_find ref");
580 }
581
582 /*!
583  * \internal
584  * \brief Qualify the given contact and set up scheduling if configured.
585  */
586 static void qualify_and_schedule(struct ast_sip_contact *contact)
587 {
588         unschedule_qualify(contact);
589
590         if (contact->qualify_frequency) {
591                 ao2_ref(contact, +1);
592                 if (ast_sip_push_task(NULL, qualify_contact_task, contact)) {
593                         ao2_ref(contact, -1);
594                 }
595
596                 schedule_qualify(contact, contact->qualify_frequency * 1000);
597         } else {
598                 update_contact_status(contact, UNKNOWN, 0);
599         }
600 }
601
602 /*!
603  * \internal
604  * \brief A new contact has been created make sure it is available.
605  */
606 static void contact_created(const void *obj)
607 {
608         qualify_and_schedule((struct ast_sip_contact *) obj);
609 }
610
611 /*!
612  * \internal
613  * \brief A contact has been updated.
614  */
615 static void contact_updated(const void *obj)
616 {
617         update_contact_status(obj, AVAILABLE, 1);
618 }
619
620 /*!
621  * \internal
622  * \brief A contact has been deleted remove status tracking.
623  */
624 static void contact_deleted(const void *obj)
625 {
626         struct ast_sip_contact *contact = (struct ast_sip_contact *) obj;
627         struct ast_sip_contact_status *status;
628
629         unschedule_qualify(contact);
630
631         status = ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), CONTACT_STATUS,
632                 ast_sorcery_object_get_id(contact));
633         if (!status) {
634                 return;
635         }
636
637         if (ast_sorcery_delete(ast_sip_get_sorcery(), status)) {
638                 ast_log(LOG_ERROR, "Unable to delete ast_sip_contact_status for contact %s\n",
639                         contact->uri);
640         }
641         ao2_ref(status, -1);
642 }
643
644 static const struct ast_sorcery_observer contact_observer = {
645         .created = contact_created,
646         .updated = contact_updated,
647         .deleted = contact_deleted,
648 };
649
650 static pj_bool_t options_start(void)
651 {
652         sched = ast_sched_context_create();
653         if (!sched) {
654                 return -1;
655         }
656         if (ast_sched_start_thread(sched)) {
657                 ast_sched_context_destroy(sched);
658                 sched = NULL;
659                 return -1;
660         }
661
662         if (ast_sorcery_observer_add(ast_sip_get_sorcery(), "contact", &contact_observer)) {
663                 ast_log(LOG_WARNING, "Unable to add contact observer\n");
664                 ast_sched_context_destroy(sched);
665                 sched = NULL;
666                 return -1;
667         }
668
669         return PJ_SUCCESS;
670 }
671
672 static int sched_qualifies_empty(void *obj, void *arg, int flags)
673 {
674         ao2_t_ref(obj, -1, "Release ref held by destroyed scheduler context.");
675         return CMP_MATCH;
676 }
677
678 static pj_bool_t options_stop(void)
679 {
680         ast_sorcery_observer_remove(ast_sip_get_sorcery(), "contact", &contact_observer);
681
682         if (sched) {
683                 ast_sched_context_destroy(sched);
684                 sched = NULL;
685         }
686
687         /* Empty the container of scheduling data refs. */
688         ao2_callback(sched_qualifies, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE,
689                 sched_qualifies_empty, NULL);
690
691         return PJ_SUCCESS;
692 }
693
694 static pj_status_t send_options_response(pjsip_rx_data *rdata, int code)
695 {
696         pjsip_endpoint *endpt = ast_sip_get_pjsip_endpoint();
697         pjsip_dialog *dlg = pjsip_rdata_get_dlg(rdata);
698         pjsip_transaction *trans = pjsip_rdata_get_tsx(rdata);
699         pjsip_tx_data *tdata;
700         const pjsip_hdr *hdr;
701         pj_status_t status;
702
703         /* Make the response object */
704         if ((status = ast_sip_create_response(rdata, code, NULL, &tdata) != PJ_SUCCESS)) {
705                 ast_log(LOG_ERROR, "Unable to create response (%d)\n", status);
706                 return status;
707         }
708
709         /* Add appropriate headers */
710         if ((hdr = pjsip_endpt_get_capability(endpt, PJSIP_H_ACCEPT, NULL))) {
711                 pjsip_msg_add_hdr(tdata->msg, (pjsip_hdr*)pjsip_hdr_clone(tdata->pool, hdr));
712         }
713         if ((hdr = pjsip_endpt_get_capability(endpt, PJSIP_H_ALLOW, NULL))) {
714                 pjsip_msg_add_hdr(tdata->msg, (pjsip_hdr*)pjsip_hdr_clone(tdata->pool, hdr));
715         }
716         if ((hdr = pjsip_endpt_get_capability(endpt, PJSIP_H_SUPPORTED, NULL))) {
717                 pjsip_msg_add_hdr(tdata->msg, (pjsip_hdr*)pjsip_hdr_clone(tdata->pool, hdr));
718         }
719
720         /*
721          * XXX TODO: pjsip doesn't care a lot about either of these headers -
722          * while it provides specific methods to create them, they are defined
723          * to be the standard string header creation. We never did add them
724          * in chan_sip, although RFC 3261 says they SHOULD. Hard coded here.
725          */
726         ast_sip_add_header(tdata, "Accept-Encoding", DEFAULT_ENCODING);
727         ast_sip_add_header(tdata, "Accept-Language", DEFAULT_LANGUAGE);
728
729         if (dlg && trans) {
730                 status = pjsip_dlg_send_response(dlg, trans, tdata);
731         } else {
732                 struct ast_sip_endpoint *endpoint;
733
734                 endpoint = ast_pjsip_rdata_get_endpoint(rdata);
735                 status = ast_sip_send_stateful_response(rdata, tdata, endpoint);
736                 ao2_cleanup(endpoint);
737         }
738
739         if (status != PJ_SUCCESS) {
740                 ast_log(LOG_ERROR, "Unable to send response (%d)\n", status);
741         }
742
743         return status;
744 }
745
746 static pj_bool_t options_on_rx_request(pjsip_rx_data *rdata)
747 {
748         RAII_VAR(struct ast_sip_endpoint *, endpoint, NULL, ao2_cleanup);
749         pjsip_uri *ruri;
750         pjsip_sip_uri *sip_ruri;
751         char exten[AST_MAX_EXTENSION];
752
753         if (pjsip_method_cmp(&rdata->msg_info.msg->line.req.method, &pjsip_options_method)) {
754                 return PJ_FALSE;
755         }
756
757         if (!(endpoint = ast_pjsip_rdata_get_endpoint(rdata))) {
758                 return PJ_FALSE;
759         }
760
761         ruri = rdata->msg_info.msg->line.req.uri;
762         if (!PJSIP_URI_SCHEME_IS_SIP(ruri) && !PJSIP_URI_SCHEME_IS_SIPS(ruri)) {
763                 send_options_response(rdata, 416);
764                 return PJ_TRUE;
765         }
766
767         sip_ruri = pjsip_uri_get_uri(ruri);
768         ast_copy_pj_str(exten, &sip_ruri->user, sizeof(exten));
769
770         /*
771          * We may want to match in the dialplan without any user
772          * options getting in the way.
773          */
774         AST_SIP_USER_OPTIONS_TRUNCATE_CHECK(exten);
775
776         if (ast_shutting_down()) {
777                 /*
778                  * Not taking any new calls at this time.
779                  * Likely a server availability OPTIONS poll.
780                  */
781                 send_options_response(rdata, 503);
782         } else if (!ast_strlen_zero(exten)
783                 && !ast_exists_extension(NULL, endpoint->context, exten, 1, NULL)) {
784                 send_options_response(rdata, 404);
785         } else {
786                 send_options_response(rdata, 200);
787         }
788         return PJ_TRUE;
789 }
790
791 static pjsip_module options_module = {
792         .name = {"Options Module", 14},
793         .id = -1,
794         .priority = PJSIP_MOD_PRIORITY_APPLICATION,
795         .start = options_start,
796         .stop = options_stop,
797         .on_rx_request = options_on_rx_request,
798 };
799
800 /*!
801  * \internal
802  * \brief Send qualify request to the given contact.
803  */
804 static int cli_on_contact(void *obj, void *arg, void *data, int flags)
805 {
806         struct ast_sip_contact *contact = obj;
807         struct ast_sip_endpoint *endpoint = data;
808         int *cli_fd = arg;
809
810         ast_cli(*cli_fd, " contact %s\n", contact->uri);
811         qualify_contact(endpoint, contact);
812         return 0;
813 }
814
815 /*!
816  * \brief Data pushed to threadpool to qualify endpoints from the CLI
817  */
818 struct qualify_data {
819         /*! Endpoint that is being qualified */
820         struct ast_sip_endpoint *endpoint;
821         /*! CLI File descriptor for printing messages */
822         int cli_fd;
823 };
824
825 static struct qualify_data *qualify_data_alloc(struct ast_sip_endpoint *endpoint, int cli_fd)
826 {
827         struct qualify_data *qual_data;
828
829         qual_data = ast_malloc(sizeof(*qual_data));
830         if (!qual_data) {
831                 return NULL;
832         }
833
834         qual_data->endpoint = ao2_bump(endpoint);
835         qual_data->cli_fd = cli_fd;
836         return qual_data;
837 }
838
839 static void qualify_data_destroy(struct qualify_data *qual_data)
840 {
841         ao2_cleanup(qual_data->endpoint);
842         ast_free(qual_data);
843 }
844
845 /*!
846  * \internal
847  * \brief For an endpoint iterate over and qualify all aors/contacts
848  */
849 static int cli_qualify_contacts(void *data)
850 {
851         char *aors;
852         char *aor_name;
853         RAII_VAR(struct qualify_data *, qual_data, data, qualify_data_destroy);
854         struct ast_sip_endpoint *endpoint = qual_data->endpoint;
855         int cli_fd = qual_data->cli_fd;
856         const char *endpoint_name = ast_sorcery_object_get_id(endpoint);
857
858         if (ast_strlen_zero(endpoint->aors)) {
859                 ast_cli(cli_fd, "Endpoint %s has no AoR's configured\n",
860                         endpoint_name);
861                 return 0;
862         }
863
864         aors = ast_strdupa(endpoint->aors);
865         while ((aor_name = ast_strip(strsep(&aors, ",")))) {
866                 struct ast_sip_aor *aor;
867                 struct ao2_container *contacts;
868
869                 aor = ast_sip_location_retrieve_aor(aor_name);
870                 if (!aor) {
871                         continue;
872                 }
873
874                 contacts = ast_sip_location_retrieve_aor_contacts(aor);
875                 if (contacts) {
876                         ast_cli(cli_fd, "Sending qualify to endpoint %s\n", endpoint_name);
877                         ao2_callback_data(contacts, OBJ_NODATA, cli_on_contact, &cli_fd, endpoint);
878                         ao2_ref(contacts, -1);
879                 }
880
881                 ao2_ref(aor, -1);
882         }
883         return 0;
884 }
885
886 static char *cli_qualify(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
887 {
888         RAII_VAR(struct ast_sip_endpoint *, endpoint, NULL, ao2_cleanup);
889         const char *endpoint_name;
890         struct qualify_data *qual_data;
891
892         switch (cmd) {
893         case CLI_INIT:
894                 e->command = "pjsip qualify";
895                 e->usage =
896                         "Usage: pjsip qualify <endpoint>\n"
897                         "       Send a SIP OPTIONS request to all contacts on the endpoint.\n";
898                 return NULL;
899         case CLI_GENERATE:
900                 return NULL;
901         }
902
903         if (a->argc != 3) {
904                 return CLI_SHOWUSAGE;
905         }
906
907         endpoint_name = a->argv[2];
908
909         if (!(endpoint = ast_sorcery_retrieve_by_id(
910                       ast_sip_get_sorcery(), "endpoint", endpoint_name))) {
911                 ast_cli(a->fd, "Unable to retrieve endpoint %s\n", endpoint_name);
912                 return CLI_FAILURE;
913         }
914
915         qual_data = qualify_data_alloc(endpoint, a->fd);
916         if (!qual_data) {
917                 return CLI_FAILURE;
918         }
919
920         if (ast_sip_push_task(NULL, cli_qualify_contacts, qual_data)) {
921                 qualify_data_destroy(qual_data);
922                 return CLI_FAILURE;
923         }
924
925         return CLI_SUCCESS;
926 }
927
928 /*!
929  * \internal
930  * \brief Send qualify request to the given contact.
931  */
932 static int ami_contact_cb(void *obj, void *arg, int flags)
933 {
934         struct ast_sip_contact *contact = obj;
935
936         ao2_ref(contact, +1);
937         if (ast_sip_push_task(NULL, qualify_contact_task, contact)) {
938                 ao2_ref(contact, -1);
939         }
940         return 0;
941 }
942
943 static int ami_sip_qualify(struct mansession *s, const struct message *m)
944 {
945         const char *endpoint_name = astman_get_header(m, "Endpoint");
946         RAII_VAR(struct ast_sip_endpoint *, endpoint, NULL, ao2_cleanup);
947         char *aors;
948         char *aor_name;
949
950         if (ast_strlen_zero(endpoint_name)) {
951                 astman_send_error(s, m, "Endpoint parameter missing.");
952                 return 0;
953         }
954
955         endpoint = ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "endpoint",
956                 endpoint_name);
957         if (!endpoint) {
958                 astman_send_error(s, m, "Unable to retrieve endpoint\n");
959                 return 0;
960         }
961
962         /* send a qualify for all contacts registered with the endpoint */
963         if (ast_strlen_zero(endpoint->aors)) {
964                 astman_send_error(s, m, "No AoRs configured for endpoint\n");
965                 return 0;
966         }
967
968         aors = ast_strdupa(endpoint->aors);
969         while ((aor_name = ast_strip(strsep(&aors, ",")))) {
970                 struct ast_sip_aor *aor;
971                 struct ao2_container *contacts;
972
973                 aor = ast_sip_location_retrieve_aor(aor_name);
974                 if (!aor) {
975                         continue;
976                 }
977
978                 contacts = ast_sip_location_retrieve_aor_contacts(aor);
979                 if (contacts) {
980                         ao2_callback(contacts, OBJ_NODATA, ami_contact_cb, NULL);
981                         ao2_ref(contacts, -1);
982                 }
983
984                 ao2_ref(aor, -1);
985         }
986
987         astman_send_ack(s, m, "Endpoint found, will qualify");
988         return 0;
989 }
990
991 static struct ast_cli_entry cli_options[] = {
992         AST_CLI_DEFINE(cli_qualify, "Send an OPTIONS request to a PJSIP endpoint")
993 };
994
995 static int sched_qualifies_hash_fn(const void *obj, int flags)
996 {
997         const struct sched_data *object;
998         const struct ast_sip_contact *key;
999
1000         switch (flags & OBJ_SEARCH_MASK) {
1001         case OBJ_SEARCH_KEY:
1002                 key = obj;
1003                 break;
1004         case OBJ_SEARCH_OBJECT:
1005                 object = obj;
1006                 key = object->contact;
1007                 break;
1008         default:
1009                 /* Hash can only work on something with a full key. */
1010                 ast_assert(0);
1011                 return 0;
1012         }
1013         return ast_str_hash(ast_sorcery_object_get_id(key));
1014 }
1015
1016 static int sched_qualifies_cmp_fn(void *obj, void *arg, int flags)
1017 {
1018         const struct sched_data *object_left = obj;
1019         const struct sched_data *object_right = arg;
1020         struct ast_sip_contact *right_key = arg;
1021         int cmp;
1022
1023         switch (flags & OBJ_SEARCH_MASK) {
1024         case OBJ_SEARCH_OBJECT:
1025                 right_key = object_right->contact;
1026                 /* Fall through */
1027         case OBJ_SEARCH_KEY:
1028                 cmp = strcmp(ast_sorcery_object_get_id(object_left->contact),
1029                         ast_sorcery_object_get_id(right_key));
1030                 break;
1031         case OBJ_SEARCH_PARTIAL_KEY:
1032                 /* Not supported by container. */
1033                 ast_assert(0);
1034                 return 0;
1035         default:
1036                 /*
1037                  * What arg points to is specific to this traversal callback
1038                  * and has no special meaning to astobj2.
1039                  */
1040                 cmp = 0;
1041                 break;
1042         }
1043         if (cmp) {
1044                 return 0;
1045         }
1046         /*
1047          * At this point the traversal callback is identical to a sorted
1048          * container.
1049          */
1050         return CMP_MATCH;
1051 }
1052
1053 static int rtt_start_handler(const struct aco_option *opt,
1054         struct ast_variable *var, void *obj)
1055 {
1056         struct ast_sip_contact_status *status = obj;
1057         long int sec, usec;
1058
1059         if (sscanf(var->value, "%ld.%06ld", &sec, &usec) != 2) {
1060                 return -1;
1061         }
1062
1063         status->rtt_start = ast_tv(sec, usec);
1064
1065         return 0;
1066 }
1067
1068 static int rtt_start_to_str(const void *obj, const intptr_t *args, char **buf)
1069 {
1070         const struct ast_sip_contact_status *status = obj;
1071
1072         if (ast_asprintf(buf, "%ld.%06ld", (long)status->rtt_start.tv_sec, (long)status->rtt_start.tv_usec) == -1) {
1073                 return -1;
1074         }
1075
1076         return 0;
1077 }
1078
1079 static char status_value_unknown[2];
1080 static char status_value_created[2];
1081
1082 int ast_sip_initialize_sorcery_qualify(void)
1083 {
1084         struct ast_sorcery *sorcery = ast_sip_get_sorcery();
1085
1086         /* initialize sorcery ast_sip_contact_status resource */
1087         ast_sorcery_apply_default(sorcery, CONTACT_STATUS, "memory", NULL);
1088         ast_sorcery_object_set_congestion_levels(sorcery, CONTACT_STATUS, -1,
1089                 3 * AST_TASKPROCESSOR_HIGH_WATER_LEVEL);
1090
1091         if (ast_sorcery_internal_object_register(sorcery, CONTACT_STATUS,
1092                                         contact_status_alloc, NULL, NULL)) {
1093                 ast_log(LOG_ERROR, "Unable to register ast_sip_contact_status in sorcery\n");
1094                 return -1;
1095         }
1096
1097         snprintf(status_value_unknown, sizeof(status_value_unknown), "%u", UNKNOWN);
1098         ast_sorcery_object_field_register_nodoc(sorcery, CONTACT_STATUS, "last_status",
1099                 status_value_unknown, OPT_UINT_T, 0, FLDSET(struct ast_sip_contact_status, last_status));
1100         snprintf(status_value_created, sizeof(status_value_created), "%u", CREATED);
1101         ast_sorcery_object_field_register_nodoc(sorcery, CONTACT_STATUS, "status",
1102                 status_value_created, OPT_UINT_T, 0, FLDSET(struct ast_sip_contact_status, status));
1103         ast_sorcery_object_field_register_custom_nodoc(sorcery, CONTACT_STATUS, "rtt_start",
1104                 "0.0", rtt_start_handler, rtt_start_to_str, NULL, 0, 0);
1105         ast_sorcery_object_field_register_nodoc(sorcery, CONTACT_STATUS, "rtt",
1106                 "0", OPT_UINT_T, 0, FLDSET(struct ast_sip_contact_status, rtt));
1107
1108         return 0;
1109 }
1110
1111 static void qualify_and_schedule_contact(struct ast_sip_contact *contact)
1112 {
1113         int initial_interval;
1114         int max_time = ast_sip_get_max_initial_qualify_time();
1115
1116         /* Delay initial qualification by a random fraction of the specified interval */
1117         if (max_time && max_time < contact->qualify_frequency) {
1118                 initial_interval = max_time;
1119         } else {
1120                 initial_interval = contact->qualify_frequency;
1121         }
1122
1123         initial_interval = (int)((initial_interval * 1000) * ast_random_double());
1124
1125         unschedule_qualify(contact);
1126         if (contact->qualify_frequency) {
1127                 schedule_qualify(contact, initial_interval);
1128         } else {
1129                 update_contact_status(contact, UNKNOWN, 0);
1130         }
1131 }
1132
1133 static int qualify_and_schedule_cb_with_aor(void *obj, void *arg, int flags)
1134 {
1135         struct ast_sip_contact *contact = obj;
1136         struct ast_sip_aor *aor = arg;
1137
1138         contact->qualify_frequency = aor->qualify_frequency;
1139         contact->qualify_timeout = aor->qualify_timeout;
1140         contact->authenticate_qualify = aor->authenticate_qualify;
1141
1142         qualify_and_schedule_contact(contact);
1143
1144         return 0;
1145 }
1146
1147 static int qualify_and_schedule_cb_without_aor(void *obj, void *arg, int flags)
1148 {
1149         qualify_and_schedule_contact((struct ast_sip_contact *) obj);
1150
1151         return 0;
1152 }
1153
1154 /*!
1155  * \internal
1156  * \brief Qualify and schedule an aor's contacts
1157  *
1158  * \details For the given aor check if it has permanent contacts,
1159  *         qualify all contacts and schedule for checks if configured.
1160  */
1161 static int qualify_and_schedule_all_cb(void *obj, void *arg, int flags)
1162 {
1163         struct ast_sip_aor *aor = obj;
1164         struct ao2_container *contacts;
1165
1166         if (aor->permanent_contacts) {
1167                 contacts = ast_sip_location_retrieve_aor_contacts(aor);
1168                 if (contacts) {
1169                         ao2_callback(contacts, OBJ_NODATA, qualify_and_schedule_cb_with_aor, aor);
1170                         ao2_ref(contacts, -1);
1171                 }
1172         }
1173
1174         return 0;
1175 }
1176
1177 /*!
1178  * \internal
1179  * \brief Unschedule all existing contacts
1180  */
1181 static int unschedule_all_cb(void *obj, void *arg, int flags)
1182 {
1183         struct sched_data *data = obj;
1184
1185         AST_SCHED_DEL_UNREF(sched, data->id, ao2_ref(data, -1));
1186
1187         return CMP_MATCH;
1188 }
1189
1190 static void qualify_and_schedule_all(void)
1191 {
1192         struct ast_variable *var = ast_variable_new("qualify_frequency >", "0", "");
1193         struct ao2_container *aors;
1194         struct ao2_container *contacts;
1195
1196         if (!var) {
1197                 return;
1198         }
1199         aors = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(),
1200                 "aor", AST_RETRIEVE_FLAG_MULTIPLE, var);
1201
1202         ao2_callback(sched_qualifies, OBJ_NODATA | OBJ_MULTIPLE | OBJ_UNLINK, unschedule_all_cb, NULL);
1203
1204         if (aors) {
1205                 ao2_callback(aors, OBJ_NODATA, qualify_and_schedule_all_cb, NULL);
1206                 ao2_ref(aors, -1);
1207         }
1208
1209         contacts = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(),
1210                 "contact", AST_RETRIEVE_FLAG_MULTIPLE, var);
1211         if (contacts) {
1212                 ao2_callback(contacts, OBJ_NODATA, qualify_and_schedule_cb_without_aor, NULL);
1213                 ao2_ref(contacts, -1);
1214         }
1215
1216         ast_variables_destroy(var);
1217
1218 }
1219
1220 static int format_contact_status(void *obj, void *arg, int flags)
1221 {
1222         struct ast_sip_contact_wrapper *wrapper = obj;
1223         struct ast_sip_contact *contact = wrapper->contact;
1224         struct ast_sip_ami *ami = arg;
1225         struct ast_sip_contact_status *status;
1226         struct ast_str *buf;
1227         const struct ast_sip_endpoint *endpoint = ami->arg;
1228
1229         buf = ast_sip_create_ami_event("ContactStatusDetail", ami);
1230         if (!buf) {
1231                 return -1;
1232         }
1233
1234         status = ast_sorcery_retrieve_by_id(
1235                 ast_sip_get_sorcery(), CONTACT_STATUS,
1236                 ast_sorcery_object_get_id(contact));
1237
1238         ast_str_append(&buf, 0, "AOR: %s\r\n", wrapper->aor_id);
1239         ast_str_append(&buf, 0, "URI: %s\r\n", contact->uri);
1240         ast_str_append(&buf, 0, "UserAgent: %s\r\n", contact->user_agent);
1241         ast_str_append(&buf, 0, "RegExpire: %ld\r\n", contact->expiration_time.tv_sec);
1242         if (!ast_strlen_zero(contact->via_addr)) {
1243                 ast_str_append(&buf, 0, "ViaAddress: %s", contact->via_addr);
1244                 if (contact->via_port) {
1245                         ast_str_append(&buf, 0, ":%d", contact->via_port);
1246                 }
1247                 ast_str_append(&buf, 0, "\r\n");
1248         }
1249         if (!ast_strlen_zero(contact->call_id)) {
1250                 ast_str_append(&buf, 0, "CallID: %s\r\n", contact->call_id);
1251         }
1252         ast_str_append(&buf, 0, "Status: %s\r\n", ast_sip_get_contact_status_label(status->status));
1253         if (status->status == UNKNOWN) {
1254                 ast_str_append(&buf, 0, "RoundtripUsec: N/A\r\n");
1255         } else {
1256                 ast_str_append(&buf, 0, "RoundtripUsec: %" PRId64 "\r\n", status->rtt);
1257         }
1258         ast_str_append(&buf, 0, "EndpointName: %s\r\n",
1259                         ast_sorcery_object_get_id(endpoint));
1260         astman_append(ami->s, "%s\r\n", ast_str_buffer(buf));
1261         ami->count++;
1262         
1263         ast_free(buf);
1264         ao2_cleanup(status);
1265         return 0;
1266 }
1267
1268 static int format_contact_status_for_aor(void *obj, void *arg, int flags)
1269 {
1270         struct ast_sip_aor *aor = obj;
1271
1272         return ast_sip_for_each_contact(aor, format_contact_status, arg);
1273 }
1274
1275 static int format_ami_contact_status(const struct ast_sip_endpoint *endpoint,
1276                 struct ast_sip_ami *ami)
1277 {
1278         ami->arg = (void *)endpoint;
1279         return ast_sip_for_each_aor(endpoint->aors, format_contact_status_for_aor, ami);
1280 }
1281
1282 static struct ast_sip_endpoint_formatter contact_status_formatter = {
1283         .format_ami = format_ami_contact_status
1284 };
1285
1286 static void aor_observer_modified(const void *obj)
1287 {
1288         struct ast_sip_aor *aor = (void *)obj;
1289         struct ao2_container *contacts;
1290
1291         contacts = ast_sip_location_retrieve_aor_contacts(aor);
1292         if (contacts) {
1293                 ao2_callback(contacts, OBJ_NODATA, qualify_and_schedule_cb_with_aor, aor);
1294                 ao2_ref(contacts, -1);
1295         }
1296 }
1297
1298 static int unschedule_contact_cb(void *obj, void *arg, int flags)
1299 {
1300         unschedule_qualify(obj);
1301
1302         return CMP_MATCH;
1303 }
1304
1305 static void aor_observer_deleted(const void *obj)
1306 {
1307         const struct ast_sip_aor *aor = obj;
1308         struct ao2_container *contacts;
1309
1310         contacts = ast_sip_location_retrieve_aor_contacts(aor);
1311         if (contacts) {
1312                 ao2_callback(contacts, OBJ_NODATA | OBJ_MULTIPLE, unschedule_contact_cb, NULL);
1313                 ao2_ref(contacts, -1);
1314         }
1315 }
1316
1317 static const struct ast_sorcery_observer observer_callbacks_options = {
1318         .created = aor_observer_modified,
1319         .updated = aor_observer_modified,
1320         .deleted = aor_observer_deleted
1321 };
1322
1323 static int aor_update_endpoint_state(void *obj, void *arg, int flags)
1324 {
1325         struct ast_sip_endpoint *endpoint = obj;
1326         const char *endpoint_name = ast_sorcery_object_get_id(endpoint);
1327         char *aor = arg;
1328         char *endpoint_aor;
1329         char *endpoint_aors;
1330
1331         if (ast_strlen_zero(aor) || ast_strlen_zero(endpoint->aors)) {
1332                 return 0;
1333         }
1334
1335         endpoint_aors = ast_strdupa(endpoint->aors);
1336         while ((endpoint_aor = ast_strip(strsep(&endpoint_aors, ",")))) {
1337                 if (!strcmp(aor, endpoint_aor)) {
1338                         if (ast_sip_persistent_endpoint_update_state(endpoint_name, AST_ENDPOINT_ONLINE) == -1) {
1339                                 ast_log(LOG_WARNING, "Unable to find persistent endpoint '%s' for aor '%s'\n",
1340                                         endpoint_name, aor);
1341                         }
1342                 }
1343         }
1344
1345         return 0;
1346 }
1347
1348 static int on_aor_update_endpoint_state(void *obj, void *arg, int flags)
1349 {
1350         struct ast_sip_aor *aor = obj;
1351         struct ao2_container *endpoints;
1352         RAII_VAR(struct ast_variable *, var, NULL, ast_variables_destroy);
1353         const char *aor_name = ast_sorcery_object_get_id(aor);
1354         char *aor_like;
1355
1356         if (ast_strlen_zero(aor_name)) {
1357                 return -1;
1358         }
1359
1360         if (aor->permanent_contacts && ((int)(aor->qualify_frequency * 1000)) <= 0) {
1361                 aor_like = ast_alloca(strlen(aor_name) + 3);
1362                 sprintf(aor_like, "%%%s%%", aor_name);
1363                 var = ast_variable_new("aors LIKE", aor_like, "");
1364                 if (!var) {
1365                         return -1;
1366                 }
1367                 endpoints = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(),
1368                         "endpoint", AST_RETRIEVE_FLAG_MULTIPLE, var);
1369
1370                 if (endpoints) {
1371                     /*
1372                      * Because aors are a string list, we have to use a pattern match but since a simple
1373                      * pattern match could return an endpoint that has an aor of "aaabccc" when searching
1374                      * for "abc", we still have to iterate over them to find an exact aor match.
1375                      */
1376                     ao2_callback(endpoints, 0, aor_update_endpoint_state, (char *)aor_name);
1377                     ao2_ref(endpoints, -1);
1378                 }
1379         }
1380
1381         return 0;
1382 }
1383
1384 static int contact_update_endpoint_state(void *obj, void *arg, int flags)
1385 {
1386         const struct ast_sip_contact *contact = obj;
1387         struct timeval tv = ast_tvnow();
1388
1389         if (!ast_strlen_zero(contact->endpoint_name) && ((int)(contact->qualify_frequency * 1000)) <= 0 &&
1390                 contact->expiration_time.tv_sec > tv.tv_sec) {
1391
1392                 if (ast_sip_persistent_endpoint_update_state(contact->endpoint_name, AST_ENDPOINT_ONLINE) == -1) {
1393                         ast_log(LOG_WARNING, "Unable to find persistent endpoint '%s' for contact '%s/%s'\n",
1394                                 contact->endpoint_name, contact->aor, contact->uri);
1395                         return -1;
1396                 }
1397         }
1398
1399         return 0;
1400 }
1401
1402 static void update_all_unqualified_endpoints(void)
1403 {
1404         struct ao2_container *aors;
1405         struct ao2_container *contacts;
1406         RAII_VAR(struct ast_variable *, var_aor, NULL, ast_variables_destroy);
1407         RAII_VAR(struct ast_variable *, var_contact, NULL, ast_variables_destroy);
1408         RAII_VAR(char *, time_now, NULL, ast_free);
1409         struct timeval tv = ast_tvnow();
1410
1411         if (!(var_aor = ast_variable_new("contact !=", "", ""))) {
1412                 return;
1413         }
1414         if (!(var_aor->next = ast_variable_new("qualify_frequency <=", "0", ""))) {
1415                 return;
1416         }
1417
1418         if (ast_asprintf(&time_now, "%ld", tv.tv_sec) == -1) {
1419                 return;
1420         }
1421         if (!(var_contact = ast_variable_new("expiration_time >", time_now, ""))) {
1422                 return;
1423         }
1424         if (!(var_contact->next = ast_variable_new("qualify_frequency <=", "0", ""))) {
1425                 return;
1426         }
1427
1428         aors = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(),
1429                 "aor", AST_RETRIEVE_FLAG_MULTIPLE, var_aor);
1430         if (aors) {
1431                 ao2_callback(aors, OBJ_NODATA, on_aor_update_endpoint_state, NULL);
1432                 ao2_ref(aors, -1);
1433         }
1434
1435         contacts = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(),
1436                 "contact", AST_RETRIEVE_FLAG_MULTIPLE, var_contact);
1437         if (contacts) {
1438                 ao2_callback(contacts, OBJ_NODATA, contact_update_endpoint_state, NULL);
1439                 ao2_ref(contacts, -1);
1440         }
1441 }
1442
1443 int ast_res_pjsip_init_options_handling(int reload)
1444 {
1445         static const pj_str_t STR_OPTIONS = { "OPTIONS", 7 };
1446
1447         if (reload) {
1448                 qualify_and_schedule_all();
1449                 return 0;
1450         }
1451
1452         sched_qualifies = ao2_t_container_alloc(QUALIFIED_BUCKETS,
1453                 sched_qualifies_hash_fn, sched_qualifies_cmp_fn,
1454                 "Create container for scheduled qualifies");
1455         if (!sched_qualifies) {
1456                 return -1;
1457         }
1458
1459         if (pjsip_endpt_register_module(ast_sip_get_pjsip_endpoint(), &options_module) != PJ_SUCCESS) {
1460                 ao2_cleanup(sched_qualifies);
1461                 sched_qualifies = NULL;
1462                 return -1;
1463         }
1464
1465         if (pjsip_endpt_add_capability(ast_sip_get_pjsip_endpoint(), NULL, PJSIP_H_ALLOW,
1466                 NULL, 1, &STR_OPTIONS) != PJ_SUCCESS) {
1467                 pjsip_endpt_unregister_module(ast_sip_get_pjsip_endpoint(), &options_module);
1468                 ao2_cleanup(sched_qualifies);
1469                 sched_qualifies = NULL;
1470                 return -1;
1471         }
1472
1473         if (ast_sorcery_observer_add(ast_sip_get_sorcery(), "aor", &observer_callbacks_options)) {
1474                 pjsip_endpt_unregister_module(ast_sip_get_pjsip_endpoint(), &options_module);
1475                 ao2_cleanup(sched_qualifies);
1476                 sched_qualifies = NULL;
1477                 return -1;
1478         }
1479
1480         internal_sip_register_endpoint_formatter(&contact_status_formatter);
1481         ast_manager_register_xml("PJSIPQualify", EVENT_FLAG_SYSTEM | EVENT_FLAG_REPORTING, ami_sip_qualify);
1482         ast_cli_register_multiple(cli_options, ARRAY_LEN(cli_options));
1483
1484         update_all_unqualified_endpoints();
1485         qualify_and_schedule_all();
1486
1487         return 0;
1488 }
1489
1490 void ast_res_pjsip_cleanup_options_handling(void)
1491 {
1492         ast_cli_unregister_multiple(cli_options, ARRAY_LEN(cli_options));
1493         ast_manager_unregister("PJSIPQualify");
1494         internal_sip_unregister_endpoint_formatter(&contact_status_formatter);
1495
1496         ast_sorcery_observer_remove(ast_sip_get_sorcery(), "aor", &observer_callbacks_options);
1497         pjsip_endpt_unregister_module(ast_sip_get_pjsip_endpoint(), &options_module);
1498         ao2_cleanup(sched_qualifies);
1499         sched_qualifies = NULL;
1500 }