DateTools: ICalEvent: add helper class for reccuring ical events

ICalEvent allows checking if a given point in time is inside a specific ical time span defined by start-time, stop-time and reoccurence rule (RRULE)

refs #10481

src/datetools.cpp

@@ -609,4 +609,39 @@ namespace dss {
bool TimeStamp::operator<(const TimeStamp &o) const {
return timespec_cmp(&m_stamp, &o.m_stamp, <);
}
+
+  ICalEvent::ICalEvent(const std::string& _rrule, const std::string& _startDate, const std::string& _endDate) {
+    m_Recurrence = icalrecurrencetype_from_string(_rrule.c_str());
+    m_StartDate = icaltime_from_string(_startDate.c_str());
+    m_Duration = icaltime_subtract(icaltime_from_string(_endDate.c_str()), m_StartDate);
+  }
+
+  ICalEvent::~ICalEvent() {
+    icalrecurrencetype_clear(&m_Recurrence);
+  }
+
+  bool ICalEvent::isDateInside(const DateTime& _date) {
+    bool ret = false;
+    time_t t0 = _date.secondsSinceEpoch()/* + _date.getTimezoneOffset()*/;
+    struct icaltimetype iDate = icaltime_from_timet(t0, 0);
+
+    icalrecur_iterator* iCalIterator = icalrecur_iterator_new(m_Recurrence, m_StartDate);
+    if (!iCalIterator) {
+      return false;
+    }
+    struct icaltimetype rule_time;
+
+    while (!icaltime_is_null_time(rule_time = icalrecur_iterator_next(iCalIterator))) {
+      if (icaltime_compare(iDate, rule_time) < 0) {
+        break;
+      }
+      if (icaltime_compare(iDate, rule_time) >= 0 && icaltime_compare(iDate, icaltime_add(rule_time, m_Duration)) < 0) {
+        ret = true;
+        break;
+      }
+    }
+
+    icalrecur_iterator_free(iCalIterator);
+    return ret;
+  }
}

src/datetools.h

@@ -261,6 +261,18 @@ namespace dss {
virtual DateTime getNextOccurence(const DateTime& _from) ;
}; // ICalSchedule
+
+  class ICalEvent {
+    __DECL_LOG_CHANNEL__
+  private:
+    struct icalrecurrencetype m_Recurrence;
+    struct icaltimetype m_StartDate;
+    struct icaldurationtype m_Duration;
+  public:
+    ICalEvent(const std::string& _rrule, const std::string& _startDate, const std::string& _endDate);
+    ~ICalEvent();
+    bool isDateInside(const DateTime& _date);
+  }; // ICalEvent
#endif
class TimeStamp {

tests/datetoolstests.cpp

@@ -287,6 +287,46 @@ BOOST_AUTO_TEST_CASE(testDynamicScheduleICal) {
BOOST_CHECK_EQUAL(firstRecurr.getMinute() % 2, 0);
BOOST_CHECK(firstRecurr.secondsSinceEpoch() - now.secondsSinceEpoch() <= 120);
} // testDynamicScheduleICal
+
+BOOST_AUTO_TEST_CASE(testICalEvent) {
+  ICalEvent event("FREQ=DAILY;BYMONTH=7;UNTIL=20160801T000000Z", "20150707T150000Z", "20150707T170000Z");
+
+  BOOST_CHECK_EQUAL(event.isDateInside(DateTime::parseRFC2445("20150707T130000Z")), false);
+  BOOST_CHECK_EQUAL(event.isDateInside(DateTime::parseRFC2445("20150707T150000Z")), true);
+  BOOST_CHECK_EQUAL(event.isDateInside(DateTime::parseRFC2445("20150707T160000Z")), true);
+  BOOST_CHECK_EQUAL(event.isDateInside(DateTime::parseRFC2445("20150707T170000Z")), false);
+  BOOST_CHECK_EQUAL(event.isDateInside(DateTime::parseRFC2445("20150707T180000Z")), false);
+  // next day
+  BOOST_CHECK_EQUAL(event.isDateInside(DateTime::parseRFC2445("20150708T130000Z")), false);
+  BOOST_CHECK_EQUAL(event.isDateInside(DateTime::parseRFC2445("20150708T160000Z")), true);
+  BOOST_CHECK_EQUAL(event.isDateInside(DateTime::parseRFC2445("20150708T180000Z")), false);
+  // next month
+  BOOST_CHECK_EQUAL(event.isDateInside(DateTime::parseRFC2445("20150808T130000Z")), false);
+  BOOST_CHECK_EQUAL(event.isDateInside(DateTime::parseRFC2445("20150808T160000Z")), false);
+  BOOST_CHECK_EQUAL(event.isDateInside(DateTime::parseRFC2445("20150808T180000Z")), false);
+  // next following year
+  BOOST_CHECK_EQUAL(event.isDateInside(DateTime::parseRFC2445("20160707T130000Z")), false);
+  BOOST_CHECK_EQUAL(event.isDateInside(DateTime::parseRFC2445("20160707T160000Z")), true);
+  BOOST_CHECK_EQUAL(event.isDateInside(DateTime::parseRFC2445("20160707T180000Z")), false);
+  // the year after
+  BOOST_CHECK_EQUAL(event.isDateInside(DateTime::parseRFC2445("20170707T130000Z")), false);
+  BOOST_CHECK_EQUAL(event.isDateInside(DateTime::parseRFC2445("20170707T160000Z")), false);
+  BOOST_CHECK_EQUAL(event.isDateInside(DateTime::parseRFC2445("20170707T180000Z")), false);
+} // testICalEvent
+
+BOOST_AUTO_TEST_CASE(testICalEventNight) {
+  ICalEvent event("FREQ=DAILY;BYMONTH=7;UNTIL=20160801T000000Z", "20150707T213000Z", "20150708T053000Z");
+
+  BOOST_CHECK_EQUAL(event.isDateInside(DateTime::parseRFC2445("20150707T130000Z")), false);
+  BOOST_CHECK_EQUAL(event.isDateInside(DateTime::parseRFC2445("20150707T220000Z")), true);
+  BOOST_CHECK_EQUAL(event.isDateInside(DateTime::parseRFC2445("20150708T010000Z")), true);
+  BOOST_CHECK_EQUAL(event.isDateInside(DateTime::parseRFC2445("20150708T060000Z")), false);
+  // next night
+  BOOST_CHECK_EQUAL(event.isDateInside(DateTime::parseRFC2445("20150708T130000Z")), false);
+  BOOST_CHECK_EQUAL(event.isDateInside(DateTime::parseRFC2445("20150708T220000Z")), true);
+  BOOST_CHECK_EQUAL(event.isDateInside(DateTime::parseRFC2445("20150709T010000Z")), true);
+  BOOST_CHECK_EQUAL(event.isDateInside(DateTime::parseRFC2445("20150709T060000Z")), false);
+} // testICalEventNight
#endif
BOOST_AUTO_TEST_SUITE_END()