Introducing the REALTIME() dialplan function
[asterisk/asterisk.git] / funcs / func_realtime.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2005-2006, BJ Weschke. All rights reserved.
5  * 
6  * BJ Weschke <bweschke@btwtech.com>
7  * 
8  * This code is released by the author with no restrictions on usage. 
9  *
10  * See http://www.asterisk.org for more information about
11  * the Asterisk project. Please do not directly contact
12  * any of the maintainers of this project for assistance;
13  * the project provides a web site, mailing lists and IRC
14  * channels for your use.
15  *
16  */
17
18 /*! \file
19  *
20  * \brief REALTIME dialplan function
21  * 
22  * \author BJ Weschke <bweschke@btwtech.com>
23  * 
24  * \ingroup functions
25  */
26
27 #include <stdio.h>
28 #include <stdlib.h>
29 #include <unistd.h>
30 #include <string.h>
31 #include <sys/types.h>
32
33 #include "asterisk.h"
34
35 /* ASTERISK_FILE_VERSION(__FILE__, "$Revision$") */
36
37 #include "asterisk/file.h"
38 #include "asterisk/channel.h"
39 #include "asterisk/pbx.h"
40 #include "asterisk/options.h"
41 #include "asterisk/config.h"
42 #include "asterisk/module.h"
43 #include "asterisk/lock.h"
44 #include "asterisk/logger.h"
45 #include "asterisk/utils.h"
46 #include "asterisk/module.h"
47 #include "asterisk/app.h"
48
49 LOCAL_USER_DECL;
50
51 static char *tdesc = "Read/Write values from a RealTime repository";
52
53 static int function_realtime_read(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len) 
54 {
55
56         struct ast_variable *var=NULL,*head=NULL;
57         struct localuser *u;
58         char *results;
59         unsigned int resultslen=0;
60
61         LOCAL_USER_ADD(u);
62
63         AST_DECLARE_APP_ARGS(args,
64                 AST_APP_ARG(family);
65                 AST_APP_ARG(fieldmatch);
66                 AST_APP_ARG(value);
67                 AST_APP_ARG(delim1);
68                 AST_APP_ARG(delim2);
69         );
70
71         if (ast_strlen_zero(data)) {
72                 ast_log(LOG_WARNING, "Syntax: REALTIME(family|fieldmatch[|value[|delim1[|delim2]]]) - missing argument!\n");
73                 LOCAL_USER_REMOVE(u);
74                 return -1;
75         } else
76                 AST_STANDARD_APP_ARGS(args, data);
77
78         if (!args.delim1)
79                 args.delim1 = "|";
80         if (!args.delim2)
81                 args.delim2 = "=";
82
83         var = ast_load_realtime(args.family, args.fieldmatch, args.value, NULL);
84
85         if (var) {
86                 head = var;
87                 while (var) {
88                         resultslen += strlen(var->name) + strlen(var->value) + 2;
89                         var = var->next;
90                 }
91                 var = head;
92                 results = alloca(resultslen);
93                 while (var) {
94                         ast_build_string(&results, &resultslen, "%s%s%s%s", var->name, args.delim2, var->value, args.delim1);
95                         var = var->next;
96                 }       
97         } else {
98                 LOCAL_USER_REMOVE(u);
99                 return -1;
100         }
101         ast_copy_string(buf, results, len);
102
103         LOCAL_USER_REMOVE(u);
104         return 0;
105 }
106
107 static int function_realtime_write(struct ast_channel *chan, char *cmd, char *data, const char *value)
108 {
109         struct localuser *u;
110         int res = 0;
111
112         LOCAL_USER_ADD(u);
113
114         AST_DECLARE_APP_ARGS(args,
115                 AST_APP_ARG(family);
116                 AST_APP_ARG(fieldmatch);
117                 AST_APP_ARG(value);
118                 AST_APP_ARG(field);
119         );
120
121         if (ast_strlen_zero(data)) {
122                 ast_log(LOG_WARNING, "Syntax: REALTIME(family|fieldmatch|value|newcol) - missing argument!\n");
123                 LOCAL_USER_REMOVE(u);
124                 return -1;
125         } else
126                 AST_STANDARD_APP_ARGS(args, data);
127
128         res = ast_update_realtime(args.family, args.fieldmatch, args.value, args.field, (char *)value, NULL);
129
130         if (res < 0) {
131                 ast_log(LOG_WARNING, "Failed to update. Check the debug log for possible data repository related entries.\n");
132         }
133
134         LOCAL_USER_REMOVE(u);
135         return 0;
136 }
137
138 struct ast_custom_function realtime_function = {
139         .name = "REALTIME",
140         .synopsis = "RealTime Read/Write Functions",
141         .syntax = "REALTIME(family|fieldmatch[|value[|delim1[|delim2]]]) on read\n"
142                   "REALTIME(family|fieldmatch|value|field) on write\n",
143         .desc = "This function will read or write values from/to a RealTime repository.\n"
144                 "REALTIME(....) will read names/values from the repository, and \n"
145                 "REALTIME(....)= will write a new value/field to the repository. On a\n"
146                 "read, this function returns a delimited text string. The name/value \n"
147                 "pairs are delimited by delim1, and the name and value are delimited \n"
148                 "between each other with delim2. The default for delim1 is '=' and   \n"
149                 "the default for delim2 is '|'. If there is no match, NULL will be   \n"
150                 "returned by the function. On a write, this function will always     \n"
151                 "return NULL. \n",
152         .read = function_realtime_read,
153         .write = function_realtime_write,
154 };
155
156 static int unload_module(void *mod)
157 {
158         int res = 0;
159
160         res |= ast_custom_function_unregister(&realtime_function);
161
162         STANDARD_HANGUP_LOCALUSERS;
163
164         return res;
165 }
166
167 static int load_module(void *mod)
168 {
169         int res = 0;
170
171         res |= ast_custom_function_register(&realtime_function);
172
173         return res;
174 }
175
176 static const char *description(void)
177 {
178         return tdesc;
179 }
180
181 static const char *key(void)
182 {
183         return ASTERISK_GPL_KEY;
184 }
185
186 STD_MOD(MOD_1, NULL, NULL, NULL);