oku_fs/fs/file.rs
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 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
use super::*;
use crate::error::OkuFsError;
use anyhow::anyhow;
use bytes::Bytes;
use futures::{pin_mut, StreamExt};
use iroh::client::docs::Entry;
use iroh::client::docs::LiveEvent::SyncFinished;
use iroh::client::Doc;
use iroh::docs::store::FilterKind;
use iroh::docs::DocTicket;
use iroh::{base::hash::Hash, docs::NamespaceId};
use log::{error, info};
use rayon::iter::{IntoParallelRefIterator, ParallelIterator};
use std::path::PathBuf;
impl OkuFs {
/// Lists files in a replica.
///
/// # Arguments
///
/// * `namespace_id` - The ID of the replica to list files in.
///
/// * `path` - An optional path within the replica.
///
/// # Returns
///
/// A list of files in the replica.
pub async fn list_files(
&self,
namespace_id: NamespaceId,
path: Option<PathBuf>,
) -> miette::Result<Vec<Entry>> {
let docs_client = &self.node.docs();
let document = docs_client
.open(namespace_id)
.await
.map_err(|e| {
error!("{}", e);
OkuFsError::CannotOpenReplica
})?
.ok_or(OkuFsError::FsEntryNotFound)?;
let query = if let Some(path) = path {
let file_key = path_to_entry_prefix(path);
iroh::docs::store::Query::single_latest_per_key()
.key_prefix(file_key)
.build()
} else {
iroh::docs::store::Query::single_latest_per_key().build()
};
let entries = document.get_many(query).await.map_err(|e| {
error!("{}", e);
OkuFsError::CannotListFiles
})?;
pin_mut!(entries);
let files: Vec<Entry> = entries.map(|entry| entry.unwrap()).collect().await;
Ok(files)
}
/// Creates a file (if it does not exist) or modifies an existing file.
///
/// # Arguments
///
/// * `namespace_id` - The ID of the replica containing the file to create or modify.
///
/// * `path` - The path of the file to create or modify.
///
/// * `data` - The data to write to the file.
///
/// # Returns
///
/// The hash of the file.
pub async fn create_or_modify_file(
&self,
namespace_id: NamespaceId,
path: PathBuf,
data: impl Into<Bytes>,
) -> miette::Result<Hash> {
let file_key = path_to_entry_key(path);
let data_bytes = data.into();
let docs_client = &self.node.docs();
let document = docs_client
.open(namespace_id)
.await
.map_err(|e| {
error!("{}", e);
OkuFsError::CannotOpenReplica
})?
.ok_or(OkuFsError::FsEntryNotFound)?;
let entry_hash = document
.set_bytes(
self.node.authors().default().await.map_err(|e| {
error!("{}", e);
OkuFsError::CannotRetrieveDefaultAuthor
})?,
file_key,
data_bytes,
)
.await
.map_err(|e| {
error!("{}", e);
OkuFsError::CannotCreateOrModifyFile
})?;
Ok(entry_hash)
}
/// Deletes a file.
///
/// # Arguments
///
/// * `namespace_id` - The ID of the replica containing the file to delete.
///
/// * `path` - The path of the file to delete.
///
/// # Returns
///
/// The number of entries deleted in the replica, which should be 1 if the file was successfully deleted.
pub async fn delete_file(
&self,
namespace_id: NamespaceId,
path: PathBuf,
) -> miette::Result<usize> {
let file_key = path_to_entry_key(path);
let docs_client = &self.node.docs();
let document = docs_client
.open(namespace_id)
.await
.map_err(|e| {
error!("{}", e);
OkuFsError::CannotOpenReplica
})?
.ok_or(OkuFsError::FsEntryNotFound)?;
let query = iroh::docs::store::Query::single_latest_per_key()
.key_exact(file_key)
.build();
let entry = document
.get_one(query)
.await
.map_err(|e| {
error!("{}", e);
OkuFsError::CannotReadFile
})?
.ok_or(OkuFsError::FsEntryNotFound)?;
let entries_deleted = document
.del(entry.author(), entry.key().to_vec())
.await
.map_err(|e| {
error!("{}", e);
OkuFsError::CannotDeleteFile
})?;
Ok(entries_deleted)
}
/// Gets an Iroh entry for a file.
///
/// # Arguments
///
/// * `namespace_id` - The ID of the replica containing the file.
///
/// * `path` - The path of the file.
///
/// # Returns
///
/// The entry representing the file.
pub async fn get_entry(
&self,
namespace_id: NamespaceId,
path: PathBuf,
) -> miette::Result<Entry> {
let file_key = path_to_entry_key(path);
let docs_client = &self.node.docs();
let document = docs_client
.open(namespace_id)
.await
.map_err(|e| {
error!("{}", e);
OkuFsError::CannotOpenReplica
})?
.ok_or(OkuFsError::FsEntryNotFound)?;
let query = iroh::docs::store::Query::single_latest_per_key()
.key_exact(file_key)
.build();
let entry = document
.get_one(query)
.await
.map_err(|e| {
error!("{}", e);
OkuFsError::CannotReadFile
})?
.ok_or(OkuFsError::FsEntryNotFound)?;
Ok(entry)
}
/// Determines the oldest timestamp of a file.
///
/// # Arguments
///
/// * `namespace_id` - The ID of the replica containing the file.
///
/// * `path` - The path to the file.
///
/// # Returns
///
/// The timestamp, in microseconds from the Unix epoch, of the oldest entry in the file.
pub async fn get_oldest_entry_timestamp(
&self,
namespace_id: NamespaceId,
path: PathBuf,
) -> miette::Result<u64> {
let file_key = path_to_entry_key(path);
let docs_client = &self.node.docs();
let document = docs_client
.open(namespace_id)
.await
.map_err(|e| {
error!("{}", e);
OkuFsError::CannotOpenReplica
})?
.ok_or(OkuFsError::FsEntryNotFound)?;
let query = iroh::docs::store::Query::all().key_exact(file_key).build();
let entries = document.get_many(query).await.map_err(|e| {
error!("{}", e);
OkuFsError::CannotListFiles
})?;
pin_mut!(entries);
let timestamps: Vec<u64> = entries
.map(|entry| entry.unwrap().timestamp())
.collect()
.await;
Ok(*timestamps.par_iter().min().unwrap_or(&u64::MIN))
}
/// Reads a file.
///
/// # Arguments
///
/// * `namespace_id` - The ID of the replica containing the file to read.
///
/// * `path` - The path of the file to read.
///
/// # Returns
///
/// The data read from the file.
pub async fn read_file(
&self,
namespace_id: NamespaceId,
path: PathBuf,
) -> miette::Result<Bytes> {
let entry = self.get_entry(namespace_id, path).await?;
Ok(entry.content_bytes(&self.node).await.map_err(|e| {
error!("{}", e);
OkuFsError::CannotReadFile
})?)
}
/// Reads a file.
///
/// # Arguments
///
/// * `document` - A handle to the replica containing the file to read.
///
/// * `path` - The path of the file to read.
///
/// # Returns
///
/// The data read from the file.
pub async fn read_file_from_replica_handle(
&self,
document: Doc,
path: PathBuf,
) -> miette::Result<Bytes> {
let file_key = path_to_entry_key(path);
let query = iroh::docs::store::Query::single_latest_per_key()
.key_exact(file_key)
.build();
let entry = document
.get_one(query)
.await
.map_err(|e| miette::miette!("{}", e))?
.ok_or(OkuFsError::FsEntryNotFound)?;
entry
.content_bytes(&document)
.await
.map_err(|e| miette::miette!("{}", e))
}
/// Moves a file by copying it to a new location and deleting the original.
///
/// # Arguments
///
/// * `from_namespace_id` - The ID of the replica containing the file to move.
///
/// * `to_namespace_id` - The ID of the replica to move the file to.
///
/// * `from_path` - The path of the file to move.
///
/// * `to_path` - The path to move the file to.
///
/// # Returns
///
/// A tuple containing the hash of the file at the new destination and the number of replica entries deleted during the operation, which should be 1 if the file at the original path was deleted.
pub async fn move_file(
&self,
from_namespace_id: NamespaceId,
from_path: PathBuf,
to_namespace_id: NamespaceId,
to_path: PathBuf,
) -> miette::Result<(Hash, usize)> {
let data = self.read_file(from_namespace_id, from_path.clone()).await?;
let hash = self
.create_or_modify_file(to_namespace_id, to_path.clone(), data)
.await?;
let entries_deleted = self.delete_file(from_namespace_id, from_path).await?;
Ok((hash, entries_deleted))
}
/// Retrieve a file locally after attempting to retrieve the latest version from the Internet.
///
/// # Arguments
///
/// * `namespace_id` - The ID of the replica containing the file to retrieve.
///
/// * `path` - The path to the file to retrieve.
///
/// # Returns
///
/// The data read from the file.
pub async fn fetch_file(
&self,
namespace_id: NamespaceId,
path: PathBuf,
) -> anyhow::Result<Bytes> {
match self.resolve_namespace_id(namespace_id).await {
Ok(ticket) => match self.fetch_file_with_ticket(&ticket, path.clone()).await {
Ok(bytes) => Ok(bytes),
Err(e) => {
error!("{}", e);
Ok(self
.read_file(namespace_id, path)
.await
.map_err(|e| anyhow!("{}", e))?)
}
},
Err(e) => {
error!("{}", e);
Ok(self
.read_file(namespace_id, path)
.await
.map_err(|e| anyhow!("{}", e))?)
}
}
}
/// Join a swarm to fetch the latest version of a file and save it to the local machine.
///
/// # Arguments
///
/// * `ticket` - A ticket for the replica containing the file to retrieve.
///
/// * `path` - The path to the file to retrieve.
///
/// # Returns
///
/// The data read from the file.
pub async fn fetch_file_with_ticket(
&self,
ticket: &DocTicket,
path: PathBuf,
) -> anyhow::Result<Bytes> {
let docs_client = &self.node.docs();
let replica = docs_client
.import_namespace(ticket.capability.clone())
.await?;
let filter = FilterKind::Exact(path_to_entry_key(path.clone()));
replica
.set_download_policy(iroh::docs::store::DownloadPolicy::NothingExcept(vec![
filter,
]))
.await?;
replica.start_sync(ticket.nodes.clone()).await?;
let namespace_id = ticket.capability.id();
let mut events = replica.subscribe().await?;
let sync_start = std::time::Instant::now();
while let Some(event) = events.next().await {
if matches!(event?, SyncFinished { .. }) {
let elapsed = sync_start.elapsed();
info!(
"Synchronisation took {elapsed:?} for {} … ",
namespace_id.to_string(),
);
break;
}
}
self.read_file(namespace_id, path)
.await
.map_err(|e| anyhow!("{}", e))
}
}