Skip to content

Commit

Permalink
Added filter expression functions
Browse files Browse the repository at this point in the history
  • Loading branch information
@benfortuna
benfortuna committed Jul 28, 2021
1 parent fc3b7c4 commit 75db1d9
Show file tree
Hide file tree
Showing 4 changed files with 165 additions and 38 deletions.
41 changes: 3 additions & 38 deletions src/main/java/net/fortuna/ical4j/filter/FilterExpression.java
View file
Expand Up @@ -74,42 +74,7 @@ public FilterExpression notExists(String name) {
}

public static FilterExpression parse(String filterExpression) {
FilterExpression expression = new FilterExpression();
Arrays.stream(filterExpression.split("\\s*and\\s*")).forEach(part -> {
if (part.matches("[\\w-]+\\s*>=\\s*\\w+")) {
String[] greaterThanEqual = part.split("\\s*>=\\s*");
expression.greaterThanEqual(greaterThanEqual[0], greaterThanEqual[1]);
} else if (part.matches("[\\w-]+\\s*<=\\s*\\w+")) {
String[] lessThanEqual = part.split("\\s*<=\\s*");
expression.lessThanEqual(lessThanEqual[0], lessThanEqual[1]);
} else if (part.matches("[\\w-]+\\s*=\\s*[^<>=]+")) {
String[] equalTo = part.split("\\s*=\\s*");
expression.equalTo(equalTo[0], equalTo[1]);
} else if (part.matches("[\\w-]+\\s*>\\s*\\w+")) {
String[] greaterThan = part.split("\\s*>\\s*");
expression.greaterThan(greaterThan[0], greaterThan[1]);
} else if (part.matches("[\\w-]+\\s*<\\s*\\w+")) {
String[] lessThan = part.split("\\s*<\\s*");
expression.lessThan(lessThan[0], lessThan[1]);
} else if (part.matches("[\\w-]+\\s+in\\s+\\[[^<>=]+]")) {
String[] in = part.split("\\s*in\\s*");
List<String> items = Arrays.asList(in[1].replaceAll("[\\[\\]]", "")
.split("\\[?\\s*,\\s*]?"));
expression.in(in[0], items);
} else if (part.matches("[\\w-]+\\s+contains\\s+\".+\"")) {
String[] contains = part.split("\\s*contains\\s*");
expression.contains(contains[0], contains[1].replaceAll("^\"?|\"?$", ""));
} else if (part.matches("[\\w-]+\\s+exists")) {
String[] exists = part.split("\\s*exists");
expression.exists(exists[0]);
} else if (part.matches("[\\w-]+\\s+not exists")) {
String[] notExists = part.split("\\s*not exists");
expression.notExists(notExists[0]);
} else {
throw new IllegalArgumentException("Invalid filter expression: " + filterExpression);
}
});
return expression;
return new FilterExpressionParser().parse(filterExpression);
}

public static <T> Predicate<T> and(List<Predicate> predicates) {
Expand All @@ -135,8 +100,8 @@ public Predicate<Calendar> toCalendarPredicate() {
return p;
}

public Predicate<Component> toComponentPredicate() {
Predicate<Component> p = and(equalToMap.entrySet().stream()
public <T extends Component> Predicate<T> toComponentPredicate() {
Predicate<T> p = and(equalToMap.entrySet().stream()
.map(e -> new PropertyEqualToRule<>(e.getKey(), e.getValue()))
.collect(Collectors.toList()));
p = p.and(and(inMap.entrySet().stream()
Expand Down
138 changes: 138 additions & 0 deletions src/main/java/net/fortuna/ical4j/filter/FilterExpressionParser.java
View file
@@ -0,0 +1,138 @@
package net.fortuna.ical4j.filter;

import net.fortuna.ical4j.model.TemporalAmountAdapter;

import java.time.*;
import java.time.temporal.Temporal;
import java.time.temporal.TemporalAdjusters;
import java.time.temporal.TemporalAmount;
import java.time.temporal.WeekFields;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.function.Function;

/**
* Support for parsing a query string to produce a {@link FilterExpression} instance.
*/
public class FilterExpressionParser {

private static final Map<String, Function<String, ?>> FUNCTIONS = new HashMap<>();
static {
FUNCTIONS.put("now", (Function<String, Temporal>) s -> {
if (!s.isEmpty()) {
TemporalAmount temporalAmount = TemporalAmountAdapter.parse(s).getDuration();
return Instant.now().plus(temporalAmount);
}
return Instant.now();
});
FUNCTIONS.put("startOfDay", (Function<String, Temporal>) s -> {
if (!s.isEmpty()) {
TemporalAmount temporalAmount = TemporalAmountAdapter.parse(s).getDuration();
return LocalDate.now().atStartOfDay().plus(temporalAmount);
}
return LocalDate.now().atStartOfDay();
});
FUNCTIONS.put("endOfDay", (Function<String, Temporal>) s -> {
if (!s.isEmpty()) {
TemporalAmount temporalAmount = TemporalAmountAdapter.parse(s).getDuration();
return LocalDate.now().atTime(23, 59).plus(temporalAmount);
}
return LocalDate.now().atTime(23, 59);
});
FUNCTIONS.put("startOfWeek", (Function<String, Temporal>) s -> {
DayOfWeek first = WeekFields.ISO.getFirstDayOfWeek();
if (!s.isEmpty()) {
TemporalAmount temporalAmount = TemporalAmountAdapter.parse(s).getDuration();
return LocalDate.now().with(TemporalAdjusters.previousOrSame(first)).plus(temporalAmount);
}
return LocalDate.now().with(TemporalAdjusters.previousOrSame(first));
});
FUNCTIONS.put("endOfWeek", (Function<String, Temporal>) s -> {
DayOfWeek last = DayOfWeek.of(WeekFields.ISO.getMinimalDaysInFirstWeek());
if (!s.isEmpty()) {
TemporalAmount temporalAmount = TemporalAmountAdapter.parse(s).getDuration();
return LocalDate.now().with(TemporalAdjusters.nextOrSame(last)).plus(temporalAmount);
}
return LocalDate.now().with(TemporalAdjusters.nextOrSame(last));
});
FUNCTIONS.put("startOfMonth", (Function<String, Temporal>) s -> {
if (!s.isEmpty()) {
TemporalAmount temporalAmount = TemporalAmountAdapter.parse(s).getDuration();
return YearMonth.now().atDay(1).atStartOfDay().plus(temporalAmount);
}
return YearMonth.now().atDay(1).atStartOfDay();
});
FUNCTIONS.put("endOfMonth", (Function<String, Temporal>) s -> {
if (!s.isEmpty()) {
TemporalAmount temporalAmount = TemporalAmountAdapter.parse(s).getDuration();
return YearMonth.now().atEndOfMonth().atTime(23, 59).plus(temporalAmount);
}
return YearMonth.now().atEndOfMonth().atTime(23, 59);
});
FUNCTIONS.put("startOfYear", (Function<String, Temporal>) s -> {
if (!s.isEmpty()) {
TemporalAmount temporalAmount = TemporalAmountAdapter.parse(s).getDuration();
return Year.now().atMonth(1).atDay(1).atStartOfDay().plus(temporalAmount);
}
return Year.now().atMonth(1).atDay(1).atStartOfDay();
});
FUNCTIONS.put("endOfYear", (Function<String, Temporal>) s -> {
if (!s.isEmpty()) {
TemporalAmount temporalAmount = TemporalAmountAdapter.parse(s).getDuration();
return Year.now().atMonth(12).atEndOfMonth().atTime(23, 59).plus(temporalAmount);
}
return Year.now().atMonth(12).atEndOfMonth().atTime(23, 59);
});
}

public FilterExpression parse(String filterExpression) {
FilterExpression expression = new FilterExpression();
Arrays.stream(filterExpression.split("\\s*and\\s*")).forEach(part -> {
if (part.matches("[\\w-]+\\s*>=\\s*\\w+")) {
String[] greaterThanEqual = part.split("\\s*>=\\s*");
expression.greaterThanEqual(greaterThanEqual[0], resolveValue(greaterThanEqual[1]));
} else if (part.matches("[\\w-]+\\s*<=\\s*\\w+")) {
String[] lessThanEqual = part.split("\\s*<=\\s*");
expression.lessThanEqual(lessThanEqual[0], resolveValue(lessThanEqual[1]));
} else if (part.matches("[\\w-]+\\s*=\\s*[^<>=]+")) {
String[] equalTo = part.split("\\s*=\\s*");
expression.equalTo(equalTo[0], resolveValue(equalTo[1]));
} else if (part.matches("[\\w-]+\\s*>\\s*\\w+")) {
String[] greaterThan = part.split("\\s*>\\s*");
expression.greaterThan(greaterThan[0], resolveValue(greaterThan[1]));
} else if (part.matches("[\\w-]+\\s*<\\s*\\w+")) {
String[] lessThan = part.split("\\s*<\\s*");
expression.lessThan(lessThan[0], resolveValue(lessThan[1]));
} else if (part.matches("[\\w-]+\\s+in\\s+\\[[^<>=]+]")) {
String[] in = part.split("\\s*in\\s*");
List<String> items = Arrays.asList(in[1].replaceAll("[\\[\\]]", "")
.split("\\[?\\s*,\\s*]?"));
expression.in(in[0], items);
} else if (part.matches("[\\w-]+\\s+contains\\s+\".+\"")) {
String[] contains = part.split("\\s*contains\\s*");
expression.contains(contains[0], contains[1].replaceAll("^\"?|\"?$", ""));
} else if (part.matches("[\\w-]+\\s+exists")) {
String[] exists = part.split("\\s*exists");
expression.exists(exists[0]);
} else if (part.matches("[\\w-]+\\s+not exists")) {
String[] notExists = part.split("\\s*not exists");
expression.notExists(notExists[0]);
} else {
throw new IllegalArgumentException("Invalid filter expression: " + filterExpression);
}
});
return expression;
}

private Object resolveValue(String valueString) {
if (valueString.matches("\\w+\\(.*\\)")
&& FUNCTIONS.containsKey(valueString.replaceAll("\\(.*\\)", ""))) {
return FUNCTIONS.get(valueString.replaceAll("\\(.*\\)", ""))
.apply(valueString.split("\\(|\\)")[1]);
} else {
return valueString;
}
}
}
9 changes: 9 additions & 0 deletions src/main/java/net/fortuna/ical4j/filter/PropertyLessThanRule.java
View file
@@ -1,8 +1,13 @@
package net.fortuna.ical4j.filter;

import net.fortuna.ical4j.model.Component;
import net.fortuna.ical4j.model.property.DateProperty;
import net.fortuna.ical4j.model.property.Sequence;

import java.time.Instant;
import java.time.temporal.Temporal;
import java.util.Arrays;
import java.util.Date;
import java.util.function.Predicate;

/**
Expand Down Expand Up @@ -36,6 +41,10 @@ public boolean test(T t) {
return inclusive ? sequence.getSequenceNo() <= Integer.parseInt(value.toString())
: sequence.getSequenceNo() < Integer.parseInt(value.toString());
}
} else if (Arrays.asList("due").contains(propertyName)) {
DateProperty dateProperty = t.getProperty(propertyName);
return inclusive ? dateProperty.getDate().compareTo(Date.from(Instant.from((Temporal) value))) < 0
: dateProperty.getDate().compareTo(Date.from(Instant.from((Temporal) value))) <= 0;
}
return false;
}
Expand Down
15 changes: 15 additions & 0 deletions src/test/groovy/net/fortuna/ical4j/filter/FilterExpressionTest.groovy
View file
Expand Up @@ -43,6 +43,21 @@ class FilterExpressionTest extends Specification {
filter.toComponentPredicate().test(event)
}

def 'test filter expression equals function'() {
given: 'a filter expression'
def filter = new FilterExpression().lessThanEqual('due', 'now(-P1D)')

and: 'an event'
def event = builder.vevent {
organizer(organiser)
attendee(attendee)
due '20210727T000000'
}

expect: 'filter matches the event'
filter.toComponentPredicate().test(event)
}

def 'test filter expression equals parameter'() {
given: 'a filter expression'
def filter = new FilterExpression().equalTo('role', Role.CHAIR)
Expand Down

0 comments on commit 75db1d9

Please sign in to comment.