serve: introduce the server-option capability
[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
824d5776 74 char *pack_lockfile;
cff7123c 75 signed verbose : 3;
d01b3c02
TRC
76 /**
77 * Transports should not set this directly, and should use this
78 * value without having to check isatty(2), -q/--quiet
79 * (transport->verbose < 0), etc. - checking has already been done
80 * in transport_set_verbosity().
81 **/
21188b1e 82 unsigned progress : 1;
aa5af974
IL
83 /*
84 * If transport is at least potentially smart, this points to
85 * git_transport_options structure to use in case transport
86 * actually turns out to be smart.
87 */
88 struct git_transport_options *smart_options;
c915f11e
EW
89
90 enum transport_family family;
9b288516
DB
91};
92
14c01bdb
BW
93#define TRANSPORT_PUSH_ALL (1<<0)
94#define TRANSPORT_PUSH_FORCE (1<<1)
95#define TRANSPORT_PUSH_DRY_RUN (1<<2)
96#define TRANSPORT_PUSH_MIRROR (1<<3)
97#define TRANSPORT_PUSH_PORCELAIN (1<<4)
98#define TRANSPORT_PUSH_SET_UPSTREAM (1<<5)
99#define TRANSPORT_RECURSE_SUBMODULES_CHECK (1<<6)
100#define TRANSPORT_PUSH_PRUNE (1<<7)
101#define TRANSPORT_RECURSE_SUBMODULES_ON_DEMAND (1<<8)
102#define TRANSPORT_PUSH_NO_HOOK (1<<9)
103#define TRANSPORT_PUSH_FOLLOW_TAGS (1<<10)
104#define TRANSPORT_PUSH_CERT_ALWAYS (1<<11)
105#define TRANSPORT_PUSH_CERT_IF_ASKED (1<<12)
106#define TRANSPORT_PUSH_ATOMIC (1<<13)
107#define TRANSPORT_PUSH_OPTIONS (1<<14)
225e8bf7 108#define TRANSPORT_RECURSE_SUBMODULES_ONLY (1<<15)
824d5776 109
11fd66de 110extern int transport_summary_width(const struct ref *refs);
824d5776 111
9b288516 112/* Returns a transport suitable for the url */
e5f4e214 113struct transport *transport_get(struct remote *, const char *);
9b288516 114
5088d3b3 115/*
a768a022
BW
116 * Check whether a transport is allowed by the environment.
117 *
118 * Type should generally be the URL scheme, as described in
119 * Documentation/git.txt
120 *
121 * from_user specifies if the transport was given by the user. If unknown pass
122 * a -1 to read from the environment to determine if the transport was given by
123 * the user.
124 *
5088d3b3 125 */
a768a022 126int is_transport_allowed(const char *type, int from_user);
5088d3b3 127
a5adaced
JK
128/*
129 * Check whether a transport is allowed by the environment,
5088d3b3 130 * and die otherwise.
a5adaced
JK
131 */
132void transport_check_allowed(const char *type);
133
9b288516
DB
134/* Transport options which apply to git:// and scp-style URLs */
135
c29727d5
DB
136/* The program to use on the remote side to send a pack */
137#define TRANS_OPT_UPLOADPACK "uploadpack"
138
9b288516
DB
139/* The program to use on the remote side to receive a pack */
140#define TRANS_OPT_RECEIVEPACK "receivepack"
141
142/* Transfer the data as a thin pack if not null */
143#define TRANS_OPT_THIN "thin"
144
91048a95
JH
145/* Check the current value of the remote ref */
146#define TRANS_OPT_CAS "cas"
147
c29727d5
DB
148/* Keep the pack that was transferred if not null */
149#define TRANS_OPT_KEEP "keep"
150
c29727d5
DB
151/* Limit the depth of the fetch if not null */
152#define TRANS_OPT_DEPTH "depth"
153
508ea882
NTND
154/* Limit the depth of the fetch based on time if not null */
155#define TRANS_OPT_DEEPEN_SINCE "deepen-since"
156
a45a2600
NTND
157/* Limit the depth of the fetch based on revs if not null */
158#define TRANS_OPT_DEEPEN_NOT "deepen-not"
159
cccf74e2
NTND
160/* Limit the deepen of the fetch if not null */
161#define TRANS_OPT_DEEPEN_RELATIVE "deepen-relative"
162
41fa7d2e
SP
163/* Aggressively fetch annotated tags if possible */
164#define TRANS_OPT_FOLLOWTAGS "followtags"
165
48d25cae
NTND
166/* Accept refs that may update .git/shallow without --depth */
167#define TRANS_OPT_UPDATE_SHALLOW "updateshallow"
168
a85b377d
JH
169/* Send push certificates */
170#define TRANS_OPT_PUSH_CERT "pushcert"
171
88e2f9ed
JT
172/* Indicate that these objects are being fetched by a promisor */
173#define TRANS_OPT_FROM_PROMISOR "from-promisor"
174
175/*
176 * Indicate that only the objects wanted need to be fetched, not their
177 * dependents
178 */
179#define TRANS_OPT_NO_DEPENDENTS "no-dependents"
180
640d8b72
JH
181/* Filter objects for partial clone and fetch */
182#define TRANS_OPT_LIST_OBJECTS_FILTER "filter"
183
9b288516
DB
184/**
185 * Returns 0 if the option was used, non-zero otherwise. Prints a
186 * message to stderr if the option is not used.
187 **/
188int transport_set_option(struct transport *transport, const char *name,
189 const char *value);
d01b3c02
TRC
190void transport_set_verbosity(struct transport *transport, int verbosity,
191 int force_progress);
9b288516 192
10643d4e
CR
193#define REJECT_NON_FF_HEAD 0x01
194#define REJECT_NON_FF_OTHER 0x02
b24e6047 195#define REJECT_ALREADY_EXISTS 0x04
75e5c0dc
JH
196#define REJECT_FETCH_FIRST 0x08
197#define REJECT_NEEDS_FORCE 0x10
10643d4e 198
9b288516 199int transport_push(struct transport *connection,
07436e43 200 int refspec_nr, const char **refspec, int flags,
10643d4e 201 unsigned int * reject_reasons);
9b288516 202
1af8ae1c
BW
203/*
204 * Retrieve refs from a remote.
205 *
206 * Optionally a list of ref prefixes can be provided which can be sent to the
207 * server (when communicating using protocol v2) to enable it to limit the ref
208 * advertisement. Since ref filtering is done on the server's end (and only
209 * when using protocol v2), this can return refs which don't match the provided
210 * ref_prefixes.
211 */
212const struct ref *transport_get_remote_refs(struct transport *transport,
213 const struct argv_array *ref_prefixes);
c29727d5 214
37148311 215int transport_fetch_refs(struct transport *transport, struct ref *refs);
1788c39c 216void transport_unlock_pack(struct transport *transport);
9b288516 217int transport_disconnect(struct transport *transport);
47abd85b 218char *transport_anonymize_url(const char *url);
61b075bd
IL
219void transport_take_over(struct transport *transport,
220 struct child_process *child);
9b288516 221
b236752a
IL
222int transport_connect(struct transport *transport, const char *name,
223 const char *exec, int fd[2]);
224
6eb996b5 225/* Transport methods defined outside transport.c */
c9e388bb 226int transport_helper_init(struct transport *transport, const char *name);
419f37db 227int bidirectional_transfer_loop(int input, int output);
6eb996b5 228
09b7e220 229/* common methods used by transport.c and builtin/send-pack.c */
f1863d0d
ML
230void transport_verify_remote_names(int nr_heads, const char **heads);
231
232void transport_update_tracking_ref(struct remote *remote, struct ref *ref, int verbose);
233
234int transport_refs_pushed(struct ref *ref);
235
236void transport_print_push_status(const char *dest, struct ref *refs,
10643d4e 237 int verbose, int porcelain, unsigned int *reject_reasons);
f1863d0d 238
2429d63a 239typedef void alternate_ref_fn(const char *refname, const struct object_id *oid, void *);
114a6a88 240extern void for_each_alternate_ref(alternate_ref_fn, void *);
9b288516 241#endif