summaryrefslogtreecommitdiffhomepage
path: root/installer-downloader/src/ui_downloader.rs
blob: fdf7737b61800853c804ecb3873cf1197c2ee360 (plain)
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
//! This module hooks up [AppDelegate]s to arbitrary implementations of [AppDownloader] and
//! [fetch::ProgressUpdater].

use crate::{
    delegate::{AppDelegate, AppDelegateQueue},
    resource,
};
use mullvad_update::{
    app::{self, AppDownloader, AppDownloaderParameters, DownloadedInstaller, VerifiedInstaller},
    fetch,
};

/// [AppDownloader] that delegates the actual work to some underlying `downloader` and uses it to
/// update a UI.
pub struct UiAppDownloader<Delegate: AppDelegate + 'static, Downloader> {
    downloader: Downloader,
    /// Queue used to control the app UI
    queue: Delegate::Queue,
}

/// Parameters for [UiAppDownloader]
pub type UiAppDownloaderParameters<Delegate> = AppDownloaderParameters<UiProgressUpdater<Delegate>>;

impl<Delegate: AppDelegate, Downloader: Send + 'static> UiAppDownloader<Delegate, Downloader> {
    /// Construct a [UiAppDownloader].
    pub fn new(delegate: &Delegate, downloader: Downloader) -> Self {
        Self {
            downloader,
            queue: delegate.queue(),
        }
    }
}

impl<Delegate: AppDelegate, Downloader: AppDownloader + Send + 'static> AppDownloader
    for UiAppDownloader<Delegate, Downloader>
{
    async fn download_executable(self) -> Result<impl DownloadedInstaller, app::DownloadError> {
        match self.downloader.download_executable().await {
            Ok(installer) => {
                self.queue.queue_main(move |self_| {
                    self_.set_download_text(resource::DOWNLOAD_COMPLETE_DESC);
                    self_.disable_cancel_button();
                });

                Ok(UiAppDownloader::<Delegate, _> {
                    downloader: installer,
                    queue: self.queue,
                })
            }
            Err(err) => {
                self.queue.queue_main(move |self_| {
                    self_.clear_status_text();
                    self_.clear_download_text();
                    self_.hide_download_progress();
                    self_.hide_download_button();
                    self_.hide_cancel_button();

                    self_.show_error_message(crate::delegate::ErrorMessage {
                        status_text: resource::DOWNLOAD_FAILED_DESC.to_owned(),
                        cancel_button_text: resource::DOWNLOAD_FAILED_CANCEL_BUTTON_TEXT.to_owned(),
                        retry_button_text: resource::DOWNLOAD_FAILED_RETRY_BUTTON_TEXT.to_owned(),
                    });
                });

                Err(err)
            }
        }
    }
}

impl<Delegate: AppDelegate, Downloader: DownloadedInstaller + Send + 'static> DownloadedInstaller
    for UiAppDownloader<Delegate, Downloader>
{
    async fn verify(self) -> Result<impl VerifiedInstaller, app::DownloadError> {
        match self.downloader.verify().await {
            Ok(verified) => {
                self.queue.queue_main(move |self_| {
                    self_.set_download_text(resource::VERIFICATION_SUCCEEDED_DESC);
                });

                Ok(UiAppDownloader::<Delegate, _> {
                    downloader: verified,
                    queue: self.queue,
                })
            }
            Err(error) => {
                self.queue.queue_main(move |self_| {
                    self_.clear_status_text();
                    self_.clear_download_text();
                    self_.hide_download_progress();
                    self_.hide_download_button();
                    self_.hide_cancel_button();

                    self_.show_error_message(crate::delegate::ErrorMessage {
                        status_text: resource::VERIFICATION_FAILED_DESC.to_owned(),
                        cancel_button_text: resource::VERIFICATION_FAILED_CANCEL_BUTTON_TEXT
                            .to_owned(),
                        retry_button_text: resource::VERIFICATION_FAILED_RETRY_BUTTON_TEXT
                            .to_owned(),
                    });
                });

                Err(error)
            }
        }
    }

    fn version(&self) -> &mullvad_version::Version {
        self.downloader.version()
    }
}

impl<Delegate: AppDelegate, I: VerifiedInstaller + Send + 'static> VerifiedInstaller
    for UiAppDownloader<Delegate, I>
{
    async fn install(self) -> Result<(), app::DownloadError> {
        match self.downloader.install().await {
            Ok(()) => {
                self.queue.queue_main(move |self_| {
                    // Success!
                    self_.quit();
                });
                Ok(())
            }
            Err(error) => {
                self.queue.queue_main(move |self_| {
                    self_.clear_status_text();
                    self_.clear_download_text();
                    self_.hide_download_progress();
                    self_.hide_download_button();
                    self_.hide_cancel_button();

                    self_.show_error_message(crate::delegate::ErrorMessage {
                        status_text: resource::LAUNCH_FAILED_DESC.to_owned(),
                        cancel_button_text: resource::LAUNCH_FAILED_CANCEL_BUTTON_TEXT.to_owned(),
                        retry_button_text: resource::LAUNCH_FAILED_RETRY_BUTTON_TEXT.to_owned(),
                    });
                });

                Err(error)
            }
        }
    }
}

/// Implementation of [fetch::ProgressUpdater] that updates some [AppDelegate].
pub struct UiProgressUpdater<Delegate: AppDelegate> {
    domain: Option<String>,
    prev_progress: Option<u32>,
    queue: Delegate::Queue,
}

impl<Delegate: AppDelegate> UiProgressUpdater<Delegate> {
    pub fn new(queue: Delegate::Queue) -> Self {
        Self {
            domain: None,
            prev_progress: None,
            queue,
        }
    }

    fn need_update(&mut self, complete: u32) -> bool {
        if self.prev_progress == Some(complete) {
            // Unconditionally updating causes flickering
            return false;
        }
        self.prev_progress = Some(complete);
        true
    }

    fn complete_from_percentage(fraction_complete: f32) -> u32 {
        (100.0 * fraction_complete).min(100.0) as u32
    }

    fn status_text(&self, complete_percentage: u32) -> String {
        format!(
            "{} {}... ({complete_percentage}%)",
            resource::DOWNLOADING_DESC_PREFIX,
            self.domain()
        )
    }

    fn domain(&self) -> &str {
        self.domain.as_deref().unwrap_or("unknown source")
    }
}

impl<Delegate: AppDelegate + 'static> fetch::ProgressUpdater for UiProgressUpdater<Delegate> {
    fn set_progress(&mut self, fraction_complete: f32) {
        let value = Self::complete_from_percentage(fraction_complete);

        if !self.need_update(value) {
            return;
        }

        let status = self.status_text(value);

        self.queue.queue_main(move |self_| {
            self_.set_download_progress(value);
            self_.set_download_text(&status);
        });
    }

    fn clear_progress(&mut self) {
        let value = 0;

        if !self.need_update(value) {
            return;
        }

        let status = self.status_text(value);

        self.queue.queue_main(move |self_| {
            self_.clear_download_progress();
            self_.set_download_text(&status);
        });
    }

    fn set_url(&mut self, url: &str) {
        // Parse out domain name
        let url = url.strip_prefix("https://").unwrap_or(url);
        let (domain, _) = url.split_once('/').unwrap_or((url, ""));
        self.domain = Some(domain.to_owned());
    }
}