build: Update config.guess and config.sub
[asterisk/asterisk.git] / res / res_pjsip_mwi.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * Mark Michelson <mmichelson@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 /*** MODULEINFO
20         <depend>pjproject</depend>
21         <depend>res_pjsip</depend>
22         <depend>res_pjsip_pubsub</depend>
23         <support_level>core</support_level>
24  ***/
25
26 #include "asterisk.h"
27
28 #include <pjsip.h>
29 #include <pjsip_simple.h>
30 #include <pjlib.h>
31
32 #include "asterisk/res_pjsip.h"
33 #include "asterisk/res_pjsip_pubsub.h"
34 #include "asterisk/res_pjsip_body_generator_types.h"
35 #include "asterisk/module.h"
36 #include "asterisk/logger.h"
37 #include "asterisk/astobj2.h"
38 #include "asterisk/taskprocessor.h"
39 #include "asterisk/sorcery.h"
40 #include "asterisk/stasis.h"
41 #include "asterisk/app.h"
42
43 struct mwi_subscription;
44 static struct ao2_container *unsolicited_mwi;
45
46 static char *default_voicemail_extension;
47
48 #define STASIS_BUCKETS 13
49 #define MWI_BUCKETS 53
50
51 #define MWI_TYPE "application"
52 #define MWI_SUBTYPE "simple-message-summary"
53
54 #define MWI_DATASTORE "MWI datastore"
55
56 /*! Number of serializers in pool if one not supplied. */
57 #define MWI_SERIALIZER_POOL_SIZE 8
58
59 /*! Pool of serializers to use if not supplied. */
60 static struct ast_taskprocessor *mwi_serializer_pool[MWI_SERIALIZER_POOL_SIZE];
61
62 static void mwi_subscription_shutdown(struct ast_sip_subscription *sub);
63 static void mwi_to_ami(struct ast_sip_subscription *sub, struct ast_str **buf);
64 static int mwi_new_subscribe(struct ast_sip_endpoint *endpoint,
65                 const char *resource);
66 static int mwi_subscription_established(struct ast_sip_subscription *sub);
67 static void *mwi_get_notify_data(struct ast_sip_subscription *sub);
68
69 static struct ast_sip_notifier mwi_notifier = {
70         .default_accept = MWI_TYPE"/"MWI_SUBTYPE,
71         .new_subscribe = mwi_new_subscribe,
72         .subscription_established = mwi_subscription_established,
73         .get_notify_data = mwi_get_notify_data,
74 };
75
76 static struct ast_sip_subscription_handler mwi_handler = {
77         .event_name = "message-summary",
78         .body_type = AST_SIP_MESSAGE_ACCUMULATOR,
79         .accept = { MWI_TYPE"/"MWI_SUBTYPE, },
80         .subscription_shutdown = mwi_subscription_shutdown,
81         .to_ami = mwi_to_ami,
82         .notifier = &mwi_notifier,
83 };
84
85 /*!
86  * \brief Wrapper for stasis subscription
87  *
88  * An MWI subscription has a container of these. This
89  * represents a stasis subscription for MWI state.
90  */
91 struct mwi_stasis_subscription {
92         /*! The MWI stasis subscription */
93         struct stasis_subscription *stasis_sub;
94         /*! The mailbox corresponding with the MWI subscription. Used as a hash key */
95         char mailbox[1];
96 };
97
98 /*!
99  * \brief A subscription for MWI
100  *
101  * This subscription is the basis for MWI for an endpoint. Each
102  * endpoint that uses MWI will have a corresponding mwi_subscription.
103  *
104  * This structure acts as the owner for the underlying SIP subscription.
105  * When the mwi_subscription is destroyed, the SIP subscription dies, too.
106  * The mwi_subscription's lifetime is governed by its underlying stasis
107  * subscriptions. When all stasis subscriptions are destroyed, the
108  * mwi_subscription is destroyed as well.
109  */
110 struct mwi_subscription {
111         /*! Container of \ref mwi_stasis_subscription structures.
112          * A single MWI subscription may be for multiple mailboxes, thus
113          * requiring multiple stasis subscriptions
114          */
115         struct ao2_container *stasis_subs;
116         /*! The SIP subscription. Unsolicited MWI does not use this */
117         struct ast_sip_subscription *sip_sub;
118         /*! AORs we should react to for unsolicited MWI NOTIFY */
119         char *aors;
120         /*! Is the MWI solicited (i.e. Initiated with an external SUBSCRIBE) ? */
121         unsigned int is_solicited;
122         /*! Identifier for the subscription.
123          * The identifier is the same as the corresponding endpoint's stasis ID.
124          * Used as a hash key
125          */
126         char id[1];
127 };
128
129 /*!
130  * \internal
131  * \brief Shutdown the serializers in the mwi pool.
132  * \since 13.12.0
133  *
134  * \return Nothing
135  */
136 static void mwi_serializer_pool_shutdown(void)
137 {
138         int idx;
139
140         for (idx = 0; idx < MWI_SERIALIZER_POOL_SIZE; ++idx) {
141                 ast_taskprocessor_unreference(mwi_serializer_pool[idx]);
142                 mwi_serializer_pool[idx] = NULL;
143         }
144 }
145
146 /*!
147  * \internal
148  * \brief Setup the serializers in the mwi pool.
149  * \since 13.12.0
150  *
151  * \retval 0 on success.
152  * \retval -1 on error.
153  */
154 static int mwi_serializer_pool_setup(void)
155 {
156         char tps_name[AST_TASKPROCESSOR_MAX_NAME + 1];
157         int idx;
158
159         for (idx = 0; idx < MWI_SERIALIZER_POOL_SIZE; ++idx) {
160                 /* Create name with seq number appended. */
161                 ast_taskprocessor_build_name(tps_name, sizeof(tps_name), "pjsip/mwi");
162
163                 mwi_serializer_pool[idx] = ast_sip_create_serializer(tps_name);
164                 if (!mwi_serializer_pool[idx]) {
165                         mwi_serializer_pool_shutdown();
166                         return -1;
167                 }
168         }
169         return 0;
170 }
171
172 /*!
173  * \internal
174  * \brief Pick a mwi serializer from the pool.
175  * \since 13.12.0
176  *
177  * \retval least queue size task processor.
178  */
179 static struct ast_taskprocessor *get_mwi_serializer(void)
180 {
181         int idx;
182         int pos;
183
184         if (!mwi_serializer_pool[0]) {
185                 return NULL;
186         }
187
188         for (pos = idx = 0; idx < MWI_SERIALIZER_POOL_SIZE; ++idx) {
189                 if (ast_taskprocessor_size(mwi_serializer_pool[idx]) < ast_taskprocessor_size(mwi_serializer_pool[pos])) {
190                         pos = idx;
191                 }
192         }
193
194         return mwi_serializer_pool[pos];
195 }
196
197 /*!
198  * \internal
199  * \brief Set taskprocessor alert levels for the serializers in the mwi pool.
200  * \since 13.12.0
201  *
202  * \retval 0 on success.
203  * \retval -1 on error.
204  */
205 static int mwi_serializer_set_alert_levels(void)
206 {
207         int idx;
208         long tps_queue_high;
209         long tps_queue_low;
210
211         if (!mwi_serializer_pool[0]) {
212                 return -1;
213         }
214
215         tps_queue_high = ast_sip_get_mwi_tps_queue_high();
216         if (tps_queue_high <= 0) {
217                 ast_log(AST_LOG_WARNING, "Invalid taskprocessor high water alert trigger level '%ld'\n",
218                         tps_queue_high);
219                 tps_queue_high = AST_TASKPROCESSOR_HIGH_WATER_LEVEL;
220         }
221
222         tps_queue_low = ast_sip_get_mwi_tps_queue_low();
223         if (tps_queue_low < -1 || tps_queue_high < tps_queue_low) {
224                 ast_log(AST_LOG_WARNING, "Invalid taskprocessor low water clear alert level '%ld'\n",
225                         tps_queue_low);
226                 tps_queue_low = -1;
227         }
228
229         for (idx = 0; idx < MWI_SERIALIZER_POOL_SIZE; ++idx) {
230                 if (ast_taskprocessor_alert_set_levels(mwi_serializer_pool[idx], tps_queue_low, tps_queue_high)) {
231                         ast_log(AST_LOG_WARNING, "Failed to set alert levels for MWI serializer pool #%d.\n",
232                                 idx);
233                 }
234         }
235
236         return 0;
237 }
238
239
240 static void mwi_stasis_cb(void *userdata, struct stasis_subscription *sub,
241                 struct stasis_message *msg);
242
243 static struct mwi_stasis_subscription *mwi_stasis_subscription_alloc(const char *mailbox, struct mwi_subscription *mwi_sub)
244 {
245         struct mwi_stasis_subscription *mwi_stasis_sub;
246         struct stasis_topic *topic;
247
248         if (!mwi_sub) {
249                 return NULL;
250         }
251
252         mwi_stasis_sub = ao2_alloc(sizeof(*mwi_stasis_sub) + strlen(mailbox), NULL);
253         if (!mwi_stasis_sub) {
254                 return NULL;
255         }
256
257         topic = ast_mwi_topic(mailbox);
258
259         /* Safe strcpy */
260         strcpy(mwi_stasis_sub->mailbox, mailbox);
261
262         ast_debug(3, "Creating stasis MWI subscription to mailbox %s for endpoint %s\n",
263                 mailbox, mwi_sub->id);
264         ao2_ref(mwi_sub, +1);
265         mwi_stasis_sub->stasis_sub = stasis_subscribe_pool(topic, mwi_stasis_cb, mwi_sub);
266         if (!mwi_stasis_sub->stasis_sub) {
267                 /* Failed to subscribe. */
268                 ao2_ref(mwi_stasis_sub, -1);
269                 ao2_ref(mwi_sub, -1);
270                 mwi_stasis_sub = NULL;
271         }
272         stasis_subscription_accept_message_type(mwi_stasis_sub->stasis_sub, ast_mwi_state_type());
273         stasis_subscription_accept_message_type(mwi_stasis_sub->stasis_sub, stasis_subscription_change_type());
274         stasis_subscription_set_filter(mwi_stasis_sub->stasis_sub, STASIS_SUBSCRIPTION_FILTER_SELECTIVE);
275         return mwi_stasis_sub;
276 }
277
278 static int stasis_sub_hash(const void *obj, const int flags)
279 {
280         const struct mwi_stasis_subscription *object;
281         const char *key;
282
283         switch (flags & OBJ_SEARCH_MASK) {
284         case OBJ_SEARCH_KEY:
285                 key = obj;
286                 break;
287         case OBJ_SEARCH_OBJECT:
288                 object = obj;
289                 key = object->mailbox;
290                 break;
291         default:
292                 ast_assert(0);
293                 return 0;
294         }
295         return ast_str_hash(key);
296 }
297
298 static int stasis_sub_cmp(void *obj, void *arg, int flags)
299 {
300         const struct mwi_stasis_subscription *sub_left = obj;
301         const struct mwi_stasis_subscription *sub_right = arg;
302         const char *right_key = arg;
303         int cmp;
304
305         switch (flags & OBJ_SEARCH_MASK) {
306         case OBJ_SEARCH_OBJECT:
307                 right_key = sub_right->mailbox;
308                 /* Fall through */
309         case OBJ_SEARCH_KEY:
310                 cmp = strcmp(sub_left->mailbox, right_key);
311                 break;
312         case OBJ_SEARCH_PARTIAL_KEY:
313                 cmp = strncmp(sub_left->mailbox, right_key, strlen(right_key));
314                 break;
315         default:
316                 cmp = 0;
317                 break;
318         }
319         if (cmp) {
320                 return 0;
321         }
322         return CMP_MATCH;
323 }
324
325 static void mwi_subscription_destructor(void *obj)
326 {
327         struct mwi_subscription *sub = obj;
328
329         ast_debug(3, "Destroying MWI subscription for endpoint %s\n", sub->id);
330         if (sub->is_solicited) {
331                 ast_sip_subscription_destroy(sub->sip_sub);
332         }
333         ao2_cleanup(sub->stasis_subs);
334         ast_free(sub->aors);
335 }
336
337 static struct mwi_subscription *mwi_subscription_alloc(struct ast_sip_endpoint *endpoint,
338                 unsigned int is_solicited, struct ast_sip_subscription *sip_sub)
339 {
340         struct mwi_subscription *sub;
341         const char *endpoint_id = ast_sorcery_object_get_id(endpoint);
342
343         sub = ao2_alloc(sizeof(*sub) + strlen(endpoint_id),
344                         mwi_subscription_destructor);
345
346         if (!sub) {
347                 return NULL;
348         }
349
350         /* Safe strcpy */
351         strcpy(sub->id, endpoint_id);
352
353         /* Unsolicited MWI doesn't actually result in a SIP subscription being
354          * created. This is because a SIP subscription associates with a dialog.
355          * Most devices expect unsolicited MWI NOTIFYs to appear out of dialog. If
356          * they receive an in-dialog MWI NOTIFY (i.e. with a to-tag), then they
357          * will reject the NOTIFY with a 481, thus resulting in message-waiting
358          * state not being updated on the device
359          */
360         if (is_solicited) {
361                 sub->sip_sub = sip_sub;
362         }
363
364         sub->stasis_subs = ao2_container_alloc_hash(AO2_ALLOC_OPT_LOCK_MUTEX, 0,
365                 STASIS_BUCKETS, stasis_sub_hash, NULL, stasis_sub_cmp);
366         if (!sub->stasis_subs) {
367                 ao2_cleanup(sub);
368                 return NULL;
369         }
370         sub->is_solicited = is_solicited;
371
372         if (!is_solicited && !ast_strlen_zero(endpoint->aors)) {
373                 sub->aors = ast_strdup(endpoint->aors);
374                 if (!sub->aors) {
375                         ao2_ref(sub, -1);
376                         return NULL;
377                 }
378         }
379
380         ast_debug(3, "Created %s MWI subscription for endpoint %s\n", is_solicited ? "solicited" : "unsolicited", sub->id);
381
382         return sub;
383 }
384
385 static int mwi_sub_hash(const void *obj, const int flags)
386 {
387         const struct mwi_subscription *object;
388         const char *key;
389
390         switch (flags & OBJ_SEARCH_MASK) {
391         case OBJ_SEARCH_KEY:
392                 key = obj;
393                 break;
394         case OBJ_SEARCH_OBJECT:
395                 object = obj;
396                 key = object->id;
397                 break;
398         default:
399                 ast_assert(0);
400                 return 0;
401         }
402         return ast_str_hash(key);
403 }
404
405 static int mwi_sub_cmp(void *obj, void *arg, int flags)
406 {
407         const struct mwi_subscription *sub_left = obj;
408         const struct mwi_subscription *sub_right = arg;
409         const char *right_key = arg;
410         int cmp;
411
412         switch (flags & OBJ_SEARCH_MASK) {
413         case OBJ_SEARCH_OBJECT:
414                 right_key = sub_right->id;
415                 /* Fall through */
416         case OBJ_SEARCH_KEY:
417                 cmp = strcmp(sub_left->id, right_key);
418                 break;
419         case OBJ_SEARCH_PARTIAL_KEY:
420                 cmp = strncmp(sub_left->id, right_key, strlen(right_key));
421                 break;
422         default:
423                 cmp = 0;
424                 break;
425         }
426         if (cmp) {
427                 return 0;
428         }
429         return CMP_MATCH;
430 }
431
432 static int get_message_count(void *obj, void *arg, int flags)
433 {
434         struct stasis_message *msg;
435         struct mwi_stasis_subscription *mwi_stasis = obj;
436         struct ast_sip_message_accumulator *counter = arg;
437         struct ast_mwi_state *mwi_state;
438
439         msg = stasis_cache_get(ast_mwi_state_cache(), ast_mwi_state_type(), mwi_stasis->mailbox);
440         if (!msg) {
441                 return 0;
442         }
443
444         mwi_state = stasis_message_data(msg);
445         counter->old_msgs += mwi_state->old_msgs;
446         counter->new_msgs += mwi_state->new_msgs;
447
448         ao2_ref(msg, -1);
449
450         return 0;
451 }
452
453 static void set_voicemail_extension(pj_pool_t *pool, pjsip_sip_uri *local_uri,
454         struct ast_sip_message_accumulator *counter, const char *voicemail_extension)
455 {
456         pjsip_sip_uri *account_uri;
457         const char *vm_exten;
458
459         if (ast_strlen_zero(voicemail_extension)) {
460                 vm_exten = default_voicemail_extension;
461         } else {
462                 vm_exten = voicemail_extension;
463         }
464
465         if (!ast_strlen_zero(vm_exten)) {
466                 account_uri = pjsip_uri_clone(pool, local_uri);
467                 pj_strdup2(pool, &account_uri->user, vm_exten);
468                 pjsip_uri_print(PJSIP_URI_IN_CONTACT_HDR, account_uri, counter->message_account, sizeof(counter->message_account));
469         }
470 }
471
472 struct unsolicited_mwi_data {
473         struct mwi_subscription *sub;
474         struct ast_sip_endpoint *endpoint;
475         pjsip_evsub_state state;
476         struct ast_sip_message_accumulator *counter;
477 };
478
479 static int send_unsolicited_mwi_notify_to_contact(void *obj, void *arg, int flags)
480 {
481         struct unsolicited_mwi_data *mwi_data = arg;
482         struct mwi_subscription *sub = mwi_data->sub;
483         struct ast_sip_endpoint *endpoint = mwi_data->endpoint;
484         pjsip_evsub_state state = mwi_data->state;
485         struct ast_sip_contact *contact = obj;
486         const char *state_name;
487         pjsip_tx_data *tdata;
488         pjsip_sub_state_hdr *sub_state;
489         pjsip_event_hdr *event;
490         pjsip_from_hdr *from;
491         pjsip_sip_uri *from_uri;
492         const pjsip_hdr *allow_events = pjsip_evsub_get_allow_events_hdr(NULL);
493         struct ast_sip_body body;
494         struct ast_str *body_text;
495         struct ast_sip_body_data body_data = {
496                 .body_type = AST_SIP_MESSAGE_ACCUMULATOR,
497                 .body_data = mwi_data->counter,
498         };
499
500         if (ast_sip_create_request("NOTIFY", NULL, endpoint, NULL, contact, &tdata)) {
501                 ast_log(LOG_WARNING, "Unable to create unsolicited NOTIFY request to endpoint %s URI %s\n", sub->id, contact->uri);
502                 return 0;
503         }
504
505         body.type = MWI_TYPE;
506         body.subtype = MWI_SUBTYPE;
507         body_text = ast_str_create(64);
508         if (!body_text) {
509                 pjsip_tx_data_dec_ref(tdata);
510                 return 0;
511         }
512
513         from = PJSIP_MSG_FROM_HDR(tdata->msg);
514         from_uri = pjsip_uri_get_uri(from->uri);
515
516         if (!ast_strlen_zero(endpoint->subscription.mwi.fromuser)) {
517                 pj_strdup2(tdata->pool, &from_uri->user, endpoint->subscription.mwi.fromuser);
518         }
519
520         set_voicemail_extension(tdata->pool, from_uri, mwi_data->counter, endpoint->subscription.mwi.voicemail_extension);
521
522         if (ast_sip_pubsub_generate_body_content(body.type, body.subtype, &body_data, &body_text)) {
523                 ast_log(LOG_WARNING, "Unable to generate SIP MWI NOTIFY body.\n");
524                 ast_free(body_text);
525                 pjsip_tx_data_dec_ref(tdata);
526                 return 0;
527         }
528
529         body.body_text = ast_str_buffer(body_text);
530
531         switch (state) {
532         case PJSIP_EVSUB_STATE_ACTIVE:
533                 state_name = "active";
534                 break;
535         case PJSIP_EVSUB_STATE_TERMINATED:
536         default:
537                 state_name = "terminated";
538                 break;
539         }
540
541         sub_state = pjsip_sub_state_hdr_create(tdata->pool);
542         pj_cstr(&sub_state->sub_state, state_name);
543         pjsip_msg_add_hdr(tdata->msg, (pjsip_hdr *) sub_state);
544
545         event = pjsip_event_hdr_create(tdata->pool);
546         pj_cstr(&event->event_type, "message-summary");
547         pjsip_msg_add_hdr(tdata->msg, (pjsip_hdr *) event);
548
549         pjsip_msg_add_hdr(tdata->msg, pjsip_hdr_shallow_clone(tdata->pool, allow_events));
550         ast_sip_add_body(tdata, &body);
551         ast_sip_send_request(tdata, NULL, endpoint, NULL, NULL);
552
553         ast_free(body_text);
554
555         return 0;
556 }
557
558 static struct ast_sip_aor *find_aor_for_resource(struct ast_sip_endpoint *endpoint, const char *resource)
559 {
560         struct ast_sip_aor *aor;
561         char *aor_name;
562         char *aors_copy;
563
564         /* Direct match */
565         if ((aor = ast_sip_location_retrieve_aor(resource))) {
566                 return aor;
567         }
568
569         if (!endpoint) {
570                 return NULL;
571         }
572
573         /*
574          * This may be a subscribe to the voicemail_extension.  If so,
575          * look for an aor belonging to this endpoint that has a matching
576          * voicemail_extension.
577          */
578         aors_copy = ast_strdupa(endpoint->aors);
579         while ((aor_name = ast_strip(strsep(&aors_copy, ",")))) {
580                 struct ast_sip_aor *check_aor = ast_sip_location_retrieve_aor(aor_name);
581
582                 if (!check_aor) {
583                         continue;
584                 }
585
586                 if (!ast_strlen_zero(check_aor->voicemail_extension)
587                         && !strcasecmp(check_aor->voicemail_extension, resource)) {
588                         ast_debug(1, "Found an aor (%s) that matches voicemail_extension %s\n", aor_name, resource);
589                         return check_aor;
590                 }
591
592                 ao2_ref(check_aor, -1);
593         }
594
595         return NULL;
596 }
597
598 static void send_unsolicited_mwi_notify(struct mwi_subscription *sub,
599                 struct ast_sip_message_accumulator *counter)
600 {
601         RAII_VAR(struct ast_sip_endpoint *, endpoint, ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(),
602                                 "endpoint", sub->id), ao2_cleanup);
603         char *endpoint_aors;
604         char *aor_name;
605
606         if (!endpoint) {
607                 ast_log(LOG_WARNING, "Unable to send unsolicited MWI to %s because endpoint does not exist\n",
608                                 sub->id);
609                 return;
610         }
611         if (ast_strlen_zero(endpoint->aors)) {
612                 ast_log(LOG_WARNING, "Unable to send unsolicited MWI to %s because the endpoint has no"
613                                 " configured AORs\n", sub->id);
614                 return;
615         }
616
617         endpoint_aors = ast_strdupa(endpoint->aors);
618
619         ast_debug(5, "Sending unsolicited MWI NOTIFY to endpoint %s, new messages: %d, old messages: %d\n",
620                         sub->id, counter->new_msgs, counter->old_msgs);
621
622         while ((aor_name = ast_strip(strsep(&endpoint_aors, ",")))) {
623                 RAII_VAR(struct ast_sip_aor *, aor, ast_sip_location_retrieve_aor(aor_name), ao2_cleanup);
624                 RAII_VAR(struct ao2_container *, contacts, NULL, ao2_cleanup);
625                 struct unsolicited_mwi_data mwi_data = {
626                         .sub = sub,
627                         .endpoint = endpoint,
628                         .counter = counter,
629                 };
630
631                 if (!aor) {
632                         ast_log(LOG_WARNING, "Unable to locate AOR %s for unsolicited MWI\n", aor_name);
633                         continue;
634                 }
635
636                 contacts = ast_sip_location_retrieve_aor_contacts(aor);
637                 if (!contacts || (ao2_container_count(contacts) == 0)) {
638                         ast_debug(1, "No contacts bound to AOR %s. Cannot send unsolicited MWI until a contact registers.\n", aor_name);
639                         continue;
640                 }
641
642                 ao2_callback(contacts, OBJ_NODATA, send_unsolicited_mwi_notify_to_contact, &mwi_data);
643         }
644 }
645
646 static void send_mwi_notify(struct mwi_subscription *sub)
647 {
648         struct ast_sip_message_accumulator counter = {
649                 .old_msgs = 0,
650                 .new_msgs = 0,
651                 .message_account[0] = '\0',
652         };
653         struct ast_sip_body_data data = {
654                 .body_type = AST_SIP_MESSAGE_ACCUMULATOR,
655                 .body_data = &counter,
656         };
657
658         ao2_callback(sub->stasis_subs, OBJ_NODATA, get_message_count, &counter);
659
660         if (sub->is_solicited) {
661                 const char *resource = ast_sip_subscription_get_resource_name(sub->sip_sub);
662                 struct ast_sip_endpoint *endpoint = ast_sip_subscription_get_endpoint(sub->sip_sub);
663                 struct ast_sip_aor *aor = find_aor_for_resource(endpoint, resource);
664                 pjsip_dialog *dlg = ast_sip_subscription_get_dialog(sub->sip_sub);
665                 pjsip_sip_uri *sip_uri = ast_sip_subscription_get_sip_uri(sub->sip_sub);
666
667                 if (aor && dlg && sip_uri) {
668                         set_voicemail_extension(dlg->pool, sip_uri, &counter, aor->voicemail_extension);
669                 }
670
671                 ao2_cleanup(aor);
672                 ao2_cleanup(endpoint);
673                 ast_sip_subscription_notify(sub->sip_sub, &data, 0);
674
675                 return;
676         }
677
678         send_unsolicited_mwi_notify(sub, &counter);
679 }
680
681 static int unsubscribe_stasis(void *obj, void *arg, int flags)
682 {
683         struct mwi_stasis_subscription *mwi_stasis = obj;
684         if (mwi_stasis->stasis_sub) {
685                 ast_debug(3, "Removing stasis subscription to mailbox %s\n", mwi_stasis->mailbox);
686                 mwi_stasis->stasis_sub = stasis_unsubscribe_and_join(mwi_stasis->stasis_sub);
687         }
688         return CMP_MATCH;
689 }
690
691 static void mwi_subscription_shutdown(struct ast_sip_subscription *sub)
692 {
693         struct mwi_subscription *mwi_sub;
694         struct ast_datastore *mwi_datastore;
695
696         mwi_datastore = ast_sip_subscription_get_datastore(sub, MWI_DATASTORE);
697         if (!mwi_datastore) {
698                 return;
699         }
700
701         mwi_sub = mwi_datastore->data;
702         ao2_callback(mwi_sub->stasis_subs, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, unsubscribe_stasis, NULL);
703         ast_sip_subscription_remove_datastore(sub, MWI_DATASTORE);
704
705         ao2_ref(mwi_datastore, -1);
706 }
707
708 static void mwi_ds_destroy(void *data)
709 {
710         struct mwi_subscription *sub = data;
711
712         ao2_ref(sub, -1);
713 }
714
715 static struct ast_datastore_info mwi_ds_info = {
716         .destroy = mwi_ds_destroy,
717 };
718
719 static int add_mwi_datastore(struct mwi_subscription *sub)
720 {
721         struct ast_datastore *mwi_datastore;
722         int res;
723
724         mwi_datastore = ast_sip_subscription_alloc_datastore(&mwi_ds_info, MWI_DATASTORE);
725         if (!mwi_datastore) {
726                 return -1;
727         }
728         ao2_ref(sub, +1);
729         mwi_datastore->data = sub;
730
731         /*
732          * NOTE:  Adding the datastore to the subscription creates a ref loop
733          * that must be manually broken.
734          */
735         res = ast_sip_subscription_add_datastore(sub->sip_sub, mwi_datastore);
736         ao2_ref(mwi_datastore, -1);
737         return res;
738 }
739
740 /*!
741  * \brief Determines if an endpoint is receiving unsolicited MWI for a particular mailbox.
742  *
743  * \param endpoint The endpoint to check
744  * \param mailbox The candidate mailbox
745  * \retval 0 The endpoint does not receive unsolicited MWI for this mailbox
746  * \retval 1 The endpoint receives unsolicited MWI for this mailbox
747  */
748 static int endpoint_receives_unsolicited_mwi_for_mailbox(struct ast_sip_endpoint *endpoint,
749                 const char *mailbox)
750 {
751         struct ao2_iterator *mwi_subs;
752         struct mwi_subscription *mwi_sub;
753         const char *endpoint_id = ast_sorcery_object_get_id(endpoint);
754         int ret = 0;
755
756         mwi_subs = ao2_find(unsolicited_mwi, endpoint_id, OBJ_SEARCH_KEY | OBJ_MULTIPLE);
757         if (!mwi_subs) {
758                 return 0;
759         }
760
761         for (; (mwi_sub = ao2_iterator_next(mwi_subs)) && !ret; ao2_cleanup(mwi_sub)) {
762                 struct mwi_stasis_subscription *mwi_stasis;
763
764                 mwi_stasis = ao2_find(mwi_sub->stasis_subs, mailbox, OBJ_SEARCH_KEY);
765                 if (mwi_stasis) {
766                         if (endpoint->subscription.mwi.subscribe_replaces_unsolicited) {
767                                 unsubscribe_stasis(mwi_stasis, NULL, 0);
768                                 ao2_unlink(mwi_sub->stasis_subs, mwi_stasis);
769                         } else {
770                                 ret = 1;
771                         }
772                         ao2_cleanup(mwi_stasis);
773                 }
774         }
775
776         ao2_iterator_destroy(mwi_subs);
777         return ret;
778 }
779
780 /*!
781  * \brief Determine if an endpoint is a candidate to be able to subscribe for MWI
782  *
783  * Currently, this just makes sure that the endpoint is not already receiving unsolicted
784  * MWI for any of an AOR's configured mailboxes.
785  *
786  * \param obj The AOR to which the endpoint is subscribing.
787  * \param arg The endpoint that is attempting to subscribe.
788  * \param flags Unused.
789  * \retval 0 Endpoint is a candidate to subscribe to MWI on the AOR.
790  * \retval -1 The endpoint cannot subscribe to MWI on the AOR.
791  */
792 static int mwi_validate_for_aor(void *obj, void *arg, int flags)
793 {
794         struct ast_sip_aor *aor = obj;
795         struct ast_sip_endpoint *endpoint = arg;
796         char *mailboxes;
797         char *mailbox;
798
799         if (ast_strlen_zero(aor->mailboxes)) {
800                 return 0;
801         }
802
803         mailboxes = ast_strdupa(aor->mailboxes);
804         while ((mailbox = ast_strip(strsep(&mailboxes, ",")))) {
805                 if (ast_strlen_zero(mailbox)) {
806                         continue;
807                 }
808
809                 if (endpoint_receives_unsolicited_mwi_for_mailbox(endpoint, mailbox)) {
810                         ast_debug(1, "Endpoint '%s' already configured for unsolicited MWI for mailbox '%s'. "
811                                         "Denying MWI subscription to %s\n", ast_sorcery_object_get_id(endpoint), mailbox,
812                                         ast_sorcery_object_get_id(aor));
813                         return -1;
814                 }
815         }
816
817         return 0;
818 }
819
820 static int mwi_on_aor(void *obj, void *arg, int flags)
821 {
822         struct ast_sip_aor *aor = obj;
823         struct mwi_subscription *sub = arg;
824         char *mailboxes;
825         char *mailbox;
826
827         if (ast_strlen_zero(aor->mailboxes)) {
828                 return 0;
829         }
830
831         mailboxes = ast_strdupa(aor->mailboxes);
832         while ((mailbox = ast_strip(strsep(&mailboxes, ",")))) {
833                 struct mwi_stasis_subscription *mwi_stasis_sub;
834
835                 if (ast_strlen_zero(mailbox)) {
836                         continue;
837                 }
838
839                 mwi_stasis_sub = mwi_stasis_subscription_alloc(mailbox, sub);
840                 if (!mwi_stasis_sub) {
841                         continue;
842                 }
843
844                 ao2_link(sub->stasis_subs, mwi_stasis_sub);
845                 ao2_ref(mwi_stasis_sub, -1);
846         }
847
848         return 0;
849 }
850
851 static struct mwi_subscription *mwi_create_subscription(
852         struct ast_sip_endpoint *endpoint, struct ast_sip_subscription *sip_sub)
853 {
854         struct mwi_subscription *sub = mwi_subscription_alloc(endpoint, 1, sip_sub);
855
856         if (!sub) {
857                 return NULL;
858         }
859
860         if (add_mwi_datastore(sub)) {
861                 ast_log(LOG_WARNING, "Unable to add datastore for MWI subscription to %s\n",
862                         sub->id);
863                 ao2_ref(sub, -1);
864                 return NULL;
865         }
866
867         return sub;
868 }
869
870 static struct mwi_subscription *mwi_subscribe_single(
871         struct ast_sip_endpoint *endpoint, struct ast_sip_subscription *sip_sub, const char *name)
872 {
873         struct ast_sip_aor *aor;
874         struct mwi_subscription *sub;
875
876         aor = find_aor_for_resource(endpoint, name);
877         if (!aor) {
878                 ast_log(LOG_WARNING, "Unable to locate aor %s. MWI subscription failed.\n", name);
879                 return NULL;
880         }
881
882         sub = mwi_create_subscription(endpoint, sip_sub);
883         if (sub) {
884                 mwi_on_aor(aor, sub, 0);
885         }
886
887         ao2_ref(aor, -1);
888         return sub;
889 }
890
891 static struct mwi_subscription *mwi_subscribe_all(
892         struct ast_sip_endpoint *endpoint, struct ast_sip_subscription *sip_sub)
893 {
894         struct mwi_subscription *sub;
895
896         sub = mwi_create_subscription(endpoint, sip_sub);
897         if (!sub) {
898                 return NULL;
899         }
900
901         ast_sip_for_each_aor(endpoint->aors, mwi_on_aor, sub);
902         return sub;
903 }
904
905 static int mwi_new_subscribe(struct ast_sip_endpoint *endpoint,
906                 const char *resource)
907 {
908         RAII_VAR(struct ast_sip_aor *, aor, NULL, ao2_cleanup);
909
910         if (ast_strlen_zero(resource)) {
911                 if (ast_sip_for_each_aor(endpoint->aors, mwi_validate_for_aor, endpoint)) {
912                         return 500;
913                 }
914                 return 200;
915         }
916
917         aor = find_aor_for_resource(endpoint, resource);
918         if (!aor) {
919                 ast_debug(1, "Unable to locate aor %s. MWI subscription failed.\n", resource);
920                 return 404;
921         }
922
923         if (ast_strlen_zero(aor->mailboxes)) {
924                 ast_debug(1, "AOR %s has no configured mailboxes. MWI subscription failed.\n",
925                         resource);
926                 return 404;
927         }
928
929         if (mwi_validate_for_aor(aor, endpoint, 0)) {
930                 return 500;
931         }
932
933         return 200;
934 }
935
936 static int mwi_subscription_established(struct ast_sip_subscription *sip_sub)
937 {
938         const char *resource = ast_sip_subscription_get_resource_name(sip_sub);
939         struct mwi_subscription *sub;
940         struct ast_sip_endpoint *endpoint = ast_sip_subscription_get_endpoint(sip_sub);
941
942         /* no aor in uri? subscribe to all on endpoint */
943         if (ast_strlen_zero(resource)) {
944                 sub = mwi_subscribe_all(endpoint, sip_sub);
945         } else {
946                 sub = mwi_subscribe_single(endpoint, sip_sub, resource);
947         }
948         if (!sub) {
949                 ao2_cleanup(endpoint);
950                 return -1;
951         }
952
953         if (!ao2_container_count(sub->stasis_subs)) {
954                 /*
955                  * We setup no MWI subscriptions so remove the MWI datastore
956                  * to break the ref loop.
957                  */
958                 ast_sip_subscription_remove_datastore(sip_sub, MWI_DATASTORE);
959         }
960
961         ao2_cleanup(sub);
962         ao2_cleanup(endpoint);
963         return 0;
964 }
965
966 static void *mwi_get_notify_data(struct ast_sip_subscription *sub)
967 {
968         struct ast_sip_message_accumulator *counter;
969         struct mwi_subscription *mwi_sub;
970         struct ast_datastore *mwi_datastore;
971         struct ast_sip_aor *aor;
972         struct ast_sip_endpoint *endpoint = ast_sip_subscription_get_endpoint(sub);
973
974         mwi_datastore = ast_sip_subscription_get_datastore(sub, MWI_DATASTORE);
975         if (!mwi_datastore) {
976                 return NULL;
977         }
978         mwi_sub = mwi_datastore->data;
979
980         counter = ao2_alloc(sizeof(*counter), NULL);
981         if (!counter) {
982                 ao2_cleanup(mwi_datastore);
983                 return NULL;
984         }
985
986         if ((aor = find_aor_for_resource(endpoint, ast_sip_subscription_get_resource_name(sub)))) {
987                 pjsip_dialog *dlg = ast_sip_subscription_get_dialog(sub);
988                 pjsip_sip_uri *sip_uri = ast_sip_subscription_get_sip_uri(sub);
989
990                 if (dlg && sip_uri) {
991                         set_voicemail_extension(dlg->pool, sip_uri, counter, aor->voicemail_extension);
992                 }
993                 ao2_ref(aor, -1);
994         }
995         ao2_cleanup(endpoint);
996
997         ao2_callback(mwi_sub->stasis_subs, OBJ_NODATA, get_message_count, counter);
998         ao2_cleanup(mwi_datastore);
999         return counter;
1000 }
1001
1002 static void mwi_subscription_mailboxes_str(struct ao2_container *stasis_subs,
1003                                            struct ast_str **str)
1004 {
1005         int is_first = 1;
1006         struct mwi_stasis_subscription *node;
1007         struct ao2_iterator i = ao2_iterator_init(stasis_subs, 0);
1008
1009         while ((node = ao2_iterator_next(&i))) {
1010                 if (is_first) {
1011                         is_first = 0;
1012                         ast_str_append(str, 0, "%s", node->mailbox);
1013                 } else {
1014                         ast_str_append(str, 0, ",%s", node->mailbox);
1015                 }
1016                 ao2_ref(node, -1);
1017         }
1018         ao2_iterator_destroy(&i);
1019 }
1020
1021 static void mwi_to_ami(struct ast_sip_subscription *sub,
1022                        struct ast_str **buf)
1023 {
1024         struct mwi_subscription *mwi_sub;
1025         struct ast_datastore *mwi_datastore;
1026
1027         mwi_datastore = ast_sip_subscription_get_datastore(sub, MWI_DATASTORE);
1028         if (!mwi_datastore) {
1029                 return;
1030         }
1031
1032         mwi_sub = mwi_datastore->data;
1033
1034         ast_str_append(buf, 0, "SubscriptionType: mwi\r\n");
1035         ast_str_append(buf, 0, "Mailboxes: ");
1036         mwi_subscription_mailboxes_str(mwi_sub->stasis_subs, buf);
1037         ast_str_append(buf, 0, "\r\n");
1038
1039         ao2_ref(mwi_datastore, -1);
1040 }
1041
1042 static int serialized_notify(void *userdata)
1043 {
1044         struct mwi_subscription *mwi_sub = userdata;
1045
1046         send_mwi_notify(mwi_sub);
1047         ao2_ref(mwi_sub, -1);
1048         return 0;
1049 }
1050
1051 static int serialized_cleanup(void *userdata)
1052 {
1053         struct mwi_subscription *mwi_sub = userdata;
1054
1055         /* This is getting rid of the reference that was added
1056          * just before this serialized task was pushed.
1057          */
1058         ao2_cleanup(mwi_sub);
1059         /* This is getting rid of the reference held by the
1060          * stasis subscription
1061          */
1062         ao2_cleanup(mwi_sub);
1063         return 0;
1064 }
1065
1066 static int send_notify(void *obj, void *arg, int flags)
1067 {
1068         struct mwi_subscription *mwi_sub = obj;
1069         struct ast_taskprocessor *serializer = mwi_sub->is_solicited
1070                 ? ast_sip_subscription_get_serializer(mwi_sub->sip_sub)
1071                 : get_mwi_serializer();
1072
1073         if (ast_sip_push_task(serializer, serialized_notify, ao2_bump(mwi_sub))) {
1074                 ao2_ref(mwi_sub, -1);
1075         }
1076
1077         return 0;
1078 }
1079
1080 static void mwi_stasis_cb(void *userdata, struct stasis_subscription *sub,
1081                 struct stasis_message *msg)
1082 {
1083         struct mwi_subscription *mwi_sub = userdata;
1084
1085         if (stasis_subscription_final_message(sub, msg)) {
1086                 if (ast_sip_push_task(NULL, serialized_cleanup, ao2_bump(mwi_sub))) {
1087                         ao2_ref(mwi_sub, -1);
1088                 }
1089                 return;
1090         }
1091
1092         if (ast_mwi_state_type() == stasis_message_type(msg)) {
1093                 send_notify(mwi_sub, NULL, 0);
1094         }
1095 }
1096
1097 /*! \note Called with the unsolicited_mwi container lock held. */
1098 static int create_mwi_subscriptions_for_endpoint(void *obj, void *arg, int flags)
1099 {
1100         RAII_VAR(struct mwi_subscription *, aggregate_sub, NULL, ao2_cleanup);
1101         struct ast_sip_endpoint *endpoint = obj;
1102         char *mailboxes, *mailbox;
1103
1104         if (ast_strlen_zero(endpoint->subscription.mwi.mailboxes)) {
1105                 return 0;
1106         }
1107
1108         if (endpoint->subscription.mwi.aggregate) {
1109                 const char *endpoint_id = ast_sorcery_object_get_id(endpoint);
1110
1111                 /* Check if subscription exists */
1112                 aggregate_sub = ao2_find(unsolicited_mwi, endpoint_id, OBJ_SEARCH_KEY | OBJ_NOLOCK);
1113                 if (aggregate_sub) {
1114                         return 0;
1115                 }
1116                 aggregate_sub = mwi_subscription_alloc(endpoint, 0, NULL);
1117                 if (!aggregate_sub) {
1118                         return 0;
1119                 }
1120         }
1121
1122         mailboxes = ast_strdupa(endpoint->subscription.mwi.mailboxes);
1123         while ((mailbox = ast_strip(strsep(&mailboxes, ",")))) {
1124                 struct mwi_subscription *sub;
1125                 struct mwi_stasis_subscription *mwi_stasis_sub;
1126
1127                 /* check if subscription exists */
1128                 if (ast_strlen_zero(mailbox) ||
1129                         (!aggregate_sub && endpoint_receives_unsolicited_mwi_for_mailbox(endpoint, mailbox))) {
1130                         continue;
1131                 }
1132
1133                 sub = aggregate_sub ?: mwi_subscription_alloc(endpoint, 0, NULL);
1134                 mwi_stasis_sub = mwi_stasis_subscription_alloc(mailbox, sub);
1135                 if (mwi_stasis_sub) {
1136                         ao2_link(sub->stasis_subs, mwi_stasis_sub);
1137                         ao2_ref(mwi_stasis_sub, -1);
1138                 }
1139                 if (!aggregate_sub && sub) {
1140                         ao2_link_flags(unsolicited_mwi, sub, OBJ_NOLOCK);
1141                         ao2_ref(sub, -1);
1142                 }
1143         }
1144         if (aggregate_sub) {
1145                 ao2_link_flags(unsolicited_mwi, aggregate_sub, OBJ_NOLOCK);
1146         }
1147         return 0;
1148 }
1149
1150 static int unsubscribe(void *obj, void *arg, int flags)
1151 {
1152         struct mwi_subscription *mwi_sub = obj;
1153
1154         ao2_callback(mwi_sub->stasis_subs, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, unsubscribe_stasis, NULL);
1155
1156         return CMP_MATCH;
1157 }
1158
1159 static void create_mwi_subscriptions(void)
1160 {
1161         struct ao2_container *endpoints;
1162         struct ast_variable *var;
1163
1164         var = ast_variable_new("mailboxes !=", "", "");
1165
1166         endpoints = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), "endpoint",
1167                 AST_RETRIEVE_FLAG_MULTIPLE, var);
1168
1169         ast_variables_destroy(var);
1170         if (!endpoints) {
1171                 return;
1172         }
1173
1174         /* We remove all the old stasis subscriptions first before applying the new configuration. This
1175          * prevents a situation where there might be multiple overlapping stasis subscriptions for an
1176          * endpoint for mailboxes. Though there may be mailbox changes during the gap between unsubscribing
1177          * and resubscribing, up-to-date mailbox state will be sent out to the endpoint when the
1178          * new stasis subscription is established
1179          */
1180         ao2_lock(unsolicited_mwi);
1181         ao2_callback(unsolicited_mwi, OBJ_NOLOCK | OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, unsubscribe, NULL);
1182         ao2_callback(endpoints, OBJ_NODATA, create_mwi_subscriptions_for_endpoint, NULL);
1183         ao2_unlock(unsolicited_mwi);
1184
1185         ao2_ref(endpoints, -1);
1186 }
1187
1188 /*! \brief Function called to send MWI NOTIFY on any unsolicited mailboxes relating to this AOR */
1189 static int send_contact_notify(void *obj, void *arg, int flags)
1190 {
1191         struct mwi_subscription *mwi_sub = obj;
1192         const char *aor = arg;
1193
1194         if (!mwi_sub->aors || !strstr(mwi_sub->aors, aor)) {
1195                 return 0;
1196         }
1197
1198         if (ast_sip_push_task(get_mwi_serializer(), serialized_notify, ao2_bump(mwi_sub))) {
1199                 ao2_ref(mwi_sub, -1);
1200         }
1201
1202         return 0;
1203 }
1204
1205 /*! \brief Create mwi subscriptions and notify */
1206 static void mwi_contact_changed(const struct ast_sip_contact *contact)
1207 {
1208         char *id = ast_strdupa(ast_sorcery_object_get_id(contact));
1209         char *aor = NULL;
1210         struct ast_sip_endpoint *endpoint = NULL;
1211
1212         if (contact->endpoint) {
1213                 endpoint = ao2_bump(contact->endpoint);
1214         } else {
1215                 if (!ast_strlen_zero(contact->endpoint_name)) {
1216                         endpoint = ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "endpoint", contact->endpoint_name);
1217                 }
1218         }
1219
1220         if (!endpoint || ast_strlen_zero(endpoint->subscription.mwi.mailboxes)) {
1221                 ao2_cleanup(endpoint);
1222                 return;
1223         }
1224
1225         ao2_lock(unsolicited_mwi);
1226         create_mwi_subscriptions_for_endpoint(endpoint, NULL, 0);
1227         ao2_unlock(unsolicited_mwi);
1228         ao2_cleanup(endpoint);
1229
1230         aor = strsep(&id, ";@");
1231         ao2_callback(unsolicited_mwi, OBJ_NODATA, send_contact_notify, aor);
1232 }
1233
1234 /*! \brief Function called when a contact is updated */
1235 static void mwi_contact_updated(const void *object)
1236 {
1237         mwi_contact_changed(object);
1238 }
1239
1240 /*! \brief Function called when a contact is added */
1241 static void mwi_contact_added(const void *object)
1242 {
1243         mwi_contact_changed(object);
1244 }
1245
1246 /*! \brief Function called when a contact is deleted */
1247 static void mwi_contact_deleted(const void *object)
1248 {
1249         const struct ast_sip_contact *contact = object;
1250         struct ao2_iterator *mwi_subs;
1251         struct mwi_subscription *mwi_sub;
1252         struct ast_sip_endpoint *endpoint = NULL;
1253         struct ast_sip_contact *found_contact;
1254
1255         if (contact->endpoint) {
1256                 endpoint = ao2_bump(contact->endpoint);
1257         } else {
1258                 if (!ast_strlen_zero(contact->endpoint_name)) {
1259                         endpoint = ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(), "endpoint", contact->endpoint_name);
1260                 }
1261         }
1262
1263         if (!endpoint || ast_strlen_zero(endpoint->subscription.mwi.mailboxes)) {
1264                 ao2_cleanup(endpoint);
1265                 return;
1266         }
1267
1268         /* Check if there is another contact */
1269         found_contact = ast_sip_location_retrieve_contact_from_aor_list(endpoint->aors);
1270         ao2_cleanup(endpoint);
1271         if (found_contact) {
1272                 ao2_cleanup(found_contact);
1273                 return;
1274         }
1275
1276         ao2_lock(unsolicited_mwi);
1277         mwi_subs = ao2_find(unsolicited_mwi, contact->endpoint_name,
1278                 OBJ_SEARCH_KEY | OBJ_MULTIPLE | OBJ_NOLOCK | OBJ_UNLINK);
1279         if (mwi_subs) {
1280                 for (; (mwi_sub = ao2_iterator_next(mwi_subs)); ao2_cleanup(mwi_sub)) {
1281                         unsubscribe(mwi_sub, NULL, 0);
1282                 }
1283                 ao2_iterator_destroy(mwi_subs);
1284         }
1285         ao2_unlock(unsolicited_mwi);
1286 }
1287
1288 /*! \brief Observer for contacts so unsolicited MWI is sent when a contact changes */
1289 static const struct ast_sorcery_observer mwi_contact_observer = {
1290         .created = mwi_contact_added,
1291         .updated = mwi_contact_updated,
1292         .deleted = mwi_contact_deleted,
1293 };
1294
1295 /*! \brief Task invoked to send initial MWI NOTIFY for unsolicited */
1296 static int send_initial_notify_all(void *obj)
1297 {
1298         ao2_callback(unsolicited_mwi, OBJ_NODATA, send_notify, NULL);
1299
1300         return 0;
1301 }
1302
1303 /*! \brief Event callback which fires initial unsolicited MWI NOTIFY messages when we're fully booted */
1304 static void mwi_startup_event_cb(void *data, struct stasis_subscription *sub, struct stasis_message *message)
1305 {
1306         struct ast_json_payload *payload;
1307         const char *type;
1308
1309         if (stasis_message_type(message) != ast_manager_get_generic_type()) {
1310                 return;
1311         }
1312
1313         payload = stasis_message_data(message);
1314         type = ast_json_string_get(ast_json_object_get(payload->json, "type"));
1315
1316         if (strcmp(type, "FullyBooted")) {
1317                 return;
1318         }
1319
1320         ast_sip_push_task(NULL, send_initial_notify_all, NULL);
1321
1322         stasis_unsubscribe(sub);
1323 }
1324
1325 static void global_loaded(const char *object_type)
1326 {
1327         ast_free(default_voicemail_extension);
1328         default_voicemail_extension = ast_sip_get_default_voicemail_extension();
1329         mwi_serializer_set_alert_levels();
1330 }
1331
1332 static struct ast_sorcery_observer global_observer = {
1333         .loaded = global_loaded,
1334 };
1335
1336 static int reload(void)
1337 {
1338         if (!ast_sip_get_mwi_disable_initial_unsolicited()) {
1339                 create_mwi_subscriptions();
1340         }
1341         return 0;
1342 }
1343
1344 static int load_module(void)
1345 {
1346         if (ast_sip_register_subscription_handler(&mwi_handler)) {
1347                 return AST_MODULE_LOAD_DECLINE;
1348         }
1349
1350         if (mwi_serializer_pool_setup()) {
1351                 ast_log(AST_LOG_WARNING, "Failed to create MWI serializer pool. The default SIP pool will be used for MWI\n");
1352         }
1353
1354         unsolicited_mwi = ao2_container_alloc_hash(AO2_ALLOC_OPT_LOCK_MUTEX, 0, MWI_BUCKETS,
1355                 mwi_sub_hash, NULL, mwi_sub_cmp);
1356         if (!unsolicited_mwi) {
1357                 mwi_serializer_pool_shutdown();
1358                 ast_sip_unregister_subscription_handler(&mwi_handler);
1359                 return AST_MODULE_LOAD_DECLINE;
1360         }
1361
1362         ast_sorcery_observer_add(ast_sip_get_sorcery(), "contact", &mwi_contact_observer);
1363         ast_sorcery_observer_add(ast_sip_get_sorcery(), "global", &global_observer);
1364         ast_sorcery_reload_object(ast_sip_get_sorcery(), "global");
1365
1366         if (!ast_sip_get_mwi_disable_initial_unsolicited()) {
1367                 create_mwi_subscriptions();
1368                 if (ast_test_flag(&ast_options, AST_OPT_FLAG_FULLY_BOOTED)) {
1369                         ast_sip_push_task(NULL, send_initial_notify_all, NULL);
1370                 } else {
1371                         struct stasis_subscription *sub;
1372
1373                         sub = stasis_subscribe_pool(ast_manager_get_topic(), mwi_startup_event_cb, NULL);
1374                         stasis_subscription_accept_message_type(sub, ast_manager_get_generic_type());
1375                         stasis_subscription_set_filter(sub, STASIS_SUBSCRIPTION_FILTER_SELECTIVE);
1376                 }
1377         }
1378
1379         return AST_MODULE_LOAD_SUCCESS;
1380 }
1381
1382 static int unload_module(void)
1383 {
1384         ast_sorcery_observer_remove(ast_sip_get_sorcery(), "global", &global_observer);
1385         ast_sorcery_observer_remove(ast_sip_get_sorcery(), "contact", &mwi_contact_observer);
1386
1387         ao2_callback(unsolicited_mwi, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, unsubscribe, NULL);
1388         ao2_ref(unsolicited_mwi, -1);
1389         unsolicited_mwi = NULL;
1390
1391         mwi_serializer_pool_shutdown();
1392
1393         ast_sip_unregister_subscription_handler(&mwi_handler);
1394
1395         ast_free(default_voicemail_extension);
1396         default_voicemail_extension = NULL;
1397         return 0;
1398 }
1399
1400 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "PJSIP MWI resource",
1401         .support_level = AST_MODULE_SUPPORT_CORE,
1402         .load = load_module,
1403         .unload = unload_module,
1404         .reload = reload,
1405         .load_pri = AST_MODPRI_CHANNEL_DEPEND + 5,
1406         .requires = "res_pjsip,res_pjsip_pubsub",
1407 );