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