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
//! # mca-parser
//!
//! mca-parser does exactly what it says on the tin.  It parses Minecraft's mca files into a format that
//! can be used by rust programs.
//!
//! The Minecraft Wiki is incredibly helpful for detailed information about the region format and
//! the chunks within, I'd recommend using it as a reference when using this crate:
//!
//! - [Region File Format](https://minecraft.fandom.com/wiki/Region_file_format)
//! - [Chunk format](https://minecraft.fandom.com/wiki/Chunk_format)
//!
//! ## Usage Example
//!
//! ```no_run
//! # // Not running this because we don't want it to read from file
//! # use mca_parser::ChunkPosition;
//! // Get a region from a given file
//! let my_region = mca_parser::from_file("r.0.0.mca")?;
//!
//! // Get the chunk at (0, 0)
//! if let Some(my_chunk) = my_region.get_chunk(ChunkPosition::new(0, 0)) {
//!
//!     // Get the nbt data for that chunk
//!     let my_nbt = my_chunk.get_nbt()?;
//!
//! }
//! # Ok::<(), anyhow::Error>(())
//! ```

use anyhow::{bail, Context};
use miniz_oxide::inflate;
use std::{
    collections::{
        hash_map::{Values, ValuesMut},
        HashMap,
    },
    convert::From,
    fs::{self, File},
    io::{BufReader, Error, ErrorKind, Read},
    path::PathBuf,
    vec::Vec,
};

pub mod nbt;
use nbt::ChunkNbt;

#[cfg(test)]
mod test;

/// A simple macro that converts a 4 byte array/slice/vec/etc into a u32 using big_endian
/// _This is used rather than [`u32::from_be_bytes`] because it consumes the array_
#[macro_export]
macro_rules! big_endian {
    ($arr: expr) => {{
        let val = $arr;
        ((val[0] as u32) << 24 | (val[1] as u32) << 16 | (val[2] as u32) << 8 | (val[3] as u32))
    }};
}

/// Represents a chunk's location in the region file
///
/// See <https://minecraft.fandom.com/wiki/Region_file_format#Chunk_location>
#[derive(Debug, Copy, Clone)]
pub struct Location {
    /// Represents the distance in 4096 byte sectors from the beginning of the file
    pub offset: u32, // Technically only 3 bytes, but I don't want to use a [u8; 3]

    /// Represents the count of the sectors in which the chunk data is stored.
    /// _Note: The actual size of the chunk data is probably less than `sector_count * 4096`_
    pub sector_count: u8, // Count of sectors from the beginning see the wiki for more info
}

impl From<[u8; 4]> for Location {
    fn from(value: [u8; 4]) -> Self {
        Self {
            offset: big_endian!(&[0, value[0], value[1], value[2]]),
            sector_count: value[3],
        }
    }
}

/// Represents the compression type for a chunk's payload
///
/// See <https://minecraft.fandom.com/wiki/Region_file_format#Payload>
#[derive(Debug, Clone, Copy)]
pub enum CompressionType {
    GZip,         // RFC1952   Unused in Practice
    Zlib,         // RFC1950
    Uncompressed, //           Unused in Practice
}

impl From<u8> for CompressionType {
    /// Get the CompressionType from an integer
    /// Expects 1, 2, or 3, and will return `CompressionType::Zlib` if provided with anything else
    fn from(value: u8) -> Self {
        match value {
            1 => CompressionType::GZip,
            2 => CompressionType::Zlib,
            3 => CompressionType::Uncompressed,
            _ => CompressionType::Zlib, // Default to Zlib (as that's the only one that should be used in practice)
        }
    }
}

/// Represnts a chunk's payload
///
/// See <https://minecraft.fandom.com/wiki/Region_file_format#Payload>
#[derive(Debug, Clone)]
pub struct ChunkPayload {
    pub length: u32,
    pub compression_type: CompressionType,
    pub compressed_data: Option<Vec<u8>>,
}

/// Represents all data for any given chunk that can be taken from the region file
#[derive(Debug, Clone)]
pub struct Chunk {
    pub timestamp: u32,
    pub payload: ChunkPayload,
}

impl Chunk {
    /// Get the nbt data for the chunk
    /// _Note: This uses quite a bit of memory as it needs to decompress all of the compressed data_
    pub fn get_nbt(&self) -> anyhow::Result<ChunkNbt> {
        if let Some(ref data) = self.payload.compressed_data {
            let uncompressed = inflate::decompress_to_vec_zlib(data);
            let uncompressed = uncompressed.map_err(|_| Error::from(ErrorKind::UnexpectedEof))?;
            Ok(fastnbt::from_bytes(&uncompressed).context("Error parsing nbt bytes")?)
        } else {
            bail!("Compressed data not stored.");
        }
    }

    //pub fn get_block(&self, pos: BlockPosition) -> anyhow::Result<BlockState> {
    //    self.get_nbt()?.get_block(pos)
    //}
}

#[derive(Debug, PartialEq, Eq, Default, Hash, Clone, Copy, Ord, PartialOrd)]
pub struct RegionPosition {
    pub x: i32,
    pub z: i32,
}

impl RegionPosition {
    pub fn new(x: i32, z: i32) -> Self {
        Self { x, z }
    }
}

impl From<ChunkPosition> for RegionPosition {
    fn from(value: ChunkPosition) -> Self {
        Self {
            x: value.x / 32,
            z: value.z / 32,
        }
    }
}

impl From<BlockPosition> for RegionPosition {
    fn from(value: BlockPosition) -> Self {
        Self {
            x: value.x / 16 / 32,
            z: value.z / 16 / 32,
        }
    }
}

#[derive(Debug, PartialEq, Eq, Default, Hash, Clone, Copy, Ord, PartialOrd)]
pub struct ChunkPosition {
    pub x: i32,
    pub z: i32,
}

impl ChunkPosition {
    pub fn new(x: i32, z: i32) -> Self {
        Self { x, z }
    }
}

impl From<BlockPosition> for ChunkPosition {
    fn from(value: BlockPosition) -> Self {
        Self {
            x: value.x / 16,
            z: value.z / 16,
        }
    }
}

#[derive(Debug, PartialEq, Eq, Default, Hash, Clone, Copy, Ord, PartialOrd)]
pub struct SubChunkPosition {
    pub x: i32,
    pub y: i32,
    pub z: i32,
}

impl From<BlockPosition> for SubChunkPosition {
    fn from(value: BlockPosition) -> Self {
        Self {
            x: value.x / 16,
            y: value.y / 16,
            z: value.z / 16,
        }
    }
}

#[derive(Debug, PartialEq, Eq, Default, Hash, Clone, Copy, Ord, PartialOrd)]
pub struct BlockPosition {
    pub x: i32,
    pub y: i32,
    pub z: i32,
}

/// Represents the contents of a region file
#[derive(Debug)]
pub struct Region {
    /// The list of chunks contained in this region
    pub chunks: [Option<Chunk>; 1024],
    /// Represents the coords in the world of this region in the order of (x, z)
    /// To find these from actual in-game coords, one must divide by 32 for the x and z (or >> 5)
    pub coords: RegionPosition,
}

impl Region {
    /// Return the chunk at a given x and y coordinate relative to the region or `None` if it has
    /// not been generated.
    /// To get the coords actual in-game coords, one must use `(n % 32) >> 4` where `n` is the
    /// current x or z coord.
    pub fn get_chunk(&self, ChunkPosition { x, z }: ChunkPosition) -> Option<&Chunk> {
        // This expression comes from the mcwiki,
        // see <https://minecraft.fandom.com/wiki/Region_file_format#Header>
        (&self.chunks[((x & 31) + (z & 31) * 32) as usize]).as_ref()
    }
}

/// The struct used for parsing the region data
//#[derive()]
pub struct RegionParser {
    pub path: PathBuf,
    pub locations: [Location; 1024], // 1024 * 4 byte for the locations of the chunks in the chunk data
    pub timestamps: [u32; 1024],     // 1024 * 4 byte for the timestamps of the last modifications
    pub coords: Option<RegionPosition>,
}

impl RegionParser {
    /// Create a RegionParser to do the parsing of the file
    pub fn new(path: PathBuf) -> Self {
        Self {
            path,
            locations: [Location::from([0; 4]); 1024],
            timestamps: [0; 1024],
            coords: None,
        }
    }

    /// Create a RegionParser to do the parsing of the file
    pub fn with_coords(path: PathBuf, coords: Option<RegionPosition>) -> Self {
        Self {
            path,
            locations: [Location::from([0; 4]); 1024],
            timestamps: [0; 1024],
            coords,
        }
    }

    fn parse_with_data_option(&mut self, keep_data: bool) -> anyhow::Result<Region> {
        let mut reader = BufReader::new(File::open(&self.path)?);
        let mut section = [0u8; 4 * 1024];
        reader.read(&mut section)?;
        section
            .chunks(4)
            .map(|x| TryInto::<[u8; 4]>::try_into(x).unwrap())
            .map(Location::from)
            .enumerate()
            .for_each(|(i, l)| self.locations[i] = l);

        reader.read(&mut section)?;
        section
            .chunks(4)
            .map(|b| big_endian!(b))
            .enumerate()
            .for_each(|(i, l)| self.timestamps[i] = l);

        // The rest is chunk data...
        let chunks = self.parse_chunks(reader, keep_data)?;
        let rg = Region {
            chunks,
            coords: self.coords.unwrap_or_default(),
        };
        Ok(rg)
    }

    /// Do the actual parsing for the region file
    /// The `coords` arg is used for the world location of the region (like r.0.0.mca -> (0, 0))
    pub fn parse(&mut self) -> anyhow::Result<Region> {
        self.parse_with_data_option(true)
    }

    /// Do the actual parsing for the region file
    /// The `coords` arg is used for the world location of the region (like r.0.0.mca -> (0, 0))
    pub fn parse_without_data(&mut self) -> anyhow::Result<Region> {
        self.parse_with_data_option(false)
    }

    fn parse_chunks(
        &mut self,
        mut reader: impl Read,
        keep_data: bool,
    ) -> anyhow::Result<[Option<Chunk>; 1024]> {
        // Grab the rest of the bytes as the locations are not in order and we'll have to jump
        // around the rest of the file quite a bit
        let mut rest = Vec::new();
        reader.read_to_end(&mut rest)?;

        // Each sector must be 4096 (and they're padded), so if the remaining bytes is not that
        // long, then there is something wrong.
        if rest.len() < 4096 {
            bail!(Error::from(ErrorKind::UnexpectedEof));
        }

        // This hurts me physically: https://github.com/rust-lang/rust/issues/44796#issuecomment-967747810
        const NONE_CHUNK: Option<Chunk> = None;
        let mut chunks: [Option<Chunk>; 1024] = [NONE_CHUNK; 1024];
        // Iterate over each location (could be timestamps or 0..1024) and get the chunk for that
        // location
        for (i, location) in self.locations.iter().enumerate() {
            let chunk = self.parse_chunk(location, &rest, keep_data)?;
            chunks[i] = chunk.map(|payload| Chunk {
                timestamp: self.timestamps[i],
                payload,
            });
        }
        Ok(chunks)
    }

    fn parse_chunk(
        &self,
        loc: &Location,
        bytes: &Vec<u8>,
        keep_data: bool,
    ) -> anyhow::Result<Option<ChunkPayload>> {
        if loc.offset == 0 && loc.sector_count == 0 {
            return Ok(None);
        }
        let start = (loc.offset - 2) as usize * 4096_usize; // Subtract two from the offset to
                                                            // account for the 8192 bytes that we
                                                            // took from the beginning for the
                                                            // location and timestamps
        if start + 4 > bytes.len() {
            bail!(Error::from(ErrorKind::UnexpectedEof));
        }

        let length = big_endian!(&bytes[start..(start + 4)]);
        let compression_type = CompressionType::from(bytes[start + 4]);

        let chunk_end = start + 5 + length as usize;
        if chunk_end > bytes.len() {
            bail!(Error::from(ErrorKind::UnexpectedEof));
        }

        Ok(Some(ChunkPayload {
            length,
            compression_type,
            compressed_data: keep_data.then(|| (&bytes[(start + 5)..chunk_end]).into()),
        }))
    }
}

fn pos_from_name(name: &str) -> Option<RegionPosition> {
    let parts: Vec<_> = name.split(".").collect();

    if parts.len() >= 3
        && parts[0] == "r"
        && parts[1].parse::<i32>().is_ok() // confirm that the second and third parts are nums
        && parts[2].parse::<i32>().is_ok()
    {
        Some(RegionPosition {
            x: parts[1].parse().expect("Checked in the conditional"),
            z: parts[2].parse().expect("Checked in the conditional"),
        })
    } else {
        None
    }
}

/// Parse a single ".mca" file into a Region.  This will return an error if the file is not a valid
/// Region file.  The coordinates of the region is taken from the name (r.0.0.mca -> (0, 0)), if
/// the filename does not fit this format, (0, 0) will be used
pub fn from_file(path: PathBuf) -> anyhow::Result<Region> {
    let name = path.file_name();
    if let Some(name) = name {
        let coords = pos_from_name(name.to_str().unwrap());
        let mut parser = RegionParser::with_coords(path, coords);
        let rg = parser.parse()?;

        Ok(rg)
    } else {
        bail!(Error::from(ErrorKind::InvalidInput))
    }
}

/// Represents the id for any given dimension, using the default values that Minecraft uses:
/// -1: Nether
/// 0: Overworld
/// 1: End
///
/// And `Other` for any other non-standard ids
#[derive(Debug)]
pub enum DimensionID {
    /// ID 0
    Overworld,
    /// ID -1
    Nether,
    /// ID 1
    End,
    Other(i32),
}

impl DimensionID {
    pub fn id(&self) -> i32 {
        match self {
            Self::Overworld => 0,
            Self::Nether => -1,
            Self::End => 1,
            Self::Other(n) => *n,
        }
    }
}

impl From<i32> for DimensionID {
    fn from(value: i32) -> Self {
        match value {
            0 => Self::Overworld,
            -1 => Self::Nether,
            1 => Self::End,
            n => Self::Other(n),
        }
    }
}

/// Represents a Dimension with its id and its regions
pub struct Dimension {
    pub id: DimensionID,
    pub regions: HashMap<RegionPosition, RegionParser>,
}

impl Dimension {
    /// Get a new dimension using id and path to region files
    ///
    /// Returns Result since [`Self::parsers_from_dir`] can fail
    fn new(id: Option<i32>, dir: PathBuf) -> anyhow::Result<Self> {
        Ok(Self {
            id: id.unwrap_or(0).into(),
            regions: Self::parsers_from_dir(dir)?,
        })
    }

    /// Get dimension parsers from a directory
    fn parsers_from_dir(dir: PathBuf) -> anyhow::Result<HashMap<RegionPosition, RegionParser>> {
        let dir = fs::read_dir(dir)?;
        let mut out = HashMap::new();
        for path in dir {
            let path = path?.path();
            let name = path.file_name();
            if let Some(name) = name {
                let coords = pos_from_name(name.to_str().unwrap());
                if let Some(coords) = coords {
                    let parser = RegionParser::with_coords(path, Some(coords));
                    out.insert(coords, parser);
                    continue;
                }
            }
            bail!("File path did not contain coords: {:?}", path);
        }
        Ok(out)
    }

    /// Get the regions in this Dimension
    pub fn get_regions(&self) -> Values<RegionPosition, RegionParser> {
        self.regions.values()
    }

    /// Get the regions in this Dimension
    pub fn get_regions_mut(&mut self) -> ValuesMut<RegionPosition, RegionParser> {
        self.regions.values_mut()
    }

    /// Get a specific region in this dimension using the region coordinates
    pub fn get_region(&mut self, coords: RegionPosition) -> Option<&mut RegionParser> {
        self.regions.get_mut(&coords)
    }

    /// Get a specific region in this dimension using the chunk coordinates
    pub fn get_region_at_chunk(&mut self, coords: ChunkPosition) -> Option<&mut RegionParser> {
        self.get_region(coords.into())
    }

    /// Get a specific region in this dimension using the block coordinates
    ///
    /// _Note: The `y` value is unused as it has no impact on the region chosen._
    pub fn get_region_at_block(&mut self, coords: BlockPosition) -> Option<&mut RegionParser> {
        self.get_region(coords.into())
    }
}

/// Get a Vec of Regions by parsing all region files in the current folder.  If the file does not
/// end with ".mca", then it will be ignored.
pub fn from_directory(dir: PathBuf) -> anyhow::Result<Dimension> {
    Dimension::new(None, dir)
}

/// Get a list of regions from a singleplayer world directory
///
/// A singleplayer world is formatted like this:
/// ```text
/// world/
/// ├─ region/
/// │  ├─ <regions ...>
/// ├─ DIM##/
/// │  ├─ region/
/// │  │  ├─ <regions ...>
/// ```
/// (where `<regions ...>` is the list of regions, and `DIM##` is either `DIM1` or `DIM-1`
/// This function should get the `region/` folder if present otherwise go to one of the `DIM##`
/// folders, which should make it work for server world files, since the `world/region/` folder is
/// not present for nether/end
///
/// TODO: Another function that will return all regions for all worlds in the singleplayer folder
pub fn from_singleplayer_world(_world_path: &str) -> anyhow::Result<Vec<Region>> {
    todo!()
}