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