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