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
use super::ResourceHandle;
use crate::sync_helpers::Mutex;
use crate::{
packets::{fscc::*, smb2::*},
Error,
};
use maybe_async::*;
use std::ops::{Deref, DerefMut};
#[cfg(feature = "async")]
use std::sync::Arc;
/// A directory resource on the server.
/// This is used to query the directory for its contents,
/// and may not be created directly -- but via [Resource][super::Resource], opened
/// from a [Tree][crate::tree::Tree]
pub struct Directory {
pub handle: ResourceHandle,
access: DirAccessMask,
/// This lock prevents iterating the directory twice at the same time.
/// This is required since query directory state is tied to the handle of
/// the directory (hence, to this structure's instance).
query_lock: Mutex<()>,
}
impl Directory {
pub fn new(handle: ResourceHandle, access: DirAccessMask) -> Self {
Directory {
handle,
access,
query_lock: Default::default(),
}
}
/// An internal method that performs a query on the directory.
/// it may be used to query information, but it is best to use
#[maybe_async]
async fn send_query<T>(&self, pattern: &str, restart: bool) -> crate::Result<Vec<T>>
where
T: QueryDirectoryInfoValue,
{
if !self.access.list_directory() {
return Err(Error::MissingPermissions("file_list_directory".to_string()));
}
log::debug!("Querying directory {}", self.handle.name());
let response = self
.handle
.send_receive(Content::QueryDirectoryRequest(QueryDirectoryRequest {
file_information_class: T::CLASS_ID,
flags: QueryDirectoryFlags::new().with_restart_scans(restart),
file_index: 0,
file_id: self.handle.file_id,
output_buffer_length: 0x10000,
file_name: pattern.into(),
}))
.await?;
Ok(response
.message
.content
.to_querydirectoryresponse()?
.read_output()?)
}
/// Asynchronously iterates over the directory contents, using the provided pattern and infromation type.
/// # Arguments
/// * `pattern` - The pattern to match against the file names in the directory. Use wildcards like `*` and `?` to match multiple files.
/// * `info` - The information type to query. This is a trait object that implements the [`QueryDirectoryInfoValue`] trait.
/// # Returns
/// * An iterator over the directory contents, yielding [`QueryDirectoryInfoValue`] objects.
/// # Returns
/// [`QueryDirectoryStream`] - Which implements [Stream] and can be used to iterate over the directory contents.
/// # Notes
/// * **IMPORTANT** Calling this method BLOCKS ANY ADDITIONAL CALLS to this method on THIS structure instance.
/// Hence, you should not call this method on the same instance from multiple threads. This is for thread safety,
/// since SMB2 does not allow multiple queries on the same handle at the same time. Re-open the directory and
/// create a new instance of this structure to query the directory again.
/// * You must use [`futures_util::StreamExt`] to consume the stream.
/// See [https://tokio.rs/tokio/tutorial/streams] for more information on how to use streams.
#[cfg(feature = "async")]
pub async fn query_directory<'a, T>(
this: &'a Arc<Self>,
pattern: &str,
) -> crate::Result<iter_stream::QueryDirectoryStream<'a, T>>
where
T: QueryDirectoryInfoValue,
{
iter_stream::QueryDirectoryStream::new(this, pattern.to_string()).await
}
/// Synchronously iterates over the directory contents, using the provided pattern and infromation type.
/// # Arguments
/// * `pattern` - The pattern to match against the file names in the directory. Use wildcards like `*` and `?` to match multiple files.
/// # Returns
/// * An iterator over the directory contents, yielding [`QueryDirectoryInfoValue`] objects.
/// # Notes
/// * **IMPORTANT**: Calling this method BLOCKS ANY ADDITIONAL CALLS to this method on THIS structure instance.
/// Hence, you should not call this method on the same instance from multiple threads. This is for safety,
/// since SMB2 does not allow multiple queries on the same handle at the same time.
#[cfg(not(feature = "async"))]
pub fn query_directory<'a, T>(
&'a self,
pattern: &str,
) -> crate::Result<iter_sync::QueryDirectoryIterator<'a, T>>
where
T: QueryDirectoryInfoValue,
{
iter_sync::QueryDirectoryIterator::new(self, pattern.to_string())
}
#[maybe_async]
pub async fn query_quota_info(&self, info: QueryQuotaInfo) -> crate::Result<QueryQuotaInfo> {
Ok(self
.handle
.query_common(QueryInfoRequest {
info_type: InfoType::Quota,
info_class: Default::default(),
output_buffer_length: 1024,
additional_info: AdditionalInfo::new(),
flags: QueryInfoFlags::new()
.with_restart_scan(true)
.with_return_single_entry(true),
file_id: self.handle.file_id,
data: GetInfoRequestData::Quota(info),
})
.await?
.unwrap_quota())
}
/// Sets the quota information for the current file.
/// # Arguments
/// * `info` - The information to set - a [QueryQuotaInfo].
#[maybe_async]
pub async fn set_quota_info(&self, info: QueryQuotaInfo) -> crate::Result<()> {
self.handle
.set_info_common(
info,
SetInfoClass::Quota(Default::default()),
Default::default(),
)
.await
}
}
impl Deref for Directory {
type Target = ResourceHandle;
fn deref(&self) -> &Self::Target {
&self.handle
}
}
impl DerefMut for Directory {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.handle
}
}
#[cfg(feature = "async")]
pub mod iter_stream {
use super::*;
use crate::sync_helpers::*;
use futures_core::Stream;
use std::pin::Pin;
use std::task::{Context, Poll};
/// A stream that allows you to iterate over the contents of a directory.
/// See [Directory::query_directory] for more information on how to use it.
pub struct QueryDirectoryStream<'a, T> {
/// A channel to receive the results from the query.
/// This is used to send the results from the query loop to the stream.
receiver: tokio::sync::mpsc::Receiver<crate::Result<T>>,
/// This is used to wake up the query (against the server) loop when more data is required,
/// since the iterator is lazy and will not fetch data until it is needed.
notify_fetch_next: Arc<tokio::sync::Notify>,
/// Holds the lock while iterating the directory,
/// to prevent multiple queries at the same time.
/// See [Directory::query_directory] for more information.
_lock_guard: MutexGuard<'a, ()>,
directory: &'a Directory,
}
impl<'a, T> QueryDirectoryStream<'a, T>
where
T: QueryDirectoryInfoValue,
{
pub async fn new(directory: &'a Arc<Directory>, pattern: String) -> crate::Result<Self> {
let (sender, receiver) = tokio::sync::mpsc::channel(1024);
let notify_fetch_next = Arc::new(tokio::sync::Notify::new());
{
let notify_fetch_next = notify_fetch_next.clone();
let directory = directory.clone();
tokio::spawn(async move {
Self::fetch_loop(directory, pattern, sender, notify_fetch_next.clone()).await;
});
}
let guard = directory.query_lock.lock().await?;
Ok(Self {
receiver,
notify_fetch_next,
_lock_guard: guard,
directory: directory.as_ref(),
})
}
async fn fetch_loop(
directory: Arc<Directory>,
pattern: String,
sender: mpsc::Sender<crate::Result<T>>,
notify_fetch_next: Arc<tokio::sync::Notify>,
) {
let mut is_first = true;
loop {
let result = directory.send_query::<T>(&pattern, is_first).await;
is_first = false;
match result {
Ok(items) => {
for item in items {
if sender.send(Ok(item)).await.is_err() {
return; // Receiver dropped
}
}
}
Err(Error::UnexpectedMessageStatus(Status::NoMoreFiles)) => {
break; // No more files
}
Err(e) => {
if sender.send(Err(e)).await.is_err() {
return; // Receiver dropped
}
}
}
// Notify the stream that a new batch is available
notify_fetch_next.notify_waiters();
notify_fetch_next.notified().await;
}
}
}
impl<'a, T> Stream for QueryDirectoryStream<'a, T>
where
T: QueryDirectoryInfoValue + Unpin + Send,
{
type Item = crate::Result<T>;
fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
let this = self.get_mut();
return match this.receiver.poll_recv(cx) {
Poll::Ready(Some(value)) => {
if this.receiver.is_empty() {
this.notify_fetch_next.notify_waiters() // Notify that batch is done
}
Poll::Ready(Some(value))
}
Poll::Ready(None) => Poll::Ready(None), // Stream is closed!
Poll::Pending => Poll::Pending,
};
}
}
}
#[cfg(not(feature = "async"))]
pub mod iter_sync {
use super::*;
use crate::sync_helpers::*;
pub struct QueryDirectoryIterator<'a, T>
where
T: QueryDirectoryInfoValue,
{
/// Results from last call to [`Directory::send_query`], that were not yet consumed.
backlog: Vec<T>,
/// The directory to query.
directory: &'a Directory,
/// The pattern to match against the file names in the directory.
pattern: String,
/// Whether this is the first query or not.
is_first: bool,
/// The lock being held while iterating the directory.
_iter_lock_guard: MutexGuard<'a, ()>,
}
impl<'a, T> QueryDirectoryIterator<'a, T>
where
T: QueryDirectoryInfoValue,
{
pub fn new(directory: &'a Directory, pattern: String) -> crate::Result<Self> {
Ok(Self {
backlog: Vec::new(),
directory,
pattern,
is_first: true,
_iter_lock_guard: directory.query_lock.lock()?,
})
}
}
impl<'a, T> Iterator for QueryDirectoryIterator<'a, T>
where
T: QueryDirectoryInfoValue,
{
type Item = crate::Result<T>;
fn next(&mut self) -> Option<Self::Item> {
// Pop from backlog if we have any results left.
if !self.backlog.is_empty() {
return Some(Ok(self.backlog.remove(0)));
}
// If we have no backlog, we need to query the directory again.
let result = self.directory.send_query::<T>(&self.pattern, self.is_first);
self.is_first = false;
match result {
Ok(items) => {
if items.is_empty() {
None
} else {
// Store the items in the backlog and return the first one.
self.backlog = items;
self.next()
}
}
Err(Error::UnexpectedMessageStatus(Status::NoMoreFiles)) => {
None // No more files!
}
Err(e) => {
// Another error occurred, return it.
Some(Err(e))
}
}
}
}
}