add dialplan functions for URI encoding/decoding (issue #4857)
[asterisk/asterisk.git] / funcs / func_uri.c
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * URI encoding / decoding
5  * 
6  * For now this code only supports 8 bit characters, not unicode,
7  * which we ultimately will need to support.
8  * 
9  * Copyright (C) 2005, Digium, Inc.
10  * Created by Olle E. Johansson, Edvina.net 
11  *
12  * This program is free software, distributed under the terms of
13  * the GNU General Public License
14  */
15
16 #include <stdlib.h>
17 #include <string.h>
18 #include <sys/types.h>
19
20 #include "asterisk.h"
21
22 /* ASTERISK_FILE_VERSION(__FILE__, "$Revision$") */
23
24 #include "asterisk/channel.h"
25 #include "asterisk/pbx.h"
26 #include "asterisk/logger.h"
27 #include "asterisk/utils.h"
28 #include "asterisk/app.h"
29 #include "asterisk/module.h"
30
31 /*--- builtin_function_uriencode: Encode URL according to RFC 2396 */
32 static char *builtin_function_uriencode(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len) 
33 {
34         char uri[BUFSIZ];
35
36         if (!data || ast_strlen_zero(data)) {
37                 ast_log(LOG_WARNING, "Syntax: URIENCODE(<data>) - missing argument!\n");
38                 return NULL;
39         }
40
41         ast_uri_encode(data, uri, sizeof(uri), 1);
42         ast_copy_string(buf, uri, len);
43
44         return buf;
45 }
46
47 /*--- builtin_function_uridecode: Decode URI according to RFC 2396 */
48 static char *builtin_function_uridecode(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len) 
49 {
50         if (!data || ast_strlen_zero(data)) {
51                 ast_log(LOG_WARNING, "Syntax: URIDECODE(<data>) - missing argument!\n");
52                 return NULL;
53         }
54
55         
56         ast_copy_string(buf, data, len);
57         ast_uri_decode(buf);
58         return buf;
59 }
60
61 #ifndef BUILTIN_FUNC
62 static
63 #endif
64 struct ast_custom_function urldecode_function = {
65         .name = "URIDECODE",
66         .synopsis = "Decodes an URI-encoded string.",
67         .syntax = "URIDECODE(<data>)",
68         .read = builtin_function_uridecode,
69 };
70
71 #ifndef BUILTIN_FUNC
72 static
73 #endif
74 struct ast_custom_function urlencode_function = {
75         .name = "URIENCODE",
76         .synopsis = "Encodes a string to URI-safe encoding.",
77         .syntax = "URIENCODE(<data>)",
78         .read = builtin_function_uriencode,
79 };
80
81 #ifndef BUILTIN_FUNC
82 static char *tdesc = "URI encode/decode functions";
83
84 int unload_module(void)
85 {
86         return ast_custom_function_unregister(&urldecode_function) || ast_custom_function_unregister(&urlencode_function);
87 }
88
89 int load_module(void)
90 {
91         return ast_custom_function_register(&urldecode_function) || ast_custom_function_register(&urlencode_function);
92 }
93
94 char *description(void)
95 {
96         return tdesc;
97 }
98
99 int usecount(void)
100 {
101         return 0;
102 }
103
104 char *key()
105 {
106         return ASTERISK_GPL_KEY;
107 }
108 #endif /* BUILTIN_FUNC */