heroforge-core 0.2.2

Pure Rust core library for reading and writing Fossil SCM repositories
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
466
467
468
469
470
471
472
473
474
use crate::error::{FossilError, Result};
use std::collections::HashMap;

/// Encode an integer in Heroforge's custom base-64 encoding
fn encode_int(mut value: u32) -> Vec<u8> {
    const CHARS: &[u8] = b"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ_abcdefghijklmnopqrstuvwxyz~";

    if value == 0 {
        return vec![b'0'];
    }

    let mut result = Vec::new();
    while value > 0 {
        result.push(CHARS[(value % 64) as usize]);
        value /= 64;
    }
    result.reverse();
    result
}

/// Create a delta between source and target
///
/// This uses a simple rolling hash approach to find matching blocks.
/// Returns the delta that, when applied to source, produces target.
pub fn create_delta(source: &[u8], target: &[u8]) -> Vec<u8> {
    // If source is empty or very small, just insert the whole target
    if source.len() < 16 {
        return create_insert_only_delta(target);
    }

    // Build hash table of source positions
    // Using 4-byte chunks with a simple hash
    const BLOCK_SIZE: usize = 4;
    let mut hash_table: HashMap<u32, Vec<usize>> = HashMap::new();

    for i in 0..source.len().saturating_sub(BLOCK_SIZE - 1) {
        let hash = simple_hash(&source[i..i + BLOCK_SIZE]);
        hash_table.entry(hash).or_default().push(i);
    }

    let mut delta = Vec::new();

    // Write header (target size)
    delta.extend(encode_int(target.len() as u32));
    delta.push(b'\n');

    let mut pos = 0;
    let mut pending_insert: Vec<u8> = Vec::new();

    while pos < target.len() {
        // Try to find a match
        let remaining = target.len() - pos;
        if remaining >= BLOCK_SIZE {
            let hash = simple_hash(&target[pos..pos + BLOCK_SIZE]);

            if let Some(positions) = hash_table.get(&hash) {
                // Find the longest match
                let mut best_match: Option<(usize, usize)> = None; // (source_pos, length)

                for &src_pos in positions {
                    let match_len = find_match_length(source, src_pos, target, pos);
                    if match_len >= BLOCK_SIZE {
                        if best_match.is_none() || match_len > best_match.unwrap().1 {
                            best_match = Some((src_pos, match_len));
                        }
                    }
                }

                if let Some((src_pos, match_len)) = best_match {
                    // Flush pending insert
                    if !pending_insert.is_empty() {
                        delta.extend(encode_int(pending_insert.len() as u32));
                        delta.push(b':');
                        delta.extend(&pending_insert);
                        pending_insert.clear();
                    }

                    // Write copy command
                    delta.extend(encode_int(match_len as u32));
                    delta.push(b'@');
                    delta.extend(encode_int(src_pos as u32));
                    delta.push(b',');

                    pos += match_len;
                    continue;
                }
            }
        }

        // No match found, add to pending insert
        pending_insert.push(target[pos]);
        pos += 1;
    }

    // Flush any remaining insert
    if !pending_insert.is_empty() {
        delta.extend(encode_int(pending_insert.len() as u32));
        delta.push(b':');
        delta.extend(&pending_insert);
    }

    // Write trailer (simple checksum)
    let checksum = simple_checksum(target);
    delta.extend(encode_int(checksum));
    delta.push(b';');

    delta
}

/// Create a delta that just inserts the entire target
fn create_insert_only_delta(target: &[u8]) -> Vec<u8> {
    let mut delta = Vec::new();
    delta.extend(encode_int(target.len() as u32));
    delta.push(b'\n');
    delta.extend(encode_int(target.len() as u32));
    delta.push(b':');
    delta.extend(target);
    let checksum = simple_checksum(target);
    delta.extend(encode_int(checksum));
    delta.push(b';');
    delta
}

/// Simple 32-bit hash of 4 bytes
fn simple_hash(data: &[u8]) -> u32 {
    let mut h: u32 = 0;
    for &b in data.iter().take(4) {
        h = h.wrapping_mul(31).wrapping_add(b as u32);
    }
    h
}

/// Find how many bytes match starting from given positions
fn find_match_length(source: &[u8], src_pos: usize, target: &[u8], tgt_pos: usize) -> usize {
    let mut len = 0;
    while src_pos + len < source.len()
        && tgt_pos + len < target.len()
        && source[src_pos + len] == target[tgt_pos + len]
    {
        len += 1;
    }
    len
}

/// Simple checksum for delta verification
fn simple_checksum(data: &[u8]) -> u32 {
    let mut sum: u32 = 0;
    for &b in data {
        sum = sum.wrapping_add(b as u32);
    }
    sum & 0xFFFF
}

/// Decode a base-64 integer from Heroforge's custom encoding
///
/// Characters: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ_abcdefghijklmnopqrstuvwxyz~
/// Values:     0-9        10-35                   36 37-62                   63
fn decode_int(data: &[u8], pos: &mut usize) -> Result<u32> {
    let mut value: u64 = 0;
    let mut count = 0;

    while *pos < data.len() {
        let c = data[*pos];
        let digit = match c {
            b'0'..=b'9' => (c - b'0') as u64,
            b'A'..=b'Z' => (c - b'A' + 10) as u64,
            b'_' => 36,
            b'a'..=b'z' => (c - b'a' + 37) as u64,
            b'~' => 63,
            _ => break, // Not a digit, stop
        };
        value = value * 64 + digit;
        *pos += 1;
        count += 1;

        // Prevent overflow
        if count > 10 {
            return Err(FossilError::DeltaFailed("Integer too large".into()));
        }
    }

    if count == 0 {
        return Err(FossilError::DeltaFailed(format!(
            "Expected integer at position {}",
            pos
        )));
    }

    Ok(value as u32)
}

/// Apply a Heroforge delta to produce the target
///
/// Delta format:
/// - Header: target_size + '\n'
/// - Segments: copy or insert operations
/// - Trailer: checksum + ';'
///
/// Copy operation: length '@' offset ','
/// Insert operation: length ':' literal_bytes
pub fn apply_delta(source: &[u8], delta: &[u8]) -> Result<Vec<u8>> {
    if delta.is_empty() {
        return Err(FossilError::DeltaFailed("Empty delta".into()));
    }

    let mut pos = 0;

    // Parse header: target size
    let target_size = decode_int(delta, &mut pos)?;

    if pos >= delta.len() || delta[pos] != b'\n' {
        return Err(FossilError::DeltaFailed(format!(
            "Invalid header: expected newline at {}, got {:?}",
            pos,
            delta.get(pos)
        )));
    }
    pos += 1; // Skip newline

    let mut output = Vec::with_capacity(target_size as usize);

    // Process segments until we hit the trailer
    while pos < delta.len() {
        // Check for trailer (checksum followed by semicolon)
        // The trailer format is: checksum;
        // We need to check if we're at a checksum followed by semicolon

        // First, try to decode an integer
        let _start_pos = pos;
        let len = match decode_int(delta, &mut pos) {
            Ok(n) => n,
            Err(_) => {
                // If we can't decode an integer, we might be at end
                break;
            }
        };

        // Check what follows the integer
        if pos >= delta.len() {
            // Unexpected end
            return Err(FossilError::DeltaFailed("Unexpected end of delta".into()));
        }

        // If the next char is ';', this was the checksum - we're done
        if delta[pos] == b';' {
            break;
        }

        if pos >= delta.len() {
            return Err(FossilError::DeltaFailed("Unexpected end of delta".into()));
        }

        match delta[pos] {
            b'@' => {
                // Copy from source: length @ offset ,
                pos += 1;
                let offset = decode_int(delta, &mut pos)?;

                if pos >= delta.len() || delta[pos] != b',' {
                    return Err(FossilError::DeltaFailed(format!(
                        "Expected ',' at position {}",
                        pos
                    )));
                }
                pos += 1;

                let start = offset as usize;
                let end = start + len as usize;

                if end > source.len() {
                    return Err(FossilError::DeltaFailed(format!(
                        "Copy range out of bounds: {}..{} > {}",
                        start,
                        end,
                        source.len()
                    )));
                }

                output.extend_from_slice(&source[start..end]);
            }
            b':' => {
                // Insert literal: length : bytes
                pos += 1;
                let end = pos + len as usize;

                if end > delta.len() {
                    return Err(FossilError::DeltaFailed(format!(
                        "Literal out of bounds: need {} bytes at {}, have {}",
                        len,
                        pos,
                        delta.len() - pos
                    )));
                }

                output.extend_from_slice(&delta[pos..end]);
                pos = end;
            }
            c => {
                return Err(FossilError::DeltaFailed(format!(
                    "Unknown operator '{}' (0x{:02x}) at position {}",
                    c as char, c, pos
                )));
            }
        }
    }

    // Verify we hit the trailer
    if pos >= delta.len() || delta[pos] != b';' {
        // Some deltas might not have a trailer with checksum
        // Be lenient if we got the expected size
        if output.len() == target_size as usize {
            return Ok(output);
        }
    }

    if output.len() != target_size as usize {
        return Err(FossilError::DeltaFailed(format!(
            "Size mismatch: expected {}, got {}",
            target_size,
            output.len()
        )));
    }

    Ok(output)
}

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

    #[test]
    fn test_decode_int_simple() {
        let mut pos = 0;
        assert_eq!(decode_int(b"0", &mut pos).unwrap(), 0);
        assert_eq!(pos, 1);

        pos = 0;
        assert_eq!(decode_int(b"9", &mut pos).unwrap(), 9);

        pos = 0;
        assert_eq!(decode_int(b"A", &mut pos).unwrap(), 10);

        pos = 0;
        assert_eq!(decode_int(b"Z", &mut pos).unwrap(), 35);

        pos = 0;
        assert_eq!(decode_int(b"_", &mut pos).unwrap(), 36);

        pos = 0;
        assert_eq!(decode_int(b"a", &mut pos).unwrap(), 37);

        pos = 0;
        assert_eq!(decode_int(b"z", &mut pos).unwrap(), 62);

        pos = 0;
        assert_eq!(decode_int(b"~", &mut pos).unwrap(), 63);
    }

    #[test]
    fn test_decode_int_multi() {
        let mut pos = 0;
        // "10" = 1*64 + 0 = 64
        assert_eq!(decode_int(b"10", &mut pos).unwrap(), 64);

        pos = 0;
        // "1X" = 1*64 + 33 = 97
        assert_eq!(decode_int(b"1X", &mut pos).unwrap(), 97);
    }

    #[test]
    fn test_apply_delta_insert_only() {
        // Delta: target size 5, insert "hello"
        let source = b"";
        let delta = b"5\n5:hello;";

        let result = apply_delta(source, delta).unwrap();
        assert_eq!(result, b"hello");
    }

    #[test]
    fn test_apply_delta_copy_only() {
        // Delta: target size 5, copy 5 bytes from offset 0
        let source = b"hello";
        let delta = b"5\n5@0,;";

        let result = apply_delta(source, delta).unwrap();
        assert_eq!(result, b"hello");
    }

    #[test]
    fn test_apply_delta_mixed() {
        // Delta: target size 11, copy 5 from 0, insert " world"
        let source = b"hello";
        let delta = b"B\n5@0,6: world;"; // B = 11 in base64

        let result = apply_delta(source, delta).unwrap();
        assert_eq!(result, b"hello world");
    }

    #[test]
    fn test_apply_delta_partial_copy() {
        // Delta: target size 3, copy 3 bytes from offset 1
        let source = b"hello";
        let delta = b"3\n3@1,;";

        let result = apply_delta(source, delta).unwrap();
        assert_eq!(result, b"ell");
    }

    #[test]
    fn test_create_and_apply_delta() {
        // Test that create_delta produces valid deltas
        let source = b"The quick brown fox jumps over the lazy dog";
        let target = b"The quick brown cat jumps over the lazy dog";

        let delta = create_delta(source, target);
        let result = apply_delta(source, &delta).unwrap();
        assert_eq!(result, target);
    }

    #[test]
    fn test_create_delta_append() {
        // Use larger source so delta compression is effective
        let source =
            b"Hello, World! This is a longer piece of text that allows for good delta compression.";
        let target = b"Hello, World! This is a longer piece of text that allows for good delta compression. Extra!";

        let delta = create_delta(source, target);
        let result = apply_delta(source, &delta).unwrap();
        assert_eq!(result, target);

        // Delta should be smaller than target for this case
        assert!(
            delta.len() < target.len(),
            "delta {} >= target {}",
            delta.len(),
            target.len()
        );
    }

    #[test]
    fn test_create_delta_empty_source() {
        let source = b"";
        let target = b"New content";

        let delta = create_delta(source, target);
        let result = apply_delta(source, &delta).unwrap();
        assert_eq!(result, target);
    }

    #[test]
    fn test_create_delta_identical() {
        let source = b"Same content here";
        let target = b"Same content here";

        let delta = create_delta(source, target);
        let result = apply_delta(source, &delta).unwrap();
        assert_eq!(result, target);

        // Delta should be much smaller than original
        assert!(delta.len() < source.len());
    }

    #[test]
    fn test_encode_decode_int() {
        // Test that encode_int is inverse of decode_int
        for value in [0, 1, 63, 64, 100, 1000, 10000, 100000] {
            let encoded = encode_int(value);
            let mut pos = 0;
            let decoded = decode_int(&encoded, &mut pos).unwrap();
            assert_eq!(decoded, value, "Failed for value {}", value);
        }
    }
}