make the 'name' and 'value' fields in ast_variable const char *
[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
29 /*! \page AstExtState Extension and device states in Asterisk
30  *
31  *      Asterisk has an internal system that reports states
32  *      for an extension. By using the dialplan priority -1,
33  *      also called a \b hint, a connection can be made from an
34  *      extension to one or many devices. The state of the extension
35  *      now depends on the combined state of the devices.
36  *
37  *      The device state is basically based on the current calls.
38  *      If the devicestate engine can find a call from or to the
39  *      device, it's in use.
40  *      
41  *      Some channel drivers implement a callback function for 
42  *      a better level of reporting device states. The SIP channel
43  *      has a complicated system for this, which is improved 
44  *      by adding call limits to the configuration.
45  * 
46  *      Functions that want to check the status of an extension
47  *      register themself as a \b watcher.
48  *      Watchers in this system can subscribe either to all extensions
49  *      or just a specific extensions.
50  *
51  *      For non-device related states, there's an API called
52  *      devicestate providers. This is an extendible system for
53  *      delivering state information from outside sources or
54  *      functions within Asterisk. Currently we have providers
55  *      for app_meetme.c - the conference bridge - and call
56  *      parking (metermaids).
57  *
58  *      There are manly three subscribers to extension states 
59  *      within Asterisk:
60  *      - AMI, the manager interface
61  *      - app_queue.c - the Queue dialplan application
62  *      - SIP subscriptions, a.k.a. "blinking lamps" or 
63  *        "buddy lists"
64  *
65  *      The CLI command "show hints" show last known state
66  *
67  *      \note None of these handle user states, like an IM presence
68  *      system. res_jabber.c can subscribe and watch such states
69  *      in jabber/xmpp based systems.
70  *
71  *      \section AstDevStateArch Architecture for devicestates
72  *
73  *      When a channel driver or asterisk app changes state for 
74  *      a watched object, it alerts the core. The core queues
75  *      a change. When the change is processed, there's a query
76  *      sent to the channel driver/provider if there's a function
77  *      to handle that, otherwise a channel walk is issued to find
78  *      a channel that involves the object.
79  *      
80  *      The changes are queued and processed by a separate thread.
81  *      This thread calls the watchers subscribing to status 
82  *      changes for the object. For manager, this results 
83  *      in events. For SIP, NOTIFY requests.
84  *
85  *      - Device states
86  *              \arg \ref devicestate.c 
87  *              \arg \ref devicestate.h 
88  *
89  *      \section AstExtStateArch Architecture for extension states
90  *      
91  *      Hints are connected to extension. If an extension changes state
92  *      it checks the hint devices. If there is a hint, the callbacks into
93  *      device states are checked. The aggregated state is set for the hint
94  *      and reported back.
95  *
96  *      - Extension states
97  *              \arg \ref AstENUM ast_extension_states
98  *              \arg \ref pbx.c 
99  *              \arg \ref pbx.h 
100  *      - Structures
101  *              - \ref ast_state_cb struct.  Callbacks for watchers
102  *              - Callback ast_state_cb_type
103  *              - \ref ast_hint struct.
104  *      - Functions
105  *              - ast_extension_state_add()
106  *              - ast_extension_state_del()
107  *              - ast_get_hint()
108  *      
109  */
110
111 #include "asterisk.h"
112
113 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
114
115 #include <sys/types.h>
116 #include <unistd.h>
117 #include <stdlib.h>
118 #include <string.h>
119 #include <stdio.h>
120
121 #include "asterisk/channel.h"
122 #include "asterisk/utils.h"
123 #include "asterisk/lock.h"
124 #include "asterisk/linkedlists.h"
125 #include "asterisk/logger.h"
126 #include "asterisk/devicestate.h"
127 #include "asterisk/pbx.h"
128 #include "asterisk/app.h"
129 #include "asterisk/options.h"
130 #include "asterisk/event.h"
131
132 /*! \brief Device state strings for printing */
133 static const char *devstatestring[] = {
134         /* 0 AST_DEVICE_UNKNOWN */      "Unknown",      /*!< Valid, but unknown state */
135         /* 1 AST_DEVICE_NOT_INUSE */    "Not in use",   /*!< Not used */
136         /* 2 AST_DEVICE IN USE */       "In use",       /*!< In use */
137         /* 3 AST_DEVICE_BUSY */         "Busy",         /*!< Busy */
138         /* 4 AST_DEVICE_INVALID */      "Invalid",      /*!< Invalid - not known to Asterisk */
139         /* 5 AST_DEVICE_UNAVAILABLE */  "Unavailable",  /*!< Unavailable (not registred) */
140         /* 6 AST_DEVICE_RINGING */      "Ringing",      /*!< Ring, ring, ring */
141         /* 7 AST_DEVICE_RINGINUSE */    "Ring+Inuse",   /*!< Ring and in use */
142         /* 8 AST_DEVICE_ONHOLD */       "On Hold"       /*!< On Hold */
143 };
144
145 /*! \brief  A device state provider (not a channel) */
146 struct devstate_prov {
147         char label[40];
148         ast_devstate_prov_cb_type callback;
149         AST_RWLIST_ENTRY(devstate_prov) list;
150 };
151
152 /*! \brief A list of providers */
153 static AST_RWLIST_HEAD_STATIC(devstate_provs, devstate_prov);
154
155 struct state_change {
156         AST_LIST_ENTRY(state_change) list;
157         char device[1];
158 };
159
160 /*! \brief The state change queue. State changes are queued
161         for processing by a separate thread */
162 static AST_LIST_HEAD_STATIC(state_changes, state_change);
163
164 /*! \brief The device state change notification thread */
165 static pthread_t change_thread = AST_PTHREADT_NULL;
166
167 /*! \brief Flag for the queue */
168 static ast_cond_t change_pending;
169
170 /*! \brief Whether or not to cache this device state value */
171 enum devstate_cache {
172         /*! Cache this value as it is coming from a device state provider which is
173          *  pushing up state change events to us as they happen */
174         CACHE_ON,
175         /*! Don't cache this result, since it was pulled from the device state provider.
176          *  We only want to cache results from device state providers that are being nice
177          *  and pushing state change events up to us as they happen. */
178         CACHE_OFF,
179 };
180
181 /* Forward declarations */
182 static int getproviderstate(const char *provider, const char *address);
183
184 /*! \brief Find devicestate as text message for output */
185 const char *devstate2str(enum ast_device_state devstate) 
186 {
187         return devstatestring[devstate];
188 }
189
190 const char *ast_devstate_str(enum ast_device_state state)
191 {
192         const char *res = "UNKNOWN";
193
194         switch (state) {
195         case AST_DEVICE_UNKNOWN:
196                 break;
197         case AST_DEVICE_NOT_INUSE:
198                 res = "NOT_INUSE";
199                 break;
200         case AST_DEVICE_INUSE:
201                 res = "INUSE";
202                 break;
203         case AST_DEVICE_BUSY:
204                 res = "BUSY";
205                 break;
206         case AST_DEVICE_INVALID:
207                 res = "INVALID";
208                 break;
209         case AST_DEVICE_UNAVAILABLE:
210                 res = "UNAVAILABLE";
211                 break;
212         case AST_DEVICE_RINGING:
213                 res = "RINGING";
214                 break;
215         case AST_DEVICE_RINGINUSE:
216                 res = "RINGINUSE";
217                 break;
218         case AST_DEVICE_ONHOLD:
219                 res = "ONHOLD";
220                 break;
221         }
222
223         return res;
224 }
225
226 enum ast_device_state ast_devstate_val(const char *val)
227 {
228         if (!strcasecmp(val, "NOT_INUSE"))
229                 return AST_DEVICE_NOT_INUSE;
230         else if (!strcasecmp(val, "INUSE"))
231                 return AST_DEVICE_INUSE;
232         else if (!strcasecmp(val, "BUSY"))
233                 return AST_DEVICE_BUSY;
234         else if (!strcasecmp(val, "INVALID"))
235                 return AST_DEVICE_INVALID;
236         else if (!strcasecmp(val, "UNAVAILABLE"))
237                 return AST_DEVICE_UNAVAILABLE;
238         else if (!strcasecmp(val, "RINGING"))
239                 return AST_DEVICE_RINGING;
240         else if (!strcasecmp(val, "RINGINUSE"))
241                 return AST_DEVICE_RINGINUSE;
242         else if (!strcasecmp(val, "ONHOLD"))
243                 return AST_DEVICE_ONHOLD;
244
245         return AST_DEVICE_UNKNOWN;
246 }
247
248 /*! \brief Find out if device is active in a call or not 
249         \note find channels with the device's name in it
250         This function is only used for channels that does not implement 
251         devicestate natively
252 */
253 enum ast_device_state ast_parse_device_state(const char *device)
254 {
255         struct ast_channel *chan;
256         char match[AST_CHANNEL_NAME];
257         enum ast_device_state res;
258
259         ast_copy_string(match, device, sizeof(match)-1);
260         strcat(match, "-");
261         chan = ast_get_channel_by_name_prefix_locked(match, strlen(match));
262
263         if (!chan)
264                 return AST_DEVICE_UNKNOWN;
265
266         if (chan->_state == AST_STATE_RINGING)
267                 res = AST_DEVICE_RINGING;
268         else
269                 res = AST_DEVICE_INUSE;
270         
271         ast_channel_unlock(chan);
272
273         return res;
274 }
275
276 static enum ast_device_state devstate_cached(const char *device)
277 {
278         enum ast_device_state res = AST_DEVICE_UNKNOWN;
279         struct ast_event *event;
280
281         event = ast_event_get_cached(AST_EVENT_DEVICE_STATE,
282                 AST_EVENT_IE_DEVICE, AST_EVENT_IE_PLTYPE_STR, device,
283                 AST_EVENT_IE_END);
284
285         if (!event)
286                 return res;
287
288         res = ast_event_get_ie_uint(event, AST_EVENT_IE_STATE);
289
290         ast_event_destroy(event);
291
292         return res;
293 }
294
295 /*! \brief Check device state through channel specific function or generic function */
296 enum ast_device_state ast_device_state(const char *device)
297 {
298         char *buf;
299         char *number;
300         const struct ast_channel_tech *chan_tech;
301         enum ast_device_state res;
302         /*! \brief Channel driver that provides device state */
303         char *tech;
304         /*! \brief Another provider of device state */
305         char *provider = NULL;
306
307         /* If the last known state is cached, just return that */
308         res = devstate_cached(device);
309         if (res != AST_DEVICE_UNKNOWN)
310                 return res;
311
312         buf = ast_strdupa(device);
313         tech = strsep(&buf, "/");
314         if (!(number = buf)) {
315                 if (!(provider = strsep(&tech, ":")))
316                         return AST_DEVICE_INVALID;
317                 /* We have a provider */
318                 number = tech;
319                 tech = NULL;
320         }
321
322         if (provider)  {
323                 ast_debug(3, "Checking if I can find provider for \"%s\" - number: %s\n", provider, number);
324                 return getproviderstate(provider, number);
325         }
326
327         ast_debug(4, "No provider found, checking channel drivers for %s - %s\n", tech, number);
328
329         if (!(chan_tech = ast_get_channel_tech(tech)))
330                 return AST_DEVICE_INVALID;
331
332         if (!(chan_tech->devicestate)) /* Does the channel driver support device state notification? */
333                 return ast_parse_device_state(device); /* No, try the generic function */
334
335         res = chan_tech->devicestate(number);
336
337         if (res != AST_DEVICE_UNKNOWN)
338                 return res;
339
340         res = ast_parse_device_state(device);
341
342         if (res == AST_DEVICE_UNKNOWN)
343                 return AST_DEVICE_NOT_INUSE;
344
345         return res;
346 }
347
348 /*! \brief Add device state provider */
349 int ast_devstate_prov_add(const char *label, ast_devstate_prov_cb_type callback)
350 {
351         struct devstate_prov *devprov;
352
353         if (!callback || !(devprov = ast_calloc(1, sizeof(*devprov))))
354                 return -1;
355
356         devprov->callback = callback;
357         ast_copy_string(devprov->label, label, sizeof(devprov->label));
358
359         AST_RWLIST_WRLOCK(&devstate_provs);
360         AST_RWLIST_INSERT_HEAD(&devstate_provs, devprov, list);
361         AST_RWLIST_UNLOCK(&devstate_provs);
362
363         return 0;
364 }
365
366 /*! \brief Remove device state provider */
367 int ast_devstate_prov_del(const char *label)
368 {
369         struct devstate_prov *devcb;
370         int res = -1;
371
372         AST_RWLIST_WRLOCK(&devstate_provs);
373         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&devstate_provs, devcb, list) {
374                 if (!strcasecmp(devcb->label, label)) {
375                         AST_RWLIST_REMOVE_CURRENT(list);
376                         ast_free(devcb);
377                         res = 0;
378                         break;
379                 }
380         }
381         AST_RWLIST_TRAVERSE_SAFE_END;
382         AST_RWLIST_UNLOCK(&devstate_provs);
383
384         return res;
385 }
386
387 /*! \brief Get provider device state */
388 static int getproviderstate(const char *provider, const char *address)
389 {
390         struct devstate_prov *devprov;
391         int res = AST_DEVICE_INVALID;
392
393
394         AST_RWLIST_RDLOCK(&devstate_provs);
395         AST_RWLIST_TRAVERSE(&devstate_provs, devprov, list) {
396                 ast_debug(5, "Checking provider %s with %s\n", devprov->label, provider);
397
398                 if (!strcasecmp(devprov->label, provider)) {
399                         res = devprov->callback(address);
400                         break;
401                 }
402         }
403         AST_RWLIST_UNLOCK(&devstate_provs);
404         return res;
405 }
406
407 static void devstate_event(const char *device, enum ast_device_state state, enum devstate_cache cache)
408 {
409         struct ast_event *event;
410
411         if (!(event = ast_event_new(AST_EVENT_DEVICE_STATE,
412                         AST_EVENT_IE_DEVICE, AST_EVENT_IE_PLTYPE_STR, device,
413                         AST_EVENT_IE_STATE, AST_EVENT_IE_PLTYPE_UINT, state,
414                         AST_EVENT_IE_END))) {
415                 return;
416         }
417
418         if (cache == CACHE_ON) {
419                 /* Cache this event, replacing an event in the cache with the same
420                  * device name if it exists. */
421                 ast_event_queue_and_cache(event,
422                         AST_EVENT_IE_DEVICE, AST_EVENT_IE_PLTYPE_STR,
423                         AST_EVENT_IE_END);
424         } else {
425                 ast_event_queue(event);
426         }
427 }
428
429 /*! Called by the state change thread to find out what the state is, and then
430  *  to queue up the state change event */
431 static void do_state_change(const char *device)
432 {
433         enum ast_device_state state;
434
435         state = ast_device_state(device);
436
437         ast_debug(3, "Changing state for %s - state %d (%s)\n", device, state, devstate2str(state));
438
439         devstate_event(device, state, CACHE_OFF);
440 }
441
442 static int __ast_devstate_changed_literal(enum ast_device_state state, char *buf)
443 {
444         char *device;
445         struct state_change *change;
446         char *tmp = NULL;
447
448         ast_debug(3, "Notification of state change to be queued on device/channel %s\n", buf);
449
450         device = buf;
451
452         tmp = strrchr(device, '-');
453         if (tmp)
454                 *tmp = '\0';
455
456         if (state != AST_DEVICE_UNKNOWN) {
457                 devstate_event(device, state, CACHE_ON);
458         } else if (change_thread == AST_PTHREADT_NULL || !(change = ast_calloc(1, sizeof(*change) + strlen(device)))) {
459                 /* we could not allocate a change struct, or */
460                 /* there is no background thread, so process the change now */
461                 do_state_change(device);
462         } else {
463                 /* queue the change */
464                 strcpy(change->device, device);
465                 AST_LIST_LOCK(&state_changes);
466                 AST_LIST_INSERT_TAIL(&state_changes, change, list);
467                 ast_cond_signal(&change_pending);
468                 AST_LIST_UNLOCK(&state_changes);
469         }
470
471         return 1;
472 }
473
474 int ast_devstate_changed_literal(enum ast_device_state state, const char *dev)
475 {
476         char *buf;
477
478         buf = ast_strdupa(dev);
479
480         return __ast_devstate_changed_literal(state, buf);
481 }
482
483 int ast_device_state_changed_literal(const char *dev)
484 {
485         char *buf;
486
487         buf = ast_strdupa(dev);
488
489         return __ast_devstate_changed_literal(AST_DEVICE_UNKNOWN, buf);
490 }
491
492 int ast_devstate_changed(enum ast_device_state state, const char *fmt, ...) 
493 {
494         char buf[AST_MAX_EXTENSION];
495         va_list ap;
496
497         va_start(ap, fmt);
498         vsnprintf(buf, sizeof(buf), fmt, ap);
499         va_end(ap);
500
501         return __ast_devstate_changed_literal(state, buf);
502 }
503
504 /*! \brief Accept change notification, add it to change queue */
505 int ast_device_state_changed(const char *fmt, ...) 
506 {
507         char buf[AST_MAX_EXTENSION];
508         va_list ap;
509
510         va_start(ap, fmt);
511         vsnprintf(buf, sizeof(buf), fmt, ap);
512         va_end(ap);
513
514         return __ast_devstate_changed_literal(AST_DEVICE_UNKNOWN, buf);
515 }
516
517 /*! \brief Go through the dev state change queue and update changes in the dev state thread */
518 static void *do_devstate_changes(void *data)
519 {
520         struct state_change *next, *current;
521
522         for (;;) {
523                 /* This basically pops off any state change entries, resets the list back to NULL, unlocks, and processes each state change */
524                 AST_LIST_LOCK(&state_changes);
525                 if (AST_LIST_EMPTY(&state_changes))
526                         ast_cond_wait(&change_pending, &state_changes.lock);
527                 next = AST_LIST_FIRST(&state_changes);
528                 AST_LIST_HEAD_INIT_NOLOCK(&state_changes);
529                 AST_LIST_UNLOCK(&state_changes);
530
531                 /* Process each state change */
532                 while ((current = next)) {
533                         next = AST_LIST_NEXT(current, list);
534                         do_state_change(current->device);
535                         ast_free(current);
536                 }
537         }
538
539         return NULL;
540 }
541
542 /*! \brief Initialize the device state engine in separate thread */
543 int ast_device_state_engine_init(void)
544 {
545         ast_cond_init(&change_pending, NULL);
546         if (ast_pthread_create_background(&change_thread, NULL, do_devstate_changes, NULL) < 0) {
547                 ast_log(LOG_ERROR, "Unable to start device state change thread.\n");
548                 return -1;
549         }
550
551         return 0;
552 }