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