rmcl 0.3.1

A fully featured Minecraft TUI launcher
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
// mojang rule evaluation. profiles, libraries, and argument entries can
// carry conditional rules that filter them by OS, architecture, or feature
// flags. this module is the single source of truth for that semantics -
// see `evaluate` below for the exact rules.

use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Serialize)]
#[serde(rename_all = "lowercase")]
pub enum RuleAction {
    Allow,
    Disallow,
}

#[derive(Debug, Clone, PartialEq, Eq, Default, Deserialize, Serialize)]
pub struct OsCondition {
    pub name: Option<String>,
    pub arch: Option<String>,
    // mojang occasionally constrains natives selection on os.version with a
    // regex. rare in practice - when present, it's a substring/anchor match
    // against the host OS version reported by `system::mojang_os_version`.
    pub version: Option<String>,
}

#[derive(Debug, Clone, PartialEq, Eq, Default, Deserialize, Serialize)]
#[serde(rename_all = "snake_case")]
pub struct FeatureSet {
    pub is_demo_user: Option<bool>,
    pub has_custom_resolution: Option<bool>,
    // quick-play feature flags (1.20+). rmcl never sets these, so any rule
    // gated on them is filtered out by features_match. listing them
    // explicitly is what makes that filter work: without the fields,
    // serde would silently drop them during deserialization, leaving a
    // FeatureSet::default that matches everything.
    pub has_quick_plays_support: Option<bool>,
    pub is_quick_play_singleplayer: Option<bool>,
    pub is_quick_play_multiplayer: Option<bool>,
    pub is_quick_play_realms: Option<bool>,
}

#[derive(Debug, Clone, PartialEq, Eq, Deserialize, Serialize)]
pub struct Rule {
    pub action: RuleAction,
    pub os: Option<OsCondition>,
    pub features: Option<FeatureSet>,
}

pub struct RuleContext<'a> {
    pub os_name: &'a str,
    pub os_version: &'a str,
    pub arch: &'a str,
    pub features: &'a FeatureSet,
}

pub fn evaluate(rules: &[Rule], ctx: &RuleContext) -> bool {
    if rules.is_empty() {
        return true;
    }
    let mut allowed = false;
    for rule in rules {
        if rule_matches(rule, ctx) {
            allowed = matches!(rule.action, RuleAction::Allow);
        }
    }
    allowed
}

fn rule_matches(rule: &Rule, ctx: &RuleContext) -> bool {
    if let Some(os) = &rule.os {
        if let Some(name) = &os.name
            && name != ctx.os_name
        {
            return false;
        }
        if let Some(arch) = &os.arch
            && arch != ctx.arch
        {
            return false;
        }
        if let Some(pattern) = &os.version
            && !os_version_matches(pattern, ctx.os_version)
        {
            return false;
        }
    }
    if let Some(required) = &rule.features
        && !features_match(required, ctx.features)
    {
        return false;
    }
    true
}

// mojang's os.version constraints are typically anchored regex patterns
// (e.g. `^10\\.`). we do a substring containment check as a defensive
// approximation that doesn't pull in the `regex` crate. when the host
// os_version is empty (Windows fallback path returns ""), version-gated
// rules don't match - which is the conservative default.
fn os_version_matches(pattern: &str, host_version: &str) -> bool {
    if host_version.is_empty() {
        return false;
    }
    // strip common regex anchors and metacharacters for substring lookup.
    // good enough for the rare profile that uses os.version.
    let needle = pattern
        .trim_start_matches('^')
        .trim_end_matches('$')
        .trim_end_matches('.')
        .trim_end_matches('\\');
    host_version.contains(needle)
}

fn features_match(required: &FeatureSet, current: &FeatureSet) -> bool {
    let pairs = [
        (required.is_demo_user, current.is_demo_user),
        (required.has_custom_resolution, current.has_custom_resolution),
        (
            required.has_quick_plays_support,
            current.has_quick_plays_support,
        ),
        (
            required.is_quick_play_singleplayer,
            current.is_quick_play_singleplayer,
        ),
        (
            required.is_quick_play_multiplayer,
            current.is_quick_play_multiplayer,
        ),
        (required.is_quick_play_realms, current.is_quick_play_realms),
    ];
    pairs.iter().all(|(req, cur)| match req {
        Some(want) => cur.unwrap_or(false) == *want,
        None => true,
    })
}

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

    fn linux_ctx<'a>(features: &'a FeatureSet) -> RuleContext<'a> {
        RuleContext {
            os_name: "linux",
            os_version: "6.0",
            arch: "x86_64",
            features,
        }
    }

    #[test]
    fn empty_rules_allow() {
        let features = FeatureSet::default();
        let ctx = linux_ctx(&features);
        assert!(evaluate(&[], &ctx));
    }

    #[test]
    fn single_allow_matching_os_allows() {
        let rules = vec![Rule {
            action: RuleAction::Allow,
            os: Some(OsCondition {
                name: Some("linux".into()),
                arch: None,
                ..Default::default()
            }),
            features: None,
        }];
        let features = FeatureSet::default();
        let ctx = linux_ctx(&features);
        assert!(evaluate(&rules, &ctx));
    }

    #[test]
    fn single_disallow_matching_os_disallows() {
        let rules = vec![Rule {
            action: RuleAction::Disallow,
            os: Some(OsCondition {
                name: Some("linux".into()),
                arch: None,
                ..Default::default()
            }),
            features: None,
        }];
        let features = FeatureSet::default();
        let ctx = linux_ctx(&features);
        assert!(!evaluate(&rules, &ctx));
    }

    #[test]
    fn allow_without_os_match_disallows_by_default() {
        // explicit allow for windows; we are on linux; nothing matches;
        // default state remains disallow.
        let rules = vec![Rule {
            action: RuleAction::Allow,
            os: Some(OsCondition {
                name: Some("windows".into()),
                arch: None,
                ..Default::default()
            }),
            features: None,
        }];
        let features = FeatureSet::default();
        let ctx = linux_ctx(&features);
        assert!(!evaluate(&rules, &ctx));
    }

    #[test]
    fn last_matching_rule_wins_when_allow_then_disallow() {
        let rules = vec![
            Rule {
                action: RuleAction::Allow,
                os: None,
                features: None,
            },
            Rule {
                action: RuleAction::Disallow,
                os: Some(OsCondition {
                    name: Some("osx".into()),
                    arch: None,
                    ..Default::default()
                }),
                features: None,
            },
        ];
        let features = FeatureSet::default();
        let osx_ctx = RuleContext {
            os_name: "osx",
            os_version: "6.0",
            arch: "x86_64",
            features: &features,
        };
        assert!(!evaluate(&rules, &osx_ctx));
        // and on linux: only the first rule matches → still allow.
        let lin = linux_ctx(&features);
        assert!(evaluate(&rules, &lin));
    }

    #[test]
    fn last_matching_rule_wins_when_disallow_then_allow() {
        let rules = vec![
            Rule {
                action: RuleAction::Disallow,
                os: None,
                features: None,
            },
            Rule {
                action: RuleAction::Allow,
                os: Some(OsCondition {
                    name: Some("linux".into()),
                    arch: None,
                    ..Default::default()
                }),
                features: None,
            },
        ];
        let features = FeatureSet::default();
        let ctx = linux_ctx(&features);
        assert!(evaluate(&rules, &ctx));
    }

    #[test]
    fn arch_mismatch_blocks_rule() {
        let rules = vec![Rule {
            action: RuleAction::Allow,
            os: Some(OsCondition {
                name: Some("linux".into()),
                arch: Some("arm64".into()),
                version: None,
            }),
            features: None,
        }];
        let features = FeatureSet::default();
        let ctx = linux_ctx(&features);
        // we are on linux but x86_64, not arm64 → rule does not match.
        assert!(!evaluate(&rules, &ctx));
    }

    #[test]
    fn feature_required_true_matches_when_ctx_true() {
        let rules = vec![Rule {
            action: RuleAction::Allow,
            os: None,
            features: Some(FeatureSet {
                is_demo_user: Some(true),
                ..Default::default()
            }),
        }];
        let demo_features = FeatureSet {
            is_demo_user: Some(true),
            ..Default::default()
        };
        let ctx = RuleContext {
            os_name: "linux",
            os_version: "6.0",
            arch: "x86_64",
            features: &demo_features,
        };
        assert!(evaluate(&rules, &ctx));
    }

    #[test]
    fn feature_required_true_blocks_when_ctx_false() {
        let rules = vec![Rule {
            action: RuleAction::Allow,
            os: None,
            features: Some(FeatureSet {
                is_demo_user: Some(true),
                ..Default::default()
            }),
        }];
        let features = FeatureSet::default();
        let ctx = linux_ctx(&features);
        assert!(!evaluate(&rules, &ctx));
    }

    #[test]
    fn no_os_no_features_rule_always_matches() {
        let rules = vec![Rule {
            action: RuleAction::Allow,
            os: None,
            features: None,
        }];
        let features = FeatureSet::default();
        let ctx = linux_ctx(&features);
        assert!(evaluate(&rules, &ctx));
    }

    #[test]
    fn os_version_pattern_matches_against_host() {
        let rules = vec![Rule {
            action: RuleAction::Allow,
            os: Some(OsCondition {
                name: Some("osx".into()),
                arch: None,
                version: Some("^10\\.".into()),
            }),
            features: None,
        }];
        let features = FeatureSet::default();
        let ctx_match = RuleContext {
            os_name: "osx",
            os_version: "10.15.7",
            arch: "x86_64",
            features: &features,
        };
        assert!(evaluate(&rules, &ctx_match));
        let ctx_mismatch = RuleContext {
            os_name: "osx",
            os_version: "13.2.1",
            arch: "x86_64",
            features: &features,
        };
        assert!(!evaluate(&rules, &ctx_mismatch));
    }

    #[test]
    fn os_version_pattern_does_not_match_when_host_unknown() {
        let rules = vec![Rule {
            action: RuleAction::Allow,
            os: Some(OsCondition {
                name: Some("windows".into()),
                arch: None,
                version: Some("^10\\.".into()),
            }),
            features: None,
        }];
        let features = FeatureSet::default();
        let ctx = RuleContext {
            os_name: "windows",
            os_version: "",
            arch: "x86_64",
            features: &features,
        };
        assert!(!evaluate(&rules, &ctx));
    }

    #[test]
    fn rule_deserializes_from_mojang_json() {
        // shape lifted from real mojang library rules.
        let json = r#"{
            "action": "allow",
            "os": { "name": "osx" }
        }"#;
        let rule: Rule = serde_json::from_str(json).unwrap();
        assert_eq!(rule.action, RuleAction::Allow);
        assert_eq!(
            rule.os.as_ref().and_then(|o| o.name.as_deref()),
            Some("osx")
        );
        assert!(rule.os.as_ref().and_then(|o| o.arch.as_ref()).is_none());
        assert!(rule.features.is_none());
    }

    #[test]
    fn rule_deserializes_with_features() {
        let json = r#"{
            "action": "allow",
            "features": { "is_demo_user": true }
        }"#;
        let rule: Rule = serde_json::from_str(json).unwrap();
        assert_eq!(rule.action, RuleAction::Allow);
        assert!(rule.os.is_none());
        assert_eq!(
            rule.features.as_ref().and_then(|f| f.is_demo_user),
            Some(true)
        );
    }
}