From 0478662854a2c1532a2dd484237c4a3231d3329f Mon Sep 17 00:00:00 2001
From: Ilya Grigoriev <ilyagr@users.noreply.github.com>
Date: Wed, 21 Feb 2024 11:54:46 -0800
Subject: [PATCH] Draft for checking before saving

---
 backend-local-server/src/fs.rs    |  8 ++++--
 backend-local-server/src/types.rs | 44 ++++++++++++++++++++++++++++++-
 2 files changed, 49 insertions(+), 3 deletions(-)

diff --git a/backend-local-server/src/fs.rs b/backend-local-server/src/fs.rs
index 76454e1..def46d4 100644
--- a/backend-local-server/src/fs.rs
+++ b/backend-local-server/src/fs.rs
@@ -26,6 +26,8 @@ pub enum ThreeDirInput {
 }
 
 impl DataInterface for ThreeDirInput {
+    // TODO: A more efficient `get_valid_entries` implementation
+
     fn scan(&self) -> Result<EntriesToCompare, DataReadError> {
         match self {
             Self::FakeData => Ok(fake_data()),
@@ -33,10 +35,12 @@ impl DataInterface for ThreeDirInput {
         }
     }
 
-    fn save(&self, result: indexmap::IndexMap<String, String>) -> Result<(), DataSaveError> {
+    fn save_unchecked(
+        &self,
+        result: indexmap::IndexMap<String, String>,
+    ) -> Result<(), DataSaveError> {
         let outdir = match self {
             Self::FakeData => {
-                // TOOO: Somewhat better error handling :)
                 eprintln!("Can't save fake demo data. Here it is as TOML");
                 eprintln!();
                 eprintln!(
diff --git a/backend-local-server/src/types.rs b/backend-local-server/src/types.rs
index 84a459b..d4f2fb8 100644
--- a/backend-local-server/src/types.rs
+++ b/backend-local-server/src/types.rs
@@ -14,6 +14,14 @@ pub enum DataSaveError {
     IOError(PathBuf, std::io::Error),
     #[error("Cannot save the demo fake data")]
     CannotSaveFakeData,
+    #[error("Failed to retreive valid paths for saving: {0}")]
+    ValidationIOError(#[from] DataReadError),
+    #[error(
+        "Security error: got request to save to a file that wasn't one of the files being merged: \
+         '{0}'\nPerhaps this client is now connected to a different server than the one it was \
+         started from?"
+    )]
+    ValidationFailError(String),
 }
 
 #[derive(Error, Debug)]
@@ -42,7 +50,41 @@ impl serde::Serialize for DataReadError {
 
 // TODO: What does 'static mean here? Can it be loosened?
 pub trait DataInterface: Send + Sync + 'static {
+    /// Return the content of either the original files to merge or the
+    /// last-saved version.
+    ///
+    /// A `scan()` after a successful `save()` should return the saved results.
     fn scan(&self) -> Result<EntriesToCompare, DataReadError>;
     // TODO: Make `save` more generic than IndexMap
-    fn save(&self, result: indexmap::IndexMap<String, String>) -> Result<(), DataSaveError>;
+    // TODO: Use `&mut self` in save
+    /// Do not use this method directly, as it does not check whether the
+    /// requested paths are save to save to.
+    fn save_unchecked(
+        &self,
+        result: indexmap::IndexMap<String, String>,
+    ) -> Result<(), DataSaveError>;
+
+    /// Get a list of all the files we were originally asked to merge.
+    ///
+    /// The default implementation may be very inefficient.
+    fn get_valid_entries(&self) -> Result<std::collections::HashSet<PathBuf>, DataReadError> {
+        let entries = self.scan()?;
+        Ok(entries.0.keys().cloned().collect())
+    }
+
+    /// Save the result. First, check that each file being saved was one of the
+    /// files we were comparing originally.
+    fn save(&self, result: indexmap::IndexMap<String, String>) -> Result<(), DataSaveError> {
+        let valid_entries = self.get_valid_entries()?;
+        if let Some(unsafe_path) = result
+            .keys()
+            .find(|x| !valid_entries.contains::<PathBuf>(&x.into()))
+        {
+            // TODO: Have the server print some debug info, e.g. the list of
+            // valid file names, to the terminal. It should not be returned to
+            // the HTTP request, though.
+            return Err(DataSaveError::ValidationFailError(unsafe_path.to_string()));
+        }
+        self.save_unchecked(result)
+    }
 }