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