issue #5626
[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  * \ingroup applications
24  */
25  
26 #include <string.h>
27 #include <stdlib.h>
28
29 #include "asterisk.h"
30
31 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
32
33 #include "asterisk/lock.h"
34 #include "asterisk/file.h"
35 #include "asterisk/logger.h"
36 #include "asterisk/channel.h"
37 #include "asterisk/pbx.h"
38 #include "asterisk/module.h"
39 #include "asterisk/translate.h"
40 #include "asterisk/image.h"
41 #include "asterisk/app.h"
42 #include "asterisk/options.h"
43
44 static char *tdesc = "Image Transmission Application";
45
46 static char *app = "SendImage";
47
48 static char *synopsis = "Send an image file";
49
50 static char *descrip = 
51 "  SendImage(filename): Sends an image on a channel. \n"
52 "SendImage only  returns  0 if  the  image was sent correctly or if\n"
53 "the channel does not support image transport, and -1 otherwise.\n"
54 "The option string may contain zero or the following character:\n"
55 "       'j' -- jump to priority n+101 if the channel doesn't support image transport\n"
56 "This application sets the following channel variable upon completion:\n"
57 "       SENDIMAGESTATUS         The status is the attempt to send an image as a text string, one of\n"
58 "               OK | NOSUPPORT \n";                     
59
60 STANDARD_LOCAL_USER;
61
62 LOCAL_USER_DECL;
63
64 static int sendimage_exec(struct ast_channel *chan, void *data)
65 {
66         int res = 0;
67         struct localuser *u;
68         char *parse;
69         int priority_jump = 0;
70         AST_DECLARE_APP_ARGS(args,
71                 AST_APP_ARG(filename);
72                 AST_APP_ARG(options);
73         );
74         
75         LOCAL_USER_ADD(u);
76
77         if (!(parse = ast_strdupa(data))) {
78                 ast_log(LOG_WARNING, "Memory Error!\n");
79                 LOCAL_USER_REMOVE(u);
80                 return -1;
81         }
82
83         AST_STANDARD_APP_ARGS(args, parse);
84
85         if (ast_strlen_zero(args.filename)) {
86                 ast_log(LOG_WARNING, "SendImage requires an argument (filename[|options])\n");
87                 return -1;
88         }
89
90         if (args.options) {
91                 if (strchr(args.options, 'j'))
92                         priority_jump = 1;
93         }
94
95         if (!ast_supports_images(chan)) {
96                 /* Does not support transport */
97                 if (priority_jump || option_priority_jumping)
98                         ast_goto_if_exists(chan, chan->context, chan->exten, chan->priority + 101);
99                 pbx_builtin_setvar_helper(chan, "SENDIMAGESTATUS", "NOSUPPORT");
100                 LOCAL_USER_REMOVE(u);
101                 return 0;
102         }
103
104         res = ast_send_image(chan, args.filename);
105         
106         if (!res)
107                 pbx_builtin_setvar_helper(chan, "SENDIMAGESTATUS", "OK");
108         
109         LOCAL_USER_REMOVE(u);
110         
111         return res;
112 }
113
114 int unload_module(void)
115 {
116         int res;
117
118         res = ast_unregister_application(app);
119
120         STANDARD_HANGUP_LOCALUSERS;
121
122         return res; 
123 }
124
125 int load_module(void)
126 {
127         return ast_register_application(app, sendimage_exec, synopsis, descrip);
128 }
129
130 char *description(void)
131 {
132         return tdesc;
133 }
134
135 int usecount(void)
136 {
137         int res;
138         STANDARD_USECOUNT(res);
139         return res;
140 }
141
142 char *key()
143 {
144         return ASTERISK_GPL_KEY;
145 }