1 /* Icinga 2 | (c) 2012 Icinga GmbH | GPLv2+ */
3 #include "icinga/legacytimeperiod.hpp"
4 #include "base/function.hpp"
5 #include "base/convert.hpp"
6 #include "base/exception.hpp"
7 #include "base/objectlock.hpp"
8 #include "base/logger.hpp"
9 #include "base/debug.hpp"
10 #include "base/utility.hpp"
12 using namespace icinga;
14 REGISTER_FUNCTION_NONCONST(Internal, LegacyTimePeriod, &LegacyTimePeriod::ScriptFunc, "tp:begin:end");
16 bool LegacyTimePeriod::IsInTimeRange(tm *begin, tm *end, int stride, tm *reference)
18 time_t tsbegin, tsend, tsref;
19 tsbegin = mktime(begin);
21 tsref = mktime(reference);
23 if (tsref < tsbegin || tsref > tsend)
26 int daynumber = (tsref - tsbegin) / (24 * 60 * 60);
28 if (stride > 1 && daynumber % stride > 0)
34 void LegacyTimePeriod::FindNthWeekday(int wday, int n, tm *reference)
44 /* Negative days are relative to the next month. */
50 reference->tm_mday = 1;
55 if (reference->tm_wday == wday) {
62 reference->tm_mday += dir;
66 int LegacyTimePeriod::WeekdayFromString(const String& daydef)
68 if (daydef == "sunday")
70 else if (daydef == "monday")
72 else if (daydef == "tuesday")
74 else if (daydef == "wednesday")
76 else if (daydef == "thursday")
78 else if (daydef == "friday")
80 else if (daydef == "saturday")
86 int LegacyTimePeriod::MonthFromString(const String& monthdef)
88 if (monthdef == "january")
90 else if (monthdef == "february")
92 else if (monthdef == "march")
94 else if (monthdef == "april")
96 else if (monthdef == "may")
98 else if (monthdef == "june")
100 else if (monthdef == "july")
102 else if (monthdef == "august")
104 else if (monthdef == "september")
106 else if (monthdef == "october")
108 else if (monthdef == "november")
110 else if (monthdef == "december")
116 void LegacyTimePeriod::ParseTimeSpec(const String& timespec, tm *begin, tm *end, tm *reference)
118 /* Let mktime() figure out whether we're in DST or not. */
119 reference->tm_isdst = -1;
122 if (timespec.GetLength() == 10 && timespec[4] == '-' && timespec[7] == '-') {
123 int year = Convert::ToLong(timespec.SubStr(0, 4));
124 int month = Convert::ToLong(timespec.SubStr(5, 2));
125 int day = Convert::ToLong(timespec.SubStr(8, 2));
127 if (month < 1 || month > 12)
128 BOOST_THROW_EXCEPTION(std::invalid_argument("Invalid month in time specification: " + timespec));
129 if (day < 1 || day > 31)
130 BOOST_THROW_EXCEPTION(std::invalid_argument("Invalid day in time specification: " + timespec));
134 begin->tm_year = year - 1900;
135 begin->tm_mon = month - 1;
136 begin->tm_mday = day;
144 end->tm_year = year - 1900;
145 end->tm_mon = month - 1;
155 std::vector<String> tokens = timespec.Split(" ");
159 if (tokens.size() > 1 && (tokens[0] == "day" || (mon = MonthFromString(tokens[0])) != -1)) {
161 mon = reference->tm_mon;
163 int mday = Convert::ToLong(tokens[1]);
168 begin->tm_mday = mday;
173 /* Negative days are relative to the next month. */
175 begin->tm_mday = mday * -1 - 1;
188 /* Negative days are relative to the next month. */
190 end->tm_mday = mday * -1 - 1;
200 if (tokens.size() >= 1 && (wday = WeekdayFromString(tokens[0])) != -1) {
201 tm myref = *reference;
203 if (tokens.size() > 2) {
204 mon = MonthFromString(tokens[2]);
207 BOOST_THROW_EXCEPTION(std::invalid_argument("Invalid month in time specification: " + timespec));
214 if (tokens.size() > 1)
215 n = Convert::ToLong(tokens[1]);
220 if (tokens.size() > 1)
221 FindNthWeekday(wday, n, begin);
223 begin->tm_mday += (7 - begin->tm_wday + wday) % 7;
233 if (tokens.size() > 1)
234 FindNthWeekday(wday, n, end);
236 end->tm_mday += (7 - end->tm_wday + wday) % 7;
247 BOOST_THROW_EXCEPTION(std::invalid_argument("Invalid time specification: " + timespec));
250 void LegacyTimePeriod::ParseTimeRange(const String& timerange, tm *begin, tm *end, int *stride, tm *reference)
252 String def = timerange;
254 /* Figure out the stride. */
255 size_t pos = def.FindFirstOf('/');
257 if (pos != String::NPos) {
258 String strStride = def.SubStr(pos + 1).Trim();
259 *stride = Convert::ToLong(strStride);
261 /* Remove the stride parameter from the definition. */
262 def = def.SubStr(0, pos);
264 *stride = 1; /* User didn't specify anything, assume default. */
267 /* Figure out whether the user has specified two dates. */
268 pos = def.Find("- ");
270 if (pos != String::NPos) {
271 String first = def.SubStr(0, pos).Trim();
273 String second = def.SubStr(pos + 1).Trim();
275 ParseTimeSpec(first, begin, nullptr, reference);
277 /* If the second definition starts with a number we need
278 * to add the first word from the first definition, e.g.:
279 * day 1 - 15 --> "day 15" */
280 bool is_number = true;
281 size_t xpos = second.FindFirstOf(' ');
282 String fword = second.SubStr(0, xpos);
285 Convert::ToLong(fword);
291 xpos = first.FindFirstOf(' ');
292 ASSERT(xpos != String::NPos);
293 second = first.SubStr(0, xpos + 1) + second;
296 ParseTimeSpec(second, nullptr, end, reference);
298 ParseTimeSpec(def, begin, end, reference);
302 bool LegacyTimePeriod::IsInDayDefinition(const String& daydef, tm *reference)
307 ParseTimeRange(daydef, &begin, &end, &stride, reference);
309 Log(LogDebug, "LegacyTimePeriod")
310 << "ParseTimeRange: '" << daydef << "' => " << mktime(&begin)
311 << " -> " << mktime(&end) << ", stride: " << stride;
313 return IsInTimeRange(&begin, &end, stride, reference);
316 void LegacyTimePeriod::ProcessTimeRangeRaw(const String& timerange, tm *reference, tm *begin, tm *end)
318 std::vector<String> times = timerange.Split("-");
320 if (times.size() != 2)
321 BOOST_THROW_EXCEPTION(std::invalid_argument("Invalid timerange: " + timerange));
323 std::vector<String> hd1 = times[0].Split(":");
326 BOOST_THROW_EXCEPTION(std::invalid_argument("Invalid time specification: " + times[0]));
328 std::vector<String> hd2 = times[1].Split(":");
331 BOOST_THROW_EXCEPTION(std::invalid_argument("Invalid time specification: " + times[1]));
335 begin->tm_min = Convert::ToLong(hd1[1]);
336 begin->tm_hour = Convert::ToLong(hd1[0]);
340 end->tm_min = Convert::ToLong(hd2[1]);
341 end->tm_hour = Convert::ToLong(hd2[0]);
343 if (begin->tm_hour * 3600 + begin->tm_min * 60 + begin->tm_sec >=
344 end->tm_hour * 3600 + end->tm_min * 60 + end->tm_sec)
345 BOOST_THROW_EXCEPTION(std::invalid_argument("Time period segment ends before it begins"));
348 Dictionary::Ptr LegacyTimePeriod::ProcessTimeRange(const String& timestamp, tm *reference)
352 ProcessTimeRangeRaw(timestamp, reference, &begin, &end);
354 return new Dictionary({
355 { "begin", (long)mktime(&begin) },
356 { "end", (long)mktime(&end) }
360 void LegacyTimePeriod::ProcessTimeRanges(const String& timeranges, tm *reference, const Array::Ptr& result)
362 std::vector<String> ranges = timeranges.Split(",");
364 for (const String& range : ranges) {
365 Dictionary::Ptr segment = ProcessTimeRange(range, reference);
367 if (segment->Get("begin") >= segment->Get("end"))
370 result->Add(segment);
374 Dictionary::Ptr LegacyTimePeriod::FindRunningSegment(const String& daydef, const String& timeranges, tm *reference)
377 time_t tsend, tsiter, tsref;
380 tsref = mktime(reference);
382 ParseTimeRange(daydef, &begin, &end, &stride, reference);
386 tsend = mktime(&end);
389 if (IsInTimeRange(&begin, &end, stride, &iter)) {
390 Array::Ptr segments = new Array();
391 ProcessTimeRanges(timeranges, &iter, segments);
393 Dictionary::Ptr bestSegment;
396 ObjectLock olock(segments);
397 for (const Dictionary::Ptr& segment : segments) {
398 double begin = segment->Get("begin");
399 double end = segment->Get("end");
401 if (begin >= tsref || end < tsref)
404 if (!bestSegment || end > bestEnd) {
405 bestSegment = segment;
418 tsiter = mktime(&iter);
419 } while (tsiter < tsend);
424 Dictionary::Ptr LegacyTimePeriod::FindNextSegment(const String& daydef, const String& timeranges, tm *reference)
426 tm begin, end, iter, ref;
427 time_t tsend, tsiter, tsref;
430 for (int pass = 1; pass <= 2; pass++) {
438 tsref = mktime(&ref);
440 ParseTimeRange(daydef, &begin, &end, &stride, &ref);
444 tsend = mktime(&end);
447 if (IsInTimeRange(&begin, &end, stride, &iter)) {
448 Array::Ptr segments = new Array();
449 ProcessTimeRanges(timeranges, &iter, segments);
451 Dictionary::Ptr bestSegment;
454 ObjectLock olock(segments);
455 for (const Dictionary::Ptr& segment : segments) {
456 double begin = segment->Get("begin");
461 if (!bestSegment || begin < bestBegin) {
462 bestSegment = segment;
475 tsiter = mktime(&iter);
476 } while (tsiter < tsend);
482 Array::Ptr LegacyTimePeriod::ScriptFunc(const TimePeriod::Ptr& tp, double begin, double end)
484 Array::Ptr segments = new Array();
486 Dictionary::Ptr ranges = tp->GetRanges();
489 for (int i = 0; i <= (end - begin) / (24 * 60 * 60); i++) {
490 time_t refts = begin + i * 24 * 60 * 60;
491 tm reference = Utility::LocalTime(refts);
494 Log(LogDebug, "LegacyTimePeriod")
495 << "Checking reference time " << refts;
496 #endif /* I2_DEBUG */
498 ObjectLock olock(ranges);
499 for (const Dictionary::Pair& kv : ranges) {
500 if (!IsInDayDefinition(kv.first, &reference)) {
502 Log(LogDebug, "LegacyTimePeriod")
503 << "Not in day definition '" << kv.first << "'.";
504 #endif /* I2_DEBUG */
509 Log(LogDebug, "LegacyTimePeriod")
510 << "In day definition '" << kv.first << "'.";
511 #endif /* I2_DEBUG */
513 ProcessTimeRanges(kv.second, &reference, segments);
518 Log(LogDebug, "LegacyTimePeriod")
519 << "Legacy timeperiod update returned " << segments->GetLength() << " segments.";