-
Notifications
You must be signed in to change notification settings - Fork 88
/
cli.rs
1620 lines (1425 loc) · 50.9 KB
/
cli.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
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
use std::convert::TryFrom;
use std::env;
use std::ffi::{OsStr, OsString};
use std::fmt;
use std::fs;
use std::io::Write;
use std::mem;
use std::path::PathBuf;
use std::str::FromStr;
use std::time::Duration;
use anyhow::anyhow;
use clap::{self, AppSettings, ArgEnum, Error, ErrorKind, FromArgMatches, Result};
use encoding_rs::Encoding;
use once_cell::sync::OnceCell;
use reqwest::{tls, Method, Url};
use serde::Deserialize;
use crate::buffer::Buffer;
use crate::regex;
use crate::request_items::RequestItems;
use crate::utils::config_dir;
// Some doc comments were copy-pasted from HTTPie
// clap guidelines:
// - Only use `short` with an explicit arg (`short = "x"`)
// - Only use `long` with an implicit arg (just `long`)
// - Unless it needs a different name, but then also use `name = "..."`
// - Add an uppercase value_name to options that take a value
/// xh is a friendly and fast tool for sending HTTP requests.
///
/// It reimplements as much as possible of HTTPie's excellent design, with a focus
/// on improved performance.
#[derive(clap::Parser, Debug)]
#[clap(
version,
long_version = long_version(),
setting(AppSettings::DeriveDisplayOrder),
args_override_self = true,
)]
pub struct Cli {
#[clap(skip)]
pub httpie_compat_mode: bool,
/// (default) Serialize data items from the command line as a JSON object.
///
/// Overrides both --form and --multipart.
#[clap(short = 'j', long, overrides_with_all = &["form", "multipart"])]
pub json: bool,
/// Serialize data items from the command line as form fields.
///
/// Overrides both --json and --multipart.
#[clap(short = 'f', long, overrides_with_all = &["json", "multipart"])]
pub form: bool,
/// Like --form, but force a multipart/form-data request even without files.
///
/// Overrides both --json and --form.
#[clap(short = 'm', long, overrides_with_all = &["json", "form"])]
pub multipart: bool,
/// Pass raw request data without extra processing.
#[clap(long, value_name = "RAW")]
pub raw: Option<String>,
/// Controls output processing
#[clap(
long,
arg_enum,
value_name = "STYLE",
long_help = "\
Controls output processing. Possible values are:
all (default) Enable both coloring and formatting
colors Apply syntax highlighting to output
format Pretty-print json and sort headers
none Disable both coloring and formatting
Defaults to \"format\" if the NO_COLOR env is set and to \"none\" if stdout is not tty."
)]
pub pretty: Option<Pretty>,
/// Output coloring style.
#[clap(short = 's', long, arg_enum, value_name = "THEME")]
pub style: Option<Theme>,
/// Override the response encoding for terminal display purposes.
///
/// Example: --response-charset=latin1
#[clap(long, value_name = "ENCODING", parse(try_from_str = parse_encoding))]
pub response_charset: Option<&'static Encoding>,
/// Override the response mime type for coloring and formatting for the terminal.
///
/// Example: --response-mime=application/json
#[clap(long, value_name = "MIME_TYPE")]
pub response_mime: Option<String>,
/// String specifying what the output should contain.
///
/// Use "H" and "B" for request header and body respectively,
/// and "h" and "b" for response header and body.
///
/// Example: --print=Hb
#[clap(short = 'p', long, value_name = "FORMAT")]
pub print: Option<Print>,
/// Print only the response headers. Shortcut for --print=h.
#[clap(short = 'h', long)]
pub headers: bool,
/// Print only the response body. Shortcut for --print=b.
#[clap(short = 'b', long)]
pub body: bool,
/// Print the whole request as well as the response.
///
/// Additionally, this enables --all for printing intermediary
/// requests/responses while following redirects.
///
/// Equivalent to --print=HhBb --all.
#[clap(short = 'v', long)]
pub verbose: bool,
/// Show any intermediary requests/responses while following redirects with --follow.
#[clap(long)]
pub all: bool,
/// The same as --print but applies only to intermediary requests/responses.
#[clap(short = 'P', long, value_name = "FORMAT")]
pub history_print: Option<Print>,
/// Resolve hostname to ipv4 addresses only.
#[clap(short = '4', long)]
pub ipv4: bool,
/// Resolve hostname to ipv6 addresses only.
#[clap(short = '6', long)]
pub ipv6: bool,
/// Do not print to stdout or stderr.
#[clap(short = 'q', long)]
pub quiet: bool,
/// Always stream the response body.
#[clap(short = 'S', long)]
pub stream: bool,
/// Save output to FILE instead of stdout.
#[clap(short = 'o', long, value_name = "FILE", parse(from_os_str))]
pub output: Option<PathBuf>,
/// Download the body to a file instead of printing it.
///
/// The Accept-Encoding header is set to identify and any redirects will be followed.
#[clap(short = 'd', long)]
pub download: bool,
/// During download, keep the raw encoding of the body. Requires --download.
///
/// For example, set Accept-Encoding: gzip and use --preserve-encoding to skip decompression.
#[clap(long, requires = "download")]
pub preserve_encoding: bool,
/// Resume an interrupted download. Requires --download and --output.
#[clap(
short = 'c',
long = "continue",
name = "continue",
requires = "download",
requires = "output"
)]
pub resume: bool,
/// Create, or reuse and update a session.
///
/// Within a session, custom headers, auth credentials, as well as any cookies sent
/// by the server persist between requests.
#[clap(long, value_name = "FILE", parse(from_os_str))]
pub session: Option<OsString>,
/// Create or read a session without updating it form the request/response exchange.
#[clap(
long,
value_name = "FILE",
conflicts_with = "session",
parse(from_os_str)
)]
pub session_read_only: Option<OsString>,
#[clap(skip)]
pub is_session_read_only: bool,
/// Specify the auth mechanism.
#[clap(short = 'A', long, arg_enum)]
pub auth_type: Option<AuthType>,
/// Authenticate as USER with PASS (-A basic|digest) or with TOKEN (-A bearer).
///
/// PASS will be prompted if missing. Use a trailing colon (i.e. "USER:")
/// to authenticate with just a username.
///
/// TOKEN is expected if --auth-type=bearer.
#[clap(short = 'a', long, value_name = "USER[:PASS] | TOKEN")]
pub auth: Option<String>,
/// Authenticate with a bearer token.
#[clap(long, value_name = "TOKEN", hide = true)]
pub bearer: Option<String>,
/// Do not use credentials from .netrc
#[clap(long)]
pub ignore_netrc: bool,
/// Construct HTTP requests without sending them anywhere.
#[clap(long)]
pub offline: bool,
/// (default) Exit with an error status code if the server replies with an error.
///
/// The exit code will be 4 on 4xx (Client Error), 5 on 5xx (Server Error),
/// or 3 on 3xx (Redirect) if --follow isn't set.
///
/// If stdout is redirected then a warning is written to stderr.
#[clap(long = "check-status", name = "check-status")]
pub check_status_raw: bool,
#[clap(skip)]
pub check_status: Option<bool>,
/// Do follow redirects.
#[clap(short = 'F', long)]
pub follow: bool,
/// Number of redirects to follow. Only respected if --follow is used.
#[clap(long, value_name = "NUM")]
pub max_redirects: Option<usize>,
/// Connection timeout of the request.
///
/// The default value is "0", i.e., there is no timeout limit.
#[clap(long, value_name = "SEC")]
pub timeout: Option<Timeout>,
/// Use a proxy for a protocol. For example: --proxy https:http://proxy.host:8080.
///
/// PROTOCOL can be "http", "https" or "all".
///
/// If your proxy requires credentials, put them in the URL, like so:
/// --proxy http:socks5://user:password@proxy.host:8000.
///
/// You can specify proxies for multiple protocols by repeating this option.
///
/// The environment variables "http_proxy" and "https_proxy" can also be used, but
/// are completely ignored if --proxy is passed.
#[clap(long, value_name = "PROTOCOL:URL", number_of_values = 1)]
pub proxy: Vec<Proxy>,
/// If "no", skip SSL verification. If a file path, use it as a CA bundle.
///
/// Specifying a CA bundle will disable the system's built-in root certificates.
///
/// "false" instead of "no" also works. The default is "yes" ("true").
#[clap(long, value_name = "VERIFY", parse(from_os_str))]
pub verify: Option<Verify>,
/// Use a client side certificate for SSL.
#[clap(long, value_name = "FILE", parse(from_os_str))]
pub cert: Option<PathBuf>,
/// A private key file to use with --cert.
///
/// Only necessary if the private key is not contained in the cert file.
#[clap(long, value_name = "FILE", parse(from_os_str))]
pub cert_key: Option<PathBuf>,
/// Force a particular TLS version.
///
/// "auto" gives the default behavior of negotiating a version
/// with the server.
#[clap(long, value_name = "VERSION", parse(from_str = parse_tls_version),
possible_value = clap::PossibleValue::new("auto").alias("ssl2.3"),
possible_values = &["tls1", "tls1.1", "tls1.2", "tls1.3"]
)]
// The nested option is weird, but parse_tls_version can return None.
// If the inner option doesn't use a qualified path clap gets confused.
pub ssl: Option<std::option::Option<tls::Version>>,
/// Use the system TLS library instead of rustls (if enabled at compile time).
#[clap(long, hide = cfg!(not(all(feature = "native-tls", feature = "rustls"))))]
pub native_tls: bool,
/// The default scheme to use if not specified in the URL.
#[clap(long, value_name = "SCHEME", hide = true)]
pub default_scheme: Option<String>,
/// Make HTTPS requests if not specified in the URL.
#[clap(long)]
pub https: bool,
/// HTTP version to use.
#[clap(long, value_name = "VERSION",
possible_value = clap::PossibleValue::new("1.0"),
possible_value = clap::PossibleValue::new("1.1").alias("1"),
possible_value = clap::PossibleValue::new("2")
)]
pub http_version: Option<HttpVersion>,
/// Do not attempt to read stdin.
///
/// This disables the default behaviour of reading the request body from stdin
/// when a redirected input is detected.
///
/// It is recommended to pass this flag when using xh for scripting purposes.
/// For more information, refer to https://httpie.io/docs/cli/best-practices.
#[clap(short = 'I', long)]
pub ignore_stdin: bool,
/// Print a translation to a curl command.
///
/// For translating the other way, try https://curl2httpie.online/.
#[clap(long)]
pub curl: bool,
/// Use the long versions of curl's flags.
#[clap(long)]
pub curl_long: bool,
/// The request URL, preceded by an optional HTTP method.
///
/// If the method is omitted, it will default to GET, or to POST
/// if the request contains a body.
///
/// The URL scheme defaults to "http://" normally, or "https://" if
/// the program is invoked as "xhs".
///
/// A leading colon works as shorthand for localhost. ":8000" is equivalent
/// to "localhost:8000", and ":/path" is equivalent to "localhost/path".
#[clap(value_name = "[METHOD] URL")]
raw_method_or_url: String,
/// Optional key-value pairs to be included in the request.
///
/// The separator is used to determine the type:
///
/// key==value
/// Add a query string to the URL.
///
/// key=value
/// Add a JSON property (--json) or form field (--form) to
/// the request body.
///
/// key=@filename
/// Add a JSON property (--json) or form field (--form) from a
/// file to the request body.
///
/// key:=value
/// Add a field with a literal JSON value to the request body.
///
/// Example: "numbers:=[1,2,3] enabled:=true"
///
/// key:=@filename
/// Add a field with a literal JSON value from a file to the
/// request body.
///
/// key@filename
/// Upload a file (requires --form or --multipart).
///
/// To set the filename and mimetype, ";type=" and
/// ";filename=" can be used respectively.
///
/// Example: "pfp@ra.jpg;type=image/jpeg;filename=profile.jpg"
///
/// @filename
/// Use a file as the request body.
///
/// header:value
/// Add a header, e.g. "user-agent:foobar"
///
/// header:
/// Unset a header, e.g. "connection:"
///
/// header;
/// Add a header with an empty value.
///
/// A backslash can be used to escape special characters, e.g. "weird\:key=value".
///
/// To construct a complex JSON object, the REQUEST_ITEM's key can be set to a JSON path instead of a field name.
/// For more information on this syntax, refer to https://httpie.io/docs/cli/nested-json.
#[clap(value_name = "REQUEST_ITEM", verbatim_doc_comment)]
raw_rest_args: Vec<String>,
/// The HTTP method, if supplied.
#[clap(skip)]
pub method: Option<Method>,
/// The request URL.
#[clap(skip = ("http://placeholder".parse::<Url>().unwrap()))]
pub url: Url,
/// Optional key-value pairs to be included in the request.
#[clap(skip)]
pub request_items: RequestItems,
/// The name of the binary.
#[clap(skip)]
pub bin_name: String,
}
impl Cli {
pub fn parse() -> Self {
if let Some(default_args) = default_cli_args() {
let mut args = std::env::args_os();
Self::parse_from(
std::iter::once(args.next().unwrap_or_else(|| "xh".into()))
.chain(default_args.into_iter().map(Into::into))
.chain(args),
)
} else {
Self::parse_from(std::env::args_os())
}
}
pub fn parse_from<I>(iter: I) -> Self
where
I: IntoIterator,
I::Item: Into<OsString> + Clone,
{
match Self::try_parse_from(iter) {
Ok(cli) => cli,
Err(err) if err.kind() == ErrorKind::DisplayHelp => {
// The logic here is a little tricky.
//
// Normally with clap, -h prints short help while --help
// prints long help.
//
// But -h is short for --header, so we want --help to print short help
// and `help` (pseudo-subcommand) to print long help.
//
// --help is baked into clap. So we intercept its special error that
// would print long help and print short help instead. And if we do
// want to print long help, then we handle that in try_parse_from
// instead of here.
Self::into_app().print_help().unwrap();
println!(
"\nRun `{} help` for more complete documentation.",
env!("CARGO_PKG_NAME")
);
safe_exit();
}
Err(err) => err.exit(),
}
}
pub fn try_parse_from<I>(iter: I) -> clap::Result<Self>
where
I: IntoIterator,
I::Item: Into<OsString> + Clone,
{
let mut app = Self::into_app();
let matches = app.try_get_matches_from_mut(iter)?;
let mut cli = Self::from_arg_matches(&matches)?;
match cli.raw_method_or_url.as_str() {
"help" => {
// opt-out of clap's auto-generated possible values help for --pretty
// as we already list them in the long_help
app = app.mut_arg("pretty", |a| a.hide_possible_values(true));
app.print_long_help().unwrap();
println!();
safe_exit();
}
"generate-completions" => return Err(generate_completions(app, cli.raw_rest_args)),
"generate-manpages" => return Err(generate_manpages(app, cli.raw_rest_args)),
_ => {}
}
let mut rest_args = mem::take(&mut cli.raw_rest_args).into_iter();
let raw_url = match parse_method(&cli.raw_method_or_url) {
Some(method) => {
cli.method = Some(method);
rest_args
.next()
.ok_or_else(|| app.error(ErrorKind::MissingRequiredArgument, "Missing <URL>"))?
}
None => {
cli.method = None;
mem::take(&mut cli.raw_method_or_url)
}
};
for request_item in rest_args {
cli.request_items.items.push(
request_item
.parse()
.map_err(|err: Error| err.format(&mut app))?,
);
}
cli.bin_name = app
.get_bin_name()
.and_then(|name| name.split('.').next())
.unwrap_or("xh")
.to_owned();
if matches!(cli.bin_name.as_str(), "https" | "xhs" | "xhttps") {
cli.https = true;
}
if matches!(cli.bin_name.as_str(), "http" | "https")
|| env::var_os("XH_HTTPIE_COMPAT_MODE").is_some()
{
cli.httpie_compat_mode = true;
}
cli.process_relations(&matches)?;
cli.url = construct_url(
&raw_url,
cli.default_scheme.as_deref(),
cli.request_items.query(),
)
.map_err(|err| {
app.error(
ErrorKind::ValueValidation,
format!("Invalid <URL>: {}", err),
)
})?;
if cfg!(not(feature = "rustls")) {
cli.native_tls = true;
}
Ok(cli)
}
/// Set flags that are implied by other flags and report conflicting flags.
fn process_relations(&mut self, matches: &clap::ArgMatches) -> clap::Result<()> {
if self.verbose {
self.all = true;
}
if self.curl_long {
self.curl = true;
}
if self.https {
self.default_scheme = Some("https".to_string());
}
if self.bearer.is_some() {
self.auth_type = Some(AuthType::Bearer);
self.auth = self.bearer.take();
}
self.check_status = match (self.check_status_raw, matches.is_present("no-check-status")) {
(true, true) => unreachable!(),
(true, false) => Some(true),
(false, true) => Some(false),
(false, false) => None,
};
if self.download {
self.follow = true;
self.check_status = Some(true);
}
// `overrides_with_all` ensures that only one of these is true
if self.json {
self.request_items.body_type = BodyType::Json;
} else if self.form {
self.request_items.body_type = BodyType::Form;
} else if self.multipart {
self.request_items.body_type = BodyType::Multipart;
}
if self.session_read_only.is_some() {
self.is_session_read_only = true;
self.session = mem::take(&mut self.session_read_only);
}
Ok(())
}
pub fn into_app() -> clap::Command<'static> {
let app = <Self as clap::CommandFactory>::command();
// Every option should have a --no- variant that makes it as if it was
// never passed.
// https://github.com/clap-rs/clap/issues/815
// https://github.com/httpie/httpie/blob/225dccb2186f14f871695b6c4e0bfbcdb2e3aa28/httpie/cli/argparser.py#L312
// Unlike HTTPie we apply the options in order, so the --no- variant
// has to follow the original to apply. You could have a chain of
// --x=y --no-x --x=z where the last one takes precedence.
let opts: Vec<_> = app.get_arguments().filter(|a| !a.is_positional()).collect();
// The strings in the `Arg`s need to live for 'static. That's a problem,
// because we also need to generate them right here.
// We could use Box::leak(), but this OnceCell maneuver keeps valgrind
// happy-ish.
// We assume that `get_arguments()` has a fixed iteration order.
static ARG_STORAGE: OnceCell<Vec<String>> = OnceCell::new();
let arg_storage = ARG_STORAGE.get_or_init(|| {
opts.iter()
.map(|opt| format!("--no-{}", opt.get_long().expect("long option")))
.collect()
});
let negations: Vec<_> = opts
.into_iter()
.zip(arg_storage)
.map(|(opt, flag)| {
// The name is inconsequential, but it has to be unique and it
// needs a static lifetime, and `flag` satisfies that
clap::Arg::new(&flag[2..])
.long(flag)
.hide(true)
// overrides_with is enough to make the flags take effect
// We never have to check their values, they'll simply
// unset previous occurrences of the original flag
.overrides_with(opt.get_id())
})
.collect();
app.args(negations)
.after_help("Each option can be reset with a --no-OPTION argument.")
}
}
#[derive(Deserialize)]
struct Config {
default_options: Vec<String>,
}
fn default_cli_args() -> Option<Vec<String>> {
let content = match fs::read_to_string(config_dir()?.join("config.json")) {
Ok(file) => Some(file),
Err(err) => {
if err.kind() != std::io::ErrorKind::NotFound {
eprintln!(
"\n{}: warning: Unable to read config file: {}\n",
env!("CARGO_PKG_NAME"),
err
);
}
None
}
}?;
match serde_json::from_str::<Config>(&content) {
Ok(config) => Some(config.default_options),
Err(err) => {
eprintln!(
"\n{}: warning: Unable to parse config file: {}\n",
env!("CARGO_PKG_NAME"),
err
);
None
}
}
}
fn parse_method(method: &str) -> Option<Method> {
// This unfortunately matches "localhost"
if !method.is_empty() && method.chars().all(|c| c.is_ascii_alphabetic()) {
// Method parsing seems to fail if the length is 0 or if there's a null byte
// Our checks rule those both out, so .unwrap() is safe
Some(method.to_ascii_uppercase().parse().unwrap())
} else {
None
}
}
fn construct_url(
url: &str,
default_scheme: Option<&str>,
query: Vec<(&str, &str)>,
) -> std::result::Result<Url, url::ParseError> {
let mut default_scheme = default_scheme.unwrap_or("http://").to_string();
if !default_scheme.ends_with("://") {
default_scheme.push_str("://");
}
let mut url: Url = if let Some(url) = url.strip_prefix("://") {
// Allow users to quickly convert a URL copied from a clipboard to xh/HTTPie command
// by simply adding a space before `://`.
// Example: https://example.org -> https ://example.org
format!("{}{}", default_scheme, url).parse()?
} else if url.starts_with(':') {
format!("{}{}{}", default_scheme, "localhost", url).parse()?
} else if !regex!("[a-zA-Z0-9]://.+").is_match(url) {
format!("{}{}", default_scheme, url).parse()?
} else {
url.parse()?
};
if !query.is_empty() {
// If we run this even without adding pairs it adds a `?`, hence
// the .is_empty() check
let mut pairs = url.query_pairs_mut();
for (name, value) in query {
pairs.append_pair(name, value);
}
}
Ok(url)
}
#[cfg(feature = "man-completion-gen")]
// This signature is a little weird: we either return an error or don't return at all
fn generate_completions(mut app: clap::Command, rest_args: Vec<String>) -> Error {
let bin_name = match app.get_bin_name() {
Some(name) => name.to_owned(),
None => return app.error(ErrorKind::EmptyValue, "Missing binary name"),
};
if rest_args.len() != 1 {
return app.error(
ErrorKind::WrongNumberOfValues,
"Usage: xh generate-completions <DIRECTORY>",
);
}
for &shell in clap_complete::Shell::value_variants() {
// Elvish complains about multiple deprecations and these don't seem to work
if shell != clap_complete::Shell::Elvish {
clap_complete::generate_to(shell, &mut app, &bin_name, &rest_args[0]).unwrap();
}
}
safe_exit();
}
#[cfg(feature = "man-completion-gen")]
fn generate_manpages(mut app: clap::Command, rest_args: Vec<String>) -> Error {
use roff::{bold, italic, roman, Roff};
use time::OffsetDateTime as DateTime;
if rest_args.len() != 1 {
return app.error(
ErrorKind::WrongNumberOfValues,
"Usage: xh generate-manpages <DIRECTORY>",
);
}
let items: Vec<_> = app.get_arguments().filter(|i| !i.is_hide_set()).collect();
let mut request_items_roff = Roff::new();
let request_items = items
.iter()
.find(|opt| opt.get_id() == "raw-rest-args")
.unwrap();
let request_items_help = request_items
.get_long_help()
.or_else(|| request_items.get_help())
.expect("request_items is missing help");
// replace the indents in request_item help with proper roff controls
// For example:
//
// ```
// normal help normal help
// normal help normal help
//
// request-item-1
// help help
//
// request-item-2
// help help
//
// normal help normal help
// ```
//
// Should look like this with roff controls
//
// ```
// normal help normal help
// normal help normal help
// .RS 12
// .TP
// request-item-1
// help help
// .TP
// request-item-2
// help help
// .RE
//
// .RS
// normal help normal help
// .RE
// ```
let lines: Vec<&str> = request_items_help.lines().collect();
let mut rs = false;
for i in 0..lines.len() {
if lines[i].is_empty() {
let prev = lines[i - 1].chars().take_while(|&x| x == ' ').count();
let next = lines[i + 1].chars().take_while(|&x| x == ' ').count();
if prev != next && next > 0 {
if !rs {
request_items_roff.control("RS", ["8"]);
rs = true;
}
request_items_roff.control("TP", ["4"]);
} else if prev != next && next == 0 {
request_items_roff.control("RE", []);
request_items_roff.text(vec![roman("")]);
request_items_roff.control("RS", []);
} else {
request_items_roff.text(vec![roman(lines[i])]);
}
} else {
request_items_roff.text(vec![roman(lines[i].trim())]);
}
}
request_items_roff.control("RE", []);
let mut options_roff = Roff::new();
let non_pos_items = items
.iter()
.filter(|a| !a.is_positional())
.collect::<Vec<_>>();
// move the first two items (i.e. --help, --version) to the end
let non_pos_items = non_pos_items
.iter()
.cycle()
.skip(2)
.take(non_pos_items.len());
for opt in non_pos_items {
let mut header = vec![];
if let Some(short) = opt.get_short() {
header.push(bold(format!("-{}", short)));
}
if let Some(long) = opt.get_long() {
if !header.is_empty() {
header.push(roman(", "));
}
header.push(bold(format!("--{}", long)));
}
if let Some(value) = &opt.get_value_names() {
if opt.get_long().is_some() {
header.push(roman("="));
} else {
header.push(roman(" "));
}
if opt.get_id() == "auth" {
header.push(italic("USER"));
header.push(roman("["));
header.push(italic(":PASS"));
header.push(roman("] | "));
header.push(italic("TOKEN"));
} else {
header.push(italic(&value.join(" ")));
}
}
let mut body = vec![];
let mut help = opt
.get_long_help()
.or_else(|| opt.get_help())
.expect("option is missing help")
.to_owned();
if !help.ends_with('.') {
help.push('.')
}
body.push(roman(help));
if let Some(possible_values) = opt.get_possible_values() {
if !opt.is_hide_possible_values_set() && opt.get_id() != "pretty" {
let possible_values_text = format!(
"\n\n[possible values: {}]",
possible_values
.iter()
.map(|v| v.get_name())
.collect::<Vec<_>>()
.join(", ")
);
body.push(roman(possible_values_text));
}
}
options_roff.control("TP", ["4"]);
options_roff.text(header);
options_roff.text(body);
}
let mut manpage = fs::read_to_string(format!("{}/man-template.roff", rest_args[0])).unwrap();
let current_date = {
let (year, month, day) = DateTime::now_utc().date().as_ymd();
format!("{}-{:02}-{:02}", year, month, day)
};
manpage = manpage.replace("{{date}}", ¤t_date);
manpage = manpage.replace("{{version}}", app.get_version().unwrap());
manpage = manpage.replace("{{request_items}}", request_items_roff.to_roff().trim());
manpage = manpage.replace("{{options}}", options_roff.to_roff().trim());
fs::write(format!("{}/xh.1", rest_args[0]), manpage).unwrap();
safe_exit();
}
#[cfg(not(feature = "man-completion-gen"))]
fn generate_completions(mut _app: clap::Command, _rest_args: Vec<String>) -> Error {
clap::Error::raw(
clap::ErrorKind::InvalidSubcommand,
"generate-completions requires enabling man-completion-gen feature\n",
)
}
#[cfg(not(feature = "man-completion-gen"))]
fn generate_manpages(mut _app: clap::Command, _rest_args: Vec<String>) -> Error {
clap::Error::raw(
clap::ErrorKind::InvalidSubcommand,
"generate-manpages requires enabling man-completion-gen feature\n",
)
}
#[derive(ArgEnum, Copy, Clone, Debug, PartialEq, Eq)]
pub enum AuthType {
Basic,
Bearer,
Digest,
}
impl Default for AuthType {
fn default() -> Self {
AuthType::Basic
}
}
#[derive(ArgEnum, Debug, PartialEq, Eq, Clone, Copy)]
pub enum Pretty {
/// (default) Enable both coloring and formatting
All,
/// Apply syntax highlighting to output
Colors,
/// Pretty-print json and sort headers
Format,
/// Disable both coloring and formatting
None,
}
/// The caller must check in advance if the string is valid. (clap does this.)
fn parse_tls_version(text: &str) -> Option<tls::Version> {
match text {
// ssl2.3 is not a real version but it's how HTTPie spells "auto"
"auto" | "ssl2.3" => None,
"tls1" => Some(tls::Version::TLS_1_0),
"tls1.1" => Some(tls::Version::TLS_1_1),
"tls1.2" => Some(tls::Version::TLS_1_2),
"tls1.3" => Some(tls::Version::TLS_1_3),
_ => unreachable!(),
}
}
impl Pretty {
pub fn color(self) -> bool {
matches!(self, Pretty::Colors | Pretty::All)
}
pub fn format(self) -> bool {
matches!(self, Pretty::Format | Pretty::All)
}
}
#[derive(ArgEnum, Debug, PartialEq, Eq, Clone, Copy)]
pub enum Theme {
Auto,
Solarized,
Monokai,
Fruity,
}
impl Theme {
pub fn as_str(&self) -> &'static str {
match self {
Theme::Auto => "ansi",
Theme::Solarized => "solarized",
Theme::Monokai => "monokai",
Theme::Fruity => "fruity",
}
}
}
#[derive(Debug, Clone, Copy)]
pub struct Print {
pub request_headers: bool,
pub request_body: bool,
pub response_headers: bool,
pub response_body: bool,
}
impl Print {
pub fn new(
verbose: bool,
headers: bool,
body: bool,
quiet: bool,
offline: bool,
buffer: &Buffer,
) -> Self {
if verbose {
Print {
request_headers: true,
request_body: true,
response_headers: true,
response_body: true,
}
} else if quiet {
Print {