org.bedework.calfacade.BwDateTime Maven / Gradle / Ivy
Show all versions of bw-calendar-facade Show documentation
/* ********************************************************************
Licensed to Jasig under one or more contributor license
agreements. See the NOTICE file distributed with this work
for additional information regarding copyright ownership.
Jasig licenses this file to you under the Apache License,
Version 2.0 (the "License"); you may not use this file
except in compliance with the License. You may obtain a
copy of the License at:
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on
an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/
package org.bedework.calfacade;
import org.bedework.base.exc.BedeworkException;
import org.bedework.calfacade.annotations.Dump;
import org.bedework.calfacade.annotations.NoDump;
import org.bedework.calfacade.annotations.ical.IcalProperties;
import org.bedework.calfacade.annotations.ical.IcalProperty;
import org.bedework.calfacade.base.BwCloneable;
import org.bedework.calfacade.base.DumpEntity;
import org.bedework.calfacade.exc.CalFacadeErrorCode;
import org.bedework.calfacade.util.CalFacadeUtil;
import org.bedework.calfacade.util.FieldSplitter;
import org.bedework.util.calendar.PropertyIndex.PropertyInfoIndex;
import org.bedework.util.calendar.XcalUtil;
import org.bedework.base.ToString;
import org.bedework.util.timezones.DateTimeUtil;
import org.bedework.util.timezones.Timezones;
import ietf.params.xml.ns.icalendar_2.DateDatetimePropertyType;
import net.fortuna.ical4j.model.Date;
import net.fortuna.ical4j.model.DateTime;
import net.fortuna.ical4j.model.Dur;
import net.fortuna.ical4j.model.Parameter;
import net.fortuna.ical4j.model.ParameterList;
import net.fortuna.ical4j.model.Property;
import net.fortuna.ical4j.model.TemporalAmountAdapter;
import net.fortuna.ical4j.model.TimeZone;
import net.fortuna.ical4j.model.TimeZoneRegistry;
import net.fortuna.ical4j.model.parameter.Value;
import net.fortuna.ical4j.model.property.DateProperty;
import net.fortuna.ical4j.model.property.DtEnd;
import net.fortuna.ical4j.model.property.DtStart;
import net.fortuna.ical4j.model.property.Due;
import java.io.Serializable;
import java.text.ParseException;
import java.time.temporal.TemporalAmount;
import java.util.Calendar;
import java.util.Comparator;
import static org.bedework.calfacade.exc.CalFacadeErrorCode.badDate;
/** Class to represent an RFC2445 date and datetime type. These are not stored
* in separate tables but as components of the including class.
*
* DateTime values take 3 forms:
*
Floating time - no timezone e.g. DTSTART:19980118T230000
*
UTC time no timezone e.g. DTSTART:19980118T230000Z
*
Local time with timezone e.g. DTSTART;TZID=US-Eastern:19980119T020000
*
* @author Mike Douglass
* @version 1.0
*/
@Dump(elementName="date-time", keyFields={"dateType", "tzid", "dtval", "date"})
public class BwDateTime extends DumpEntity
implements BwCloneable, Comparable, Comparator, Serializable {
/** If true this represents a date - not datetime.
*/
private boolean dateType;
/** Non-null if one was specified. To avoid schema changes
* this field might be a combined tzid and fractional value.
*/
private String tzid;
public static final String fieldDelimiter = "\t";
private FieldSplitter tzidSplit;
private static final int tzidIndex = 0;
private static final int fractionalIndex = 1;
private String dtval; // rfc2445 date or datetime value
private String range; // Only for recurrence id
/** */
public static String oneDayForward = "P1D";
/** */
public static String oneDayBack = "-P1D";
/** This is a UTC datetime value to make searching easier. There are a number of
* complications to dates, the end date is specified as non-inclusive
* but there are a number of boundary problems to watch out for.
*
* For date only values this field has a zero time appended so that simple
* string comparisons will work.
*/
private String date; // For indexing
private Boolean floatFlag;
/** Constructor
*/
public BwDateTime() {
}
/** Constructor
*
* @param dateType true for date only
* @param date date time
* @param tzid timezone id
* @return initialised BwDateTime
* @throws RuntimeException on bad date
*/
public static BwDateTime makeBwDateTime(final boolean dateType,
final String date,
final String tzid) {
try {
if (dateType) {
if (!DateTimeUtil.isISODate(date)) {
throw new RuntimeException("org.bedework.datetime.expect.dateonly");
}
}
final BwDateTime bwd = new BwDateTime();
bwd.setDateType(dateType);
bwd.setDtval(date);
bwd.setTzid(tzid);
if (tzid == null) {
if (DateTimeUtil.isISODateTime(date)) {
bwd.setFloatFlag(true);
bwd.setDate(date + "Z");
}
}
/* Made this change 2/16/20 - don't know why but it caused
problems with searches.
if (dateType) {
bwd.setDate(date + "T000000Z");
} else if (!bwd.getFloating()) {
bwd.setDate(Timezones.getUtc(date, tzid));
}
*/
if (!bwd.getFloating()) {
bwd.setDate(Timezones.getUtc(date, tzid));
}
return bwd;
} catch (final RuntimeException rte) {
throw rte;
} catch (final Throwable t) {
throw new RuntimeException(t);
}
}
/** Make date time based on all properties
*
* @param dateType true for date only
* @param date date time
* @param utcDate UTC value
* @param tzid timezone id
* @param floating true for floating
* @return initialised BwDateTime
* @throws RuntimeException on bad date
*/
public static BwDateTime makeBwDateTime(final boolean dateType,
final String date,
final String utcDate,
final String tzid,
final boolean floating) {
try {
if (dateType) {
if (!DateTimeUtil.isISODate(date)) {
throw new RuntimeException("org.bedework.datetime.expect.dateonly");
}
}
final BwDateTime bwd = new BwDateTime();
bwd.setDateType(dateType);
bwd.setDtval(date);
bwd.setDate(utcDate);
bwd.setTzid(tzid);
bwd.setFloatFlag(floating);
return bwd;
} catch (final RuntimeException rte) {
throw rte;
} catch (final Throwable t) {
throw new RuntimeException(t);
}
}
/** Make date time based on ical property
*
* @param val ical date property
* @return BwDateTime
*/
public static BwDateTime makeBwDateTime(final DateProperty val) {
Parameter par = getIcalParameter(val, "VALUE");
final BwDateTime bwdt =
makeBwDateTime((par != null) && (par.equals(Value.DATE)),
val.getValue(),
getTzid(val));
par = getIcalParameter(val, "RANGE");
if (par != null) {
/* XXX What do I do with it? */
bwdt.range = par.getValue();
}
return bwdt;
}
/** Make date time based on the xcal property
*
* @param val xcal date/datetime property
* @return BwDateTime
*/
public static BwDateTime makeBwDateTime(final DateDatetimePropertyType val) {
final XcalUtil.DtTzid dtTzid = XcalUtil.getDtTzid(val);
return makeBwDateTime(dtTzid.dateOnly,
dtTzid.dt,
dtTzid.tzid);
}
/** Make date time based on the xcal property with tzid supplied
*
* @param val xcal date/datetime property
* @param tzid timezone id
* @return BwDateTime
*/
public static BwDateTime makeBwDateTime(final DateDatetimePropertyType val,
final String tzid) {
final XcalUtil.DtTzid dtTzid = XcalUtil.getDtTzid(val);
return makeBwDateTime(dtTzid.dateOnly,
dtTzid.dt,
tzid);
}
/**
* @param val Date object
* @return initialised BwDateTime
*/
public static BwDateTime makeBwDateTime(final Date val) {
String tzid = null;
boolean dateType = true;
if (val instanceof DateTime) {
dateType = false;
final TimeZone tz = ((DateTime)val).getTimeZone();
if (tz != null) {
tzid = tz.getID();
}
}
return makeBwDateTime(dateType, val.toString(), tzid);
}
/** Make a new date time value based on the dtStart value + the duration.
*
* @param dtStart date property
* @param dateOnly true for date only value
* @param dur duration to increment
* @return BwDateTime
*/
public static BwDateTime makeDateTime(final DateProperty dtStart,
final boolean dateOnly,
final String dur) {
final DtEnd dtEnd;
final java.util.Date endDt = new Dur(dur).getTime(dtStart.getDate());
final Parameter tzid = getIcalParameter(dtStart, "TZID");
if (dateOnly) {
//dtEnd = new DtEnd(new Date(endDt));
final ParameterList parl = new ParameterList();
parl.add(Value.DATE);
dtEnd = new DtEnd(parl, new Date(endDt));
//addIcalParameter(dtEnd, Value.DATE);
//if (tzid != null) {
// addIcalParameter(dtEnd, tzid);
//}
} else {
final DateTime d = new DateTime(endDt);
if (tzid != null) {
final DateTime sd = (DateTime)dtStart.getDate();
d.setTimeZone(sd.getTimeZone());
}
// dtEnd = new DtEnd(d, dtStart.isUtc());
dtEnd = new DtEnd(d);
if (tzid != null) {
addIcalParameter(dtEnd, tzid);
} else if (dtStart.isUtc()) {
dtEnd.setUtc(true);
}
}
return makeBwDateTime(dtEnd);
}
/** Create from utc time
*
* @param dateType true for date only
* @param date the UTC value
* @return initialised BwDateTime
* @throws RuntimeException on bad date
*/
public static BwDateTime fromUTC(final boolean dateType,
final String date) {
if (!dateType && !date.endsWith("Z")) {
throw new RuntimeException(badDate);
}
final BwDateTime bwd = new BwDateTime();
bwd.setDateType(dateType);
bwd.setDtval(date);
bwd.setTzid(null);
if (dateType) {
bwd.setDate(date + "T000000Z");
} else {
bwd.setDate(date);
}
return bwd;
}
/** Create from utc time with timezone
*
* @param dateType true for a date value
* @param date the string UTC date/time or 8 character date
* @param tzid tzid for local time
* @return initialised BwDateTime
*/
public static BwDateTime fromUTC(final boolean dateType,
final String date,
final String tzid) {
if (!dateType && !date.endsWith("Z")) {
throw new BedeworkException(CalFacadeErrorCode.badDate);
}
try {
final BwDateTime bwd = new BwDateTime();
bwd.setDateType(dateType);
if (dateType | (tzid == null)) {
bwd.setDtval(date);
bwd.setTzid(null);
} else {
final java.util.Date dt = DateTimeUtil.fromISODateTimeUTC(date);
bwd.setDtval(DateTimeUtil.isoDateTime(dt, Timezones.getTz(tzid)));
bwd.setTzid(tzid);
}
if (dateType) {
bwd.setDate(date + "T000000Z");
} else {
bwd.setDate(date);
}
return bwd;
} catch (final Throwable t) {
throw new BedeworkException(CalFacadeErrorCode.badDate);
}
}
/** Get the date/times dateType
*
* @return boolean true for a date only type
*/
public boolean getDateType() {
return dateType;
}
/** Get the tzid
*
* @return String tzid
*/
@IcalProperties({
@IcalProperty(pindex = PropertyInfoIndex.TZIDPAR,
dbFieldName = "tzid",
param = true),
@IcalProperty(pindex = PropertyInfoIndex.TZID)
})
public String getTzid() {
return fetchTzidSplit().getFld(tzidIndex);
}
public void setFractional(final String val) {
assignTzidField(fractionalIndex, val);
}
public String getFractional() {
return fetchTzidSplit().getFld(fractionalIndex);
}
/** For hibernate
*
* @return the combined id and fractional value
*/
@NoDump
private String getTimezoneId() {
return tzid;
}
/** Get the dtval - the rfc2445 date or datetime value
*
* @return String dtval
*/
public String getDtval() {
return dtval;
}
/** Get the range for a query
*
* @return String range
*/
public String getRange() {
return range;
}
/** Set the date as a datetime value for comparisons.
*
*
This is a UTC datetime value to make searching easier. There are a number of
* complications to dates, the end date is specified as non-inclusive
* but there are a number of boundary problems to watch out for.
*
*
For date only values this field has a zero time appended so that simple
* string comparisons will work.
*
* @param val UTC datetime value
*/
@IcalProperty(pindex = PropertyInfoIndex.UTC,
jname = "utc")
private void setDate(final String val) {
date = val;
}
/** This is a UTC datetime value to make searching easier. There are a number of
* complications to dates, the end date is specified as non-inclusive
* but there are a number of boundary problems to watch out for.
*
*
For date only values this field has a zero time appended so that simple
* string comparisons will work.
*
*
For floating time values this is the same as the dtval made to look like
* a UTC value.
*
* @return String date
*/
@IcalProperty(pindex = PropertyInfoIndex.LOCAL,
jname = "local")
public String getDate() {
return date;
}
/** For non floating values this should be null rather than false. This is
* sort of a db thing (maybe possible to hide it).
*
*
Virtually all events are expected to be non-floating but we need to index
* floating v non-floating.
*
*
A null value will usually not be indexed so the index will consist of
* only those that are floating time.
*
* @param val true for floating time
*/
@IcalProperty(pindex = PropertyInfoIndex.FLOATING,
jname = "floating")
private void setFloatFlag(final Boolean val) {
floatFlag = val;
}
/**
* @return Boolean or null
*/
public Boolean getFloatFlag() {
return floatFlag;
}
/* ====================================================================
* Conversion methods
* ==================================================================== */
/**
* @return boolean
*/
public boolean getFloating() {
if (getFloatFlag() == null) {
return false;
}
return floatFlag;
}
/**
* @return true if this represents a valid UTC date
*/
public boolean isUTC() {
if (getDateType()) {
return false;
}
try {
return DateTimeUtil.isISODateTimeUTC(getDtval());
} catch (final Throwable t) {
return false;
}
}
/** Make a DtEnd from this object
*
* @return DtEnd ical4j dtend object
*/
public DtEnd makeDtEnd() {
return makeDtEnd(Timezones.getTzRegistry());
}
/** Make a DtEnd from this object
*
* @param tzreg timezone registry
* @return DtEnd
*/
public DtEnd makeDtEnd(final TimeZoneRegistry tzreg) {
final DtEnd dt = new DtEnd();
initDateProp(dt, tzreg);
return dt;
}
/** Make a Due from this object
*
* @param tzreg timezone registry
* @return Due
*/
public Due makeDue(final TimeZoneRegistry tzreg) {
final Due dt = new Due();
initDateProp(dt, tzreg);
return dt;
}
/** Create a copy of this object
*
* @return BwDateTime
*/
public BwDateTime copy() {
return makeBwDateTime(makeDtEnd());
}
/** Make a DtStart from this object
*
* @return DtStart
*/
public DtStart makeDtStart() {
return makeDtStart(Timezones.getTzRegistry());
}
/** Make a DtStart from this object
*
* @param tzreg timezone registry
* @return DtStart
*/
public DtStart makeDtStart(final TimeZoneRegistry tzreg) {
/*
String tzid = null;
ParameterList pl = new ParameterList();
if (getDateType()) {
pl.add(Value.DATE);
} else if (!isUTC()) {
tzid = getTzid();
if (tzid != null) {
pl.add(new TzId(tzid));
}
}
return new DtStart(pl, getDtval());*/
final String tzid = getTzid();
final DtStart dt = new DtStart();
final ParameterList pl = dt.getParameters();
if (getDateType()) {
pl.add(Value.DATE);
} else if (tzid != null) {
dt.setTimeZone(tzreg.getTimeZone(tzid));
}
try {
dt.setValue(getDtval());
} catch (final ParseException pe) {
throw new RuntimeException(pe);
}
return dt;
}
/** Return an ical DateTime or Date object
*
* @return Date
*/
public Date makeDate() {
try {
if (getDateType()) {
return new Date(getDtval());
}
if (tzid != null) {
return new DateTime(getDtval(), Timezones.getTz(tzid));
}
return new DateTime(getDtval());
} catch (final Throwable t) {
checkRuntimeException(t);
throw new RuntimeException(t);
}
}
/** Make an ical Dur from a start and end
*
* @param start bw start object
* @param end bw end object
* @return Dur
*/
public static Dur makeDuration(final BwDateTime start,
final BwDateTime end) {
return new Dur(start.makeDate(),
end.makeDate());
}
/** Return a value based on this value plus a duration.
*
* @param val bw duration object
* @return BwDateTime
*/
public BwDateTime addDuration(final BwDuration val) {
return addDuration(val.makeDuration().getDuration());
}
private static final Calendar dateIncrementor =
Calendar.getInstance(java.util.TimeZone.getTimeZone("GMT"));
/** For a date only object returns a date 1 day in advance of this date.
* Used when moving between displayed and internal values and also when
* breaking a collection of events up into days.
*
* @return BwDateTime tomorrow
*/
public BwDateTime getNextDay() {
if (!getDateType()) {
throw new RuntimeException("org.bedework.datetime.expect.dateonly");
}
try {
Date dt = new Date(getDtval());
synchronized (dateIncrementor) {
dateIncrementor.setTime(dt);
dateIncrementor.add(Calendar.DATE, 1);
dt = new Date(dateIncrementor.getTime());
}
return makeBwDateTime(dt);
} catch (final Throwable t) {
throw new RuntimeException(t);
}
}
/** For a date only object returns a date 1 day previous to this date.
* Used when moving between displayed and internal values.
*
* @return BwDateTime yesterday
*/
public BwDateTime getPreviousDay() {
if (!getDateType()) {
throw new RuntimeException("Must be a date only value");
}
return makeDateTime(makeDtStart(Timezones.getTzRegistry()),
true, oneDayBack);
}
/** Add a duration and return the result
*
* @param d dur value
* @return BwDateTime
*/
public BwDateTime addDur(final String d) {
return makeDateTime(makeDtStart(Timezones.getTzRegistry()),
getDateType(), d);
}
/* ====================================================================
* private methods
* ==================================================================== */
/** Set the dateType for this timezone
*
* @param val boolean dateType
*/
private void setDateType(final boolean val) {
dateType = val;
}
/** Set the tzid. This should not be used to change the timezone for a value
* as we may need to recalculate other values based on that change.
*
* @param val String tzid
*/
private void setTzid(final String val) {
tzid = val;
}
/** For hibernate
*
* @param val combined tzid and possible fractional value
*/
private void setTimezoneId(final String val) {
tzid = val;
}
/** Set the dtval - the rfc2445 date or datetime value
*
* @param val String dtval
*/
private void setDtval(final String val) {
dtval = val;
if (val == null) {
setDate(null);
}
}
/** Add parameter val to prop
*
* @param prop property
* @param val parameter
*/
private static void addIcalParameter(final Property prop,
final Parameter val) {
final ParameterList parl = prop.getParameters();
parl.add(val);
}
/** Get named parameter from prop
*
* @param prop property
* @param name parameter
* @return Parameter
*/
private static Parameter getIcalParameter(final Property prop,
final String name) {
final ParameterList parl = prop.getParameters();
if (parl == null) {
return null;
}
return parl.getParameter(name);
}
/** Return the timezone id if it is set for the property.
*
* @param val date property
* @return String tzid or null.
*/
private static String getTzid(final DateProperty val) {
final Parameter tzidPar = getIcalParameter(val, "TZID");
String tzid = null;
if (tzidPar != null) {
tzid = tzidPar.getValue();
}
return tzid;
}
/* Init a date property for makeDtEnd, makeDue
*/
private void initDateProp(final DateProperty dt,
final TimeZoneRegistry tzreg) {
final String tzid = getTzid();
final ParameterList pl = dt.getParameters();
if (getDateType()) {
pl.add(Value.DATE);
}
if (tzid != null) {
dt.setTimeZone(tzreg.getTimeZone(tzid));
}
try {
dt.setValue(getDtval());
} catch (final ParseException pe) {
throw new RuntimeException(pe);
}
}
private BwDateTime addDuration(final TemporalAmount val) {
final DtEnd dtEnd;
final java.util.Date endDt =
new TemporalAmountAdapter(val).getTime(makeDate());
final DtStart dtStart = makeDtStart(Timezones.getTzRegistry());
if (getDateType()) {
dtEnd = new DtEnd(new Date(endDt));
addIcalParameter(dtEnd, Value.DATE);
} else {
final DateTime d = new DateTime(endDt);
final Parameter tzid = getIcalParameter(dtStart, "TZID");
if (tzid != null) {
final DateTime sd = (DateTime)dtStart.getDate();
d.setTimeZone(sd.getTimeZone());
}
// dtEnd = new DtEnd(d, dtStart.isUtc());
dtEnd = new DtEnd(d);
if (tzid != null) {
addIcalParameter(dtEnd, tzid);
} else if (dtStart.isUtc()) {
dtEnd.setUtc(true);
}
}
return makeBwDateTime(dtEnd);
}
/* ====================================================================
* Object methods
* ==================================================================== */
@Override
public int compare(final BwDateTime dt1, final BwDateTime dt2) {
if (dt1 == dt2) {
return 0;
}
return dt1.getDate().compareTo(dt2.getDate());
}
@Override
public int compareTo(final BwDateTime o2) {
return compare(this, o2);
}
/** Return true if this is before val
*
* @param val bw date time
* @return boolean this before val
*/
public boolean before(final BwDateTime val) {
return compare(this, val) < 0;
}
/** Return true if this is after val
*
* @param val bw date time
* @return boolean this after val
*/
public boolean after(final BwDateTime val) {
return compare(this, val) > 0;
}
@Override
public int hashCode() {
int hc = 1;
if (getDateType()) {
hc = 3;
}
if (getTzid() != null) {
hc *= getTzid().hashCode();
}
if (getDtval() != null) {
hc *= getDtval().hashCode();
}
return hc;
}
/** */
public final static int dtOk = 0;
/** Should not have a tzid */
public final static int dtBadTz = 1;
/** */
public final static int dtBadDtval = 2;
/** Ensure the date time is a valid representation. Provide an indication of
* reasons why not.
*
* @return validity code
*/
public int validate() {
if (getDtval().length() == 8) {
if (!getDateType()) {
return dtBadDtval;
}
}
if (getDateType()) {
if (getDtval().length() > 8) {
return dtBadDtval;
}
if (getTzid() != null) {
return dtBadTz;
}
return dtOk;
}
if (getDtval().length() == 16) {
// Can only be UTC
if (!getDtval().endsWith("Z")) {
return dtBadDtval;
}
if (getTzid() != null) {
return dtBadTz;
}
return dtOk;
}
// Floating or local time
return dtOk;
}
@Override
public boolean equals(final Object obj) {
if (this == obj) {
return true;
}
if (!(obj instanceof BwDateTime)) {
return false;
}
final BwDateTime that = (BwDateTime)obj;
if (getDateType() != that.getDateType()) {
return false;
}
if (!CalFacadeUtil.eqObjval(getTzid(), that.getTzid())) {
return false;
}
return CalFacadeUtil.eqObjval(getDtval(), that.getDtval());
}
@SuppressWarnings("MethodDoesntCallSuperMethod")
@Override
public Object clone() {
final BwDateTime ndt = new BwDateTime();
ndt.setDateType(getDateType());
ndt.setTzid(getTzid());
ndt.setDtval(getDtval());
ndt.setDate(getDate());
ndt.setFloatFlag(getFloatFlag());
return ndt;
}
@Override
public String toString() {
final ToString ts = new ToString(this);
if (getDateType()) {
ts.append("DATE");
} else {
ts.append("DATETIME");
}
if (getTzid() != null) {
ts.append("tzid", getTzid());
}
ts.append("dtval", getDtval());
if (getFloating()) {
ts.append("floating");
} else if (isUTC()) {
ts.append("UTC");
} else {
ts.append("UTC", getDate());
}
return ts.toString();
}
private FieldSplitter fetchTzidSplit() {
if (tzidSplit == null) {
tzidSplit = new FieldSplitter(fieldDelimiter);
tzidSplit.setVal(getTimezoneId());
}
return tzidSplit;
}
private void assignTzidField(final int index,
final String val) {
fetchTzidSplit().setFld(index, val);
setTimezoneId(fetchTzidSplit().getCombined());
}
private void checkRuntimeException(final Throwable t) {
if (t instanceof RuntimeException) {
throw (RuntimeException)t;
}
}
}