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