application doc update
[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  * Requires support of sending text messages from channel driver
24  *
25  * \ingroup applications
26  */
27  
28 #include <string.h>
29 #include <stdlib.h>
30
31 #include "asterisk.h"
32
33 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
34
35 #include "asterisk/lock.h"
36 #include "asterisk/file.h"
37 #include "asterisk/logger.h"
38 #include "asterisk/channel.h"
39 #include "asterisk/pbx.h"
40 #include "asterisk/module.h"
41 #include "asterisk/translate.h"
42 #include "asterisk/image.h"
43 #include "asterisk/options.h"
44
45 static const char *tdesc = "Send Text Applications";
46
47 static const char *app = "SendText";
48
49 static const char *synopsis = "Send a Text Message";
50
51 static const char *descrip = 
52 "  SendText(text): Sends text to current channel (callee).\n"
53 "Otherwise, execution will continue at the next priority level.\n"
54 "Result of transmission will be stored in the SENDTEXTSTATUS\n"
55 "channel variable:\n"
56 "      SUCCESS      Transmission succeeded\n"
57 "      FAILURE      Transmission failed\n"
58 "      UNSUPPORTED  Text transmission not supported by channel\n"
59 "\n"
60 "At this moment, text is supposed to be 7 bit ASCII in most channels.\n"
61 "Old deprecated behavior: \n"
62 " SendText should continue with the next priority upon successful execution.\n"
63 " If the client does not support text transport, and there exists a\n"
64 " step with priority n + 101, then execution will continue at that step.\n";
65
66 STANDARD_LOCAL_USER;
67
68 LOCAL_USER_DECL;
69
70 static int sendtext_exec(struct ast_channel *chan, void *data)
71 {
72         int res = 0;
73         struct localuser *u;
74         char *status = "UNSUPPORTED";
75                 
76         if (ast_strlen_zero(data)) {
77                 ast_log(LOG_WARNING, "SendText requires an argument (text)\n");
78                 return -1;
79         }
80         
81         LOCAL_USER_ADD(u);
82
83         ast_mutex_lock(&chan->lock);
84         if (!chan->tech->send_text) {
85                 ast_mutex_unlock(&chan->lock);
86                 /* Does not support transport */
87                 if (option_priority_jumping)
88                         ast_goto_if_exists(chan, chan->context, chan->exten, chan->priority + 101);
89                 LOCAL_USER_REMOVE(u);
90                 return 0;
91         }
92         status = "FAILURE";
93         ast_mutex_unlock(&chan->lock);
94         res = ast_sendtext(chan, (char *)data);
95         if (!res)
96                 status = "SUCCESS";
97         pbx_builtin_setvar_helper(chan, "SENDTEXTSTATUS", status);
98         LOCAL_USER_REMOVE(u);
99         return 0;
100 }
101
102 int unload_module(void)
103 {
104         int res;
105         
106         res = ast_unregister_application(app);
107         
108         STANDARD_HANGUP_LOCALUSERS;
109
110         return res;     
111 }
112
113 int load_module(void)
114 {
115         return ast_register_application(app, sendtext_exec, synopsis, descrip);
116 }
117
118 char *description(void)
119 {
120         return (char *) tdesc;
121 }
122
123 int usecount(void)
124 {
125         int res;
126
127         STANDARD_USECOUNT(res);
128
129         return res;
130 }
131
132 char *key()
133 {
134         return ASTERISK_GPL_KEY;
135 }