remote: convert push refspecs to struct refspec
[git/git.git] / remote.h
CommitLineData
5751f490
DB
1#ifndef REMOTE_H
2#define REMOTE_H
3
28f5d176 4#include "parse-options.h"
d0da003d 5#include "hashmap.h"
6bdb304b 6#include "refspec.h"
28f5d176 7
89cf4c70 8enum {
674468b3 9 REMOTE_UNCONFIGURED = 0,
89cf4c70
MV
10 REMOTE_CONFIG,
11 REMOTE_REMOTES,
12 REMOTE_BRANCHES
13};
14
5751f490 15struct remote {
d0da003d
PR
16 struct hashmap_entry ent; /* must be first */
17
5751f490 18 const char *name;
e459b073 19 int origin, configured_in_repo;
5751f490 20
c578f51d
DB
21 const char *foreign_vcs;
22
28b91f8a
SP
23 const char **url;
24 int url_nr;
2d31347b 25 int url_alloc;
5751f490 26
20346234
MG
27 const char **pushurl;
28 int pushurl_nr;
29 int pushurl_alloc;
30
6bdb304b 31 struct refspec push;
5751f490 32
5d46c9d4 33 const char **fetch_refspec;
0ad4a5ff 34 struct refspec_item *fetch;
5d46c9d4 35 int fetch_refspec_nr;
2d31347b 36 int fetch_refspec_alloc;
5d46c9d4 37
d71ab174
DB
38 /*
39 * -1 to never fetch tags
40 * 0 to auto-follow tags on heuristic (default)
41 * 1 to always auto-follow tags
42 * 2 to always fetch tags
43 */
44 int fetch_tags;
211c8968 45 int skip_default_update;
84bb2dfd 46 int mirror;
737c5a9c 47 int prune;
97716d21 48 int prune_tags;
d71ab174 49
5751f490 50 const char *receivepack;
0012ba21 51 const char *uploadpack;
14c98218
SV
52
53 /*
54 * for curl remotes only
55 */
56 char *http_proxy;
ef976395 57 char *http_proxy_authmethod;
5751f490
DB
58};
59
60struct remote *remote_get(const char *name);
f24f715e 61struct remote *pushremote_get(const char *name);
e459b073 62int remote_is_configured(struct remote *remote, int in_repo);
5751f490 63
b42f6927
JS
64typedef int each_remote_fn(struct remote *remote, void *priv);
65int for_each_remote(each_remote_fn fn, void *priv);
66
28b91f8a 67int remote_has_url(struct remote *remote, const char *url);
5d46c9d4 68
47a59185
JH
69struct ref {
70 struct ref *next;
f4e54d02 71 struct object_id old_oid;
72 struct object_id new_oid;
73 struct object_id old_oid_expect; /* used by expect-old */
47a59185
JH
74 char *symref;
75 unsigned int
76 force:1,
77 forced_update:1,
91048a95 78 expect_old_sha1:1,
d56583de
MM
79 deletion:1;
80
81 enum {
82 REF_NOT_MATCHED = 0, /* initial value */
83 REF_MATCHED,
84 REF_UNADVERTISED_NOT_ALLOWED
85 } match_status;
47a59185
JH
86
87 /*
88 * Order is important here, as we write to FETCH_HEAD
89 * in numeric order. And the default NOT_FOR_MERGE
90 * should be 0, so that xcalloc'd structures get it
91 * by default.
92 */
93 enum {
94 FETCH_HEAD_MERGE = -1,
95 FETCH_HEAD_NOT_FOR_MERGE = 0,
96 FETCH_HEAD_IGNORE = 1
97 } fetch_head_status;
98
99 enum {
100 REF_STATUS_NONE = 0,
101 REF_STATUS_OK,
102 REF_STATUS_REJECT_NONFASTFORWARD,
103 REF_STATUS_REJECT_ALREADY_EXISTS,
104 REF_STATUS_REJECT_NODELETE,
105 REF_STATUS_REJECT_FETCH_FIRST,
106 REF_STATUS_REJECT_NEEDS_FORCE,
631b5ef2 107 REF_STATUS_REJECT_STALE,
4820a33b 108 REF_STATUS_REJECT_SHALLOW,
47a59185
JH
109 REF_STATUS_UPTODATE,
110 REF_STATUS_REMOTE_REJECT,
4ff17f10
RS
111 REF_STATUS_EXPECTING_REPORT,
112 REF_STATUS_ATOMIC_PUSH_FAILED
47a59185
JH
113 } status;
114 char *remote_status;
115 struct ref *peer_ref; /* when renaming */
116 char name[FLEX_ARRAY]; /* more */
117};
118
119#define REF_NORMAL (1u << 0)
120#define REF_HEADS (1u << 1)
121#define REF_TAGS (1u << 2)
122
123extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
124
59c69c0c 125struct ref *alloc_ref(const char *name);
59a57757 126struct ref *copy_ref(const struct ref *ref);
4577370e 127struct ref *copy_ref_list(const struct ref *ref);
ed81c76b 128void sort_ref_list(struct ref **, int (*cmp)(const void *, const void *));
ca02465b 129extern int count_refspec_match(const char *, struct ref *refs, struct ref **matched_ref);
ed81c76b 130int ref_compare_name(const void *, const void *);
4577370e
DB
131
132int check_ref_type(const struct ref *ref, int flags);
133
dfd255dd
DB
134/*
135 * Frees the entire list and peers of elements.
136 */
137void free_refs(struct ref *ref);
138
910650d2 139struct oid_array;
ad6ac124 140struct packet_reader;
e52449b6 141struct argv_array;
ad6ac124 142extern struct ref **get_remote_heads(struct packet_reader *reader,
47a59185 143 struct ref **list, unsigned int flags,
910650d2 144 struct oid_array *extra_have,
ad6ac124 145 struct oid_array *shallow_points);
47a59185 146
e52449b6
BW
147/* Used for protocol v2 in order to retrieve refs from a remote */
148extern struct ref **get_remote_refs(int fd_out, struct packet_reader *reader,
149 struct ref **list, int for_push,
150 const struct argv_array *ref_prefixes);
47a59185 151
be885d96 152int resolve_remote_symref(struct ref *ref, struct ref *list);
6f3d57b6 153int ref_newer(const struct object_id *new_oid, const struct object_id *old_oid);
be885d96 154
2467a4fa 155/*
b9afe665
MH
156 * Remove and free all but the first of any entries in the input list
157 * that map the same remote reference to the same local reference. If
158 * there are two entries that map different remote references to the
159 * same local reference, emit an error message and die. Return a
160 * pointer to the head of the resulting list.
2467a4fa 161 */
b9afe665 162struct ref *ref_remove_duplicates(struct ref *ref_map);
2467a4fa 163
0ad4a5ff
BW
164extern int query_refspecs(struct refspec_item *specs, int nr, struct refspec_item *query);
165char *apply_refspecs(struct refspec_item *refspecs, int nr_refspec,
72ff8943
DB
166 const char *name);
167
ba928c13 168int check_push_refs(struct ref *src, int nr_refspec, const char **refspec);
29753cdd
JH
169int match_push_refs(struct ref *src, struct ref **dst,
170 int nr_refspec, const char **refspec, int all);
20e8b465
TRC
171void set_ref_status_for_push(struct ref *remote_refs, int send_mirror,
172 int force_update);
6b62816c 173
d71ab174
DB
174/*
175 * Given a list of the remote refs and the specification of things to
176 * fetch, makes a (separate) list of the refs to fetch and the local
177 * refs to store into.
178 *
179 * *tail is the pointer to the tail pointer of the list of results
180 * beforehand, and will be set to the tail pointer of the list of
181 * results afterward.
9ad7c5ae
JH
182 *
183 * missing_ok is usually false, but when we are adding branch.$name.merge
184 * it is Ok if the branch is not at the remote anymore.
d71ab174 185 */
0ad4a5ff 186int get_fetch_map(const struct ref *remote_refs, const struct refspec_item *refspec,
9ad7c5ae 187 struct ref ***tail, int missing_ok);
d71ab174 188
4577370e 189struct ref *get_remote_ref(const struct ref *remote_refs, const char *name);
d71ab174 190
5d46c9d4
DB
191/*
192 * For the given remote, reads the refspec's src and sets the other fields.
193 */
0ad4a5ff 194int remote_find_tracking(struct remote *remote, struct refspec_item *refspec);
5d46c9d4 195
cf818348
DB
196struct branch {
197 const char *name;
198 const char *refname;
199
200 const char *remote_name;
da66b274 201 const char *pushremote_name;
cf818348
DB
202
203 const char **merge_name;
0ad4a5ff 204 struct refspec_item **merge;
cf818348 205 int merge_nr;
2d31347b 206 int merge_alloc;
e291c75a
JK
207
208 const char *push_tracking_ref;
cf818348
DB
209};
210
211struct branch *branch_get(const char *name);
f052154d 212const char *remote_for_branch(struct branch *branch, int *explicit);
da66b274 213const char *pushremote_for_branch(struct branch *branch, int *explicit);
9700fae5
W
214const char *remote_ref_for_branch(struct branch *branch, int for_push,
215 int *explicit);
cf818348
DB
216
217int branch_has_merge_config(struct branch *branch);
85682c19 218int branch_merge_matches(struct branch *, int n, const char *);
cf818348 219
a9f9f8cc
JK
220/**
221 * Return the fully-qualified refname of the tracking branch for `branch`.
222 * I.e., what "branch@{upstream}" would give you. Returns NULL if no
223 * upstream is defined.
3a429d0a
JK
224 *
225 * If `err` is not NULL and no upstream is defined, a more specific error
226 * message is recorded there (if the function does not return NULL, then
227 * `err` is not touched).
a9f9f8cc 228 */
3a429d0a 229const char *branch_get_upstream(struct branch *branch, struct strbuf *err);
a9f9f8cc 230
e291c75a
JK
231/**
232 * Return the tracking branch that corresponds to the ref we would push to
233 * given a bare `git push` while `branch` is checked out.
234 *
235 * The return value and `err` conventions match those of `branch_get_upstream`.
236 */
237const char *branch_get_push(struct branch *branch, struct strbuf *err);
238
28b9d6e5
AW
239/* Flags to match_refs. */
240enum match_refs_flags {
241 MATCH_REFS_NONE = 0,
242 MATCH_REFS_ALL = (1 << 0),
6ddba5e2 243 MATCH_REFS_MIRROR = (1 << 1),
c2aba155
JH
244 MATCH_REFS_PRUNE = (1 << 2),
245 MATCH_REFS_FOLLOW_TAGS = (1 << 3)
28b9d6e5
AW
246};
247
d7d1b496
JH
248/* Flags for --ahead-behind option. */
249enum ahead_behind_flags {
fd9b544a
JH
250 AHEAD_BEHIND_UNSPECIFIED = -1,
251 AHEAD_BEHIND_QUICK = 0, /* just eq/neq reporting */
252 AHEAD_BEHIND_FULL = 1, /* traditional a/b reporting */
d7d1b496
JH
253};
254
6d21bf96 255/* Reporting of tracking info */
979cb245 256int stat_tracking_info(struct branch *branch, int *num_ours, int *num_theirs,
d7d1b496 257 const char **upstream_name, enum ahead_behind_flags abf);
f39a757d
JH
258int format_tracking_info(struct branch *branch, struct strbuf *sb,
259 enum ahead_behind_flags abf);
6d21bf96 260
454e2025 261struct ref *get_local_heads(void);
8ef51733 262/*
4229f1fa
JS
263 * Find refs from a list which are likely to be pointed to by the given HEAD
264 * ref. If 'all' is false, returns the most likely ref; otherwise, returns a
265 * list of all candidate refs. If no match is found (or 'head' is NULL),
266 * returns NULL. All returns are newly allocated and should be freed.
8ef51733 267 */
4229f1fa
JS
268struct ref *guess_remote_head(const struct ref *head,
269 const struct ref *refs,
270 int all);
271
f2ef6075 272/* Return refs which no longer exist on remote */
0ad4a5ff 273struct ref *get_stale_heads(struct refspec_item *refs, int ref_count, struct ref *fetch_map);
f2ef6075 274
28f5d176
JH
275/*
276 * Compare-and-swap
277 */
278#define CAS_OPT_NAME "force-with-lease"
279
280struct push_cas_option {
281 unsigned use_tracking_for_rest:1;
282 struct push_cas {
b8566f8f 283 struct object_id expect;
28f5d176
JH
284 unsigned use_tracking:1;
285 char *refname;
286 } *entry;
287 int nr;
288 int alloc;
289};
290
291extern int parseopt_push_cas_option(const struct option *, const char *arg, int unset);
28f5d176 292
91048a95
JH
293extern int is_empty_cas(const struct push_cas_option *);
294void apply_push_cas(struct push_cas_option *, struct remote *, struct ref *);
295
97716d21
ÆAB
296void add_prune_tags_to_fetch_refspec(struct remote *remote);
297
5751f490 298#endif