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