f25a7c48f9714fd7f7221f0d9f578344c0fe5df2
[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/sorcery.h"
39 #include "asterisk/stasis.h"
40 #include "asterisk/app.h"
41
42 struct mwi_subscription;
43 AO2_GLOBAL_OBJ_STATIC(unsolicited_mwi);
44
45 #define STASIS_BUCKETS 13
46 #define MWI_BUCKETS 53
47
48 #define MWI_TYPE "application"
49 #define MWI_SUBTYPE "simple-message-summary"
50
51 static void mwi_subscription_shutdown(struct ast_sip_subscription *sub);
52 static struct ast_sip_subscription *mwi_new_subscribe(struct ast_sip_endpoint *endpoint,
53                 pjsip_rx_data *rdata);
54 static void mwi_resubscribe(struct ast_sip_subscription *sub, pjsip_rx_data *rdata,
55                 struct ast_sip_subscription_response_data *response_data);
56 static void mwi_subscription_timeout(struct ast_sip_subscription *sub);
57 static void mwi_subscription_terminated(struct ast_sip_subscription *sub, pjsip_rx_data *rdata);
58 static void mwi_notify_response(struct ast_sip_subscription *sub, pjsip_rx_data *rdata);
59 static void mwi_notify_request(struct ast_sip_subscription *sub, pjsip_rx_data *rdata,
60                 struct ast_sip_subscription_response_data *response_data);
61 static int mwi_refresh_subscription(struct ast_sip_subscription *sub);
62 static void mwi_to_ami(struct ast_sip_subscription *sub, struct ast_str **buf);
63
64 static struct ast_sip_subscription_handler mwi_handler = {
65         .event_name = "message-summary",
66         .accept = { MWI_TYPE"/"MWI_SUBTYPE, },
67         .default_accept =  MWI_TYPE"/"MWI_SUBTYPE,
68         .subscription_shutdown = mwi_subscription_shutdown,
69         .new_subscribe = mwi_new_subscribe,
70         .resubscribe = mwi_resubscribe,
71         .subscription_timeout = mwi_subscription_timeout,
72         .subscription_terminated = mwi_subscription_terminated,
73         .notify_response = mwi_notify_response,
74         .notify_request = mwi_notify_request,
75         .refresh_subscription = mwi_refresh_subscription,
76         .to_ami = mwi_to_ami,
77 };
78
79 /*!
80  * \brief Wrapper for stasis subscription
81  *
82  * An MWI subscription has a container of these. This
83  * represents a stasis subscription for MWI state.
84  */
85 struct mwi_stasis_subscription {
86         /*! The MWI stasis subscription */
87         struct stasis_subscription *stasis_sub;
88         /*! The mailbox corresponding with the MWI subscription. Used as a hash key */
89         char mailbox[1];
90 };
91
92 /*!
93  * \brief A subscription for MWI
94  *
95  * This subscription is the basis for MWI for an endpoint. Each
96  * endpoint that uses MWI will have a corresponding mwi_subscription.
97  *
98  * This structure acts as the owner for the underlying SIP subscription.
99  * When the mwi_subscription is destroyed, the SIP subscription dies, too.
100  * The mwi_subscription's lifetime is governed by its underlying stasis
101  * subscriptions. When all stasis subscriptions are destroyed, the
102  * mwi_subscription is destroyed as well.
103  */
104 struct mwi_subscription {
105         /*! Container of \ref mwi_stasis_subscription structures.
106          * A single MWI subscription may be fore multiple mailboxes, thus
107          * requiring multiple stasis subscriptions
108          */
109         struct ao2_container *stasis_subs;
110         /*! The SIP subscription. Unsolicited MWI does not use this */
111         struct ast_sip_subscription *sip_sub;
112         /*! Is the MWI solicited (i.e. Initiated with an external SUBSCRIBE) ? */
113         unsigned int is_solicited;
114         /*! Identifier for the subscription.
115          * The identifier is the same as the corresponding endpoint's stasis ID.
116          * Used as a hash key
117          */
118         char id[1];
119 };
120
121 static void mwi_stasis_cb(void *userdata, struct stasis_subscription *sub,
122                 struct stasis_message *msg);
123
124 static struct mwi_stasis_subscription *mwi_stasis_subscription_alloc(const char *mailbox, struct mwi_subscription *mwi_sub)
125 {
126         struct mwi_stasis_subscription *mwi_stasis_sub;
127         struct stasis_topic *topic;
128
129         if (!mwi_sub) {
130                 return NULL;
131         }
132
133         mwi_stasis_sub = ao2_alloc(sizeof(*mwi_stasis_sub) + strlen(mailbox), NULL);
134         if (!mwi_stasis_sub) {
135                 return NULL;
136         }
137
138         topic = ast_mwi_topic(mailbox);
139
140         /* Safe strcpy */
141         strcpy(mwi_stasis_sub->mailbox, mailbox);
142         ao2_ref(mwi_sub, +1);
143         ast_debug(3, "Creating stasis MWI subscription to mailbox %s for endpoint %s\n", mailbox, mwi_sub->id);
144         mwi_stasis_sub->stasis_sub = stasis_subscribe(topic, mwi_stasis_cb, mwi_sub);
145         return mwi_stasis_sub;
146 }
147
148 static int stasis_sub_hash(const void *obj, const int flags)
149 {
150         const struct mwi_stasis_subscription *object;
151         const char *key;
152
153         switch (flags & OBJ_SEARCH_MASK) {
154         case OBJ_SEARCH_KEY:
155                 key = obj;
156                 break;
157         case OBJ_SEARCH_OBJECT:
158                 object = obj;
159                 key = object->mailbox;
160                 break;
161         default:
162                 ast_assert(0);
163                 return 0;
164         }
165         return ast_str_hash(key);
166 }
167
168 static int stasis_sub_cmp(void *obj, void *arg, int flags)
169 {
170         const struct mwi_stasis_subscription *sub_left = obj;
171         const struct mwi_stasis_subscription *sub_right = arg;
172         const char *right_key = arg;
173         int cmp;
174
175         switch (flags & OBJ_SEARCH_MASK) {
176         case OBJ_SEARCH_OBJECT:
177                 right_key = sub_right->mailbox;
178                 /* Fall through */
179         case OBJ_SEARCH_KEY:
180                 cmp = strcmp(sub_left->mailbox, right_key);
181                 break;
182         case OBJ_SEARCH_PARTIAL_KEY:
183                 cmp = strncmp(sub_left->mailbox, right_key, strlen(right_key));
184                 break;
185         default:
186                 cmp = 0;
187                 break;
188         }
189         if (cmp) {
190                 return 0;
191         }
192         return CMP_MATCH;
193 }
194
195 static void mwi_subscription_destructor(void *obj)
196 {
197         struct mwi_subscription *sub = obj;
198
199         ast_debug(3, "Destroying MWI subscription for endpoint %s\n", sub->id);
200         ao2_cleanup(sub->sip_sub);
201         ao2_cleanup(sub->stasis_subs);
202 }
203
204 static struct mwi_subscription *mwi_subscription_alloc(struct ast_sip_endpoint *endpoint,
205                 enum ast_sip_subscription_role role, unsigned int is_solicited, pjsip_rx_data *rdata)
206 {
207         struct mwi_subscription *sub;
208         const char *endpoint_id = ast_sorcery_object_get_id(endpoint);
209
210         sub = ao2_alloc(sizeof(*sub) + strlen(endpoint_id),
211                         mwi_subscription_destructor);
212
213         if (!sub) {
214                 return NULL;
215         }
216
217         /* Safe strcpy */
218         strcpy(sub->id, endpoint_id);
219         /* Unsolicited MWI doesn't actually result in a SIP subscription being
220          * created. This is because a SIP subscription associates with a dialog.
221          * Most devices expect unsolicited MWI NOTIFYs to appear out of dialog. If
222          * they receive an in-dialog MWI NOTIFY (i.e. with a to-tag), then they
223          * will reject the NOTIFY with a 481, thus resulting in message-waiting
224          * state not being updated on the device
225          */
226         if (is_solicited) {
227                 sub->sip_sub = ast_sip_create_subscription(&mwi_handler,
228                                 role, endpoint, rdata);
229                 if (!sub->sip_sub) {
230                         ast_log(LOG_WARNING, "Unable to create MWI SIP subscription for endpoint %s\n", sub->id);
231                         ao2_cleanup(sub);
232                         return NULL;
233                 }
234         }
235
236         sub->stasis_subs = ao2_container_alloc(STASIS_BUCKETS, stasis_sub_hash, stasis_sub_cmp);
237         if (!sub->stasis_subs) {
238                 ao2_cleanup(sub);
239                 return NULL;
240         }
241         sub->is_solicited = is_solicited;
242
243         ast_debug(3, "Created %s MWI subscription for endpoint %s\n", is_solicited ? "solicited" : "unsolicited", sub->id);
244
245         return sub;
246 }
247
248 static int mwi_sub_hash(const void *obj, const int flags)
249 {
250         const struct mwi_subscription *object;
251         const char *key;
252
253         switch (flags & OBJ_SEARCH_MASK) {
254         case OBJ_SEARCH_KEY:
255                 key = obj;
256                 break;
257         case OBJ_SEARCH_OBJECT:
258                 object = obj;
259                 key = object->id;
260                 break;
261         default:
262                 ast_assert(0);
263                 return 0;
264         }
265         return ast_str_hash(key);
266 }
267
268 static int mwi_sub_cmp(void *obj, void *arg, int flags)
269 {
270         const struct mwi_subscription *sub_left = obj;
271         const struct mwi_subscription *sub_right = arg;
272         const char *right_key = arg;
273         int cmp;
274
275         switch (flags & OBJ_SEARCH_MASK) {
276         case OBJ_SEARCH_OBJECT:
277                 right_key = sub_right->id;
278                 /* Fall through */
279         case OBJ_SEARCH_KEY:
280                 cmp = strcmp(sub_left->id, right_key);
281                 break;
282         case OBJ_SEARCH_PARTIAL_KEY:
283                 cmp = strncmp(sub_left->id, right_key, strlen(right_key));
284                 break;
285         default:
286                 cmp = 0;
287                 break;
288         }
289         if (cmp) {
290                 return 0;
291         }
292         return CMP_MATCH;
293 }
294
295 static int get_message_count(void *obj, void *arg, int flags)
296 {
297         RAII_VAR(struct stasis_message *, msg, NULL, ao2_cleanup);
298         struct mwi_stasis_subscription *mwi_stasis = obj;
299         struct ast_sip_message_accumulator *counter = arg;
300         struct ast_mwi_state *mwi_state;
301
302         msg = stasis_cache_get(ast_mwi_state_cache(), ast_mwi_state_type(), mwi_stasis->mailbox);
303         if (!msg) {
304                 return 0;
305         }
306
307         mwi_state = stasis_message_data(msg);
308         counter->old_msgs += mwi_state->old_msgs;
309         counter->new_msgs += mwi_state->new_msgs;
310         return 0;
311 }
312
313 struct unsolicited_mwi_data {
314         struct mwi_subscription *sub;
315         struct ast_sip_endpoint *endpoint;
316         pjsip_evsub_state state;
317         const char *reason;
318         const struct ast_sip_body *body;
319 };
320
321 static int send_unsolicited_mwi_notify_to_contact(void *obj, void *arg, int flags)
322 {
323         struct unsolicited_mwi_data *mwi_data = arg;
324         struct mwi_subscription *sub = mwi_data->sub;
325         struct ast_sip_endpoint *endpoint = mwi_data->endpoint;
326         pjsip_evsub_state state = mwi_data->state;
327         const char *reason = mwi_data->reason;
328         const struct ast_sip_body *body = mwi_data->body;
329         struct ast_sip_contact *contact = obj;
330         const char *state_name;
331         pjsip_tx_data *tdata;
332         pjsip_sub_state_hdr *sub_state;
333         pjsip_event_hdr *event;
334         const pjsip_hdr *allow_events = pjsip_evsub_get_allow_events_hdr(NULL);
335
336         if (ast_sip_create_request("NOTIFY", NULL, endpoint, NULL, contact, &tdata)) {
337                 ast_log(LOG_WARNING, "Unable to create unsolicited NOTIFY request to endpoint %s URI %s\n", sub->id, contact->uri);
338                 return 0;
339         }
340
341         if (!ast_strlen_zero(endpoint->subscription.mwi.fromuser)) {
342                 pjsip_fromto_hdr *from = pjsip_msg_find_hdr(tdata->msg, PJSIP_H_FROM, NULL);
343                 pjsip_name_addr *from_name_addr = (pjsip_name_addr *) from->uri;
344                 pjsip_sip_uri *from_uri = pjsip_uri_get_uri(from_name_addr->uri);
345
346                 pj_strdup2(tdata->pool, &from_uri->user, endpoint->subscription.mwi.fromuser);
347         }
348
349         switch (state) {
350         case PJSIP_EVSUB_STATE_ACTIVE:
351                 state_name = "active";
352                 break;
353         case PJSIP_EVSUB_STATE_TERMINATED:
354         default:
355                 state_name = "terminated";
356                 break;
357         }
358
359         sub_state = pjsip_sub_state_hdr_create(tdata->pool);
360         pj_cstr(&sub_state->sub_state, state_name);
361         if (reason) {
362                 pj_cstr(&sub_state->reason_param, reason);
363         }
364         pjsip_msg_add_hdr(tdata->msg, (pjsip_hdr *) sub_state);
365
366         event = pjsip_event_hdr_create(tdata->pool);
367         pj_cstr(&event->event_type, "message-summary");
368         pjsip_msg_add_hdr(tdata->msg, (pjsip_hdr *) event);
369
370         pjsip_msg_add_hdr(tdata->msg, pjsip_hdr_shallow_clone(tdata->pool, allow_events));
371         ast_sip_add_body(tdata, body);
372         ast_sip_send_request(tdata, NULL, endpoint, NULL, NULL);
373
374         return 0;
375 }
376
377 static void send_unsolicited_mwi_notify(struct mwi_subscription *sub, pjsip_evsub_state state, const char *reason,
378                 struct ast_sip_body *body)
379 {
380         RAII_VAR(struct ast_sip_endpoint *, endpoint, ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(),
381                                 "endpoint", sub->id), ao2_cleanup);
382         char *endpoint_aors;
383         char *aor_name;
384
385         if (!endpoint) {
386                 ast_log(LOG_WARNING, "Unable to send unsolicited MWI to %s because endpoint does not exist\n",
387                                 sub->id);
388                 return;
389         }
390         if (ast_strlen_zero(endpoint->aors)) {
391                 ast_log(LOG_WARNING, "Unable to send unsolicited MWI to %s because the endpoint has no"
392                                 " configured AORs\n", sub->id);
393                 return;
394         }
395
396         endpoint_aors = ast_strdupa(endpoint->aors);
397
398         while ((aor_name = strsep(&endpoint_aors, ","))) {
399                 RAII_VAR(struct ast_sip_aor *, aor, ast_sip_location_retrieve_aor(aor_name), ao2_cleanup);
400                 RAII_VAR(struct ao2_container *, contacts, NULL, ao2_cleanup);
401                 struct unsolicited_mwi_data mwi_data = {
402                         .sub = sub,
403                         .endpoint = endpoint,
404                         .state = state,
405                         .reason = reason,
406                         .body = body,
407                 };
408
409                 if (!aor) {
410                         ast_log(LOG_WARNING, "Unable to locate AOR %s for unsolicited MWI\n", aor_name);
411                         continue;
412                 }
413
414                 contacts = ast_sip_location_retrieve_aor_contacts(aor);
415                 if (!contacts || (ao2_container_count(contacts) == 0)) {
416                         ast_log(LOG_WARNING, "No contacts bound to AOR %s. Cannot send unsolicited MWI.\n", aor_name);
417                         continue;
418                 }
419
420                 ao2_callback(contacts, OBJ_NODATA, send_unsolicited_mwi_notify_to_contact, &mwi_data);
421         }
422 }
423
424 static void send_mwi_notify(struct mwi_subscription *sub, pjsip_evsub_state state, const char *reason)
425 {
426         const pj_str_t *reason_str_ptr = NULL;
427         struct ast_sip_message_accumulator counter = {
428                 .old_msgs = 0,
429                 .new_msgs = 0,
430         };
431         RAII_VAR(struct ast_str *, body_text, ast_str_create(64), ast_free_ptr);
432         pjsip_tx_data *tdata;
433         pj_str_t reason_str;
434         struct ast_sip_body body;
435
436         body.type = sub->is_solicited ?
437                 ast_sip_subscription_get_body_type(sub->sip_sub) :
438                 MWI_TYPE;
439
440         body.subtype = sub->is_solicited ?
441                 ast_sip_subscription_get_body_subtype(sub->sip_sub) :
442                 MWI_SUBTYPE;
443
444         ao2_callback(sub->stasis_subs, OBJ_NODATA, get_message_count, &counter);
445
446         if (reason) {
447                 pj_cstr(&reason_str, reason);
448                 reason_str_ptr = &reason_str;
449         }
450
451         if (ast_sip_pubsub_generate_body_content(body.type, body.subtype, &counter, &body_text)) {
452                 ast_log(LOG_WARNING, "Unable to generate SIP MWI NOTIFY body.\n");
453                 return;
454         }
455
456         body.body_text = ast_str_buffer(body_text);
457
458         ast_debug(5, "Sending %s MWI NOTIFY to endpoint %s, new messages: %d, old messages: %d\n",
459                         sub->is_solicited ? "solicited" : "unsolicited", sub->id, counter.new_msgs,
460                         counter.old_msgs);
461
462         if (sub->is_solicited) {
463                 if (pjsip_evsub_notify(ast_sip_subscription_get_evsub(sub->sip_sub),
464                                         state, NULL, reason_str_ptr, &tdata) != PJ_SUCCESS) {
465                         ast_log(LOG_WARNING, "Unable to create MWI NOTIFY request to %s.\n", sub->id);
466                         return;
467                 }
468                 if (ast_sip_add_body(tdata, &body)) {
469                         ast_log(LOG_WARNING, "Unable to add body to MWI NOTIFY request\n");
470                         return;
471                 }
472                 if (ast_sip_subscription_send_request(sub->sip_sub, tdata) != PJ_SUCCESS) {
473                         ast_log(LOG_WARNING, "Unable to send MWI NOTIFY request to %s\n", sub->id);
474                         return;
475                 }
476         } else {
477                 send_unsolicited_mwi_notify(sub, state, reason, &body);
478         }
479 }
480
481 static int unsubscribe_stasis(void *obj, void *arg, int flags)
482 {
483         struct mwi_stasis_subscription *mwi_stasis = obj;
484         if (mwi_stasis->stasis_sub) {
485                 ast_debug(3, "Removing stasis subscription to mailbox %s\n", mwi_stasis->mailbox);
486                 mwi_stasis->stasis_sub = stasis_unsubscribe(mwi_stasis->stasis_sub);
487         }
488         return CMP_MATCH;
489 }
490
491 static void mwi_subscription_shutdown(struct ast_sip_subscription *sub)
492 {
493         struct mwi_subscription *mwi_sub;
494         RAII_VAR(struct ast_datastore *, mwi_datastore,
495                         ast_sip_subscription_get_datastore(sub, "MWI datastore"), ao2_cleanup);
496
497         if (!mwi_datastore) {
498                 return;
499         }
500
501         mwi_sub = mwi_datastore->data;
502         ao2_callback(mwi_sub->stasis_subs, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, unsubscribe_stasis, NULL);
503 }
504
505 static struct ast_datastore_info mwi_ds_info = { };
506
507 static int add_mwi_datastore(struct mwi_subscription *sub)
508 {
509         RAII_VAR(struct ast_datastore *, mwi_datastore, NULL, ao2_cleanup);
510
511         mwi_datastore = ast_sip_subscription_alloc_datastore(&mwi_ds_info, "MWI datastore");
512         if (!mwi_datastore) {
513                 return -1;
514         }
515         mwi_datastore->data = sub;
516
517         ast_sip_subscription_add_datastore(sub->sip_sub, mwi_datastore);
518         return 0;
519 }
520
521 /*!
522  * \brief Determines if an endpoint is receiving unsolicited MWI for a particular mailbox.
523  *
524  * \param endpoint The endpoint to check
525  * \param mailbox The candidate mailbox
526  * \retval 0 The endpoint does not receive unsolicited MWI for this mailbox
527  * \retval 1 The endpoint receives unsolicited MWI for this mailbox
528  */
529 static int endpoint_receives_unsolicited_mwi_for_mailbox(struct ast_sip_endpoint *endpoint,
530                 const char *mailbox)
531 {
532         struct ao2_container *unsolicited = ao2_global_obj_ref(unsolicited_mwi);
533         struct ao2_iterator *mwi_subs;
534         struct mwi_subscription *mwi_sub;
535         const char *endpoint_id = ast_sorcery_object_get_id(endpoint);
536         int ret = 0;
537
538         if (!unsolicited) {
539                 return 0;
540         }
541
542         mwi_subs = ao2_find(unsolicited, endpoint_id, OBJ_SEARCH_KEY | OBJ_MULTIPLE);
543         ao2_cleanup(unsolicited);
544
545         if (!mwi_subs) {
546                 return 0;
547         }
548
549         for (; (mwi_sub = ao2_iterator_next(mwi_subs)) && !ret; ao2_cleanup(mwi_sub)) {
550                 struct mwi_stasis_subscription *mwi_stasis;
551
552                 mwi_stasis = ao2_find(mwi_sub->stasis_subs, mailbox, OBJ_SEARCH_KEY);
553                 if (mwi_stasis) {
554                         ret = 1;
555                         ao2_cleanup(mwi_stasis);
556                 }
557         }
558
559         ao2_iterator_destroy(mwi_subs);
560         return ret;
561 }
562
563 /*!
564  * \brief Determine if an endpoint is a candidate to be able to subscribe for MWI
565  *
566  * Currently, this just makes sure that the endpoint is not already receiving unsolicted
567  * MWI for any of an AOR's configured mailboxes.
568  *
569  * \param obj The AOR to which the endpoint is subscribing.
570  * \param arg The endpoint that is attempting to subscribe.
571  * \param flags Unused.
572  * \retval 0 Endpoint is a candidate to subscribe to MWI on the AOR.
573  * \retval -1 The endpoint cannot subscribe to MWI on the AOR.
574  */
575 static int mwi_validate_for_aor(void *obj, void *arg, int flags)
576 {
577         struct ast_sip_aor *aor = obj;
578         struct ast_sip_endpoint *endpoint = arg;
579         char *mailboxes;
580         char *mailbox;
581
582         if (ast_strlen_zero(aor->mailboxes)) {
583                 return 0;
584         }
585
586         mailboxes = ast_strdupa(aor->mailboxes);
587         while ((mailbox = strsep(&mailboxes, ","))) {
588                 if (endpoint_receives_unsolicited_mwi_for_mailbox(endpoint, mailbox)) {
589                         ast_log(LOG_NOTICE, "Endpoint '%s' already configured for unsolicited MWI for mailbox '%s'. "
590                                         "Denying MWI subscription to %s\n", ast_sorcery_object_get_id(endpoint), mailbox,
591                                         ast_sorcery_object_get_id(aor));
592                         return -1;
593                 }
594         }
595
596         return 0;
597 }
598
599 static int mwi_on_aor(void *obj, void *arg, int flags)
600 {
601         struct ast_sip_aor *aor = obj;
602         struct mwi_subscription *sub = arg;
603         char *mailboxes;
604         char *mailbox;
605
606         if (ast_strlen_zero(aor->mailboxes)) {
607                 return 0;
608         }
609
610         mailboxes = ast_strdupa(aor->mailboxes);
611         while ((mailbox = strsep(&mailboxes, ","))) {
612                 RAII_VAR(struct mwi_stasis_subscription *, mwi_stasis_sub,
613                                 mwi_stasis_subscription_alloc(mailbox, sub), ao2_cleanup);
614                 if (mwi_stasis_sub) {
615                         ao2_link(sub->stasis_subs, mwi_stasis_sub);
616                 }
617         }
618
619         return 0;
620 }
621
622 static struct mwi_subscription *mwi_create_subscription(
623         struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata)
624 {
625         struct mwi_subscription *sub = mwi_subscription_alloc(
626                 endpoint, AST_SIP_NOTIFIER, 1, rdata);
627
628         if (!sub) {
629                 return NULL;
630         }
631
632         if (add_mwi_datastore(sub)) {
633                 ast_log(LOG_WARNING, "Unable to allocate datastore on MWI "
634                         "subscription from %s\n", sub->id);
635                 ao2_ref(sub, -1);
636                 return NULL;
637         }
638
639         return sub;
640 }
641
642 static struct mwi_subscription *mwi_subscribe_single(
643         struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, const char *name)
644 {
645         RAII_VAR(struct ast_sip_aor *, aor,
646                  ast_sip_location_retrieve_aor(name), ao2_cleanup);
647         struct mwi_subscription *sub;
648
649         if (!aor) {
650                 ast_log(LOG_WARNING, "Unable to locate aor %s. MWI "
651                         "subscription failed.\n", name);
652                 return NULL;
653         }
654
655         if (ast_strlen_zero(aor->mailboxes)) {
656                 ast_log(LOG_WARNING, "AOR %s has no configured mailboxes. "
657                         "MWI subscription failed\n", name);
658                 return NULL;
659         }
660
661         if (mwi_validate_for_aor(aor, endpoint, 0)) {
662                 return NULL;
663         }
664
665         if (!(sub = mwi_create_subscription(endpoint, rdata))) {
666                 return NULL;
667         }
668
669         mwi_on_aor(aor, sub, 0);
670         return sub;
671 }
672
673 static struct mwi_subscription *mwi_subscribe_all(
674         struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata)
675 {
676         struct mwi_subscription *sub;
677
678         if (ast_sip_for_each_aor(endpoint->aors, mwi_validate_for_aor, endpoint)) {
679                 return NULL;
680         }
681
682         sub = mwi_create_subscription(endpoint, rdata);
683
684         if (!sub) {
685                 return NULL;
686         }
687
688         ast_sip_for_each_aor(endpoint->aors, mwi_on_aor, sub);
689         return sub;
690 }
691
692 static struct ast_sip_subscription *mwi_new_subscribe(struct ast_sip_endpoint *endpoint,
693                 pjsip_rx_data *rdata)
694 {
695         /* It's not obvious here, but the reference(s) to this subscription,
696          * once this function exits, is held by the stasis subscription(s)
697          * created in mwi_stasis_subscription_alloc()
698          */
699         RAII_VAR(struct mwi_subscription *, sub, NULL, ao2_cleanup);
700         pjsip_uri *ruri = rdata->msg_info.msg->line.req.uri;
701         pjsip_sip_uri *sip_ruri;
702         char aor_name[80];
703
704         if (!PJSIP_URI_SCHEME_IS_SIP(ruri) && !PJSIP_URI_SCHEME_IS_SIPS(ruri)) {
705                 ast_log(LOG_WARNING, "Attempt to SUBSCRIBE to a non-SIP URI\n");
706                 return NULL;
707         }
708         sip_ruri = pjsip_uri_get_uri(ruri);
709         ast_copy_pj_str(aor_name, &sip_ruri->user, sizeof(aor_name));
710
711         /* no aor in uri? subscribe to all on endpoint */
712         if (!(sub = ast_strlen_zero(aor_name) ? mwi_subscribe_all(endpoint, rdata) :
713               mwi_subscribe_single(endpoint, rdata, aor_name))) {
714                 return NULL;
715         }
716
717         ast_sip_subscription_accept(sub->sip_sub, rdata, 200);
718         send_mwi_notify(sub, PJSIP_EVSUB_STATE_ACTIVE, NULL);
719
720         return sub->sip_sub;
721 }
722
723 static void mwi_resubscribe(struct ast_sip_subscription *sub,
724                 pjsip_rx_data *rdata, struct ast_sip_subscription_response_data *response_data)
725 {
726         struct mwi_subscription *mwi_sub;
727         pjsip_evsub_state state;
728         pjsip_evsub *evsub;
729         RAII_VAR(struct ast_datastore *, mwi_datastore,
730                         ast_sip_subscription_get_datastore(sub, "MWI datastore"), ao2_cleanup);
731
732         if (!mwi_datastore) {
733                 return;
734         }
735
736         mwi_sub = mwi_datastore->data;
737         evsub = ast_sip_subscription_get_evsub(sub);
738         state = pjsip_evsub_get_state(evsub);
739
740         send_mwi_notify(mwi_sub, state, NULL);
741 }
742
743 static void mwi_subscription_timeout(struct ast_sip_subscription *sub)
744 {
745         struct mwi_subscription *mwi_sub;
746         RAII_VAR(struct ast_datastore *, mwi_datastore,
747                         ast_sip_subscription_get_datastore(sub, "MWI datastore"), ao2_cleanup);
748
749         if (!mwi_datastore) {
750                 return;
751         }
752
753
754         mwi_sub = mwi_datastore->data;
755
756         ast_log(LOG_NOTICE, "MWI subscription for %s has timed out.\n", mwi_sub->id);
757
758         send_mwi_notify(mwi_sub, PJSIP_EVSUB_STATE_TERMINATED, "timeout");
759 }
760
761 static void mwi_subscription_terminated(struct ast_sip_subscription *sub, pjsip_rx_data *rdata)
762 {
763         struct mwi_subscription *mwi_sub;
764         RAII_VAR(struct ast_datastore *, mwi_datastore,
765                         ast_sip_subscription_get_datastore(sub, "MWI datastore"), ao2_cleanup);
766
767         if (!mwi_datastore) {
768                 return;
769         }
770
771         mwi_sub = mwi_datastore->data;
772
773         ast_log(LOG_NOTICE, "MWI subscription for %s has been terminated\n", mwi_sub->id);
774
775         send_mwi_notify(mwi_sub, PJSIP_EVSUB_STATE_TERMINATED, NULL);
776 }
777
778 static void mwi_notify_response(struct ast_sip_subscription *sub, pjsip_rx_data *rdata)
779 {
780         /* We don't really care about NOTIFY responses for the moment */
781 }
782
783 static void mwi_notify_request(struct ast_sip_subscription *sub, pjsip_rx_data *rdata,
784                 struct ast_sip_subscription_response_data *response_data)
785 {
786         ast_log(LOG_WARNING, "Received an MWI NOTIFY request? This should not happen\n");
787 }
788
789 static int mwi_refresh_subscription(struct ast_sip_subscription *sub)
790 {
791         ast_log(LOG_WARNING, "Being told to refresh an MWI subscription? This should not happen\n");
792         return 0;
793 }
794
795 static void mwi_subscription_mailboxes_str(struct ao2_container *stasis_subs,
796                                            struct ast_str **str)
797 {
798         int num = ao2_container_count(stasis_subs);
799
800         struct mwi_stasis_subscription *node;
801         struct ao2_iterator i = ao2_iterator_init(stasis_subs, 0);
802
803         while ((node = ao2_iterator_next(&i))) {
804                 if (--num) {
805                         ast_str_append(str, 0, "%s,", node->mailbox);
806                 } else {
807                         ast_str_append(str, 0, "%s", node->mailbox);
808                 }
809                 ao2_ref(node, -1);
810         }
811         ao2_iterator_destroy(&i);
812 }
813
814 static void mwi_to_ami(struct ast_sip_subscription *sub,
815                        struct ast_str **buf)
816 {
817         struct mwi_subscription *mwi_sub;
818         RAII_VAR(struct ast_datastore *, mwi_datastore,
819                         ast_sip_subscription_get_datastore(sub, "MWI datastore"), ao2_cleanup);
820
821         if (!mwi_datastore) {
822                 return;
823         }
824
825         mwi_sub = mwi_datastore->data;
826
827         ast_str_append(buf, 0, "SubscriptionType: mwi\r\n");
828         ast_str_append(buf, 0, "Mailboxes: ");
829         mwi_subscription_mailboxes_str(mwi_sub->stasis_subs, buf);
830         ast_str_append(buf, 0, "\r\n");
831 }
832
833 static int serialized_notify(void *userdata)
834 {
835         struct mwi_subscription *mwi_sub = userdata;
836
837         send_mwi_notify(mwi_sub, PJSIP_EVSUB_STATE_ACTIVE, NULL);
838         ao2_ref(mwi_sub, -1);
839         return 0;
840 }
841
842 static int serialized_cleanup(void *userdata)
843 {
844         struct mwi_subscription *mwi_sub = userdata;
845
846         /* This is getting rid of the reference that was added
847          * just before this serialized task was pushed.
848          */
849         ao2_cleanup(mwi_sub);
850         /* This is getting rid of the reference held by the
851          * stasis subscription
852          */
853         ao2_cleanup(mwi_sub);
854         return 0;
855 }
856
857 static void mwi_stasis_cb(void *userdata, struct stasis_subscription *sub,
858                 struct stasis_message *msg)
859 {
860         struct mwi_subscription *mwi_sub = userdata;
861
862         if (stasis_subscription_final_message(sub, msg)) {
863                 ao2_ref(mwi_sub, +1);
864                 ast_sip_push_task(NULL, serialized_cleanup, mwi_sub);
865                 return;
866         }
867
868         if (ast_mwi_state_type() == stasis_message_type(msg)) {
869                 struct ast_taskprocessor *serializer = mwi_sub->is_solicited ? ast_sip_subscription_get_serializer(mwi_sub->sip_sub) : NULL;
870                 ao2_ref(mwi_sub, +1);
871                 ast_sip_push_task(serializer, serialized_notify, mwi_sub);
872         }
873 }
874
875 static int create_mwi_subscriptions_for_endpoint(void *obj, void *arg, int flags)
876 {
877         RAII_VAR(struct mwi_subscription *, aggregate_sub, NULL, ao2_cleanup);
878         struct ast_sip_endpoint *endpoint = obj;
879         struct ao2_container *mwi_subscriptions = arg;
880         char *mailboxes;
881         char *mailbox;
882
883         if (ast_strlen_zero(endpoint->subscription.mwi.mailboxes)) {
884                 return 0;
885         }
886
887         if (endpoint->subscription.mwi.aggregate) {
888                 aggregate_sub = mwi_subscription_alloc(endpoint, AST_SIP_NOTIFIER, 0, NULL);
889                 if (!aggregate_sub) {
890                         return 0;
891                 }
892         }
893
894         mailboxes = ast_strdupa(endpoint->subscription.mwi.mailboxes);
895         while ((mailbox = strsep(&mailboxes, ","))) {
896                 struct mwi_subscription *sub = aggregate_sub ?:
897                         mwi_subscription_alloc(endpoint, AST_SIP_SUBSCRIBER, 0, NULL);
898                 RAII_VAR(struct mwi_stasis_subscription *, mwi_stasis_sub,
899                                 mwi_stasis_subscription_alloc(mailbox, sub), ao2_cleanup);
900                 if (mwi_stasis_sub) {
901                         ao2_link(sub->stasis_subs, mwi_stasis_sub);
902                 }
903                 if (!aggregate_sub) {
904                         ao2_link(mwi_subscriptions, sub);
905                         ao2_cleanup(sub);
906                 }
907         }
908         if (aggregate_sub) {
909                 ao2_link(mwi_subscriptions, aggregate_sub);
910         }
911         return 0;
912 }
913
914 static int unsubscribe(void *obj, void *arg, int flags)
915 {
916         struct mwi_subscription *mwi_sub = obj;
917
918         ao2_callback(mwi_sub->stasis_subs, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, unsubscribe_stasis, NULL);
919         return CMP_MATCH;
920 }
921
922 static void create_mwi_subscriptions(void)
923 {
924         struct ao2_container *mwi_subscriptions = ao2_container_alloc(MWI_BUCKETS, mwi_sub_hash, mwi_sub_cmp);
925         RAII_VAR(struct ao2_container *, old_mwi_subscriptions, ao2_global_obj_ref(unsolicited_mwi), ao2_cleanup);
926         RAII_VAR(struct ao2_container *, endpoints, ast_sorcery_retrieve_by_fields(
927                                 ast_sip_get_sorcery(), "endpoint", AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL),
928                         ao2_cleanup);
929
930         if (!mwi_subscriptions) {
931                 return;
932         }
933
934         /* We remove all the old stasis subscriptions first before applying the new configuration. This
935          * prevents a situation where there might be multiple overlapping stasis subscriptions for an
936          * endpoint for mailboxes. Though there may be mailbox changes during the gap between unsubscribing
937          * and resubscribing, up-to-date mailbox state will be sent out to the endpoint when the
938          * new stasis subscription is established
939          */
940         if (old_mwi_subscriptions) {
941                 ao2_callback(old_mwi_subscriptions, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, unsubscribe, NULL);
942         }
943         ao2_callback(endpoints, OBJ_NODATA, create_mwi_subscriptions_for_endpoint, mwi_subscriptions);
944         ao2_global_obj_replace_unref(unsolicited_mwi, mwi_subscriptions);
945         ao2_ref(mwi_subscriptions, -1);
946 }
947
948 static int reload(void)
949 {
950         create_mwi_subscriptions();
951         return 0;
952 }
953
954 static int load_module(void)
955 {
956         if (ast_sip_register_subscription_handler(&mwi_handler)) {
957                 return AST_MODULE_LOAD_DECLINE;
958         }
959         create_mwi_subscriptions();
960         return AST_MODULE_LOAD_SUCCESS;
961 }
962
963 static int unload_module(void)
964 {
965         RAII_VAR(struct ao2_container *, mwi_subscriptions, ao2_global_obj_ref(unsolicited_mwi), ao2_cleanup);
966         if (mwi_subscriptions) {
967                 ao2_callback(mwi_subscriptions, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, unsubscribe, NULL);
968                 ao2_global_obj_release(unsolicited_mwi);
969         }
970         ast_sip_unregister_subscription_handler(&mwi_handler);
971         return 0;
972 }
973
974 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "PJSIP MWI resource",
975                 .load = load_module,
976                 .unload = unload_module,
977                 .reload = reload,
978                 .load_pri = AST_MODPRI_CHANNEL_DEPEND,
979 );