Don't do SIP contact/route DNS if we're not using the result.
[asterisk/asterisk.git] / apps / app_sendtext.c
old mode 100755 (executable)
new mode 100644 (file)
index b58ec7f..98b7b2f
 /*
- * Asterisk -- A telephony toolkit for Linux.
+ * Asterisk -- An open source telephony toolkit.
  *
- * App to transmit a text message
- * 
  * Copyright (C) 1999 - 2005, Digium, Inc.
  *
  * Mark Spencer <markster@digium.com>
  *
+ * See http://www.asterisk.org for more information about
+ * the Asterisk project. Please do not directly contact
+ * any of the maintainers of this project for assistance;
+ * the project provides a web site, mailing lists and IRC
+ * channels for your use.
+ *
  * This program is free software, distributed under the terms of
- * the GNU General Public License
+ * the GNU General Public License Version 2. See the LICENSE file
+ * at the top of the source tree.
  */
-#include <asterisk/lock.h>
-#include <asterisk/file.h>
-#include <asterisk/logger.h>
-#include <asterisk/channel.h>
-#include <asterisk/channel_pvt.h>
-#include <asterisk/pbx.h>
-#include <asterisk/module.h>
-#include <asterisk/translate.h>
-#include <asterisk/image.h>
-#include <string.h>
-#include <stdlib.h>
 
-static char *tdesc = "Send Text Applications";
+/*! \file
+ *
+ * \brief App to transmit a text message
+ *
+ * \author Mark Spencer <markster@digium.com>
+ * 
+ * \note Requires support of sending text messages from channel driver
+ *
+ * \ingroup applications
+ */
 
-static char *app = "SendText";
+/*** MODULEINFO
+       <support_level>core</support_level>
+ ***/
+#include "asterisk.h"
 
-static char *synopsis = "Send a Text Message";
+ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 
-static char *descrip = 
-"  SendText(text): Sends text to client.  If the client\n"
-"does not support text transport, and  there  exists  a  step  with\n"
-"priority  n + 101,  then  execution  will  continue  at that step.\n"
-"Otherwise, execution will continue at  the  next  priority  level.\n"
-"SendText only returns 0  if  the  text  was  sent  correctly  or  if\n"
-"the channel  does  not  support text transport,  and -1 otherwise.\n";
+#include "asterisk/file.h"
+#include "asterisk/channel.h"
+#include "asterisk/pbx.h"
+#include "asterisk/module.h"
+#include "asterisk/app.h"
 
-STANDARD_LOCAL_USER;
+/*** DOCUMENTATION
+       <application name="SendText" language="en_US">
+               <synopsis>
+                       Send a Text Message.
+               </synopsis>
+               <syntax>
+                       <parameter name="text" required="true" />
+               </syntax>
+               <description>
+                       <para>Sends <replaceable>text</replaceable> to current channel (callee).</para>
+                       <para>Result of transmission will be stored in the <variable>SENDTEXTSTATUS</variable></para>
+                       <variablelist>
+                               <variable name="SENDTEXTSTATUS">
+                                       <value name="SUCCESS">
+                                               Transmission succeeded.
+                                       </value>
+                                       <value name="FAILURE">
+                                               Transmission failed.
+                                       </value>
+                                       <value name="UNSUPPORTED">
+                                               Text transmission not supported by channel.
+                                       </value>
+                               </variable>
+                       </variablelist>
+                       <note><para>At this moment, text is supposed to be 7 bit ASCII in most channels.</para></note>
+               </description>
+               <see-also>
+                       <ref type="application">SendImage</ref>
+                       <ref type="application">SendURL</ref>
+               </see-also>
+       </application>
+ ***/
 
-LOCAL_USER_DECL;
+static const char * const app = "SendText";
 
-static int sendtext_exec(struct ast_channel *chan, void *data)
+static int sendtext_exec(struct ast_channel *chan, const char *data)
 {
-       int res = 0;
-       struct localuser *u;
-       if (!data || !strlen((char *)data)) {
+       char *status = "UNSUPPORTED";
+       struct ast_str *str;
+
+       /* NOT ast_strlen_zero, because some protocols (e.g. SIP) MUST be able to
+        * send a zero-length message. */
+       if (!data) {
                ast_log(LOG_WARNING, "SendText requires an argument (text)\n");
                return -1;
        }
-       LOCAL_USER_ADD(u);
-       ast_mutex_lock(&chan->lock);
-       if (!chan->pvt->send_text) {
-               ast_mutex_unlock(&chan->lock);
+
+       if (!(str = ast_str_alloca(strlen(data) + 1))) {
+               return -1;
+       }
+
+       ast_str_get_encoded_str(&str, -1, data);
+
+       ast_channel_lock(chan);
+       if (!ast_channel_tech(chan)->send_text) {
+               ast_channel_unlock(chan);
                /* Does not support transport */
-               if (ast_exists_extension(chan, chan->context, chan->exten, chan->priority + 101, chan->cid.cid_num))
-                       chan->priority += 100;
-               LOCAL_USER_REMOVE(u);
+               pbx_builtin_setvar_helper(chan, "SENDTEXTSTATUS", status);
                return 0;
        }
-       ast_mutex_unlock(&chan->lock);
-       res = ast_sendtext(chan, (char *)data);
-       LOCAL_USER_REMOVE(u);
-       return res;
+       status = "FAILURE";
+       if (!ast_sendtext(chan, ast_str_buffer(str))) {
+               status = "SUCCESS";
+       }
+       ast_channel_unlock(chan);
+       pbx_builtin_setvar_helper(chan, "SENDTEXTSTATUS", status);
+       return 0;
 }
 
-int unload_module(void)
+static int unload_module(void)
 {
-       STANDARD_HANGUP_LOCALUSERS;
        return ast_unregister_application(app);
 }
 
-int load_module(void)
-{
-       return ast_register_application(app, sendtext_exec, synopsis, descrip);
-}
-
-char *description(void)
-{
-       return tdesc;
-}
-
-int usecount(void)
+static int load_module(void)
 {
-       int res;
-       STANDARD_USECOUNT(res);
-       return res;
+       return ast_register_application_xml(app, sendtext_exec);
 }
 
-char *key()
-{
-       return ASTERISK_GPL_KEY;
-}
+AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Send Text Applications");