add 'consumed' argument to ast_get_time_t, so callers can know how many characters...
[asterisk/asterisk.git] / apps / app_sayunixtime.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (c) 2003, 2006 Tilghman Lesher.  All rights reserved.
5  * Copyright (c) 2006 Digium, Inc.
6  *
7  * Tilghman Lesher <app_sayunixtime__200309@the-tilghman.com>
8  *
9  * This code is released by the author with no restrictions on usage.
10  *
11  * See http://www.asterisk.org for more information about
12  * the Asterisk project. Please do not directly contact
13  * any of the maintainers of this project for assistance;
14  * the project provides a web site, mailing lists and IRC
15  * channels for your use.
16  *
17  */
18
19 /*! \file
20  *
21  * \brief SayUnixTime application
22  *
23  * \author Tilghman Lesher <app_sayunixtime__200309@the-tilghman.com>
24  * 
25  * \ingroup applications
26  */
27
28 #include <stdio.h>
29 #include <stdlib.h>
30 #include <unistd.h>
31 #include <string.h>
32
33 #include "asterisk.h"
34
35 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
36
37 #include "asterisk/file.h"
38 #include "asterisk/logger.h"
39 #include "asterisk/options.h"
40 #include "asterisk/channel.h"
41 #include "asterisk/pbx.h"
42 #include "asterisk/module.h"
43 #include "asterisk/say.h"
44 #include "asterisk/app.h"
45
46 static char *tdesc = "Say time";
47
48 static char *app_sayunixtime = "SayUnixTime";
49 static char *app_datetime = "DateTime";
50
51 static char *sayunixtime_synopsis = "Says a specified time in a custom format";
52
53 static char *sayunixtime_descrip =
54 "SayUnixTime([unixtime][|[timezone][|format]])\n"
55 "  unixtime: time, in seconds since Jan 1, 1970.  May be negative.\n"
56 "              defaults to now.\n"
57 "  timezone: timezone, see /usr/share/zoneinfo for a list.\n"
58 "              defaults to machine default.\n"
59 "  format:   a format the time is to be said in.  See voicemail.conf.\n"
60 "              defaults to \"ABdY 'digits/at' IMp\"\n";
61 static char *datetime_descrip =
62 "DateTime([unixtime][|[timezone][|format]])\n"
63 "  unixtime: time, in seconds since Jan 1, 1970.  May be negative.\n"
64 "              defaults to now.\n"
65 "  timezone: timezone, see /usr/share/zoneinfo for a list.\n"
66 "              defaults to machine default.\n"
67 "  format:   a format the time is to be said in.  See voicemail.conf.\n"
68 "              defaults to \"ABdY 'digits/at' IMp\"\n";
69
70 LOCAL_USER_DECL;
71
72 static int sayunixtime_exec(struct ast_channel *chan, void *data)
73 {
74         AST_DECLARE_APP_ARGS(args,
75                              AST_APP_ARG(timeval);
76                              AST_APP_ARG(timezone);
77                              AST_APP_ARG(format);
78         );
79         char *parse;
80         int res = 0;
81         struct localuser *u;
82         time_t unixtime;
83         
84         if (!data)
85                 return 0;
86
87         if (!(parse = ast_strdupa(data)))
88                 return -1;
89
90         LOCAL_USER_ADD(u);
91
92         args.format = "c";              /* default datetime */
93
94         AST_STANDARD_APP_ARGS(args, parse);
95
96         ast_get_time_t(args.timeval, &unixtime, time(NULL), NULL);
97
98         if (chan->_state != AST_STATE_UP)
99                 res = ast_answer(chan);
100
101         if (!res)
102                 res = ast_say_date_with_format(chan, unixtime, AST_DIGIT_ANY,
103                                                chan->language, args.format, args.timezone);
104
105         LOCAL_USER_REMOVE(u);
106
107         return res;
108 }
109
110 int unload_module(void)
111 {
112         int res;
113         
114         res = ast_unregister_application(app_sayunixtime);
115         res |= ast_unregister_application(app_datetime);
116
117         STANDARD_HANGUP_LOCALUSERS;
118         
119         return res;
120 }
121
122 int load_module(void)
123 {
124         int res;
125         
126         res = ast_register_application(app_sayunixtime, sayunixtime_exec, sayunixtime_synopsis, sayunixtime_descrip);
127         res |= ast_register_application(app_datetime, sayunixtime_exec, sayunixtime_synopsis, datetime_descrip);
128         
129         return res;
130 }
131
132 char *description(void)
133 {
134         return tdesc;
135 }
136
137 int usecount(void)
138 {
139         int res;
140         STANDARD_USECOUNT(res);
141         return res;
142 }
143
144 char *key()
145 {
146         return ASTERISK_GPL_KEY;
147 }