Automatic repair for calendar objects with invalid VERSION:4.0

.github/workflows/docker-publish.yml

@@ -2,7 +2,7 @@ name: Docker
 
 on:
   push:
-    branches: ["main"]
+    branches: ["main", "dev"]
   release:
     types: ["published"]
 

Cargo.lock

@@ -3618,6 +3618,7 @@ dependencies = [
  "password-auth",
  "password-hash",
  "pbkdf2",
+ "regex",
  "rstest",
  "rustical_ical",
  "rustical_store",

crates/store_sqlite/Cargo.toml

@@ -36,3 +36,4 @@ pbkdf2.workspace = true
 rustical_ical.workspace = true
 rstest = { workspace = true, optional = true }
 sha2.workspace = true
+regex.workspace = true

crates/store_sqlite/src/calendar_store.rs

@@ -3,6 +3,7 @@ use crate::BEGIN_IMMEDIATE;
 use async_trait::async_trait;
 use chrono::TimeDelta;
 use derive_more::derive::Constructor;
+use regex::Regex;
 use rustical_ical::{CalDateTime, CalendarObject, CalendarObjectType};
 use rustical_store::calendar_store::CalendarQuery;
 use rustical_store::synctoken::format_synctoken;
@@ -145,6 +146,83 @@ impl SqliteCalendarStore {
         }
     }
 
+    /// In the past exports generated objects with invalid VERSION:4.0
+    /// This repair sets them to VERSION:2.0
+    #[allow(clippy::missing_panics_doc)]
+    pub async fn repair_invalid_version_4_0(&self) -> Result<(), Error> {
+        struct Row {
+            principal: String,
+            cal_id: String,
+            id: String,
+            ics: String,
+        }
+
+        let mut tx = self
+            .db
+            .begin_with(BEGIN_IMMEDIATE)
+            .await
+            .map_err(crate::Error::from)?;
+
+        #[allow(clippy::missing_panics_doc)]
+        let version_pattern = Regex::new(r"(?mi)^VERSION:4.0").unwrap();
+
+        let repairs: Vec<Row> = sqlx::query_as!(
+            Row,
+            r#"SELECT principal, cal_id, id, ics FROM calendarobjects WHERE ics LIKE '%VERSION:4.0%';"#
+        )
+        .fetch_all(&mut *tx)
+        .await
+        .map_err(crate::Error::from)?
+            .into_iter()
+            .filter_map(|mut row| {
+                version_pattern.find(&row.ics)?;
+                let new_ics = version_pattern.replace(&row.ics, "VERSION:2.0");
+                // Safeguard that we really only changed the version
+                assert_eq!(row.ics.len(), new_ics.len());
+                row.ics = new_ics.to_string();
+                Some(row)
+            })
+            .collect();
+
+        if repairs.is_empty() {
+            return Ok(());
+        }
+        warn!(
+            "Found {} calendar objects with invalid VERSION:4.0. Repairing by setting to VERSION:2.0",
+            repairs.len()
+        );
+
+        for repair in &repairs {
+            // calendarobjectchangelog is used by sync-collection to fetch changes
+            // By deleting entries we will later regenerate new entries such that clients will notice
+            // the objects have changed
+            warn!(
+                "Repairing VERSION for {}/{}/{}.ics",
+                repair.principal, repair.cal_id, repair.id
+            );
+            sqlx::query!(
+                "DELETE FROM calendarobjectchangelog WHERE (principal, cal_id, object_id) = (?, ?, ?);",
+                repair.principal, repair.cal_id, repair.id
+            ).execute(&mut *tx).await
+            .map_err(crate::Error::from)?;
+
+            sqlx::query!(
+                "UPDATE calendarobjects SET ics = ? WHERE (principal, cal_id, id) = (?, ?, ?);",
+                repair.ics,
+                repair.principal,
+                repair.cal_id,
+                repair.id
+            )
+            .execute(&mut *tx)
+            .await
+            .map_err(crate::Error::from)?;
+        }
+
+        tx.commit().await.map_err(crate::Error::from)?;
+
+        Ok(())
+    }
+
     // Commit "orphaned" objects to the changelog table
     pub async fn repair_orphans(&self) -> Result<(), Error> {
         struct Row {

src/commands/mod.rs

@@ -17,6 +17,7 @@ pub fn cmd_gen_config(_args: GenConfigArgs) -> anyhow::Result<()> {
         http: HttpConfig::default(),
         data_store: DataStoreConfig::Sqlite(SqliteDataStoreConfig {
             db_url: "/var/lib/rustical/db.sqlite3".to_owned(),
+            run_repairs: true,
         }),
         tracing: TracingConfig::default(),
         frontend: FrontendConfig {

src/config.rs

@@ -26,6 +26,8 @@ impl Default for HttpConfig {
 #[serde(deny_unknown_fields)]
 pub struct SqliteDataStoreConfig {
     pub db_url: String,
+    #[serde(default = "default_true")]
+    pub run_repairs: bool,
 }
 
 #[derive(Debug, Deserialize, Serialize)]

src/main.rs

@@ -70,15 +70,22 @@ async fn get_data_stores(
     Receiver<CollectionOperation>,
 )> {
     Ok(match &config {
-        DataStoreConfig::Sqlite(SqliteDataStoreConfig { db_url }) => {
+        DataStoreConfig::Sqlite(SqliteDataStoreConfig {
+            db_url,
+            run_repairs,
+        }) => {
             let db = create_db_pool(db_url, migrate).await?;
             // Channel to watch for changes (for DAV Push)
             let (send, recv) = tokio::sync::mpsc::channel(1000);
 
             let addressbook_store = Arc::new(SqliteAddressbookStore::new(db.clone(), send.clone()));
-            addressbook_store.repair_orphans().await?;
             let cal_store = Arc::new(SqliteCalendarStore::new(db.clone(), send));
-            cal_store.repair_orphans().await?;
+            if *run_repairs {
+                info!("Running repair tasks");
+                addressbook_store.repair_orphans().await?;
+                cal_store.repair_invalid_version_4_0().await?;
+                cal_store.repair_orphans().await?;
+            }
             let subscription_store = Arc::new(SqliteStore::new(db.clone()));
             let principal_store = Arc::new(SqlitePrincipalStore::new(db));
             (
@@ -119,7 +126,9 @@ async fn main() -> Result<()> {
                 get_data_stores(!args.no_migrations, &config.data_store).await?;
 
             warn!(
-                "Validating calendar data against the next-version ical parser.\nIn the next major release these will be rejected and cause errors.\nIf any errors occur, please open an issue so they can be fixed before the next major release."
+                "Validating calendar data against the next-version ical parser.
+In the next major release these will be rejected and cause errors.
+If any errors occur, please open an issue so they can be fixed before the next major release."
             );
             validate_calendar_objects_0_12(principal_store.as_ref(), cal_store.as_ref()).await?;
             validate_address_objects_0_12(principal_store.as_ref(), addr_store.as_ref()).await?;