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