app_dial.c: Factor out a connected line update routine.
[asterisk/asterisk.git] / apps / app_sendtext.c
index 7830ee8..3b7f0ca 100644 (file)
 /*! \file
  *
  * \brief App to transmit a text message
+ *
+ * \author Mark Spencer <markster@digium.com>
  * 
- * Requires support of sending text messages from channel driver
+ * \note Requires support of sending text messages from channel driver
  *
  * \ingroup applications
  */
-#include <stdlib.h>
-#include <stdio.h>
-#include <string.h>
 
+/*** MODULEINFO
+       <support_level>core</support_level>
+ ***/
 #include "asterisk.h"
 
-ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
+ASTERISK_REGISTER_FILE()
 
-#include "asterisk/lock.h"
 #include "asterisk/file.h"
-#include "asterisk/logger.h"
 #include "asterisk/channel.h"
 #include "asterisk/pbx.h"
 #include "asterisk/module.h"
-#include "asterisk/translate.h"
-#include "asterisk/image.h"
-#include "asterisk/options.h"
 #include "asterisk/app.h"
 
-static const char *tdesc = "Send Text Applications";
-
-static const char *app = "SendText";
-
-static const char *synopsis = "Send a Text Message";
-
-static const char *descrip = 
-"  SendText(text[|options]): Sends text to current channel (callee).\n"
-"Result of transmission will be stored in the SENDTEXTSTATUS\n"
-"channel variable:\n"
-"      SUCCESS      Transmission succeeded\n"
-"      FAILURE      Transmission failed\n"
-"      UNSUPPORTED  Text transmission not supported by channel\n"
-"\n"
-"At this moment, text is supposed to be 7 bit ASCII in most channels.\n"
-"The option string many contain the following character:\n"
-"'j' -- jump to n+101 priority if the channel doesn't support\n"
-"       text transport\n";
-
-STANDARD_LOCAL_USER;
-
-LOCAL_USER_DECL;
-
-static int sendtext_exec(struct ast_channel *chan, void *data)
+/*** 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>
+ ***/
+
+static const char * const app = "SendText";
+
+static int sendtext_exec(struct ast_channel *chan, const char *data)
 {
-       int res = 0;
-       struct localuser *u;
        char *status = "UNSUPPORTED";
-       char *parse = NULL;
-       int priority_jump = 0;
-       AST_DECLARE_APP_ARGS(args,
-               AST_APP_ARG(text);
-               AST_APP_ARG(options);
-       );
-               
-       LOCAL_USER_ADD(u);      
+       struct ast_str *str;
 
-       if (ast_strlen_zero(data)) {
-               ast_log(LOG_WARNING, "SendText requires an argument (text[|options])\n");
-               LOCAL_USER_REMOVE(u);
+       /* 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;
-       } else {
-               parse = ast_strdupa(data);
-               if (!parse) {
-                       ast_log(LOG_ERROR, "Out of memory!\n");
-                       LOCAL_USER_REMOVE(u);
-                       return -1;
-               }
        }
-       
-       AST_STANDARD_APP_ARGS(args, parse);
 
-       if (args.options) {
-               if (strchr(args.options, 'j'))
-                       priority_jump = 1;
+       if (!(str = ast_str_alloca(strlen(data) + 1))) {
+               return -1;
        }
 
-       ast_mutex_lock(&chan->lock);
-       if (!chan->tech->send_text) {
-               ast_mutex_unlock(&chan->lock);
+       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 (priority_jump || option_priority_jumping)
-                       ast_goto_if_exists(chan, chan->context, chan->exten, chan->priority + 101);
-               LOCAL_USER_REMOVE(u);
+               pbx_builtin_setvar_helper(chan, "SENDTEXTSTATUS", status);
                return 0;
        }
        status = "FAILURE";
-       ast_mutex_unlock(&chan->lock);
-       res = ast_sendtext(chan, args.text);
-       if (!res)
+       if (!ast_sendtext(chan, ast_str_buffer(str))) {
                status = "SUCCESS";
+       }
+       ast_channel_unlock(chan);
        pbx_builtin_setvar_helper(chan, "SENDTEXTSTATUS", status);
-       LOCAL_USER_REMOVE(u);
        return 0;
 }
 
-int unload_module(void)
+static int unload_module(void)
 {
-       int res;
-       
-       res = ast_unregister_application(app);
-       
-       STANDARD_HANGUP_LOCALUSERS;
-
-       return res;     
-}
-
-int load_module(void)
-{
-       return ast_register_application(app, sendtext_exec, synopsis, descrip);
+       return ast_unregister_application(app);
 }
 
-char *description(void)
+static int load_module(void)
 {
-       return (char *) tdesc;
+       return ast_register_application_xml(app, sendtext_exec);
 }
 
-int usecount(void)
-{
-       int res;
-
-       STANDARD_USECOUNT(res);
-
-       return res;
-}
-
-char *key()
-{
-       return ASTERISK_GPL_KEY;
-}
+AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Send Text Applications");