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 #include "list-objects-filter-options.h"
   8 #include "string-list.h"
   9
  10 struct git_transport_options {
  11         unsigned thin : 1;
  12         unsigned keep : 1;
  13         unsigned followtags : 1;
  14         unsigned check_self_contained_and_connected : 1;
  15         unsigned self_contained_and_connected : 1;
  16         unsigned update_shallow : 1;
  17         unsigned deepen_relative : 1;
  18
  19         /* see documentation of corresponding flag in fetch-pack.h */
  20         unsigned from_promisor : 1;
  21
  22         /*
  23          * If this transport supports connect or stateless-connect,
  24          * the corresponding field in struct fetch_pack_args is copied
  25          * here after fetching.
  26          *
  27          * See the definition of connectivity_checked in struct
  28          * fetch_pack_args for more information.
  29          */
  30         unsigned connectivity_checked:1;
  31
  32         int depth;
  33         const char *deepen_since;
  34         const struct string_list *deepen_not;
  35         const char *uploadpack;
  36         const char *receivepack;
  37         struct push_cas_option *cas;
  38         struct list_objects_filter_options filter_options;
  39
  40         /*
  41          * This is only used during fetch. See the documentation of
  42          * negotiation_tips in struct fetch_pack_args.
  43          *
  44          * This field is only supported by transports that support connect or
  45          * stateless_connect. Set this field directly instead of using
  46          * transport_set_option().
  47          */
  48         struct oid_array *negotiation_tips;
  49 };
  50
  51 enum transport_family {
  52         TRANSPORT_FAMILY_ALL = 0,
  53         TRANSPORT_FAMILY_IPV4,
  54         TRANSPORT_FAMILY_IPV6
  55 };
  56
  57 struct transport {
  58         const struct transport_vtable *vtable;
  59
  60         struct remote *remote;
  61         const char *url;
  62         void *data;
  63         const struct ref *remote_refs;
  64
  65         /**
  66          * Indicates whether we already called get_refs_list(); set by
  67          * transport.c::transport_get_remote_refs().
  68          */
  69         unsigned got_remote_refs : 1;
  70
  71         /*
  72          * Transports that call take-over destroys the data specific to
  73          * the transport type while doing so, and cannot be reused.
  74          */
  75         unsigned cannot_reuse : 1;
  76
  77         /*
  78          * A hint from caller that it will be performing a clone, not
  79          * normal fetch. IOW the repository is guaranteed empty.
  80          */
  81         unsigned cloning : 1;
  82
  83         /*
  84          * Indicates that the transport is connected via a half-duplex
  85          * connection and should operate in stateless-rpc mode.
  86          */
  87         unsigned stateless_rpc : 1;
  88
  89         /*
  90          * These strings will be passed to the {pre, post}-receive hook,
  91          * on the remote side, if both sides support the push options capability.
  92          */
  93         const struct string_list *push_options;
  94
  95         /*
  96          * These strings will be passed to the remote side on each command
  97          * request, if both sides support the server-option capability.
  98          */
  99         const struct string_list *server_options;
 100
 101         struct string_list pack_lockfiles;
 102
 103         signed verbose : 3;
 104         /**
 105          * Transports should not set this directly, and should use this
 106          * value without having to check isatty(2), -q/--quiet
 107          * (transport->verbose < 0), etc. - checking has already been done
 108          * in transport_set_verbosity().
 109          **/
 110         unsigned progress : 1;
 111         /*
 112          * If transport is at least potentially smart, this points to
 113          * git_transport_options structure to use in case transport
 114          * actually turns out to be smart.
 115          */
 116         struct git_transport_options *smart_options;
 117
 118         enum transport_family family;
 119
 120         const struct git_hash_algo *hash_algo;
 121 };
 122
 123 #define TRANSPORT_PUSH_ALL                      (1<<0)
 124 #define TRANSPORT_PUSH_FORCE                    (1<<1)
 125 #define TRANSPORT_PUSH_DRY_RUN                  (1<<2)
 126 #define TRANSPORT_PUSH_MIRROR                   (1<<3)
 127 #define TRANSPORT_PUSH_PORCELAIN                (1<<4)
 128 #define TRANSPORT_PUSH_SET_UPSTREAM             (1<<5)
 129 #define TRANSPORT_RECURSE_SUBMODULES_CHECK      (1<<6)
 130 #define TRANSPORT_PUSH_PRUNE                    (1<<7)
 131 #define TRANSPORT_RECURSE_SUBMODULES_ON_DEMAND  (1<<8)
 132 #define TRANSPORT_PUSH_NO_HOOK                  (1<<9)
 133 #define TRANSPORT_PUSH_FOLLOW_TAGS              (1<<10)
 134 #define TRANSPORT_PUSH_CERT_ALWAYS              (1<<11)
 135 #define TRANSPORT_PUSH_CERT_IF_ASKED            (1<<12)
 136 #define TRANSPORT_PUSH_ATOMIC                   (1<<13)
 137 #define TRANSPORT_PUSH_OPTIONS                  (1<<14)
 138 #define TRANSPORT_RECURSE_SUBMODULES_ONLY       (1<<15)
 139
 140 int transport_summary_width(const struct ref *refs);
 141
 142 /* Returns a transport suitable for the url */
 143 struct transport *transport_get(struct remote *, const char *);
 144
 145 /*
 146  * Check whether a transport is allowed by the environment.
 147  *
 148  * Type should generally be the URL scheme, as described in
 149  * Documentation/git.txt
 150  *
 151  * from_user specifies if the transport was given by the user.  If unknown pass
 152  * a -1 to read from the environment to determine if the transport was given by
 153  * the user.
 154  *
 155  */
 156 int is_transport_allowed(const char *type, int from_user);
 157
 158 /*
 159  * Check whether a transport is allowed by the environment,
 160  * and die otherwise.
 161  */
 162 void transport_check_allowed(const char *type);
 163
 164 /* Transport options which apply to git:// and scp-style URLs */
 165
 166 /* The program to use on the remote side to send a pack */
 167 #define TRANS_OPT_UPLOADPACK "uploadpack"
 168
 169 /* The program to use on the remote side to receive a pack */
 170 #define TRANS_OPT_RECEIVEPACK "receivepack"
 171
 172 /* Transfer the data as a thin pack if not null */
 173 #define TRANS_OPT_THIN "thin"
 174
 175 /* Check the current value of the remote ref */
 176 #define TRANS_OPT_CAS "cas"
 177
 178 /* Keep the pack that was transferred if not null */
 179 #define TRANS_OPT_KEEP "keep"
 180
 181 /* Limit the depth of the fetch if not null */
 182 #define TRANS_OPT_DEPTH "depth"
 183
 184 /* Limit the depth of the fetch based on time if not null */
 185 #define TRANS_OPT_DEEPEN_SINCE "deepen-since"
 186
 187 /* Limit the depth of the fetch based on revs if not null */
 188 #define TRANS_OPT_DEEPEN_NOT "deepen-not"
 189
 190 /* Limit the deepen of the fetch if not null */
 191 #define TRANS_OPT_DEEPEN_RELATIVE "deepen-relative"
 192
 193 /* Aggressively fetch annotated tags if possible */
 194 #define TRANS_OPT_FOLLOWTAGS "followtags"
 195
 196 /* Accept refs that may update .git/shallow without --depth */
 197 #define TRANS_OPT_UPDATE_SHALLOW "updateshallow"
 198
 199 /* Send push certificates */
 200 #define TRANS_OPT_PUSH_CERT "pushcert"
 201
 202 /* Indicate that these objects are being fetched by a promisor */
 203 #define TRANS_OPT_FROM_PROMISOR "from-promisor"
 204
 205 /* Filter objects for partial clone and fetch */
 206 #define TRANS_OPT_LIST_OBJECTS_FILTER "filter"
 207
 208 /* Request atomic (all-or-nothing) updates when pushing */
 209 #define TRANS_OPT_ATOMIC "atomic"
 210
 211 /**
 212  * Returns 0 if the option was used, non-zero otherwise. Prints a
 213  * message to stderr if the option is not used.
 214  **/
 215 int transport_set_option(struct transport *transport, const char *name,
 216                          const char *value);
 217 void transport_set_verbosity(struct transport *transport, int verbosity,
 218         int force_progress);
 219
 220 #define REJECT_NON_FF_HEAD     0x01
 221 #define REJECT_NON_FF_OTHER    0x02
 222 #define REJECT_ALREADY_EXISTS  0x04
 223 #define REJECT_FETCH_FIRST     0x08
 224 #define REJECT_NEEDS_FORCE     0x10
 225
 226 int transport_push(struct repository *repo,
 227                    struct transport *connection,
 228                    struct refspec *rs, int flags,
 229                    unsigned int * reject_reasons);
 230
 231 /*
 232  * Retrieve refs from a remote.
 233  *
 234  * Optionally a list of ref prefixes can be provided which can be sent to the
 235  * server (when communicating using protocol v2) to enable it to limit the ref
 236  * advertisement.  Since ref filtering is done on the server's end (and only
 237  * when using protocol v2), this can return refs which don't match the provided
 238  * ref_prefixes.
 239  */
 240 const struct ref *transport_get_remote_refs(struct transport *transport,
 241                                             const struct strvec *ref_prefixes);
 242
 243 /*
 244  * Fetch the hash algorithm used by a remote.
 245  *
 246  * This can only be called after fetching the remote refs.
 247  */
 248 const struct git_hash_algo *transport_get_hash_algo(struct transport *transport);
 249 int transport_fetch_refs(struct transport *transport, struct ref *refs);
 250 void transport_unlock_pack(struct transport *transport);
 251 int transport_disconnect(struct transport *transport);
 252 char *transport_anonymize_url(const char *url);
 253 void transport_take_over(struct transport *transport,
 254                          struct child_process *child);
 255
 256 int transport_connect(struct transport *transport, const char *name,
 257                       const char *exec, int fd[2]);
 258
 259 /* Transport methods defined outside transport.c */
 260 int transport_helper_init(struct transport *transport, const char *name);
 261 int bidirectional_transfer_loop(int input, int output);
 262
 263 /* common methods used by transport.c and builtin/send-pack.c */
 264 void transport_update_tracking_ref(struct remote *remote, struct ref *ref, int verbose);
 265
 266 int transport_refs_pushed(struct ref *ref);
 267
 268 void transport_print_push_status(const char *dest, struct ref *refs,
 269                   int verbose, int porcelain, unsigned int *reject_reasons);
 270
 271 /* common method used by transport-helper.c and send-pack.c */
 272 void reject_atomic_push(struct ref *refs, int mirror_mode);
 273
 274 #endif