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