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
use std::collections::BTreeMap;
use tokio::io;
use tokio::try_join;
use crate::checksum::{Checksum, ChecksumType, MD5, SHA256};
use crate::diff::{str_diff, Diff, FileContent};
use crate::newtypes::PileName;
use crate::paths::{HoardPath, RelativePath, SystemPath};
use super::hoard_item::HoardItem;
/// Wrapper around [`HoardItem`] that accesses the filesystem at creation time and
/// caches file data.
///
/// # Usage
///
/// This does nothing to ensure that files are not modified during its lifetime. For directly
/// interacting with files on the filesystem, [`HoardItem`] may be better.
///
/// This struct is useful for prolonged processing of a given file.
///
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[allow(clippy::module_name_repetitions)]
#[allow(clippy::struct_excessive_bools)]
pub struct CachedHoardItem {
inner: HoardItem,
hoard_checksums: Option<BTreeMap<ChecksumType, Checksum>>,
system_checksums: Option<BTreeMap<ChecksumType, Checksum>>,
diff: Option<Diff>,
is_file: bool,
is_dir: bool,
is_text: bool,
exists: bool,
}
impl From<CachedHoardItem> for HoardItem {
fn from(cached: CachedHoardItem) -> Self {
cached.inner
}
}
impl CachedHoardItem {
/// Create a new `CachedHoardItem`.
///
/// See [`HoardItem::new`] for more about usage.
///
/// # Errors
///
/// Will return I/O errors if they occur while processing file data, with the exception of
/// `NotFound` errors, which are translated into `None` values, as applicable.
#[tracing::instrument(name = "new_cached_hoard_item")]
pub async fn new(
pile_name: PileName,
hoard_prefix: HoardPath,
system_prefix: SystemPath,
relative_path: RelativePath,
) -> io::Result<Self> {
let inner = HoardItem::new(pile_name, hoard_prefix, system_prefix, relative_path);
Self::try_from_hoard_item(inner).await
}
/// Attempt to create a cached version of the given [`HoardItem`]
///
/// # Errors
///
/// Any I/O errors while reading the associated files, etc.
#[tracing::instrument]
pub async fn try_from_hoard_item(inner: HoardItem) -> io::Result<Self> {
let (is_file, is_dir) = {
let system_exists = inner.system_path().exists();
let hoard_exists = inner.hoard_path().exists();
let is_file = (inner.system_path().is_file() || !system_exists)
&& (inner.hoard_path().is_file() || !hoard_exists)
&& (system_exists || hoard_exists);
let is_dir = (inner.system_path().is_dir() || !system_exists)
&& (inner.hoard_path().is_dir() || !hoard_exists)
&& (system_exists || hoard_exists);
(is_file, is_dir)
};
let (system_content, hoard_content) = if is_file {
let system_content = inner.system_content();
let hoard_content = inner.hoard_content();
let (system_content, hoard_content) = try_join!(system_content, hoard_content)?;
(Some(system_content), Some(hoard_content))
} else {
(None, None)
};
let system_checksums = system_content.as_ref().and_then(Self::checksums);
let hoard_checksums = hoard_content.as_ref().and_then(Self::checksums);
let diff = if let (Some(system_content), Some(hoard_content)) =
(&system_content, &hoard_content)
{
match (system_content, hoard_content) {
(FileContent::Missing, FileContent::Missing) => None,
(FileContent::Missing, FileContent::Binary(_) | FileContent::Text(_)) => {
Some(Diff::SystemNotExists)
}
(FileContent::Binary(_) | FileContent::Text(_), FileContent::Missing) => {
Some(Diff::HoardNotExists)
}
(FileContent::Binary(_), FileContent::Text(_))
| (FileContent::Text(_), FileContent::Binary(_)) => Some(Diff::Binary),
(FileContent::Binary(_), FileContent::Binary(_)) => {
(system_checksums != hoard_checksums).then_some(Diff::Binary)
}
(FileContent::Text(system_text), FileContent::Text(hoard_text)) => str_diff(
(inner.hoard_path(), hoard_text),
(inner.system_path(), system_text),
),
}
} else {
None
};
let is_text = is_file
&& matches!(
(system_content, hoard_content),
(
Some(FileContent::Text(_)),
Some(FileContent::Text(_) | FileContent::Missing)
) | (Some(FileContent::Missing), Some(FileContent::Text(_)))
);
let exists = inner.hoard_path().exists() || inner.system_path().exists();
Ok(Self {
inner,
hoard_checksums,
system_checksums,
diff,
is_file,
is_dir,
is_text,
exists,
})
}
/// Returns the name of the pile this item belongs to, if any.
#[must_use]
pub fn pile_name(&self) -> &PileName {
self.inner.pile_name()
}
/// Returns the relative path for this item.
#[must_use]
pub fn relative_path(&self) -> &RelativePath {
self.inner.relative_path()
}
/// Returns the hoard-controlled path for this item's pile.
#[must_use]
pub fn hoard_prefix(&self) -> &HoardPath {
self.inner.hoard_prefix()
}
/// Returns the system path for this item's pile.
#[must_use]
pub fn system_prefix(&self) -> &SystemPath {
self.inner.system_prefix()
}
/// Returns the Hoard-controlled path for this item.
///
/// If [`HoardItem::relative_path()`] is `None`, this is the same as
/// [`HoardItem::hoard_prefix()`].
#[must_use]
pub fn hoard_path(&self) -> &HoardPath {
self.inner.hoard_path()
}
/// Returns the system path for this item.
///
/// If [`HoardItem::relative_path()`] is `None`, this is the same as
/// [`HoardItem::system_prefix()`].
#[must_use]
pub fn system_path(&self) -> &SystemPath {
self.inner.system_path()
}
/// Returns whether this item is a file.
///
/// This is `true` if:
/// - At least one of `hoard_path` or `system_path` exists
/// - All existing paths are a file
#[must_use]
pub fn is_file(&self) -> bool {
self.is_file
}
/// Returns whether this item is a directory.
///
/// This is `true` if:
/// - At least one of `hoard_path` or `system_path` exists
/// - All existing paths are directories
#[must_use]
pub fn is_dir(&self) -> bool {
self.is_dir
}
/// Returns whether this file contains text.
///
/// This is `true` if at least one file (system/hoard) exists and all files that exist contain
/// text.
#[must_use]
pub fn is_text(&self) -> bool {
self.is_text
}
/// Returns whether this file *does not* contains text.
///
/// This is `true` if at least one file (system/hoard) exists and is not text.
#[must_use]
pub fn is_binary(&self) -> bool {
!self.is_text
}
/// Returns the precomputed diff between the hoard and system files of this [`CachedHoardItem`].
#[must_use]
pub fn diff(&self) -> Option<&Diff> {
self.diff.as_ref()
}
#[tracing::instrument(name = "calculate_calculate_cached_hoard_item_checksums")]
fn checksums(content: &FileContent) -> Option<BTreeMap<ChecksumType, Checksum>> {
match content {
FileContent::Missing => None,
FileContent::Text(s) => {
let mut map = BTreeMap::new();
map.insert(
ChecksumType::MD5,
Checksum::MD5(MD5::from_data(s.as_bytes())),
);
map.insert(
ChecksumType::SHA256,
Checksum::SHA256(SHA256::from_data(s.as_bytes())),
);
Some(map)
}
FileContent::Binary(data) => {
let mut map = BTreeMap::new();
map.insert(
ChecksumType::MD5,
Checksum::MD5(MD5::from_data(data.as_slice())),
);
map.insert(
ChecksumType::SHA256,
Checksum::SHA256(SHA256::from_data(data.as_slice())),
);
Some(map)
}
}
}
/// Returns the requested [`ChecksumType`] for the Hoard version of the file.
///
/// # Errors
///
/// Returns `Ok(None)` if the file does not exist, and errors for all other
/// error cases for [`std::fs::read`], including if `hoard_path` is a directory.
///
/// If always calling this function with a constant or programmer-determined value,
/// consider using [`CachedHoardItem::hoard_md5`] or [`CachedHoardItem::hoard_sha256`] instead.
#[must_use]
pub fn hoard_checksum(&self, typ: ChecksumType) -> Option<Checksum> {
match typ {
ChecksumType::MD5 => self.hoard_md5(),
ChecksumType::SHA256 => self.hoard_sha256(),
}
}
/// Returns the MD5 checksum for the Hoard version of the file.
///
/// # Errors
///
/// Returns `Ok(None)` if the file does not exist, and errors for all other
/// error cases for [`std::fs::read`], including if `hoard_path` is a directory.
#[must_use]
pub fn hoard_md5(&self) -> Option<Checksum> {
self.hoard_checksums
.as_ref()
.and_then(|map| map.get(&ChecksumType::MD5).cloned())
}
/// Returns the SHA256 checksum for the Hoard version of the file.
///
/// # Errors
///
/// Returns `Ok(None)` if the file does not exist, and errors for all other
/// error cases for [`std::fs::read`], including if `hoard_path` is a directory.
#[must_use]
pub fn hoard_sha256(&self) -> Option<Checksum> {
self.hoard_checksums
.as_ref()
.and_then(|map| map.get(&ChecksumType::SHA256).cloned())
}
/// Returns the requested [`ChecksumType`] for the system version of the file.
///
/// # Errors
///
/// Returns `Ok(None)` if the file does not exist, and errors for all other
/// error cases for [`std::fs::read`], including if `system_path` is a directory.
///
/// If always calling this function with a constant or programmer-determined value,
/// consider using [`CachedHoardItem::system_md5`] or [`CachedHoardItem::system_sha256`] instead.
#[must_use]
pub fn system_checksum(&self, typ: ChecksumType) -> Option<Checksum> {
match typ {
ChecksumType::MD5 => self.system_md5(),
ChecksumType::SHA256 => self.system_sha256(),
}
}
/// Returns the MD5 checksum for the system version of the file.
///
/// # Errors
///
/// Returns `Ok(None)` if the file does not exist, and errors for all other
/// error cases for [`std::fs::read`], including if `system_path` is a directory.
#[must_use]
pub fn system_md5(&self) -> Option<Checksum> {
self.system_checksums
.as_ref()
.and_then(|map| map.get(&ChecksumType::MD5).cloned())
}
/// Returns the SHA256 checksum for the system version of the file.
///
/// # Errors
///
/// Returns `Ok(None)` if the file does not exist, and errors for all other
/// error cases for [`std::fs::read`], including if `system_path` is a directory.
#[must_use]
pub fn system_sha256(&self) -> Option<Checksum> {
self.system_checksums
.as_ref()
.and_then(|map| map.get(&ChecksumType::SHA256).cloned())
}
}