bl4 0.8.5

Borderlands 4 save editor library - encryption, decryption, and parsing
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
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
//! Campaign progression reading and mutation.
//!
//! Reads mission status from decrypted save YAML, and provides mutation
//! functions to set campaign progress to a specific point.

use super::SaveError;
use crate::missions;

/// Status of a mission set in the save file.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum CampaignStatus {
    NotStarted,
    Active,
    Completed,
}

impl std::fmt::Display for CampaignStatus {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::NotStarted => write!(f, "not started"),
            Self::Active => write!(f, "active"),
            Self::Completed => write!(f, "completed"),
        }
    }
}

/// A mission set's status as read from the save file.
#[derive(Debug, Clone)]
pub struct CampaignEntry {
    pub mission_set: String,
    pub status: CampaignStatus,
    pub region: String,
    pub category: String,
}

/// Description of changes that will be applied by `set_campaign_progress`.
#[derive(Debug, Clone, Default)]
pub struct CampaignChanges {
    pub completed_sets: Vec<String>,
    pub reset_sets: Vec<String>,
    pub active_set: String,
    pub active_mission: String,
}

/// Read current campaign status from save data.
///
/// Returns main story mission sets in order with their completion status.
pub fn get_campaign_status(data: &serde_yaml::Value) -> Vec<CampaignEntry> {
    get_mission_status(data, Some("main"))
}

/// Read mission status for all categories, or a specific category.
///
/// Pass `None` to get all mission sets, or `Some("main")`, `Some("dlc")`, etc.
pub(crate) fn get_mission_status(
    data: &serde_yaml::Value,
    category: Option<&str>,
) -> Vec<CampaignEntry> {
    let missions_node = &data["missions"];
    let all_sets = missions::all_mission_sets();

    // For "main", use the ordered chain
    if category == Some("main") {
        let order = missions::main_story_order();
        return order
            .iter()
            .map(|ms| {
                let status = read_set_status(missions_node, &ms.name);
                CampaignEntry {
                    mission_set: ms.name.clone(),
                    status,
                    region: ms.region.clone(),
                    category: ms.category.clone(),
                }
            })
            .collect();
    }

    // For other categories (or all), collect and sort by name
    let mut entries: Vec<CampaignEntry> = all_sets
        .values()
        .filter(|ms| match category {
            Some(c) => ms.category == c,
            None => true,
        })
        .map(|ms| {
            let status = read_set_status(missions_node, &ms.name);
            CampaignEntry {
                mission_set: ms.name.clone(),
                status,
                region: ms.region.clone(),
                category: ms.category.clone(),
            }
        })
        .collect();

    entries.sort_by(|a, b| a.mission_set.cmp(&b.mission_set));
    entries
}

/// Compute what changes are needed to set progress to a target mission set.
///
/// Returns `None` if the target is not a valid main story mission set.
/// Main-story mission sets that come *after* the target (not in the prereq
/// chain) are added to `reset_sets` to support rewinding.
pub fn plan_campaign_progress(target: &str) -> Option<CampaignChanges> {
    let resolved = missions::resolve_mission_set_name(target)?;
    let prereqs = missions::prerequisites_for(resolved);

    if prereqs.is_empty() {
        return None;
    }

    let (completed, active) = prereqs.split_at(prereqs.len() - 1);
    let active_set = &active[0];

    // Build reset list: all main-story sets NOT in the prereq chain and NOT the target
    let prereq_names: std::collections::HashSet<&str> =
        prereqs.iter().map(|ms| ms.name.as_str()).collect();
    let reset_sets: Vec<String> = missions::main_story_order()
        .iter()
        .filter(|ms| !prereq_names.contains(ms.name.as_str()))
        .map(|ms| ms.name.clone())
        .collect();

    Some(CampaignChanges {
        completed_sets: completed.iter().map(|ms| ms.name.clone()).collect(),
        reset_sets,
        active_set: active_set.name.clone(),
        active_mission: missions::mission_name_for_set(&active_set.name),
    })
}

/// Plan completion of all main campaign and side missions.
///
/// Returns a `CampaignChanges` that marks every main, dlc, and side
/// mission set as completed. No active set — all are marked complete.
pub fn plan_complete_all() -> CampaignChanges {
    let mut completed: Vec<String> = missions::all_mission_sets()
        .values()
        .filter(|ms| matches!(ms.category.as_str(), "main" | "dlc" | "side"))
        .map(|ms| ms.name.clone())
        .collect();
    completed.sort();

    // Use the last main-story set as the active set for structural validity
    let last_main = missions::main_story_order()
        .last()
        .map(|ms| ms.name.clone())
        .unwrap_or_default();

    let active_mission = missions::mission_name_for_set(&last_main);

    CampaignChanges {
        completed_sets: completed.clone(),
        reset_sets: Vec::new(),
        active_set: last_main,
        active_mission,
    }
}

/// Known DLC mission set groups. Each DLC may have multiple mission sets
/// that must all be completed together.
const DLC_GROUPS: &[(&str, &[&str])] = &[
    (
        "cowbell",
        &["missionset_main_cowbell_unlock", "missionset_main_cowbell"],
    ),
    ("cello", &["missionset_dlc_cello"]),
    ("banjo", &["missionset_dlc_banjo"]),
    ("raid1", &["missionset_dlc_raid1"]),
];

/// Plan completion of a DLC by name.
///
/// Returns the list of mission sets to mark as completed, or `None` if
/// the DLC name isn't recognized.
pub fn plan_dlc_completion(dlc_name: &str) -> Option<CampaignChanges> {
    let lower = dlc_name.to_lowercase();

    let sets = DLC_GROUPS
        .iter()
        .find(|(name, _)| *name == lower)
        .map(|(_, sets)| *sets)?;

    let all_completed: Vec<String> = sets.iter().map(|s| s.to_string()).collect();
    let last_set = all_completed.last()?.clone();

    Some(CampaignChanges {
        completed_sets: all_completed,
        reset_sets: Vec::new(),
        active_set: last_set.clone(),
        active_mission: missions::mission_name_for_set(&last_set),
    })
}

/// Mark a single mission as completed within its parent set.
///
/// Does not change the set-level status — only the individual mission.
pub fn complete_single_mission(
    data: &mut serde_yaml::Value,
    mission_name: &str,
) -> Result<(), SaveError> {
    let mission = missions::resolve_mission_name(mission_name)
        .ok_or_else(|| SaveError::KeyNotFound(format!("mission '{}'", mission_name)))?;

    let set_name = &mission.mission_set;
    ensure_missions_structure(data);

    let set_key = serde_yaml::Value::String(set_name.to_lowercase());
    let mission_key = serde_yaml::Value::String(mission.name.clone());

    // Ensure the set exists in local_sets
    let local = data["missions"]["local_sets"]
        .as_mapping_mut()
        .ok_or_else(|| SaveError::KeyNotFound("local_sets".to_string()))?;

    if !local.contains_key(&set_key) {
        let mut set_entry = serde_yaml::Mapping::new();
        set_entry.insert(
            serde_yaml::Value::String("missions".to_string()),
            serde_yaml::Value::Mapping(serde_yaml::Mapping::new()),
        );
        local.insert(set_key.clone(), serde_yaml::Value::Mapping(set_entry));
    }

    let missions_map = ensure_missions_in_set(local, &set_key, set_name)?;
    upsert_completed_mission(missions_map, &mission_key);

    Ok(())
}

/// Apply campaign progress changes to save data.
///
/// For main story: marks prerequisite sets as completed and target as active.
/// For DLC completion: marks all sets as completed (no active set).
pub fn apply_campaign_progress(
    data: &mut serde_yaml::Value,
    changes: &CampaignChanges,
) -> Result<(), SaveError> {
    ensure_missions_structure(data);

    // Check if the active set is in the completed list (DLC completion / complete-all)
    let all_completed = changes.completed_sets.contains(&changes.active_set);

    // Reset sets that should be rewound (remove from local_sets)
    for set_name in &changes.reset_sets {
        mark_set_reset(data, set_name);
    }

    // Mark all completed sets
    for set_name in &changes.completed_sets {
        mark_set_completed(data, set_name);
    }

    if !all_completed {
        // Main story: mark the target set as active with its first mission
        mark_set_active(data, &changes.active_set, &changes.active_mission);

        // Update tracked missions
        let tracked_name = title_case_mission(&changes.active_mission);
        data["missions"]["tracked_missions"] =
            serde_yaml::Value::Sequence(vec![serde_yaml::Value::String(tracked_name)]);
    }

    Ok(())
}

/// Remove a mission set from `local_sets` to reset its completion status.
fn mark_set_reset(data: &mut serde_yaml::Value, set_name: &str) {
    let set_key = serde_yaml::Value::String(set_name.to_string());
    if let Some(local) = data["missions"]["local_sets"].as_mapping_mut() {
        local.remove(&set_key);
    }
    if let Some(remote) = data["missions"]["remote_sets"].as_mapping_mut() {
        remote.remove(&set_key);
    }
}

// --- Internal helpers ---

fn ensure_missions_in_set<'a>(
    local: &'a mut serde_yaml::Mapping,
    set_key: &serde_yaml::Value,
    set_name: &str,
) -> Result<&'a mut serde_yaml::Mapping, SaveError> {
    let set_data = local
        .get_mut(set_key)
        .and_then(|v| v.as_mapping_mut())
        .ok_or_else(|| SaveError::KeyNotFound(set_name.to_string()))?;

    if !set_data.contains_key(serde_yaml::Value::String("missions".to_string())) {
        set_data.insert(
            serde_yaml::Value::String("missions".to_string()),
            serde_yaml::Value::Mapping(serde_yaml::Mapping::new()),
        );
    }

    set_data
        .get_mut(serde_yaml::Value::String("missions".to_string()))
        .and_then(|v| v.as_mapping_mut())
        .ok_or_else(|| SaveError::KeyNotFound("missions".to_string()))
}

fn upsert_completed_mission(
    missions_map: &mut serde_yaml::Mapping,
    mission_key: &serde_yaml::Value,
) {
    if let Some(existing) = missions_map.get_mut(mission_key) {
        if let Some(m) = existing.as_mapping_mut() {
            m.insert(
                serde_yaml::Value::String("status".to_string()),
                serde_yaml::Value::String("completed".to_string()),
            );
            m.insert(
                serde_yaml::Value::String("ui_flags".to_string()),
                serde_yaml::Value::Number(1.into()),
            );
            m.remove(serde_yaml::Value::String("objectives".to_string()));
        }
    } else {
        let mut entry = serde_yaml::Mapping::new();
        entry.insert(
            serde_yaml::Value::String("status".to_string()),
            serde_yaml::Value::String("completed".to_string()),
        );
        entry.insert(
            serde_yaml::Value::String("ui_flags".to_string()),
            serde_yaml::Value::Number(1.into()),
        );
        missions_map.insert(mission_key.clone(), serde_yaml::Value::Mapping(entry));
    }
}

fn read_set_status(missions: &serde_yaml::Value, set_name: &str) -> CampaignStatus {
    // Check local_sets first (completed sets live here)
    if let Some(set_data) = missions["local_sets"][set_name].as_mapping() {
        if set_data
            .get(serde_yaml::Value::String("status".to_string()))
            .and_then(|v| v.as_str())
            == Some("completed")
        {
            return CampaignStatus::Completed;
        }
        // Has missions but no completed status = active
        if set_data.contains_key(serde_yaml::Value::String("missions".to_string())) {
            return CampaignStatus::Active;
        }
    }

    // Check remote_sets (active sets sometimes appear here)
    if missions["remote_sets"][set_name].is_mapping() {
        return CampaignStatus::Active;
    }

    CampaignStatus::NotStarted
}

fn ensure_missions_structure(data: &mut serde_yaml::Value) {
    if data["missions"].is_null() {
        data["missions"] = serde_yaml::Value::Mapping(serde_yaml::Mapping::new());
    }
    if data["missions"]["local_sets"].is_null() {
        data["missions"]["local_sets"] = serde_yaml::Value::Mapping(serde_yaml::Mapping::new());
    }
}

fn mark_set_completed(data: &mut serde_yaml::Value, set_name: &str) {
    let set_key = serde_yaml::Value::String(set_name.to_string());

    // Remove from remote_sets if present
    if let Some(remote) = data["missions"]["remote_sets"].as_mapping_mut() {
        remote.remove(&set_key);
    }

    let new_entry = build_completed_set_entry(set_name);

    // Write to local_sets, preserving existing data if present
    if let Some(local) = data["missions"]["local_sets"].as_mapping_mut() {
        let existing = local.get(&set_key).cloned();
        if let Some(serde_yaml::Value::Mapping(mut existing_map)) = existing {
            complete_existing_set(&mut existing_map);
            local.insert(set_key, serde_yaml::Value::Mapping(existing_map));
        } else {
            local.insert(set_key, serde_yaml::Value::Mapping(new_entry));
        }
    }
}

fn build_completed_set_entry(set_name: &str) -> serde_yaml::Mapping {
    let mut set_entry = serde_yaml::Mapping::new();
    set_entry.insert(
        serde_yaml::Value::String("status".to_string()),
        serde_yaml::Value::String("completed".to_string()),
    );

    let all_missions = missions::missions_in_set(set_name);
    if !all_missions.is_empty() {
        let mut missions_map = serde_yaml::Mapping::new();
        for mission in &all_missions {
            let mut mission_entry = serde_yaml::Mapping::new();
            mission_entry.insert(
                serde_yaml::Value::String("status".to_string()),
                serde_yaml::Value::String("completed".to_string()),
            );
            missions_map.insert(
                serde_yaml::Value::String(mission.name.clone()),
                serde_yaml::Value::Mapping(mission_entry),
            );
        }
        set_entry.insert(
            serde_yaml::Value::String("missions".to_string()),
            serde_yaml::Value::Mapping(missions_map),
        );
    }

    set_entry
}

fn complete_existing_set(existing: &mut serde_yaml::Mapping) {
    existing.insert(
        serde_yaml::Value::String("status".to_string()),
        serde_yaml::Value::String("completed".to_string()),
    );
    if let Some(serde_yaml::Value::Mapping(missions)) =
        existing.get_mut(serde_yaml::Value::String("missions".to_string()))
    {
        for (_name, mdata) in missions.iter_mut() {
            if let serde_yaml::Value::Mapping(m) = mdata {
                m.insert(
                    serde_yaml::Value::String("status".to_string()),
                    serde_yaml::Value::String("completed".to_string()),
                );
                m.insert(
                    serde_yaml::Value::String("ui_flags".to_string()),
                    serde_yaml::Value::Number(1.into()),
                );
                m.remove(serde_yaml::Value::String("objectives".to_string()));
            }
        }
    }
}

fn mark_set_active(data: &mut serde_yaml::Value, set_name: &str, mission_name: &str) {
    let set_key = serde_yaml::Value::String(set_name.to_string());

    // Build active mission entry
    let mut mission_entry = serde_yaml::Mapping::new();
    mission_entry.insert(
        serde_yaml::Value::String("status".to_string()),
        serde_yaml::Value::String("Active".to_string()),
    );

    let mut missions_map = serde_yaml::Mapping::new();
    missions_map.insert(
        serde_yaml::Value::String(mission_name.to_string()),
        serde_yaml::Value::Mapping(mission_entry),
    );

    let mut set_entry = serde_yaml::Mapping::new();
    set_entry.insert(
        serde_yaml::Value::String("missions".to_string()),
        serde_yaml::Value::Mapping(missions_map),
    );

    // Place in local_sets (matching observed save behavior for active main missions)
    if let Some(local) = data["missions"]["local_sets"].as_mapping_mut() {
        local.insert(set_key, serde_yaml::Value::Mapping(set_entry));
    }
}

/// Convert "mission_main_grasslands1" to "Mission_Main_Grasslands1" for tracked_missions.
fn title_case_mission(name: &str) -> String {
    name.split('_')
        .map(|word| {
            let mut chars = word.chars();
            match chars.next() {
                Some(c) => {
                    let upper: String = c.to_uppercase().collect();
                    format!("{}{}", upper, chars.as_str())
                }
                None => String::new(),
            }
        })
        .collect::<Vec<_>>()
        .join("_")
}

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

    fn sample_save_data() -> serde_yaml::Value {
        serde_yaml::from_str(
            r#"
missions:
  tracked_missions:
  - Mission_Main_Beach
  local_sets:
    missionset_main_prisonprologue:
      status: completed
      missions:
        mission_main_prisonprologue:
          ui_flags: 1
          status: completed
    missionset_main_beach:
      missions:
        mission_main_beach:
          status: Active
          objectives:
            reach_village:
              status: Active
"#,
        )
        .unwrap()
    }

    #[test]
    fn test_get_campaign_status() {
        let data = sample_save_data();
        let status = get_campaign_status(&data);
        assert!(!status.is_empty());

        let prologue = status
            .iter()
            .find(|e| e.mission_set.contains("prisonprologue"))
            .unwrap();
        assert_eq!(prologue.status, CampaignStatus::Completed);

        let beach = status
            .iter()
            .find(|e| e.mission_set.contains("beach"))
            .unwrap();
        assert_eq!(beach.status, CampaignStatus::Active);

        let grasslands1 = status
            .iter()
            .find(|e| e.mission_set == "missionset_main_grasslands1")
            .unwrap();
        assert_eq!(grasslands1.status, CampaignStatus::NotStarted);
    }

    #[test]
    fn test_plan_campaign_progress() {
        let changes = plan_campaign_progress("grasslands1").unwrap();
        assert_eq!(changes.active_set, "missionset_main_grasslands1");
        assert!(changes
            .completed_sets
            .contains(&"missionset_main_prisonprologue".to_string()));
        assert!(changes
            .completed_sets
            .contains(&"missionset_main_beach".to_string()));
        assert!(!changes
            .completed_sets
            .contains(&"missionset_main_grasslands1".to_string()));
    }

    #[test]
    fn test_apply_campaign_progress() {
        let mut data = sample_save_data();
        let changes = plan_campaign_progress("grasslands1").unwrap();
        apply_campaign_progress(&mut data, &changes).unwrap();

        // Prologue should be completed
        let prologue_status =
            data["missions"]["local_sets"]["missionset_main_prisonprologue"]["status"].as_str();
        assert_eq!(prologue_status, Some("completed"));

        // Beach should be completed
        let beach_status =
            data["missions"]["local_sets"]["missionset_main_beach"]["status"].as_str();
        assert_eq!(beach_status, Some("completed"));

        // Grasslands1 should be active
        let g1_mission = &data["missions"]["local_sets"]["missionset_main_grasslands1"]["missions"]
            ["mission_main_grasslands1"]["status"];
        assert_eq!(g1_mission.as_str(), Some("Active"));
    }

    #[test]
    fn test_title_case_mission() {
        assert_eq!(
            title_case_mission("mission_main_grasslands1"),
            "Mission_Main_Grasslands1"
        );
        assert_eq!(
            title_case_mission("mission_main_prisonprologue"),
            "Mission_Main_Prisonprologue"
        );
    }

    #[test]
    fn test_plan_returns_none_for_invalid() {
        assert!(plan_campaign_progress("nonexistent_mission").is_none());
    }
}