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