]>
Commit | Line | Data |
---|---|---|
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 | /** | |
10 | * The API gives access to the configuration related to remotes. It handles | |
11 | * all three configuration mechanisms historically and currently used by Git, | |
12 | * and presents the information in a uniform fashion. Note that the code also | |
13 | * handles plain URLs without any configuration, giving them just the default | |
14 | * information. | |
15 | */ | |
16 | ||
17 | enum { | |
18 | REMOTE_UNCONFIGURED = 0, | |
19 | REMOTE_CONFIG, | |
20 | REMOTE_REMOTES, | |
21 | REMOTE_BRANCHES | |
22 | }; | |
23 | ||
24 | struct remote { | |
25 | struct hashmap_entry ent; | |
26 | ||
27 | /* The user's nickname for the remote */ | |
28 | const char *name; | |
29 | ||
30 | int origin, configured_in_repo; | |
31 | ||
32 | const char *foreign_vcs; | |
33 | ||
34 | /* An array of all of the url_nr URLs configured for the remote */ | |
35 | const char **url; | |
36 | ||
37 | int url_nr; | |
38 | int url_alloc; | |
39 | ||
40 | /* An array of all of the pushurl_nr push URLs configured for the remote */ | |
41 | const char **pushurl; | |
42 | ||
43 | int pushurl_nr; | |
44 | int pushurl_alloc; | |
45 | ||
46 | struct refspec push; | |
47 | ||
48 | struct refspec fetch; | |
49 | ||
50 | /* | |
51 | * The setting for whether to fetch tags (as a separate rule from the | |
52 | * configured refspecs); | |
53 | * -1 to never fetch tags | |
54 | * 0 to auto-follow tags on heuristic (default) | |
55 | * 1 to always auto-follow tags | |
56 | * 2 to always fetch tags | |
57 | */ | |
58 | int fetch_tags; | |
59 | ||
60 | int skip_default_update; | |
61 | int mirror; | |
62 | int prune; | |
63 | int prune_tags; | |
64 | ||
65 | /** | |
66 | * The configured helper programs to run on the remote side, for | |
67 | * Git-native protocols. | |
68 | */ | |
69 | const char *receivepack; | |
70 | const char *uploadpack; | |
71 | ||
72 | /* The proxy to use for curl (http, https, ftp, etc.) URLs. */ | |
73 | char *http_proxy; | |
74 | ||
75 | /* The method used for authenticating against `http_proxy`. */ | |
76 | char *http_proxy_authmethod; | |
77 | }; | |
78 | ||
79 | /** | |
80 | * struct remotes can be found by name with remote_get(). | |
81 | * remote_get(NULL) will return the default remote, given the current branch | |
82 | * and configuration. | |
83 | */ | |
84 | struct remote *remote_get(const char *name); | |
85 | ||
86 | struct remote *pushremote_get(const char *name); | |
87 | int remote_is_configured(struct remote *remote, int in_repo); | |
88 | ||
89 | typedef int each_remote_fn(struct remote *remote, void *priv); | |
90 | ||
91 | /* iterate through struct remotes */ | |
92 | int for_each_remote(each_remote_fn fn, void *priv); | |
93 | ||
94 | int remote_has_url(struct remote *remote, const char *url); | |
95 | ||
96 | struct ref_push_report { | |
97 | const char *ref_name; | |
98 | struct object_id *old_oid; | |
99 | struct object_id *new_oid; | |
100 | unsigned int forced_update:1; | |
101 | struct ref_push_report *next; | |
102 | }; | |
103 | ||
104 | struct ref { | |
105 | struct ref *next; | |
106 | struct object_id old_oid; | |
107 | struct object_id new_oid; | |
108 | struct object_id old_oid_expect; /* used by expect-old */ | |
109 | char *symref; | |
110 | char *tracking_ref; | |
111 | unsigned int | |
112 | force:1, | |
113 | forced_update:1, | |
114 | expect_old_sha1:1, | |
115 | exact_oid:1, | |
116 | deletion:1, | |
117 | /* Need to check if local reflog reaches the remote tip. */ | |
118 | check_reachable:1, | |
119 | /* | |
120 | * Store the result of the check enabled by "check_reachable"; | |
121 | * implies the local reflog does not reach the remote tip. | |
122 | */ | |
123 | unreachable:1; | |
124 | ||
125 | enum { | |
126 | REF_NOT_MATCHED = 0, /* initial value */ | |
127 | REF_MATCHED, | |
128 | REF_UNADVERTISED_NOT_ALLOWED | |
129 | } match_status; | |
130 | ||
131 | /* | |
132 | * Order is important here, as we write to FETCH_HEAD | |
133 | * in numeric order. And the default NOT_FOR_MERGE | |
134 | * should be 0, so that xcalloc'd structures get it | |
135 | * by default. | |
136 | */ | |
137 | enum { | |
138 | FETCH_HEAD_MERGE = -1, | |
139 | FETCH_HEAD_NOT_FOR_MERGE = 0, | |
140 | FETCH_HEAD_IGNORE = 1 | |
141 | } fetch_head_status; | |
142 | ||
143 | enum { | |
144 | REF_STATUS_NONE = 0, | |
145 | REF_STATUS_OK, | |
146 | REF_STATUS_REJECT_NONFASTFORWARD, | |
147 | REF_STATUS_REJECT_ALREADY_EXISTS, | |
148 | REF_STATUS_REJECT_NODELETE, | |
149 | REF_STATUS_REJECT_FETCH_FIRST, | |
150 | REF_STATUS_REJECT_NEEDS_FORCE, | |
151 | REF_STATUS_REJECT_STALE, | |
152 | REF_STATUS_REJECT_SHALLOW, | |
153 | REF_STATUS_REJECT_REMOTE_UPDATED, | |
154 | REF_STATUS_UPTODATE, | |
155 | REF_STATUS_REMOTE_REJECT, | |
156 | REF_STATUS_EXPECTING_REPORT, | |
157 | REF_STATUS_ATOMIC_PUSH_FAILED | |
158 | } status; | |
159 | char *remote_status; | |
160 | struct ref_push_report *report; | |
161 | struct ref *peer_ref; /* when renaming */ | |
162 | char name[FLEX_ARRAY]; /* more */ | |
163 | }; | |
164 | ||
165 | #define REF_NORMAL (1u << 0) | |
166 | #define REF_HEADS (1u << 1) | |
167 | #define REF_TAGS (1u << 2) | |
168 | ||
169 | struct ref *find_ref_by_name(const struct ref *list, const char *name); | |
170 | ||
171 | struct ref *alloc_ref(const char *name); | |
172 | struct ref *copy_ref(const struct ref *ref); | |
173 | struct ref *copy_ref_list(const struct ref *ref); | |
174 | void sort_ref_list(struct ref **, int (*cmp)(const void *, const void *)); | |
175 | int count_refspec_match(const char *, struct ref *refs, struct ref **matched_ref); | |
176 | int ref_compare_name(const void *, const void *); | |
177 | ||
178 | int check_ref_type(const struct ref *ref, int flags); | |
179 | ||
180 | /* | |
181 | * Free a single ref and its peer, or an entire list of refs and their peers, | |
182 | * respectively. | |
183 | */ | |
184 | void free_one_ref(struct ref *ref); | |
185 | void free_refs(struct ref *ref); | |
186 | ||
187 | struct oid_array; | |
188 | struct packet_reader; | |
189 | struct strvec; | |
190 | struct string_list; | |
191 | struct ref **get_remote_heads(struct packet_reader *reader, | |
192 | struct ref **list, unsigned int flags, | |
193 | struct oid_array *extra_have, | |
194 | struct oid_array *shallow_points); | |
195 | ||
196 | /* Used for protocol v2 in order to retrieve refs from a remote */ | |
197 | struct ref **get_remote_refs(int fd_out, struct packet_reader *reader, | |
198 | struct ref **list, int for_push, | |
199 | const struct strvec *ref_prefixes, | |
200 | const struct string_list *server_options, | |
201 | int stateless_rpc); | |
202 | ||
203 | int resolve_remote_symref(struct ref *ref, struct ref *list); | |
204 | ||
205 | /* | |
206 | * Remove and free all but the first of any entries in the input list | |
207 | * that map the same remote reference to the same local reference. If | |
208 | * there are two entries that map different remote references to the | |
209 | * same local reference, emit an error message and die. Return a | |
210 | * pointer to the head of the resulting list. | |
211 | */ | |
212 | struct ref *ref_remove_duplicates(struct ref *ref_map); | |
213 | ||
214 | /* | |
215 | * Remove all entries in the input list which match any negative refspec in | |
216 | * the refspec list. | |
217 | */ | |
218 | struct ref *apply_negative_refspecs(struct ref *ref_map, struct refspec *rs); | |
219 | ||
220 | int query_refspecs(struct refspec *rs, struct refspec_item *query); | |
221 | char *apply_refspecs(struct refspec *rs, const char *name); | |
222 | ||
223 | int check_push_refs(struct ref *src, struct refspec *rs); | |
224 | int match_push_refs(struct ref *src, struct ref **dst, | |
225 | struct refspec *rs, int flags); | |
226 | void set_ref_status_for_push(struct ref *remote_refs, int send_mirror, | |
227 | int force_update); | |
228 | ||
229 | /* | |
230 | * Given a list of the remote refs and the specification of things to | |
231 | * fetch, makes a (separate) list of the refs to fetch and the local | |
232 | * refs to store into. Note that negative refspecs are ignored here, and | |
233 | * should be handled separately. | |
234 | * | |
235 | * *tail is the pointer to the tail pointer of the list of results | |
236 | * beforehand, and will be set to the tail pointer of the list of | |
237 | * results afterward. | |
238 | * | |
239 | * missing_ok is usually false, but when we are adding branch.$name.merge | |
240 | * it is Ok if the branch is not at the remote anymore. | |
241 | */ | |
242 | int get_fetch_map(const struct ref *remote_refs, const struct refspec_item *refspec, | |
243 | struct ref ***tail, int missing_ok); | |
244 | ||
245 | struct ref *get_remote_ref(const struct ref *remote_refs, const char *name); | |
246 | ||
247 | /* | |
248 | * For the given remote, reads the refspec's src and sets the other fields. | |
249 | */ | |
250 | int remote_find_tracking(struct remote *remote, struct refspec_item *refspec); | |
251 | ||
252 | /** | |
253 | * struct branch holds the configuration for a branch. It can be looked up with | |
254 | * branch_get(name) for "refs/heads/{name}", or with branch_get(NULL) for HEAD. | |
255 | */ | |
256 | struct branch { | |
257 | ||
258 | /* The short name of the branch. */ | |
259 | const char *name; | |
260 | ||
261 | /* The full path for the branch ref. */ | |
262 | const char *refname; | |
263 | ||
264 | /* The name of the remote listed in the configuration. */ | |
265 | const char *remote_name; | |
266 | ||
267 | const char *pushremote_name; | |
268 | ||
269 | /* An array of the "merge" lines in the configuration. */ | |
270 | const char **merge_name; | |
271 | ||
272 | /** | |
273 | * An array of the struct refspecs used for the merge lines. That is, | |
274 | * merge[i]->dst is a local tracking ref which should be merged into this | |
275 | * branch by default. | |
276 | */ | |
277 | struct refspec_item **merge; | |
278 | ||
279 | /* The number of merge configurations */ | |
280 | int merge_nr; | |
281 | ||
282 | int merge_alloc; | |
283 | ||
284 | const char *push_tracking_ref; | |
285 | }; | |
286 | ||
287 | struct branch *branch_get(const char *name); | |
288 | const char *remote_for_branch(struct branch *branch, int *explicit); | |
289 | const char *pushremote_for_branch(struct branch *branch, int *explicit); | |
290 | const char *remote_ref_for_branch(struct branch *branch, int for_push); | |
291 | ||
292 | /* returns true if the given branch has merge configuration given. */ | |
293 | int branch_has_merge_config(struct branch *branch); | |
294 | ||
295 | int branch_merge_matches(struct branch *, int n, const char *); | |
296 | ||
297 | /** | |
298 | * Return the fully-qualified refname of the tracking branch for `branch`. | |
299 | * I.e., what "branch@{upstream}" would give you. Returns NULL if no | |
300 | * upstream is defined. | |
301 | * | |
302 | * If `err` is not NULL and no upstream is defined, a more specific error | |
303 | * message is recorded there (if the function does not return NULL, then | |
304 | * `err` is not touched). | |
305 | */ | |
306 | const char *branch_get_upstream(struct branch *branch, struct strbuf *err); | |
307 | ||
308 | /** | |
309 | * Return the tracking branch that corresponds to the ref we would push to | |
310 | * given a bare `git push` while `branch` is checked out. | |
311 | * | |
312 | * The return value and `err` conventions match those of `branch_get_upstream`. | |
313 | */ | |
314 | const char *branch_get_push(struct branch *branch, struct strbuf *err); | |
315 | ||
316 | /* Flags to match_refs. */ | |
317 | enum match_refs_flags { | |
318 | MATCH_REFS_NONE = 0, | |
319 | MATCH_REFS_ALL = (1 << 0), | |
320 | MATCH_REFS_MIRROR = (1 << 1), | |
321 | MATCH_REFS_PRUNE = (1 << 2), | |
322 | MATCH_REFS_FOLLOW_TAGS = (1 << 3) | |
323 | }; | |
324 | ||
325 | /* Flags for --ahead-behind option. */ | |
326 | enum ahead_behind_flags { | |
327 | AHEAD_BEHIND_UNSPECIFIED = -1, | |
328 | AHEAD_BEHIND_QUICK = 0, /* just eq/neq reporting */ | |
329 | AHEAD_BEHIND_FULL = 1, /* traditional a/b reporting */ | |
330 | }; | |
331 | ||
332 | /* Reporting of tracking info */ | |
333 | int stat_tracking_info(struct branch *branch, int *num_ours, int *num_theirs, | |
334 | const char **upstream_name, int for_push, | |
335 | enum ahead_behind_flags abf); | |
336 | int format_tracking_info(struct branch *branch, struct strbuf *sb, | |
337 | enum ahead_behind_flags abf); | |
338 | ||
339 | struct ref *get_local_heads(void); | |
340 | /* | |
341 | * Find refs from a list which are likely to be pointed to by the given HEAD | |
342 | * ref. If 'all' is false, returns the most likely ref; otherwise, returns a | |
343 | * list of all candidate refs. If no match is found (or 'head' is NULL), | |
344 | * returns NULL. All returns are newly allocated and should be freed. | |
345 | */ | |
346 | struct ref *guess_remote_head(const struct ref *head, | |
347 | const struct ref *refs, | |
348 | int all); | |
349 | ||
350 | /* Return refs which no longer exist on remote */ | |
351 | struct ref *get_stale_heads(struct refspec *rs, struct ref *fetch_map); | |
352 | ||
353 | /* | |
354 | * Compare-and-swap | |
355 | */ | |
356 | #define CAS_OPT_NAME "force-with-lease" | |
357 | ||
358 | struct push_cas_option { | |
359 | unsigned use_tracking_for_rest:1; | |
360 | unsigned use_force_if_includes:1; | |
361 | struct push_cas { | |
362 | struct object_id expect; | |
363 | unsigned use_tracking:1; | |
364 | char *refname; | |
365 | } *entry; | |
366 | int nr; | |
367 | int alloc; | |
368 | }; | |
369 | ||
370 | int parseopt_push_cas_option(const struct option *, const char *arg, int unset); | |
371 | ||
372 | int is_empty_cas(const struct push_cas_option *); | |
373 | void apply_push_cas(struct push_cas_option *, struct remote *, struct ref *); | |
374 | ||
375 | #endif |