Cast the 2nd argument to iconv() to a void *, as some systems define it as a
[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  ***/
29
30 #include "asterisk.h"
31
32 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
33
34 #include <stdlib.h>
35 #include <stdio.h>
36 #include <string.h>
37 #include <sys/types.h>
38 #include <ctype.h>
39 #include <errno.h>
40 #include <iconv.h>
41
42 #include "asterisk/module.h"
43 #include "asterisk/channel.h"
44 #include "asterisk/pbx.h"
45 #include "asterisk/logger.h"
46 #include "asterisk/utils.h"
47 #include "asterisk/app.h"
48 #include "asterisk/options.h"
49
50 /*! 
51  * Some systems define the second arg to iconv() as (const char *),
52  * while others define it as (char *).  Cast it to a (void *) to 
53  * suppress compiler warnings about it. 
54  */
55 #define AST_ICONV_CAST void *
56
57 static int iconv_read(struct ast_channel *chan, const char *cmd, char *arguments, char *buf, size_t len)
58 {
59         AST_DECLARE_APP_ARGS(args,
60                 AST_APP_ARG(in_charset);
61                 AST_APP_ARG(out_charset);
62                 AST_APP_ARG(text);
63         );
64         iconv_t cd;
65         size_t incount, outcount = len;
66         char *parse;
67
68         if (ast_strlen_zero(arguments)) {
69                 ast_log(LOG_WARNING, "Syntax: ICONV(<in-charset>,<out-charset>,<text>) - missing arguments!\n");
70                 return -1;
71         }
72
73         parse = ast_strdupa(arguments);
74         AST_STANDARD_APP_ARGS(args, parse);
75
76         if (args.argc < 3) {
77                 ast_log(LOG_WARNING, "Syntax: ICONV(<in-charset>,<out-charset>,<text>) %d\n", args.argc);
78                 return -1;
79         }
80
81         incount = strlen(args.text);
82
83         ast_debug(1, "Iconv: \"%s\" %s -> %s\n", args.text, args.in_charset, args.out_charset);
84
85         cd = iconv_open(args.out_charset, args.in_charset);
86
87         if (cd == (iconv_t) -1) {
88                 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);
89                 return -1;
90         }
91
92         if (iconv(cd, (AST_ICONV_CAST) &args.text, &incount, &buf, &outcount) == (size_t) -1) {
93                 if (errno == E2BIG)
94                         ast_log(LOG_WARNING, "Iconv: output buffer too small.\n");
95                 else if (errno == EILSEQ)
96                         ast_log(LOG_WARNING,  "Iconv: illegal character.\n");
97                 else if (errno == EINVAL)
98                         ast_log(LOG_WARNING,  "Iconv: incomplete character sequence.\n");
99                 else
100                         ast_log(LOG_WARNING,  "Iconv: error %d: %s.\n", errno, strerror(errno));
101         }
102         iconv_close(cd);
103
104         return 0;
105 }
106
107
108 static struct ast_custom_function iconv_function = {
109         .name = "ICONV",
110         .synopsis = "Converts charsets of strings.",
111         .desc =
112 "Converts string from in-charset into out-charset.  For available charsets,\n"
113 "use 'iconv -l' on your shell command line.\n"
114 "Note: due to limitations within the API, ICONV will not currently work with\n"
115 "charsets with embedded NULLs.  If found, the string will terminate.\n",
116         .syntax = "ICONV(in-charset,out-charset,string)",
117         .read = iconv_read,
118 };
119
120 static int unload_module(void)
121 {
122         return ast_custom_function_unregister(&iconv_function);
123 }
124
125 static int load_module(void)
126 {
127         return ast_custom_function_register(&iconv_function);
128 }
129
130 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Charset conversions");
131