1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
//! The ecosystem's one switch for the update notice: whether its applications ask once a day if a
//! newer version of themselves is out.
//!
//! It lives in the ecosystem's shared file only, as `update-notice = false`, because it is a choice
//! about the ecosystem rather than one application: a person who does not want to be told turns it
//! off once. A missing key is on, so an ecosystem that never heard of the notice has it.
use std::fs;
use std::io;
use std::path::Path;
use super::{Ecosystem, SettingValue, Settings};
/// The switch as the shared file `settings` has it: on unless it says `false`.
pub(super) fn from_shared(settings: &Settings) -> bool {
settings.get::<bool>(Settings::UPDATE_NOTICE).unwrap_or(true)
}
impl Ecosystem {
/// Whether the ecosystem's applications say when a newer version is out: the shared file's
/// `update-notice`, on when the file or the key is missing. Off without a home folder, where
/// nothing could remember that it was asked.
#[must_use]
pub fn update_notice(&self) -> bool {
self.config_dir().is_some_and(|dir| self.update_notice_in(&dir))
}
/// [`update_notice`](Self::update_notice) with `config_dir` as the ecosystem's folder instead of
/// this platform's, for a test or a demo.
#[must_use]
pub fn update_notice_in(&self, config_dir: &Path) -> bool {
let path = config_dir.join(super::ecosystem::file_name(self.id()));
!path.exists() || from_shared(&Settings::open(path))
}
/// Turns the update notice on or off for every application of the ecosystem, in the shared file.
/// The file is read right before it is written and only this key changes in it, as
/// [`set`](Self::set) does.
///
/// # Errors
///
/// Returns an error of kind [`io::ErrorKind::NotFound`] when there is no home folder, and any
/// error from writing.
pub fn set_update_notice(&self, on: bool) -> io::Result<()> {
match self.config_dir() {
Some(dir) => self.set_update_notice_in(&dir, on),
None => Err(io::Error::new(io::ErrorKind::NotFound, "no config directory found")),
}
}
/// [`set_update_notice`](Self::set_update_notice) with `config_dir` as the ecosystem's folder
/// instead of this platform's.
///
/// ```
/// use qframe::storage::Ecosystem;
///
/// # let folder = std::env::temp_dir().join(format!("quvyta-update-notice-doc-{}", std::process::id()));
/// assert!(Ecosystem::QUVYTA.update_notice_in(&folder), "on until someone turns it off");
/// Ecosystem::QUVYTA.set_update_notice_in(&folder, false).expect("saved");
/// assert!(!Ecosystem::QUVYTA.update_notice_in(&folder));
/// # std::fs::remove_dir_all(&folder).ok();
/// ```
///
/// # Errors
///
/// Any error from writing.
pub fn set_update_notice_in(&self, config_dir: &Path, on: bool) -> io::Result<()> {
fs::create_dir_all(config_dir)?;
let _held = super::preferences::hold_folder(config_dir)?;
let shared = config_dir.join(super::ecosystem::file_name(self.id()));
super::preferences::rewrite(&shared, Settings::UPDATE_NOTICE, SettingValue::Bool(on), None)
}
}
#[cfg(test)]
mod tests {
use crate::i18n::I18n;
use crate::storage::Ecosystem;
fn scratch(name: &str) -> std::path::PathBuf {
let dir = std::env::temp_dir().join(format!("quvyta-update-notice-{name}-{}", std::process::id()));
let _ = std::fs::remove_dir_all(&dir);
dir
}
#[test]
fn the_notice_is_on_until_the_ecosystem_turns_it_off_and_other_keys_stay() {
let dir = scratch("switch");
let ecosystem = Ecosystem::QUVYTA;
assert!(ecosystem.update_notice_in(&dir), "an ecosystem that never chose has it");
std::fs::create_dir_all(&dir).expect("folder");
std::fs::write(dir.join("quvyta.conf"), "theme = \"amber\"\n").expect("shared file");
assert!(ecosystem.update_notice_in(&dir), "a shared file without the key has it");
ecosystem.set_update_notice_in(&dir, false).expect("saved");
assert!(!ecosystem.update_notice_in(&dir));
assert!(!ecosystem.preferences_in(&dir, "code", &I18n::builtin()).update_notice(), "preferences read it too");
let text = std::fs::read_to_string(dir.join("quvyta.conf")).expect("read");
assert!(text.contains("theme = \"amber\"") && text.contains("update-notice = false"), "{text}");
ecosystem.set_update_notice_in(&dir, true).expect("saved");
assert!(ecosystem.preferences_in(&dir, "code", &I18n::builtin()).update_notice());
std::fs::remove_dir_all(dir).ok();
}
}