]>
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; |
3c7bab06 | 19 | unsigned refetch : 1; |
42d418df JT |
20 | |
21 | /* see documentation of corresponding flag in fetch-pack.h */ | |
88e2f9ed | 22 | unsigned from_promisor : 1; |
42d418df | 23 | |
cf1e7c07 JT |
24 | /* |
25 | * If this transport supports connect or stateless-connect, | |
26 | * the corresponding field in struct fetch_pack_args is copied | |
27 | * here after fetching. | |
28 | * | |
29 | * See the definition of connectivity_checked in struct | |
30 | * fetch_pack_args for more information. | |
31 | */ | |
32 | unsigned connectivity_checked:1; | |
33 | ||
aa5af974 | 34 | int depth; |
508ea882 | 35 | const char *deepen_since; |
a45a2600 | 36 | const struct string_list *deepen_not; |
aa5af974 IL |
37 | const char *uploadpack; |
38 | const char *receivepack; | |
91048a95 | 39 | struct push_cas_option *cas; |
640d8b72 | 40 | struct list_objects_filter_options filter_options; |
3390e42a JT |
41 | |
42 | /* | |
43 | * This is only used during fetch. See the documentation of | |
44 | * negotiation_tips in struct fetch_pack_args. | |
45 | * | |
46 | * This field is only supported by transports that support connect or | |
47 | * stateless_connect. Set this field directly instead of using | |
48 | * transport_set_option(). | |
49 | */ | |
50 | struct oid_array *negotiation_tips; | |
9c1e657a JT |
51 | |
52 | /* | |
53 | * If allocated, whenever transport_fetch_refs() is called, add known | |
54 | * common commits to this oidset instead of fetching any packfiles. | |
55 | */ | |
56 | struct oidset *acked_commits; | |
aa5af974 IL |
57 | }; |
58 | ||
c915f11e EW |
59 | enum transport_family { |
60 | TRANSPORT_FAMILY_ALL = 0, | |
61 | TRANSPORT_FAMILY_IPV4, | |
62 | TRANSPORT_FAMILY_IPV6 | |
63 | }; | |
64 | ||
9b288516 | 65 | struct transport { |
e967ca38 JT |
66 | const struct transport_vtable *vtable; |
67 | ||
9b288516 DB |
68 | struct remote *remote; |
69 | const char *url; | |
9b288516 | 70 | void *data; |
4577370e | 71 | const struct ref *remote_refs; |
9b288516 | 72 | |
b0d66e15 TRC |
73 | /** |
74 | * Indicates whether we already called get_refs_list(); set by | |
75 | * transport.c::transport_get_remote_refs(). | |
76 | */ | |
77 | unsigned got_remote_refs : 1; | |
78 | ||
b26ed430 JH |
79 | /* |
80 | * Transports that call take-over destroys the data specific to | |
81 | * the transport type while doing so, and cannot be reused. | |
82 | */ | |
83 | unsigned cannot_reuse : 1; | |
84 | ||
beea4152 NTND |
85 | /* |
86 | * A hint from caller that it will be performing a clone, not | |
87 | * normal fetch. IOW the repository is guaranteed empty. | |
88 | */ | |
89 | unsigned cloning : 1; | |
90 | ||
edc9caf7 BW |
91 | /* |
92 | * Indicates that the transport is connected via a half-duplex | |
93 | * connection and should operate in stateless-rpc mode. | |
94 | */ | |
95 | unsigned stateless_rpc : 1; | |
96 | ||
f6a4e61f SB |
97 | /* |
98 | * These strings will be passed to the {pre, post}-receive hook, | |
99 | * on the remote side, if both sides support the push options capability. | |
100 | */ | |
101 | const struct string_list *push_options; | |
102 | ||
ff473221 BW |
103 | /* |
104 | * These strings will be passed to the remote side on each command | |
105 | * request, if both sides support the server-option capability. | |
106 | */ | |
107 | const struct string_list *server_options; | |
108 | ||
9da69a65 JT |
109 | struct string_list pack_lockfiles; |
110 | ||
cff7123c | 111 | signed verbose : 3; |
d01b3c02 TRC |
112 | /** |
113 | * Transports should not set this directly, and should use this | |
114 | * value without having to check isatty(2), -q/--quiet | |
115 | * (transport->verbose < 0), etc. - checking has already been done | |
116 | * in transport_set_verbosity(). | |
117 | **/ | |
21188b1e | 118 | unsigned progress : 1; |
aa5af974 IL |
119 | /* |
120 | * If transport is at least potentially smart, this points to | |
121 | * git_transport_options structure to use in case transport | |
122 | * actually turns out to be smart. | |
123 | */ | |
124 | struct git_transport_options *smart_options; | |
c915f11e EW |
125 | |
126 | enum transport_family family; | |
7c97af4d | 127 | |
128 | const struct git_hash_algo *hash_algo; | |
9b288516 DB |
129 | }; |
130 | ||
14c01bdb BW |
131 | #define TRANSPORT_PUSH_ALL (1<<0) |
132 | #define TRANSPORT_PUSH_FORCE (1<<1) | |
133 | #define TRANSPORT_PUSH_DRY_RUN (1<<2) | |
134 | #define TRANSPORT_PUSH_MIRROR (1<<3) | |
135 | #define TRANSPORT_PUSH_PORCELAIN (1<<4) | |
136 | #define TRANSPORT_PUSH_SET_UPSTREAM (1<<5) | |
137 | #define TRANSPORT_RECURSE_SUBMODULES_CHECK (1<<6) | |
138 | #define TRANSPORT_PUSH_PRUNE (1<<7) | |
139 | #define TRANSPORT_RECURSE_SUBMODULES_ON_DEMAND (1<<8) | |
140 | #define TRANSPORT_PUSH_NO_HOOK (1<<9) | |
141 | #define TRANSPORT_PUSH_FOLLOW_TAGS (1<<10) | |
142 | #define TRANSPORT_PUSH_CERT_ALWAYS (1<<11) | |
143 | #define TRANSPORT_PUSH_CERT_IF_ASKED (1<<12) | |
144 | #define TRANSPORT_PUSH_ATOMIC (1<<13) | |
145 | #define TRANSPORT_PUSH_OPTIONS (1<<14) | |
225e8bf7 | 146 | #define TRANSPORT_RECURSE_SUBMODULES_ONLY (1<<15) |
3b990aa6 | 147 | #define TRANSPORT_PUSH_FORCE_IF_INCLUDES (1<<16) |
824d5776 | 148 | |
55454427 | 149 | int transport_summary_width(const struct ref *refs); |
824d5776 | 150 | |
9b288516 | 151 | /* Returns a transport suitable for the url */ |
e5f4e214 | 152 | struct transport *transport_get(struct remote *, const char *); |
9b288516 | 153 | |
5088d3b3 | 154 | /* |
a768a022 BW |
155 | * Check whether a transport is allowed by the environment. |
156 | * | |
157 | * Type should generally be the URL scheme, as described in | |
158 | * Documentation/git.txt | |
159 | * | |
160 | * from_user specifies if the transport was given by the user. If unknown pass | |
161 | * a -1 to read from the environment to determine if the transport was given by | |
162 | * the user. | |
163 | * | |
5088d3b3 | 164 | */ |
a768a022 | 165 | int is_transport_allowed(const char *type, int from_user); |
5088d3b3 | 166 | |
a5adaced JK |
167 | /* |
168 | * Check whether a transport is allowed by the environment, | |
5088d3b3 | 169 | * and die otherwise. |
a5adaced JK |
170 | */ |
171 | void transport_check_allowed(const char *type); | |
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 | ||
4fe788b1 LL |
205 | /* Reject shallow repo transport */ |
206 | #define TRANS_OPT_REJECT_SHALLOW "rejectshallow" | |
207 | ||
48d25cae NTND |
208 | /* Accept refs that may update .git/shallow without --depth */ |
209 | #define TRANS_OPT_UPDATE_SHALLOW "updateshallow" | |
210 | ||
a85b377d JH |
211 | /* Send push certificates */ |
212 | #define TRANS_OPT_PUSH_CERT "pushcert" | |
213 | ||
88e2f9ed JT |
214 | /* Indicate that these objects are being fetched by a promisor */ |
215 | #define TRANS_OPT_FROM_PROMISOR "from-promisor" | |
216 | ||
640d8b72 JH |
217 | /* Filter objects for partial clone and fetch */ |
218 | #define TRANS_OPT_LIST_OBJECTS_FILTER "filter" | |
219 | ||
3c7bab06 RC |
220 | /* Refetch all objects without negotiating */ |
221 | #define TRANS_OPT_REFETCH "refetch" | |
222 | ||
6f119424 | 223 | /* Request atomic (all-or-nothing) updates when pushing */ |
224 | #define TRANS_OPT_ATOMIC "atomic" | |
225 | ||
3b990aa6 SK |
226 | /* Require remote changes to be integrated locally. */ |
227 | #define TRANS_OPT_FORCE_IF_INCLUDES "force-if-includes" | |
228 | ||
9b288516 DB |
229 | /** |
230 | * Returns 0 if the option was used, non-zero otherwise. Prints a | |
231 | * message to stderr if the option is not used. | |
232 | **/ | |
233 | int transport_set_option(struct transport *transport, const char *name, | |
234 | const char *value); | |
d01b3c02 TRC |
235 | void transport_set_verbosity(struct transport *transport, int verbosity, |
236 | int force_progress); | |
9b288516 | 237 | |
3b990aa6 SK |
238 | #define REJECT_NON_FF_HEAD 0x01 |
239 | #define REJECT_NON_FF_OTHER 0x02 | |
240 | #define REJECT_ALREADY_EXISTS 0x04 | |
241 | #define REJECT_FETCH_FIRST 0x08 | |
242 | #define REJECT_NEEDS_FORCE 0x10 | |
243 | #define REJECT_REF_NEEDS_UPDATE 0x20 | |
10643d4e | 244 | |
6c6d5d07 NTND |
245 | int transport_push(struct repository *repo, |
246 | struct transport *connection, | |
306f22db | 247 | struct refspec *rs, int flags, |
10643d4e | 248 | unsigned int * reject_reasons); |
9b288516 | 249 | |
39835409 JT |
250 | struct transport_ls_refs_options { |
251 | /* | |
252 | * Optionally, a list of ref prefixes can be provided which can be sent | |
253 | * to the server (when communicating using protocol v2) to enable it to | |
254 | * limit the ref advertisement. Since ref filtering is done on the | |
255 | * server's end (and only when using protocol v2), | |
256 | * transport_get_remote_refs() could return refs which don't match the | |
257 | * provided ref_prefixes. | |
258 | */ | |
259 | struct strvec ref_prefixes; | |
4f37d457 JT |
260 | |
261 | /* | |
262 | * If unborn_head_target is not NULL, and the remote reports HEAD as | |
263 | * pointing to an unborn branch, transport_get_remote_refs() stores the | |
f36d4f83 | 264 | * unborn branch in unborn_head_target. |
4f37d457 | 265 | */ |
f36d4f83 | 266 | const char *unborn_head_target; |
39835409 | 267 | }; |
f69a6e4f ÆAB |
268 | #define TRANSPORT_LS_REFS_OPTIONS_INIT { \ |
269 | .ref_prefixes = STRVEC_INIT, \ | |
270 | } | |
39835409 | 271 | |
f36d4f83 ÆAB |
272 | /** |
273 | * Release the "struct transport_ls_refs_options". | |
274 | */ | |
275 | void transport_ls_refs_options_release(struct transport_ls_refs_options *opts); | |
276 | ||
1af8ae1c BW |
277 | /* |
278 | * Retrieve refs from a remote. | |
1af8ae1c BW |
279 | */ |
280 | const struct ref *transport_get_remote_refs(struct transport *transport, | |
39835409 | 281 | struct transport_ls_refs_options *transport_options); |
c29727d5 | 282 | |
7c97af4d | 283 | /* |
284 | * Fetch the hash algorithm used by a remote. | |
285 | * | |
286 | * This can only be called after fetching the remote refs. | |
287 | */ | |
288 | const struct git_hash_algo *transport_get_hash_algo(struct transport *transport); | |
e2842b39 | 289 | int transport_fetch_refs(struct transport *transport, struct ref *refs); |
58d4d7f1 PS |
290 | |
291 | /* | |
292 | * If this flag is set, unlocking will avoid to call non-async-signal-safe | |
293 | * functions. This will necessarily leave behind some data structures which | |
294 | * cannot be cleaned up. | |
295 | */ | |
296 | #define TRANSPORT_UNLOCK_PACK_IN_SIGNAL_HANDLER (1 << 0) | |
297 | ||
298 | /* | |
299 | * Unlock all packfiles locked by the transport. | |
300 | */ | |
301 | void transport_unlock_pack(struct transport *transport, unsigned int flags); | |
302 | ||
9b288516 | 303 | int transport_disconnect(struct transport *transport); |
47abd85b | 304 | char *transport_anonymize_url(const char *url); |
61b075bd IL |
305 | void transport_take_over(struct transport *transport, |
306 | struct child_process *child); | |
9b288516 | 307 | |
b236752a IL |
308 | int transport_connect(struct transport *transport, const char *name, |
309 | const char *exec, int fd[2]); | |
310 | ||
6eb996b5 | 311 | /* Transport methods defined outside transport.c */ |
c9e388bb | 312 | int transport_helper_init(struct transport *transport, const char *name); |
419f37db | 313 | int bidirectional_transfer_loop(int input, int output); |
6eb996b5 | 314 | |
09b7e220 | 315 | /* common methods used by transport.c and builtin/send-pack.c */ |
f1863d0d ML |
316 | void transport_update_tracking_ref(struct remote *remote, struct ref *ref, int verbose); |
317 | ||
318 | int transport_refs_pushed(struct ref *ref); | |
319 | ||
320 | void transport_print_push_status(const char *dest, struct ref *refs, | |
10643d4e | 321 | int verbose, int porcelain, unsigned int *reject_reasons); |
f1863d0d | 322 | |
dfe1b7f1 JX |
323 | /* common method used by transport-helper.c and send-pack.c */ |
324 | void reject_atomic_push(struct ref *refs, int mirror_mode); | |
325 | ||
9b288516 | 326 | #endif |