Doxygen update
[asterisk/asterisk.git] / funcs / func_env.c
index a4a5162..20af016 100644 (file)
@@ -1,7 +1,7 @@
 /*
  * Asterisk -- An open source telephony toolkit.
  *
- * Copyright (C) 1999 - 2005, Digium, Inc.
+ * Copyright (C) 1999 - 2006, Digium, Inc.
  *
  * See http://www.asterisk.org for more information about
  * the Asterisk project. Please do not directly contact
  *
  * \brief Environment related dialplan functions
  * 
+ * \ingroup functions
  */
 
+#include "asterisk.h"
+
+ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
+
+#include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 #include <sys/types.h>
 #include <sys/stat.h>
 
-#include "asterisk.h"
-
-/* ASTERISK_FILE_VERSION(__FILE__, "$Revision$") */
-
+#include "asterisk/module.h"
 #include "asterisk/channel.h"
 #include "asterisk/pbx.h"
 #include "asterisk/logger.h"
 #include "asterisk/utils.h"
 #include "asterisk/app.h"
 
-static char *builtin_function_env_read(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len) 
+static int env_read(struct ast_channel *chan, const char *cmd, char *data,
+                   char *buf, size_t len)
 {
-       char *ret = "";
+       char *ret = NULL;
 
-       if (data) {
+       *buf = '\0';
+
+       if (data)
                ret = getenv(data);
-               if (!ret)
-                       ret = "";
-       }
-       ast_copy_string(buf, ret, len);
 
-       return buf;
+       if (ret)
+               ast_copy_string(buf, ret, len);
+
+       return 0;
 }
 
-static void builtin_function_env_write(struct ast_channel *chan, char *cmd, char *data, const char *value) 
+static int env_write(struct ast_channel *chan, const char *cmd, char *data,
+                    const char *value)
 {
        if (!ast_strlen_zero(data)) {
                if (!ast_strlen_zero(value)) {
@@ -58,29 +64,28 @@ static void builtin_function_env_write(struct ast_channel *chan, char *cmd, char
                        unsetenv(data);
                }
        }
+
+       return 0;
 }
 
-static char *builtin_function_stat_read(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len)
+static int stat_read(struct ast_channel *chan, const char *cmd, char *data,
+                    char *buf, size_t len)
 {
        char *action;
        struct stat s;
 
-       ast_copy_string(buf, "0", len);
-       if (!data) {
-               ast_log(LOG_ERROR, "Out of memory\n");
-               return buf;
-       }
+       *buf = '\0';
 
        action = strsep(&data, "|");
        if (stat(data, &s)) {
-               return buf;
+               return -1;
        } else {
                switch (*action) {
                case 'e':
-                       ast_copy_string(buf, "1", len);
+                       strcpy(buf, "1");
                        break;
                case 's':
-                       snprintf(buf, len, "%d", (unsigned int)s.st_size);
+                       snprintf(buf, len, "%d", (unsigned int) s.st_size);
                        break;
                case 'f':
                        snprintf(buf, len, "%d", S_ISREG(s.st_mode) ? 1 : 0);
@@ -89,50 +94,66 @@ static char *builtin_function_stat_read(struct ast_channel *chan, char *cmd, cha
                        snprintf(buf, len, "%d", S_ISDIR(s.st_mode) ? 1 : 0);
                        break;
                case 'M':
-                       snprintf(buf, len, "%d", (int)s.st_mtime);
+                       snprintf(buf, len, "%d", (int) s.st_mtime);
                        break;
                case 'A':
-                       snprintf(buf, len, "%d", (int)s.st_mtime);
+                       snprintf(buf, len, "%d", (int) s.st_mtime);
                        break;
                case 'C':
-                       snprintf(buf, len, "%d", (int)s.st_ctime);
+                       snprintf(buf, len, "%d", (int) s.st_ctime);
                        break;
                case 'm':
-                       snprintf(buf, len, "%o", (int)s.st_mode);
+                       snprintf(buf, len, "%o", (int) s.st_mode);
                        break;
                }
        }
-       return buf;
+
+       return 0;
 }
 
-#ifndef BUILTIN_FUNC
-static
-#endif
-struct ast_custom_function env_function = {
+static struct ast_custom_function env_function = {
        .name = "ENV",
        .synopsis = "Gets or sets the environment variable specified",
        .syntax = "ENV(<envname>)",
-       .read = builtin_function_env_read,
-       .write = builtin_function_env_write,
+       .read = env_read,
+       .write = env_write,
 };
 
-#ifndef BUILTIN_FUNC
-static
-#endif
-struct ast_custom_function stat_function = {
+static struct ast_custom_function stat_function = {
        .name = "STAT",
        .synopsis = "Does a check on the specified file",
        .syntax = "STAT(<flag>,<filename>)",
-       .read = builtin_function_stat_read,
+       .read = stat_read,
        .desc =
-"flag may be one of the following:\n"
-"  d - Checks if the file is a directory\n"
-"  e - Checks if the file exists\n"
-"  f - Checks if the file is a regular file\n"
-"  m - Returns the file mode (in octal)\n"
-"  s - Returns the size (in bytes) of the file\n"
-"  A - Returns the epoch at which the file was last accessed\n"
-"  C - Returns the epoch at which the inode was last changed\n"
-"  M - Returns the epoch at which the file was last modified\n",
+               "flag may be one of the following:\n"
+               "  d - Checks if the file is a directory\n"
+               "  e - Checks if the file exists\n"
+               "  f - Checks if the file is a regular file\n"
+               "  m - Returns the file mode (in octal)\n"
+               "  s - Returns the size (in bytes) of the file\n"
+               "  A - Returns the epoch at which the file was last accessed\n"
+               "  C - Returns the epoch at which the inode was last changed\n"
+               "  M - Returns the epoch at which the file was last modified\n",
 };
 
+static int unload_module(void)
+{
+       int res = 0;
+
+       res |= ast_custom_function_unregister(&env_function);
+       res |= ast_custom_function_unregister(&stat_function);
+
+       return res;
+}
+
+static int load_module(void)
+{
+       int res = 0;
+
+       res |= ast_custom_function_register(&env_function);
+       res |= ast_custom_function_register(&stat_function);
+
+       return res;
+}
+
+AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Environment/filesystem dialplan functions");