]> git.ipfire.org Git - thirdparty/git.git/blob - remote.h
Merge branch 'jk/clone-allow-bare-and-o-together'
[thirdparty/git.git] / remote.h
1 #ifndef REMOTE_H
2 #define REMOTE_H
3
4 #include "cache.h"
5 #include "parse-options.h"
6 #include "hashmap.h"
7 #include "refspec.h"
8
9 struct transport_ls_refs_options;
10
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
19 enum {
20 REMOTE_UNCONFIGURED = 0,
21 REMOTE_CONFIG,
22 REMOTE_REMOTES,
23 REMOTE_BRANCHES
24 };
25
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
46 struct hashmap branches_hash;
47
48 struct branch *current_branch;
49 const char *pushremote_name;
50
51 struct rewrites rewrites;
52 struct rewrites rewrites_push;
53
54 int initialized;
55 };
56
57 void remote_state_clear(struct remote_state *remote_state);
58 struct remote_state *remote_state_new(void);
59
60 struct remote {
61 struct hashmap_entry ent;
62
63 /* The user's nickname for the remote */
64 const char *name;
65
66 int origin, configured_in_repo;
67
68 const char *foreign_vcs;
69
70 /* An array of all of the url_nr URLs configured for the remote */
71 const char **url;
72
73 int url_nr;
74 int url_alloc;
75
76 /* An array of all of the pushurl_nr push URLs configured for the remote */
77 const char **pushurl;
78
79 int pushurl_nr;
80 int pushurl_alloc;
81
82 struct refspec push;
83
84 struct refspec fetch;
85
86 /*
87 * The setting for whether to fetch tags (as a separate rule from the
88 * configured refspecs);
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;
95
96 int skip_default_update;
97 int mirror;
98 int prune;
99 int prune_tags;
100
101 /**
102 * The configured helper programs to run on the remote side, for
103 * Git-native protocols.
104 */
105 const char *receivepack;
106 const char *uploadpack;
107
108 /* The proxy to use for curl (http, https, ftp, etc.) URLs. */
109 char *http_proxy;
110
111 /* The method used for authenticating against `http_proxy`. */
112 char *http_proxy_authmethod;
113 };
114
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 */
120 struct remote *remote_get(const char *name);
121
122 struct remote *pushremote_get(const char *name);
123 int remote_is_configured(struct remote *remote, int in_repo);
124
125 typedef int each_remote_fn(struct remote *remote, void *priv);
126
127 /* iterate through struct remotes */
128 int for_each_remote(each_remote_fn fn, void *priv);
129
130 int remote_has_url(struct remote *remote, const char *url);
131
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
140 struct ref {
141 struct ref *next;
142 struct object_id old_oid;
143 struct object_id new_oid;
144 struct object_id old_oid_expect; /* used by expect-old */
145 char *symref;
146 char *tracking_ref;
147 unsigned int
148 force:1,
149 forced_update:1,
150 expect_old_sha1:1,
151 exact_oid:1,
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;
160
161 enum {
162 REF_NOT_MATCHED = 0, /* initial value */
163 REF_MATCHED,
164 REF_UNADVERTISED_NOT_ALLOWED
165 } match_status;
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 */
173 enum fetch_head_status {
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,
187 REF_STATUS_REJECT_STALE,
188 REF_STATUS_REJECT_SHALLOW,
189 REF_STATUS_REJECT_REMOTE_UPDATED,
190 REF_STATUS_UPTODATE,
191 REF_STATUS_REMOTE_REJECT,
192 REF_STATUS_EXPECTING_REPORT,
193 REF_STATUS_ATOMIC_PUSH_FAILED
194 } status;
195 char *remote_status;
196 struct ref_push_report *report;
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
205 struct ref *find_ref_by_name(const struct ref *list, const char *name);
206
207 struct ref *alloc_ref(const char *name);
208 struct ref *copy_ref(const struct ref *ref);
209 struct ref *copy_ref_list(const struct ref *ref);
210 int count_refspec_match(const char *, struct ref *refs, struct ref **matched_ref);
211
212 int check_ref_type(const struct ref *ref, int flags);
213
214 /*
215 * Free a single ref and its peer, or an entire list of refs and their peers,
216 * respectively.
217 */
218 void free_one_ref(struct ref *ref);
219 void free_refs(struct ref *ref);
220
221 struct oid_array;
222 struct packet_reader;
223 struct strvec;
224 struct string_list;
225 struct ref **get_remote_heads(struct packet_reader *reader,
226 struct ref **list, unsigned int flags,
227 struct oid_array *extra_have,
228 struct oid_array *shallow_points);
229
230 /* Used for protocol v2 in order to retrieve refs from a remote */
231 struct ref **get_remote_refs(int fd_out, struct packet_reader *reader,
232 struct ref **list, int for_push,
233 struct transport_ls_refs_options *transport_options,
234 const struct string_list *server_options,
235 int stateless_rpc);
236
237 int resolve_remote_symref(struct ref *ref, struct ref *list);
238
239 /*
240 * Remove and free all but the first of any entries in the input list
241 * that map the same remote reference to the same local reference. If
242 * there are two entries that map different remote references to the
243 * same local reference, emit an error message and die. Return a
244 * pointer to the head of the resulting list.
245 */
246 struct ref *ref_remove_duplicates(struct ref *ref_map);
247
248 /*
249 * Check whether a name matches any negative refspec in rs. Returns 1 if the
250 * name matches at least one negative refspec, and 0 otherwise.
251 */
252 int omit_name_by_refspec(const char *name, struct refspec *rs);
253
254 /*
255 * Remove all entries in the input list which match any negative refspec in
256 * the refspec list.
257 */
258 struct ref *apply_negative_refspecs(struct ref *ref_map, struct refspec *rs);
259
260 int query_refspecs(struct refspec *rs, struct refspec_item *query);
261 char *apply_refspecs(struct refspec *rs, const char *name);
262
263 int check_push_refs(struct ref *src, struct refspec *rs);
264 int match_push_refs(struct ref *src, struct ref **dst,
265 struct refspec *rs, int flags);
266 void set_ref_status_for_push(struct ref *remote_refs, int send_mirror,
267 int force_update);
268
269 /*
270 * Given a list of the remote refs and the specification of things to
271 * fetch, makes a (separate) list of the refs to fetch and the local
272 * refs to store into. Note that negative refspecs are ignored here, and
273 * should be handled separately.
274 *
275 * *tail is the pointer to the tail pointer of the list of results
276 * beforehand, and will be set to the tail pointer of the list of
277 * results afterward.
278 *
279 * missing_ok is usually false, but when we are adding branch.$name.merge
280 * it is Ok if the branch is not at the remote anymore.
281 */
282 int get_fetch_map(const struct ref *remote_refs, const struct refspec_item *refspec,
283 struct ref ***tail, int missing_ok);
284
285 struct ref *get_remote_ref(const struct ref *remote_refs, const char *name);
286
287 /*
288 * For the given remote, reads the refspec's src and sets the other fields.
289 */
290 int remote_find_tracking(struct remote *remote, struct refspec_item *refspec);
291
292 /**
293 * struct branch holds the configuration for a branch. It can be looked up with
294 * branch_get(name) for "refs/heads/{name}", or with branch_get(NULL) for HEAD.
295 */
296 struct branch {
297 struct hashmap_entry ent;
298
299 /* The short name of the branch. */
300 const char *name;
301
302 /* The full path for the branch ref. */
303 const char *refname;
304
305 /* The name of the remote listed in the configuration. */
306 const char *remote_name;
307
308 const char *pushremote_name;
309
310 /* An array of the "merge" lines in the configuration. */
311 const char **merge_name;
312
313 /**
314 * An array of the struct refspecs used for the merge lines. That is,
315 * merge[i]->dst is a local tracking ref which should be merged into this
316 * branch by default.
317 */
318 struct refspec_item **merge;
319
320 /* The number of merge configurations */
321 int merge_nr;
322
323 int merge_alloc;
324
325 const char *push_tracking_ref;
326 };
327
328 struct branch *branch_get(const char *name);
329 const char *remote_for_branch(struct branch *branch, int *explicit);
330 const char *pushremote_for_branch(struct branch *branch, int *explicit);
331 const char *remote_ref_for_branch(struct branch *branch, int for_push);
332
333 /* returns true if the given branch has merge configuration given. */
334 int branch_has_merge_config(struct branch *branch);
335
336 int branch_merge_matches(struct branch *, int n, const char *);
337
338 /**
339 * Return the fully-qualified refname of the tracking branch for `branch`.
340 * I.e., what "branch@{upstream}" would give you. Returns NULL if no
341 * upstream is defined.
342 *
343 * If `err` is not NULL and no upstream is defined, a more specific error
344 * message is recorded there (if the function does not return NULL, then
345 * `err` is not touched).
346 */
347 const char *branch_get_upstream(struct branch *branch, struct strbuf *err);
348
349 /**
350 * Return the tracking branch that corresponds to the ref we would push to
351 * given a bare `git push` while `branch` is checked out.
352 *
353 * The return value and `err` conventions match those of `branch_get_upstream`.
354 */
355 const char *branch_get_push(struct branch *branch, struct strbuf *err);
356
357 /* Flags to match_refs. */
358 enum match_refs_flags {
359 MATCH_REFS_NONE = 0,
360 MATCH_REFS_ALL = (1 << 0),
361 MATCH_REFS_MIRROR = (1 << 1),
362 MATCH_REFS_PRUNE = (1 << 2),
363 MATCH_REFS_FOLLOW_TAGS = (1 << 3)
364 };
365
366 /* Flags for --ahead-behind option. */
367 enum ahead_behind_flags {
368 AHEAD_BEHIND_UNSPECIFIED = -1,
369 AHEAD_BEHIND_QUICK = 0, /* just eq/neq reporting */
370 AHEAD_BEHIND_FULL = 1, /* traditional a/b reporting */
371 };
372
373 /* Reporting of tracking info */
374 int stat_tracking_info(struct branch *branch, int *num_ours, int *num_theirs,
375 const char **upstream_name, int for_push,
376 enum ahead_behind_flags abf);
377 int format_tracking_info(struct branch *branch, struct strbuf *sb,
378 enum ahead_behind_flags abf);
379
380 struct ref *get_local_heads(void);
381 /*
382 * Find refs from a list which are likely to be pointed to by the given HEAD
383 * ref. If 'all' is false, returns the most likely ref; otherwise, returns a
384 * list of all candidate refs. If no match is found (or 'head' is NULL),
385 * returns NULL. All returns are newly allocated and should be freed.
386 */
387 struct ref *guess_remote_head(const struct ref *head,
388 const struct ref *refs,
389 int all);
390
391 /* Return refs which no longer exist on remote */
392 struct ref *get_stale_heads(struct refspec *rs, struct ref *fetch_map);
393
394 /*
395 * Compare-and-swap
396 */
397 #define CAS_OPT_NAME "force-with-lease"
398
399 struct push_cas_option {
400 unsigned use_tracking_for_rest:1;
401 unsigned use_force_if_includes:1;
402 struct push_cas {
403 struct object_id expect;
404 unsigned use_tracking:1;
405 char *refname;
406 } *entry;
407 int nr;
408 int alloc;
409 };
410
411 int parseopt_push_cas_option(const struct option *, const char *arg, int unset);
412
413 int is_empty_cas(const struct push_cas_option *);
414 void apply_push_cas(struct push_cas_option *, struct remote *, struct ref *);
415
416 /*
417 * The `url` argument is the URL that navigates to the submodule origin
418 * repo. When relative, this URL is relative to the superproject origin
419 * URL repo. The `up_path` argument, if specified, is the relative
420 * path that navigates from the submodule working tree to the superproject
421 * working tree. Returns the origin URL of the submodule.
422 *
423 * Return either an absolute URL or filesystem path (if the superproject
424 * origin URL is an absolute URL or filesystem path, respectively) or a
425 * relative file system path (if the superproject origin URL is a relative
426 * file system path).
427 *
428 * When the output is a relative file system path, the path is either
429 * relative to the submodule working tree, if up_path is specified, or to
430 * the superproject working tree otherwise.
431 *
432 * NEEDSWORK: This works incorrectly on the domain and protocol part.
433 * remote_url url outcome expectation
434 * http://a.com/b ../c http://a.com/c as is
435 * http://a.com/b/ ../c http://a.com/c same as previous line, but
436 * ignore trailing slash in url
437 * http://a.com/b ../../c http://c error out
438 * http://a.com/b ../../../c http:/c error out
439 * http://a.com/b ../../../../c http:c error out
440 * http://a.com/b ../../../../../c .:c error out
441 * http://a.com/b http://d.org/e http://d.org/e as is
442 * NEEDSWORK: Given how chop_last_dir() works, this function is broken
443 * when a local part has a colon in its path component, too.
444 */
445 char *relative_url(const char *remote_url, const char *url,
446 const char *up_path);
447
448 #endif