use std::error::Error; use std::collections::{HashMap, HashSet}; use std::sync::{Arc, Mutex}; use async_trait::async_trait; use crate::item::SyncStatus; use crate::item::Item; use crate::item::ItemId; use crate::item::VersionTag; use crate::calendar::CalendarId; use crate::calendar::SupportedComponents; use crate::resource::Resource; /// This trait must be implemented by data sources (either local caches or remote CalDAV clients) #[async_trait] pub trait CalDavSource { /// Returns the current calendars that this source contains /// This function may trigger an update (that can be a long process, or that can even fail, e.g. in case of a remote server) async fn get_calendars(&self) -> Result>>, Box>; /// Returns the calendar matching the ID async fn get_calendar(&self, id: &CalendarId) -> Option>>; /// Create a calendar if it did not exist, and return it async fn create_calendar(&mut self, id: CalendarId, name: String, supported_components: SupportedComponents) -> Result>, Box>; // Removing a calendar is not supported yet } /// This trait contains functions that are common to all calendars #[async_trait] pub trait BaseCalendar { /// Returns the calendar name fn name(&self) -> &str; /// Returns the calendar unique ID fn id(&self) -> &CalendarId; /// Returns the supported kinds of components for this calendar fn supported_components(&self) -> crate::calendar::SupportedComponents; /// Add an item into this calendar, and return its new sync status. /// For local calendars, the sync status is not modified. /// For remote calendars, the sync status is updated by the server async fn add_item(&mut self, item: Item) -> Result>; /// Update an item that already exists in this calendar and returns its new `SyncStatus` /// This replaces a given item at a given URL async fn update_item(&mut self, item: Item) -> Result>; /// Returns whether this calDAV calendar supports to-do items fn supports_todo(&self) -> bool { self.supported_components().contains(crate::calendar::SupportedComponents::TODO) } /// Returns whether this calDAV calendar supports calendar items fn supports_events(&self) -> bool { self.supported_components().contains(crate::calendar::SupportedComponents::EVENT) } } /// Functions availabe for calendars that are backed by a CalDAV server #[async_trait] pub trait DavCalendar : BaseCalendar { /// Create a new calendar fn new(name: String, resource: Resource, supported_components: SupportedComponents) -> Self; /// Get the IDs and the version tags of every item in this calendar async fn get_item_version_tags(&self) -> Result, Box>; /// Returns a particular item async fn get_item_by_id(&self, id: &ItemId) -> Result, Box>; /// Delete an item async fn delete_item(&mut self, item_id: &ItemId) -> Result<(), Box>; /// Get the IDs of all current items in this calendar async fn get_item_ids(&self) -> Result, Box> { let items = self.get_item_version_tags().await?; Ok(items.iter() .map(|(id, _tag)| id.clone()) .collect()) } // Note: the CalDAV protocol could also enable to do this: // fn get_current_version(&self) -> CTag } /// Functions availabe for calendars we have full knowledge of /// /// Usually, these are local calendars fully backed by a local folder #[async_trait] pub trait CompleteCalendar : BaseCalendar { /// Create a new calendar fn new(name: String, id: CalendarId, supported_components: SupportedComponents) -> Self; /// Get the IDs of all current items in this calendar async fn get_item_ids(&self) -> Result, Box>; /// Returns all items that this calendar contains async fn get_items(&self) -> Result, Box>; /// Returns a particular item async fn get_item_by_id_ref<'a>(&'a self, id: &ItemId) -> Option<&'a Item>; /// Returns a particular item async fn get_item_by_id_mut<'a>(&'a mut self, id: &ItemId) -> Option<&'a mut Item>; /// Mark an item for deletion. /// This is required so that the upcoming sync will know it should also also delete this task from the server /// (and then call [`CompleteCalendar::immediately_delete_item`] once it has been successfully deleted on the server) async fn mark_for_deletion(&mut self, item_id: &ItemId) -> Result<(), Box>; /// Immediately remove an item. See [`CompleteCalendar::mark_for_deletion`] async fn immediately_delete_item(&mut self, item_id: &ItemId) -> Result<(), Box>; }