update doxygen docs to specify authors
[asterisk/asterisk.git] / funcs / func_uri.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, 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  */
29
30 #include <stdlib.h>
31 #include <stdio.h>
32 #include <string.h>
33 #include <sys/types.h>
34
35 #include "asterisk.h"
36
37 /* ASTERISK_FILE_VERSION(__FILE__, "$Revision$") */
38
39 #include "asterisk/channel.h"
40 #include "asterisk/pbx.h"
41 #include "asterisk/logger.h"
42 #include "asterisk/utils.h"
43 #include "asterisk/app.h"
44 #include "asterisk/module.h"
45
46 /*! \brief builtin_function_uriencode: Encode URL according to RFC 2396 */
47 static char *builtin_function_uriencode(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len) 
48 {
49         char uri[BUFSIZ];
50
51         if (ast_strlen_zero(data)) {
52                 ast_log(LOG_WARNING, "Syntax: URIENCODE(<data>) - missing argument!\n");
53                 return NULL;
54         }
55
56         ast_uri_encode(data, uri, sizeof(uri), 1);
57         ast_copy_string(buf, uri, len);
58
59         return buf;
60 }
61
62 /*!\brief builtin_function_uridecode: Decode URI according to RFC 2396 */
63 static char *builtin_function_uridecode(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len) 
64 {
65         if (ast_strlen_zero(data)) {
66                 ast_log(LOG_WARNING, "Syntax: URIDECODE(<data>) - missing argument!\n");
67                 return NULL;
68         }
69
70         
71         ast_copy_string(buf, data, len);
72         ast_uri_decode(buf);
73         return buf;
74 }
75
76 #ifndef BUILTIN_FUNC
77 static
78 #endif
79 struct ast_custom_function urldecode_function = {
80         .name = "URIDECODE",
81         .synopsis = "Decodes an URI-encoded string.",
82         .syntax = "URIDECODE(<data>)",
83         .read = builtin_function_uridecode,
84 };
85
86 #ifndef BUILTIN_FUNC
87 static
88 #endif
89 struct ast_custom_function urlencode_function = {
90         .name = "URIENCODE",
91         .synopsis = "Encodes a string to URI-safe encoding.",
92         .syntax = "URIENCODE(<data>)",
93         .read = builtin_function_uriencode,
94 };
95
96 #ifndef BUILTIN_FUNC
97 static char *tdesc = "URI encode/decode functions";
98
99 int unload_module(void)
100 {
101         return ast_custom_function_unregister(&urldecode_function) || ast_custom_function_unregister(&urlencode_function);
102 }
103
104 int load_module(void)
105 {
106         return ast_custom_function_register(&urldecode_function) || ast_custom_function_register(&urlencode_function);
107 }
108
109 char *description(void)
110 {
111         return tdesc;
112 }
113
114 int usecount(void)
115 {
116         return 0;
117 }
118
119 char *key()
120 {
121         return ASTERISK_GPL_KEY;
122 }
123 #endif /* BUILTIN_FUNC */