PdfCraft: An open-source PDF reader and editor written by scratch in pure Rust
//! Help ▸ Check for updates and the check at start, through `craft_update`: the flow itself is its
//! `Updater`; this module supplies the suite and the quit path, and shows the result in
//! `craft_update`'s `CheckResultDialog`.
#[cfg(not(target_arch = "wasm32"))]
use craft_update::updater::{Action, CheckSource, Status, Updater};
#[cfg(not(target_arch = "wasm32"))]
use craft_update::{CheckResultDialog, CheckResultResponse};
use crate::PdfCraftApp;
/// Where every PdfCraft release is listed.
pub const RELEASES_PAGE: &str = "https://github.com/storytold/pdfcraft/releases";
/// Stands in for the network in tests.
#[cfg(not(target_arch = "wasm32"))]
pub type UpdateSource = CheckSource;
pub(crate) struct Updates {
#[cfg(not(target_arch = "wasm32"))]
updater: Updater,
/// The Updates dialog is showing.
pub(crate) open: bool,
/// Ask for a newer release at start; the desktop app turns it on, so tests never reach the network.
#[cfg(not(target_arch = "wasm32"))]
startup_check: bool,
#[cfg(not(target_arch = "wasm32"))]
check_requested: bool,
}
impl Default for Updates {
fn default() -> Self {
Self {
#[cfg(not(target_arch = "wasm32"))]
updater: Updater::new(&crate::UPDATE_APP, env!("CARGO_PKG_VERSION")),
open: false,
#[cfg(not(target_arch = "wasm32"))]
startup_check: false,
#[cfg(not(target_arch = "wasm32"))]
check_requested: false,
}
}
}
impl PdfCraftApp {
/// Whether the app asks for a newer release on its first frame (off until the desktop app turns it on).
#[cfg(not(target_arch = "wasm32"))]
pub fn set_startup_update_check(&mut self, on: bool) {
self.updates.startup_check = on;
}
/// Replaces the network with `source` (tests).
#[cfg(not(target_arch = "wasm32"))]
pub fn set_update_source(&mut self, source: UpdateSource) {
self.updates.updater = Updater::new(&crate::UPDATE_APP, env!("CARGO_PKG_VERSION")).with_source(source);
}
/// Help ▸ Check for updates: ask for the latest release and show the outcome.
pub fn check_for_updates(&mut self) {
#[cfg(not(target_arch = "wasm32"))]
{
self.updates.open = true;
self.updates.check_requested = true;
}
#[cfg(target_arch = "wasm32")]
{
self.open_url(RELEASES_PAGE);
}
}
/// Starts the checks and picks up their answers (each frame).
pub(crate) fn poll_updates(&mut self) {
#[cfg(not(target_arch = "wasm32"))]
{
let Some(ctx) = self.ctx.clone() else { return };
let updates = &mut self.updates;
if std::mem::take(&mut updates.check_requested) {
updates.updater.check_now(&ctx);
} else if updates.startup_check {
updates.updater.check_at_start(&ctx);
}
updates.updater.tick(&ctx);
}
}
}
/// The startup prompt, and the Updates dialog that answers Help ▸ Check for updates.
pub(crate) fn dialog(app: &mut PdfCraftApp, ctx: &egui::Context) {
#[cfg(not(target_arch = "wasm32"))]
{
// The restart helper is scheduled before the app closes, so no update starts over unsaved work.
let clean = app.first_dirty().is_none();
match app.updates.updater.show_if(ctx, clean) {
Action::None => {}
Action::OpenUrl(url) => app.open_url(&url),
Action::Close => {
app.request_quit(ctx);
}
}
// A requested check that found a release is answered by the prompt, not by this dialog.
if app.updates.open && !app.updates.check_requested && matches!(app.updates.updater.status(), Status::Idle) {
app.updates.open = false;
}
if app.updates.open {
let dialog = CheckResultDialog::new(&crate::UPDATE_APP, env!("CARGO_PKG_VERSION"));
match dialog.show(ctx, app.updates.updater.status()) {
CheckResultResponse::None => {}
CheckResultResponse::Close => {
app.updates.open = false;
app.updates.updater.dismiss_status();
}
CheckResultResponse::CheckAgain => app.updates.check_requested = true,
}
}
}
#[cfg(target_arch = "wasm32")]
let _ = (app, ctx);
}