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