Mon May 14 04:48:08 2007

Asterisk developer's documentation


func_curl.c File Reference

Curl - Load a URL. More...

#include "asterisk.h"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <curl/curl.h>
#include "asterisk/lock.h"
#include "asterisk/file.h"
#include "asterisk/logger.h"
#include "asterisk/channel.h"
#include "asterisk/pbx.h"
#include "asterisk/cli.h"
#include "asterisk/options.h"
#include "asterisk/module.h"
#include "asterisk/app.h"
#include "asterisk/utils.h"
#include "asterisk/threadstorage.h"

Include dependency graph for func_curl.c:

Go to the source code of this file.

Data Structures

struct  MemoryStruct

Functions

static int acf_curl_exec (struct ast_channel *chan, char *cmd, char *info, char *buf, size_t len)
 AST_MODULE_INFO_STANDARD (ASTERISK_GPL_KEY,"Load external URL")
 AST_THREADSTORAGE_CUSTOM (curl_instance, curl_instance_init, curl_instance_cleanup)
static void curl_instance_cleanup (void *data)
static int curl_internal (struct MemoryStruct *chunk, char *url, char *post)
static int load_module (void)
static void * myrealloc (void *ptr, size_t size)
static int unload_module (void)
static size_t WriteMemoryCallback (void *ptr, size_t size, size_t nmemb, void *data)

Variables

ast_custom_function acf_curl
static const char * global_useragent = "asterisk-libcurl-agent/1.0"


Detailed Description

Curl - Load a URL.

Author:
Tilghman Lesher <curl-20050919@the-tilghman.com>
Note:
Brian Wilkins <bwilkins@cfl.rr.com> (Added POST option)

Definition in file func_curl.c.


Function Documentation

static int acf_curl_exec ( struct ast_channel chan,
char *  cmd,
char *  info,
char *  buf,
size_t  len 
) [static]

Definition at line 128 of file func_curl.c.

References AST_APP_ARG, AST_DECLARE_APP_ARGS, ast_log(), ast_module_user_add, ast_module_user_remove, AST_STANDARD_APP_ARGS, ast_strlen_zero(), curl_internal(), free, LOG_ERROR, LOG_WARNING, MemoryStruct::memory, and MemoryStruct::size.

00129 {
00130    struct ast_module_user *u;
00131    struct MemoryStruct chunk = { NULL, 0 };
00132    AST_DECLARE_APP_ARGS(args,
00133       AST_APP_ARG(url);
00134       AST_APP_ARG(postdata);
00135    );
00136 
00137    *buf = '\0';
00138    
00139    if (ast_strlen_zero(info)) {
00140       ast_log(LOG_WARNING, "CURL requires an argument (URL)\n");
00141       return -1;
00142    }
00143 
00144    u = ast_module_user_add(chan);
00145 
00146    AST_STANDARD_APP_ARGS(args, info);  
00147 
00148    if (!curl_internal(&chunk, args.url, args.postdata)) {
00149       if (chunk.memory) {
00150          chunk.memory[chunk.size] = '\0';
00151          if (chunk.memory[chunk.size - 1] == 10)
00152             chunk.memory[chunk.size - 1] = '\0';
00153 
00154          ast_copy_string(buf, chunk.memory, len);
00155          free(chunk.memory);
00156       }
00157    } else {
00158       ast_log(LOG_ERROR, "Cannot allocate curl structure\n");
00159    }
00160 
00161    ast_module_user_remove(u);
00162 
00163    return 0;
00164 }

AST_MODULE_INFO_STANDARD ( ASTERISK_GPL_KEY  ,
"Load external URL"   
)

AST_THREADSTORAGE_CUSTOM ( curl_instance  ,
curl_instance_init  ,
curl_instance_cleanup   
)

static void curl_instance_cleanup ( void *  data  )  [static]

Definition at line 87 of file func_curl.c.

00088 {
00089    CURL **curl = data;
00090 
00091    curl_easy_cleanup(*curl);
00092 }

static int curl_internal ( struct MemoryStruct chunk,
char *  url,
char *  post 
) [static]

Definition at line 96 of file func_curl.c.

References WriteMemoryCallback().

Referenced by acf_curl_exec().

00097 {
00098    CURL **curl;
00099 
00100    if (!(curl = ast_threadstorage_get(&curl_instance, sizeof(*curl))))
00101       return -1;
00102 
00103    if (!*curl) {
00104       if (!(*curl = curl_easy_init()))
00105          return -1;
00106       curl_easy_setopt(*curl, CURLOPT_NOSIGNAL, 1);
00107       curl_easy_setopt(*curl, CURLOPT_TIMEOUT, 180);
00108       curl_easy_setopt(*curl, CURLOPT_WRITEFUNCTION, WriteMemoryCallback);
00109       curl_easy_setopt(*curl, CURLOPT_USERAGENT, global_useragent);
00110    }
00111 
00112    curl_easy_setopt(*curl, CURLOPT_URL, url);
00113    curl_easy_setopt(*curl, CURLOPT_WRITEDATA, (void *) chunk);
00114 
00115    if (post) {
00116       curl_easy_setopt(*curl, CURLOPT_POST, 1);
00117       curl_easy_setopt(*curl, CURLOPT_POSTFIELDS, post);
00118    }
00119 
00120    curl_easy_perform(*curl);
00121 
00122    if (post)
00123       curl_easy_setopt(*curl, CURLOPT_POST, 0);
00124 
00125    return 0;
00126 }

static int load_module ( void   )  [static]

Definition at line 189 of file func_curl.c.

References acf_curl, ast_custom_function_register(), ast_log(), AST_MODULE_LOAD_DECLINE, and LOG_ERROR.

00190 {
00191    int res;
00192 
00193    if (curl_global_init(CURL_GLOBAL_ALL)) {
00194       ast_log(LOG_ERROR, "Unable to initialize the CURL library. Cannot load func_curl\n");
00195       return AST_MODULE_LOAD_DECLINE;
00196    }  
00197 
00198    res = ast_custom_function_register(&acf_curl);
00199 
00200    return res;
00201 }

static void* myrealloc ( void *  ptr,
size_t  size 
) [static]

Definition at line 61 of file func_curl.c.

References ast_malloc, and ast_realloc.

Referenced by WriteMemoryCallback().

00062 {
00063    /* There might be a realloc() out there that doesn't like reallocing
00064       NULL pointers, so we take care of it here */
00065    if (ptr)
00066       return ast_realloc(ptr, size);
00067    else
00068       return ast_malloc(size);
00069 }

static int unload_module ( void   )  [static]

Definition at line 176 of file func_curl.c.

References acf_curl, ast_custom_function_unregister(), and ast_module_user_hangup_all.

00177 {
00178    int res;
00179 
00180    res = ast_custom_function_unregister(&acf_curl);
00181 
00182    ast_module_user_hangup_all();
00183 
00184    curl_global_cleanup();
00185    
00186    return res;
00187 }

static size_t WriteMemoryCallback ( void *  ptr,
size_t  size,
size_t  nmemb,
void *  data 
) [static]

Definition at line 71 of file func_curl.c.

References MemoryStruct::memory, myrealloc(), and MemoryStruct::size.

Referenced by curl_internal().

00072 {
00073    register int realsize = size * nmemb;
00074    struct MemoryStruct *mem = (struct MemoryStruct *)data;
00075 
00076    mem->memory = (char *)myrealloc(mem->memory, mem->size + realsize + 1);
00077    if (mem->memory) {
00078       memcpy(&(mem->memory[mem->size]), ptr, realsize);
00079       mem->size += realsize;
00080       mem->memory[mem->size] = 0;
00081    }
00082    return realsize;
00083 }


Variable Documentation

struct ast_custom_function acf_curl

Definition at line 166 of file func_curl.c.

Referenced by load_module(), and unload_module().

const char* global_useragent = "asterisk-libcurl-agent/1.0" [static]

Definition at line 85 of file func_curl.c.


Generated on Mon May 14 04:48:09 2007 for Asterisk - the Open Source PBX by  doxygen 1.5.1