appx 0.1.0

Managing appx packages
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

use crate::reg;
use crate::WString;

use std::fmt::{self, Display, Formatter};
use std::io;
use std::ops::Deref;
use std::path::PathBuf;



/// e.g. `NcsiUwpApp_1000.19041.423.0_neutral_neutral_8wekyb3d8bbwe` -
/// A specific appx package.
///
/// This is comprised of the following underscore separated fields:
///
/// | Field             | Example               | Example |
/// | ----------------- | --------------------- | ------- |
/// | `Name`            | `NcsiUwpApp`          | `CanonicalGroupLimited.Ubuntu20.04onWindows`
/// | `Version`         | `1000.19041.423.0`    | `2004.2020.812.0`
/// | `Architecture`    | `neutral`             | `x64`
/// | ???               | `neutral`             | (blank), `split.scale-100`
/// | `PublisherId`     | `8wekyb3d8bbwe`       | `79rhkp1fndgsc`
///
/// ### Examples
///
/// * `NcsiUwpApp_1000.19041.423.0_neutral_neutral_8wekyb3d8bbwe`
/// * `CanonicalGroupLimited.UbuntuonWindows_2004.2020.812.0_x64__79rhkp1fndgsc`
/// * `CanonicalGroupLimited.Ubuntu16.04onWindows_1604.2020.824.0_x64__79rhkp1fndgsc`
/// * `CanonicalGroupLimited.Ubuntu18.04onWindows_1804.2020.824.0_x64__79rhkp1fndgsc`
/// * `CanonicalGroupLimited.Ubuntu20.04onWindows_2004.2020.812.0_x64__79rhkp1fndgsc`
/// * `CanonicalGroupLimited.Ubuntu20.04onWindows_2004.2020.812.0_neutral_split.scale-100_79rhkp1fndgsc`
///
/// ### Corresponds to
///
/// `powershell Get-AppxPackage ^| Format-Table -Property PackageFullName`<br>
/// `HKCR\Local Settings\Software\Microsoft\Windows\CurrentVersion\AppModel\Repository\Packages\...`<br>
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)] pub struct PackageFullName(pub(crate) WString);

impl Deref              for PackageFullName { fn deref(&self) -> &Self::Target { &self.0 } type Target = WString; }
impl Display            for PackageFullName { fn fmt(&self, fmt: &mut Formatter) -> fmt::Result { Display::fmt(&self.0.display(), fmt) } }
impl From<&String  >    for PackageFullName { fn from(value: &String  ) -> Self { Self(WString::from(value)) } }
impl From< String  >    for PackageFullName { fn from(value:  String  ) -> Self { Self(WString::from(value)) } }
impl From<&str     >    for PackageFullName { fn from(value: &str     ) -> Self { Self(WString::from(value)) } }
impl From<&   [u16]>    for PackageFullName { fn from(value: &   [u16]) -> Self { Self(WString::from(value)) } }
impl From<&Vec<u16>>    for PackageFullName { fn from(value: &Vec<u16>) -> Self { Self(WString::from(value)) } }
impl From< Vec<u16>>    for PackageFullName { fn from(value:  Vec<u16>) -> Self { Self(WString::from(value)) } }

impl PackageFullName {
    pub fn new(pfn: impl Into<Self>) -> Self { pfn.into() }

    /// Package `Name`
    ///
    /// ### Examples
    ///
    /// * `NcsiUwpApp`
    /// * `CanonicalGroupLimited.Ubuntu20.04onWindows`
    pub fn name(&self) -> &[u16] { self.field(0) }

    /// Package `Version`
    ///
    /// ### Examples
    ///
    /// * `1000.19041.423.0`
    /// * `2004.2020.812.0`
    pub fn version(&self) -> &[u16] { self.field(1) }

    /// Package `Architecture`
    ///
    /// ### Examples
    ///
    /// * `x64`
    /// * `neutral`
    pub fn architecture(&self) -> &[u16] { self.field(2) }

    /// ???
    ///
    /// ### Examples
    ///
    /// * (blank)
    /// * `neutral`         (`ResourceId`?)
    /// * `split.scale-100` (**not** `ResourceId`)
    #[allow(dead_code)] // TODO: name
    fn field4(&self) -> &[u16] { self.field(3) }

    /// Package `PublisherId`
    ///
    /// ### Examples
    ///
    /// * `8wekyb3d8bbwe`
    /// * `79rhkp1fndgsc`
    pub fn publisher_id(&self) -> &[u16] { self.field(4) }

    fn field(&self, n: usize) -> &[u16] { self.0.units().splitn(5, |&cu| cu == u16::from(b'_')).skip(n).next().unwrap_or(&[]) }
}

impl PackageFullName {
    fn key_packages() -> io::Result<reg::Key> { reg::Key::hkcr(winstr0!(r"Local Settings\Software\Microsoft\Windows\CurrentVersion\AppModel\Repository\Packages"), reg::Options::NONE, reg::SAM::READ_ONLY) }

    // `CapabilityCount` - parse w/ `CapabilitySids` instead?
    // pub fn capability_count(&self) -> io::Result<u32> { ... }
    
    // `CapabilitySids` - format?
    // pub fn capability_sids(&self) -> io::Result<Vec<u8>> { ... }
    
    /// `DisplayName`
    pub fn display_name(&self) -> io::Result<String> { key_packages()?.get_value_string(Some(self.units0()), Some(winstr0!("DisplayName")), &mut temp_vec(64 * 1024)) }

    /// `OSMaxVersionTested`
    pub fn os_max_version_tested(&self) -> io::Result<u64> { key_packages()?.get_value_qword(Some(self.units0()), Some(winstr0!("OSMaxVersionTested"))) }

    /// `OSMinVersion`
    pub fn os_min_version(&self) -> io::Result<u64> { key_packages()?.get_value_qword(Some(self.units0()), Some(winstr0!("OSMinVersion"))) }

    // `PackageId`
    // pub fn package_id(&self) -> io::Result<OsString> { ... } - is a reg key, but already implied from the PFN

    /// `PackageRootFolder` (registry)
    /// `InstallLocation` (powershell)
    pub fn package_root_folder(&self) -> io::Result<PathBuf> { Self::key_packages()?.get_value_pathbuf(Some(self.units0()), Some(winstr0!("PackageRootFolder")), &mut temp_vec(64 * 1024)) }

    /// `PackageRootFolder` (registry)
    /// `InstallLocation` (powershell)
    pub fn install_location(&self) -> io::Result<PathBuf> { self.package_root_folder() }

    // `PackageSid` - don't have REG_BINARY APIs (yet)
    //pub fn package_sid(&self) -> io::Result<Vec<u8>> {
    //}

    /// `SupportedUsers`
    pub fn supported_users(&self) -> io::Result<u32> { key_packages()?.get_value_dword(Some(self.units0()), Some(winstr0!("SupportedUsers"))) }
}

fn key_packages() -> io::Result<reg::Key> { reg::Key::hkcr(winstr0!(r"Local Settings\Software\Microsoft\Windows\CurrentVersion\AppModel\Repository\Packages"), reg::Options::NONE, reg::SAM::READ_ONLY) }

fn temp_vec<T: Copy + Default>(n: usize) -> Vec<T> {
    let mut v = Vec::new();
    v.resize(n, Default::default());
    v
}

#[test] fn test_pfn() {
    let pfn = PackageFullName::from("NcsiUwpApp_1000.19041.423.0_neutral_neutral_8wekyb3d8bbwe");
    assert_eq!(pfn.name(),          wchar::wch!("NcsiUwpApp"));
    assert_eq!(pfn.version(),       wchar::wch!("1000.19041.423.0"));
    assert_eq!(pfn.architecture(),  wchar::wch!("neutral"));
    assert_eq!(pfn.field4(),        wchar::wch!("neutral"));
    assert_eq!(pfn.publisher_id(),  wchar::wch!("8wekyb3d8bbwe"));

    if pfn.display_name().is_ok() { 
        assert_eq!(pfn.display_name().unwrap(),                 "NcsiUwpApp");
        assert_eq!(pfn.package_root_folder().unwrap(),          PathBuf::from(r"C:\WINDOWS\SystemApps\NcsiUwpApp_8wekyb3d8bbwe"));
        assert_eq!(pfn.install_location().unwrap(),             PathBuf::from(r"C:\WINDOWS\SystemApps\NcsiUwpApp_8wekyb3d8bbwe"));
        assert!(   pfn.supported_users().unwrap_or(0)           >= 1);

        if std::env::var("COMPUTERNAME").map_or(false, |cn| cn == "SACRILEGE") {
            assert!(pfn.os_max_version_tested().unwrap_or(0)    >= 0x03E8_4A61_01A7_0000);
            assert!(pfn.os_min_version().unwrap_or(0)           >= 0x000A_0000_0000_0000);
        }
    }

    let pfn = PackageFullName::from("CanonicalGroupLimited.UbuntuonWindows_2004.2020.812.0_x64__79rhkp1fndgsc");
    assert_eq!(pfn.name(),          wchar::wch!("CanonicalGroupLimited.UbuntuonWindows"));
    assert_eq!(pfn.version(),       wchar::wch!("2004.2020.812.0"));
    assert_eq!(pfn.architecture(),  wchar::wch!("x64"));
    assert_eq!(pfn.field4(),        wchar::wch!(""));
    assert_eq!(pfn.publisher_id(),  wchar::wch!("79rhkp1fndgsc"));
}