Merge branch '505-invalid-paths-in-etc-asusd-anime-ron-result-in-broken-anime-control' into 'main'

Resolve "Invalid paths in /etc/asusd/anime.ron result in broken anime control"

Closes #505

See merge request asus-linux/asusctl!188

CHANGELOG.md

@@ -11,6 +11,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Add G513RS to laptop DB.
 
+### Changed
+
+- Rename and recreate the default Anime config if cache setup fails
+
 ## [v6.0.8]
 
 ### Added

asusd/src/ctrl_anime/mod.rs

@@ -90,7 +90,7 @@ impl CtrlAnime {
         //     }
         // }
 
-        let config = AnimeConfig::new().load();
+        let mut config = AnimeConfig::new().load();
         let mut anime_type = get_anime_type()?;
         if let AnimeType::Unknown = anime_type {
             if let Some(model) = config.model_override {
@@ -101,7 +101,12 @@ impl CtrlAnime {
 
         info!("Device has an AniMe Matrix display: {anime_type:?}");
         let mut cache = AnimeConfigCached::default();
-        cache.init_from_config(&config, anime_type)?;
+        if let Err(e) = cache.init_from_config(&config, anime_type) {
+            error!("Trying to cache the Anime Config failed, will reset to default config: {e:?}");
+            config.rename_file_old();
+            config = AnimeConfig::new();
+            config.write();
+        }
 
         let ctrl = CtrlAnime {
             node,

config-traits/src/lib.rs

@@ -146,11 +146,7 @@ where
 
     /// Renames the existing file to `<file>-old`
     fn rename_file_old(&self) {
-        warn!(
-            "Renaming {} to {}-old and recreating config",
-            self.file_name(),
-            self.file_name()
-        );
+        warn!("Renaming {} to {}-old", self.file_name(), self.file_name());
         let mut cfg_old = self.file_path().to_string_lossy().to_string();
         cfg_old.push_str("-old");
         std::fs::rename(self.file_path(), cfg_old).unwrap_or_else(|err| {

rog-anime/src/diagonal.rs

@@ -3,6 +3,8 @@
 use std::path::Path;
 use std::time::Duration;
 
+use log::error;
+
 use crate::data::AnimeDataBuffer;
 use crate::error::{AnimeError, Result};
 use crate::AnimeType;
@@ -49,7 +51,10 @@ impl AnimeDiagonal {
         bright: f32,
         anime_type: AnimeType,
     ) -> Result<Self> {
-        let data = std::fs::read(path)?;
+        let data = std::fs::read(path).map_err(|e| {
+            error!("Could not open {path:?}: {e:?}");
+            e
+        })?;
         let data = std::io::Cursor::new(data);
         let decoder = png_pong::Decoder::new(data)?.into_steps();
         let png_pong::Step { raster, delay: _ } = decoder.last().ok_or(AnimeError::NoFrames)??;

rog-anime/src/gif.rs

@@ -4,6 +4,7 @@ use std::path::Path;
 use std::time::Duration;
 
 use glam::Vec2;
+use log::error;
 use serde_derive::{Deserialize, Serialize};
 
 use crate::error::{AnimeError, Result};
@@ -107,7 +108,10 @@ impl AnimeGif {
         // Configure the decoder such that it will expand the image to RGBA.
         decoder.set_color_output(gif::ColorOutput::RGBA);
         // Read the file header
-        let file = File::open(file_name)?;
+        let file = File::open(file_name).map_err(|e| {
+            error!("Could not open {file_name:?}: {e:?}");
+            e
+        })?;
         let mut decoder = decoder.read_info(file)?;
 
         let mut frames = Vec::default();
@@ -186,12 +190,14 @@ impl AnimeGif {
         anime_type: AnimeType,
     ) -> Result<Self> {
         let mut frames = Vec::new();
-
         let mut decoder = gif::DecodeOptions::new();
         // Configure the decoder such that it will expand the image to RGBA.
         decoder.set_color_output(gif::ColorOutput::RGBA);
         // Read the file header
-        let file = File::open(file_name)?;
+        let file = File::open(file_name).map_err(|e| {
+            error!("Could not open {file_name:?}: {e:?}");
+            e
+        })?;
         let mut decoder = decoder.read_info(file)?;
 
         let height = decoder.height();

rog-anime/src/image.rs

@@ -3,6 +3,7 @@ use std::path::Path;
 
 pub use glam::Vec2;
 use glam::{Mat3, Vec3};
+use log::error;
 
 use crate::data::AnimeDataBuffer;
 use crate::error::{AnimeError, Result};
@@ -421,7 +422,10 @@ impl AnimeImage {
         bright: f32,
         anime_type: AnimeType,
     ) -> Result<Self> {
-        let data = std::fs::read(path)?;
+        let data = std::fs::read(path).map_err(|e| {
+            error!("Could not open {path:?}: {e:?}");
+            e
+        })?;
         let data = std::io::Cursor::new(data);
         let decoder = png_pong::Decoder::new(data)?.into_steps();
         let png_pong::Step { raster, delay: _ } = decoder.last().ok_or(AnimeError::NoFrames)??;