]>
Commit | Line | Data |
---|---|---|
5751f490 DB |
1 | #ifndef REMOTE_H |
2 | #define REMOTE_H | |
3 | ||
b9a7ac2c | 4 | #include "hash-ll.h" |
d0da003d | 5 | #include "hashmap.h" |
6bdb304b | 6 | #include "refspec.h" |
28f5d176 | 7 | |
c4d9c793 | 8 | struct option; |
39835409 JT |
9 | struct transport_ls_refs_options; |
10 | ||
d27eb356 HW |
11 | /** |
12 | * The API gives access to the configuration related to remotes. It handles | |
13 | * all three configuration mechanisms historically and currently used by Git, | |
14 | * and presents the information in a uniform fashion. Note that the code also | |
15 | * handles plain URLs without any configuration, giving them just the default | |
16 | * information. | |
17 | */ | |
18 | ||
89cf4c70 | 19 | enum { |
674468b3 | 20 | REMOTE_UNCONFIGURED = 0, |
89cf4c70 MV |
21 | REMOTE_CONFIG, |
22 | REMOTE_REMOTES, | |
23 | REMOTE_BRANCHES | |
24 | }; | |
25 | ||
fd3cb050 GC |
26 | struct rewrite { |
27 | const char *base; | |
28 | size_t baselen; | |
29 | struct counted_string *instead_of; | |
30 | int instead_of_nr; | |
31 | int instead_of_alloc; | |
32 | }; | |
33 | ||
34 | struct rewrites { | |
35 | struct rewrite **rewrite; | |
36 | int rewrite_alloc; | |
37 | int rewrite_nr; | |
38 | }; | |
39 | ||
40 | struct remote_state { | |
41 | struct remote **remotes; | |
42 | int remotes_alloc; | |
43 | int remotes_nr; | |
44 | struct hashmap remotes_hash; | |
45 | ||
4a2dcb1a | 46 | struct hashmap branches_hash; |
fd3cb050 GC |
47 | |
48 | struct branch *current_branch; | |
49 | const char *pushremote_name; | |
50 | ||
51 | struct rewrites rewrites; | |
52 | struct rewrites rewrites_push; | |
085b98f6 GC |
53 | |
54 | int initialized; | |
fd3cb050 GC |
55 | }; |
56 | ||
57 | void remote_state_clear(struct remote_state *remote_state); | |
58 | struct remote_state *remote_state_new(void); | |
59 | ||
5751f490 | 60 | struct remote { |
e2b5038d | 61 | struct hashmap_entry ent; |
d0da003d | 62 | |
d27eb356 | 63 | /* The user's nickname for the remote */ |
5751f490 | 64 | const char *name; |
d27eb356 | 65 | |
e459b073 | 66 | int origin, configured_in_repo; |
5751f490 | 67 | |
c578f51d DB |
68 | const char *foreign_vcs; |
69 | ||
d27eb356 | 70 | /* An array of all of the url_nr URLs configured for the remote */ |
28b91f8a | 71 | const char **url; |
d27eb356 | 72 | |
28b91f8a | 73 | int url_nr; |
2d31347b | 74 | int url_alloc; |
5751f490 | 75 | |
d27eb356 | 76 | /* An array of all of the pushurl_nr push URLs configured for the remote */ |
20346234 | 77 | const char **pushurl; |
d27eb356 | 78 | |
20346234 MG |
79 | int pushurl_nr; |
80 | int pushurl_alloc; | |
81 | ||
6bdb304b | 82 | struct refspec push; |
5751f490 | 83 | |
e5349abf | 84 | struct refspec fetch; |
5d46c9d4 | 85 | |
d71ab174 | 86 | /* |
d27eb356 HW |
87 | * The setting for whether to fetch tags (as a separate rule from the |
88 | * configured refspecs); | |
d71ab174 DB |
89 | * -1 to never fetch tags |
90 | * 0 to auto-follow tags on heuristic (default) | |
91 | * 1 to always auto-follow tags | |
92 | * 2 to always fetch tags | |
93 | */ | |
94 | int fetch_tags; | |
d27eb356 | 95 | |
211c8968 | 96 | int skip_default_update; |
84bb2dfd | 97 | int mirror; |
737c5a9c | 98 | int prune; |
97716d21 | 99 | int prune_tags; |
d71ab174 | 100 | |
d27eb356 HW |
101 | /** |
102 | * The configured helper programs to run on the remote side, for | |
103 | * Git-native protocols. | |
104 | */ | |
5751f490 | 105 | const char *receivepack; |
0012ba21 | 106 | const char *uploadpack; |
14c98218 | 107 | |
d27eb356 | 108 | /* The proxy to use for curl (http, https, ftp, etc.) URLs. */ |
14c98218 | 109 | char *http_proxy; |
d27eb356 HW |
110 | |
111 | /* The method used for authenticating against `http_proxy`. */ | |
ef976395 | 112 | char *http_proxy_authmethod; |
5751f490 DB |
113 | }; |
114 | ||
d27eb356 HW |
115 | /** |
116 | * struct remotes can be found by name with remote_get(). | |
117 | * remote_get(NULL) will return the default remote, given the current branch | |
118 | * and configuration. | |
119 | */ | |
5751f490 | 120 | struct remote *remote_get(const char *name); |
d27eb356 | 121 | |
f24f715e | 122 | struct remote *pushremote_get(const char *name); |
e459b073 | 123 | int remote_is_configured(struct remote *remote, int in_repo); |
5751f490 | 124 | |
b42f6927 | 125 | typedef int each_remote_fn(struct remote *remote, void *priv); |
d27eb356 HW |
126 | |
127 | /* iterate through struct remotes */ | |
b42f6927 JS |
128 | int for_each_remote(each_remote_fn fn, void *priv); |
129 | ||
28b91f8a | 130 | int remote_has_url(struct remote *remote, const char *url); |
5d46c9d4 | 131 | |
15d3af5e JX |
132 | struct ref_push_report { |
133 | const char *ref_name; | |
134 | struct object_id *old_oid; | |
135 | struct object_id *new_oid; | |
136 | unsigned int forced_update:1; | |
137 | struct ref_push_report *next; | |
138 | }; | |
139 | ||
47a59185 JH |
140 | struct ref { |
141 | struct ref *next; | |
f4e54d02 | 142 | struct object_id old_oid; |
143 | struct object_id new_oid; | |
144 | struct object_id old_oid_expect; /* used by expect-old */ | |
47a59185 | 145 | char *symref; |
99a1f9ae | 146 | char *tracking_ref; |
47a59185 JH |
147 | unsigned int |
148 | force:1, | |
149 | forced_update:1, | |
91048a95 | 150 | expect_old_sha1:1, |
73302051 | 151 | exact_oid:1, |
99a1f9ae SK |
152 | deletion:1, |
153 | /* Need to check if local reflog reaches the remote tip. */ | |
154 | check_reachable:1, | |
155 | /* | |
156 | * Store the result of the check enabled by "check_reachable"; | |
157 | * implies the local reflog does not reach the remote tip. | |
158 | */ | |
159 | unreachable:1; | |
d56583de MM |
160 | |
161 | enum { | |
162 | REF_NOT_MATCHED = 0, /* initial value */ | |
163 | REF_MATCHED, | |
164 | REF_UNADVERTISED_NOT_ALLOWED | |
165 | } match_status; | |
47a59185 JH |
166 | |
167 | /* | |
168 | * Order is important here, as we write to FETCH_HEAD | |
169 | * in numeric order. And the default NOT_FOR_MERGE | |
170 | * should be 0, so that xcalloc'd structures get it | |
171 | * by default. | |
172 | */ | |
58a646a3 | 173 | enum fetch_head_status { |
47a59185 JH |
174 | FETCH_HEAD_MERGE = -1, |
175 | FETCH_HEAD_NOT_FOR_MERGE = 0, | |
176 | FETCH_HEAD_IGNORE = 1 | |
177 | } fetch_head_status; | |
178 | ||
179 | enum { | |
180 | REF_STATUS_NONE = 0, | |
181 | REF_STATUS_OK, | |
182 | REF_STATUS_REJECT_NONFASTFORWARD, | |
183 | REF_STATUS_REJECT_ALREADY_EXISTS, | |
184 | REF_STATUS_REJECT_NODELETE, | |
185 | REF_STATUS_REJECT_FETCH_FIRST, | |
186 | REF_STATUS_REJECT_NEEDS_FORCE, | |
631b5ef2 | 187 | REF_STATUS_REJECT_STALE, |
4820a33b | 188 | REF_STATUS_REJECT_SHALLOW, |
99a1f9ae | 189 | REF_STATUS_REJECT_REMOTE_UPDATED, |
47a59185 JH |
190 | REF_STATUS_UPTODATE, |
191 | REF_STATUS_REMOTE_REJECT, | |
4ff17f10 RS |
192 | REF_STATUS_EXPECTING_REPORT, |
193 | REF_STATUS_ATOMIC_PUSH_FAILED | |
47a59185 JH |
194 | } status; |
195 | char *remote_status; | |
63518a57 | 196 | struct ref_push_report *report; |
47a59185 JH |
197 | struct ref *peer_ref; /* when renaming */ |
198 | char name[FLEX_ARRAY]; /* more */ | |
199 | }; | |
200 | ||
201 | #define REF_NORMAL (1u << 0) | |
202 | #define REF_HEADS (1u << 1) | |
203 | #define REF_TAGS (1u << 2) | |
204 | ||
55454427 | 205 | struct ref *find_ref_by_name(const struct ref *list, const char *name); |
47a59185 | 206 | |
59c69c0c | 207 | struct ref *alloc_ref(const char *name); |
59a57757 | 208 | struct ref *copy_ref(const struct ref *ref); |
4577370e | 209 | struct ref *copy_ref_list(const struct ref *ref); |
55454427 | 210 | int count_refspec_match(const char *, struct ref *refs, struct ref **matched_ref); |
4577370e DB |
211 | |
212 | int check_ref_type(const struct ref *ref, int flags); | |
213 | ||
dfd255dd | 214 | /* |
1027186f JK |
215 | * Free a single ref and its peer, or an entire list of refs and their peers, |
216 | * respectively. | |
dfd255dd | 217 | */ |
1027186f | 218 | void free_one_ref(struct ref *ref); |
dfd255dd DB |
219 | void free_refs(struct ref *ref); |
220 | ||
910650d2 | 221 | struct oid_array; |
ad6ac124 | 222 | struct packet_reader; |
873cd28a | 223 | struct strvec; |
ff473221 | 224 | struct string_list; |
55454427 | 225 | struct ref **get_remote_heads(struct packet_reader *reader, |
ad6dad09 DL |
226 | struct ref **list, unsigned int flags, |
227 | struct oid_array *extra_have, | |
228 | struct oid_array *shallow_points); | |
47a59185 | 229 | |
e52449b6 | 230 | /* Used for protocol v2 in order to retrieve refs from a remote */ |
55454427 | 231 | struct ref **get_remote_refs(int fd_out, struct packet_reader *reader, |
ad6dad09 | 232 | struct ref **list, int for_push, |
39835409 | 233 | struct transport_ls_refs_options *transport_options, |
b0df0c16 DL |
234 | const struct string_list *server_options, |
235 | int stateless_rpc); | |
47a59185 | 236 | |
0cfde740 ÆAB |
237 | /* Used for protocol v2 in order to retrieve refs from a remote */ |
238 | struct bundle_list; | |
239 | int get_remote_bundle_uri(int fd_out, struct packet_reader *reader, | |
240 | struct bundle_list *bundles, int stateless_rpc); | |
241 | ||
be885d96 DB |
242 | int resolve_remote_symref(struct ref *ref, struct ref *list); |
243 | ||
2467a4fa | 244 | /* |
b9afe665 MH |
245 | * Remove and free all but the first of any entries in the input list |
246 | * that map the same remote reference to the same local reference. If | |
247 | * there are two entries that map different remote references to the | |
248 | * same local reference, emit an error message and die. Return a | |
249 | * pointer to the head of the resulting list. | |
2467a4fa | 250 | */ |
b9afe665 | 251 | struct ref *ref_remove_duplicates(struct ref *ref_map); |
2467a4fa | 252 | |
2c80a82e JK |
253 | /* |
254 | * Check whether a name matches any negative refspec in rs. Returns 1 if the | |
255 | * name matches at least one negative refspec, and 0 otherwise. | |
256 | */ | |
257 | int omit_name_by_refspec(const char *name, struct refspec *rs); | |
258 | ||
c0192df6 JK |
259 | /* |
260 | * Remove all entries in the input list which match any negative refspec in | |
261 | * the refspec list. | |
262 | */ | |
263 | struct ref *apply_negative_refspecs(struct ref *ref_map, struct refspec *rs); | |
264 | ||
86baf825 | 265 | int query_refspecs(struct refspec *rs, struct refspec_item *query); |
d000414e | 266 | char *apply_refspecs(struct refspec *rs, const char *name); |
d71ab174 | 267 | |
afb1aed4 | 268 | int check_push_refs(struct ref *src, struct refspec *rs); |
29753cdd | 269 | int match_push_refs(struct ref *src, struct ref **dst, |
5c7ec846 | 270 | struct refspec *rs, int flags); |
20e8b465 TRC |
271 | void set_ref_status_for_push(struct ref *remote_refs, int send_mirror, |
272 | int force_update); | |
6b62816c | 273 | |
d71ab174 DB |
274 | /* |
275 | * Given a list of the remote refs and the specification of things to | |
276 | * fetch, makes a (separate) list of the refs to fetch and the local | |
c0192df6 JK |
277 | * refs to store into. Note that negative refspecs are ignored here, and |
278 | * should be handled separately. | |
d71ab174 DB |
279 | * |
280 | * *tail is the pointer to the tail pointer of the list of results | |
281 | * beforehand, and will be set to the tail pointer of the list of | |
282 | * results afterward. | |
9ad7c5ae JH |
283 | * |
284 | * missing_ok is usually false, but when we are adding branch.$name.merge | |
285 | * it is Ok if the branch is not at the remote anymore. | |
d71ab174 | 286 | */ |
0ad4a5ff | 287 | int get_fetch_map(const struct ref *remote_refs, const struct refspec_item *refspec, |
9ad7c5ae | 288 | struct ref ***tail, int missing_ok); |
d71ab174 | 289 | |
4577370e | 290 | struct ref *get_remote_ref(const struct ref *remote_refs, const char *name); |
d71ab174 | 291 | |
5d46c9d4 DB |
292 | /* |
293 | * For the given remote, reads the refspec's src and sets the other fields. | |
294 | */ | |
0ad4a5ff | 295 | int remote_find_tracking(struct remote *remote, struct refspec_item *refspec); |
5d46c9d4 | 296 | |
d27eb356 HW |
297 | /** |
298 | * struct branch holds the configuration for a branch. It can be looked up with | |
299 | * branch_get(name) for "refs/heads/{name}", or with branch_get(NULL) for HEAD. | |
300 | */ | |
cf818348 | 301 | struct branch { |
4a2dcb1a | 302 | struct hashmap_entry ent; |
d27eb356 HW |
303 | |
304 | /* The short name of the branch. */ | |
cf818348 | 305 | const char *name; |
d27eb356 HW |
306 | |
307 | /* The full path for the branch ref. */ | |
cf818348 DB |
308 | const char *refname; |
309 | ||
d27eb356 | 310 | /* The name of the remote listed in the configuration. */ |
cf818348 | 311 | const char *remote_name; |
d27eb356 | 312 | |
da66b274 | 313 | const char *pushremote_name; |
cf818348 | 314 | |
d27eb356 | 315 | /* An array of the "merge" lines in the configuration. */ |
cf818348 | 316 | const char **merge_name; |
d27eb356 HW |
317 | |
318 | /** | |
319 | * An array of the struct refspecs used for the merge lines. That is, | |
320 | * merge[i]->dst is a local tracking ref which should be merged into this | |
321 | * branch by default. | |
322 | */ | |
0ad4a5ff | 323 | struct refspec_item **merge; |
d27eb356 HW |
324 | |
325 | /* The number of merge configurations */ | |
cf818348 | 326 | int merge_nr; |
d27eb356 | 327 | |
2d31347b | 328 | int merge_alloc; |
e291c75a JK |
329 | |
330 | const char *push_tracking_ref; | |
cf818348 DB |
331 | }; |
332 | ||
333 | struct branch *branch_get(const char *name); | |
f052154d | 334 | const char *remote_for_branch(struct branch *branch, int *explicit); |
da66b274 | 335 | const char *pushremote_for_branch(struct branch *branch, int *explicit); |
af8ccd8a | 336 | const char *remote_ref_for_branch(struct branch *branch, int for_push); |
cf818348 | 337 | |
d27eb356 | 338 | /* returns true if the given branch has merge configuration given. */ |
cf818348 | 339 | int branch_has_merge_config(struct branch *branch); |
d27eb356 | 340 | |
85682c19 | 341 | int branch_merge_matches(struct branch *, int n, const char *); |
cf818348 | 342 | |
a9f9f8cc JK |
343 | /** |
344 | * Return the fully-qualified refname of the tracking branch for `branch`. | |
345 | * I.e., what "branch@{upstream}" would give you. Returns NULL if no | |
346 | * upstream is defined. | |
3a429d0a JK |
347 | * |
348 | * If `err` is not NULL and no upstream is defined, a more specific error | |
349 | * message is recorded there (if the function does not return NULL, then | |
350 | * `err` is not touched). | |
a9f9f8cc | 351 | */ |
3a429d0a | 352 | const char *branch_get_upstream(struct branch *branch, struct strbuf *err); |
a9f9f8cc | 353 | |
e291c75a JK |
354 | /** |
355 | * Return the tracking branch that corresponds to the ref we would push to | |
356 | * given a bare `git push` while `branch` is checked out. | |
357 | * | |
358 | * The return value and `err` conventions match those of `branch_get_upstream`. | |
359 | */ | |
360 | const char *branch_get_push(struct branch *branch, struct strbuf *err); | |
361 | ||
28b9d6e5 AW |
362 | /* Flags to match_refs. */ |
363 | enum match_refs_flags { | |
364 | MATCH_REFS_NONE = 0, | |
365 | MATCH_REFS_ALL = (1 << 0), | |
6ddba5e2 | 366 | MATCH_REFS_MIRROR = (1 << 1), |
c2aba155 JH |
367 | MATCH_REFS_PRUNE = (1 << 2), |
368 | MATCH_REFS_FOLLOW_TAGS = (1 << 3) | |
28b9d6e5 AW |
369 | }; |
370 | ||
d7d1b496 JH |
371 | /* Flags for --ahead-behind option. */ |
372 | enum ahead_behind_flags { | |
fd9b544a JH |
373 | AHEAD_BEHIND_UNSPECIFIED = -1, |
374 | AHEAD_BEHIND_QUICK = 0, /* just eq/neq reporting */ | |
375 | AHEAD_BEHIND_FULL = 1, /* traditional a/b reporting */ | |
d7d1b496 JH |
376 | }; |
377 | ||
6d21bf96 | 378 | /* Reporting of tracking info */ |
979cb245 | 379 | int stat_tracking_info(struct branch *branch, int *num_ours, int *num_theirs, |
c646d093 DR |
380 | const char **upstream_name, int for_push, |
381 | enum ahead_behind_flags abf); | |
f39a757d JH |
382 | int format_tracking_info(struct branch *branch, struct strbuf *sb, |
383 | enum ahead_behind_flags abf); | |
6d21bf96 | 384 | |
454e2025 | 385 | struct ref *get_local_heads(void); |
8ef51733 | 386 | /* |
4229f1fa JS |
387 | * Find refs from a list which are likely to be pointed to by the given HEAD |
388 | * ref. If 'all' is false, returns the most likely ref; otherwise, returns a | |
389 | * list of all candidate refs. If no match is found (or 'head' is NULL), | |
390 | * returns NULL. All returns are newly allocated and should be freed. | |
8ef51733 | 391 | */ |
4229f1fa JS |
392 | struct ref *guess_remote_head(const struct ref *head, |
393 | const struct ref *refs, | |
394 | int all); | |
395 | ||
f2ef6075 | 396 | /* Return refs which no longer exist on remote */ |
a2ac50cb | 397 | struct ref *get_stale_heads(struct refspec *rs, struct ref *fetch_map); |
f2ef6075 | 398 | |
28f5d176 JH |
399 | /* |
400 | * Compare-and-swap | |
401 | */ | |
402 | #define CAS_OPT_NAME "force-with-lease" | |
403 | ||
404 | struct push_cas_option { | |
405 | unsigned use_tracking_for_rest:1; | |
99a1f9ae | 406 | unsigned use_force_if_includes:1; |
28f5d176 | 407 | struct push_cas { |
b8566f8f | 408 | struct object_id expect; |
28f5d176 JH |
409 | unsigned use_tracking:1; |
410 | char *refname; | |
411 | } *entry; | |
412 | int nr; | |
413 | int alloc; | |
414 | }; | |
415 | ||
55454427 | 416 | int parseopt_push_cas_option(const struct option *, const char *arg, int unset); |
28f5d176 | 417 | |
55454427 | 418 | int is_empty_cas(const struct push_cas_option *); |
91048a95 JH |
419 | void apply_push_cas(struct push_cas_option *, struct remote *, struct ref *); |
420 | ||
1d04e719 DS |
421 | /* |
422 | * The `url` argument is the URL that navigates to the submodule origin | |
423 | * repo. When relative, this URL is relative to the superproject origin | |
424 | * URL repo. The `up_path` argument, if specified, is the relative | |
425 | * path that navigates from the submodule working tree to the superproject | |
426 | * working tree. Returns the origin URL of the submodule. | |
427 | * | |
428 | * Return either an absolute URL or filesystem path (if the superproject | |
429 | * origin URL is an absolute URL or filesystem path, respectively) or a | |
430 | * relative file system path (if the superproject origin URL is a relative | |
431 | * file system path). | |
432 | * | |
433 | * When the output is a relative file system path, the path is either | |
434 | * relative to the submodule working tree, if up_path is specified, or to | |
435 | * the superproject working tree otherwise. | |
436 | * | |
437 | * NEEDSWORK: This works incorrectly on the domain and protocol part. | |
438 | * remote_url url outcome expectation | |
439 | * http://a.com/b ../c http://a.com/c as is | |
440 | * http://a.com/b/ ../c http://a.com/c same as previous line, but | |
441 | * ignore trailing slash in url | |
442 | * http://a.com/b ../../c http://c error out | |
443 | * http://a.com/b ../../../c http:/c error out | |
444 | * http://a.com/b ../../../../c http:c error out | |
445 | * http://a.com/b ../../../../../c .:c error out | |
834e3520 | 446 | * http://a.com/b http://d.org/e http://d.org/e as is |
1d04e719 DS |
447 | * NEEDSWORK: Given how chop_last_dir() works, this function is broken |
448 | * when a local part has a colon in its path component, too. | |
449 | */ | |
450 | char *relative_url(const char *remote_url, const char *url, | |
451 | const char *up_path); | |
452 | ||
5751f490 | 453 | #endif |