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