Newer
Older
Russell Bryant
committed
/*
* Asterisk -- An open source telephony toolkit.
*
* Copyright (C) 2007, Digium, Inc.
*
* Russell Bryant <russell@digium.com>
*
* See http://www.asterisk.org for more information about
* the Asterisk project. Please do not directly contact
* any of the maintainers of this project for assistance;
* the project provides a web site, mailing lists and IRC
* channels for your use.
*
* This program is free software, distributed under the terms of
* the GNU General Public License Version 2. See the LICENSE file
* at the top of the source tree.
*/
/*! \file
*
* \brief Manually controlled blinky lights
*
* \author Russell Bryant <russell@digium.com>
*
* \ingroup functions
*
* \note Props go out to Ahrimanes in \#asterisk for requesting this at 4:30 AM
Russell Bryant
committed
* when I couldn't sleep. :)
*/
#include "asterisk.h"
ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
#include <stdlib.h>
#include "asterisk/module.h"
#include "asterisk/channel.h"
#include "asterisk/pbx.h"
#include "asterisk/utils.h"
#include "asterisk/linkedlists.h"
#include "asterisk/devicestate.h"
#include "asterisk/cli.h"
Russell Bryant
committed
#include "asterisk/astdb.h"
Russell Bryant
committed
Russell Bryant
committed
static const char astdb_family[] = "CustomDevstate";
Russell Bryant
committed
static int devstate_read(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
{
ast_copy_string(buf, ast_devstate_str(ast_device_state(data)), len);
return 0;
}
static int devstate_write(struct ast_channel *chan, const char *cmd, char *data, const char *value)
{
Russell Bryant
committed
size_t len = strlen("Custom:");
Russell Bryant
committed
if (strncasecmp(data, "Custom:", len)) {
ast_log(LOG_WARNING, "The DEVSTATE function can only be used to set 'Custom:' device state!\n");
return -1;
}
data += len;
if (ast_strlen_zero(data)) {
ast_log(LOG_WARNING, "DEVSTATE function called with no custom device name!\n");
return -1;
}
Russell Bryant
committed
ast_db_put(astdb_family, data, value);
ast_devstate_changed(ast_devstate_val(value), "Custom:%s", data);
Russell Bryant
committed
return 0;
}
static enum ast_device_state custom_devstate_callback(const char *data)
{
Russell Bryant
committed
char buf[256] = "";
Russell Bryant
committed
Russell Bryant
committed
ast_db_get(astdb_family, data, buf, sizeof(buf));
return ast_devstate_val(buf);
Russell Bryant
committed
}
static char *cli_funcdevstate_list(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
{
Russell Bryant
committed
struct ast_db_entry *db_entry, *db_tree;
Russell Bryant
committed
switch (cmd) {
case CLI_INIT:
e->command = "funcdevstate list";
e->usage =
"Usage: funcdevstate list\n"
" List all custom device states that have been set by using\n"
" the DEVSTATE dialplan function.\n";
return NULL;
case CLI_GENERATE:
return NULL;
}
if (a->argc != e->args)
return CLI_SHOWUSAGE;
ast_cli(a->fd, "\n"
"---------------------------------------------------------------------\n"
"--- Custom Device States --------------------------------------------\n"
"---------------------------------------------------------------------\n"
"---\n");
Russell Bryant
committed
db_entry = db_tree = ast_db_gettree(astdb_family, NULL);
for (; db_entry; db_entry = db_entry->next) {
const char *dev_name = strrchr(db_entry->key, '/') + 1;
if (dev_name <= (const char *) 1)
continue;
Russell Bryant
committed
ast_cli(a->fd, "--- Name: 'Custom:%s' State: '%s'\n"
Russell Bryant
committed
"---\n", dev_name, db_entry->data);
Russell Bryant
committed
}
Russell Bryant
committed
ast_db_freetree(db_tree);
db_tree = NULL;
Russell Bryant
committed
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
ast_cli(a->fd,
"---------------------------------------------------------------------\n"
"---------------------------------------------------------------------\n"
"\n");
return CLI_SUCCESS;
}
static struct ast_cli_entry cli_funcdevstate[] = {
NEW_CLI(cli_funcdevstate_list, "List currently known custom device states"),
};
static struct ast_custom_function devstate_function = {
.name = "DEVSTATE",
.synopsis = "Get or Set a device state",
.syntax = "DEVSTATE(device)",
.desc =
" The DEVSTATE function can be used to retrieve the device state from any\n"
"device state provider. For example:\n"
" NoOp(SIP/mypeer has state ${DEVSTATE(SIP/mypeer)})\n"
" NoOp(Conference number 1234 has state ${DEVSTATE(MeetMe:1234)})\n"
"\n"
" The DEVSTATE function can also be used to set custom device state from\n"
"the dialplan. The \"Custom:\" prefix must be used. For example:\n"
" Set(DEVSTATE(Custom:lamp1)=BUSY)\n"
" Set(DEVSTATE(Custom:lamp2)=NOT_INUSE)\n"
"You can subscribe to the status of a custom device state using a hint in\n"
"the dialplan:\n"
" exten => 1234,hint,Custom:lamp1\n"
"\n"
" The possible values for both uses of this function are:\n"
"UNKNOWN | NOT_INUSE | INUSE | BUSY | INVALID | UNAVAILABLE | RINGING\n"
"RINGINUSE | ONHOLD\n",
.read = devstate_read,
.write = devstate_write,
};
static int unload_module(void)
{
int res = 0;
res |= ast_custom_function_unregister(&devstate_function);
res |= ast_devstate_prov_del("Custom");
res |= ast_cli_unregister_multiple(cli_funcdevstate, ARRAY_LEN(cli_funcdevstate));
return res;
}
static int load_module(void)
{
int res = 0;
Russell Bryant
committed
struct ast_db_entry *db_entry, *db_tree;
/* Populate the device state cache on the system with all of the currently
* known custom device states. */
db_entry = db_tree = ast_db_gettree(astdb_family, NULL);
for (; db_entry; db_entry = db_entry->next) {
const char *dev_name = strrchr(db_entry->key, '/') + 1;
if (dev_name <= (const char *) 1)
continue;
ast_devstate_changed(ast_devstate_val(db_entry->data),
"Custom:%s\n", dev_name);
}
ast_db_freetree(db_tree);
db_tree = NULL;
Russell Bryant
committed
res |= ast_custom_function_register(&devstate_function);
res |= ast_devstate_prov_add("Custom", custom_devstate_callback);
res |= ast_cli_register_multiple(cli_funcdevstate, ARRAY_LEN(cli_funcdevstate));
return res;
}
AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Gets or sets a device state in the dialplan");