silly people that don't want to install/run autoconf :-)
[asterisk/asterisk.git] / 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  * \author Mark Spencer <markster@digium.com> 
24  */
25
26 #include <sys/types.h>
27 #include <unistd.h>
28 #include <stdlib.h>
29 #include <string.h>
30 #include <stdio.h>
31
32 #include "asterisk.h"
33
34 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
35
36 #include "asterisk/channel.h"
37 #include "asterisk/utils.h"
38 #include "asterisk/lock.h"
39 #include "asterisk/linkedlists.h"
40 #include "asterisk/logger.h"
41 #include "asterisk/devicestate.h"
42 #include "asterisk/pbx.h"
43 #include "asterisk/options.h"
44
45 /*! \brief Device state strings for printing */
46 static const char *devstatestring[] = {
47         /* 0 AST_DEVICE_UNKNOWN */      "Unknown",      /*!< Valid, but unknown state */
48         /* 1 AST_DEVICE_NOT_INUSE */    "Not in use",   /*!< Not used */
49         /* 2 AST_DEVICE IN USE */       "In use",       /*!< In use */
50         /* 3 AST_DEVICE_BUSY */         "Busy",         /*!< Busy */
51         /* 4 AST_DEVICE_INVALID */      "Invalid",      /*!< Invalid - not known to Asterisk */
52         /* 5 AST_DEVICE_UNAVAILABLE */  "Unavailable",  /*!< Unavailable (not registred) */
53         /* 6 AST_DEVICE_RINGING */      "Ringing"       /*!< Ring, ring, ring */
54 };
55
56 /*! \brief  A device state watcher (callback) */
57 struct devstate_cb {
58         void *data;
59         ast_devstate_cb_type callback;
60         AST_LIST_ENTRY(devstate_cb) list;
61 };
62
63 static AST_LIST_HEAD_STATIC(devstate_cbs, devstate_cb);
64
65 struct state_change {
66         AST_LIST_ENTRY(state_change) list;
67         char device[1];
68 };
69
70 static AST_LIST_HEAD_STATIC(state_changes, state_change);
71
72 static pthread_t change_thread = AST_PTHREADT_NULL;
73 static ast_cond_t change_pending;
74
75 /*! \brief Find devicestate as text message for output */
76 const char *devstate2str(int devstate) 
77 {
78         return devstatestring[devstate];
79 }
80
81 /*! \brief Find out if device is active in a call or not 
82 \note find channels with the device's name in it
83 This function is only used for channels that does not implement 
84 devicestate natively
85 */
86 int ast_parse_device_state(const char *device)
87 {
88         struct ast_channel *chan;
89         char match[AST_CHANNEL_NAME];
90         int res;
91
92         ast_copy_string(match, device, sizeof(match)-1);
93         strcat(match, "-");
94         chan = ast_get_channel_by_name_prefix_locked(match, strlen(match));
95
96         if (!chan)
97                 return AST_DEVICE_UNKNOWN;
98
99         if (chan->_state == AST_STATE_RINGING)
100                 res = AST_DEVICE_RINGING;
101         else
102                 res = AST_DEVICE_INUSE;
103         
104         ast_channel_unlock(chan);
105
106         return res;
107 }
108
109 /*! \brief Check device state through channel specific function or generic function */
110 int ast_device_state(const char *device)
111 {
112         char *buf;
113         char *tech;
114         char *number;
115         const struct ast_channel_tech *chan_tech;
116         int res = 0;
117         
118         buf = ast_strdupa(device);
119         tech = strsep(&buf, "/");
120         number = buf;
121         if (!number)
122                 return AST_DEVICE_INVALID;
123                 
124         chan_tech = ast_get_channel_tech(tech);
125         if (!chan_tech)
126                 return AST_DEVICE_INVALID;
127
128         if (!chan_tech->devicestate)    /* Does the channel driver support device state notification? */
129                 return ast_parse_device_state(device);  /* No, try the generic function */
130         else {
131                 res = chan_tech->devicestate(number);   /* Ask the channel driver for device state */
132                 if (res == AST_DEVICE_UNKNOWN) {
133                         res = ast_parse_device_state(device);
134                         /* at this point we know the device exists, but the channel driver
135                            could not give us a state; if there is no channel state available,
136                            it must be 'not in use'
137                         */
138                         if (res == AST_DEVICE_UNKNOWN)
139                                 res = AST_DEVICE_NOT_INUSE;
140                         return res;
141                 } else
142                         return res;
143         }
144 }
145
146 /*! \brief Add device state watcher */
147 int ast_devstate_add(ast_devstate_cb_type callback, void *data)
148 {
149         struct devstate_cb *devcb;
150
151         if (!callback || !(devcb = ast_calloc(1, sizeof(*devcb))))
152                 return -1;
153
154         devcb->data = data;
155         devcb->callback = callback;
156
157         AST_LIST_LOCK(&devstate_cbs);
158         AST_LIST_INSERT_HEAD(&devstate_cbs, devcb, list);
159         AST_LIST_UNLOCK(&devstate_cbs);
160
161         return 0;
162 }
163
164 /*! \brief Remove device state watcher */
165 void ast_devstate_del(ast_devstate_cb_type callback, void *data)
166 {
167         struct devstate_cb *devcb;
168
169         AST_LIST_LOCK(&devstate_cbs);
170         AST_LIST_TRAVERSE_SAFE_BEGIN(&devstate_cbs, devcb, list) {
171                 if ((devcb->callback == callback) && (devcb->data == data)) {
172                         AST_LIST_REMOVE_CURRENT(&devstate_cbs, list);
173                         free(devcb);
174                         break;
175                 }
176         }
177         AST_LIST_TRAVERSE_SAFE_END;
178         AST_LIST_UNLOCK(&devstate_cbs);
179 }
180
181 /*! \brief Notify callback watchers of change, and notify PBX core for hint updates */
182 static void do_state_change(const char *device)
183 {
184         int state;
185         struct devstate_cb *devcb;
186
187         state = ast_device_state(device);
188         if (option_debug > 2)
189                 ast_log(LOG_DEBUG, "Changing state for %s - state %d (%s)\n", device, state, devstate2str(state));
190
191         AST_LIST_LOCK(&devstate_cbs);
192         AST_LIST_TRAVERSE(&devstate_cbs, devcb, list)
193                 devcb->callback(device, state, devcb->data);
194         AST_LIST_UNLOCK(&devstate_cbs);
195
196         ast_hint_state_changed(device);
197 }
198
199 static int __ast_device_state_changed_literal(char *buf)
200 {
201         char *device, *tmp;
202         struct state_change *change;
203
204         device = buf;
205         if ((tmp = strrchr(device, '-')))
206                 *tmp = '\0';
207
208         if (change_thread == AST_PTHREADT_NULL || !(change = ast_calloc(1, sizeof(*change) + strlen(device)))) {
209                 /* we could not allocate a change struct, or */
210                 /* there is no background thread, so process the change now */
211                 do_state_change(device);
212         } else {
213                 /* queue the change */
214                 strcpy(change->device, device);
215                 AST_LIST_LOCK(&state_changes);
216                 AST_LIST_INSERT_TAIL(&state_changes, change, list);
217                 if (AST_LIST_FIRST(&state_changes) == change)
218                         /* the list was empty, signal the thread */
219                         ast_cond_signal(&change_pending);
220                 AST_LIST_UNLOCK(&state_changes);
221         }
222
223         return 1;
224 }
225
226 int ast_device_state_changed_literal(const char *dev)
227 {
228         char *buf;
229         buf = ast_strdupa(dev);
230         return __ast_device_state_changed_literal(buf);
231 }
232
233 /*! \brief Accept change notification, add it to change queue */
234 int ast_device_state_changed(const char *fmt, ...) 
235 {
236         char buf[AST_MAX_EXTENSION];
237         va_list ap;
238
239         va_start(ap, fmt);
240         vsnprintf(buf, sizeof(buf), fmt, ap);
241         va_end(ap);
242         return __ast_device_state_changed_literal(buf);
243 }
244
245 /*! \brief Go through the dev state change queue and update changes in the dev state thread */
246 static void *do_devstate_changes(void *data)
247 {
248         struct state_change *cur;
249
250         AST_LIST_LOCK(&state_changes);
251         for(;;) {
252                 /* the list lock will _always_ be held at this point in the loop */
253                 cur = AST_LIST_REMOVE_HEAD(&state_changes, list);
254                 if (cur) {
255                         /* we got an entry, so unlock the list while we process it */
256                         AST_LIST_UNLOCK(&state_changes);
257                         do_state_change(cur->device);
258                         free(cur);
259                         AST_LIST_LOCK(&state_changes);
260                 } else {
261                         /* there was no entry, so atomically unlock the list and wait for
262                            the condition to be signalled (returns with the lock held) */
263                         ast_cond_wait(&change_pending, &state_changes.lock);
264                 }
265         }
266
267         return NULL;
268 }
269
270 /*! \brief Initialize the device state engine in separate thread */
271 int ast_device_state_engine_init(void)
272 {
273         ast_cond_init(&change_pending, NULL);
274         if (ast_pthread_create(&change_thread, NULL, do_devstate_changes, NULL) < 0) {
275                 ast_log(LOG_ERROR, "Unable to start device state change thread.\n");
276                 return -1;
277         }
278
279         return 0;
280 }