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 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944
#![doc(html_favicon_url = "https://raw.githubusercontent.com/zng-ui/zng/main/examples/image/res/zng-logo-icon.png")]
#![doc(html_logo_url = "https://raw.githubusercontent.com/zng-ui/zng/main/examples/image/res/zng-logo.png")]
//!
//! Process environment directories and unique name.
//!
//! # Crate
//!
#![doc = include_str!(concat!("../", std::env!("CARGO_PKG_README")))]
#![warn(unused_extern_crates)]
#![warn(missing_docs)]
use std::{
fs,
io::{self, BufRead},
path::{Path, PathBuf},
str::FromStr,
};
use semver::Version;
use zng_txt::Txt;
use zng_unique_id::{lazy_static, lazy_static_init};
mod process;
pub use process::*;
lazy_static! {
static ref ABOUT: About = About::fallback_name();
}
/// Inits process metadata, calls process start handlers and defines the process lifetime in `main`.
///
/// This **must** be called in main.
///
/// Init [`about`] an [`About`] for the process metadata. See [`on_process_start!`] for process start handlers.
/// See [`on_process_exit`] for exit handlers called at the end of the `main` function.
///
/// # Process Start
///
/// A single Zng executable can be built with multiple components that spawn different instances
/// of the executable that must run as different processes. If the current instance is requested
/// by component `init!` runs it and exits the process, never returning flow to the normal main function.
///
/// ```
/// # mod zng { pub mod env { pub use zng_env::*; } }
/// fn main() {
/// println!("print in all processes");
/// zng::env::init!();
/// println!("print only in the app-process");
///
/// // directories are available after `init!`.
/// let _res = zng::env::res("");
///
/// // APP.defaults().run(...);
///
/// // on_exit handlers are called here
/// }
/// ```
///
/// # Web Start
///
/// WebAssembly builds (`target_arch = "wasm32"`) must share the app wasm module reference by setting the custom attribute
/// `__zng_env_init_module` on the Javascript `window` object.
///
/// The `init!` call **will panic** if the attribute is not found.
///
/// ```html
/// <script type="module">
/// import init, * as my_app_wasm from './my_app.js';
/// window.__zng_env_init_module = my_app_wasm;
/// async function main() {
/// await init();
/// }
/// main();
/// </script>
/// ```
///
/// The example above imports and runs an app built using [`wasm-pack`] with `--target web` options.
///
/// # Android Start
///
/// Android builds (`target_os = "android"`) receive an `AndroidApp` instance from the `android_main`. This type
/// is tightly coupled with the view-process implementation and so it is defined by the `zng-view` crate. In builds
/// feature `"view"` you must call `zng::view_process::default::android::init_android_app` just after `init!`.
///
/// ```
/// # macro_rules! demo { () => {
/// #[no_mangle]
/// fn android_main(app: zng::view_process::default::android::AndroidApp) {
/// zng::env::init!();
/// zng::view_process::default::android::init_android_app(app);
/// // zng::view_process::default::run_same_process(..);
/// }
/// # }}
/// ```
///
/// See the [multi example] for more details on how to support Android and other platforms.
///
/// [`wasm-pack`]: https://crates.io/crates/wasm-pack
/// [multi example]: https://github.com/zng-ui/zng/tree/main/examples#multi
#[macro_export]
macro_rules! init {
() => {
let _on_main_exit = $crate::init_parse!($crate);
};
}
#[doc(hidden)]
pub use zng_env_proc_macros::init_parse;
#[doc(hidden)]
pub fn init(about: About) -> impl Drop {
if lazy_static_init(&ABOUT, about).is_err() {
panic!("env already inited, env::init must be the first call in the process")
}
process_init()
}
/// Metadata about the app and main crate.
///
/// See [`about`] for more details.
#[derive(Clone, Debug, PartialEq, Eq, Hash, serde::Serialize, serde::Deserialize)]
pub struct About {
/// package.name
pub pkg_name: Txt,
/// package.authors
pub pkg_authors: Box<[Txt]>,
/// package.name in snake_case
pub crate_name: Txt,
/// package.version
pub version: Version,
/// package.metadata.zng.about.app or `pkg_name`
pub app: Txt,
/// package.metadata.zng.about.org or the first `pkg_authors`
pub org: Txt,
/// package.metadata.zng.about.qualifier
///
/// Reverse domain name notation, excluding the name of the application.
pub qualifier: Txt,
/// package.description
pub description: Txt,
/// package.homepage
pub homepage: Txt,
/// package.license
pub license: Txt,
/// If package.metadata.zng.about is set on the Cargo.toml manifest.
///
/// The presence of this section is used by `cargo zng res` to find the main
/// crate if the workspace has multiple bin crates.
pub has_about: bool,
}
impl About {
fn fallback_name() -> Self {
Self {
pkg_name: Txt::from_static(""),
pkg_authors: Box::new([]),
version: Version::new(0, 0, 0),
app: fallback_name(),
crate_name: Txt::from_static(""),
org: Txt::from_static(""),
qualifier: Txt::from_static(""),
description: Txt::from_static(""),
homepage: Txt::from_static(""),
license: Txt::from_static(""),
has_about: false,
}
}
/// Parse a Cargo.toml string.
pub fn parse_manifest(cargo_toml: &str) -> Result<Self, toml::de::Error> {
let m: Manifest = toml::from_str(cargo_toml)?;
let mut about = About {
crate_name: m.package.name.replace('-', "_").into(),
pkg_name: m.package.name,
pkg_authors: m.package.authors.unwrap_or_default(),
version: m.package.version,
description: m.package.description.unwrap_or_default(),
homepage: m.package.homepage.unwrap_or_default(),
license: m.package.license.unwrap_or_default(),
app: Txt::from_static(""),
org: Txt::from_static(""),
qualifier: Txt::from_static(""),
has_about: false,
};
if let Some(m) = m.package.metadata.and_then(|m| m.zng).and_then(|z| z.about) {
about.has_about = true;
about.app = m.app.unwrap_or_default();
about.org = m.org.unwrap_or_default();
about.qualifier = m.qualifier.unwrap_or_default();
}
if about.app.is_empty() {
about.app = about.pkg_name.clone();
}
if about.org.is_empty() {
about.org = about.pkg_authors.first().cloned().unwrap_or_default();
}
Ok(about)
}
#[doc(hidden)]
#[expect(clippy::too_many_arguments)]
pub fn macro_new(
pkg_name: &'static str,
pkg_authors: &[&'static str],
crate_name: &'static str,
(major, minor, patch, pre, build): (u64, u64, u64, &'static str, &'static str),
app: &'static str,
org: &'static str,
qualifier: &'static str,
description: &'static str,
homepage: &'static str,
license: &'static str,
has_about: bool,
) -> Self {
Self {
pkg_name: Txt::from_static(pkg_name),
pkg_authors: pkg_authors.iter().copied().map(Txt::from_static).collect(),
crate_name: Txt::from_static(crate_name),
version: {
let mut v = Version::new(major, minor, patch);
v.pre = semver::Prerelease::from_str(pre).unwrap();
v.build = semver::BuildMetadata::from_str(build).unwrap();
v
},
app: Txt::from_static(app),
org: Txt::from_static(org),
qualifier: Txt::from_static(qualifier),
description: Txt::from_static(description),
homepage: Txt::from_static(homepage),
license: Txt::from_static(license),
has_about,
}
}
}
#[derive(serde::Deserialize)]
struct Manifest {
package: Package,
}
#[derive(serde::Deserialize)]
struct Package {
name: Txt,
version: Version,
description: Option<Txt>,
homepage: Option<Txt>,
license: Option<Txt>,
authors: Option<Box<[Txt]>>,
metadata: Option<Metadata>,
}
#[derive(serde::Deserialize)]
struct Metadata {
zng: Option<Zng>,
}
#[derive(serde::Deserialize)]
struct Zng {
about: Option<MetadataAbout>,
}
#[derive(serde::Deserialize)]
struct MetadataAbout {
app: Option<Txt>,
org: Option<Txt>,
qualifier: Option<Txt>,
}
/// Gets metadata about the application.
///
/// The app must call [`init!`] at the beginning of the process, otherwise the metadata will fallback
/// to just a name extracted from the current executable file path.
///
/// See the [`directories::ProjectDirs::from`] documentation for more details on how this metadata is
/// used to create/find the app data directories.
///
/// [`directories::ProjectDirs::from`]: https://docs.rs/directories/5.0/directories/struct.ProjectDirs.html#method.from
pub fn about() -> &'static About {
&ABOUT
}
fn fallback_name() -> Txt {
let exe = current_exe();
let exe_name = exe.file_name().unwrap().to_string_lossy();
let name = exe_name.split('.').find(|p| !p.is_empty()).unwrap();
Txt::from_str(name)
}
/// Gets a path relative to the package binaries.
///
/// * In Wasm returns `./`, as in the relative URL.
/// * In all other platforms returns `std::env::current_exe().parent()`.
///
/// # Panics
///
/// Panics if [`std::env::current_exe`] returns an error or has no parent directory.
pub fn bin(relative_path: impl AsRef<Path>) -> PathBuf {
BIN.join(relative_path)
}
lazy_static! {
static ref BIN: PathBuf = find_bin();
}
fn find_bin() -> PathBuf {
if cfg!(target_arch = "wasm32") {
PathBuf::from("./")
} else {
current_exe().parent().expect("current_exe path parent is required").to_owned()
}
}
/// Gets a path relative to the package resources.
///
/// * The res dir can be set by [`init_res`] before any env dir is used.
/// * In Android returns `android_internal("res")`, assumes the package assets are extracted to this directory.
/// * In Linux, macOS and Windows if a file `bin/current_exe_name.res-dir` is found the first non-empty and non-comment (#) line
/// defines the res path.
/// * In `cfg(debug_assertions)` builds returns `res`.
/// * In Wasm returns `./res`, as in the relative URL.
/// * In macOS returns `bin("../Resources")`, assumes the package is deployed using a desktop `.app` folder.
/// * In all other Unix systems returns `bin("../share/current_exe_name")`, assumes the package is deployed
/// using a Debian package.
/// * In Windows returns `bin("../res")`. Note that there is no Windows standard, make sure to install
/// the project using this structure.
///
/// # Built Resources
///
/// In `cfg(any(debug_assertions, feature="built_res"))` builds if the `target/res/{relative_path}` path exists it
/// is returned instead. This is useful during development when the app depends on res that are generated locally and not
/// included in version control.
///
/// Note that the built resources must be packaged with the other res at the same relative location, so that release builds can find them.
///
/// # Android
///
/// Unfortunately Android does not provide file system access to the bundled resources, you must use the `ndk::asset::AssetManager` to
/// request files that are decompressed on demand from the APK file. We recommend extracting all cross-platform assets once on startup
/// to avoid having to implement special Android handling for each resource usage. See [`android_install_res`] for more details.
pub fn res(relative_path: impl AsRef<Path>) -> PathBuf {
res_impl(relative_path.as_ref())
}
#[cfg(all(
any(debug_assertions, feature = "built_res"),
not(any(target_os = "android", target_arch = "wasm32", target_os = "ios")),
))]
fn res_impl(relative_path: &Path) -> PathBuf {
let built = BUILT_RES.join(relative_path);
if built.exists() {
return built;
}
RES.join(relative_path)
}
#[cfg(not(all(
any(debug_assertions, feature = "built_res"),
not(any(target_os = "android", target_arch = "wasm32", target_os = "ios")),
)))]
fn res_impl(relative_path: &Path) -> PathBuf {
RES.join(relative_path)
}
/// Helper function for adapting Android assets to the cross-platform [`res`] API.
///
/// To implement Android resource extraction, bundle the resources in a tar that is itself bundled in `assets/res.tar` inside the APK.
/// On startup, call this function, it handles resources extraction and versioning.
///
/// # Examples
///
/// ```
/// # macro_rules! demo { () => {
/// #[no_mangle]
/// fn android_main(app: zng::view_process::default::android::AndroidApp) {
/// zng::env::init!();
/// zng::view_process::default::android::init_android_app(app.clone());
/// zng::env::android_install_res(|| app.asset_manager().open(c"res.tar"));
/// // zng::view_process::default::run_same_process(..);
/// }
/// # }}
/// ```
///
/// The `open_res` closure is only called if this is the first instance of the current app version on the device, or if the user
/// cleared all app data.
///
/// The resources are installed in the [`res`] directory, if the tar archive has only a root dir named `res` it is stripped.
/// This function assumes that it is the only app component that writes to this directory.
///
/// Note that the tar file is not compressed, because the APK already compresses it. The `cargo zng res` tool `.zr-apk`
/// tar resources by default, simply place the resources in `/assets/res/`.
pub fn android_install_res<Asset: std::io::Read>(open_res: impl FnOnce() -> Option<Asset>) {
#[cfg(target_os = "android")]
{
let version = res(format!(".zng-env.res.{}", about().version));
if !version.exists() {
if let Some(res) = open_res() {
if let Err(e) = install_res(version, res) {
tracing::error!("res install failed, {e}");
}
}
}
}
// cfg not applied to function so it shows on docs
#[cfg(not(target_os = "android"))]
let _ = open_res;
}
#[cfg(target_os = "android")]
fn install_res(version: PathBuf, res: impl std::io::Read) -> std::io::Result<()> {
let res_path = version.parent().unwrap();
let _ = fs::remove_dir_all(res_path);
fs::create_dir(res_path)?;
let mut res = tar::Archive::new(res);
res.unpack(res_path)?;
// rename res/res to res if it is the only entry in res
let mut needs_pop = false;
for (i, entry) in fs::read_dir(&res_path)?.take(2).enumerate() {
needs_pop = i == 0 && entry?.file_name() == "res";
}
if needs_pop {
let tmp = res_path.parent().unwrap().join("res-tmp");
fs::rename(res_path.join("res"), &tmp)?;
fs::rename(tmp, res_path)?;
}
fs::File::create(&version)?;
Ok(())
}
/// Sets a custom [`res`] path.
///
/// # Panics
///
/// Panics if not called at the beginning of the process.
pub fn init_res(path: impl Into<PathBuf>) {
if lazy_static_init(&RES, path.into()).is_err() {
panic!("cannot `init_res`, `res` has already inited")
}
}
/// Sets a custom path for the "built resources" override checked by [`res`] in debug builds.
///
/// # Panics
///
/// Panics if not called at the beginning of the process.
#[cfg(any(debug_assertions, feature = "built_res"))]
pub fn init_built_res(path: impl Into<PathBuf>) {
if lazy_static_init(&BUILT_RES, path.into()).is_err() {
panic!("cannot `init_built_res`, `res` has already inited")
}
}
lazy_static! {
static ref RES: PathBuf = find_res();
#[cfg(any(debug_assertions, feature="built_res"))]
static ref BUILT_RES: PathBuf = PathBuf::from("target/res");
}
#[cfg(target_os = "android")]
fn find_res() -> PathBuf {
android_internal("res")
}
#[cfg(not(target_os = "android"))]
fn find_res() -> PathBuf {
#[cfg(not(target_arch = "wasm32"))]
if let Ok(mut p) = std::env::current_exe() {
p.set_extension("res-dir");
if let Ok(dir) = read_line(&p) {
return bin(dir);
}
}
if cfg!(debug_assertions) {
PathBuf::from("res")
} else if cfg!(target_arch = "wasm32") {
PathBuf::from("./res")
} else if cfg!(windows) {
bin("../res")
} else if cfg!(target_os = "macos") {
bin("../Resources")
} else if cfg!(target_family = "unix") {
let c = current_exe();
bin(format!("../share/{}", c.file_name().unwrap().to_string_lossy()))
} else {
panic!(
"resources dir not specified for platform {}, use a 'bin/current_exe_name.res-dir' file to specify an alternative",
std::env::consts::OS
)
}
}
/// Gets a path relative to the user config directory for the app.
///
/// * The config dir can be set by [`init_config`] before any env dir is used.
/// * In Android returns `android_internal("config")`.
/// * In Linux, macOS and Windows if a file in `res("config-dir")` is found the first non-empty and non-comment (#) line
/// defines the res path.
/// * In `cfg(debug_assertions)` builds returns `target/tmp/dev_config/`.
/// * In all platforms attempts [`directories::ProjectDirs::config_dir`] and panic if it fails.
/// * If the config dir selected by the previous method contains a `"config-dir"` file it will be
/// used to redirect to another config dir, you can use this to implement config migration. Redirection only happens once.
///
/// The config directory is created if it is missing, checks once on init or first use.
///
/// [`directories::ProjectDirs::config_dir`]: https://docs.rs/directories/5.0/directories/struct.ProjectDirs.html#method.config_dir
pub fn config(relative_path: impl AsRef<Path>) -> PathBuf {
CONFIG.join(relative_path)
}
/// Sets a custom [`original_config`] path.
///
/// # Panics
///
/// Panics if not called at the beginning of the process.
pub fn init_config(path: impl Into<PathBuf>) {
if lazy_static_init(&ORIGINAL_CONFIG, path.into()).is_err() {
panic!("cannot `init_config`, `original_config` has already inited")
}
}
/// Config path before migration.
///
/// If this is equal to [`config`] the config has not migrated.
pub fn original_config() -> PathBuf {
ORIGINAL_CONFIG.clone()
}
lazy_static! {
static ref ORIGINAL_CONFIG: PathBuf = find_config();
}
/// Copied all config to `new_path` and saves it as the config path.
///
/// If copying and saving path succeeds make a best effort to wipe the previous config dir. If copy and save fails
/// makes a best effort to undo already made copies.
///
/// The `new_path` must not exist or be empty.
pub fn migrate_config(new_path: impl AsRef<Path>) -> io::Result<()> {
migrate_config_impl(new_path.as_ref())
}
fn migrate_config_impl(new_path: &Path) -> io::Result<()> {
let prev_path = CONFIG.as_path();
if prev_path == new_path {
return Ok(());
}
let original_path = ORIGINAL_CONFIG.as_path();
let is_return = new_path == original_path;
if !is_return && dir_exists_not_empty(new_path) {
return Err(io::Error::new(
io::ErrorKind::AlreadyExists,
"can only migrate to new dir or empty dir",
));
}
let created = !new_path.exists();
if created {
fs::create_dir_all(new_path)?;
}
let migrate = |from: &Path, to: &Path| {
copy_dir_all(from, to)?;
if fs::remove_dir_all(from).is_ok() {
fs::create_dir(from)?;
}
let redirect = ORIGINAL_CONFIG.join("config-dir");
if is_return {
fs::remove_file(redirect)
} else {
fs::write(redirect, to.display().to_string().as_bytes())
}
};
if let Err(e) = migrate(prev_path, new_path) {
eprintln!("migration failed, {e}");
if fs::remove_dir_all(new_path).is_ok() && !created {
let _ = fs::create_dir(new_path);
}
}
tracing::info!("changed config dir to `{}`", new_path.display());
Ok(())
}
fn copy_dir_all(from: &Path, to: &Path) -> io::Result<()> {
for entry in fs::read_dir(from)? {
let from = entry?.path();
if from.is_dir() {
let to = to.join(from.file_name().unwrap());
fs::create_dir(&to)?;
copy_dir_all(&from, &to)?;
} else if from.is_file() {
let to = to.join(from.file_name().unwrap());
fs::copy(&from, &to)?;
} else {
continue;
}
}
Ok(())
}
lazy_static! {
static ref CONFIG: PathBuf = redirect_config(original_config());
}
#[cfg(target_os = "android")]
fn find_config() -> PathBuf {
android_internal("config")
}
#[cfg(not(target_os = "android"))]
fn find_config() -> PathBuf {
let cfg_dir = res("config-dir");
if let Ok(dir) = read_line(&cfg_dir) {
return res(dir);
}
if cfg!(debug_assertions) {
return PathBuf::from("target/tmp/dev_config/");
}
let a = about();
if let Some(dirs) = directories::ProjectDirs::from(&a.qualifier, &a.org, &a.app) {
dirs.config_dir().to_owned()
} else {
panic!(
"config dir not specified for platform {}, use a '{}' file to specify an alternative",
std::env::consts::OS,
cfg_dir.display(),
)
}
}
fn redirect_config(cfg: PathBuf) -> PathBuf {
if cfg!(target_arch = "wasm32") {
return cfg;
}
if let Ok(dir) = read_line(&cfg.join("config-dir")) {
let mut dir = PathBuf::from(dir);
if dir.is_relative() {
dir = cfg.join(dir);
}
if dir.exists() {
let test_path = dir.join(".zng-config-test");
if let Err(e) = fs::create_dir_all(&dir)
.and_then(|_| fs::write(&test_path, "# check write access"))
.and_then(|_| fs::remove_file(&test_path))
{
eprintln!("error writing to migrated `{}`, {e}", dir.display());
tracing::error!("error writing to migrated `{}`, {e}", dir.display());
return cfg;
}
} else if let Err(e) = fs::create_dir_all(&dir) {
eprintln!("error creating migrated `{}`, {e}", dir.display());
tracing::error!("error creating migrated `{}`, {e}", dir.display());
return cfg;
}
dir
} else {
create_dir_opt(cfg)
}
}
fn create_dir_opt(dir: PathBuf) -> PathBuf {
if let Err(e) = std::fs::create_dir_all(&dir) {
eprintln!("error creating `{}`, {e}", dir.display());
tracing::error!("error creating `{}`, {e}", dir.display());
}
dir
}
/// Gets a path relative to the cache directory for the app.
///
/// * The cache dir can be set by [`init_cache`] before any env dir is used.
/// * In Android returns `android_internal("cache")`.
/// * In Linux, macOS and Windows if a file `config("cache-dir")` is found the first non-empty and non-comment (#) line
/// defines the res path.
/// * In `cfg(debug_assertions)` builds returns `target/tmp/dev_cache/`.
/// * In all platforms attempts [`directories::ProjectDirs::cache_dir`] and panic if it fails.
///
/// The cache dir is created if it is missing, checks once on init or first use.
///
/// [`directories::ProjectDirs::cache_dir`]: https://docs.rs/directories/5.0/directories/struct.ProjectDirs.html#method.cache_dir
pub fn cache(relative_path: impl AsRef<Path>) -> PathBuf {
CACHE.join(relative_path)
}
/// Sets a custom [`cache`] path.
///
/// # Panics
///
/// Panics if not called at the beginning of the process.
pub fn init_cache(path: impl Into<PathBuf>) {
match lazy_static_init(&CONFIG, path.into()) {
Ok(p) => {
create_dir_opt(p.to_owned());
}
Err(_) => panic!("cannot `init_cache`, `cache` has already inited"),
}
}
/// Removes all cache files possible.
///
/// Continues removing after the first fail, returns the last error.
pub fn clear_cache() -> io::Result<()> {
best_effort_clear(CACHE.as_path())
}
fn best_effort_clear(path: &Path) -> io::Result<()> {
let mut error = None;
match fs::read_dir(path) {
Ok(cache) => {
for entry in cache {
match entry {
Ok(e) => {
let path = e.path();
if path.is_dir() {
if fs::remove_dir_all(&path).is_err() {
match best_effort_clear(&path) {
Ok(()) => {
if let Err(e) = fs::remove_dir(&path) {
error = Some(e)
}
}
Err(e) => {
error = Some(e);
}
}
}
} else if path.is_file() {
if let Err(e) = fs::remove_file(&path) {
error = Some(e);
}
}
}
Err(e) => {
error = Some(e);
}
}
}
}
Err(e) => {
error = Some(e);
}
}
match error {
Some(e) => Err(e),
None => Ok(()),
}
}
/// Save `new_path` as the new cache path and make a best effort to move existing cache files.
///
/// Note that the move failure is not considered an error (it is only logged), the app is expected to
/// rebuild missing cache entries.
///
/// Note that [`cache`] will still point to the previous path on success, the app must be restarted to use the new cache.
///
/// The `new_path` must not exist or be empty.
pub fn migrate_cache(new_path: impl AsRef<Path>) -> io::Result<()> {
migrate_cache_impl(new_path.as_ref())
}
fn migrate_cache_impl(new_path: &Path) -> io::Result<()> {
if dir_exists_not_empty(new_path) {
return Err(io::Error::new(
io::ErrorKind::AlreadyExists,
"can only migrate to new dir or empty dir",
));
}
fs::create_dir_all(new_path)?;
let write_test = new_path.join(".zng-cache");
fs::write(&write_test, "# zng cache dir".as_bytes())?;
fs::remove_file(&write_test)?;
fs::write(config("cache-dir"), new_path.display().to_string().as_bytes())?;
tracing::info!("changed cache dir to `{}`", new_path.display());
let prev_path = CACHE.as_path();
if prev_path == new_path {
return Ok(());
}
if let Err(e) = best_effort_move(prev_path, new_path) {
eprintln!("failed to migrate all cache files, {e}");
tracing::error!("failed to migrate all cache files, {e}");
}
Ok(())
}
fn dir_exists_not_empty(dir: &Path) -> bool {
match fs::read_dir(dir) {
Ok(dir) => {
for entry in dir {
match entry {
Ok(_) => return true,
Err(e) => {
if e.kind() != io::ErrorKind::NotFound {
return true;
}
}
}
}
false
}
Err(e) => e.kind() != io::ErrorKind::NotFound,
}
}
fn best_effort_move(from: &Path, to: &Path) -> io::Result<()> {
let mut error = None;
match fs::read_dir(from) {
Ok(cache) => {
for entry in cache {
match entry {
Ok(e) => {
let from = e.path();
if from.is_dir() {
let to = to.join(from.file_name().unwrap());
if let Err(e) = fs::rename(&from, &to).or_else(|_| {
fs::create_dir(&to)?;
best_effort_move(&from, &to)?;
fs::remove_dir(&from)
}) {
error = Some(e)
}
} else if from.is_file() {
let to = to.join(from.file_name().unwrap());
if let Err(e) = fs::rename(&from, &to).or_else(|_| {
fs::copy(&from, &to)?;
fs::remove_file(&from)
}) {
error = Some(e);
}
}
}
Err(e) => {
error = Some(e);
}
}
}
}
Err(e) => {
error = Some(e);
}
}
match error {
Some(e) => Err(e),
None => Ok(()),
}
}
lazy_static! {
static ref CACHE: PathBuf = create_dir_opt(find_cache());
}
#[cfg(target_os = "android")]
fn find_cache() -> PathBuf {
android_internal("cache")
}
#[cfg(not(target_os = "android"))]
fn find_cache() -> PathBuf {
let cache_dir = config("cache-dir");
if let Ok(dir) = read_line(&cache_dir) {
return config(dir);
}
if cfg!(debug_assertions) {
return PathBuf::from("target/tmp/dev_cache/");
}
let a = about();
if let Some(dirs) = directories::ProjectDirs::from(&a.qualifier, &a.org, &a.app) {
dirs.cache_dir().to_owned()
} else {
panic!(
"cache dir not specified for platform {}, use a '{}' file to specify an alternative",
std::env::consts::OS,
cache_dir.display(),
)
}
}
fn current_exe() -> PathBuf {
std::env::current_exe().expect("current_exe path is required")
}
fn read_line(path: &Path) -> io::Result<String> {
let file = fs::File::open(path)?;
for line in io::BufReader::new(file).lines() {
let line = line?;
let line = line.trim();
if line.starts_with('#') {
continue;
}
return Ok(line.into());
}
Err(io::Error::new(io::ErrorKind::UnexpectedEof, "no uncommented line"))
}
#[cfg(target_os = "android")]
mod android {
use super::*;
lazy_static! {
static ref ANDROID_PATHS: [PathBuf; 2] = [PathBuf::new(), PathBuf::new()];
}
/// Initialize the Android app paths.
///
/// This is called by `init_android_app` provided by view-process implementers.
pub fn init_android_paths(internal: PathBuf, external: PathBuf) {
if lazy_static_init(&ANDROID_PATHS, [internal, external]).is_err() {
panic!("cannot `init_android_paths`, already inited")
}
}
/// Gets a path relative to the internal storage reserved for the app.
///
/// Prefer using [`config`] or [`cache`] over this directly.
pub fn android_internal(relative_path: impl AsRef<Path>) -> PathBuf {
ANDROID_PATHS[0].join(relative_path)
}
/// Gets a path relative to the external storage reserved for the app.
///
/// This directory is user accessible.
pub fn android_external(relative_path: impl AsRef<Path>) -> PathBuf {
ANDROID_PATHS[1].join(relative_path)
}
}
#[cfg(target_os = "android")]
pub use android::*;
#[cfg(test)]
mod tests {
use crate::*;
#[test]
fn parse_manifest() {
init!();
let a = about();
assert_eq!(a.pkg_name, "zng-env");
assert_eq!(a.app, "zng-env");
assert_eq!(&a.pkg_authors[..], &[Txt::from("The Zng Project Developers")]);
assert_eq!(a.org, "The Zng Project Developers");
}
}