ls-remote: send server options when using protocol v2
[git/git.git] / transport.h
CommitLineData
9b288516
DB
1#ifndef TRANSPORT_H
2#define TRANSPORT_H
3
4#include "cache.h"
47a59185 5#include "run-command.h"
9b288516 6#include "remote.h"
640d8b72 7#include "list-objects-filter-options.h"
9b288516 8
a45a2600
NTND
9struct string_list;
10
aa5af974
IL
11struct git_transport_options {
12 unsigned thin : 1;
13 unsigned keep : 1;
14 unsigned followtags : 1;
c6807a40
NTND
15 unsigned check_self_contained_and_connected : 1;
16 unsigned self_contained_and_connected : 1;
48d25cae 17 unsigned update_shallow : 1;
cccf74e2 18 unsigned deepen_relative : 1;
88e2f9ed
JT
19 unsigned from_promisor : 1;
20 unsigned no_dependents : 1;
aa5af974 21 int depth;
508ea882 22 const char *deepen_since;
a45a2600 23 const struct string_list *deepen_not;
aa5af974
IL
24 const char *uploadpack;
25 const char *receivepack;
91048a95 26 struct push_cas_option *cas;
640d8b72 27 struct list_objects_filter_options filter_options;
aa5af974
IL
28};
29
c915f11e
EW
30enum transport_family {
31 TRANSPORT_FAMILY_ALL = 0,
32 TRANSPORT_FAMILY_IPV4,
33 TRANSPORT_FAMILY_IPV6
34};
35
9b288516 36struct transport {
e967ca38
JT
37 const struct transport_vtable *vtable;
38
9b288516
DB
39 struct remote *remote;
40 const char *url;
9b288516 41 void *data;
4577370e 42 const struct ref *remote_refs;
9b288516 43
b0d66e15
TRC
44 /**
45 * Indicates whether we already called get_refs_list(); set by
46 * transport.c::transport_get_remote_refs().
47 */
48 unsigned got_remote_refs : 1;
49
b26ed430
JH
50 /*
51 * Transports that call take-over destroys the data specific to
52 * the transport type while doing so, and cannot be reused.
53 */
54 unsigned cannot_reuse : 1;
55
beea4152
NTND
56 /*
57 * A hint from caller that it will be performing a clone, not
58 * normal fetch. IOW the repository is guaranteed empty.
59 */
60 unsigned cloning : 1;
61
edc9caf7
BW
62 /*
63 * Indicates that the transport is connected via a half-duplex
64 * connection and should operate in stateless-rpc mode.
65 */
66 unsigned stateless_rpc : 1;
67
f6a4e61f
SB
68 /*
69 * These strings will be passed to the {pre, post}-receive hook,
70 * on the remote side, if both sides support the push options capability.
71 */
72 const struct string_list *push_options;
73
ff473221
BW
74 /*
75 * These strings will be passed to the remote side on each command
76 * request, if both sides support the server-option capability.
77 */
78 const struct string_list *server_options;
79
824d5776 80 char *pack_lockfile;
cff7123c 81 signed verbose : 3;
d01b3c02
TRC
82 /**
83 * Transports should not set this directly, and should use this
84 * value without having to check isatty(2), -q/--quiet
85 * (transport->verbose < 0), etc. - checking has already been done
86 * in transport_set_verbosity().
87 **/
21188b1e 88 unsigned progress : 1;
aa5af974
IL
89 /*
90 * If transport is at least potentially smart, this points to
91 * git_transport_options structure to use in case transport
92 * actually turns out to be smart.
93 */
94 struct git_transport_options *smart_options;
c915f11e
EW
95
96 enum transport_family family;
9b288516
DB
97};
98
14c01bdb
BW
99#define TRANSPORT_PUSH_ALL (1<<0)
100#define TRANSPORT_PUSH_FORCE (1<<1)
101#define TRANSPORT_PUSH_DRY_RUN (1<<2)
102#define TRANSPORT_PUSH_MIRROR (1<<3)
103#define TRANSPORT_PUSH_PORCELAIN (1<<4)
104#define TRANSPORT_PUSH_SET_UPSTREAM (1<<5)
105#define TRANSPORT_RECURSE_SUBMODULES_CHECK (1<<6)
106#define TRANSPORT_PUSH_PRUNE (1<<7)
107#define TRANSPORT_RECURSE_SUBMODULES_ON_DEMAND (1<<8)
108#define TRANSPORT_PUSH_NO_HOOK (1<<9)
109#define TRANSPORT_PUSH_FOLLOW_TAGS (1<<10)
110#define TRANSPORT_PUSH_CERT_ALWAYS (1<<11)
111#define TRANSPORT_PUSH_CERT_IF_ASKED (1<<12)
112#define TRANSPORT_PUSH_ATOMIC (1<<13)
113#define TRANSPORT_PUSH_OPTIONS (1<<14)
225e8bf7 114#define TRANSPORT_RECURSE_SUBMODULES_ONLY (1<<15)
824d5776 115
11fd66de 116extern int transport_summary_width(const struct ref *refs);
824d5776 117
9b288516 118/* Returns a transport suitable for the url */
e5f4e214 119struct transport *transport_get(struct remote *, const char *);
9b288516 120
5088d3b3 121/*
a768a022
BW
122 * Check whether a transport is allowed by the environment.
123 *
124 * Type should generally be the URL scheme, as described in
125 * Documentation/git.txt
126 *
127 * from_user specifies if the transport was given by the user. If unknown pass
128 * a -1 to read from the environment to determine if the transport was given by
129 * the user.
130 *
5088d3b3 131 */
a768a022 132int is_transport_allowed(const char *type, int from_user);
5088d3b3 133
a5adaced
JK
134/*
135 * Check whether a transport is allowed by the environment,
5088d3b3 136 * and die otherwise.
a5adaced
JK
137 */
138void transport_check_allowed(const char *type);
139
9b288516
DB
140/* Transport options which apply to git:// and scp-style URLs */
141
c29727d5
DB
142/* The program to use on the remote side to send a pack */
143#define TRANS_OPT_UPLOADPACK "uploadpack"
144
9b288516
DB
145/* The program to use on the remote side to receive a pack */
146#define TRANS_OPT_RECEIVEPACK "receivepack"
147
148/* Transfer the data as a thin pack if not null */
149#define TRANS_OPT_THIN "thin"
150
91048a95
JH
151/* Check the current value of the remote ref */
152#define TRANS_OPT_CAS "cas"
153
c29727d5
DB
154/* Keep the pack that was transferred if not null */
155#define TRANS_OPT_KEEP "keep"
156
c29727d5
DB
157/* Limit the depth of the fetch if not null */
158#define TRANS_OPT_DEPTH "depth"
159
508ea882
NTND
160/* Limit the depth of the fetch based on time if not null */
161#define TRANS_OPT_DEEPEN_SINCE "deepen-since"
162
a45a2600
NTND
163/* Limit the depth of the fetch based on revs if not null */
164#define TRANS_OPT_DEEPEN_NOT "deepen-not"
165
cccf74e2
NTND
166/* Limit the deepen of the fetch if not null */
167#define TRANS_OPT_DEEPEN_RELATIVE "deepen-relative"
168
41fa7d2e
SP
169/* Aggressively fetch annotated tags if possible */
170#define TRANS_OPT_FOLLOWTAGS "followtags"
171
48d25cae
NTND
172/* Accept refs that may update .git/shallow without --depth */
173#define TRANS_OPT_UPDATE_SHALLOW "updateshallow"
174
a85b377d
JH
175/* Send push certificates */
176#define TRANS_OPT_PUSH_CERT "pushcert"
177
88e2f9ed
JT
178/* Indicate that these objects are being fetched by a promisor */
179#define TRANS_OPT_FROM_PROMISOR "from-promisor"
180
181/*
182 * Indicate that only the objects wanted need to be fetched, not their
183 * dependents
184 */
185#define TRANS_OPT_NO_DEPENDENTS "no-dependents"
186
640d8b72
JH
187/* Filter objects for partial clone and fetch */
188#define TRANS_OPT_LIST_OBJECTS_FILTER "filter"
189
9b288516
DB
190/**
191 * Returns 0 if the option was used, non-zero otherwise. Prints a
192 * message to stderr if the option is not used.
193 **/
194int transport_set_option(struct transport *transport, const char *name,
195 const char *value);
d01b3c02
TRC
196void transport_set_verbosity(struct transport *transport, int verbosity,
197 int force_progress);
9b288516 198
10643d4e
CR
199#define REJECT_NON_FF_HEAD 0x01
200#define REJECT_NON_FF_OTHER 0x02
b24e6047 201#define REJECT_ALREADY_EXISTS 0x04
75e5c0dc
JH
202#define REJECT_FETCH_FIRST 0x08
203#define REJECT_NEEDS_FORCE 0x10
10643d4e 204
9b288516 205int transport_push(struct transport *connection,
07436e43 206 int refspec_nr, const char **refspec, int flags,
10643d4e 207 unsigned int * reject_reasons);
9b288516 208
1af8ae1c
BW
209/*
210 * Retrieve refs from a remote.
211 *
212 * Optionally a list of ref prefixes can be provided which can be sent to the
213 * server (when communicating using protocol v2) to enable it to limit the ref
214 * advertisement. Since ref filtering is done on the server's end (and only
215 * when using protocol v2), this can return refs which don't match the provided
216 * ref_prefixes.
217 */
218const struct ref *transport_get_remote_refs(struct transport *transport,
219 const struct argv_array *ref_prefixes);
c29727d5 220
37148311 221int transport_fetch_refs(struct transport *transport, struct ref *refs);
1788c39c 222void transport_unlock_pack(struct transport *transport);
9b288516 223int transport_disconnect(struct transport *transport);
47abd85b 224char *transport_anonymize_url(const char *url);
61b075bd
IL
225void transport_take_over(struct transport *transport,
226 struct child_process *child);
9b288516 227
b236752a
IL
228int transport_connect(struct transport *transport, const char *name,
229 const char *exec, int fd[2]);
230
6eb996b5 231/* Transport methods defined outside transport.c */
c9e388bb 232int transport_helper_init(struct transport *transport, const char *name);
419f37db 233int bidirectional_transfer_loop(int input, int output);
6eb996b5 234
09b7e220 235/* common methods used by transport.c and builtin/send-pack.c */
f1863d0d
ML
236void transport_verify_remote_names(int nr_heads, const char **heads);
237
238void transport_update_tracking_ref(struct remote *remote, struct ref *ref, int verbose);
239
240int transport_refs_pushed(struct ref *ref);
241
242void transport_print_push_status(const char *dest, struct ref *refs,
10643d4e 243 int verbose, int porcelain, unsigned int *reject_reasons);
f1863d0d 244
2429d63a 245typedef void alternate_ref_fn(const char *refname, const struct object_id *oid, void *);
114a6a88 246extern void for_each_alternate_ref(alternate_ref_fn, void *);
9b288516 247#endif