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 struct transport_ls_refs_options;
   9
  10 /**
  11  * The API gives access to the configuration related to remotes. It handles
  12  * all three configuration mechanisms historically and currently used by Git,
  13  * and presents the information in a uniform fashion. Note that the code also
  14  * handles plain URLs without any configuration, giving them just the default
  15  * information.
  16  */
  17
  18 enum {
  19         REMOTE_UNCONFIGURED = 0,
  20         REMOTE_CONFIG,
  21         REMOTE_REMOTES,
  22         REMOTE_BRANCHES
  23 };
  24
  25 struct rewrite {
  26         const char *base;
  27         size_t baselen;
  28         struct counted_string *instead_of;
  29         int instead_of_nr;
  30         int instead_of_alloc;
  31 };
  32
  33 struct rewrites {
  34         struct rewrite **rewrite;
  35         int rewrite_alloc;
  36         int rewrite_nr;
  37 };
  38
  39 struct remote_state {
  40         struct remote **remotes;
  41         int remotes_alloc;
  42         int remotes_nr;
  43         struct hashmap remotes_hash;
  44
  45         struct hashmap branches_hash;
  46
  47         struct branch *current_branch;
  48         const char *pushremote_name;
  49
  50         struct rewrites rewrites;
  51         struct rewrites rewrites_push;
  52
  53         int initialized;
  54 };
  55
  56 void remote_state_clear(struct remote_state *remote_state);
  57 struct remote_state *remote_state_new(void);
  58
  59 struct remote {
  60         struct hashmap_entry ent;
  61
  62         /* The user's nickname for the remote */
  63         const char *name;
  64
  65         int origin, configured_in_repo;
  66
  67         const char *foreign_vcs;
  68
  69         /* An array of all of the url_nr URLs configured for the remote */
  70         const char **url;
  71
  72         int url_nr;
  73         int url_alloc;
  74
  75         /* An array of all of the pushurl_nr push URLs configured for the remote */
  76         const char **pushurl;
  77
  78         int pushurl_nr;
  79         int pushurl_alloc;
  80
  81         struct refspec push;
  82
  83         struct refspec fetch;
  84
  85         /*
  86          * The setting for whether to fetch tags (as a separate rule from the
  87          * configured refspecs);
  88          * -1 to never fetch tags
  89          * 0 to auto-follow tags on heuristic (default)
  90          * 1 to always auto-follow tags
  91          * 2 to always fetch tags
  92          */
  93         int fetch_tags;
  94
  95         int skip_default_update;
  96         int mirror;
  97         int prune;
  98         int prune_tags;
  99
 100         /**
 101          * The configured helper programs to run on the remote side, for
 102          * Git-native protocols.
 103          */
 104         const char *receivepack;
 105         const char *uploadpack;
 106
 107         /* The proxy to use for curl (http, https, ftp, etc.) URLs. */
 108         char *http_proxy;
 109
 110         /* The method used for authenticating against `http_proxy`. */
 111         char *http_proxy_authmethod;
 112 };
 113
 114 /**
 115  * struct remotes can be found by name with remote_get().
 116  * remote_get(NULL) will return the default remote, given the current branch
 117  * and configuration.
 118  */
 119 struct remote *remote_get(const char *name);
 120
 121 struct remote *pushremote_get(const char *name);
 122 int remote_is_configured(struct remote *remote, int in_repo);
 123
 124 typedef int each_remote_fn(struct remote *remote, void *priv);
 125
 126 /* iterate through struct remotes */
 127 int for_each_remote(each_remote_fn fn, void *priv);
 128
 129 int remote_has_url(struct remote *remote, const char *url);
 130
 131 struct ref_push_report {
 132         const char *ref_name;
 133         struct object_id *old_oid;
 134         struct object_id *new_oid;
 135         unsigned int forced_update:1;
 136         struct ref_push_report *next;
 137 };
 138
 139 struct ref {
 140         struct ref *next;
 141         struct object_id old_oid;
 142         struct object_id new_oid;
 143         struct object_id old_oid_expect; /* used by expect-old */
 144         char *symref;
 145         char *tracking_ref;
 146         unsigned int
 147                 force:1,
 148                 forced_update:1,
 149                 expect_old_sha1:1,
 150                 exact_oid:1,
 151                 deletion:1,
 152                 /* Need to check if local reflog reaches the remote tip. */
 153                 check_reachable:1,
 154                 /*
 155                  * Store the result of the check enabled by "check_reachable";
 156                  * implies the local reflog does not reach the remote tip.
 157                  */
 158                 unreachable:1;
 159
 160         enum {
 161                 REF_NOT_MATCHED = 0, /* initial value */
 162                 REF_MATCHED,
 163                 REF_UNADVERTISED_NOT_ALLOWED
 164         } match_status;
 165
 166         /*
 167          * Order is important here, as we write to FETCH_HEAD
 168          * in numeric order. And the default NOT_FOR_MERGE
 169          * should be 0, so that xcalloc'd structures get it
 170          * by default.
 171          */
 172         enum fetch_head_status {
 173                 FETCH_HEAD_MERGE = -1,
 174                 FETCH_HEAD_NOT_FOR_MERGE = 0,
 175                 FETCH_HEAD_IGNORE = 1
 176         } fetch_head_status;
 177
 178         enum {
 179                 REF_STATUS_NONE = 0,
 180                 REF_STATUS_OK,
 181                 REF_STATUS_REJECT_NONFASTFORWARD,
 182                 REF_STATUS_REJECT_ALREADY_EXISTS,
 183                 REF_STATUS_REJECT_NODELETE,
 184                 REF_STATUS_REJECT_FETCH_FIRST,
 185                 REF_STATUS_REJECT_NEEDS_FORCE,
 186                 REF_STATUS_REJECT_STALE,
 187                 REF_STATUS_REJECT_SHALLOW,
 188                 REF_STATUS_REJECT_REMOTE_UPDATED,
 189                 REF_STATUS_UPTODATE,
 190                 REF_STATUS_REMOTE_REJECT,
 191                 REF_STATUS_EXPECTING_REPORT,
 192                 REF_STATUS_ATOMIC_PUSH_FAILED
 193         } status;
 194         char *remote_status;
 195         struct ref_push_report *report;
 196         struct ref *peer_ref; /* when renaming */
 197         char name[FLEX_ARRAY]; /* more */
 198 };
 199
 200 #define REF_NORMAL      (1u << 0)
 201 #define REF_HEADS       (1u << 1)
 202 #define REF_TAGS        (1u << 2)
 203
 204 struct ref *find_ref_by_name(const struct ref *list, const char *name);
 205
 206 struct ref *alloc_ref(const char *name);
 207 struct ref *copy_ref(const struct ref *ref);
 208 struct ref *copy_ref_list(const struct ref *ref);
 209 int count_refspec_match(const char *, struct ref *refs, struct ref **matched_ref);
 210
 211 int check_ref_type(const struct ref *ref, int flags);
 212
 213 /*
 214  * Free a single ref and its peer, or an entire list of refs and their peers,
 215  * respectively.
 216  */
 217 void free_one_ref(struct ref *ref);
 218 void free_refs(struct ref *ref);
 219
 220 struct oid_array;
 221 struct packet_reader;
 222 struct strvec;
 223 struct string_list;
 224 struct ref **get_remote_heads(struct packet_reader *reader,
 225                               struct ref **list, unsigned int flags,
 226                               struct oid_array *extra_have,
 227                               struct oid_array *shallow_points);
 228
 229 /* Used for protocol v2 in order to retrieve refs from a remote */
 230 struct ref **get_remote_refs(int fd_out, struct packet_reader *reader,
 231                              struct ref **list, int for_push,
 232                              struct transport_ls_refs_options *transport_options,
 233                              const struct string_list *server_options,
 234                              int stateless_rpc);
 235
 236 /* Used for protocol v2 in order to retrieve refs from a remote */
 237 struct bundle_list;
 238 int get_remote_bundle_uri(int fd_out, struct packet_reader *reader,
 239                           struct bundle_list *bundles, int stateless_rpc);
 240
 241 int resolve_remote_symref(struct ref *ref, struct ref *list);
 242
 243 /*
 244  * Remove and free all but the first of any entries in the input list
 245  * that map the same remote reference to the same local reference.  If
 246  * there are two entries that map different remote references to the
 247  * same local reference, emit an error message and die.  Return a
 248  * pointer to the head of the resulting list.
 249  */
 250 struct ref *ref_remove_duplicates(struct ref *ref_map);
 251
 252 /*
 253  * Check whether a name matches any negative refspec in rs. Returns 1 if the
 254  * name matches at least one negative refspec, and 0 otherwise.
 255  */
 256 int omit_name_by_refspec(const char *name, struct refspec *rs);
 257
 258 /*
 259  * Remove all entries in the input list which match any negative refspec in
 260  * the refspec list.
 261  */
 262 struct ref *apply_negative_refspecs(struct ref *ref_map, struct refspec *rs);
 263
 264 int query_refspecs(struct refspec *rs, struct refspec_item *query);
 265 char *apply_refspecs(struct refspec *rs, const char *name);
 266
 267 int check_push_refs(struct ref *src, struct refspec *rs);
 268 int match_push_refs(struct ref *src, struct ref **dst,
 269                     struct refspec *rs, int flags);
 270 void set_ref_status_for_push(struct ref *remote_refs, int send_mirror,
 271         int force_update);
 272
 273 /*
 274  * Given a list of the remote refs and the specification of things to
 275  * fetch, makes a (separate) list of the refs to fetch and the local
 276  * refs to store into. Note that negative refspecs are ignored here, and
 277  * should be handled separately.
 278  *
 279  * *tail is the pointer to the tail pointer of the list of results
 280  * beforehand, and will be set to the tail pointer of the list of
 281  * results afterward.
 282  *
 283  * missing_ok is usually false, but when we are adding branch.$name.merge
 284  * it is Ok if the branch is not at the remote anymore.
 285  */
 286 int get_fetch_map(const struct ref *remote_refs, const struct refspec_item *refspec,
 287                   struct ref ***tail, int missing_ok);
 288
 289 struct ref *get_remote_ref(const struct ref *remote_refs, const char *name);
 290
 291 /*
 292  * For the given remote, reads the refspec's src and sets the other fields.
 293  */
 294 int remote_find_tracking(struct remote *remote, struct refspec_item *refspec);
 295
 296 /**
 297  * struct branch holds the configuration for a branch. It can be looked up with
 298  * branch_get(name) for "refs/heads/{name}", or with branch_get(NULL) for HEAD.
 299  */
 300 struct branch {
 301         struct hashmap_entry ent;
 302
 303         /* The short name of the branch. */
 304         const char *name;
 305
 306         /* The full path for the branch ref. */
 307         const char *refname;
 308
 309         /* The name of the remote listed in the configuration. */
 310         const char *remote_name;
 311
 312         const char *pushremote_name;
 313
 314         /* An array of the "merge" lines in the configuration. */
 315         const char **merge_name;
 316
 317         /**
 318          * An array of the struct refspecs used for the merge lines. That is,
 319          * merge[i]->dst is a local tracking ref which should be merged into this
 320          * branch by default.
 321          */
 322         struct refspec_item **merge;
 323
 324         /* The number of merge configurations */
 325         int merge_nr;
 326
 327         int merge_alloc;
 328
 329         const char *push_tracking_ref;
 330 };
 331
 332 struct branch *branch_get(const char *name);
 333 const char *remote_for_branch(struct branch *branch, int *explicit);
 334 const char *pushremote_for_branch(struct branch *branch, int *explicit);
 335 const char *remote_ref_for_branch(struct branch *branch, int for_push);
 336
 337 /* returns true if the given branch has merge configuration given. */
 338 int branch_has_merge_config(struct branch *branch);
 339
 340 int branch_merge_matches(struct branch *, int n, const char *);
 341
 342 /**
 343  * Return the fully-qualified refname of the tracking branch for `branch`.
 344  * I.e., what "branch@{upstream}" would give you. Returns NULL if no
 345  * upstream is defined.
 346  *
 347  * If `err` is not NULL and no upstream is defined, a more specific error
 348  * message is recorded there (if the function does not return NULL, then
 349  * `err` is not touched).
 350  */
 351 const char *branch_get_upstream(struct branch *branch, struct strbuf *err);
 352
 353 /**
 354  * Return the tracking branch that corresponds to the ref we would push to
 355  * given a bare `git push` while `branch` is checked out.
 356  *
 357  * The return value and `err` conventions match those of `branch_get_upstream`.
 358  */
 359 const char *branch_get_push(struct branch *branch, struct strbuf *err);
 360
 361 /* Flags to match_refs. */
 362 enum match_refs_flags {
 363         MATCH_REFS_NONE         = 0,
 364         MATCH_REFS_ALL          = (1 << 0),
 365         MATCH_REFS_MIRROR       = (1 << 1),
 366         MATCH_REFS_PRUNE        = (1 << 2),
 367         MATCH_REFS_FOLLOW_TAGS  = (1 << 3)
 368 };
 369
 370 /* Flags for --ahead-behind option. */
 371 enum ahead_behind_flags {
 372         AHEAD_BEHIND_UNSPECIFIED = -1,
 373         AHEAD_BEHIND_QUICK       =  0,  /* just eq/neq reporting */
 374         AHEAD_BEHIND_FULL        =  1,  /* traditional a/b reporting */
 375 };
 376
 377 /* Reporting of tracking info */
 378 int stat_tracking_info(struct branch *branch, int *num_ours, int *num_theirs,
 379                        const char **upstream_name, int for_push,
 380                        enum ahead_behind_flags abf);
 381 int format_tracking_info(struct branch *branch, struct strbuf *sb,
 382                          enum ahead_behind_flags abf);
 383
 384 struct ref *get_local_heads(void);
 385 /*
 386  * Find refs from a list which are likely to be pointed to by the given HEAD
 387  * ref. If 'all' is false, returns the most likely ref; otherwise, returns a
 388  * list of all candidate refs. If no match is found (or 'head' is NULL),
 389  * returns NULL. All returns are newly allocated and should be freed.
 390  */
 391 struct ref *guess_remote_head(const struct ref *head,
 392                               const struct ref *refs,
 393                               int all);
 394
 395 /* Return refs which no longer exist on remote */
 396 struct ref *get_stale_heads(struct refspec *rs, struct ref *fetch_map);
 397
 398 /*
 399  * Compare-and-swap
 400  */
 401 #define CAS_OPT_NAME "force-with-lease"
 402
 403 struct push_cas_option {
 404         unsigned use_tracking_for_rest:1;
 405         unsigned use_force_if_includes:1;
 406         struct push_cas {
 407                 struct object_id expect;
 408                 unsigned use_tracking:1;
 409                 char *refname;
 410         } *entry;
 411         int nr;
 412         int alloc;
 413 };
 414
 415 int parseopt_push_cas_option(const struct option *, const char *arg, int unset);
 416
 417 int is_empty_cas(const struct push_cas_option *);
 418 void apply_push_cas(struct push_cas_option *, struct remote *, struct ref *);
 419
 420 /*
 421  * The `url` argument is the URL that navigates to the submodule origin
 422  * repo. When relative, this URL is relative to the superproject origin
 423  * URL repo. The `up_path` argument, if specified, is the relative
 424  * path that navigates from the submodule working tree to the superproject
 425  * working tree. Returns the origin URL of the submodule.
 426  *
 427  * Return either an absolute URL or filesystem path (if the superproject
 428  * origin URL is an absolute URL or filesystem path, respectively) or a
 429  * relative file system path (if the superproject origin URL is a relative
 430  * file system path).
 431  *
 432  * When the output is a relative file system path, the path is either
 433  * relative to the submodule working tree, if up_path is specified, or to
 434  * the superproject working tree otherwise.
 435  *
 436  * NEEDSWORK: This works incorrectly on the domain and protocol part.
 437  * remote_url      url              outcome          expectation
 438  * http://a.com/b  ../c             http://a.com/c   as is
 439  * http://a.com/b/ ../c             http://a.com/c   same as previous line, but
 440  *                                                   ignore trailing slash in url
 441  * http://a.com/b  ../../c          http://c         error out
 442  * http://a.com/b  ../../../c       http:/c          error out
 443  * http://a.com/b  ../../../../c    http:c           error out
 444  * http://a.com/b  ../../../../../c    .:c           error out
 445  * http://a.com/b  http://d.org/e   http://d.org/e   as is
 446  * NEEDSWORK: Given how chop_last_dir() works, this function is broken
 447  * when a local part has a colon in its path component, too.
 448  */
 449 char *relative_url(const char *remote_url, const char *url,
 450                    const char *up_path);
 451
 452 #endif