Fri Nov 12 12:02:28 2010

Asterisk developer's documentation

func_env.c File Reference

Environment related dialplan functions. More...

#include "asterisk.h"
#include <sys/stat.h>
#include "asterisk/module.h"
#include "asterisk/channel.h"
#include "asterisk/pbx.h"
#include "asterisk/utils.h"
#include "asterisk/app.h"
Include dependency graph for func_env.c:

Go to the source code of this file.

Functions

static void __reg_module (void)
static void __unreg_module (void)
static int env_read (struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
static int env_write (struct ast_channel *chan, const char *cmd, char *data, const char *value)
static int file_read (struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
static int load_module (void)
static int stat_read (struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t len)
static int unload_module (void)

Variables

static struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "Environment/filesystem dialplan functions" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = "0901e4e500243c855563a2d78b0c03e4" , .load = load_module, .unload = unload_module, }
static struct ast_module_info * ast_module_info = &__mod_info
static struct ast_custom_function env_function
static struct ast_custom_function file_function
static struct ast_custom_function stat_function

Detailed Description

Environment related dialplan functions.

Definition in file func_env.c.

Function Documentation

static void __reg_module ( void   )  [static]

Definition at line 268 of file func_env.c.

static void __unreg_module ( void   )  [static]

Definition at line 268 of file func_env.c.

static int env_read ( struct ast_channel *  chan,
const char *  cmd,
char *  data,
char *  buf,
size_t  len 
) [static]

Definition at line 90 of file func_env.c.

References ast_copy_string().

00092 {
00093    char *ret = NULL;
00094 
00095    *buf = '\0';
00096 
00097    if (data)
00098       ret = getenv(data);
00099 
00100    if (ret)
00101       ast_copy_string(buf, ret, len);
00102 
00103    return 0;
00104 }

static int env_write ( struct ast_channel *  chan,
const char *  cmd,
char *  data,
const char *  value 
) [static]

Definition at line 106 of file func_env.c.

References ast_strlen_zero().

00108 {
00109    if (!ast_strlen_zero(data)) {
00110       if (!ast_strlen_zero(value)) {
00111          setenv(data, value, 1);
00112       } else {
00113          unsetenv(data);
00114       }
00115    }
00116 
00117    return 0;
00118 }

static int file_read ( struct ast_channel *  chan,
const char *  cmd,
char *  data,
char *  buf,
size_t  len 
) [static]

Definition at line 163 of file func_env.c.

References AST_APP_ARG, ast_copy_string(), AST_DECLARE_APP_ARGS, ast_free, ast_log(), ast_read_textfile(), AST_STANDARD_APP_ARGS, and LOG_WARNING.

00164 {
00165    AST_DECLARE_APP_ARGS(args,
00166       AST_APP_ARG(filename);
00167       AST_APP_ARG(offset);
00168       AST_APP_ARG(length);
00169    );
00170    int offset = 0, length, res = 0;
00171    char *contents;
00172    size_t contents_len;
00173 
00174    AST_STANDARD_APP_ARGS(args, data);
00175    if (args.argc > 1) {
00176       offset = atoi(args.offset);
00177    }
00178 
00179    if (args.argc > 2) {
00180       /* The +1/-1 in this code section is to accomodate for the terminating NULL. */
00181       if ((length = atoi(args.length) + 1) > len) {
00182          ast_log(LOG_WARNING, "Length %d is greater than the max (%d).  Truncating output.\n", length - 1, (int)len - 1);
00183          length = len;
00184       }
00185    } else {
00186       length = len;
00187    }
00188 
00189    if (!(contents = ast_read_textfile(args.filename))) {
00190       return -1;
00191    }
00192 
00193    do {
00194       contents_len = strlen(contents);
00195       if (offset > contents_len) {
00196          res = -1;
00197          break;
00198       }
00199 
00200       if (offset >= 0) {
00201          if (length < 0) {
00202             if (contents_len - offset + length < 0) {
00203                /* Nothing left after trimming */
00204                res = -1;
00205                break;
00206             }
00207             ast_copy_string(buf, &contents[offset], contents_len + length);
00208          } else {
00209             ast_copy_string(buf, &contents[offset], length);
00210          }
00211       } else {
00212          if (offset * -1 > contents_len) {
00213             ast_log(LOG_WARNING, "Offset is larger than the file size.\n");
00214             offset = contents_len * -1;
00215          }
00216          ast_copy_string(buf, &contents[contents_len + offset], length);
00217       }
00218    } while (0);
00219 
00220    ast_free(contents);
00221 
00222    return res;
00223 }

static int load_module ( void   )  [static]

Definition at line 257 of file func_env.c.

References ast_custom_function_register.

00258 {
00259    int res = 0;
00260 
00261    res |= ast_custom_function_register(&env_function);
00262    res |= ast_custom_function_register(&stat_function);
00263    res |= ast_custom_function_register(&file_function);
00264 
00265    return res;
00266 }

static int stat_read ( struct ast_channel *  chan,
const char *  cmd,
char *  data,
char *  buf,
size_t  len 
) [static]

Definition at line 120 of file func_env.c.

References ast_copy_string().

00122 {
00123    char *action;
00124    struct stat s;
00125 
00126    ast_copy_string(buf, "0", len);
00127 
00128    action = strsep(&data, ",");
00129    if (stat(data, &s)) {
00130       return 0;
00131    } else {
00132       switch (*action) {
00133       case 'e':
00134          strcpy(buf, "1");
00135          break;
00136       case 's':
00137          snprintf(buf, len, "%d", (unsigned int) s.st_size);
00138          break;
00139       case 'f':
00140          snprintf(buf, len, "%d", S_ISREG(s.st_mode) ? 1 : 0);
00141          break;
00142       case 'd':
00143          snprintf(buf, len, "%d", S_ISDIR(s.st_mode) ? 1 : 0);
00144          break;
00145       case 'M':
00146          snprintf(buf, len, "%d", (int) s.st_mtime);
00147          break;
00148       case 'A':
00149          snprintf(buf, len, "%d", (int) s.st_mtime);
00150          break;
00151       case 'C':
00152          snprintf(buf, len, "%d", (int) s.st_ctime);
00153          break;
00154       case 'm':
00155          snprintf(buf, len, "%o", (int) s.st_mode);
00156          break;
00157       }
00158    }
00159 
00160    return 0;
00161 }

static int unload_module ( void   )  [static]

Definition at line 246 of file func_env.c.

References ast_custom_function_unregister().

00247 {
00248    int res = 0;
00249 
00250    res |= ast_custom_function_unregister(&env_function);
00251    res |= ast_custom_function_unregister(&stat_function);
00252    res |= ast_custom_function_unregister(&file_function);
00253 
00254    return res;
00255 }

Variable Documentation

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_DEFAULT , .description = "Environment/filesystem dialplan functions" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = "0901e4e500243c855563a2d78b0c03e4" , .load = load_module, .unload = unload_module, } [static]

Definition at line 268 of file func_env.c.

struct ast_module_info* ast_module_info = &__mod_info [static]

Definition at line 268 of file func_env.c.

struct ast_custom_function env_function [static]
Initial value:
 {
   .name = "ENV",
   .read = env_read,
   .write = env_write
}

Definition at line 225 of file func_env.c.

struct ast_custom_function file_function [static]
Initial value:
 {
   .name = "FILE",
   .read = file_read
   
}

Definition at line 236 of file func_env.c.

struct ast_custom_function stat_function [static]
Initial value:
 {
   .name = "STAT",
   .read = stat_read
}

Definition at line 231 of file func_env.c.

Generated by  doxygen 1.6.2