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