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