Replace direct access to channel name with accessor functions
[asterisk/asterisk.git] / apps / app_test.c
index b2a8406..9e11866 100644 (file)
  * \ingroup applications
  */
 
+/*** MODULEINFO
+       <support_level>extended</support_level>
+ ***/
+
 #include "asterisk.h"
 
 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 
-#include <fcntl.h>
 #include <sys/stat.h>
 
+#include "asterisk/paths.h"    /* use ast_config_AST_LOG_DIR */
 #include "asterisk/channel.h"
-#include "asterisk/options.h"
 #include "asterisk/module.h"
-#include "asterisk/logger.h"
 #include "asterisk/lock.h"
 #include "asterisk/app.h"
 #include "asterisk/pbx.h"
 #include "asterisk/utils.h"
 
-static char *tests_descrip = 
-        "  TestServer(): Perform test server function and write call report.\n"
-        "Results stored in /var/log/asterisk/testreports/<testid>-server.txt";
-static char *tests_app = "TestServer";
-static char *tests_synopsis = "Execute Interface Test Server";
-
-static char *testc_descrip = 
-        "  TestClient(testid): Executes test client with given testid.\n"
-        "Results stored in /var/log/asterisk/testreports/<testid>-client.txt";
+/*** DOCUMENTATION
+       <application name="TestServer" language="en_US">
+               <synopsis>
+                       Execute Interface Test Server.
+               </synopsis>
+               <syntax />
+               <description>
+                       <para>Perform test server function and write call report. Results stored in
+                       <filename>/var/log/asterisk/testreports/&lt;testid&gt;-server.txt</filename></para>
+               </description>
+               <see-also>
+                       <ref type="application">TestClient</ref>
+               </see-also>
+       </application>
+       <application name="TestClient" language="en_US">
+               <synopsis>
+                       Execute Interface Test Client.
+               </synopsis>
+               <syntax>
+                       <parameter name="testid" required="true">
+                               <para>An ID to identify this test.</para>
+                       </parameter>
+               </syntax>
+               <description>
+                       <para>Executes test client with given <replaceable>testid</replaceable>. Results stored in
+                       <filename>/var/log/asterisk/testreports/&lt;testid&gt;-client.txt</filename></para>
+               </description>
+               <see-also>
+                       <ref type="application">TestServer</ref>
+               </see-also>
+       </application>
+ ***/
 
+static char *tests_app = "TestServer";
 static char *testc_app = "TestClient";
-static char *testc_synopsis = "Execute Interface Test Client";
 
 static int measurenoise(struct ast_channel *chan, int ms, char *who)
 {
@@ -66,9 +91,10 @@ static int measurenoise(struct ast_channel *chan, int ms, char *who)
        short *foo;
        struct timeval start;
        struct ast_frame *f;
-       int rformat;
-       rformat = chan->readformat;
-       if (ast_set_read_format(chan, AST_FORMAT_SLINEAR)) {
+       struct ast_format rformat;
+
+       ast_format_copy(&rformat, &chan->readformat);
+       if (ast_set_read_format_by_id(chan, AST_FORMAT_SLINEAR)) {
                ast_log(LOG_NOTICE, "Unable to set to linear mode!\n");
                return -1;
        }
@@ -85,8 +111,8 @@ static int measurenoise(struct ast_channel *chan, int ms, char *who)
                        res = -1;
                        break;
                }
-               if ((f->frametype == AST_FRAME_VOICE) && (f->subclass == AST_FORMAT_SLINEAR)) {
-                       foo = (short *)f->data;
+               if ((f->frametype == AST_FRAME_VOICE) && (f->subclass.format.id == AST_FORMAT_SLINEAR)) {
+                       foo = (short *)f->data.ptr;
                        for (x=0;x<f->samples;x++) {
                                noise += abs(foo[x]);
                                samples++;
@@ -95,8 +121,8 @@ static int measurenoise(struct ast_channel *chan, int ms, char *who)
                ast_frfree(f);
        }
 
-       if (rformat) {
-               if (ast_set_read_format(chan, rformat)) {
+       if (rformat.id) {
+               if (ast_set_read_format(chan, &rformat)) {
                        ast_log(LOG_NOTICE, "Unable to restore original format!\n");
                        return -1;
                }
@@ -111,7 +137,7 @@ static int measurenoise(struct ast_channel *chan, int ms, char *who)
        return (noise / samples);
 }
 
-static int sendnoise(struct ast_channel *chan, int ms) 
+static int sendnoise(struct ast_channel *chan, int ms)
 {
        int res;
        res = ast_tonepair_start(chan, 1537, 2195, ms, 8192);
@@ -119,51 +145,51 @@ static int sendnoise(struct ast_channel *chan, int ms)
                res = ast_waitfordigit(chan, ms);
                ast_tonepair_stop(chan);
        }
-       return res;     
+       return res;
 }
 
-static int testclient_exec(struct ast_channel *chan, void *data)
+static int testclient_exec(struct ast_channel *chan, const char *data)
 {
        int res = 0;
-       char *testid=data;
+       const char *testid=data;
        char fn[80];
        char serverver[80];
        FILE *f;
-       
+
        /* Check for test id */
        if (ast_strlen_zero(testid)) {
                ast_log(LOG_WARNING, "TestClient requires an argument - the test id\n");
                return -1;
        }
-       
+
        if (chan->_state != AST_STATE_UP)
                res = ast_answer(chan);
-       
+
        /* Wait a few just to be sure things get started */
        res = ast_safe_sleep(chan, 3000);
        /* Transmit client version */
        if (!res)
                res = ast_dtmf_stream(chan, NULL, "8378*1#", 0, 0);
        ast_debug(1, "Transmit client version\n");
-       
+
        /* Read server version */
        ast_debug(1, "Read server version\n");
-       if (!res) 
+       if (!res)
                res = ast_app_getdata(chan, NULL, serverver, sizeof(serverver) - 1, 0);
        if (res > 0)
                res = 0;
        ast_debug(1, "server version: %s\n", serverver);
-               
+
        if (res > 0)
                res = 0;
 
        if (!res)
                res = ast_safe_sleep(chan, 1000);
        /* Send test id */
-       if (!res) 
-               res = ast_dtmf_stream(chan, NULL, testid, 0, 0);                
-       if (!res) 
-               res = ast_dtmf_stream(chan, NULL, "#", 0, 0);           
+       if (!res)
+               res = ast_dtmf_stream(chan, NULL, testid, 0, 0);
+       if (!res)
+               res = ast_dtmf_stream(chan, NULL, "#", 0, 0);
        ast_debug(1, "send test identifier: %s\n", testid);
 
        if ((res >=0) && (!ast_strlen_zero(testid))) {
@@ -173,11 +199,11 @@ static int testclient_exec(struct ast_channel *chan, void *data)
                snprintf(fn, sizeof(fn), "%s/testresults/%s-client.txt", ast_config_AST_LOG_DIR, testid);
                if ((f = fopen(fn, "w+"))) {
                        setlinebuf(f);
-                       fprintf(f, "CLIENTCHAN:    %s\n", chan->name);
+                       fprintf(f, "CLIENTCHAN:    %s\n", ast_channel_name(chan));
                        fprintf(f, "CLIENTTEST ID: %s\n", testid);
                        fprintf(f, "ANSWER:        PASS\n");
                        res = 0;
-                       
+
                        if (!res) {
                                /* Step 1: Wait for "1" */
                                ast_debug(1, "TestClient: 2.  Wait DTMF 1\n");
@@ -188,8 +214,9 @@ static int testclient_exec(struct ast_channel *chan, void *data)
                                else
                                        res = -1;
                        }
-                       if (!res)
+                       if (!res) {
                                res = ast_safe_sleep(chan, 1000);
+                       }
                        if (!res) {
                                /* Step 2: Send "2" */
                                ast_debug(1, "TestClient: 2.  Send DTMF 2\n");
@@ -205,7 +232,7 @@ static int testclient_exec(struct ast_channel *chan, void *data)
                                fprintf(f, "WAIT 1 SEC:    %s\n", (res < 0) ? "FAIL" : "PASS");
                                if (res > 0)
                                        res = 0;
-                       }                       
+                       }
                        if (!res) {
                                /* Step 4: Measure noise */
                                ast_debug(1, "TestClient: 4.  Measure noise\n");
@@ -251,7 +278,7 @@ static int testclient_exec(struct ast_channel *chan, void *data)
                        }
                        if (!res) {
                                /* Step 9: Measure noise */
-                               ast_debug(1, "TestClient: 6.  Measure tone\n");
+                               ast_debug(1, "TestClient: 9.  Measure tone\n");
                                res = measurenoise(chan, 4000, "TestClient");
                                fprintf(f, "MEASURETONE:   %s (%d)\n", (res < 0) ? "FAIL" : "PASS", res);
                                if (res > 0)
@@ -259,7 +286,7 @@ static int testclient_exec(struct ast_channel *chan, void *data)
                        }
                        if (!res) {
                                /* Step 10: Send "7" */
-                               ast_debug(1, "TestClient: 7.  Send DTMF 7\n");
+                               ast_debug(1, "TestClient: 10.  Send DTMF 7\n");
                                res = ast_dtmf_stream(chan, NULL, "7", 0, 0);
                                fprintf(f, "SEND DTMF 7:   %s\n", (res < 0) ? "FAIL" : "PASS");
                                if (res > 0)
@@ -276,6 +303,9 @@ static int testclient_exec(struct ast_channel *chan, void *data)
                                        res = -1;
                        }
                        if (!res) {
+                               res = ast_safe_sleep(chan, 1000);
+                       }
+                       if (!res) {
                                /* Step 12: Hangup! */
                                ast_debug(1, "TestClient: 12.  Hangup\n");
                        }
@@ -287,13 +317,13 @@ static int testclient_exec(struct ast_channel *chan, void *data)
                } else
                        res = -1;
        } else {
-               ast_log(LOG_NOTICE, "Did not read a test ID on '%s'\n", chan->name);
+               ast_log(LOG_NOTICE, "Did not read a test ID on '%s'\n", ast_channel_name(chan));
                res = -1;
        }
        return res;
 }
 
-static int testserver_exec(struct ast_channel *chan, void *data)
+static int testserver_exec(struct ast_channel *chan, const char *data)
 {
        int res = 0;
        char testid[80]="";
@@ -303,7 +333,7 @@ static int testserver_exec(struct ast_channel *chan, void *data)
                res = ast_answer(chan);
        /* Read version */
        ast_debug(1, "Read client version\n");
-       if (!res) 
+       if (!res)
                res = ast_app_getdata(chan, NULL, testid, sizeof(testid) - 1, 0);
        if (res > 0)
                res = 0;
@@ -317,8 +347,8 @@ static int testserver_exec(struct ast_channel *chan, void *data)
        if (res > 0)
                res = 0;
 
-       if (!res) 
-               res = ast_app_getdata(chan, NULL, testid, sizeof(testid) - 1, 0);               
+       if (!res)
+               res = ast_app_getdata(chan, NULL, testid, sizeof(testid) - 1, 0);
        ast_debug(1, "read test identifier: %s\n", testid);
        /* Check for sneakyness */
        if (strchr(testid, '/'))
@@ -331,7 +361,7 @@ static int testserver_exec(struct ast_channel *chan, void *data)
                snprintf(fn, sizeof(fn), "%s/testresults/%s-server.txt", ast_config_AST_LOG_DIR, testid);
                if ((f = fopen(fn, "w+"))) {
                        setlinebuf(f);
-                       fprintf(f, "SERVERCHAN:    %s\n", chan->name);
+                       fprintf(f, "SERVERCHAN:    %s\n", ast_channel_name(chan));
                        fprintf(f, "SERVERTEST ID: %s\n", testid);
                        fprintf(f, "ANSWER:        PASS\n");
                        ast_debug(1, "Processing Test ID '%s'\n", testid);
@@ -370,7 +400,6 @@ static int testserver_exec(struct ast_channel *chan, void *data)
                                if (res > 0)
                                        res = 0;
                        }
-               
                        if (!res) {
                                /* Step 5: Wait one second */
                                ast_debug(1, "TestServer: 5.  Wait one second\n");
@@ -379,7 +408,6 @@ static int testserver_exec(struct ast_channel *chan, void *data)
                                if (res > 0)
                                        res = 0;
                        }
-               
                        if (!res) {
                                /* Step 6: Measure noise */
                                ast_debug(1, "TestServer: 6.  Measure tone\n");
@@ -388,7 +416,6 @@ static int testserver_exec(struct ast_channel *chan, void *data)
                                if (res > 0)
                                        res = 0;
                        }
-
                        if (!res) {
                                /* Step 7: Send "5" */
                                ast_debug(1, "TestServer: 7.  Send DTMF 5\n");
@@ -397,14 +424,13 @@ static int testserver_exec(struct ast_channel *chan, void *data)
                                if (res > 0)
                                        res = 0;
                        }
-
                        if (!res) {
                                /* Step 8: Transmit tone noise */
                                ast_debug(1, "TestServer: 8.  Transmit tone\n");
                                res = sendnoise(chan, 6000);
                                fprintf(f, "SENDTONE:      %s\n", (res < 0) ? "FAIL" : "PASS");
                        }
-               
+
                        if (!res || (res == '7')) {
                                /* Step 9: Wait for "7" */
                                ast_debug(1, "TestServer: 9.  Wait DTMF 7\n");
@@ -416,8 +442,9 @@ static int testserver_exec(struct ast_channel *chan, void *data)
                                else
                                        res = -1;
                        }
-                       if (!res)
+                       if (!res) {
                                res = ast_safe_sleep(chan, 1000);
+                       }
                        if (!res) {
                                /* Step 10: Send "8" */
                                ast_debug(1, "TestServer: 10.  Send DTMF 8\n");
@@ -440,7 +467,7 @@ static int testserver_exec(struct ast_channel *chan, void *data)
                } else
                        res = -1;
        } else {
-               ast_log(LOG_NOTICE, "Did not read a test ID on '%s'\n", chan->name);
+               ast_log(LOG_NOTICE, "Did not read a test ID on '%s'\n", ast_channel_name(chan));
                res = -1;
        }
        return res;
@@ -453,15 +480,15 @@ static int unload_module(void)
        res = ast_unregister_application(testc_app);
        res |= ast_unregister_application(tests_app);
 
-       return res;     
+       return res;
 }
 
 static int load_module(void)
 {
        int res;
 
-       res = ast_register_application(testc_app, testclient_exec, testc_synopsis, testc_descrip);
-       res |= ast_register_application(tests_app, testserver_exec, tests_synopsis, tests_descrip);
+       res = ast_register_application_xml(testc_app, testclient_exec);
+       res |= ast_register_application_xml(tests_app, testserver_exec);
 
        return res;
 }