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