sk-desktop 0.4.0

Skathi's desktop integration: argv, shell, single instance, custom protocols and the tray
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
//! Per-user protocol registration in the registry.
//!
//! ```text
//!   HKCU\Software\Classes\<scheme>
//!     (Default)                  = "URL:<scheme>"
//!     URL Protocol               = ""
//!     VnOwner                    = "<app id>"         ← the ownership marker
//!     DefaultIcon\(Default)      = "\"<exe>\",0"
//!     shell\open\command\(Default) = "\"<exe>\" [--sk-dist \"<slot>\"] --sk-protocol-launch -- \"%1\""
//! ```
//!
//! HKCU only. A scheme that already exists without our marker (in HKCU or HKLM) is another app's and is
//! never overwritten: registering it is a TypeError naming the owner. Writes are idempotent.

use std::ptr::{null, null_mut};

use windows_sys::Win32::Foundation::{
    ERROR_FILE_NOT_FOUND, ERROR_NO_MORE_ITEMS, ERROR_SUCCESS, WIN32_ERROR,
};
use windows_sys::Win32::Storage::Packaging::Appx::GetCurrentPackageFullName;
use windows_sys::Win32::System::Registry::{
    RegCloseKey, RegCreateKeyExW, RegDeleteTreeW, RegEnumKeyExW, RegOpenKeyExW, RegQueryValueExW,
    RegSetValueExW, HKEY, HKEY_CURRENT_USER, HKEY_LOCAL_MACHINE, KEY_READ, KEY_WRITE,
    REG_OPTION_NON_VOLATILE, REG_SZ,
};
use windows_sys::Win32::UI::Shell::{SHChangeNotify, SHCNE_ASSOCCHANGED, SHCNF_IDLIST};

use super::instance_win::wide;
use super::protocol::{command_line, command_targets};

fn notify_assoc_changed() {
    unsafe { SHChangeNotify(SHCNE_ASSOCCHANGED as i32, SHCNF_IDLIST, null(), null()) };
}

pub const OWNER_VALUE: &str = "VnOwner";

#[derive(Debug, Clone)]
pub struct Hive {
    pub classes: String,
    pub machine: Option<String>,
    pub notify: bool,
}

impl Hive {
    pub fn user() -> Hive {
        Hive {
            classes: r"Software\Classes".into(),
            machine: Some(r"Software\Classes".into()),
            notify: true,
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum Status {
    Absent,
    Ours { command: String },
    Foreign { owner: String },
}

struct Key(HKEY);
impl Drop for Key {
    fn drop(&mut self) {
        unsafe {
            RegCloseKey(self.0);
        }
    }
}

fn open(root: HKEY, path: &str, write: bool) -> Result<Option<Key>, WIN32_ERROR> {
    let mut h: HKEY = null_mut();
    let r = unsafe {
        RegOpenKeyExW(
            root,
            wide(path).as_ptr(),
            0,
            if write {
                KEY_READ | KEY_WRITE
            } else {
                KEY_READ
            },
            &mut h,
        )
    };
    if r == ERROR_SUCCESS {
        Ok(Some(Key(h)))
    } else if r == ERROR_FILE_NOT_FOUND {
        Ok(None)
    } else {
        Err(r)
    }
}

fn create(root: HKEY, path: &str) -> Result<Key, WIN32_ERROR> {
    let mut h: HKEY = null_mut();
    let r = unsafe {
        RegCreateKeyExW(
            root,
            wide(path).as_ptr(),
            0,
            null(),
            REG_OPTION_NON_VOLATILE,
            KEY_READ | KEY_WRITE,
            null(),
            &mut h,
            null_mut(),
        )
    };
    if r == ERROR_SUCCESS {
        Ok(Key(h))
    } else {
        Err(r)
    }
}

fn read_sz(key: &Key, name: &str) -> Option<String> {
    let name = wide(name);
    let mut ty = 0;
    let mut len = 0u32;
    if unsafe { RegQueryValueExW(key.0, name.as_ptr(), null(), &mut ty, null_mut(), &mut len) }
        != ERROR_SUCCESS
    {
        return None;
    }
    if ty != REG_SZ {
        return Some(String::new());
    }
    let mut buf = vec![0u8; len as usize + 2];
    let mut len2 = buf.len() as u32;
    if unsafe {
        RegQueryValueExW(
            key.0,
            name.as_ptr(),
            null(),
            null_mut(),
            buf.as_mut_ptr(),
            &mut len2,
        )
    } != ERROR_SUCCESS
    {
        return None;
    }
    let wide: Vec<u16> = buf[..len2 as usize]
        .chunks_exact(2)
        .map(|c| u16::from_le_bytes([c[0], c[1]]))
        .collect();
    let end = wide.iter().position(|&c| c == 0).unwrap_or(wide.len());
    Some(String::from_utf16_lossy(&wide[..end]))
}

fn write_sz(key: &Key, name: &str, value: &str) -> Result<bool, WIN32_ERROR> {
    if read_sz(key, name).as_deref() == Some(value) {
        return Ok(false);
    }
    let mut bytes: Vec<u8> = value.encode_utf16().flat_map(u16::to_le_bytes).collect();
    bytes.extend_from_slice(&[0, 0]);
    let r = unsafe {
        RegSetValueExW(
            key.0,
            wide(name).as_ptr(),
            0,
            REG_SZ,
            bytes.as_ptr(),
            bytes.len() as u32,
        )
    };
    if r == ERROR_SUCCESS {
        Ok(true)
    } else {
        Err(r)
    }
}

fn describe_owner(key: &Key, scheme: &str) -> String {
    if let Some(owner) = read_sz(key, OWNER_VALUE).filter(|o| !o.is_empty()) {
        return format!("the Skathi app \"{owner}\"");
    }
    match read_sz(key, "")
        .filter(|d| !d.is_empty() && !d.eq_ignore_ascii_case(&format!("URL:{scheme}")))
    {
        Some(desc) => format!("another application (\"{desc}\")"),
        None => "another application".into(),
    }
}

pub fn status(hive: &Hive, scheme: &str, id: &str) -> Result<Status, String> {
    let path = format!(r"{}\{scheme}", hive.classes);
    match open(HKEY_CURRENT_USER, &path, false)
        .map_err(|e| format!("reading HKCU\\{path}: {e:?}"))?
    {
        Some(key) => {
            if read_sz(&key, OWNER_VALUE).as_deref() == Some(id) {
                let command = open(
                    HKEY_CURRENT_USER,
                    &format!(r"{path}\shell\open\command"),
                    false,
                )
                .ok()
                .flatten()
                .and_then(|k| read_sz(&k, ""))
                .unwrap_or_default();
                Ok(Status::Ours { command })
            } else {
                Ok(Status::Foreign {
                    owner: describe_owner(&key, scheme),
                })
            }
        }
        None => {
            if let Some(machine) = &hive.machine {
                let mpath = format!(r"{machine}\{scheme}");
                if let Ok(Some(_)) = open(HKEY_LOCAL_MACHINE, &mpath, false) {
                    return Ok(Status::Foreign {
                        owner: "a machine-wide registration (HKLM)".into(),
                    });
                }
            }
            Ok(Status::Absent)
        }
    }
}

pub fn register(
    hive: &Hive,
    scheme: &str,
    id: &str,
    exe: &str,
    dev_slot: Option<&str>,
) -> Result<bool, String> {
    if let Status::Foreign { owner } = status(hive, scheme, id)? {
        return Err(format!("the \"{scheme}\" scheme is registered to {owner}; Skathi never takes over another app's scheme"));
    }
    let path = format!(r"{}\{scheme}", hive.classes);
    let fail = |what: &str, e: WIN32_ERROR| format!("writing HKCU\\{path}{what}: {e:?}");
    let root = create(HKEY_CURRENT_USER, &path).map_err(|e| fail("", e))?;
    let mut wrote = false;
    wrote |= write_sz(&root, OWNER_VALUE, id).map_err(|e| fail("", e))?;
    wrote |= write_sz(&root, "", &format!("URL:{scheme}")).map_err(|e| fail("", e))?;
    wrote |= write_sz(&root, "URL Protocol", "").map_err(|e| fail("", e))?;
    let icon = create(HKEY_CURRENT_USER, &format!(r"{path}\DefaultIcon"))
        .map_err(|e| fail(r"\DefaultIcon", e))?;
    wrote |= write_sz(&icon, "", &format!("\"{exe}\",0")).map_err(|e| fail(r"\DefaultIcon", e))?;
    let cmd = create(HKEY_CURRENT_USER, &format!(r"{path}\shell\open\command"))
        .map_err(|e| fail(r"\shell\open\command", e))?;
    wrote |= write_sz(&cmd, "", &command_line(exe, dev_slot))
        .map_err(|e| fail(r"\shell\open\command", e))?;
    if wrote && hive.notify {
        notify_assoc_changed();
    }
    Ok(wrote)
}

pub fn is_registered(hive: &Hive, scheme: &str, id: &str, exe: &str) -> bool {
    matches!(status(hive, scheme, id), Ok(Status::Ours { command }) if command_targets(&command, exe))
}

fn delete(hive: &Hive, scheme: &str) -> bool {
    let Ok(Some(classes)) = open(HKEY_CURRENT_USER, &hive.classes, true) else {
        return false;
    };
    let ok = unsafe { RegDeleteTreeW(classes.0, wide(scheme).as_ptr()) } == ERROR_SUCCESS;
    if ok && hive.notify {
        notify_assoc_changed();
    }
    ok
}

pub fn unregister(hive: &Hive, scheme: &str, id: &str, exe: &str) -> bool {
    is_registered(hive, scheme, id, exe) && delete(hive, scheme)
}

pub fn unregister_all(hive: &Hive, id: &str) -> Vec<String> {
    let Ok(Some(classes)) = open(HKEY_CURRENT_USER, &hive.classes, false) else {
        return Vec::new();
    };
    let mut ours = Vec::new();
    let mut i = 0u32;
    loop {
        let mut name = vec![0u16; 256];
        let mut len = name.len() as u32;
        let r = unsafe {
            RegEnumKeyExW(
                classes.0,
                i,
                name.as_mut_ptr(),
                &mut len,
                null(),
                null_mut(),
                null_mut(),
                null_mut(),
            )
        };
        if r == ERROR_NO_MORE_ITEMS {
            break;
        }
        i += 1;
        if r != ERROR_SUCCESS {
            continue;
        }
        let sub = String::from_utf16_lossy(&name[..len as usize]);
        if sub.starts_with('.') || sub.starts_with('{') {
            continue;
        }
        if let Ok(Some(k)) = open(
            HKEY_CURRENT_USER,
            &format!(r"{}\{sub}", hive.classes),
            false,
        ) {
            if read_sz(&k, OWNER_VALUE).as_deref() == Some(id) {
                ours.push(sub);
            }
        }
    }
    drop(classes);
    ours.into_iter().filter(|s| delete(hive, s)).collect()
}

/// Under MSIX package identity HKCU\Classes writes are virtualised and register nothing.
pub fn has_package_identity() -> bool {
    let mut len = 0u32;
    let r = unsafe { GetCurrentPackageFullName(&mut len, std::ptr::null_mut()) };
    r == 122
}

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

    struct Scratch(Hive, String);
    impl Scratch {
        fn new(tag: &str) -> Scratch {
            let base = format!(r"Software\skathi-test-{}-{tag}", std::process::id());
            let hive = Hive {
                classes: format!(r"{base}\Classes"),
                machine: None,
                notify: false,
            };
            create(HKEY_CURRENT_USER, &hive.classes).expect("scratch hive");
            Scratch(hive, base)
        }
    }
    impl Drop for Scratch {
        fn drop(&mut self) {
            if let Ok(Some(sw)) = open(HKEY_CURRENT_USER, "Software", true) {
                let name = self.1.trim_start_matches(r"Software\");
                unsafe {
                    RegDeleteTreeW(sw.0, wide(name).as_ptr());
                }
            }
            assert!(
                matches!(open(HKEY_CURRENT_USER, &self.1, false), Ok(None)),
                "the scratch hive HKCU\\{} must be gone",
                self.1
            );
        }
    }

    const EXE: &str = r"C:\Program Files\Notes\Notes.exe";

    #[test]
    fn register_writes_the_documented_shape_and_is_idempotent() {
        let s = Scratch::new("shape");
        assert_eq!(status(&s.0, "vntest", "gl.argon.notes"), Ok(Status::Absent));
        assert_eq!(
            register(&s.0, "vntest", "gl.argon.notes", EXE, None),
            Ok(true)
        );
        assert_eq!(
            register(&s.0, "vntest", "gl.argon.notes", EXE, None),
            Ok(false),
            "nothing changed, nothing written"
        );
        let root = open(
            HKEY_CURRENT_USER,
            &format!(r"{}\vntest", s.0.classes),
            false,
        )
        .unwrap()
        .unwrap();
        assert_eq!(read_sz(&root, "").as_deref(), Some("URL:vntest"));
        assert_eq!(read_sz(&root, "URL Protocol").as_deref(), Some(""));
        assert_eq!(
            read_sz(&root, OWNER_VALUE).as_deref(),
            Some("gl.argon.notes")
        );
        let icon = open(
            HKEY_CURRENT_USER,
            &format!(r"{}\vntest\DefaultIcon", s.0.classes),
            false,
        )
        .unwrap()
        .unwrap();
        assert_eq!(read_sz(&icon, "").unwrap(), format!("\"{EXE}\",0"));
        assert_eq!(
            status(&s.0, "vntest", "gl.argon.notes"),
            Ok(Status::Ours {
                command: command_line(EXE, None)
            })
        );
        assert!(is_registered(&s.0, "vntest", "gl.argon.notes", EXE));
        let moved = r"D:\Notes\Notes.exe";
        assert!(!is_registered(&s.0, "vntest", "gl.argon.notes", moved));
        assert_eq!(
            register(&s.0, "vntest", "gl.argon.notes", moved, Some(r"C:\slot")),
            Ok(true)
        );
        assert!(is_registered(&s.0, "vntest", "gl.argon.notes", moved));
    }

    #[test]
    fn a_foreign_scheme_is_never_overwritten() {
        let s = Scratch::new("foreign");
        let k = create(HKEY_CURRENT_USER, &format!(r"{}\other", s.0.classes)).unwrap();
        write_sz(&k, "", "URL:Other App Protocol").unwrap();
        drop(k);
        assert!(register(&s.0, "other", "gl.argon.notes", EXE, None).is_err());
        assert!(
            !unregister(&s.0, "other", "gl.argon.notes", EXE),
            "and never deleted"
        );
        assert!(
            open(HKEY_CURRENT_USER, &format!(r"{}\other", s.0.classes), false)
                .unwrap()
                .is_some()
        );
        register(&s.0, "theirs", "gl.argon.other", EXE, None).unwrap();
        assert!(register(&s.0, "theirs", "gl.argon.notes", EXE, None).is_err());
    }

    #[test]
    fn unregister_needs_our_marker_and_our_exe() {
        let s = Scratch::new("unreg");
        register(&s.0, "vntest", "gl.argon.notes", EXE, None).unwrap();
        assert!(
            !unregister(&s.0, "vntest", "gl.argon.notes", r"D:\elsewhere\Notes.exe"),
            "another copy's"
        );
        assert!(
            !unregister(&s.0, "vntest", "gl.argon.other", EXE),
            "another app's"
        );
        assert!(unregister(&s.0, "vntest", "gl.argon.notes", EXE));
        assert_eq!(status(&s.0, "vntest", "gl.argon.notes"), Ok(Status::Absent));
        assert!(
            !unregister(&s.0, "vntest", "gl.argon.notes", EXE),
            "already gone"
        );
    }

    #[test]
    fn unregister_all_takes_exactly_our_keys() {
        let s = Scratch::new("all");
        register(&s.0, "one", "gl.argon.notes", EXE, None).unwrap();
        register(&s.0, "two", "gl.argon.notes", r"D:\moved\Notes.exe", None).unwrap();
        register(&s.0, "three", "gl.argon.other", EXE, None).unwrap();
        create(HKEY_CURRENT_USER, &format!(r"{}\.txt", s.0.classes)).unwrap();
        let mut gone = unregister_all(&s.0, "gl.argon.notes");
        gone.sort();
        assert_eq!(gone, vec!["one".to_string(), "two".to_string()]);
        assert!(matches!(
            status(&s.0, "three", "gl.argon.other"),
            Ok(Status::Ours { .. })
        ));
    }
}