make app_queue 1.2 jump compliant (issue #5580)
[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  * \note For now this code only supports 8 bit characters, not unicode,
24          which we ultimately will need to support.
25  * 
26  */
27
28 #include <stdlib.h>
29 #include <stdio.h>
30 #include <string.h>
31 #include <sys/types.h>
32
33 #include "asterisk.h"
34
35 /* ASTERISK_FILE_VERSION(__FILE__, "$Revision$") */
36
37 #include "asterisk/channel.h"
38 #include "asterisk/pbx.h"
39 #include "asterisk/logger.h"
40 #include "asterisk/utils.h"
41 #include "asterisk/app.h"
42 #include "asterisk/module.h"
43
44 /*! \brief builtin_function_uriencode: Encode URL according to RFC 2396 */
45 static char *builtin_function_uriencode(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len) 
46 {
47         char uri[BUFSIZ];
48
49         if (ast_strlen_zero(data)) {
50                 ast_log(LOG_WARNING, "Syntax: URIENCODE(<data>) - missing argument!\n");
51                 return NULL;
52         }
53
54         ast_uri_encode(data, uri, sizeof(uri), 1);
55         ast_copy_string(buf, uri, len);
56
57         return buf;
58 }
59
60 /*!\brief builtin_function_uridecode: Decode URI according to RFC 2396 */
61 static char *builtin_function_uridecode(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len) 
62 {
63         if (ast_strlen_zero(data)) {
64                 ast_log(LOG_WARNING, "Syntax: URIDECODE(<data>) - missing argument!\n");
65                 return NULL;
66         }
67
68         
69         ast_copy_string(buf, data, len);
70         ast_uri_decode(buf);
71         return buf;
72 }
73
74 #ifndef BUILTIN_FUNC
75 static
76 #endif
77 struct ast_custom_function urldecode_function = {
78         .name = "URIDECODE",
79         .synopsis = "Decodes an URI-encoded string.",
80         .syntax = "URIDECODE(<data>)",
81         .read = builtin_function_uridecode,
82 };
83
84 #ifndef BUILTIN_FUNC
85 static
86 #endif
87 struct ast_custom_function urlencode_function = {
88         .name = "URIENCODE",
89         .synopsis = "Encodes a string to URI-safe encoding.",
90         .syntax = "URIENCODE(<data>)",
91         .read = builtin_function_uriencode,
92 };
93
94 #ifndef BUILTIN_FUNC
95 static char *tdesc = "URI encode/decode functions";
96
97 int unload_module(void)
98 {
99         return ast_custom_function_unregister(&urldecode_function) || ast_custom_function_unregister(&urlencode_function);
100 }
101
102 int load_module(void)
103 {
104         return ast_custom_function_register(&urldecode_function) || ast_custom_function_register(&urlencode_function);
105 }
106
107 char *description(void)
108 {
109         return tdesc;
110 }
111
112 int usecount(void)
113 {
114         return 0;
115 }
116
117 char *key()
118 {
119         return ASTERISK_GPL_KEY;
120 }
121 #endif /* BUILTIN_FUNC */