It is no longer required for each module that deals with a channel to call ast_module...
[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 "asterisk.h"
28
29 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
30
31 #include <stdio.h>
32 #include <stdlib.h>
33 #include <unistd.h>
34 #include <string.h>
35 #include <sys/types.h>
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/app.h"
47
48 static int function_realtime_read(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len) 
49 {
50         struct ast_variable *var, *head;
51         struct ast_module_user *u;
52         struct ast_str *out;
53         size_t resultslen;
54         int n;
55         AST_DECLARE_APP_ARGS(args,
56                 AST_APP_ARG(family);
57                 AST_APP_ARG(fieldmatch);
58                 AST_APP_ARG(value);
59                 AST_APP_ARG(delim1);
60                 AST_APP_ARG(delim2);
61         );
62
63         if (ast_strlen_zero(data)) {
64                 ast_log(LOG_WARNING, "Syntax: REALTIME(family|fieldmatch[|value[|delim1[|delim2]]]) - missing argument!\n");
65                 return -1;
66         }
67
68         u = ast_module_user_add(chan);
69
70         AST_STANDARD_APP_ARGS(args, data);
71
72         if (!args.delim1)
73                 args.delim1 = "|";
74         if (!args.delim2)
75                 args.delim2 = "=";
76
77         head = ast_load_realtime_all(args.family, args.fieldmatch, args.value, NULL);
78
79         if (!head) {
80                 ast_module_user_remove(u);
81                 return -1;
82         }
83         resultslen = 0;
84         n = 0;
85         for (var = head; var; n++, var = var->next)
86                 resultslen += strlen(var->name) + strlen(var->value);
87         /* add space for delimiters and final '\0' */
88         resultslen += n * (strlen(args.delim1) + strlen(args.delim2)) + 1;
89
90         out = ast_str_alloca(resultslen);
91         for (var = head; var; var = var->next)
92                 ast_str_append(&out, 0, "%s%s%s%s", var->name, args.delim2, var->value, args.delim1);
93         ast_copy_string(buf, out->str, len);
94
95         ast_module_user_remove(u);
96
97         return 0;
98 }
99
100 static int function_realtime_write(struct ast_channel *chan, const char *cmd, char *data, const char *value)
101 {
102         struct ast_module_user *u;
103         int res = 0;
104         AST_DECLARE_APP_ARGS(args,
105                 AST_APP_ARG(family);
106                 AST_APP_ARG(fieldmatch);
107                 AST_APP_ARG(value);
108                 AST_APP_ARG(field);
109         );
110
111         if (ast_strlen_zero(data)) {
112                 ast_log(LOG_WARNING, "Syntax: REALTIME(family|fieldmatch|value|newcol) - missing argument!\n");
113                 return -1;
114         }
115
116         u = ast_module_user_add(chan);
117
118         AST_STANDARD_APP_ARGS(args, data);
119
120         res = ast_update_realtime(args.family, args.fieldmatch, args.value, args.field, (char *)value, NULL);
121
122         if (res < 0) {
123                 ast_log(LOG_WARNING, "Failed to update. Check the debug log for possible data repository related entries.\n");
124         }
125
126         ast_module_user_remove(u);
127
128         return 0;
129 }
130
131 struct ast_custom_function realtime_function = {
132         .name = "REALTIME",
133         .synopsis = "RealTime Read/Write Functions",
134         .syntax = "REALTIME(family|fieldmatch[|value[|delim1[|delim2]]]) on read\n"
135                   "REALTIME(family|fieldmatch|value|field) on write\n",
136         .desc = "This function will read or write values from/to a RealTime repository.\n"
137                 "REALTIME(....) will read names/values from the repository, and \n"
138                 "REALTIME(....)= will write a new value/field to the repository. On a\n"
139                 "read, this function returns a delimited text string. The name/value \n"
140                 "pairs are delimited by delim1, and the name and value are delimited \n"
141                 "between each other with delim2. The default for delim1 is '|' and   \n"
142                 "the default for delim2 is '='. If there is no match, NULL will be   \n"
143                 "returned by the function. On a write, this function will always     \n"
144                 "return NULL. \n",
145         .read = function_realtime_read,
146         .write = function_realtime_write,
147 };
148
149 static int unload_module(void)
150 {
151         return ast_custom_function_unregister(&realtime_function);
152 }
153
154 static int load_module(void)
155 {
156         return ast_custom_function_register(&realtime_function);
157 }
158
159 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Read/Write values from a RealTime repository");