Add CLI/AMI commands to force chan_pjsip actions
[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 "include/res_pjsip_private.h"
32
33 #define DEFAULT_LANGUAGE "en"
34 #define DEFAULT_ENCODING "text/plain"
35 #define QUALIFIED_BUCKETS 211
36
37 static int qualify_contact(struct ast_sip_contact *contact);
38
39 /*!
40  * \internal
41  * \brief Create a ast_sip_contact_status object.
42  */
43 static void *contact_status_alloc(const char *name)
44 {
45         struct ast_sip_contact_status *status = ast_sorcery_generic_alloc(sizeof(*status), NULL);
46
47         if (!status) {
48                 ast_log(LOG_ERROR, "Unable to allocate ast_sip_contact_status\n");
49                 return NULL;
50         }
51
52         status->status = UNAVAILABLE;
53
54         return status;
55 }
56
57 /*!
58  * \internal
59  * \brief Retrieve a ast_sip_contact_status object from sorcery creating
60  *        one if not found.
61  */
62 static struct ast_sip_contact_status *find_or_create_contact_status(const struct ast_sip_contact *contact)
63 {
64         struct ast_sip_contact_status *status = ast_sorcery_retrieve_by_id(
65                 ast_sip_get_sorcery(), CONTACT_STATUS,
66                 ast_sorcery_object_get_id(contact));
67
68         if (status) {
69                 return status;
70         }
71
72         if (!(status = ast_sorcery_alloc(
73                       ast_sip_get_sorcery(), CONTACT_STATUS,
74                       ast_sorcery_object_get_id(contact)))) {
75
76                 ast_log(LOG_ERROR, "Unable to create ast_sip_contact_status for contact %s\n",
77                         contact->uri);
78                 return NULL;
79         }
80
81         if (ast_sorcery_create(ast_sip_get_sorcery(), status)) {
82                 ast_log(LOG_ERROR, "Unable to persist ast_sip_contact_status for contact %s\n",
83                         contact->uri);
84                 return NULL;
85         }
86
87         return status;
88 }
89
90 /*!
91  * \internal
92  * \brief Update an ast_sip_contact_status's elements.
93  */
94 static void update_contact_status(const struct ast_sip_contact *contact,
95                                   enum ast_sip_contact_status_type value)
96 {
97         RAII_VAR(struct ast_sip_contact_status *, status,
98                  find_or_create_contact_status(contact), ao2_cleanup);
99
100         RAII_VAR(struct ast_sip_contact_status *, update, ast_sorcery_alloc(
101                       ast_sip_get_sorcery(), CONTACT_STATUS,
102                       ast_sorcery_object_get_id(status)), ao2_cleanup);
103
104         if (!update) {
105                 ast_log(LOG_ERROR, "Unable to create update ast_sip_contact_status for contact %s\n",
106                         contact->uri);
107                 return;
108         }
109
110         update->status = value;
111
112         /* if the contact is available calculate the rtt as
113            the diff between the last start time and "now" */
114         update->rtt = update->status ?
115                 ast_tvdiff_us(ast_tvnow(), status->rtt_start) : 0;
116
117         update->rtt_start = ast_tv(0, 0);
118
119         if (ast_sorcery_update(ast_sip_get_sorcery(), update)) {
120                 ast_log(LOG_ERROR, "Unable to update ast_sip_contact_status for contact %s\n",
121                         contact->uri);
122         }
123 }
124
125 /*!
126  * \internal
127  * \brief Initialize the start time on a contact status so the round
128  *        trip time can be calculated upon a valid response.
129  */
130 static void init_start_time(const struct ast_sip_contact *contact)
131 {
132         RAII_VAR(struct ast_sip_contact_status *, status,
133                  find_or_create_contact_status(contact), ao2_cleanup);
134
135         RAII_VAR(struct ast_sip_contact_status *, update, ast_sorcery_alloc(
136                       ast_sip_get_sorcery(), CONTACT_STATUS,
137                       ast_sorcery_object_get_id(status)), ao2_cleanup);
138
139         if (!update) {
140                 ast_log(LOG_ERROR, "Unable to create update ast_sip_contact_status for contact %s\n",
141                         contact->uri);
142                 return;
143         }
144
145         update->rtt_start = ast_tvnow();
146
147         if (ast_sorcery_update(ast_sip_get_sorcery(), update)) {
148                 ast_log(LOG_ERROR, "Unable to update ast_sip_contact_status for contact %s\n",
149                         contact->uri);
150         }
151 }
152
153 /*!
154  * \internal
155  * \brief For an endpoint try to match on a given contact.
156  */
157 static int on_endpoint(void *obj, void *arg, int flags)
158 {
159         struct ast_sip_endpoint *endpoint = obj;
160         char *aor_name, *aors;
161
162         if (!arg || ast_strlen_zero(endpoint->aors)) {
163                 return 0;
164         }
165
166         aors = ast_strdupa(endpoint->aors);
167
168         while ((aor_name = strsep(&aors, ","))) {
169                 RAII_VAR(struct ast_sip_aor *, aor,
170                          ast_sip_location_retrieve_aor(aor_name), ao2_cleanup);
171                 RAII_VAR(struct ao2_container *, contacts, NULL, ao2_cleanup);
172
173                 if (!aor || !(contacts = ast_sip_location_retrieve_aor_contacts(aor))) {
174                         continue;
175                 }
176
177                 if (ao2_find(contacts, arg, OBJ_NODATA | OBJ_POINTER)) {
178                         return CMP_MATCH;
179                 }
180         }
181
182         return 0;
183 }
184
185 /*!
186  * \internal
187  * \brief Find endpoints associated with the given contact.
188  */
189 static struct ao2_container *find_endpoints(struct ast_sip_contact *contact)
190 {
191         RAII_VAR(struct ao2_container *, endpoints,
192                  ast_sip_get_endpoints(), ao2_cleanup);
193
194         return ao2_callback(endpoints, OBJ_MULTIPLE, on_endpoint, contact);
195 }
196
197 /*!
198  * \internal
199  * \brief Receive an response to the qualify contact request.
200  */
201 static void qualify_contact_cb(void *token, pjsip_event *e)
202 {
203         RAII_VAR(struct ast_sip_contact *, contact, token, ao2_cleanup);
204         RAII_VAR(struct ao2_container *, endpoints, NULL, ao2_cleanup);
205         RAII_VAR(struct ast_sip_endpoint *, endpoint, NULL, ao2_cleanup);
206
207         pjsip_transaction *tsx = e->body.tsx_state.tsx;
208         pjsip_rx_data *challenge = e->body.tsx_state.src.rdata;
209         pjsip_tx_data *tdata;
210
211         switch(e->body.tsx_state.type) {
212         case PJSIP_EVENT_TRANSPORT_ERROR:
213         case PJSIP_EVENT_TIMER:
214                 update_contact_status(contact, UNAVAILABLE);
215                 return;
216         default:
217                 break;
218         }
219
220         if (!contact->authenticate_qualify || (tsx->status_code != 401 &&
221                                                tsx->status_code != 407)) {
222                 update_contact_status(contact, AVAILABLE);
223                 return;
224         }
225
226         /* try to find endpoints that are associated with the contact */
227         if (!(endpoints = find_endpoints(contact))) {
228                 ast_log(LOG_ERROR, "No endpoints found for contact %s, cannot authenticate",
229                         contact->uri);
230                 return;
231         }
232
233         /* find "first" endpoint in order to authenticate - actually any
234            endpoint should do that matched on the contact */
235         endpoint = ao2_callback(endpoints, 0, NULL, NULL);
236
237         if (!ast_sip_create_request_with_auth(&endpoint->outbound_auths,
238                                               challenge, tsx, &tdata)) {
239                 pjsip_endpt_send_request(ast_sip_get_pjsip_endpoint(), tdata,
240                                          -1, NULL, NULL);
241         }
242 }
243
244 /*!
245  * \internal
246  * \brief Attempt to qualify the contact
247  *
248  * \detail Sends a SIP OPTIONS request to the given contact in order to make
249  *         sure that contact is available.
250  */
251 static int qualify_contact(struct ast_sip_contact *contact)
252 {
253         pjsip_tx_data *tdata;
254
255         if (ast_sip_create_request("OPTIONS", NULL, NULL, contact->uri, &tdata)) {
256                 ast_log(LOG_ERROR, "Unable to create request to qualify contact %s\n",
257                         contact->uri);
258                 return -1;
259         }
260
261         init_start_time(contact);
262
263         ao2_ref(contact, +1);
264         if (pjsip_endpt_send_request(ast_sip_get_pjsip_endpoint(),
265                                      tdata, -1, contact, qualify_contact_cb) != PJ_SUCCESS) {
266                 pjsip_tx_data_dec_ref(tdata);
267                 ast_log(LOG_ERROR, "Unable to send request to qualify contact %s\n",
268                         contact->uri);
269                 ao2_ref(contact, -1);
270                 return -1;
271         }
272
273         return 0;
274 }
275
276 /*!
277  * \internal
278  * \brief Scheduling context for sending QUALIFY request at specified intervals.
279  */
280 static struct ast_sched_context *sched;
281
282 /*!
283  * \internal
284  * \brief Container to hold all actively scheduled qualifies.
285  */
286 static struct ao2_container *sched_qualifies;
287
288 /*!
289  * \internal
290  * \brief Structure to hold qualify contact scheduling information.
291  */
292 struct sched_data {
293         /*! The scheduling id */
294         int id;
295         /*! The the contact being checked */
296         struct ast_sip_contact *contact;
297 };
298
299 /*!
300  * \internal
301  * \brief Destroy the scheduled data and remove from scheduler.
302  */
303 static void sched_data_destructor(void *obj)
304 {
305         struct sched_data *data = obj;
306         ao2_cleanup(data->contact);
307 }
308 /*!
309  * \internal
310  * \brief Create the scheduling data object.
311  */
312 static struct sched_data *sched_data_create(struct ast_sip_contact *contact)
313 {
314         struct sched_data *data = ao2_alloc(sizeof(*data), sched_data_destructor);
315
316         if (!data) {
317                 ast_log(LOG_ERROR, "Unable to create schedule qualify data\n");
318                 return NULL;
319         }
320
321         data->contact = contact;
322         ao2_ref(data->contact, +1);
323
324         return data;
325 }
326
327 /*!
328  * \internal
329  * \brief Send a qualify contact request within a threaded task.
330  */
331 static int qualify_contact_task(void *obj)
332 {
333         RAII_VAR(struct ast_sip_contact *, contact, obj, ao2_cleanup);
334         return qualify_contact(contact);
335 }
336
337 /*!
338  * \internal
339  * \brief Send a scheduled qualify contact request.
340  */
341 static int qualify_contact_sched(const void *obj)
342 {
343         struct sched_data *data = (struct sched_data *)obj;
344
345         ao2_ref(data->contact, +1);
346         if (ast_sip_push_task(NULL, qualify_contact_task, data->contact)) {
347                 ao2_ref(data->contact, -1);
348                 ao2_cleanup(data);
349                 return 0;
350         }
351
352         return data->contact->qualify_frequency * 1000;
353 }
354
355 /*!
356  * \internal
357  * \brief Set up a scheduled qualify contact check.
358  */
359 static void schedule_qualify(struct ast_sip_contact *contact)
360 {
361         RAII_VAR(struct sched_data *, data, sched_data_create(contact), ao2_cleanup);
362
363         if (!data) {
364                 return;
365         }
366
367         ao2_ref(data, +1);
368         if ((data->id = ast_sched_add_variable(
369                     sched, contact->qualify_frequency * 1000,
370                     qualify_contact_sched, data, 1)) < 0) {
371
372                 ao2_ref(data, -1);
373                 ast_log(LOG_ERROR, "Unable to schedule qualify for contact %s\n",
374                         contact->uri);
375                 return;
376         }
377
378         ao2_link(sched_qualifies, data);
379 }
380
381 /*!
382  * \internal
383  * \brief Remove the contact from the scheduler.
384  */
385 static void unschedule_qualify(struct ast_sip_contact *contact)
386 {
387         RAII_VAR(struct sched_data *, data, ao2_find(
388                          sched_qualifies, contact, OBJ_UNLINK), ao2_cleanup);
389
390         if (!data) {
391                 return;
392         }
393
394         AST_SCHED_DEL_UNREF(sched, data->id, ao2_cleanup(data));
395 }
396
397 /*!
398  * \internal
399  * \brief Qualify the given contact and set up scheduling if configured.
400  */
401 static void qualify_and_schedule(struct ast_sip_contact *contact)
402 {
403         unschedule_qualify(contact);
404
405         if (contact->qualify_frequency) {
406                 ao2_ref(contact, +1);
407                 ast_sip_push_task(NULL, qualify_contact_task, contact);
408
409                 schedule_qualify(contact);
410         }
411 }
412
413 /*!
414  * \internal
415  * \brief A new contact has been created make sure it is available.
416  */
417 static void contact_created(const void *obj)
418 {
419         qualify_and_schedule((struct ast_sip_contact *)obj);
420 }
421
422 /*!
423  * \internal
424  * \brief A contact has been deleted remove status tracking.
425  */
426 static void contact_deleted(const void *obj)
427 {
428         struct ast_sip_contact *contact = (struct ast_sip_contact *)obj;
429         RAII_VAR(struct ast_sip_contact_status *, status, NULL, ao2_cleanup);
430
431         unschedule_qualify(contact);
432
433         if (!(status = ast_sorcery_retrieve_by_id(
434                       ast_sip_get_sorcery(), CONTACT_STATUS,
435                       ast_sorcery_object_get_id(contact)))) {
436                 return;
437         }
438
439         if (ast_sorcery_delete(ast_sip_get_sorcery(), status)) {
440                 ast_log(LOG_ERROR, "Unable to delete ast_sip_contact_status for contact %s\n",
441                         contact->uri);
442         }
443 }
444
445 struct ast_sorcery_observer contact_observer = {
446         .created = contact_created,
447         .deleted = contact_deleted
448 };
449
450 static pj_bool_t options_start(void)
451 {
452         if (!(sched = ast_sched_context_create()) ||
453             ast_sched_start_thread(sched)) {
454                 return -1;
455         }
456
457         return PJ_SUCCESS;
458 }
459
460 static pj_bool_t options_stop(void)
461 {
462         ast_sorcery_observer_remove(ast_sip_get_sorcery(), "contact", &contact_observer);
463
464         ao2_t_ref(sched_qualifies, -1, "Remove scheduled qualifies on module stop");
465
466         if (sched) {
467                 ast_sched_context_destroy(sched);
468         }
469
470         return PJ_SUCCESS;
471 }
472
473 static pj_status_t send_options_response(pjsip_rx_data *rdata, int code)
474 {
475         pjsip_endpoint *endpt = ast_sip_get_pjsip_endpoint();
476         pjsip_dialog *dlg = pjsip_rdata_get_dlg(rdata);
477         pjsip_transaction *trans = pjsip_rdata_get_tsx(rdata);
478         pjsip_tx_data *tdata;
479         const pjsip_hdr *hdr;
480         pjsip_response_addr res_addr;
481         pj_status_t status;
482
483         /* Make the response object */
484         if ((status = pjsip_endpt_create_response(
485                      endpt, rdata, code, NULL, &tdata) != PJ_SUCCESS)) {
486                 ast_log(LOG_ERROR, "Unable to create response (%d)\n", status);
487                 return status;
488         }
489
490         /* Add appropriate headers */
491         if ((hdr = pjsip_endpt_get_capability(endpt, PJSIP_H_ACCEPT, NULL))) {
492                 pjsip_msg_add_hdr(tdata->msg, (pjsip_hdr*)pjsip_hdr_clone(tdata->pool, hdr));
493         }
494         if ((hdr = pjsip_endpt_get_capability(endpt, PJSIP_H_ALLOW, NULL))) {
495                 pjsip_msg_add_hdr(tdata->msg, (pjsip_hdr*)pjsip_hdr_clone(tdata->pool, hdr));
496         }
497         if ((hdr = pjsip_endpt_get_capability(endpt, PJSIP_H_SUPPORTED, NULL))) {
498                 pjsip_msg_add_hdr(tdata->msg, (pjsip_hdr*)pjsip_hdr_clone(tdata->pool, hdr));
499         }
500
501         /*
502          * XXX TODO: pjsip doesn't care a lot about either of these headers -
503          * while it provides specific methods to create them, they are defined
504          * to be the standard string header creation. We never did add them
505          * in chan_sip, although RFC 3261 says they SHOULD. Hard coded here.
506          */
507         ast_sip_add_header(tdata, "Accept-Encoding", DEFAULT_ENCODING);
508         ast_sip_add_header(tdata, "Accept-Language", DEFAULT_LANGUAGE);
509
510         if (dlg && trans) {
511                 status = pjsip_dlg_send_response(dlg, trans, tdata);
512         } else {
513                 /* Get where to send request. */
514                 if ((status = pjsip_get_response_addr(
515                              tdata->pool, rdata, &res_addr)) != PJ_SUCCESS) {
516                         ast_log(LOG_ERROR, "Unable to get response address (%d)\n",
517                                 status);
518
519                         pjsip_tx_data_dec_ref(tdata);
520                         return status;
521                 }
522                 status = pjsip_endpt_send_response(endpt, &res_addr, tdata,
523                                                    NULL, NULL);
524         }
525
526         if (status != PJ_SUCCESS) {
527                 ast_log(LOG_ERROR, "Unable to send response (%d)\n", status);
528         }
529
530         return status;
531 }
532
533 static pj_bool_t options_on_rx_request(pjsip_rx_data *rdata)
534 {
535         RAII_VAR(struct ast_sip_endpoint *, endpoint, NULL, ao2_cleanup);
536         pjsip_uri *ruri;
537         pjsip_sip_uri *sip_ruri;
538         char exten[AST_MAX_EXTENSION];
539
540         if (pjsip_method_cmp(&rdata->msg_info.msg->line.req.method,
541                              &pjsip_options_method)) {
542                 return PJ_FALSE;
543         }
544
545         if (!(endpoint = ast_pjsip_rdata_get_endpoint(rdata))) {
546                 return PJ_FALSE;
547         }
548
549         ruri = rdata->msg_info.msg->line.req.uri;
550         if (!PJSIP_URI_SCHEME_IS_SIP(ruri) && !PJSIP_URI_SCHEME_IS_SIPS(ruri)) {
551                 send_options_response(rdata, 416);
552                 return -1;
553         }
554
555         sip_ruri = pjsip_uri_get_uri(ruri);
556         ast_copy_pj_str(exten, &sip_ruri->user, sizeof(exten));
557
558         if (ast_shutting_down()) {
559                 send_options_response(rdata, 503);
560         } else if (!ast_exists_extension(NULL, endpoint->context, exten, 1, NULL)) {
561                 send_options_response(rdata, 404);
562         } else {
563                 send_options_response(rdata, 200);
564         }
565         return PJ_TRUE;
566 }
567
568 static pjsip_module options_module = {
569         .name = {"Options Module", 14},
570         .id = -1,
571         .priority = PJSIP_MOD_PRIORITY_APPLICATION,
572         .start = options_start,
573         .stop = options_stop,
574         .on_rx_request = options_on_rx_request,
575 };
576
577 /*!
578  * \internal
579  * \brief Send qualify request to the given contact.
580  */
581 static int cli_on_contact(void *obj, void *arg, int flags)
582 {
583         struct ast_sip_contact *contact = obj;
584         struct ast_cli_args *a = arg;
585         ast_cli(a->fd, " contact %s\n", contact->uri);
586         qualify_contact(contact);
587         return 0;
588 }
589
590 /*!
591  * \internal
592  * \brief For an endpoint iterate over and qualify all aors/contacts
593  */
594 static void cli_qualify_contacts(struct ast_cli_args *a, const char *endpoint_name,
595                                  struct ast_sip_endpoint *endpoint)
596 {
597         char *aor_name, *aors;
598
599         if (ast_strlen_zero(endpoint->aors)) {
600                 ast_cli(a->fd, "Endpoint %s has no AoR's configured\n",
601                         endpoint_name);
602                 return;
603         }
604
605         aors = ast_strdupa(endpoint->aors);
606
607         while ((aor_name = strsep(&aors, ","))) {
608                 RAII_VAR(struct ast_sip_aor *, aor,
609                          ast_sip_location_retrieve_aor(aor_name), ao2_cleanup);
610                 RAII_VAR(struct ao2_container *, contacts, NULL, ao2_cleanup);
611
612                 if (!aor || !(contacts = ast_sip_location_retrieve_aor_contacts(aor))) {
613                         continue;
614                 }
615
616                 ast_cli(a->fd, "Sending qualify to endpoint %s\n", endpoint_name);
617                 ao2_callback(contacts, OBJ_NODATA, cli_on_contact, a);
618         }
619 }
620
621 static char *cli_qualify(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
622 {
623         RAII_VAR(struct ast_sip_endpoint *, endpoint, NULL, ao2_cleanup);
624         const char *endpoint_name;
625
626         switch (cmd) {
627         case CLI_INIT:
628                 e->command = "pjsip qualify";
629                 e->usage =
630                         "Usage: pjsip qualify <endpoint>\n"
631                         "       Send a SIP OPTIONS request to all contacts on the endpoint.\n";
632                 return NULL;
633         case CLI_GENERATE:
634                 return NULL;
635         }
636
637         if (a->argc != 3) {
638                 return CLI_SHOWUSAGE;
639         }
640
641         endpoint_name = a->argv[2];
642
643         if (!(endpoint = ast_sorcery_retrieve_by_id(
644                       ast_sip_get_sorcery(), "endpoint", endpoint_name))) {
645                 ast_cli(a->fd, "Unable to retrieve endpoint %s\n", endpoint_name);
646                 return CLI_FAILURE;
647         }
648
649         /* send a qualify for all contacts registered with the endpoint */
650         cli_qualify_contacts(a, endpoint_name, endpoint);
651
652         return CLI_SUCCESS;
653 }
654
655 /*!
656  * \internal
657  * \brief Send qualify request to the given contact.
658  */
659 static int ami_contact_cb(void *obj, void *arg, int flags)
660 {
661         struct ast_sip_contact *contact = obj;
662         ao2_ref(contact, +1);
663         if (ast_sip_push_task(NULL, qualify_contact_task, contact)) {
664                 ao2_cleanup(contact);
665         }
666         return 0;
667 }
668
669 static int ami_sip_qualify(struct mansession *s, const struct message *m)
670 {
671         const char *endpoint_name = astman_get_header(m, "Endpoint");
672         RAII_VAR(struct ast_sip_endpoint *, endpoint, NULL, ao2_cleanup);
673         char *aor_name, *aors;
674
675         if (ast_strlen_zero(endpoint_name)) {
676                 astman_send_error(s, m, "Endpoint parameter missing.");
677                 return 0;
678         }
679
680         endpoint = ast_sorcery_retrieve_by_id(
681                 ast_sip_get_sorcery(),
682                 "endpoint",
683                 endpoint_name);
684         if (!endpoint) {
685                 astman_send_error(s, m, "Unable to retrieve endpoint\n");
686                 return 0;
687         }
688
689         /* send a qualify for all contacts registered with the endpoint */
690         if (ast_strlen_zero(endpoint->aors)) {
691                 astman_send_error(s, m, "No AoRs configured for endpoint\n");
692                 return 0;
693         }
694
695         aors = ast_strdupa(endpoint->aors);
696
697         while ((aor_name = strsep(&aors, ","))) {
698                 RAII_VAR(struct ast_sip_aor *, aor,
699                          ast_sip_location_retrieve_aor(aor_name), ao2_cleanup);
700                 RAII_VAR(struct ao2_container *, contacts, NULL, ao2_cleanup);
701
702                 if (!aor || !(contacts = ast_sip_location_retrieve_aor_contacts(aor))) {
703                         continue;
704                 }
705
706                 ao2_callback(contacts, OBJ_NODATA, ami_contact_cb, NULL);
707         }
708
709         astman_send_ack(s, m, "Endpoint found, will qualify");
710         return 0;
711 }
712
713 static struct ast_cli_entry cli_options[] = {
714         AST_CLI_DEFINE(cli_qualify, "Send an OPTIONS request to a PJSIP endpoint")
715 };
716
717 static int sched_qualifies_hash_fn(const void *obj, int flags)
718 {
719         const struct sched_data *data = obj;
720
721         return ast_str_hash(ast_sorcery_object_get_id(data->contact));
722 }
723
724 static int sched_qualifies_cmp_fn(void *obj, void *arg, int flags)
725 {
726         struct sched_data *data = obj;
727
728         return !strcmp(ast_sorcery_object_get_id(data->contact),
729                        ast_sorcery_object_get_id(arg));
730 }
731
732 int ast_sip_initialize_sorcery_qualify(struct ast_sorcery *sorcery)
733 {
734         /* initialize sorcery ast_sip_contact_status resource */
735         ast_sorcery_apply_default(sorcery, CONTACT_STATUS, "memory", NULL);
736
737         if (ast_sorcery_object_register(sorcery, CONTACT_STATUS,
738                                         contact_status_alloc, NULL, NULL)) {
739                 ast_log(LOG_ERROR, "Unable to register ast_sip_contact_status in sorcery\n");
740                 return -1;
741         }
742
743         ast_sorcery_object_field_register(sorcery, CONTACT_STATUS, "rtt", "0", OPT_UINT_T,
744                                           1, FLDSET(struct ast_sip_contact_status, status));
745         ast_sorcery_object_field_register(sorcery, CONTACT_STATUS, "rtt", "0", OPT_UINT_T,
746                                           1, FLDSET(struct ast_sip_contact_status, rtt));
747
748         return 0;
749 }
750
751 static int qualify_and_schedule_cb(void *obj, void *arg, int flags)
752 {
753         struct ast_sip_contact *contact = obj;
754         struct ast_sip_aor *aor = arg;
755
756         contact->qualify_frequency = aor->qualify_frequency;
757         qualify_and_schedule(contact);
758
759         return 0;
760 }
761
762 /*!
763  * \internal
764  * \brief Qualify and schedule an endpoint's permanent contacts
765  *
766  * \detail For the given endpoint retrieve its list of aors, qualify all
767  *         permanent contacts, and schedule for checks if configured.
768  */
769 static int qualify_and_schedule_permanent_cb(void *obj, void *arg, int flags)
770 {
771         struct ast_sip_endpoint *endpoint = obj;
772         char *aor_name, *aors;
773
774         if (ast_strlen_zero(endpoint->aors)) {
775                 return 0;
776         }
777
778         aors = ast_strdupa(endpoint->aors);
779
780         while ((aor_name = strsep(&aors, ","))) {
781                 RAII_VAR(struct ast_sip_aor *, aor,
782                          ast_sip_location_retrieve_aor(aor_name), ao2_cleanup);
783
784                 if (!aor || !aor->permanent_contacts) {
785                         continue;
786                 }
787                 ao2_callback(aor->permanent_contacts, OBJ_NODATA, qualify_and_schedule_cb, aor);
788         }
789
790         return 0;
791 }
792
793 static void qualify_and_schedule_permanent(void)
794 {
795         RAII_VAR(struct ao2_container *, endpoints,
796                  ast_sip_get_endpoints(), ao2_cleanup);
797
798         ao2_callback(endpoints, OBJ_NODATA,
799                      qualify_and_schedule_permanent_cb, NULL);
800 }
801
802 int ast_res_pjsip_init_options_handling(int reload)
803 {
804         const pj_str_t STR_OPTIONS = { "OPTIONS", 7 };
805
806         if (sched_qualifies) {
807                 ao2_t_ref(sched_qualifies, -1, "Remove old scheduled qualifies");
808         }
809
810         if (!(sched_qualifies = ao2_t_container_alloc(
811                 QUALIFIED_BUCKETS, sched_qualifies_hash_fn, sched_qualifies_cmp_fn,
812                 "Create container for scheduled qualifies"))) {
813
814                 return -1;
815         }
816
817         if (reload) {
818                 qualify_and_schedule_permanent();
819                 return 0;
820         }
821
822         if (pjsip_endpt_register_module(ast_sip_get_pjsip_endpoint(), &options_module) != PJ_SUCCESS) {
823                 options_stop();
824                 return -1;
825         }
826
827         if (pjsip_endpt_add_capability(ast_sip_get_pjsip_endpoint(), NULL, PJSIP_H_ALLOW, NULL, 1, &STR_OPTIONS) != PJ_SUCCESS) {
828                 pjsip_endpt_unregister_module(ast_sip_get_pjsip_endpoint(), &options_module);
829                 return -1;
830         }
831
832         if (ast_sorcery_observer_add(ast_sip_get_sorcery(), "contact", &contact_observer)) {
833                 ast_log(LOG_WARNING, "Unable to add contact observer\n");
834                 return -1;
835         }
836
837         qualify_and_schedule_permanent();
838         ast_cli_register_multiple(cli_options, ARRAY_LEN(cli_options));
839         ast_manager_register2("PJSIPQualify", EVENT_FLAG_SYSTEM | EVENT_FLAG_REPORTING, ami_sip_qualify, NULL, NULL, NULL);
840
841         return 0;
842 }
843
844 void ast_res_pjsip_cleanup_options_handling(void)
845 {
846         ast_cli_unregister_multiple(cli_options, ARRAY_LEN(cli_options));
847         ast_manager_unregister("PJSIPQualify");
848 }