Skip to content

Commit

Permalink
Merge pull request #1175 from abicky/support-l-and-lw-with-other-days…
Browse files Browse the repository at this point in the history 
…-of-month

Support for specifying 'L' and 'LW' with other days in day-of-month field
  • Loading branch information
@jhouserizer
jhouserizer authored Oct 14, 2024
2 parents 25e11b8 + b8d1628 commit f3bbe5a
Show file tree
Hide file tree
Showing 2 changed files with 103 additions and 114 deletions.
181 changes: 74 additions & 107 deletions quartz/src/main/java/org/quartz/CronExpression.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
import java.util.Iterator;
import java.util.Locale;
import java.util.Map;
import java.util.Optional;
import java.util.SortedSet;
import java.util.StringTokenizer;
import java.util.TimeZone;
Expand Down Expand Up @@ -217,6 +218,9 @@ public final class CronExpression implements Serializable, Cloneable {
protected static final int YEAR = 6;
protected static final int ALL_SPEC_INT = 99; // '*'
protected static final int NO_SPEC_INT = 98; // '?'
protected static final int MAX_LAST_DAY_OFFSET = 30;
protected static final int LAST_DAY_OFFSET_START = 32; // "L-30"
protected static final int LAST_DAY_OFFSET_END = LAST_DAY_OFFSET_START + MAX_LAST_DAY_OFFSET; // 'L'
protected static final Integer ALL_SPEC = ALL_SPEC_INT;
protected static final Integer NO_SPEC = NO_SPEC_INT;

Expand Down Expand Up @@ -251,15 +255,13 @@ public final class CronExpression implements Serializable, Cloneable {
protected transient TreeSet<Integer> minutes;
protected transient TreeSet<Integer> hours;
protected transient TreeSet<Integer> daysOfMonth;
protected transient TreeSet<Integer> nearestWeekdays;
protected transient TreeSet<Integer> months;
protected transient TreeSet<Integer> daysOfWeek;
protected transient TreeSet<Integer> years;

protected transient boolean lastDayOfWeek = false;
protected transient int nthDayOfWeek = 0;
protected transient boolean lastDayOfMonth = false;
protected transient boolean nearestWeekday = false;
protected transient int lastDayOffset = 0;
protected transient boolean expressionParsed = false;

public static final int MAX_YEAR = Calendar.getInstance().get(Calendar.YEAR) + 100;
Expand Down Expand Up @@ -459,6 +461,9 @@ protected void buildExpression(String expression) throws ParseException {
if (daysOfMonth == null) {
daysOfMonth = new TreeSet<Integer>();
}
if (nearestWeekdays == null) {
nearestWeekdays = new TreeSet<Integer>();
}
if (months == null) {
months = new TreeSet<Integer>();
}
Expand All @@ -477,10 +482,6 @@ protected void buildExpression(String expression) throws ParseException {
while (exprsTok.hasMoreTokens() && exprOn <= YEAR) {
String expr = exprsTok.nextToken().trim();

// throw an exception if L is used with other days of the month
if(exprOn == DAY_OF_MONTH && expr.indexOf('L') != -1 && expr.length() > 1 && expr.contains(",")) {
throw new ParseException("Support for specifying 'L' and 'LW' with other days of the month is not implemented", -1);
}
// throw an exception if L is used with other days of the week
if(exprOn == DAY_OF_WEEK && expr.indexOf('L') != -1 && expr.length() > 1 && expr.contains(",")) {
throw new ParseException("Support for specifying 'L' with other days of the week is not implemented", -1);
Expand Down Expand Up @@ -616,9 +617,8 @@ protected int storeExpressionVals(int pos, String s, int type)
"'?' can only be specified for Day-of-Month or Day-of-Week.",
i);
}
if (type == DAY_OF_WEEK && !lastDayOfMonth) {
int val = daysOfMonth.last();
if (val == NO_SPEC_INT) {
if (type == DAY_OF_WEEK) {
if (!daysOfMonth.isEmpty() && daysOfMonth.last() == NO_SPEC_INT) {
throw new ParseException(
"'?' can only be specified for Day-of-Month -OR- Day-of-Week.",
i);
Expand Down Expand Up @@ -662,28 +662,35 @@ protected int storeExpressionVals(int pos, String s, int type)
return i;
} else if (c == 'L') {
i++;
if (type == DAY_OF_MONTH) {
lastDayOfMonth = true;
}
if (type == DAY_OF_WEEK) {
addToSet(7, 7, 0, type);
}
if(type == DAY_OF_MONTH && s.length() > i) {
c = s.charAt(i);
if(c == '-') {
ValueSet vs = getValue(0, s, i+1);
lastDayOffset = vs.value;
if(lastDayOffset > 30)
throw new ParseException("Offset from last day must be <= 30", i+1);
i = vs.pos;
}
if(s.length() > i) {
if (type == DAY_OF_MONTH) {
int dom = LAST_DAY_OFFSET_END;
boolean nearestWeekday = false;
if (s.length() > i) {
c = s.charAt(i);
if(c == 'W') {
nearestWeekday = true;
i++;
if (c == '-') {
ValueSet vs = getValue(0, s, i + 1);
int offset = vs.value;
if (offset > MAX_LAST_DAY_OFFSET)
throw new ParseException("Offset from last day must be <= " + MAX_LAST_DAY_OFFSET, i + 1);
dom -= offset;
i = vs.pos;
}
if (s.length() > i) {
c = s.charAt(i);
if (c == 'W') {
nearestWeekday = true;
i++;
}
}
}
if (nearestWeekday) {
nearestWeekdays.add(dom);
} else {
daysOfMonth.add(dom);
}
}
return i;
} else if (c >= '0' && c <= '9') {
Expand Down Expand Up @@ -750,15 +757,12 @@ protected int checkNext(int pos, String s, int val, int type)
}

if (c == 'W') {
if (type == DAY_OF_MONTH) {
nearestWeekday = true;
} else {
if (type != DAY_OF_MONTH) {
throw new ParseException("'W' option is not valid here. (pos=" + i + ")", i);
}
if(val > 31)
throw new ParseException("The 'W' option does not make sense with values larger than 31 (max number of days in a month)", i);
TreeSet<Integer> set = getSet(type);
set.add(val);
throw new ParseException("The 'W' option does not make sense with values larger than 31 (max number of days in a month)", i);
nearestWeekdays.add(val);
i++;
return i;
}
Expand Down Expand Up @@ -878,6 +882,9 @@ public String getExpressionSummary() {
buf.append("daysOfMonth: ");
buf.append(getExpressionSetSummary(daysOfMonth));
buf.append("\n");
buf.append("nearestWeekdays: ");
buf.append(getExpressionSetSummary(nearestWeekdays));
buf.append("\n");
buf.append("months: ");
buf.append(getExpressionSetSummary(months));
buf.append("\n");
Expand All @@ -887,15 +894,9 @@ public String getExpressionSummary() {
buf.append("lastDayOfWeek: ");
buf.append(lastDayOfWeek);
buf.append("\n");
buf.append("nearestWeekday: ");
buf.append(nearestWeekday);
buf.append("\n");
buf.append("nthDayOfWeek: ");
buf.append("NthDayOfWeek: ");
buf.append(nthDayOfWeek);
buf.append("\n");
buf.append("lastDayOfMonth: ");
buf.append(lastDayOfMonth);
buf.append("\n");
buf.append("years: ");
buf.append(getExpressionSetSummary(years));
buf.append("\n");
Expand Down Expand Up @@ -1267,61 +1268,12 @@ public Date getTimeAfter(Date afterTime) {
boolean dayOfMSpec = !daysOfMonth.contains(NO_SPEC);
boolean dayOfWSpec = !daysOfWeek.contains(NO_SPEC);
if (dayOfMSpec && !dayOfWSpec) { // get day by day of month rule
st = daysOfMonth.tailSet(day);
if (lastDayOfMonth) {
if(!nearestWeekday) {
t = day;
day = getLastDayOfMonth(mon, cl.get(Calendar.YEAR));
day -= lastDayOffset;
if(t > day) {
mon++;
if(mon > 12) {
mon = 1;
tmon = 3333; // ensure test of mon != tmon further below fails
cl.add(Calendar.YEAR, 1);
}
day = 1;
}
} else {
t = day;
day = getLastDayOfMonth(mon, cl.get(Calendar.YEAR));
day -= lastDayOffset;

java.util.Calendar tcal = java.util.Calendar.getInstance(getTimeZone());
tcal.set(Calendar.SECOND, 0);
tcal.set(Calendar.MINUTE, 0);
tcal.set(Calendar.HOUR_OF_DAY, 0);
tcal.set(Calendar.DAY_OF_MONTH, day);
tcal.set(Calendar.MONTH, mon - 1);
tcal.set(Calendar.YEAR, cl.get(Calendar.YEAR));

int ldom = getLastDayOfMonth(mon, cl.get(Calendar.YEAR));
int dow = tcal.get(Calendar.DAY_OF_WEEK);

if(dow == Calendar.SATURDAY && day == 1) {
day += 2;
} else if(dow == Calendar.SATURDAY) {
day -= 1;
} else if(dow == Calendar.SUNDAY && day == ldom) {
day -= 2;
} else if(dow == Calendar.SUNDAY) {
day += 1;
}

tcal.set(Calendar.SECOND, sec);
tcal.set(Calendar.MINUTE, min);
tcal.set(Calendar.HOUR_OF_DAY, hr);
tcal.set(Calendar.DAY_OF_MONTH, day);
tcal.set(Calendar.MONTH, mon - 1);
Date nTime = tcal.getTime();
if(nTime.before(afterTime)) {
day = 1;
mon++;
}
}
} else if(nearestWeekday) {
t = day;
day = daysOfMonth.first();
Optional<Integer> smallestDay = findSmallestDay(day, mon, cl.get(Calendar.YEAR), daysOfMonth);
Optional<Integer> smallestDayForWeekday = findSmallestDay(day, mon, cl.get(Calendar.YEAR), nearestWeekdays);
t = day;
day = -1;
if (smallestDayForWeekday.isPresent()) {
day = smallestDayForWeekday.get();

java.util.Calendar tcal = java.util.Calendar.getInstance(getTimeZone());
tcal.set(Calendar.SECOND, 0);
Expand Down Expand Up @@ -1352,23 +1304,17 @@ public Date getTimeAfter(Date afterTime) {
tcal.set(Calendar.MONTH, mon - 1);
Date nTime = tcal.getTime();
if(nTime.before(afterTime)) {
day = daysOfMonth.first();
mon++;
day = -1;
}
} else if (st != null && st.size() != 0) {
t = day;
day = st.first();
// make sure we don't over-run a short month, such as february
int lastDay = getLastDayOfMonth(mon, cl.get(Calendar.YEAR));
if (day > lastDay) {
day = daysOfMonth.first();
mon++;
}
if (smallestDay.isPresent()) {
if (day == -1 || smallestDay.get() < day) {
day = smallestDay.get();
}
} else {
day = daysOfMonth.first();
} else if (day == -1) {
day = 1;
mon++;
}

if (day != t || mon != tmon) {
cl.set(Calendar.SECOND, 0);
cl.set(Calendar.MINUTE, 0);
Expand Down Expand Up @@ -1649,6 +1595,27 @@ protected int getLastDayOfMonth(int monthNum, int year) {
}


private Optional<Integer> findSmallestDay(int day, int mon, int year, TreeSet<Integer> set) {
if (set.isEmpty()) {
return Optional.empty();
}

final int lastDay = getLastDayOfMonth(mon, year);
// For "L", "L-1", etc.
int smallestDay = Optional.ofNullable(set.ceiling(LAST_DAY_OFFSET_END - (lastDay - day)))
.map(d -> d - LAST_DAY_OFFSET_START + 1)
.orElse(Integer.MAX_VALUE);

// For "1", "2", etc.
SortedSet<Integer> st = set.subSet(day, LAST_DAY_OFFSET_START);
// make sure we don't over-run a short month, such as february
if (!st.isEmpty() && st.first() < smallestDay && st.first() <= lastDay) {
smallestDay = st.first();
}

return smallestDay == Integer.MAX_VALUE ? Optional.empty() : Optional.of(smallestDay);
}

private void readObject(java.io.ObjectInputStream stream)
throws java.io.IOException, ClassNotFoundException {

Expand Down
36 changes: 29 additions & 7 deletions quartz/src/test/java/org/quartz/CronExpressionTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,35 @@ public void testLastDayOffset() throws Exception {
cal.set(2010, Calendar.OCTOBER, 29, 10, 15, 0); // nearest weekday to last day - 1 (29th is a friday in 2010)
assertTrue(cronExpression.isSatisfiedBy(cal.getTime()));

cronExpression = new CronExpression("0 15 10 1,L * ? 2010");

cal.set(2010, Calendar.OCTOBER, 1, 10, 15, 0);
assertTrue(cronExpression.isSatisfiedBy(cal.getTime()));

cal.set(2010, Calendar.OCTOBER, 31, 10, 15, 0);
assertTrue(cronExpression.isSatisfiedBy(cal.getTime()));

cal.set(2010, Calendar.OCTOBER, 30, 10, 15, 0);
assertFalse(cronExpression.isSatisfiedBy(cal.getTime()));

cronExpression = new CronExpression("0 15 10 L-1W,L-1 * ? 2010");

cal.set(2010, Calendar.OCTOBER, 29, 10, 15, 0); // nearest weekday to last day - 1 (29th is a friday in 2010)
assertTrue(cronExpression.isSatisfiedBy(cal.getTime()));

cal.set(2010, Calendar.OCTOBER, 30, 10, 15, 0); // last day - 1

cronExpression = new CronExpression("0 15 10 2W,16 * ? 2010");

cal.set(2010, Calendar.OCTOBER, 1, 10, 15, 0); // nearest weekday to the 2nd of the month (1st is a friday in 2010)
assertTrue(cronExpression.isSatisfiedBy(cal.getTime()));

cal.set(2010, Calendar.OCTOBER, 2, 10, 15, 0);
assertFalse(cronExpression.isSatisfiedBy(cal.getTime()));

cal.set(2010, Calendar.OCTOBER, 16, 10, 15, 0);
assertTrue(cronExpression.isSatisfiedBy(cal.getTime()));

}

/*
Expand Down Expand Up @@ -214,13 +243,6 @@ public void testQuartz621() {
}

public void testQuartz640() throws ParseException {
try {
new CronExpression("0 43 9 1,5,29,L * ?");
fail("Expected ParseException did not fire for L combined with other days of the month");
} catch(ParseException pe) {
assertTrue("Incorrect ParseException thrown",
pe.getMessage().startsWith("Support for specifying 'L' and 'LW' with other days of the month is not implemented"));
}
try {
new CronExpression("0 43 9 ? * SAT,SUN,L");
fail("Expected ParseException did not fire for L combined with other days of the week");
Expand Down

0 comments on commit f3bbe5a

Please sign in to comment.