feat: add TimeExclude filter

Author: timonegk

README.md

@@ -192,11 +192,16 @@ filters:
   # Events which cover the full day aren't synced
   - name: AllDayEvents
   # Events within the specified timeframe will be retained, while all others will be filtered out.
-  # hours are represented in the 24h time format
+  # hours are represented in the 24h time format (time is always UTC)
   - name: TimeFrame
     config:
       HourStart: 8
       HourEnd: 17
+  # Events within the specified timeframe will be excluded (time is always UTC)
+  - name: TimeFilter
+    config:
+      HourStart: 12
+      HourEnd: 13
   # Events where the title matches the ExcludeRegexp (RE2 Regex) aren't synced
   - name: RegexTitle
     config:

example.sync.yaml

@@ -64,11 +64,16 @@ filters:
   # Events which cover the full day aren't synced
   - name: AllDayEvents
   # Events within the specified timeframe will be retained, while all others will be filtered out.
-  # hours are represented in the 24h time format
+  # hours are represented in the 24h time format (time is always UTC)
   - name: TimeFrame
     config:
       HourStart: 8
       HourEnd: 17
+  # Events within the specified timeframe will be excluded (time is always UTC)
+  - name: TimeFilter
+    config:
+      HourStart: 12
+      HourEnd: 13
   # Events where the title matches the ExcludeRegexp (RE2 Regex) aren't synced
   - name: RegexTitle
     config:

internal/filter/timeFilter.go

@@ -0,0 +1,34 @@
+package filter
+
+import (
+	"github.com/inovex/CalendarSync/internal/models"
+)
+
+type TimeFilterEvents struct {
+	HourStart int
+	HourEnd   int
+}
+
+func (a TimeFilterEvents) Name() string {
+	return "TimeFilter"
+}
+
+func (a TimeFilterEvents) Filter(event models.Event) bool {
+	// if it is an all-day event, it should not be filtered here,
+	// the AllDayEvents filter should be used instead
+	if event.AllDay {
+		return true
+	}
+
+	// if start time and end time are inside the timeframe: exclude
+	// example: event from 12:15-12:45, timeframe is 12-13
+	// starttime and endtime are inside the timeframe
+	if event.StartTime.Hour() >= a.HourStart && event.EndTime.Hour() <= a.HourEnd {
+		return false
+	}
+
+	// if the endtime is inside the timeframe, but the starttime is outside,
+	// or if the starttime is inside the timeframe, but the endtime is outside,
+	// or in any other case: keep the event
+	return true
+}

internal/filter/timeFilter_test.go

@@ -0,0 +1,103 @@
+package filter_test
+
+import (
+	"testing"
+	"time"
+
+	"github.com/inovex/CalendarSync/internal/filter"
+	"github.com/inovex/CalendarSync/internal/models"
+)
+
+// Events which match the start and end hour should be kept
+func TestTimeFilterEventsFilter(t *testing.T) {
+	const timeFormat string = "2006-01-02T15:04"
+
+	t1, err := time.Parse(timeFormat, "2024-01-01T08:00")
+	if err != nil {
+		t.Error(err)
+	}
+
+	t2, err := time.Parse(timeFormat, "2024-01-01T12:15")
+	if err != nil {
+		t.Error(err)
+	}
+
+	t3, err := time.Parse(timeFormat, "2024-01-01T12:00")
+	if err != nil {
+		t.Error(err)
+	}
+
+	t4, err := time.Parse(timeFormat, "2024-01-01T13:00")
+	if err != nil {
+		t.Error(err)
+	}
+
+	sourceEvents := []models.Event{
+		// Should be kept (all-day event)
+		{
+			ICalUID:     "testId",
+			ID:          "testUid",
+			Title:       "all-day",
+			Description: "bar",
+			AllDay:      true,
+			StartTime:   t1,
+			EndTime:     t1.Add(time.Hour * 1),
+		},
+		// Should be kept, as Start AND Endtime are outside the excluded times
+		{
+			ICalUID:     "testId",
+			ID:          "testUid",
+			Title:       "outside frame",
+			Description: "bar",
+			AllDay:      false,
+			StartTime:   t1,
+			EndTime:     t1.Add(time.Hour * 1),
+		},
+		// Should be filtered, as the Start and EndTime are inside the excluded times
+		{
+			ICalUID:     "testId2",
+			ID:          "testUid2",
+			Title:       "inside frame",
+			Description: "bar",
+			AllDay:      false,
+			StartTime:   t2,
+			EndTime:     t2.Add(time.Minute * 30),
+		},
+		// Should be filtered, as the end time is part of the timeframe
+		{
+			ICalUID:     "testId4",
+			ID:          "inside frame 2",
+			Title:       "foo",
+			Description: "bar",
+			StartTime:   t2,
+			EndTime:     t2.Add(time.Minute * 45),
+		},
+		// Should be filtered, as start and end times are at exclusion borders
+		{
+			ICalUID:     "testId5",
+			ID:          "testUid4",
+			Title:       "inside frame 3",
+			Description: "bar",
+			StartTime:   t3,
+			EndTime:     t3.Add(time.Hour * 1),
+		},
+    // Should be kept, as the start time is at the end of the exclusion border
+		{
+			ICalUID:     "testId5",
+			ID:          "testUid4",
+			Title:       "outside frame 2",
+			Description: "bar",
+			StartTime:   t4,
+			EndTime:     t4.Add(time.Hour * 1),
+		},
+	}
+
+	expectedSinkEvents := []models.Event{sourceEvents[0], sourceEvents[1], sourceEvents[5]}
+
+	eventFilter := filter.TimeFilterEvents{
+		// Events from 12 to 13 should be filtered
+		HourStart: 12,
+		HourEnd:   13,
+	}
+	checkEventFilter(t, eventFilter, sourceEvents, expectedSinkEvents)
+}

internal/filter/timeFrame_test.go

@@ -8,10 +8,10 @@ import (
 	"github.com/inovex/CalendarSync/internal/models"
 )
 
-const timeFormat string = "2006-01-02T15:04"
-
 // Events which match the start and end hour should be kept
 func TestTimeFrameEventsFilter(t *testing.T) {
+  const timeFormat string = "2006-01-02T15:04"
+
 	t1, err := time.Parse(timeFormat, "2024-01-01T13:00")
 	if err != nil {
 		t.Error(err)

internal/sync/filter.go

@@ -31,13 +31,15 @@ func FilterEvent(event models.Event, filters ...Filter) (result bool) {
 var (
 	filterConfigMapping = map[string]Filter{
 		"TimeFrame":      &filter.TimeFrameEvents{},
+		"TimeFilter":     &filter.TimeFilterEvents{},
 		"DeclinedEvents": &filter.DeclinedEvents{},
 		"AllDayEvents":   &filter.AllDayEvents{},
 		"RegexTitle":     &filter.RegexTitle{},
 	}
 
 	filterOrder = []string{
 		"TimeFrame",
+		"TimeFilter",
 		"DeclinedEvents",
 		"AllDayEvents",
 		"RegexTitle",