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