Asterisk data retrieval API.
[asterisk/asterisk.git] / apps / app_image.c
old mode 100755 (executable)
new mode 100644 (file)
index e0a48c1..af4abd7
  * at the top of the source tree.
  */
 
-/*
+/*! \file
+ *
+ * \brief App to transmit an image
  *
- * App to transmit an image
+ * \author Mark Spencer <markster@digium.com>
  * 
+ * \ingroup applications
  */
  
-#include <string.h>
-#include <stdlib.h>
-
 #include "asterisk.h"
 
 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 
-#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"
 
-static char *tdesc = "Image Transmission Application";
-
 static char *app = "SendImage";
 
-static char *synopsis = "Send an image file";
-
-static char *descrip = 
-"  SendImage(filename): Sends an image on a channel. If the channel\n"
-"does not support  image 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"
-"SendImage only  returns  0 if  the  image was sent correctly or if\n"
-"the channel does not support image transport, and -1 otherwise.\n";
-
-STANDARD_LOCAL_USER;
-
-LOCAL_USER_DECL;
-
-static int sendimage_exec(struct ast_channel *chan, void *data)
+/*** DOCUMENTATION
+       <application name="SendImage" language="en_US">
+               <synopsis>
+                       Sends an image file.
+               </synopsis>
+               <syntax>
+                       <parameter name="filename" required="true">
+                               <para>Path of the filename (image) to send.</para>
+                       </parameter>
+               </syntax>
+               <description>
+                       <para>Send an image file on a channel supporting it.</para>
+                       <para>Result of transmission will be stored in <variable>SENDIMAGESTATUS</variable></para>
+                       <variablelist>
+                               <variable name="SENDIMAGESTATUS">
+                                       <value name="SUCCESS">
+                                               Transmission succeeded.
+                                       </value>
+                                       <value name="FAILURE">
+                                               Transmission failed.
+                                       </value>
+                                       <value name="UNSUPPORTED">
+                                               Image transmission not supported by channel.
+                                       </value>
+                               </variable>
+                       </variablelist>
+               </description>
+               <see-also>
+                       <ref type="application">SendText</ref>
+                       <ref type="application">SendURL</ref>
+               </see-also>
+       </application>
+ ***/
+
+static int sendimage_exec(struct ast_channel *chan, const char *data)
 {
-       int res = 0;
-       struct localuser *u;
-       if (!data || !strlen((char *)data)) {
+
+       if (ast_strlen_zero(data)) {
                ast_log(LOG_WARNING, "SendImage requires an argument (filename)\n");
                return -1;
        }
-       LOCAL_USER_ADD(u);
+
        if (!ast_supports_images(chan)) {
                /* Does not support transport */
-               if (ast_exists_extension(chan, chan->context, chan->exten, chan->priority + 101, chan->cid.cid_num))
-                       chan->priority += 100;
+               pbx_builtin_setvar_helper(chan, "SENDIMAGESTATUS", "UNSUPPORTED");
                return 0;
        }
-       res = ast_send_image(chan, data);
-       LOCAL_USER_REMOVE(u);
-       return res;
-}
-
-int unload_module(void)
-{
-       STANDARD_HANGUP_LOCALUSERS;
-       return ast_unregister_application(app);
-}
 
-int load_module(void)
-{
-       return ast_register_application(app, sendimage_exec, synopsis, descrip);
+       if (!ast_send_image(chan, data)) {
+               pbx_builtin_setvar_helper(chan, "SENDIMAGESTATUS", "SUCCESS");
+       } else {
+               pbx_builtin_setvar_helper(chan, "SENDIMAGESTATUS", "FAILURE");
+       }
+       
+       return 0;
 }
 
-char *description(void)
+static int unload_module(void)
 {
-       return tdesc;
+       return ast_unregister_application(app);
 }
 
-int usecount(void)
+static int load_module(void)
 {
-       int res;
-       STANDARD_USECOUNT(res);
-       return res;
+       return ast_register_application_xml(app, sendimage_exec);
 }
 
-char *key()
-{
-       return ASTERISK_GPL_KEY;
-}
+AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Image Transmission Application");