remote.h

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