zoi-install 1.25.2

Advanced Package Manager & Environment Orchestrator
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
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
//! Main installer logic.

use std::fs;
use std::io::Write;
use std::path::{Path, PathBuf};

use anyhow::{Result, anyhow};
use colored::Colorize;
use indicatif::{MultiProgress, ProgressBar, ProgressStyle};
use zoi_core::{cache, config, pgp, pkgdir, recorder, types};
use zoi_db as db;
use zoi_hooks as hooks;
use zoi_resolver::local;

use crate::resolver::InstallNode;
use crate::{manifest, plan, prebuilt, util};

/// Downloads and caches a package archive.
///
/// This function handles:
/// - Checking pkg-dirs and the archive cache.
/// - Downloading from mirrors if not found locally.
/// - Verifying hashes and PGP signatures.
///
/// # Errors
///
/// Returns an error if:
/// - The configuration cannot be read.
/// - The archive cache directory cannot be created.
/// - Zoi is offline and the archive is missing.
/// - The download fails.
/// - Hash verification fails.
/// - Signature verification fails.
pub fn download_and_cache_archive(
    node: &InstallNode,
    details: &plan::PrebuiltDetails,
    pb: Option<&ProgressBar>,
    verbose: bool
) -> Result<PathBuf> {
    let config = config::read_config()?;
    let signature_policy =
        config.policy.signature_enforcement.filter(|p| p.enable);

    let archive_cache_root = cache::get_archive_cache_root()?;
    fs::create_dir_all(&archive_cache_root)?;

    let archive_filename = details
        .info
        .final_url
        .split('/')
        .next_back()
        .unwrap_or("archive.zpa");
    let cached_archive_path = archive_cache_root.join(archive_filename);
    let sig_filename = format!("{archive_filename}.sig");
    let cached_sig_path = archive_cache_root.join(&sig_filename);

    let archive_path = if let Some(path) =
        pkgdir::find_in_pkg_dirs(archive_filename)
    {
        if pb.is_none() {
            println!("Found archive in pkg-dir: {}", path.display());
        }
        path
    } else if cached_archive_path.exists() {
        if pb.is_none() {
            println!("Using cached archive: {}", cached_archive_path.display());
        }
        cached_archive_path.clone()
    } else {
        if zoi_core::offline::is_offline() {
            return Err(anyhow!(
                "Archive not found in cache and cannot download: Zoi is in \
                 offline mode. Missing: {archive_filename}"
            ));
        }
        let part_path =
            archive_cache_root.join(format!("{archive_filename}.part"));

        if part_path.exists() && pb.is_none() {
            println!("Resuming partial download: {}", part_path.display());
        }

        let mut last_error = None;
        let candidate_urls =
            cache::mirror_candidate_urls(&details.info.final_url);
        let mut downloaded = false;
        for candidate_url in candidate_urls {
            match util::download_file_with_progress(
                &candidate_url,
                &part_path,
                pb,
                Some(details.download_size)
            ) {
                Ok(()) => {
                    downloaded = true;
                    break;
                }
                Err(e) => last_error = Some((candidate_url, e))
            }
        }
        if !downloaded {
            let (url, error) = last_error.ok_or_else(|| {
                anyhow!("archive download failed but no error recorded")
            })?;
            return Err(anyhow!(
                "Failed to download package archive from {url}: {error}"
            ));
        }

        fs::rename(&part_path, &cached_archive_path)?;
        cached_archive_path.clone()
    };

    if let Some(hash_url) = &details.info.hash_url {
        let hash = db::get_package_hash_from_db(
            &node.registry_handle,
            &node.pkg.name,
            node.sub_package.as_deref(),
            &node.pkg.repo
        )
        .unwrap_or(None)
        .filter(|h| !h.is_empty())
        .or_else(|| {
            util::get_expected_hash(hash_url, Some(archive_filename)).ok()
        });

        if let Some(ref hash) = hash
            && !util::verify_file_hash(&archive_path, hash, pb)?
        {
            return Err(anyhow!("Hash verification failed"));
        }
    }

    let authorities = config
        .default_registry
        .as_ref()
        .filter(|r| r.handle == node.registry_handle)
        .and_then(|r| r.authorities.as_ref())
        .or_else(|| {
            config
                .added_registries
                .iter()
                .find(|r| r.handle == node.registry_handle)
                .and_then(|r| r.authorities.as_ref())
        });
    let has_authorities = authorities.is_some_and(|a| !a.is_empty());
    let pgp_identifiers: Option<Vec<String>> = signature_policy
        .as_ref()
        .map(|p| p.trusted_keys.clone())
        .or_else(|| authorities.cloned());

    if let Some(pgp_url) = &details.info.pgp_url {
        if let Some(ref identifiers) = pgp_identifiers
            && !identifiers.is_empty()
        {
            let sig_path = if cached_sig_path.exists() {
                cached_sig_path.clone()
            } else {
                if zoi_core::offline::is_offline() {
                    return Err(anyhow!(
                        "Signature not found in cache and cannot download: \
                         Zoi is in offline mode."
                    ));
                }
                let temp_dir =
                    tempfile::Builder::new().prefix("zoi-sig-dl-").tempdir()?;
                let temp_sig_path = temp_dir.path().join(&sig_filename);
                let mut last_error = None;
                let mut downloaded = false;
                for candidate_url in cache::mirror_candidate_urls(pgp_url) {
                    match util::download_file_with_progress(
                        &candidate_url,
                        &temp_sig_path,
                        pb,
                        None
                    ) {
                        Ok(()) => {
                            downloaded = true;
                            break;
                        }
                        Err(e) => last_error = Some((candidate_url, e))
                    }
                }
                if !downloaded {
                    let (url, error) = last_error.ok_or_else(|| {
                        anyhow!(
                            "signature download failed but no error recorded"
                        )
                    })?;
                    return Err(anyhow!(
                        "Failed to download signature from {url}: {error}"
                    ));
                }
                fs::copy(&temp_sig_path, &cached_sig_path)?;
                cached_sig_path.clone()
            };

            if verbose {
                println!("Verifying signature...");
            }
            let trusted_certs =
                pgp::get_certs_by_name_or_fingerprint(identifiers)?;
            pgp::verify_detached_signature_multi_key(
                &archive_path,
                &sig_path,
                trusted_certs
            )?;
            if verbose {
                println!("{}", "Signature verified successfully.".green());
            }
        }
    } else if has_authorities {
        let msg = format!(
            "Warning: Installing unsigned package '{}' from a registry that \
             claims to be secure.",
            node.pkg.name
        );
        if let Some(p) = pb {
            p.println(msg.yellow().to_string());
        } else {
            println!("{}", msg.yellow());
        }
        if signature_policy.is_some() {
            return Err(anyhow!(
                "Signature enforcement is active, but no PGP URL found for \
                 package"
            ));
        }
    }

    Ok(archive_path)
}

/// Information about a package that has been prepared for installation.
#[derive(Clone)]
pub struct PreparedNode {
    /// Path to the downloaded or built archive.
    pub archive_path: PathBuf,
    /// The method used for installation (e.g. "pre-compiled", "source").
    pub install_method: String,
    /// Whether the archive was built from source.
    pub is_build: bool
}

/// Performs the non-destructive first phase of installation: "Preparation".
///
/// Preparation includes:
/// - Downloading pre-built archives from the registry.
/// - Verifying checksums and PGP signatures (Root of Trust).
/// - Or, building the package from source in a temporary sandbox if requested.
///
/// This phase always runs in user-space and does not modify the system state
/// or the package store.
///
/// # Errors
///
/// Returns an error if:
/// - The archive cannot be downloaded or built.
/// - The progress bar style cannot be created.
pub fn prepare_node(
    node: &InstallNode,
    action: &plan::InstallAction,
    m: Option<&MultiProgress>,
    build_type: Option<&str>,
    verbose: bool
) -> Result<PreparedNode> {
    let pkg = &node.pkg;
    let version = &node.version;

    let pb_style = ProgressStyle::default_bar()
        .template(
            "{spinner:.green} {msg:30.cyan} [{bar:40.cyan/blue}] {percent}%"
        )?
        .progress_chars("#>-");

    let spinner_style = ProgressStyle::default_spinner()
        .template("{spinner:.green} {msg:30.cyan}")?
        .tick_chars("⠋⠙⠹⠸⠼⠴⠦⠧⠇⠏ ");

    let display_name = if let Some(sub) = &node.sub_package {
        format!("{}:{}", pkg.name, sub)
    } else {
        pkg.name.clone()
    };
    let version_display = if node.revision == "1" {
        version.clone()
    } else {
        format!("{}-{}", version, node.revision)
    };
    let message = format!("zoi:{display_name}@{version_display}");

    let pb = if let Some(m_inner) = m {
        let pb = m_inner.add(ProgressBar::new(100));
        pb.set_style(pb_style);
        pb.set_message(message.clone());
        Some(pb)
    } else {
        None
    };

    let (archive_path, install_method, is_build) = match action {
        plan::InstallAction::DownloadAndInstall(details) => {
            if let Some(p) = &pb {
                p.set_message("Downloading package...");
            }
            let archive_path = download_and_cache_archive(
                node,
                details,
                pb.as_ref(),
                verbose
            )?;
            (archive_path, "pre-compiled".to_string(), false)
        }
        plan::InstallAction::InstallFromArchive(archive_path) => {
            if archive_path.to_string_lossy().ends_with(".zsa") {
                if let Some(p) = &pb {
                    p.set_style(spinner_style);
                    p.enable_steady_tick(std::time::Duration::from_millis(100));
                    p.set_message(format!("Building {display_name}..."));
                }
                let archive_path = prebuilt::build_archive(
                    archive_path,
                    pkg,
                    node.sub_package.as_deref(),
                    build_type,
                    pb.as_ref(),
                    !verbose
                )?;
                match archive_path {
                    Some(path) => (path, "source".to_string(), true),
                    None => (PathBuf::new(), "meta".to_string(), false)
                }
            } else {
                if let Some(p) = &pb {
                    p.set_message("Using local archive...");
                    p.finish();
                }
                (archive_path.clone(), "pre-compiled".to_string(), false)
            }
        }
        plan::InstallAction::BuildAndInstall => {
            if let Some(p) = &pb {
                p.set_style(spinner_style);
                p.enable_steady_tick(std::time::Duration::from_millis(100));
                p.set_message(format!("Building {display_name}..."));
            }
            let pkg_lua_path = Path::new(&node.source);
            let archive_path = prebuilt::build_archive(
                pkg_lua_path,
                pkg,
                node.sub_package.as_deref(),
                build_type,
                pb.as_ref(),
                !verbose
            )?;

            match archive_path {
                Some(path) => (path, "source".to_string(), true),
                None => (PathBuf::new(), "meta".to_string(), false)
            }
        }
    };

    if let Some(p) = pb {
        p.finish_and_clear();
    }

    Ok(PreparedNode {
        archive_path,
        install_method,
        is_build
    })
}

/// Performs the destructive second phase of installation: "Execution".
///
/// This phase takes a `PreparedNode` and:
/// - Unpacks the archive into the versioned store directory.
/// - Creates binary shims in the global Zoi `bin` directory.
/// - Registers the installation in the registry database and lockfile.
///
/// Just-in-Time Escalation: If the target scope is `system`, this function
/// will spawn a privileged sub-process (`sudo zoi helper elevate-install-node`)
/// to perform the final file moves, keeping the main CLI unprivileged.
///
/// # Errors
///
/// Returns an error if:
/// - Hooks fail to run.
/// - Privilege escalation fails.
/// - The archive cannot be unpacked.
/// - The manifest cannot be created or written.
/// - The package cannot be recorded in the database.
pub fn install_prepared_node(
    node: &InstallNode,
    prepared: &PreparedNode,
    m: Option<&MultiProgress>,
    yes: bool,
    record: bool,
    link_bins: bool,
    _verbose: bool
) -> Result<types::InstallManifest> {
    let pkg = &node.pkg;
    let version = &node.version;
    let handle = &node.registry_handle;
    let is_direct = matches!(node.reason, types::InstallReason::Direct);

    let pb_style = ProgressStyle::default_spinner()
        .template("{spinner:.green} {msg:30.cyan}")?
        .tick_chars("⠋⠙⠹⠸⠼⠴⠦⠧⠇⠏ ");

    let main_pb = if let Some(m_inner) = m {
        if is_direct {
            None
        } else {
            let pb = m_inner.add(ProgressBar::new_spinner());
            pb.set_style(pb_style.clone());
            let name = if let Some(sub) = &node.sub_package {
                format!("{}:{}", pkg.name, sub)
            } else {
                pkg.name.clone()
            };
            let version_display = if node.revision == "1" {
                version.clone()
            } else {
                format!("{}-{}", version, node.revision)
            };
            pb.set_message(format!("zoi:{name}@{version_display}"));
            pb.enable_steady_tick(std::time::Duration::from_millis(100));
            Some(pb)
        }
    } else {
        None
    };

    let step_pb = if is_direct && let Some(m_inner) = m {
        let pb = m_inner.add(ProgressBar::new_spinner());
        pb.set_style(pb_style);
        pb.enable_steady_tick(std::time::Duration::from_millis(100));
        Some(pb)
    } else {
        None
    };

    if let Some(hooks) = &pkg.hooks {
        if let Some(pb) = &step_pb {
            pb.set_message("Running pre-install hooks...");
        }
        hooks::run_hooks(hooks, hooks::HookType::PreInstall, pkg.scope)?;
    }

    let sub_package_to_install = node.sub_package.clone();
    let sub_packages_vec = sub_package_to_install.clone().map(|s| vec![s]);

    let archive_path = &prepared.archive_path;
    let install_method = &prepared.install_method;

    let needs_escalation =
        pkg.scope == types::Scope::System && !zoi_core::utils::is_admin();

    let install_manifest = if needs_escalation {
        let escalator =
            zoi_core::utils::get_privilege_escalator().ok_or_else(|| {
                anyhow!(
                    "Root privileges required for system scope installation, \
                     but neither 'sudo' nor 'doas' was found."
                )
            })?;

        if let Some(pb) = step_pb.as_ref().or(main_pb.as_ref()) {
            pb.set_message(format!(
                "Waiting for {escalator} privileges to install system \
                 package..."
            ));
        }

        let node_json = serde_json::to_string(node)?;
        let mut temp_file = tempfile::NamedTempFile::new()?;
        temp_file.write_all(node_json.as_bytes())?;
        let temp_path = temp_file.path();

        let mut cmd = std::process::Command::new(escalator);
        cmd.arg(std::env::current_exe()?);
        cmd.arg("helper").arg("elevate-install-node");
        cmd.arg("--node-json").arg(temp_path);
        cmd.arg("--archive").arg(archive_path);
        cmd.arg("--install-method").arg(install_method);
        if yes {
            cmd.arg("--yes");
        }
        if link_bins {
            cmd.arg("--link-bins");
        }

        let status = cmd
            .status()
            .map_err(|e| anyhow!("Failed to spawn privilege escalator: {e}"))?;
        if !status.success() {
            return Err(anyhow!("Escalated installation failed."));
        }

        let version_dir = local::get_package_version_dir(
            pkg.scope,
            &node.registry_handle,
            &pkg.repo,
            &pkg.name,
            &node.version
        )?;
        let manifest_filename = if let Some(sub) = &node.sub_package {
            format!("manifest-{sub}.yaml")
        } else {
            "manifest.yaml".to_string()
        };
        let manifest_path = version_dir.join(manifest_filename);
        let content = std::fs::read_to_string(&manifest_path)?;
        let install_manifest: types::InstallManifest =
            serde_yaml::from_str(&content)?;

        install_manifest
    } else {
        if let Some(pb) = step_pb.as_ref().or(main_pb.as_ref()) {
            pb.set_message(format!("Installing {}...", pkg.name.cyan()));
        }

        let installed_files = crate::pkg_install::run(
            archive_path,
            Some(pkg.scope),
            &node.registry_handle,
            Some(&node.version),
            yes,
            sub_packages_vec,
            link_bins,
            step_pb.as_ref().or(main_pb.as_ref())
        )?;

        if let types::InstallReason::Dependency { ref parent } = node.reason {
            let package_dir = local::get_package_dir(
                pkg.scope, handle, &pkg.repo, &pkg.name
            )?;
            local::add_dependent(&package_dir, parent)?;
        }

        let install_manifest = manifest::create_manifest(
            pkg,
            node.reason.clone(),
            node.dependencies.clone(),
            Some(install_method.clone()),
            installed_files,
            handle,
            node.repo_type.clone(),
            &node.chosen_options,
            &node.chosen_optionals,
            sub_package_to_install.clone()
        )?;

        if record {
            local::write_manifest(&install_manifest)?;
            local::persist_package_source(
                &install_manifest,
                Path::new(&node.source)
            )?;
        }

        install_manifest
    };

    if prepared.is_build {
        let _ = fs::remove_file(archive_path);
    }

    if record {
        if let Ok(conn) = db::open_connection("local")
            && let Ok(pkg_id) = db::update_package(
                &conn,
                pkg,
                handle,
                Some(pkg.scope),
                sub_package_to_install.as_deref(),
                Some(&node.reason)
            )
        {
            let _ = db::clear_package_files(&conn, pkg_id);
            let _ = db::index_package_files(
                &conn,
                pkg_id,
                &install_manifest.installed_files
            );
        }

        if let Err(e) = recorder::record_package(
            pkg,
            &node.reason,
            &node.dependencies,
            handle,
            &node.repo_type,
            &node.chosen_options,
            &node.chosen_optionals,
            sub_package_to_install.as_deref()
        ) {
            eprintln!(
                "Warning: failed to record package installation for '{}': {}",
                pkg.name, e
            );
        }
    }

    if let Some(hooks) = &pkg.hooks {
        if let Some(pb) = &step_pb {
            pb.set_message("Running post-install hooks...");
        }
        hooks::run_hooks(hooks, hooks::HookType::PostInstall, pkg.scope)?;
    }

    if let Some(pb) = main_pb {
        pb.finish();
    }
    if let Some(pb) = step_pb {
        pb.finish();
    }

    util::send_telemetry("install", pkg, handle, Some(install_method));

    Ok(install_manifest)
}

/// Performs both preparation and execution phases for an install node.
///
/// # Errors
///
/// Returns an error if preparation or execution fails.
pub fn install_node(
    node: &InstallNode,
    action: &plan::InstallAction,
    m: Option<&MultiProgress>,
    build_type: Option<&str>,
    yes: bool,
    record: bool,
    link_bins: bool,
    verbose: bool
) -> Result<types::InstallManifest> {
    let prepared = prepare_node(node, action, m, build_type, verbose)?;
    install_prepared_node(node, &prepared, m, yes, record, link_bins, verbose)
}