transport.h

   1 #ifndef TRANSPORT_H
   2 #define TRANSPORT_H
   3
   4 #include "cache.h"
   5 #include "remote.h"
   6
   7 struct transport {
   8         struct remote *remote;
   9         const char *url;
  10         void *data;
  11         const struct ref *remote_refs;
  12
  13         /**
  14          * Returns 0 if successful, positive if the option is not
  15          * recognized or is inapplicable, and negative if the option
  16          * is applicable but the value is invalid.
  17          **/
  18         int (*set_option)(struct transport *connection, const char *name,
  19                           const char *value);
  20
  21         /**
  22          * Returns a list of the remote side's refs. In order to allow
  23          * the transport to try to share connections, for_push is a
  24          * hint as to whether the ultimate operation is a push or a fetch.
  25          *
  26          * If the transport is able to determine the remote hash for
  27          * the ref without a huge amount of effort, it should store it
  28          * in the ref's old_sha1 field; otherwise it should be all 0.
  29          **/
  30         struct ref *(*get_refs_list)(struct transport *transport, int for_push);
  31
  32         /**
  33          * Fetch the objects for the given refs. Note that this gets
  34          * an array, and should ignore the list structure.
  35          *
  36          * If the transport did not get hashes for refs in
  37          * get_refs_list(), it should set the old_sha1 fields in the
  38          * provided refs now.
  39          **/
  40         int (*fetch)(struct transport *transport, int refs_nr, struct ref **refs);
  41
  42         /**
  43          * Push the objects and refs. Send the necessary objects, and
  44          * then, for any refs where peer_ref is set and
  45          * peer_ref->new_sha1 is different from old_sha1, tell the
  46          * remote side to update each ref in the list from old_sha1 to
  47          * peer_ref->new_sha1.
  48          *
  49          * Where possible, set the status for each ref appropriately.
  50          *
  51          * The transport must modify new_sha1 in the ref to the new
  52          * value if the remote accepted the change. Note that this
  53          * could be a different value from peer_ref->new_sha1 if the
  54          * process involved generating new commits.
  55          **/
  56         int (*push_refs)(struct transport *transport, struct ref *refs, int flags);
  57         int (*push)(struct transport *connection, int refspec_nr, const char **refspec, int flags);
  58
  59         /** get_refs_list(), fetch(), and push_refs() can keep
  60          * resources (such as a connection) reserved for futher
  61          * use. disconnect() releases these resources.
  62          **/
  63         int (*disconnect)(struct transport *connection);
  64         char *pack_lockfile;
  65         signed verbose : 3;
  66         /* Force progress even if the output is not a tty */
  67         unsigned progress : 1;
  68 };
  69
  70 #define TRANSPORT_PUSH_ALL 1
  71 #define TRANSPORT_PUSH_FORCE 2
  72 #define TRANSPORT_PUSH_DRY_RUN 4
  73 #define TRANSPORT_PUSH_MIRROR 8
  74 #define TRANSPORT_PUSH_VERBOSE 16
  75 #define TRANSPORT_PUSH_PORCELAIN 32
  76 #define TRANSPORT_PUSH_QUIET 64
  77
  78 /* Returns a transport suitable for the url */
  79 struct transport *transport_get(struct remote *, const char *);
  80
  81 /* Transport options which apply to git:// and scp-style URLs */
  82
  83 /* The program to use on the remote side to send a pack */
  84 #define TRANS_OPT_UPLOADPACK "uploadpack"
  85
  86 /* The program to use on the remote side to receive a pack */
  87 #define TRANS_OPT_RECEIVEPACK "receivepack"
  88
  89 /* Transfer the data as a thin pack if not null */
  90 #define TRANS_OPT_THIN "thin"
  91
  92 /* Keep the pack that was transferred if not null */
  93 #define TRANS_OPT_KEEP "keep"
  94
  95 /* Limit the depth of the fetch if not null */
  96 #define TRANS_OPT_DEPTH "depth"
  97
  98 /* Aggressively fetch annotated tags if possible */
  99 #define TRANS_OPT_FOLLOWTAGS "followtags"
 100
 101 /**
 102  * Returns 0 if the option was used, non-zero otherwise. Prints a
 103  * message to stderr if the option is not used.
 104  **/
 105 int transport_set_option(struct transport *transport, const char *name,
 106                          const char *value);
 107
 108 int transport_push(struct transport *connection,
 109                    int refspec_nr, const char **refspec, int flags,
 110                    int * nonfastforward);
 111
 112 const struct ref *transport_get_remote_refs(struct transport *transport);
 113
 114 int transport_fetch_refs(struct transport *transport, struct ref *refs);
 115 void transport_unlock_pack(struct transport *transport);
 116 int transport_disconnect(struct transport *transport);
 117 char *transport_anonymize_url(const char *url);
 118
 119 /* Transport methods defined outside transport.c */
 120 int transport_helper_init(struct transport *transport, const char *name);
 121
 122 #endif