submodules: add RECURSE_SUBMODULES_ONLY value
[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
DB
6#include "remote.h"
7
a45a2600
NTND
8struct string_list;
9
aa5af974
IL
10struct git_transport_options {
11 unsigned thin : 1;
12 unsigned keep : 1;
13 unsigned followtags : 1;
c6807a40
NTND
14 unsigned check_self_contained_and_connected : 1;
15 unsigned self_contained_and_connected : 1;
48d25cae 16 unsigned update_shallow : 1;
cccf74e2 17 unsigned deepen_relative : 1;
aa5af974 18 int depth;
508ea882 19 const char *deepen_since;
a45a2600 20 const struct string_list *deepen_not;
aa5af974
IL
21 const char *uploadpack;
22 const char *receivepack;
91048a95 23 struct push_cas_option *cas;
aa5af974
IL
24};
25
c915f11e
EW
26enum transport_family {
27 TRANSPORT_FAMILY_ALL = 0,
28 TRANSPORT_FAMILY_IPV4,
29 TRANSPORT_FAMILY_IPV6
30};
31
9b288516 32struct transport {
9b288516
DB
33 struct remote *remote;
34 const char *url;
9b288516 35 void *data;
4577370e 36 const struct ref *remote_refs;
9b288516 37
b0d66e15
TRC
38 /**
39 * Indicates whether we already called get_refs_list(); set by
40 * transport.c::transport_get_remote_refs().
41 */
42 unsigned got_remote_refs : 1;
43
b26ed430
JH
44 /*
45 * Transports that call take-over destroys the data specific to
46 * the transport type while doing so, and cannot be reused.
47 */
48 unsigned cannot_reuse : 1;
49
beea4152
NTND
50 /*
51 * A hint from caller that it will be performing a clone, not
52 * normal fetch. IOW the repository is guaranteed empty.
53 */
54 unsigned cloning : 1;
55
f6a4e61f
SB
56 /*
57 * These strings will be passed to the {pre, post}-receive hook,
58 * on the remote side, if both sides support the push options capability.
59 */
60 const struct string_list *push_options;
61
9b288516
DB
62 /**
63 * Returns 0 if successful, positive if the option is not
64 * recognized or is inapplicable, and negative if the option
65 * is applicable but the value is invalid.
66 **/
67 int (*set_option)(struct transport *connection, const char *name,
68 const char *value);
69
37148311
DB
70 /**
71 * Returns a list of the remote side's refs. In order to allow
72 * the transport to try to share connections, for_push is a
73 * hint as to whether the ultimate operation is a push or a fetch.
74 *
75 * If the transport is able to determine the remote hash for
76 * the ref without a huge amount of effort, it should store it
77 * in the ref's old_sha1 field; otherwise it should be all 0.
78 **/
64fcef2d 79 struct ref *(*get_refs_list)(struct transport *transport, int for_push);
37148311
DB
80
81 /**
82 * Fetch the objects for the given refs. Note that this gets
83 * an array, and should ignore the list structure.
84 *
85 * If the transport did not get hashes for refs in
86 * get_refs_list(), it should set the old_sha1 fields in the
87 * provided refs now.
88 **/
89 int (*fetch)(struct transport *transport, int refs_nr, struct ref **refs);
90
91 /**
92 * Push the objects and refs. Send the necessary objects, and
93 * then, for any refs where peer_ref is set and
f4e54d02 94 * peer_ref->new_oid is different from old_oid, tell the
95 * remote side to update each ref in the list from old_oid to
96 * peer_ref->new_oid.
37148311
DB
97 *
98 * Where possible, set the status for each ref appropriately.
99 *
100 * The transport must modify new_sha1 in the ref to the new
101 * value if the remote accepted the change. Note that this
f4e54d02 102 * could be a different value from peer_ref->new_oid if the
37148311
DB
103 * process involved generating new commits.
104 **/
64fcef2d 105 int (*push_refs)(struct transport *transport, struct ref *refs, int flags);
9b288516 106 int (*push)(struct transport *connection, int refspec_nr, const char **refspec, int flags);
b236752a
IL
107 int (*connect)(struct transport *connection, const char *name,
108 const char *executable, int fd[2]);
9b288516 109
37148311 110 /** get_refs_list(), fetch(), and push_refs() can keep
41ccfdd9 111 * resources (such as a connection) reserved for further
37148311
DB
112 * use. disconnect() releases these resources.
113 **/
9b288516 114 int (*disconnect)(struct transport *connection);
824d5776 115 char *pack_lockfile;
cff7123c 116 signed verbose : 3;
d01b3c02
TRC
117 /**
118 * Transports should not set this directly, and should use this
119 * value without having to check isatty(2), -q/--quiet
120 * (transport->verbose < 0), etc. - checking has already been done
121 * in transport_set_verbosity().
122 **/
21188b1e 123 unsigned progress : 1;
aa5af974
IL
124 /*
125 * If transport is at least potentially smart, this points to
126 * git_transport_options structure to use in case transport
127 * actually turns out to be smart.
128 */
129 struct git_transport_options *smart_options;
c915f11e
EW
130
131 enum transport_family family;
9b288516
DB
132};
133
14c01bdb
BW
134#define TRANSPORT_PUSH_ALL (1<<0)
135#define TRANSPORT_PUSH_FORCE (1<<1)
136#define TRANSPORT_PUSH_DRY_RUN (1<<2)
137#define TRANSPORT_PUSH_MIRROR (1<<3)
138#define TRANSPORT_PUSH_PORCELAIN (1<<4)
139#define TRANSPORT_PUSH_SET_UPSTREAM (1<<5)
140#define TRANSPORT_RECURSE_SUBMODULES_CHECK (1<<6)
141#define TRANSPORT_PUSH_PRUNE (1<<7)
142#define TRANSPORT_RECURSE_SUBMODULES_ON_DEMAND (1<<8)
143#define TRANSPORT_PUSH_NO_HOOK (1<<9)
144#define TRANSPORT_PUSH_FOLLOW_TAGS (1<<10)
145#define TRANSPORT_PUSH_CERT_ALWAYS (1<<11)
146#define TRANSPORT_PUSH_CERT_IF_ASKED (1<<12)
147#define TRANSPORT_PUSH_ATOMIC (1<<13)
148#define TRANSPORT_PUSH_OPTIONS (1<<14)
824d5776 149
11fd66de 150extern int transport_summary_width(const struct ref *refs);
824d5776 151
9b288516 152/* Returns a transport suitable for the url */
e5f4e214 153struct transport *transport_get(struct remote *, const char *);
9b288516 154
5088d3b3
JK
155/*
156 * Check whether a transport is allowed by the environment. Type should
157 * generally be the URL scheme, as described in Documentation/git.txt
158 */
159int is_transport_allowed(const char *type);
160
a5adaced
JK
161/*
162 * Check whether a transport is allowed by the environment,
5088d3b3 163 * and die otherwise.
a5adaced
JK
164 */
165void transport_check_allowed(const char *type);
166
5088d3b3
JK
167/*
168 * Returns true if the user has attempted to turn on protocol
169 * restrictions at all.
170 */
171int transport_restrict_protocols(void);
172
9b288516
DB
173/* Transport options which apply to git:// and scp-style URLs */
174
c29727d5
DB
175/* The program to use on the remote side to send a pack */
176#define TRANS_OPT_UPLOADPACK "uploadpack"
177
9b288516
DB
178/* The program to use on the remote side to receive a pack */
179#define TRANS_OPT_RECEIVEPACK "receivepack"
180
181/* Transfer the data as a thin pack if not null */
182#define TRANS_OPT_THIN "thin"
183
91048a95
JH
184/* Check the current value of the remote ref */
185#define TRANS_OPT_CAS "cas"
186
c29727d5
DB
187/* Keep the pack that was transferred if not null */
188#define TRANS_OPT_KEEP "keep"
189
c29727d5
DB
190/* Limit the depth of the fetch if not null */
191#define TRANS_OPT_DEPTH "depth"
192
508ea882
NTND
193/* Limit the depth of the fetch based on time if not null */
194#define TRANS_OPT_DEEPEN_SINCE "deepen-since"
195
a45a2600
NTND
196/* Limit the depth of the fetch based on revs if not null */
197#define TRANS_OPT_DEEPEN_NOT "deepen-not"
198
cccf74e2
NTND
199/* Limit the deepen of the fetch if not null */
200#define TRANS_OPT_DEEPEN_RELATIVE "deepen-relative"
201
41fa7d2e
SP
202/* Aggressively fetch annotated tags if possible */
203#define TRANS_OPT_FOLLOWTAGS "followtags"
204
48d25cae
NTND
205/* Accept refs that may update .git/shallow without --depth */
206#define TRANS_OPT_UPDATE_SHALLOW "updateshallow"
207
a85b377d
JH
208/* Send push certificates */
209#define TRANS_OPT_PUSH_CERT "pushcert"
210
9b288516
DB
211/**
212 * Returns 0 if the option was used, non-zero otherwise. Prints a
213 * message to stderr if the option is not used.
214 **/
215int transport_set_option(struct transport *transport, const char *name,
216 const char *value);
d01b3c02
TRC
217void transport_set_verbosity(struct transport *transport, int verbosity,
218 int force_progress);
9b288516 219
10643d4e
CR
220#define REJECT_NON_FF_HEAD 0x01
221#define REJECT_NON_FF_OTHER 0x02
b24e6047 222#define REJECT_ALREADY_EXISTS 0x04
75e5c0dc
JH
223#define REJECT_FETCH_FIRST 0x08
224#define REJECT_NEEDS_FORCE 0x10
10643d4e 225
9b288516 226int transport_push(struct transport *connection,
07436e43 227 int refspec_nr, const char **refspec, int flags,
10643d4e 228 unsigned int * reject_reasons);
9b288516 229
4577370e 230const struct ref *transport_get_remote_refs(struct transport *transport);
c29727d5 231
37148311 232int transport_fetch_refs(struct transport *transport, struct ref *refs);
1788c39c 233void transport_unlock_pack(struct transport *transport);
9b288516 234int transport_disconnect(struct transport *transport);
47abd85b 235char *transport_anonymize_url(const char *url);
61b075bd
IL
236void transport_take_over(struct transport *transport,
237 struct child_process *child);
9b288516 238
b236752a
IL
239int transport_connect(struct transport *transport, const char *name,
240 const char *exec, int fd[2]);
241
6eb996b5 242/* Transport methods defined outside transport.c */
c9e388bb 243int transport_helper_init(struct transport *transport, const char *name);
419f37db 244int bidirectional_transfer_loop(int input, int output);
6eb996b5 245
09b7e220 246/* common methods used by transport.c and builtin/send-pack.c */
f1863d0d
ML
247void transport_verify_remote_names(int nr_heads, const char **heads);
248
249void transport_update_tracking_ref(struct remote *remote, struct ref *ref, int verbose);
250
251int transport_refs_pushed(struct ref *ref);
252
253void transport_print_push_status(const char *dest, struct ref *refs,
10643d4e 254 int verbose, int porcelain, unsigned int *reject_reasons);
f1863d0d 255
36cfda15 256typedef void alternate_ref_fn(const struct ref *, void *);
114a6a88 257extern void for_each_alternate_ref(alternate_ref_fn, void *);
9b288516 258#endif