remote.h

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