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