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