Merge branch 'jt/http-redact-cookies' into maint
[git.git] / transport.h
blob731c78b6795740f8e9bfb80741b0170671b37dd3
1 #ifndef TRANSPORT_H
2 #define TRANSPORT_H
4 #include "cache.h"
5 #include "run-command.h"
6 #include "remote.h"
8 struct string_list;
10 struct git_transport_options {
11 unsigned thin : 1;
12 unsigned keep : 1;
13 unsigned followtags : 1;
14 unsigned check_self_contained_and_connected : 1;
15 unsigned self_contained_and_connected : 1;
16 unsigned update_shallow : 1;
17 unsigned deepen_relative : 1;
18 int depth;
19 const char *deepen_since;
20 const struct string_list *deepen_not;
21 const char *uploadpack;
22 const char *receivepack;
23 struct push_cas_option *cas;
26 enum transport_family {
27 TRANSPORT_FAMILY_ALL = 0,
28 TRANSPORT_FAMILY_IPV4,
29 TRANSPORT_FAMILY_IPV6
32 struct transport {
33 const struct transport_vtable *vtable;
35 struct remote *remote;
36 const char *url;
37 void *data;
38 const struct ref *remote_refs;
40 /**
41 * Indicates whether we already called get_refs_list(); set by
42 * transport.c::transport_get_remote_refs().
44 unsigned got_remote_refs : 1;
47 * Transports that call take-over destroys the data specific to
48 * the transport type while doing so, and cannot be reused.
50 unsigned cannot_reuse : 1;
53 * A hint from caller that it will be performing a clone, not
54 * normal fetch. IOW the repository is guaranteed empty.
56 unsigned cloning : 1;
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.
62 const struct string_list *push_options;
64 char *pack_lockfile;
65 signed verbose : 3;
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 **/
72 unsigned progress : 1;
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.
78 struct git_transport_options *smart_options;
80 enum transport_family family;
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)
98 #define TRANSPORT_RECURSE_SUBMODULES_ONLY (1<<15)
100 extern int transport_summary_width(const struct ref *refs);
102 /* Returns a transport suitable for the url */
103 struct transport *transport_get(struct remote *, const char *);
106 * Check whether a transport is allowed by the environment.
108 * Type should generally be the URL scheme, as described in
109 * Documentation/git.txt
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.
116 int is_transport_allowed(const char *type, int from_user);
119 * Check whether a transport is allowed by the environment,
120 * and die otherwise.
122 void transport_check_allowed(const char *type);
124 /* Transport options which apply to git:// and scp-style URLs */
126 /* The program to use on the remote side to send a pack */
127 #define TRANS_OPT_UPLOADPACK "uploadpack"
129 /* The program to use on the remote side to receive a pack */
130 #define TRANS_OPT_RECEIVEPACK "receivepack"
132 /* Transfer the data as a thin pack if not null */
133 #define TRANS_OPT_THIN "thin"
135 /* Check the current value of the remote ref */
136 #define TRANS_OPT_CAS "cas"
138 /* Keep the pack that was transferred if not null */
139 #define TRANS_OPT_KEEP "keep"
141 /* Limit the depth of the fetch if not null */
142 #define TRANS_OPT_DEPTH "depth"
144 /* Limit the depth of the fetch based on time if not null */
145 #define TRANS_OPT_DEEPEN_SINCE "deepen-since"
147 /* Limit the depth of the fetch based on revs if not null */
148 #define TRANS_OPT_DEEPEN_NOT "deepen-not"
150 /* Limit the deepen of the fetch if not null */
151 #define TRANS_OPT_DEEPEN_RELATIVE "deepen-relative"
153 /* Aggressively fetch annotated tags if possible */
154 #define TRANS_OPT_FOLLOWTAGS "followtags"
156 /* Accept refs that may update .git/shallow without --depth */
157 #define TRANS_OPT_UPDATE_SHALLOW "updateshallow"
159 /* Send push certificates */
160 #define TRANS_OPT_PUSH_CERT "pushcert"
163 * Returns 0 if the option was used, non-zero otherwise. Prints a
164 * message to stderr if the option is not used.
166 int transport_set_option(struct transport *transport, const char *name,
167 const char *value);
168 void transport_set_verbosity(struct transport *transport, int verbosity,
169 int force_progress);
171 #define REJECT_NON_FF_HEAD 0x01
172 #define REJECT_NON_FF_OTHER 0x02
173 #define REJECT_ALREADY_EXISTS 0x04
174 #define REJECT_FETCH_FIRST 0x08
175 #define REJECT_NEEDS_FORCE 0x10
177 int transport_push(struct transport *connection,
178 int refspec_nr, const char **refspec, int flags,
179 unsigned int * reject_reasons);
181 const struct ref *transport_get_remote_refs(struct transport *transport);
183 int transport_fetch_refs(struct transport *transport, struct ref *refs);
184 void transport_unlock_pack(struct transport *transport);
185 int transport_disconnect(struct transport *transport);
186 char *transport_anonymize_url(const char *url);
187 void transport_take_over(struct transport *transport,
188 struct child_process *child);
190 int transport_connect(struct transport *transport, const char *name,
191 const char *exec, int fd[2]);
193 /* Transport methods defined outside transport.c */
194 int transport_helper_init(struct transport *transport, const char *name);
195 int bidirectional_transfer_loop(int input, int output);
197 /* common methods used by transport.c and builtin/send-pack.c */
198 void transport_verify_remote_names(int nr_heads, const char **heads);
200 void transport_update_tracking_ref(struct remote *remote, struct ref *ref, int verbose);
202 int transport_refs_pushed(struct ref *ref);
204 void transport_print_push_status(const char *dest, struct ref *refs,
205 int verbose, int porcelain, unsigned int *reject_reasons);
207 typedef void alternate_ref_fn(const char *refname, const struct object_id *oid, void *);
208 extern void for_each_alternate_ref(alternate_ref_fn, void *);
209 #endif