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