For my next trick I will make it so dialplan functions no longer need to call ast_mod...
[asterisk/asterisk.git] / funcs / func_curl.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C)  2004 - 2006, Tilghman Lesher
5  *
6  * Tilghman Lesher <curl-20050919@the-tilghman.com>
7  * and Brian Wilkins <bwilkins@cfl.rr.com> (Added POST option)
8  *
9  * app_curl.c is distributed with no restrictions on usage or
10  * redistribution.
11  *
12  * See http://www.asterisk.org for more information about
13  * the Asterisk project. Please do not directly contact
14  * any of the maintainers of this project for assistance;
15  * the project provides a web site, mailing lists and IRC
16  * channels for your use.
17  *
18  */
19
20 /*! \file
21  * 
22  * \brief Curl - Load a URL
23  *
24  * \author Tilghman Lesher <curl-20050919@the-tilghman.com>
25  *
26  * \note Brian Wilkins <bwilkins@cfl.rr.com> (Added POST option) 
27  *
28  * \extref Depends on the CURL library  - http://curl.haxx.se/
29  * 
30  * \ingroup functions
31  */
32  
33 /*** MODULEINFO
34         <depend>curl</depend>
35  ***/
36
37 #include "asterisk.h"
38
39 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
40
41 #include <stdio.h>
42 #include <stdlib.h>
43 #include <string.h>
44 #include <curl/curl.h>
45
46 #include "asterisk/lock.h"
47 #include "asterisk/file.h"
48 #include "asterisk/logger.h"
49 #include "asterisk/channel.h"
50 #include "asterisk/pbx.h"
51 #include "asterisk/cli.h"
52 #include "asterisk/options.h"
53 #include "asterisk/module.h"
54 #include "asterisk/app.h"
55 #include "asterisk/utils.h"
56 #include "asterisk/threadstorage.h"
57
58 struct MemoryStruct {
59         char *memory;
60         size_t size;
61 };
62
63 static void *myrealloc(void *ptr, size_t size)
64 {
65         /* There might be a realloc() out there that doesn't like reallocing
66            NULL pointers, so we take care of it here */
67         if (ptr)
68                 return ast_realloc(ptr, size);
69         else
70                 return ast_malloc(size);
71 }
72
73 static size_t WriteMemoryCallback(void *ptr, size_t size, size_t nmemb, void *data)
74 {
75         register int realsize = size * nmemb;
76         struct MemoryStruct *mem = (struct MemoryStruct *)data;
77
78         mem->memory = (char *)myrealloc(mem->memory, mem->size + realsize + 1);
79         if (mem->memory) {
80                 memcpy(&(mem->memory[mem->size]), ptr, realsize);
81                 mem->size += realsize;
82                 mem->memory[mem->size] = 0;
83         }
84         return realsize;
85 }
86
87 static const char *global_useragent = "asterisk-libcurl-agent/1.0";
88
89 static int curl_instance_init(void *data)
90 {
91         CURL **curl = data;
92
93         if (!(*curl = curl_easy_init()))
94                 return -1;
95
96         curl_easy_setopt(*curl, CURLOPT_NOSIGNAL, 1);
97         curl_easy_setopt(*curl, CURLOPT_TIMEOUT, 180);
98         curl_easy_setopt(*curl, CURLOPT_WRITEFUNCTION, WriteMemoryCallback);
99         curl_easy_setopt(*curl, CURLOPT_USERAGENT, global_useragent);
100
101         return 0;
102 }
103
104 static void curl_instance_cleanup(void *data)
105 {
106         CURL **curl = data;
107
108         curl_easy_cleanup(*curl);
109 }
110
111 AST_THREADSTORAGE_CUSTOM(curl_instance, curl_instance_init, curl_instance_cleanup);
112
113 static int curl_internal(struct MemoryStruct *chunk, char *url, char *post)
114 {
115         CURL **curl;
116
117         if (!(curl = ast_threadstorage_get(&curl_instance, sizeof(*curl))))
118                 return -1;
119
120         curl_easy_setopt(*curl, CURLOPT_URL, url);
121         curl_easy_setopt(*curl, CURLOPT_WRITEDATA, (void *) chunk);
122
123         if (post) {
124                 curl_easy_setopt(*curl, CURLOPT_POST, 1);
125                 curl_easy_setopt(*curl, CURLOPT_POSTFIELDS, post);
126         }
127
128         curl_easy_perform(*curl);
129
130         if (post)
131                 curl_easy_setopt(*curl, CURLOPT_POST, 0);
132
133         return 0;
134 }
135
136 static int acf_curl_exec(struct ast_channel *chan, const char *cmd, char *info, char *buf, size_t len)
137 {
138         struct MemoryStruct chunk = { NULL, 0 };
139         AST_DECLARE_APP_ARGS(args,
140                 AST_APP_ARG(url);
141                 AST_APP_ARG(postdata);
142         );
143
144         *buf = '\0';
145         
146         if (ast_strlen_zero(info)) {
147                 ast_log(LOG_WARNING, "CURL requires an argument (URL)\n");
148                 return -1;
149         }
150
151         AST_STANDARD_APP_ARGS(args, info);      
152
153         if (!curl_internal(&chunk, args.url, args.postdata)) {
154                 if (chunk.memory) {
155                         chunk.memory[chunk.size] = '\0';
156                         if (chunk.memory[chunk.size - 1] == 10)
157                                 chunk.memory[chunk.size - 1] = '\0';
158
159                         ast_copy_string(buf, chunk.memory, len);
160                         ast_free(chunk.memory);
161                 }
162         } else {
163                 ast_log(LOG_ERROR, "Cannot allocate curl structure\n");
164         }
165
166         return 0;
167 }
168
169 struct ast_custom_function acf_curl = {
170         .name = "CURL",
171         .synopsis = "Retrieves the contents of a URL",
172         .syntax = "CURL(url[|post-data])",
173         .desc =
174         "  url       - URL to retrieve\n"
175         "  post-data - Optional data to send as a POST (GET is default action)\n",
176         .read = acf_curl_exec,
177 };
178
179 static int unload_module(void)
180 {
181         int res;
182
183         res = ast_custom_function_unregister(&acf_curl);
184
185         curl_global_cleanup();
186         
187         return res;
188 }
189
190 static int load_module(void)
191 {
192         int res;
193
194         if (curl_global_init(CURL_GLOBAL_ALL)) {
195                 ast_log(LOG_ERROR, "Unable to initialize the CURL library. Cannot load func_curl\n");
196                 return AST_MODULE_LOAD_DECLINE;
197         }       
198
199         res = ast_custom_function_register(&acf_curl);
200
201         return res;
202 }
203
204 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Load external URL");
205