Move where the sorcery observer is added for qualify to guarantee the sched_qualifies...
[asterisk/asterisk.git] / res / res_sip / sip_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_sip.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_sip_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_res_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->sip_outbound_auths,
238                                               endpoint->num_outbound_auths,
239                                               challenge, tsx, &tdata)) {
240                 pjsip_endpt_send_request(ast_sip_get_pjsip_endpoint(), tdata,
241                                          -1, NULL, NULL);
242         }
243 }
244
245 /*!
246  * \internal
247  * \brief Attempt to qualify the contact
248  *
249  * \detail Sends a SIP OPTIONS request to the given contact in order to make
250  *         sure that contact is available.
251  */
252 static int qualify_contact(struct ast_sip_contact *contact)
253 {
254         pjsip_tx_data *tdata;
255
256         if (ast_sip_create_request("OPTIONS", NULL, NULL, contact->uri, &tdata)) {
257                 ast_log(LOG_ERROR, "Unable to create request to qualify contact %s\n",
258                         contact->uri);
259                 return -1;
260         }
261
262         init_start_time(contact);
263
264         ao2_ref(contact, +1);
265         if (pjsip_endpt_send_request(ast_sip_get_pjsip_endpoint(),
266                                      tdata, -1, contact, qualify_contact_cb) != PJ_SUCCESS) {
267                 pjsip_tx_data_dec_ref(tdata);
268                 ast_log(LOG_ERROR, "Unable to send request to qualify contact %s\n",
269                         contact->uri);
270                 ao2_ref(contact, -1);
271                 return -1;
272         }
273
274         return 0;
275 }
276
277 /*!
278  * \internal
279  * \brief Scheduling context for sending QUALIFY request at specified intervals.
280  */
281 static struct ast_sched_context *sched;
282
283 /*!
284  * \internal
285  * \brief Container to hold all actively scheduled qualifies.
286  */
287 static struct ao2_container *sched_qualifies;
288
289 /*!
290  * \internal
291  * \brief Structure to hold qualify contact scheduling information.
292  */
293 struct sched_data {
294         /*! The scheduling id */
295         int id;
296         /*! The the contact being checked */
297         struct ast_sip_contact *contact;
298 };
299
300 /*!
301  * \internal
302  * \brief Destroy the scheduled data and remove from scheduler.
303  */
304 static void sched_data_destructor(void *obj)
305 {
306         struct sched_data *data = obj;
307         ao2_cleanup(data->contact);
308 }
309 /*!
310  * \internal
311  * \brief Create the scheduling data object.
312  */
313 static struct sched_data *sched_data_create(struct ast_sip_contact *contact)
314 {
315         struct sched_data *data = ao2_alloc(sizeof(*data), sched_data_destructor);
316
317         if (!data) {
318                 ast_log(LOG_ERROR, "Unable to create schedule qualify data\n");
319                 return NULL;
320         }
321
322         data->contact = contact;
323         ao2_ref(data->contact, +1);
324
325         return data;
326 }
327
328 /*!
329  * \internal
330  * \brief Send a qualify contact request within a threaded task.
331  */
332 static int qualify_contact_task(void *obj)
333 {
334         RAII_VAR(struct ast_sip_contact *, contact, obj, ao2_cleanup);
335         return qualify_contact(contact);
336 }
337
338 /*!
339  * \internal
340  * \brief Send a scheduled qualify contact request.
341  */
342 static int qualify_contact_sched(const void *obj)
343 {
344         struct sched_data *data = (struct sched_data *)obj;
345
346         ao2_ref(data->contact, +1);
347         if (ast_sip_push_task(NULL, qualify_contact_task, data->contact)) {
348                 ao2_ref(data->contact, -1);
349                 ao2_cleanup(data);
350                 return 0;
351         }
352
353         return data->contact->qualify_frequency * 1000;
354 }
355
356 /*!
357  * \internal
358  * \brief Set up a scheduled qualify contact check.
359  */
360 static void schedule_qualify(struct ast_sip_contact *contact)
361 {
362         RAII_VAR(struct sched_data *, data, sched_data_create(contact), ao2_cleanup);
363
364         if (!data) {
365                 return;
366         }
367
368         ao2_ref(data, +1);
369         if ((data->id = ast_sched_add_variable(
370                     sched, contact->qualify_frequency * 1000,
371                     qualify_contact_sched, data, 1)) < 0) {
372
373                 ao2_ref(data, -1);
374                 ast_log(LOG_ERROR, "Unable to schedule qualify for contact %s\n",
375                         contact->uri);
376                 return;
377         }
378
379         ao2_link(sched_qualifies, data);
380 }
381
382 /*!
383  * \internal
384  * \brief Remove the contact from the scheduler.
385  */
386 static void unschedule_qualify(struct ast_sip_contact *contact)
387 {
388         RAII_VAR(struct sched_data *, data, ao2_find(
389                          sched_qualifies, contact, OBJ_UNLINK), ao2_cleanup);
390
391         if (!data) {
392                 return;
393         }
394
395         AST_SCHED_DEL_UNREF(sched, data->id, ao2_cleanup(data));
396 }
397
398 /*!
399  * \internal
400  * \brief Qualify the given contact and set up scheduling if configured.
401  */
402 static void qualify_and_schedule(struct ast_sip_contact *contact)
403 {
404         unschedule_qualify(contact);
405
406         if (contact->qualify_frequency) {
407                 ao2_ref(contact, +1);
408                 ast_sip_push_task(NULL, qualify_contact_task, contact);
409
410                 schedule_qualify(contact);
411         }
412 }
413
414 /*!
415  * \internal
416  * \brief A new contact has been created make sure it is available.
417  */
418 static void contact_created(const void *obj)
419 {
420         qualify_and_schedule((struct ast_sip_contact *)obj);
421 }
422
423 /*!
424  * \internal
425  * \brief A contact has been deleted remove status tracking.
426  */
427 static void contact_deleted(const void *obj)
428 {
429         struct ast_sip_contact *contact = (struct ast_sip_contact *)obj;
430         RAII_VAR(struct ast_sip_contact_status *, status, NULL, ao2_cleanup);
431
432         unschedule_qualify(contact);
433
434         if (!(status = ast_sorcery_retrieve_by_id(
435                       ast_sip_get_sorcery(), CONTACT_STATUS,
436                       ast_sorcery_object_get_id(contact)))) {
437                 return;
438         }
439
440         if (ast_sorcery_delete(ast_sip_get_sorcery(), status)) {
441                 ast_log(LOG_ERROR, "Unable to delete ast_sip_contact_status for contact %s\n",
442                         contact->uri);
443         }
444 }
445
446 struct ast_sorcery_observer contact_observer = {
447         .created = contact_created,
448         .deleted = contact_deleted
449 };
450
451 static pj_bool_t options_start(void)
452 {
453         if (!(sched = ast_sched_context_create()) ||
454             ast_sched_start_thread(sched)) {
455                 return -1;
456         }
457
458         return PJ_SUCCESS;
459 }
460
461 static pj_bool_t options_stop(void)
462 {
463         ast_sorcery_observer_remove(ast_sip_get_sorcery(), "contact", &contact_observer);
464
465         ao2_t_ref(sched_qualifies, -1, "Remove scheduled qualifies on module stop");
466
467         if (sched) {
468                 ast_sched_context_destroy(sched);
469         }
470
471         return PJ_SUCCESS;
472 }
473
474 static pj_status_t send_options_response(pjsip_rx_data *rdata, int code)
475 {
476         pjsip_endpoint *endpt = ast_sip_get_pjsip_endpoint();
477         pjsip_dialog *dlg = pjsip_rdata_get_dlg(rdata);
478         pjsip_transaction *trans = pjsip_rdata_get_tsx(rdata);
479         pjsip_tx_data *tdata;
480         const pjsip_hdr *hdr;
481         pjsip_response_addr res_addr;
482         pj_status_t status;
483
484         /* Make the response object */
485         if ((status = pjsip_endpt_create_response(
486                      endpt, rdata, code, NULL, &tdata) != PJ_SUCCESS)) {
487                 ast_log(LOG_ERROR, "Unable to create response (%d)\n", status);
488                 return status;
489         }
490
491         /* Add appropriate headers */
492         if ((hdr = pjsip_endpt_get_capability(endpt, PJSIP_H_ACCEPT, NULL))) {
493                 pjsip_msg_add_hdr(tdata->msg, (pjsip_hdr*)pjsip_hdr_clone(tdata->pool, hdr));
494         }
495         if ((hdr = pjsip_endpt_get_capability(endpt, PJSIP_H_ALLOW, NULL))) {
496                 pjsip_msg_add_hdr(tdata->msg, (pjsip_hdr*)pjsip_hdr_clone(tdata->pool, hdr));
497         }
498         if ((hdr = pjsip_endpt_get_capability(endpt, PJSIP_H_SUPPORTED, NULL))) {
499                 pjsip_msg_add_hdr(tdata->msg, (pjsip_hdr*)pjsip_hdr_clone(tdata->pool, hdr));
500         }
501
502         /*
503          * XXX TODO: pjsip doesn't care a lot about either of these headers -
504          * while it provides specific methods to create them, they are defined
505          * to be the standard string header creation. We never did add them
506          * in chan_sip, although RFC 3261 says they SHOULD. Hard coded here.
507          */
508         ast_sip_add_header(tdata, "Accept-Encoding", DEFAULT_ENCODING);
509         ast_sip_add_header(tdata, "Accept-Language", DEFAULT_LANGUAGE);
510
511         if (dlg && trans) {
512                 status = pjsip_dlg_send_response(dlg, trans, tdata);
513         } else {
514                 /* Get where to send request. */
515                 if ((status = pjsip_get_response_addr(
516                              tdata->pool, rdata, &res_addr)) != PJ_SUCCESS) {
517                         ast_log(LOG_ERROR, "Unable to get response address (%d)\n",
518                                 status);
519
520                         pjsip_tx_data_dec_ref(tdata);
521                         return status;
522                 }
523                 status = pjsip_endpt_send_response(endpt, &res_addr, tdata,
524                                                    NULL, NULL);
525         }
526
527         if (status != PJ_SUCCESS) {
528                 ast_log(LOG_ERROR, "Unable to send response (%d)\n", status);
529         }
530
531         return status;
532 }
533
534 static pj_bool_t options_on_rx_request(pjsip_rx_data *rdata)
535 {
536         RAII_VAR(struct ast_sip_endpoint *, endpoint, NULL, ao2_cleanup);
537         pjsip_uri *ruri;
538         pjsip_sip_uri *sip_ruri;
539         char exten[AST_MAX_EXTENSION];
540
541         if (pjsip_method_cmp(&rdata->msg_info.msg->line.req.method,
542                              &pjsip_options_method)) {
543                 return PJ_FALSE;
544         }
545
546         if (!(endpoint = ast_pjsip_rdata_get_endpoint(rdata))) {
547                 return PJ_FALSE;
548         }
549
550         ruri = rdata->msg_info.msg->line.req.uri;
551         if (!PJSIP_URI_SCHEME_IS_SIP(ruri) && !PJSIP_URI_SCHEME_IS_SIPS(ruri)) {
552                 send_options_response(rdata, 416);
553                 return -1;
554         }
555
556         sip_ruri = pjsip_uri_get_uri(ruri);
557         ast_copy_pj_str(exten, &sip_ruri->user, sizeof(exten));
558
559         if (ast_shutting_down()) {
560                 send_options_response(rdata, 503);
561         } else if (!ast_exists_extension(NULL, endpoint->context, exten, 1, NULL)) {
562                 send_options_response(rdata, 404);
563         } else {
564                 send_options_response(rdata, 200);
565         }
566         return PJ_TRUE;
567 }
568
569 static pjsip_module options_module = {
570         .name = {"Options Module", 14},
571         .id = -1,
572         .priority = PJSIP_MOD_PRIORITY_APPLICATION,
573         .start = options_start,
574         .stop = options_stop,
575         .on_rx_request = options_on_rx_request,
576 };
577
578 /*!
579  * \internal
580  * \brief Send qualify request to the given contact.
581  */
582 static int cli_on_contact(void *obj, void *arg, int flags)
583 {
584         struct ast_sip_contact *contact = obj;
585         struct ast_cli_args *a = arg;
586         ast_cli(a->fd, " contact %s\n", contact->uri);
587         qualify_contact(contact);
588         return 0;
589 }
590
591 /*!
592  * \internal
593  * \brief For an endpoint iterate over and qualify all aors/contacts
594  */
595 static void cli_qualify_contacts(struct ast_cli_args *a, const char *endpoint_name,
596                                  struct ast_sip_endpoint *endpoint)
597 {
598         char *aor_name, *aors;
599
600         if (ast_strlen_zero(endpoint->aors)) {
601                 ast_cli(a->fd, "Endpoint %s has no AoR's configured\n",
602                         endpoint_name);
603                 return;
604         }
605
606         aors = ast_strdupa(endpoint->aors);
607
608         while ((aor_name = strsep(&aors, ","))) {
609                 RAII_VAR(struct ast_sip_aor *, aor,
610                          ast_sip_location_retrieve_aor(aor_name), ao2_cleanup);
611                 RAII_VAR(struct ao2_container *, contacts, NULL, ao2_cleanup);
612
613                 if (!aor || !(contacts = ast_sip_location_retrieve_aor_contacts(aor))) {
614                         continue;
615                 }
616
617                 ast_cli(a->fd, "Sending qualify to endpoint %s", endpoint_name);
618                 ao2_callback(contacts, OBJ_NODATA, cli_on_contact, a);
619         }
620 }
621
622 static char *cli_qualify(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
623 {
624         RAII_VAR(struct ast_sip_endpoint *, endpoint, NULL, ao2_cleanup);
625         const char *endpoint_name;
626
627         switch (cmd) {
628         case CLI_INIT:
629                 e->command = "sip qualify";
630                 e->usage =
631                         "Usage: sip qualify <endpoint>\n"
632                         "       Send a SIP OPTIONS request to all contacts on the endpoint.\n";
633                 return NULL;
634         case CLI_GENERATE:
635                 return NULL;
636         }
637
638         if (a->argc != 3) {
639                 return CLI_SHOWUSAGE;
640         }
641
642         endpoint_name = a->argv[2];
643
644         if (!(endpoint = ast_sorcery_retrieve_by_id(
645                       ast_sip_get_sorcery(), "endpoint", endpoint_name))) {
646                 ast_cli(a->fd, "Unable to retrieve endpoint %s\n", endpoint_name);
647                 return CLI_FAILURE;
648         }
649
650         /* send a qualify for all contacts registered with the endpoint */
651         cli_qualify_contacts(a, endpoint_name, endpoint);
652
653         return CLI_SUCCESS;
654 }
655
656 static struct ast_cli_entry cli_options[] = {
657         AST_CLI_DEFINE(cli_qualify, "Send an OPTIONS request to a SIP endpoint")
658 };
659
660 static int sched_qualifies_hash_fn(const void *obj, int flags)
661 {
662         const struct sched_data *data = obj;
663
664         return ast_str_hash(ast_sorcery_object_get_id(data->contact));
665 }
666
667 static int sched_qualifies_cmp_fn(void *obj, void *arg, int flags)
668 {
669         struct sched_data *data = obj;
670
671         return !strcmp(ast_sorcery_object_get_id(data->contact),
672                        ast_sorcery_object_get_id(arg));
673 }
674
675 int ast_sip_initialize_sorcery_qualify(struct ast_sorcery *sorcery)
676 {
677         /* initialize sorcery ast_sip_contact_status resource */
678         ast_sorcery_apply_default(sorcery, CONTACT_STATUS, "memory", NULL);
679
680         if (ast_sorcery_object_register(sorcery, CONTACT_STATUS,
681                                         contact_status_alloc, NULL, NULL)) {
682                 ast_log(LOG_ERROR, "Unable to register ast_sip_contact_status in sorcery\n");
683                 return -1;
684         }
685
686         ast_sorcery_object_field_register(sorcery, CONTACT_STATUS, "rtt", "0", OPT_UINT_T,
687                                           1, FLDSET(struct ast_sip_contact_status, status));
688         ast_sorcery_object_field_register(sorcery, CONTACT_STATUS, "rtt", "0", OPT_UINT_T,
689                                           1, FLDSET(struct ast_sip_contact_status, rtt));
690
691         return 0;
692 }
693
694 static int qualify_and_schedule_cb(void *obj, void *arg, int flags)
695 {
696         struct ast_sip_contact *contact = obj;
697         struct ast_sip_aor *aor = arg;
698
699         contact->qualify_frequency = aor->qualify_frequency;
700         qualify_and_schedule(contact);
701
702         return 0;
703 }
704
705 /*!
706  * \internal
707  * \brief Qualify and schedule an endpoint's permanent contacts
708  *
709  * \detail For the given endpoint retrieve its list of aors, qualify all
710  *         permanent contacts, and schedule for checks if configured.
711  */
712 static int qualify_and_schedule_permanent_cb(void *obj, void *arg, int flags)
713 {
714         struct ast_sip_endpoint *endpoint = obj;
715         char *aor_name, *aors;
716
717         if (ast_strlen_zero(endpoint->aors)) {
718                 return 0;
719         }
720
721         aors = ast_strdupa(endpoint->aors);
722
723         while ((aor_name = strsep(&aors, ","))) {
724                 RAII_VAR(struct ast_sip_aor *, aor,
725                          ast_sip_location_retrieve_aor(aor_name), ao2_cleanup);
726
727                 if (!aor || !aor->permanent_contacts) {
728                         continue;
729                 }
730                 ao2_callback(aor->permanent_contacts, OBJ_NODATA, qualify_and_schedule_cb, aor);
731         }
732
733         return 0;
734 }
735
736 static void qualify_and_schedule_permanent(void)
737 {
738         RAII_VAR(struct ao2_container *, endpoints,
739                  ast_res_sip_get_endpoints(), ao2_cleanup);
740
741         ao2_callback(endpoints, OBJ_NODATA,
742                      qualify_and_schedule_permanent_cb, NULL);
743 }
744
745 int ast_res_sip_init_options_handling(int reload)
746 {
747         const pj_str_t STR_OPTIONS = { "OPTIONS", 7 };
748
749         if (sched_qualifies) {
750                 ao2_t_ref(sched_qualifies, -1, "Remove old scheduled qualifies");
751         }
752
753         if (!(sched_qualifies = ao2_t_container_alloc(
754                 QUALIFIED_BUCKETS, sched_qualifies_hash_fn, sched_qualifies_cmp_fn,
755                 "Create container for scheduled qualifies"))) {
756
757                 return -1;
758         }
759
760         if (reload) {
761                 qualify_and_schedule_permanent();
762                 return 0;
763         }
764
765         if (pjsip_endpt_register_module(ast_sip_get_pjsip_endpoint(), &options_module) != PJ_SUCCESS) {
766                 options_stop();
767                 return -1;
768         }
769
770         if (pjsip_endpt_add_capability(ast_sip_get_pjsip_endpoint(), NULL, PJSIP_H_ALLOW, NULL, 1, &STR_OPTIONS) != PJ_SUCCESS) {
771                 pjsip_endpt_unregister_module(ast_sip_get_pjsip_endpoint(), &options_module);
772                 return -1;
773         }
774
775         if (ast_sorcery_observer_add(ast_sip_get_sorcery(), "contact", &contact_observer)) {
776                 ast_log(LOG_WARNING, "Unable to add contact observer\n");
777                 return -1;
778         }
779
780         qualify_and_schedule_permanent();
781         ast_cli_register_multiple(cli_options, ARRAY_LEN(cli_options));
782
783         return 0;
784 }