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 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213
//! Define blob-related commands.
#![allow(missing_docs)]
use std::{
collections::{BTreeMap, HashMap},
net::SocketAddr,
path::PathBuf,
time::Duration,
};
use anyhow::{anyhow, bail, ensure, Context, Result};
use clap::Subcommand;
use console::{style, Emoji};
use futures_lite::{Stream, StreamExt};
use indicatif::{
HumanBytes, HumanDuration, MultiProgress, ProgressBar, ProgressDrawTarget, ProgressState,
ProgressStyle,
};
use iroh_base::{node_addr::AddrInfoOptions, ticket::BlobTicket};
use iroh_net::{key::PublicKey, relay::RelayUrl, NodeAddr};
use tokio::io::AsyncWriteExt;
use crate::{
get::{db::DownloadProgress, progress::BlobProgress, Stats},
net_protocol::DownloadMode,
provider::AddProgress,
rpc::client::blobs::{
self, BlobInfo, BlobStatus, CollectionInfo, DownloadOptions, IncompleteBlobInfo, WrapOption,
},
store::{ConsistencyCheckProgress, ExportFormat, ExportMode, ReportLevel, ValidateProgress},
util::SetTagOption,
BlobFormat, Hash, HashAndFormat, Tag,
};
pub mod tags;
/// Subcommands for the blob command.
#[allow(clippy::large_enum_variant)]
#[derive(Subcommand, Debug, Clone)]
pub enum BlobCommands {
/// Add data from PATH to the running node.
Add {
/// Path to a file or folder.
///
/// If set to `STDIN`, the data will be read from stdin.
source: BlobSource,
#[clap(flatten)]
options: BlobAddOptions,
},
/// Download data to the running node's database and provide it.
///
/// In addition to downloading the data, you can also specify an optional output directory
/// where the data will be exported to after it has been downloaded.
Get {
/// Ticket or Hash to use.
#[clap(name = "TICKET OR HASH")]
ticket: TicketOrHash,
/// Additional socket address to use to contact the node. Can be used multiple times.
#[clap(long)]
address: Vec<SocketAddr>,
/// Override the relay URL to use to contact the node.
#[clap(long)]
relay_url: Option<RelayUrl>,
/// Override to treat the blob as a raw blob or a hash sequence.
#[clap(long)]
recursive: Option<bool>,
/// If set, the ticket's direct addresses will not be used.
#[clap(long)]
override_addresses: bool,
/// NodeId of the provider.
#[clap(long)]
node: Option<PublicKey>,
/// Directory or file in which to save the file(s).
///
/// If set to `STDOUT` the output will be redirected to stdout.
///
/// If not specified, the data will only be stored internally.
#[clap(long, short)]
out: Option<OutputTarget>,
/// If set, the data will be moved to the output directory, and iroh will assume that it
/// will not change.
#[clap(long, default_value_t = false)]
stable: bool,
/// Tag to tag the data with.
#[clap(long)]
tag: Option<String>,
/// If set, will queue the download in the download queue.
///
/// Use this if you are doing many downloads in parallel and want to limit the number of
/// downloads running concurrently.
#[clap(long)]
queued: bool,
},
/// Export a blob from the internal blob store to the local filesystem.
Export {
/// The hash to export.
hash: Hash,
/// Directory or file in which to save the file(s).
///
/// If set to `STDOUT` the output will be redirected to stdout.
out: OutputTarget,
/// Set to true if the hash refers to a collection and you want to export all children of
/// the collection.
#[clap(long, default_value_t = false)]
recursive: bool,
/// If set, the data will be moved to the output directory, and iroh will assume that it
/// will not change.
#[clap(long, default_value_t = false)]
stable: bool,
},
/// List available content on the node.
#[clap(subcommand)]
List(ListCommands),
/// Validate hashes on the running node.
Validate {
/// Verbosity level.
#[clap(short, long, action(clap::ArgAction::Count))]
verbose: u8,
/// Repair the store by removing invalid data
///
/// Caution: this will remove data to make the store consistent, even
/// if the data might be salvageable. E.g. for an entry for which the
/// outboard data is missing, the entry will be removed, even if the
/// data is complete.
#[clap(long, default_value_t = false)]
repair: bool,
},
/// Perform a database consistency check on the running node.
ConsistencyCheck {
/// Verbosity level.
#[clap(short, long, action(clap::ArgAction::Count))]
verbose: u8,
/// Repair the store by removing invalid data
///
/// Caution: this will remove data to make the store consistent, even
/// if the data might be salvageable. E.g. for an entry for which the
/// outboard data is missing, the entry will be removed, even if the
/// data is complete.
#[clap(long, default_value_t = false)]
repair: bool,
},
/// Delete content on the node.
#[clap(subcommand)]
Delete(DeleteCommands),
/// Get a ticket to share this blob.
Share {
/// Hash of the blob to share.
hash: Hash,
/// Options to configure the address information in the generated ticket.
///
/// Use `relay-and-addresses` in networks with no internet connectivity.
#[clap(long, default_value_t = AddrInfoOptions::Id)]
addr_options: AddrInfoOptions,
/// If the blob is a collection, the requester will also fetch the listed blobs.
#[clap(long, default_value_t = false)]
recursive: bool,
/// Display the contents of this ticket too.
#[clap(long, hide = true)]
debug: bool,
},
}
/// Possible outcomes of an input.
#[derive(Debug, Clone, derive_more::Display)]
pub enum TicketOrHash {
Ticket(BlobTicket),
Hash(Hash),
}
impl std::str::FromStr for TicketOrHash {
type Err = anyhow::Error;
fn from_str(s: &str) -> std::result::Result<Self, Self::Err> {
if let Ok(ticket) = BlobTicket::from_str(s) {
return Ok(Self::Ticket(ticket));
}
if let Ok(hash) = Hash::from_str(s) {
return Ok(Self::Hash(hash));
}
Err(anyhow!("neither a valid ticket or hash"))
}
}
impl BlobCommands {
/// Runs the blob command given the iroh client.
pub async fn run(self, blobs: &blobs::Client, addr: NodeAddr) -> Result<()> {
match self {
Self::Get {
ticket,
mut address,
relay_url,
recursive,
override_addresses,
node,
out,
stable,
tag,
queued,
} => {
let (node_addr, hash, format) = match ticket {
TicketOrHash::Ticket(ticket) => {
let (node_addr, hash, blob_format) = ticket.into_parts();
// create the node address with the appropriate overrides
let node_addr = {
let NodeAddr { node_id, info } = node_addr;
let addresses = if override_addresses {
// use only the cli supplied ones
address
} else {
// use both the cli supplied ones and the ticket ones
address.extend(info.direct_addresses);
address
};
// prefer direct arg over ticket
let relay_url = relay_url.or(info.relay_url);
NodeAddr::from_parts(node_id, relay_url, addresses)
};
// check if the blob format has an override
let blob_format = match recursive {
Some(true) => BlobFormat::HashSeq,
Some(false) => BlobFormat::Raw,
None => blob_format,
};
(node_addr, hash, blob_format)
}
TicketOrHash::Hash(hash) => {
// check if the blob format has an override
let blob_format = match recursive {
Some(true) => BlobFormat::HashSeq,
Some(false) => BlobFormat::Raw,
None => BlobFormat::Raw,
};
let Some(node) = node else {
bail!("missing NodeId");
};
let node_addr = NodeAddr::from_parts(node, relay_url, address);
(node_addr, hash, blob_format)
}
};
if format != BlobFormat::Raw && out == Some(OutputTarget::Stdout) {
return Err(anyhow::anyhow!("The input arguments refer to a collection of blobs and output is set to STDOUT. Only single blobs may be passed in this case."));
}
let tag = match tag {
Some(tag) => SetTagOption::Named(Tag::from(tag)),
None => SetTagOption::Auto,
};
let mode = match queued {
true => DownloadMode::Queued,
false => DownloadMode::Direct,
};
let mut stream = blobs
.download_with_opts(
hash,
DownloadOptions {
format,
nodes: vec![node_addr],
tag,
mode,
},
)
.await?;
show_download_progress(hash, &mut stream).await?;
match out {
None => {}
Some(OutputTarget::Stdout) => {
// we asserted above that `OutputTarget::Stdout` is only permitted if getting a
// single hash and not a hashseq.
let mut blob_read = blobs.read(hash).await?;
tokio::io::copy(&mut blob_read, &mut tokio::io::stdout()).await?;
}
Some(OutputTarget::Path(path)) => {
let absolute = std::env::current_dir()?.join(&path);
if matches!(format, BlobFormat::HashSeq) {
ensure!(!absolute.is_dir(), "output must not be a directory");
}
let recursive = format == BlobFormat::HashSeq;
let mode = match stable {
true => ExportMode::TryReference,
false => ExportMode::Copy,
};
let format = match recursive {
true => ExportFormat::Collection,
false => ExportFormat::Blob,
};
tracing::info!("exporting to {} -> {}", path.display(), absolute.display());
let stream = blobs.export(hash, absolute, format, mode).await?;
// TODO: report export progress
stream.await?;
}
};
Ok(())
}
Self::Export {
hash,
out,
recursive,
stable,
} => {
match out {
OutputTarget::Stdout => {
ensure!(
!recursive,
"Recursive option is not supported when exporting to STDOUT"
);
let mut blob_read = blobs.read(hash).await?;
tokio::io::copy(&mut blob_read, &mut tokio::io::stdout()).await?;
}
OutputTarget::Path(path) => {
let absolute = std::env::current_dir()?.join(&path);
if !recursive {
ensure!(!absolute.is_dir(), "output must not be a directory");
}
let mode = match stable {
true => ExportMode::TryReference,
false => ExportMode::Copy,
};
let format = match recursive {
true => ExportFormat::Collection,
false => ExportFormat::Blob,
};
tracing::info!(
"exporting {hash} to {} -> {}",
path.display(),
absolute.display()
);
let stream = blobs.export(hash, absolute, format, mode).await?;
// TODO: report export progress
stream.await?;
}
};
Ok(())
}
Self::List(cmd) => cmd.run(blobs).await,
Self::Delete(cmd) => cmd.run(blobs).await,
Self::Validate { verbose, repair } => validate(blobs, verbose, repair).await,
Self::ConsistencyCheck { verbose, repair } => {
consistency_check(blobs, verbose, repair).await
}
Self::Add {
source: path,
options,
} => add_with_opts(blobs, addr, path, options).await,
Self::Share {
hash,
addr_options,
recursive,
debug,
} => {
let format = if recursive {
BlobFormat::HashSeq
} else {
BlobFormat::Raw
};
let status = blobs.status(hash).await?;
let mut addr = addr;
addr.apply_options(addr_options);
let ticket = BlobTicket::new(addr, hash, format)?;
let (blob_status, size) = match (status, format) {
(BlobStatus::Complete { size }, BlobFormat::Raw) => ("blob", size),
(BlobStatus::Partial { size }, BlobFormat::Raw) => {
("incomplete blob", size.value())
}
(BlobStatus::Complete { size }, BlobFormat::HashSeq) => ("collection", size),
(BlobStatus::Partial { size }, BlobFormat::HashSeq) => {
("incomplete collection", size.value())
}
(BlobStatus::NotFound, _) => {
return Err(anyhow!("blob is missing"));
}
};
println!(
"Ticket for {blob_status} {hash} ({})\n{ticket}",
HumanBytes(size)
);
if debug {
println!("{ticket:#?}")
}
Ok(())
}
}
}
}
/// Options for the `blob add` command.
#[derive(clap::Args, Debug, Clone)]
pub struct BlobAddOptions {
/// Add in place
///
/// Set this to true only if you are sure that the data in its current location
/// will not change.
#[clap(long, default_value_t = false)]
pub in_place: bool,
/// Tag to tag the data with.
#[clap(long)]
pub tag: Option<String>,
/// Wrap the added file or directory in a collection.
///
/// When adding a single file, without `wrap` the file is added as a single blob and no
/// collection is created. When enabling `wrap` it also creates a collection with a
/// single entry, where the entry's name is the filename and the entry's content is blob.
///
/// When adding a directory, a collection is always created.
/// Without `wrap`, the collection directly contains the entries from the added directory.
/// With `wrap`, the directory will be nested so that all names in the collection are
/// prefixed with the directory name, thus preserving the name of the directory.
///
/// When adding content from STDIN and setting `wrap` you also need to set `filename` to name
/// the entry pointing to the content from STDIN.
#[clap(long, default_value_t = false)]
pub wrap: bool,
/// Override the filename used for the entry in the created collection.
///
/// Only supported `wrap` is set.
/// Required when adding content from STDIN and setting `wrap`.
#[clap(long, requires = "wrap")]
pub filename: Option<String>,
/// Do not print the all-in-one ticket to get the added data from this node.
#[clap(long)]
pub no_ticket: bool,
}
/// Possible list subcommands.
#[derive(Subcommand, Debug, Clone)]
pub enum ListCommands {
/// List the available blobs on the running provider.
Blobs,
/// List the blobs on the running provider that are not full files.
IncompleteBlobs,
/// List the available collections on the running provider.
Collections,
}
impl ListCommands {
/// Runs a list subcommand.
pub async fn run(self, blobs: &blobs::Client) -> Result<()> {
match self {
Self::Blobs => {
let mut response = blobs.list().await?;
while let Some(item) = response.next().await {
let BlobInfo { path, hash, size } = item?;
println!("{} {} ({})", path, hash, HumanBytes(size));
}
}
Self::IncompleteBlobs => {
let mut response = blobs.list_incomplete().await?;
while let Some(item) = response.next().await {
let IncompleteBlobInfo { hash, size, .. } = item?;
println!("{} ({})", hash, HumanBytes(size));
}
}
Self::Collections => {
let mut response = blobs.list_collections()?;
while let Some(item) = response.next().await {
let CollectionInfo {
tag,
hash,
total_blobs_count,
total_blobs_size,
} = item?;
let total_blobs_count = total_blobs_count.unwrap_or_default();
let total_blobs_size = total_blobs_size.unwrap_or_default();
println!(
"{}: {} {} {} ({})",
tag,
hash,
total_blobs_count,
if total_blobs_count > 1 {
"blobs"
} else {
"blob"
},
HumanBytes(total_blobs_size),
);
}
}
}
Ok(())
}
}
/// Possible delete subcommands.
#[derive(Subcommand, Debug, Clone)]
pub enum DeleteCommands {
/// Delete the given blobs
Blob {
/// Blobs to delete
#[arg(required = true)]
hash: Hash,
},
}
impl DeleteCommands {
/// Runs the delete command.
pub async fn run(self, blobs: &blobs::Client) -> Result<()> {
match self {
Self::Blob { hash } => {
let response = blobs.delete_blob(hash).await;
if let Err(e) = response {
eprintln!("Error: {}", e);
}
}
}
Ok(())
}
}
/// Returns the corresponding [`ReportLevel`] given the verbosity level.
fn get_report_level(verbose: u8) -> ReportLevel {
match verbose {
0 => ReportLevel::Warn,
1 => ReportLevel::Info,
_ => ReportLevel::Trace,
}
}
/// Applies the report level to the given text.
fn apply_report_level(text: String, level: ReportLevel) -> console::StyledObject<String> {
match level {
ReportLevel::Trace => style(text).dim(),
ReportLevel::Info => style(text),
ReportLevel::Warn => style(text).yellow(),
ReportLevel::Error => style(text).red(),
}
}
/// Checks the consistency of the blobs on the running node, and repairs inconsistencies if instructed.
pub async fn consistency_check(blobs: &blobs::Client, verbose: u8, repair: bool) -> Result<()> {
let mut response = blobs.consistency_check(repair).await?;
let verbosity = get_report_level(verbose);
let print = |level: ReportLevel, entry: Option<Hash>, message: String| {
if level < verbosity {
return;
}
let level_text = level.to_string().to_lowercase();
let text = if let Some(hash) = entry {
format!("{}: {} ({})", level_text, message, hash.to_hex())
} else {
format!("{}: {}", level_text, message)
};
let styled = apply_report_level(text, level);
eprintln!("{}", styled);
};
while let Some(item) = response.next().await {
match item? {
ConsistencyCheckProgress::Start => {
eprintln!("Starting consistency check ...");
}
ConsistencyCheckProgress::Update {
message,
entry,
level,
} => {
print(level, entry, message);
}
ConsistencyCheckProgress::Done { .. } => {
eprintln!("Consistency check done");
}
ConsistencyCheckProgress::Abort(error) => {
eprintln!("Consistency check error {}", error);
break;
}
}
}
Ok(())
}
/// Checks the validity of the blobs on the running node, and repairs anything invalid if instructed.
pub async fn validate(blobs: &blobs::Client, verbose: u8, repair: bool) -> Result<()> {
let mut state = ValidateProgressState::new();
let mut response = blobs.validate(repair).await?;
let verbosity = get_report_level(verbose);
let print = |level: ReportLevel, entry: Option<Hash>, message: String| {
if level < verbosity {
return;
}
let level_text = level.to_string().to_lowercase();
let text = if let Some(hash) = entry {
format!("{}: {} ({})", level_text, message, hash.to_hex())
} else {
format!("{}: {}", level_text, message)
};
let styled = apply_report_level(text, level);
eprintln!("{}", styled);
};
let mut partial = BTreeMap::new();
while let Some(item) = response.next().await {
match item? {
ValidateProgress::PartialEntry {
id,
hash,
path,
size,
} => {
partial.insert(id, hash);
print(
ReportLevel::Trace,
Some(hash),
format!(
"Validating partial entry {} {} {}",
id,
path.unwrap_or_default(),
size
),
);
}
ValidateProgress::PartialEntryProgress { id, offset } => {
let entry = partial.get(&id).cloned();
print(
ReportLevel::Trace,
entry,
format!("Partial entry {} at {}", id, offset),
);
}
ValidateProgress::PartialEntryDone { id, ranges } => {
let entry: Option<Hash> = partial.remove(&id);
print(
ReportLevel::Info,
entry,
format!("Partial entry {} done {:?}", id, ranges.to_chunk_ranges()),
);
}
ValidateProgress::Starting { total } => {
state.starting(total);
}
ValidateProgress::Entry {
id,
hash,
path,
size,
} => {
state.add_entry(id, hash, path, size);
}
ValidateProgress::EntryProgress { id, offset } => {
state.progress(id, offset);
}
ValidateProgress::EntryDone { id, error } => {
state.done(id, error);
}
ValidateProgress::Abort(error) => {
state.abort(error.to_string());
break;
}
ValidateProgress::AllDone => {
break;
}
}
}
Ok(())
}
/// Collection of all the validation progress state.
struct ValidateProgressState {
mp: MultiProgress,
pbs: HashMap<u64, ProgressBar>,
overall: ProgressBar,
total: u64,
errors: u64,
successes: u64,
}
impl ValidateProgressState {
/// Creates a new validation progress state collection.
fn new() -> Self {
let mp = MultiProgress::new();
let overall = mp.add(ProgressBar::new(0));
overall.enable_steady_tick(Duration::from_millis(500));
Self {
mp,
pbs: HashMap::new(),
overall,
total: 0,
errors: 0,
successes: 0,
}
}
/// Sets the total number to the provided value and style the progress bar to starting.
fn starting(&mut self, total: u64) {
self.total = total;
self.errors = 0;
self.successes = 0;
self.overall.set_position(0);
self.overall.set_length(total);
self.overall.set_style(
ProgressStyle::default_bar()
.template("{spinner:.green} [{bar:60.cyan/blue}] {msg}")
.unwrap()
.progress_chars("=>-"),
);
}
/// Adds a message to the progress bar in the given `id`.
fn add_entry(&mut self, id: u64, hash: Hash, path: Option<String>, size: u64) {
let pb = self.mp.insert_before(&self.overall, ProgressBar::new(size));
pb.set_style(ProgressStyle::default_bar()
.template("{spinner:.green} [{bar:40.cyan/blue}] {msg} {bytes}/{total_bytes} ({bytes_per_sec}, eta {eta})").unwrap()
.progress_chars("=>-"));
let msg = if let Some(path) = path {
format!("{} {}", hash.to_hex(), path)
} else {
hash.to_hex().to_string()
};
pb.set_message(msg);
pb.set_position(0);
pb.set_length(size);
pb.enable_steady_tick(Duration::from_millis(500));
self.pbs.insert(id, pb);
}
/// Progresses the progress bar with `id` by `progress` amount.
fn progress(&mut self, id: u64, progress: u64) {
if let Some(pb) = self.pbs.get_mut(&id) {
pb.set_position(progress);
}
}
/// Set an error in the progress bar. Consumes the [`ValidateProgressState`].
fn abort(self, error: String) {
let error_line = self.mp.add(ProgressBar::new(0));
error_line.set_style(ProgressStyle::default_bar().template("{msg}").unwrap());
error_line.set_message(error);
}
/// Finishes a progress bar with a given error message.
fn done(&mut self, id: u64, error: Option<String>) {
if let Some(pb) = self.pbs.remove(&id) {
let ok_char = style(Emoji("✔", "OK")).green();
let fail_char = style(Emoji("✗", "Error")).red();
let ok = error.is_none();
let msg = match error {
Some(error) => format!("{} {} {}", pb.message(), fail_char, error),
None => format!("{} {}", pb.message(), ok_char),
};
if ok {
self.successes += 1;
} else {
self.errors += 1;
}
self.overall.set_position(self.errors + self.successes);
self.overall.set_message(format!(
"Overall {} {}, {} {}",
self.errors, fail_char, self.successes, ok_char
));
if ok {
pb.finish_and_clear();
} else {
pb.set_style(ProgressStyle::default_bar().template("{msg}").unwrap());
pb.finish_with_message(msg);
}
}
}
}
/// Where the data should be read from.
#[derive(Debug, Clone, derive_more::Display, PartialEq, Eq)]
pub enum BlobSource {
/// Reads from stdin
#[display("STDIN")]
Stdin,
/// Reads from the provided path
#[display("{}", _0.display())]
Path(PathBuf),
}
impl From<String> for BlobSource {
fn from(s: String) -> Self {
if s == "STDIN" {
return BlobSource::Stdin;
}
BlobSource::Path(s.into())
}
}
/// Data source for adding data to iroh.
#[derive(Debug, Clone)]
pub enum BlobSourceIroh {
/// A file or directory on the node's local file system.
LocalFs { path: PathBuf, in_place: bool },
/// Data passed via STDIN.
Stdin,
}
/// Whether to print an all-in-one ticket.
#[derive(Debug, Clone)]
pub enum TicketOption {
/// Do not print an all-in-one ticket
None,
/// Print an all-in-one ticket.
Print,
}
/// Adds a [`BlobSource`] given some [`BlobAddOptions`].
pub async fn add_with_opts(
blobs: &blobs::Client,
addr: NodeAddr,
source: BlobSource,
opts: BlobAddOptions,
) -> Result<()> {
let tag = match opts.tag {
Some(tag) => SetTagOption::Named(Tag::from(tag)),
None => SetTagOption::Auto,
};
let ticket = match opts.no_ticket {
true => TicketOption::None,
false => TicketOption::Print,
};
let source = match source {
BlobSource::Stdin => BlobSourceIroh::Stdin,
BlobSource::Path(path) => BlobSourceIroh::LocalFs {
path,
in_place: opts.in_place,
},
};
let wrap = match (opts.wrap, opts.filename) {
(true, None) => WrapOption::Wrap { name: None },
(true, Some(filename)) => WrapOption::Wrap {
name: Some(filename),
},
(false, None) => WrapOption::NoWrap,
(false, Some(_)) => bail!("`--filename` may not be used without `--wrap`"),
};
add(blobs, addr, source, tag, ticket, wrap).await
}
/// Adds data to iroh, either from a path or, if path is `None`, from STDIN.
pub async fn add(
blobs: &blobs::Client,
addr: NodeAddr,
source: BlobSourceIroh,
tag: SetTagOption,
ticket: TicketOption,
wrap: WrapOption,
) -> Result<()> {
let (hash, format, entries) = match source {
BlobSourceIroh::LocalFs { path, in_place } => {
let absolute = path.canonicalize()?;
println!("Adding {} as {}...", path.display(), absolute.display());
// tell the node to add the data
let stream = blobs.add_from_path(absolute, in_place, tag, wrap).await?;
aggregate_add_response(stream).await?
}
BlobSourceIroh::Stdin => {
println!("Adding from STDIN...");
// Store STDIN content into a temporary file
let (file, path) = tempfile::NamedTempFile::new()?.into_parts();
let mut file = tokio::fs::File::from_std(file);
let path_buf = path.to_path_buf();
// Copy from stdin to the file, until EOF
tokio::io::copy(&mut tokio::io::stdin(), &mut file).await?;
file.flush().await?;
drop(file);
// tell the node to add the data
let stream = blobs.add_from_path(path_buf, false, tag, wrap).await?;
aggregate_add_response(stream).await?
}
};
print_add_response(hash, format, entries);
if let TicketOption::Print = ticket {
let ticket = BlobTicket::new(addr, hash, format)?;
println!("All-in-one ticket: {ticket}");
}
Ok(())
}
/// Entry with a given name, size, and hash.
#[derive(Debug)]
pub struct ProvideResponseEntry {
pub name: String,
pub size: u64,
pub hash: Hash,
}
/// Combines the [`AddProgress`] outputs from a [`Stream`] into a single tuple.
pub async fn aggregate_add_response(
mut stream: impl Stream<Item = Result<AddProgress>> + Unpin,
) -> Result<(Hash, BlobFormat, Vec<ProvideResponseEntry>)> {
let mut hash_and_format = None;
let mut collections = BTreeMap::<u64, (String, u64, Option<Hash>)>::new();
let mut mp = Some(ProvideProgressState::new());
while let Some(item) = stream.next().await {
match item? {
AddProgress::Found { name, id, size } => {
tracing::trace!("Found({id},{name},{size})");
if let Some(mp) = mp.as_mut() {
mp.found(name.clone(), id, size);
}
collections.insert(id, (name, size, None));
}
AddProgress::Progress { id, offset } => {
tracing::trace!("Progress({id}, {offset})");
if let Some(mp) = mp.as_mut() {
mp.progress(id, offset);
}
}
AddProgress::Done { hash, id } => {
tracing::trace!("Done({id},{hash:?})");
if let Some(mp) = mp.as_mut() {
mp.done(id, hash);
}
match collections.get_mut(&id) {
Some((_, _, ref mut h)) => {
*h = Some(hash);
}
None => {
anyhow::bail!("Got Done for unknown collection id {id}");
}
}
}
AddProgress::AllDone { hash, format, .. } => {
tracing::trace!("AllDone({hash:?})");
if let Some(mp) = mp.take() {
mp.all_done();
}
hash_and_format = Some(HashAndFormat { hash, format });
break;
}
AddProgress::Abort(e) => {
if let Some(mp) = mp.take() {
mp.error();
}
anyhow::bail!("Error while adding data: {e}");
}
}
}
let HashAndFormat { hash, format } =
hash_and_format.context("Missing hash for collection or blob")?;
let entries = collections
.into_iter()
.map(|(_, (name, size, hash))| {
let hash = hash.context(format!("Missing hash for {name}"))?;
Ok(ProvideResponseEntry { name, size, hash })
})
.collect::<Result<Vec<_>>>()?;
Ok((hash, format, entries))
}
/// Prints out the add response.
pub fn print_add_response(hash: Hash, format: BlobFormat, entries: Vec<ProvideResponseEntry>) {
let mut total_size = 0;
for ProvideResponseEntry { name, size, hash } in entries {
total_size += size;
println!("- {}: {} {:#}", name, HumanBytes(size), hash);
}
println!("Total: {}", HumanBytes(total_size));
println!();
match format {
BlobFormat::Raw => println!("Blob: {}", hash),
BlobFormat::HashSeq => println!("Collection: {}", hash),
}
}
/// Progress state for providing.
#[derive(Debug)]
pub struct ProvideProgressState {
mp: MultiProgress,
pbs: HashMap<u64, ProgressBar>,
}
impl ProvideProgressState {
/// Creates a new provide progress state.
fn new() -> Self {
Self {
mp: MultiProgress::new(),
pbs: HashMap::new(),
}
}
/// Inserts a new progress bar with the given id, name, and size.
fn found(&mut self, name: String, id: u64, size: u64) {
let pb = self.mp.add(ProgressBar::new(size));
pb.set_style(ProgressStyle::default_bar()
.template("{spinner:.green} [{bar:40.cyan/blue}] {msg} {bytes}/{total_bytes} ({bytes_per_sec}, eta {eta})").unwrap()
.progress_chars("=>-"));
pb.set_message(name);
pb.set_length(size);
pb.set_position(0);
pb.enable_steady_tick(Duration::from_millis(500));
self.pbs.insert(id, pb);
}
/// Adds some progress to the progress bar with the given id.
fn progress(&mut self, id: u64, progress: u64) {
if let Some(pb) = self.pbs.get_mut(&id) {
pb.set_position(progress);
}
}
/// Sets the multiprogress bar with the given id as finished and clear it.
fn done(&mut self, id: u64, _hash: Hash) {
if let Some(pb) = self.pbs.remove(&id) {
pb.finish_and_clear();
self.mp.remove(&pb);
}
}
/// Sets the multiprogress bar as finished and clear them.
fn all_done(self) {
self.mp.clear().ok();
}
/// Clears the multiprogress bar.
fn error(self) {
self.mp.clear().ok();
}
}
/// Displays the download progress for a given stream.
pub async fn show_download_progress(
hash: Hash,
mut stream: impl Stream<Item = Result<DownloadProgress>> + Unpin,
) -> Result<()> {
eprintln!("Fetching: {}", hash);
let mp = MultiProgress::new();
mp.set_draw_target(ProgressDrawTarget::stderr());
let op = mp.add(make_overall_progress());
let ip = mp.add(make_individual_progress());
op.set_message(format!("{} Connecting ...\n", style("[1/3]").bold().dim()));
let mut seq = false;
while let Some(x) = stream.next().await {
match x? {
DownloadProgress::InitialState(state) => {
if state.connected {
op.set_message(format!("{} Requesting ...\n", style("[2/3]").bold().dim()));
}
if let Some(count) = state.root.child_count {
op.set_message(format!(
"{} Downloading {} blob(s)\n",
style("[3/3]").bold().dim(),
count + 1,
));
op.set_length(count + 1);
op.reset();
op.set_position(state.current.map(u64::from).unwrap_or(0));
seq = true;
}
if let Some(blob) = state.get_current() {
if let Some(size) = blob.size {
ip.set_length(size.value());
ip.reset();
match blob.progress {
BlobProgress::Pending => {}
BlobProgress::Progressing(offset) => ip.set_position(offset),
BlobProgress::Done => ip.finish_and_clear(),
}
if !seq {
op.finish_and_clear();
}
}
}
}
DownloadProgress::FoundLocal { .. } => {}
DownloadProgress::Connected => {
op.set_message(format!("{} Requesting ...\n", style("[2/3]").bold().dim()));
}
DownloadProgress::FoundHashSeq { children, .. } => {
op.set_message(format!(
"{} Downloading {} blob(s)\n",
style("[3/3]").bold().dim(),
children + 1,
));
op.set_length(children + 1);
op.reset();
seq = true;
}
DownloadProgress::Found { size, child, .. } => {
if seq {
op.set_position(child.into());
} else {
op.finish_and_clear();
}
ip.set_length(size);
ip.reset();
}
DownloadProgress::Progress { offset, .. } => {
ip.set_position(offset);
}
DownloadProgress::Done { .. } => {
ip.finish_and_clear();
}
DownloadProgress::AllDone(Stats {
bytes_read,
elapsed,
..
}) => {
op.finish_and_clear();
eprintln!(
"Transferred {} in {}, {}/s",
HumanBytes(bytes_read),
HumanDuration(elapsed),
HumanBytes((bytes_read as f64 / elapsed.as_secs_f64()) as u64)
);
break;
}
DownloadProgress::Abort(e) => {
bail!("download aborted: {}", e);
}
}
}
Ok(())
}
/// Where the data should be stored.
#[derive(Debug, Clone, derive_more::Display, PartialEq, Eq)]
pub enum OutputTarget {
/// Writes to stdout
#[display("STDOUT")]
Stdout,
/// Writes to the provided path
#[display("{}", _0.display())]
Path(PathBuf),
}
impl From<String> for OutputTarget {
fn from(s: String) -> Self {
if s == "STDOUT" {
return OutputTarget::Stdout;
}
OutputTarget::Path(s.into())
}
}
/// Creates a [`ProgressBar`] with some defaults for the overall progress.
fn make_overall_progress() -> ProgressBar {
let pb = ProgressBar::hidden();
pb.enable_steady_tick(std::time::Duration::from_millis(100));
pb.set_style(
ProgressStyle::with_template(
"{msg}{spinner:.green} [{elapsed_precise}] [{wide_bar:.cyan/blue}] {pos}/{len}",
)
.unwrap()
.progress_chars("#>-"),
);
pb
}
/// Creates a [`ProgressBar`] with some defaults for the individual progress.
fn make_individual_progress() -> ProgressBar {
let pb = ProgressBar::hidden();
pb.enable_steady_tick(std::time::Duration::from_millis(100));
pb.set_style(
ProgressStyle::with_template("{msg}{spinner:.green} [{elapsed_precise}] [{wide_bar:.cyan/blue}] {bytes}/{total_bytes} ({eta})")
.unwrap()
.with_key(
"eta",
|state: &ProgressState, w: &mut dyn std::fmt::Write| {
write!(w, "{:.1}s", state.eta().as_secs_f64()).unwrap()
},
)
.progress_chars("#>-"),
);
pb
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_blob_source() {
assert_eq!(
BlobSource::from(BlobSource::Stdin.to_string()),
BlobSource::Stdin
);
assert_eq!(
BlobSource::from(BlobSource::Path("hello/world".into()).to_string()),
BlobSource::Path("hello/world".into()),
);
}
#[test]
fn test_output_target() {
assert_eq!(
OutputTarget::from(OutputTarget::Stdout.to_string()),
OutputTarget::Stdout
);
assert_eq!(
OutputTarget::from(OutputTarget::Path("hello/world".into()).to_string()),
OutputTarget::Path("hello/world".into()),
);
}
}