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