transport.h

   1 #ifndef TRANSPORT_H
   2 #define TRANSPORT_H
   3
   4 #include "cache.h"
   5 #include "run-command.h"
   6 #include "remote.h"
   7
   8 struct git_transport_options {
   9         unsigned thin : 1;
  10         unsigned keep : 1;
  11         unsigned followtags : 1;
  12         unsigned check_self_contained_and_connected : 1;
  13         unsigned self_contained_and_connected : 1;
  14         unsigned update_shallow : 1;
  15         unsigned push_cert : 1;
  16         int depth;
  17         const char *uploadpack;
  18         const char *receivepack;
  19         struct push_cas_option *cas;
  20 };
  21
  22 struct transport {
  23         struct remote *remote;
  24         const char *url;
  25         void *data;
  26         const struct ref *remote_refs;
  27
  28         /**
  29          * Indicates whether we already called get_refs_list(); set by
  30          * transport.c::transport_get_remote_refs().
  31          */
  32         unsigned got_remote_refs : 1;
  33
  34         /*
  35          * Transports that call take-over destroys the data specific to
  36          * the transport type while doing so, and cannot be reused.
  37          */
  38         unsigned cannot_reuse : 1;
  39
  40         /*
  41          * A hint from caller that it will be performing a clone, not
  42          * normal fetch. IOW the repository is guaranteed empty.
  43          */
  44         unsigned cloning : 1;
  45
  46         /**
  47          * Returns 0 if successful, positive if the option is not
  48          * recognized or is inapplicable, and negative if the option
  49          * is applicable but the value is invalid.
  50          **/
  51         int (*set_option)(struct transport *connection, const char *name,
  52                           const char *value);
  53
  54         /**
  55          * Returns a list of the remote side's refs. In order to allow
  56          * the transport to try to share connections, for_push is a
  57          * hint as to whether the ultimate operation is a push or a fetch.
  58          *
  59          * If the transport is able to determine the remote hash for
  60          * the ref without a huge amount of effort, it should store it
  61          * in the ref's old_sha1 field; otherwise it should be all 0.
  62          **/
  63         struct ref *(*get_refs_list)(struct transport *transport, int for_push);
  64
  65         /**
  66          * Fetch the objects for the given refs. Note that this gets
  67          * an array, and should ignore the list structure.
  68          *
  69          * If the transport did not get hashes for refs in
  70          * get_refs_list(), it should set the old_sha1 fields in the
  71          * provided refs now.
  72          **/
  73         int (*fetch)(struct transport *transport, int refs_nr, struct ref **refs);
  74
  75         /**
  76          * Push the objects and refs. Send the necessary objects, and
  77          * then, for any refs where peer_ref is set and
  78          * peer_ref->new_sha1 is different from old_sha1, tell the
  79          * remote side to update each ref in the list from old_sha1 to
  80          * peer_ref->new_sha1.
  81          *
  82          * Where possible, set the status for each ref appropriately.
  83          *
  84          * The transport must modify new_sha1 in the ref to the new
  85          * value if the remote accepted the change. Note that this
  86          * could be a different value from peer_ref->new_sha1 if the
  87          * process involved generating new commits.
  88          **/
  89         int (*push_refs)(struct transport *transport, struct ref *refs, int flags);
  90         int (*push)(struct transport *connection, int refspec_nr, const char **refspec, int flags);
  91         int (*connect)(struct transport *connection, const char *name,
  92                        const char *executable, int fd[2]);
  93
  94         /** get_refs_list(), fetch(), and push_refs() can keep
  95          * resources (such as a connection) reserved for further
  96          * use. disconnect() releases these resources.
  97          **/
  98         int (*disconnect)(struct transport *connection);
  99         char *pack_lockfile;
 100         signed verbose : 3;
 101         /**
 102          * Transports should not set this directly, and should use this
 103          * value without having to check isatty(2), -q/--quiet
 104          * (transport->verbose < 0), etc. - checking has already been done
 105          * in transport_set_verbosity().
 106          **/
 107         unsigned progress : 1;
 108         /*
 109          * If transport is at least potentially smart, this points to
 110          * git_transport_options structure to use in case transport
 111          * actually turns out to be smart.
 112          */
 113         struct git_transport_options *smart_options;
 114 };
 115
 116 #define TRANSPORT_PUSH_ALL 1
 117 #define TRANSPORT_PUSH_FORCE 2
 118 #define TRANSPORT_PUSH_DRY_RUN 4
 119 #define TRANSPORT_PUSH_MIRROR 8
 120 #define TRANSPORT_PUSH_PORCELAIN 16
 121 #define TRANSPORT_PUSH_SET_UPSTREAM 32
 122 #define TRANSPORT_RECURSE_SUBMODULES_CHECK 64
 123 #define TRANSPORT_PUSH_PRUNE 128
 124 #define TRANSPORT_RECURSE_SUBMODULES_ON_DEMAND 256
 125 #define TRANSPORT_PUSH_NO_HOOK 512
 126 #define TRANSPORT_PUSH_FOLLOW_TAGS 1024
 127 #define TRANSPORT_PUSH_CERT 2048
 128
 129 #define TRANSPORT_SUMMARY_WIDTH (2 * DEFAULT_ABBREV + 3)
 130 #define TRANSPORT_SUMMARY(x) (int)(TRANSPORT_SUMMARY_WIDTH + strlen(x) - gettext_width(x)), (x)
 131
 132 /* Returns a transport suitable for the url */
 133 struct transport *transport_get(struct remote *, const char *);
 134
 135 /* Transport options which apply to git:// and scp-style URLs */
 136
 137 /* The program to use on the remote side to send a pack */
 138 #define TRANS_OPT_UPLOADPACK "uploadpack"
 139
 140 /* The program to use on the remote side to receive a pack */
 141 #define TRANS_OPT_RECEIVEPACK "receivepack"
 142
 143 /* Transfer the data as a thin pack if not null */
 144 #define TRANS_OPT_THIN "thin"
 145
 146 /* Check the current value of the remote ref */
 147 #define TRANS_OPT_CAS "cas"
 148
 149 /* Keep the pack that was transferred if not null */
 150 #define TRANS_OPT_KEEP "keep"
 151
 152 /* Limit the depth of the fetch if not null */
 153 #define TRANS_OPT_DEPTH "depth"
 154
 155 /* Aggressively fetch annotated tags if possible */
 156 #define TRANS_OPT_FOLLOWTAGS "followtags"
 157
 158 /* Accept refs that may update .git/shallow without --depth */
 159 #define TRANS_OPT_UPDATE_SHALLOW "updateshallow"
 160
 161 /* Send push certificates */
 162 #define TRANS_OPT_PUSH_CERT "pushcert"
 163
 164 /**
 165  * Returns 0 if the option was used, non-zero otherwise. Prints a
 166  * message to stderr if the option is not used.
 167  **/
 168 int transport_set_option(struct transport *transport, const char *name,
 169                          const char *value);
 170 void transport_set_verbosity(struct transport *transport, int verbosity,
 171         int force_progress);
 172
 173 #define REJECT_NON_FF_HEAD     0x01
 174 #define REJECT_NON_FF_OTHER    0x02
 175 #define REJECT_ALREADY_EXISTS  0x04
 176 #define REJECT_FETCH_FIRST     0x08
 177 #define REJECT_NEEDS_FORCE     0x10
 178
 179 int transport_push(struct transport *connection,
 180                    int refspec_nr, const char **refspec, int flags,
 181                    unsigned int * reject_reasons);
 182
 183 const struct ref *transport_get_remote_refs(struct transport *transport);
 184
 185 int transport_fetch_refs(struct transport *transport, struct ref *refs);
 186 void transport_unlock_pack(struct transport *transport);
 187 int transport_disconnect(struct transport *transport);
 188 char *transport_anonymize_url(const char *url);
 189 void transport_take_over(struct transport *transport,
 190                          struct child_process *child);
 191
 192 int transport_connect(struct transport *transport, const char *name,
 193                       const char *exec, int fd[2]);
 194
 195 /* Transport methods defined outside transport.c */
 196 int transport_helper_init(struct transport *transport, const char *name);
 197 int bidirectional_transfer_loop(int input, int output);
 198
 199 /* common methods used by transport.c and builtin/send-pack.c */
 200 void transport_verify_remote_names(int nr_heads, const char **heads);
 201
 202 void transport_update_tracking_ref(struct remote *remote, struct ref *ref, int verbose);
 203
 204 int transport_refs_pushed(struct ref *ref);
 205
 206 void transport_print_push_status(const char *dest, struct ref *refs,
 207                   int verbose, int porcelain, unsigned int *reject_reasons);
 208
 209 typedef void alternate_ref_fn(const struct ref *, void *);
 210 extern void for_each_alternate_ref(alternate_ref_fn, void *);
 211 #endif