Merge branch 'develop' into vpk

Author: sour-dani

CONTRIBUTING.md

@@ -2,6 +2,8 @@
 
 **When creating a PR, you must branch off the `develop` branch.** When merging back into this repo remember to select the `develop` as the branch to merge into. After the **7th of June 2024** any PRs that **do not** use `develop` as the base branch will be closed.
 
+**Before submitting a PR** make sure to format your code using the `cargo fmt` command. Code that is not properly formatted will need to do so before being merged.
+
 When adding a new feature (that a user will interact with), create a new file in `src/workflows/` with the name of the feature (for example, `launch.rs`). Inside of `launch.rs` you would have a struct with the name of `LaunchWorkflow`. It would look something like this;
 ```rust
 use crate::{RunnerContext, BeansError};

src/error.rs

@@ -175,12 +175,31 @@ pub enum BeansError
         old_location: String,
         old_content: String
     },
+    #[error("Failed to serialize JSON {instance:?} to location {location} ({error:})")]
+    VersionFileSerializeFailure
+    {
+        error: serde_json::Error,
+        instance: AdastralVersionFile,
+        location: String
+    },
     #[error("Failed to read version file at {location}. ({error:})")]
     VersionFileReadFailure
     {
         error: std::io::Error,
         location: String
     },
+    #[error("Failed to open version file at {location}. ({error:})")]
+    VersionFileOpenFailure
+    {
+        error: std::io::Error,
+        location: String
+    },
+    #[error("Failed to write version file at {location}. ({error:})")]
+    VersionFileWriteFailure
+    {
+        error: std::io::Error,
+        location: String
+    },
 
     #[error("Failed to serialize provided AppVarData to JSON. ({error:})")]
     AppVarDataSerializeFailure

src/version.rs

@@ -3,6 +3,7 @@ use std::{backtrace::Backtrace,
           fs::{File,
                read_to_string},
           io::{Read,
+               BufWriter,
                Write}};
 
 use log::{debug,
@@ -319,6 +320,68 @@ async fn generate_version_file(
     log::info!("Generated .adastral file at location {}", mod_path);
 
     Ok(mod_version_translation)
+  
+/// set the version in the `.adastral` file in the sourcemod folder.
+/// will silently fail when install_state is not InstallType::Adastral, or the
+/// sourcemod isn't installed.
+pub fn set_current_version(
+    sourcemods_location: Option<String>,
+    new_version: usize
+) -> Result<(), BeansError>
+{
+    let install_state = helper::install_state(sourcemods_location.clone());
+    if install_state != InstallType::Adastral
+    {
+        return Ok(());
+    }
+    match get_mod_location(sourcemods_location)
+    {
+        Some(smp_x) =>
+        {
+            // TODO generate BeansError instead of using panic
+            let location = format!("{}.adastral", smp_x);
+            let file = match helper::file_exists(location.clone())
+            {
+                false => match File::create(&location)
+                {
+                    Ok(v) => v,
+                    Err(e) =>
+                    {
+                        return Err(BeansError::VersionFileWriteFailure {
+                            location: location.clone(),
+                            error: e
+                        });
+                    }
+                },
+                true => match File::open(&location)
+                {
+                    Ok(v) => v,
+                    Err(e) =>
+                    {
+                        return Err(BeansError::VersionFileOpenFailure {
+                            location: location.clone(),
+                            error: e
+                        });
+                    }
+                }
+            };
+            let data = AdastralVersionFile {
+                version: format!("{new_version}")
+            };
+            debug!("[set_current_version] location: {location:}, content: {data:?}");
+            let mut writer = BufWriter::new(file);
+            match serde_json::to_writer(&mut writer, &data)
+            {
+                Ok(_) => Ok(()),
+                Err(e) => Err(BeansError::VersionFileSerializeFailure {
+                    location: location.clone(),
+                    instance: data.clone(),
+                    error: e
+                })
+            }
+        }
+        None => Ok(()) // silently fail
+    }
 }
 
 fn get_version_location(sourcemods_location: Option<String>) -> Option<String>

src/workflows/update.rs

@@ -5,7 +5,8 @@ use crate::{BeansError,
             RunnerContext,
             appvar::AppVarData,
             butler,
-            helper};
+            helper,
+            version};
 
 pub struct UpdateWorkflow
 {
@@ -30,6 +31,7 @@ impl UpdateWorkflow
         };
 
         let remote_version = ctx.current_remote_version()?;
+        let (remote_version_ident, _) = ctx.latest_remote_version();
 
         ctx.prepare_symlink()?;
         let patch = match ctx.has_patch_available()
@@ -112,6 +114,9 @@ impl UpdateWorkflow
             return Err(e);
         }
 
+        info!("[UpdateWorkflow] Updating version file (.adastral)");
+        version::set_current_version(Some(ctx.sourcemod_path.clone()), remote_version_ident)?;
+
         ctx.gameinfo_perms()?;
 
         Self::post_update_msg();