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
   9 struct string_list;
  10
  11 struct git_transport_options {
  12         unsigned thin : 1;
  13         unsigned keep : 1;
  14         unsigned followtags : 1;
  15         unsigned check_self_contained_and_connected : 1;
  16         unsigned self_contained_and_connected : 1;
  17         unsigned update_shallow : 1;
  18         unsigned deepen_relative : 1;
  19         unsigned from_promisor : 1;
  20         unsigned no_dependents : 1;
  21         int depth;
  22         const char *deepen_since;
  23         const struct string_list *deepen_not;
  24         const char *uploadpack;
  25         const char *receivepack;
  26         struct push_cas_option *cas;
  27         struct list_objects_filter_options filter_options;
  28 };
  29
  30 enum transport_family {
  31         TRANSPORT_FAMILY_ALL = 0,
  32         TRANSPORT_FAMILY_IPV4,
  33         TRANSPORT_FAMILY_IPV6
  34 };
  35
  36 struct transport {
  37         struct remote *remote;
  38         const char *url;
  39         void *data;
  40         const struct ref *remote_refs;
  41
  42         /**
  43          * Indicates whether we already called get_refs_list(); set by
  44          * transport.c::transport_get_remote_refs().
  45          */
  46         unsigned got_remote_refs : 1;
  47
  48         /*
  49          * Transports that call take-over destroys the data specific to
  50          * the transport type while doing so, and cannot be reused.
  51          */
  52         unsigned cannot_reuse : 1;
  53
  54         /*
  55          * A hint from caller that it will be performing a clone, not
  56          * normal fetch. IOW the repository is guaranteed empty.
  57          */
  58         unsigned cloning : 1;
  59
  60         /*
  61          * These strings will be passed to the {pre, post}-receive hook,
  62          * on the remote side, if both sides support the push options capability.
  63          */
  64         const struct string_list *push_options;
  65
  66         /**
  67          * Returns 0 if successful, positive if the option is not
  68          * recognized or is inapplicable, and negative if the option
  69          * is applicable but the value is invalid.
  70          **/
  71         int (*set_option)(struct transport *connection, const char *name,
  72                           const char *value);
  73
  74         /**
  75          * Returns a list of the remote side's refs. In order to allow
  76          * the transport to try to share connections, for_push is a
  77          * hint as to whether the ultimate operation is a push or a fetch.
  78          *
  79          * If the transport is able to determine the remote hash for
  80          * the ref without a huge amount of effort, it should store it
  81          * in the ref's old_sha1 field; otherwise it should be all 0.
  82          **/
  83         struct ref *(*get_refs_list)(struct transport *transport, int for_push);
  84
  85         /**
  86          * Fetch the objects for the given refs. Note that this gets
  87          * an array, and should ignore the list structure.
  88          *
  89          * If the transport did not get hashes for refs in
  90          * get_refs_list(), it should set the old_sha1 fields in the
  91          * provided refs now.
  92          **/
  93         int (*fetch)(struct transport *transport, int refs_nr, struct ref **refs);
  94
  95         /**
  96          * Push the objects and refs. Send the necessary objects, and
  97          * then, for any refs where peer_ref is set and
  98          * peer_ref->new_oid is different from old_oid, tell the
  99          * remote side to update each ref in the list from old_oid to
 100          * peer_ref->new_oid.
 101          *
 102          * Where possible, set the status for each ref appropriately.
 103          *
 104          * The transport must modify new_sha1 in the ref to the new
 105          * value if the remote accepted the change. Note that this
 106          * could be a different value from peer_ref->new_oid if the
 107          * process involved generating new commits.
 108          **/
 109         int (*push_refs)(struct transport *transport, struct ref *refs, int flags);
 110         int (*push)(struct transport *connection, int refspec_nr, const char **refspec, int flags);
 111         int (*connect)(struct transport *connection, const char *name,
 112                        const char *executable, int fd[2]);
 113
 114         /** get_refs_list(), fetch(), and push_refs() can keep
 115          * resources (such as a connection) reserved for further
 116          * use. disconnect() releases these resources.
 117          **/
 118         int (*disconnect)(struct transport *connection);
 119         char *pack_lockfile;
 120         signed verbose : 3;
 121         /**
 122          * Transports should not set this directly, and should use this
 123          * value without having to check isatty(2), -q/--quiet
 124          * (transport->verbose < 0), etc. - checking has already been done
 125          * in transport_set_verbosity().
 126          **/
 127         unsigned progress : 1;
 128         /*
 129          * If transport is at least potentially smart, this points to
 130          * git_transport_options structure to use in case transport
 131          * actually turns out to be smart.
 132          */
 133         struct git_transport_options *smart_options;
 134
 135         enum transport_family family;
 136 };
 137
 138 #define TRANSPORT_PUSH_ALL                      (1<<0)
 139 #define TRANSPORT_PUSH_FORCE                    (1<<1)
 140 #define TRANSPORT_PUSH_DRY_RUN                  (1<<2)
 141 #define TRANSPORT_PUSH_MIRROR                   (1<<3)
 142 #define TRANSPORT_PUSH_PORCELAIN                (1<<4)
 143 #define TRANSPORT_PUSH_SET_UPSTREAM             (1<<5)
 144 #define TRANSPORT_RECURSE_SUBMODULES_CHECK      (1<<6)
 145 #define TRANSPORT_PUSH_PRUNE                    (1<<7)
 146 #define TRANSPORT_RECURSE_SUBMODULES_ON_DEMAND  (1<<8)
 147 #define TRANSPORT_PUSH_NO_HOOK                  (1<<9)
 148 #define TRANSPORT_PUSH_FOLLOW_TAGS              (1<<10)
 149 #define TRANSPORT_PUSH_CERT_ALWAYS              (1<<11)
 150 #define TRANSPORT_PUSH_CERT_IF_ASKED            (1<<12)
 151 #define TRANSPORT_PUSH_ATOMIC                   (1<<13)
 152 #define TRANSPORT_PUSH_OPTIONS                  (1<<14)
 153 #define TRANSPORT_RECURSE_SUBMODULES_ONLY       (1<<15)
 154
 155 extern int transport_summary_width(const struct ref *refs);
 156
 157 /* Returns a transport suitable for the url */
 158 struct transport *transport_get(struct remote *, const char *);
 159
 160 /*
 161  * Check whether a transport is allowed by the environment.
 162  *
 163  * Type should generally be the URL scheme, as described in
 164  * Documentation/git.txt
 165  *
 166  * from_user specifies if the transport was given by the user.  If unknown pass
 167  * a -1 to read from the environment to determine if the transport was given by
 168  * the user.
 169  *
 170  */
 171 int is_transport_allowed(const char *type, int from_user);
 172
 173 /*
 174  * Check whether a transport is allowed by the environment,
 175  * and die otherwise.
 176  */
 177 void transport_check_allowed(const char *type);
 178
 179 /* Transport options which apply to git:// and scp-style URLs */
 180
 181 /* The program to use on the remote side to send a pack */
 182 #define TRANS_OPT_UPLOADPACK "uploadpack"
 183
 184 /* The program to use on the remote side to receive a pack */
 185 #define TRANS_OPT_RECEIVEPACK "receivepack"
 186
 187 /* Transfer the data as a thin pack if not null */
 188 #define TRANS_OPT_THIN "thin"
 189
 190 /* Check the current value of the remote ref */
 191 #define TRANS_OPT_CAS "cas"
 192
 193 /* Keep the pack that was transferred if not null */
 194 #define TRANS_OPT_KEEP "keep"
 195
 196 /* Limit the depth of the fetch if not null */
 197 #define TRANS_OPT_DEPTH "depth"
 198
 199 /* Limit the depth of the fetch based on time if not null */
 200 #define TRANS_OPT_DEEPEN_SINCE "deepen-since"
 201
 202 /* Limit the depth of the fetch based on revs if not null */
 203 #define TRANS_OPT_DEEPEN_NOT "deepen-not"
 204
 205 /* Limit the deepen of the fetch if not null */
 206 #define TRANS_OPT_DEEPEN_RELATIVE "deepen-relative"
 207
 208 /* Aggressively fetch annotated tags if possible */
 209 #define TRANS_OPT_FOLLOWTAGS "followtags"
 210
 211 /* Accept refs that may update .git/shallow without --depth */
 212 #define TRANS_OPT_UPDATE_SHALLOW "updateshallow"
 213
 214 /* Send push certificates */
 215 #define TRANS_OPT_PUSH_CERT "pushcert"
 216
 217 /* Indicate that these objects are being fetched by a promisor */
 218 #define TRANS_OPT_FROM_PROMISOR "from-promisor"
 219
 220 /*
 221  * Indicate that only the objects wanted need to be fetched, not their
 222  * dependents
 223  */
 224 #define TRANS_OPT_NO_DEPENDENTS "no-dependents"
 225
 226 /* Filter objects for partial clone and fetch */
 227 #define TRANS_OPT_LIST_OBJECTS_FILTER "filter"
 228
 229 /**
 230  * Returns 0 if the option was used, non-zero otherwise. Prints a
 231  * message to stderr if the option is not used.
 232  **/
 233 int transport_set_option(struct transport *transport, const char *name,
 234                          const char *value);
 235 void transport_set_verbosity(struct transport *transport, int verbosity,
 236         int force_progress);
 237
 238 #define REJECT_NON_FF_HEAD     0x01
 239 #define REJECT_NON_FF_OTHER    0x02
 240 #define REJECT_ALREADY_EXISTS  0x04
 241 #define REJECT_FETCH_FIRST     0x08
 242 #define REJECT_NEEDS_FORCE     0x10
 243
 244 int transport_push(struct transport *connection,
 245                    int refspec_nr, const char **refspec, int flags,
 246                    unsigned int * reject_reasons);
 247
 248 const struct ref *transport_get_remote_refs(struct transport *transport);
 249
 250 int transport_fetch_refs(struct transport *transport, struct ref *refs);
 251 void transport_unlock_pack(struct transport *transport);
 252 int transport_disconnect(struct transport *transport);
 253 char *transport_anonymize_url(const char *url);
 254 void transport_take_over(struct transport *transport,
 255                          struct child_process *child);
 256
 257 int transport_connect(struct transport *transport, const char *name,
 258                       const char *exec, int fd[2]);
 259
 260 /* Transport methods defined outside transport.c */
 261 int transport_helper_init(struct transport *transport, const char *name);
 262 int bidirectional_transfer_loop(int input, int output);
 263
 264 /* common methods used by transport.c and builtin/send-pack.c */
 265 void transport_verify_remote_names(int nr_heads, const char **heads);
 266
 267 void transport_update_tracking_ref(struct remote *remote, struct ref *ref, int verbose);
 268
 269 int transport_refs_pushed(struct ref *ref);
 270
 271 void transport_print_push_status(const char *dest, struct ref *refs,
 272                   int verbose, int porcelain, unsigned int *reject_reasons);
 273
 274 typedef void alternate_ref_fn(const char *refname, const struct object_id *oid, void *);
 275 extern void for_each_alternate_ref(alternate_ref_fn, void *);
 276 #endif