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