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