blob: 01e717c29ee6e0f0724b5757ebc7538a72e7e807 [file] [log] [blame]
Daniel Barkalow9b288512007-09-10 23:03:04 -04001#ifndef TRANSPORT_H
2#define TRANSPORT_H
3
4#include "cache.h"
Junio C Hamano47a59182013-07-08 13:56:53 -07005#include "run-command.h"
Daniel Barkalow9b288512007-09-10 23:03:04 -04006#include "remote.h"
Jeff Hostetler640d8b72017-12-08 15:58:40 +00007#include "list-objects-filter-options.h"
Daniel Barkalow9b288512007-09-10 23:03:04 -04008
Nguyễn Thái Ngọc Duya45a2602016-06-12 17:54:04 +07009struct string_list;
10
Ilari Liusvaaraaa5af972009-12-09 17:26:30 +020011struct git_transport_options {
12 unsigned thin : 1;
13 unsigned keep : 1;
14 unsigned followtags : 1;
Nguyễn Thái Ngọc Duyc6807a42013-05-26 08:16:17 +070015 unsigned check_self_contained_and_connected : 1;
16 unsigned self_contained_and_connected : 1;
Nguyễn Thái Ngọc Duy48d25ca2013-12-05 20:02:42 +070017 unsigned update_shallow : 1;
Nguyễn Thái Ngọc Duycccf74e2016-06-12 17:54:09 +070018 unsigned deepen_relative : 1;
Jonathan Tan88e2f9e2017-12-05 16:58:49 +000019 unsigned from_promisor : 1;
20 unsigned no_dependents : 1;
Jonathan Tancf1e7c02018-07-02 15:08:43 -070021
22 /*
23 * If this transport supports connect or stateless-connect,
24 * the corresponding field in struct fetch_pack_args is copied
25 * here after fetching.
26 *
27 * See the definition of connectivity_checked in struct
28 * fetch_pack_args for more information.
29 */
30 unsigned connectivity_checked:1;
31
Ilari Liusvaaraaa5af972009-12-09 17:26:30 +020032 int depth;
Nguyễn Thái Ngọc Duy508ea882016-06-12 17:53:59 +070033 const char *deepen_since;
Nguyễn Thái Ngọc Duya45a2602016-06-12 17:54:04 +070034 const struct string_list *deepen_not;
Ilari Liusvaaraaa5af972009-12-09 17:26:30 +020035 const char *uploadpack;
36 const char *receivepack;
Junio C Hamano91048a92013-07-09 11:01:06 -070037 struct push_cas_option *cas;
Jeff Hostetler640d8b72017-12-08 15:58:40 +000038 struct list_objects_filter_options filter_options;
Jonathan Tan3390e422018-07-02 15:39:44 -070039
40 /*
41 * This is only used during fetch. See the documentation of
42 * negotiation_tips in struct fetch_pack_args.
43 *
44 * This field is only supported by transports that support connect or
45 * stateless_connect. Set this field directly instead of using
46 * transport_set_option().
47 */
48 struct oid_array *negotiation_tips;
Ilari Liusvaaraaa5af972009-12-09 17:26:30 +020049};
50
Eric Wongc915f112016-02-03 04:09:14 +000051enum transport_family {
52 TRANSPORT_FAMILY_ALL = 0,
53 TRANSPORT_FAMILY_IPV4,
54 TRANSPORT_FAMILY_IPV6
55};
56
Daniel Barkalow9b288512007-09-10 23:03:04 -040057struct transport {
Jonathan Tane967ca32017-12-14 13:44:45 -080058 const struct transport_vtable *vtable;
59
Daniel Barkalow9b288512007-09-10 23:03:04 -040060 struct remote *remote;
61 const char *url;
Daniel Barkalow9b288512007-09-10 23:03:04 -040062 void *data;
Daniel Barkalow45773702007-10-29 21:05:40 -040063 const struct ref *remote_refs;
Daniel Barkalow9b288512007-09-10 23:03:04 -040064
Daniel Barkalow9b288512007-09-10 23:03:04 -040065 /**
Tay Ray Chuanb0d66e12010-02-16 15:18:21 +080066 * Indicates whether we already called get_refs_list(); set by
67 * transport.c::transport_get_remote_refs().
68 */
69 unsigned got_remote_refs : 1;
70
Junio C Hamanob26ed432013-08-07 15:47:18 -070071 /*
72 * Transports that call take-over destroys the data specific to
73 * the transport type while doing so, and cannot be reused.
74 */
75 unsigned cannot_reuse : 1;
76
Nguyễn Thái Ngọc Duybeea4152013-12-05 20:02:39 +070077 /*
78 * A hint from caller that it will be performing a clone, not
79 * normal fetch. IOW the repository is guaranteed empty.
80 */
81 unsigned cloning : 1;
82
Stefan Bellerf6a4e612016-07-14 14:49:47 -070083 /*
Brandon Williamsedc9caf2018-03-15 10:31:34 -070084 * Indicates that the transport is connected via a half-duplex
85 * connection and should operate in stateless-rpc mode.
86 */
87 unsigned stateless_rpc : 1;
88
89 /*
Stefan Bellerf6a4e612016-07-14 14:49:47 -070090 * These strings will be passed to the {pre, post}-receive hook,
91 * on the remote side, if both sides support the push options capability.
92 */
93 const struct string_list *push_options;
94
Brandon Williamsff473222018-04-23 15:46:23 -070095 /*
96 * These strings will be passed to the remote side on each command
97 * request, if both sides support the server-option capability.
98 */
99 const struct string_list *server_options;
100
Shawn O. Pearce824d5772007-09-19 00:49:31 -0400101 char *pack_lockfile;
Shawn O. Pearcecff71232009-10-30 17:47:27 -0700102 signed verbose : 3;
Tay Ray Chuand01b3c02010-02-24 20:50:26 +0800103 /**
104 * Transports should not set this directly, and should use this
105 * value without having to check isatty(2), -q/--quiet
106 * (transport->verbose < 0), etc. - checking has already been done
107 * in transport_set_verbosity().
108 **/
Miklos Vajna21188b12008-10-09 01:40:32 +0200109 unsigned progress : 1;
Ilari Liusvaaraaa5af972009-12-09 17:26:30 +0200110 /*
111 * If transport is at least potentially smart, this points to
112 * git_transport_options structure to use in case transport
113 * actually turns out to be smart.
114 */
115 struct git_transport_options *smart_options;
Eric Wongc915f112016-02-03 04:09:14 +0000116
117 enum transport_family family;
Daniel Barkalow9b288512007-09-10 23:03:04 -0400118};
119
Brandon Williams14c01bd2016-12-19 10:25:31 -0800120#define TRANSPORT_PUSH_ALL (1<<0)
121#define TRANSPORT_PUSH_FORCE (1<<1)
122#define TRANSPORT_PUSH_DRY_RUN (1<<2)
123#define TRANSPORT_PUSH_MIRROR (1<<3)
124#define TRANSPORT_PUSH_PORCELAIN (1<<4)
125#define TRANSPORT_PUSH_SET_UPSTREAM (1<<5)
126#define TRANSPORT_RECURSE_SUBMODULES_CHECK (1<<6)
127#define TRANSPORT_PUSH_PRUNE (1<<7)
128#define TRANSPORT_RECURSE_SUBMODULES_ON_DEMAND (1<<8)
129#define TRANSPORT_PUSH_NO_HOOK (1<<9)
130#define TRANSPORT_PUSH_FOLLOW_TAGS (1<<10)
131#define TRANSPORT_PUSH_CERT_ALWAYS (1<<11)
132#define TRANSPORT_PUSH_CERT_IF_ASKED (1<<12)
133#define TRANSPORT_PUSH_ATOMIC (1<<13)
134#define TRANSPORT_PUSH_OPTIONS (1<<14)
Brandon Williams225e8bf2016-12-19 10:25:33 -0800135#define TRANSPORT_RECURSE_SUBMODULES_ONLY (1<<15)
Shawn O. Pearce824d5772007-09-19 00:49:31 -0400136
Junio C Hamano11fd66d2016-10-21 15:28:07 -0700137extern int transport_summary_width(const struct ref *refs);
Daniel Barkalow9b288512007-09-10 23:03:04 -0400138
139/* Returns a transport suitable for the url */
140struct transport *transport_get(struct remote *, const char *);
141
Jeff Kinga5adace2015-09-16 13:12:52 -0400142/*
Brandon Williamsa768a022016-12-14 14:39:54 -0800143 * Check whether a transport is allowed by the environment.
144 *
145 * Type should generally be the URL scheme, as described in
146 * Documentation/git.txt
147 *
148 * from_user specifies if the transport was given by the user. If unknown pass
149 * a -1 to read from the environment to determine if the transport was given by
150 * the user.
151 *
Jeff King5088d3b2015-09-22 18:03:49 -0400152 */
Brandon Williamsa768a022016-12-14 14:39:54 -0800153int is_transport_allowed(const char *type, int from_user);
Jeff King5088d3b2015-09-22 18:03:49 -0400154
155/*
Jeff Kinga5adace2015-09-16 13:12:52 -0400156 * Check whether a transport is allowed by the environment,
Jeff King5088d3b2015-09-22 18:03:49 -0400157 * and die otherwise.
Jeff Kinga5adace2015-09-16 13:12:52 -0400158 */
159void transport_check_allowed(const char *type);
160
Daniel Barkalow9b288512007-09-10 23:03:04 -0400161/* Transport options which apply to git:// and scp-style URLs */
162
Daniel Barkalowc29727d2007-09-10 23:03:11 -0400163/* The program to use on the remote side to send a pack */
164#define TRANS_OPT_UPLOADPACK "uploadpack"
165
Daniel Barkalow9b288512007-09-10 23:03:04 -0400166/* The program to use on the remote side to receive a pack */
167#define TRANS_OPT_RECEIVEPACK "receivepack"
168
169/* Transfer the data as a thin pack if not null */
170#define TRANS_OPT_THIN "thin"
171
Junio C Hamano91048a92013-07-09 11:01:06 -0700172/* Check the current value of the remote ref */
173#define TRANS_OPT_CAS "cas"
174
Daniel Barkalowc29727d2007-09-10 23:03:11 -0400175/* Keep the pack that was transferred if not null */
176#define TRANS_OPT_KEEP "keep"
177
Daniel Barkalowc29727d2007-09-10 23:03:11 -0400178/* Limit the depth of the fetch if not null */
179#define TRANS_OPT_DEPTH "depth"
180
Nguyễn Thái Ngọc Duy508ea882016-06-12 17:53:59 +0700181/* Limit the depth of the fetch based on time if not null */
182#define TRANS_OPT_DEEPEN_SINCE "deepen-since"
183
Nguyễn Thái Ngọc Duya45a2602016-06-12 17:54:04 +0700184/* Limit the depth of the fetch based on revs if not null */
185#define TRANS_OPT_DEEPEN_NOT "deepen-not"
186
Nguyễn Thái Ngọc Duycccf74e2016-06-12 17:54:09 +0700187/* Limit the deepen of the fetch if not null */
188#define TRANS_OPT_DEEPEN_RELATIVE "deepen-relative"
189
Shawn O. Pearce41fa7d22008-03-03 22:27:40 -0500190/* Aggressively fetch annotated tags if possible */
191#define TRANS_OPT_FOLLOWTAGS "followtags"
192
Nguyễn Thái Ngọc Duy48d25ca2013-12-05 20:02:42 +0700193/* Accept refs that may update .git/shallow without --depth */
194#define TRANS_OPT_UPDATE_SHALLOW "updateshallow"
195
Junio C Hamanoa85b3772014-09-12 11:17:07 -0700196/* Send push certificates */
197#define TRANS_OPT_PUSH_CERT "pushcert"
198
Jonathan Tan88e2f9e2017-12-05 16:58:49 +0000199/* Indicate that these objects are being fetched by a promisor */
200#define TRANS_OPT_FROM_PROMISOR "from-promisor"
201
202/*
203 * Indicate that only the objects wanted need to be fetched, not their
204 * dependents
205 */
206#define TRANS_OPT_NO_DEPENDENTS "no-dependents"
207
Jeff Hostetler640d8b72017-12-08 15:58:40 +0000208/* Filter objects for partial clone and fetch */
209#define TRANS_OPT_LIST_OBJECTS_FILTER "filter"
210
Daniel Barkalow9b288512007-09-10 23:03:04 -0400211/**
212 * Returns 0 if the option was used, non-zero otherwise. Prints a
213 * message to stderr if the option is not used.
214 **/
215int transport_set_option(struct transport *transport, const char *name,
216 const char *value);
Tay Ray Chuand01b3c02010-02-24 20:50:26 +0800217void transport_set_verbosity(struct transport *transport, int verbosity,
218 int force_progress);
Daniel Barkalow9b288512007-09-10 23:03:04 -0400219
Chris Rorvick10643d42012-11-29 19:41:33 -0600220#define REJECT_NON_FF_HEAD 0x01
221#define REJECT_NON_FF_OTHER 0x02
Chris Rorvickb24e6042012-11-29 19:41:34 -0600222#define REJECT_ALREADY_EXISTS 0x04
Junio C Hamano75e5c0d2013-01-23 13:55:30 -0800223#define REJECT_FETCH_FIRST 0x08
224#define REJECT_NEEDS_FORCE 0x10
Chris Rorvick10643d42012-11-29 19:41:33 -0600225
Daniel Barkalow9b288512007-09-10 23:03:04 -0400226int transport_push(struct transport *connection,
Brandon Williams306f22d2018-05-16 15:58:17 -0700227 struct refspec *rs, int flags,
Chris Rorvick10643d42012-11-29 19:41:33 -0600228 unsigned int * reject_reasons);
Daniel Barkalow9b288512007-09-10 23:03:04 -0400229
Brandon Williams1af8ae12018-03-15 10:31:23 -0700230/*
231 * Retrieve refs from a remote.
232 *
233 * Optionally a list of ref prefixes can be provided which can be sent to the
234 * server (when communicating using protocol v2) to enable it to limit the ref
235 * advertisement. Since ref filtering is done on the server's end (and only
236 * when using protocol v2), this can return refs which don't match the provided
237 * ref_prefixes.
238 */
239const struct ref *transport_get_remote_refs(struct transport *transport,
240 const struct argv_array *ref_prefixes);
Daniel Barkalowc29727d2007-09-10 23:03:11 -0400241
Jonathan Tane2842b32018-08-01 13:13:20 -0700242int transport_fetch_refs(struct transport *transport, struct ref *refs);
Shawn O. Pearce1788c392007-09-14 03:31:23 -0400243void transport_unlock_pack(struct transport *transport);
Daniel Barkalow9b288512007-09-10 23:03:04 -0400244int transport_disconnect(struct transport *transport);
Andreas Ericsson47abd852009-04-17 10:20:11 +0200245char *transport_anonymize_url(const char *url);
Ilari Liusvaara61b075b2009-12-09 17:26:31 +0200246void transport_take_over(struct transport *transport,
247 struct child_process *child);
Daniel Barkalow9b288512007-09-10 23:03:04 -0400248
Ilari Liusvaarab2367522009-12-09 17:26:33 +0200249int transport_connect(struct transport *transport, const char *name,
250 const char *exec, int fd[2]);
251
Daniel Barkalow6eb996b2009-08-05 01:01:53 -0400252/* Transport methods defined outside transport.c */
Daniel Barkalowc9e388b2009-09-03 22:13:49 -0400253int transport_helper_init(struct transport *transport, const char *name);
Ilari Liusvaara419f37d2010-10-12 19:39:41 +0300254int bidirectional_transfer_loop(int input, int output);
Daniel Barkalow6eb996b2009-08-05 01:01:53 -0400255
Phil Hord09b7e222013-06-18 13:44:58 -0400256/* common methods used by transport.c and builtin/send-pack.c */
Michael Lukashovf1863d02010-02-16 23:42:52 +0000257void transport_update_tracking_ref(struct remote *remote, struct ref *ref, int verbose);
258
259int transport_refs_pushed(struct ref *ref);
260
261void transport_print_push_status(const char *dest, struct ref *refs,
Chris Rorvick10643d42012-11-29 19:41:33 -0600262 int verbose, int porcelain, unsigned int *reject_reasons);
Michael Lukashovf1863d02010-02-16 23:42:52 +0000263
Jeff King2429d632017-02-08 15:52:57 -0500264typedef void alternate_ref_fn(const char *refname, const struct object_id *oid, void *);
Jeff King114a6a82011-05-19 17:33:17 -0400265extern void for_each_alternate_ref(alternate_ref_fn, void *);
Daniel Barkalow9b288512007-09-10 23:03:04 -0400266#endif