Merged revisions 140670 via svnmerge from
[asterisk/asterisk.git] / funcs / func_uri.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Created by Olle E. Johansson, Edvina.net 
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief URI encoding / decoding
22  *
23  * \author Olle E. Johansson <oej@edvina.net>
24  * 
25  * \note For now this code only supports 8 bit characters, not unicode,
26          which we ultimately will need to support.
27  * 
28  * \ingroup functions
29  */
30
31 #include "asterisk.h"
32
33 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
34
35 #include "asterisk/module.h"
36 #include "asterisk/channel.h"
37 #include "asterisk/pbx.h"
38 #include "asterisk/utils.h"
39 #include "asterisk/app.h"
40
41 /*! \brief uriencode: Encode URL according to RFC 2396 */
42 static int uriencode(struct ast_channel *chan, const char *cmd, char *data,
43                      char *buf, size_t len)
44 {
45         if (ast_strlen_zero(data)) {
46                 ast_log(LOG_WARNING, "Syntax: URIENCODE(<data>) - missing argument!\n");
47                 return -1;
48         }
49
50         ast_uri_encode(data, buf, len, 1);
51
52         return 0;
53 }
54
55 /*!\brief uridecode: Decode URI according to RFC 2396 */
56 static int uridecode(struct ast_channel *chan, const char *cmd, char *data,
57                      char *buf, size_t len)
58 {
59         if (ast_strlen_zero(data)) {
60                 ast_log(LOG_WARNING, "Syntax: URIDECODE(<data>) - missing argument!\n");
61                 return -1;
62         }
63
64         ast_copy_string(buf, data, len);
65         ast_uri_decode(buf);
66
67         return 0;
68 }
69
70 static struct ast_custom_function urldecode_function = {
71         .name = "URIDECODE",
72         .synopsis = "Decodes a URI-encoded string according to RFC 2396.",
73         .syntax = "URIDECODE(<data>)",
74         .read = uridecode,
75 };
76
77 static struct ast_custom_function urlencode_function = {
78         .name = "URIENCODE",
79         .synopsis = "Encodes a string to URI-safe encoding according to RFC 2396.",
80         .syntax = "URIENCODE(<data>)",
81         .read = uriencode,
82 };
83
84 static int unload_module(void)
85 {
86         return ast_custom_function_unregister(&urldecode_function)
87                 || ast_custom_function_unregister(&urlencode_function);
88 }
89
90 static int load_module(void)
91 {
92         return ast_custom_function_register(&urldecode_function)
93                 || ast_custom_function_register(&urlencode_function);
94 }
95
96 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "URI encode/decode dialplan functions");