The eighth batch
[git.git] / transport.h
blob4d5db0a7f22b366db870f9b421e41d1bba5a339c
1 #ifndef TRANSPORT_H
2 #define TRANSPORT_H
4 #include "cache.h"
5 #include "run-command.h"
6 #include "remote.h"
7 #include "list-objects-filter-options.h"
8 #include "string-list.h"
10 struct git_transport_options {
11 unsigned thin : 1;
12 unsigned keep : 1;
13 unsigned followtags : 1;
14 unsigned check_self_contained_and_connected : 1;
15 unsigned self_contained_and_connected : 1;
16 unsigned update_shallow : 1;
17 unsigned reject_shallow : 1;
18 unsigned deepen_relative : 1;
20 /* see documentation of corresponding flag in fetch-pack.h */
21 unsigned from_promisor : 1;
24 * If this transport supports connect or stateless-connect,
25 * the corresponding field in struct fetch_pack_args is copied
26 * here after fetching.
28 * See the definition of connectivity_checked in struct
29 * fetch_pack_args for more information.
31 unsigned connectivity_checked:1;
33 int depth;
34 const char *deepen_since;
35 const struct string_list *deepen_not;
36 const char *uploadpack;
37 const char *receivepack;
38 struct push_cas_option *cas;
39 struct list_objects_filter_options filter_options;
42 * This is only used during fetch. See the documentation of
43 * negotiation_tips in struct fetch_pack_args.
45 * This field is only supported by transports that support connect or
46 * stateless_connect. Set this field directly instead of using
47 * transport_set_option().
49 struct oid_array *negotiation_tips;
52 enum transport_family {
53 TRANSPORT_FAMILY_ALL = 0,
54 TRANSPORT_FAMILY_IPV4,
55 TRANSPORT_FAMILY_IPV6
58 struct transport {
59 const struct transport_vtable *vtable;
61 struct remote *remote;
62 const char *url;
63 void *data;
64 const struct ref *remote_refs;
66 /**
67 * Indicates whether we already called get_refs_list(); set by
68 * transport.c::transport_get_remote_refs().
70 unsigned got_remote_refs : 1;
73 * Transports that call take-over destroys the data specific to
74 * the transport type while doing so, and cannot be reused.
76 unsigned cannot_reuse : 1;
79 * A hint from caller that it will be performing a clone, not
80 * normal fetch. IOW the repository is guaranteed empty.
82 unsigned cloning : 1;
85 * Indicates that the transport is connected via a half-duplex
86 * connection and should operate in stateless-rpc mode.
88 unsigned stateless_rpc : 1;
91 * These strings will be passed to the {pre, post}-receive hook,
92 * on the remote side, if both sides support the push options capability.
94 const struct string_list *push_options;
97 * These strings will be passed to the remote side on each command
98 * request, if both sides support the server-option capability.
100 const struct string_list *server_options;
102 struct string_list pack_lockfiles;
104 signed verbose : 3;
106 * Transports should not set this directly, and should use this
107 * value without having to check isatty(2), -q/--quiet
108 * (transport->verbose < 0), etc. - checking has already been done
109 * in transport_set_verbosity().
111 unsigned progress : 1;
113 * If transport is at least potentially smart, this points to
114 * git_transport_options structure to use in case transport
115 * actually turns out to be smart.
117 struct git_transport_options *smart_options;
119 enum transport_family family;
121 const struct git_hash_algo *hash_algo;
124 #define TRANSPORT_PUSH_ALL (1<<0)
125 #define TRANSPORT_PUSH_FORCE (1<<1)
126 #define TRANSPORT_PUSH_DRY_RUN (1<<2)
127 #define TRANSPORT_PUSH_MIRROR (1<<3)
128 #define TRANSPORT_PUSH_PORCELAIN (1<<4)
129 #define TRANSPORT_PUSH_SET_UPSTREAM (1<<5)
130 #define TRANSPORT_RECURSE_SUBMODULES_CHECK (1<<6)
131 #define TRANSPORT_PUSH_PRUNE (1<<7)
132 #define TRANSPORT_RECURSE_SUBMODULES_ON_DEMAND (1<<8)
133 #define TRANSPORT_PUSH_NO_HOOK (1<<9)
134 #define TRANSPORT_PUSH_FOLLOW_TAGS (1<<10)
135 #define TRANSPORT_PUSH_CERT_ALWAYS (1<<11)
136 #define TRANSPORT_PUSH_CERT_IF_ASKED (1<<12)
137 #define TRANSPORT_PUSH_ATOMIC (1<<13)
138 #define TRANSPORT_PUSH_OPTIONS (1<<14)
139 #define TRANSPORT_RECURSE_SUBMODULES_ONLY (1<<15)
140 #define TRANSPORT_PUSH_FORCE_IF_INCLUDES (1<<16)
142 int transport_summary_width(const struct ref *refs);
144 /* Returns a transport suitable for the url */
145 struct transport *transport_get(struct remote *, const char *);
148 * Check whether a transport is allowed by the environment.
150 * Type should generally be the URL scheme, as described in
151 * Documentation/git.txt
153 * from_user specifies if the transport was given by the user. If unknown pass
154 * a -1 to read from the environment to determine if the transport was given by
155 * the user.
158 int is_transport_allowed(const char *type, int from_user);
161 * Check whether a transport is allowed by the environment,
162 * and die otherwise.
164 void transport_check_allowed(const char *type);
166 /* Transport options which apply to git:// and scp-style URLs */
168 /* The program to use on the remote side to send a pack */
169 #define TRANS_OPT_UPLOADPACK "uploadpack"
171 /* The program to use on the remote side to receive a pack */
172 #define TRANS_OPT_RECEIVEPACK "receivepack"
174 /* Transfer the data as a thin pack if not null */
175 #define TRANS_OPT_THIN "thin"
177 /* Check the current value of the remote ref */
178 #define TRANS_OPT_CAS "cas"
180 /* Keep the pack that was transferred if not null */
181 #define TRANS_OPT_KEEP "keep"
183 /* Limit the depth of the fetch if not null */
184 #define TRANS_OPT_DEPTH "depth"
186 /* Limit the depth of the fetch based on time if not null */
187 #define TRANS_OPT_DEEPEN_SINCE "deepen-since"
189 /* Limit the depth of the fetch based on revs if not null */
190 #define TRANS_OPT_DEEPEN_NOT "deepen-not"
192 /* Limit the deepen of the fetch if not null */
193 #define TRANS_OPT_DEEPEN_RELATIVE "deepen-relative"
195 /* Aggressively fetch annotated tags if possible */
196 #define TRANS_OPT_FOLLOWTAGS "followtags"
198 /* Reject shallow repo transport */
199 #define TRANS_OPT_REJECT_SHALLOW "rejectshallow"
201 /* Accept refs that may update .git/shallow without --depth */
202 #define TRANS_OPT_UPDATE_SHALLOW "updateshallow"
204 /* Send push certificates */
205 #define TRANS_OPT_PUSH_CERT "pushcert"
207 /* Indicate that these objects are being fetched by a promisor */
208 #define TRANS_OPT_FROM_PROMISOR "from-promisor"
210 /* Filter objects for partial clone and fetch */
211 #define TRANS_OPT_LIST_OBJECTS_FILTER "filter"
213 /* Request atomic (all-or-nothing) updates when pushing */
214 #define TRANS_OPT_ATOMIC "atomic"
216 /* Require remote changes to be integrated locally. */
217 #define TRANS_OPT_FORCE_IF_INCLUDES "force-if-includes"
220 * Returns 0 if the option was used, non-zero otherwise. Prints a
221 * message to stderr if the option is not used.
223 int transport_set_option(struct transport *transport, const char *name,
224 const char *value);
225 void transport_set_verbosity(struct transport *transport, int verbosity,
226 int force_progress);
228 #define REJECT_NON_FF_HEAD 0x01
229 #define REJECT_NON_FF_OTHER 0x02
230 #define REJECT_ALREADY_EXISTS 0x04
231 #define REJECT_FETCH_FIRST 0x08
232 #define REJECT_NEEDS_FORCE 0x10
233 #define REJECT_REF_NEEDS_UPDATE 0x20
235 int transport_push(struct repository *repo,
236 struct transport *connection,
237 struct refspec *rs, int flags,
238 unsigned int * reject_reasons);
240 struct transport_ls_refs_options {
242 * Optionally, a list of ref prefixes can be provided which can be sent
243 * to the server (when communicating using protocol v2) to enable it to
244 * limit the ref advertisement. Since ref filtering is done on the
245 * server's end (and only when using protocol v2),
246 * transport_get_remote_refs() could return refs which don't match the
247 * provided ref_prefixes.
249 struct strvec ref_prefixes;
252 * If unborn_head_target is not NULL, and the remote reports HEAD as
253 * pointing to an unborn branch, transport_get_remote_refs() stores the
254 * unborn branch in unborn_head_target. It should be freed by the
255 * caller.
257 char *unborn_head_target;
259 #define TRANSPORT_LS_REFS_OPTIONS_INIT { STRVEC_INIT }
262 * Retrieve refs from a remote.
264 const struct ref *transport_get_remote_refs(struct transport *transport,
265 struct transport_ls_refs_options *transport_options);
268 * Fetch the hash algorithm used by a remote.
270 * This can only be called after fetching the remote refs.
272 const struct git_hash_algo *transport_get_hash_algo(struct transport *transport);
273 int transport_fetch_refs(struct transport *transport, struct ref *refs);
274 void transport_unlock_pack(struct transport *transport);
275 int transport_disconnect(struct transport *transport);
276 char *transport_anonymize_url(const char *url);
277 void transport_take_over(struct transport *transport,
278 struct child_process *child);
280 int transport_connect(struct transport *transport, const char *name,
281 const char *exec, int fd[2]);
283 /* Transport methods defined outside transport.c */
284 int transport_helper_init(struct transport *transport, const char *name);
285 int bidirectional_transfer_loop(int input, int output);
287 /* common methods used by transport.c and builtin/send-pack.c */
288 void transport_update_tracking_ref(struct remote *remote, struct ref *ref, int verbose);
290 int transport_refs_pushed(struct ref *ref);
292 void transport_print_push_status(const char *dest, struct ref *refs,
293 int verbose, int porcelain, unsigned int *reject_reasons);
295 /* common method used by transport-helper.c and send-pack.c */
296 void reject_atomic_push(struct ref *refs, int mirror_mode);
298 #endif