[svn-commits] tilghman: trunk r165397 - /trunk/apps/app_record.c

[SVN commits to the Digium repositories]

Author: tilghman
Date: Wed Dec 17 17:39:48 2008
New Revision: 165397

URL: http://svn.digium.com/view/asterisk?view=rev&rev=165397
Log:
Add RECORD_STATUS variable, as requested on the -users list.
Patch by me (license 14)

Modified:
    trunk/apps/app_record.c

Modified: trunk/apps/app_record.c
URL: http://svn.digium.com/view/asterisk/trunk/apps/app_record.c?view=diff&rev=165397&r1=165396&r2=165397
==============================================================================
--- trunk/apps/app_record.c (original)
+++ trunk/apps/app_record.c Wed Dec 17 17:39:48 2008
@@ -87,6 +87,15 @@
 			<variablelist>
 				<variable name="RECORDED_FILE">
 					<para>Will be set to the final filename of the recording.</para>
+				</variable>
+				<variable name="RECORD_STATUS">
+					<para>This is the final status of the command</para>
+					<value name="DTMF"><para>A terminating DTMF was received ('#' or '*', depending upon option 't')</para></value>
+					<value name="SILENCE"><para>The maximum silence occurred in the recording.</para></value>
+					<value name="SKIP"><para>The line was not yet answered and the 's' option was specified.</para></value>
+					<value name="TIMEOUT"><para>The maximum length was reached.</para></value>
+					<value name="HANGUP"><para>The channel was hung up.</para></value>
+					<value name="ERROR"><para>An unrecoverable error occurred, which resulted in a WARNING to the logs.</para></value>
 				</variable>
 			</variablelist>
 		</description>
@@ -150,6 +159,7 @@
 	/* The next few lines of code parse out the filename and header from the input string */
 	if (ast_strlen_zero(data)) { /* no data implies no filename or anything is present */
 		ast_log(LOG_WARNING, "Record requires an argument (filename)\n");
+		pbx_builtin_setvar_helper(chan, "RECORD_STATUS", "ERROR");
 		return -1;
 	}
 
@@ -171,6 +181,7 @@
 	}
 	if (!ext) {
 		ast_log(LOG_WARNING, "No extension specified to filename!\n");
+		pbx_builtin_setvar_helper(chan, "RECORD_STATUS", "ERROR");
 		return -1;
 	}
 	if (args.silence) {
@@ -237,6 +248,7 @@
 	if (chan->_state != AST_STATE_UP) {
 		if (ast_test_flag(&flags, OPTION_SKIP)) {
 			/* At the user's option, skip if the line is not up */
+			pbx_builtin_setvar_helper(chan, "RECORD_STATUS", "SKIP");
 			return 0;
 		} else if (!ast_test_flag(&flags, OPTION_NOANSWER)) {
 			/* Otherwise answer unless we're supposed to record while on-hook */
@@ -246,6 +258,7 @@
 
 	if (res) {
 		ast_log(LOG_WARNING, "Could not answer channel '%s'\n", chan->name);
+		pbx_builtin_setvar_helper(chan, "RECORD_STATUS", "ERROR");
 		goto out;
 	}
 
@@ -267,11 +280,13 @@
 		res = ast_set_read_format(chan, AST_FORMAT_SLINEAR);
 		if (res < 0) {
 			ast_log(LOG_WARNING, "Unable to set to linear mode, giving up\n");
+			pbx_builtin_setvar_helper(chan, "RECORD_STATUS", "ERROR");
 			return -1;
 		}
 		sildet = ast_dsp_new();
 		if (!sildet) {
 			ast_log(LOG_WARNING, "Unable to create silence detector :(\n");
+			pbx_builtin_setvar_helper(chan, "RECORD_STATUS", "ERROR");
 			return -1;
 		}
 		ast_dsp_set_threshold(sildet, ast_dsp_get_threshold_from_settings(THRESHOLD_SILENCE));
@@ -288,6 +303,7 @@
 
 	if (!s) {
 		ast_log(LOG_WARNING, "Could not create file %s\n", args.filename);
+		pbx_builtin_setvar_helper(chan, "RECORD_STATUS", "ERROR");
 		goto out;
 	}
 
@@ -304,6 +320,7 @@
 		if (maxduration > 0) {
 			if (waitres == 0) {
 				gottimeout = 1;
+				pbx_builtin_setvar_helper(chan, "RECORD_STATUS", "TIMEOUT");
 				break;
 			}
 			maxduration = waitres;
@@ -320,6 +337,7 @@
 			if (res) {
 				ast_log(LOG_WARNING, "Problem writing frame\n");
 				ast_frfree(f);
+				pbx_builtin_setvar_helper(chan, "RECORD_STATUS", "ERROR");
 				break;
 			}
 
@@ -335,6 +353,7 @@
 					/* Ended happily with silence */
 					ast_frfree(f);
 					gotsilence = 1;
+					pbx_builtin_setvar_helper(chan, "RECORD_STATUS", "SILENCE");
 					break;
 				}
 			}
@@ -343,12 +362,14 @@
 
 			if (res) {
 				ast_log(LOG_WARNING, "Problem writing frame\n");
+				pbx_builtin_setvar_helper(chan, "RECORD_STATUS", "ERROR");
 				ast_frfree(f);
 				break;
 			}
 		} else if ((f->frametype == AST_FRAME_DTMF) &&
 		    (f->subclass == terminator)) {
 			ast_frfree(f);
+			pbx_builtin_setvar_helper(chan, "RECORD_STATUS", "DTMF");
 			break;
 		}
 		ast_frfree(f);
@@ -356,6 +377,7 @@
 	if (!f) {
 		ast_debug(1, "Got hangup\n");
 		res = -1;
+		pbx_builtin_setvar_helper(chan, "RECORD_STATUS", "HANGUP");
 		ast_filedelete(args.filename, NULL);
 	}