131130a611b55c9f79649037e6dde916b621f578
[git/git.git] / remote.h
1 #ifndef REMOTE_H
2 #define REMOTE_H
3
4 #include "parse-options.h"
5
6 enum {
7 REMOTE_CONFIG,
8 REMOTE_REMOTES,
9 REMOTE_BRANCHES
10 };
11
12 struct remote {
13 const char *name;
14 int origin;
15
16 const char *foreign_vcs;
17
18 const char **url;
19 int url_nr;
20 int url_alloc;
21
22 const char **pushurl;
23 int pushurl_nr;
24 int pushurl_alloc;
25
26 const char **push_refspec;
27 struct refspec *push;
28 int push_refspec_nr;
29 int push_refspec_alloc;
30
31 const char **fetch_refspec;
32 struct refspec *fetch;
33 int fetch_refspec_nr;
34 int fetch_refspec_alloc;
35
36 /*
37 * -1 to never fetch tags
38 * 0 to auto-follow tags on heuristic (default)
39 * 1 to always auto-follow tags
40 * 2 to always fetch tags
41 */
42 int fetch_tags;
43 int skip_default_update;
44 int mirror;
45 int prune;
46
47 const char *receivepack;
48 const char *uploadpack;
49
50 /*
51 * for curl remotes only
52 */
53 char *http_proxy;
54 };
55
56 struct remote *remote_get(const char *name);
57 struct remote *pushremote_get(const char *name);
58 int remote_is_configured(const char *name);
59
60 typedef int each_remote_fn(struct remote *remote, void *priv);
61 int for_each_remote(each_remote_fn fn, void *priv);
62
63 int remote_has_url(struct remote *remote, const char *url);
64
65 struct refspec {
66 unsigned force : 1;
67 unsigned pattern : 1;
68 unsigned matching : 1;
69 unsigned exact_sha1 : 1;
70
71 char *src;
72 char *dst;
73 };
74
75 extern const struct refspec *tag_refspec;
76
77 struct ref {
78 struct ref *next;
79 unsigned char old_sha1[20];
80 unsigned char new_sha1[20];
81 unsigned char old_sha1_expect[20]; /* used by expect-old */
82 char *symref;
83 unsigned int
84 force:1,
85 forced_update:1,
86 expect_old_sha1:1,
87 expect_old_no_trackback:1,
88 deletion:1,
89 matched:1;
90
91 /*
92 * Order is important here, as we write to FETCH_HEAD
93 * in numeric order. And the default NOT_FOR_MERGE
94 * should be 0, so that xcalloc'd structures get it
95 * by default.
96 */
97 enum {
98 FETCH_HEAD_MERGE = -1,
99 FETCH_HEAD_NOT_FOR_MERGE = 0,
100 FETCH_HEAD_IGNORE = 1
101 } fetch_head_status;
102
103 enum {
104 REF_STATUS_NONE = 0,
105 REF_STATUS_OK,
106 REF_STATUS_REJECT_NONFASTFORWARD,
107 REF_STATUS_REJECT_ALREADY_EXISTS,
108 REF_STATUS_REJECT_NODELETE,
109 REF_STATUS_REJECT_FETCH_FIRST,
110 REF_STATUS_REJECT_NEEDS_FORCE,
111 REF_STATUS_REJECT_STALE,
112 REF_STATUS_UPTODATE,
113 REF_STATUS_REMOTE_REJECT,
114 REF_STATUS_EXPECTING_REPORT
115 } status;
116 char *remote_status;
117 struct ref *peer_ref; /* when renaming */
118 char name[FLEX_ARRAY]; /* more */
119 };
120
121 #define REF_NORMAL (1u << 0)
122 #define REF_HEADS (1u << 1)
123 #define REF_TAGS (1u << 2)
124
125 extern struct ref *find_ref_by_name(const struct ref *list, const char *name);
126
127 struct ref *alloc_ref(const char *name);
128 struct ref *copy_ref(const struct ref *ref);
129 struct ref *copy_ref_list(const struct ref *ref);
130 void sort_ref_list(struct ref **, int (*cmp)(const void *, const void *));
131 int ref_compare_name(const void *, const void *);
132
133 int check_ref_type(const struct ref *ref, int flags);
134
135 /*
136 * Frees the entire list and peers of elements.
137 */
138 void free_refs(struct ref *ref);
139
140 struct extra_have_objects {
141 int nr, alloc;
142 unsigned char (*array)[20];
143 };
144 extern struct ref **get_remote_heads(int in, char *src_buf, size_t src_len,
145 struct ref **list, unsigned int flags,
146 struct extra_have_objects *);
147
148 int resolve_remote_symref(struct ref *ref, struct ref *list);
149 int ref_newer(const unsigned char *new_sha1, const unsigned char *old_sha1);
150
151 /*
152 * Removes and frees any duplicate refs in the map.
153 */
154 void ref_remove_duplicates(struct ref *ref_map);
155
156 int valid_fetch_refspec(const char *refspec);
157 struct refspec *parse_fetch_refspec(int nr_refspec, const char **refspec);
158
159 void free_refspec(int nr_refspec, struct refspec *refspec);
160
161 char *apply_refspecs(struct refspec *refspecs, int nr_refspec,
162 const char *name);
163
164 int match_push_refs(struct ref *src, struct ref **dst,
165 int nr_refspec, const char **refspec, int all);
166 void set_ref_status_for_push(struct ref *remote_refs, int send_mirror,
167 int force_update);
168
169 /*
170 * Given a list of the remote refs and the specification of things to
171 * fetch, makes a (separate) list of the refs to fetch and the local
172 * refs to store into.
173 *
174 * *tail is the pointer to the tail pointer of the list of results
175 * beforehand, and will be set to the tail pointer of the list of
176 * results afterward.
177 *
178 * missing_ok is usually false, but when we are adding branch.$name.merge
179 * it is Ok if the branch is not at the remote anymore.
180 */
181 int get_fetch_map(const struct ref *remote_refs, const struct refspec *refspec,
182 struct ref ***tail, int missing_ok);
183
184 struct ref *get_remote_ref(const struct ref *remote_refs, const char *name);
185
186 /*
187 * For the given remote, reads the refspec's src and sets the other fields.
188 */
189 int remote_find_tracking(struct remote *remote, struct refspec *refspec);
190
191 struct branch {
192 const char *name;
193 const char *refname;
194
195 const char *remote_name;
196 struct remote *remote;
197
198 const char **merge_name;
199 struct refspec **merge;
200 int merge_nr;
201 int merge_alloc;
202 };
203
204 struct branch *branch_get(const char *name);
205
206 int branch_has_merge_config(struct branch *branch);
207 int branch_merge_matches(struct branch *, int n, const char *);
208
209 /* Flags to match_refs. */
210 enum match_refs_flags {
211 MATCH_REFS_NONE = 0,
212 MATCH_REFS_ALL = (1 << 0),
213 MATCH_REFS_MIRROR = (1 << 1),
214 MATCH_REFS_PRUNE = (1 << 2),
215 MATCH_REFS_FOLLOW_TAGS = (1 << 3)
216 };
217
218 /* Reporting of tracking info */
219 int stat_tracking_info(struct branch *branch, int *num_ours, int *num_theirs);
220 int format_tracking_info(struct branch *branch, struct strbuf *sb);
221
222 struct ref *get_local_heads(void);
223 /*
224 * Find refs from a list which are likely to be pointed to by the given HEAD
225 * ref. If 'all' is false, returns the most likely ref; otherwise, returns a
226 * list of all candidate refs. If no match is found (or 'head' is NULL),
227 * returns NULL. All returns are newly allocated and should be freed.
228 */
229 struct ref *guess_remote_head(const struct ref *head,
230 const struct ref *refs,
231 int all);
232
233 /* Return refs which no longer exist on remote */
234 struct ref *get_stale_heads(struct refspec *refs, int ref_count, struct ref *fetch_map);
235
236 /*
237 * Compare-and-swap
238 */
239 #define CAS_OPT_NAME "force-with-lease"
240
241 struct push_cas_option {
242 unsigned use_tracking_for_rest:1;
243 struct push_cas {
244 unsigned char expect[20];
245 unsigned use_tracking:1;
246 char *refname;
247 } *entry;
248 int nr;
249 int alloc;
250 };
251
252 extern int parseopt_push_cas_option(const struct option *, const char *arg, int unset);
253 extern int parse_push_cas_option(struct push_cas_option *, const char *arg, int unset);
254 extern void clear_cas_option(struct push_cas_option *);
255
256 extern int is_empty_cas(const struct push_cas_option *);
257 void apply_push_cas(struct push_cas_option *, struct remote *, struct ref *);
258
259 #endif