blob: 976292152c020127e6c88d54e5448ef21e0eb4e8 [file] [log] [blame]
Daniel Barkalow5751f492007-05-12 11:45:53 -04001#ifndef REMOTE_H
2#define REMOTE_H
3
Junio C Hamano28f5d172013-07-08 15:34:36 -07004#include "parse-options.h"
Patrick Reynoldsd0da0032014-07-29 14:43:39 +00005#include "hashmap.h"
Brandon Williams6bdb3042018-05-16 15:58:00 -07006#include "refspec.h"
Junio C Hamano28f5d172013-07-08 15:34:36 -07007
Miklos Vajna89cf4c72008-11-10 21:43:00 +01008enum {
Thomas Gummerer674468b2016-02-16 10:47:50 +01009 REMOTE_UNCONFIGURED = 0,
Miklos Vajna89cf4c72008-11-10 21:43:00 +010010 REMOTE_CONFIG,
11 REMOTE_REMOTES,
12 REMOTE_BRANCHES
13};
14
Daniel Barkalow5751f492007-05-12 11:45:53 -040015struct remote {
Patrick Reynoldsd0da0032014-07-29 14:43:39 +000016 struct hashmap_entry ent; /* must be first */
17
Daniel Barkalow5751f492007-05-12 11:45:53 -040018 const char *name;
Johannes Schindeline459b072017-01-19 22:20:02 +010019 int origin, configured_in_repo;
Daniel Barkalow5751f492007-05-12 11:45:53 -040020
Daniel Barkalowc578f512009-11-18 02:42:25 +010021 const char *foreign_vcs;
22
Shawn O. Pearce28b91f82007-09-19 00:49:27 -040023 const char **url;
24 int url_nr;
Daniel Barkalow2d313472008-02-18 23:41:41 -050025 int url_alloc;
Daniel Barkalow5751f492007-05-12 11:45:53 -040026
Michael J Gruber20346232009-06-09 18:01:34 +020027 const char **pushurl;
28 int pushurl_nr;
29 int pushurl_alloc;
30
Brandon Williams6bdb3042018-05-16 15:58:00 -070031 struct refspec push;
Daniel Barkalow5751f492007-05-12 11:45:53 -040032
Brandon Williamse5349ab2018-05-16 15:58:01 -070033 struct refspec fetch;
Daniel Barkalow5d46c9d2007-05-12 11:46:03 -040034
Daniel Barkalowd71ab172007-09-10 23:03:08 -040035 /*
36 * -1 to never fetch tags
37 * 0 to auto-follow tags on heuristic (default)
38 * 1 to always auto-follow tags
39 * 2 to always fetch tags
40 */
41 int fetch_tags;
Johannes Schindelin211c8962008-02-29 01:45:45 +000042 int skip_default_update;
Paolo Bonzini84bb2df2008-04-17 13:17:20 +020043 int mirror;
Michael Schubert737c5a92013-07-13 11:36:24 +020044 int prune;
Ævar Arnfjörð Bjarmason97716d22018-02-09 20:32:15 +000045 int prune_tags;
Daniel Barkalowd71ab172007-09-10 23:03:08 -040046
Daniel Barkalow5751f492007-05-12 11:45:53 -040047 const char *receivepack;
Daniel Barkalow0012ba22007-09-10 23:02:51 -040048 const char *uploadpack;
Sam Vilain14c98212007-12-04 10:48:54 +130049
50 /*
51 * for curl remotes only
52 */
53 char *http_proxy;
Knut Frankeef976392016-01-26 13:02:47 +000054 char *http_proxy_authmethod;
Daniel Barkalow5751f492007-05-12 11:45:53 -040055};
56
57struct remote *remote_get(const char *name);
Ramkumar Ramachandraf24f7152013-04-02 13:10:32 +053058struct remote *pushremote_get(const char *name);
Johannes Schindeline459b072017-01-19 22:20:02 +010059int remote_is_configured(struct remote *remote, int in_repo);
Daniel Barkalow5751f492007-05-12 11:45:53 -040060
Johannes Schindelinb42f6922007-07-10 18:48:40 +010061typedef int each_remote_fn(struct remote *remote, void *priv);
62int for_each_remote(each_remote_fn fn, void *priv);
63
Shawn O. Pearce28b91f82007-09-19 00:49:27 -040064int remote_has_url(struct remote *remote, const char *url);
Daniel Barkalow5d46c9d2007-05-12 11:46:03 -040065
Junio C Hamano47a59182013-07-08 13:56:53 -070066struct ref {
67 struct ref *next;
brian m. carlsonf4e54d02015-11-10 02:22:20 +000068 struct object_id old_oid;
69 struct object_id new_oid;
70 struct object_id old_oid_expect; /* used by expect-old */
Junio C Hamano47a59182013-07-08 13:56:53 -070071 char *symref;
72 unsigned int
73 force:1,
74 forced_update:1,
Junio C Hamano91048a92013-07-09 11:01:06 -070075 expect_old_sha1:1,
Brandon Williams73302052018-06-27 15:30:23 -070076 exact_oid:1,
Matt McCutchend56583d2017-02-22 11:05:57 -050077 deletion:1;
78
79 enum {
80 REF_NOT_MATCHED = 0, /* initial value */
81 REF_MATCHED,
82 REF_UNADVERTISED_NOT_ALLOWED
83 } match_status;
Junio C Hamano47a59182013-07-08 13:56:53 -070084
85 /*
86 * Order is important here, as we write to FETCH_HEAD
87 * in numeric order. And the default NOT_FOR_MERGE
88 * should be 0, so that xcalloc'd structures get it
89 * by default.
90 */
91 enum {
92 FETCH_HEAD_MERGE = -1,
93 FETCH_HEAD_NOT_FOR_MERGE = 0,
94 FETCH_HEAD_IGNORE = 1
95 } fetch_head_status;
96
97 enum {
98 REF_STATUS_NONE = 0,
99 REF_STATUS_OK,
100 REF_STATUS_REJECT_NONFASTFORWARD,
101 REF_STATUS_REJECT_ALREADY_EXISTS,
102 REF_STATUS_REJECT_NODELETE,
103 REF_STATUS_REJECT_FETCH_FIRST,
104 REF_STATUS_REJECT_NEEDS_FORCE,
Junio C Hamano631b5ef2013-07-08 14:42:40 -0700105 REF_STATUS_REJECT_STALE,
Nguyễn Thái Ngọc Duy4820a332013-12-05 20:02:40 +0700106 REF_STATUS_REJECT_SHALLOW,
Junio C Hamano47a59182013-07-08 13:56:53 -0700107 REF_STATUS_UPTODATE,
108 REF_STATUS_REMOTE_REJECT,
Ronnie Sahlberg4ff17f12015-01-07 19:23:22 -0800109 REF_STATUS_EXPECTING_REPORT,
110 REF_STATUS_ATOMIC_PUSH_FAILED
Junio C Hamano47a59182013-07-08 13:56:53 -0700111 } status;
112 char *remote_status;
113 struct ref *peer_ref; /* when renaming */
114 char name[FLEX_ARRAY]; /* more */
115};
116
117#define REF_NORMAL (1u << 0)
118#define REF_HEADS (1u << 1)
119#define REF_TAGS (1u << 2)
120
121extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
122
René Scharfe59c69c02008-10-18 10:44:18 +0200123struct ref *alloc_ref(const char *name);
Jeff King59a57752011-06-07 19:03:03 -0400124struct ref *copy_ref(const struct ref *ref);
Daniel Barkalow45773702007-10-29 21:05:40 -0400125struct ref *copy_ref_list(const struct ref *ref);
Jeff Kinged81c762012-05-21 18:19:28 -0400126void sort_ref_list(struct ref **, int (*cmp)(const void *, const void *));
Junio C Hamanoca024652013-12-03 15:41:15 -0800127extern int count_refspec_match(const char *, struct ref *refs, struct ref **matched_ref);
Jeff Kinged81c762012-05-21 18:19:28 -0400128int ref_compare_name(const void *, const void *);
Daniel Barkalow45773702007-10-29 21:05:40 -0400129
130int check_ref_type(const struct ref *ref, int flags);
131
Daniel Barkalowdfd255d2007-07-10 00:47:23 -0400132/*
133 * Frees the entire list and peers of elements.
134 */
135void free_refs(struct ref *ref);
136
brian m. carlson910650d2017-03-31 01:40:00 +0000137struct oid_array;
Brandon Williamsad6ac122018-03-14 11:31:45 -0700138struct packet_reader;
Brandon Williamse52449b2018-03-15 10:31:21 -0700139struct argv_array;
Brandon Williamsff473222018-04-23 15:46:23 -0700140struct string_list;
Brandon Williamsad6ac122018-03-14 11:31:45 -0700141extern struct ref **get_remote_heads(struct packet_reader *reader,
Junio C Hamano47a59182013-07-08 13:56:53 -0700142 struct ref **list, unsigned int flags,
brian m. carlson910650d2017-03-31 01:40:00 +0000143 struct oid_array *extra_have,
Brandon Williamsad6ac122018-03-14 11:31:45 -0700144 struct oid_array *shallow_points);
Junio C Hamano47a59182013-07-08 13:56:53 -0700145
Brandon Williamse52449b2018-03-15 10:31:21 -0700146/* Used for protocol v2 in order to retrieve refs from a remote */
147extern struct ref **get_remote_refs(int fd_out, struct packet_reader *reader,
148 struct ref **list, int for_push,
Brandon Williamsff473222018-04-23 15:46:23 -0700149 const struct argv_array *ref_prefixes,
150 const struct string_list *server_options);
Daniel Barkalow5d46c9d2007-05-12 11:46:03 -0400151
Daniel Barkalowbe885d92008-04-26 15:53:12 -0400152int resolve_remote_symref(struct ref *ref, struct ref *list);
brian m. carlson6f3d57b2015-11-10 02:22:25 +0000153int ref_newer(const struct object_id *new_oid, const struct object_id *old_oid);
Daniel Barkalowbe885d92008-04-26 15:53:12 -0400154
Daniel Barkalow2467a4f2007-10-08 00:25:07 -0400155/*
Michael Haggertyb9afe662013-10-30 06:33:09 +0100156 * 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.
Daniel Barkalow2467a4f2007-10-08 00:25:07 -0400161 */
Michael Haggertyb9afe662013-10-30 06:33:09 +0100162struct ref *ref_remove_duplicates(struct ref *ref_map);
Daniel Barkalow2467a4f2007-10-08 00:25:07 -0400163
Brandon Williams86baf822018-05-16 15:58:12 -0700164int query_refspecs(struct refspec *rs, struct refspec_item *query);
Brandon Williamsd0004142018-05-16 15:58:11 -0700165char *apply_refspecs(struct refspec *rs, const char *name);
Daniel Barkalowd71ab172007-09-10 23:03:08 -0400166
Brandon Williamsafb1aed2018-05-16 15:58:22 -0700167int check_push_refs(struct ref *src, struct refspec *rs);
Junio C Hamano29753cd2011-09-09 11:54:58 -0700168int match_push_refs(struct ref *src, struct ref **dst,
Brandon Williams5c7ec842018-05-16 15:58:21 -0700169 struct refspec *rs, int flags);
Tay Ray Chuan20e8b462010-01-08 10:12:42 +0800170void set_ref_status_for_push(struct ref *remote_refs, int send_mirror,
171 int force_update);
Daniel Barkalow6b628162007-05-12 11:45:59 -0400172
Daniel Barkalow5d46c9d2007-05-12 11:46:03 -0400173/*
Daniel Barkalowd71ab172007-09-10 23:03:08 -0400174 * Given a list of the remote refs and the specification of things to
175 * fetch, makes a (separate) list of the refs to fetch and the local
176 * refs to store into.
177 *
178 * *tail is the pointer to the tail pointer of the list of results
179 * beforehand, and will be set to the tail pointer of the list of
180 * results afterward.
Junio C Hamano9ad7c5a2007-10-26 23:09:48 -0700181 *
182 * missing_ok is usually false, but when we are adding branch.$name.merge
183 * it is Ok if the branch is not at the remote anymore.
Daniel Barkalowd71ab172007-09-10 23:03:08 -0400184 */
Brandon Williams0ad4a5f2018-05-16 15:57:49 -0700185int get_fetch_map(const struct ref *remote_refs, const struct refspec_item *refspec,
Junio C Hamano9ad7c5a2007-10-26 23:09:48 -0700186 struct ref ***tail, int missing_ok);
Daniel Barkalowd71ab172007-09-10 23:03:08 -0400187
Daniel Barkalow45773702007-10-29 21:05:40 -0400188struct ref *get_remote_ref(const struct ref *remote_refs, const char *name);
Daniel Barkalowd71ab172007-09-10 23:03:08 -0400189
190/*
Daniel Barkalow5d46c9d2007-05-12 11:46:03 -0400191 * For the given remote, reads the refspec's src and sets the other fields.
192 */
Brandon Williams0ad4a5f2018-05-16 15:57:49 -0700193int remote_find_tracking(struct remote *remote, struct refspec_item *refspec);
Daniel Barkalow5d46c9d2007-05-12 11:46:03 -0400194
Daniel Barkalowcf818342007-09-10 23:02:56 -0400195struct branch {
196 const char *name;
197 const char *refname;
198
199 const char *remote_name;
Jeff Kingda66b272015-05-21 00:45:20 -0400200 const char *pushremote_name;
Daniel Barkalowcf818342007-09-10 23:02:56 -0400201
202 const char **merge_name;
Brandon Williams0ad4a5f2018-05-16 15:57:49 -0700203 struct refspec_item **merge;
Daniel Barkalowcf818342007-09-10 23:02:56 -0400204 int merge_nr;
Daniel Barkalow2d313472008-02-18 23:41:41 -0500205 int merge_alloc;
Jeff Kinge291c752015-05-21 00:45:36 -0400206
207 const char *push_tracking_ref;
Daniel Barkalowcf818342007-09-10 23:02:56 -0400208};
209
210struct branch *branch_get(const char *name);
Jeff Kingf0521542015-05-21 00:45:16 -0400211const char *remote_for_branch(struct branch *branch, int *explicit);
Jeff Kingda66b272015-05-21 00:45:20 -0400212const char *pushremote_for_branch(struct branch *branch, int *explicit);
J Wyman9700fae2017-11-07 17:31:08 +0100213const char *remote_ref_for_branch(struct branch *branch, int for_push,
214 int *explicit);
Daniel Barkalowcf818342007-09-10 23:02:56 -0400215
216int branch_has_merge_config(struct branch *branch);
Shawn O. Pearce85682c12007-09-18 04:54:53 -0400217int branch_merge_matches(struct branch *, int n, const char *);
Daniel Barkalowcf818342007-09-10 23:02:56 -0400218
Jeff Kinga9f9f8c2015-05-21 00:45:28 -0400219/**
220 * Return the fully-qualified refname of the tracking branch for `branch`.
221 * I.e., what "branch@{upstream}" would give you. Returns NULL if no
222 * upstream is defined.
Jeff King3a429d02015-05-21 00:45:32 -0400223 *
224 * If `err` is not NULL and no upstream is defined, a more specific error
225 * message is recorded there (if the function does not return NULL, then
226 * `err` is not touched).
Jeff Kinga9f9f8c2015-05-21 00:45:28 -0400227 */
Jeff King3a429d02015-05-21 00:45:32 -0400228const char *branch_get_upstream(struct branch *branch, struct strbuf *err);
Jeff Kinga9f9f8c2015-05-21 00:45:28 -0400229
Jeff Kinge291c752015-05-21 00:45:36 -0400230/**
231 * Return the tracking branch that corresponds to the ref we would push to
232 * given a bare `git push` while `branch` is checked out.
233 *
234 * The return value and `err` conventions match those of `branch_get_upstream`.
235 */
236const char *branch_get_push(struct branch *branch, struct strbuf *err);
237
Andy Whitcroft28b9d6e2007-11-09 23:32:10 +0000238/* Flags to match_refs. */
239enum match_refs_flags {
240 MATCH_REFS_NONE = 0,
241 MATCH_REFS_ALL = (1 << 0),
Felipe Contreras6ddba5e2012-02-23 00:43:41 +0200242 MATCH_REFS_MIRROR = (1 << 1),
Junio C Hamanoc2aba152013-03-04 12:09:50 -0800243 MATCH_REFS_PRUNE = (1 << 2),
244 MATCH_REFS_FOLLOW_TAGS = (1 << 3)
Andy Whitcroft28b9d6e2007-11-09 23:32:10 +0000245};
246
Jeff Hostetlerd7d1b492018-01-09 18:50:15 +0000247/* Flags for --ahead-behind option. */
248enum ahead_behind_flags {
Jeff Hostetlerfd9b5442018-01-09 18:50:16 +0000249 AHEAD_BEHIND_UNSPECIFIED = -1,
250 AHEAD_BEHIND_QUICK = 0, /* just eq/neq reporting */
251 AHEAD_BEHIND_FULL = 1, /* traditional a/b reporting */
Jeff Hostetlerd7d1b492018-01-09 18:50:15 +0000252};
253
Junio C Hamano6d21bf92008-07-02 00:51:18 -0700254/* Reporting of tracking info */
Jeff King979cb242015-05-21 20:49:11 -0400255int stat_tracking_info(struct branch *branch, int *num_ours, int *num_theirs,
Jeff Hostetlerd7d1b492018-01-09 18:50:15 +0000256 const char **upstream_name, enum ahead_behind_flags abf);
Jeff Hostetlerf39a7572018-01-09 18:50:18 +0000257int format_tracking_info(struct branch *branch, struct strbuf *sb,
258 enum ahead_behind_flags abf);
Junio C Hamano6d21bf92008-07-02 00:51:18 -0700259
Jay Soffian454e2022009-02-25 03:32:11 -0500260struct ref *get_local_heads(void);
Jay Soffian6cb4e6c2009-02-25 03:32:14 -0500261/*
Jay Soffian4229f1f2009-02-27 14:10:05 -0500262 * Find refs from a list which are likely to be pointed to by the given HEAD
263 * ref. If 'all' is false, returns the most likely ref; otherwise, returns a
264 * list of all candidate refs. If no match is found (or 'head' is NULL),
265 * returns NULL. All returns are newly allocated and should be freed.
Jay Soffian6cb4e6c2009-02-25 03:32:14 -0500266 */
Jay Soffian4229f1f2009-02-27 14:10:05 -0500267struct ref *guess_remote_head(const struct ref *head,
268 const struct ref *refs,
269 int all);
270
Jay Soffianf2ef6072009-11-10 00:03:31 -0500271/* Return refs which no longer exist on remote */
Brandon Williamsa2ac50c2018-05-16 15:58:10 -0700272struct ref *get_stale_heads(struct refspec *rs, struct ref *fetch_map);
Jay Soffianf2ef6072009-11-10 00:03:31 -0500273
Junio C Hamano28f5d172013-07-08 15:34:36 -0700274/*
275 * Compare-and-swap
276 */
277#define CAS_OPT_NAME "force-with-lease"
278
279struct push_cas_option {
280 unsigned use_tracking_for_rest:1;
281 struct push_cas {
brian m. carlsonb8566f82017-07-13 23:49:21 +0000282 struct object_id expect;
Junio C Hamano28f5d172013-07-08 15:34:36 -0700283 unsigned use_tracking:1;
284 char *refname;
285 } *entry;
286 int nr;
287 int alloc;
288};
289
290extern int parseopt_push_cas_option(const struct option *, const char *arg, int unset);
Junio C Hamano28f5d172013-07-08 15:34:36 -0700291
Junio C Hamano91048a92013-07-09 11:01:06 -0700292extern int is_empty_cas(const struct push_cas_option *);
293void apply_push_cas(struct push_cas_option *, struct remote *, struct ref *);
294
Daniel Barkalow5751f492007-05-12 11:45:53 -0400295#endif