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