transport.h

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