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