Wed Jan 8 2020 09:50:13

Asterisk developer's documentation


func_uri.c File Reference

URI encoding / decoding. More...

#include "asterisk.h"
#include "asterisk/module.h"
#include "asterisk/channel.h"
#include "asterisk/pbx.h"
#include "asterisk/utils.h"
#include "asterisk/app.h"

Go to the source code of this file.

Functions

static void __reg_module (void)
 
static void __unreg_module (void)
 
static int load_module (void)
 
static int unload_module (void)
 
static int uridecode (struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
 uridecode: Decode URI according to RFC 2396 More...
 
static int uriencode (struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
 uriencode: Encode URL according to RFC 2396 More...
 

Variables

static struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "URI encode/decode dialplan functions" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = "ac1f6a56484a8820659555499174e588" , .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, }
 
static struct ast_module_infoast_module_info = &__mod_info
 
static struct ast_custom_function urldecode_function
 
static struct ast_custom_function urlencode_function
 

Detailed Description

URI encoding / decoding.

Author
Olle E. Johansson oej@e.nosp@m.dvin.nosp@m.a.net
Note
For now this code only supports 8 bit characters, not unicode, which we ultimately will need to support.

Definition in file func_uri.c.

Function Documentation

static void __reg_module ( void  )
static

Definition at line 125 of file func_uri.c.

static void __unreg_module ( void  )
static

Definition at line 125 of file func_uri.c.

static int load_module ( void  )
static

Definition at line 119 of file func_uri.c.

References ast_custom_function_register.

120 {
123 }
static struct ast_custom_function urldecode_function
Definition: func_uri.c:103
static struct ast_custom_function urlencode_function
Definition: func_uri.c:108
#define ast_custom_function_register(acf)
Register a custom function.
Definition: pbx.h:1164
static int unload_module ( void  )
static

Definition at line 113 of file func_uri.c.

References ast_custom_function_unregister().

114 {
117 }
int ast_custom_function_unregister(struct ast_custom_function *acf)
Unregister a custom function.
Definition: pbx.c:3814
static struct ast_custom_function urldecode_function
Definition: func_uri.c:103
static struct ast_custom_function urlencode_function
Definition: func_uri.c:108
static int uridecode ( struct ast_channel chan,
const char *  cmd,
char *  data,
char *  buf,
size_t  len 
)
static

uridecode: Decode URI according to RFC 2396

Definition at line 89 of file func_uri.c.

References ast_copy_string(), ast_strlen_zero(), and ast_uri_decode().

91 {
92  if (ast_strlen_zero(data)) {
93  buf[0] = '\0';
94  return 0;
95  }
96 
97  ast_copy_string(buf, data, len);
98  ast_uri_decode(buf);
99 
100  return 0;
101 }
void ast_uri_decode(char *s)
Decode URI, URN, URL (overwrite string)
Definition: utils.c:484
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition: strings.h:63
static int len(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t buflen)
void ast_copy_string(char *dst, const char *src, size_t size)
Size-limited null-terminating string copy.
Definition: strings.h:223
static int uriencode ( struct ast_channel chan,
const char *  cmd,
char *  data,
char *  buf,
size_t  len 
)
static

uriencode: Encode URL according to RFC 2396

Definition at line 75 of file func_uri.c.

References ast_strlen_zero(), and ast_uri_encode().

77 {
78  if (ast_strlen_zero(data)) {
79  buf[0] = '\0';
80  return 0;
81  }
82 
83  ast_uri_encode(data, buf, len, 1);
84 
85  return 0;
86 }
char * ast_uri_encode(const char *string, char *outbuf, int buflen, int do_special_char)
Turn text string to URI-encoded XX version.
Definition: utils.c:398
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition: strings.h:63
static int len(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t buflen)

Variable Documentation

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "URI encode/decode dialplan functions" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = "ac1f6a56484a8820659555499174e588" , .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, }
static

Definition at line 125 of file func_uri.c.

Definition at line 125 of file func_uri.c.

struct ast_custom_function urldecode_function
static
Initial value:
= {
.name = "URIDECODE",
.read = uridecode,
}
static int uridecode(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
uridecode: Decode URI according to RFC 2396
Definition: func_uri.c:89

Definition at line 103 of file func_uri.c.

struct ast_custom_function urlencode_function
static
Initial value:
= {
.name = "URIENCODE",
.read = uriencode,
}
static int uriencode(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
uriencode: Encode URL according to RFC 2396
Definition: func_uri.c:75

Definition at line 108 of file func_uri.c.