remote.h

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