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