Sat Nov 1 06:29:06 2008

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 131 of file func_curl.c.

References AST_APP_ARG, ast_autoservice_start(), ast_autoservice_stop(), 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.

{
   int ret = -1;
   struct ast_module_user *u;
   struct MemoryStruct chunk = { NULL, 0 };
   AST_DECLARE_APP_ARGS(args,
      AST_APP_ARG(url);
      AST_APP_ARG(postdata);
   );

   *buf = '\0';
   
   if (ast_strlen_zero(info)) {
      ast_log(LOG_WARNING, "CURL requires an argument (URL)\n");
      return -1;
   }

   u = ast_module_user_add(chan);

   AST_STANDARD_APP_ARGS(args, info);  

   if (chan)
      ast_autoservice_start(chan);

   if (!curl_internal(&chunk, args.url, args.postdata)) {
      if (chunk.memory) {
         chunk.memory[chunk.size] = '\0';
         if (chunk.memory[chunk.size - 1] == 10)
            chunk.memory[chunk.size - 1] = '\0';

         ast_copy_string(buf, chunk.memory, len);
         free(chunk.memory);
      }
      ret = 0;
   } else {
      ast_log(LOG_ERROR, "Cannot allocate curl structure\n");
   }

   if (chan)
      ast_autoservice_stop(chan);

   ast_module_user_remove(u);

   return ret;
}

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.

References free.

{
   CURL **curl = data;

   curl_easy_cleanup(*curl);

   free(data);
}

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

Definition at line 98 of file func_curl.c.

References WriteMemoryCallback().

Referenced by acf_curl_exec().

{
   int ret;
   CURL **curl;

   if (!(curl = ast_threadstorage_get(&curl_instance, sizeof(*curl))))
      return -1;

   if (!*curl) {
      if (!(*curl = curl_easy_init()))
         return -1;
      curl_easy_setopt(*curl, CURLOPT_NOSIGNAL, 1);
      curl_easy_setopt(*curl, CURLOPT_TIMEOUT, 180);
      curl_easy_setopt(*curl, CURLOPT_WRITEFUNCTION, WriteMemoryCallback);
      curl_easy_setopt(*curl, CURLOPT_USERAGENT, global_useragent);
   }

   curl_easy_setopt(*curl, CURLOPT_URL, url);
   curl_easy_setopt(*curl, CURLOPT_WRITEDATA, (void *) chunk);

   if (post) {
      curl_easy_setopt(*curl, CURLOPT_POST, 1);
      curl_easy_setopt(*curl, CURLOPT_POSTFIELDS, post);
   }

   ret = curl_easy_perform(*curl);

   if (post)
      curl_easy_setopt(*curl, CURLOPT_POST, 0);

   return ret ? -1 : 0;
}

static int load_module

(

void

)

[static]

Definition at line 200 of file func_curl.c.

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

{
   int res;

   if (curl_global_init(CURL_GLOBAL_ALL)) {
      ast_log(LOG_ERROR, "Unable to initialize the CURL library. Cannot load func_curl\n");
      return AST_MODULE_LOAD_DECLINE;
   }  

   res = ast_custom_function_register(&acf_curl);

   return res;
}

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().

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

static int unload_module

(

void

)

[static]

Definition at line 187 of file func_curl.c.

References acf_curl, ast_custom_function_unregister(), and ast_module_user_hangup_all.

{
   int res;

   res = ast_custom_function_unregister(&acf_curl);

   ast_module_user_hangup_all();

   curl_global_cleanup();
   
   return res;
}

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().

{
   register int realsize = size * nmemb;
   struct MemoryStruct *mem = (struct MemoryStruct *)data;

   mem->memory = (char *)myrealloc(mem->memory, mem->size + realsize + 1);
   if (mem->memory) {
      memcpy(&(mem->memory[mem->size]), ptr, realsize);
      mem->size += realsize;
      mem->memory[mem->size] = 0;
   }
   return realsize;
}

---

Variable Documentation

struct ast_custom_function acf_curl

Definition at line 177 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.

---