Merge "res_pjsip: Failover when server is not available"
[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         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         struct stasis_message *msg;
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
314         ao2_ref(msg, -1);
315
316         return 0;
317 }
318
319 struct unsolicited_mwi_data {
320         struct mwi_subscription *sub;
321         struct ast_sip_endpoint *endpoint;
322         pjsip_evsub_state state;
323         const struct ast_sip_body *body;
324 };
325
326 static int send_unsolicited_mwi_notify_to_contact(void *obj, void *arg, int flags)
327 {
328         struct unsolicited_mwi_data *mwi_data = arg;
329         struct mwi_subscription *sub = mwi_data->sub;
330         struct ast_sip_endpoint *endpoint = mwi_data->endpoint;
331         pjsip_evsub_state state = mwi_data->state;
332         const struct ast_sip_body *body = mwi_data->body;
333         struct ast_sip_contact *contact = obj;
334         const char *state_name;
335         pjsip_tx_data *tdata;
336         pjsip_sub_state_hdr *sub_state;
337         pjsip_event_hdr *event;
338         const pjsip_hdr *allow_events = pjsip_evsub_get_allow_events_hdr(NULL);
339
340         if (ast_sip_create_request("NOTIFY", NULL, endpoint, NULL, contact, &tdata)) {
341                 ast_log(LOG_WARNING, "Unable to create unsolicited NOTIFY request to endpoint %s URI %s\n", sub->id, contact->uri);
342                 return 0;
343         }
344
345         if (!ast_strlen_zero(endpoint->subscription.mwi.fromuser)) {
346                 pjsip_fromto_hdr *from = pjsip_msg_find_hdr(tdata->msg, PJSIP_H_FROM, NULL);
347                 pjsip_name_addr *from_name_addr = (pjsip_name_addr *) from->uri;
348                 pjsip_sip_uri *from_uri = pjsip_uri_get_uri(from_name_addr->uri);
349
350                 pj_strdup2(tdata->pool, &from_uri->user, endpoint->subscription.mwi.fromuser);
351         }
352
353         switch (state) {
354         case PJSIP_EVSUB_STATE_ACTIVE:
355                 state_name = "active";
356                 break;
357         case PJSIP_EVSUB_STATE_TERMINATED:
358         default:
359                 state_name = "terminated";
360                 break;
361         }
362
363         sub_state = pjsip_sub_state_hdr_create(tdata->pool);
364         pj_cstr(&sub_state->sub_state, state_name);
365         pjsip_msg_add_hdr(tdata->msg, (pjsip_hdr *) sub_state);
366
367         event = pjsip_event_hdr_create(tdata->pool);
368         pj_cstr(&event->event_type, "message-summary");
369         pjsip_msg_add_hdr(tdata->msg, (pjsip_hdr *) event);
370
371         pjsip_msg_add_hdr(tdata->msg, pjsip_hdr_shallow_clone(tdata->pool, allow_events));
372         ast_sip_add_body(tdata, body);
373         ast_sip_send_request(tdata, NULL, endpoint, NULL, NULL);
374
375         return 0;
376 }
377
378 static void send_unsolicited_mwi_notify(struct mwi_subscription *sub,
379                 struct ast_sip_message_accumulator *counter)
380 {
381         RAII_VAR(struct ast_sip_endpoint *, endpoint, ast_sorcery_retrieve_by_id(ast_sip_get_sorcery(),
382                                 "endpoint", sub->id), ao2_cleanup);
383         char *endpoint_aors;
384         char *aor_name;
385         struct ast_sip_body body;
386         struct ast_str *body_text;
387         struct ast_sip_body_data body_data = {
388                 .body_type = AST_SIP_MESSAGE_ACCUMULATOR,
389                 .body_data = counter,
390         };
391
392         if (!endpoint) {
393                 ast_log(LOG_WARNING, "Unable to send unsolicited MWI to %s because endpoint does not exist\n",
394                                 sub->id);
395                 return;
396         }
397         if (ast_strlen_zero(endpoint->aors)) {
398                 ast_log(LOG_WARNING, "Unable to send unsolicited MWI to %s because the endpoint has no"
399                                 " configured AORs\n", sub->id);
400                 return;
401         }
402
403         body.type = MWI_TYPE;
404         body.subtype = MWI_SUBTYPE;
405
406         body_text = ast_str_create(64);
407
408         if (!body_text) {
409                 return;
410         }
411
412         if (ast_sip_pubsub_generate_body_content(body.type, body.subtype, &body_data, &body_text)) {
413                 ast_log(LOG_WARNING, "Unable to generate SIP MWI NOTIFY body.\n");
414                 ast_free(body_text);
415                 return;
416         }
417
418         body.body_text = ast_str_buffer(body_text);
419
420         endpoint_aors = ast_strdupa(endpoint->aors);
421
422         ast_debug(5, "Sending unsolicited MWI NOTIFY to endpoint %s, new messages: %d, old messages: %d\n",
423                         sub->id, counter->new_msgs, counter->old_msgs);
424
425         while ((aor_name = strsep(&endpoint_aors, ","))) {
426                 RAII_VAR(struct ast_sip_aor *, aor, ast_sip_location_retrieve_aor(aor_name), ao2_cleanup);
427                 RAII_VAR(struct ao2_container *, contacts, NULL, ao2_cleanup);
428                 struct unsolicited_mwi_data mwi_data = {
429                         .sub = sub,
430                         .endpoint = endpoint,
431                         .body = &body,
432                 };
433
434                 if (!aor) {
435                         ast_log(LOG_WARNING, "Unable to locate AOR %s for unsolicited MWI\n", aor_name);
436                         continue;
437                 }
438
439                 contacts = ast_sip_location_retrieve_aor_contacts(aor);
440                 if (!contacts || (ao2_container_count(contacts) == 0)) {
441                         ast_log(LOG_NOTICE, "No contacts bound to AOR %s. Cannot send unsolicited MWI until a contact registers.\n", aor_name);
442                         continue;
443                 }
444
445                 ao2_callback(contacts, OBJ_NODATA, send_unsolicited_mwi_notify_to_contact, &mwi_data);
446         }
447
448         ast_free(body_text);
449 }
450
451 static void send_mwi_notify(struct mwi_subscription *sub)
452 {
453         struct ast_sip_message_accumulator counter = {
454                 .old_msgs = 0,
455                 .new_msgs = 0,
456         };
457         struct ast_sip_body_data data = {
458                 .body_type = AST_SIP_MESSAGE_ACCUMULATOR,
459                 .body_data = &counter,
460         };
461
462         ao2_callback(sub->stasis_subs, OBJ_NODATA, get_message_count, &counter);
463
464         if (sub->is_solicited) {
465                 ast_sip_subscription_notify(sub->sip_sub, &data, 0);
466                 return;
467         }
468
469         send_unsolicited_mwi_notify(sub, &counter);
470 }
471
472 static int unsubscribe_stasis(void *obj, void *arg, int flags)
473 {
474         struct mwi_stasis_subscription *mwi_stasis = obj;
475         if (mwi_stasis->stasis_sub) {
476                 ast_debug(3, "Removing stasis subscription to mailbox %s\n", mwi_stasis->mailbox);
477                 mwi_stasis->stasis_sub = stasis_unsubscribe_and_join(mwi_stasis->stasis_sub);
478         }
479         return CMP_MATCH;
480 }
481
482 static void mwi_subscription_shutdown(struct ast_sip_subscription *sub)
483 {
484         struct mwi_subscription *mwi_sub;
485         struct ast_datastore *mwi_datastore;
486
487         mwi_datastore = ast_sip_subscription_get_datastore(sub, MWI_DATASTORE);
488         if (!mwi_datastore) {
489                 return;
490         }
491
492         mwi_sub = mwi_datastore->data;
493         ao2_callback(mwi_sub->stasis_subs, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, unsubscribe_stasis, NULL);
494
495         ao2_ref(mwi_datastore, -1);
496 }
497
498 static struct ast_datastore_info mwi_ds_info = { };
499
500 static int add_mwi_datastore(struct mwi_subscription *sub)
501 {
502         struct ast_datastore *mwi_datastore;
503
504         mwi_datastore = ast_sip_subscription_alloc_datastore(&mwi_ds_info, MWI_DATASTORE);
505         if (!mwi_datastore) {
506                 return -1;
507         }
508         mwi_datastore->data = sub;
509
510         ast_sip_subscription_add_datastore(sub->sip_sub, mwi_datastore);
511         ao2_ref(mwi_datastore, -1);
512         return 0;
513 }
514
515 /*!
516  * \brief Determines if an endpoint is receiving unsolicited MWI for a particular mailbox.
517  *
518  * \param endpoint The endpoint to check
519  * \param mailbox The candidate mailbox
520  * \retval 0 The endpoint does not receive unsolicited MWI for this mailbox
521  * \retval 1 The endpoint receives unsolicited MWI for this mailbox
522  */
523 static int endpoint_receives_unsolicited_mwi_for_mailbox(struct ast_sip_endpoint *endpoint,
524                 const char *mailbox)
525 {
526         struct ao2_iterator *mwi_subs;
527         struct mwi_subscription *mwi_sub;
528         const char *endpoint_id = ast_sorcery_object_get_id(endpoint);
529         int ret = 0;
530
531         mwi_subs = ao2_find(unsolicited_mwi, endpoint_id, OBJ_SEARCH_KEY | OBJ_MULTIPLE);
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                 struct mwi_stasis_subscription *mwi_stasis_sub;
601
602                 mwi_stasis_sub = mwi_stasis_subscription_alloc(mailbox, sub);
603                 if (!mwi_stasis_sub) {
604                         continue;
605                 }
606
607                 ao2_link(sub->stasis_subs, mwi_stasis_sub);
608                 ao2_ref(mwi_stasis_sub, -1);
609         }
610
611         return 0;
612 }
613
614 static struct mwi_subscription *mwi_create_subscription(
615         struct ast_sip_endpoint *endpoint, struct ast_sip_subscription *sip_sub)
616 {
617         struct mwi_subscription *sub = mwi_subscription_alloc(endpoint, 1, sip_sub);
618
619         if (!sub) {
620                 return NULL;
621         }
622
623         if (add_mwi_datastore(sub)) {
624                 ast_log(LOG_WARNING, "Unable to allocate datastore on MWI "
625                         "subscription from %s\n", sub->id);
626                 ao2_ref(sub, -1);
627                 return NULL;
628         }
629
630         return sub;
631 }
632
633 static struct mwi_subscription *mwi_subscribe_single(
634         struct ast_sip_endpoint *endpoint, struct ast_sip_subscription *sip_sub, const char *name)
635 {
636         RAII_VAR(struct ast_sip_aor *, aor,
637                  ast_sip_location_retrieve_aor(name), ao2_cleanup);
638         struct mwi_subscription *sub;
639
640         if (!aor) {
641                 /*! I suppose it's possible for the AOR to disappear on us
642                  * between accepting the subscription and sending the first
643                  * NOTIFY...
644                  */
645                 ast_log(LOG_WARNING, "Unable to locate aor %s. MWI "
646                         "subscription failed.\n", name);
647                 return NULL;
648         }
649
650         if (!(sub = mwi_create_subscription(endpoint, sip_sub))) {
651                 return NULL;
652         }
653
654         mwi_on_aor(aor, sub, 0);
655         return sub;
656 }
657
658 static struct mwi_subscription *mwi_subscribe_all(
659         struct ast_sip_endpoint *endpoint, struct ast_sip_subscription *sip_sub)
660 {
661         struct mwi_subscription *sub;
662
663         sub = mwi_create_subscription(endpoint, sip_sub);
664
665         if (!sub) {
666                 return NULL;
667         }
668
669         ast_sip_for_each_aor(endpoint->aors, mwi_on_aor, sub);
670         return sub;
671 }
672
673 static int mwi_new_subscribe(struct ast_sip_endpoint *endpoint,
674                 const char *resource)
675 {
676         RAII_VAR(struct ast_sip_aor *, aor, NULL, ao2_cleanup);
677
678         if (ast_strlen_zero(resource)) {
679                 if (ast_sip_for_each_aor(endpoint->aors, mwi_validate_for_aor, endpoint)) {
680                         return 500;
681                 }
682                 return 200;
683         }
684
685         aor = ast_sip_location_retrieve_aor(resource);
686
687         if (!aor) {
688                 ast_log(LOG_WARNING, "Unable to locate aor %s. MWI "
689                         "subscription failed.\n", resource);
690                 return 404;
691         }
692
693         if (ast_strlen_zero(aor->mailboxes)) {
694                 ast_log(LOG_NOTICE, "AOR %s has no configured mailboxes. "
695                         "MWI subscription failed\n", resource);
696                 return 404;
697         }
698
699         if (mwi_validate_for_aor(aor, endpoint, 0)) {
700                 return 500;
701         }
702
703         return 200;
704 }
705
706 static int mwi_subscription_established(struct ast_sip_subscription *sip_sub)
707 {
708         const char *resource = ast_sip_subscription_get_resource_name(sip_sub);
709         struct mwi_subscription *sub;
710         struct ast_sip_endpoint *endpoint = ast_sip_subscription_get_endpoint(sip_sub);
711
712         /* no aor in uri? subscribe to all on endpoint */
713         if (ast_strlen_zero(resource)) {
714                 sub = mwi_subscribe_all(endpoint, sip_sub);
715         } else {
716                 sub = mwi_subscribe_single(endpoint, sip_sub, resource);
717         }
718
719         if (!sub) {
720                 ao2_cleanup(endpoint);
721                 return -1;
722         }
723
724         ao2_cleanup(sub);
725         ao2_cleanup(endpoint);
726         return 0;
727 }
728
729 static void *mwi_get_notify_data(struct ast_sip_subscription *sub)
730 {
731         struct ast_sip_message_accumulator *counter;
732         struct mwi_subscription *mwi_sub;
733         struct ast_datastore *mwi_datastore;
734
735         mwi_datastore = ast_sip_subscription_get_datastore(sub, MWI_DATASTORE);
736         if (!mwi_datastore) {
737                 return NULL;
738         }
739         mwi_sub = mwi_datastore->data;
740
741         counter = ao2_alloc(sizeof(*counter), NULL);
742         if (!counter) {
743                 ao2_cleanup(mwi_datastore);
744                 return NULL;
745         }
746
747         ao2_callback(mwi_sub->stasis_subs, OBJ_NODATA, get_message_count, counter);
748         ao2_cleanup(mwi_datastore);
749         return counter;
750 }
751
752 static void mwi_subscription_mailboxes_str(struct ao2_container *stasis_subs,
753                                            struct ast_str **str)
754 {
755         int num = ao2_container_count(stasis_subs);
756
757         struct mwi_stasis_subscription *node;
758         struct ao2_iterator i = ao2_iterator_init(stasis_subs, 0);
759
760         while ((node = ao2_iterator_next(&i))) {
761                 if (--num) {
762                         ast_str_append(str, 0, "%s,", node->mailbox);
763                 } else {
764                         ast_str_append(str, 0, "%s", node->mailbox);
765                 }
766                 ao2_ref(node, -1);
767         }
768         ao2_iterator_destroy(&i);
769 }
770
771 static void mwi_to_ami(struct ast_sip_subscription *sub,
772                        struct ast_str **buf)
773 {
774         struct mwi_subscription *mwi_sub;
775         struct ast_datastore *mwi_datastore;
776
777         mwi_datastore = ast_sip_subscription_get_datastore(sub, MWI_DATASTORE);
778         if (!mwi_datastore) {
779                 return;
780         }
781
782         mwi_sub = mwi_datastore->data;
783
784         ast_str_append(buf, 0, "SubscriptionType: mwi\r\n");
785         ast_str_append(buf, 0, "Mailboxes: ");
786         mwi_subscription_mailboxes_str(mwi_sub->stasis_subs, buf);
787         ast_str_append(buf, 0, "\r\n");
788
789         ao2_ref(mwi_datastore, -1);
790 }
791
792 static int serialized_notify(void *userdata)
793 {
794         struct mwi_subscription *mwi_sub = userdata;
795
796         send_mwi_notify(mwi_sub);
797         ao2_ref(mwi_sub, -1);
798         return 0;
799 }
800
801 static int serialized_cleanup(void *userdata)
802 {
803         struct mwi_subscription *mwi_sub = userdata;
804
805         /* This is getting rid of the reference that was added
806          * just before this serialized task was pushed.
807          */
808         ao2_cleanup(mwi_sub);
809         /* This is getting rid of the reference held by the
810          * stasis subscription
811          */
812         ao2_cleanup(mwi_sub);
813         return 0;
814 }
815
816 static int send_notify(void *obj, void *arg, int flags)
817 {
818         struct mwi_subscription *mwi_sub = obj;
819         struct ast_taskprocessor *serializer = mwi_sub->is_solicited ? ast_sip_subscription_get_serializer(mwi_sub->sip_sub) : NULL;
820
821         if (ast_sip_push_task(serializer, serialized_notify, ao2_bump(mwi_sub))) {
822                 ao2_ref(mwi_sub, -1);
823         }
824
825         return 0;
826 }
827
828 static void mwi_stasis_cb(void *userdata, struct stasis_subscription *sub,
829                 struct stasis_message *msg)
830 {
831         struct mwi_subscription *mwi_sub = userdata;
832
833         if (stasis_subscription_final_message(sub, msg)) {
834                 if (ast_sip_push_task(NULL, serialized_cleanup, ao2_bump(mwi_sub))) {
835                         ao2_ref(mwi_sub, -1);
836                 }
837                 return;
838         }
839
840         if (ast_mwi_state_type() == stasis_message_type(msg)) {
841                 send_notify(mwi_sub, NULL, 0);
842         }
843 }
844
845 static int create_mwi_subscriptions_for_endpoint(void *obj, void *arg, int flags)
846 {
847         RAII_VAR(struct mwi_subscription *, aggregate_sub, NULL, ao2_cleanup);
848         struct ast_sip_endpoint *endpoint = obj;
849         char *endpoint_aors, *aor_name, *mailboxes, *mailbox;
850         struct ao2_container *contacts = NULL;
851
852         if (ast_strlen_zero(endpoint->subscription.mwi.mailboxes)) {
853                 return 0;
854         }
855
856         endpoint_aors = ast_strdupa(endpoint->aors);
857
858         while ((aor_name = strsep(&endpoint_aors, ","))) {
859                 RAII_VAR(struct ast_sip_aor *, aor, ast_sip_location_retrieve_aor(aor_name), ao2_cleanup);
860
861                 if (!aor) {
862                         continue;
863                 }
864
865                 contacts = ast_sip_location_retrieve_aor_contacts(aor);
866                 if (!contacts || (ao2_container_count(contacts) == 0)) {
867                         ao2_cleanup(contacts);
868                         contacts = NULL;
869                         continue;
870                 }
871
872                 break;
873         }
874
875         if (!contacts) {
876                 return 0;
877         }
878
879         ao2_ref(contacts, -1);
880
881         if (endpoint->subscription.mwi.aggregate) {
882                 aggregate_sub = mwi_subscription_alloc(endpoint, 0, NULL);
883                 if (!aggregate_sub) {
884                         return 0;
885                 }
886         }
887
888         mailboxes = ast_strdupa(endpoint->subscription.mwi.mailboxes);
889         while ((mailbox = strsep(&mailboxes, ","))) {
890                 struct mwi_subscription *sub = aggregate_sub ?:
891                         mwi_subscription_alloc(endpoint, 0, NULL);
892                 struct mwi_stasis_subscription *mwi_stasis_sub;
893
894                 mwi_stasis_sub = mwi_stasis_subscription_alloc(mailbox, sub);
895                 if (mwi_stasis_sub) {
896                         ao2_link(sub->stasis_subs, mwi_stasis_sub);
897                         ao2_ref(mwi_stasis_sub, -1);
898                 }
899                 if (!aggregate_sub && sub) {
900                         ao2_link_flags(unsolicited_mwi, sub, OBJ_NOLOCK);
901                         ao2_ref(sub, -1);
902                 }
903         }
904         if (aggregate_sub) {
905                 ao2_link_flags(unsolicited_mwi, aggregate_sub, OBJ_NOLOCK);
906         }
907         return 0;
908 }
909
910 static int unsubscribe(void *obj, void *arg, int flags)
911 {
912         struct mwi_subscription *mwi_sub = obj;
913
914         ao2_callback(mwi_sub->stasis_subs, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, unsubscribe_stasis, NULL);
915
916         return CMP_MATCH;
917 }
918
919 static void create_mwi_subscriptions(void)
920 {
921         struct ao2_container *endpoints;
922
923         endpoints = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), "endpoint",
924                 AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);
925         if (!endpoints) {
926                 return;
927         }
928
929         /* We remove all the old stasis subscriptions first before applying the new configuration. This
930          * prevents a situation where there might be multiple overlapping stasis subscriptions for an
931          * endpoint for mailboxes. Though there may be mailbox changes during the gap between unsubscribing
932          * and resubscribing, up-to-date mailbox state will be sent out to the endpoint when the
933          * new stasis subscription is established
934          */
935         ao2_lock(unsolicited_mwi);
936         ao2_callback(unsolicited_mwi, OBJ_NOLOCK | OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, unsubscribe, NULL);
937         ao2_callback(endpoints, OBJ_NODATA, create_mwi_subscriptions_for_endpoint, NULL);
938         ao2_unlock(unsolicited_mwi);
939
940         ao2_ref(endpoints, -1);
941 }
942
943 /*! \brief Function called to send MWI NOTIFY on any unsolicited mailboxes relating to this AOR */
944 static int send_contact_notify(void *obj, void *arg, int flags)
945 {
946         struct mwi_subscription *mwi_sub = obj;
947         const char *aor = arg;
948
949         if (!mwi_sub->aors || !strstr(mwi_sub->aors, aor)) {
950                 return 0;
951         }
952
953         if (ast_sip_push_task(NULL, serialized_notify, ao2_bump(mwi_sub))) {
954                 ao2_ref(mwi_sub, -1);
955         }
956
957         return 0;
958 }
959
960 /*! \brief Function called when a contact is updated */
961 static void mwi_contact_updated(const void *object)
962 {
963         char *id = ast_strdupa(ast_sorcery_object_get_id(object)), *aor = NULL;
964
965         aor = strsep(&id, ";@");
966
967         ao2_callback(unsolicited_mwi, OBJ_NODATA, send_contact_notify, aor);
968 }
969
970 /*! \brief Function called when a contact is added */
971 static void mwi_contact_added(const void *object)
972 {
973         const struct ast_sip_contact *contact = object;
974         struct ao2_iterator *mwi_subs;
975         struct mwi_subscription *mwi_sub;
976         const char *endpoint_id = ast_sorcery_object_get_id(contact->endpoint);
977
978         if (ast_strlen_zero(contact->endpoint->subscription.mwi.mailboxes)) {
979                 return;
980         }
981
982         ao2_lock(unsolicited_mwi);
983
984         mwi_subs = ao2_find(unsolicited_mwi, endpoint_id, OBJ_SEARCH_KEY | OBJ_MULTIPLE | OBJ_NOLOCK | OBJ_UNLINK);
985
986         if (mwi_subs) {
987                 for (; (mwi_sub = ao2_iterator_next(mwi_subs)); ao2_cleanup(mwi_sub)) {
988                         unsubscribe(mwi_sub, NULL, 0);
989                 }
990                 ao2_iterator_destroy(mwi_subs);
991         }
992
993         create_mwi_subscriptions_for_endpoint(contact->endpoint, NULL, 0);
994
995         ao2_unlock(unsolicited_mwi);
996
997         mwi_contact_updated(object);
998 }
999
1000 /*! \brief Observer for contacts so unsolicited MWI is sent when a contact changes */
1001 static const struct ast_sorcery_observer mwi_contact_observer = {
1002         .created = mwi_contact_added,
1003         .updated = mwi_contact_updated,
1004 };
1005
1006 /*! \brief Task invoked to send initial MWI NOTIFY for unsolicited */
1007 static int send_initial_notify_all(void *obj)
1008 {
1009         ao2_callback(unsolicited_mwi, OBJ_NODATA, send_notify, NULL);
1010
1011         return 0;
1012 }
1013
1014 /*! \brief Event callback which fires initial unsolicited MWI NOTIFY messages when we're fully booted */
1015 static void mwi_startup_event_cb(void *data, struct stasis_subscription *sub, struct stasis_message *message)
1016 {
1017         struct ast_json_payload *payload;
1018         const char *type;
1019
1020         if (stasis_message_type(message) != ast_manager_get_generic_type()) {
1021                 return;
1022         }
1023
1024         payload = stasis_message_data(message);
1025         type = ast_json_string_get(ast_json_object_get(payload->json, "type"));
1026
1027         if (strcmp(type, "FullyBooted")) {
1028                 return;
1029         }
1030
1031         ast_sip_push_task(NULL, send_initial_notify_all, NULL);
1032
1033         stasis_unsubscribe(sub);
1034 }
1035
1036 static int reload(void)
1037 {
1038         create_mwi_subscriptions();
1039         return 0;
1040 }
1041
1042 static int load_module(void)
1043 {
1044         CHECK_PJSIP_MODULE_LOADED();
1045
1046         if (ast_sip_register_subscription_handler(&mwi_handler)) {
1047                 return AST_MODULE_LOAD_DECLINE;
1048         }
1049
1050         unsolicited_mwi = ao2_container_alloc(MWI_BUCKETS, mwi_sub_hash, mwi_sub_cmp);
1051         if (!unsolicited_mwi) {
1052                 ast_sip_unregister_subscription_handler(&mwi_handler);
1053                 return AST_MODULE_LOAD_DECLINE;
1054         }
1055
1056         create_mwi_subscriptions();
1057         ast_sorcery_observer_add(ast_sip_get_sorcery(), "contact", &mwi_contact_observer);
1058
1059         if (ast_test_flag(&ast_options, AST_OPT_FLAG_FULLY_BOOTED)) {
1060                 ast_sip_push_task(NULL, send_initial_notify_all, NULL);
1061         } else {
1062                 stasis_subscribe_pool(ast_manager_get_topic(), mwi_startup_event_cb, NULL);
1063         }
1064
1065         return AST_MODULE_LOAD_SUCCESS;
1066 }
1067
1068 static int unload_module(void)
1069 {
1070         ao2_callback(unsolicited_mwi, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, unsubscribe, NULL);
1071         ao2_ref(unsolicited_mwi, -1);
1072         ast_sorcery_observer_remove(ast_sip_get_sorcery(), "contact", &mwi_contact_observer);
1073         ast_sip_unregister_subscription_handler(&mwi_handler);
1074         return 0;
1075 }
1076
1077 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "PJSIP MWI resource",
1078         .support_level = AST_MODULE_SUPPORT_CORE,
1079         .load = load_module,
1080         .unload = unload_module,
1081         .reload = reload,
1082         .load_pri = AST_MODPRI_CHANNEL_DEPEND,
1083 );