waxpkg 0.20.4

Fast Homebrew-compatible package manager
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
//! Install portable Windows packages from Scoop-style JSON manifests using wax's
//! HTTP downloader (multipart when beneficial) and local extraction — without
//! invoking Scoop's PowerShell installer. Supports zip/tar.gz archives and
//! direct `.exe` downloads (including Scoop's `#/rename.exe` URL fragments).
//!
//! Chocolatey `.nupkg` packages are not supported here: most run
//! `chocolateyinstall.ps1` to compute download URLs and drive MSI/EXE setups.
//! Use `scoop-install` for zip/tar.gz-based portable apps, or run `choco.exe`
//! separately for full Chocolatey semantics.

use crate::bottle::BottleDownloader;
use crate::error::{Result, WaxError};
use crate::package_spec::Ecosystem;
use crate::ui::copy_dir_all;
use crate::windows_state::{self, WindowsPackageManifest};
use indicatif::{ProgressBar, ProgressStyle};
use serde::Deserialize;
use serde_json::Value;
use std::path::{Component, Path, PathBuf};
use tempfile::TempDir;
use tracing::debug;

pub const DEFAULT_BUCKET_BASE: &str =
    "https://raw.githubusercontent.com/ScoopInstaller/Main/master/bucket";

#[derive(Debug, Clone)]
pub struct ResolvedScoopPackage {
    pub version: String,
    pub download_url: String,
    /// Scoop `#/filename.exe` fragment — save the downloaded artifact under this name.
    pub save_as: Option<String>,
    pub sha256: String,
    pub extract_dir: Option<String>,
    /// Paths relative to the extraction root (after optional extract_dir), using OS separators.
    pub bin_paths: Vec<PathBuf>,
}

#[derive(Debug, Deserialize)]
struct ArchEntry {
    url: String,
    hash: String,
    extract_dir: Option<String>,
}

#[derive(Debug, Deserialize)]
struct ScoopManifest {
    version: String,
    url: Option<String>,
    hash: Option<String>,
    architecture: Option<std::collections::HashMap<String, ArchEntry>>,
    bin: Option<Value>,
    pre_install: Option<Value>,
    post_install: Option<Value>,
    installer: Option<Value>,
}

fn scoop_arch_key() -> &'static str {
    match std::env::consts::ARCH {
        "x86_64" => "64bit",
        "aarch64" => "arm64",
        "x86" => "32bit",
        _ => "64bit",
    }
}

fn parse_scoop_download_url(url_raw: &str) -> (String, Option<String>) {
    let (base, fragment) = match url_raw.split_once('#') {
        Some((b, f)) => (b, Some(f)),
        None => (url_raw, None),
    };
    let save_as = fragment.and_then(|f| {
        let name = f.strip_prefix('/').unwrap_or(f);
        if name.is_empty() {
            None
        } else {
            Some(name.replace('\\', "/"))
        }
    });
    (base.to_string(), save_as)
}

fn unsupported_script_fields(m: &ScoopManifest) -> Option<&'static str> {
    if let Some(v) = &m.pre_install {
        if !value_is_empty_or_comment_only(v) {
            return Some("pre_install");
        }
    }
    if let Some(v) = &m.post_install {
        if !value_is_empty_or_comment_only(v) {
            return Some("post_install");
        }
    }
    if m.installer.is_some() {
        return Some("installer");
    }
    None
}

fn value_is_empty_or_comment_only(v: &Value) -> bool {
    match v {
        Value::Null => true,
        Value::Array(a) => a.iter().all(|x| match x {
            Value::String(s) => {
                let t = s.trim();
                t.is_empty() || t.starts_with('#')
            }
            _ => false,
        }),
        Value::String(s) => {
            let t = s.trim();
            t.is_empty() || t.starts_with('#')
        }
        _ => false,
    }
}

fn normalize_scoop_hash(raw: &str) -> String {
    let t = raw.trim();
    if let Some(rest) = t.strip_prefix("sha256:") {
        return rest.trim().to_ascii_lowercase();
    }
    if let Some(rest) = t.strip_prefix("SHA256:") {
        return rest.trim().to_ascii_lowercase();
    }
    t.to_ascii_lowercase()
}

fn parse_bin_paths(bin: &Option<Value>) -> Result<Vec<PathBuf>> {
    let Some(bin) = bin else {
        return Err(WaxError::InstallError(
            "Scoop manifest has no bin field (wax cannot guess executables)".into(),
        ));
    };

    let mut out = Vec::new();
    match bin {
        Value::String(s) => out.push(PathBuf::from(s.replace('\\', "/"))),
        Value::Array(items) => {
            for item in items {
                match item {
                    Value::String(s) => out.push(PathBuf::from(s.replace('\\', "/"))),
                    Value::Array(pair) => {
                        if let Some(Value::String(p)) = pair.first() {
                            out.push(PathBuf::from(p.replace('\\', "/")));
                        }
                    }
                    _ => {}
                }
            }
        }
        _ => {
            return Err(WaxError::ParseError(
                "Scoop manifest bin field has unsupported shape".into(),
            ));
        }
    }

    if out.is_empty() {
        return Err(WaxError::InstallError(
            "Scoop manifest bin field resolved to no executables".into(),
        ));
    }
    Ok(out)
}

fn join_under_root(root: &Path, rel: &Path) -> Result<PathBuf> {
    for c in rel.components() {
        match c {
            Component::Normal(_) | Component::CurDir => {}
            Component::ParentDir | Component::RootDir | Component::Prefix(_) => {
                return Err(WaxError::InstallError(format!(
                    "Unsafe path in manifest: {}",
                    rel.display()
                )));
            }
        }
    }
    Ok(root.join(rel))
}

/// Parse a manifest JSON string and resolve URLs for the current architecture.
pub fn resolve_manifest_json(raw: &str) -> Result<ResolvedScoopPackage> {
    let m: ScoopManifest = serde_json::from_str(raw).map_err(WaxError::JsonError)?;

    if let Some(field) = unsupported_script_fields(&m) {
        return Err(WaxError::InstallError(format!(
            "This Scoop manifest uses `{field}` scripts; wax only supports portable zip/tar.gz installs without PowerShell hooks. Try another package or install with Scoop itself."
        )));
    }

    let arch = scoop_arch_key();
    let (url_raw, hash_raw, extract_dir) = if let Some(map) = &m.architecture {
        let entry = map.get(arch).ok_or_else(|| {
            WaxError::InstallError(format!(
                "Scoop manifest has no {arch} architecture entry for this host"
            ))
        })?;
        (
            entry.url.clone(),
            entry.hash.clone(),
            entry.extract_dir.clone(),
        )
    } else {
        let url = m.url.ok_or_else(|| {
            WaxError::InstallError("Scoop manifest has no url (and no architecture block)".into())
        })?;
        let hash = m.hash.ok_or_else(|| {
            WaxError::InstallError("Scoop manifest has no hash (and no architecture block)".into())
        })?;
        (url, hash, None)
    };

    let (download_url, save_as) = parse_scoop_download_url(&url_raw);
    let sha256 = normalize_scoop_hash(&hash_raw);
    if sha256.len() != 64 || !sha256.chars().all(|c| c.is_ascii_hexdigit()) {
        return Err(WaxError::InstallError(format!(
            "Expected 64-char sha256 hex from manifest, got {sha256:?}"
        )));
    }

    let bin_paths = parse_bin_paths(&m.bin)?;

    Ok(ResolvedScoopPackage {
        version: m.version,
        download_url,
        save_as,
        sha256,
        extract_dir,
        bin_paths,
    })
}

/// True if a Scoop JSON manifest exists for this package name (HEAD request).
#[cfg(target_os = "windows")]
pub async fn scoop_manifest_exists(bucket_base: &str, package: &str) -> bool {
    let base = bucket_base.trim_end_matches('/');
    let url = format!("{base}/{}.json", package);
    let client = crate::http_client::default_client();
    match client.head(&url).send().await {
        Ok(r) => r.status().is_success(),
        Err(_) => false,
    }
}

async fn fetch_manifest_text(bucket_base: &str, package: &str) -> Result<String> {
    let base = bucket_base.trim_end_matches('/');
    let url = format!("{base}/{}.json", package);
    debug!("Fetching Scoop manifest {}", url);
    let client = crate::http_client::default_client();
    let resp = client.get(&url).send().await?;
    if !resp.status().is_success() {
        return Err(WaxError::InstallError(format!(
            "Failed to fetch manifest {}: HTTP {}",
            url,
            resp.status()
        )));
    }
    Ok(resp.text().await?)
}

fn download_kind_from_url(url: &str) -> Result<&'static str> {
    let lower = url.to_ascii_lowercase();
    let path = lower.split('?').next().unwrap_or(&lower);
    if path.ends_with(".zip") {
        return Ok("zip");
    }
    if path.contains(".tar.gz") || path.ends_with(".tgz") {
        return Ok("tar.gz");
    }
    if path.ends_with(".exe") {
        return Ok("exe");
    }
    Err(WaxError::InstallError(format!(
        "Unsupported download type for wax scoop-install (need .zip, .tar.gz/.tgz, or .exe URL): {url}"
    )))
}

fn exe_filename(resolved: &ResolvedScoopPackage) -> Result<String> {
    if let Some(name) = &resolved.save_as {
        return Ok(name.clone());
    }
    let path = resolved
        .download_url
        .split('?')
        .next()
        .unwrap_or(&resolved.download_url);
    Path::new(path)
        .file_name()
        .and_then(|s| s.to_str())
        .map(|s| s.to_string())
        .ok_or_else(|| {
            WaxError::InstallError(format!(
                "Cannot determine executable filename from {}",
                resolved.download_url
            ))
        })
}

pub(crate) fn extract_zip_file(zip_path: &Path, dest_dir: &Path) -> Result<()> {
    let file = std::fs::File::open(zip_path)?;
    let mut archive =
        zip::ZipArchive::new(file).map_err(|e| WaxError::InstallError(e.to_string()))?;

    for i in 0..archive.len() {
        let mut entry = archive
            .by_index(i)
            .map_err(|e| WaxError::InstallError(e.to_string()))?;
        let rel = match entry.enclosed_name() {
            Some(p) => p.to_path_buf(),
            None => continue,
        };
        if rel.as_os_str().is_empty() {
            continue;
        }
        let out_path = dest_dir.join(&rel);
        if entry.is_dir() {
            std::fs::create_dir_all(&out_path)?;
        } else {
            if let Some(p) = out_path.parent() {
                std::fs::create_dir_all(p)?;
            }
            let mut outfile = std::fs::File::create(&out_path)?;
            std::io::copy(&mut entry, &mut outfile)?;
        }
    }
    Ok(())
}

fn extract_tar_gz(tarball: &Path, dest_dir: &Path) -> Result<()> {
    BottleDownloader::extract(tarball, dest_dir)
}

/// Download manifest from `bucket_base`, then download & extract the artifact.
pub async fn install_from_bucket(package: &str, bucket_base: Option<&str>) -> Result<()> {
    if !cfg!(target_os = "windows") {
        return Err(WaxError::PlatformNotSupported(
            "scoop-install is only supported on Windows (portable .exe layout)".into(),
        ));
    }

    let bucket = bucket_base.unwrap_or(DEFAULT_BUCKET_BASE);
    let text = fetch_manifest_text(bucket, package).await?;
    let resolved = resolve_manifest_json(&text)?;

    let kind = download_kind_from_url(&resolved.download_url)?;
    debug!(
        "Scoop package {} @ {} kind={} url={}",
        package, resolved.version, kind, resolved.download_url
    );

    let version_dir = resolved_staging_dir(package, &resolved.version)?;
    if version_dir.exists() {
        std::fs::remove_dir_all(&version_dir)?;
    }
    std::fs::create_dir_all(version_dir.parent().unwrap())?;

    let tmp = TempDir::new()?;
    let ext = match kind {
        "zip" => "zip",
        "tar.gz" => "tar.gz",
        "exe" => "exe",
        _ => "dat",
    };
    let download_path = tmp.path().join(format!("download.{ext}"));

    download_and_verify(package, &resolved, &download_path).await?;
    extract_and_stage(kind, &download_path, &version_dir, tmp.path(), &resolved)?;
    let bin_dir = link_bins_and_save_manifest(package, &resolved, &version_dir)?;

    println!(
        "Installed {} {} (Scoop manifest) — add to PATH if needed:\n  {}",
        package,
        resolved.version,
        bin_dir.display()
    );

    Ok(())
}

async fn download_and_verify(
    package: &str,
    resolved: &ResolvedScoopPackage,
    download_path: &Path,
) -> Result<()> {
    let dl = BottleDownloader::new();
    let size = dl.probe_size(&resolved.download_url).await;
    let conns =
        BottleDownloader::num_connections(size, BottleDownloader::MAX_CONNECTIONS_PER_DOWNLOAD);
    let pb = ProgressBar::new(0);
    pb.set_style(
        ProgressStyle::default_bar()
            .template("{spinner:.cyan} {msg} [{bar:30.cyan/blue}] {bytes}/{total_bytes}")
            .unwrap()
            .progress_chars("=>-"),
    );
    pb.set_message(format!("{} {}", package, resolved.version));

    dl.download(
        &resolved.download_url,
        download_path,
        Some(&pb),
        conns,
        None,
    )
    .await?;
    pb.finish_and_clear();

    crate::digest::verify_sha256_file(download_path, &resolved.sha256)?;
    Ok(())
}

fn extract_and_stage(
    kind: &str,
    download_path: &Path,
    version_dir: &Path,
    tmp_path: &Path,
    resolved: &ResolvedScoopPackage,
) -> Result<()> {
    match kind {
        "zip" | "tar.gz" => {
            let extract_root = tmp_path.join("extract");
            std::fs::create_dir_all(&extract_root)?;
            match kind {
                "zip" => extract_zip_file(download_path, &extract_root)?,
                "tar.gz" => extract_tar_gz(download_path, &extract_root)?,
                _ => unreachable!(),
            }

            let source_tree = match &resolved.extract_dir {
                Some(d) => extract_root.join(d.replace('\\', "/")),
                None => extract_root.clone(),
            };
            if !source_tree.exists() {
                return Err(WaxError::InstallError(format!(
                    "Extracted files missing expected extract_dir {:?}",
                    resolved.extract_dir
                )));
            }

            copy_dir_all(&source_tree, version_dir)?;
        }
        "exe" => {
            std::fs::create_dir_all(version_dir)?;
            let dest = version_dir.join(exe_filename(resolved)?);
            std::fs::copy(download_path, &dest)?;
        }
        _ => unreachable!(),
    }
    Ok(())
}

fn link_bins_and_save_manifest(
    package: &str,
    resolved: &ResolvedScoopPackage,
    version_dir: &Path,
) -> Result<PathBuf> {
    let bin_dir = windows_state::wax_bin_dir()?;
    std::fs::create_dir_all(&bin_dir)?;

    let mut copy_actions = Vec::new();
    for rel in &resolved.bin_paths {
        let src = join_under_root(version_dir, rel)?;
        if !src.exists() {
            return Err(WaxError::InstallError(format!(
                "Expected binary missing after extract: {}",
                src.display()
            )));
        }
        let file_name = src
            .file_name()
            .ok_or_else(|| WaxError::InstallError("Invalid bin path".into()))?;
        let dest = bin_dir.join(file_name);
        copy_actions.push((src, dest));
    }
    let bin_links: Vec<PathBuf> = copy_actions.iter().map(|(_, dest)| dest.clone()).collect();
    windows_state::validate_bin_links_available(Ecosystem::Scoop, package, &bin_links)?;

    for (src, dest) in copy_actions {
        if dest.exists() {
            std::fs::remove_file(&dest)?;
        }
        std::fs::copy(&src, &dest)?;
    }

    let mut files = windows_state::collect_files(version_dir)?;
    files.extend(bin_links.iter().cloned());
    WindowsPackageManifest::new(
        Ecosystem::Scoop,
        package,
        resolved.version.clone(),
        resolved.download_url.clone(),
        version_dir.to_path_buf(),
        bin_links,
        files,
    )
    .save()?;

    Ok(bin_dir)
}

fn wax_user_root() -> Result<PathBuf> {
    windows_state::wax_windows_root()
}

fn resolved_staging_dir(package: &str, version: &str) -> Result<PathBuf> {
    Ok(wax_user_root()?
        .join("scoop-apps")
        .join(package)
        .join(version))
}

#[cfg(test)]
mod tests {
    use super::*;

    const RG_MANIFEST: &str = include_str!("../tests/fixtures/scoop_ripgrep.json");
    const AGENT_BROWSER_MANIFEST: &str = include_str!("../tests/fixtures/scoop_agent_browser.json");

    #[test]
    fn resolve_ripgrep_main_manifest() {
        let r = resolve_manifest_json(RG_MANIFEST).unwrap();
        assert_eq!(r.version, "15.1.0");
        assert!(r.download_url.ends_with(".zip"));
        assert_eq!(r.sha256.len(), 64);
        assert!(r.extract_dir.as_ref().unwrap().contains("ripgrep"));
        assert_eq!(r.bin_paths.len(), 1);
        assert!(r.bin_paths[0].to_string_lossy().contains("rg"));
        assert!(r.save_as.is_none());
    }

    #[test]
    fn resolve_agent_browser_exe_manifest() {
        let r = resolve_manifest_json(AGENT_BROWSER_MANIFEST).unwrap();
        assert_eq!(r.version, "0.31.1");
        assert!(r.download_url.ends_with(".exe"));
        assert!(!r.download_url.contains('#'));
        assert_eq!(r.save_as.as_deref(), Some("agent-browser.exe"));
        assert_eq!(r.sha256.len(), 64);
        assert!(r.extract_dir.is_none());
        assert_eq!(r.bin_paths.len(), 1);
        assert_eq!(r.bin_paths[0].to_string_lossy(), "agent-browser.exe");
        assert_eq!(download_kind_from_url(&r.download_url).unwrap(), "exe");
        assert_eq!(exe_filename(&r).unwrap(), "agent-browser.exe");
    }

    #[test]
    fn parse_scoop_download_url_strips_fragment_and_save_as() {
        let (url, save_as) = parse_scoop_download_url(
            "https://example.invalid/pkg-win32-x64.exe#/agent-browser.exe",
        );
        assert_eq!(url, "https://example.invalid/pkg-win32-x64.exe");
        assert_eq!(save_as.as_deref(), Some("agent-browser.exe"));
    }
}