builtin/clone: allow remote helpers to detect repo
[alt-git.git] / remote.h
blobdfd4837e602755806bcfc73a725c04394ef81c6c
1 #ifndef REMOTE_H
2 #define REMOTE_H
4 #include "hash-ll.h"
5 #include "hashmap.h"
6 #include "refspec.h"
8 struct option;
9 struct transport_ls_refs_options;
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.
19 enum {
20 REMOTE_UNCONFIGURED = 0,
21 REMOTE_CONFIG,
22 REMOTE_REMOTES,
23 REMOTE_BRANCHES
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;
34 struct rewrites {
35 struct rewrite **rewrite;
36 int rewrite_alloc;
37 int rewrite_nr;
40 struct remote_state {
41 struct remote **remotes;
42 int remotes_alloc;
43 int remotes_nr;
44 struct hashmap remotes_hash;
46 struct hashmap branches_hash;
48 struct branch *current_branch;
49 const char *pushremote_name;
51 struct rewrites rewrites;
52 struct rewrites rewrites_push;
54 int initialized;
57 void remote_state_clear(struct remote_state *remote_state);
58 struct remote_state *remote_state_new(void);
60 struct remote {
61 struct hashmap_entry ent;
63 /* The user's nickname for the remote */
64 const char *name;
66 int origin, configured_in_repo;
68 const char *foreign_vcs;
70 /* An array of all of the url_nr URLs configured for the remote */
71 const char **url;
73 int url_nr;
74 int url_alloc;
76 /* An array of all of the pushurl_nr push URLs configured for the remote */
77 const char **pushurl;
79 int pushurl_nr;
80 int pushurl_alloc;
82 struct refspec push;
84 struct refspec fetch;
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
94 int fetch_tags;
96 int skip_default_update;
97 int mirror;
98 int prune;
99 int prune_tags;
102 * The configured helper programs to run on the remote side, for
103 * Git-native protocols.
105 const char *receivepack;
106 const char *uploadpack;
108 /* The proxy to use for curl (http, https, ftp, etc.) URLs. */
109 char *http_proxy;
111 /* The method used for authenticating against `http_proxy`. */
112 char *http_proxy_authmethod;
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.
120 struct remote *remote_get(const char *name);
121 struct remote *remote_get_early(const char *name);
123 struct remote *pushremote_get(const char *name);
124 int remote_is_configured(struct remote *remote, int in_repo);
126 typedef int each_remote_fn(struct remote *remote, void *priv);
128 /* iterate through struct remotes */
129 int for_each_remote(each_remote_fn fn, void *priv);
131 int remote_has_url(struct remote *remote, const char *url);
133 struct ref_push_report {
134 const char *ref_name;
135 struct object_id *old_oid;
136 struct object_id *new_oid;
137 unsigned int forced_update:1;
138 struct ref_push_report *next;
141 struct ref {
142 struct ref *next;
143 struct object_id old_oid;
144 struct object_id new_oid;
145 struct object_id old_oid_expect; /* used by expect-old */
146 char *symref;
147 char *tracking_ref;
148 unsigned int
149 force:1,
150 forced_update:1,
151 expect_old_sha1:1,
152 exact_oid:1,
153 deletion:1,
154 /* Need to check if local reflog reaches the remote tip. */
155 check_reachable:1,
157 * Store the result of the check enabled by "check_reachable";
158 * implies the local reflog does not reach the remote tip.
160 unreachable:1;
162 enum {
163 REF_NOT_MATCHED = 0, /* initial value */
164 REF_MATCHED,
165 REF_UNADVERTISED_NOT_ALLOWED
166 } match_status;
169 * Order is important here, as we write to FETCH_HEAD
170 * in numeric order. And the default NOT_FOR_MERGE
171 * should be 0, so that xcalloc'd structures get it
172 * by default.
174 enum fetch_head_status {
175 FETCH_HEAD_MERGE = -1,
176 FETCH_HEAD_NOT_FOR_MERGE = 0,
177 FETCH_HEAD_IGNORE = 1
178 } fetch_head_status;
180 enum {
181 REF_STATUS_NONE = 0,
182 REF_STATUS_OK,
183 REF_STATUS_REJECT_NONFASTFORWARD,
184 REF_STATUS_REJECT_ALREADY_EXISTS,
185 REF_STATUS_REJECT_NODELETE,
186 REF_STATUS_REJECT_FETCH_FIRST,
187 REF_STATUS_REJECT_NEEDS_FORCE,
188 REF_STATUS_REJECT_STALE,
189 REF_STATUS_REJECT_SHALLOW,
190 REF_STATUS_REJECT_REMOTE_UPDATED,
191 REF_STATUS_UPTODATE,
192 REF_STATUS_REMOTE_REJECT,
193 REF_STATUS_EXPECTING_REPORT,
194 REF_STATUS_ATOMIC_PUSH_FAILED
195 } status;
196 char *remote_status;
197 struct ref_push_report *report;
198 struct ref *peer_ref; /* when renaming */
199 char name[FLEX_ARRAY]; /* more */
202 #define REF_NORMAL (1u << 0)
203 #define REF_HEADS (1u << 1)
204 #define REF_TAGS (1u << 2)
206 struct ref *find_ref_by_name(const struct ref *list, const char *name);
208 struct ref *alloc_ref(const char *name);
209 struct ref *copy_ref(const struct ref *ref);
210 struct ref *copy_ref_list(const struct ref *ref);
211 int count_refspec_match(const char *, struct ref *refs, struct ref **matched_ref);
213 int check_ref_type(const struct ref *ref, int flags);
216 * Free a single ref and its peer, or an entire list of refs and their peers,
217 * respectively.
219 void free_one_ref(struct ref *ref);
220 void free_refs(struct ref *ref);
222 struct oid_array;
223 struct packet_reader;
224 struct strvec;
225 struct string_list;
226 struct ref **get_remote_heads(struct packet_reader *reader,
227 struct ref **list, unsigned int flags,
228 struct oid_array *extra_have,
229 struct oid_array *shallow_points);
231 /* Used for protocol v2 in order to retrieve refs from a remote */
232 struct ref **get_remote_refs(int fd_out, struct packet_reader *reader,
233 struct ref **list, int for_push,
234 struct transport_ls_refs_options *transport_options,
235 const struct string_list *server_options,
236 int stateless_rpc);
238 /* Used for protocol v2 in order to retrieve refs from a remote */
239 struct bundle_list;
240 int get_remote_bundle_uri(int fd_out, struct packet_reader *reader,
241 struct bundle_list *bundles, int stateless_rpc);
243 int resolve_remote_symref(struct ref *ref, struct ref *list);
246 * Remove and free all but the first of any entries in the input list
247 * that map the same remote reference to the same local reference. If
248 * there are two entries that map different remote references to the
249 * same local reference, emit an error message and die. Return a
250 * pointer to the head of the resulting list.
252 struct ref *ref_remove_duplicates(struct ref *ref_map);
255 * Check whether a name matches any negative refspec in rs. Returns 1 if the
256 * name matches at least one negative refspec, and 0 otherwise.
258 int omit_name_by_refspec(const char *name, struct refspec *rs);
261 * Remove all entries in the input list which match any negative refspec in
262 * the refspec list.
264 struct ref *apply_negative_refspecs(struct ref *ref_map, struct refspec *rs);
266 int query_refspecs(struct refspec *rs, struct refspec_item *query);
267 char *apply_refspecs(struct refspec *rs, const char *name);
269 int check_push_refs(struct ref *src, struct refspec *rs);
270 int match_push_refs(struct ref *src, struct ref **dst,
271 struct refspec *rs, int flags);
272 void set_ref_status_for_push(struct ref *remote_refs, int send_mirror,
273 int force_update);
276 * Given a list of the remote refs and the specification of things to
277 * fetch, makes a (separate) list of the refs to fetch and the local
278 * refs to store into. Note that negative refspecs are ignored here, and
279 * should be handled separately.
281 * *tail is the pointer to the tail pointer of the list of results
282 * beforehand, and will be set to the tail pointer of the list of
283 * results afterward.
285 * missing_ok is usually false, but when we are adding branch.$name.merge
286 * it is Ok if the branch is not at the remote anymore.
288 int get_fetch_map(const struct ref *remote_refs, const struct refspec_item *refspec,
289 struct ref ***tail, int missing_ok);
291 struct ref *get_remote_ref(const struct ref *remote_refs, const char *name);
294 * For the given remote, reads the refspec's src and sets the other fields.
296 int remote_find_tracking(struct remote *remote, struct refspec_item *refspec);
299 * struct branch holds the configuration for a branch. It can be looked up with
300 * branch_get(name) for "refs/heads/{name}", or with branch_get(NULL) for HEAD.
302 struct branch {
303 struct hashmap_entry ent;
305 /* The short name of the branch. */
306 const char *name;
308 /* The full path for the branch ref. */
309 const char *refname;
311 /* The name of the remote listed in the configuration. */
312 const char *remote_name;
314 const char *pushremote_name;
316 /* An array of the "merge" lines in the configuration. */
317 const char **merge_name;
320 * An array of the struct refspecs used for the merge lines. That is,
321 * merge[i]->dst is a local tracking ref which should be merged into this
322 * branch by default.
324 struct refspec_item **merge;
326 /* The number of merge configurations */
327 int merge_nr;
329 int merge_alloc;
331 const char *push_tracking_ref;
334 struct branch *branch_get(const char *name);
335 const char *remote_for_branch(struct branch *branch, int *explicit);
336 const char *pushremote_for_branch(struct branch *branch, int *explicit);
337 const char *remote_ref_for_branch(struct branch *branch, int for_push);
339 /* returns true if the given branch has merge configuration given. */
340 int branch_has_merge_config(struct branch *branch);
342 int branch_merge_matches(struct branch *, int n, const char *);
345 * Return the fully-qualified refname of the tracking branch for `branch`.
346 * I.e., what "branch@{upstream}" would give you. Returns NULL if no
347 * upstream is defined.
349 * If `err` is not NULL and no upstream is defined, a more specific error
350 * message is recorded there (if the function does not return NULL, then
351 * `err` is not touched).
353 const char *branch_get_upstream(struct branch *branch, struct strbuf *err);
356 * Return the tracking branch that corresponds to the ref we would push to
357 * given a bare `git push` while `branch` is checked out.
359 * The return value and `err` conventions match those of `branch_get_upstream`.
361 const char *branch_get_push(struct branch *branch, struct strbuf *err);
363 /* Flags to match_refs. */
364 enum match_refs_flags {
365 MATCH_REFS_NONE = 0,
366 MATCH_REFS_ALL = (1 << 0),
367 MATCH_REFS_MIRROR = (1 << 1),
368 MATCH_REFS_PRUNE = (1 << 2),
369 MATCH_REFS_FOLLOW_TAGS = (1 << 3)
372 /* Flags for --ahead-behind option. */
373 enum ahead_behind_flags {
374 AHEAD_BEHIND_UNSPECIFIED = -1,
375 AHEAD_BEHIND_QUICK = 0, /* just eq/neq reporting */
376 AHEAD_BEHIND_FULL = 1, /* traditional a/b reporting */
379 /* Reporting of tracking info */
380 int stat_tracking_info(struct branch *branch, int *num_ours, int *num_theirs,
381 const char **upstream_name, int for_push,
382 enum ahead_behind_flags abf);
383 int format_tracking_info(struct branch *branch, struct strbuf *sb,
384 enum ahead_behind_flags abf,
385 int show_divergence_advice);
387 struct ref *get_local_heads(void);
389 * Find refs from a list which are likely to be pointed to by the given HEAD
390 * ref. If 'all' is false, returns the most likely ref; otherwise, returns a
391 * list of all candidate refs. If no match is found (or 'head' is NULL),
392 * returns NULL. All returns are newly allocated and should be freed.
394 struct ref *guess_remote_head(const struct ref *head,
395 const struct ref *refs,
396 int all);
398 /* Return refs which no longer exist on remote */
399 struct ref *get_stale_heads(struct refspec *rs, struct ref *fetch_map);
402 * Compare-and-swap
404 struct push_cas_option {
405 unsigned use_tracking_for_rest:1;
406 unsigned use_force_if_includes:1;
407 struct push_cas {
408 struct object_id expect;
409 unsigned use_tracking:1;
410 char *refname;
411 } *entry;
412 int nr;
413 int alloc;
416 int parseopt_push_cas_option(const struct option *, const char *arg, int unset);
418 int is_empty_cas(const struct push_cas_option *);
419 void apply_push_cas(struct push_cas_option *, struct remote *, struct ref *);
422 * The `url` argument is the URL that navigates to the submodule origin
423 * repo. When relative, this URL is relative to the superproject origin
424 * URL repo. The `up_path` argument, if specified, is the relative
425 * path that navigates from the submodule working tree to the superproject
426 * working tree. Returns the origin URL of the submodule.
428 * Return either an absolute URL or filesystem path (if the superproject
429 * origin URL is an absolute URL or filesystem path, respectively) or a
430 * relative file system path (if the superproject origin URL is a relative
431 * file system path).
433 * When the output is a relative file system path, the path is either
434 * relative to the submodule working tree, if up_path is specified, or to
435 * the superproject working tree otherwise.
437 * NEEDSWORK: This works incorrectly on the domain and protocol part.
438 * remote_url url outcome expectation
439 * http://a.com/b ../c http://a.com/c as is
440 * http://a.com/b/ ../c http://a.com/c same as previous line, but
441 * ignore trailing slash in url
442 * http://a.com/b ../../c http://c error out
443 * http://a.com/b ../../../c http:/c error out
444 * http://a.com/b ../../../../c http:c error out
445 * http://a.com/b ../../../../../c .:c error out
446 * http://a.com/b http://d.org/e http://d.org/e as is
447 * NEEDSWORK: Given how chop_last_dir() works, this function is broken
448 * when a local part has a colon in its path component, too.
450 char *relative_url(const char *remote_url, const char *url,
451 const char *up_path);
453 #endif