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