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
use std::ops::Range;
use windows::{
core,
Win32::Storage::CloudFilters::{CfReportProviderProgress, CF_CONNECTION_KEY},
};
use crate::{
command::{self, Command},
filter::{RawConnectionKey, RawTransferKey},
placeholder_file::PlaceholderFile,
sealed, utility,
};
/// A ticket for the [SyncFilter::fetch_data][crate::filter::SyncFilter::fetch_data] callback.
#[derive(Debug)]
pub struct FetchData {
connection_key: RawConnectionKey,
transfer_key: RawTransferKey,
}
impl FetchData {
/// Create a new [FetchData].
pub(crate) fn new(connection_key: RawConnectionKey, transfer_key: RawTransferKey) -> Self {
Self {
connection_key,
transfer_key,
}
}
/// Displays a progress bar next to the file in the file explorer to show the progress of the
/// current operation. In addition, the standard Windows file progress dialog will open
/// displaying the speed and progress based on the values set. During background hydrations,
/// an interactive toast will appear notifying the user of an operation with a progress bar.
pub fn report_progress(&self, total: u64, completed: u64) -> core::Result<()> {
unsafe {
CfReportProviderProgress(
CF_CONNECTION_KEY(self.connection_key),
self.transfer_key,
total as i64,
completed as i64,
)
}?;
Ok(())
}
// TODO: response command::Update
}
impl utility::ReadAt for FetchData {
/// Read data at an offset from a placeholder file.
///
/// This method is equivalent to calling `CfExecute` with `CF_OPERATION_TYPE_RETRIEVE_DATA`.
fn read_at(&self, buf: &mut [u8], offset: u64) -> core::Result<u64> {
command::Read {
buffer: buf,
position: offset,
}
.execute(self.connection_key, self.transfer_key)
}
}
impl utility::WriteAt for FetchData {
/// Write data at an offset to a placeholder file.
///
/// The buffer passed must be 4KiB in length or end on the logical file size. Unfortunately,
/// this is a restriction of the operating system.
///
/// This method is equivalent to calling `CfExecute` with `CF_OPERATION_TYPE_TRANSFER_DATA`.
fn write_at(&self, buf: &[u8], offset: u64) -> core::Result<()> {
command::Write {
buffer: buf,
position: offset,
}
.execute(self.connection_key, self.transfer_key)
}
}
impl sealed::Sealed for FetchData {}
/// A ticket for the [SyncFilter::validate_data][crate::filter::SyncFilter::validate_data] callback.
#[derive(Debug)]
pub struct ValidateData {
connection_key: RawConnectionKey,
transfer_key: RawTransferKey,
}
impl ValidateData {
/// Create a new [ValidateData].
pub(crate) fn new(connection_key: RawConnectionKey, transfer_key: RawTransferKey) -> Self {
Self {
connection_key,
transfer_key,
}
}
/// Validates the data range in the placeholder file is valid.
///
/// This method is equivalent to calling `CfExecute` with `CF_OPERATION_TYPE_ACK_DATA`.
// TODO: make this generic over a RangeBounds
// if the range specified is past the current file length, will it consider that range to be validated?
// https://docs.microsoft.com/en-us/answers/questions/750302/if-the-ackdata-field-of-cf-operation-parameters-is.html
pub fn pass(&self, range: Range<u64>) -> core::Result<()> {
command::Validate { range }.execute(self.connection_key, self.transfer_key)
}
// TODO: response command::Update
}
impl utility::ReadAt for ValidateData {
/// Read data at an offset from a placeholder file.
///
/// This method is equivalent to calling `CfExecute` with `CF_OPERATION_TYPE_RETRIEVE_DATA`.
///
/// The bytes returned will ALWAYS be the length of the buffer passed in. The operating
/// system provides these guarantees.
fn read_at(&self, buf: &mut [u8], offset: u64) -> core::Result<u64> {
command::Read {
buffer: buf,
position: offset,
}
.execute(self.connection_key, self.transfer_key)
}
}
impl sealed::Sealed for ValidateData {}
/// A ticket for the [SyncFilter::fetch_placeholders][crate::filter::SyncFilter::fetch_placeholders] callback.
#[derive(Debug)]
pub struct FetchPlaceholders {
connection_key: RawConnectionKey,
transfer_key: RawTransferKey,
}
impl FetchPlaceholders {
/// Create a new [FetchPlaceholders].
pub(crate) fn new(connection_key: RawConnectionKey, transfer_key: RawTransferKey) -> Self {
Self {
connection_key,
transfer_key,
}
}
/// Creates a list of placeholder files/directorys on the file system.
///
/// The value returned is the final [Usn][crate::usn::Usn] (and if they succeeded) after each placeholder is created.
pub fn pass_with_placeholder(&self, placeholders: &mut [PlaceholderFile]) -> core::Result<()> {
command::CreatePlaceholders {
total: placeholders.len() as _,
placeholders,
}
.execute(self.connection_key, self.transfer_key)
}
}
/// A ticket for the [SyncFilter::dehydrate][crate::filter::SyncFilter::dehydrate] callback.
#[derive(Debug)]
pub struct Dehydrate {
connection_key: RawConnectionKey,
transfer_key: RawTransferKey,
}
impl Dehydrate {
/// Create a new [Dehydrate].
pub(crate) fn new(connection_key: RawConnectionKey, transfer_key: RawTransferKey) -> Self {
Self {
connection_key,
transfer_key,
}
}
/// Confirms dehydration of the file.
pub fn pass(&self) -> core::Result<()> {
command::Dehydrate { blob: &[] }.execute(self.connection_key, self.transfer_key)
}
/// Confirms dehydration of the file and updates its file blob.
pub fn pass_with_blob(&self, blob: &[u8]) -> core::Result<()> {
command::Dehydrate { blob }.execute(self.connection_key, self.transfer_key)
}
}
/// A ticket for the [SyncFilter::delete][crate::filter::SyncFilter::delete] callback.
#[derive(Debug)]
pub struct Delete {
connection_key: RawConnectionKey,
transfer_key: RawTransferKey,
}
impl Delete {
/// Create a new [Delete].
pub(crate) fn new(connection_key: RawConnectionKey, transfer_key: RawTransferKey) -> Self {
Self {
connection_key,
transfer_key,
}
}
/// Confirms deletion of the file.
pub fn pass(&self) -> core::Result<()> {
command::Delete.execute(self.connection_key, self.transfer_key)
}
}
/// A ticket for the [SyncFilter::rename][crate::filter::SyncFilter::rename] callback.
#[derive(Debug)]
pub struct Rename {
connection_key: RawConnectionKey,
transfer_key: RawTransferKey,
}
impl Rename {
/// Create a new [Rename].
pub(crate) fn new(connection_key: RawConnectionKey, transfer_key: RawTransferKey) -> Self {
Self {
connection_key,
transfer_key,
}
}
/// Confirms the rename/move of a file.
pub fn pass(&self) -> core::Result<()> {
command::Rename.execute(self.connection_key, self.transfer_key)
}
}