include/git2/remote.h

   1 /*
   2  * Copyright (C) the libgit2 contributors. All rights reserved.
   3  *
   4  * This file is part of libgit2, distributed under the GNU GPL v2 with
   5  * a Linking Exception. For full terms see the included COPYING file.
   6  */
   7 #ifndef INCLUDE_git_remote_h__
   8 #define INCLUDE_git_remote_h__
   9
  10 #include "common.h"
  11 #include "repository.h"
  12 #include "refspec.h"
  13 #include "net.h"
  14 #include "indexer.h"
  15 #include "strarray.h"
  16 #include "transport.h"
  17 #include "pack.h"
  18 #include "proxy.h"
  19
  20 /**
  21  * @file git2/remote.h
  22  * @brief Git remote management functions
  23  * @defgroup git_remote remote management functions
  24  * @ingroup Git
  25  * @{
  26  */
  27 GIT_BEGIN_DECL
  28
  29 /**
  30  * Add a remote with the default fetch refspec to the repository's configuration.
  31  *
  32  * @param out the resulting remote
  33  * @param repo the repository in which to create the remote
  34  * @param name the remote's name
  35  * @param url the remote's url
  36  * @return 0, GIT_EINVALIDSPEC, GIT_EEXISTS or an error code
  37  */
  38 GIT_EXTERN(int) git_remote_create(
  39                 git_remote **out,
  40                 git_repository *repo,
  41                 const char *name,
  42                 const char *url);
  43
  44 /**
  45  * Remote creation options flags
  46  */
  47 typedef enum {
  48         /** Ignore the repository apply.insteadOf configuration */
  49         GIT_REMOTE_CREATE_SKIP_INSTEADOF = (1 << 0),
  50
  51         /** Don't build a fetchspec from the name if none is set */
  52         GIT_REMOTE_CREATE_SKIP_DEFAULT_FETCHSPEC = (1 << 1),
  53 } git_remote_create_flags;
  54
  55 /**
  56  * Remote creation options structure
  57  *
  58  * Initialize with `GIT_REMOTE_CREATE_OPTIONS_INIT`. Alternatively, you can
  59  * use `git_remote_create_init_options`.
  60  *
  61  */
  62 typedef struct git_remote_create_options {
  63         unsigned int version;
  64
  65         /**
  66          * The repository that should own the remote.
  67          * Setting this to NULL results in a detached remote.
  68          */
  69         git_repository *repository;
  70
  71         /**
  72          * The remote's name.
  73          * Setting this to NULL results in an in-memory/anonymous remote.
  74          */
  75         const char *name;
  76
  77         /** The fetchspec the remote should use. */
  78         const char *fetchspec;
  79
  80         /** Additional flags for the remote. See git_remote_create_flags. */
  81         unsigned int flags;
  82 } git_remote_create_options;
  83
  84 #define GIT_REMOTE_CREATE_OPTIONS_VERSION 1
  85 #define GIT_REMOTE_CREATE_OPTIONS_INIT {GIT_REMOTE_CREATE_OPTIONS_VERSION}
  86
  87 /**
  88  * Initialize git_remote_create_options structure
  89  *
  90  * Initializes a `git_remote_create_options` with default values. Equivalent to
  91  * creating an instance with `GIT_REMOTE_CREATE_OPTIONS_INIT`.
  92  *
  93  * @param opts The `git_remote_create_options` struct to initialize.
  94  * @param version The struct version; pass `GIT_REMOTE_CREATE_OPTIONS_VERSION`.
  95  * @return Zero on success; -1 on failure.
  96  */
  97 GIT_EXTERN(int) git_remote_create_init_options(
  98                 git_remote_create_options *opts,
  99                 unsigned int version);
 100
 101 /**
 102  * Create a remote, with options.
 103  *
 104  * This function allows more fine-grained control over the remote creation.
 105  *
 106  * Passing NULL as the opts argument will result in a detached remote.
 107  *
 108  * @param out the resulting remote
 109  * @param url the remote's url
 110  * @param opts the remote creation options
 111  * @return 0, GIT_EINVALIDSPEC, GIT_EEXISTS or an error code
 112  */
 113 GIT_EXTERN(int) git_remote_create_with_opts(
 114                 git_remote **out,
 115                 const char *url,
 116                 const git_remote_create_options *opts);
 117
 118 /**
 119  * Add a remote with the provided fetch refspec (or default if NULL) to the repository's
 120  * configuration.
 121  *
 122  * @param out the resulting remote
 123  * @param repo the repository in which to create the remote
 124  * @param name the remote's name
 125  * @param url the remote's url
 126  * @param fetch the remote fetch value
 127  * @return 0, GIT_EINVALIDSPEC, GIT_EEXISTS or an error code
 128  */
 129 GIT_EXTERN(int) git_remote_create_with_fetchspec(
 130                 git_remote **out,
 131                 git_repository *repo,
 132                 const char *name,
 133                 const char *url,
 134                 const char *fetch);
 135
 136 /**
 137  * Create an anonymous remote
 138  *
 139  * Create a remote with the given url in-memory. You can use this when
 140  * you have a URL instead of a remote's name.
 141  *
 142  * @param out pointer to the new remote objects
 143  * @param repo the associated repository
 144  * @param url the remote repository's URL
 145  * @return 0 or an error code
 146  */
 147 GIT_EXTERN(int) git_remote_create_anonymous(
 148                 git_remote **out,
 149                 git_repository *repo,
 150                 const char *url);
 151
 152 /**
 153  * Create a remote without a connected local repo
 154  *
 155  * Create a remote with the given url in-memory. You can use this when
 156  * you have a URL instead of a remote's name.
 157  *
 158  * Contrasted with git_remote_create_anonymous, a detached remote
 159  * will not consider any repo configuration values (such as insteadof url
 160  * substitutions).
 161  *
 162  * @param out pointer to the new remote objects
 163  * @param url the remote repository's URL
 164  * @return 0 or an error code
 165  */
 166 GIT_EXTERN(int) git_remote_create_detached(
 167                 git_remote **out,
 168                 const char *url);
 169
 170 /**
 171  * Get the information for a particular remote
 172  *
 173  * The name will be checked for validity.
 174  * See `git_tag_create()` for rules about valid names.
 175  *
 176  * @param out pointer to the new remote object
 177  * @param repo the associated repository
 178  * @param name the remote's name
 179  * @return 0, GIT_ENOTFOUND, GIT_EINVALIDSPEC or an error code
 180  */
 181 GIT_EXTERN(int) git_remote_lookup(git_remote **out, git_repository *repo, const char *name);
 182
 183 /**
 184  * Create a copy of an existing remote.  All internal strings are also
 185  * duplicated. Callbacks are not duplicated.
 186  *
 187  * Call `git_remote_free` to free the data.
 188  *
 189  * @param dest pointer where to store the copy
 190  * @param source object to copy
 191  * @return 0 or an error code
 192  */
 193 GIT_EXTERN(int) git_remote_dup(git_remote **dest, git_remote *source);
 194
 195 /**
 196  * Get the remote's repository
 197  *
 198  * @param remote the remote
 199  * @return a pointer to the repository
 200  */
 201 GIT_EXTERN(git_repository *) git_remote_owner(const git_remote *remote);
 202
 203 /**
 204  * Get the remote's name
 205  *
 206  * @param remote the remote
 207  * @return a pointer to the name or NULL for in-memory remotes
 208  */
 209 GIT_EXTERN(const char *) git_remote_name(const git_remote *remote);
 210
 211 /**
 212  * Get the remote's url
 213  *
 214  * If url.*.insteadOf has been configured for this URL, it will
 215  * return the modified URL.
 216  *
 217  * @param remote the remote
 218  * @return a pointer to the url
 219  */
 220 GIT_EXTERN(const char *) git_remote_url(const git_remote *remote);
 221
 222 /**
 223  * Get the remote's url for pushing
 224  *
 225  * If url.*.pushInsteadOf has been configured for this URL, it
 226  * will return the modified URL.
 227  *
 228  * @param remote the remote
 229  * @return a pointer to the url or NULL if no special url for pushing is set
 230  */
 231 GIT_EXTERN(const char *) git_remote_pushurl(const git_remote *remote);
 232
 233 /**
 234  * Set the remote's url in the configuration
 235  *
 236  * Remote objects already in memory will not be affected. This assumes
 237  * the common case of a single-url remote and will otherwise return an error.
 238  *
 239  * @param repo the repository in which to perform the change
 240  * @param remote the remote's name
 241  * @param url the url to set
 242  * @return 0 or an error value
 243  */
 244 GIT_EXTERN(int) git_remote_set_url(git_repository *repo, const char *remote, const char* url);
 245
 246 /**
 247  * Set the remote's url for pushing in the configuration.
 248  *
 249  * Remote objects already in memory will not be affected. This assumes
 250  * the common case of a single-url remote and will otherwise return an error.
 251  *
 252  *
 253  * @param repo the repository in which to perform the change
 254  * @param remote the remote's name
 255  * @param url the url to set
 256  */
 257 GIT_EXTERN(int) git_remote_set_pushurl(git_repository *repo, const char *remote, const char* url);
 258
 259 /**
 260  * Add a fetch refspec to the remote's configuration
 261  *
 262  * Add the given refspec to the fetch list in the configuration. No
 263  * loaded remote instances will be affected.
 264  *
 265  * @param repo the repository in which to change the configuration
 266  * @param remote the name of the remote to change
 267  * @param refspec the new fetch refspec
 268  * @return 0, GIT_EINVALIDSPEC if refspec is invalid or an error value
 269  */
 270 GIT_EXTERN(int) git_remote_add_fetch(git_repository *repo, const char *remote, const char *refspec);
 271
 272 /**
 273  * Get the remote's list of fetch refspecs
 274  *
 275  * The memory is owned by the user and should be freed with
 276  * `git_strarray_free`.
 277  *
 278  * @param array pointer to the array in which to store the strings
 279  * @param remote the remote to query
 280  */
 281 GIT_EXTERN(int) git_remote_get_fetch_refspecs(git_strarray *array, const git_remote *remote);
 282
 283 /**
 284  * Add a push refspec to the remote's configuration
 285  *
 286  * Add the given refspec to the push list in the configuration. No
 287  * loaded remote instances will be affected.
 288  *
 289  * @param repo the repository in which to change the configuration
 290  * @param remote the name of the remote to change
 291  * @param refspec the new push refspec
 292  * @return 0, GIT_EINVALIDSPEC if refspec is invalid or an error value
 293  */
 294 GIT_EXTERN(int) git_remote_add_push(git_repository *repo, const char *remote, const char *refspec);
 295
 296 /**
 297  * Get the remote's list of push refspecs
 298  *
 299  * The memory is owned by the user and should be freed with
 300  * `git_strarray_free`.
 301  *
 302  * @param array pointer to the array in which to store the strings
 303  * @param remote the remote to query
 304  */
 305 GIT_EXTERN(int) git_remote_get_push_refspecs(git_strarray *array, const git_remote *remote);
 306
 307 /**
 308  * Get the number of refspecs for a remote
 309  *
 310  * @param remote the remote
 311  * @return the amount of refspecs configured in this remote
 312  */
 313 GIT_EXTERN(size_t) git_remote_refspec_count(const git_remote *remote);
 314
 315 /**
 316  * Get a refspec from the remote
 317  *
 318  * @param remote the remote to query
 319  * @param n the refspec to get
 320  * @return the nth refspec
 321  */
 322 GIT_EXTERN(const git_refspec *)git_remote_get_refspec(const git_remote *remote, size_t n);
 323
 324 /**
 325  * Open a connection to a remote
 326  *
 327  * The transport is selected based on the URL. The direction argument
 328  * is due to a limitation of the git protocol (over TCP or SSH) which
 329  * starts up a specific binary which can only do the one or the other.
 330  *
 331  * @param remote the remote to connect to
 332  * @param direction GIT_DIRECTION_FETCH if you want to fetch or
 333  * GIT_DIRECTION_PUSH if you want to push
 334  * @param callbacks the callbacks to use for this connection
 335  * @param proxy_opts proxy settings
 336  * @param custom_headers extra HTTP headers to use in this connection
 337  * @return 0 or an error code
 338  */
 339 GIT_EXTERN(int) git_remote_connect(git_remote *remote, git_direction direction, const git_remote_callbacks *callbacks, const git_proxy_options *proxy_opts, const git_strarray *custom_headers);
 340
 341 /**
 342  * Get the remote repository's reference advertisement list
 343  *
 344  * Get the list of references with which the server responds to a new
 345  * connection.
 346  *
 347  * The remote (or more exactly its transport) must have connected to
 348  * the remote repository. This list is available as soon as the
 349  * connection to the remote is initiated and it remains available
 350  * after disconnecting.
 351  *
 352  * The memory belongs to the remote. The pointer will be valid as long
 353  * as a new connection is not initiated, but it is recommended that
 354  * you make a copy in order to make use of the data.
 355  *
 356  * @param out pointer to the array
 357  * @param size the number of remote heads
 358  * @param remote the remote
 359  * @return 0 on success, or an error code
 360  */
 361 GIT_EXTERN(int) git_remote_ls(const git_remote_head ***out,  size_t *size, git_remote *remote);
 362
 363 /**
 364  * Check whether the remote is connected
 365  *
 366  * Check whether the remote's underlying transport is connected to the
 367  * remote host.
 368  *
 369  * @param remote the remote
 370  * @return 1 if it's connected, 0 otherwise.
 371  */
 372 GIT_EXTERN(int) git_remote_connected(const git_remote *remote);
 373
 374 /**
 375  * Cancel the operation
 376  *
 377  * At certain points in its operation, the network code checks whether
 378  * the operation has been cancelled and if so stops the operation.
 379  *
 380  * @param remote the remote
 381  */
 382 GIT_EXTERN(void) git_remote_stop(git_remote *remote);
 383
 384 /**
 385  * Disconnect from the remote
 386  *
 387  * Close the connection to the remote.
 388  *
 389  * @param remote the remote to disconnect from
 390  */
 391 GIT_EXTERN(void) git_remote_disconnect(git_remote *remote);
 392
 393 /**
 394  * Free the memory associated with a remote
 395  *
 396  * This also disconnects from the remote, if the connection
 397  * has not been closed yet (using git_remote_disconnect).
 398  *
 399  * @param remote the remote to free
 400  */
 401 GIT_EXTERN(void) git_remote_free(git_remote *remote);
 402
 403 /**
 404  * Get a list of the configured remotes for a repo
 405  *
 406  * The string array must be freed by the user.
 407  *
 408  * @param out a string array which receives the names of the remotes
 409  * @param repo the repository to query
 410  * @return 0 or an error code
 411  */
 412 GIT_EXTERN(int) git_remote_list(git_strarray *out, git_repository *repo);
 413
 414 /**
 415  * Argument to the completion callback which tells it which operation
 416  * finished.
 417  */
 418 typedef enum git_remote_completion_type {
 419         GIT_REMOTE_COMPLETION_DOWNLOAD,
 420         GIT_REMOTE_COMPLETION_INDEXING,
 421         GIT_REMOTE_COMPLETION_ERROR,
 422 } git_remote_completion_type;
 423
 424 /** Push network progress notification function */
 425 typedef int GIT_CALLBACK(git_push_transfer_progress)(
 426         unsigned int current,
 427         unsigned int total,
 428         size_t bytes,
 429         void* payload);
 430 /**
 431  * Represents an update which will be performed on the remote during push
 432  */
 433 typedef struct {
 434         /**
 435          * The source name of the reference
 436          */
 437         char *src_refname;
 438         /**
 439          * The name of the reference to update on the server
 440          */
 441         char *dst_refname;
 442         /**
 443          * The current target of the reference
 444          */
 445         git_oid src;
 446         /**
 447          * The new target for the reference
 448          */
 449         git_oid dst;
 450 } git_push_update;
 451
 452 /**
 453  * Callback used to inform of upcoming updates.
 454  *
 455  * @param updates an array containing the updates which will be sent
 456  * as commands to the destination.
 457  * @param len number of elements in `updates`
 458  * @param payload Payload provided by the caller
 459  */
 460 typedef int GIT_CALLBACK(git_push_negotiation)(const git_push_update **updates, size_t len, void *payload);
 461
 462 /**
 463  * Callback used to inform of the update status from the remote.
 464  *
 465  * Called for each updated reference on push. If `status` is
 466  * not `NULL`, the update was rejected by the remote server
 467  * and `status` contains the reason given.
 468  *
 469  * @param refname refname specifying to the remote ref
 470  * @param status status message sent from the remote
 471  * @param data data provided by the caller
 472  * @return 0 on success, otherwise an error
 473  */
 474 typedef int GIT_CALLBACK(git_push_update_reference_cb)(const char *refname, const char *status, void *data);
 475
 476 /**
 477  * The callback settings structure
 478  *
 479  * Set the callbacks to be called by the remote when informing the user
 480  * about the progress of the network operations.
 481  */
 482 struct git_remote_callbacks {
 483         unsigned int version;
 484         /**
 485          * Textual progress from the remote. Text send over the
 486          * progress side-band will be passed to this function (this is
 487          * the 'counting objects' output).
 488          */
 489         git_transport_message_cb sideband_progress;
 490
 491         /**
 492          * Completion is called when different parts of the download
 493          * process are done (currently unused).
 494          */
 495         int GIT_CALLBACK(completion)(git_remote_completion_type type, void *data);
 496
 497         /**
 498          * This will be called if the remote host requires
 499          * authentication in order to connect to it.
 500          *
 501          * Returning GIT_PASSTHROUGH will make libgit2 behave as
 502          * though this field isn't set.
 503          */
 504         git_cred_acquire_cb credentials;
 505
 506         /**
 507          * If cert verification fails, this will be called to let the
 508          * user make the final decision of whether to allow the
 509          * connection to proceed. Returns 0 to allow the connection
 510          * or a negative value to indicate an error.
 511          */
 512         git_transport_certificate_check_cb certificate_check;
 513
 514         /**
 515          * During the download of new data, this will be regularly
 516          * called with the current count of progress done by the
 517          * indexer.
 518          */
 519         git_transfer_progress_cb transfer_progress;
 520
 521         /**
 522          * Each time a reference is updated locally, this function
 523          * will be called with information about it.
 524          */
 525         int GIT_CALLBACK(update_tips)(const char *refname, const git_oid *a, const git_oid *b, void *data);
 526
 527         /**
 528          * Function to call with progress information during pack
 529          * building. Be aware that this is called inline with pack
 530          * building operations, so performance may be affected.
 531          */
 532         git_packbuilder_progress pack_progress;
 533
 534         /**
 535          * Function to call with progress information during the
 536          * upload portion of a push. Be aware that this is called
 537          * inline with pack building operations, so performance may be
 538          * affected.
 539          */
 540         git_push_transfer_progress push_transfer_progress;
 541
 542         /**
 543          * See documentation of git_push_update_reference_cb
 544          */
 545         git_push_update_reference_cb push_update_reference;
 546
 547         /**
 548          * Called once between the negotiation step and the upload. It
 549          * provides information about what updates will be performed.
 550          */
 551         git_push_negotiation push_negotiation;
 552
 553         /**
 554          * Create the transport to use for this operation. Leave NULL
 555          * to auto-detect.
 556          */
 557         git_transport_cb transport;
 558
 559         /**
 560          * This will be passed to each of the callbacks in this struct
 561          * as the last parameter.
 562          */
 563         void *payload;
 564 };
 565
 566 #define GIT_REMOTE_CALLBACKS_VERSION 1
 567 #define GIT_REMOTE_CALLBACKS_INIT {GIT_REMOTE_CALLBACKS_VERSION}
 568
 569 /**
 570  * Initializes a `git_remote_callbacks` with default values. Equivalent to
 571  * creating an instance with GIT_REMOTE_CALLBACKS_INIT.
 572  *
 573  * @param opts the `git_remote_callbacks` struct to initialize
 574  * @param version Version of struct; pass `GIT_REMOTE_CALLBACKS_VERSION`
 575  * @return Zero on success; -1 on failure.
 576  */
 577 GIT_EXTERN(int) git_remote_init_callbacks(
 578         git_remote_callbacks *opts,
 579         unsigned int version);
 580
 581 typedef enum {
 582         /**
 583          * Use the setting from the configuration
 584          */
 585         GIT_FETCH_PRUNE_UNSPECIFIED,
 586         /**
 587          * Force pruning on
 588          */
 589         GIT_FETCH_PRUNE,
 590         /**
 591          * Force pruning off
 592          */
 593         GIT_FETCH_NO_PRUNE,
 594 } git_fetch_prune_t;
 595
 596 /**
 597  * Automatic tag following option
 598  *
 599  * Lets us select the --tags option to use.
 600  */
 601 typedef enum {
 602         /**
 603          * Use the setting from the configuration.
 604          */
 605         GIT_REMOTE_DOWNLOAD_TAGS_UNSPECIFIED = 0,
 606         /**
 607          * Ask the server for tags pointing to objects we're already
 608          * downloading.
 609          */
 610         GIT_REMOTE_DOWNLOAD_TAGS_AUTO,
 611         /**
 612          * Don't ask for any tags beyond the refspecs.
 613          */
 614         GIT_REMOTE_DOWNLOAD_TAGS_NONE,
 615         /**
 616          * Ask for the all the tags.
 617          */
 618         GIT_REMOTE_DOWNLOAD_TAGS_ALL,
 619 } git_remote_autotag_option_t;
 620
 621 /**
 622  * Fetch options structure.
 623  *
 624  * Zero out for defaults.  Initialize with `GIT_FETCH_OPTIONS_INIT` macro to
 625  * correctly set the `version` field.  E.g.
 626  *
 627  *              git_fetch_options opts = GIT_FETCH_OPTIONS_INIT;
 628  */
 629 typedef struct {
 630         int version;
 631
 632         /**
 633          * Callbacks to use for this fetch operation
 634          */
 635         git_remote_callbacks callbacks;
 636
 637         /**
 638          * Whether to perform a prune after the fetch
 639          */
 640         git_fetch_prune_t prune;
 641
 642         /**
 643          * Whether to write the results to FETCH_HEAD. Defaults to
 644          * on. Leave this default in order to behave like git.
 645          */
 646         int update_fetchhead;
 647
 648         /**
 649          * Determines how to behave regarding tags on the remote, such
 650          * as auto-downloading tags for objects we're downloading or
 651          * downloading all of them.
 652          *
 653          * The default is to auto-follow tags.
 654          */
 655         git_remote_autotag_option_t download_tags;
 656
 657         /**
 658          * Proxy options to use, by default no proxy is used.
 659          */
 660         git_proxy_options proxy_opts;
 661
 662         /**
 663          * Extra headers for this fetch operation
 664          */
 665         git_strarray custom_headers;
 666 } git_fetch_options;
 667
 668 #define GIT_FETCH_OPTIONS_VERSION 1
 669 #define GIT_FETCH_OPTIONS_INIT { GIT_FETCH_OPTIONS_VERSION, GIT_REMOTE_CALLBACKS_INIT, GIT_FETCH_PRUNE_UNSPECIFIED, 1, \
 670                                  GIT_REMOTE_DOWNLOAD_TAGS_UNSPECIFIED, GIT_PROXY_OPTIONS_INIT }
 671
 672 /**
 673  * Initialize git_fetch_options structure
 674  *
 675  * Initializes a `git_fetch_options` with default values. Equivalent to
 676  * creating an instance with `GIT_FETCH_OPTIONS_INIT`.
 677  *
 678  * @param opts The `git_fetch_options` struct to initialize.
 679  * @param version The struct version; pass `GIT_FETCH_OPTIONS_VERSION`.
 680  * @return Zero on success; -1 on failure.
 681  */
 682 GIT_EXTERN(int) git_fetch_init_options(
 683         git_fetch_options *opts,
 684         unsigned int version);
 685
 686
 687 /**
 688  * Controls the behavior of a git_push object.
 689  */
 690 typedef struct {
 691         unsigned int version;
 692
 693         /**
 694          * If the transport being used to push to the remote requires the creation
 695          * of a pack file, this controls the number of worker threads used by
 696          * the packbuilder when creating that pack file to be sent to the remote.
 697          *
 698          * If set to 0, the packbuilder will auto-detect the number of threads
 699          * to create. The default value is 1.
 700          */
 701         unsigned int pb_parallelism;
 702
 703         /**
 704          * Callbacks to use for this push operation
 705          */
 706         git_remote_callbacks callbacks;
 707
 708         /**
 709         * Proxy options to use, by default no proxy is used.
 710         */
 711         git_proxy_options proxy_opts;
 712
 713         /**
 714          * Extra headers for this push operation
 715          */
 716         git_strarray custom_headers;
 717 } git_push_options;
 718
 719 #define GIT_PUSH_OPTIONS_VERSION 1
 720 #define GIT_PUSH_OPTIONS_INIT { GIT_PUSH_OPTIONS_VERSION, 1, GIT_REMOTE_CALLBACKS_INIT, GIT_PROXY_OPTIONS_INIT }
 721
 722 /**
 723  * Initialize git_push_options structure
 724  *
 725  * Initializes a `git_push_options` with default values. Equivalent to
 726  * creating an instance with `GIT_PUSH_OPTIONS_INIT`.
 727  *
 728  * @param opts The `git_push_options` struct to initialize.
 729  * @param version The struct version; pass `GIT_PUSH_OPTIONS_VERSION`.
 730  * @return Zero on success; -1 on failure.
 731  */
 732 GIT_EXTERN(int) git_push_init_options(
 733         git_push_options *opts,
 734         unsigned int version);
 735
 736 /**
 737  * Download and index the packfile
 738  *
 739  * Connect to the remote if it hasn't been done yet, negotiate with
 740  * the remote git which objects are missing, download and index the
 741  * packfile.
 742  *
 743  * The .idx file will be created and both it and the packfile with be
 744  * renamed to their final name.
 745  *
 746  * @param remote the remote
 747  * @param refspecs the refspecs to use for this negotiation and
 748  * download. Use NULL or an empty array to use the base refspecs
 749  * @param opts the options to use for this fetch
 750  * @return 0 or an error code
 751  */
 752  GIT_EXTERN(int) git_remote_download(git_remote *remote, const git_strarray *refspecs, const git_fetch_options *opts);
 753
 754 /**
 755  * Create a packfile and send it to the server
 756  *
 757  * Connect to the remote if it hasn't been done yet, negotiate with
 758  * the remote git which objects are missing, create a packfile with the missing objects and send it.
 759  *
 760  * @param remote the remote
 761  * @param refspecs the refspecs to use for this negotiation and
 762  * upload. Use NULL or an empty array to use the base refspecs
 763  * @param opts the options to use for this push
 764  * @return 0 or an error code
 765  */
 766 GIT_EXTERN(int) git_remote_upload(git_remote *remote, const git_strarray *refspecs, const git_push_options *opts);
 767
 768 /**
 769  * Update the tips to the new state
 770  *
 771  * @param remote the remote to update
 772  * @param reflog_message The message to insert into the reflogs. If
 773  * NULL and fetching, the default is "fetch <name>", where <name> is
 774  * the name of the remote (or its url, for in-memory remotes). This
 775  * parameter is ignored when pushing.
 776  * @param callbacks  pointer to the callback structure to use
 777  * @param update_fetchhead whether to write to FETCH_HEAD. Pass 1 to behave like git.
 778  * @param download_tags what the behaviour for downloading tags is for this fetch. This is
 779  * ignored for push. This must be the same value passed to `git_remote_download()`.
 780  * @return 0 or an error code
 781  */
 782 GIT_EXTERN(int) git_remote_update_tips(
 783                 git_remote *remote,
 784                 const git_remote_callbacks *callbacks,
 785                 int update_fetchhead,
 786                 git_remote_autotag_option_t download_tags,
 787                 const char *reflog_message);
 788
 789 /**
 790  * Download new data and update tips
 791  *
 792  * Convenience function to connect to a remote, download the data,
 793  * disconnect and update the remote-tracking branches.
 794  *
 795  * @param remote the remote to fetch from
 796  * @param refspecs the refspecs to use for this fetch. Pass NULL or an
 797  *                 empty array to use the base refspecs.
 798  * @param opts options to use for this fetch
 799  * @param reflog_message The message to insert into the reflogs. If NULL, the
 800  *                                                               default is "fetch"
 801  * @return 0 or an error code
 802  */
 803 GIT_EXTERN(int) git_remote_fetch(
 804                 git_remote *remote,
 805                 const git_strarray *refspecs,
 806                 const git_fetch_options *opts,
 807                 const char *reflog_message);
 808
 809 /**
 810  * Prune tracking refs that are no longer present on remote
 811  *
 812  * @param remote the remote to prune
 813  * @param callbacks callbacks to use for this prune
 814  * @return 0 or an error code
 815  */
 816 GIT_EXTERN(int) git_remote_prune(git_remote *remote, const git_remote_callbacks *callbacks);
 817
 818 /**
 819  * Perform a push
 820  *
 821  * Peform all the steps from a push.
 822  *
 823  * @param remote the remote to push to
 824  * @param refspecs the refspecs to use for pushing. If NULL or an empty
 825  *                 array, the configured refspecs will be used
 826  * @param opts options to use for this push
 827  */
 828 GIT_EXTERN(int) git_remote_push(git_remote *remote,
 829                                 const git_strarray *refspecs,
 830                                 const git_push_options *opts);
 831
 832 /**
 833  * Get the statistics structure that is filled in by the fetch operation.
 834  */
 835 GIT_EXTERN(const git_transfer_progress *) git_remote_stats(git_remote *remote);
 836
 837 /**
 838  * Retrieve the tag auto-follow setting
 839  *
 840  * @param remote the remote to query
 841  * @return the auto-follow setting
 842  */
 843 GIT_EXTERN(git_remote_autotag_option_t) git_remote_autotag(const git_remote *remote);
 844
 845 /**
 846  * Set the remote's tag following setting.
 847  *
 848  * The change will be made in the configuration. No loaded remotes
 849  * will be affected.
 850  *
 851  * @param repo the repository in which to make the change
 852  * @param remote the name of the remote
 853  * @param value the new value to take.
 854  */
 855 GIT_EXTERN(int) git_remote_set_autotag(git_repository *repo, const char *remote, git_remote_autotag_option_t value);
 856 /**
 857  * Retrieve the ref-prune setting
 858  *
 859  * @param remote the remote to query
 860  * @return the ref-prune setting
 861  */
 862 GIT_EXTERN(int) git_remote_prune_refs(const git_remote *remote);
 863
 864 /**
 865  * Give the remote a new name
 866  *
 867  * All remote-tracking branches and configuration settings
 868  * for the remote are updated.
 869  *
 870  * The new name will be checked for validity.
 871  * See `git_tag_create()` for rules about valid names.
 872  *
 873  * No loaded instances of a the remote with the old name will change
 874  * their name or their list of refspecs.
 875  *
 876  * @param problems non-default refspecs cannot be renamed and will be
 877  * stored here for further processing by the caller. Always free this
 878  * strarray on successful return.
 879  * @param repo the repository in which to rename
 880  * @param name the current name of the remote
 881  * @param new_name the new name the remote should bear
 882  * @return 0, GIT_EINVALIDSPEC, GIT_EEXISTS or an error code
 883  */
 884 GIT_EXTERN(int) git_remote_rename(
 885         git_strarray *problems,
 886         git_repository *repo,
 887         const char *name,
 888         const char *new_name);
 889
 890 /**
 891  * Ensure the remote name is well-formed.
 892  *
 893  * @param remote_name name to be checked.
 894  * @return 1 if the reference name is acceptable; 0 if it isn't
 895  */
 896 GIT_EXTERN(int) git_remote_is_valid_name(const char *remote_name);
 897
 898 /**
 899 * Delete an existing persisted remote.
 900 *
 901 * All remote-tracking branches and configuration settings
 902 * for the remote will be removed.
 903 *
 904 * @param repo the repository in which to act
 905 * @param name the name of the remote to delete
 906 * @return 0 on success, or an error code.
 907 */
 908 GIT_EXTERN(int) git_remote_delete(git_repository *repo, const char *name);
 909
 910 /**
 911  * Retrieve the name of the remote's default branch
 912  *
 913  * The default branch of a repository is the branch which HEAD points
 914  * to. If the remote does not support reporting this information
 915  * directly, it performs the guess as git does; that is, if there are
 916  * multiple branches which point to the same commit, the first one is
 917  * chosen. If the master branch is a candidate, it wins.
 918  *
 919  * This function must only be called after connecting.
 920  *
 921  * @param out the buffern in which to store the reference name
 922  * @param remote the remote
 923  * @return 0, GIT_ENOTFOUND if the remote does not have any references
 924  * or none of them point to HEAD's commit, or an error message.
 925  */
 926 GIT_EXTERN(int) git_remote_default_branch(git_buf *out, git_remote *remote);
 927
 928 /** @} */
 929 GIT_END_DECL
 930 #endif