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