/
Observance.java
333 lines (295 loc) · 12.1 KB
/
Observance.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
/**
* Copyright (c) 2012, Ben Fortuna
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* o Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* o Neither the name of Ben Fortuna nor the names of any other contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package net.fortuna.ical4j.model.component;
import net.fortuna.ical4j.model.*;
import net.fortuna.ical4j.model.parameter.Value;
import net.fortuna.ical4j.model.property.*;
import net.fortuna.ical4j.util.Dates;
import net.fortuna.ical4j.util.PropertyValidator;
import net.fortuna.ical4j.util.TimeZones;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Arrays;
import java.util.Calendar;
import java.util.Collections;
/**
* $Id$ [05-Apr-2004]
* <p/>
* Defines an iCalendar sub-component representing a timezone observance. Class made abstract such that only Standard
* and Daylight instances are valid.
*
* @author Ben Fortuna
*/
public abstract class Observance extends Component {
/**
*
*/
private static final long serialVersionUID = 2523330383042085994L;
/**
* one of 'standardc' or 'daylightc' MUST occur and each MAY occur more than once.
*/
public static final String STANDARD = "STANDARD";
/**
* Token for daylight observance.
*/
public static final String DAYLIGHT = "DAYLIGHT";
// TODO: clear cache when observance definition changes (??)
private long[] onsetsMillisec;
private DateTime[] onsetsDates;
// private Map onsets = new TreeMap();
private Date initialOnset = null;
/**
* Used for parsing times in a UTC date-time representation.
*/
private static final String UTC_PATTERN = "yyyyMMdd'T'HHmmss";
private static final DateFormat UTC_FORMAT = new SimpleDateFormat(
UTC_PATTERN);
static {
UTC_FORMAT.setTimeZone(TimeZones.getUtcTimeZone());
UTC_FORMAT.setLenient(false);
}
/* If this is set we have rrules. If we get a date after this rebuild onsets */
private Date onsetLimit;
/**
* Constructs a timezone observance with the specified name and no properties.
*
* @param name the name of this observance component
*/
protected Observance(final String name) {
super(name);
}
/**
* Constructor protected to enforce use of sub-classes from this library.
*
* @param name the name of the time type
* @param properties a list of properties
*/
protected Observance(final String name, final PropertyList properties) {
super(name, properties);
}
/**
* {@inheritDoc}
*/
public final void validate(final boolean recurse) throws ValidationException {
// From "4.8.3.3 Time Zone Offset From":
// Conformance: This property MUST be specified in a "VTIMEZONE"
// calendar component.
PropertyValidator.getInstance().assertOne(Property.TZOFFSETFROM,
getProperties());
// From "4.8.3.4 Time Zone Offset To":
// Conformance: This property MUST be specified in a "VTIMEZONE"
// calendar component.
PropertyValidator.getInstance().assertOne(Property.TZOFFSETTO,
getProperties());
/*
* ; the following are each REQUIRED, ; but MUST NOT occur more than once dtstart / tzoffsetto / tzoffsetfrom /
*/
PropertyValidator.getInstance().assertOne(Property.DTSTART,
getProperties());
/*
* ; the following are optional, ; and MAY occur more than once comment / rdate / rrule / tzname / x-prop
*/
if (recurse) {
validateProperties();
}
}
/**
* Returns the latest applicable onset of this observance for the specified date.
*
* @param date the latest date that an observance onset may occur
* @return the latest applicable observance date or null if there is no applicable observance onset for the
* specified date
*/
public final Date getLatestOnset(final Date date) {
if (initialOnset == null) {
try {
DtStart dtStart = (DtStart) getProperty(Property.DTSTART, false);
initialOnset = applyOffsetFrom(calculateOnset(dtStart.getDate()));
} catch (ParseException e) {
Logger log = LoggerFactory.getLogger(Observance.class);
log.error("Unexpected error calculating initial onset", e);
// XXX: is this correct?
return null;
} catch (ConstraintViolationException e) {
Logger log = LoggerFactory.getLogger(Observance.class);
log.error("Unexpected error calculating initial onset", e);
// XXX: is this correct?
return null;
}
}
// observance not applicable if date is before the effective date of this observance..
if (date.before(initialOnset)) {
return null;
}
if ((onsetsMillisec != null) && (onsetLimit == null || date.before(onsetLimit))) {
return getCachedOnset(date);
}
Date onset = initialOnset;
Date initialOnsetUTC;
// get first onset without adding TZFROM as this may lead to a day boundary
// change which would be incompatible with BYDAY RRULES
// we will have to add the offset to all cacheable onsets
try {
initialOnsetUTC = calculateOnset(((DtStart) getProperty(Property.DTSTART)).getDate());
} catch (ParseException e) {
Logger log = LoggerFactory.getLogger(Observance.class);
log.error("Unexpected error calculating initial onset", e);
// XXX: is this correct?
return null;
}
// collect all onsets for the purposes of caching..
final DateList cacheableOnsets = new DateList();
cacheableOnsets.setUtc(true);
cacheableOnsets.add(initialOnset);
// check rdates for latest applicable onset..
final PropertyList rdates = getProperties(Property.RDATE);
for (Property rdate1 : rdates) {
final RDate rdate = (RDate) rdate1;
for (final Date rdateDate : rdate.getDates()) {
try {
final DateTime rdateOnset = applyOffsetFrom(calculateOnset(rdateDate));
if (!rdateOnset.after(date) && rdateOnset.after(onset)) {
onset = rdateOnset;
}
/*
* else if (rdateOnset.after(date) && rdateOnset.after(onset) && (nextOnset == null ||
* rdateOnset.before(nextOnset))) { nextOnset = rdateOnset; }
*/
cacheableOnsets.add(rdateOnset);
} catch (ParseException e) {
Logger log = LoggerFactory.getLogger(Observance.class);
log.error("Unexpected error calculating onset", e);
}
}
}
// check recurrence rules for latest applicable onset..
final PropertyList rrules = getProperties(Property.RRULE);
for (Property rrule1 : rrules) {
final RRule rrule = (RRule) rrule1;
// include future onsets to determine onset period..
final Calendar cal = Dates.getCalendarInstance(date);
cal.setTime(date);
cal.add(Calendar.YEAR, 10);
onsetLimit = Dates.getInstance(cal.getTime(), Value.DATE_TIME);
final DateList recurrenceDates = rrule.getRecur().getDates(initialOnsetUTC,
onsetLimit, Value.DATE_TIME);
for (final Date recurDate : recurrenceDates) {
final DateTime rruleOnset = applyOffsetFrom((DateTime) recurDate);
if (!rruleOnset.after(date) && rruleOnset.after(onset)) {
onset = rruleOnset;
}
/*
* else if (rruleOnset.after(date) && rruleOnset.after(onset) && (nextOnset == null ||
* rruleOnset.before(nextOnset))) { nextOnset = rruleOnset; }
*/
cacheableOnsets.add(rruleOnset);
}
}
// cache onsets..
Collections.sort(cacheableOnsets);
DateTime cacheableOnset;
this.onsetsMillisec = new long[cacheableOnsets.size()];
this.onsetsDates = new DateTime[onsetsMillisec.length];
for (int i = 0; i < onsetsMillisec.length; i++) {
cacheableOnset = (DateTime) cacheableOnsets.get(i);
onsetsMillisec[i] = cacheableOnset.getTime();
onsetsDates[i] = cacheableOnset;
}
return onset;
}
/**
* Returns a cached onset for the specified date.
*
* @param date
* @return a cached onset date or null if no cached onset is applicable for the specified date
*/
private DateTime getCachedOnset(final Date date) {
int index = Arrays.binarySearch(onsetsMillisec, date.getTime());
if (index >= 0) {
return onsetsDates[index];
} else {
int insertionIndex = -index - 1;
return onsetsDates[insertionIndex - 1];
}
}
/**
* Returns the mandatory dtstart property.
*
* @return the DTSTART property or null if not specified
*/
public final DtStart getStartDate() {
return (DtStart) getProperty(Property.DTSTART);
}
/**
* Returns the mandatory tzoffsetfrom property.
*
* @return the TZOFFSETFROM property or null if not specified
*/
public final TzOffsetFrom getOffsetFrom() {
return (TzOffsetFrom) getProperty(Property.TZOFFSETFROM);
}
/**
* Returns the mandatory tzoffsetto property.
*
* @return the TZOFFSETTO property or null if not specified
*/
public final TzOffsetTo getOffsetTo() {
return (TzOffsetTo) getProperty(Property.TZOFFSETTO);
}
// private Date calculateOnset(DateProperty dateProperty) {
// return calculateOnset(dateProperty.getValue());
// }
//
private DateTime calculateOnset(Date date) throws ParseException {
return calculateOnset(date.toString());
}
private DateTime calculateOnset(String dateStr) throws ParseException {
// Translate local onset into UTC time by parsing local time
// as GMT and adjusting by TZOFFSETFROM if required
long utcOnset;
synchronized (UTC_FORMAT) {
utcOnset = UTC_FORMAT.parse(dateStr).getTime();
}
// return a UTC
DateTime onset = new DateTime(true);
onset.setTime(utcOnset);
return onset;
}
private DateTime applyOffsetFrom(DateTime orig) {
DateTime withOffset = new DateTime(true);
withOffset.setTime(orig.getTime() - getOffsetFrom().getOffset().getOffset());
return withOffset;
}
}