Doxygen documentation update from oej (issue #5505)
[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  */
23
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <unistd.h>
27 #include <string.h>
28
29 #include "asterisk.h"
30
31 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
32
33 #include "asterisk/file.h"
34 #include "asterisk/logger.h"
35 #include "asterisk/options.h"
36 #include "asterisk/channel.h"
37 #include "asterisk/pbx.h"
38 #include "asterisk/module.h"
39 #include "asterisk/say.h"
40
41
42 static char *tdesc = "Say time";
43
44 static char *app_sayunixtime = "SayUnixTime";
45 static char *app_datetime = "DateTime";
46
47 static char *sayunixtime_synopsis = "Says a specified time in a custom format";
48
49 static char *sayunixtime_descrip =
50 "SayUnixTime([unixtime][|[timezone][|format]])\n"
51 "  unixtime: time, in seconds since Jan 1, 1970.  May be negative.\n"
52 "              defaults to now.\n"
53 "  timezone: timezone, see /usr/share/zoneinfo for a list.\n"
54 "              defaults to machine default.\n"
55 "  format:   a format the time is to be said in.  See voicemail.conf.\n"
56 "              defaults to \"ABdY 'digits/at' IMp\"\n"
57 "  Returns 0 or -1 on hangup.\n";
58 static char *datetime_descrip =
59 "DateTime([unixtime][|[timezone][|format]])\n"
60 "  unixtime: time, in seconds since Jan 1, 1970.  May be negative.\n"
61 "              defaults to now.\n"
62 "  timezone: timezone, see /usr/share/zoneinfo for a list.\n"
63 "              defaults to machine default.\n"
64 "  format:   a format the time is to be said in.  See voicemail.conf.\n"
65 "              defaults to \"ABdY 'digits/at' IMp\"\n"
66 "  Returns 0 or -1 on hangup.\n";
67
68 STANDARD_LOCAL_USER;
69
70 LOCAL_USER_DECL;
71
72 static int sayunixtime_exec(struct ast_channel *chan, void *data)
73 {
74         int res=0;
75         struct localuser *u;
76         char *s,*zone=NULL,*timec,*format;
77         time_t unixtime;
78         struct timeval tv;
79         
80         LOCAL_USER_ADD(u);
81
82         tv = ast_tvnow();
83         unixtime = (time_t)tv.tv_sec;
84
85         if( !strcasecmp(chan->language, "da" ) ) {
86                 format = "A dBY HMS";
87         } else if ( !strcasecmp(chan->language, "de" ) ) {
88                 format = "A dBY HMS";
89         } else {
90                 format = "ABdY 'digits/at' IMp";
91         } 
92
93         if (data) {
94                 s = data;
95                 s = ast_strdupa(s);
96                 if (s) {
97                         timec = strsep(&s,"|");
98                         if ((timec) && (*timec != '\0')) {
99                                 long timein;
100                                 if (sscanf(timec,"%ld",&timein) == 1) {
101                                         unixtime = (time_t)timein;
102                                 }
103                         }
104                         if (s) {
105                                 zone = strsep(&s,"|");
106                                 if (zone && (*zone == '\0'))
107                                         zone = NULL;
108                                 if (s) {
109                                         format = s;
110                                 }
111                         }
112                 } else {
113                         ast_log(LOG_ERROR, "Out of memory error\n");
114                 }
115         }
116
117         if (chan->_state != AST_STATE_UP) {
118                 res = ast_answer(chan);
119         }
120         if (!res)
121                 res = ast_say_date_with_format(chan, unixtime, AST_DIGIT_ANY, chan->language, format, zone);
122
123         LOCAL_USER_REMOVE(u);
124         return res;
125 }
126
127 int unload_module(void)
128 {
129         int res;
130         
131         res = ast_unregister_application(app_sayunixtime);
132         res |= ast_unregister_application(app_datetime);
133
134         STANDARD_HANGUP_LOCALUSERS;
135         
136         return res;
137 }
138
139 int load_module(void)
140 {
141         int res;
142         
143         res = ast_register_application(app_sayunixtime, sayunixtime_exec, sayunixtime_synopsis, sayunixtime_descrip);
144         res |= ast_register_application(app_datetime, sayunixtime_exec, sayunixtime_synopsis, datetime_descrip);
145         
146         return res;
147 }
148
149 char *description(void)
150 {
151         return tdesc;
152 }
153
154 int usecount(void)
155 {
156         int res;
157         STANDARD_USECOUNT(res);
158         return res;
159 }
160
161 char *key()
162 {
163         return ASTERISK_GPL_KEY;
164 }