update doxygen docs to specify authors
[asterisk/asterisk.git] / apps / app_sendtext.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 a text message
22  *
23  * \author Mark Spencer <markster@digium.com>
24  * 
25  * \note Requires support of sending text messages from channel driver
26  *
27  * \ingroup applications
28  */
29  
30 #include <stdlib.h>
31 #include <stdio.h>
32 #include <string.h>
33
34 #include "asterisk.h"
35
36 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
37
38 #include "asterisk/lock.h"
39 #include "asterisk/file.h"
40 #include "asterisk/logger.h"
41 #include "asterisk/channel.h"
42 #include "asterisk/pbx.h"
43 #include "asterisk/module.h"
44 #include "asterisk/translate.h"
45 #include "asterisk/image.h"
46 #include "asterisk/options.h"
47 #include "asterisk/app.h"
48
49 static const char *tdesc = "Send Text Applications";
50
51 static const char *app = "SendText";
52
53 static const char *synopsis = "Send a Text Message";
54
55 static const char *descrip = 
56 "  SendText(text[|options]): Sends text to current channel (callee).\n"
57 "Result of transmission will be stored in the SENDTEXTSTATUS\n"
58 "channel variable:\n"
59 "      SUCCESS      Transmission succeeded\n"
60 "      FAILURE      Transmission failed\n"
61 "      UNSUPPORTED  Text transmission not supported by channel\n"
62 "\n"
63 "At this moment, text is supposed to be 7 bit ASCII in most channels.\n"
64 "The option string many contain the following character:\n"
65 "'j' -- jump to n+101 priority if the channel doesn't support\n"
66 "       text transport\n";
67
68 STANDARD_LOCAL_USER;
69
70 LOCAL_USER_DECL;
71
72 static int sendtext_exec(struct ast_channel *chan, void *data)
73 {
74         int res = 0;
75         struct localuser *u;
76         char *status = "UNSUPPORTED";
77         char *parse = NULL;
78         int priority_jump = 0;
79         AST_DECLARE_APP_ARGS(args,
80                 AST_APP_ARG(text);
81                 AST_APP_ARG(options);
82         );
83                 
84         LOCAL_USER_ADD(u);      
85
86         if (ast_strlen_zero(data)) {
87                 ast_log(LOG_WARNING, "SendText requires an argument (text[|options])\n");
88                 LOCAL_USER_REMOVE(u);
89                 return -1;
90         } else {
91                 parse = ast_strdupa(data);
92                 if (!parse) {
93                         ast_log(LOG_ERROR, "Out of memory!\n");
94                         LOCAL_USER_REMOVE(u);
95                         return -1;
96                 }
97         }
98         
99         AST_STANDARD_APP_ARGS(args, parse);
100
101         if (args.options) {
102                 if (strchr(args.options, 'j'))
103                         priority_jump = 1;
104         }
105
106         ast_mutex_lock(&chan->lock);
107         if (!chan->tech->send_text) {
108                 ast_mutex_unlock(&chan->lock);
109                 /* Does not support transport */
110                 if (priority_jump || ast_opt_priority_jumping)
111                         ast_goto_if_exists(chan, chan->context, chan->exten, chan->priority + 101);
112                 LOCAL_USER_REMOVE(u);
113                 return 0;
114         }
115         status = "FAILURE";
116         ast_mutex_unlock(&chan->lock);
117         res = ast_sendtext(chan, args.text);
118         if (!res)
119                 status = "SUCCESS";
120         pbx_builtin_setvar_helper(chan, "SENDTEXTSTATUS", status);
121         LOCAL_USER_REMOVE(u);
122         return 0;
123 }
124
125 int unload_module(void)
126 {
127         int res;
128         
129         res = ast_unregister_application(app);
130         
131         STANDARD_HANGUP_LOCALUSERS;
132
133         return res;     
134 }
135
136 int load_module(void)
137 {
138         return ast_register_application(app, sendtext_exec, synopsis, descrip);
139 }
140
141 char *description(void)
142 {
143         return (char *) tdesc;
144 }
145
146 int usecount(void)
147 {
148         int res;
149
150         STANDARD_USECOUNT(res);
151
152         return res;
153 }
154
155 char *key()
156 {
157         return ASTERISK_GPL_KEY;
158 }