stfs 0.1.0

Parser for Xbox 360 STFS (Secure Transacted File System) packages
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
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

use std::fmt::Debug;
use std::io::Cursor;

use fskit::Metadata;
use fskit::VfsEntry;
use fskit::VfsTree;
use vfs::error::VfsErrorKind;
use vfs::FileSystem;
use vfs::VfsMetadata;

use crate::file_table::StfsFileEntry;
use crate::file_table::StfsFileTable;
use crate::io::ReadAt;
use crate::package::StfsPackage;

#[derive(Debug, Clone)]
pub struct StfsFileMeta {
	pub entry: StfsFileEntry,
}

impl Metadata for StfsFileMeta {
	fn len(&self) -> u64 {
		self.entry.file_size as u64
	}
}

#[derive(Debug)]
pub struct StfsVfs<S> {
	source: S,
	package: StfsPackage,
	tree: VfsTree<StfsFileMeta>,
}

impl<S> StfsVfs<S> {
	pub fn package(&self) -> &StfsPackage {
		&self.package
	}

	pub fn source(&self) -> &S {
		&self.source
	}

	pub fn tree(&self) -> &VfsTree<StfsFileMeta> {
		&self.tree
	}
}

impl<S: ReadAt> StfsVfs<S> {
	pub fn new(source: S, package: StfsPackage) -> Self {
		let tree = build_tree(&package.file_table);
		StfsVfs { source, package, tree }
	}
}

fn build_tree(file_table: &StfsFileTable) -> VfsTree<StfsFileMeta> {
	let mut builder = VfsTree::builder();
	for walk_entry in file_table.walk_files() {
		builder = builder.insert(walk_entry.path, StfsFileMeta { entry: walk_entry.entry });
	}
	builder.build()
}

impl<S: ReadAt + Debug + Send + Sync + 'static> FileSystem for StfsVfs<S> {
	fn read_dir(&self, path: &str) -> vfs::VfsResult<Box<dyn Iterator<Item = String> + Send>> {
		self.tree.vfs_read_dir(path)
	}

	fn open_file(&self, path: &str) -> vfs::VfsResult<Box<dyn vfs::SeekAndRead + Send>> {
		let entry = self.tree.vfs_lookup(path)?;
		let VfsEntry::File(meta) = entry else {
			return Err(VfsErrorKind::Other("not a file".into()).into());
		};

		let mut data = Vec::with_capacity(meta.entry.file_size);
		self.package
			.extract_file(&self.source, &mut data, &meta.entry)
			.map_err(|e| vfs::VfsError::from(VfsErrorKind::IoError(std::io::Error::other(e))))?;
		Ok(Box::new(Cursor::new(data)))
	}

	fn metadata(&self, path: &str) -> vfs::VfsResult<VfsMetadata> {
		self.tree.vfs_metadata(path)
	}

	fn exists(&self, path: &str) -> vfs::VfsResult<bool> {
		self.tree.vfs_exists(path)
	}

	fskit::read_only_fs_stubs!();
}

#[cfg(feature = "async-vfs")]
const _: () = {
	use async_trait::async_trait;
	use vfs::async_vfs::AsyncFileSystem;

	#[async_trait]
	impl<S: ReadAt + Debug + Send + Sync + 'static> AsyncFileSystem for StfsVfs<S> {
		async fn read_dir(&self, path: &str) -> vfs::VfsResult<Box<dyn Unpin + futures::Stream<Item = String> + Send>> {
			self.tree.async_vfs_read_dir(path)
		}

		async fn open_file(&self, path: &str) -> vfs::VfsResult<Box<dyn vfs::async_vfs::SeekAndRead + Send + Unpin>> {
			let entry = self.tree.vfs_lookup(path)?;
			let VfsEntry::File(meta) = entry else {
				return Err(VfsErrorKind::Other("not a file".into()).into());
			};

			let mut data = Vec::with_capacity(meta.entry.file_size);
			self.package
				.extract_file(&self.source, &mut data, &meta.entry)
				.map_err(|e| vfs::VfsError::from(VfsErrorKind::IoError(std::io::Error::other(e))))?;
			Ok(Box::new(futures::io::Cursor::new(data)))
		}

		async fn metadata(&self, path: &str) -> vfs::VfsResult<vfs::VfsMetadata> {
			self.tree.vfs_metadata(path)
		}

		async fn exists(&self, path: &str) -> vfs::VfsResult<bool> {
			self.tree.vfs_exists(path)
		}

		async fn create_dir(&self, _path: &str) -> vfs::VfsResult<()> {
			Err(VfsErrorKind::NotSupported.into())
		}

		async fn create_file(&self, _path: &str) -> vfs::VfsResult<Box<dyn futures::io::AsyncWrite + Send + Unpin>> {
			Err(VfsErrorKind::NotSupported.into())
		}

		async fn append_file(&self, _path: &str) -> vfs::VfsResult<Box<dyn futures::io::AsyncWrite + Send + Unpin>> {
			Err(VfsErrorKind::NotSupported.into())
		}

		async fn remove_file(&self, _path: &str) -> vfs::VfsResult<()> {
			Err(VfsErrorKind::NotSupported.into())
		}

		async fn remove_dir(&self, _path: &str) -> vfs::VfsResult<()> {
			Err(VfsErrorKind::NotSupported.into())
		}

		async fn copy_file(&self, _src: &str, _dest: &str) -> vfs::VfsResult<()> {
			Err(VfsErrorKind::NotSupported.into())
		}

		async fn move_file(&self, _src: &str, _dest: &str) -> vfs::VfsResult<()> {
			Err(VfsErrorKind::NotSupported.into())
		}

		async fn move_dir(&self, _src: &str, _dest: &str) -> vfs::VfsResult<()> {
			Err(VfsErrorKind::NotSupported.into())
		}
	}
};