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
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
use std::env;
use std::io;
use std::io::SeekFrom;
use std::path;
use directories::ProjectDirs;
use crate::conf;
use crate::vfs::{self, VFS};
use crate::{Context, GameError, GameResult};
pub use crate::vfs::OpenOptions;
const CONFIG_NAME: &str = "/conf.toml";
#[derive(Debug)]
pub struct Filesystem {
vfs: vfs::OverlayFS,
resources_path: path::PathBuf,
zip_path: path::PathBuf,
user_config_path: path::PathBuf,
user_data_path: path::PathBuf,
}
#[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) -> 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");
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");
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: overlay,
resources_path,
zip_path: resources_zip_path,
user_config_path: user_config_path.to_path_buf(),
user_data_path: user_data_path.to_path_buf(),
};
Ok(fs)
}
pub(crate) fn open<P: AsRef<path::Path>>(&mut self, path: P) -> GameResult<File> {
self.vfs.open(path.as_ref()).map(|f| File::VfsFile(f))
}
pub(crate) fn open_options<P: AsRef<path::Path>>(
&mut 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(crate) fn create<P: AsRef<path::Path>>(&mut self, path: P) -> GameResult<File> {
self.vfs.create(path.as_ref()).map(|f| File::VfsFile(f))
}
pub(crate) fn create_dir<P: AsRef<path::Path>>(&mut self, path: P) -> GameResult<()> {
self.vfs.mkdir(path.as_ref())
}
pub(crate) fn delete<P: AsRef<path::Path>>(&mut self, path: P) -> GameResult<()> {
self.vfs.rm(path.as_ref())
}
pub(crate) fn delete_dir<P: AsRef<path::Path>>(&mut self, path: P) -> GameResult<()> {
self.vfs.rmrf(path.as_ref())
}
pub(crate) fn exists<P: AsRef<path::Path>>(&self, path: P) -> bool {
self.vfs.exists(path.as_ref())
}
pub(crate) 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(crate) 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(crate) fn read_dir<P: AsRef<path::Path>>(
&mut 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(&mut 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(crate) fn print_all(&mut self) {
println!("{}", self.write_to_string());
}
pub(crate) fn log_all(&mut self) {
info!("{}", self.write_to_string());
}
pub(crate) fn mount(&mut 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(crate) fn add_zip_file<R: io::Read + io::Seek + 'static>(
&mut 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(crate) fn read_config(&mut 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(crate) fn write_config(&mut 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 open<P: AsRef<path::Path>>(ctx: &mut Context, path: P) -> GameResult<File> {
ctx.filesystem.open(path)
}
pub fn open_options<P: AsRef<path::Path>>(
ctx: &mut Context,
path: P,
options: OpenOptions,
) -> GameResult<File> {
ctx.filesystem.open_options(path, options)
}
pub fn create<P: AsRef<path::Path>>(ctx: &mut Context, path: P) -> GameResult<File> {
ctx.filesystem.create(path)
}
pub fn create_dir<P: AsRef<path::Path>>(ctx: &mut Context, path: P) -> GameResult {
ctx.filesystem.create_dir(path.as_ref())
}
pub fn delete<P: AsRef<path::Path>>(ctx: &mut Context, path: P) -> GameResult {
ctx.filesystem.delete(path.as_ref())
}
pub fn delete_dir<P: AsRef<path::Path>>(ctx: &mut Context, path: P) -> GameResult {
ctx.filesystem.delete_dir(path.as_ref())
}
pub fn exists<P: AsRef<path::Path>>(ctx: &Context, path: P) -> bool {
ctx.filesystem.exists(path.as_ref())
}
pub fn is_file<P: AsRef<path::Path>>(ctx: &Context, path: P) -> bool {
ctx.filesystem.is_file(path)
}
pub fn is_dir<P: AsRef<path::Path>>(ctx: &Context, path: P) -> bool {
ctx.filesystem.is_dir(path)
}
pub fn user_data_dir(ctx: &Context) -> &path::Path {
&ctx.filesystem.user_data_path
}
pub fn user_config_dir(ctx: &Context) -> &path::Path {
&ctx.filesystem.user_config_path
}
pub fn resources_dir(ctx: &Context) -> &path::Path {
&ctx.filesystem.resources_path
}
pub fn read_dir<P: AsRef<path::Path>>(
ctx: &mut Context,
path: P,
) -> GameResult<Box<dyn Iterator<Item = path::PathBuf>>> {
ctx.filesystem.read_dir(path)
}
pub fn print_all(ctx: &mut Context) {
ctx.filesystem.print_all()
}
pub fn log_all(ctx: &mut Context) {
ctx.filesystem.log_all()
}
pub fn mount(ctx: &mut Context, path: &path::Path, readonly: bool) {
ctx.filesystem.mount(path, readonly)
}
pub fn read_config(ctx: &mut Context) -> GameResult<conf::Conf> {
ctx.filesystem.read_config()
}
pub fn write_config(ctx: &mut Context, conf: &conf::Conf) -> GameResult {
ctx.filesystem.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: ofs,
resources_path: "".into(),
zip_path: "".into(),
user_config_path: "".into(),
user_data_path: "".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 mut 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 mut 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 mut 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 mut 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();
}
}