0711a100214d9441ac72db2f9ca5d6271a1a200d
[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 /*! \page AstExtState Extension and device states in Asterisk
27  *
28  *      Asterisk has an internal system that reports states
29  *      for an extension. By using the dialplan priority -1,
30  *      also called a \b hint, a connection can be made from an
31  *      extension to one or many devices. The state of the extension
32  *      now depends on the combined state of the devices.
33  *
34  *      The device state is basically based on the current calls.
35  *      If the devicestate engine can find a call from or to the
36  *      device, it's in use.
37  *      
38  *      Some channel drivers implement a callback function for 
39  *      a better level of reporting device states. The SIP channel
40  *      has a complicated system for this, which is improved 
41  *      by adding call limits to the configuration.
42  * 
43  *      Functions that want to check the status of an extension
44  *      register themself as a \b watcher.
45  *      Watchers in this system can subscribe either to all extensions
46  *      or just a specific extensions.
47  *
48  *      For non-device related states, there's an API called
49  *      devicestateproviders. This is an extendable system for
50  *      delivering state information from outside sources or
51  *      functions within Asterisk. Currently we have providers
52  *      for app_meetme.c - the conference bridge - and call
53  *      parking (metermaids).
54  *
55  *      There are manly three subscribers to extension states 
56  *      within Asterisk:
57  *      - AMI, the manager interface
58  *      - app_queue.c - the Queue dialplan application
59  *      - SIP subscriptions, a.k.a. "blinking lamps" or 
60  *        "buddy lists"
61  *
62  *      None of these handle user states, like an IM presense
63  *      system. res_jabber.c can subscribe and watch such states
64  *      in jabber/xmpp based systems.
65  *
66  *      
67  */
68
69 #include "asterisk.h"
70
71 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
72
73 #include <sys/types.h>
74 #include <unistd.h>
75 #include <stdlib.h>
76 #include <string.h>
77 #include <stdio.h>
78
79 #include "asterisk/channel.h"
80 #include "asterisk/utils.h"
81 #include "asterisk/lock.h"
82 #include "asterisk/linkedlists.h"
83 #include "asterisk/logger.h"
84 #include "asterisk/devicestate.h"
85 #include "asterisk/pbx.h"
86 #include "asterisk/app.h"
87 #include "asterisk/options.h"
88
89 /*! \brief Device state strings for printing */
90 static const char *devstatestring[] = {
91         /* 0 AST_DEVICE_UNKNOWN */      "Unknown",      /*!< Valid, but unknown state */
92         /* 1 AST_DEVICE_NOT_INUSE */    "Not in use",   /*!< Not used */
93         /* 2 AST_DEVICE IN USE */       "In use",       /*!< In use */
94         /* 3 AST_DEVICE_BUSY */         "Busy",         /*!< Busy */
95         /* 4 AST_DEVICE_INVALID */      "Invalid",      /*!< Invalid - not known to Asterisk */
96         /* 5 AST_DEVICE_UNAVAILABLE */  "Unavailable",  /*!< Unavailable (not registred) */
97         /* 6 AST_DEVICE_RINGING */      "Ringing",      /*!< Ring, ring, ring */
98         /* 7 AST_DEVICE_RINGINUSE */    "Ring+Inuse",   /*!< Ring and in use */
99         /* 8 AST_DEVICE_ONHOLD */       "On Hold"       /*!< On Hold */
100 };
101
102 /*! \brief  A device state provider (not a channel) */
103 struct devstate_prov {
104         char label[40];
105         ast_devstate_prov_cb_type callback;
106         AST_LIST_ENTRY(devstate_prov) list;
107 };
108
109 /*! \brief A list of providers */
110 static AST_LIST_HEAD_STATIC(devstate_provs, devstate_prov);
111
112 /*! \brief  A device state watcher (callback) */
113 struct devstate_cb {
114         void *data;
115         ast_devstate_cb_type callback;  /*!< Where to report when state changes */
116         AST_LIST_ENTRY(devstate_cb) list;
117 };
118
119 /*! \brief A device state watcher list */
120 static AST_LIST_HEAD_STATIC(devstate_cbs, devstate_cb);
121
122 struct state_change {
123         AST_LIST_ENTRY(state_change) list;
124         char device[1];
125 };
126
127 /*! \brief The state change queue. State changes are queued
128         for processing by a separate thread */
129 static AST_LIST_HEAD_STATIC(state_changes, state_change);
130
131 /*! \brief The device state change notification thread */
132 static pthread_t change_thread = AST_PTHREADT_NULL;
133
134 /*! \brief Flag for the queue */
135 static ast_cond_t change_pending;
136
137 /* Forward declarations */
138 static int getproviderstate(const char *provider, const char *address);
139
140 /*! \brief Find devicestate as text message for output */
141 const char *devstate2str(int devstate) 
142 {
143         return devstatestring[devstate];
144 }
145
146 /*! \brief Find out if device is active in a call or not 
147         \note find channels with the device's name in it
148         This function is only used for channels that does not implement 
149         devicestate natively
150 */
151 int ast_parse_device_state(const char *device)
152 {
153         struct ast_channel *chan;
154         char match[AST_CHANNEL_NAME];
155         int res;
156
157         ast_copy_string(match, device, sizeof(match)-1);
158         strcat(match, "-");
159         chan = ast_get_channel_by_name_prefix_locked(match, strlen(match));
160
161         if (!chan)
162                 return AST_DEVICE_UNKNOWN;
163
164         if (chan->_state == AST_STATE_RINGING)
165                 res = AST_DEVICE_RINGING;
166         else
167                 res = AST_DEVICE_INUSE;
168         
169         ast_channel_unlock(chan);
170
171         return res;
172 }
173
174 /*! \brief Check device state through channel specific function or generic function */
175 int ast_device_state(const char *device)
176 {
177         char *buf;
178         char *number;
179         const struct ast_channel_tech *chan_tech;
180         int res = 0;
181         /*! \brief Channel driver that provides device state */
182         char *tech;
183         /*! \brief Another provider of device state */
184         char *provider = NULL;
185         
186         buf = ast_strdupa(device);
187         tech = strsep(&buf, "/");
188         number = buf;
189         if (!number) {
190                 provider = strsep(&tech, ":");
191                 if (!provider)
192                         return AST_DEVICE_INVALID;
193                 /* We have a provider */
194                 number = tech;
195                 tech = NULL;
196         }
197
198         if (provider)  {
199                 if(option_debug > 2)
200                         ast_log(LOG_DEBUG, "Checking if I can find provider for \"%s\" - number: %s\n", provider, number);
201                 return getproviderstate(provider, number);
202         }
203         if (option_debug > 3)
204                 ast_log(LOG_DEBUG, "No provider found, checking channel drivers for %s - %s\n", tech, number);
205
206         chan_tech = ast_get_channel_tech(tech);
207         if (!chan_tech)
208                 return AST_DEVICE_INVALID;
209
210         if (!chan_tech->devicestate)    /* Does the channel driver support device state notification? */
211                 return ast_parse_device_state(device);  /* No, try the generic function */
212         else {
213                 res = chan_tech->devicestate(number);   /* Ask the channel driver for device state */
214                 if (res == AST_DEVICE_UNKNOWN) {
215                         res = ast_parse_device_state(device);
216                         /* at this point we know the device exists, but the channel driver
217                            could not give us a state; if there is no channel state available,
218                            it must be 'not in use'
219                         */
220                         if (res == AST_DEVICE_UNKNOWN)
221                                 res = AST_DEVICE_NOT_INUSE;
222                         return res;
223                 } else
224                         return res;
225         }
226 }
227
228 /*! \brief Add device state provider */
229 int ast_devstate_prov_add(const char *label, ast_devstate_prov_cb_type callback)
230 {
231         struct devstate_prov *devprov;
232
233         if (!callback || !(devprov = ast_calloc(1, sizeof(*devprov))))
234                 return -1;
235
236         devprov->callback = callback;
237         ast_copy_string(devprov->label, label, sizeof(devprov->label));
238
239         AST_LIST_LOCK(&devstate_provs);
240         AST_LIST_INSERT_HEAD(&devstate_provs, devprov, list);
241         AST_LIST_UNLOCK(&devstate_provs);
242
243         return 0;
244 }
245
246 /*! \brief Remove device state provider */
247 void ast_devstate_prov_del(const char *label)
248 {
249         struct devstate_prov *devcb;
250
251         AST_LIST_LOCK(&devstate_provs);
252         AST_LIST_TRAVERSE_SAFE_BEGIN(&devstate_provs, devcb, list) {
253                 if (!strcasecmp(devcb->label, label)) {
254                         AST_LIST_REMOVE_CURRENT(&devstate_provs, list);
255                         free(devcb);
256                         break;
257                 }
258         }
259         AST_LIST_TRAVERSE_SAFE_END;
260         AST_LIST_UNLOCK(&devstate_provs);
261 }
262
263 /*! \brief Get provider device state */
264 static int getproviderstate(const char *provider, const char *address)
265 {
266         struct devstate_prov *devprov;
267         int res = AST_DEVICE_INVALID;
268
269
270         AST_LIST_LOCK(&devstate_provs);
271         AST_LIST_TRAVERSE_SAFE_BEGIN(&devstate_provs, devprov, list) {
272                 if(option_debug > 4)
273                         ast_log(LOG_DEBUG, "Checking provider %s with %s\n", devprov->label, provider);
274
275                 if (!strcasecmp(devprov->label, provider)) {
276                         res = devprov->callback(address);
277                         break;
278                 }
279         }
280         AST_LIST_TRAVERSE_SAFE_END;
281         AST_LIST_UNLOCK(&devstate_provs);
282         return res;
283 }
284
285 /*! \brief Add device state watcher */
286 int ast_devstate_add(ast_devstate_cb_type callback, void *data)
287 {
288         struct devstate_cb *devcb;
289
290         if (!callback || !(devcb = ast_calloc(1, sizeof(*devcb))))
291                 return -1;
292
293         devcb->data = data;
294         devcb->callback = callback;
295
296         AST_LIST_LOCK(&devstate_cbs);
297         AST_LIST_INSERT_HEAD(&devstate_cbs, devcb, list);
298         AST_LIST_UNLOCK(&devstate_cbs);
299
300         return 0;
301 }
302
303 /*! \brief Remove device state watcher */
304 void ast_devstate_del(ast_devstate_cb_type callback, void *data)
305 {
306         struct devstate_cb *devcb;
307
308         AST_LIST_LOCK(&devstate_cbs);
309         AST_LIST_TRAVERSE_SAFE_BEGIN(&devstate_cbs, devcb, list) {
310                 if ((devcb->callback == callback) && (devcb->data == data)) {
311                         AST_LIST_REMOVE_CURRENT(&devstate_cbs, list);
312                         free(devcb);
313                         break;
314                 }
315         }
316         AST_LIST_TRAVERSE_SAFE_END;
317         AST_LIST_UNLOCK(&devstate_cbs);
318 }
319
320 /*! \brief Notify callback watchers of change, and notify PBX core for hint updates
321         Normally executed within a separate thread
322 */
323 static void do_state_change(const char *device)
324 {
325         int state;
326         struct devstate_cb *devcb;
327
328         state = ast_device_state(device);
329         if (option_debug > 2)
330                 ast_log(LOG_DEBUG, "Changing state for %s - state %d (%s)\n", device, state, devstate2str(state));
331
332         AST_LIST_LOCK(&devstate_cbs);
333         AST_LIST_TRAVERSE(&devstate_cbs, devcb, list)
334                 devcb->callback(device, state, devcb->data);
335         AST_LIST_UNLOCK(&devstate_cbs);
336
337         ast_hint_state_changed(device);
338 }
339
340 static int __ast_device_state_changed_literal(char *buf)
341 {
342         char *device, *tmp;
343         struct state_change *change;
344
345         if (option_debug > 2)
346                 ast_log(LOG_DEBUG, "Notification of state change to be queued on device/channel %s\n", buf);
347
348         device = buf;
349         if ((tmp = strrchr(device, '-')))
350                 *tmp = '\0';
351
352         
353
354         if (change_thread == AST_PTHREADT_NULL || !(change = ast_calloc(1, sizeof(*change) + strlen(device)))) {
355                 /* we could not allocate a change struct, or */
356                 /* there is no background thread, so process the change now */
357                 do_state_change(device);
358         } else {
359                 /* queue the change */
360                 strcpy(change->device, device);
361                 AST_LIST_LOCK(&state_changes);
362                 AST_LIST_INSERT_TAIL(&state_changes, change, list);
363                 if (AST_LIST_FIRST(&state_changes) == change)
364                         /* the list was empty, signal the thread */
365                         ast_cond_signal(&change_pending);
366                 AST_LIST_UNLOCK(&state_changes);
367         }
368
369         return 1;
370 }
371
372 int ast_device_state_changed_literal(const char *dev)
373 {
374         char *buf;
375         buf = ast_strdupa(dev);
376         return __ast_device_state_changed_literal(buf);
377 }
378
379 /*! \brief Accept change notification, add it to change queue */
380 int ast_device_state_changed(const char *fmt, ...) 
381 {
382         char buf[AST_MAX_EXTENSION];
383         va_list ap;
384
385         va_start(ap, fmt);
386         vsnprintf(buf, sizeof(buf), fmt, ap);
387         va_end(ap);
388         return __ast_device_state_changed_literal(buf);
389 }
390
391 /*! \brief Go through the dev state change queue and update changes in the dev state thread */
392 static void *do_devstate_changes(void *data)
393 {
394         struct state_change *cur;
395
396         AST_LIST_LOCK(&state_changes);
397         for(;;) {
398                 /* the list lock will _always_ be held at this point in the loop */
399                 cur = AST_LIST_REMOVE_HEAD(&state_changes, list);
400                 if (cur) {
401                         /* we got an entry, so unlock the list while we process it */
402                         AST_LIST_UNLOCK(&state_changes);
403                         do_state_change(cur->device);
404                         free(cur);
405                         AST_LIST_LOCK(&state_changes);
406                 } else {
407                         /* there was no entry, so atomically unlock the list and wait for
408                            the condition to be signalled (returns with the lock held) */
409                         ast_cond_wait(&change_pending, &state_changes.lock);
410                 }
411         }
412
413         return NULL;
414 }
415
416 /*! \brief Initialize the device state engine in separate thread */
417 int ast_device_state_engine_init(void)
418 {
419         ast_cond_init(&change_pending, NULL);
420         if (ast_pthread_create_background(&change_thread, NULL, do_devstate_changes, NULL) < 0) {
421                 ast_log(LOG_ERROR, "Unable to start device state change thread.\n");
422                 return -1;
423         }
424
425         return 0;
426 }