install-framework-base 1.0.0

[Install Framework] Official generic interface implementation
Documentation
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
// Copyright 2021 Yuri6037

// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:

// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.

// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.

use std::io;
use std::path::Path;
use std::path::PathBuf;
use std::collections::HashMap;
use std::string::String;
use reqwest::blocking::Client;
use install_framework_core::command::Interpreter;
use install_framework_core::command::InstallCommand;
use install_framework_core::interface::InstallMethod;

use super::base;
use crate::cache::Cache;
use crate::error::Error;
use crate::interface::SimpleInterpreter;
use crate::platform;

#[cfg(unix)]
fn check_and_assign_bin_perm(path: &Path) -> io::Result<()>
{
    use std::os::unix::fs::PermissionsExt;

    let meta = std::fs::metadata(path)?;
    if meta.permissions().mode() != 755
    {
        let perms = PermissionsExt::from_mode(0o755);
        std::fs::set_permissions(path, perms)?;
    }
    return Ok(());
}

#[cfg(target_os="linux")]
fn auto_create_desktop(cache: &Path, desktop_folder: &Path, content_dir: &Path, path: &str) -> io::Result<()>
{
    use std::fs::File;
    use std::io::Write;

    let name = platform::common::get_target_desktop_name(path);
    let mut copy = name.clone();
    copy.push_str(".icon");
    let mut copy1 = name.clone();
    copy1.push_str(".desktop");
    let icon = content_dir.join(copy);
    let bin = content_dir.join(path);
    let outpath = desktop_folder.join(copy1);
    check_and_assign_bin_perm(&bin)?;
    if path.ends_with(".AppImage") && !icon.exists()
    {
        use std::process::Command;
        use std::fs::metadata;
        use std::fs::read_link;

        let mut res = Command::new(&bin).arg("--appimage-extract").current_dir(cache).spawn()?;
        if !res.wait()?.success()
        {
            return Err(io::Error::new(io::ErrorKind::Other, "AppImage extraction failure"));
        }
        let icon_link = cache.join("squashfs-root").join(".DirIcon");
        let meta = metadata(&icon_link)?;
        if meta.file_type().is_symlink()
        {
            let target = read_link(&icon_link)?;
            std::fs::copy(target, &icon)?;
        }
        else
        {
            std::fs::copy(icon_link, &icon)?;
        }
        std::fs::remove_dir_all(cache.join("squashfs-root"))?;
    }
    let mut f = File::create(outpath)?;
    writeln!(f, "[Desktop Entry]")?;
    writeln!(f, "Name=ERPMod")?;
    writeln!(f, "Exec={:?}", &bin)?;
    writeln!(f, "Terminal=false")?;
    writeln!(f, "Type=Application")?;
    let fuckyourust = format!("{:?}", icon); //Because rust is a peace of shit
    let fuckyourust1 = &fuckyourust[1..fuckyourust.len() - 1]; //Remove double quotes as GNOME refuses to load icons with double quotes
    writeln!(f, "Icon={}", fuckyourust1)?;
    return Ok(());
}

#[cfg(windows)]
fn auto_create_shortcut<TError: Error>(desktop_folder: &Path, content_dir: &Path, path: &str) -> Result<(), TError::ErrorType>
{
    use winapi::um::objbase::CoInitialize;
    use winapi::um::combaseapi::CoUninitialize;
    use winapi::um::combaseapi::CoCreateInstance;
    use winapi::shared::ntdef::NULL;
    use winapi::um::shobjidl_core::IShellLinkW;
    use winapi::um::objidl::IPersistFile;
    use winapi::um::combaseapi::CLSCTX_ALL;
    use winapi::shared::winerror::SUCCEEDED;
    use winapi::DEFINE_GUID;
    use std::os::windows::ffi::OsStrExt;
    use winapi::shared::minwindef::TRUE;
    use std::ffi::OsString;
    use winapi::um::unknwnbase::LPUNKNOWN;

    DEFINE_GUID!(CLSID_SHELLLINK, 0x00021401, 0x0000, 0x0000, 0xC0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x46);
    DEFINE_GUID!(IID_ISHELLLINKW, 0x000214F9, 0x0000, 0x0000, 0xC0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x46);
    DEFINE_GUID!(IID_IPERSISTFILE, 0x0000010B, 0x0000, 0x0000, 0xC0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x46);

    let name = platform::common::get_target_desktop_name(path);
    let mut name1 = name.clone();
    name1.push_str(".lnk");
    let bin = content_dir.join(path);
    unsafe
    {
        let mut linka: *mut IShellLinkW = std::ptr::null_mut();
        CoInitialize(NULL);
        if !SUCCEEDED(CoCreateInstance(&CLSID_SHELLLINK, NULL as LPUNKNOWN, CLSCTX_ALL, &IID_ISHELLLINKW, &mut linka as *mut _ as _))
        {
            CoUninitialize();
            return Err(TError::generic(String::from("IShellLinkW allocation failure")));
        }
        let mut wname: Vec<u16> = OsString::from(name).encode_wide().collect();
        let mut wlink: Vec<u16> = bin.as_os_str().encode_wide().collect();
        wname.push(0);
        wlink.push(0);
        linka.as_ref().unwrap().SetDescription(wname.as_ptr());
        linka.as_ref().unwrap().SetPath(wlink.as_ptr());
        linka.as_ref().unwrap().SetIconLocation(wlink.as_ptr(), 0);
        let mut persist: *mut IPersistFile = std::ptr::null_mut();
        if !SUCCEEDED(linka.as_ref().unwrap().QueryInterface(&IID_IPERSISTFILE, &mut persist as *mut _ as _))
        {
            linka.as_ref().unwrap().Release();
            CoUninitialize();
            return Err(TError::generic(String::from("IPersistFile allocation failure")));
        }
        let dest = desktop_folder.join(name1);
        let mut wdest: Vec<u16> = dest.as_os_str().encode_wide().collect();
        wdest.push(0);
        persist.as_ref().unwrap().Save(wdest.as_ptr(), TRUE);
        persist.as_ref().unwrap().Release();
        linka.as_ref().unwrap().Release();
        CoUninitialize();
    }
    return Ok(());
}

#[cfg(windows)]
fn emulate_windows_symlink(src: &Path, dst: &Path) -> io::Result<()>
{
    use std::fs::File;
    use std::io::Write;
    use std::ffi::OsString;
    use std::fs::canonicalize;

    let mut dst1 = OsString::from(dst.as_os_str());
    dst1.push(".bat");
    let mut f = File::create(&dst1)?;
    writeln!(f, "@ECHO OFF")?;
    writeln!(f, "")?;
    let src1 = canonicalize(src)?;
    writeln!(f, "{}", src1.to_string_lossy())?;
    return Ok(());
}

fn recursive_copy(src: &Path, dst: &Path) -> io::Result<()>
{
    if !src.is_dir()
    {
        std::fs::copy(src, dst)?;
        return Ok(());
    }
    std::fs::create_dir(dst)?;
    let paths = std::fs::read_dir(src)?;
    for v in paths
    {
        let useless = v?;
        if useless.file_type()?.is_dir()
        {
            recursive_copy(&useless.path(), &dst.join(useless.file_name()))?;
        }
        else
        {
            std::fs::copy(useless.path(), &dst.join(useless.file_name()))?;
        }
    }
    return Ok(());
}

pub struct InstallInterpreter<'a, TError: Error>
{
    interpreter: &'a mut dyn SimpleInterpreter<TError::ErrorType>,
    cache: &'a mut Cache<TError>,
    props: &'a HashMap<String, String>,
    client: Client,
    resources: &'a HashMap<&'static str, &'static [u8]>,
    content_dir: &'a Path,
    bin_dir: &'a Path,
    #[cfg(target_os = "linux")]
    install_dir: &'a Path,
    #[cfg(not(target_os = "macos"))]
    method: InstallMethod
}

impl <'a, TError: Error> InstallInterpreter<'a, TError>
{
    #[cfg(target_os = "linux")]
    pub fn new(interpreter: &'a mut dyn SimpleInterpreter<TError::ErrorType>, cache: &'a mut Cache<TError>, install_dir: &'a Path, method: InstallMethod, content_dir: &'a Path, bin_dir: &'a Path, props: &'a HashMap<String, String>, resources: &'a HashMap<&'static str, &'static [u8]>) -> InstallInterpreter<'a, TError>
    {
        return InstallInterpreter
        {
            interpreter: interpreter,
            cache: cache,
            props: props,
            client: Client::new(),
            resources: resources,
            content_dir: content_dir,
            bin_dir: bin_dir,
            install_dir: install_dir,
            method: method
        }
    }

    #[cfg(target_os = "windows")]
    pub fn new(interpreter: &'a mut dyn SimpleInterpreter<TError::ErrorType>, cache: &'a mut Cache<TError>, method: InstallMethod, content_dir: &'a Path, bin_dir: &'a Path, props: &'a HashMap<String, String>, resources: &'a HashMap<&'static str, &'static [u8]>) -> InstallInterpreter<'a, TError>
    {
        return InstallInterpreter
        {
            interpreter: interpreter,
            cache: cache,
            props: props,
            client: Client::new(),
            resources: resources,
            content_dir: content_dir,
            bin_dir: bin_dir,
            method: method
        }
    }

    #[cfg(target_os = "macos")]
    pub fn new(interpreter: &'a mut dyn SimpleInterpreter<TError::ErrorType>, cache: &'a mut Cache<TError>, content_dir: &'a Path, bin_dir: &'a Path, props: &'a HashMap<String, String>, resources: &'a HashMap<&'static str, &'static [u8]>) -> InstallInterpreter<'a, TError>
    {
        return InstallInterpreter
        {
            interpreter: interpreter,
            cache: cache,
            props: props,
            client: Client::new(),
            resources: resources,
            content_dir: content_dir,
            bin_dir: bin_dir
        }
    }

    fn download_file(&mut self, resid: usize, filename: String, url: String, headers: HashMap<String, String>) -> Result<(), TError::ErrorType>
    {
        return base::download_file(self.interpreter, &mut self.client, &mut self.cache, resid, filename, url, headers);
    }

    fn unpack_cached(&mut self, resid: usize, path: String) -> Result<(), TError::ErrorType>
    {
        return base::unpack_cached(self.interpreter, &mut self.cache, resid, path);
    }

    fn extract_resource(&mut self, resid: usize, path: &'static str) -> Result<(), TError::ErrorType>
    {
        return base::extract_resource(&mut self.cache, &self.resources, resid, path);
    }

    fn user_input(&mut self, resid: usize, prop: String, message: String) -> Result<(), TError::ErrorType>
    {
        return base::user_input(self.interpreter, &mut self.cache, &self.props, resid, prop, message);
    }

    fn create_folder(&mut self, resid: usize, name: String) -> Result<(), TError::ErrorType>
    {
        let path = self.content_dir.join(name);
        if path.exists()
        {
            self.cache.insert(resid, path);
            return Ok(());
        }
        match std::fs::create_dir(&path)
        {
            Ok(()) =>
            {
                self.cache.insert(resid, path);
                return Ok(());
            },
            Err(e) => return Err(TError::io(e))
        };
    }

    fn install_cached(&mut self, resid: usize, path: String, folder: usize) -> Result<(), TError::ErrorType>
    {
        let src = PathBuf::from(self.cache.parse_string(&path)?);
        let dst;
        let dstf;

        if folder == 0
        {
            dst = self.content_dir;
        }
        else
        {
            dst = Path::new(self.cache.get(folder)?);
        }
        if let Some(name) = src.file_name()
        {
            dstf = dst.join(name);
        }
        else
        {
            dstf = dst.join(&src);
        }
        if let Err(e) = recursive_copy(&src, &dstf)
        {
            return Err(TError::io(e));
        }
        self.cache.insert(resid, dstf);
        return Ok(());
    }

    fn install_resource(&mut self, resid: usize, path: &'static str, folder: usize) -> Result<(), TError::ErrorType>
    {
        let src = match self.resources.get(path)
        {
            Some(v) => v,
            None => return Err(TError::unknown_resource_path(path))
        };
        let dst;

        if folder == 0
        {
            dst = self.content_dir;
        }
        else
        {
            dst = Path::new(self.cache.get(folder)?);
        }
        let name =
        {
            if let Some(id) = path.rfind('/')
            {
                &path[id + 1..]
            }
            else
            {
                path
            }
        };
        let dstf = dst.join(name);
        match base::buf_to_file(&dstf, src)
        {
            Ok(()) =>
            {
                self.cache.insert(resid, dstf);
                return Ok(());
            },
            Err(e) => return Err(TError::io(e))
        }
    }

    fn add_to_path(&mut self, resid: usize, path: String) -> Result<(), TError::ErrorType>
    {
        let src = self.content_dir.join(path);
        let name =
        {
            if let Some(n) = src.file_name()
            {
                n
            }
            else
            {
                src.as_os_str()
            }
        };
        let dst = self.bin_dir.join(name);
        if !src.exists()
        {
            return Err(TError::io(io::Error::new(io::ErrorKind::NotFound, "Could not file input file")));
        }
        #[cfg(unix)]
        {
            if let Err(e) = check_and_assign_bin_perm(&src)
            {
                return Err(TError::io(e));
            }
            use std::os::unix::fs::symlink;
            if let Err(e) = symlink(src, &dst)
            {
                return Err(TError::io(e));
            }
        }
        #[cfg(windows)]
        {
            platform::winpath::append_path::<TError>(self.bin_dir, self.method)?;
            if let Err(e) = emulate_windows_symlink(&src, &dst)
            {
                return Err(TError::io(e));
            }
        }
        self.cache.insert(resid, dst);
        return Ok(());
    }

    fn add_shortcut(&mut self, path: String) -> Result<(), TError::ErrorType>
    {
        #[cfg(target_os="linux")]
        {
            let dir = platform::common::get_desktop_folder(self.install_dir, self.method);
            if let Err(e) = auto_create_desktop(&self.cache.get_path(Path::new("."))?, &dir, self.content_dir, &path)
            {
                return Err(TError::io(e));
            }
        }
        #[cfg(windows)]
        {
            let dir = platform::common::get_desktop_folder(self.method);
            auto_create_shortcut::<TError>(&dir, self.content_dir, &path)?;
        }
        return Ok(());
    }
}

impl <TError: Error> Interpreter<InstallCommand> for InstallInterpreter<'_, TError>
{
    type ErrorType = TError::ErrorType;

    fn execute(&mut self, resid: usize, cmd: InstallCommand) -> Result<(), TError::ErrorType>
    {
        match cmd
        {
            InstallCommand::DownloadFile(f, u, h) => self.download_file(resid, f, u, h)?,
            InstallCommand::UnpackCached(p) => self.unpack_cached(resid, p)?,
            InstallCommand::ExtractResource(p) => self.extract_resource(resid, p)?,
            InstallCommand::UserInput(p, m) => self.user_input(resid, p, m)?,
            InstallCommand::AddToPath(p) => self.add_to_path(resid, p)?,
            InstallCommand::CreateFolder(n) => self.create_folder(resid, n)?,
            InstallCommand::InstallCached(p, f) => self.install_cached(resid, p, f)?,
            InstallCommand::InstallResource(p, f) => self.install_resource(resid, p, f)?,
            InstallCommand::AddShortcut(p) => self.add_shortcut(p)?
        }
        return Ok(());
    }

    fn progress(&mut self, cur: usize, max: usize) -> Result<(), Self::ErrorType>
    {
        self.interpreter.update_step((cur as f64 / max as f64) as f32)?;
        return Ok(());
    }
}