main/pbx: Move timing routines to pbx_timing.c.
[asterisk/asterisk.git] / main / pbx_timing.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2016, CFWare, LLC
5  *
6  * Corey Farrell <git@cfware.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief PBX timing routines.
22  *
23  * \author Corey Farrell <git@cfware.com>
24  */
25
26 /*** MODULEINFO
27         <support_level>core</support_level>
28  ***/
29
30 #include "asterisk.h"
31
32 ASTERISK_REGISTER_FILE()
33
34 #include "asterisk/localtime.h"
35 #include "asterisk/logger.h"
36 #include "asterisk/pbx.h"
37 #include "asterisk/strings.h"
38 #include "asterisk/utils.h"
39
40 /*! \brief Helper for get_range.
41  * return the index of the matching entry, starting from 1.
42  * If names is not supplied, try numeric values.
43  */
44 static int lookup_name(const char *s, const char * const names[], int max)
45 {
46         int i;
47
48         if (names && *s > '9') {
49                 for (i = 0; names[i]; i++) {
50                         if (!strcasecmp(s, names[i])) {
51                                 return i;
52                         }
53                 }
54         }
55
56         /* Allow months and weekdays to be specified as numbers, as well */
57         if (sscanf(s, "%2d", &i) == 1 && i >= 1 && i <= max) {
58                 /* What the array offset would have been: "1" would be at offset 0 */
59                 return i - 1;
60         }
61         return -1; /* error return */
62 }
63
64 /*! \brief helper function to return a range up to max (7, 12, 31 respectively).
65  * names, if supplied, is an array of names that should be mapped to numbers.
66  */
67 static unsigned get_range(char *src, int max, const char * const names[], const char *msg)
68 {
69         int start, end; /* start and ending position */
70         unsigned int mask = 0;
71         char *part;
72
73         /* Check for whole range */
74         if (ast_strlen_zero(src) || !strcmp(src, "*")) {
75                 return (1 << max) - 1;
76         }
77
78         while ((part = strsep(&src, "&"))) {
79                 /* Get start and ending position */
80                 char *endpart = strchr(part, '-');
81                 if (endpart) {
82                         *endpart++ = '\0';
83                 }
84                 /* Find the start */
85                 if ((start = lookup_name(part, names, max)) < 0) {
86                         ast_log(LOG_WARNING, "Invalid %s '%s', skipping element\n", msg, part);
87                         continue;
88                 }
89                 if (endpart) { /* find end of range */
90                         if ((end = lookup_name(endpart, names, max)) < 0) {
91                                 ast_log(LOG_WARNING, "Invalid end %s '%s', skipping element\n", msg, endpart);
92                                 continue;
93                         }
94                 } else {
95                         end = start;
96                 }
97                 /* Fill the mask. Remember that ranges are cyclic */
98                 mask |= (1 << end);   /* initialize with last element */
99                 while (start != end) {
100                         mask |= (1 << start);
101                         if (++start >= max) {
102                                 start = 0;
103                         }
104                 }
105         }
106         return mask;
107 }
108
109 /*! \brief store a bitmask of valid times, one bit each 1 minute */
110 static void get_timerange(struct ast_timing *i, char *times)
111 {
112         char *endpart, *part;
113         int x;
114         int st_h, st_m;
115         int endh, endm;
116         int minute_start, minute_end;
117
118         /* start disabling all times, fill the fields with 0's, as they may contain garbage */
119         memset(i->minmask, 0, sizeof(i->minmask));
120
121         /* 1-minute per bit */
122         /* Star is all times */
123         if (ast_strlen_zero(times) || !strcmp(times, "*")) {
124                 /* 48, because each hour takes 2 integers; 30 bits each */
125                 for (x = 0; x < 48; x++) {
126                         i->minmask[x] = 0x3fffffff; /* 30 bits */
127                 }
128                 return;
129         }
130         /* Otherwise expect a range */
131         while ((part = strsep(&times, "&"))) {
132                 if (!(endpart = strchr(part, '-'))) {
133                         if (sscanf(part, "%2d:%2d", &st_h, &st_m) != 2 || st_h < 0 || st_h > 23 || st_m < 0 || st_m > 59) {
134                                 ast_log(LOG_WARNING, "%s isn't a valid time.\n", part);
135                                 continue;
136                         }
137                         i->minmask[st_h * 2 + (st_m >= 30 ? 1 : 0)] |= (1 << (st_m % 30));
138                         continue;
139                 }
140                 *endpart++ = '\0';
141                 /* why skip non digits? Mostly to skip spaces */
142                 while (*endpart && !isdigit(*endpart)) {
143                         endpart++;
144                 }
145                 if (!*endpart) {
146                         ast_log(LOG_WARNING, "Invalid time range starting with '%s-'.\n", part);
147                         continue;
148                 }
149                 if (sscanf(part, "%2d:%2d", &st_h, &st_m) != 2 || st_h < 0 || st_h > 23 || st_m < 0 || st_m > 59) {
150                         ast_log(LOG_WARNING, "'%s' isn't a valid start time.\n", part);
151                         continue;
152                 }
153                 if (sscanf(endpart, "%2d:%2d", &endh, &endm) != 2 || endh < 0 || endh > 23 || endm < 0 || endm > 59) {
154                         ast_log(LOG_WARNING, "'%s' isn't a valid end time.\n", endpart);
155                         continue;
156                 }
157                 minute_start = st_h * 60 + st_m;
158                 minute_end = endh * 60 + endm;
159                 /* Go through the time and enable each appropriate bit */
160                 for (x = minute_start; x != minute_end; x = (x + 1) % (24 * 60)) {
161                         i->minmask[x / 30] |= (1 << (x % 30));
162                 }
163                 /* Do the last one */
164                 i->minmask[x / 30] |= (1 << (x % 30));
165         }
166         /* All done */
167         return;
168 }
169
170 static const char * const days[] =
171 {
172         "sun",
173         "mon",
174         "tue",
175         "wed",
176         "thu",
177         "fri",
178         "sat",
179         NULL,
180 };
181
182 static const char * const months[] =
183 {
184         "jan",
185         "feb",
186         "mar",
187         "apr",
188         "may",
189         "jun",
190         "jul",
191         "aug",
192         "sep",
193         "oct",
194         "nov",
195         "dec",
196         NULL,
197 };
198
199 /*! /brief Build timing
200  *
201  * /param i info
202  * /param info_in
203  *
204  */
205 int ast_build_timing(struct ast_timing *i, const char *info_in)
206 {
207         char *info;
208         int j, num_fields, last_sep = -1;
209
210         i->timezone = NULL;
211
212         /* Check for empty just in case */
213         if (ast_strlen_zero(info_in)) {
214                 return 0;
215         }
216
217         /* make a copy just in case we were passed a static string */
218         info = ast_strdupa(info_in);
219
220         /* count the number of fields in the timespec */
221         for (j = 0, num_fields = 1; info[j] != '\0'; j++) {
222                 if (info[j] == ',') {
223                         last_sep = j;
224                         num_fields++;
225                 }
226         }
227
228         /* save the timezone, if it is specified */
229         if (num_fields == 5) {
230                 i->timezone = ast_strdup(info + last_sep + 1);
231         }
232
233         /* Assume everything except time */
234         i->monthmask = 0xfff;   /* 12 bits */
235         i->daymask = 0x7fffffffU; /* 31 bits */
236         i->dowmask = 0x7f; /* 7 bits */
237         /* on each call, use strsep() to move info to the next argument */
238         get_timerange(i, strsep(&info, "|,"));
239         if (info)
240                 i->dowmask = get_range(strsep(&info, "|,"), 7, days, "day of week");
241         if (info)
242                 i->daymask = get_range(strsep(&info, "|,"), 31, NULL, "day");
243         if (info)
244                 i->monthmask = get_range(strsep(&info, "|,"), 12, months, "month");
245         return 1;
246 }
247
248 int ast_check_timing(const struct ast_timing *i)
249 {
250         return ast_check_timing2(i, ast_tvnow());
251 }
252
253 int ast_check_timing2(const struct ast_timing *i, const struct timeval tv)
254 {
255         struct ast_tm tm;
256
257         ast_localtime(&tv, &tm, i->timezone);
258
259         /* If it's not the right month, return */
260         if (!(i->monthmask & (1 << tm.tm_mon)))
261                 return 0;
262
263         /* If it's not that time of the month.... */
264         /* Warning, tm_mday has range 1..31! */
265         if (!(i->daymask & (1 << (tm.tm_mday-1))))
266                 return 0;
267
268         /* If it's not the right day of the week */
269         if (!(i->dowmask & (1 << tm.tm_wday)))
270                 return 0;
271
272         /* Sanity check the hour just to be safe */
273         if ((tm.tm_hour < 0) || (tm.tm_hour > 23)) {
274                 ast_log(LOG_WARNING, "Insane time...\n");
275                 return 0;
276         }
277
278         /* Now the tough part, we calculate if it fits
279            in the right time based on min/hour */
280         if (!(i->minmask[tm.tm_hour * 2 + (tm.tm_min >= 30 ? 1 : 0)] & (1 << (tm.tm_min >= 30 ? tm.tm_min - 30 : tm.tm_min))))
281                 return 0;
282
283         /* If we got this far, then we're good */
284         return 1;
285 }
286
287 int ast_destroy_timing(struct ast_timing *i)
288 {
289         if (i->timezone) {
290                 ast_free(i->timezone);
291                 i->timezone = NULL;
292         }
293         return 0;
294 }