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
|
use std::collections::HashSet;
use gix_features::progress::Progress;
use gix_protocol::transport::client::Transport;
use crate::{
bstr,
bstr::{BString, ByteVec},
remote::{connection::HandshakeWithRefs, fetch, fetch::SpecIndex, Connection, Direction},
};
/// The error returned by [`Connection::ref_map()`].
#[derive(Debug, thiserror::Error)]
#[allow(missing_docs)]
pub enum Error {
#[error("Failed to configure the transport before connecting to {url:?}")]
GatherTransportConfig {
url: BString,
source: crate::config::transport::Error,
},
#[error("Failed to configure the transport layer")]
ConfigureTransport(#[from] Box<dyn std::error::Error + Send + Sync + 'static>),
#[error(transparent)]
Handshake(#[from] gix_protocol::handshake::Error),
#[error("The object format {format:?} as used by the remote is unsupported")]
UnknownObjectFormat { format: BString },
#[error(transparent)]
ListRefs(#[from] gix_protocol::ls_refs::Error),
#[error(transparent)]
Transport(#[from] gix_protocol::transport::client::Error),
#[error(transparent)]
ConfigureCredentials(#[from] crate::config::credential_helpers::Error),
#[error(transparent)]
MappingValidation(#[from] gix_refspec::match_group::validate::Error),
}
impl gix_protocol::transport::IsSpuriousError for Error {
fn is_spurious(&self) -> bool {
match self {
Error::Transport(err) => err.is_spurious(),
Error::ListRefs(err) => err.is_spurious(),
Error::Handshake(err) => err.is_spurious(),
_ => false,
}
}
}
/// For use in [`Connection::ref_map()`].
#[derive(Debug, Clone)]
pub struct Options {
/// Use a two-component prefix derived from the ref-spec's source, like `refs/heads/` to let the server pre-filter refs
/// with great potential for savings in traffic and local CPU time. Defaults to `true`.
pub prefix_from_spec_as_filter_on_remote: bool,
/// Parameters in the form of `(name, optional value)` to add to the handshake.
///
/// This is useful in case of custom servers.
pub handshake_parameters: Vec<(String, Option<String>)>,
/// A list of refspecs to use as implicit refspecs which won't be saved or otherwise be part of the remote in question.
///
/// This is useful for handling `remote.<name>.tagOpt` for example.
pub extra_refspecs: Vec<gix_refspec::RefSpec>,
}
impl Default for Options {
fn default() -> Self {
Options {
prefix_from_spec_as_filter_on_remote: true,
handshake_parameters: Vec::new(),
extra_refspecs: Vec::new(),
}
}
}
impl<'remote, 'repo, T> Connection<'remote, 'repo, T>
where
T: Transport,
{
/// List all references on the remote that have been filtered through our remote's [`refspecs`][crate::Remote::refspecs()]
/// for _fetching_.
///
/// This comes in the form of all matching tips on the remote and the object they point to, along with
/// with the local tracking branch of these tips (if available).
///
/// Note that this doesn't fetch the objects mentioned in the tips nor does it make any change to underlying repository.
///
/// # Consumption
///
/// Due to management of the transport, it's cleanest to only use it for a single interaction. Thus it's consumed along with
/// the connection.
///
/// ### Configuration
///
/// - `gitoxide.userAgent` is read to obtain the application user agent for git servers and for HTTP servers as well.
#[allow(clippy::result_large_err)]
#[gix_protocol::maybe_async::maybe_async]
pub async fn ref_map(mut self, progress: impl Progress, options: Options) -> Result<fetch::RefMap, Error> {
let res = self.ref_map_inner(progress, options).await;
gix_protocol::indicate_end_of_interaction(&mut self.transport)
.await
.ok();
res
}
#[allow(clippy::result_large_err)]
#[gix_protocol::maybe_async::maybe_async]
pub(crate) async fn ref_map_inner(
&mut self,
progress: impl Progress,
Options {
prefix_from_spec_as_filter_on_remote,
handshake_parameters,
mut extra_refspecs,
}: Options,
) -> Result<fetch::RefMap, Error> {
let null = gix_hash::ObjectId::null(gix_hash::Kind::Sha1); // OK to hardcode Sha1, it's not supposed to match, ever.
if let Some(tag_spec) = self.remote.fetch_tags.to_refspec().map(|spec| spec.to_owned()) {
if !extra_refspecs.contains(&tag_spec) {
extra_refspecs.push(tag_spec);
}
};
let specs = {
let mut s = self.remote.fetch_specs.clone();
s.extend(extra_refspecs.clone());
s
};
let remote = self
.fetch_refs(
prefix_from_spec_as_filter_on_remote,
handshake_parameters,
&specs,
progress,
)
.await?;
let num_explicit_specs = self.remote.fetch_specs.len();
let group = gix_refspec::MatchGroup::from_fetch_specs(specs.iter().map(|s| s.to_ref()));
let (res, fixes) = group
.match_remotes(remote.refs.iter().map(|r| {
let (full_ref_name, target, object) = r.unpack();
gix_refspec::match_group::Item {
full_ref_name,
target: target.unwrap_or(&null),
object,
}
}))
.validated()?;
let mappings = res.mappings;
let mappings = mappings
.into_iter()
.map(|m| fetch::Mapping {
remote: m
.item_index
.map(|idx| fetch::Source::Ref(remote.refs[idx].clone()))
.unwrap_or_else(|| {
fetch::Source::ObjectId(match m.lhs {
gix_refspec::match_group::SourceRef::ObjectId(id) => id,
_ => unreachable!("no item index implies having an object id"),
})
}),
local: m.rhs.map(|c| c.into_owned()),
spec_index: if m.spec_index < num_explicit_specs {
SpecIndex::ExplicitInRemote(m.spec_index)
} else {
SpecIndex::Implicit(m.spec_index - num_explicit_specs)
},
})
.collect();
let object_hash = extract_object_format(self.remote.repo, &remote.outcome)?;
Ok(fetch::RefMap {
mappings,
extra_refspecs,
fixes,
remote_refs: remote.refs,
handshake: remote.outcome,
object_hash,
})
}
#[allow(clippy::result_large_err)]
#[gix_protocol::maybe_async::maybe_async]
async fn fetch_refs(
&mut self,
filter_by_prefix: bool,
extra_parameters: Vec<(String, Option<String>)>,
refspecs: &[gix_refspec::RefSpec],
mut progress: impl Progress,
) -> Result<HandshakeWithRefs, Error> {
let mut credentials_storage;
let url = self.transport.to_url();
let authenticate = match self.authenticate.as_mut() {
Some(f) => f,
None => {
let url = self
.remote
.url(Direction::Fetch)
.map(ToOwned::to_owned)
.unwrap_or_else(|| gix_url::parse(url.as_ref()).expect("valid URL to be provided by transport"));
credentials_storage = self.configured_credentials(url)?;
&mut credentials_storage
}
};
if self.transport_options.is_none() {
self.transport_options = self
.remote
.repo
.transport_options(url.as_ref(), self.remote.name().map(|n| n.as_bstr()))
.map_err(|err| Error::GatherTransportConfig {
source: err,
url: url.into_owned(),
})?;
}
if let Some(config) = self.transport_options.as_ref() {
self.transport.configure(&**config)?;
}
let mut outcome =
gix_protocol::fetch::handshake(&mut self.transport, authenticate, extra_parameters, &mut progress).await?;
let refs = match outcome.refs.take() {
Some(refs) => refs,
None => {
let agent_feature = self.remote.repo.config.user_agent_tuple();
gix_protocol::ls_refs(
&mut self.transport,
&outcome.capabilities,
move |_capabilities, arguments, features| {
features.push(agent_feature);
if filter_by_prefix {
let mut seen = HashSet::new();
for spec in refspecs {
let spec = spec.to_ref();
if seen.insert(spec.instruction()) {
let mut prefixes = Vec::with_capacity(1);
spec.expand_prefixes(&mut prefixes);
for mut prefix in prefixes {
prefix.insert_str(0, "ref-prefix ");
arguments.push(prefix);
}
}
}
}
Ok(gix_protocol::ls_refs::Action::Continue)
},
&mut progress,
)
.await?
}
};
Ok(HandshakeWithRefs { outcome, refs })
}
}
/// Assume sha1 if server says nothing, otherwise configure anything beyond sha1 in the local repo configuration
#[allow(clippy::result_large_err)]
fn extract_object_format(
_repo: &crate::Repository,
outcome: &gix_protocol::handshake::Outcome,
) -> Result<gix_hash::Kind, Error> {
use bstr::ByteSlice;
let object_hash =
if let Some(object_format) = outcome.capabilities.capability("object-format").and_then(|c| c.value()) {
let object_format = object_format.to_str().map_err(|_| Error::UnknownObjectFormat {
format: object_format.into(),
})?;
match object_format {
"sha1" => gix_hash::Kind::Sha1,
unknown => return Err(Error::UnknownObjectFormat { format: unknown.into() }),
}
} else {
gix_hash::Kind::Sha1
};
Ok(object_hash)
}
|