Bugfix: set/query FILE_QUOTA_INFORMATION (#137)

- Add CLI `info --show-quota`
- Remove test (samba requires too much setup for now :()

misc:
- Remove `unwrap_*` methods in query/set cast types
- Add some doc
- Add `Boolean::Into<bool>`
- Add macro for generating `Resource` casts

Author: afiffon

crates/smb-cli/src/info.rs

@@ -4,8 +4,8 @@ use clap::{Parser, ValueEnum};
 use futures_util::StreamExt;
 use maybe_async::*;
 use smb::{
-    Client, FileAccessMask, FileBasicInformation, FileIdBothDirectoryInformation, UncPath,
-    resource::*,
+    Client, FileAccessMask, FileBasicInformation, FileIdBothDirectoryInformation, QueryQuotaInfo,
+    UncPath, resource::*,
 };
 use std::collections::VecDeque;
 use std::fmt::Display;
@@ -39,6 +39,11 @@ pub struct InfoCmd {
     #[arg(short, long)]
     #[clap(default_value_t = RecursiveMode::NonRecursive)]
     pub recursive: RecursiveMode,
+
+    /// Whether to display quota information on the directory being queried.
+    #[arg(long)]
+    #[clap(default_value_t = false)]
+    pub show_quota: bool,
 }
 
 #[maybe_async]
@@ -80,14 +85,17 @@ pub async fn info(cmd: &InfoCmd, cli: &Cli) -> Result<(), Box<dyn Error>> {
         }
         Resource::Directory(dir) => {
             let dir = Arc::new(dir);
+            if cmd.show_quota {
+                try_query_and_show_quota(&dir).await;
+            }
             iterate_directory(
                 &dir,
                 &cmd.path,
                 "*",
                 &IterateParams {
-                    display_func: &display_item_info,
                     client: &client,
                     recursive: cmd.recursive,
+                    show_quota: cmd.show_quota,
                 },
             )
             .await?;
@@ -104,8 +112,6 @@ pub async fn info(cmd: &InfoCmd, cli: &Cli) -> Result<(), Box<dyn Error>> {
     Ok(())
 }
 
-type DisplayFunc = dyn Fn(&FileIdBothDirectoryInformation, &UncPath);
-
 fn display_item_info(info: &FileIdBothDirectoryInformation, dir_path: &UncPath) {
     if info.file_name == "." || info.file_name == ".." {
         return; // Skip current and parent directory entries
@@ -122,26 +128,40 @@ fn display_item_info(info: &FileIdBothDirectoryInformation, dir_path: &UncPath)
     }
 }
 
+fn display_quota_info(info: &Vec<smb::FileQuotaInformation>) {
+    for quota in info {
+        if quota.quota_limit == u64::MAX && quota.quota_threshold == u64::MAX {
+            log::trace!("Skipping quota for SID {} with no limit", quota.sid);
+            continue; // No quota set
+        }
+        log::info!(
+            "Quota for SID {}: used {}, threshold {}, limit {}",
+            quota.sid,
+            get_size_string(quota.quota_used),
+            get_size_string(quota.quota_threshold),
+            get_size_string(quota.quota_limit)
+        );
+    }
+}
+
 fn get_size_string(size_bytes: u64) -> String {
     const KB: u64 = 1024;
     const MB: u64 = 1024 * KB;
     const GB: u64 = 1024 * MB;
 
-    if size_bytes >= GB {
-        format!("{:.2} GB", size_bytes as f64 / GB as f64)
-    } else if size_bytes >= MB {
-        format!("{:.2} MB", size_bytes as f64 / MB as f64)
-    } else if size_bytes >= KB {
-        format!("{:.2} kB", size_bytes as f64 / KB as f64)
-    } else {
-        format!("{} bytes", size_bytes)
+    match size_bytes {
+        x if x == u64::MAX => "∞".to_string(),
+        x if x >= GB => format!("{:.2} GB", x as f64 / GB as f64),
+        x if x >= MB => format!("{:.2} MB", x as f64 / MB as f64),
+        x if x >= KB => format!("{:.2} kB", x as f64 / KB as f64),
+        x => format!("{} B", x),
     }
 }
 
 struct IterateParams<'a> {
-    display_func: &'a DisplayFunc,
     client: &'a Client,
     recursive: RecursiveMode,
+    show_quota: bool,
 }
 struct IteratedItem {
     dir: Arc<Directory>,
@@ -207,9 +227,9 @@ async fn handle_iteration_item(
     dir_path: &UncPath,
     params: &IterateParams<'_>,
 ) -> Option<IteratedItem> {
-    (params.display_func)(info, dir_path);
+    display_item_info(info, dir_path);
 
-    if params.recursive < RecursiveMode::List {
+    if params.recursive < RecursiveMode::List && !params.show_quota {
         return None;
     }
 
@@ -231,18 +251,44 @@ async fn handle_iteration_item(
         return None;
     }
 
-    let dir: Result<Directory, _> = dir_result.unwrap().try_into();
-    match dir {
-        Ok(dir) => Some(IteratedItem {
-            dir: Arc::new(dir),
-            path: path_of_subdir,
-        }),
-        _ => {
+    let dir = dir_result.unwrap();
+
+    let dir: Directory = match dir.try_into() {
+        Ok(dir) => dir,
+        Err(e) => {
             log::warn!(
-                "Failed to convert resource to directory for {}",
+                "Failed to convert resource to directory {}: {}",
                 path_of_subdir,
+                e.0
             );
-            None
+            return None;
         }
+    };
+
+    // Quota information
+    if params.show_quota {
+        try_query_and_show_quota(&dir).await;
+    }
+
+    // Recursion
+    if params.recursive >= RecursiveMode::List {
+        Some(IteratedItem {
+            dir: Arc::new(dir),
+            path: path_of_subdir,
+        })
+    } else {
+        dir.close().await.ok()?;
+        None
+    }
+}
+
+#[maybe_async]
+async fn try_query_and_show_quota(dir: &Directory) {
+    match dir
+        .query_quota_info(QueryQuotaInfo::new(false, true, vec![]))
+        .await
+    {
+        Ok(qi) => display_quota_info(&qi),
+        Err(e) => log::warn!("Failed to query quota info: {}", e),
     }
 }

crates/smb-dtyp/src/binrw_util/helpers.rs

@@ -125,6 +125,12 @@ impl From<bool> for Boolean {
     }
 }
 
+impl From<Boolean> for bool {
+    fn from(val: Boolean) -> Self {
+        val.0
+    }
+}
+
 /// A MultiSz (Multiple Null-terminated Wide Strings) type that reads and writes a sequence of
 /// null-terminated wide strings, ending with an additional null string.
 ///

crates/smb-fscc/src/lib.rs

@@ -15,18 +15,18 @@
 
 #![allow(unused_parens)]
 
-use binrw::{io::TakeSeekExt, meta::ReadEndian, prelude::*};
+use binrw::{meta::ReadEndian, prelude::*};
 use modular_bitfield::prelude::*;
 use smb_dtyp::access_mask;
 
-use smb_dtyp::SID;
 use smb_dtyp::binrw_util::prelude::*;
 pub mod chained_item;
 pub mod common_info;
 pub mod directory_info;
 pub mod error;
 pub mod filesystem_info;
 pub mod query_file_info;
+pub mod quota;
 pub mod set_file_info;
 
 pub use chained_item::{ChainedItem, ChainedItemList};
@@ -35,6 +35,7 @@ pub use directory_info::*;
 pub use error::SmbFsccError;
 pub use filesystem_info::*;
 pub use query_file_info::*;
+pub use quota::*;
 pub use set_file_info::*;
 
 /// MS-FSCC 2.6
@@ -261,31 +262,3 @@ macro_rules! file_info_classes {
         }
     }
 }
-
-#[binrw::binrw]
-#[derive(Debug)]
-pub struct FileQuotaInformationInner {
-    #[bw(calc = PosMarker::default())]
-    sid_length: PosMarker<u32>,
-    pub change_time: FileTime,
-    pub quota_used: u64,
-    pub quota_threshold: u64,
-    pub quota_limit: u64,
-    #[br(map_stream = |s| s.take_seek(sid_length.value as u64))]
-    #[bw(write_with = PosMarker::write_size, args(&sid_length))]
-    pub sid: SID,
-}
-
-pub type FileQuotaInformation = ChainedItem<FileQuotaInformationInner>;
-
-#[binrw::binrw]
-#[derive(Debug)]
-pub struct FileGetQuotaInformationInner {
-    #[bw(calc = PosMarker::default())]
-    sid_length: PosMarker<u32>,
-    #[br(map_stream = |s| s.take_seek(sid_length.value as u64))]
-    #[bw(write_with = PosMarker::write_size, args(&sid_length))]
-    pub sid: SID,
-}
-
-pub type FileGetQuotaInformation = ChainedItem<FileGetQuotaInformationInner>;

crates/smb-fscc/src/quota.rs

@@ -0,0 +1,45 @@
+use crate::ChainedItem;
+use binrw::{io::TakeSeekExt, prelude::*};
+use smb_dtyp::SID;
+use smb_dtyp::binrw_util::prelude::*;
+
+/// This information class is used to query or to set file quota information for a volume.
+/// For queries, an optional buffer of FILE_GET_QUOTA_INFORMATION (section 2.4.41.1) data elements is provided by the client to specify the SIDs for which quota information is requested.
+/// If the FILE_GET_QUOTA_INFORMATION buffer is not specified, information for all quotas is returned.
+/// A buffer of FILE_QUOTA_INFORMATION data elements is returned by the server.
+/// For sets, FILE_QUOTA_INFORMATION data elements are populated and sent by the client,
+/// as specified in [MS-SMB] section 2.2.7.6.1 and [MS-SMB2] section 3.2.4.15.<145>
+///
+/// [MS-FSCC 2.4.41](<https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-fscc/acdc0738-ba3c-47a1-b11a-72e22d831c57>)
+///
+/// _Note_: This structure is partial: it does not contain the NextEntryOffset field, as it is intended to be used
+/// in a chained list, see [`ChainedItem<T>`] and [`ChainedItemList<T>`].
+#[binrw::binrw]
+#[derive(Debug)]
+pub struct FileQuotaInformation {
+    #[bw(calc = PosMarker::default())]
+    sid_length: PosMarker<u32>,
+    pub change_time: FileTime,
+    pub quota_used: u64,
+    pub quota_threshold: u64,
+    pub quota_limit: u64,
+    #[br(map_stream = |s| s.take_seek(sid_length.value as u64))]
+    #[bw(write_with = PosMarker::write_size, args(&sid_length))]
+    pub sid: SID,
+}
+
+/// See [`FileGetQuotaInformation`]; use [`FileGetQuotaInformationInner::into`] to convert.
+#[binrw::binrw]
+#[derive(Debug)]
+pub struct FileGetQuotaInformationInner {
+    #[bw(calc = PosMarker::default())]
+    sid_length: PosMarker<u32>,
+    #[br(map_stream = |s| s.take_seek(sid_length.value as u64))]
+    #[bw(write_with = PosMarker::write_size, args(&sid_length))]
+    pub sid: SID,
+}
+
+/// This structure is used to provide the list of SIDs for which quota query information is requested.
+///
+/// [MS-FSCC 2.4.41.1](<https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-fscc/56adae21-add4-4434-97ec-e40e87739d52>)
+pub type FileGetQuotaInformation = ChainedItem<FileGetQuotaInformationInner>;

crates/smb-msg/src/info/common.rs

@@ -37,7 +37,11 @@ pub struct AdditionalInfo {
 /// Internal helper macro to easily generate fields & methods for [QueryInfoData](super::query::QueryInfoData).
 ///
 /// Builds:
-/// 1. The enum with the specified name, with variants for each info type specified.
+/// 1. The enum with the specified name, with variants for each info type specified. This includes:
+///   - A method to get the info type of the enum variant - `info_type()`.
+///   - A method to get the name of the enum variant - `name()`.
+///   - implementations of `From<ContentType>` for each content type.
+///   - Methods to unwrap the content type, named `as_<variant_name_in_snake_case>()`.
 /// 2. A generic struct names `Raw<name>` to hold the raw data, with a method to convert it to the actual data.
 #[macro_export]
 macro_rules! query_info_data {
@@ -47,9 +51,9 @@ macro_rules! query_info_data {
             use binrw::prelude::*;
             #[allow(unused_imports)]
             use binrw::meta::WriteEndian;
-            /// Represents information passed in get/set info requests.
-            /// This is the information matching [InfoType], and should be used
-            /// in the get info response and in the set info request.
+
+            #[doc = concat!("Enum to hold the different info types for ", stringify!($name),
+            ", that are used within SMB requests for querying or setting information.")]
             #[binrw::binrw]
             #[derive(Debug)]
             #[brw(little)]
@@ -62,14 +66,9 @@ macro_rules! query_info_data {
             }
 
             impl $name {
-                // unwrap_ methods to easily get the inner content.
+                // as_ methods to easily get the inner content.
                 $(
-                    pub fn [<unwrap_ $info_type:lower>](self) -> $content {
-                        match self {
-                            $name::$info_type(data) => data,
-                            _ => panic!("Expected $info_type, got {:?}", self),
-                        }
-                    }
+                    #[doc = concat!("Get the inner content as [`", stringify!($content), "`].")]
                     pub fn [<as_ $info_type:lower>](self) -> Result<$content, $crate::SmbMsgError> {
                         match self {
                             $name::$info_type(data) => Ok(data),