Add a massive set of changes for converting to use the ast_debug() macro.
[asterisk/asterisk.git] / main / devicestate.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2007, 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  *      devicestate providers. This is an extendible 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 presence
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 ast_state_cb struct.  Callbacks for watchers
101  *              - Callback ast_state_cb_type
102  *              - \ref ast_hint struct.
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 #include "asterisk/event.h"
130
131 /*! \brief Device state strings for printing */
132 static const char *devstatestring[] = {
133         /* 0 AST_DEVICE_UNKNOWN */      "Unknown",      /*!< Valid, but unknown state */
134         /* 1 AST_DEVICE_NOT_INUSE */    "Not in use",   /*!< Not used */
135         /* 2 AST_DEVICE IN USE */       "In use",       /*!< In use */
136         /* 3 AST_DEVICE_BUSY */         "Busy",         /*!< Busy */
137         /* 4 AST_DEVICE_INVALID */      "Invalid",      /*!< Invalid - not known to Asterisk */
138         /* 5 AST_DEVICE_UNAVAILABLE */  "Unavailable",  /*!< Unavailable (not registred) */
139         /* 6 AST_DEVICE_RINGING */      "Ringing",      /*!< Ring, ring, ring */
140         /* 7 AST_DEVICE_RINGINUSE */    "Ring+Inuse",   /*!< Ring and in use */
141         /* 8 AST_DEVICE_ONHOLD */       "On Hold"       /*!< On Hold */
142 };
143
144 /*! \brief  A device state provider (not a channel) */
145 struct devstate_prov {
146         char label[40];
147         ast_devstate_prov_cb_type callback;
148         AST_RWLIST_ENTRY(devstate_prov) list;
149 };
150
151 /*! \brief A list of providers */
152 static AST_RWLIST_HEAD_STATIC(devstate_provs, devstate_prov);
153
154 struct state_change {
155         AST_LIST_ENTRY(state_change) list;
156         char device[1];
157 };
158
159 /*! \brief The state change queue. State changes are queued
160         for processing by a separate thread */
161 static AST_LIST_HEAD_STATIC(state_changes, state_change);
162
163 /*! \brief The device state change notification thread */
164 static pthread_t change_thread = AST_PTHREADT_NULL;
165
166 /*! \brief Flag for the queue */
167 static ast_cond_t change_pending;
168
169 /* Forward declarations */
170 static int getproviderstate(const char *provider, const char *address);
171
172 /*! \brief Find devicestate as text message for output */
173 const char *devstate2str(enum ast_device_state devstate) 
174 {
175         return devstatestring[devstate];
176 }
177
178 const char *ast_devstate_str(enum ast_device_state state)
179 {
180         const char *res = "UNKNOWN";
181
182         switch (state) {
183         case AST_DEVICE_UNKNOWN:
184                 break;
185         case AST_DEVICE_NOT_INUSE:
186                 res = "NOT_INUSE";
187                 break;
188         case AST_DEVICE_INUSE:
189                 res = "INUSE";
190                 break;
191         case AST_DEVICE_BUSY:
192                 res = "BUSY";
193                 break;
194         case AST_DEVICE_INVALID:
195                 res = "INVALID";
196                 break;
197         case AST_DEVICE_UNAVAILABLE:
198                 res = "UNAVAILABLE";
199                 break;
200         case AST_DEVICE_RINGING:
201                 res = "RINGING";
202                 break;
203         case AST_DEVICE_RINGINUSE:
204                 res = "RINGINUSE";
205                 break;
206         case AST_DEVICE_ONHOLD:
207                 res = "ONHOLD";
208                 break;
209         }
210
211         return res;
212 }
213
214 enum ast_device_state ast_devstate_val(const char *val)
215 {
216         if (!strcasecmp(val, "NOT_INUSE"))
217                 return AST_DEVICE_NOT_INUSE;
218         else if (!strcasecmp(val, "INUSE"))
219                 return AST_DEVICE_INUSE;
220         else if (!strcasecmp(val, "BUSY"))
221                 return AST_DEVICE_BUSY;
222         else if (!strcasecmp(val, "INVALID"))
223                 return AST_DEVICE_INVALID;
224         else if (!strcasecmp(val, "UNAVAILABLE"))
225                 return AST_DEVICE_UNAVAILABLE;
226         else if (!strcasecmp(val, "RINGING"))
227                 return AST_DEVICE_RINGING;
228         else if (!strcasecmp(val, "RINGINUSE"))
229                 return AST_DEVICE_RINGINUSE;
230         else if (!strcasecmp(val, "ONHOLD"))
231                 return AST_DEVICE_ONHOLD;
232
233         return AST_DEVICE_UNKNOWN;
234 }
235
236 /*! \brief Find out if device is active in a call or not 
237         \note find channels with the device's name in it
238         This function is only used for channels that does not implement 
239         devicestate natively
240 */
241 enum ast_device_state ast_parse_device_state(const char *device)
242 {
243         struct ast_channel *chan;
244         char match[AST_CHANNEL_NAME];
245         enum ast_device_state res;
246
247         ast_copy_string(match, device, sizeof(match)-1);
248         strcat(match, "-");
249         chan = ast_get_channel_by_name_prefix_locked(match, strlen(match));
250
251         if (!chan)
252                 return AST_DEVICE_UNKNOWN;
253
254         if (chan->_state == AST_STATE_RINGING)
255                 res = AST_DEVICE_RINGING;
256         else
257                 res = AST_DEVICE_INUSE;
258         
259         ast_channel_unlock(chan);
260
261         return res;
262 }
263
264 /*! \brief Check device state through channel specific function or generic function */
265 enum ast_device_state ast_device_state(const char *device)
266 {
267         char *buf;
268         char *number;
269         const struct ast_channel_tech *chan_tech;
270         enum ast_device_state res = AST_DEVICE_UNKNOWN;
271         /*! \brief Channel driver that provides device state */
272         char *tech;
273         /*! \brief Another provider of device state */
274         char *provider = NULL;
275         
276         buf = ast_strdupa(device);
277         tech = strsep(&buf, "/");
278         if (!(number = buf)) {
279                 if (!(provider = strsep(&tech, ":")))
280                         return AST_DEVICE_INVALID;
281                 /* We have a provider */
282                 number = tech;
283                 tech = NULL;
284         }
285
286         if (provider)  {
287                 ast_debug(3, "Checking if I can find provider for \"%s\" - number: %s\n", provider, number);
288                 return getproviderstate(provider, number);
289         }
290
291         ast_debug(4, "No provider found, checking channel drivers for %s - %s\n", tech, number);
292
293         if (!(chan_tech = ast_get_channel_tech(tech)))
294                 return AST_DEVICE_INVALID;
295
296         if (!(chan_tech->devicestate)) /* Does the channel driver support device state notification? */
297                 return ast_parse_device_state(device); /* No, try the generic function */
298
299         res = chan_tech->devicestate(number);
300
301         if (res != AST_DEVICE_UNKNOWN)
302                 return res;
303
304         res = ast_parse_device_state(device);
305
306         if (res == AST_DEVICE_UNKNOWN)
307                 return AST_DEVICE_NOT_INUSE;
308
309         return res;
310 }
311
312 /*! \brief Add device state provider */
313 int ast_devstate_prov_add(const char *label, ast_devstate_prov_cb_type callback)
314 {
315         struct devstate_prov *devprov;
316
317         if (!callback || !(devprov = ast_calloc(1, sizeof(*devprov))))
318                 return -1;
319
320         devprov->callback = callback;
321         ast_copy_string(devprov->label, label, sizeof(devprov->label));
322
323         AST_RWLIST_WRLOCK(&devstate_provs);
324         AST_RWLIST_INSERT_HEAD(&devstate_provs, devprov, list);
325         AST_RWLIST_UNLOCK(&devstate_provs);
326
327         return 0;
328 }
329
330 /*! \brief Remove device state provider */
331 int ast_devstate_prov_del(const char *label)
332 {
333         struct devstate_prov *devcb;
334         int res = -1;
335
336         AST_RWLIST_WRLOCK(&devstate_provs);
337         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&devstate_provs, devcb, list) {
338                 if (!strcasecmp(devcb->label, label)) {
339                         AST_RWLIST_REMOVE_CURRENT(&devstate_provs, list);
340                         ast_free(devcb);
341                         res = 0;
342                         break;
343                 }
344         }
345         AST_RWLIST_TRAVERSE_SAFE_END;
346         AST_RWLIST_UNLOCK(&devstate_provs);
347
348         return res;
349 }
350
351 /*! \brief Get provider device state */
352 static int getproviderstate(const char *provider, const char *address)
353 {
354         struct devstate_prov *devprov;
355         int res = AST_DEVICE_INVALID;
356
357
358         AST_RWLIST_RDLOCK(&devstate_provs);
359         AST_RWLIST_TRAVERSE(&devstate_provs, devprov, list) {
360                 ast_debug(5, "Checking provider %s with %s\n", devprov->label, provider);
361
362                 if (!strcasecmp(devprov->label, provider)) {
363                         res = devprov->callback(address);
364                         break;
365                 }
366         }
367         AST_RWLIST_UNLOCK(&devstate_provs);
368         return res;
369 }
370
371 /*! \brief Notify callback watchers of change, and notify PBX core for hint updates
372         Normally executed within a separate thread
373 */
374 static void do_state_change(const char *device)
375 {
376         enum ast_device_state state;
377         struct ast_event *event;
378
379         state = ast_device_state(device);
380         ast_debug(3, "Changing state for %s - state %d (%s)\n", device, state, devstate2str(state));
381
382         if (!(event = ast_event_new(AST_EVENT_DEVICE_STATE,
383                         AST_EVENT_IE_DEVICE, AST_EVENT_IE_PLTYPE_STR, device,
384                         AST_EVENT_IE_STATE, AST_EVENT_IE_PLTYPE_UINT, state,
385                         AST_EVENT_IE_END))) {
386                 return;
387         }
388
389         ast_event_queue_and_cache(event,
390                 AST_EVENT_IE_DEVICE, AST_EVENT_IE_PLTYPE_STR,
391                 AST_EVENT_IE_END);
392 }
393
394 static int __ast_device_state_changed_literal(char *buf)
395 {
396         char *device;
397         struct state_change *change;
398         char *tmp = NULL;
399
400         ast_debug(3, "Notification of state change to be queued on device/channel %s\n", buf);
401
402         device = buf;
403
404         tmp = strrchr(device, '-');
405         if (tmp)
406                 *tmp = '\0';
407         
408         if (change_thread == AST_PTHREADT_NULL || !(change = ast_calloc(1, sizeof(*change) + strlen(device)))) {
409                 /* we could not allocate a change struct, or */
410                 /* there is no background thread, so process the change now */
411                 do_state_change(device);
412         } else {
413                 /* queue the change */
414                 strcpy(change->device, device);
415                 AST_LIST_LOCK(&state_changes);
416                 AST_LIST_INSERT_TAIL(&state_changes, change, list);
417                 ast_cond_signal(&change_pending);
418                 AST_LIST_UNLOCK(&state_changes);
419         }
420
421         return 1;
422 }
423
424 int ast_device_state_changed_literal(const char *dev)
425 {
426         char *buf;
427         buf = ast_strdupa(dev);
428         return __ast_device_state_changed_literal(buf);
429 }
430
431 /*! \brief Accept change notification, add it to change queue */
432 int ast_device_state_changed(const char *fmt, ...) 
433 {
434         char buf[AST_MAX_EXTENSION];
435         va_list ap;
436
437         va_start(ap, fmt);
438         vsnprintf(buf, sizeof(buf), fmt, ap);
439         va_end(ap);
440         return __ast_device_state_changed_literal(buf);
441 }
442
443 /*! \brief Go through the dev state change queue and update changes in the dev state thread */
444 static void *do_devstate_changes(void *data)
445 {
446         struct state_change *next, *current;
447
448         for (;;) {
449                 /* This basically pops off any state change entries, resets the list back to NULL, unlocks, and processes each state change */
450                 AST_LIST_LOCK(&state_changes);
451                 if (AST_LIST_EMPTY(&state_changes))
452                         ast_cond_wait(&change_pending, &state_changes.lock);
453                 next = AST_LIST_FIRST(&state_changes);
454                 AST_LIST_HEAD_INIT_NOLOCK(&state_changes);
455                 AST_LIST_UNLOCK(&state_changes);
456
457                 /* Process each state change */
458                 while ((current = next)) {
459                         next = AST_LIST_NEXT(current, list);
460                         do_state_change(current->device);
461                         ast_free(current);
462                 }
463         }
464
465         return NULL;
466 }
467
468 /*! \brief Initialize the device state engine in separate thread */
469 int ast_device_state_engine_init(void)
470 {
471         ast_cond_init(&change_pending, NULL);
472         if (ast_pthread_create_background(&change_thread, NULL, do_devstate_changes, NULL) < 0) {
473                 ast_log(LOG_ERROR, "Unable to start device state change thread.\n");
474                 return -1;
475         }
476
477         return 0;
478 }