Blocked revisions 53878 via svnmerge
[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  * \ingroup functions
29  */
30  
31 /*** MODULEINFO
32         <depend>curl</depend>
33  ***/
34
35 #include "asterisk.h"
36
37 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
38
39 #include <stdio.h>
40 #include <stdlib.h>
41 #include <string.h>
42 #include <curl/curl.h>
43
44 #include "asterisk/lock.h"
45 #include "asterisk/file.h"
46 #include "asterisk/logger.h"
47 #include "asterisk/channel.h"
48 #include "asterisk/pbx.h"
49 #include "asterisk/cli.h"
50 #include "asterisk/options.h"
51 #include "asterisk/module.h"
52 #include "asterisk/app.h"
53 #include "asterisk/utils.h"
54 #include "asterisk/threadstorage.h"
55
56 struct MemoryStruct {
57         char *memory;
58         size_t size;
59 };
60
61 static void *myrealloc(void *ptr, size_t size)
62 {
63         /* There might be a realloc() out there that doesn't like reallocing
64            NULL pointers, so we take care of it here */
65         if (ptr)
66                 return ast_realloc(ptr, size);
67         else
68                 return ast_malloc(size);
69 }
70
71 static size_t WriteMemoryCallback(void *ptr, size_t size, size_t nmemb, void *data)
72 {
73         register int realsize = size * nmemb;
74         struct MemoryStruct *mem = (struct MemoryStruct *)data;
75
76         mem->memory = (char *)myrealloc(mem->memory, mem->size + realsize + 1);
77         if (mem->memory) {
78                 memcpy(&(mem->memory[mem->size]), ptr, realsize);
79                 mem->size += realsize;
80                 mem->memory[mem->size] = 0;
81         }
82         return realsize;
83 }
84
85 static const char *global_useragent = "asterisk-libcurl-agent/1.0";
86
87 static int curl_instance_init(void *data)
88 {
89         CURL **curl = data;
90
91         if (!(*curl = curl_easy_init()))
92                 return -1;
93
94         curl_easy_setopt(*curl, CURLOPT_NOSIGNAL, 1);
95         curl_easy_setopt(*curl, CURLOPT_TIMEOUT, 180);
96         curl_easy_setopt(*curl, CURLOPT_WRITEFUNCTION, WriteMemoryCallback);
97         curl_easy_setopt(*curl, CURLOPT_USERAGENT, global_useragent);
98
99         return 0;
100 }
101
102 static void curl_instance_cleanup(void *data)
103 {
104         CURL **curl = data;
105
106         curl_easy_cleanup(*curl);
107 }
108
109 AST_THREADSTORAGE_CUSTOM(curl_instance, curl_instance_init, curl_instance_cleanup);
110
111 static int curl_internal(struct MemoryStruct *chunk, char *url, char *post)
112 {
113         CURL **curl;
114
115         if (!(curl = ast_threadstorage_get(&curl_instance, sizeof(*curl))))
116                 return -1;
117
118         curl_easy_setopt(*curl, CURLOPT_URL, url);
119         curl_easy_setopt(*curl, CURLOPT_WRITEDATA, (void *) chunk);
120
121         if (post) {
122                 curl_easy_setopt(*curl, CURLOPT_POST, 1);
123                 curl_easy_setopt(*curl, CURLOPT_POSTFIELDS, post);
124         }
125
126         curl_easy_perform(*curl);
127
128         if (post)
129                 curl_easy_setopt(*curl, CURLOPT_POST, 0);
130
131         return 0;
132 }
133
134 static int acf_curl_exec(struct ast_channel *chan, const char *cmd, char *info, char *buf, size_t len)
135 {
136         struct ast_module_user *u;
137         struct MemoryStruct chunk = { NULL, 0 };
138         AST_DECLARE_APP_ARGS(args,
139                 AST_APP_ARG(url);
140                 AST_APP_ARG(postdata);
141         );
142
143         *buf = '\0';
144         
145         if (ast_strlen_zero(info)) {
146                 ast_log(LOG_WARNING, "CURL requires an argument (URL)\n");
147                 return -1;
148         }
149
150         u = ast_module_user_add(chan);
151
152         AST_STANDARD_APP_ARGS(args, info);      
153
154         if (!curl_internal(&chunk, args.url, args.postdata)) {
155                 if (chunk.memory) {
156                         chunk.memory[chunk.size] = '\0';
157                         if (chunk.memory[chunk.size - 1] == 10)
158                                 chunk.memory[chunk.size - 1] = '\0';
159
160                         ast_copy_string(buf, chunk.memory, len);
161                         free(chunk.memory);
162                 }
163         } else {
164                 ast_log(LOG_ERROR, "Cannot allocate curl structure\n");
165         }
166
167         ast_module_user_remove(u);
168
169         return 0;
170 }
171
172 struct ast_custom_function acf_curl = {
173         .name = "CURL",
174         .synopsis = "Retrieves the contents of a URL",
175         .syntax = "CURL(url[|post-data])",
176         .desc =
177         "  url       - URL to retrieve\n"
178         "  post-data - Optional data to send as a POST (GET is default action)\n",
179         .read = acf_curl_exec,
180 };
181
182 static int unload_module(void)
183 {
184         int res;
185
186         res = ast_custom_function_unregister(&acf_curl);
187
188         ast_module_user_hangup_all();
189
190         curl_global_cleanup();
191         
192         return res;
193 }
194
195 static int load_module(void)
196 {
197         int res;
198
199         if (curl_global_init(CURL_GLOBAL_ALL)) {
200                 ast_log(LOG_ERROR, "Unable to initialize the CURL library. Cannot load func_curl\n");
201                 return AST_MODULE_LOAD_DECLINE;
202         }       
203
204         res = ast_custom_function_register(&acf_curl);
205
206         return res;
207 }
208
209 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Load external URL");
210