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