app_sayunixtime.c File Reference

SayUnixTime application. More...

#include "asterisk.h"
#include "asterisk/file.h"
#include "asterisk/channel.h"
#include "asterisk/pbx.h"
#include "asterisk/module.h"
#include "asterisk/say.h"
#include "asterisk/app.h"

Include dependency graph for app_sayunixtime.c:

Go to the source code of this file.

Enumerations
enum	{ OPT_JUMP = (1 << 0) }
enum	{ OPT_ARG_JUMP = 0 , OPT_ARG_ARRAY_SIZE }

Functions
static void	__reg_module (void)
static void	__unreg_module (void)
struct ast_module *	AST_MODULE_SELF_SYM (void)
static int	load_module (void)
static int	sayunixtime_exec (struct ast_channel *chan, const char *data)
static int	unload_module (void)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Say time" , .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 = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, .support_level = AST_MODULE_SUPPORT_CORE, }
static char *	app_datetime = "DateTime"
static char *	app_sayunixtime = "SayUnixTime"
static const struct ast_module_info *	ast_module_info = &__mod_info
static const struct ast_app_option	sayunixtime_exec_options [128] = { [ 'j' ] = { .flag = OPT_JUMP , .arg_index = OPT_ARG_JUMP + 1 }, }

Detailed Description

SayUnixTime application.

Author

Tilghman Lesher app_s.nosp@m.ayun.nosp@m.ixtim.nosp@m.e__2.nosp@m.00309.nosp@m.@the.nosp@m.-tilg.nosp@m.hman.nosp@m..com

Definition in file app_sayunixtime.c.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
OPT_JUMP

Definition at line 107 of file app_sayunixtime.c.

     {
    OPT_JUMP =          (1 << 0),
};

anonymous enum

anonymous enum

Enumerator
OPT_ARG_JUMP
OPT_ARG_ARRAY_SIZE

Definition at line 111 of file app_sayunixtime.c.

     {
    OPT_ARG_JUMP = 0,
    /* note: this entry _MUST_ be the last one in the enum */
    OPT_ARG_ARRAY_SIZE,
};

Function Documentation

__reg_module()

static void __reg_module ( void  )

static

Definition at line 199 of file app_sayunixtime.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 199 of file app_sayunixtime.c.

AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM

(

void

)

Definition at line 199 of file app_sayunixtime.c.

load_module()

static int load_module ( void  )

static

Definition at line 189 of file app_sayunixtime.c.

{
    int res;
 
    res = ast_register_application_xml(app_sayunixtime, sayunixtime_exec);
    res |= ast_register_application_xml(app_datetime, sayunixtime_exec);
 
    return res;
}

References app_datetime, app_sayunixtime, ast_register_application_xml, and sayunixtime_exec().

sayunixtime_exec()

static int sayunixtime_exec ( struct ast_channel *  chan, const char *  data  )

static

Definition at line 124 of file app_sayunixtime.c.

{
    AST_DECLARE_APP_ARGS(args,
        AST_APP_ARG(timeval);
        AST_APP_ARG(timezone);
        AST_APP_ARG(format);
        AST_APP_ARG(options);
    );
    char *parse;
    int res = 0;
    time_t unixtime;
    /* New default behavior is do not jump on key pressed */
    const char * haltondigits = AST_DIGIT_NONE;
    struct ast_flags64 opts = { 0, };
    char *opt_args[OPT_ARG_ARRAY_SIZE];
    const char *interrupt_string;
 
    if (!data) {
        return 0;
    }
 
    parse = ast_strdupa(data);
 
    AST_STANDARD_APP_ARGS(args, parse);
 
    /* check if we had the 'j' jump flag in option list */
    if (!ast_strlen_zero(args.options)) {
        ast_app_parse_options64(sayunixtime_exec_options, &opts, opt_args, args.options);
        if (ast_test_flag64(&opts, OPT_JUMP)){
            haltondigits = AST_DIGIT_ANY;
        }
    }
 
    /* Check if 'SAY_DTMF_INTERRUPT' is true and apply the same behavior as the j flag. */
    ast_channel_lock(chan);
    interrupt_string = pbx_builtin_getvar_helper(chan, "SAY_DTMF_INTERRUPT");
    if (ast_true(interrupt_string)) {
        haltondigits = AST_DIGIT_ANY;
    }
    ast_channel_unlock(chan);
 
    ast_get_time_t(ast_strlen_zero(args.timeval) ? NULL : args.timeval, &unixtime, time(NULL), NULL);
 
    if (ast_channel_state(chan) != AST_STATE_UP) {
        res = ast_answer(chan);
    }
 
    if (!res) {
        res = ast_say_date_with_format(chan, unixtime, haltondigits,
                           ast_channel_language(chan), ast_strlen_zero(args.format) ? NULL : args.format, ast_strlen_zero(args.timezone) ? NULL : args.timezone);
    }
 
    return res;
}

References args, ast_answer(), AST_APP_ARG, ast_app_parse_options64(), ast_channel_language(), ast_channel_lock, ast_channel_unlock, AST_DECLARE_APP_ARGS, AST_DIGIT_ANY, AST_DIGIT_NONE, ast_get_time_t(), ast_say_date_with_format, AST_STANDARD_APP_ARGS, AST_STATE_UP, ast_strdupa, ast_strlen_zero(), ast_test_flag64, ast_true(), NULL, OPT_ARG_ARRAY_SIZE, OPT_JUMP, options, pbx_builtin_getvar_helper(), and sayunixtime_exec_options.

Referenced by load_module().

unload_module()

static int unload_module ( void  )

static

Definition at line 179 of file app_sayunixtime.c.

{
    int res;
 
    res = ast_unregister_application(app_sayunixtime);
    res |= ast_unregister_application(app_datetime);
 
    return res;
}

References app_datetime, app_sayunixtime, and ast_unregister_application().

Variable Documentation

__mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Say time" , .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 = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, .support_level = AST_MODULE_SUPPORT_CORE, }

static

Definition at line 199 of file app_sayunixtime.c.

app_datetime

char* app_datetime = "DateTime"

static

Definition at line 122 of file app_sayunixtime.c.

Referenced by load_module(), and unload_module().

app_sayunixtime

char* app_sayunixtime = "SayUnixTime"

static

Definition at line 121 of file app_sayunixtime.c.

Referenced by load_module(), and unload_module().

ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 199 of file app_sayunixtime.c.

sayunixtime_exec_options

const struct ast_app_option sayunixtime_exec_options[128] = { [ 'j' ] = { .flag = OPT_JUMP , .arg_index = OPT_ARG_JUMP + 1 }, }

static

Definition at line 119 of file app_sayunixtime.c.

Referenced by sayunixtime_exec().