omt 0.8.2-alpha

A set of tiny tools mostly used for game development. A Texture atlas packer, a font converter, a pakfile creator.
Documentation
use std::fs;
use std::fs::File;
use std::io::{BufRead, BufReader, Read, Write};
use std::string::String;

use byteorder::{LittleEndian, ReadBytesExt, WriteBytesExt};
use symlink::symlink_file;

use crate::name_map::NameMap;

#[derive(Debug, Default)]
pub struct Entry {
	//	basepath: String,
	filename:   String,
	clean_name: Option<String>,
	crc:        u32,
	size:       u32,
	pos:        u32,
	data:       Vec<u8>,
}

impl core::fmt::Display for Entry {
	fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> Result<(), core::fmt::Error> {
		write!(
			f,
			"[{:#010x}] {:#10} bytes at {:#010x} -> {}",
			self.crc,
			self.size,
			self.pos,
			if let Some(clean_name) = &self.clean_name {
				clean_name
			} else {
				&self.filename
			},
		)
	}
}
impl Entry {
	fn create(basepath: &String, filename: &String) -> Entry {
		let fullfilename = format!("{}/{}", basepath, filename);

		// :TODO: better error handling
		let size = match fs::metadata(fullfilename) {
			Ok(metadata) => metadata.len() as u32,
			Err(_) => 0,
		};

		// :TODO: calculate actual CRC name
		let downcase_name = filename.to_lowercase();
		// Ruby: .gsub( /\W\./, ' ' ) // should be 'a-zA-Z0-9_', but actual code behaves differently
		let clean_name: String = downcase_name
			.chars()
			.map(|c| match c {
				'0'..='9' => c,
				'a'..='z' => c,
				//			'A'..='Z' => c,	// already downcase
				'!'..='@' => c,
				'['..='`' => c,
				'{'..='~' => c,
				//		0x7f => c,			// ignore DEL
				_ => ' ',
			})
			.collect();

		const CRC32: crc::Crc<u32> = crc::Crc::<u32>::new(&crc::CRC_32_ISO_HDLC);
		let crc = CRC32.checksum(clean_name.as_bytes());

		println!(
			"CRC: {:?} -> {:?} crc: {:?} {:#10X}\n",
			filename, clean_name, crc, crc
		);
		//	      puts "CRC: " + filename + " -> " + name + " crc: " + @crc.to_s

		Entry {
			//			basepath: basepath.to_string(),
			filename: filename.to_string(),
			clean_name: Some(clean_name),
			crc: crc,
			size: size,
			..Default::default()
		}
	}

	fn create_from_archive(crc: u32, pos: u32, size: u32) -> Entry {
		Entry {
			//basepath: String::new(),
			filename: String::new(),
			crc: crc,
			size: size,
			pos: pos,
			..Default::default()
		}
	}

	fn load_from_archive(&mut self, data: &Vec<u8>) -> bool {
		// :TODO: find a more idomatic way
		let start = self.pos as usize;
		let end = start + self.size as usize;
		self.data.resize(self.size as usize, 0);
		self.data.clone_from_slice(&data[start..end]);

		true
	}

	#[allow(dead_code)]
	fn display(&self) {
		println!("Displaying Entry for filename {:?}", self.filename);
		print!("{:?}\n", self);
	}
}

#[derive(Debug, Default)]
pub struct Archive {
	basepath:   String,
	entries:    Vec<Entry>,
	name_map:   Option<NameMap>,
	names_only: bool,
}

impl Archive {
	pub fn create(basepath: &str) -> Archive {
		Archive {
			basepath: basepath.to_string(),
			entries: Vec::new(),
			..Default::default()
		}
	}

	pub fn give_name_map(&mut self, name_map: Option<NameMap>) {
		self.name_map = name_map;
	}

	pub fn take_name_map(&mut self) -> Option<NameMap> {
		self.name_map.take()
	}

	pub fn set_names_only(&mut self, names_only: bool) {
		self.names_only = names_only;
	}

	pub fn add_entry(&mut self, filename: &String) -> bool {
		let entry = Entry::create(&self.basepath, &filename);
		if let Some(name_map) = &mut self.name_map {
			if let Some(clean_name) = &entry.clean_name {
				name_map.insert(entry.crc, clean_name.to_string());
			}
		}

		self.entries.push(entry);

		true
	}

	fn add_entry_from_archive(&mut self, crc: u32, pos: u32, size: u32) -> bool {
		let mut entry = Entry::create_from_archive(crc, pos, size);
		if let Some(name_map) = &mut self.name_map {
			if let Some(clean_name) = &entry.clean_name {
				name_map.insert(entry.crc, clean_name.to_string());
			} else {
				entry.clean_name = name_map.get_name(crc).cloned();
				/*
				if let Some( clean_name ) = name_map.get_name( crc ) {
					entry.clean_name = clean_name.to_string();
				}
				*/
			}
		}

		self.entries.push(entry);
		true
	}

	pub fn save(&self, output: &String) -> anyhow::Result<u32> {
		// write output
		let output_file = File::create(output);
		// :TODO: rethink error handling
		let mut output_file = match output_file {
			Ok(p) => p,
			Err(_e) => anyhow::bail!("Error writing file"),
		};

		// :TODO: add error handling
		let write_names = false;
		let mut flags: u8 = 0;
		if write_names {
			flags |= 1
		}
		let number_of_files: u32 = self.entries.len() as u32;

		output_file
			.write_all(&[
				0x4f, 0x4d, 0x41, 0x52,  // magic header
				2,     // version
				flags, // flags
				0, 0, // reserved
			])
			.unwrap();
		output_file
			.write_u32::<LittleEndian>(number_of_files)
			.unwrap();

		// write the directory
		let mut pos = 0;
		for entry in &self.entries {
			// crc, pos, size all as LittleEndian u32
			output_file.write_u32::<LittleEndian>(entry.crc).unwrap();
			output_file.write_u32::<LittleEndian>(pos).unwrap();
			output_file.write_u32::<LittleEndian>(entry.size).unwrap();

			pos += entry.size;
		}

		// write data to output

		for entry in &self.entries {
			let filename = format!("{}/{}", self.basepath, entry.filename);
			//		println!("{:?}", filename );
			let data_file = File::open(&filename);
			// :TODO: rethink error handling
			let mut data_file = match data_file {
				Ok(p) => p,
				Err(_e) => anyhow::bail!("Error reading data file: {}", &filename),
			};
			let mut buffer = Vec::<u8>::new();
			data_file.read_to_end(&mut buffer).unwrap();
			output_file.write_all(&buffer).unwrap();
		}

		Ok(number_of_files)
	}

	pub fn load(&mut self, filename: &String) -> Result<u32, &'static str> {
		let file = File::open(filename);

		let file = match file {
			Ok(p) => p,
			Err(_e) => return Err("Error reading file"),
		};

		let mut bufreader = BufReader::new(file);

		// read header
		// check magic
		let magic = [0x4fu8, 0x4d, 0x41, 0x52];
		for m in &magic {
			let b = bufreader.read_u8().unwrap_or(0);
			if b != *m {
				return Err("Broken magic");
			}
		}

		let v = bufreader.read_u8().unwrap_or(0);
		if v != 2 {
			return Err("Wrong version");
		}

		let flags = bufreader.read_u8().unwrap_or(0);
		if flags != 0 {
			return Err(":TODO: Flags not implemented");
		}

		for _reserved in 0..2 {
			let r = bufreader.read_u8().unwrap_or(0);
			if r != 0 {
				return Err(":TODO: Reserved field not zero");
			}
		}

		let number_of_files = bufreader.read_u32::<LittleEndian>().unwrap_or(0);
		println!("Reading {:?} files from archive", number_of_files);

		for _e in 0..number_of_files {
			let crc = bufreader.read_u32::<LittleEndian>().unwrap_or(0);
			let pos = bufreader.read_u32::<LittleEndian>().unwrap_or(0);
			let size = bufreader.read_u32::<LittleEndian>().unwrap_or(0);
			self.add_entry_from_archive(crc, pos, size);
		}

		let mut data = Vec::new();
		bufreader.read_to_end(&mut data).unwrap();
		for entry in &mut self.entries {
			(*entry).load_from_archive(&data);
		}

		Ok(0)
	}

	pub fn unpack(&self, targetpath: &String) -> Result<u32, &'static str> {
		for entry in &self.entries {
			let filename = format!("{}/{:#010X}", targetpath, entry.crc);
			let clean_name = if let Some(name_map) = &self.name_map {
				name_map.get_name(entry.crc)
			} else {
				None
			};
			println!("{} <- {}", filename, clean_name.unwrap_or(&"".to_string()));

			let filename = if !self.names_only {
				filename
			} else {
				if let Some(clean_name) = clean_name {
					format!("{}/{}", targetpath, clean_name)
				} else {
					println!("Name for {} not found, using crc name.", filename);
					filename
				}
			};

			let output_file = File::create(&filename);
			// :TODO: rethink error handling
			let mut output_file = match output_file {
				Ok(p) => p,
				Err(_e) => return Err("Error writing file"),
			};

			output_file.write_all(&entry.data).unwrap();

			if !self.names_only {
				if let Some(clean_name) = &clean_name {
					let clean_name = format!("{}/{}", targetpath, clean_name);
					let filename = format!("{:#010X}", entry.crc);
					println!("Linking {} <- {}", filename, clean_name);
					match symlink_file(filename, clean_name) {
						Ok(()) => {},
						Err(_e) => {},
					}
				// println!("Linking {:#010x} <- {}", entry.crc, clean_name);
				} else {
					// println!("Not linking {:#010x}, no name found in map.", entry.crc);
				}
			}
		}
		Ok(0)
	}

	pub fn entries(&self) -> std::slice::Iter<'_, Entry> {
		self.entries.iter()
	}
}

pub struct Helper {}

impl Helper {
	pub fn filenames_in_file(filename: &String) -> Result<Vec<String>, &'static str> {
		let file = File::open(filename);

		let file = match file {
			Ok(p) => p,
			Err(_e) => return Err("Error reading file"),
		};

		let bufreader = BufReader::new(file);

		let mut files: Vec<String> = Vec::new();
		for line in bufreader.lines() {
			let filename = line.unwrap();
			files.push(filename);
		}

		Ok(files)
	}
}