Applications no longer need to call ast_module_user_add and ast_module_user_remove...
[asterisk/asterisk.git] / apps / app_while.c
index df2fb97..f7da65b 100644 (file)
 
 /*! \file
  *
- * \brief While Loop and ExecIf Implementations
+ * \brief While Loop Implementation
  *
  * \author Anthony Minessale <anthmct@yahoo.com>
  * 
  * \ingroup applications
  */
 
+#include "asterisk.h"
+
+ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
+
 #include <stdlib.h>
 #include <stdio.h>
 #include <string.h>
 #include <unistd.h>
 
-#include "asterisk.h"
-
-ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
-
 #include "asterisk/file.h"
 #include "asterisk/logger.h"
 #include "asterisk/channel.h"
@@ -44,77 +44,33 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 #include "asterisk/lock.h"
 #include "asterisk/options.h"
 
-#define ALL_DONE(u,ret) {LOCAL_USER_REMOVE(u); return ret;}
-
-
-static char *exec_app = "ExecIf";
-static char *exec_desc = 
-"Usage:  ExecIF (<expr>|<app>|<data>)\n"
-"If <expr> is true, execute and return the result of <app>(<data>).\n"
-"If <expr> is true, but <app> is not found, then the application\n"
-"will return a non-zero value.";
-static char *exec_synopsis = "Conditional exec";
-
 static char *start_app = "While";
 static char *start_desc = 
 "Usage:  While(<expr>)\n"
 "Start a While Loop.  Execution will return to this point when\n"
 "EndWhile is called until expr is no longer true.\n";
 
-static char *start_synopsis = "Start A While Loop";
+static char *start_synopsis = "Start a while loop";
 
 
 static char *stop_app = "EndWhile";
 static char *stop_desc = 
 "Usage:  EndWhile()\n"
-"Return to the previous called While\n\n";
-
-static char *stop_synopsis = "End A While Loop";
-
-static char *tdesc = "While Loops and Conditional Execution";
-
+"Return to the previous called While\n";
 
+static char *stop_synopsis = "End a while loop";
 
-STANDARD_LOCAL_USER;
+static char *exit_app = "ExitWhile";
+static char *exit_desc =
+"Usage:  ExitWhile()\n"
+"Exits a While loop, whether or not the conditional has been satisfied.\n";
+static char *exit_synopsis = "End a While loop";
 
-LOCAL_USER_DECL;
-
-static int execif_exec(struct ast_channel *chan, void *data) {
-       int res=0;
-       struct localuser *u;
-       char *myapp = NULL;
-       char *mydata = NULL;
-       char *expr = NULL;
-       struct ast_app *app = NULL;
-
-       LOCAL_USER_ADD(u);
-
-       expr = ast_strdupa(data);
-
-       if ((myapp = strchr(expr,'|'))) {
-               *myapp = '\0';
-               myapp++;
-               if ((mydata = strchr(myapp,'|'))) {
-                       *mydata = '\0';
-                       mydata++;
-               } else
-                       mydata = "";
-
-               if (ast_true(expr)) { 
-                       if ((app = pbx_findapp(myapp))) {
-                               res = pbx_exec(chan, app, mydata, 1);
-                       } else {
-                               ast_log(LOG_WARNING, "Count not find application! (%s)\n", myapp);
-                               res = -1;
-                       }
-               }
-       } else {
-               ast_log(LOG_ERROR,"Invalid Syntax.\n");
-               res = -1;
-       }
-               
-       ALL_DONE(u,res);
-}
+static char *continue_app = "ContinueWhile";
+static char *continue_desc =
+"Usage:  ContinueWhile()\n"
+"Returns to the top of the while loop and re-evaluates the conditional.\n";
+static char *continue_synopsis = "Restart a While loop";
 
 #define VAR_SIZE 64
 
@@ -166,7 +122,7 @@ static int find_matching_endwhile(struct ast_channel *chan)
        struct ast_context *c;
        int res=-1;
 
-       if (ast_lock_contexts()) {
+       if (ast_rdlock_contexts()) {
                ast_log(LOG_ERROR, "Failed to lock contexts list\n");
                return -1;
        }
@@ -174,7 +130,7 @@ static int find_matching_endwhile(struct ast_channel *chan)
        for (c=ast_walk_contexts(NULL); c; c=ast_walk_contexts(c)) {
                struct ast_exten *e;
 
-               if (!ast_lock_context(c)) {
+               if (!ast_rdlock_context(c)) {
                        if (!strcmp(ast_get_context_name(c), chan->context)) {
                                /* This is the matching context we want */
                                int cur_priority = chan->priority + 1, level=1;
@@ -205,7 +161,6 @@ static int find_matching_endwhile(struct ast_channel *chan)
 static int _while_exec(struct ast_channel *chan, void *data, int end)
 {
        int res=0;
-       struct localuser *u;
        const char *while_pri = NULL;
        char *my_name = NULL;
        const char *condition = NULL, *label = NULL;
@@ -220,14 +175,11 @@ static int _while_exec(struct ast_channel *chan, void *data, int end)
                return -1;
        }
 
-       LOCAL_USER_ADD(u);
-
        /* dont want run away loops if the chan isn't even up
           this is up for debate since it slows things down a tad ......
        */
        if (ast_waitfordigit(chan,1) < 0)
-               ALL_DONE(u,-1);
-
+               return -1;
 
        for (x=0;;x++) {
                if (get_index(chan, prefix, x)) {
@@ -265,15 +217,15 @@ static int _while_exec(struct ast_channel *chan, void *data, int end)
        }
        
 
-       if (!end && !ast_true(condition)) {
+       if ((!end && !pbx_checkcondition(condition)) || (end == 2)) {
                /* Condition Met (clean up helper vars) */
                const char *goto_str;
                pbx_builtin_setvar_helper(chan, varname, NULL);
                pbx_builtin_setvar_helper(chan, my_name, NULL);
-        snprintf(end_varname,VAR_SIZE,"END_%s",varname);
+               snprintf(end_varname,VAR_SIZE,"END_%s",varname);
                if ((goto_str=pbx_builtin_getvar_helper(chan, end_varname))) {
-                       pbx_builtin_setvar_helper(chan, end_varname, NULL);
                        ast_parseable_goto(chan, goto_str);
+                       pbx_builtin_setvar_helper(chan, end_varname, NULL);
                } else {
                        int pri = find_matching_endwhile(chan);
                        if (pri > 0) {
@@ -284,7 +236,7 @@ static int _while_exec(struct ast_channel *chan, void *data, int end)
                                ast_log(LOG_WARNING, "Couldn't find matching EndWhile? (While at %s@%s priority %d)\n", chan->context, chan->exten, chan->priority);
                        }
                }
-               ALL_DONE(u,res);
+               return res;
        }
 
        if (!end && !while_pri) {
@@ -309,11 +261,8 @@ static int _while_exec(struct ast_channel *chan, void *data, int end)
                }
                ast_parseable_goto(chan, while_pri);
        }
-       
-
-
 
-       ALL_DONE(u, res);
+       return res;
 }
 
 static int while_start_exec(struct ast_channel *chan, void *data) {
@@ -324,45 +273,51 @@ static int while_end_exec(struct ast_channel *chan, void *data) {
        return _while_exec(chan, data, 1);
 }
 
+static int while_exit_exec(struct ast_channel *chan, void *data) {
+       return _while_exec(chan, data, 2);
+}
+
+static int while_continue_exec(struct ast_channel *chan, void *data)
+{
+       int x;
+       const char *prefix = "WHILE", *while_pri=NULL;
+
+       for (x = 0; ; x++) {
+               const char *tmp = get_index(chan, prefix, x);
+               if (tmp)
+                       while_pri = tmp;
+               else
+                       break;
+       }
+
+       if (while_pri)
+               ast_parseable_goto(chan, while_pri);
+
+       return 0;
+}
 
-int unload_module(void)
+static int unload_module(void)
 {
        int res;
        
        res = ast_unregister_application(start_app);
-       res |= ast_unregister_application(exec_app);
        res |= ast_unregister_application(stop_app);
-
-       STANDARD_HANGUP_LOCALUSERS;
+       res |= ast_unregister_application(exit_app);
+       res |= ast_unregister_application(continue_app);
 
        return res;
 }
 
-int load_module(void)
+static int load_module(void)
 {
        int res;
 
        res = ast_register_application(start_app, while_start_exec, start_synopsis, start_desc);
-       res |= ast_register_application(exec_app, execif_exec, exec_synopsis, exec_desc);
        res |= ast_register_application(stop_app, while_end_exec, stop_synopsis, stop_desc);
+       res |= ast_register_application(exit_app, while_exit_exec, exit_synopsis, exit_desc);
+       res |= ast_register_application(continue_app, while_continue_exec, continue_synopsis, continue_desc);
 
        return res;
 }
 
-char *description(void)
-{
-       return tdesc;
-}
-
-int usecount(void)
-{
-       int res;
-       STANDARD_USECOUNT(res);
-       return res;
-}
-
-char *key()
-{
-       return ASTERISK_GPL_KEY;
-}
-
+AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "While Loops and Conditional Execution");