7f9136da39a63ca4d0cc1e48e5ce1131a4fc9791
[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 /*** DOCUMENTATION
121         <managerEvent language="en_US" name="DeviceStateChange">
122                 <managerEventInstance class="EVENT_FLAG_CALL">
123                         <synopsis>Raised when a device state changes</synopsis>
124                         <syntax>
125                                 <parameter name="Device">
126                                         <para>The device whose state has changed</para>
127                                 </parameter>
128                                 <parameter name="State">
129                                         <para>The new state of the device</para>
130                                 </parameter>
131                         </syntax>
132                         <description>
133                                 <para>This differs from the <literal>ExtensionStatus</literal>
134                                 event because this event is raised for all device state changes,
135                                 not only for changes that affect dialplan hints.</para>
136                         </description>
137                         <see-also>
138                                 <ref type="managerEvent">ExtensionStatus</ref>
139                         </see-also>
140                 </managerEventInstance>
141         </managerEvent>
142 ***/
143
144 #include "asterisk.h"
145
146 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
147
148 #include "asterisk/_private.h"
149 #include "asterisk/channel.h"
150 #include "asterisk/utils.h"
151 #include "asterisk/lock.h"
152 #include "asterisk/linkedlists.h"
153 #include "asterisk/devicestate.h"
154 #include "asterisk/pbx.h"
155 #include "asterisk/app.h"
156 #include "asterisk/astobj2.h"
157 #include "asterisk/stasis.h"
158 #include "asterisk/devicestate.h"
159
160 #define DEVSTATE_TOPIC_BUCKETS 57
161
162 /*! \brief Device state strings for printing */
163 static const char * const devstatestring[][2] = {
164         { /* 0 AST_DEVICE_UNKNOWN */     "Unknown",     "UNKNOWN"     }, /*!< Valid, but unknown state */
165         { /* 1 AST_DEVICE_NOT_INUSE */   "Not in use",  "NOT_INUSE"   }, /*!< Not used */
166         { /* 2 AST_DEVICE IN USE */      "In use",      "INUSE"       }, /*!< In use */
167         { /* 3 AST_DEVICE_BUSY */        "Busy",        "BUSY"        }, /*!< Busy */
168         { /* 4 AST_DEVICE_INVALID */     "Invalid",     "INVALID"     }, /*!< Invalid - not known to Asterisk */
169         { /* 5 AST_DEVICE_UNAVAILABLE */ "Unavailable", "UNAVAILABLE" }, /*!< Unavailable (not registered) */
170         { /* 6 AST_DEVICE_RINGING */     "Ringing",     "RINGING"     }, /*!< Ring, ring, ring */
171         { /* 7 AST_DEVICE_RINGINUSE */   "Ring+Inuse",  "RINGINUSE"   }, /*!< Ring and in use */
172         { /* 8 AST_DEVICE_ONHOLD */      "On Hold",      "ONHOLD"      }, /*!< On Hold */
173 };
174
175 /*!\brief Mapping for channel states to device states */
176 static const struct chan2dev {
177         enum ast_channel_state chan;
178         enum ast_device_state dev;
179 } chan2dev[] = {
180         { AST_STATE_DOWN,            AST_DEVICE_NOT_INUSE },
181         { AST_STATE_RESERVED,        AST_DEVICE_INUSE },
182         { AST_STATE_OFFHOOK,         AST_DEVICE_INUSE },
183         { AST_STATE_DIALING,         AST_DEVICE_INUSE },
184         { AST_STATE_RING,            AST_DEVICE_INUSE },
185         { AST_STATE_RINGING,         AST_DEVICE_RINGING },
186         { AST_STATE_UP,              AST_DEVICE_INUSE },
187         { AST_STATE_BUSY,            AST_DEVICE_BUSY },
188         { AST_STATE_DIALING_OFFHOOK, AST_DEVICE_INUSE },
189         { AST_STATE_PRERING,         AST_DEVICE_RINGING },
190         { -100,                      -100 },
191 };
192
193 /*! \brief  A device state provider (not a channel) */
194 struct devstate_prov {
195         char label[40];
196         ast_devstate_prov_cb_type callback;
197         AST_RWLIST_ENTRY(devstate_prov) list;
198 };
199
200 /*! \brief A list of providers */
201 static AST_RWLIST_HEAD_STATIC(devstate_provs, devstate_prov);
202
203 struct state_change {
204         AST_LIST_ENTRY(state_change) list;
205         enum ast_devstate_cache cachable;
206         char device[1];
207 };
208
209 /*! \brief The state change queue. State changes are queued
210         for processing by a separate thread */
211 static AST_LIST_HEAD_STATIC(state_changes, state_change);
212
213 /*! \brief The device state change notification thread */
214 static pthread_t change_thread = AST_PTHREADT_NULL;
215
216 /*! \brief Flag for the queue */
217 static ast_cond_t change_pending;
218
219 struct stasis_subscription *devstate_message_sub;
220
221 static struct stasis_topic *device_state_topic_all;
222 static struct stasis_cache *device_state_cache;
223 static struct stasis_caching_topic *device_state_topic_cached;
224 static struct stasis_topic_pool *device_state_topic_pool;
225
226 static struct ast_manager_event_blob *devstate_to_ami(struct stasis_message *msg);
227 static struct ast_event *devstate_to_event(struct stasis_message *msg);
228
229
230 STASIS_MESSAGE_TYPE_DEFN(ast_device_state_message_type,
231         .to_ami = devstate_to_ami,
232         .to_event = devstate_to_event,
233 );
234
235 /* Forward declarations */
236 static int getproviderstate(const char *provider, const char *address);
237
238 /*! \brief Find devicestate as text message for output */
239 const char *ast_devstate2str(enum ast_device_state devstate)
240 {
241         return devstatestring[devstate][0];
242 }
243
244 /* Deprecated interface (not prefixed with ast_) */
245 const char *devstate2str(enum ast_device_state devstate)
246 {
247         return devstatestring[devstate][0];
248 }
249
250 enum ast_device_state ast_state_chan2dev(enum ast_channel_state chanstate)
251 {
252         int i;
253         chanstate &= 0xFFFF;
254         for (i = 0; chan2dev[i].chan != -100; i++) {
255                 if (chan2dev[i].chan == chanstate) {
256                         return chan2dev[i].dev;
257                 }
258         }
259         return AST_DEVICE_UNKNOWN;
260 }
261
262 /* Parseable */
263 const char *ast_devstate_str(enum ast_device_state state)
264 {
265         return devstatestring[state][1];
266 }
267
268 enum ast_device_state ast_devstate_val(const char *val)
269 {
270         if (!strcasecmp(val, "NOT_INUSE"))
271                 return AST_DEVICE_NOT_INUSE;
272         else if (!strcasecmp(val, "INUSE"))
273                 return AST_DEVICE_INUSE;
274         else if (!strcasecmp(val, "BUSY"))
275                 return AST_DEVICE_BUSY;
276         else if (!strcasecmp(val, "INVALID"))
277                 return AST_DEVICE_INVALID;
278         else if (!strcasecmp(val, "UNAVAILABLE"))
279                 return AST_DEVICE_UNAVAILABLE;
280         else if (!strcasecmp(val, "RINGING"))
281                 return AST_DEVICE_RINGING;
282         else if (!strcasecmp(val, "RINGINUSE"))
283                 return AST_DEVICE_RINGINUSE;
284         else if (!strcasecmp(val, "ONHOLD"))
285                 return AST_DEVICE_ONHOLD;
286
287         return AST_DEVICE_UNKNOWN;
288 }
289
290 /*! \brief Find out if device is active in a call or not
291         \note find channels with the device's name in it
292         This function is only used for channels that does not implement
293         devicestate natively
294 */
295 enum ast_device_state ast_parse_device_state(const char *device)
296 {
297         struct ast_channel *chan;
298         char match[AST_CHANNEL_NAME];
299         enum ast_device_state res;
300
301         snprintf(match, sizeof(match), "%s-", device);
302
303         if (!(chan = ast_channel_get_by_name_prefix(match, strlen(match)))) {
304                 return AST_DEVICE_UNKNOWN;
305         }
306
307         if (ast_channel_hold_state(chan) == AST_CONTROL_HOLD) {
308                 res = AST_DEVICE_ONHOLD;
309         } else {
310                 res = ast_state_chan2dev(ast_channel_state(chan));
311         }
312         ast_channel_unref(chan);
313
314         return res;
315 }
316
317 static enum ast_device_state devstate_cached(const char *device)
318 {
319         struct stasis_message *cached_msg;
320         struct ast_device_state_message *device_state;
321         enum ast_device_state state;
322
323         cached_msg = stasis_cache_get_by_eid(ast_device_state_cache(),
324                 ast_device_state_message_type(), device, NULL);
325         if (!cached_msg) {
326                 return AST_DEVICE_UNKNOWN;
327         }
328         device_state = stasis_message_data(cached_msg);
329         state = device_state->state;
330         ao2_cleanup(cached_msg);
331
332         return state;
333 }
334
335 /*! \brief Check device state through channel specific function or generic function */
336 static enum ast_device_state _ast_device_state(const char *device, int check_cache)
337 {
338         char *number;
339         const struct ast_channel_tech *chan_tech;
340         enum ast_device_state res;
341         /*! \brief Channel driver that provides device state */
342         char *tech;
343
344         /* If the last known state is cached, just return that */
345         if (check_cache) {
346                 res = devstate_cached(device);
347                 if (res != AST_DEVICE_UNKNOWN) {
348                         return res;
349                 }
350         }
351
352         number = ast_strdupa(device);
353         tech = strsep(&number, "/");
354         if (!number) {
355                 /*! \brief Another provider of device state */
356                 char *provider;
357
358                 provider = strsep(&tech, ":");
359                 if (!tech) {
360                         return AST_DEVICE_INVALID;
361                 }
362                 /* We have a provider */
363                 number = tech;
364
365                 ast_debug(3, "Checking if I can find provider for \"%s\" - number: %s\n", provider, number);
366                 return getproviderstate(provider, number);
367         }
368
369         ast_debug(4, "No provider found, checking channel drivers for %s - %s\n", tech, number);
370
371         chan_tech = ast_get_channel_tech(tech);
372         if (!chan_tech) {
373                 return AST_DEVICE_INVALID;
374         }
375
376         /* Does the channel driver support device state notification? */
377         if (!chan_tech->devicestate) {
378                 /* No, try the generic function */
379                 return ast_parse_device_state(device);
380         }
381
382         res = chan_tech->devicestate(number);
383         if (res == AST_DEVICE_UNKNOWN) {
384                 res = ast_parse_device_state(device);
385         }
386
387         return res;
388 }
389
390 enum ast_device_state ast_device_state(const char *device)
391 {
392         /* This function is called from elsewhere in the code to find out the
393          * current state of a device.  Check the cache, first. */
394
395         return _ast_device_state(device, 1);
396 }
397
398 /*! \brief Add device state provider */
399 int ast_devstate_prov_add(const char *label, ast_devstate_prov_cb_type callback)
400 {
401         struct devstate_prov *devprov;
402
403         if (!callback || !(devprov = ast_calloc(1, sizeof(*devprov))))
404                 return -1;
405
406         devprov->callback = callback;
407         ast_copy_string(devprov->label, label, sizeof(devprov->label));
408
409         AST_RWLIST_WRLOCK(&devstate_provs);
410         AST_RWLIST_INSERT_HEAD(&devstate_provs, devprov, list);
411         AST_RWLIST_UNLOCK(&devstate_provs);
412
413         return 0;
414 }
415
416 /*! \brief Remove device state provider */
417 int ast_devstate_prov_del(const char *label)
418 {
419         struct devstate_prov *devcb;
420         int res = -1;
421
422         AST_RWLIST_WRLOCK(&devstate_provs);
423         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&devstate_provs, devcb, list) {
424                 if (!strcasecmp(devcb->label, label)) {
425                         AST_RWLIST_REMOVE_CURRENT(list);
426                         ast_free(devcb);
427                         res = 0;
428                         break;
429                 }
430         }
431         AST_RWLIST_TRAVERSE_SAFE_END;
432         AST_RWLIST_UNLOCK(&devstate_provs);
433
434         return res;
435 }
436
437 /*! \brief Get provider device state */
438 static int getproviderstate(const char *provider, const char *address)
439 {
440         struct devstate_prov *devprov;
441         int res = AST_DEVICE_INVALID;
442
443         AST_RWLIST_RDLOCK(&devstate_provs);
444         AST_RWLIST_TRAVERSE(&devstate_provs, devprov, list) {
445                 ast_debug(5, "Checking provider %s with %s\n", devprov->label, provider);
446
447                 if (!strcasecmp(devprov->label, provider)) {
448                         res = devprov->callback(address);
449                         break;
450                 }
451         }
452         AST_RWLIST_UNLOCK(&devstate_provs);
453
454         return res;
455 }
456
457 /*! Called by the state change thread to find out what the state is, and then
458  *  to queue up the state change event */
459 static void do_state_change(const char *device, enum ast_devstate_cache cachable)
460 {
461         enum ast_device_state state;
462
463         state = _ast_device_state(device, 0);
464
465         ast_debug(3, "Changing state for %s - state %u (%s)\n", device, state, ast_devstate2str(state));
466
467         ast_publish_device_state(device, state, cachable);
468 }
469
470 int ast_devstate_changed_literal(enum ast_device_state state, enum ast_devstate_cache cachable, const char *device)
471 {
472         struct state_change *change;
473
474         /*
475          * If we know the state change (how nice of the caller of this function!)
476          * then we can just generate a device state event.
477          *
478          * Otherwise, we do the following:
479          *   - Queue an event up to another thread that the state has changed
480          *   - In the processing thread, it calls the callback provided by the
481          *     device state provider (which may or may not be a channel driver)
482          *     to determine the state.
483          *   - If the device state provider does not know the state, or this is
484          *     for a channel and the channel driver does not implement a device
485          *     state callback, then we will look through the channel list to
486          *     see if we can determine a state based on active calls.
487          *   - Once a state has been determined, a device state event is generated.
488          */
489
490         if (state != AST_DEVICE_UNKNOWN) {
491                 ast_publish_device_state(device, state, cachable);
492         } else if (change_thread == AST_PTHREADT_NULL || !(change = ast_calloc(1, sizeof(*change) + strlen(device)))) {
493                 /* we could not allocate a change struct, or */
494                 /* there is no background thread, so process the change now */
495                 do_state_change(device, cachable);
496         } else {
497                 /* queue the change */
498                 strcpy(change->device, device);
499                 change->cachable = cachable;
500                 AST_LIST_LOCK(&state_changes);
501                 AST_LIST_INSERT_TAIL(&state_changes, change, list);
502                 ast_cond_signal(&change_pending);
503                 AST_LIST_UNLOCK(&state_changes);
504         }
505
506         return 0;
507 }
508
509 int ast_device_state_changed_literal(const char *dev)
510 {
511         return ast_devstate_changed_literal(AST_DEVICE_UNKNOWN, AST_DEVSTATE_CACHABLE, dev);
512 }
513
514 int ast_devstate_changed(enum ast_device_state state, enum ast_devstate_cache cachable, const char *fmt, ...)
515 {
516         char buf[AST_MAX_EXTENSION];
517         va_list ap;
518
519         va_start(ap, fmt);
520         vsnprintf(buf, sizeof(buf), fmt, ap);
521         va_end(ap);
522
523         return ast_devstate_changed_literal(state, cachable, buf);
524 }
525
526 int ast_device_state_changed(const char *fmt, ...)
527 {
528         char buf[AST_MAX_EXTENSION];
529         va_list ap;
530
531         va_start(ap, fmt);
532         vsnprintf(buf, sizeof(buf), fmt, ap);
533         va_end(ap);
534
535         return ast_devstate_changed_literal(AST_DEVICE_UNKNOWN, AST_DEVSTATE_CACHABLE, buf);
536 }
537
538 /*! \brief Go through the dev state change queue and update changes in the dev state thread */
539 static void *do_devstate_changes(void *data)
540 {
541         struct state_change *next, *current;
542
543         for (;;) {
544                 /* This basically pops off any state change entries, resets the list back to NULL, unlocks, and processes each state change */
545                 AST_LIST_LOCK(&state_changes);
546                 if (AST_LIST_EMPTY(&state_changes))
547                         ast_cond_wait(&change_pending, &state_changes.lock);
548                 next = AST_LIST_FIRST(&state_changes);
549                 AST_LIST_HEAD_INIT_NOLOCK(&state_changes);
550                 AST_LIST_UNLOCK(&state_changes);
551
552                 /* Process each state change */
553                 while ((current = next)) {
554                         next = AST_LIST_NEXT(current, list);
555                         do_state_change(current->device, current->cachable);
556                         ast_free(current);
557                 }
558         }
559
560         return NULL;
561 }
562
563 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)
564 {
565         struct ast_device_state_message *new_device_state;
566         char *pos;
567         size_t stuff_len;
568
569         ast_assert(!ast_strlen_zero(device));
570
571         stuff_len = strlen(device) + 1;
572         if (eid) {
573                 stuff_len += sizeof(*eid);
574         }
575         new_device_state = ao2_alloc_options(sizeof(*new_device_state) + stuff_len, NULL,
576                 AO2_ALLOC_OPT_LOCK_NOLOCK);
577         if (!new_device_state) {
578                 return NULL;
579         }
580
581         if (eid) {
582                 /* non-aggregate device state. */
583                 new_device_state->stuff[0] = *eid;
584                 new_device_state->eid = &new_device_state->stuff[0];
585                 pos = (char *) &new_device_state->stuff[1];
586         } else {
587                 pos = (char *) &new_device_state->stuff[0];
588         }
589
590         strcpy(pos, device);/* Safe */
591         new_device_state->device = pos;
592
593         new_device_state->state = state;
594         new_device_state->cachable = cachable;
595
596         return new_device_state;
597 }
598
599 static void devstate_change_cb(void *data, struct stasis_subscription *sub, struct stasis_message *msg)
600 {
601         struct ast_device_state_message *device_state;
602
603         if (ast_device_state_message_type() != stasis_message_type(msg)) {
604                 return;
605         }
606
607         device_state = stasis_message_data(msg);
608         if (device_state->cachable == AST_DEVSTATE_CACHABLE || !device_state->eid) {
609                 /* Ignore cacheable and aggregate messages. */
610                 return;
611         }
612
613         /*
614          * Non-cacheable device state aggregates are just the
615          * device state republished as the aggregate.
616          */
617         ast_publish_device_state_full(device_state->device, device_state->state,
618                 device_state->cachable, NULL);
619 }
620
621 /*! \brief Initialize the device state engine in separate thread */
622 int ast_device_state_engine_init(void)
623 {
624         ast_cond_init(&change_pending, NULL);
625         if (ast_pthread_create_background(&change_thread, NULL, do_devstate_changes, NULL) < 0) {
626                 ast_log(LOG_ERROR, "Unable to start device state change thread.\n");
627                 return -1;
628         }
629
630         return 0;
631 }
632
633 void ast_devstate_aggregate_init(struct ast_devstate_aggregate *agg)
634 {
635         memset(agg, 0, sizeof(*agg));
636         agg->state = AST_DEVICE_INVALID;
637 }
638
639 void ast_devstate_aggregate_add(struct ast_devstate_aggregate *agg, enum ast_device_state state)
640 {
641         static enum ast_device_state state_order[] = {
642                 1, /* AST_DEVICE_UNKNOWN */
643                 3, /* AST_DEVICE_NOT_INUSE */
644                 6, /* AST_DEVICE_INUSE */
645                 7, /* AST_DEVICE_BUSY */
646                 0, /* AST_DEVICE_INVALID */
647                 2, /* AST_DEVICE_UNAVAILABLE */
648                 5, /* AST_DEVICE_RINGING */
649                 8, /* AST_DEVICE_RINGINUSE */
650                 4, /* AST_DEVICE_ONHOLD */
651         };
652
653         if (state == AST_DEVICE_RINGING) {
654                 agg->ringing = 1;
655         } else if (state == AST_DEVICE_INUSE || state == AST_DEVICE_ONHOLD || state == AST_DEVICE_BUSY) {
656                 agg->inuse = 1;
657         }
658
659         if (agg->ringing && agg->inuse) {
660                 agg->state = AST_DEVICE_RINGINUSE;
661         } else if (state_order[state] > state_order[agg->state]) {
662                 agg->state = state;
663         }
664 }
665
666 enum ast_device_state ast_devstate_aggregate_result(struct ast_devstate_aggregate *agg)
667 {
668         return agg->state;
669 }
670
671 struct stasis_topic *ast_device_state_topic_all(void)
672 {
673         return device_state_topic_all;
674 }
675
676 struct stasis_cache *ast_device_state_cache(void)
677 {
678         return device_state_cache;
679 }
680
681 struct stasis_topic *ast_device_state_topic_cached(void)
682 {
683         return stasis_caching_get_topic(device_state_topic_cached);
684 }
685
686 struct stasis_topic *ast_device_state_topic(const char *device)
687 {
688         return stasis_topic_pool_get_topic(device_state_topic_pool, device);
689 }
690
691 int ast_device_state_clear_cache(const char *device)
692 {
693         struct stasis_message *cached_msg;
694         struct stasis_message *msg;
695
696         cached_msg = stasis_cache_get_by_eid(ast_device_state_cache(),
697                 ast_device_state_message_type(), device, &ast_eid_default);
698         if (!cached_msg) {
699                 /* nothing to clear */
700                 return -1;
701         }
702
703         msg = stasis_cache_clear_create(cached_msg);
704         if (msg) {
705                 stasis_publish(ast_device_state_topic(device), msg);
706         }
707         ao2_cleanup(msg);
708         ao2_cleanup(cached_msg);
709         return 0;
710 }
711
712 int ast_publish_device_state_full(
713         const char *device,
714         enum ast_device_state state,
715         enum ast_devstate_cache cachable,
716         struct ast_eid *eid)
717 {
718         RAII_VAR(struct ast_device_state_message *, device_state, NULL, ao2_cleanup);
719         RAII_VAR(struct stasis_message *, message, NULL, ao2_cleanup);
720         struct stasis_topic *device_specific_topic;
721
722         ast_assert(!ast_strlen_zero(device));
723
724         if (!ast_device_state_message_type()) {
725                 return -1;
726         }
727
728         device_state = device_state_alloc(device, state, cachable, eid);
729         if (!device_state) {
730                 return -1;
731         }
732
733         message = stasis_message_create_full(ast_device_state_message_type(), device_state,
734                 eid);
735         if (!message) {
736                 return -1;
737         }
738
739         device_specific_topic = ast_device_state_topic(device);
740         if (!device_specific_topic) {
741                 return -1;
742         }
743
744         stasis_publish(device_specific_topic, message);
745         return 0;
746 }
747
748 static const char *device_state_get_id(struct stasis_message *message)
749 {
750         struct ast_device_state_message *device_state;
751
752         if (ast_device_state_message_type() != stasis_message_type(message)) {
753                 return NULL;
754         }
755
756         device_state = stasis_message_data(message);
757         if (device_state->cachable == AST_DEVSTATE_NOT_CACHABLE) {
758                 return NULL;
759         }
760
761         return device_state->device;
762 }
763
764 /*!
765  * \internal
766  * \brief Callback to publish the aggregate device state cache entry message.
767  * \since 12.2.0
768  *
769  * \param cache_topic Caching topic the aggregate message may be published over.
770  * \param aggregate The aggregate shapshot message to publish.
771  *
772  * \return Nothing
773  */
774 static void device_state_aggregate_publish(struct stasis_topic *cache_topic, struct stasis_message *aggregate)
775 {
776         const char *device;
777         struct stasis_topic *device_specific_topic;
778
779         device = device_state_get_id(aggregate);
780         if (!device) {
781                 return;
782         }
783         device_specific_topic = ast_device_state_topic(device);
784         if (!device_specific_topic) {
785                 return;
786         }
787
788         stasis_publish(device_specific_topic, aggregate);
789 }
790
791 /*!
792  * \internal
793  * \brief Callback to calculate the aggregate device state cache entry.
794  * \since 12.2.0
795  *
796  * \param entry Cache entry to calculate a new aggregate snapshot.
797  * \param new_snapshot The shapshot that is being updated.
798  *
799  * \note Return a ref bumped pointer from stasis_cache_entry_get_aggregate()
800  * if a new aggregate could not be calculated because of error.
801  *
802  * \return New aggregate-snapshot calculated on success.
803  * Caller has a reference on return.
804  */
805 static struct stasis_message *device_state_aggregate_calc(struct stasis_cache_entry *entry, struct stasis_message *new_snapshot)
806 {
807         struct stasis_message *aggregate_snapshot;
808         struct stasis_message *snapshot;
809         struct ast_device_state_message *device_state;
810         const char *device = NULL;
811         struct ast_devstate_aggregate aggregate;
812         int idx;
813
814         if (!ast_device_state_message_type()) {
815                 return NULL;
816         }
817
818         /* Determine the new aggregate device state. */
819         ast_devstate_aggregate_init(&aggregate);
820         snapshot = stasis_cache_entry_get_local(entry);
821         if (snapshot) {
822                 device_state = stasis_message_data(snapshot);
823                 device = device_state->device;
824                 ast_devstate_aggregate_add(&aggregate, device_state->state);
825         }
826         for (idx = 0; ; ++idx) {
827                 snapshot = stasis_cache_entry_get_remote(entry, idx);
828                 if (!snapshot) {
829                         break;
830                 }
831
832                 device_state = stasis_message_data(snapshot);
833                 device = device_state->device;
834                 ast_devstate_aggregate_add(&aggregate, device_state->state);
835         }
836
837         if (!device) {
838                 /* There are no device states cached.  Delete the aggregate. */
839                 return NULL;
840         }
841
842         snapshot = stasis_cache_entry_get_aggregate(entry);
843         if (snapshot) {
844                 device_state = stasis_message_data(snapshot);
845                 if (device_state->state == ast_devstate_aggregate_result(&aggregate)) {
846                         /* Aggregate device state did not change. */
847                         return ao2_bump(snapshot);
848                 }
849         }
850
851         device_state = device_state_alloc(device, ast_devstate_aggregate_result(&aggregate),
852                 AST_DEVSTATE_CACHABLE, NULL);
853         if (!device_state) {
854                 /* Bummer.  We have to keep the old aggregate snapshot. */
855                 return ao2_bump(snapshot);
856         }
857         aggregate_snapshot = stasis_message_create_full(ast_device_state_message_type(),
858                 device_state, NULL);
859         ao2_cleanup(device_state);
860         if (!aggregate_snapshot) {
861                 /* Bummer.  We have to keep the old aggregate snapshot. */
862                 return ao2_bump(snapshot);
863         }
864
865         return aggregate_snapshot;
866 }
867
868 static void devstate_cleanup(void)
869 {
870         devstate_message_sub = stasis_unsubscribe_and_join(devstate_message_sub);
871         device_state_topic_cached = stasis_caching_unsubscribe_and_join(device_state_topic_cached);
872
873         ao2_cleanup(device_state_cache);
874         device_state_cache = NULL;
875
876         ao2_cleanup(device_state_topic_pool);
877         device_state_topic_pool = NULL;
878
879         ao2_cleanup(device_state_topic_all);
880         device_state_topic_all = NULL;
881
882         STASIS_MESSAGE_TYPE_CLEANUP(ast_device_state_message_type);
883 }
884
885 int devstate_init(void)
886 {
887         ast_register_cleanup(devstate_cleanup);
888
889         if (STASIS_MESSAGE_TYPE_INIT(ast_device_state_message_type) != 0) {
890                 return -1;
891         }
892         device_state_topic_all = stasis_topic_create("ast_device_state_topic");
893         if (!device_state_topic_all) {
894                 devstate_cleanup();
895                 return -1;
896         }
897         device_state_topic_pool = stasis_topic_pool_create(ast_device_state_topic_all());
898         if (!device_state_topic_pool) {
899                 devstate_cleanup();
900                 return -1;
901         }
902         device_state_cache = stasis_cache_create_full(device_state_get_id,
903                 device_state_aggregate_calc, device_state_aggregate_publish);
904         if (!device_state_cache) {
905                 devstate_cleanup();
906                 return -1;
907         }
908         device_state_topic_cached = stasis_caching_topic_create(ast_device_state_topic_all(),
909                 device_state_cache);
910         if (!device_state_topic_cached) {
911                 devstate_cleanup();
912                 return -1;
913         }
914
915         devstate_message_sub = stasis_subscribe(ast_device_state_topic_all(),
916                 devstate_change_cb, NULL);
917         if (!devstate_message_sub) {
918                 ast_log(LOG_ERROR, "Failed to create subscription creating uncached device state aggregate events.\n");
919                 devstate_cleanup();
920                 return -1;
921         }
922
923         return 0;
924 }
925
926 static struct ast_manager_event_blob *devstate_to_ami(struct stasis_message *msg)
927 {
928         struct ast_device_state_message *dev_state;
929
930         dev_state = stasis_message_data(msg);
931
932         /* Ignore non-aggregate states */
933         if (dev_state->eid) {
934                 return NULL;
935         }
936
937         return ast_manager_event_blob_create(EVENT_FLAG_CALL, "DeviceStateChange",
938                 "Device: %s\r\n"
939                 "State: %s\r\n",
940                 dev_state->device, ast_devstate_str(dev_state->state));
941 }
942
943 /*! \brief Convert a \ref stasis_message to a \ref ast_event */
944 static struct ast_event *devstate_to_event(struct stasis_message *message)
945 {
946         struct ast_event *event;
947         struct ast_device_state_message *device_state;
948
949         if (!message) {
950                 return NULL;
951         }
952
953         device_state = stasis_message_data(message);
954
955         if (device_state->eid) {
956                 event = ast_event_new(AST_EVENT_DEVICE_STATE_CHANGE,
957                                             AST_EVENT_IE_DEVICE, AST_EVENT_IE_PLTYPE_STR, device_state->device,
958                                             AST_EVENT_IE_STATE, AST_EVENT_IE_PLTYPE_UINT, device_state->state,
959                                             AST_EVENT_IE_CACHABLE, AST_EVENT_IE_PLTYPE_UINT, device_state->cachable,
960                                             AST_EVENT_IE_EID, AST_EVENT_IE_PLTYPE_RAW, device_state->eid, sizeof(*device_state->eid),
961                                             AST_EVENT_IE_END);
962         } else {
963                 event = ast_event_new(AST_EVENT_DEVICE_STATE,
964                                             AST_EVENT_IE_DEVICE, AST_EVENT_IE_PLTYPE_STR, device_state->device,
965                                             AST_EVENT_IE_STATE, AST_EVENT_IE_PLTYPE_UINT, device_state->state,
966                                             AST_EVENT_IE_CACHABLE, AST_EVENT_IE_PLTYPE_UINT, device_state->cachable,
967                                             AST_EVENT_IE_END);
968         }
969
970         return event;
971 }