ARI: Add ability to raise arbitrary User Events
[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         res = (ast_channel_state(chan) == AST_STATE_RINGING) ? AST_DEVICE_RINGING : AST_DEVICE_INUSE;
308
309         chan = ast_channel_unref(chan);
310
311         return res;
312 }
313
314 static enum ast_device_state devstate_cached(const char *device)
315 {
316         struct stasis_message *cached_msg;
317         struct ast_device_state_message *device_state;
318         enum ast_device_state state;
319
320         cached_msg = stasis_cache_get_by_eid(ast_device_state_cache(),
321                 ast_device_state_message_type(), device, NULL);
322         if (!cached_msg) {
323                 return AST_DEVICE_UNKNOWN;
324         }
325         device_state = stasis_message_data(cached_msg);
326         state = device_state->state;
327         ao2_cleanup(cached_msg);
328
329         return state;
330 }
331
332 /*! \brief Check device state through channel specific function or generic function */
333 static enum ast_device_state _ast_device_state(const char *device, int check_cache)
334 {
335         char *number;
336         const struct ast_channel_tech *chan_tech;
337         enum ast_device_state res;
338         /*! \brief Channel driver that provides device state */
339         char *tech;
340
341         /* If the last known state is cached, just return that */
342         if (check_cache) {
343                 res = devstate_cached(device);
344                 if (res != AST_DEVICE_UNKNOWN) {
345                         return res;
346                 }
347         }
348
349         number = ast_strdupa(device);
350         tech = strsep(&number, "/");
351         if (!number) {
352                 /*! \brief Another provider of device state */
353                 char *provider;
354
355                 provider = strsep(&tech, ":");
356                 if (!tech) {
357                         return AST_DEVICE_INVALID;
358                 }
359                 /* We have a provider */
360                 number = tech;
361
362                 ast_debug(3, "Checking if I can find provider for \"%s\" - number: %s\n", provider, number);
363                 return getproviderstate(provider, number);
364         }
365
366         ast_debug(4, "No provider found, checking channel drivers for %s - %s\n", tech, number);
367
368         chan_tech = ast_get_channel_tech(tech);
369         if (!chan_tech) {
370                 return AST_DEVICE_INVALID;
371         }
372
373         /* Does the channel driver support device state notification? */
374         if (!chan_tech->devicestate) {
375                 /* No, try the generic function */
376                 return ast_parse_device_state(device);
377         }
378
379         res = chan_tech->devicestate(number);
380         if (res == AST_DEVICE_UNKNOWN) {
381                 res = ast_parse_device_state(device);
382         }
383
384         return res;
385 }
386
387 enum ast_device_state ast_device_state(const char *device)
388 {
389         /* This function is called from elsewhere in the code to find out the
390          * current state of a device.  Check the cache, first. */
391
392         return _ast_device_state(device, 1);
393 }
394
395 /*! \brief Add device state provider */
396 int ast_devstate_prov_add(const char *label, ast_devstate_prov_cb_type callback)
397 {
398         struct devstate_prov *devprov;
399
400         if (!callback || !(devprov = ast_calloc(1, sizeof(*devprov))))
401                 return -1;
402
403         devprov->callback = callback;
404         ast_copy_string(devprov->label, label, sizeof(devprov->label));
405
406         AST_RWLIST_WRLOCK(&devstate_provs);
407         AST_RWLIST_INSERT_HEAD(&devstate_provs, devprov, list);
408         AST_RWLIST_UNLOCK(&devstate_provs);
409
410         return 0;
411 }
412
413 /*! \brief Remove device state provider */
414 int ast_devstate_prov_del(const char *label)
415 {
416         struct devstate_prov *devcb;
417         int res = -1;
418
419         AST_RWLIST_WRLOCK(&devstate_provs);
420         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&devstate_provs, devcb, list) {
421                 if (!strcasecmp(devcb->label, label)) {
422                         AST_RWLIST_REMOVE_CURRENT(list);
423                         ast_free(devcb);
424                         res = 0;
425                         break;
426                 }
427         }
428         AST_RWLIST_TRAVERSE_SAFE_END;
429         AST_RWLIST_UNLOCK(&devstate_provs);
430
431         return res;
432 }
433
434 /*! \brief Get provider device state */
435 static int getproviderstate(const char *provider, const char *address)
436 {
437         struct devstate_prov *devprov;
438         int res = AST_DEVICE_INVALID;
439
440         AST_RWLIST_RDLOCK(&devstate_provs);
441         AST_RWLIST_TRAVERSE(&devstate_provs, devprov, list) {
442                 ast_debug(5, "Checking provider %s with %s\n", devprov->label, provider);
443
444                 if (!strcasecmp(devprov->label, provider)) {
445                         res = devprov->callback(address);
446                         break;
447                 }
448         }
449         AST_RWLIST_UNLOCK(&devstate_provs);
450
451         return res;
452 }
453
454 /*! Called by the state change thread to find out what the state is, and then
455  *  to queue up the state change event */
456 static void do_state_change(const char *device, enum ast_devstate_cache cachable)
457 {
458         enum ast_device_state state;
459
460         state = _ast_device_state(device, 0);
461
462         ast_debug(3, "Changing state for %s - state %u (%s)\n", device, state, ast_devstate2str(state));
463
464         ast_publish_device_state(device, state, cachable);
465 }
466
467 int ast_devstate_changed_literal(enum ast_device_state state, enum ast_devstate_cache cachable, const char *device)
468 {
469         struct state_change *change;
470
471         /*
472          * If we know the state change (how nice of the caller of this function!)
473          * then we can just generate a device state event.
474          *
475          * Otherwise, we do the following:
476          *   - Queue an event up to another thread that the state has changed
477          *   - In the processing thread, it calls the callback provided by the
478          *     device state provider (which may or may not be a channel driver)
479          *     to determine the state.
480          *   - If the device state provider does not know the state, or this is
481          *     for a channel and the channel driver does not implement a device
482          *     state callback, then we will look through the channel list to
483          *     see if we can determine a state based on active calls.
484          *   - Once a state has been determined, a device state event is generated.
485          */
486
487         if (state != AST_DEVICE_UNKNOWN) {
488                 ast_publish_device_state(device, state, cachable);
489         } else if (change_thread == AST_PTHREADT_NULL || !(change = ast_calloc(1, sizeof(*change) + strlen(device)))) {
490                 /* we could not allocate a change struct, or */
491                 /* there is no background thread, so process the change now */
492                 do_state_change(device, cachable);
493         } else {
494                 /* queue the change */
495                 strcpy(change->device, device);
496                 change->cachable = cachable;
497                 AST_LIST_LOCK(&state_changes);
498                 AST_LIST_INSERT_TAIL(&state_changes, change, list);
499                 ast_cond_signal(&change_pending);
500                 AST_LIST_UNLOCK(&state_changes);
501         }
502
503         return 0;
504 }
505
506 int ast_device_state_changed_literal(const char *dev)
507 {
508         return ast_devstate_changed_literal(AST_DEVICE_UNKNOWN, AST_DEVSTATE_CACHABLE, dev);
509 }
510
511 int ast_devstate_changed(enum ast_device_state state, enum ast_devstate_cache cachable, const char *fmt, ...)
512 {
513         char buf[AST_MAX_EXTENSION];
514         va_list ap;
515
516         va_start(ap, fmt);
517         vsnprintf(buf, sizeof(buf), fmt, ap);
518         va_end(ap);
519
520         return ast_devstate_changed_literal(state, cachable, buf);
521 }
522
523 int ast_device_state_changed(const char *fmt, ...)
524 {
525         char buf[AST_MAX_EXTENSION];
526         va_list ap;
527
528         va_start(ap, fmt);
529         vsnprintf(buf, sizeof(buf), fmt, ap);
530         va_end(ap);
531
532         return ast_devstate_changed_literal(AST_DEVICE_UNKNOWN, AST_DEVSTATE_CACHABLE, buf);
533 }
534
535 /*! \brief Go through the dev state change queue and update changes in the dev state thread */
536 static void *do_devstate_changes(void *data)
537 {
538         struct state_change *next, *current;
539
540         for (;;) {
541                 /* This basically pops off any state change entries, resets the list back to NULL, unlocks, and processes each state change */
542                 AST_LIST_LOCK(&state_changes);
543                 if (AST_LIST_EMPTY(&state_changes))
544                         ast_cond_wait(&change_pending, &state_changes.lock);
545                 next = AST_LIST_FIRST(&state_changes);
546                 AST_LIST_HEAD_INIT_NOLOCK(&state_changes);
547                 AST_LIST_UNLOCK(&state_changes);
548
549                 /* Process each state change */
550                 while ((current = next)) {
551                         next = AST_LIST_NEXT(current, list);
552                         do_state_change(current->device, current->cachable);
553                         ast_free(current);
554                 }
555         }
556
557         return NULL;
558 }
559
560 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)
561 {
562         struct ast_device_state_message *new_device_state;
563         char *pos;
564         size_t stuff_len;
565
566         ast_assert(!ast_strlen_zero(device));
567
568         stuff_len = strlen(device) + 1;
569         if (eid) {
570                 stuff_len += sizeof(*eid);
571         }
572         new_device_state = ao2_alloc_options(sizeof(*new_device_state) + stuff_len, NULL,
573                 AO2_ALLOC_OPT_LOCK_NOLOCK);
574         if (!new_device_state) {
575                 return NULL;
576         }
577
578         if (eid) {
579                 /* non-aggregate device state. */
580                 new_device_state->stuff[0] = *eid;
581                 new_device_state->eid = &new_device_state->stuff[0];
582                 pos = (char *) &new_device_state->stuff[1];
583         } else {
584                 pos = (char *) &new_device_state->stuff[0];
585         }
586
587         strcpy(pos, device);/* Safe */
588         new_device_state->device = pos;
589
590         new_device_state->state = state;
591         new_device_state->cachable = cachable;
592
593         return new_device_state;
594 }
595
596 static void devstate_change_cb(void *data, struct stasis_subscription *sub, struct stasis_message *msg)
597 {
598         struct ast_device_state_message *device_state;
599
600         if (ast_device_state_message_type() != stasis_message_type(msg)) {
601                 return;
602         }
603
604         device_state = stasis_message_data(msg);
605         if (device_state->cachable == AST_DEVSTATE_CACHABLE || !device_state->eid) {
606                 /* Ignore cacheable and aggregate messages. */
607                 return;
608         }
609
610         /*
611          * Non-cacheable device state aggregates are just the
612          * device state republished as the aggregate.
613          */
614         ast_publish_device_state_full(device_state->device, device_state->state,
615                 device_state->cachable, NULL);
616 }
617
618 /*! \brief Initialize the device state engine in separate thread */
619 int ast_device_state_engine_init(void)
620 {
621         ast_cond_init(&change_pending, NULL);
622         if (ast_pthread_create_background(&change_thread, NULL, do_devstate_changes, NULL) < 0) {
623                 ast_log(LOG_ERROR, "Unable to start device state change thread.\n");
624                 return -1;
625         }
626
627         return 0;
628 }
629
630 void ast_devstate_aggregate_init(struct ast_devstate_aggregate *agg)
631 {
632         memset(agg, 0, sizeof(*agg));
633         agg->state = AST_DEVICE_INVALID;
634 }
635
636 void ast_devstate_aggregate_add(struct ast_devstate_aggregate *agg, enum ast_device_state state)
637 {
638         static enum ast_device_state state_order[] = {
639                 1, /* AST_DEVICE_UNKNOWN */
640                 3, /* AST_DEVICE_NOT_INUSE */
641                 6, /* AST_DEVICE_INUSE */
642                 7, /* AST_DEVICE_BUSY */
643                 0, /* AST_DEVICE_INVALID */
644                 2, /* AST_DEVICE_UNAVAILABLE */
645                 5, /* AST_DEVICE_RINGING */
646                 8, /* AST_DEVICE_RINGINUSE */
647                 4, /* AST_DEVICE_ONHOLD */
648         };
649
650         if (state == AST_DEVICE_RINGING) {
651                 agg->ringing = 1;
652         } else if (state == AST_DEVICE_INUSE || state == AST_DEVICE_ONHOLD || state == AST_DEVICE_BUSY) {
653                 agg->inuse = 1;
654         }
655
656         if (agg->ringing && agg->inuse) {
657                 agg->state = AST_DEVICE_RINGINUSE;
658         } else if (state_order[state] > state_order[agg->state]) {
659                 agg->state = state;
660         }
661 }
662
663 enum ast_device_state ast_devstate_aggregate_result(struct ast_devstate_aggregate *agg)
664 {
665         return agg->state;
666 }
667
668 struct stasis_topic *ast_device_state_topic_all(void)
669 {
670         return device_state_topic_all;
671 }
672
673 struct stasis_cache *ast_device_state_cache(void)
674 {
675         return device_state_cache;
676 }
677
678 struct stasis_topic *ast_device_state_topic_cached(void)
679 {
680         return stasis_caching_get_topic(device_state_topic_cached);
681 }
682
683 struct stasis_topic *ast_device_state_topic(const char *device)
684 {
685         return stasis_topic_pool_get_topic(device_state_topic_pool, device);
686 }
687
688 int ast_device_state_clear_cache(const char *device)
689 {
690         struct stasis_message *cached_msg;
691         struct stasis_message *msg;
692
693         cached_msg = stasis_cache_get_by_eid(ast_device_state_cache(),
694                 ast_device_state_message_type(), device, &ast_eid_default);
695         if (!cached_msg) {
696                 /* nothing to clear */
697                 return -1;
698         }
699
700         msg = stasis_cache_clear_create(cached_msg);
701         if (msg) {
702                 stasis_publish(ast_device_state_topic(device), msg);
703         }
704         ao2_cleanup(msg);
705         ao2_cleanup(cached_msg);
706         return 0;
707 }
708
709 int ast_publish_device_state_full(
710         const char *device,
711         enum ast_device_state state,
712         enum ast_devstate_cache cachable,
713         struct ast_eid *eid)
714 {
715         RAII_VAR(struct ast_device_state_message *, device_state, NULL, ao2_cleanup);
716         RAII_VAR(struct stasis_message *, message, NULL, ao2_cleanup);
717         struct stasis_topic *device_specific_topic;
718
719         ast_assert(!ast_strlen_zero(device));
720
721         device_state = device_state_alloc(device, state, cachable, eid);
722         if (!device_state) {
723                 return -1;
724         }
725
726         message = stasis_message_create_full(ast_device_state_message_type(), device_state,
727                 eid);
728         if (!message) {
729                 return -1;
730         }
731
732         device_specific_topic = ast_device_state_topic(device);
733         if (!device_specific_topic) {
734                 return -1;
735         }
736
737         stasis_publish(device_specific_topic, message);
738         return 0;
739 }
740
741 static const char *device_state_get_id(struct stasis_message *message)
742 {
743         struct ast_device_state_message *device_state;
744
745         if (ast_device_state_message_type() != stasis_message_type(message)) {
746                 return NULL;
747         }
748
749         device_state = stasis_message_data(message);
750         if (device_state->cachable == AST_DEVSTATE_NOT_CACHABLE) {
751                 return NULL;
752         }
753
754         return device_state->device;
755 }
756
757 /*!
758  * \internal
759  * \brief Callback to publish the aggregate device state cache entry message.
760  * \since 12.2.0
761  *
762  * \param cache_topic Caching topic the aggregate message may be published over.
763  * \param aggregate The aggregate shapshot message to publish.
764  *
765  * \return Nothing
766  */
767 static void device_state_aggregate_publish(struct stasis_topic *cache_topic, struct stasis_message *aggregate)
768 {
769         const char *device;
770         struct stasis_topic *device_specific_topic;
771
772         device = device_state_get_id(aggregate);
773         if (!device) {
774                 return;
775         }
776         device_specific_topic = ast_device_state_topic(device);
777         if (!device_specific_topic) {
778                 return;
779         }
780
781         stasis_publish(device_specific_topic, aggregate);
782 }
783
784 /*!
785  * \internal
786  * \brief Callback to calculate the aggregate device state cache entry.
787  * \since 12.2.0
788  *
789  * \param entry Cache entry to calculate a new aggregate snapshot.
790  * \param new_snapshot The shapshot that is being updated.
791  *
792  * \note Return a ref bumped pointer from stasis_cache_entry_get_aggregate()
793  * if a new aggregate could not be calculated because of error.
794  *
795  * \return New aggregate-snapshot calculated on success.
796  * Caller has a reference on return.
797  */
798 static struct stasis_message *device_state_aggregate_calc(struct stasis_cache_entry *entry, struct stasis_message *new_snapshot)
799 {
800         struct stasis_message *aggregate_snapshot;
801         struct stasis_message *snapshot;
802         struct ast_device_state_message *device_state;
803         const char *device = NULL;
804         struct ast_devstate_aggregate aggregate;
805         int idx;
806
807         /* Determine the new aggregate device state. */
808         ast_devstate_aggregate_init(&aggregate);
809         snapshot = stasis_cache_entry_get_local(entry);
810         if (snapshot) {
811                 device_state = stasis_message_data(snapshot);
812                 device = device_state->device;
813                 ast_devstate_aggregate_add(&aggregate, device_state->state);
814         }
815         for (idx = 0; ; ++idx) {
816                 snapshot = stasis_cache_entry_get_remote(entry, idx);
817                 if (!snapshot) {
818                         break;
819                 }
820
821                 device_state = stasis_message_data(snapshot);
822                 device = device_state->device;
823                 ast_devstate_aggregate_add(&aggregate, device_state->state);
824         }
825
826         if (!device) {
827                 /* There are no device states cached.  Delete the aggregate. */
828                 return NULL;
829         }
830
831         snapshot = stasis_cache_entry_get_aggregate(entry);
832         if (snapshot) {
833                 device_state = stasis_message_data(snapshot);
834                 if (device_state->state == ast_devstate_aggregate_result(&aggregate)) {
835                         /* Aggregate device state did not change. */
836                         return ao2_bump(snapshot);
837                 }
838         }
839
840         device_state = device_state_alloc(device, ast_devstate_aggregate_result(&aggregate),
841                 AST_DEVSTATE_CACHABLE, NULL);
842         if (!device_state) {
843                 /* Bummer.  We have to keep the old aggregate snapshot. */
844                 return ao2_bump(snapshot);
845         }
846         aggregate_snapshot = stasis_message_create_full(ast_device_state_message_type(),
847                 device_state, NULL);
848         ao2_cleanup(device_state);
849         if (!aggregate_snapshot) {
850                 /* Bummer.  We have to keep the old aggregate snapshot. */
851                 return ao2_bump(snapshot);
852         }
853
854         return aggregate_snapshot;
855 }
856
857 static void devstate_cleanup(void)
858 {
859         devstate_message_sub = stasis_unsubscribe_and_join(devstate_message_sub);
860         device_state_topic_cached = stasis_caching_unsubscribe_and_join(device_state_topic_cached);
861
862         ao2_cleanup(device_state_cache);
863         device_state_cache = NULL;
864
865         ao2_cleanup(device_state_topic_pool);
866         device_state_topic_pool = NULL;
867
868         ao2_cleanup(device_state_topic_all);
869         device_state_topic_all = NULL;
870
871         STASIS_MESSAGE_TYPE_CLEANUP(ast_device_state_message_type);
872 }
873
874 int devstate_init(void)
875 {
876         ast_register_cleanup(devstate_cleanup);
877
878         if (STASIS_MESSAGE_TYPE_INIT(ast_device_state_message_type) != 0) {
879                 return -1;
880         }
881         device_state_topic_all = stasis_topic_create("ast_device_state_topic");
882         if (!device_state_topic_all) {
883                 devstate_cleanup();
884                 return -1;
885         }
886         device_state_topic_pool = stasis_topic_pool_create(ast_device_state_topic_all());
887         if (!device_state_topic_pool) {
888                 devstate_cleanup();
889                 return -1;
890         }
891         device_state_cache = stasis_cache_create_full(device_state_get_id,
892                 device_state_aggregate_calc, device_state_aggregate_publish);
893         if (!device_state_cache) {
894                 devstate_cleanup();
895                 return -1;
896         }
897         device_state_topic_cached = stasis_caching_topic_create(ast_device_state_topic_all(),
898                 device_state_cache);
899         if (!device_state_topic_cached) {
900                 devstate_cleanup();
901                 return -1;
902         }
903
904         devstate_message_sub = stasis_subscribe(ast_device_state_topic_all(),
905                 devstate_change_cb, NULL);
906         if (!devstate_message_sub) {
907                 ast_log(LOG_ERROR, "Failed to create subscription creating uncached device state aggregate events.\n");
908                 devstate_cleanup();
909                 return -1;
910         }
911
912         return 0;
913 }
914
915 static struct ast_manager_event_blob *devstate_to_ami(struct stasis_message *msg)
916 {
917         struct ast_device_state_message *dev_state;
918
919         dev_state = stasis_message_data(msg);
920
921         /* Ignore non-aggregate states */
922         if (dev_state->eid) {
923                 return NULL;
924         }
925
926         return ast_manager_event_blob_create(EVENT_FLAG_CALL, "DeviceStateChange",
927                 "Device: %s\r\n"
928                 "State: %s\r\n",
929                 dev_state->device, ast_devstate_str(dev_state->state));
930 }
931
932 /*! \brief Convert a \ref stasis_message to a \ref ast_event */
933 static struct ast_event *devstate_to_event(struct stasis_message *message)
934 {
935         struct ast_event *event;
936         struct ast_device_state_message *device_state;
937
938         if (!message) {
939                 return NULL;
940         }
941
942         device_state = stasis_message_data(message);
943
944         if (device_state->eid) {
945                 event = ast_event_new(AST_EVENT_DEVICE_STATE_CHANGE,
946                                             AST_EVENT_IE_DEVICE, AST_EVENT_IE_PLTYPE_STR, device_state->device,
947                                             AST_EVENT_IE_STATE, AST_EVENT_IE_PLTYPE_UINT, device_state->state,
948                                             AST_EVENT_IE_CACHABLE, AST_EVENT_IE_PLTYPE_UINT, device_state->cachable,
949                                             AST_EVENT_IE_EID, AST_EVENT_IE_PLTYPE_RAW, device_state->eid, sizeof(*device_state->eid),
950                                             AST_EVENT_IE_END);
951         } else {
952                 event = ast_event_new(AST_EVENT_DEVICE_STATE,
953                                             AST_EVENT_IE_DEVICE, AST_EVENT_IE_PLTYPE_STR, device_state->device,
954                                             AST_EVENT_IE_STATE, AST_EVENT_IE_PLTYPE_UINT, device_state->state,
955                                             AST_EVENT_IE_CACHABLE, AST_EVENT_IE_PLTYPE_UINT, device_state->cachable,
956                                             AST_EVENT_IE_END);
957         }
958
959         return event;
960 }