app_curl.c File Reference

Curl - App to load a URL. More...

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <curl/curl.h>
#include "asterisk.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 dependency graph for app_curl.c:

Go to the source code of this file.

Data Structures
struct	MemoryStruct
Functions
static char *	acf_curl_exec (struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len)
static int	curl_exec (struct ast_channel *chan, void *data)
static int	curl_internal (struct MemoryStruct *chunk, char *url, char *post)
char *	description (void)
	Provides a description of the module.
char *	key ()
	Returns the ASTERISK_GPL_KEY.
int	load_module (void)
	Initialize the module.
static void *	myrealloc (void *ptr, size_t size)
int	unload_module (void)
	Cleanup all module structures, sockets, etc.
int	usecount (void)
	Provides a usecount.
static size_t	WriteMemoryCallback (void *ptr, size_t size, size_t nmemb, void *data)
Variables
struct ast_custom_function	acf_curl
static char *	app = "Curl"
static char *	descrip
	LOCAL_USER_DECL
	STANDARD_LOCAL_USER
static char *	synopsis = "Load an external URL"
static char *	tdesc = "Load external URL"

---

Detailed Description

Curl - App to load a URL.

Definition in file app_curl.c.

---

Function Documentation

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

Definition at line 166 of file app_curl.c.

References ast_log(), ast_strdupa, ast_strlen_zero(), curl_internal(), free, LOCAL_USER_ACF_ADD, LOCAL_USER_REMOVE, LOG_ERROR, LOG_WARNING, MemoryStruct::memory, MemoryStruct::size, and strsep().

{
   struct localuser *u;
   char *info, *post_data=NULL, *url;
   struct MemoryStruct chunk = { NULL, 0 };

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

   LOCAL_USER_ACF_ADD(u);

   info = ast_strdupa(data);
   if (!info) {
      ast_log(LOG_ERROR, "Out of memory\n");
      LOCAL_USER_REMOVE(u);
      return buf;
   }
   
   url = strsep(&info, "|");
   post_data = info;
   
   if (! curl_internal(&chunk, url, post_data)) {
      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);
      }
   } else {
      ast_log(LOG_ERROR, "Cannot allocate curl structure\n");
   }

   LOCAL_USER_REMOVE(u);
   return buf;
}

static int curl_exec	(	struct ast_channel *	chan,
		void *	data
	)			[static]

Definition at line 118 of file app_curl.c.

References ast_log(), ast_strdupa, ast_strlen_zero(), curl_internal(), dep_warning, free, LOCAL_USER_ADD, LOCAL_USER_REMOVE, LOG_ERROR, LOG_WARNING, MemoryStruct::memory, pbx_builtin_setvar_helper(), MemoryStruct::size, and strsep().

Referenced by load_module().

{
   int res = 0;
   struct localuser *u;
   char *info, *post_data=NULL, *url;
   struct MemoryStruct chunk = { NULL, 0 };
   static int dep_warning = 0;
   
   if (!dep_warning) {
      ast_log(LOG_WARNING, "The application Curl is deprecated.  Please use the CURL() function instead.\n");
      dep_warning = 1;
   }

   if (ast_strlen_zero(data)) {
      ast_log(LOG_WARNING, "Curl requires an argument (URL)\n");
      return -1;
   }
   
   LOCAL_USER_ADD(u);
   
   if ((info = ast_strdupa(data))) {
      url = strsep(&info, "|");
      post_data = info;
   } else {
      ast_log(LOG_ERROR, "Out of memory\n");
      LOCAL_USER_REMOVE(u);
      return -1;
   }

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

         pbx_builtin_setvar_helper(chan, "CURL", chunk.memory);

         free(chunk.memory);
      }
   } else {
      ast_log(LOG_ERROR, "Cannot allocate curl structure\n");
      res = -1;
   }

   LOCAL_USER_REMOVE(u);
   return res;
}

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

Definition at line 93 of file app_curl.c.

References WriteMemoryCallback().

Referenced by acf_curl_exec(), and curl_exec().

{
   CURL *curl;

   curl = curl_easy_init();

   if (!curl) {
      return -1;
   }

   curl_easy_setopt(curl, CURLOPT_URL, url);
   curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, WriteMemoryCallback);
   curl_easy_setopt(curl, CURLOPT_WRITEDATA, (void *)chunk);
   curl_easy_setopt(curl, CURLOPT_USERAGENT, "asterisk-libcurl-agent/1.0");

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

   curl_easy_perform(curl);
   curl_easy_cleanup(curl);
   return 0;
}

char* description

(

void

)

Provides a description of the module.

Returns:

a short description of your module

Definition at line 242 of file app_curl.c.

{
   return tdesc;
}

char* key

(

void

)

Returns the ASTERISK_GPL_KEY.

This returns the ASTERISK_GPL_KEY, signifiying that you agree to the terms of the GPL stated in the ASTERISK_GPL_KEY. Your module will not load if it does not return the EXACT message:

 char *key(void) {
         return ASTERISK_GPL_KEY;
 }

Returns:

ASTERISK_GPL_KEY

Definition at line 254 of file app_curl.c.

References ASTERISK_GPL_KEY.

{
   return ASTERISK_GPL_KEY;
}

int load_module

(

void

)

Initialize the module.

This function is called at module load time. Put all code in here that needs to set up your module's hardware, software, registrations, etc.

Returns:

This function should return 0 on success and non-zero on failure. If the module is not loaded successfully, Asterisk will call its unload_module() function.

Initialize the Agents module. This function is being called by Asterisk when loading the module. Among other thing it registers applications, cli commands and reads the cofiguration file.

Returns:

int Always 0.

TE STUFF END

Definition at line 231 of file app_curl.c.

References ast_custom_function_register(), ast_register_application(), and curl_exec().

{
   int res;

   curl_global_init(CURL_GLOBAL_ALL);
   res = ast_custom_function_register(&acf_curl);
   res |= ast_register_application(app, curl_exec, synopsis, descrip);

   return res;
}

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

Definition at line 69 of file app_curl.c.

References malloc, and 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 realloc(ptr, size);
   else
      return malloc(size);
}

int unload_module

(

void

)

Cleanup all module structures, sockets, etc.

This is called at exit. Any registrations and memory allocations need to be unregistered and free'd here. Nothing else will do these for you (until exit).

Returns:

Zero on success, or non-zero on error.

Definition at line 218 of file app_curl.c.

References ast_custom_function_unregister(), ast_unregister_application(), and STANDARD_HANGUP_LOCALUSERS.

{
   int res;

   res = ast_custom_function_unregister(&acf_curl);
   res |= ast_unregister_application(app);

   STANDARD_HANGUP_LOCALUSERS;
   curl_global_cleanup();
   
   return res;
}

int usecount

(

void

)

Provides a usecount.

This function will be called by various parts of asterisk. Basically, all it has to do is to return a usecount when called. You will need to maintain your usecount within the module somewhere. The usecount should be how many channels provided by this module are in use.

Returns:

The module's usecount.

Definition at line 247 of file app_curl.c.

References STANDARD_USECOUNT.

{
   int res;
   STANDARD_USECOUNT(res);
   return res;
}

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

Definition at line 79 of file app_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 208 of file app_curl.c.

char* app = "Curl" [static]

Definition at line 46 of file app_curl.c.

char* descrip [static]

Definition at line 50 of file app_curl.c.

LOCAL_USER_DECL

Definition at line 62 of file app_curl.c.

STANDARD_LOCAL_USER

Definition at line 60 of file app_curl.c.

char* synopsis = "Load an external URL" [static]

Definition at line 48 of file app_curl.c.

char* tdesc = "Load external URL" [static]

Definition at line 44 of file app_curl.c.