]>
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; |
cccf74e2 | 17 | unsigned deepen_relative : 1; |
42d418df JT |
18 | |
19 | /* see documentation of corresponding flag in fetch-pack.h */ | |
88e2f9ed | 20 | unsigned from_promisor : 1; |
42d418df | 21 | |
cf1e7c07 JT |
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 | ||
9da69a65 JT |
101 | struct string_list pack_lockfiles; |
102 | ||
cff7123c | 103 | signed verbose : 3; |
d01b3c02 TRC |
104 | /** |
105 | * Transports should not set this directly, and should use this | |
106 | * value without having to check isatty(2), -q/--quiet | |
107 | * (transport->verbose < 0), etc. - checking has already been done | |
108 | * in transport_set_verbosity(). | |
109 | **/ | |
21188b1e | 110 | unsigned progress : 1; |
aa5af974 IL |
111 | /* |
112 | * If transport is at least potentially smart, this points to | |
113 | * git_transport_options structure to use in case transport | |
114 | * actually turns out to be smart. | |
115 | */ | |
116 | struct git_transport_options *smart_options; | |
c915f11e EW |
117 | |
118 | enum transport_family family; | |
7c97af4d | 119 | |
120 | const struct git_hash_algo *hash_algo; | |
9b288516 DB |
121 | }; |
122 | ||
14c01bdb BW |
123 | #define TRANSPORT_PUSH_ALL (1<<0) |
124 | #define TRANSPORT_PUSH_FORCE (1<<1) | |
125 | #define TRANSPORT_PUSH_DRY_RUN (1<<2) | |
126 | #define TRANSPORT_PUSH_MIRROR (1<<3) | |
127 | #define TRANSPORT_PUSH_PORCELAIN (1<<4) | |
128 | #define TRANSPORT_PUSH_SET_UPSTREAM (1<<5) | |
129 | #define TRANSPORT_RECURSE_SUBMODULES_CHECK (1<<6) | |
130 | #define TRANSPORT_PUSH_PRUNE (1<<7) | |
131 | #define TRANSPORT_RECURSE_SUBMODULES_ON_DEMAND (1<<8) | |
132 | #define TRANSPORT_PUSH_NO_HOOK (1<<9) | |
133 | #define TRANSPORT_PUSH_FOLLOW_TAGS (1<<10) | |
134 | #define TRANSPORT_PUSH_CERT_ALWAYS (1<<11) | |
135 | #define TRANSPORT_PUSH_CERT_IF_ASKED (1<<12) | |
136 | #define TRANSPORT_PUSH_ATOMIC (1<<13) | |
137 | #define TRANSPORT_PUSH_OPTIONS (1<<14) | |
225e8bf7 | 138 | #define TRANSPORT_RECURSE_SUBMODULES_ONLY (1<<15) |
3b990aa6 | 139 | #define TRANSPORT_PUSH_FORCE_IF_INCLUDES (1<<16) |
824d5776 | 140 | |
55454427 | 141 | int transport_summary_width(const struct ref *refs); |
824d5776 | 142 | |
9b288516 | 143 | /* Returns a transport suitable for the url */ |
e5f4e214 | 144 | struct transport *transport_get(struct remote *, const char *); |
9b288516 | 145 | |
5088d3b3 | 146 | /* |
a768a022 BW |
147 | * Check whether a transport is allowed by the environment. |
148 | * | |
149 | * Type should generally be the URL scheme, as described in | |
150 | * Documentation/git.txt | |
151 | * | |
152 | * from_user specifies if the transport was given by the user. If unknown pass | |
153 | * a -1 to read from the environment to determine if the transport was given by | |
154 | * the user. | |
155 | * | |
5088d3b3 | 156 | */ |
a768a022 | 157 | int is_transport_allowed(const char *type, int from_user); |
5088d3b3 | 158 | |
a5adaced JK |
159 | /* |
160 | * Check whether a transport is allowed by the environment, | |
5088d3b3 | 161 | * and die otherwise. |
a5adaced JK |
162 | */ |
163 | void transport_check_allowed(const char *type); | |
164 | ||
9b288516 DB |
165 | /* Transport options which apply to git:// and scp-style URLs */ |
166 | ||
c29727d5 DB |
167 | /* The program to use on the remote side to send a pack */ |
168 | #define TRANS_OPT_UPLOADPACK "uploadpack" | |
169 | ||
9b288516 DB |
170 | /* The program to use on the remote side to receive a pack */ |
171 | #define TRANS_OPT_RECEIVEPACK "receivepack" | |
172 | ||
173 | /* Transfer the data as a thin pack if not null */ | |
174 | #define TRANS_OPT_THIN "thin" | |
175 | ||
91048a95 JH |
176 | /* Check the current value of the remote ref */ |
177 | #define TRANS_OPT_CAS "cas" | |
178 | ||
c29727d5 DB |
179 | /* Keep the pack that was transferred if not null */ |
180 | #define TRANS_OPT_KEEP "keep" | |
181 | ||
c29727d5 DB |
182 | /* Limit the depth of the fetch if not null */ |
183 | #define TRANS_OPT_DEPTH "depth" | |
184 | ||
508ea882 NTND |
185 | /* Limit the depth of the fetch based on time if not null */ |
186 | #define TRANS_OPT_DEEPEN_SINCE "deepen-since" | |
187 | ||
a45a2600 NTND |
188 | /* Limit the depth of the fetch based on revs if not null */ |
189 | #define TRANS_OPT_DEEPEN_NOT "deepen-not" | |
190 | ||
cccf74e2 NTND |
191 | /* Limit the deepen of the fetch if not null */ |
192 | #define TRANS_OPT_DEEPEN_RELATIVE "deepen-relative" | |
193 | ||
41fa7d2e SP |
194 | /* Aggressively fetch annotated tags if possible */ |
195 | #define TRANS_OPT_FOLLOWTAGS "followtags" | |
196 | ||
48d25cae NTND |
197 | /* Accept refs that may update .git/shallow without --depth */ |
198 | #define TRANS_OPT_UPDATE_SHALLOW "updateshallow" | |
199 | ||
a85b377d JH |
200 | /* Send push certificates */ |
201 | #define TRANS_OPT_PUSH_CERT "pushcert" | |
202 | ||
88e2f9ed JT |
203 | /* Indicate that these objects are being fetched by a promisor */ |
204 | #define TRANS_OPT_FROM_PROMISOR "from-promisor" | |
205 | ||
640d8b72 JH |
206 | /* Filter objects for partial clone and fetch */ |
207 | #define TRANS_OPT_LIST_OBJECTS_FILTER "filter" | |
208 | ||
6f119424 | 209 | /* Request atomic (all-or-nothing) updates when pushing */ |
210 | #define TRANS_OPT_ATOMIC "atomic" | |
211 | ||
3b990aa6 SK |
212 | /* Require remote changes to be integrated locally. */ |
213 | #define TRANS_OPT_FORCE_IF_INCLUDES "force-if-includes" | |
214 | ||
9b288516 DB |
215 | /** |
216 | * Returns 0 if the option was used, non-zero otherwise. Prints a | |
217 | * message to stderr if the option is not used. | |
218 | **/ | |
219 | int transport_set_option(struct transport *transport, const char *name, | |
220 | const char *value); | |
d01b3c02 TRC |
221 | void transport_set_verbosity(struct transport *transport, int verbosity, |
222 | int force_progress); | |
9b288516 | 223 | |
3b990aa6 SK |
224 | #define REJECT_NON_FF_HEAD 0x01 |
225 | #define REJECT_NON_FF_OTHER 0x02 | |
226 | #define REJECT_ALREADY_EXISTS 0x04 | |
227 | #define REJECT_FETCH_FIRST 0x08 | |
228 | #define REJECT_NEEDS_FORCE 0x10 | |
229 | #define REJECT_REF_NEEDS_UPDATE 0x20 | |
10643d4e | 230 | |
6c6d5d07 NTND |
231 | int transport_push(struct repository *repo, |
232 | struct transport *connection, | |
306f22db | 233 | struct refspec *rs, int flags, |
10643d4e | 234 | unsigned int * reject_reasons); |
9b288516 | 235 | |
1af8ae1c BW |
236 | /* |
237 | * Retrieve refs from a remote. | |
238 | * | |
239 | * Optionally a list of ref prefixes can be provided which can be sent to the | |
240 | * server (when communicating using protocol v2) to enable it to limit the ref | |
241 | * advertisement. Since ref filtering is done on the server's end (and only | |
242 | * when using protocol v2), this can return refs which don't match the provided | |
243 | * ref_prefixes. | |
244 | */ | |
245 | const struct ref *transport_get_remote_refs(struct transport *transport, | |
c972bf4c | 246 | const struct strvec *ref_prefixes); |
c29727d5 | 247 | |
7c97af4d | 248 | /* |
249 | * Fetch the hash algorithm used by a remote. | |
250 | * | |
251 | * This can only be called after fetching the remote refs. | |
252 | */ | |
253 | const struct git_hash_algo *transport_get_hash_algo(struct transport *transport); | |
e2842b39 | 254 | int transport_fetch_refs(struct transport *transport, struct ref *refs); |
1788c39c | 255 | void transport_unlock_pack(struct transport *transport); |
9b288516 | 256 | int transport_disconnect(struct transport *transport); |
47abd85b | 257 | char *transport_anonymize_url(const char *url); |
61b075bd IL |
258 | void transport_take_over(struct transport *transport, |
259 | struct child_process *child); | |
9b288516 | 260 | |
b236752a IL |
261 | int transport_connect(struct transport *transport, const char *name, |
262 | const char *exec, int fd[2]); | |
263 | ||
6eb996b5 | 264 | /* Transport methods defined outside transport.c */ |
c9e388bb | 265 | int transport_helper_init(struct transport *transport, const char *name); |
419f37db | 266 | int bidirectional_transfer_loop(int input, int output); |
6eb996b5 | 267 | |
09b7e220 | 268 | /* common methods used by transport.c and builtin/send-pack.c */ |
f1863d0d ML |
269 | void transport_update_tracking_ref(struct remote *remote, struct ref *ref, int verbose); |
270 | ||
271 | int transport_refs_pushed(struct ref *ref); | |
272 | ||
273 | void transport_print_push_status(const char *dest, struct ref *refs, | |
10643d4e | 274 | int verbose, int porcelain, unsigned int *reject_reasons); |
f1863d0d | 275 | |
dfe1b7f1 JX |
276 | /* common method used by transport-helper.c and send-pack.c */ |
277 | void reject_atomic_push(struct ref *refs, int mirror_mode); | |
278 | ||
9b288516 | 279 | #endif |