http: create function to get curl allowed protocols
[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
aa5af974
IL
8struct git_transport_options {
9 unsigned thin : 1;
10 unsigned keep : 1;
11 unsigned followtags : 1;
c6807a40
NTND
12 unsigned check_self_contained_and_connected : 1;
13 unsigned self_contained_and_connected : 1;
48d25cae 14 unsigned update_shallow : 1;
aa5af974
IL
15 int depth;
16 const char *uploadpack;
17 const char *receivepack;
91048a95 18 struct push_cas_option *cas;
aa5af974
IL
19};
20
c915f11e
EW
21enum transport_family {
22 TRANSPORT_FAMILY_ALL = 0,
23 TRANSPORT_FAMILY_IPV4,
24 TRANSPORT_FAMILY_IPV6
25};
26
9b288516 27struct transport {
9b288516
DB
28 struct remote *remote;
29 const char *url;
9b288516 30 void *data;
4577370e 31 const struct ref *remote_refs;
9b288516 32
b0d66e15
TRC
33 /**
34 * Indicates whether we already called get_refs_list(); set by
35 * transport.c::transport_get_remote_refs().
36 */
37 unsigned got_remote_refs : 1;
38
b26ed430
JH
39 /*
40 * Transports that call take-over destroys the data specific to
41 * the transport type while doing so, and cannot be reused.
42 */
43 unsigned cannot_reuse : 1;
44
beea4152
NTND
45 /*
46 * A hint from caller that it will be performing a clone, not
47 * normal fetch. IOW the repository is guaranteed empty.
48 */
49 unsigned cloning : 1;
50
9b288516
DB
51 /**
52 * Returns 0 if successful, positive if the option is not
53 * recognized or is inapplicable, and negative if the option
54 * is applicable but the value is invalid.
55 **/
56 int (*set_option)(struct transport *connection, const char *name,
57 const char *value);
58
37148311
DB
59 /**
60 * Returns a list of the remote side's refs. In order to allow
61 * the transport to try to share connections, for_push is a
62 * hint as to whether the ultimate operation is a push or a fetch.
63 *
64 * If the transport is able to determine the remote hash for
65 * the ref without a huge amount of effort, it should store it
66 * in the ref's old_sha1 field; otherwise it should be all 0.
67 **/
64fcef2d 68 struct ref *(*get_refs_list)(struct transport *transport, int for_push);
37148311
DB
69
70 /**
71 * Fetch the objects for the given refs. Note that this gets
72 * an array, and should ignore the list structure.
73 *
74 * If the transport did not get hashes for refs in
75 * get_refs_list(), it should set the old_sha1 fields in the
76 * provided refs now.
77 **/
78 int (*fetch)(struct transport *transport, int refs_nr, struct ref **refs);
79
80 /**
81 * Push the objects and refs. Send the necessary objects, and
82 * then, for any refs where peer_ref is set and
f4e54d02 83 * peer_ref->new_oid is different from old_oid, tell the
84 * remote side to update each ref in the list from old_oid to
85 * peer_ref->new_oid.
37148311
DB
86 *
87 * Where possible, set the status for each ref appropriately.
88 *
89 * The transport must modify new_sha1 in the ref to the new
90 * value if the remote accepted the change. Note that this
f4e54d02 91 * could be a different value from peer_ref->new_oid if the
37148311
DB
92 * process involved generating new commits.
93 **/
64fcef2d 94 int (*push_refs)(struct transport *transport, struct ref *refs, int flags);
9b288516 95 int (*push)(struct transport *connection, int refspec_nr, const char **refspec, int flags);
b236752a
IL
96 int (*connect)(struct transport *connection, const char *name,
97 const char *executable, int fd[2]);
9b288516 98
37148311 99 /** get_refs_list(), fetch(), and push_refs() can keep
41ccfdd9 100 * resources (such as a connection) reserved for further
37148311
DB
101 * use. disconnect() releases these resources.
102 **/
9b288516 103 int (*disconnect)(struct transport *connection);
824d5776 104 char *pack_lockfile;
cff7123c 105 signed verbose : 3;
d01b3c02
TRC
106 /**
107 * Transports should not set this directly, and should use this
108 * value without having to check isatty(2), -q/--quiet
109 * (transport->verbose < 0), etc. - checking has already been done
110 * in transport_set_verbosity().
111 **/
21188b1e 112 unsigned progress : 1;
aa5af974
IL
113 /*
114 * If transport is at least potentially smart, this points to
115 * git_transport_options structure to use in case transport
116 * actually turns out to be smart.
117 */
118 struct git_transport_options *smart_options;
c915f11e
EW
119
120 enum transport_family family;
9b288516
DB
121};
122
824d5776
SP
123#define TRANSPORT_PUSH_ALL 1
124#define TRANSPORT_PUSH_FORCE 2
2e13e5d8 125#define TRANSPORT_PUSH_DRY_RUN 4
94c89ba6 126#define TRANSPORT_PUSH_MIRROR 8
212cfe15
TRC
127#define TRANSPORT_PUSH_PORCELAIN 16
128#define TRANSPORT_PUSH_SET_UPSTREAM 32
d2b17b32 129#define TRANSPORT_RECURSE_SUBMODULES_CHECK 64
6ddba5e2 130#define TRANSPORT_PUSH_PRUNE 128
eb21c732 131#define TRANSPORT_RECURSE_SUBMODULES_ON_DEMAND 256
ec55559f 132#define TRANSPORT_PUSH_NO_HOOK 512
c2aba155 133#define TRANSPORT_PUSH_FOLLOW_TAGS 1024
30261094
DB
134#define TRANSPORT_PUSH_CERT_ALWAYS 2048
135#define TRANSPORT_PUSH_CERT_IF_ASKED 4096
136#define TRANSPORT_PUSH_ATOMIC 8192
824d5776 137
f1863d0d 138#define TRANSPORT_SUMMARY_WIDTH (2 * DEFAULT_ABBREV + 3)
754395d3 139#define TRANSPORT_SUMMARY(x) (int)(TRANSPORT_SUMMARY_WIDTH + strlen(x) - gettext_width(x)), (x)
824d5776 140
9b288516 141/* Returns a transport suitable for the url */
e5f4e214 142struct transport *transport_get(struct remote *, const char *);
9b288516 143
5088d3b3
JK
144/*
145 * Check whether a transport is allowed by the environment. Type should
146 * generally be the URL scheme, as described in Documentation/git.txt
147 */
148int is_transport_allowed(const char *type);
149
a5adaced
JK
150/*
151 * Check whether a transport is allowed by the environment,
5088d3b3 152 * and die otherwise.
a5adaced
JK
153 */
154void transport_check_allowed(const char *type);
155
9b288516
DB
156/* Transport options which apply to git:// and scp-style URLs */
157
c29727d5
DB
158/* The program to use on the remote side to send a pack */
159#define TRANS_OPT_UPLOADPACK "uploadpack"
160
9b288516
DB
161/* The program to use on the remote side to receive a pack */
162#define TRANS_OPT_RECEIVEPACK "receivepack"
163
164/* Transfer the data as a thin pack if not null */
165#define TRANS_OPT_THIN "thin"
166
91048a95
JH
167/* Check the current value of the remote ref */
168#define TRANS_OPT_CAS "cas"
169
c29727d5
DB
170/* Keep the pack that was transferred if not null */
171#define TRANS_OPT_KEEP "keep"
172
c29727d5
DB
173/* Limit the depth of the fetch if not null */
174#define TRANS_OPT_DEPTH "depth"
175
41fa7d2e
SP
176/* Aggressively fetch annotated tags if possible */
177#define TRANS_OPT_FOLLOWTAGS "followtags"
178
48d25cae
NTND
179/* Accept refs that may update .git/shallow without --depth */
180#define TRANS_OPT_UPDATE_SHALLOW "updateshallow"
181
a85b377d
JH
182/* Send push certificates */
183#define TRANS_OPT_PUSH_CERT "pushcert"
184
9b288516
DB
185/**
186 * Returns 0 if the option was used, non-zero otherwise. Prints a
187 * message to stderr if the option is not used.
188 **/
189int transport_set_option(struct transport *transport, const char *name,
190 const char *value);
d01b3c02
TRC
191void transport_set_verbosity(struct transport *transport, int verbosity,
192 int force_progress);
9b288516 193
10643d4e
CR
194#define REJECT_NON_FF_HEAD 0x01
195#define REJECT_NON_FF_OTHER 0x02
b24e6047 196#define REJECT_ALREADY_EXISTS 0x04
75e5c0dc
JH
197#define REJECT_FETCH_FIRST 0x08
198#define REJECT_NEEDS_FORCE 0x10
10643d4e 199
9b288516 200int transport_push(struct transport *connection,
07436e43 201 int refspec_nr, const char **refspec, int flags,
10643d4e 202 unsigned int * reject_reasons);
9b288516 203
4577370e 204const struct ref *transport_get_remote_refs(struct transport *transport);
c29727d5 205
37148311 206int transport_fetch_refs(struct transport *transport, struct ref *refs);
1788c39c 207void transport_unlock_pack(struct transport *transport);
9b288516 208int transport_disconnect(struct transport *transport);
47abd85b 209char *transport_anonymize_url(const char *url);
61b075bd
IL
210void transport_take_over(struct transport *transport,
211 struct child_process *child);
9b288516 212
b236752a
IL
213int transport_connect(struct transport *transport, const char *name,
214 const char *exec, int fd[2]);
215
6eb996b5 216/* Transport methods defined outside transport.c */
c9e388bb 217int transport_helper_init(struct transport *transport, const char *name);
419f37db 218int bidirectional_transfer_loop(int input, int output);
6eb996b5 219
09b7e220 220/* common methods used by transport.c and builtin/send-pack.c */
f1863d0d
ML
221void transport_verify_remote_names(int nr_heads, const char **heads);
222
223void transport_update_tracking_ref(struct remote *remote, struct ref *ref, int verbose);
224
225int transport_refs_pushed(struct ref *ref);
226
227void transport_print_push_status(const char *dest, struct ref *refs,
10643d4e 228 int verbose, int porcelain, unsigned int *reject_reasons);
f1863d0d 229
36cfda15 230typedef void alternate_ref_fn(const struct ref *, void *);
114a6a88 231extern void for_each_alternate_ref(alternate_ref_fn, void *);
9b288516 232#endif