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