mirror of
https://github.com/marcoallegretti/WEFT_OS.git
synced 2026-11-22 08:13:59 +00:00
fix(pack): never delete a data directory that was not moved
weft-pack uninstall moved earlier app data only when the package manifest could be read and declared an app-data capability, and only when the store path was spelled exactly as the user store; otherwise it removed the package directory with the data in it. A directory left holding only data by an earlier weft-appd, which has no manifest, was deleted that way. A data directory is now never removed with a package. In the user store, recognised by its real location rather than its spelling, it is moved when the package declares app data or its manifest cannot be read; in every other case uninstall stops and changes nothing. Tests cover a directory holding only data, a store reached through '..', a symbolically linked home, an app without the capability and another store. weft-appd reports both locations when a move fails with an I/O error and creates the data directory with mode 0700 instead of tightening it afterwards.
This commit is contained in:
parent
f39a330027
commit
1928ffb661
4 changed files with 112 additions and 25 deletions
|
|
@ -186,10 +186,22 @@ fn prepare_app_data(app_id: &str, dir: &Path, host: &HostDirs) -> Result<(), Ref
|
|||
}
|
||||
Ok(Migration::NotNeeded) => {}
|
||||
Err(e @ MigrationError::Conflict { .. }) => return Err(Refusal::new(409, e.to_string())),
|
||||
Err(MigrationError::Io(e)) => {
|
||||
return Err(Refusal::new(
|
||||
500,
|
||||
format!(
|
||||
"cannot move app data from {} to {}: {e}",
|
||||
legacy.display(),
|
||||
dir.display()
|
||||
),
|
||||
));
|
||||
}
|
||||
Err(e) => return Err(Refusal::new(500, e.to_string())),
|
||||
}
|
||||
let mut builder = std::fs::DirBuilder::new();
|
||||
builder.recursive(true);
|
||||
#[cfg(unix)]
|
||||
std::os::unix::fs::DirBuilderExt::mode(&mut builder, 0o700);
|
||||
builder
|
||||
.create(dir)
|
||||
.and_then(|()| weft_ipc_types::package::make_private(dir))
|
||||
|
|
|
|||
|
|
@ -302,7 +302,7 @@ fn install_package_to(path: &Path, store_root: &Path) -> anyhow::Result<()> {
|
|||
// where the package now goes; move the data to its own location so it
|
||||
// neither blocks nor joins the package.
|
||||
if dest.is_dir() && only_holds_app_data(&dest)? {
|
||||
if declares_app_data(&manifest) {
|
||||
if std::fs::symlink_metadata(dest.join("data")).is_ok() && is_user_store(store_root) {
|
||||
move_app_data_out(app_id, &dest)?;
|
||||
}
|
||||
let _ = std::fs::remove_dir(&dest);
|
||||
|
|
@ -337,10 +337,29 @@ fn uninstall_package_from(app_id: &str, store_root: &Path) -> anyhow::Result<()>
|
|||
target.display()
|
||||
);
|
||||
}
|
||||
if load_manifest(&target).is_ok_and(|m| declares_app_data(&m)) {
|
||||
// A `data` directory is never removed with the package: packages cannot
|
||||
// ship one, so it holds app data from an earlier version. It is moved to
|
||||
// the app data directory when this is the user store and the package
|
||||
// declares app data (or its manifest cannot be read); otherwise uninstall
|
||||
// stops and leaves everything in place.
|
||||
if std::fs::symlink_metadata(target.join("data")).is_ok() {
|
||||
let may_hold_app_data = load_manifest(&target).map_or(true, |m| declares_app_data(&m));
|
||||
if !(may_hold_app_data && is_user_store(store_root)) {
|
||||
anyhow::bail!(
|
||||
"{} contains a 'data' directory that may hold app data; move it aside before \
|
||||
uninstalling",
|
||||
target.display()
|
||||
);
|
||||
}
|
||||
move_app_data_out(app_id, &target)?;
|
||||
}
|
||||
std::fs::remove_dir_all(&target).with_context(|| format!("remove {}", target.display()))?;
|
||||
// Moving the data removes a package directory it leaves empty.
|
||||
match std::fs::remove_dir_all(&target) {
|
||||
Err(e) if e.kind() != std::io::ErrorKind::NotFound => {
|
||||
return Err(e).with_context(|| format!("remove {}", target.display()));
|
||||
}
|
||||
_ => {}
|
||||
}
|
||||
println!("uninstalled {}", app_id);
|
||||
Ok(())
|
||||
}
|
||||
|
|
@ -366,22 +385,30 @@ fn declares_app_data(manifest: &Manifest) -> bool {
|
|||
.any(|c| matches!(c.parse(), Ok(Capability::AppData(_))))
|
||||
}
|
||||
|
||||
/// Moves app data that an earlier weft-appd kept in `<package_dir>/data` to
|
||||
/// the app's data directory, which package operations never remove. Earlier
|
||||
/// versions only did so in the user package store (`~/.local/share/weft/apps`),
|
||||
/// so other stores are left alone. Fails, changing nothing, if the data
|
||||
/// cannot be moved.
|
||||
/// Whether `store_root` is the user package store, where earlier versions of
|
||||
/// weft-appd kept app data, however the path is spelled.
|
||||
fn is_user_store(store_root: &Path) -> bool {
|
||||
let Some(home) = std::env::var_os("HOME").map(PathBuf::from) else {
|
||||
return false;
|
||||
};
|
||||
let user_store = home.join(".local/share/weft/apps");
|
||||
match (
|
||||
std::fs::canonicalize(store_root),
|
||||
std::fs::canonicalize(user_store),
|
||||
) {
|
||||
(Ok(a), Ok(b)) => a == b,
|
||||
_ => false,
|
||||
}
|
||||
}
|
||||
|
||||
/// Moves app data that an earlier weft-appd kept in `<package_dir>/data` in
|
||||
/// the user store to the app's data directory, which package operations
|
||||
/// never remove. Fails, changing nothing, if the data cannot be moved.
|
||||
fn move_app_data_out(app_id: &str, package_dir: &Path) -> anyhow::Result<()> {
|
||||
use weft_ipc_types::package::{
|
||||
Migration, app_data_dir, data_home, legacy_app_data_dir, make_private, migrate_app_data,
|
||||
};
|
||||
let Some(home) = std::env::var_os("HOME").map(PathBuf::from) else {
|
||||
return Ok(());
|
||||
Migration, app_data_dir, data_home, make_private, migrate_app_data,
|
||||
};
|
||||
let legacy = package_dir.join("data");
|
||||
if legacy != legacy_app_data_dir(&home, app_id) {
|
||||
return Ok(());
|
||||
}
|
||||
let data_home = data_home().context("cannot locate the data home to keep app data")?;
|
||||
let target = app_data_dir(&data_home, app_id);
|
||||
if migrate_app_data(&legacy, &target).with_context(|| format!("keep app data of {app_id}"))?
|
||||
|
|
@ -749,27 +776,74 @@ mod tests {
|
|||
}
|
||||
|
||||
#[test]
|
||||
fn other_stores_and_apps_without_data_capability_are_left_alone() {
|
||||
let home = temp_root("alone");
|
||||
let app_id = "com.example.alone";
|
||||
// No app-data capability: a data directory is not app data.
|
||||
fn data_that_is_not_moved_is_never_removed() {
|
||||
let home = temp_root("refuse");
|
||||
let app_id = "com.example.refuse";
|
||||
// No app-data capability: the data directory is left and uninstall stops.
|
||||
write_package(&home.join("src"), app_id, "");
|
||||
let store = home.join(".local/share/weft/apps");
|
||||
install_package_to(&home.join("src"), &store).unwrap();
|
||||
std::fs::create_dir_all(store.join(app_id).join("data")).unwrap();
|
||||
with_home(&home, || uninstall_package_from(app_id, &store)).unwrap();
|
||||
assert!(!home.join("share").exists());
|
||||
std::fs::write(store.join(app_id).join("data/x"), "x").unwrap();
|
||||
assert!(with_home(&home, || uninstall_package_from(app_id, &store)).is_err());
|
||||
assert_eq!(
|
||||
std::fs::read_to_string(store.join(app_id).join("data/x")).unwrap(),
|
||||
"x"
|
||||
);
|
||||
std::fs::remove_dir_all(store.join(app_id)).unwrap();
|
||||
|
||||
// Another store: earlier versions never kept data there.
|
||||
// Another store: earlier versions never kept data there, so it stops too.
|
||||
write_package(&home.join("src2"), app_id, APP_DATA);
|
||||
let other = home.join("other-store");
|
||||
install_package_to(&home.join("src2"), &other).unwrap();
|
||||
std::fs::create_dir_all(other.join(app_id).join("data")).unwrap();
|
||||
with_home(&home, || uninstall_package_from(app_id, &other)).unwrap();
|
||||
assert!(with_home(&home, || uninstall_package_from(app_id, &other)).is_err());
|
||||
assert!(other.join(app_id).join("data").is_dir());
|
||||
assert!(!home.join("share").exists());
|
||||
let _ = std::fs::remove_dir_all(&home);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn data_left_without_a_manifest_is_moved_not_deleted() {
|
||||
let home = temp_root("orphan");
|
||||
let app_id = "org.weft.demo.notes";
|
||||
let store = home.join(".local/share/weft/apps");
|
||||
std::fs::create_dir_all(store.join(app_id).join("data")).unwrap();
|
||||
std::fs::write(store.join(app_id).join("data/notes.txt"), "kept").unwrap();
|
||||
// The store reached through another spelling of the same path.
|
||||
let spelled = home.join(".local/share/weft/../weft/apps");
|
||||
with_home(&home, || uninstall_package_from(app_id, &spelled)).unwrap();
|
||||
let kept = weft_ipc_types::package::app_data_dir(&home.join("share"), app_id);
|
||||
assert_eq!(
|
||||
std::fs::read_to_string(kept.join("notes.txt")).unwrap(),
|
||||
"kept"
|
||||
);
|
||||
assert!(!store.join(app_id).exists());
|
||||
let _ = std::fs::remove_dir_all(&home);
|
||||
}
|
||||
|
||||
#[cfg(unix)]
|
||||
#[test]
|
||||
fn a_linked_home_still_finds_the_user_store() {
|
||||
let root = temp_root("linked");
|
||||
let real = root.join("var-home");
|
||||
let app_id = "org.weft.demo.notes";
|
||||
std::fs::create_dir_all(
|
||||
real.join(".local/share/weft/apps")
|
||||
.join(app_id)
|
||||
.join("data"),
|
||||
)
|
||||
.unwrap();
|
||||
std::os::unix::fs::symlink(&real, root.join("home")).unwrap();
|
||||
let store = real.join(".local/share/weft/apps");
|
||||
with_home(&root.join("home"), || {
|
||||
uninstall_package_from(app_id, &store)
|
||||
})
|
||||
.unwrap();
|
||||
assert!(weft_ipc_types::package::app_data_dir(&root.join("home/share"), app_id).is_dir());
|
||||
let _ = std::fs::remove_dir_all(&root);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn packages_cannot_ship_a_top_level_data_entry() {
|
||||
let root = temp_root("ships-data");
|
||||
|
|
|
|||
|
|
@ -112,12 +112,12 @@ Package store roots (in priority order):
|
|||
|
||||
## App data
|
||||
|
||||
Each app's private data lives in `$XDG_DATA_HOME/weft/app-data/<id>` (`~/.local/share/weft/app-data/<id>` by default), apart from installed packages. Installing, updating or uninstalling a package never removes it. `weft-appd` creates the directory when a session with an app-data capability starts and makes it accessible only to the user (mode 0700). `weft-appd` and `weft-pack` must run with the same `HOME` and `XDG_DATA_HOME` to agree on this location; the systemd unit allows `weft-appd` to write under `~/.local/share/weft`.
|
||||
Each app's private data lives in `$XDG_DATA_HOME/weft/app-data/<id>` (`~/.local/share/weft/app-data/<id>` by default), apart from installed packages. Installing, updating or uninstalling a package never removes it. `weft-appd` creates the directory when a session with an app-data capability starts and makes it accessible only to the user (mode 0700); a symbolic link in its place is refused rather than followed. `weft-appd` and `weft-pack` must run with the same `HOME` and `XDG_DATA_HOME` to agree on this location; the systemd unit allows `weft-appd` to write under `~/.local/share/weft`.
|
||||
|
||||
Earlier versions kept app data inside the user package store, in `~/.local/share/weft/apps/<id>/data`, for apps declaring an app-data capability. That directory is moved to the new location in a single rename, which never replaces an existing directory:
|
||||
|
||||
- by `weft-appd`, on the first launch with an app-data capability;
|
||||
- by `weft-pack uninstall` and `weft-pack install`, before they touch the package directory, for packages in the user store that declare an app-data capability.
|
||||
- by `weft-pack uninstall` and `weft-pack install`, before they touch a package directory in the user store (however its path is spelled). `uninstall` moves it when the package declares an app-data capability or its manifest cannot be read, and otherwise stops without removing anything; a `data` directory is never deleted with a package.
|
||||
|
||||
A package directory left empty by the move is removed. Nothing is moved, and `weft-pack` stops or the launch is refused, when the new location already exists, even empty (error 409), when the old one is not a plain directory, or when the two are on different filesystems (error 500); the message names both locations so the user can keep one copy and remove the other. The system UI shows such refusals. Packages cannot contain a top-level `data` entry, so package content is never taken for app data. `tests/frame/check_app_data.py` checks that existing Notes data arrives byte for byte, that the Notes session then reads and saves it, and that a conflict is refused.
|
||||
|
||||
|
|
|
|||
|
|
@ -17,6 +17,7 @@ RestartSec=1s
|
|||
ProtectSystem=strict
|
||||
PrivateTmp=true
|
||||
# App data and the user package store, where earlier versions kept app data.
|
||||
# %h is the home of the user the unit runs as; run it as the session user.
|
||||
ReadWritePaths=%t -%h/.local/share/weft
|
||||
|
||||
[Install]
|
||||
|
|
|
|||
Loading…
Reference in a new issue