Mostly cleanup of documentation to substitute the pipe with the comma, but a few...
[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 /* There might be a realloc() out there that doesn't like reallocing
64  * NULL pointers, so we take care of it here
65  */
66 static void *myrealloc(void *ptr, size_t size)
67 {
68         return (ptr ? ast_realloc(ptr, size) : 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         if ((mem->memory = (char *)myrealloc(mem->memory, mem->size + realsize + 1))) {
77                 memcpy(&(mem->memory[mem->size]), ptr, realsize);
78                 mem->size += realsize;
79                 mem->memory[mem->size] = 0;
80         }
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 MemoryStruct chunk = { NULL, 0 };
137         AST_DECLARE_APP_ARGS(args,
138                 AST_APP_ARG(url);
139                 AST_APP_ARG(postdata);
140         );
141
142         *buf = '\0';
143         
144         if (ast_strlen_zero(info)) {
145                 ast_log(LOG_WARNING, "CURL requires an argument (URL)\n");
146                 return -1;
147         }
148
149         AST_STANDARD_APP_ARGS(args, info);      
150
151         if (!curl_internal(&chunk, args.url, args.postdata)) {
152                 if (chunk.memory) {
153                         chunk.memory[chunk.size] = '\0';
154                         if (chunk.memory[chunk.size - 1] == 10)
155                                 chunk.memory[chunk.size - 1] = '\0';
156
157                         ast_copy_string(buf, chunk.memory, len);
158                         ast_free(chunk.memory);
159                 }
160         } else {
161                 ast_log(LOG_ERROR, "Cannot allocate curl structure\n");
162         }
163
164         return 0;
165 }
166
167 struct ast_custom_function acf_curl = {
168         .name = "CURL",
169         .synopsis = "Retrieves the contents of a URL",
170         .syntax = "CURL(url[,post-data])",
171         .desc =
172         "  url       - URL to retrieve\n"
173         "  post-data - Optional data to send as a POST (GET is default action)\n",
174         .read = acf_curl_exec,
175 };
176
177 static int unload_module(void)
178 {
179         int res;
180
181         res = ast_custom_function_unregister(&acf_curl);
182
183         curl_global_cleanup();
184         
185         return res;
186 }
187
188 static int load_module(void)
189 {
190         int res;
191
192         if (curl_global_init(CURL_GLOBAL_ALL)) {
193                 ast_log(LOG_ERROR, "Unable to initialize the CURL library. Cannot load func_curl\n");
194                 return AST_MODULE_LOAD_DECLINE;
195         }       
196
197         res = ast_custom_function_register(&acf_curl);
198
199         return res;
200 }
201
202 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Load external URL");
203