cat-dev 0.0.13

A library for interacting with the CAT-DEV hardware units distributed by Nintendo (i.e. a type of Wii-U DevKits).
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
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

//! Handle iterating over a directory, getting a file that is in a directory.

use crate::{
	errors::CatBridgeError,
	fsemul::pcfs::sata::{
		proto::{
			DirectoryItemResponse, SataFDInfo, SataReadFolderPacketBody, SataRequest, SataResponse,
		},
		server::PcfsServerState,
	},
	net::{
		additions::StreamID,
		server::requestable::{Body, State},
	},
};
use std::path::PathBuf;
use tracing::debug;

/// A filesystem error occured.
const FS_ERROR: u32 = 0xFFF0_FFE0;

/// Create a packet to then get the file information in the next file in a
/// folder.
///
/// ## Errors
///
/// If the path is too long to encode into a packet.
pub async fn handle_read_folder(
	stream: StreamID,
	State(state): State<PcfsServerState>,
	Body(request): Body<SataRequest<SataReadFolderPacketBody>>,
) -> Result<SataResponse<DirectoryItemResponse>, CatBridgeError> {
	let packet = request.body();
	let request_header = request.header().clone();

	let fd = packet.file_descriptor();
	let Ok(optional_next_item) = state
		.host_filesystem()
		.next_in_folder(fd, Some(stream.to_raw()))
		.await
	else {
		debug!(
			packet.fd = fd,
			packet.typ = "PcfsSrvReadDirectory",
			"Failed to query for next item in folder!",
		);

		return Ok(SataResponse::new(
			state.pid(),
			request_header,
			DirectoryItemResponse::new_error_code(FS_ERROR),
		));
	};
	let Some((item, components_to_remove)) = optional_next_item else {
		debug!(
			packet.fd = fd,
			packet.typ = "PcfsSrvReadDirectory",
			"No more items in directory!",
		);

		return Ok(SataResponse::new(
			state.pid(),
			request_header,
			DirectoryItemResponse::new_nothing_left(),
		));
	};

	let Ok(md) = item.metadata() else {
		debug!(
			packet.fd = fd,
			packet.typ = "PcfsSrvReadDirectory",
			"Failed to get information for next file in folder!",
		);

		return Ok(SataResponse::new(
			state.pid(),
			request_header,
			DirectoryItemResponse::new_error_code(FS_ERROR),
		));
	};
	let info = SataFDInfo::get_info(state.host_filesystem(), &md, &item).await;

	let utf8 = item
		.components()
		.skip(components_to_remove)
		.collect::<PathBuf>()
		.to_string_lossy()
		.to_string();
	if utf8.len() > 255 {
		debug!(
			packet.fd = fd,
			packet.typ = "PcfsSrvReadDirectory",
			"UTF-8 path is too long, cant serve!",
		);

		return Ok(SataResponse::new(
			state.pid(),
			request_header,
			DirectoryItemResponse::new_error_code(FS_ERROR),
		));
	}

	Ok(SataResponse::new(
		state.pid(),
		request_header,
		DirectoryItemResponse::new_next(info, utf8)?,
	))
}

#[cfg(test)]
mod unit_tests {
	use super::*;
	use crate::fsemul::{
		host_filesystem::test_helpers::{create_temporary_host_filesystem, join_many},
		pcfs::sata::proto::{SataCommandInfo, SataPacketHeader},
	};
	use bytes::Bytes;

	#[tokio::test]
	pub async fn can_handle_read_directory() {
		let (tempdir, fs) = create_temporary_host_filesystem().await;
		let mocked_header = SataPacketHeader::new(0);
		let mocked_ci = SataCommandInfo::new((0, 0), (0, 0), 0);

		let base_dir = join_many(tempdir.path(), ["data", "slc", "to-query"]);
		tokio::fs::create_dir(&base_dir)
			.await
			.expect("Failed to create temporary directory for test!");
		// Create a file to be returned.
		_ = tokio::fs::File::create(join_many(&base_dir, ["cafe.bat"]))
			.await
			.expect("Failed to create file to use!");

		let dfd = fs
			.open_folder(&base_dir, Some(1))
			.expect("Failed to open existing directory!");
		let request = SataReadFolderPacketBody::new(dfd);

		// First request should return file information, and path name.
		let actual_file_response: Bytes = handle_read_folder(
			StreamID::from_existing(1),
			State(PcfsServerState::new(false, fs.clone(), 0)),
			Body(SataRequest::new(
				mocked_header.clone(),
				mocked_ci.clone(),
				request.clone(),
			)),
		)
		.await
		.expect("Failed to handle read folder request!")
		.try_into()
		.expect("Failed to serialize read folder response!");
		assert_eq!(
			&actual_file_response[0x20..0x48],
			&[
				0x00, 0x00, 0x00, 0x00, // RC
				0x2C, 0x00, 0x00, 0x00, // We should've gotten a file.
				0x00, 0x00, 0x06, 0x66, // Permissions
				0x00, 0x00, 0x00, 0x01, // Hardcoded 1
				0x00, 0x00, 0x00, 0x01, // Hardcoded 1
				0x00, 0x00, 0x00, 0x00, // File size.
				0x00, 0x00, 0x00, 0x00, // Hardcoded 0.
				0x00, 0x00, 0x00, 0xE8, // Hardcoded E8.
				0xDA, 0x6F, 0xF0, 0x00, // Hardcoded da6ff000.
				0x00, 0x00, 0x00, 0x00, // Hardcoded 0.
			],
		);
		assert_ne!(
			&actual_file_response[0x48..0x54],
			&[0_u8, 0, 0, 0, 0, 0, 0, 0],
		);
		assert_ne!(
			&actual_file_response[0x54..0x5C],
			&[0_u8, 0, 0, 0, 0, 0, 0, 0],
		);
		assert_eq!(
			&actual_file_response[0x5C..0x78],
			&[
				0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
				0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
			],
		);
		assert_eq!(
			&actual_file_response[0x78..],
			&[
				0x63, 0x61, 0x66, 0x65, 0x2e, 0x62, 0x61, 0x74, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
				0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
				0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
				0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
				0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
				0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
				0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
				0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
				0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
				0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
				0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
				0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
				0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
				0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
				0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
				0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
				0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
				0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
				0x00, 0x00, 0x00, 0x00,
			]
		);

		// Second one is an empty response.
		let new_response: Bytes = handle_read_folder(
			StreamID::from_existing(1),
			State(PcfsServerState::new(true, fs.clone(), 0)),
			Body(SataRequest::new(mocked_header, mocked_ci, request)),
		)
		.await
		.expect("Failed to handle read folder request!")
		.try_into()
		.expect("Failed to serialize read folder response!");
		assert_eq!(&new_response[0x20..0x24], &[0xFF, 0xF0, 0xFF, 0xFC]);
		fs.close_folder(dfd, Some(1)).await;
	}
}