Mostly cleanup of documentation to substitute the pipe with the comma, but a few...
[asterisk/asterisk.git] / apps / app_image.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
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 App to transmit an image
22  *
23  * \author Mark Spencer <markster@digium.com>
24  * 
25  * \ingroup applications
26  */
27  
28 #include "asterisk.h"
29
30 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
31
32 #include <stdlib.h>
33 #include <stdio.h>
34 #include <string.h>
35
36 #include "asterisk/lock.h"
37 #include "asterisk/file.h"
38 #include "asterisk/logger.h"
39 #include "asterisk/channel.h"
40 #include "asterisk/pbx.h"
41 #include "asterisk/module.h"
42 #include "asterisk/translate.h"
43 #include "asterisk/image.h"
44 #include "asterisk/app.h"
45 #include "asterisk/options.h"
46
47 static char *app = "SendImage";
48
49 static char *synopsis = "Send an image file";
50
51 static char *descrip = 
52 "  SendImage(filename): Sends an image on a channel.\n"
53 "If the channel supports image transport but the image send fails, the channel\n"
54 "will be hung up.  Otherwise, the dialplan continues execution.  This\n"
55 "application sets the following channel variable upon completion:\n"
56 "   SENDIMAGESTATUS  The status is the result of the attempt, one of:\n"
57 "                    OK | NOSUPPORT \n";                        
58
59
60 static int sendimage_exec(struct ast_channel *chan, void *data)
61 {
62         int res = 0;
63
64         if (ast_strlen_zero(data)) {
65                 ast_log(LOG_WARNING, "SendImage requires an argument (filename)\n");
66                 return -1;
67         }
68
69         if (!ast_supports_images(chan)) {
70                 /* Does not support transport */
71                 pbx_builtin_setvar_helper(chan, "SENDIMAGESTATUS", "NOSUPPORT");
72                 return 0;
73         }
74
75         if (!(res = ast_send_image(chan, data)))
76                 pbx_builtin_setvar_helper(chan, "SENDIMAGESTATUS", "OK");
77                 
78         return res;
79 }
80
81 static int unload_module(void)
82 {
83         return ast_unregister_application(app);
84 }
85
86 static int load_module(void)
87 {
88         return ast_register_application(app, sendimage_exec, synopsis, descrip);
89 }
90
91 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Image Transmission Application");