Small update
[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 AstExtStateARch Architecture
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  *      - Extension states
88  *              \arg \ref pbx.c 
89  *              \arg \ref pbx.h 
90  *      
91  */
92
93 #include "asterisk.h"
94
95 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
96
97 #include <sys/types.h>
98 #include <unistd.h>
99 #include <stdlib.h>
100 #include <string.h>
101 #include <stdio.h>
102
103 #include "asterisk/channel.h"
104 #include "asterisk/utils.h"
105 #include "asterisk/lock.h"
106 #include "asterisk/linkedlists.h"
107 #include "asterisk/logger.h"
108 #include "asterisk/devicestate.h"
109 #include "asterisk/pbx.h"
110 #include "asterisk/app.h"
111 #include "asterisk/options.h"
112
113 /*! \brief Device state strings for printing */
114 static const char *devstatestring[] = {
115         /* 0 AST_DEVICE_UNKNOWN */      "Unknown",      /*!< Valid, but unknown state */
116         /* 1 AST_DEVICE_NOT_INUSE */    "Not in use",   /*!< Not used */
117         /* 2 AST_DEVICE IN USE */       "In use",       /*!< In use */
118         /* 3 AST_DEVICE_BUSY */         "Busy",         /*!< Busy */
119         /* 4 AST_DEVICE_INVALID */      "Invalid",      /*!< Invalid - not known to Asterisk */
120         /* 5 AST_DEVICE_UNAVAILABLE */  "Unavailable",  /*!< Unavailable (not registred) */
121         /* 6 AST_DEVICE_RINGING */      "Ringing",      /*!< Ring, ring, ring */
122         /* 7 AST_DEVICE_RINGINUSE */    "Ring+Inuse",   /*!< Ring and in use */
123         /* 8 AST_DEVICE_ONHOLD */       "On Hold"       /*!< On Hold */
124 };
125
126 /*! \brief  A device state provider (not a channel) */
127 struct devstate_prov {
128         char label[40];
129         ast_devstate_prov_cb_type callback;
130         AST_LIST_ENTRY(devstate_prov) list;
131 };
132
133 /*! \brief A list of providers */
134 static AST_LIST_HEAD_STATIC(devstate_provs, devstate_prov);
135
136 /*! \brief  A device state watcher (callback) */
137 struct devstate_cb {
138         void *data;
139         ast_devstate_cb_type callback;  /*!< Where to report when state changes */
140         AST_LIST_ENTRY(devstate_cb) list;
141 };
142
143 /*! \brief A device state watcher list */
144 static AST_LIST_HEAD_STATIC(devstate_cbs, devstate_cb);
145
146 struct state_change {
147         AST_LIST_ENTRY(state_change) list;
148         char device[1];
149 };
150
151 /*! \brief The state change queue. State changes are queued
152         for processing by a separate thread */
153 static AST_LIST_HEAD_STATIC(state_changes, state_change);
154
155 /*! \brief The device state change notification thread */
156 static pthread_t change_thread = AST_PTHREADT_NULL;
157
158 /*! \brief Flag for the queue */
159 static ast_cond_t change_pending;
160
161 /* Forward declarations */
162 static int getproviderstate(const char *provider, const char *address);
163
164 /*! \brief Find devicestate as text message for output */
165 const char *devstate2str(int devstate) 
166 {
167         return devstatestring[devstate];
168 }
169
170 /*! \brief Find out if device is active in a call or not 
171         \note find channels with the device's name in it
172         This function is only used for channels that does not implement 
173         devicestate natively
174 */
175 int ast_parse_device_state(const char *device)
176 {
177         struct ast_channel *chan;
178         char match[AST_CHANNEL_NAME];
179         int res;
180
181         ast_copy_string(match, device, sizeof(match)-1);
182         strcat(match, "-");
183         chan = ast_get_channel_by_name_prefix_locked(match, strlen(match));
184
185         if (!chan)
186                 return AST_DEVICE_UNKNOWN;
187
188         if (chan->_state == AST_STATE_RINGING)
189                 res = AST_DEVICE_RINGING;
190         else
191                 res = AST_DEVICE_INUSE;
192         
193         ast_channel_unlock(chan);
194
195         return res;
196 }
197
198 /*! \brief Check device state through channel specific function or generic function */
199 int ast_device_state(const char *device)
200 {
201         char *buf;
202         char *number;
203         const struct ast_channel_tech *chan_tech;
204         int res = 0;
205         /*! \brief Channel driver that provides device state */
206         char *tech;
207         /*! \brief Another provider of device state */
208         char *provider = NULL;
209         
210         buf = ast_strdupa(device);
211         tech = strsep(&buf, "/");
212         number = buf;
213         if (!number) {
214                 provider = strsep(&tech, ":");
215                 if (!provider)
216                         return AST_DEVICE_INVALID;
217                 /* We have a provider */
218                 number = tech;
219                 tech = NULL;
220         }
221
222         if (provider)  {
223                 if(option_debug > 2)
224                         ast_log(LOG_DEBUG, "Checking if I can find provider for \"%s\" - number: %s\n", provider, number);
225                 return getproviderstate(provider, number);
226         }
227         if (option_debug > 3)
228                 ast_log(LOG_DEBUG, "No provider found, checking channel drivers for %s - %s\n", tech, number);
229
230         chan_tech = ast_get_channel_tech(tech);
231         if (!chan_tech)
232                 return AST_DEVICE_INVALID;
233
234         if (!chan_tech->devicestate)    /* Does the channel driver support device state notification? */
235                 return ast_parse_device_state(device);  /* No, try the generic function */
236         else {
237                 res = chan_tech->devicestate(number);   /* Ask the channel driver for device state */
238                 if (res == AST_DEVICE_UNKNOWN) {
239                         res = ast_parse_device_state(device);
240                         /* at this point we know the device exists, but the channel driver
241                            could not give us a state; if there is no channel state available,
242                            it must be 'not in use'
243                         */
244                         if (res == AST_DEVICE_UNKNOWN)
245                                 res = AST_DEVICE_NOT_INUSE;
246                         return res;
247                 } else
248                         return res;
249         }
250 }
251
252 /*! \brief Add device state provider */
253 int ast_devstate_prov_add(const char *label, ast_devstate_prov_cb_type callback)
254 {
255         struct devstate_prov *devprov;
256
257         if (!callback || !(devprov = ast_calloc(1, sizeof(*devprov))))
258                 return -1;
259
260         devprov->callback = callback;
261         ast_copy_string(devprov->label, label, sizeof(devprov->label));
262
263         AST_LIST_LOCK(&devstate_provs);
264         AST_LIST_INSERT_HEAD(&devstate_provs, devprov, list);
265         AST_LIST_UNLOCK(&devstate_provs);
266
267         return 0;
268 }
269
270 /*! \brief Remove device state provider */
271 void ast_devstate_prov_del(const char *label)
272 {
273         struct devstate_prov *devcb;
274
275         AST_LIST_LOCK(&devstate_provs);
276         AST_LIST_TRAVERSE_SAFE_BEGIN(&devstate_provs, devcb, list) {
277                 if (!strcasecmp(devcb->label, label)) {
278                         AST_LIST_REMOVE_CURRENT(&devstate_provs, list);
279                         free(devcb);
280                         break;
281                 }
282         }
283         AST_LIST_TRAVERSE_SAFE_END;
284         AST_LIST_UNLOCK(&devstate_provs);
285 }
286
287 /*! \brief Get provider device state */
288 static int getproviderstate(const char *provider, const char *address)
289 {
290         struct devstate_prov *devprov;
291         int res = AST_DEVICE_INVALID;
292
293
294         AST_LIST_LOCK(&devstate_provs);
295         AST_LIST_TRAVERSE_SAFE_BEGIN(&devstate_provs, devprov, list) {
296                 if(option_debug > 4)
297                         ast_log(LOG_DEBUG, "Checking provider %s with %s\n", devprov->label, provider);
298
299                 if (!strcasecmp(devprov->label, provider)) {
300                         res = devprov->callback(address);
301                         break;
302                 }
303         }
304         AST_LIST_TRAVERSE_SAFE_END;
305         AST_LIST_UNLOCK(&devstate_provs);
306         return res;
307 }
308
309 /*! \brief Add device state watcher */
310 int ast_devstate_add(ast_devstate_cb_type callback, void *data)
311 {
312         struct devstate_cb *devcb;
313
314         if (!callback || !(devcb = ast_calloc(1, sizeof(*devcb))))
315                 return -1;
316
317         devcb->data = data;
318         devcb->callback = callback;
319
320         AST_LIST_LOCK(&devstate_cbs);
321         AST_LIST_INSERT_HEAD(&devstate_cbs, devcb, list);
322         AST_LIST_UNLOCK(&devstate_cbs);
323
324         return 0;
325 }
326
327 /*! \brief Remove device state watcher */
328 void ast_devstate_del(ast_devstate_cb_type callback, void *data)
329 {
330         struct devstate_cb *devcb;
331
332         AST_LIST_LOCK(&devstate_cbs);
333         AST_LIST_TRAVERSE_SAFE_BEGIN(&devstate_cbs, devcb, list) {
334                 if ((devcb->callback == callback) && (devcb->data == data)) {
335                         AST_LIST_REMOVE_CURRENT(&devstate_cbs, list);
336                         free(devcb);
337                         break;
338                 }
339         }
340         AST_LIST_TRAVERSE_SAFE_END;
341         AST_LIST_UNLOCK(&devstate_cbs);
342 }
343
344 /*! \brief Notify callback watchers of change, and notify PBX core for hint updates
345         Normally executed within a separate thread
346 */
347 static void do_state_change(const char *device)
348 {
349         int state;
350         struct devstate_cb *devcb;
351
352         state = ast_device_state(device);
353         if (option_debug > 2)
354                 ast_log(LOG_DEBUG, "Changing state for %s - state %d (%s)\n", device, state, devstate2str(state));
355
356         AST_LIST_LOCK(&devstate_cbs);
357         AST_LIST_TRAVERSE(&devstate_cbs, devcb, list)
358                 devcb->callback(device, state, devcb->data);
359         AST_LIST_UNLOCK(&devstate_cbs);
360
361         ast_hint_state_changed(device);
362 }
363
364 static int __ast_device_state_changed_literal(char *buf)
365 {
366         char *device, *tmp;
367         struct state_change *change;
368
369         if (option_debug > 2)
370                 ast_log(LOG_DEBUG, "Notification of state change to be queued on device/channel %s\n", buf);
371
372         device = buf;
373         if ((tmp = strrchr(device, '-')))
374                 *tmp = '\0';
375
376         
377
378         if (change_thread == AST_PTHREADT_NULL || !(change = ast_calloc(1, sizeof(*change) + strlen(device)))) {
379                 /* we could not allocate a change struct, or */
380                 /* there is no background thread, so process the change now */
381                 do_state_change(device);
382         } else {
383                 /* queue the change */
384                 strcpy(change->device, device);
385                 AST_LIST_LOCK(&state_changes);
386                 AST_LIST_INSERT_TAIL(&state_changes, change, list);
387                 if (AST_LIST_FIRST(&state_changes) == change)
388                         /* the list was empty, signal the thread */
389                         ast_cond_signal(&change_pending);
390                 AST_LIST_UNLOCK(&state_changes);
391         }
392
393         return 1;
394 }
395
396 int ast_device_state_changed_literal(const char *dev)
397 {
398         char *buf;
399         buf = ast_strdupa(dev);
400         return __ast_device_state_changed_literal(buf);
401 }
402
403 /*! \brief Accept change notification, add it to change queue */
404 int ast_device_state_changed(const char *fmt, ...) 
405 {
406         char buf[AST_MAX_EXTENSION];
407         va_list ap;
408
409         va_start(ap, fmt);
410         vsnprintf(buf, sizeof(buf), fmt, ap);
411         va_end(ap);
412         return __ast_device_state_changed_literal(buf);
413 }
414
415 /*! \brief Go through the dev state change queue and update changes in the dev state thread */
416 static void *do_devstate_changes(void *data)
417 {
418         struct state_change *cur;
419
420         AST_LIST_LOCK(&state_changes);
421         for(;;) {
422                 /* the list lock will _always_ be held at this point in the loop */
423                 cur = AST_LIST_REMOVE_HEAD(&state_changes, list);
424                 if (cur) {
425                         /* we got an entry, so unlock the list while we process it */
426                         AST_LIST_UNLOCK(&state_changes);
427                         do_state_change(cur->device);
428                         free(cur);
429                         AST_LIST_LOCK(&state_changes);
430                 } else {
431                         /* there was no entry, so atomically unlock the list and wait for
432                            the condition to be signalled (returns with the lock held) */
433                         ast_cond_wait(&change_pending, &state_changes.lock);
434                 }
435         }
436
437         return NULL;
438 }
439
440 /*! \brief Initialize the device state engine in separate thread */
441 int ast_device_state_engine_init(void)
442 {
443         ast_cond_init(&change_pending, NULL);
444         if (ast_pthread_create_background(&change_thread, NULL, do_devstate_changes, NULL) < 0) {
445                 ast_log(LOG_ERROR, "Unable to start device state change thread.\n");
446                 return -1;
447         }
448
449         return 0;
450 }