gma-lite 0.3.4

Lite GMA (Garry's Mod Addon) archive reader/writer
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

use std::io::{self, BufWriter, Write};
use std::time::{SystemTime, UNIX_EPOCH};

use crate::{GMAFile, GmaError, HEADER, VERSION};

/// Builder for writing `.gma` archives.
///
/// Collects metadata + entries
/// and writes them to a writer with `write_to`.
pub struct Builder {
    name: String,
    steam_id64: i64,
    author: String,
    description: String,
    entries: Vec<GMAFile>,
}

impl Builder {
    #[inline]
    pub fn new(name: impl Into<String>, steam_id64: i64) -> Self {
        Self::new_with_capacity(name, steam_id64, 0)
    }

    pub fn new_with_capacity(name: impl Into<String>, steam_id64: i64, capacity: usize) -> Self {
        Self {
            name: name.into(),
            steam_id64,
            author: "unknown".into(),
            description: String::new(),
            entries: Vec::with_capacity(capacity),
        }
    }

    pub fn set_description(&mut self, desc: impl Into<String>) {
        self.description = desc.into();
    }

    pub fn set_author(&mut self, author: impl Into<String>) {
        self.author = author.into();
    }

    pub fn file_from_bytes(&mut self, name: impl Into<String>, bytes: Vec<u8>) {
        let name = name.into();
        let size = bytes.len() as i64;
        self.entries.push(GMAFile {
            name,
            content: bytes,
            size,
        });
    }

    pub fn file_from_string(&mut self, name: impl Into<String>, content: impl Into<String>) {
        self.file_from_bytes(name, content.into().into_bytes());
    }

    /// Write the archive to a writer.
    pub fn write_to<W: Write>(&self, mut w: W) -> Result<(), GmaError> {
        let mut bw = BufWriter::new(&mut w);

        // Header
        bw.write_all(HEADER)?;

        // Version
        bw.write_all(&VERSION.to_le_bytes())?;

        // SteamID64
        bw.write_all(&self.steam_id64.to_le_bytes())?;

        // Timestamp
        let unix_time = SystemTime::now()
            .duration_since(UNIX_EPOCH)
            .unwrap()
            .as_secs();
        bw.write_all(&unix_time.to_le_bytes())?;

        // Required content (unused)
        bw.write_all(&[0u8])?;

        // Addon strings
        write_cstring(&mut bw, &self.name)?;
        write_cstring(&mut bw, &self.description)?;
        write_cstring(&mut bw, &self.author)?;

        // Version (unused, int32 = 1)
        bw.write_all(&1i32.to_le_bytes())?;

        // Metadata for each file entry
        for (i, e) in self.entries.iter().enumerate() {
            // File index (1-based)
            bw.write_all(&(i as u32 + 1).to_le_bytes())?;
            // Name
            write_cstring(&mut bw, &e.name)?;
            // Size (int64)
            bw.write_all(&(e.content.len() as i64).to_le_bytes())?;
            // CRC (unused, write 0)
            bw.write_all(&0u32.to_le_bytes())?;
        }

        // End of metadata
        bw.write_all(&0u32.to_le_bytes())?;

        // File contents
        for e in &self.entries {
            bw.write_all(&e.content)?;
        }

        // End of file marker
        bw.write_all(&0u32.to_le_bytes())?;

        bw.flush()?;
        Ok(())
    }
}

fn write_cstring<W: Write>(mut w: W, s: &str) -> Result<(), GmaError> {
    if s.bytes().any(|b| b == 0) {
        return Err(
            io::Error::new(io::ErrorKind::InvalidInput, "string contains null byte").into(),
        );
    }
    w.write_all(s.as_bytes())?;
    w.write_all(&[0u8])?;
    Ok(())
}