This introduces a new dialplan function, DEVSTATE, which allows you to do some
[asterisk/asterisk.git] / main / devicestate.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief Device state management
22  *
23  *
24  * \author Mark Spencer <markster@digium.com> 
25  *
26  *      \arg \ref AstExtState
27  */
28 /*! \page AstExtState Extension and device states in Asterisk
29  *
30  *      Asterisk has an internal system that reports states
31  *      for an extension. By using the dialplan priority -1,
32  *      also called a \b hint, a connection can be made from an
33  *      extension to one or many devices. The state of the extension
34  *      now depends on the combined state of the devices.
35  *
36  *      The device state is basically based on the current calls.
37  *      If the devicestate engine can find a call from or to the
38  *      device, it's in use.
39  *      
40  *      Some channel drivers implement a callback function for 
41  *      a better level of reporting device states. The SIP channel
42  *      has a complicated system for this, which is improved 
43  *      by adding call limits to the configuration.
44  * 
45  *      Functions that want to check the status of an extension
46  *      register themself as a \b watcher.
47  *      Watchers in this system can subscribe either to all extensions
48  *      or just a specific extensions.
49  *
50  *      For non-device related states, there's an API called
51  *      devicestateproviders. This is an extendable system for
52  *      delivering state information from outside sources or
53  *      functions within Asterisk. Currently we have providers
54  *      for app_meetme.c - the conference bridge - and call
55  *      parking (metermaids).
56  *
57  *      There are manly three subscribers to extension states 
58  *      within Asterisk:
59  *      - AMI, the manager interface
60  *      - app_queue.c - the Queue dialplan application
61  *      - SIP subscriptions, a.k.a. "blinking lamps" or 
62  *        "buddy lists"
63  *
64  *      The CLI command "show hints" show last known state
65  *
66  *      \note None of these handle user states, like an IM presense
67  *      system. res_jabber.c can subscribe and watch such states
68  *      in jabber/xmpp based systems.
69  *
70  *      \section AstDevStateArch Architecture for devicestates
71  *
72  *      When a channel driver or asterisk app changes state for 
73  *      a watched object, it alerts the core. The core queues
74  *      a change. When the change is processed, there's a query
75  *      sent to the channel driver/provider if there's a function
76  *      to handle that, otherwise a channel walk is issued to find
77  *      a channel that involves the object.
78  *      
79  *      The changes are queued and processed by a separate thread.
80  *      This thread calls the watchers subscribing to status 
81  *      changes for the object. For manager, this results 
82  *      in events. For SIP, NOTIFY requests.
83  *
84  *      - Device states
85  *              \arg \ref devicestate.c 
86  *              \arg \ref devicestate.h 
87  *
88  *      \section AstExtStateArch Architecture for extension states
89  *      
90  *      Hints are connected to extension. If an extension changes state
91  *      it checks the hint devices. If there is a hint, the callbacks into
92  *      device states are checked. The aggregated state is set for the hint
93  *      and reported back.
94  *
95  *      - Extension states
96  *              \arg \ref enum ast_extension_states
97  *              \arg \ref pbx.c 
98  *              \arg \ref pbx.h 
99  *      - Structures
100  *              - \ref struct ast_state_cb  Callbacks for watchers
101  *              - Callback ast_state_cb_type
102  *              - \ref struct ast_hint
103  *      - Functions
104  *              - ast_extension_state_add()
105  *              - ast_extension_state_del()
106  *              - ast_get_hint()
107  *      
108  */
109
110 #include "asterisk.h"
111
112 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
113
114 #include <sys/types.h>
115 #include <unistd.h>
116 #include <stdlib.h>
117 #include <string.h>
118 #include <stdio.h>
119
120 #include "asterisk/channel.h"
121 #include "asterisk/utils.h"
122 #include "asterisk/lock.h"
123 #include "asterisk/linkedlists.h"
124 #include "asterisk/logger.h"
125 #include "asterisk/devicestate.h"
126 #include "asterisk/pbx.h"
127 #include "asterisk/app.h"
128 #include "asterisk/options.h"
129
130 /*! \brief Device state strings for printing */
131 static const char *devstatestring[] = {
132         /* 0 AST_DEVICE_UNKNOWN */      "Unknown",      /*!< Valid, but unknown state */
133         /* 1 AST_DEVICE_NOT_INUSE */    "Not in use",   /*!< Not used */
134         /* 2 AST_DEVICE IN USE */       "In use",       /*!< In use */
135         /* 3 AST_DEVICE_BUSY */         "Busy",         /*!< Busy */
136         /* 4 AST_DEVICE_INVALID */      "Invalid",      /*!< Invalid - not known to Asterisk */
137         /* 5 AST_DEVICE_UNAVAILABLE */  "Unavailable",  /*!< Unavailable (not registred) */
138         /* 6 AST_DEVICE_RINGING */      "Ringing",      /*!< Ring, ring, ring */
139         /* 7 AST_DEVICE_RINGINUSE */    "Ring+Inuse",   /*!< Ring and in use */
140         /* 8 AST_DEVICE_ONHOLD */       "On Hold"       /*!< On Hold */
141 };
142
143 /*! \brief  A device state provider (not a channel) */
144 struct devstate_prov {
145         char label[40];
146         ast_devstate_prov_cb_type callback;
147         AST_RWLIST_ENTRY(devstate_prov) list;
148 };
149
150 /*! \brief A list of providers */
151 static AST_RWLIST_HEAD_STATIC(devstate_provs, devstate_prov);
152
153 /*! \brief  A device state watcher (callback) */
154 struct devstate_cb {
155         void *data;
156         ast_devstate_cb_type callback;  /*!< Where to report when state changes */
157         AST_RWLIST_ENTRY(devstate_cb) list;
158 };
159
160 /*! \brief A device state watcher list */
161 static AST_RWLIST_HEAD_STATIC(devstate_cbs, devstate_cb);
162
163 struct state_change {
164         AST_LIST_ENTRY(state_change) list;
165         char device[1];
166 };
167
168 /*! \brief The state change queue. State changes are queued
169         for processing by a separate thread */
170 static AST_LIST_HEAD_STATIC(state_changes, state_change);
171
172 /*! \brief The device state change notification thread */
173 static pthread_t change_thread = AST_PTHREADT_NULL;
174
175 /*! \brief Flag for the queue */
176 static ast_cond_t change_pending;
177
178 /* Forward declarations */
179 static int getproviderstate(const char *provider, const char *address);
180
181 /*! \brief Find devicestate as text message for output */
182 const char *devstate2str(enum ast_device_state devstate) 
183 {
184         return devstatestring[devstate];
185 }
186
187 const char *ast_devstate_str(enum ast_device_state state)
188 {
189         const char *res = "UNKNOWN";
190
191         switch (state) {
192         case AST_DEVICE_UNKNOWN:
193                 break;
194         case AST_DEVICE_NOT_INUSE:
195                 res = "NOT_INUSE";
196                 break;
197         case AST_DEVICE_INUSE:
198                 res = "INUSE";
199                 break;
200         case AST_DEVICE_BUSY:
201                 res = "BUSY";
202                 break;
203         case AST_DEVICE_INVALID:
204                 res = "INVALID";
205                 break;
206         case AST_DEVICE_UNAVAILABLE:
207                 res = "UNAVAILABLE";
208                 break;
209         case AST_DEVICE_RINGING:
210                 res = "RINGING";
211                 break;
212         case AST_DEVICE_RINGINUSE:
213                 res = "RINGINUSE";
214                 break;
215         case AST_DEVICE_ONHOLD:
216                 res = "ONHOLD";
217                 break;
218         }
219
220         return res;
221 }
222
223 enum ast_device_state ast_devstate_val(const char *val)
224 {
225         if (!strcasecmp(val, "NOT_INUSE"))
226                 return AST_DEVICE_NOT_INUSE;
227         else if (!strcasecmp(val, "INUSE"))
228                 return AST_DEVICE_INUSE;
229         else if (!strcasecmp(val, "BUSY"))
230                 return AST_DEVICE_BUSY;
231         else if (!strcasecmp(val, "INVALID"))
232                 return AST_DEVICE_INVALID;
233         else if (!strcasecmp(val, "UNAVAILABLE"))
234                 return AST_DEVICE_UNAVAILABLE;
235         else if (!strcasecmp(val, "RINGING"))
236                 return AST_DEVICE_RINGING;
237         else if (!strcasecmp(val, "RINGINUSE"))
238                 return AST_DEVICE_RINGINUSE;
239         else if (!strcasecmp(val, "ONHOLD"))
240                 return AST_DEVICE_ONHOLD;
241
242         return AST_DEVICE_UNKNOWN;
243 }
244
245 /*! \brief Find out if device is active in a call or not 
246         \note find channels with the device's name in it
247         This function is only used for channels that does not implement 
248         devicestate natively
249 */
250 enum ast_device_state ast_parse_device_state(const char *device)
251 {
252         struct ast_channel *chan;
253         char match[AST_CHANNEL_NAME];
254         enum ast_device_state res;
255
256         ast_copy_string(match, device, sizeof(match)-1);
257         strcat(match, "-");
258         chan = ast_get_channel_by_name_prefix_locked(match, strlen(match));
259
260         if (!chan)
261                 return AST_DEVICE_UNKNOWN;
262
263         if (chan->_state == AST_STATE_RINGING)
264                 res = AST_DEVICE_RINGING;
265         else
266                 res = AST_DEVICE_INUSE;
267         
268         ast_channel_unlock(chan);
269
270         return res;
271 }
272
273 /*! \brief Check device state through channel specific function or generic function */
274 enum ast_device_state ast_device_state(const char *device)
275 {
276         char *buf;
277         char *number;
278         const struct ast_channel_tech *chan_tech;
279         enum ast_device_state res = AST_DEVICE_UNKNOWN;
280         /*! \brief Channel driver that provides device state */
281         char *tech;
282         /*! \brief Another provider of device state */
283         char *provider = NULL;
284         
285         buf = ast_strdupa(device);
286         tech = strsep(&buf, "/");
287         if (!(number = buf)) {
288                 if (!(provider = strsep(&tech, ":")))
289                         return AST_DEVICE_INVALID;
290                 /* We have a provider */
291                 number = tech;
292                 tech = NULL;
293         }
294
295         if (provider)  {
296                 if (option_debug > 2)
297                         ast_log(LOG_DEBUG, "Checking if I can find provider for \"%s\" - number: %s\n", provider, number);
298                 return getproviderstate(provider, number);
299         }
300
301         if (option_debug > 3)
302                 ast_log(LOG_DEBUG, "No provider found, checking channel drivers for %s - %s\n", tech, number);
303
304         if (!(chan_tech = ast_get_channel_tech(tech)))
305                 return AST_DEVICE_INVALID;
306
307         if (!(chan_tech->devicestate)) /* Does the channel driver support device state notification? */
308                 return ast_parse_device_state(device); /* No, try the generic function */
309
310         res = chan_tech->devicestate(number);
311
312         if (res != AST_DEVICE_UNKNOWN)
313                 return res;
314
315         res = ast_parse_device_state(device);
316
317         if (res == AST_DEVICE_UNKNOWN)
318                 return AST_DEVICE_NOT_INUSE;
319
320         return res;
321 }
322
323 /*! \brief Add device state provider */
324 int ast_devstate_prov_add(const char *label, ast_devstate_prov_cb_type callback)
325 {
326         struct devstate_prov *devprov;
327
328         if (!callback || !(devprov = ast_calloc(1, sizeof(*devprov))))
329                 return -1;
330
331         devprov->callback = callback;
332         ast_copy_string(devprov->label, label, sizeof(devprov->label));
333
334         AST_RWLIST_WRLOCK(&devstate_provs);
335         AST_RWLIST_INSERT_HEAD(&devstate_provs, devprov, list);
336         AST_RWLIST_UNLOCK(&devstate_provs);
337
338         return 0;
339 }
340
341 /*! \brief Remove device state provider */
342 int ast_devstate_prov_del(const char *label)
343 {
344         struct devstate_prov *devcb;
345         int res = -1;
346
347         AST_RWLIST_WRLOCK(&devstate_provs);
348         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&devstate_provs, devcb, list) {
349                 if (!strcasecmp(devcb->label, label)) {
350                         AST_RWLIST_REMOVE_CURRENT(&devstate_provs, list);
351                         free(devcb);
352                         res = 0;
353                         break;
354                 }
355         }
356         AST_RWLIST_TRAVERSE_SAFE_END;
357         AST_RWLIST_UNLOCK(&devstate_provs);
358
359         return res;
360 }
361
362 /*! \brief Get provider device state */
363 static int getproviderstate(const char *provider, const char *address)
364 {
365         struct devstate_prov *devprov;
366         int res = AST_DEVICE_INVALID;
367
368
369         AST_RWLIST_RDLOCK(&devstate_provs);
370         AST_RWLIST_TRAVERSE(&devstate_provs, devprov, list) {
371                 if (option_debug > 4)
372                         ast_log(LOG_DEBUG, "Checking provider %s with %s\n", devprov->label, provider);
373
374                 if (!strcasecmp(devprov->label, provider)) {
375                         res = devprov->callback(address);
376                         break;
377                 }
378         }
379         AST_RWLIST_UNLOCK(&devstate_provs);
380         return res;
381 }
382
383 /*! \brief Add device state watcher */
384 int ast_devstate_add(ast_devstate_cb_type callback, void *data)
385 {
386         struct devstate_cb *devcb;
387
388         if (!callback || !(devcb = ast_calloc(1, sizeof(*devcb))))
389                 return -1;
390
391         devcb->data = data;
392         devcb->callback = callback;
393
394         AST_RWLIST_WRLOCK(&devstate_cbs);
395         AST_RWLIST_INSERT_HEAD(&devstate_cbs, devcb, list);
396         AST_RWLIST_UNLOCK(&devstate_cbs);
397
398         return 0;
399 }
400
401 /*! \brief Remove device state watcher */
402 void ast_devstate_del(ast_devstate_cb_type callback, void *data)
403 {
404         struct devstate_cb *devcb;
405
406         AST_RWLIST_WRLOCK(&devstate_cbs);
407         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&devstate_cbs, devcb, list) {
408                 if ((devcb->callback == callback) && (devcb->data == data)) {
409                         AST_RWLIST_REMOVE_CURRENT(&devstate_cbs, list);
410                         free(devcb);
411                         break;
412                 }
413         }
414         AST_RWLIST_TRAVERSE_SAFE_END;
415         AST_RWLIST_UNLOCK(&devstate_cbs);
416 }
417
418 /*! \brief Notify callback watchers of change, and notify PBX core for hint updates
419         Normally executed within a separate thread
420 */
421 static void do_state_change(const char *device)
422 {
423         int state;
424         struct devstate_cb *devcb;
425
426         state = ast_device_state(device);
427         if (option_debug > 2)
428                 ast_log(LOG_DEBUG, "Changing state for %s - state %d (%s)\n", device, state, devstate2str(state));
429
430         AST_RWLIST_RDLOCK(&devstate_cbs);
431         AST_RWLIST_TRAVERSE(&devstate_cbs, devcb, list)
432                 devcb->callback(device, state, devcb->data);
433         AST_RWLIST_UNLOCK(&devstate_cbs);
434
435         ast_hint_state_changed(device);
436 }
437
438 static int __ast_device_state_changed_literal(char *buf)
439 {
440         char *device, *tmp;
441         struct state_change *change;
442
443         if (option_debug > 2)
444                 ast_log(LOG_DEBUG, "Notification of state change to be queued on device/channel %s\n", buf);
445
446         device = buf;
447         if ((tmp = strrchr(device, '-')))
448                 *tmp = '\0';
449
450         if (change_thread == AST_PTHREADT_NULL || !(change = ast_calloc(1, sizeof(*change) + strlen(device)))) {
451                 /* we could not allocate a change struct, or */
452                 /* there is no background thread, so process the change now */
453                 do_state_change(device);
454         } else {
455                 /* queue the change */
456                 strcpy(change->device, device);
457                 AST_LIST_LOCK(&state_changes);
458                 AST_LIST_INSERT_TAIL(&state_changes, change, list);
459                 ast_cond_signal(&change_pending);
460                 AST_LIST_UNLOCK(&state_changes);
461         }
462
463         return 1;
464 }
465
466 int ast_device_state_changed_literal(const char *dev)
467 {
468         char *buf;
469         buf = ast_strdupa(dev);
470         return __ast_device_state_changed_literal(buf);
471 }
472
473 /*! \brief Accept change notification, add it to change queue */
474 int ast_device_state_changed(const char *fmt, ...) 
475 {
476         char buf[AST_MAX_EXTENSION];
477         va_list ap;
478
479         va_start(ap, fmt);
480         vsnprintf(buf, sizeof(buf), fmt, ap);
481         va_end(ap);
482         return __ast_device_state_changed_literal(buf);
483 }
484
485 /*! \brief Go through the dev state change queue and update changes in the dev state thread */
486 static void *do_devstate_changes(void *data)
487 {
488         struct state_change *next, *current;
489
490         for (;;) {
491                 /* This basically pops off any state change entries, resets the list back to NULL, unlocks, and processes each state change */
492                 AST_LIST_LOCK(&state_changes);
493                 if (AST_LIST_EMPTY(&state_changes))
494                         ast_cond_wait(&change_pending, &state_changes.lock);
495                 next = AST_LIST_FIRST(&state_changes);
496                 AST_LIST_HEAD_INIT_NOLOCK(&state_changes);
497                 AST_LIST_UNLOCK(&state_changes);
498
499                 /* Process each state change */
500                 while ((current = next)) {
501                         next = AST_LIST_NEXT(current, list);
502                         do_state_change(current->device);
503                         free(current);
504                 }
505         }
506
507         return NULL;
508 }
509
510 /*! \brief Initialize the device state engine in separate thread */
511 int ast_device_state_engine_init(void)
512 {
513         ast_cond_init(&change_pending, NULL);
514         if (ast_pthread_create_background(&change_thread, NULL, do_devstate_changes, NULL) < 0) {
515                 ast_log(LOG_ERROR, "Unable to start device state change thread.\n");
516                 return -1;
517         }
518
519         return 0;
520 }