Might as well go crazy here too and make the autoservice list read/write.
[asterisk/asterisk.git] / funcs / func_shell.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2006, Digium, Inc.
5  *
6  * See http://www.asterisk.org for more information about
7  * the Asterisk project. Please do not directly contact
8  * any of the maintainers of this project for assistance;
9  * the project provides a web site, mailing lists and IRC
10  * channels for your use.
11  *
12  * This program is free software, distributed under the terms of
13  * the GNU General Public License Version 2. See the LICENSE file
14  * at the top of the source tree.
15  */
16
17 /*! \file
18  *
19  * \SHELL function to return the value of a system call.
20  * 
21  * \ Inspiration and Guidance from Russell! Thank You! 
22  *
23  * \author Brandon Kruse <bkruse@digium.com>
24  */
25
26 #include "asterisk.h"
27
28 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
29
30 #include <stdio.h>
31 #include <stdlib.h>
32 #include <string.h>
33 #include <sys/types.h>
34
35 #include "asterisk/module.h"
36 #include "asterisk/channel.h"
37 #include "asterisk/pbx.h"
38 #include "asterisk/logger.h"
39 #include "asterisk/utils.h"
40 #include "asterisk/app.h"
41
42 static int shell_helper(struct ast_channel *chan, const char *cmd, char *data,
43                                          char *buf, size_t len)
44 {
45         if (ast_strlen_zero(data)) {
46                 ast_log(LOG_WARNING, "Missing Argument!  Example:  Set(foo=${SHELL(echo \"bar\")})\n");
47                 return -1;
48         }
49
50         if (len >= 1) {
51                 FILE *ptr;
52                 char plbuff[4096];
53
54                 ptr = popen(data, "r");
55                 while (fgets(plbuff, sizeof(plbuff), ptr)) {
56                         strncat(buf, plbuff, len - strlen(buf) - 1);
57                 }
58                 pclose(ptr);
59         }
60
61         return 0;
62 }
63
64 static struct ast_custom_function shell_function = {
65         .name = "SHELL",
66         .synopsis = "Executes a command as if you were at a shell.",
67         .syntax = "SHELL(<command>)",
68         .read = shell_helper,
69         .desc =
70 "Returns the value from a system command\n"
71 "  Example:  Set(foo=${SHELL(echo \"bar\")})\n"
72 "  Note:  When using the SHELL() dialplan function, your \"SHELL\" is /bin/sh,\n"
73 "  which may differ as to the underlying shell, depending upon your production\n"
74 "  platform.  Also keep in mind that if you are using a common path, you should\n"
75 "  be mindful of race conditions that could result from two calls running\n"
76 "  SHELL() simultaneously.\n",
77 };
78
79 static int unload_module(void)
80 {
81         return ast_custom_function_unregister(&shell_function);
82 }
83
84 static int load_module(void)
85 {
86         return ast_custom_function_register(&shell_function);
87 }
88
89 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "SHELL dialplan function");
90