use crate::{
conf,
vfs::{self, OverlayFS, VFS},
Context, GameError, GameResult,
};
use directories::ProjectDirs;
use std::{
env, io,
io::SeekFrom,
ops::DerefMut,
path,
sync::{Arc, Mutex},
};
pub use crate::vfs::OpenOptions;
const CONFIG_NAME: &str = "/conf.toml";
#[derive(Debug)]
pub struct Filesystem {
vfs: Arc<Mutex<vfs::OverlayFS>>,
resources_dir: path::PathBuf,
zip_dir: path::PathBuf,
user_config_dir: path::PathBuf,
user_data_dir: path::PathBuf,
}
pub(crate) trait InternalClone {
fn clone(&self) -> Self;
}
impl InternalClone for Filesystem {
fn clone(&self) -> Self {
Filesystem {
vfs: self.vfs.clone(),
resources_dir: self.resources_dir.clone(),
zip_dir: self.zip_dir.clone(),
user_config_dir: self.user_config_dir.clone(),
user_data_dir: self.user_data_dir.clone(),
}
}
}
#[derive(Debug)]
pub enum File {
VfsFile(Box<dyn vfs::VFile>),
}
impl io::Read for File {
fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
match *self {
File::VfsFile(ref mut f) => f.read(buf),
}
}
}
impl io::Write for File {
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
match *self {
File::VfsFile(ref mut f) => f.write(buf),
}
}
fn flush(&mut self) -> io::Result<()> {
match *self {
File::VfsFile(ref mut f) => f.flush(),
}
}
}
impl io::Seek for File {
fn seek(&mut self, pos: SeekFrom) -> io::Result<u64> {
match *self {
File::VfsFile(ref mut f) => f.seek(pos),
}
}
}
impl Filesystem {
pub fn new(
id: &str,
author: &str,
resources_dir_name: &str,
resources_zip_name: &str,
) -> GameResult<Filesystem> {
let mut root_path = env::current_exe()?;
if root_path.file_name().is_some() {
let _ = root_path.pop();
}
let mut overlay = vfs::OverlayFS::new();
let mut resources_path;
let mut resources_zip_path;
let user_data_path;
let user_config_path;
let project_dirs = match ProjectDirs::from("", author, id) {
Some(dirs) => dirs,
None => {
return Err(GameError::FilesystemError(String::from(
"No valid home directory path could be retrieved.",
)));
}
};
{
resources_path = root_path.clone();
resources_path.push(resources_dir_name);
trace!("Resources path: {:?}", resources_path);
let physfs = vfs::PhysicalFS::new(&resources_path, true);
overlay.push_back(Box::new(physfs));
}
{
resources_zip_path = root_path;
resources_zip_path.push(resources_zip_name);
if resources_zip_path.exists() {
trace!("Resources zip file: {:?}", resources_zip_path);
let zipfs = vfs::ZipFS::new(&resources_zip_path)?;
overlay.push_back(Box::new(zipfs));
} else {
trace!("No resources zip file found");
}
}
{
user_data_path = project_dirs.data_local_dir();
trace!("User-local data path: {:?}", user_data_path);
let physfs = vfs::PhysicalFS::new(user_data_path, true);
overlay.push_back(Box::new(physfs));
}
{
user_config_path = project_dirs.config_dir();
trace!("User-local configuration path: {:?}", user_config_path);
let physfs = vfs::PhysicalFS::new(user_config_path, false);
overlay.push_back(Box::new(physfs));
}
let fs = Filesystem {
vfs: Arc::new(Mutex::new(overlay)),
resources_dir: resources_path,
zip_dir: resources_zip_path,
user_config_dir: user_config_path.to_path_buf(),
user_data_dir: user_data_path.to_path_buf(),
};
Ok(fs)
}
fn vfs(&self) -> impl DerefMut<Target = OverlayFS> + '_ {
self.vfs.lock().unwrap()
}
pub fn open<P: AsRef<path::Path>>(&self, path: P) -> GameResult<File> {
self.vfs().open(path.as_ref()).map(|f| File::VfsFile(f))
}
pub fn open_options<P: AsRef<path::Path>>(
&self,
path: P,
options: OpenOptions,
) -> GameResult<File> {
self.vfs()
.open_options(path.as_ref(), options)
.map(|f| File::VfsFile(f))
.map_err(|e| {
GameError::ResourceLoadError(format!(
"Tried to open {:?} but got error: {:?}",
path.as_ref(),
e
))
})
}
pub fn create<P: AsRef<path::Path>>(&self, path: P) -> GameResult<File> {
self.vfs().create(path.as_ref()).map(|f| File::VfsFile(f))
}
pub fn create_dir<P: AsRef<path::Path>>(&self, path: P) -> GameResult<()> {
self.vfs().mkdir(path.as_ref())
}
pub fn delete<P: AsRef<path::Path>>(&self, path: P) -> GameResult<()> {
self.vfs().rm(path.as_ref())
}
pub fn delete_dir<P: AsRef<path::Path>>(&self, path: P) -> GameResult<()> {
self.vfs().rmrf(path.as_ref())
}
pub fn exists<P: AsRef<path::Path>>(&self, path: P) -> bool {
self.vfs().exists(path.as_ref())
}
pub fn is_file<P: AsRef<path::Path>>(&self, path: P) -> bool {
self.vfs()
.metadata(path.as_ref())
.map(|m| m.is_file())
.unwrap_or(false)
}
pub fn is_dir<P: AsRef<path::Path>>(&self, path: P) -> bool {
self.vfs()
.metadata(path.as_ref())
.map(|m| m.is_dir())
.unwrap_or(false)
}
pub fn read_dir<P: AsRef<path::Path>>(
&self,
path: P,
) -> GameResult<Box<dyn Iterator<Item = path::PathBuf>>> {
let itr = self.vfs().read_dir(path.as_ref())?.map(|fname| {
fname.expect("Could not read file in read_dir()? Should never happen, I hope!")
});
Ok(Box::new(itr))
}
fn write_to_string(&self) -> String {
use std::fmt::Write;
let mut s = String::new();
for vfs in self.vfs().roots() {
write!(s, "Source {:?}", vfs).expect("Could not write to string; should never happen?");
match vfs.read_dir(path::Path::new("/")) {
Ok(files) => {
for itm in files {
write!(s, " {:?}", itm)
.expect("Could not write to string; should never happen?");
}
}
Err(e) => write!(s, " Could not read source: {:?}", e)
.expect("Could not write to string; should never happen?"),
}
}
s
}
pub fn print_all(&self) {
println!("{}", self.write_to_string());
}
pub fn log_all(&self) {
info!("{}", self.write_to_string());
}
pub fn mount(&self, path: &path::Path, readonly: bool) {
let physfs = vfs::PhysicalFS::new(path, readonly);
trace!("Mounting new path: {:?}", physfs);
self.vfs().push_back(Box::new(physfs));
}
pub fn add_zip_file<R: io::Read + io::Seek + 'static>(&self, reader: R) -> GameResult<()> {
let zipfs = vfs::ZipFS::from_read(reader)?;
trace!("Adding zip file from reader");
self.vfs().push_back(Box::new(zipfs));
Ok(())
}
pub fn read_config(&self) -> GameResult<conf::Conf> {
let conf_path = path::Path::new(CONFIG_NAME);
if self.is_file(conf_path) {
let mut file = self.open(conf_path)?;
let c = conf::Conf::from_toml_file(&mut file)?;
Ok(c)
} else {
Err(GameError::ConfigError(String::from(
"Config file not found",
)))
}
}
pub fn write_config(&self, conf: &conf::Conf) -> GameResult<()> {
let conf_path = path::Path::new(CONFIG_NAME);
let mut file = self.create(conf_path)?;
conf.to_toml_file(&mut file)?;
if self.is_file(conf_path) {
Ok(())
} else {
Err(GameError::ConfigError(format!(
"Failed to write config file at {}",
conf_path.to_string_lossy()
)))
}
}
pub fn resources_dir(&self) -> &path::Path {
&self.resources_dir
}
pub fn zip_dir(&self) -> &path::Path {
&self.zip_dir
}
pub fn user_config_dir(&self) -> &path::Path {
&self.user_config_dir
}
pub fn user_data_dir(&self) -> &path::Path {
&self.user_data_dir
}
}
#[deprecated(since = "0.8.0", note = "Use `ctx.fs.open` instead")]
pub fn open<P: AsRef<path::Path>>(ctx: &Context, path: P) -> GameResult<File> {
ctx.fs.open(path)
}
#[deprecated(note = "Use `ctx.fs.open_options` instead")]
pub fn open_options<P: AsRef<path::Path>>(
ctx: &Context,
path: P,
options: OpenOptions,
) -> GameResult<File> {
ctx.fs.open_options(path, options)
}
#[deprecated(since = "0.8.0", note = "Use `ctx.fs.create` instead")]
pub fn create<P: AsRef<path::Path>>(ctx: &Context, path: P) -> GameResult<File> {
ctx.fs.create(path)
}
#[deprecated(since = "0.8.0", note = "Use `ctx.fs.create_dir` instead")]
pub fn create_dir<P: AsRef<path::Path>>(ctx: &Context, path: P) -> GameResult {
ctx.fs.create_dir(path.as_ref())
}
#[deprecated(since = "0.8.0", note = "Use `ctx.fs.delete` instead")]
pub fn delete<P: AsRef<path::Path>>(ctx: &Context, path: P) -> GameResult {
ctx.fs.delete(path.as_ref())
}
#[deprecated(since = "0.8.0", note = "Use `ctx.fs.delete_dir` instead")]
pub fn delete_dir<P: AsRef<path::Path>>(ctx: &Context, path: P) -> GameResult {
ctx.fs.delete_dir(path.as_ref())
}
#[deprecated(since = "0.8.0", note = "Use `ctx.fs.exists` instead")]
pub fn exists<P: AsRef<path::Path>>(ctx: &Context, path: P) -> bool {
ctx.fs.exists(path.as_ref())
}
#[deprecated(since = "0.8.0", note = "Use `ctx.fs.is_file` instead")]
pub fn is_file<P: AsRef<path::Path>>(ctx: &Context, path: P) -> bool {
ctx.fs.is_file(path)
}
#[deprecated(since = "0.8.0", note = "Use `ctx.fs.is_dir` instead")]
pub fn is_dir<P: AsRef<path::Path>>(ctx: &Context, path: P) -> bool {
ctx.fs.is_dir(path)
}
#[deprecated(since = "0.8.0", note = "Use `ctx.fs.user_data_dir` instead")]
pub fn user_data_dir(ctx: &Context) -> &path::Path {
ctx.fs.user_data_dir()
}
#[deprecated(since = "0.8.0", note = "Use `ctx.fs.user_config_dir` instead")]
pub fn user_config_dir(ctx: &Context) -> &path::Path {
ctx.fs.user_config_dir()
}
#[deprecated(since = "0.8.0", note = "Use `ctx.fs.resources_dir` instead")]
pub fn resources_dir(ctx: &Context) -> &path::Path {
ctx.fs.resources_dir()
}
#[deprecated(since = "0.8.0", note = "Use `ctx.fs.zip_dir` instead")]
pub fn zip_dir(ctx: &Context) -> &path::Path {
ctx.fs.zip_dir()
}
#[deprecated(since = "0.8.0", note = "Use `ctx.fs.read_dir` instead")]
pub fn read_dir<P: AsRef<path::Path>>(
ctx: &Context,
path: P,
) -> GameResult<Box<dyn Iterator<Item = path::PathBuf>>> {
ctx.fs.read_dir(path)
}
#[deprecated(since = "0.8.0", note = "Use `ctx.fs.print_all` instead")]
pub fn print_all(ctx: &Context) {
ctx.fs.print_all()
}
#[deprecated(since = "0.8.0", note = "Use `ctx.fs.log_all` instead")]
pub fn log_all(ctx: &Context) {
ctx.fs.log_all()
}
#[deprecated(since = "0.8.0", note = "Use `ctx.fs.mount` instead")]
pub fn mount(ctx: &mut Context, path: &path::Path, readonly: bool) {
ctx.fs.mount(path, readonly)
}
#[deprecated(since = "0.8.0", note = "Use `ctx.fs.read_config` instead")]
pub fn read_config(ctx: &Context) -> GameResult<conf::Conf> {
ctx.fs.read_config()
}
#[deprecated(since = "0.8.0", note = "Use `ctx.fs.write_config` instead")]
pub fn write_config(ctx: &Context, conf: &conf::Conf) -> GameResult {
ctx.fs.write_config(conf)
}
#[cfg(test)]
mod tests {
use crate::conf;
use crate::error::*;
use crate::filesystem::*;
use std::io::{Read, Write};
use std::path;
fn dummy_fs_for_tests() -> Filesystem {
let mut path = path::PathBuf::from(env!("CARGO_MANIFEST_DIR"));
path.push("resources");
let physfs = vfs::PhysicalFS::new(&path, false);
let mut ofs = vfs::OverlayFS::new();
ofs.push_front(Box::new(physfs));
Filesystem {
vfs: Arc::new(Mutex::new(ofs)),
resources_dir: "".into(),
zip_dir: "".into(),
user_config_dir: "".into(),
user_data_dir: "".into(),
}
}
#[test]
fn headless_test_file_exists() {
let f = dummy_fs_for_tests();
let tile_file = path::Path::new("/tile.png");
assert!(f.exists(tile_file));
assert!(f.is_file(tile_file));
let tile_file = path::Path::new("/oglebog.png");
assert!(!f.exists(tile_file));
assert!(!f.is_file(tile_file));
assert!(!f.is_dir(tile_file));
}
#[test]
fn headless_test_read_dir() {
let f = dummy_fs_for_tests();
let dir_contents_size = f.read_dir("/").unwrap().count();
assert!(dir_contents_size > 0);
}
#[test]
fn headless_test_create_delete_file() {
let fs = dummy_fs_for_tests();
let test_file = path::Path::new("/testfile.txt");
let bytes = b"test";
{
let mut file = fs.create(test_file).unwrap();
let _ = file.write(bytes).unwrap();
}
{
let mut buffer = Vec::new();
let mut file = fs.open(test_file).unwrap();
let _ = file.read_to_end(&mut buffer).unwrap();
assert_eq!(bytes, buffer.as_slice());
}
fs.delete(test_file).unwrap();
}
#[test]
fn headless_test_file_not_found() {
let fs = dummy_fs_for_tests();
{
let rel_file = "testfile.txt";
match fs.open(rel_file) {
Err(GameError::ResourceNotFound(_, _)) => (),
Err(e) => panic!("Invalid error for opening file with relative path: {:?}", e),
Ok(f) => panic!("Should have gotten an error but instead got {:?}!", f),
}
}
{
match fs.open("/ooglebooglebarg.txt") {
Err(GameError::ResourceNotFound(_, _)) => (),
Err(e) => panic!("Invalid error for opening nonexistent file: {}", e),
Ok(f) => panic!("Should have gotten an error but instead got {:?}", f),
}
}
}
#[test]
fn headless_test_write_config() {
let f = dummy_fs_for_tests();
let conf = conf::Conf::new();
match f.write_config(&conf) {
Ok(_) => (),
Err(e) => panic!("{:?}", e),
}
f.delete(CONFIG_NAME).unwrap();
}
}