ami_testhooks.c automatically registers hook
[asterisk/asterisk.git] / funcs / func_iconv.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (c) 2005,2006,2007 Sven Slezak <sunny@mezzo.net>
5  *
6  * See http://www.asterisk.org for more information about
7  * the Asterisk project. Please do not directly contact
8  * any of the maintainers of this project for assistance;
9  * the project provides a web site, mailing lists and IRC
10  * channels for your use.
11  *
12  * This program is free software, distributed under the terms of
13  * the GNU General Public License Version 2. See the LICENSE file
14  * at the top of the source tree.
15  */
16
17 /*!
18  * \file
19  *
20  * \brief Charset conversions
21  *
22  * \author Sven Slezak <sunny@mezzo.net>
23  *
24  * \ingroup functions
25  */
26
27 /*** MODULEINFO
28     <depend>iconv</depend>
29  ***/
30
31 #include "asterisk.h"
32
33 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
34
35 #include <ctype.h>
36 #include <iconv.h>
37
38 #include "asterisk/module.h"
39 #include "asterisk/channel.h"
40 #include "asterisk/pbx.h"
41 #include "asterisk/utils.h"
42 #include "asterisk/app.h"
43
44 /*** DOCUMENTATION
45         <function name="ICONV" language="en_US">
46                 <synopsis>
47                         Converts charsets of strings.   
48                 </synopsis>
49                 <syntax>
50                         <parameter name="in-charset" required="true">
51                                 <para>Input charset</para>
52                         </parameter>
53                         <parameter name="out-charset" required="true">
54                                 <para>Output charset</para>
55                         </parameter>
56                         <parameter name="string" required="true">
57                                 <para>String to convert, from <replaceable>in-charset</replaceable> to <replaceable>out-charset</replaceable></para>
58                         </parameter>
59                 </syntax>
60                 <description>
61                         <para>Converts string from <replaceable>in-charset</replaceable> into <replaceable>out-charset</replaceable>.
62                         For available charsets, use <literal>iconv -l</literal> on your shell command line.</para>
63                         <note><para>Due to limitations within the API, ICONV will not currently work with
64                         charsets with embedded NULLs. If found, the string will terminate.</para></note>
65                 </description>
66         </function>
67  ***/
68
69
70 /*! 
71  * Some systems define the second arg to iconv() as (const char *),
72  * while others define it as (char *).  Cast it to a (void *) to 
73  * suppress compiler warnings about it. 
74  */
75 #define AST_ICONV_CAST void *
76
77 static int iconv_read(struct ast_channel *chan, const char *cmd, char *arguments, char *buf, size_t len)
78 {
79         AST_DECLARE_APP_ARGS(args,
80                 AST_APP_ARG(in_charset);
81                 AST_APP_ARG(out_charset);
82                 AST_APP_ARG(text);
83         );
84         iconv_t cd;
85         size_t incount, outcount = len;
86         char *parse;
87
88         if (ast_strlen_zero(arguments)) {
89                 ast_log(LOG_WARNING, "Syntax: ICONV(<in-charset>,<out-charset>,<text>) - missing arguments!\n");
90                 return -1;
91         }
92
93         parse = ast_strdupa(arguments);
94         AST_STANDARD_APP_ARGS(args, parse);
95
96         if (args.argc < 3) {
97                 ast_log(LOG_WARNING, "Syntax: ICONV(<in-charset>,<out-charset>,<text>) %d\n", args.argc);
98                 return -1;
99         }
100
101         incount = strlen(args.text);
102
103         ast_debug(1, "Iconv: \"%s\" %s -> %s\n", args.text, args.in_charset, args.out_charset);
104
105         cd = iconv_open(args.out_charset, args.in_charset);
106
107         if (cd == (iconv_t) -1) {
108                 ast_log(LOG_ERROR, "conversion from '%s' to '%s' not available. type 'iconv -l' in a shell to list the supported charsets.\n", args.in_charset, args.out_charset);
109                 return -1;
110         }
111
112         if (iconv(cd, (AST_ICONV_CAST) &args.text, &incount, &buf, &outcount) == (size_t) -1) {
113                 if (errno == E2BIG)
114                         ast_log(LOG_WARNING, "Iconv: output buffer too small.\n");
115                 else if (errno == EILSEQ)
116                         ast_log(LOG_WARNING,  "Iconv: illegal character.\n");
117                 else if (errno == EINVAL)
118                         ast_log(LOG_WARNING,  "Iconv: incomplete character sequence.\n");
119                 else
120                         ast_log(LOG_WARNING,  "Iconv: error %d: %s.\n", errno, strerror(errno));
121         }
122         iconv_close(cd);
123
124         return 0;
125 }
126
127
128 static struct ast_custom_function iconv_function = {
129         .name = "ICONV",
130         .read = iconv_read
131 };
132
133 static int unload_module(void)
134 {
135         return ast_custom_function_unregister(&iconv_function);
136 }
137
138 static int load_module(void)
139 {
140         return ast_custom_function_register(&iconv_function);
141 }
142
143 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Charset conversions");
144