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