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
597
598
599
600
601
602
603
604
605
606
//! Batch change tracking for save file modifications.

use std::collections::HashMap;

use super::{parse_value, SaveError, SaveFile, StateFlags};

/// Represents a set of changes to apply to a save file
///
/// This is useful for batching multiple changes together and for
/// tracking modifications in a GUI before applying them.
#[derive(Default, Debug, Clone)]
pub struct ChangeSet {
    changes: HashMap<String, serde_yaml::Value>,
}

impl ChangeSet {
    /// Create a new empty ChangeSet
    pub fn new() -> Self {
        ChangeSet {
            changes: HashMap::new(),
        }
    }

    /// Add a change to the set
    pub fn add(&mut self, path: String, value: serde_yaml::Value) {
        self.changes.insert(path, value);
    }

    /// Add a change with a string value (auto-parsed)
    pub fn add_parsed(&mut self, path: String, value_str: &str) {
        let value = parse_value(value_str);
        self.changes.insert(path, value);
    }

    /// Add a raw YAML change from a string (for complex/unknown structures)
    pub fn add_raw(&mut self, path: String, yaml_str: &str) -> Result<(), SaveError> {
        let value: serde_yaml::Value = serde_yaml::from_str(yaml_str)?;
        self.changes.insert(path, value);
        Ok(())
    }

    /// Check if a specific path has been modified
    pub fn has_change(&self, path: &str) -> bool {
        self.changes.contains_key(path)
    }

    /// Get the pending change for a path, if any
    pub fn get_change(&self, path: &str) -> Option<&serde_yaml::Value> {
        self.changes.get(path)
    }

    /// Remove a change from the set
    pub fn remove(&mut self, path: &str) -> Option<serde_yaml::Value> {
        self.changes.remove(path)
    }

    /// Clear all changes
    pub fn clear(&mut self) {
        self.changes.clear();
    }

    /// Get number of changes
    pub fn len(&self) -> usize {
        self.changes.len()
    }

    /// Check if empty
    pub fn is_empty(&self) -> bool {
        self.changes.is_empty()
    }

    /// Get an iterator over all changes
    pub fn iter(&self) -> impl Iterator<Item = (&String, &serde_yaml::Value)> {
        self.changes.iter()
    }

    /// Apply all changes to a SaveFile
    pub fn apply(&self, save: &mut SaveFile) -> Result<(), SaveError> {
        for (path, value) in &self.changes {
            save.set(path, value.clone())?;
        }
        Ok(())
    }

    /// Convenience methods for common operations
    ///
    /// Set character name
    pub fn set_character_name(&mut self, name: &str) {
        self.add(
            "state.char_name".to_string(),
            serde_yaml::Value::String(name.to_string()),
        );
    }

    /// Set cash amount
    pub fn set_cash(&mut self, amount: u64) {
        self.add(
            "state.currencies.cash".to_string(),
            serde_yaml::Value::Number(amount.into()),
        );
    }

    /// Set eridium amount
    pub fn set_eridium(&mut self, amount: u64) {
        self.add(
            "state.currencies.eridium".to_string(),
            serde_yaml::Value::Number(amount.into()),
        );
    }

    /// Set character XP
    pub fn set_character_xp(&mut self, xp: u64) {
        self.add(
            "state.experience[0].points".to_string(),
            serde_yaml::Value::Number(xp.into()),
        );
    }

    /// Set specialization XP
    pub fn set_specialization_xp(&mut self, xp: u64) {
        self.add(
            "state.experience[1].points".to_string(),
            serde_yaml::Value::Number(xp.into()),
        );
    }

    // ─────────────────────────────────────────────────────────────────
    // Backpack Item Operations
    // ─────────────────────────────────────────────────────────────────

    /// Add an item to a backpack slot.
    ///
    /// # Arguments
    /// * `slot` - Backpack slot number (0-22 typically)
    /// * `serial` - Item serial string (e.g., "@Ugr$ZCm/...")
    /// * `flags` - State flags for the item
    ///
    /// # Example
    /// ```
    /// use bl4::{ChangeSet, StateFlags};
    ///
    /// let mut changes = ChangeSet::new();
    /// changes.add_backpack_item(0, "@Ugr$ZCm/...", StateFlags::backpack());
    /// ```
    pub fn add_backpack_item(&mut self, slot: u8, serial: &str, flags: StateFlags) {
        let base = format!("state.inventory.items.backpack.slot_{}", slot);
        self.add(
            format!("{}.serial", base),
            serde_yaml::Value::String(serial.to_string()),
        );
        self.add(
            format!("{}.flags", base),
            serde_yaml::Value::Number(0.into()),
        );
        self.add(
            format!("{}.state_flags", base),
            serde_yaml::Value::Number((flags.0 as i64).into()),
        );
    }

    /// Set state_flags on an existing backpack item.
    pub fn set_backpack_flags(&mut self, slot: u8, flags: StateFlags) {
        self.add(
            format!("state.inventory.items.backpack.slot_{}.state_flags", slot),
            serde_yaml::Value::Number((flags.0 as i64).into()),
        );
    }

    /// Set or clear the favorite flag on a backpack item.
    pub fn set_favorite(&mut self, slot: u8, value: bool) {
        let mut flags = StateFlags::backpack();
        flags.set_favorite(value);
        self.set_backpack_flags(slot, flags);
    }

    /// Set or clear the junk flag on a backpack item.
    pub fn set_junk(&mut self, slot: u8, value: bool) {
        let mut flags = StateFlags::backpack();
        flags.set_junk(value);
        self.set_backpack_flags(slot, flags);
    }

    /// Set or clear label 1 on a backpack item.
    pub fn set_label1(&mut self, slot: u8, value: bool) {
        let mut flags = StateFlags::backpack();
        flags.set_label1(value);
        self.set_backpack_flags(slot, flags);
    }

    /// Set or clear label 2 on a backpack item.
    pub fn set_label2(&mut self, slot: u8, value: bool) {
        let mut flags = StateFlags::backpack();
        flags.set_label2(value);
        self.set_backpack_flags(slot, flags);
    }

    /// Set or clear label 3 on a backpack item.
    pub fn set_label3(&mut self, slot: u8, value: bool) {
        let mut flags = StateFlags::backpack();
        flags.set_label3(value);
        self.set_backpack_flags(slot, flags);
    }

    /// Set or clear label 4 on a backpack item.
    pub fn set_label4(&mut self, slot: u8, value: bool) {
        let mut flags = StateFlags::backpack();
        flags.set_label4(value);
        self.set_backpack_flags(slot, flags);
    }

    // ─────────────────────────────────────────────────────────────────
    // Bank Item Operations (profile.sav)
    // ─────────────────────────────────────────────────────────────────

    /// Add an item to a bank slot.
    ///
    /// Note: Bank items are stored in profile.sav, not character saves.
    ///
    /// # Arguments
    /// * `slot` - Bank slot number
    /// * `serial` - Item serial string
    /// * `flags` - State flags for the item
    pub fn add_bank_item(&mut self, slot: u16, serial: &str, flags: StateFlags) {
        let base = format!("domains.local.shared.inventory.items.bank.slot_{}", slot);
        self.add(
            format!("{}.serial", base),
            serde_yaml::Value::String(serial.to_string()),
        );
        self.add(
            format!("{}.state_flags", base),
            serde_yaml::Value::Number((flags.0 as i64).into()),
        );
    }

    /// Set state_flags on an existing bank item.
    pub fn set_bank_flags(&mut self, slot: u16, flags: StateFlags) {
        self.add(
            format!(
                "domains.local.shared.inventory.items.bank.slot_{}.state_flags",
                slot
            ),
            serde_yaml::Value::Number((flags.0 as i64).into()),
        );
    }

    // ─────────────────────────────────────────────────────────────────
    // Equipped Item Operations
    // ─────────────────────────────────────────────────────────────────

    /// Equip an item to a slot.
    ///
    /// This adds the item to equipped_inventory. The item should also
    /// exist in the backpack with matching flags.
    ///
    /// # Arguments
    /// * `slot` - Equipped slot (0-3 weapons, 4 shield, 5 grenade, 6+ gear)
    /// * `serial` - Item serial string
    pub fn equip_item(&mut self, slot: u8, serial: &str) {
        let yaml = format!("- serial: '{}'\n  flags: 1\n  state_flags: 1", serial);
        let _ = self.add_raw(
            format!("state.inventory.equipped_inventory.equipped.slot_{}", slot),
            &yaml,
        );
    }

    /// Set item level on all serials in a save file.
    ///
    /// Decodes each serial, re-encodes at the target level, and adds
    /// the updated serial to the changeset. Returns the number of
    /// serials successfully updated.
    pub fn set_all_item_levels(&mut self, save: &super::SaveFile, level: u8) -> u32 {
        let mut count = 0u32;
        for (path, serial) in save.collect_serial_paths() {
            let Ok(item) = crate::serial::ItemSerial::decode(&serial) else {
                continue;
            };
            let Some(modified) = item.with_level(level) else {
                continue;
            };
            let new_serial = modified.original.clone();
            self.add(path, serde_yaml::Value::String(new_serial));
            count += 1;
        }
        count
    }

    /// Clear an equipped slot (unequip item).
    pub fn unequip_slot(&mut self, slot: u8) {
        let _ = self.add_raw(
            format!("state.inventory.equipped_inventory.equipped.slot_{}", slot),
            "[]",
        );
    }
}

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

    fn test_save_yaml() -> &'static str {
        r#"
state:
  char_name: TestChar
  class: Char_TestClass
  player_difficulty: Normal
  currencies:
    cash: 1000
    eridium: 50
    golden_key: shift
  experience:
    - type: Character
      level: 10
      points: 5000
    - type: Specialization
      level: 5
      points: 2500
  inventory:
    items:
      backpack:
        slot_0:
          serial: "@Test123"
          flags: 1
save_game_header:
  guid: ABC123
"#
    }

    #[test]
    fn test_changeset_new() {
        let changeset = ChangeSet::new();
        assert!(changeset.is_empty());
        assert_eq!(changeset.len(), 0);
    }

    #[test]
    fn test_changeset_add() {
        let mut changeset = ChangeSet::new();
        changeset.add(
            "state.cash".to_string(),
            serde_yaml::Value::Number(999.into()),
        );

        assert_eq!(changeset.len(), 1);
        assert!(changeset.has_change("state.cash"));
        assert!(!changeset.has_change("state.eridium"));
    }

    #[test]
    fn test_changeset_add_parsed() {
        let mut changeset = ChangeSet::new();
        changeset.add_parsed("state.cash".to_string(), "12345");

        let change = changeset.get_change("state.cash").unwrap();
        assert_eq!(change.as_u64(), Some(12345));
    }

    #[test]
    fn test_changeset_remove() {
        let mut changeset = ChangeSet::new();
        changeset.add(
            "state.cash".to_string(),
            serde_yaml::Value::Number(999.into()),
        );

        let removed = changeset.remove("state.cash");
        assert!(removed.is_some());
        assert!(changeset.is_empty());
    }

    #[test]
    fn test_changeset_clear() {
        let mut changeset = ChangeSet::new();
        changeset.add(
            "state.cash".to_string(),
            serde_yaml::Value::Number(999.into()),
        );
        changeset.add(
            "state.eridium".to_string(),
            serde_yaml::Value::Number(123.into()),
        );

        changeset.clear();
        assert!(changeset.is_empty());
    }

    #[test]
    fn test_changeset_apply() {
        let mut save = SaveFile::from_yaml(test_save_yaml().as_bytes()).unwrap();
        let mut changeset = ChangeSet::new();

        changeset.add(
            "state.currencies.cash".to_string(),
            serde_yaml::Value::Number(5555.into()),
        );
        changeset.add(
            "state.currencies.eridium".to_string(),
            serde_yaml::Value::Number(6666.into()),
        );
        changeset.add(
            "state.char_name".to_string(),
            serde_yaml::Value::String("Modified".into()),
        );

        changeset.apply(&mut save).unwrap();

        assert_eq!(save.get_cash(), Some(5555));
        assert_eq!(save.get_eridium(), Some(6666));
        assert_eq!(save.get_character_name(), Some("Modified"));
    }

    #[test]
    fn test_changeset_convenience_methods() {
        let mut changeset = ChangeSet::new();

        changeset.set_character_name("TestName");
        changeset.set_cash(11111);
        changeset.set_eridium(22222);
        changeset.set_character_xp(33333);
        changeset.set_specialization_xp(44444);

        assert_eq!(changeset.len(), 5);
        assert!(changeset.has_change("state.char_name"));
        assert!(changeset.has_change("state.currencies.cash"));
        assert!(changeset.has_change("state.currencies.eridium"));
        assert!(changeset.has_change("state.experience[0].points"));
        assert!(changeset.has_change("state.experience[1].points"));
    }

    #[test]
    fn test_changeset_iter() {
        let mut changeset = ChangeSet::new();
        changeset.set_cash(1111);
        changeset.set_eridium(2222);

        let count = changeset.iter().count();
        assert_eq!(count, 2);
    }

    #[test]
    fn test_changeset_apply_multiple() {
        let mut save = SaveFile::from_yaml(test_save_yaml().as_bytes()).unwrap();
        let mut changeset = ChangeSet::new();

        changeset.set_cash(99999);
        changeset.set_eridium(88888);
        changeset.set_character_name("BatchTest");
        changeset.set_character_xp(77777);
        changeset.set_specialization_xp(66666);

        changeset.apply(&mut save).unwrap();

        assert_eq!(save.get_cash(), Some(99999));
        assert_eq!(save.get_eridium(), Some(88888));
        assert_eq!(save.get_character_name(), Some("BatchTest"));
        assert_eq!(save.get_character_level(), Some((10, 77777)));
        assert_eq!(save.get_specialization_level(), Some((5, 66666)));
    }

    #[test]
    fn test_changeset_add_backpack_item() {
        let mut changeset = ChangeSet::new();
        changeset.add_backpack_item(5, "@TestSerial", StateFlags::backpack().with_favorite());

        assert!(changeset.has_change("state.inventory.items.backpack.slot_5.serial"));
        assert!(changeset.has_change("state.inventory.items.backpack.slot_5.flags"));
        assert!(changeset.has_change("state.inventory.items.backpack.slot_5.state_flags"));

        let state_flags = changeset
            .get_change("state.inventory.items.backpack.slot_5.state_flags")
            .unwrap();
        assert_eq!(state_flags.as_i64(), Some(515)); // 513 + 2 (backpack + favorite)
    }

    #[test]
    fn test_changeset_set_backpack_flags() {
        let mut changeset = ChangeSet::new();
        changeset.set_backpack_flags(3, StateFlags::backpack().with_junk());

        let change = changeset
            .get_change("state.inventory.items.backpack.slot_3.state_flags")
            .unwrap();
        assert_eq!(change.as_i64(), Some(517)); // 513 + 4 (backpack + junk)
    }

    #[test]
    fn test_changeset_set_favorite() {
        let mut changeset = ChangeSet::new();
        changeset.set_favorite(0, true);

        let change = changeset
            .get_change("state.inventory.items.backpack.slot_0.state_flags")
            .unwrap();
        assert_eq!(change.as_i64(), Some(515)); // 513 + 2 (backpack + favorite)
    }

    #[test]
    fn test_changeset_set_junk() {
        let mut changeset = ChangeSet::new();
        changeset.set_junk(1, true);

        let change = changeset
            .get_change("state.inventory.items.backpack.slot_1.state_flags")
            .unwrap();
        assert_eq!(change.as_i64(), Some(517)); // 513 + 4 (backpack + junk)
    }

    #[test]
    fn test_changeset_add_bank_item() {
        let mut changeset = ChangeSet::new();
        changeset.add_bank_item(10, "@BankSerial", StateFlags::bank());

        assert!(changeset.has_change("domains.local.shared.inventory.items.bank.slot_10.serial"));
        assert!(
            changeset.has_change("domains.local.shared.inventory.items.bank.slot_10.state_flags")
        );
        // Bank items don't have a flags field
        assert!(!changeset.has_change("domains.local.shared.inventory.items.bank.slot_10.flags"));
    }

    #[test]
    fn test_changeset_equip_item() {
        let mut changeset = ChangeSet::new();
        changeset.equip_item(0, "@WeaponSerial");

        assert!(changeset.has_change("state.inventory.equipped_inventory.equipped.slot_0"));
    }

    #[test]
    fn test_changeset_unequip_slot() {
        let mut changeset = ChangeSet::new();
        changeset.unequip_slot(4);

        assert!(changeset.has_change("state.inventory.equipped_inventory.equipped.slot_4"));
    }

    #[test]
    fn test_changeset_set_label1() {
        let mut changeset = ChangeSet::new();
        changeset.set_label1(2, true);

        let change = changeset
            .get_change("state.inventory.items.backpack.slot_2.state_flags")
            .unwrap();
        assert_eq!(change.as_i64(), Some(529)); // 513 + 16 (backpack + label1)
    }

    #[test]
    fn test_changeset_set_label2() {
        let mut changeset = ChangeSet::new();
        changeset.set_label2(3, true);

        let change = changeset
            .get_change("state.inventory.items.backpack.slot_3.state_flags")
            .unwrap();
        assert_eq!(change.as_i64(), Some(545)); // 513 + 32 (backpack + label2)
    }

    #[test]
    fn test_changeset_set_label3() {
        let mut changeset = ChangeSet::new();
        changeset.set_label3(4, true);

        let change = changeset
            .get_change("state.inventory.items.backpack.slot_4.state_flags")
            .unwrap();
        assert_eq!(change.as_i64(), Some(577)); // 513 + 64 (backpack + label3)
    }

    #[test]
    fn test_changeset_set_label4() {
        let mut changeset = ChangeSet::new();
        changeset.set_label4(5, true);

        let change = changeset
            .get_change("state.inventory.items.backpack.slot_5.state_flags")
            .unwrap();
        assert_eq!(change.as_i64(), Some(641)); // 513 + 128 (backpack + label4)
    }

    #[test]
    fn test_changeset_set_bank_flags() {
        let mut changeset = ChangeSet::new();
        changeset.set_bank_flags(42, StateFlags::bank().with_favorite());

        let change = changeset
            .get_change("domains.local.shared.inventory.items.bank.slot_42.state_flags")
            .unwrap();
        assert_eq!(change.as_i64(), Some(3)); // 1 + 2 (valid + favorite)
    }

    #[test]
    fn test_changeset_add_raw() {
        let mut changeset = ChangeSet::new();
        let result =
            changeset.add_raw("some.path".to_string(), "key: value\nnested:\n  field: 123");
        assert!(result.is_ok());
        assert!(changeset.has_change("some.path"));
    }

    #[test]
    fn test_changeset_add_raw_invalid_yaml() {
        let mut changeset = ChangeSet::new();
        let result = changeset.add_raw("some.path".to_string(), "invalid: yaml: :::");
        assert!(result.is_err());
    }
}