elio 1.3.0

Snappy, batteries-included terminal file manager with rich previews, inline images, bulk actions, and trash support.
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
// This module is only compiled on Linux / BSD (gated in discovery/mod.rs).

use std::collections::{HashMap, HashSet};
use std::path::{Path, PathBuf};

use super::super::super::state::OpenWithApp;
use super::desktop_file::{
    DesktopEntryCandidate, parse_desktop_entry, parse_mimeapps_defaults, parse_mimeapps_removed,
};
use super::exec::expand_exec_template;

/// Manual desktop-file scan: walks all desktop entry directories and returns
/// apps that explicitly list `mime` in their `MimeType=` field.
/// Used as a fallback when `gio` is unavailable.
pub(super) fn discover_via_desktop_scan(mime: &str, path: &Path) -> Vec<OpenWithApp> {
    discover_via_desktop_scan_in_dirs(mime, path, &desktop_entry_dirs())
}

/// Inner scan that accepts an explicit directory list (allows hermetic testing).
pub(super) fn discover_via_desktop_scan_in_dirs(
    mime: &str,
    path: &Path,
    dirs: &[PathBuf],
) -> Vec<OpenWithApp> {
    discover_via_desktop_scan_inner(mime, path, dirs, &mimeapps_paths())
}

/// Innermost scan accepting both explicit desktop dirs and explicit mimeapps
/// paths, enabling fully hermetic tests without environment-variable mutation.
fn discover_via_desktop_scan_inner(
    mime: &str,
    path: &Path,
    dirs: &[PathBuf],
    mime_paths: &[PathBuf],
) -> Vec<OpenWithApp> {
    let desktops = super::current_desktops();

    // Collect all desktop entries that declare this MIME type, keyed by
    // desktop-id.  Higher-priority directories come first; once a desktop-id
    // is seen it is never overwritten by a lower-priority directory.
    // The recursive walk derives desktop-ids from relative paths per XDG spec
    // (e.g. `kde/konsole.desktop` → desktop-id `kde-konsole.desktop`).
    let mut candidates: HashMap<String, DesktopEntryCandidate> = HashMap::new();
    for dir in dirs {
        for (desktop_id, entry_path) in collect_desktop_entries(dir) {
            if candidates.contains_key(&desktop_id) {
                continue; // already claimed by a higher-priority dir
            }
            let Ok(contents) = std::fs::read_to_string(&entry_path) else {
                continue;
            };
            let Some(candidate) = parse_desktop_entry(&contents) else {
                continue;
            };
            if candidate.mime_types.iter().any(|m| m == mime) && candidate.is_shown_in(&desktops) {
                candidates.insert(desktop_id, candidate);
            }
        }
    }

    // Default ordering: first file in priority order that mentions this MIME type.
    let ordered_defaults: Vec<String> = mime_paths
        .iter()
        .find_map(|p| {
            let contents = std::fs::read_to_string(p).ok()?;
            let defaults = parse_mimeapps_defaults(&contents, mime);
            if defaults.is_empty() {
                None
            } else {
                Some(defaults)
            }
        })
        .unwrap_or_default();

    // Remove any candidate explicitly suppressed in any mimeapps.list
    // [Removed Associations] section for this MIME type.
    let mut removed: HashSet<String> = HashSet::new();
    for p in mime_paths {
        if let Ok(contents) = std::fs::read_to_string(p) {
            removed.extend(parse_mimeapps_removed(&contents, mime));
        }
    }
    candidates.retain(|id, _| !removed.contains(id));

    // Build result: defaults first (in declared order), then the rest sorted by
    // display name (case-insensitive) for stable ordering.
    // Only the first resolved default gets is_default=true — that is the user's
    // explicit preferred handler; subsequent entries in the defaults list are
    // listed before non-defaults but are not flagged as the default.
    let mut apps: Vec<OpenWithApp> = Vec::new();
    let mut first_default_emitted = false;

    for desktop_id in &ordered_defaults {
        let Some(candidate) = candidates.remove(desktop_id) else {
            continue;
        };
        let Some((program, args)) = expand_exec_template(&candidate.exec, path) else {
            continue;
        };
        let is_default = !first_default_emitted;
        first_default_emitted = true;
        apps.push(OpenWithApp {
            display_name: candidate.name,
            desktop_id: Some(desktop_id.clone()),
            program,
            args,
            is_default,
            requires_terminal: candidate.terminal,
        });
    }

    let mut remaining: Vec<_> = candidates.into_iter().collect();
    remaining.sort_by(|a, b| a.1.name.to_lowercase().cmp(&b.1.name.to_lowercase()));

    for (desktop_id, candidate) in remaining {
        let Some((program, args)) = expand_exec_template(&candidate.exec, path) else {
            continue;
        };
        apps.push(OpenWithApp {
            display_name: candidate.name,
            desktop_id: Some(desktop_id),
            program,
            args,
            is_default: false,
            requires_terminal: candidate.terminal,
        });
    }

    apps
}

/// Returns the ordered list of directories to search for `.desktop` files,
/// from highest to lowest priority, following the XDG Base Dir spec.
///
/// Includes Flatpak and Snap export paths so apps installed via those package
/// managers are discovered even when they are not in `XDG_DATA_DIRS`.
pub(super) fn desktop_entry_dirs() -> Vec<PathBuf> {
    let mut dirs = Vec::new();
    let data_dirs = super::xdg_data_dirs();

    // XDG_DATA_HOME/applications — highest-priority user directory.
    if let Some(data_home) = data_dirs.first() {
        dirs.push(data_home.join("applications"));
    }

    // Flatpak user exports sit between user data home and system dirs.
    // On many systems Flatpak adds this to XDG_DATA_DIRS itself, so the
    // deduplication step below will handle the overlap.
    if let Some(home) = dirs::home_dir() {
        dirs.push(home.join(".local/share/flatpak/exports/share/applications"));
    }

    // XDG_DATA_DIRS/applications — system-level directories.
    for data_dir in data_dirs.iter().skip(1) {
        dirs.push(data_dir.join("applications"));
    }

    // System-level package manager exports (usually not in XDG_DATA_DIRS).
    dirs.push(PathBuf::from("/var/lib/flatpak/exports/share/applications"));
    dirs.push(PathBuf::from("/var/lib/snapd/desktop/applications"));

    // Deduplicate while preserving priority order.
    let mut seen = HashSet::new();
    dirs.retain(|d| seen.insert(d.clone()));

    dirs
}

/// Returns the ordered list of `mimeapps.list` paths to consult, from highest
/// to lowest priority, per the XDG MIME Applications spec.
///
/// The lookup order is:
/// 1. `$XDG_CONFIG_HOME/$desktop-mimeapps.list` (per-desktop user override)
/// 2. `$XDG_CONFIG_HOME/mimeapps.list`
/// 3. `$XDG_CONFIG_DIRS/$desktop-mimeapps.list`
/// 4. `$XDG_CONFIG_DIRS/mimeapps.list`
/// 5. `$XDG_DATA_HOME/applications/$desktop-mimeapps.list`
/// 6. `$XDG_DATA_HOME/applications/mimeapps.list`
/// 7. `$XDG_DATA_DIRS/applications/$desktop-mimeapps.list`
/// 8. `$XDG_DATA_DIRS/applications/mimeapps.list`
pub(super) fn mimeapps_paths() -> Vec<PathBuf> {
    let mut paths = Vec::new();

    // Desktop names (lowercased) for per-desktop filename variants.
    // XDG spec: "$desktop" is each component of XDG_CURRENT_DESKTOP, lowercased.
    let desktops: Vec<String> = super::current_desktops()
        .into_iter()
        .map(|s| s.to_lowercase())
        .collect();

    // ── Config-dir section ────────────────────────────────────────────────────

    // $XDG_CONFIG_HOME defaults to ~/.config
    let config_home = std::env::var("XDG_CONFIG_HOME")
        .map(PathBuf::from)
        .unwrap_or_else(|_| {
            dirs::home_dir()
                .map(|h| h.join(".config"))
                .unwrap_or_default()
        });
    if !config_home.as_os_str().is_empty() {
        for desktop in &desktops {
            paths.push(config_home.join(format!("{desktop}-mimeapps.list")));
        }
        paths.push(config_home.join("mimeapps.list"));
    }

    // $XDG_CONFIG_DIRS defaults to /etc/xdg
    for dir in std::env::var("XDG_CONFIG_DIRS")
        .unwrap_or_else(|_| "/etc/xdg".to_string())
        .split(':')
        .filter(|s| !s.is_empty())
        .map(PathBuf::from)
    {
        for desktop in &desktops {
            paths.push(dir.join(format!("{desktop}-mimeapps.list")));
        }
        paths.push(dir.join("mimeapps.list"));
    }

    // ── Data-dir/applications section ─────────────────────────────────────────

    for data_dir in super::xdg_data_dirs() {
        let apps = data_dir.join("applications");
        for desktop in &desktops {
            paths.push(apps.join(format!("{desktop}-mimeapps.list")));
        }
        paths.push(apps.join("mimeapps.list"));
    }

    paths
}

// ── Desktop entry collection ──────────────────────────────────────────────────

/// Recursively collects `(desktop_id, file_path)` pairs from `dir`.
///
/// Desktop IDs are derived from the path relative to `dir` by replacing the
/// directory separator with `-`, per the XDG Desktop Entry spec:
///   `{dir}/applications/kde/konsole.desktop` → `kde-konsole.desktop`
///
/// Entries are returned in deterministic order (sorted by desktop-id).
fn collect_desktop_entries(dir: &Path) -> Vec<(String, PathBuf)> {
    let mut results = Vec::new();
    collect_desktop_entries_recursive(dir, dir, &mut results);
    // Sort by desktop-id for a stable, deterministic order.
    results.sort_unstable_by(|a, b| a.0.cmp(&b.0));
    results
}

fn collect_desktop_entries_recursive(
    base: &Path,
    current: &Path,
    results: &mut Vec<(String, PathBuf)>,
) {
    let Ok(read_dir) = std::fs::read_dir(current) else {
        return;
    };

    // Sort entries within each directory for determinism before recursing.
    let mut entries: Vec<_> = read_dir.flatten().collect();
    entries.sort_unstable_by_key(|e| e.file_name());

    for entry in entries {
        let path = entry.path();
        // Use path.is_dir() rather than file_type to follow symlinks.
        if path.is_dir() {
            collect_desktop_entries_recursive(base, &path, results);
        } else if path.extension().and_then(|e| e.to_str()) == Some("desktop") {
            let Ok(rel) = path.strip_prefix(base) else {
                continue;
            };
            // Derive desktop-id: join path components with '-'.
            let components: Vec<_> = rel
                .components()
                .map(|c| c.as_os_str().to_string_lossy().into_owned())
                .collect();
            results.push((components.join("-"), path));
        }
    }
}

// ── tests ─────────────────────────────────────────────────────────────────────

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

    fn unique_dir(label: &str) -> PathBuf {
        use std::time::{SystemTime, UNIX_EPOCH};
        let nanos = SystemTime::now()
            .duration_since(UNIX_EPOCH)
            .unwrap_or_default()
            .subsec_nanos();
        std::env::temp_dir().join(format!(
            "elio-scan-test-{label}-{}-{nanos}",
            std::process::id()
        ))
    }

    // ── discover_via_desktop_scan_in_dirs ─────────────────────────────────────

    #[test]
    fn desktop_scan_finds_app_by_exact_mime_type() {
        use std::fs;
        let dir = unique_dir("flat");
        fs::create_dir_all(&dir).expect("create temp dir");

        fs::write(
            dir.join("testeditor.desktop"),
            "[Desktop Entry]\nName=Test Editor\nExec=testeditor %f\nMimeType=text/plain;\n",
        )
        .expect("write desktop file");

        let apps = discover_via_desktop_scan_in_dirs(
            "text/plain",
            Path::new("/tmp/hello.txt"),
            std::slice::from_ref(&dir),
        );
        let _ = fs::remove_dir_all(&dir);

        assert_eq!(apps.len(), 1);
        assert_eq!(apps[0].display_name, "Test Editor");
        assert_eq!(apps[0].program, "testeditor");
        assert_eq!(apps[0].args, vec!["/tmp/hello.txt"]);
    }

    #[test]
    fn desktop_scan_does_not_find_app_by_inherited_mime_type() {
        use std::fs;
        // Documents that the fallback scan does exact matching only.
        // An app listing text/plain will NOT be found for text/markdown.
        let dir = unique_dir("inherit");
        fs::create_dir_all(&dir).expect("create temp dir");

        fs::write(
            dir.join("plaineditor.desktop"),
            "[Desktop Entry]\nName=Plain Editor\nExec=plaineditor %f\nMimeType=text/plain;\n",
        )
        .expect("write desktop file");

        let apps = discover_via_desktop_scan_in_dirs(
            "text/markdown",
            Path::new("/tmp/notes.md"),
            std::slice::from_ref(&dir),
        );
        let _ = fs::remove_dir_all(&dir);

        assert!(
            apps.is_empty(),
            "fallback scan must not infer MIME inheritance — that is gio's job"
        );
    }

    // ── collect_desktop_entries / desktop-id derivation ───────────────────────

    #[test]
    fn flat_desktop_file_gets_basename_as_desktop_id() {
        use std::fs;
        let dir = unique_dir("flat-id");
        fs::create_dir_all(&dir).expect("create dir");
        fs::write(dir.join("gedit.desktop"), "").expect("write file");

        let entries = collect_desktop_entries(&dir);
        let _ = fs::remove_dir_all(&dir);

        assert_eq!(entries.len(), 1);
        assert_eq!(entries[0].0, "gedit.desktop");
    }

    #[test]
    fn subdirectory_desktop_file_gets_path_joined_with_dash() {
        use std::fs;
        let dir = unique_dir("subdir-id");
        fs::create_dir_all(dir.join("kde")).expect("create subdir");
        fs::write(dir.join("kde/konsole.desktop"), "").expect("write file");

        let entries = collect_desktop_entries(&dir);
        let _ = fs::remove_dir_all(&dir);

        assert_eq!(entries.len(), 1);
        assert_eq!(entries[0].0, "kde-konsole.desktop");
    }

    #[test]
    fn deeply_nested_desktop_file_gets_full_path_as_id() {
        use std::fs;
        let dir = unique_dir("deep-id");
        fs::create_dir_all(dir.join("a/b")).expect("create deep dirs");
        fs::write(dir.join("a/b/app.desktop"), "").expect("write file");

        let entries = collect_desktop_entries(&dir);
        let _ = fs::remove_dir_all(&dir);

        assert_eq!(entries.len(), 1);
        assert_eq!(entries[0].0, "a-b-app.desktop");
    }

    #[test]
    fn desktop_scan_finds_app_in_subdirectory() {
        use std::fs;
        let dir = unique_dir("subdir-scan");
        fs::create_dir_all(dir.join("kde")).expect("create subdir");

        fs::write(
            dir.join("kde/konsole.desktop"),
            "[Desktop Entry]\nName=Konsole\nExec=konsole %f\nMimeType=text/plain;\n",
        )
        .expect("write desktop file");

        let apps = discover_via_desktop_scan_in_dirs(
            "text/plain",
            Path::new("/tmp/hello.txt"),
            std::slice::from_ref(&dir),
        );
        let _ = fs::remove_dir_all(&dir);

        assert_eq!(apps.len(), 1);
        assert_eq!(apps[0].display_name, "Konsole");
        assert_eq!(
            apps[0].desktop_id.as_deref(),
            Some("kde-konsole.desktop"),
            "desktop-id must use '-' not '/'"
        );
    }

    #[test]
    fn higher_priority_dir_wins_for_same_desktop_id() {
        use std::fs;
        let dir1 = unique_dir("priority-high");
        let dir2 = unique_dir("priority-low");
        fs::create_dir_all(&dir1).expect("create dir1");
        fs::create_dir_all(&dir2).expect("create dir2");

        fs::write(
            dir1.join("app.desktop"),
            "[Desktop Entry]\nName=High Priority\nExec=app %f\nMimeType=text/plain;\n",
        )
        .expect("write high");
        fs::write(
            dir2.join("app.desktop"),
            "[Desktop Entry]\nName=Low Priority\nExec=app %f\nMimeType=text/plain;\n",
        )
        .expect("write low");

        let apps = discover_via_desktop_scan_in_dirs(
            "text/plain",
            Path::new("/tmp/file.txt"),
            &[dir1.clone(), dir2.clone()],
        );
        let _ = fs::remove_dir_all(&dir1);
        let _ = fs::remove_dir_all(&dir2);

        assert_eq!(
            apps.len(),
            1,
            "same desktop-id should not produce duplicates"
        );
        assert_eq!(apps[0].display_name, "High Priority");
    }

    #[test]
    fn removed_associations_are_filtered_out() {
        use std::fs;
        let apps_dir = unique_dir("removed-assoc");
        let mime_dir = unique_dir("removed-assoc-mime");
        fs::create_dir_all(&apps_dir).expect("create apps dir");
        fs::create_dir_all(&mime_dir).expect("create mime dir");

        fs::write(
            apps_dir.join("suppressed.desktop"),
            "[Desktop Entry]\nName=Suppressed\nExec=suppressed %f\nMimeType=text/plain;\n",
        )
        .expect("write suppressed desktop");
        fs::write(
            apps_dir.join("allowed.desktop"),
            "[Desktop Entry]\nName=Allowed\nExec=allowed %f\nMimeType=text/plain;\n",
        )
        .expect("write allowed desktop");
        let mimeapps = mime_dir.join("mimeapps.list");
        fs::write(
            &mimeapps,
            "[Removed Associations]\ntext/plain=suppressed.desktop;\n",
        )
        .expect("write mimeapps.list");

        let apps = discover_via_desktop_scan_inner(
            "text/plain",
            Path::new("/tmp/file.txt"),
            std::slice::from_ref(&apps_dir),
            std::slice::from_ref(&mimeapps),
        );
        let _ = fs::remove_dir_all(&apps_dir);
        let _ = fs::remove_dir_all(&mime_dir);

        let names: Vec<&str> = apps.iter().map(|a| a.display_name.as_str()).collect();
        assert!(
            !names.contains(&"Suppressed"),
            "suppressed.desktop must be filtered out by [Removed Associations]"
        );
        assert!(
            names.contains(&"Allowed"),
            "allowed.desktop must still appear"
        );
    }

    #[test]
    fn only_first_default_gets_is_default_true() {
        use std::fs;
        let apps_dir = unique_dir("multi-default");
        let mime_dir = unique_dir("multi-default-mime");
        fs::create_dir_all(&apps_dir).expect("create apps dir");
        fs::create_dir_all(&mime_dir).expect("create mime dir");

        for name in &["alpha", "beta", "gamma"] {
            fs::write(
                apps_dir.join(format!("{name}.desktop")),
                format!(
                    "[Desktop Entry]\nName={cap}\nExec={name} %f\nMimeType=text/plain;\n",
                    cap = name[..1].to_uppercase() + &name[1..]
                ),
            )
            .expect("write desktop");
        }
        let mimeapps = mime_dir.join("mimeapps.list");
        fs::write(
            &mimeapps,
            "[Default Applications]\ntext/plain=alpha.desktop;beta.desktop;gamma.desktop;\n",
        )
        .expect("write mimeapps.list");

        let apps = discover_via_desktop_scan_inner(
            "text/plain",
            Path::new("/tmp/file.txt"),
            std::slice::from_ref(&apps_dir),
            std::slice::from_ref(&mimeapps),
        );
        let _ = fs::remove_dir_all(&apps_dir);
        let _ = fs::remove_dir_all(&mime_dir);

        assert_eq!(apps.len(), 3);
        let defaults: Vec<_> = apps.iter().filter(|a| a.is_default).collect();
        assert_eq!(
            defaults.len(),
            1,
            "exactly one app should be is_default=true"
        );
        assert_eq!(
            defaults[0].display_name, "Alpha",
            "first declared default wins"
        );
    }

    #[test]
    fn non_desktop_files_in_scan_dirs_are_ignored() {
        use std::fs;
        let dir = unique_dir("non-desktop");
        fs::create_dir_all(&dir).expect("create dir");
        fs::write(dir.join("README.md"), "not a desktop file").expect("write readme");
        fs::write(dir.join("app.txt"), "also not a desktop file").expect("write txt");
        fs::write(
            dir.join("real.desktop"),
            "[Desktop Entry]\nName=Real\nExec=real %f\nMimeType=text/plain;\n",
        )
        .expect("write desktop");

        let apps = discover_via_desktop_scan_in_dirs(
            "text/plain",
            Path::new("/tmp/file.txt"),
            std::slice::from_ref(&dir),
        );
        let _ = fs::remove_dir_all(&dir);

        assert_eq!(apps.len(), 1);
        assert_eq!(apps[0].display_name, "Real");
    }
}