Merge "chan_pjsip: Relock correct channel during "fax" redirect."
[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         <support_level>core</support_level>
30  ***/
31
32 #include "asterisk.h"
33
34 #include <ctype.h>
35 #include <iconv.h>
36
37 #include "asterisk/module.h"
38 #include "asterisk/channel.h"
39 #include "asterisk/pbx.h"
40 #include "asterisk/utils.h"
41 #include "asterisk/app.h"
42
43 /*** DOCUMENTATION
44         <function name="ICONV" language="en_US">
45                 <synopsis>
46                         Converts charsets of strings.
47                 </synopsis>
48                 <syntax>
49                         <parameter name="in-charset" required="true">
50                                 <para>Input charset</para>
51                         </parameter>
52                         <parameter name="out-charset" required="true">
53                                 <para>Output charset</para>
54                         </parameter>
55                         <parameter name="string" required="true">
56                                 <para>String to convert, from <replaceable>in-charset</replaceable> to <replaceable>out-charset</replaceable></para>
57                         </parameter>
58                 </syntax>
59                 <description>
60                         <para>Converts string from <replaceable>in-charset</replaceable> into <replaceable>out-charset</replaceable>.
61                         For available charsets, use <literal>iconv -l</literal> on your shell command line.</para>
62                         <note><para>Due to limitations within the API, ICONV will not currently work with
63                         charsets with embedded NULLs. If found, the string will terminate.</para></note>
64                 </description>
65         </function>
66  ***/
67
68
69 /*!
70  * Some systems define the second arg to iconv() as (const char *),
71  * while others define it as (char *).  Cast it to a (void *) to
72  * suppress compiler warnings about it.
73  */
74 #define AST_ICONV_CAST void *
75
76 static int iconv_read(struct ast_channel *chan, const char *cmd, char *arguments, char *buf, size_t len)
77 {
78         AST_DECLARE_APP_ARGS(args,
79                 AST_APP_ARG(in_charset);
80                 AST_APP_ARG(out_charset);
81                 AST_APP_ARG(text);
82         );
83         iconv_t cd;
84         size_t incount, outcount = len - 1;
85         char *parse;
86
87         if (ast_strlen_zero(arguments)) {
88                 ast_log(LOG_WARNING, "Syntax: ICONV(<in-charset>,<out-charset>,<text>) - missing arguments!\n");
89                 return -1;
90         }
91
92         parse = ast_strdupa(arguments);
93         AST_STANDARD_APP_ARGS(args, parse);
94
95         if (args.argc < 3) {
96                 ast_log(LOG_WARNING, "Syntax: ICONV(<in-charset>,<out-charset>,<text>) %u\n", args.argc);
97                 return -1;
98         }
99
100         incount = strlen(args.text);
101
102         ast_debug(1, "Iconv: \"%s\" %s -> %s\n", args.text, args.in_charset, args.out_charset);
103
104         cd = iconv_open(args.out_charset, args.in_charset);
105
106         if (cd == (iconv_t) -1) {
107                 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);
108                 return -1;
109         }
110
111         if (iconv(cd, (AST_ICONV_CAST) &args.text, &incount, &buf, &outcount) == (size_t) -1) {
112                 if (errno == E2BIG)
113                         ast_log(LOG_WARNING, "Iconv: output buffer too small.\n");
114                 else if (errno == EILSEQ)
115                         ast_log(LOG_WARNING,  "Iconv: illegal character.\n");
116                 else if (errno == EINVAL)
117                         ast_log(LOG_WARNING,  "Iconv: incomplete character sequence.\n");
118                 else
119                         ast_log(LOG_WARNING,  "Iconv: error %d: %s.\n", errno, strerror(errno));
120         }
121         *buf = '\0';
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");