use crate::core::char;
use crate::core::iter::FromIterator;
use crate::core::{fmt, str};
use crate::io;
use crate::io::prelude::*;
use crate::io::Cursor;
#[cfg(all(not(feature = "std"), feature = "alloc"))]
use alloc::string::String;
#[cfg(not(feature = "unicode"))]
use core::iter;
use crate::byteorder_ext::{ReadBytesExt, WriteBytesExt};
use byteorder::LittleEndian;
#[cfg(feature = "lfn")]
use crate::dir::LfnBuffer;
use crate::dir::{Dir, DirRawStream};
use crate::file::File;
use crate::fs::{FatType, FileSystem, OemCpConverter, ReadWriteSeek};
use crate::time::{Date, DateTime};
bitflags! {
#[derive(Default)]
pub struct FileAttributes: u8 {
const READ_ONLY = 0x01;
const HIDDEN = 0x02;
const SYSTEM = 0x04;
const VOLUME_ID = 0x08;
const DIRECTORY = 0x10;
const ARCHIVE = 0x20;
const LFN = Self::READ_ONLY.bits | Self::HIDDEN.bits
| Self::SYSTEM.bits | Self::VOLUME_ID.bits;
}
}
pub(crate) const DIR_ENTRY_SIZE: u64 = 32;
pub(crate) const DIR_ENTRY_DELETED_FLAG: u8 = 0xE5;
pub(crate) const DIR_ENTRY_REALLY_E5_FLAG: u8 = 0x05;
pub(crate) const SFN_SIZE: usize = 11;
pub(crate) const SFN_PADDING: u8 = b' ';
pub(crate) const LFN_PART_LEN: usize = 13;
#[cfg(feature = "lfn")]
pub(crate) const LFN_ENTRY_LAST_FLAG: u8 = 0x40;
#[cfg(feature = "unicode")]
fn char_to_uppercase(c: char) -> char::ToUppercase {
c.to_uppercase()
}
#[cfg(not(feature = "unicode"))]
fn char_to_uppercase(c: char) -> iter::Once<char> {
iter::once(c.to_ascii_uppercase())
}
#[derive(Clone, Debug, Default)]
pub(crate) struct ShortName {
name: [u8; 12],
len: u8,
}
impl ShortName {
pub(crate) fn new(raw_name: &[u8; SFN_SIZE]) -> Self {
let name_len =
raw_name[0..8].iter().rposition(|x| *x != SFN_PADDING).map(|p| p + 1).unwrap_or(0);
let ext_len =
raw_name[8..11].iter().rposition(|x| *x != SFN_PADDING).map(|p| p + 1).unwrap_or(0);
let mut name = [SFN_PADDING; 12];
name[..name_len].copy_from_slice(&raw_name[..name_len]);
let total_len = if ext_len > 0 {
name[name_len] = b'.';
name[name_len + 1..name_len + 1 + ext_len].copy_from_slice(&raw_name[8..8 + ext_len]);
name_len + 1 + ext_len
} else {
name_len
};
if name[0] == DIR_ENTRY_REALLY_E5_FLAG {
name[0] = 0xE5;
}
ShortName { name, len: total_len as u8 }
}
fn as_bytes(&self) -> &[u8] {
&self.name[..self.len as usize]
}
#[cfg(feature = "alloc")]
fn to_string<OCC: OemCpConverter>(&self, oem_cp_converter: &OCC) -> String {
let char_iter = self.as_bytes().iter().cloned().map(|c| oem_cp_converter.decode(c));
String::from_iter(char_iter)
}
fn eq_ignore_case<OCC: OemCpConverter>(&self, name: &str, oem_cp_converter: &OCC) -> bool {
let byte_iter = self.as_bytes().iter().cloned();
let char_iter = byte_iter.map(|c| oem_cp_converter.decode(c));
let uppercase_char_iter = char_iter.flat_map(char_to_uppercase);
uppercase_char_iter.eq(name.chars().flat_map(char_to_uppercase))
}
}
#[allow(dead_code)]
#[derive(Clone, Debug, Default)]
pub(crate) struct DirFileEntryData {
name: [u8; SFN_SIZE],
attrs: FileAttributes,
reserved_0: u8,
create_time_0: u8,
create_time_1: u16,
create_date: u16,
access_date: u16,
first_cluster_hi: u16,
modify_time: u16,
modify_date: u16,
first_cluster_lo: u16,
size: u32,
}
impl DirFileEntryData {
pub(crate) fn new(name: [u8; SFN_SIZE], attrs: FileAttributes) -> Self {
DirFileEntryData { name, attrs, ..Default::default() }
}
pub(crate) fn renamed(&self, new_name: [u8; SFN_SIZE]) -> Self {
let mut sfn_entry = self.clone();
sfn_entry.name = new_name;
sfn_entry
}
pub(crate) fn name(&self) -> &[u8; SFN_SIZE] {
&self.name
}
#[cfg(feature = "alloc")]
fn lowercase_name(&self) -> ShortName {
let mut name_copy: [u8; SFN_SIZE] = self.name;
if self.lowercase_basename() {
for c in &mut name_copy[..8] {
*c = (*c as char).to_ascii_lowercase() as u8;
}
}
if self.lowercase_ext() {
for c in &mut name_copy[8..] {
*c = (*c as char).to_ascii_lowercase() as u8;
}
}
ShortName::new(&name_copy)
}
pub(crate) fn first_cluster(&self, fat_type: FatType) -> Option<u32> {
let first_cluster_hi = if fat_type == FatType::Fat32 { self.first_cluster_hi } else { 0 };
let n = ((first_cluster_hi as u32) << 16) | self.first_cluster_lo as u32;
if n == 0 {
None
} else {
Some(n)
}
}
pub(crate) fn set_first_cluster(&mut self, cluster: Option<u32>, fat_type: FatType) {
let n = cluster.unwrap_or(0);
if fat_type == FatType::Fat32 {
self.first_cluster_hi = (n >> 16) as u16;
}
self.first_cluster_lo = (n & 0xFFFF) as u16;
}
pub(crate) fn size(&self) -> Option<u32> {
if self.is_file() {
Some(self.size)
} else {
None
}
}
fn set_size(&mut self, size: u32) {
self.size = size;
}
pub(crate) fn is_dir(&self) -> bool {
self.attrs.contains(FileAttributes::DIRECTORY)
}
fn is_file(&self) -> bool {
!self.is_dir()
}
fn lowercase_basename(&self) -> bool {
self.reserved_0 & (1 << 3) != 0
}
fn lowercase_ext(&self) -> bool {
self.reserved_0 & (1 << 4) != 0
}
pub(crate) fn created(&self) -> DateTime {
DateTime::decode(self.create_date, self.create_time_1, self.create_time_0)
}
pub(crate) fn accessed(&self) -> Date {
Date::decode(self.access_date)
}
pub(crate) fn modified(&self) -> DateTime {
DateTime::decode(self.modify_date, self.modify_time, 0)
}
pub(crate) fn set_created(&mut self, date_time: DateTime) {
self.create_date = date_time.date.encode();
let encoded_time = date_time.time.encode();
self.create_time_1 = encoded_time.0;
self.create_time_0 = encoded_time.1;
}
pub(crate) fn set_accessed(&mut self, date: Date) {
self.access_date = date.encode();
}
pub(crate) fn set_modified(&mut self, date_time: DateTime) {
self.modify_date = date_time.date.encode();
self.modify_time = date_time.time.encode().0;
}
pub(crate) fn serialize<W: Write>(&self, wrt: &mut W) -> io::Result<()> {
wrt.write_all(&self.name)?;
wrt.write_u8(self.attrs.bits())?;
wrt.write_u8(self.reserved_0)?;
wrt.write_u8(self.create_time_0)?;
wrt.write_u16::<LittleEndian>(self.create_time_1)?;
wrt.write_u16::<LittleEndian>(self.create_date)?;
wrt.write_u16::<LittleEndian>(self.access_date)?;
wrt.write_u16::<LittleEndian>(self.first_cluster_hi)?;
wrt.write_u16::<LittleEndian>(self.modify_time)?;
wrt.write_u16::<LittleEndian>(self.modify_date)?;
wrt.write_u16::<LittleEndian>(self.first_cluster_lo)?;
wrt.write_u32::<LittleEndian>(self.size)?;
Ok(())
}
pub(crate) fn is_deleted(&self) -> bool {
self.name[0] == DIR_ENTRY_DELETED_FLAG
}
pub(crate) fn set_deleted(&mut self) {
self.name[0] = DIR_ENTRY_DELETED_FLAG;
}
pub(crate) fn is_end(&self) -> bool {
self.name[0] == 0
}
pub(crate) fn is_volume(&self) -> bool {
self.attrs.contains(FileAttributes::VOLUME_ID)
}
}
#[allow(dead_code)]
#[derive(Clone, Debug, Default)]
pub(crate) struct DirLfnEntryData {
order: u8,
name_0: [u16; 5],
attrs: FileAttributes,
entry_type: u8,
checksum: u8,
name_1: [u16; 6],
reserved_0: u16,
name_2: [u16; 2],
}
impl DirLfnEntryData {
pub(crate) fn new(order: u8, checksum: u8) -> Self {
DirLfnEntryData { order, checksum, attrs: FileAttributes::LFN, ..Default::default() }
}
pub(crate) fn copy_name_from_slice(&mut self, lfn_part: &[u16; LFN_PART_LEN]) {
self.name_0.copy_from_slice(&lfn_part[0..5]);
self.name_1.copy_from_slice(&lfn_part[5..5 + 6]);
self.name_2.copy_from_slice(&lfn_part[11..11 + 2]);
}
pub(crate) fn copy_name_to_slice(&self, lfn_part: &mut [u16]) {
debug_assert!(lfn_part.len() == LFN_PART_LEN);
lfn_part[0..5].copy_from_slice(&self.name_0);
lfn_part[5..11].copy_from_slice(&self.name_1);
lfn_part[11..13].copy_from_slice(&self.name_2);
}
pub(crate) fn serialize<W: Write>(&self, wrt: &mut W) -> io::Result<()> {
wrt.write_u8(self.order)?;
for ch in self.name_0.iter() {
wrt.write_u16::<LittleEndian>(*ch)?;
}
wrt.write_u8(self.attrs.bits())?;
wrt.write_u8(self.entry_type)?;
wrt.write_u8(self.checksum)?;
for ch in self.name_1.iter() {
wrt.write_u16::<LittleEndian>(*ch)?;
}
wrt.write_u16::<LittleEndian>(self.reserved_0)?;
for ch in self.name_2.iter() {
wrt.write_u16::<LittleEndian>(*ch)?;
}
Ok(())
}
pub(crate) fn order(&self) -> u8 {
self.order
}
pub(crate) fn checksum(&self) -> u8 {
self.checksum
}
pub(crate) fn is_deleted(&self) -> bool {
self.order == DIR_ENTRY_DELETED_FLAG
}
pub(crate) fn set_deleted(&mut self) {
self.order = DIR_ENTRY_DELETED_FLAG;
}
pub(crate) fn is_end(&self) -> bool {
self.order == 0
}
}
#[derive(Clone, Debug)]
pub(crate) enum DirEntryData {
File(DirFileEntryData),
Lfn(DirLfnEntryData),
}
impl DirEntryData {
pub(crate) fn serialize<W: Write>(&self, wrt: &mut W) -> io::Result<()> {
match self {
DirEntryData::File(file) => file.serialize(wrt),
DirEntryData::Lfn(lfn) => lfn.serialize(wrt),
}
}
pub(crate) fn deserialize<R: Read>(rdr: &mut R) -> io::Result<Self> {
let mut name = [0; SFN_SIZE];
match rdr.read_exact(&mut name) {
Err(ref err) if err.kind() == io::ErrorKind::UnexpectedEof => {
return Ok(DirEntryData::File(DirFileEntryData { ..Default::default() }));
}
Err(err) => return Err(err),
_ => {}
}
let attrs = FileAttributes::from_bits_truncate(rdr.read_u8()?);
if attrs & FileAttributes::LFN == FileAttributes::LFN {
let mut data = DirLfnEntryData { attrs, ..Default::default() };
let mut cur = Cursor::new(&name);
data.order = cur.read_u8()?;
cur.read_u16_into::<LittleEndian>(&mut data.name_0)?;
data.entry_type = rdr.read_u8()?;
data.checksum = rdr.read_u8()?;
rdr.read_u16_into::<LittleEndian>(&mut data.name_1)?;
data.reserved_0 = rdr.read_u16::<LittleEndian>()?;
rdr.read_u16_into::<LittleEndian>(&mut data.name_2)?;
Ok(DirEntryData::Lfn(data))
} else {
let data = DirFileEntryData {
name,
attrs,
reserved_0: rdr.read_u8()?,
create_time_0: rdr.read_u8()?,
create_time_1: rdr.read_u16::<LittleEndian>()?,
create_date: rdr.read_u16::<LittleEndian>()?,
access_date: rdr.read_u16::<LittleEndian>()?,
first_cluster_hi: rdr.read_u16::<LittleEndian>()?,
modify_time: rdr.read_u16::<LittleEndian>()?,
modify_date: rdr.read_u16::<LittleEndian>()?,
first_cluster_lo: rdr.read_u16::<LittleEndian>()?,
size: rdr.read_u32::<LittleEndian>()?,
};
Ok(DirEntryData::File(data))
}
}
pub(crate) fn is_deleted(&self) -> bool {
match self {
DirEntryData::File(file) => file.is_deleted(),
DirEntryData::Lfn(lfn) => lfn.is_deleted(),
}
}
pub(crate) fn set_deleted(&mut self) {
match self {
DirEntryData::File(file) => file.set_deleted(),
DirEntryData::Lfn(lfn) => lfn.set_deleted(),
}
}
pub(crate) fn is_end(&self) -> bool {
match self {
DirEntryData::File(file) => file.is_end(),
DirEntryData::Lfn(lfn) => lfn.is_end(),
}
}
}
#[derive(Clone, Debug)]
pub(crate) struct DirEntryEditor {
data: DirFileEntryData,
pos: u64,
pub(crate) offset_range: (u64, u64),
dirty: bool,
}
impl DirEntryEditor {
fn new(data: DirFileEntryData, pos: u64, offset_range: (u64, u64)) -> Self {
DirEntryEditor { data, pos, offset_range, dirty: false }
}
pub(crate) fn inner(&self) -> &DirFileEntryData {
&self.data
}
pub(crate) fn mark_deleted(&mut self) {
assert!(!self.data.is_deleted());
self.data.set_deleted();
self.dirty = false;
}
pub(crate) fn set_first_cluster(&mut self, first_cluster: Option<u32>, fat_type: FatType) {
if first_cluster != self.data.first_cluster(fat_type) {
self.data.set_first_cluster(first_cluster, fat_type);
self.maybe_set_dirty();
}
}
pub(crate) fn set_size(&mut self, size: u32) {
match self.data.size() {
Some(n) if size != n => {
self.data.set_size(size);
self.maybe_set_dirty();
}
_ => {}
}
}
pub(crate) fn set_created(&mut self, date_time: DateTime) {
if date_time != self.data.created() {
self.data.set_created(date_time);
self.maybe_set_dirty();
}
}
pub(crate) fn set_accessed(&mut self, date: Date) {
if date != self.data.accessed() {
self.data.set_accessed(date);
self.maybe_set_dirty();
}
}
pub(crate) fn set_modified(&mut self, date_time: DateTime) {
if date_time != self.data.modified() {
self.data.set_modified(date_time);
self.maybe_set_dirty();
}
}
pub(crate) fn flush<IO: ReadWriteSeek, TP, OCC>(
&mut self,
fs: &FileSystem<IO, TP, OCC>,
) -> io::Result<()> {
if self.dirty {
self.write(fs)?;
self.dirty = false;
}
Ok(())
}
fn maybe_set_dirty(&mut self) {
if !self.data.is_deleted() {
self.dirty = true;
}
}
fn write<IO: ReadWriteSeek, TP, OCC>(&self, fs: &FileSystem<IO, TP, OCC>) -> io::Result<()> {
let mut disk = fs.disk.borrow_mut();
disk.seek(io::SeekFrom::Start(self.pos))?;
self.data.serialize(&mut *disk)
}
}
#[derive(Clone)]
pub struct DirEntry<'a, IO: ReadWriteSeek, TP, OCC> {
pub(crate) data: DirFileEntryData,
pub(crate) short_name: ShortName,
#[cfg(feature = "lfn")]
pub(crate) lfn_utf16: LfnBuffer,
pub(crate) entry_pos: u64,
pub(crate) offset_range: (u64, u64),
pub(crate) fs: &'a FileSystem<IO, TP, OCC>,
}
impl<'a, IO: ReadWriteSeek, TP, OCC: OemCpConverter> DirEntry<'a, IO, TP, OCC> {
#[cfg(feature = "alloc")]
pub fn short_file_name(&self) -> String {
self.short_name.to_string(&self.fs.options.oem_cp_converter)
}
pub fn short_file_name_as_bytes(&self) -> &[u8] {
self.short_name.as_bytes()
}
#[cfg(feature = "lfn")]
pub fn long_file_name_as_ucs2_units(&self) -> Option<&[u16]> {
if self.lfn_utf16.len() > 0 {
Some(self.lfn_utf16.as_ucs2_units())
} else {
None
}
}
#[cfg(feature = "alloc")]
pub fn file_name(&self) -> String {
#[cfg(feature = "lfn")]
{
let lfn_opt = self.long_file_name_as_ucs2_units();
if let Some(lfn) = lfn_opt {
return String::from_utf16_lossy(lfn);
}
}
self.data.lowercase_name().to_string(&self.fs.options.oem_cp_converter)
}
pub fn attributes(&self) -> FileAttributes {
self.data.attrs
}
pub fn is_dir(&self) -> bool {
self.data.is_dir()
}
pub fn is_file(&self) -> bool {
self.data.is_file()
}
pub(crate) fn first_cluster(&self) -> Option<u32> {
self.data.first_cluster(self.fs.fat_type())
}
pub(crate) fn editor(&self) -> DirEntryEditor {
DirEntryEditor::new(self.data.clone(), self.entry_pos, self.offset_range)
}
pub(crate) fn is_same_entry(&self, other: &DirEntry<IO, TP, OCC>) -> bool {
self.entry_pos == other.entry_pos
}
pub fn to_file(&self) -> File<'a, IO, TP, OCC> {
assert!(!self.is_dir(), "Not a file entry");
File::new(self.first_cluster(), Some(self.editor()), self.fs)
}
pub fn to_dir(&self) -> Dir<'a, IO, TP, OCC> {
assert!(self.is_dir(), "Not a directory entry");
match self.first_cluster() {
Some(n) => {
let file = File::new(Some(n), Some(self.editor()), self.fs);
Dir::new(DirRawStream::File(Some(file)), self.fs, false)
}
None => self.fs.root_dir(),
}
}
pub fn len(&self) -> u64 {
self.data.size as u64
}
pub fn created(&self) -> DateTime {
self.data.created()
}
pub fn accessed(&self) -> Date {
self.data.accessed()
}
pub fn modified(&self) -> DateTime {
self.data.modified()
}
pub(crate) fn raw_short_name(&self) -> &[u8; SFN_SIZE] {
&self.data.name
}
#[cfg(feature = "lfn")]
fn eq_name_lfn(&self, name: &str) -> bool {
if let Some(lfn) = self.long_file_name_as_ucs2_units() {
if char::decode_utf16(lfn.iter().cloned()).any(|r| r.is_err()) {
return false;
}
let self_name_uppercase_iter = char::decode_utf16(lfn.iter().cloned())
.map(|r| r.unwrap())
.flat_map(char_to_uppercase);
let other_name_uppercase_iter = name.chars().flat_map(char_to_uppercase);
if self_name_uppercase_iter.eq(other_name_uppercase_iter) {
return true;
}
}
false
}
pub fn eq_name(&self, name: &str) -> bool {
#[cfg(feature = "lfn")]
{
if self.eq_name_lfn(name) {
return true;
}
}
self.short_name.eq_ignore_case(name, &self.fs.options.oem_cp_converter)
}
}
impl<IO: ReadWriteSeek, TP, OCC> fmt::Debug for DirEntry<'_, IO, TP, OCC> {
fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
self.data.fmt(f)
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::fs::LossyOemCpConverter;
#[test]
fn short_name_with_ext() {
let oem_cp_conv = LossyOemCpConverter::new();
assert_eq!(ShortName::new(b"FOO BAR").to_string(&oem_cp_conv), "FOO.BAR");
assert_eq!(ShortName::new(b"LOOK AT M E").to_string(&oem_cp_conv), "LOOK AT.M E");
assert_eq!(
ShortName::new(b"\x99OOK AT M \x99").to_string(&oem_cp_conv),
"\u{FFFD}OOK AT.M \u{FFFD}"
);
assert_eq!(
ShortName::new(b"\x99OOK AT M \x99")
.eq_ignore_case("\u{FFFD}OOK AT.M \u{FFFD}", &oem_cp_conv),
true
);
}
#[test]
fn short_name_without_ext() {
let oem_cp_conv = LossyOemCpConverter::new();
assert_eq!(ShortName::new(b"FOO ").to_string(&oem_cp_conv), "FOO");
assert_eq!(ShortName::new(&b"LOOK AT ").to_string(&oem_cp_conv), "LOOK AT");
}
#[test]
fn short_name_eq_ignore_case() {
let oem_cp_conv = LossyOemCpConverter::new();
let raw_short_name: &[u8; SFN_SIZE] = b"\x99OOK AT M \x99";
assert_eq!(
ShortName::new(raw_short_name)
.eq_ignore_case("\u{FFFD}OOK AT.M \u{FFFD}", &oem_cp_conv),
true
);
assert_eq!(
ShortName::new(raw_short_name)
.eq_ignore_case("\u{FFFD}ook AT.m \u{FFFD}", &oem_cp_conv),
true
);
}
#[test]
fn short_name_05_changed_to_e5() {
let raw_short_name = [0x05; SFN_SIZE];
assert_eq!(
ShortName::new(&raw_short_name).as_bytes(),
[0xE5, 0x05, 0x05, 0x05, 0x05, 0x05, 0x05, 0x05, b'.', 0x05, 0x05, 0x05]
);
}
#[test]
fn lowercase_short_name() {
let oem_cp_conv = LossyOemCpConverter::new();
let raw_short_name: &[u8; SFN_SIZE] = b"FOO RS ";
let mut raw_entry = DirFileEntryData {
name: *raw_short_name,
reserved_0: (1 << 3) | (1 << 4),
..Default::default()
};
assert_eq!(raw_entry.lowercase_name().to_string(&oem_cp_conv), "foo.rs");
raw_entry.reserved_0 = 1 << 3;
assert_eq!(raw_entry.lowercase_name().to_string(&oem_cp_conv), "foo.RS");
raw_entry.reserved_0 = 1 << 4;
assert_eq!(raw_entry.lowercase_name().to_string(&oem_cp_conv), "FOO.rs");
raw_entry.reserved_0 = 0;
assert_eq!(raw_entry.lowercase_name().to_string(&oem_cp_conv), "FOO.RS");
}
}