5c2340863ed9c3151d90d7e843ba686d0287d073
[asterisk/asterisk.git] / main / devicestate.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2008, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  * Russell Bryant <russell@digium.com>
8  *
9  * See http://www.asterisk.org for more information about
10  * the Asterisk project. Please do not directly contact
11  * any of the maintainers of this project for assistance;
12  * the project provides a web site, mailing lists and IRC
13  * channels for your use.
14  *
15  * This program is free software, distributed under the terms of
16  * the GNU General Public License Version 2. See the LICENSE file
17  * at the top of the source tree.
18  */
19
20 /*! \file
21  *
22  * \brief Device state management
23  *
24  * \author Mark Spencer <markster@digium.com>
25  * \author Russell Bryant <russell@digium.com>
26  *
27  *      \arg \ref AstExtState
28  */
29
30 /*! \page AstExtState Extension and device states in Asterisk
31  *
32  * (Note that these descriptions of device states and extension
33  * states have not been updated to the way things work
34  * in Asterisk 1.6.)
35  *
36  *      Asterisk has an internal system that reports states
37  *      for an extension. By using the dialplan priority -1,
38  *      also called a \b hint, a connection can be made from an
39  *      extension to one or many devices. The state of the extension
40  *      now depends on the combined state of the devices.
41  *
42  *      The device state is basically based on the current calls.
43  *      If the devicestate engine can find a call from or to the
44  *      device, it's in use.
45  *
46  *      Some channel drivers implement a callback function for
47  *      a better level of reporting device states. The SIP channel
48  *      has a complicated system for this, which is improved
49  *      by adding call limits to the configuration.
50  *
51  *      Functions that want to check the status of an extension
52  *      register themself as a \b watcher.
53  *      Watchers in this system can subscribe either to all extensions
54  *      or just a specific extensions.
55  *
56  *      For non-device related states, there's an API called
57  *      devicestate providers. This is an extendible system for
58  *      delivering state information from outside sources or
59  *      functions within Asterisk. Currently we have providers
60  *      for app_meetme.c - the conference bridge - and call
61  *      parking (metermaids).
62  *
63  *      There are manly three subscribers to extension states
64  *      within Asterisk:
65  *      - AMI, the manager interface
66  *      - app_queue.c - the Queue dialplan application
67  *      - SIP subscriptions, a.k.a. "blinking lamps" or
68  *        "buddy lists"
69  *
70  *      The CLI command "show hints" show last known state
71  *
72  *      \note None of these handle user states, like an IM presence
73  *      system. res_xmpp.c can subscribe and watch such states
74  *      in jabber/xmpp based systems.
75  *
76  *      \section AstDevStateArch Architecture for devicestates
77  *
78  *      When a channel driver or asterisk app changes state for
79  *      a watched object, it alerts the core. The core queues
80  *      a change. When the change is processed, there's a query
81  *      sent to the channel driver/provider if there's a function
82  *      to handle that, otherwise a channel walk is issued to find
83  *      a channel that involves the object.
84  *
85  *      The changes are queued and processed by a separate thread.
86  *      This thread calls the watchers subscribing to status
87  *      changes for the object. For manager, this results
88  *      in events. For SIP, NOTIFY requests.
89  *
90  *      - Device states
91  *              \arg \ref devicestate.c
92  *              \arg \ref devicestate.h
93  *
94  *      \section AstExtStateArch Architecture for extension states
95  *
96  *      Hints are connected to extension. If an extension changes state
97  *      it checks the hint devices. If there is a hint, the callbacks into
98  *      device states are checked. The aggregated state is set for the hint
99  *      and reported back.
100  *
101  *      - Extension states
102  *              \arg \ref AstENUM ast_extension_states
103  *              \arg \ref pbx.c
104  *              \arg \ref pbx.h
105  *      - Structures
106  *              - \ref ast_state_cb struct.  Callbacks for watchers
107  *              - Callback ast_state_cb_type
108  *              - \ref ast_hint struct.
109  *      - Functions
110  *              - ast_extension_state_add()
111  *              - ast_extension_state_del()
112  *              - ast_get_hint()
113  *
114  */
115
116 /*** MODULEINFO
117         <support_level>core</support_level>
118  ***/
119
120 #include "asterisk.h"
121
122 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
123
124 #include "asterisk/_private.h"
125 #include "asterisk/channel.h"
126 #include "asterisk/utils.h"
127 #include "asterisk/lock.h"
128 #include "asterisk/linkedlists.h"
129 #include "asterisk/devicestate.h"
130 #include "asterisk/pbx.h"
131 #include "asterisk/app.h"
132 #include "asterisk/astobj2.h"
133 #include "asterisk/stasis.h"
134 #include "asterisk/devicestate.h"
135
136 #define DEVSTATE_TOPIC_BUCKETS 57
137
138 /*! \brief Device state strings for printing */
139 static const char * const devstatestring[][2] = {
140         { /* 0 AST_DEVICE_UNKNOWN */     "Unknown",     "UNKNOWN"     }, /*!< Valid, but unknown state */
141         { /* 1 AST_DEVICE_NOT_INUSE */   "Not in use",  "NOT_INUSE"   }, /*!< Not used */
142         { /* 2 AST_DEVICE IN USE */      "In use",      "INUSE"       }, /*!< In use */
143         { /* 3 AST_DEVICE_BUSY */        "Busy",        "BUSY"        }, /*!< Busy */
144         { /* 4 AST_DEVICE_INVALID */     "Invalid",     "INVALID"     }, /*!< Invalid - not known to Asterisk */
145         { /* 5 AST_DEVICE_UNAVAILABLE */ "Unavailable", "UNAVAILABLE" }, /*!< Unavailable (not registered) */
146         { /* 6 AST_DEVICE_RINGING */     "Ringing",     "RINGING"     }, /*!< Ring, ring, ring */
147         { /* 7 AST_DEVICE_RINGINUSE */   "Ring+Inuse",  "RINGINUSE"   }, /*!< Ring and in use */
148         { /* 8 AST_DEVICE_ONHOLD */      "On Hold",      "ONHOLD"      }, /*!< On Hold */
149 };
150
151 /*!\brief Mapping for channel states to device states */
152 static const struct chan2dev {
153         enum ast_channel_state chan;
154         enum ast_device_state dev;
155 } chan2dev[] = {
156         { AST_STATE_DOWN,            AST_DEVICE_NOT_INUSE },
157         { AST_STATE_RESERVED,        AST_DEVICE_INUSE },
158         { AST_STATE_OFFHOOK,         AST_DEVICE_INUSE },
159         { AST_STATE_DIALING,         AST_DEVICE_INUSE },
160         { AST_STATE_RING,            AST_DEVICE_INUSE },
161         { AST_STATE_RINGING,         AST_DEVICE_RINGING },
162         { AST_STATE_UP,              AST_DEVICE_INUSE },
163         { AST_STATE_BUSY,            AST_DEVICE_BUSY },
164         { AST_STATE_DIALING_OFFHOOK, AST_DEVICE_INUSE },
165         { AST_STATE_PRERING,         AST_DEVICE_RINGING },
166         { -100,                      -100 },
167 };
168
169 /*! \brief  A device state provider (not a channel) */
170 struct devstate_prov {
171         char label[40];
172         ast_devstate_prov_cb_type callback;
173         AST_RWLIST_ENTRY(devstate_prov) list;
174 };
175
176 /*! \brief A list of providers */
177 static AST_RWLIST_HEAD_STATIC(devstate_provs, devstate_prov);
178
179 struct state_change {
180         AST_LIST_ENTRY(state_change) list;
181         enum ast_devstate_cache cachable;
182         char device[1];
183 };
184
185 /*! \brief The state change queue. State changes are queued
186         for processing by a separate thread */
187 static AST_LIST_HEAD_STATIC(state_changes, state_change);
188
189 /*! \brief The device state change notification thread */
190 static pthread_t change_thread = AST_PTHREADT_NULL;
191
192 /*! \brief Flag for the queue */
193 static ast_cond_t change_pending;
194
195 struct stasis_subscription *devstate_message_sub;
196
197 static struct stasis_topic *device_state_topic_all;
198 static struct stasis_cache *device_state_cache;
199 static struct stasis_caching_topic *device_state_topic_cached;
200 static struct stasis_topic_pool *device_state_topic_pool;
201
202 STASIS_MESSAGE_TYPE_DEFN(ast_device_state_message_type);
203
204 /* Forward declarations */
205 static int getproviderstate(const char *provider, const char *address);
206
207 /*! \brief Find devicestate as text message for output */
208 const char *ast_devstate2str(enum ast_device_state devstate)
209 {
210         return devstatestring[devstate][0];
211 }
212
213 /* Deprecated interface (not prefixed with ast_) */
214 const char *devstate2str(enum ast_device_state devstate)
215 {
216         return devstatestring[devstate][0];
217 }
218
219 enum ast_device_state ast_state_chan2dev(enum ast_channel_state chanstate)
220 {
221         int i;
222         chanstate &= 0xFFFF;
223         for (i = 0; chan2dev[i].chan != -100; i++) {
224                 if (chan2dev[i].chan == chanstate) {
225                         return chan2dev[i].dev;
226                 }
227         }
228         return AST_DEVICE_UNKNOWN;
229 }
230
231 /* Parseable */
232 const char *ast_devstate_str(enum ast_device_state state)
233 {
234         return devstatestring[state][1];
235 }
236
237 enum ast_device_state ast_devstate_val(const char *val)
238 {
239         if (!strcasecmp(val, "NOT_INUSE"))
240                 return AST_DEVICE_NOT_INUSE;
241         else if (!strcasecmp(val, "INUSE"))
242                 return AST_DEVICE_INUSE;
243         else if (!strcasecmp(val, "BUSY"))
244                 return AST_DEVICE_BUSY;
245         else if (!strcasecmp(val, "INVALID"))
246                 return AST_DEVICE_INVALID;
247         else if (!strcasecmp(val, "UNAVAILABLE"))
248                 return AST_DEVICE_UNAVAILABLE;
249         else if (!strcasecmp(val, "RINGING"))
250                 return AST_DEVICE_RINGING;
251         else if (!strcasecmp(val, "RINGINUSE"))
252                 return AST_DEVICE_RINGINUSE;
253         else if (!strcasecmp(val, "ONHOLD"))
254                 return AST_DEVICE_ONHOLD;
255
256         return AST_DEVICE_UNKNOWN;
257 }
258
259 /*! \brief Find out if device is active in a call or not
260         \note find channels with the device's name in it
261         This function is only used for channels that does not implement
262         devicestate natively
263 */
264 enum ast_device_state ast_parse_device_state(const char *device)
265 {
266         struct ast_channel *chan;
267         char match[AST_CHANNEL_NAME];
268         enum ast_device_state res;
269
270         snprintf(match, sizeof(match), "%s-", device);
271
272         if (!(chan = ast_channel_get_by_name_prefix(match, strlen(match)))) {
273                 return AST_DEVICE_UNKNOWN;
274         }
275
276         res = (ast_channel_state(chan) == AST_STATE_RINGING) ? AST_DEVICE_RINGING : AST_DEVICE_INUSE;
277
278         chan = ast_channel_unref(chan);
279
280         return res;
281 }
282
283 static enum ast_device_state devstate_cached(const char *device)
284 {
285         struct stasis_message *cached_msg;
286         struct ast_device_state_message *device_state;
287         enum ast_device_state state;
288
289         cached_msg = stasis_cache_get_by_eid(ast_device_state_cache(),
290                 ast_device_state_message_type(), device, NULL);
291         if (!cached_msg) {
292                 return AST_DEVICE_UNKNOWN;
293         }
294         device_state = stasis_message_data(cached_msg);
295         state = device_state->state;
296         ao2_cleanup(cached_msg);
297
298         return state;
299 }
300
301 /*! \brief Check device state through channel specific function or generic function */
302 static enum ast_device_state _ast_device_state(const char *device, int check_cache)
303 {
304         char *number;
305         const struct ast_channel_tech *chan_tech;
306         enum ast_device_state res;
307         /*! \brief Channel driver that provides device state */
308         char *tech;
309
310         /* If the last known state is cached, just return that */
311         if (check_cache) {
312                 res = devstate_cached(device);
313                 if (res != AST_DEVICE_UNKNOWN) {
314                         return res;
315                 }
316         }
317
318         number = ast_strdupa(device);
319         tech = strsep(&number, "/");
320         if (!number) {
321                 /*! \brief Another provider of device state */
322                 char *provider;
323
324                 provider = strsep(&tech, ":");
325                 if (!tech) {
326                         return AST_DEVICE_INVALID;
327                 }
328                 /* We have a provider */
329                 number = tech;
330
331                 ast_debug(3, "Checking if I can find provider for \"%s\" - number: %s\n", provider, number);
332                 return getproviderstate(provider, number);
333         }
334
335         ast_debug(4, "No provider found, checking channel drivers for %s - %s\n", tech, number);
336
337         chan_tech = ast_get_channel_tech(tech);
338         if (!chan_tech) {
339                 return AST_DEVICE_INVALID;
340         }
341
342         /* Does the channel driver support device state notification? */
343         if (!chan_tech->devicestate) {
344                 /* No, try the generic function */
345                 return ast_parse_device_state(device);
346         }
347
348         res = chan_tech->devicestate(number);
349         if (res == AST_DEVICE_UNKNOWN) {
350                 res = ast_parse_device_state(device);
351         }
352
353         return res;
354 }
355
356 enum ast_device_state ast_device_state(const char *device)
357 {
358         /* This function is called from elsewhere in the code to find out the
359          * current state of a device.  Check the cache, first. */
360
361         return _ast_device_state(device, 1);
362 }
363
364 /*! \brief Add device state provider */
365 int ast_devstate_prov_add(const char *label, ast_devstate_prov_cb_type callback)
366 {
367         struct devstate_prov *devprov;
368
369         if (!callback || !(devprov = ast_calloc(1, sizeof(*devprov))))
370                 return -1;
371
372         devprov->callback = callback;
373         ast_copy_string(devprov->label, label, sizeof(devprov->label));
374
375         AST_RWLIST_WRLOCK(&devstate_provs);
376         AST_RWLIST_INSERT_HEAD(&devstate_provs, devprov, list);
377         AST_RWLIST_UNLOCK(&devstate_provs);
378
379         return 0;
380 }
381
382 /*! \brief Remove device state provider */
383 int ast_devstate_prov_del(const char *label)
384 {
385         struct devstate_prov *devcb;
386         int res = -1;
387
388         AST_RWLIST_WRLOCK(&devstate_provs);
389         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&devstate_provs, devcb, list) {
390                 if (!strcasecmp(devcb->label, label)) {
391                         AST_RWLIST_REMOVE_CURRENT(list);
392                         ast_free(devcb);
393                         res = 0;
394                         break;
395                 }
396         }
397         AST_RWLIST_TRAVERSE_SAFE_END;
398         AST_RWLIST_UNLOCK(&devstate_provs);
399
400         return res;
401 }
402
403 /*! \brief Get provider device state */
404 static int getproviderstate(const char *provider, const char *address)
405 {
406         struct devstate_prov *devprov;
407         int res = AST_DEVICE_INVALID;
408
409         AST_RWLIST_RDLOCK(&devstate_provs);
410         AST_RWLIST_TRAVERSE(&devstate_provs, devprov, list) {
411                 ast_debug(5, "Checking provider %s with %s\n", devprov->label, provider);
412
413                 if (!strcasecmp(devprov->label, provider)) {
414                         res = devprov->callback(address);
415                         break;
416                 }
417         }
418         AST_RWLIST_UNLOCK(&devstate_provs);
419
420         return res;
421 }
422
423 /*! Called by the state change thread to find out what the state is, and then
424  *  to queue up the state change event */
425 static void do_state_change(const char *device, enum ast_devstate_cache cachable)
426 {
427         enum ast_device_state state;
428
429         state = _ast_device_state(device, 0);
430
431         ast_debug(3, "Changing state for %s - state %d (%s)\n", device, state, ast_devstate2str(state));
432
433         ast_publish_device_state(device, state, cachable);
434 }
435
436 int ast_devstate_changed_literal(enum ast_device_state state, enum ast_devstate_cache cachable, const char *device)
437 {
438         struct state_change *change;
439
440         /*
441          * If we know the state change (how nice of the caller of this function!)
442          * then we can just generate a device state event.
443          *
444          * Otherwise, we do the following:
445          *   - Queue an event up to another thread that the state has changed
446          *   - In the processing thread, it calls the callback provided by the
447          *     device state provider (which may or may not be a channel driver)
448          *     to determine the state.
449          *   - If the device state provider does not know the state, or this is
450          *     for a channel and the channel driver does not implement a device
451          *     state callback, then we will look through the channel list to
452          *     see if we can determine a state based on active calls.
453          *   - Once a state has been determined, a device state event is generated.
454          */
455
456         if (state != AST_DEVICE_UNKNOWN) {
457                 ast_publish_device_state(device, state, cachable);
458         } else if (change_thread == AST_PTHREADT_NULL || !(change = ast_calloc(1, sizeof(*change) + strlen(device)))) {
459                 /* we could not allocate a change struct, or */
460                 /* there is no background thread, so process the change now */
461                 do_state_change(device, cachable);
462         } else {
463                 /* queue the change */
464                 strcpy(change->device, device);
465                 change->cachable = cachable;
466                 AST_LIST_LOCK(&state_changes);
467                 AST_LIST_INSERT_TAIL(&state_changes, change, list);
468                 ast_cond_signal(&change_pending);
469                 AST_LIST_UNLOCK(&state_changes);
470         }
471
472         return 0;
473 }
474
475 int ast_device_state_changed_literal(const char *dev)
476 {
477         return ast_devstate_changed_literal(AST_DEVICE_UNKNOWN, AST_DEVSTATE_CACHABLE, dev);
478 }
479
480 int ast_devstate_changed(enum ast_device_state state, enum ast_devstate_cache cachable, const char *fmt, ...)
481 {
482         char buf[AST_MAX_EXTENSION];
483         va_list ap;
484
485         va_start(ap, fmt);
486         vsnprintf(buf, sizeof(buf), fmt, ap);
487         va_end(ap);
488
489         return ast_devstate_changed_literal(state, cachable, buf);
490 }
491
492 int ast_device_state_changed(const char *fmt, ...)
493 {
494         char buf[AST_MAX_EXTENSION];
495         va_list ap;
496
497         va_start(ap, fmt);
498         vsnprintf(buf, sizeof(buf), fmt, ap);
499         va_end(ap);
500
501         return ast_devstate_changed_literal(AST_DEVICE_UNKNOWN, AST_DEVSTATE_CACHABLE, buf);
502 }
503
504 /*! \brief Go through the dev state change queue and update changes in the dev state thread */
505 static void *do_devstate_changes(void *data)
506 {
507         struct state_change *next, *current;
508
509         for (;;) {
510                 /* This basically pops off any state change entries, resets the list back to NULL, unlocks, and processes each state change */
511                 AST_LIST_LOCK(&state_changes);
512                 if (AST_LIST_EMPTY(&state_changes))
513                         ast_cond_wait(&change_pending, &state_changes.lock);
514                 next = AST_LIST_FIRST(&state_changes);
515                 AST_LIST_HEAD_INIT_NOLOCK(&state_changes);
516                 AST_LIST_UNLOCK(&state_changes);
517
518                 /* Process each state change */
519                 while ((current = next)) {
520                         next = AST_LIST_NEXT(current, list);
521                         do_state_change(current->device, current->cachable);
522                         ast_free(current);
523                 }
524         }
525
526         return NULL;
527 }
528
529 static struct ast_device_state_message *device_state_alloc(const char *device, enum ast_device_state state, enum ast_devstate_cache cachable, const struct ast_eid *eid)
530 {
531         struct ast_device_state_message *new_device_state;
532         char *pos;
533         size_t stuff_len;
534
535         ast_assert(!ast_strlen_zero(device));
536
537         stuff_len = strlen(device) + 1;
538         if (eid) {
539                 stuff_len += sizeof(*eid);
540         }
541         new_device_state = ao2_alloc_options(sizeof(*new_device_state) + stuff_len, NULL,
542                 AO2_ALLOC_OPT_LOCK_NOLOCK);
543         if (!new_device_state) {
544                 return NULL;
545         }
546
547         if (eid) {
548                 /* non-aggregate device state. */
549                 new_device_state->stuff[0] = *eid;
550                 new_device_state->eid = &new_device_state->stuff[0];
551                 pos = (char *) &new_device_state->stuff[1];
552         } else {
553                 pos = (char *) &new_device_state->stuff[0];
554         }
555
556         strcpy(pos, device);/* Safe */
557         new_device_state->device = pos;
558
559         new_device_state->state = state;
560         new_device_state->cachable = cachable;
561
562         return new_device_state;
563 }
564
565 static void devstate_change_cb(void *data, struct stasis_subscription *sub, struct stasis_message *msg)
566 {
567         struct ast_device_state_message *device_state;
568
569         if (ast_device_state_message_type() != stasis_message_type(msg)) {
570                 return;
571         }
572
573         device_state = stasis_message_data(msg);
574         if (device_state->cachable == AST_DEVSTATE_CACHABLE || !device_state->eid) {
575                 /* Ignore cacheable and aggregate messages. */
576                 return;
577         }
578
579         /*
580          * Non-cacheable device state aggregates are just the
581          * device state republished as the aggregate.
582          */
583         ast_publish_device_state_full(device_state->device, device_state->state,
584                 device_state->cachable, NULL);
585 }
586
587 /*! \brief Initialize the device state engine in separate thread */
588 int ast_device_state_engine_init(void)
589 {
590         ast_cond_init(&change_pending, NULL);
591         if (ast_pthread_create_background(&change_thread, NULL, do_devstate_changes, NULL) < 0) {
592                 ast_log(LOG_ERROR, "Unable to start device state change thread.\n");
593                 return -1;
594         }
595
596         return 0;
597 }
598
599 void ast_devstate_aggregate_init(struct ast_devstate_aggregate *agg)
600 {
601         memset(agg, 0, sizeof(*agg));
602         agg->state = AST_DEVICE_INVALID;
603 }
604
605 void ast_devstate_aggregate_add(struct ast_devstate_aggregate *agg, enum ast_device_state state)
606 {
607         static enum ast_device_state state_order[] = {
608                 1, /* AST_DEVICE_UNKNOWN */
609                 3, /* AST_DEVICE_NOT_INUSE */
610                 6, /* AST_DEVICE_INUSE */
611                 7, /* AST_DEVICE_BUSY */
612                 0, /* AST_DEVICE_INVALID */
613                 2, /* AST_DEVICE_UNAVAILABLE */
614                 5, /* AST_DEVICE_RINGING */
615                 8, /* AST_DEVICE_RINGINUSE */
616                 4, /* AST_DEVICE_ONHOLD */
617         };
618
619         if (state == AST_DEVICE_RINGING) {
620                 agg->ringing = 1;
621         } else if (state == AST_DEVICE_INUSE || state == AST_DEVICE_ONHOLD || state == AST_DEVICE_BUSY) {
622                 agg->inuse = 1;
623         }
624
625         if (agg->ringing && agg->inuse) {
626                 agg->state = AST_DEVICE_RINGINUSE;
627         } else if (state_order[state] > state_order[agg->state]) {
628                 agg->state = state;
629         }
630 }
631
632 enum ast_device_state ast_devstate_aggregate_result(struct ast_devstate_aggregate *agg)
633 {
634         return agg->state;
635 }
636
637 struct stasis_topic *ast_device_state_topic_all(void)
638 {
639         return device_state_topic_all;
640 }
641
642 struct stasis_cache *ast_device_state_cache(void)
643 {
644         return device_state_cache;
645 }
646
647 struct stasis_topic *ast_device_state_topic_cached(void)
648 {
649         return stasis_caching_get_topic(device_state_topic_cached);
650 }
651
652 struct stasis_topic *ast_device_state_topic(const char *device)
653 {
654         return stasis_topic_pool_get_topic(device_state_topic_pool, device);
655 }
656
657 int ast_device_state_clear_cache(const char *device)
658 {
659         struct stasis_message *cached_msg;
660         struct stasis_message *msg;
661
662         cached_msg = stasis_cache_get_by_eid(ast_device_state_cache(),
663                 ast_device_state_message_type(), device, &ast_eid_default);
664         if (!cached_msg) {
665                 /* nothing to clear */
666                 return -1;
667         }
668
669         msg = stasis_cache_clear_create(cached_msg);
670         if (msg) {
671                 stasis_publish(ast_device_state_topic(device), msg);
672         }
673         ao2_cleanup(msg);
674         ao2_cleanup(cached_msg);
675         return 0;
676 }
677
678 int ast_publish_device_state_full(
679         const char *device,
680         enum ast_device_state state,
681         enum ast_devstate_cache cachable,
682         struct ast_eid *eid)
683 {
684         RAII_VAR(struct ast_device_state_message *, device_state, NULL, ao2_cleanup);
685         RAII_VAR(struct stasis_message *, message, NULL, ao2_cleanup);
686         struct stasis_topic *device_specific_topic;
687
688         ast_assert(!ast_strlen_zero(device));
689
690         device_state = device_state_alloc(device, state, cachable, eid);
691         if (!device_state) {
692                 return -1;
693         }
694
695         message = stasis_message_create_full(ast_device_state_message_type(), device_state,
696                 eid);
697         if (!message) {
698                 return -1;
699         }
700
701         device_specific_topic = ast_device_state_topic(device);
702         if (!device_specific_topic) {
703                 return -1;
704         }
705
706         stasis_publish(device_specific_topic, message);
707         return 0;
708 }
709
710 static const char *device_state_get_id(struct stasis_message *message)
711 {
712         struct ast_device_state_message *device_state;
713
714         if (ast_device_state_message_type() != stasis_message_type(message)) {
715                 return NULL;
716         }
717
718         device_state = stasis_message_data(message);
719         if (device_state->cachable == AST_DEVSTATE_NOT_CACHABLE) {
720                 return NULL;
721         }
722
723         return device_state->device;
724 }
725
726 /*!
727  * \internal
728  * \brief Callback to publish the aggregate device state cache entry message.
729  * \since 12.2.0
730  *
731  * \param cache_topic Caching topic the aggregate message may be published over.
732  * \param aggregate The aggregate shapshot message to publish.
733  *
734  * \return Nothing
735  */
736 static void device_state_aggregate_publish(struct stasis_topic *cache_topic, struct stasis_message *aggregate)
737 {
738         const char *device;
739         struct stasis_topic *device_specific_topic;
740
741         device = device_state_get_id(aggregate);
742         if (!device) {
743                 return;
744         }
745         device_specific_topic = ast_device_state_topic(device);
746         if (!device_specific_topic) {
747                 return;
748         }
749
750         stasis_publish(device_specific_topic, aggregate);
751 }
752
753 /*!
754  * \internal
755  * \brief Callback to calculate the aggregate device state cache entry.
756  * \since 12.2.0
757  *
758  * \param entry Cache entry to calculate a new aggregate snapshot.
759  * \param new_snapshot The shapshot that is being updated.
760  *
761  * \note Return a ref bumped pointer from stasis_cache_entry_get_aggregate()
762  * if a new aggregate could not be calculated because of error.
763  *
764  * \return New aggregate-snapshot calculated on success.
765  * Caller has a reference on return.
766  */
767 static struct stasis_message *device_state_aggregate_calc(struct stasis_cache_entry *entry, struct stasis_message *new_snapshot)
768 {
769         struct stasis_message *aggregate_snapshot;
770         struct stasis_message *snapshot;
771         struct ast_device_state_message *device_state;
772         const char *device = NULL;
773         struct ast_devstate_aggregate aggregate;
774         int idx;
775
776         /* Determine the new aggregate device state. */
777         ast_devstate_aggregate_init(&aggregate);
778         snapshot = stasis_cache_entry_get_local(entry);
779         if (snapshot) {
780                 device_state = stasis_message_data(snapshot);
781                 device = device_state->device;
782                 ast_devstate_aggregate_add(&aggregate, device_state->state);
783         }
784         for (idx = 0; ; ++idx) {
785                 snapshot = stasis_cache_entry_get_remote(entry, idx);
786                 if (!snapshot) {
787                         break;
788                 }
789
790                 device_state = stasis_message_data(snapshot);
791                 device = device_state->device;
792                 ast_devstate_aggregate_add(&aggregate, device_state->state);
793         }
794
795         if (!device) {
796                 /* There are no device states cached.  Delete the aggregate. */
797                 return NULL;
798         }
799
800         snapshot = stasis_cache_entry_get_aggregate(entry);
801         if (snapshot) {
802                 device_state = stasis_message_data(snapshot);
803                 if (device_state->state == ast_devstate_aggregate_result(&aggregate)) {
804                         /* Aggregate device state did not change. */
805                         return ao2_bump(snapshot);
806                 }
807         }
808
809         device_state = device_state_alloc(device, ast_devstate_aggregate_result(&aggregate),
810                 AST_DEVSTATE_CACHABLE, NULL);
811         if (!device_state) {
812                 /* Bummer.  We have to keep the old aggregate snapshot. */
813                 return ao2_bump(snapshot);
814         }
815         aggregate_snapshot = stasis_message_create_full(ast_device_state_message_type(),
816                 device_state, NULL);
817         ao2_cleanup(device_state);
818         if (!aggregate_snapshot) {
819                 /* Bummer.  We have to keep the old aggregate snapshot. */
820                 return ao2_bump(snapshot);
821         }
822
823         return aggregate_snapshot;
824 }
825
826 static void devstate_cleanup(void)
827 {
828         devstate_message_sub = stasis_unsubscribe_and_join(devstate_message_sub);
829         device_state_topic_cached = stasis_caching_unsubscribe_and_join(device_state_topic_cached);
830
831         ao2_cleanup(device_state_cache);
832         device_state_cache = NULL;
833
834         ao2_cleanup(device_state_topic_pool);
835         device_state_topic_pool = NULL;
836
837         ao2_cleanup(device_state_topic_all);
838         device_state_topic_all = NULL;
839
840         STASIS_MESSAGE_TYPE_CLEANUP(ast_device_state_message_type);
841 }
842
843 int devstate_init(void)
844 {
845         ast_register_cleanup(devstate_cleanup);
846
847         if (STASIS_MESSAGE_TYPE_INIT(ast_device_state_message_type) != 0) {
848                 return -1;
849         }
850         device_state_topic_all = stasis_topic_create("ast_device_state_topic");
851         if (!device_state_topic_all) {
852                 devstate_cleanup();
853                 return -1;
854         }
855         device_state_topic_pool = stasis_topic_pool_create(ast_device_state_topic_all());
856         if (!device_state_topic_pool) {
857                 devstate_cleanup();
858                 return -1;
859         }
860         device_state_cache = stasis_cache_create_full(device_state_get_id,
861                 device_state_aggregate_calc, device_state_aggregate_publish);
862         if (!device_state_cache) {
863                 devstate_cleanup();
864                 return -1;
865         }
866         device_state_topic_cached = stasis_caching_topic_create(ast_device_state_topic_all(),
867                 device_state_cache);
868         if (!device_state_topic_cached) {
869                 devstate_cleanup();
870                 return -1;
871         }
872
873         devstate_message_sub = stasis_subscribe(ast_device_state_topic_all(),
874                 devstate_change_cb, NULL);
875         if (!devstate_message_sub) {
876                 ast_log(LOG_ERROR, "Failed to create subscription creating uncached device state aggregate events.\n");
877                 devstate_cleanup();
878                 return -1;
879         }
880
881         return 0;
882 }