zoi-plugins 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
use std::fs;
use std::path::PathBuf;

use anyhow::{Result, anyhow};
use mlua::LuaSerdeExt;
use zoi_core::{config, pgp, types};
use zoi_hooks as hooks;
use zoi_lua;
use zoi_resolver::{local, resolve};

use crate::PluginManager;

/// Filename used to store the persistent state of an extension.
const EXTENSION_STATE_FILE: &str = "extension-state.yaml";

/// Represents the persistent state of an installed extension, allowing for
/// rollbacks.
#[derive(Debug, Clone, Default, serde::Serialize, serde::Deserialize)]
struct ExtensionState {
    /// The default registry configuration before the extension was added.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    previous_default_registry: Option<types::Registry>,
    /// The path to the project file created by the extension, if any.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    project_file_path: Option<PathBuf>,
    /// Metadata about the installed extension itself.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    installed_extension: Option<types::ExtensionInfo>
}

/// Returns the path to the extension state file for a given manifest.
fn get_extension_state_path(
    manifest: &types::InstallManifest
) -> Result<PathBuf> {
    let version_dir = local::get_package_version_dir(
        manifest.scope,
        &manifest.registry_handle,
        &manifest.repo,
        &manifest.name,
        &manifest.version
    )?;
    Ok(version_dir.join(EXTENSION_STATE_FILE))
}

/// Writes the extension state to disk.
fn write_extension_state(
    manifest: &types::InstallManifest,
    extension_state: &ExtensionState
) -> Result<()> {
    let state_path = get_extension_state_path(manifest)?;
    fs::write(state_path, serde_yaml::to_string(extension_state)?)?;
    Ok(())
}

/// Reads the extension state from disk, if it exists.
fn read_extension_state(
    manifest: &types::InstallManifest
) -> Result<Option<ExtensionState>> {
    let state_path = get_extension_state_path(manifest)?;
    if !state_path.exists() {
        return Ok(None);
    }
    let content = fs::read_to_string(state_path)?;
    Ok(Some(serde_yaml::from_str(&content)?))
}

/// Restores the default registry to its previous state.
fn restore_default_registry(
    saved_state: Option<&ExtensionState>,
    added_registry_url: &str
) -> Result<()> {
    if let Some(saved_state) = saved_state {
        return config::set_user_default_registry(
            saved_state.previous_default_registry.clone()
        );
    }

    let user_config = config::read_user_config()?;
    let should_clear = user_config
        .default_registry
        .as_ref()
        .is_some_and(|registry| registry.url == added_registry_url);
    if should_clear {
        config::set_user_default_registry(None)?;
    }
    Ok(())
}

/// Checks if the extension state contains any data that needs to be persisted.
fn extension_state_requires_persistence(
    extension_state: &ExtensionState
) -> bool {
    extension_state.previous_default_registry.is_some()
        || extension_state.project_file_path.is_some()
        || extension_state.installed_extension.is_some()
}

/// Returns the path to the project file, either from saved state or the
/// default.
fn get_project_file_path(saved_state: Option<&ExtensionState>) -> PathBuf {
    saved_state
        .and_then(|state| state.project_file_path.clone())
        .unwrap_or_else(|| PathBuf::from("zoi.yaml"))
}

/// Extracts the repository name from a git URL.
fn get_repo_name_from_url(url: &str) -> &str {
    url.trim_end_matches('/')
        .split('/')
        .next_back()
        .unwrap_or_default()
        .trim_end_matches(".git")
}

/// Reverts a specific change made by an extension.
fn revert_extension_change(
    change: &types::ExtensionChange,
    saved_state: Option<&ExtensionState>
) -> Result<()> {
    match change {
        types::ExtensionChange::RepoGit { add } => {
            let repo_name = get_repo_name_from_url(add);
            if !repo_name.is_empty() {
                config::remove_git_repo(repo_name)?;
            }
        }
        types::ExtensionChange::RegistryRepo { add } => {
            restore_default_registry(saved_state, add)?;
        }
        types::ExtensionChange::RegistryAdd { add } => {
            config::remove_added_registry(add)?;
        }
        types::ExtensionChange::RepoAdd { add } => {
            config::remove_repo(add)?;
        }
        types::ExtensionChange::Project { add: _ } => {
            let project_file_path = get_project_file_path(saved_state);
            if project_file_path.exists() {
                fs::remove_file(project_file_path)?;
            }
        }
        types::ExtensionChange::Pgp { name, key: _ } => {
            pgp::remove_key_by_name(name)?;
        }
        types::ExtensionChange::Plugin { name, script: _ } => {
            let plugin_dir = crate::get_plugin_dir()?;
            let plugin_path = plugin_dir.join(format!("{name}.lua"));
            if plugin_path.exists() {
                fs::remove_file(plugin_path)?;
            }
        }
        types::ExtensionChange::Hook { name, content: _ } => {
            let hooks_dir = hooks::global::get_user_hooks_dir()?;
            let hook_path = hooks_dir.join(format!("{name}.hook.yaml"));
            if hook_path.exists() {
                fs::remove_file(hook_path)?;
            }
        }
    }
    Ok(())
}

/// Installs an extension, applying its declared changes to the system and
/// registry configuration.
///
/// # Errors
///
/// Returns an error if the extension package cannot be resolved, if it's not an
/// extension package, or if applying any of the changes fails.
pub fn add(
    ext_name: &str,
    yes: bool,
    plugin_manager: Option<&PluginManager>
) -> Result<()> {
    println!("Adding extension: {ext_name}");

    let (pkg, _, _, pkg_lua_path, registry_handle, repo_type, _) =
        resolve::resolve_package_and_version(ext_name, None, false, yes)?;

    if pkg.package_type != types::PackageType::Extension {
        return Err(anyhow!("'{ext_name}' is not an extension package."));
    }

    let mut pkg_val = None;
    if let Some(pm) = plugin_manager {
        let v = pm
            .lua
            .to_value(&pkg)
            .map_err(|e: mlua::Error| anyhow!(e.to_string()))?;
        pm.trigger_hook("on_pre_extension_add", Some(&v.clone()))?;
        pkg_val = Some(v);
    }

    let Some(extension_info) = pkg.extension else {
        return Err(anyhow!(
            "'{ext_name}' is an extension package but contains no extension \
             data."
        ));
    };
    if extension_info.extension_type != "zoi" {
        return Err(anyhow!(
            "Unsupported extension type: {}",
            extension_info.extension_type
        ));
    }
    let has_registry_repo_change =
        extension_info.changes.iter().any(|change| {
            matches!(change, types::ExtensionChange::RegistryRepo { .. })
        });
    let has_project_change = extension_info
        .changes
        .iter()
        .any(|change| matches!(change, types::ExtensionChange::Project { .. }));
    let previous_default_registry = if has_registry_repo_change {
        config::read_user_config()?.default_registry.clone()
    } else {
        None
    };
    let project_file_path = if has_project_change {
        Some(std::env::current_dir()?.join("zoi.yaml"))
    } else {
        None
    };
    let extension_state = ExtensionState {
        previous_default_registry,
        project_file_path,
        installed_extension: Some(extension_info.clone())
    };

    let manifest = types::InstallManifest {
        name: pkg.name.clone(),
        version: pkg.version.clone().unwrap_or_default(),
        epoch: pkg.epoch,
        revision: pkg.revision.clone(),
        sub_package: None,
        repo: pkg.repo.clone(),
        repo_type: repo_type.unwrap_or_else(|| "unofficial".to_string()),
        registry_handle: registry_handle.unwrap_or_default(),
        package_type: pkg.package_type,
        description: pkg.description.clone(),
        reason: types::InstallReason::Direct,
        scope: pkg.scope,
        bins: None,
        conflicts: None,
        replaces: None,
        provides: None,
        backup: None,
        installed_dependencies: vec![],
        dependencies_v2: None,
        chosen_options: vec![],
        chosen_optionals: vec![],
        install_method: None,
        platform: zoi_core::utils::get_platform().unwrap_or_default(),
        service: None,
        installed_files: vec![],
        installed_size: pkg.installed_size,
        sandbox: None,
        completions: None
    };
    let mut wrote_manifest = false;
    let mut applied_changes = Vec::new();
    let add_result = (|| -> Result<()> {
        if extension_state_requires_persistence(&extension_state) {
            local::write_manifest(&manifest)?;
            local::persist_package_source(&manifest, &pkg_lua_path)?;
            wrote_manifest = true;
            write_extension_state(&manifest, &extension_state)?;
        }

        println!("Applying extension changes...");
        for change in &extension_info.changes {
            match change {
                types::ExtensionChange::RepoGit { add } => {
                    println!("Adding git repository: {add}");
                    config::clone_git_repo(add)?;
                }
                types::ExtensionChange::RegistryRepo { add } => {
                    println!("Setting registry to: {add}");
                    config::set_default_registry(add)?;
                }
                types::ExtensionChange::RegistryAdd { add } => {
                    println!("Adding registry: {add}");
                    config::add_added_registry(add)?;
                }
                types::ExtensionChange::RepoAdd { add } => {
                    println!("Adding repository: {add}");
                    config::add_repo(add)?;
                }
                types::ExtensionChange::Project { add } => {
                    let project_file_path =
                        get_project_file_path(Some(&extension_state));
                    println!("Creating {}...", project_file_path.display());
                    if project_file_path.exists() {
                        return Err(anyhow!(
                            "A 'zoi.yaml' file already exists at '{}'. Please \
                             remove it first.",
                            project_file_path.display()
                        ));
                    }
                    fs::write(&project_file_path, add)?;
                }
                types::ExtensionChange::Pgp { name, key } => {
                    println!("Adding PGP key: {name} from {key}");
                    if key.starts_with("http") {
                        pgp::add_key_from_url(key, name, false)?;
                    } else {
                        pgp::add_key_from_fingerprint(key, name, false)?;
                    }
                }
                types::ExtensionChange::Plugin { name, script } => {
                    println!("Adding plugin: {name}");
                    let plugin_dir = crate::get_plugin_dir()?;
                    let plugin_path = plugin_dir.join(format!("{name}.lua"));
                    fs::write(plugin_path, script)?;
                }
                types::ExtensionChange::Hook { name, content } => {
                    println!("Adding global hook: {name}");
                    let hooks_dir = hooks::global::get_user_hooks_dir()?;
                    let hook_path = hooks_dir.join(format!("{name}.hook.yaml"));
                    fs::write(hook_path, content)?;
                }
            }
            applied_changes.push(change.clone());
        }
        if !wrote_manifest {
            local::write_manifest(&manifest)?;
            local::persist_package_source(&manifest, &pkg_lua_path)?;
            wrote_manifest = true;
        }
        Ok(())
    })();
    if let Err(error) = add_result {
        for change in applied_changes.iter().rev() {
            if let Err(rollback_error) =
                revert_extension_change(change, Some(&extension_state))
            {
                eprintln!(
                    "Warning: failed to roll back extension change \
                     {change:?}: {rollback_error}"
                );
            }
        }
        if wrote_manifest
            && let Ok(package_dir) = local::get_package_dir(
                manifest.scope,
                &manifest.registry_handle,
                &manifest.repo,
                &manifest.name
            )
        {
            let _ = fs::remove_dir_all(package_dir);
        }
        return Err(error);
    }

    if let (Some(pm), Some(v)) = (plugin_manager, pkg_val) {
        pm.trigger_hook_nonfatal("on_post_extension_add", Some(&v));
    }

    println!("Successfully added extension '{ext_name}'.");

    Ok(())
}

/// Uninstalls an extension and reverts all changes it made to the system and
/// configuration.
///
/// # Errors
///
/// Returns an error if the extension is not installed, if it's not an extension
/// package, or if reverting any of the changes fails.
pub fn remove(
    ext_name: &str,
    yes: bool,
    plugin_manager: Option<&PluginManager>
) -> Result<()> {
    println!("Removing extension: {ext_name}");

    let request = resolve::parse_source_string(ext_name)?;
    let mut candidates = Vec::new();
    for scope in [
        types::Scope::Project,
        types::Scope::User,
        types::Scope::System
    ] {
        candidates
            .extend(local::find_installed_manifests_matching(&request, scope)?);
    }

    if candidates.is_empty() {
        return Err(anyhow!("Extension '{ext_name}' is not installed."));
    }

    let manifest = select_candidate(ext_name, candidates, yes)?;
    let scope = manifest.scope;

    let mut manifest_val = None;
    if let Some(pm) = plugin_manager {
        let v = pm
            .lua
            .to_value(&manifest)
            .map_err(|e: mlua::Error| anyhow!(e.to_string()))?;
        pm.trigger_hook("on_pre_extension_remove", Some(&v.clone()))?;
        manifest_val = Some(v);
    }

    if manifest.package_type != types::PackageType::Extension {
        return Err(anyhow!("'{ext_name}' is not an extension package."));
    }

    let installed_source_path = local::get_package_source_path(&manifest)?;
    let pkg = if installed_source_path.exists() {
        let path = installed_source_path.to_str().ok_or_else(|| {
            anyhow!("Stored package source path contains invalid UTF-8")
        })?;
        zoi_lua::parser::parse_lua_package(
            path,
            Some(&manifest.version),
            Some(manifest.scope),
            true
        )?
    } else {
        let source = local::installed_manifest_source(&manifest);
        let (pkg, _, _, _, _, _, _) = resolve::resolve_package_and_version(
            &source,
            Some(manifest.scope),
            true,
            yes
        )?;
        pkg
    };

    let extension_state = read_extension_state(&manifest)?;
    let extension_info = extension_state
        .as_ref()
        .and_then(|state| state.installed_extension.clone())
        .or(pkg.extension);

    if let Some(extension_info) = extension_info {
        if extension_info.extension_type != "zoi" {
            return Err(anyhow!(
                "Unsupported extension type: {}",
                extension_info.extension_type
            ));
        }

        println!("Reverting extension changes...");
        for change in extension_info.changes.iter().rev() {
            match change {
                types::ExtensionChange::RepoGit { add } => {
                    let repo_name = get_repo_name_from_url(add);
                    if !repo_name.is_empty() {
                        println!("Removing git repository: {repo_name}");
                        if let Err(e) = revert_extension_change(
                            change,
                            extension_state.as_ref()
                        ) {
                            eprintln!(
                                "Warning: failed to remove git repo \
                                 '{repo_name}': {e}"
                            );
                        }
                    }
                }
                types::ExtensionChange::RegistryRepo { add: _ } => {
                    println!("Restoring previous default registry");
                    if let Err(e) = revert_extension_change(
                        change,
                        extension_state.as_ref()
                    ) {
                        eprintln!(
                            "Warning: failed to restore default registry: {e}"
                        );
                    }
                }
                types::ExtensionChange::RegistryAdd { add } => {
                    println!("Removing registry: {add}");
                    if let Err(e) = revert_extension_change(
                        change,
                        extension_state.as_ref()
                    ) {
                        eprintln!(
                            "Warning: failed to remove registry '{add}': {e}"
                        );
                    }
                }
                types::ExtensionChange::RepoAdd { add } => {
                    println!("Removing repository: {add}");
                    if let Err(e) = revert_extension_change(
                        change,
                        extension_state.as_ref()
                    ) {
                        eprintln!(
                            "Warning: failed to remove repo '{add}': {e}"
                        );
                    }
                }
                types::ExtensionChange::Project { add: _ } => {
                    let project_file_path =
                        get_project_file_path(extension_state.as_ref());
                    println!("Removing {}...", project_file_path.display());
                    if let Err(e) = revert_extension_change(
                        change,
                        extension_state.as_ref()
                    ) {
                        eprintln!(
                            "Warning: failed to remove '{}': {e}",
                            project_file_path.display()
                        );
                    }
                }
                types::ExtensionChange::Pgp { name, key: _ } => {
                    println!("Removing PGP key: {name}");
                    if let Err(e) = revert_extension_change(
                        change,
                        extension_state.as_ref()
                    ) {
                        eprintln!(
                            "Warning: failed to remove PGP key '{name}': {e}"
                        );
                    }
                }
                types::ExtensionChange::Plugin { name, script: _ } => {
                    println!("Removing plugin: {name}");
                    if let Err(e) = revert_extension_change(
                        change,
                        extension_state.as_ref()
                    ) {
                        eprintln!(
                            "Warning: failed to remove plugin '{name}': {e}"
                        );
                    }
                }
                types::ExtensionChange::Hook { name, content: _ } => {
                    println!("Removing global hook: {name}");
                    if let Err(e) = revert_extension_change(
                        change,
                        extension_state.as_ref()
                    ) {
                        eprintln!(
                            "Warning: failed to remove global hook '{name}': \
                             {e}"
                        );
                    }
                }
            }
        }
    } else {
        return Err(anyhow!(
            "'{ext_name}' is an extension package but contains no extension \
             data."
        ));
    }

    let package_dir = local::get_package_dir(
        scope,
        &manifest.registry_handle,
        &manifest.repo,
        &manifest.name
    )?;

    if package_dir.exists() {
        fs::remove_dir_all(&package_dir)?;
    }

    if let (Some(pm), Some(v)) = (plugin_manager, manifest_val) {
        pm.trigger_hook_nonfatal("on_post_extension_remove", Some(&v));
    }

    println!("Successfully removed extension '{ext_name}'.");

    Ok(())
}

/// Prompts the user to select one extension if multiple candidates match the
/// request.
fn select_candidate(
    package_name: &str,
    candidates: Vec<types::InstallManifest>,
    yes: bool
) -> Result<types::InstallManifest> {
    use colored::Colorize;
    use comfy_table::Table;
    use comfy_table::presets::UTF8_FULL;
    use dialoguer::Select;
    use dialoguer::theme::ColorfulTheme;

    if candidates.is_empty() {
        return Err(anyhow!("Package '{package_name}' is not installed."));
    }
    if candidates.len() == 1 {
        return Ok(candidates
            .into_iter()
            .next()
            .expect("Already checked length"));
    }
    if yes {
        return Err(anyhow!(
            "Package '{package_name}' matches multiple installed packages. \
             Use an explicit source like '#handle@repo/name[:sub]@version'."
        ));
    }

    let displays: Vec<_> = candidates
        .iter()
        .map(|m| {
            let source = local::installed_manifest_source(m);
            let scope_label = match m.scope {
                types::Scope::User => "user",
                types::Scope::System => "system",
                types::Scope::Project => "project"
            };
            format!("{} ({}, v{})", source, scope_label, m.version)
        })
        .collect();

    let mut table = Table::new();
    table.load_style(UTF8_FULL);
    table.set_header(vec!["#", "Source", "Version"]);
    for (i, m) in candidates.iter().enumerate() {
        table.add_row(vec![
            (i + 1).to_string(),
            local::installed_manifest_source(m),
            m.version.clone(),
        ]);
    }
    println!(
        "Found multiple installed packages matching '{}'. Please choose one:",
        package_name.cyan()
    );
    println!("{table}");

    let selection = Select::with_theme(&ColorfulTheme::default())
        .with_prompt("Select an installed package")
        .items(&displays)
        .default(0)
        .interact()?;

    Ok(candidates
        .get(selection)
        .cloned()
        .expect("Invalid selection"))
}