1#ifndef TRANSPORT_H 2#define TRANSPORT_H 3 4#include "cache.h" 5#include "remote.h" 6 7struct git_transport_options { 8 unsigned thin : 1; 9 unsigned keep : 1; 10 unsigned followtags : 1; 11 int depth; 12 const char *uploadpack; 13 const char *receivepack; 14}; 15 16struct transport { 17 struct remote *remote; 18 const char *url; 19 void *data; 20 const struct ref *remote_refs; 21 22 /** 23 * Indicates whether we already called get_refs_list(); set by 24 * transport.c::transport_get_remote_refs(). 25 */ 26 unsigned got_remote_refs : 1; 27 28 /** 29 * Returns 0 if successful, positive if the option is not 30 * recognized or is inapplicable, and negative if the option 31 * is applicable but the value is invalid. 32 **/ 33 int (*set_option)(struct transport *connection, const char *name, 34 const char *value); 35 36 /** 37 * Returns a list of the remote side's refs. In order to allow 38 * the transport to try to share connections, for_push is a 39 * hint as to whether the ultimate operation is a push or a fetch. 40 * 41 * If the transport is able to determine the remote hash for 42 * the ref without a huge amount of effort, it should store it 43 * in the ref's old_sha1 field; otherwise it should be all 0. 44 **/ 45 struct ref *(*get_refs_list)(struct transport *transport, int for_push); 46 47 /** 48 * Fetch the objects for the given refs. Note that this gets 49 * an array, and should ignore the list structure. 50 * 51 * If the transport did not get hashes for refs in 52 * get_refs_list(), it should set the old_sha1 fields in the 53 * provided refs now. 54 **/ 55 int (*fetch)(struct transport *transport, int refs_nr, struct ref **refs); 56 57 /** 58 * Push the objects and refs. Send the necessary objects, and 59 * then, for any refs where peer_ref is set and 60 * peer_ref->new_sha1 is different from old_sha1, tell the 61 * remote side to update each ref in the list from old_sha1 to 62 * peer_ref->new_sha1. 63 * 64 * Where possible, set the status for each ref appropriately. 65 * 66 * The transport must modify new_sha1 in the ref to the new 67 * value if the remote accepted the change. Note that this 68 * could be a different value from peer_ref->new_sha1 if the 69 * process involved generating new commits. 70 **/ 71 int (*push_refs)(struct transport *transport, struct ref *refs, int flags); 72 int (*push)(struct transport *connection, int refspec_nr, const char **refspec, int flags); 73 int (*connect)(struct transport *connection, const char *name, 74 const char *executable, int fd[2]); 75 76 /** get_refs_list(), fetch(), and push_refs() can keep 77 * resources (such as a connection) reserved for futher 78 * use. disconnect() releases these resources. 79 **/ 80 int (*disconnect)(struct transport *connection); 81 char *pack_lockfile; 82 signed verbose : 3; 83 /** 84 * Transports should not set this directly, and should use this 85 * value without having to check isatty(2), -q/--quiet 86 * (transport->verbose < 0), etc. - checking has already been done 87 * in transport_set_verbosity(). 88 **/ 89 unsigned progress : 1; 90 /* 91 * If transport is at least potentially smart, this points to 92 * git_transport_options structure to use in case transport 93 * actually turns out to be smart. 94 */ 95 struct git_transport_options *smart_options; 96}; 97 98#define TRANSPORT_PUSH_ALL 1 99#define TRANSPORT_PUSH_FORCE 2 100#define TRANSPORT_PUSH_DRY_RUN 4 101#define TRANSPORT_PUSH_MIRROR 8 102#define TRANSPORT_PUSH_PORCELAIN 16 103#define TRANSPORT_PUSH_SET_UPSTREAM 32 104#define TRANSPORT_RECURSE_SUBMODULES_CHECK 64 105#define TRANSPORT_PUSH_PRUNE 128 106#define TRANSPORT_RECURSE_SUBMODULES_ON_DEMAND 256 107 108#define TRANSPORT_SUMMARY_WIDTH (2 * DEFAULT_ABBREV + 3) 109#define TRANSPORT_SUMMARY(x) (int)(TRANSPORT_SUMMARY_WIDTH + strlen(x) - gettext_width(x)), (x) 110 111/* Returns a transport suitable for the url */ 112struct transport *transport_get(struct remote *, const char *); 113 114/* Transport options which apply to git:// and scp-style URLs */ 115 116/* The program to use on the remote side to send a pack */ 117#define TRANS_OPT_UPLOADPACK "uploadpack" 118 119/* The program to use on the remote side to receive a pack */ 120#define TRANS_OPT_RECEIVEPACK "receivepack" 121 122/* Transfer the data as a thin pack if not null */ 123#define TRANS_OPT_THIN "thin" 124 125/* Keep the pack that was transferred if not null */ 126#define TRANS_OPT_KEEP "keep" 127 128/* Limit the depth of the fetch if not null */ 129#define TRANS_OPT_DEPTH "depth" 130 131/* Aggressively fetch annotated tags if possible */ 132#define TRANS_OPT_FOLLOWTAGS "followtags" 133 134/** 135 * Returns 0 if the option was used, non-zero otherwise. Prints a 136 * message to stderr if the option is not used. 137 **/ 138int transport_set_option(struct transport *transport, const char *name, 139 const char *value); 140void transport_set_verbosity(struct transport *transport, int verbosity, 141 int force_progress); 142 143#define NON_FF_HEAD 1 144#define NON_FF_OTHER 2 145int transport_push(struct transport *connection, 146 int refspec_nr, const char **refspec, int flags, 147 int * nonfastforward); 148 149const struct ref *transport_get_remote_refs(struct transport *transport); 150 151int transport_fetch_refs(struct transport *transport, struct ref *refs); 152void transport_unlock_pack(struct transport *transport); 153int transport_disconnect(struct transport *transport); 154char *transport_anonymize_url(const char *url); 155void transport_take_over(struct transport *transport, 156 struct child_process *child); 157 158int transport_connect(struct transport *transport, const char *name, 159 const char *exec, int fd[2]); 160 161/* Transport methods defined outside transport.c */ 162int transport_helper_init(struct transport *transport, const char *name); 163int bidirectional_transfer_loop(int input, int output); 164 165/* common methods used by transport.c and builtin-send-pack.c */ 166void transport_verify_remote_names(int nr_heads, const char **heads); 167 168void transport_update_tracking_ref(struct remote *remote, struct ref *ref, int verbose); 169 170int transport_refs_pushed(struct ref *ref); 171 172void transport_print_push_status(const char *dest, struct ref *refs, 173 int verbose, int porcelain, int *nonfastforward); 174 175typedef void alternate_ref_fn(const struct ref *, void *); 176extern void for_each_alternate_ref(alternate_ref_fn, void *); 177 178#endif