]>
Commit | Line | Data |
---|---|---|
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" |
9da69a65 | 8 | #include "string-list.h" |
a45a2600 | 9 | |
aa5af974 IL |
10 | struct 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; |
4fe788b1 | 17 | unsigned reject_shallow : 1; |
cccf74e2 | 18 | unsigned deepen_relative : 1; |
42d418df JT |
19 | |
20 | /* see documentation of corresponding flag in fetch-pack.h */ | |
88e2f9ed | 21 | unsigned from_promisor : 1; |
42d418df | 22 | |
cf1e7c07 JT |
23 | /* |
24 | * If this transport supports connect or stateless-connect, | |
25 | * the corresponding field in struct fetch_pack_args is copied | |
26 | * here after fetching. | |
27 | * | |
28 | * See the definition of connectivity_checked in struct | |
29 | * fetch_pack_args for more information. | |
30 | */ | |
31 | unsigned connectivity_checked:1; | |
32 | ||
aa5af974 | 33 | int depth; |
508ea882 | 34 | const char *deepen_since; |
a45a2600 | 35 | const struct string_list *deepen_not; |
aa5af974 IL |
36 | const char *uploadpack; |
37 | const char *receivepack; | |
91048a95 | 38 | struct push_cas_option *cas; |
640d8b72 | 39 | struct list_objects_filter_options filter_options; |
3390e42a JT |
40 | |
41 | /* | |
42 | * This is only used during fetch. See the documentation of | |
43 | * negotiation_tips in struct fetch_pack_args. | |
44 | * | |
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(). | |
48 | */ | |
49 | struct oid_array *negotiation_tips; | |
aa5af974 IL |
50 | }; |
51 | ||
c915f11e EW |
52 | enum transport_family { |
53 | TRANSPORT_FAMILY_ALL = 0, | |
54 | TRANSPORT_FAMILY_IPV4, | |
55 | TRANSPORT_FAMILY_IPV6 | |
56 | }; | |
57 | ||
9b288516 | 58 | struct transport { |
e967ca38 JT |
59 | const struct transport_vtable *vtable; |
60 | ||
9b288516 DB |
61 | struct remote *remote; |
62 | const char *url; | |
9b288516 | 63 | void *data; |
4577370e | 64 | const struct ref *remote_refs; |
9b288516 | 65 | |
b0d66e15 TRC |
66 | /** |
67 | * Indicates whether we already called get_refs_list(); set by | |
68 | * transport.c::transport_get_remote_refs(). | |
69 | */ | |
70 | unsigned got_remote_refs : 1; | |
71 | ||
b26ed430 JH |
72 | /* |
73 | * Transports that call take-over destroys the data specific to | |
74 | * the transport type while doing so, and cannot be reused. | |
75 | */ | |
76 | unsigned cannot_reuse : 1; | |
77 | ||
beea4152 NTND |
78 | /* |
79 | * A hint from caller that it will be performing a clone, not | |
80 | * normal fetch. IOW the repository is guaranteed empty. | |
81 | */ | |
82 | unsigned cloning : 1; | |
83 | ||
edc9caf7 BW |
84 | /* |
85 | * Indicates that the transport is connected via a half-duplex | |
86 | * connection and should operate in stateless-rpc mode. | |
87 | */ | |
88 | unsigned stateless_rpc : 1; | |
89 | ||
f6a4e61f SB |
90 | /* |
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. | |
93 | */ | |
94 | const struct string_list *push_options; | |
95 | ||
ff473221 BW |
96 | /* |
97 | * These strings will be passed to the remote side on each command | |
98 | * request, if both sides support the server-option capability. | |
99 | */ | |
100 | const struct string_list *server_options; | |
101 | ||
9da69a65 JT |
102 | struct string_list pack_lockfiles; |
103 | ||
cff7123c | 104 | signed verbose : 3; |
d01b3c02 TRC |
105 | /** |
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(). | |
110 | **/ | |
21188b1e | 111 | unsigned progress : 1; |
aa5af974 IL |
112 | /* |
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. | |
116 | */ | |
117 | struct git_transport_options *smart_options; | |
c915f11e EW |
118 | |
119 | enum transport_family family; | |
7c97af4d | 120 | |
121 | const struct git_hash_algo *hash_algo; | |
9b288516 DB |
122 | }; |
123 | ||
14c01bdb BW |
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) | |
225e8bf7 | 139 | #define TRANSPORT_RECURSE_SUBMODULES_ONLY (1<<15) |
3b990aa6 | 140 | #define TRANSPORT_PUSH_FORCE_IF_INCLUDES (1<<16) |
824d5776 | 141 | |
55454427 | 142 | int transport_summary_width(const struct ref *refs); |
824d5776 | 143 | |
9b288516 | 144 | /* Returns a transport suitable for the url */ |
e5f4e214 | 145 | struct transport *transport_get(struct remote *, const char *); |
9b288516 | 146 | |
5088d3b3 | 147 | /* |
a768a022 BW |
148 | * Check whether a transport is allowed by the environment. |
149 | * | |
150 | * Type should generally be the URL scheme, as described in | |
151 | * Documentation/git.txt | |
152 | * | |
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. | |
156 | * | |
5088d3b3 | 157 | */ |
a768a022 | 158 | int is_transport_allowed(const char *type, int from_user); |
5088d3b3 | 159 | |
a5adaced JK |
160 | /* |
161 | * Check whether a transport is allowed by the environment, | |
5088d3b3 | 162 | * and die otherwise. |
a5adaced JK |
163 | */ |
164 | void transport_check_allowed(const char *type); | |
165 | ||
9b288516 DB |
166 | /* Transport options which apply to git:// and scp-style URLs */ |
167 | ||
c29727d5 DB |
168 | /* The program to use on the remote side to send a pack */ |
169 | #define TRANS_OPT_UPLOADPACK "uploadpack" | |
170 | ||
9b288516 DB |
171 | /* The program to use on the remote side to receive a pack */ |
172 | #define TRANS_OPT_RECEIVEPACK "receivepack" | |
173 | ||
174 | /* Transfer the data as a thin pack if not null */ | |
175 | #define TRANS_OPT_THIN "thin" | |
176 | ||
91048a95 JH |
177 | /* Check the current value of the remote ref */ |
178 | #define TRANS_OPT_CAS "cas" | |
179 | ||
c29727d5 DB |
180 | /* Keep the pack that was transferred if not null */ |
181 | #define TRANS_OPT_KEEP "keep" | |
182 | ||
c29727d5 DB |
183 | /* Limit the depth of the fetch if not null */ |
184 | #define TRANS_OPT_DEPTH "depth" | |
185 | ||
508ea882 NTND |
186 | /* Limit the depth of the fetch based on time if not null */ |
187 | #define TRANS_OPT_DEEPEN_SINCE "deepen-since" | |
188 | ||
a45a2600 NTND |
189 | /* Limit the depth of the fetch based on revs if not null */ |
190 | #define TRANS_OPT_DEEPEN_NOT "deepen-not" | |
191 | ||
cccf74e2 NTND |
192 | /* Limit the deepen of the fetch if not null */ |
193 | #define TRANS_OPT_DEEPEN_RELATIVE "deepen-relative" | |
194 | ||
41fa7d2e SP |
195 | /* Aggressively fetch annotated tags if possible */ |
196 | #define TRANS_OPT_FOLLOWTAGS "followtags" | |
197 | ||
4fe788b1 LL |
198 | /* Reject shallow repo transport */ |
199 | #define TRANS_OPT_REJECT_SHALLOW "rejectshallow" | |
200 | ||
48d25cae NTND |
201 | /* Accept refs that may update .git/shallow without --depth */ |
202 | #define TRANS_OPT_UPDATE_SHALLOW "updateshallow" | |
203 | ||
a85b377d JH |
204 | /* Send push certificates */ |
205 | #define TRANS_OPT_PUSH_CERT "pushcert" | |
206 | ||
88e2f9ed JT |
207 | /* Indicate that these objects are being fetched by a promisor */ |
208 | #define TRANS_OPT_FROM_PROMISOR "from-promisor" | |
209 | ||
640d8b72 JH |
210 | /* Filter objects for partial clone and fetch */ |
211 | #define TRANS_OPT_LIST_OBJECTS_FILTER "filter" | |
212 | ||
6f119424 | 213 | /* Request atomic (all-or-nothing) updates when pushing */ |
214 | #define TRANS_OPT_ATOMIC "atomic" | |
215 | ||
3b990aa6 SK |
216 | /* Require remote changes to be integrated locally. */ |
217 | #define TRANS_OPT_FORCE_IF_INCLUDES "force-if-includes" | |
218 | ||
9b288516 DB |
219 | /** |
220 | * Returns 0 if the option was used, non-zero otherwise. Prints a | |
221 | * message to stderr if the option is not used. | |
222 | **/ | |
223 | int transport_set_option(struct transport *transport, const char *name, | |
224 | const char *value); | |
d01b3c02 TRC |
225 | void transport_set_verbosity(struct transport *transport, int verbosity, |
226 | int force_progress); | |
9b288516 | 227 | |
3b990aa6 SK |
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 | |
10643d4e | 234 | |
6c6d5d07 NTND |
235 | int transport_push(struct repository *repo, |
236 | struct transport *connection, | |
306f22db | 237 | struct refspec *rs, int flags, |
10643d4e | 238 | unsigned int * reject_reasons); |
9b288516 | 239 | |
39835409 JT |
240 | struct transport_ls_refs_options { |
241 | /* | |
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. | |
248 | */ | |
249 | struct strvec ref_prefixes; | |
4f37d457 JT |
250 | |
251 | /* | |
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. | |
256 | */ | |
257 | char *unborn_head_target; | |
39835409 JT |
258 | }; |
259 | #define TRANSPORT_LS_REFS_OPTIONS_INIT { STRVEC_INIT } | |
260 | ||
1af8ae1c BW |
261 | /* |
262 | * Retrieve refs from a remote. | |
1af8ae1c BW |
263 | */ |
264 | const struct ref *transport_get_remote_refs(struct transport *transport, | |
39835409 | 265 | struct transport_ls_refs_options *transport_options); |
c29727d5 | 266 | |
7c97af4d | 267 | /* |
268 | * Fetch the hash algorithm used by a remote. | |
269 | * | |
270 | * This can only be called after fetching the remote refs. | |
271 | */ | |
272 | const struct git_hash_algo *transport_get_hash_algo(struct transport *transport); | |
e2842b39 | 273 | int transport_fetch_refs(struct transport *transport, struct ref *refs); |
1788c39c | 274 | void transport_unlock_pack(struct transport *transport); |
9b288516 | 275 | int transport_disconnect(struct transport *transport); |
47abd85b | 276 | char *transport_anonymize_url(const char *url); |
61b075bd IL |
277 | void transport_take_over(struct transport *transport, |
278 | struct child_process *child); | |
9b288516 | 279 | |
b236752a IL |
280 | int transport_connect(struct transport *transport, const char *name, |
281 | const char *exec, int fd[2]); | |
282 | ||
6eb996b5 | 283 | /* Transport methods defined outside transport.c */ |
c9e388bb | 284 | int transport_helper_init(struct transport *transport, const char *name); |
419f37db | 285 | int bidirectional_transfer_loop(int input, int output); |
6eb996b5 | 286 | |
09b7e220 | 287 | /* common methods used by transport.c and builtin/send-pack.c */ |
f1863d0d ML |
288 | void transport_update_tracking_ref(struct remote *remote, struct ref *ref, int verbose); |
289 | ||
290 | int transport_refs_pushed(struct ref *ref); | |
291 | ||
292 | void transport_print_push_status(const char *dest, struct ref *refs, | |
10643d4e | 293 | int verbose, int porcelain, unsigned int *reject_reasons); |
f1863d0d | 294 | |
dfe1b7f1 JX |
295 | /* common method used by transport-helper.c and send-pack.c */ |
296 | void reject_atomic_push(struct ref *refs, int mirror_mode); | |
297 | ||
9b288516 | 298 | #endif |