Enable macros in 1.8 to find the next highest "h" extension in a context, like in 1.4.

This change restores functionality that was present in 1.4, when AEL macros
were implemented with the Macro dialplan application.  Macros are fraught with
functionality issues, because they consume a large portion of the underlying
application stack.  This limits the ability of AEL users to call many layers
of subroutines, an issue which Gosub does not have (originally tested to
100,000 levels deep).  Therefore, starting in 1.6.0, AEL macros were
implemented with Gosub.

However, there were some implicit behaviors of Macro, which were not replicated
at the same time as with the transition to Gosub, one of which is documented in
the related issue.  In particular, the "h" extension is designed to execute not
in the Macro context, but in the topmost calling context.  Due to legacy issues
with a misapplied bugfix many years ago, when a macro exited in 1.4, it looks
in all calling contexts, bubbling up from the deepest level until it finds an
"h" extension.

Since AEL hides the complexity of the underlying dialplan logic from the AEL
programmer, it's reasonable to assume that this behavior should not change in
the transition from Asterisk 1.4 LTS to Asterisk 1.8 LTS, lest we break
working AEL configurations in the transition to Asterisk 1.8 LTS.  This fix
is the result, which implements a search for the "h" extension in all calling
Gosub contexts.

Fixes ASTERISK-19336

Patch: 20120308__ael_bugfix_for_trunk__2.diff (License #5003) by Tilghman Lesher
	(with slight modifications for 1.8)

Tested by: Johan Wilfer

Review: https://reviewboard.asterisk.org/r/1776/
........

Merged revisions 358810 from http://svn.asterisk.org/svn/asterisk/branches/1.8
........

Merged revisions 358811 from http://svn.asterisk.org/svn/asterisk/branches/10


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@358812 65c4cc65-6c06-0410-ace0-fbb531ad65f3

1 files changed, 139 insertions, 14 deletions

diff --git a/apps/app_stack.c b/apps/app_stack.c
index 827bb508a..28bd3cfb4 100644
--- a/apps/app_stack.c
+++ b/apps/app_stack.c
@@ -165,6 +165,24 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 			<ref type="application">Return</ref>
 		</see-also>
 	</function>
+	<function name="STACK_PEEK" language="en_US">
+		<synopsis>
+			View info about the location which called Gosub
+		</synopsis>
+		<syntax>
+			<parameter name="n" required="true" />
+			<parameter name="which" required="true" />
+			<parameter name="suppress" required="false" />
+		</syntax>
+		<description>
+			<para>Read the calling <literal>c</literal>ontext, <literal>e</literal>xtension,
+			<literal>p</literal>riority, or <literal>l</literal>abel, as specified by
+			<replaceable>which</replaceable>, by going up <replaceable>n</replaceable> frames
+			in the Gosub stack.  If <replaceable>suppress</replaceable> is true, then if the
+			number of available stack frames is exceeded, then no error message will be
+			printed.</para>
+		</description>
+	</function>
 	<agi name="gosub" language="en_US">
 		<synopsis>
 			Cause the channel to execute the specified dialplan subroutine.
@@ -285,12 +303,14 @@ static void gosub_free(void *data)
 
 static int pop_exec(struct ast_channel *chan, const char *data)
 {
-	struct ast_datastore *stack_store = ast_channel_datastore_find(chan, &stack_info, NULL);
+	struct ast_datastore *stack_store;
 	struct gosub_stack_frame *oldframe;
 	AST_LIST_HEAD(, gosub_stack_frame) *oldlist;
 
-	if (!stack_store) {
+	ast_channel_lock(chan);
+	if (!(stack_store = ast_channel_datastore_find(chan, &stack_info, NULL))) {
 		ast_log(LOG_WARNING, "%s called with no gosub stack allocated.\n", app_pop);
+		ast_channel_unlock(chan);
 		return 0;
 	}
 
@@ -304,19 +324,22 @@ static int pop_exec(struct ast_channel *chan, const char *data)
 	} else {
 		ast_debug(1, "%s called with an empty gosub stack\n", app_pop);
 	}
+	ast_channel_unlock(chan);
 	return 0;
 }
 
 static int return_exec(struct ast_channel *chan, const char *data)
 {
-	struct ast_datastore *stack_store = ast_channel_datastore_find(chan, &stack_info, NULL);
+	struct ast_datastore *stack_store;
 	struct gosub_stack_frame *oldframe;
 	AST_LIST_HEAD(, gosub_stack_frame) *oldlist;
 	const char *retval = data;
 	int res = 0;
 
-	if (!stack_store) {
+	ast_channel_lock(chan);
+	if (!(stack_store = ast_channel_datastore_find(chan, &stack_info, NULL))) {
 		ast_log(LOG_ERROR, "Return without Gosub: stack is unallocated\n");
+		ast_channel_unlock(chan);
 		return -1;
 	}
 
@@ -327,6 +350,7 @@ static int return_exec(struct ast_channel *chan, const char *data)
 
 	if (!oldframe) {
 		ast_log(LOG_ERROR, "Return without Gosub: stack is empty\n");
+		ast_channel_unlock(chan);
 		return -1;
 	} else if (oldframe->is_agi) {
 		/* Exit from AGI */
@@ -338,12 +362,13 @@ static int return_exec(struct ast_channel *chan, const char *data)
 
 	/* Set a return value, if any */
 	pbx_builtin_setvar_helper(chan, "GOSUB_RETVAL", S_OR(retval, ""));
+	ast_channel_unlock(chan);
 	return res;
 }
 
 static int gosub_exec(struct ast_channel *chan, const char *data)
 {
-	struct ast_datastore *stack_store = ast_channel_datastore_find(chan, &stack_info, NULL);
+	struct ast_datastore *stack_store;
 	AST_LIST_HEAD(,gosub_stack_frame) *oldlist;
 	struct gosub_stack_frame *newframe, *lastframe;
 	char argname[15], *tmp = ast_strdupa(data), *label, *endparen;
@@ -357,11 +382,13 @@ static int gosub_exec(struct ast_channel *chan, const char *data)
 		return -1;
 	}
 
-	if (!stack_store) {
+	ast_channel_lock(chan);
+	if (!(stack_store = ast_channel_datastore_find(chan, &stack_info, NULL))) {
 		ast_debug(1, "Channel %s has no datastore, so we're allocating one.\n", ast_channel_name(chan));
 		stack_store = ast_datastore_alloc(&stack_info, NULL);
 		if (!stack_store) {
 			ast_log(LOG_ERROR, "Unable to allocate new datastore.  Gosub will fail.\n");
+			ast_channel_unlock(chan);
 			return -1;
 		}
 
@@ -369,6 +396,7 @@ static int gosub_exec(struct ast_channel *chan, const char *data)
 		if (!oldlist) {
 			ast_log(LOG_ERROR, "Unable to allocate datastore list head.  Gosub will fail.\n");
 			ast_datastore_free(stack_store);
+			ast_channel_unlock(chan);
 			return -1;
 		}
 
@@ -405,12 +433,14 @@ static int gosub_exec(struct ast_channel *chan, const char *data)
 	newframe = gosub_allocate_frame(ast_channel_context(chan), ast_channel_exten(chan), ast_channel_priority(chan) + 1, max_argc);
 
 	if (!newframe) {
+		ast_channel_unlock(chan);
 		return -1;
 	}
 
 	if (ast_parseable_goto(chan, label)) {
 		ast_log(LOG_ERROR, "Gosub address is invalid: '%s'\n", (char *)data);
 		ast_free(newframe);
+		ast_channel_unlock(chan);
 		return -1;
 	}
 
@@ -423,6 +453,7 @@ static int gosub_exec(struct ast_channel *chan, const char *data)
 		ast_channel_exten_set(chan, newframe->extension);
 		ast_channel_priority_set(chan, newframe->priority - 1);
 		ast_free(newframe);
+		ast_channel_unlock(chan);
 		return -1;
 	}
 
@@ -440,6 +471,7 @@ static int gosub_exec(struct ast_channel *chan, const char *data)
 	AST_LIST_LOCK(oldlist);
 	AST_LIST_INSERT_HEAD(oldlist, newframe, entries);
 	AST_LIST_UNLOCK(oldlist);
+	ast_channel_unlock(chan);
 
 	return 0;
 }
@@ -483,44 +515,49 @@ static int gosubif_exec(struct ast_channel *chan, const char *data)
 
 static int local_read(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
 {
-	struct ast_datastore *stack_store = ast_channel_datastore_find(chan, &stack_info, NULL);
+	struct ast_datastore *stack_store;
 	AST_LIST_HEAD(, gosub_stack_frame) *oldlist;
 	struct gosub_stack_frame *frame;
 	struct ast_var_t *variables;
 
-	if (!stack_store)
+	ast_channel_lock(chan);
+	if (!(stack_store = ast_channel_datastore_find(chan, &stack_info, NULL))) {
+		ast_channel_unlock(chan);
 		return -1;
+	}
 
 	oldlist = stack_store->data;
 	AST_LIST_LOCK(oldlist);
 	if (!(frame = AST_LIST_FIRST(oldlist))) {
 		/* Not within a Gosub routine */
 		AST_LIST_UNLOCK(oldlist);
+		ast_channel_unlock(chan);
 		return -1;
 	}
 
 	AST_LIST_TRAVERSE(&frame->varshead, variables, entries) {
 		if (!strcmp(data, ast_var_name(variables))) {
 			const char *tmp;
-			ast_channel_lock(chan);
 			tmp = pbx_builtin_getvar_helper(chan, data);
 			ast_copy_string(buf, S_OR(tmp, ""), len);
-			ast_channel_unlock(chan);
 			break;
 		}
 	}
 	AST_LIST_UNLOCK(oldlist);
+	ast_channel_unlock(chan);
 	return 0;
 }
 
 static int local_write(struct ast_channel *chan, const char *cmd, char *var, const char *value)
 {
-	struct ast_datastore *stack_store = ast_channel_datastore_find(chan, &stack_info, NULL);
+	struct ast_datastore *stack_store;
 	AST_LIST_HEAD(, gosub_stack_frame) *oldlist;
 	struct gosub_stack_frame *frame;
 
-	if (!stack_store) {
+	ast_channel_lock(chan);
+	if (!(stack_store = ast_channel_datastore_find(chan, &stack_info, NULL))) {
 		ast_log(LOG_ERROR, "Tried to set LOCAL(%s), but we aren't within a Gosub routine\n", var);
+		ast_channel_unlock(chan);
 		return -1;
 	}
 
@@ -528,10 +565,12 @@ static int local_write(struct ast_channel *chan, const char *cmd, char *var, con
 	AST_LIST_LOCK(oldlist);
 	frame = AST_LIST_FIRST(oldlist);
 
-	if (frame)
+	if (frame) {
 		frame_set_var(chan, frame, var, value);
+	}
 
 	AST_LIST_UNLOCK(oldlist);
+	ast_channel_unlock(chan);
 
 	return 0;
 }
@@ -576,6 +615,89 @@ static struct ast_custom_function peek_function = {
 	.read = peek_read,
 };
 
+static int stackpeek_read(struct ast_channel *chan, const char *cmd, char *data, struct ast_str **str, ssize_t len)
+{
+	struct ast_datastore *stack_store;
+	AST_LIST_HEAD(, gosub_stack_frame) *oldlist;
+	struct gosub_stack_frame *frame;
+	int n;
+	AST_DECLARE_APP_ARGS(args,
+		AST_APP_ARG(n);
+		AST_APP_ARG(which);
+		AST_APP_ARG(suppress);
+	);
+
+	if (!chan) {
+		ast_log(LOG_ERROR, "STACK_PEEK must be called on an active channel\n");
+		return -1;
+	}
+
+	data = ast_strdupa(data);
+	AST_STANDARD_APP_ARGS(args, data);
+
+	n = atoi(args.n);
+	if (n <= 0) {
+		ast_log(LOG_ERROR, "STACK_PEEK must be called with a positive peek value\n");
+		return -1;
+	}
+
+	ast_channel_lock(chan);
+	if (!(stack_store = ast_channel_datastore_find(chan, &stack_info, NULL))) {
+		if (!ast_true(args.suppress)) {
+			ast_log(LOG_ERROR, "STACK_PEEK called on a channel without a gosub stack\n");
+		}
+		ast_channel_unlock(chan);
+		return -1;
+	}
+
+	oldlist = stack_store->data;
+
+	AST_LIST_LOCK(oldlist);
+	AST_LIST_TRAVERSE(oldlist, frame, entries) {
+		if (--n == 0) {
+			break;
+		}
+	}
+
+	if (!frame) {
+		/* Too deep */
+		if (!ast_true(args.suppress)) {
+			ast_log(LOG_ERROR, "Stack peek of '%s' is more stack frames than I have\n", args.n);
+		}
+		ast_channel_unlock(chan);
+		return -1;
+	}
+
+	args.which = ast_skip_blanks(args.which);
+
+	switch (args.which[0]) {
+	case 'l': /* label */
+		ast_str_set(str, len, "%s,%s,%d", frame->context, frame->extension, frame->priority - 1);
+		break;
+	case 'c': /* context */
+		ast_str_set(str, len, "%s", frame->context);
+		break;
+	case 'e': /* extension */
+		ast_str_set(str, len, "%s", frame->extension);
+		break;
+	case 'p': /* priority */
+		ast_str_set(str, len, "%d", frame->priority - 1);
+		break;
+	default:
+		ast_log(LOG_ERROR, "Unknown argument '%s' to STACK_PEEK\n", args.which);
+	}
+
+	AST_LIST_UNLOCK(oldlist);
+	ast_channel_unlock(chan);
+
+	return 0;
+}
+
+static struct ast_custom_function stackpeek_function = {
+	.name = "STACK_PEEK",
+	.read2 = stackpeek_read,
+};
+
 static int handle_gosub(struct ast_channel *chan, AGI *agi, int argc, const char * const *argv)
 {
 	int old_priority, priority;
@@ -687,6 +809,7 @@ static int unload_module(void)
 	ast_unregister_application(app_gosub);
 	ast_custom_function_unregister(&local_function);
 	ast_custom_function_unregister(&peek_function);
+	ast_custom_function_unregister(&stackpeek_function);
 
 	return 0;
 }
@@ -701,12 +824,14 @@ static int load_module(void)
 	ast_register_application_xml(app_gosub, gosub_exec);
 	ast_custom_function_register(&local_function);
 	ast_custom_function_register(&peek_function);
+	ast_custom_function_register(&stackpeek_function);
 
 	return 0;
 }
 
-AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT, "Dialplan subroutines (Gosub, Return, etc)",
+AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT | AST_MODFLAG_LOAD_ORDER, "Dialplan subroutines (Gosub, Return, etc)",
 		.load = load_module,
 		.unload = unload_module,
+		.load_pri = AST_MODPRI_APP_DEPEND,
 		.nonoptreq = "res_agi",
 		);