Merge branch 'so/pretty-abbrev-doc'
[git] / remote.h
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 {
97         struct ref *next;
98         struct object_id old_oid;
99         struct object_id new_oid;
100         struct object_id old_oid_expect; /* used by expect-old */
101         char *symref;
102         unsigned int
103                 force:1,
104                 forced_update:1,
105                 expect_old_sha1:1,
106                 exact_oid:1,
107                 deletion:1;
108
109         enum {
110                 REF_NOT_MATCHED = 0, /* initial value */
111                 REF_MATCHED,
112                 REF_UNADVERTISED_NOT_ALLOWED
113         } match_status;
114
115         /*
116          * Order is important here, as we write to FETCH_HEAD
117          * in numeric order. And the default NOT_FOR_MERGE
118          * should be 0, so that xcalloc'd structures get it
119          * by default.
120          */
121         enum {
122                 FETCH_HEAD_MERGE = -1,
123                 FETCH_HEAD_NOT_FOR_MERGE = 0,
124                 FETCH_HEAD_IGNORE = 1
125         } fetch_head_status;
126
127         enum {
128                 REF_STATUS_NONE = 0,
129                 REF_STATUS_OK,
130                 REF_STATUS_REJECT_NONFASTFORWARD,
131                 REF_STATUS_REJECT_ALREADY_EXISTS,
132                 REF_STATUS_REJECT_NODELETE,
133                 REF_STATUS_REJECT_FETCH_FIRST,
134                 REF_STATUS_REJECT_NEEDS_FORCE,
135                 REF_STATUS_REJECT_STALE,
136                 REF_STATUS_REJECT_SHALLOW,
137                 REF_STATUS_UPTODATE,
138                 REF_STATUS_REMOTE_REJECT,
139                 REF_STATUS_EXPECTING_REPORT,
140                 REF_STATUS_ATOMIC_PUSH_FAILED
141         } status;
142         char *remote_status;
143         struct ref *peer_ref; /* when renaming */
144         char name[FLEX_ARRAY]; /* more */
145 };
146
147 #define REF_NORMAL      (1u << 0)
148 #define REF_HEADS       (1u << 1)
149 #define REF_TAGS        (1u << 2)
150
151 struct ref *find_ref_by_name(const struct ref *list, const char *name);
152
153 struct ref *alloc_ref(const char *name);
154 struct ref *copy_ref(const struct ref *ref);
155 struct ref *copy_ref_list(const struct ref *ref);
156 void sort_ref_list(struct ref **, int (*cmp)(const void *, const void *));
157 int count_refspec_match(const char *, struct ref *refs, struct ref **matched_ref);
158 int ref_compare_name(const void *, const void *);
159
160 int check_ref_type(const struct ref *ref, int flags);
161
162 /*
163  * Free a single ref and its peer, or an entire list of refs and their peers,
164  * respectively.
165  */
166 void free_one_ref(struct ref *ref);
167 void free_refs(struct ref *ref);
168
169 struct oid_array;
170 struct packet_reader;
171 struct strvec;
172 struct string_list;
173 struct ref **get_remote_heads(struct packet_reader *reader,
174                               struct ref **list, unsigned int flags,
175                               struct oid_array *extra_have,
176                               struct oid_array *shallow_points);
177
178 /* Used for protocol v2 in order to retrieve refs from a remote */
179 struct ref **get_remote_refs(int fd_out, struct packet_reader *reader,
180                              struct ref **list, int for_push,
181                              const struct strvec *ref_prefixes,
182                              const struct string_list *server_options,
183                              int stateless_rpc);
184
185 int resolve_remote_symref(struct ref *ref, struct ref *list);
186
187 /*
188  * Remove and free all but the first of any entries in the input list
189  * that map the same remote reference to the same local reference.  If
190  * there are two entries that map different remote references to the
191  * same local reference, emit an error message and die.  Return a
192  * pointer to the head of the resulting list.
193  */
194 struct ref *ref_remove_duplicates(struct ref *ref_map);
195
196 int query_refspecs(struct refspec *rs, struct refspec_item *query);
197 char *apply_refspecs(struct refspec *rs, const char *name);
198
199 int check_push_refs(struct ref *src, struct refspec *rs);
200 int match_push_refs(struct ref *src, struct ref **dst,
201                     struct refspec *rs, int flags);
202 void set_ref_status_for_push(struct ref *remote_refs, int send_mirror,
203         int force_update);
204
205 /*
206  * Given a list of the remote refs and the specification of things to
207  * fetch, makes a (separate) list of the refs to fetch and the local
208  * refs to store into.
209  *
210  * *tail is the pointer to the tail pointer of the list of results
211  * beforehand, and will be set to the tail pointer of the list of
212  * results afterward.
213  *
214  * missing_ok is usually false, but when we are adding branch.$name.merge
215  * it is Ok if the branch is not at the remote anymore.
216  */
217 int get_fetch_map(const struct ref *remote_refs, const struct refspec_item *refspec,
218                   struct ref ***tail, int missing_ok);
219
220 struct ref *get_remote_ref(const struct ref *remote_refs, const char *name);
221
222 /*
223  * For the given remote, reads the refspec's src and sets the other fields.
224  */
225 int remote_find_tracking(struct remote *remote, struct refspec_item *refspec);
226
227 /**
228  * struct branch holds the configuration for a branch. It can be looked up with
229  * branch_get(name) for "refs/heads/{name}", or with branch_get(NULL) for HEAD.
230  */
231 struct branch {
232
233         /* The short name of the branch. */
234         const char *name;
235
236         /* The full path for the branch ref. */
237         const char *refname;
238
239         /* The name of the remote listed in the configuration. */
240         const char *remote_name;
241
242         const char *pushremote_name;
243
244         /* An array of the "merge" lines in the configuration. */
245         const char **merge_name;
246
247         /**
248          * An array of the struct refspecs used for the merge lines. That is,
249          * merge[i]->dst is a local tracking ref which should be merged into this
250          * branch by default.
251          */
252         struct refspec_item **merge;
253
254         /* The number of merge configurations */
255         int merge_nr;
256
257         int merge_alloc;
258
259         const char *push_tracking_ref;
260 };
261
262 struct branch *branch_get(const char *name);
263 const char *remote_for_branch(struct branch *branch, int *explicit);
264 const char *pushremote_for_branch(struct branch *branch, int *explicit);
265 const char *remote_ref_for_branch(struct branch *branch, int for_push);
266
267 /* returns true if the given branch has merge configuration given. */
268 int branch_has_merge_config(struct branch *branch);
269
270 int branch_merge_matches(struct branch *, int n, const char *);
271
272 /**
273  * Return the fully-qualified refname of the tracking branch for `branch`.
274  * I.e., what "branch@{upstream}" would give you. Returns NULL if no
275  * upstream is defined.
276  *
277  * If `err` is not NULL and no upstream is defined, a more specific error
278  * message is recorded there (if the function does not return NULL, then
279  * `err` is not touched).
280  */
281 const char *branch_get_upstream(struct branch *branch, struct strbuf *err);
282
283 /**
284  * Return the tracking branch that corresponds to the ref we would push to
285  * given a bare `git push` while `branch` is checked out.
286  *
287  * The return value and `err` conventions match those of `branch_get_upstream`.
288  */
289 const char *branch_get_push(struct branch *branch, struct strbuf *err);
290
291 /* Flags to match_refs. */
292 enum match_refs_flags {
293         MATCH_REFS_NONE         = 0,
294         MATCH_REFS_ALL          = (1 << 0),
295         MATCH_REFS_MIRROR       = (1 << 1),
296         MATCH_REFS_PRUNE        = (1 << 2),
297         MATCH_REFS_FOLLOW_TAGS  = (1 << 3)
298 };
299
300 /* Flags for --ahead-behind option. */
301 enum ahead_behind_flags {
302         AHEAD_BEHIND_UNSPECIFIED = -1,
303         AHEAD_BEHIND_QUICK       =  0,  /* just eq/neq reporting */
304         AHEAD_BEHIND_FULL        =  1,  /* traditional a/b reporting */
305 };
306
307 /* Reporting of tracking info */
308 int stat_tracking_info(struct branch *branch, int *num_ours, int *num_theirs,
309                        const char **upstream_name, int for_push,
310                        enum ahead_behind_flags abf);
311 int format_tracking_info(struct branch *branch, struct strbuf *sb,
312                          enum ahead_behind_flags abf);
313
314 struct ref *get_local_heads(void);
315 /*
316  * Find refs from a list which are likely to be pointed to by the given HEAD
317  * ref. If 'all' is false, returns the most likely ref; otherwise, returns a
318  * list of all candidate refs. If no match is found (or 'head' is NULL),
319  * returns NULL. All returns are newly allocated and should be freed.
320  */
321 struct ref *guess_remote_head(const struct ref *head,
322                               const struct ref *refs,
323                               int all);
324
325 /* Return refs which no longer exist on remote */
326 struct ref *get_stale_heads(struct refspec *rs, struct ref *fetch_map);
327
328 /*
329  * Compare-and-swap
330  */
331 #define CAS_OPT_NAME "force-with-lease"
332
333 struct push_cas_option {
334         unsigned use_tracking_for_rest:1;
335         struct push_cas {
336                 struct object_id expect;
337                 unsigned use_tracking:1;
338                 char *refname;
339         } *entry;
340         int nr;
341         int alloc;
342 };
343
344 int parseopt_push_cas_option(const struct option *, const char *arg, int unset);
345
346 int is_empty_cas(const struct push_cas_option *);
347 void apply_push_cas(struct push_cas_option *, struct remote *, struct ref *);
348
349 #endif