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