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