Deprecate SetGlobalVar, replacing it with a dialplan function
[asterisk/asterisk.git] / funcs / func_global.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2006, Tilghman Lesher
5  *
6  * Tilghman Lesher <func_global__200605@the-tilghman.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 Global variable dialplan functions
22  *
23  * \author Tilghman Lesher <func_global__200605@the-tilghman.com>
24  */
25
26 #include <stdio.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include <sys/types.h>
30 #include <sys/stat.h>
31
32 #include "asterisk.h"
33
34 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
35
36 #include "asterisk/module.h"
37 #include "asterisk/channel.h"
38 #include "asterisk/pbx.h"
39 #include "asterisk/utils.h"
40
41 static int global_read(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len)
42 {
43         const char *var = pbx_builtin_getvar_helper(NULL, data);
44
45         *buf = '\0';
46
47         if (var)
48                 ast_copy_string(buf, var, len);
49
50         return 0;
51 }
52
53 static int global_write(struct ast_channel *chan, char *cmd, char *data, const char *value)
54 {
55         pbx_builtin_setvar_helper(NULL, data, value);
56
57         return 0;
58 }
59
60 static struct ast_custom_function global_function = {
61         .name = "GLOBAL",
62         .synopsis = "Gets or sets the global variable specified",
63         .syntax = "GLOBAL(<varname>)",
64         .read = global_read,
65         .write = global_write,
66 };
67
68 static char *tdesc = "Global variable dialplan functions";
69
70 static int unload_module(void *mod)
71 {
72         int res = 0;
73
74         res |= ast_custom_function_unregister(&global_function);
75
76         return res;
77 }
78
79 static int load_module(void *mod)
80 {
81         int res = 0;
82
83         res |= ast_custom_function_register(&global_function);
84
85         return res;
86 }
87
88 static const char *description(void)
89 {
90         return tdesc;
91 }
92
93
94 static const char *key(void)
95 {
96         return ASTERISK_GPL_KEY;
97 }
98
99 STD_MOD(MOD_1 | NO_USECOUNT, NULL, NULL, NULL);
100 /*
101  * Asterisk -- An open source telephony toolkit.
102  *
103  * Copyright (C) 2006, Tilghman Lesher
104  *
105  * Tilghman Lesher <func_global__200605@the-tilghman.com>
106  *
107  * See http://www.asterisk.org for more information about
108  * the Asterisk project. Please do not directly contact
109  * any of the maintainers of this project for assistance;
110  * the project provides a web site, mailing lists and IRC
111  * channels for your use.
112  *
113  * This program is free software, distributed under the terms of
114  * the GNU General Public License Version 2. See the LICENSE file
115  * at the top of the source tree.
116  */
117
118 /*! \file
119  *
120  * \brief Global variable dialplan functions
121  *
122  * \author Tilghman Lesher <func_global__200605@the-tilghman.com>
123  */
124
125 #include <stdio.h>
126 #include <stdlib.h>
127 #include <string.h>
128 #include <sys/types.h>
129 #include <sys/stat.h>
130
131 #include "asterisk.h"
132
133 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
134
135 #include "asterisk/module.h"
136 #include "asterisk/channel.h"
137 #include "asterisk/pbx.h"
138 #include "asterisk/utils.h"
139
140 static int global_read(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len)
141 {
142         const char *var = pbx_builtin_getvar_helper(NULL, data);
143
144         *buf = '\0';
145
146         if (var)
147                 ast_copy_string(buf, var, len);
148
149         return 0;
150 }
151
152 static int global_write(struct ast_channel *chan, char *cmd, char *data, const char *value)
153 {
154         pbx_builtin_setvar_helper(NULL, data, value);
155
156         return 0;
157 }
158
159 static struct ast_custom_function global_function = {
160         .name = "GLOBAL",
161         .synopsis = "Gets or sets the global variable specified",
162         .syntax = "GLOBAL(<varname>)",
163         .read = global_read,
164         .write = global_write,
165 };
166
167 static char *tdesc = "Global variable dialplan functions";
168
169 static int unload_module(void *mod)
170 {
171         int res = 0;
172
173         res |= ast_custom_function_unregister(&global_function);
174
175         return res;
176 }
177
178 static int load_module(void *mod)
179 {
180         int res = 0;
181
182         res |= ast_custom_function_register(&global_function);
183
184         return res;
185 }
186
187 static const char *description(void)
188 {
189         return tdesc;
190 }
191
192
193 static const char *key(void)
194 {
195         return ASTERISK_GPL_KEY;
196 }
197
198 STD_MOD(MOD_1 | NO_USECOUNT, NULL, NULL, NULL);