use super::timezone::CalTimezone; use crate::IcalProperty; use chrono::{DateTime, Datelike, Duration, Local, NaiveDate, NaiveDateTime, NaiveTime, Utc}; use chrono_tz::Tz; use derive_more::derive::Deref; use ical::{ parser::{Component, ical::component::IcalTimeZone}, property::Property, }; use lazy_static::lazy_static; use rustical_xml::{ValueDeserialize, ValueSerialize}; use std::{collections::HashMap, ops::Add}; lazy_static! { static ref RE_VCARD_DATE_MM_DD: regex::Regex = regex::Regex::new(r"^--(?\d{2})(?\d{2})$").unwrap(); } const LOCAL_DATE_TIME: &str = "%Y%m%dT%H%M%S"; const UTC_DATE_TIME: &str = "%Y%m%dT%H%M%SZ"; pub const LOCAL_DATE: &str = "%Y%m%d"; #[derive(Debug, thiserror::Error)] pub enum CalDateTimeError { #[error( "Timezone has X-LIC-LOCATION property to specify a timezone from the Olson database, however its value {0} is invalid" )] InvalidOlson(String), #[error("TZID {0} does not refer to a valid timezone")] InvalidTZID(String), #[error("Timestamp doesn't exist because of gap in local time")] LocalTimeGap, #[error("Datetime string {0} has an invalid format")] InvalidDatetimeFormat(String), #[error("Could not parse datetime {0}")] ParseError(String), #[error("Duration string {0} has an invalid format")] InvalidDurationFormat(String), } #[derive(Debug, Clone, Deref, PartialEq)] pub struct UtcDateTime(DateTime); impl ValueDeserialize for UtcDateTime { fn deserialize(val: &str) -> Result { let input = ::deserialize(val)?; Ok(Self( NaiveDateTime::parse_from_str(&input, UTC_DATE_TIME) .map_err(|_| { rustical_xml::XmlError::InvalidValue(rustical_xml::ParseValueError::Other( "Could not parse as UTC timestamp".to_owned(), )) })? .and_utc(), )) } } impl ValueSerialize for UtcDateTime { fn serialize(&self) -> String { format!("{}", self.0.format(UTC_DATE_TIME)) } } #[derive(Debug, Clone, PartialEq, PartialOrd, Eq, Ord)] pub enum CalDateTime { // Form 1, example: 19980118T230000 -> Local // Form 2, example: 19980119T070000Z -> UTC // Form 3, example: TZID=America/New_York:19980119T020000 -> Olson // https://en.wikipedia.org/wiki/Tz_database DateTime(DateTime), Date(NaiveDate), } impl From> for CalDateTime { fn from(value: DateTime) -> Self { CalDateTime::DateTime(value.with_timezone(&CalTimezone::Local)) } } impl From> for CalDateTime { fn from(value: DateTime) -> Self { CalDateTime::DateTime(value.with_timezone(&CalTimezone::Utc)) } } impl Add for CalDateTime { type Output = Self; fn add(self, duration: Duration) -> Self::Output { match self { Self::DateTime(datetime) => Self::DateTime(datetime + duration), Self::Date(date) => Self::DateTime( date.and_time(NaiveTime::default()) .and_local_timezone(CalTimezone::Local) .earliest() .expect("Local timezone has constant offset") + duration, ), } } } impl CalDateTime { pub fn parse_prop( prop: &Property, timezones: &HashMap, ) -> Result, CalDateTimeError> { let prop_value = if let Some(value) = prop.value.as_ref() { value } else { return Ok(None); }; // Use the TZID parameter from the property let timezone = if let Some(tzid) = prop.get_tzid() { if let Some(timezone) = timezones.get(tzid) { // X-LIC-LOCATION is often used to refer to a standardised timezone from the Olson // database if let Some(olson_name) = timezone .get_property("X-LIC-LOCATION") .map(|prop| prop.value.to_owned()) .unwrap_or_default() { if let Ok(tz) = olson_name.parse::() { Some(tz) } else { return Err(CalDateTimeError::InvalidOlson(olson_name)); } } else { // If the TZID matches a name from the Olson database (e.g. Europe/Berlin) we // guess that we can just use it tzid.parse::().ok() // TODO: If None: Too bad, we need to manually parse it // For now it's just treated as localtime } } else { // TZID refers to timezone that does not exist return Err(CalDateTimeError::InvalidTZID(tzid.to_string())); } } else { // No explicit timezone specified. // This is valid and will be localtime or UTC depending on the value None }; Self::parse(prop_value, timezone).map(Some) } pub fn format(&self) -> String { match self { Self::DateTime(datetime) => match datetime.timezone() { CalTimezone::Utc => datetime.format(UTC_DATE_TIME).to_string(), _ => datetime.format(LOCAL_DATE_TIME).to_string(), }, Self::Date(date) => date.format(LOCAL_DATE).to_string(), } } pub fn date(&self) -> NaiveDate { match self { Self::DateTime(datetime) => datetime.date_naive(), Self::Date(date) => date.to_owned(), } } pub fn into_datetime(self) -> DateTime { match self { Self::DateTime(datetime) => datetime, Self::Date(date) => date .and_time(NaiveTime::default()) .and_local_timezone(CalTimezone::Local) .earliest() .expect("Midnight always exists"), } } pub fn parse(value: &str, timezone: Option) -> Result { if let Ok(datetime) = NaiveDateTime::parse_from_str(value, LOCAL_DATE_TIME) { if let Some(timezone) = timezone { return Ok(CalDateTime::DateTime( datetime .and_local_timezone(timezone.into()) .earliest() .ok_or(CalDateTimeError::LocalTimeGap)?, )); } return Ok(CalDateTime::DateTime( datetime .and_local_timezone(CalTimezone::Local) .earliest() .ok_or(CalDateTimeError::LocalTimeGap)?, )); } if let Ok(datetime) = NaiveDateTime::parse_from_str(value, UTC_DATE_TIME) { return Ok(datetime.and_utc().into()); } if let Ok(date) = NaiveDate::parse_from_str(value, LOCAL_DATE) { return Ok(CalDateTime::Date(date)); } if let Ok(date) = NaiveDate::parse_from_str(value, "%Y-%m-%d") { return Ok(CalDateTime::Date(date)); } if let Ok(date) = NaiveDate::parse_from_str(value, "%Y%m%d") { return Ok(CalDateTime::Date(date)); } if let Some(captures) = RE_VCARD_DATE_MM_DD.captures(value) { // Because 1972 is a leap year let year = 1972; // Cannot fail because of the regex let month = captures.name("m").unwrap().as_str().parse().ok().unwrap(); let day = captures.name("d").unwrap().as_str().parse().ok().unwrap(); return Ok(CalDateTime::Date( NaiveDate::from_ymd_opt(year, month, day) .ok_or(CalDateTimeError::ParseError(value.to_string()))?, )); } Err(CalDateTimeError::InvalidDatetimeFormat(value.to_string())) } pub fn utc(&self) -> DateTime { match &self { CalDateTime::DateTime(datetime) => datetime.to_utc(), CalDateTime::Date(date) => date.and_time(NaiveTime::default()).and_utc(), } } pub fn timezone(&self) -> Option { match &self { CalDateTime::DateTime(datetime) => Some(datetime.timezone()), CalDateTime::Date(_) => None, } } } impl From for DateTime { fn from(value: CalDateTime) -> Self { value.utc() } } impl Datelike for CalDateTime { fn year(&self) -> i32 { match &self { CalDateTime::DateTime(datetime) => datetime.year(), CalDateTime::Date(date) => date.year(), } } fn month(&self) -> u32 { match &self { CalDateTime::DateTime(datetime) => datetime.month(), CalDateTime::Date(date) => date.month(), } } fn month0(&self) -> u32 { match &self { CalDateTime::DateTime(datetime) => datetime.month0(), CalDateTime::Date(date) => date.month0(), } } fn day(&self) -> u32 { match &self { CalDateTime::DateTime(datetime) => datetime.day(), CalDateTime::Date(date) => date.day(), } } fn day0(&self) -> u32 { match &self { CalDateTime::DateTime(datetime) => datetime.day0(), CalDateTime::Date(date) => date.day0(), } } fn ordinal(&self) -> u32 { match &self { CalDateTime::DateTime(datetime) => datetime.ordinal(), CalDateTime::Date(date) => date.ordinal(), } } fn ordinal0(&self) -> u32 { match &self { CalDateTime::DateTime(datetime) => datetime.ordinal0(), CalDateTime::Date(date) => date.ordinal0(), } } fn weekday(&self) -> chrono::Weekday { match &self { CalDateTime::DateTime(datetime) => datetime.weekday(), CalDateTime::Date(date) => date.weekday(), } } fn iso_week(&self) -> chrono::IsoWeek { match &self { CalDateTime::DateTime(datetime) => datetime.iso_week(), CalDateTime::Date(date) => date.iso_week(), } } fn with_year(&self, year: i32) -> Option { match &self { CalDateTime::DateTime(datetime) => Some(Self::DateTime(datetime.with_year(year)?)), CalDateTime::Date(date) => Some(Self::Date(date.with_year(year)?)), } } fn with_month(&self, month: u32) -> Option { match &self { CalDateTime::DateTime(datetime) => Some(Self::DateTime(datetime.with_month(month)?)), CalDateTime::Date(date) => Some(Self::Date(date.with_month(month)?)), } } fn with_month0(&self, month0: u32) -> Option { match &self { CalDateTime::DateTime(datetime) => Some(Self::DateTime(datetime.with_month0(month0)?)), CalDateTime::Date(date) => Some(Self::Date(date.with_month0(month0)?)), } } fn with_day(&self, day: u32) -> Option { match &self { CalDateTime::DateTime(datetime) => Some(Self::DateTime(datetime.with_day(day)?)), CalDateTime::Date(date) => Some(Self::Date(date.with_day(day)?)), } } fn with_day0(&self, day0: u32) -> Option { match &self { CalDateTime::DateTime(datetime) => Some(Self::DateTime(datetime.with_day0(day0)?)), CalDateTime::Date(date) => Some(Self::Date(date.with_day0(day0)?)), } } fn with_ordinal(&self, ordinal: u32) -> Option { match &self { CalDateTime::DateTime(datetime) => { Some(Self::DateTime(datetime.with_ordinal(ordinal)?)) } CalDateTime::Date(date) => Some(Self::Date(date.with_ordinal(ordinal)?)), } } fn with_ordinal0(&self, ordinal0: u32) -> Option { match &self { CalDateTime::DateTime(datetime) => { Some(Self::DateTime(datetime.with_ordinal0(ordinal0)?)) } CalDateTime::Date(date) => Some(Self::Date(date.with_ordinal0(ordinal0)?)), } } } impl CalDateTime { pub fn inc_year(&self, interval: u32) -> Option { self.with_year(self.year() + interval as i32) } // Increments the year until a valid date is found pub fn inc_find_year(&self, interval: u32) -> Self { let mut year = self.year(); loop { year += interval as i32; if let Some(date) = self.with_year(year) { return date; } } } pub fn inc_month(&self, interval: u32) -> Self { let mut month0 = self.month0(); loop { month0 += interval; if month0 >= 12 {} if let Some(date) = self.with_month0(month0) { return date; } } } } #[cfg(test)] mod tests { use crate::CalDateTime; use chrono::NaiveDate; #[test] fn test_vcard_date() { assert_eq!( CalDateTime::parse("19850412", None).unwrap(), CalDateTime::Date(NaiveDate::from_ymd_opt(1985, 4, 12).unwrap()) ); assert_eq!( CalDateTime::parse("1985-04-12", None).unwrap(), CalDateTime::Date(NaiveDate::from_ymd_opt(1985, 4, 12).unwrap()) ); assert_eq!( CalDateTime::parse("--0412", None).unwrap(), CalDateTime::Date(NaiveDate::from_ymd_opt(1972, 4, 12).unwrap()) ); } }