make app_queue 1.2 jump compliant (issue #5580)
[asterisk/asterisk.git] / apps / app_db.c
index 2014f7a..659f968 100755 (executable)
@@ -1,50 +1,71 @@
 /*
- * Asterisk -- A telephony toolkit for Linux.
+ * Asterisk -- An open source telephony toolkit.
  *
- * Database access functions
- *
- * Copyright (C) 1999-2004, Digium, Inc.
+ * Copyright (C) 1999 - 2005, Digium, Inc.
  * Copyright (C) 2003, Jefferson Noxon
  *
  * Mark Spencer <markster@digium.com>
  * Jefferson Noxon <jeff@debian.org>
  *
+ * See http://www.asterisk.org for more information about
+ * the Asterisk project. Please do not directly contact
+ * any of the maintainers of this project for assistance;
+ * the project provides a web site, mailing lists and IRC
+ * channels for your use.
+ *
  * This program is free software, distributed under the terms of
- * the GNU General Public License
+ * the GNU General Public License Version 2. See the LICENSE file
+ * at the top of the source tree.
+ */
+
+/*! \file
+ *
+ * \brief Database access functions
+ *
+ * \ingroup applications
  */
 
-#include <sys/types.h>
-#include <asterisk/options.h>
-#include <asterisk/file.h>
-#include <asterisk/logger.h>
-#include <asterisk/channel.h>
-#include <asterisk/pbx.h>
-#include <asterisk/module.h>
-#include <asterisk/astdb.h>
-#include <asterisk/lock.h>
 #include <stdlib.h>
-#include <unistd.h>
+#include <stdio.h>
 #include <string.h>
-#include <stdlib.h>
+#include <unistd.h>
+#include <sys/types.h>
+
+#include "asterisk.h"
+
+ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
+
+#include "asterisk/options.h"
+#include "asterisk/file.h"
+#include "asterisk/logger.h"
+#include "asterisk/channel.h"
+#include "asterisk/pbx.h"
+#include "asterisk/module.h"
+#include "asterisk/astdb.h"
+#include "asterisk/lock.h"
+#include "asterisk/options.h"
 
 static char *tdesc = "Database access functions for Asterisk extension logic";
 
 static char *g_descrip =
-       "  DBget(varname=family/key): Retrieves a value from the Asterisk\n"
-       "database and stores it in the given variable.  Always returns 0.  If the\n"
-       "requested key is not found, jumps to priority n+101 if available.\n";
+       "  DBget(varname=family/key[|options]): Retrieves a value from the Asterisk\n"
+       "database and stores it in the given variable.\n"
+       "  The option string may contain the following character:\n"
+       "       'j' -- jump to +101 priority if the requested family/key isn't found.\n"
+       "  This application sets the following channel variable upon completion:\n"
+       "     DBGETSTATUS       The status of the attempt as a text string, one of\n"
+       "             FOUND | NOTFOUND \n";
 
 static char *p_descrip =
        "  DBput(family/key=value): Stores the given value in the Asterisk\n"
-       "database.  Always returns 0.\n";
+       "database.\n";
 
 static char *d_descrip =
-       "  DBdel(family/key): Deletes a key from the Asterisk database.  Always\n"
-       "returns 0.\n";
+       "  DBdel(family/key): Deletes a key from the Asterisk database.\n";
 
 static char *dt_descrip =
        "  DBdeltree(family[/keytree]): Deletes a family or keytree from the Asterisk\n"
-       "database.  Always returns 0.\n";
+       "database.\n";
 
 static char *g_app = "DBget";
 static char *p_app = "DBput";
@@ -60,27 +81,29 @@ STANDARD_LOCAL_USER;
 
 LOCAL_USER_DECL;
 
-static int deltree_exec (struct ast_channel *chan, void *data)
+static int deltree_exec(struct ast_channel *chan, void *data)
 {
-       int arglen;
        char *argv, *family, *keytree;
+       struct localuser *u;
+
+       LOCAL_USER_ADD(u);
 
-       arglen = strlen (data);
-       argv = alloca (arglen + 1);
-       if (!argv) {    /* Why would this fail? */
-               ast_log (LOG_DEBUG, "Memory allocation failed\n");
+       argv = ast_strdupa(data);
+       if (!argv) {
+               ast_log(LOG_ERROR, "Memory allocation failed\n");
+               LOCAL_USER_REMOVE(u);
                return 0;
        }
-       memcpy (argv, data, arglen + 1);
 
-       if (strchr (argv, '/')) {
-               family = strsep (&argv, "/");
-               keytree = strsep (&argv, "\0");
+       if (strchr(argv, '/')) {
+               family = strsep(&argv, "/");
+               keytree = strsep(&argv, "\0");
                        if (!family || !keytree) {
-                               ast_log (LOG_DEBUG, "Ignoring; Syntax error in argument\n");
+                               ast_log(LOG_DEBUG, "Ignoring; Syntax error in argument\n");
+                               LOCAL_USER_REMOVE(u);
                                return 0;
                        }
-               if (!strlen (keytree))
+               if (ast_strlen_zero(keytree))
                        keytree = 0;
        } else {
                family = argv;
@@ -89,167 +112,209 @@ static int deltree_exec (struct ast_channel *chan, void *data)
 
        if (option_verbose > 2) {
                if (keytree)
-                       ast_verbose (VERBOSE_PREFIX_3 "DBdeltree: family=%s, keytree=%s\n", family, keytree);
+                       ast_verbose(VERBOSE_PREFIX_3 "DBdeltree: family=%s, keytree=%s\n", family, keytree);
                else
-                       ast_verbose (VERBOSE_PREFIX_3 "DBdeltree: family=%s\n", family);
+                       ast_verbose(VERBOSE_PREFIX_3 "DBdeltree: family=%s\n", family);
        }
 
-       if (ast_db_deltree (family, keytree)) {
+       if (ast_db_deltree(family, keytree)) {
                if (option_verbose > 2)
-                       ast_verbose (VERBOSE_PREFIX_3 "DBdeltree: Error deleting key from database.\n");
+                       ast_verbose(VERBOSE_PREFIX_3 "DBdeltree: Error deleting key from database.\n");
        }
 
+       LOCAL_USER_REMOVE(u);
+
        return 0;
 }
 
-static int del_exec (struct ast_channel *chan, void *data)
+static int del_exec(struct ast_channel *chan, void *data)
 {
-       int arglen;
        char *argv, *family, *key;
+       struct localuser *u;
+
+       LOCAL_USER_ADD(u);
 
-       arglen = strlen (data);
-       argv = alloca (arglen + 1);
-       if (!argv) {    /* Why would this fail? */
-               ast_log (LOG_DEBUG, "Memory allocation failed\n");
+       argv = ast_strdupa(data);
+       if (!argv) {
+               ast_log (LOG_ERROR, "Memory allocation failed\n");
+               LOCAL_USER_REMOVE(u);
                return 0;
        }
-       memcpy (argv, data, arglen + 1);
 
-       if (strchr (argv, '/')) {
-               family = strsep (&argv, "/");
-               key = strsep (&argv, "\0");
+       if (strchr(argv, '/')) {
+               family = strsep(&argv, "/");
+               key = strsep(&argv, "\0");
                if (!family || !key) {
-                       ast_log (LOG_DEBUG, "Ignoring; Syntax error in argument\n");
+                       ast_log(LOG_DEBUG, "Ignoring; Syntax error in argument\n");
+                       LOCAL_USER_REMOVE(u);
                        return 0;
                }
                if (option_verbose > 2)
-                       ast_verbose (VERBOSE_PREFIX_3 "DBdel: family=%s, key=%s\n", family, key);
-               if (ast_db_del (family, key)) {
+                       ast_verbose(VERBOSE_PREFIX_3 "DBdel: family=%s, key=%s\n", family, key);
+               if (ast_db_del(family, key)) {
                        if (option_verbose > 2)
-                               ast_verbose (VERBOSE_PREFIX_3 "DBdel: Error deleting key from database.\n");
+                               ast_verbose(VERBOSE_PREFIX_3 "DBdel: Error deleting key from database.\n");
                }
        } else {
-               ast_log (LOG_DEBUG, "Ignoring, no parameters\n");
+               ast_log(LOG_DEBUG, "Ignoring, no parameters\n");
        }
+
+       LOCAL_USER_REMOVE(u);
+       
        return 0;
 }
 
-static int put_exec (struct ast_channel *chan, void *data)
+static int put_exec(struct ast_channel *chan, void *data)
 {
-       int arglen;
        char *argv, *value, *family, *key;
+       static int dep_warning = 0;
+       struct localuser *u;
 
-       arglen = strlen (data);
-       argv = alloca (arglen + 1);
-       if (!argv) {    /* Why would this fail? */
-               ast_log (LOG_DEBUG, "Memory allocation failed\n");
+       LOCAL_USER_ADD(u);
+
+       if (!dep_warning) {
+               ast_log(LOG_WARNING, "This application has been deprecated, please use the ${DB(family/key)} function instead.\n");
+               dep_warning = 1;
+       }
+       
+       argv = ast_strdupa(data);
+       if (!argv) {
+               ast_log(LOG_ERROR, "Memory allocation failed\n");
+               LOCAL_USER_REMOVE(u);
                return 0;
        }
-       memcpy (argv, data, arglen + 1);
 
-       if (strchr (argv, '/') && strchr (argv, '=')) {
-               family = strsep (&argv, "/");
-               key = strsep (&argv, "=");
-               value = strsep (&argv, "\0");
+       if (strchr(argv, '/') && strchr(argv, '=')) {
+               family = strsep(&argv, "/");
+               key = strsep(&argv, "=");
+               value = strsep(&argv, "\0");
                if (!value || !family || !key) {
-                       ast_log (LOG_DEBUG, "Ignoring; Syntax error in argument\n");
+                       ast_log(LOG_DEBUG, "Ignoring; Syntax error in argument\n");
+                       LOCAL_USER_REMOVE(u);
                        return 0;
                }
                if (option_verbose > 2)
-                       ast_verbose (VERBOSE_PREFIX_3 "DBput: family=%s, key=%s, value=%s\n", family, key, value);
-               if (ast_db_put (family, key, value)) {
+                       ast_verbose(VERBOSE_PREFIX_3 "DBput: family=%s, key=%s, value=%s\n", family, key, value);
+               if (ast_db_put(family, key, value)) {
                        if (option_verbose > 2)
-                               ast_verbose (VERBOSE_PREFIX_3 "DBput: Error writing value to database.\n");
+                               ast_verbose(VERBOSE_PREFIX_3 "DBput: Error writing value to database.\n");
                }
 
        } else  {
                ast_log (LOG_DEBUG, "Ignoring, no parameters\n");
        }
+
+       LOCAL_USER_REMOVE(u);
+
        return 0;
 }
 
-static int get_exec (struct ast_channel *chan, void *data)
+static int get_exec(struct ast_channel *chan, void *data)
 {
-       int arglen;
-       char *argv, *varname, *family, *key;
+       char *argv, *varname, *family, *key, *options = NULL;
        char dbresult[256];
+       static int dep_warning = 0;
+       int priority_jump = 0;
+       struct localuser *u;
 
-       arglen = strlen (data);
-       argv = alloca (arglen + 1);
-       if (!argv) {    /* Why would this fail? */
-               ast_log (LOG_DEBUG, "Memory allocation failed\n");
+       LOCAL_USER_ADD(u);
+
+       if (!dep_warning) {
+               ast_log(LOG_WARNING, "This application has been deprecated, please use the ${DB(family/key)} function instead.\n");
+               dep_warning = 1;
+       }
+       
+       argv = ast_strdupa(data);
+       if (!argv) {
+               ast_log(LOG_ERROR, "Memory allocation failed\n");
+               LOCAL_USER_REMOVE(u);
                return 0;
        }
-       memcpy (argv, data, arglen + 1);
 
-       if (strchr (argv, '=') && strchr (argv, '/')) {
-               varname = strsep (&argv, "=");
-               family = strsep (&argv, "/");
-               key = strsep (&argv, "\0");
+       if (strchr(argv, '=') && strchr(argv, '/')) {
+               varname = strsep(&argv, "=");
+               family = strsep(&argv, "/");
+               if (strchr((void *)&argv, '|')) {
+                       key = strsep(&argv, "|");
+                       options = strsep(&argv, "\0");
+               } else
+                       key = strsep(&argv, "\0");
+                       
                if (!varname || !family || !key) {
-                       ast_log (LOG_DEBUG, "Ignoring; Syntax error in argument\n");
+                       ast_log(LOG_DEBUG, "Ignoring; Syntax error in argument\n");
+                       LOCAL_USER_REMOVE(u);
                        return 0;
                }
+
+               if (options) {
+                       if (strchr(options, 'j'))
+                               priority_jump = 1;
+               }
+                       
                if (option_verbose > 2)
-                       ast_verbose (VERBOSE_PREFIX_3 "DBget: varname=%s, family=%s, key=%s\n", varname, family, key);
-               if (!ast_db_get (family, key, dbresult, sizeof (dbresult) - 1)) {
-                       pbx_builtin_setvar_helper (chan, varname, dbresult);
+                       ast_verbose(VERBOSE_PREFIX_3 "DBget: varname=%s, family=%s, key=%s\n", varname, family, key);
+               if (!ast_db_get(family, key, dbresult, sizeof (dbresult) - 1)) {
+                       pbx_builtin_setvar_helper(chan, varname, dbresult);
                        if (option_verbose > 2)
-                               ast_verbose (VERBOSE_PREFIX_3 "DBget: set variable %s to %s\n", varname, dbresult);
+                               ast_verbose(VERBOSE_PREFIX_3 "DBget: set variable %s to %s\n", varname, dbresult);
+                       pbx_builtin_setvar_helper(chan, "DBGETSTATUS", "FOUND");
                } else {
                        if (option_verbose > 2)
-                       ast_verbose (VERBOSE_PREFIX_3 "DBget: Value not found in database.\n");
-                       /* Send the call to n+101 priority, where n is the current priority */
-                       if (ast_exists_extension (chan, chan->context, chan->exten, chan->priority + 101, chan->cid.cid_num))
-                               chan->priority += 100;
+                       ast_verbose(VERBOSE_PREFIX_3 "DBget: Value not found in database.\n");
+                       if (priority_jump || option_priority_jumping) {
+                               /* Send the call to n+101 priority, where n is the current priority */
+                               ast_goto_if_exists(chan, chan->context, chan->exten, chan->priority + 101);
+                       }
+                       pbx_builtin_setvar_helper(chan, "DBGETSTATUS", "NOTFOUND");
                }
-
        } else {
-               ast_log (LOG_DEBUG, "Ignoring, no parameters\n");
+               ast_log(LOG_DEBUG, "Ignoring, no parameters\n");
        }
+
+       LOCAL_USER_REMOVE(u);
+
        return 0;
 }
 
-int unload_module (void)
+int unload_module(void)
 {
        int retval;
 
+       retval = ast_unregister_application(dt_app);
+       retval |= ast_unregister_application(d_app);
+       retval |= ast_unregister_application(p_app);
+       retval |= ast_unregister_application(g_app);
+
        STANDARD_HANGUP_LOCALUSERS;
-       retval = ast_unregister_application (dt_app);
-       retval |= ast_unregister_application (d_app);
-       retval |= ast_unregister_application (p_app);
-       retval |= ast_unregister_application (g_app);
 
        return retval;
 }
 
-int load_module (void)
+int load_module(void)
 {
        int retval;
 
-       retval = ast_register_application (g_app, get_exec, g_synopsis, g_descrip);
-       if (!retval)
-               retval = ast_register_application (p_app, put_exec, p_synopsis, p_descrip);
-       if (!retval)
-               retval = ast_register_application (d_app, del_exec, d_synopsis, d_descrip);
-       if (!retval)
-               retval = ast_register_application (dt_app, deltree_exec, dt_synopsis, dt_descrip);
+       retval = ast_register_application(g_app, get_exec, g_synopsis, g_descrip);
+       retval |= ast_register_application(p_app, put_exec, p_synopsis, p_descrip);
+       retval |= ast_register_application(d_app, del_exec, d_synopsis, d_descrip);
+       retval |= ast_register_application(dt_app, deltree_exec, dt_synopsis, dt_descrip);
+       
        return retval;
 }
 
-char *description (void)
+char *description(void)
 {
        return tdesc;
 }
 
-int usecount (void)
+int usecount(void)
 {
        int res;
-       STANDARD_USECOUNT (res);
+       STANDARD_USECOUNT(res);
        return res;
 }
 
-char *key ()
+char *key()
 {
        return ASTERISK_GPL_KEY;
 }